vhost.c 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610
  1. /* Copyright (C) 2009 Red Hat, Inc.
  2. * Copyright (C) 2006 Rusty Russell IBM Corporation
  3. *
  4. * Author: Michael S. Tsirkin <mst@redhat.com>
  5. *
  6. * Inspiration, some code, and most witty comments come from
  7. * Documentation/virtual/lguest/lguest.c, by Rusty Russell
  8. *
  9. * This work is licensed under the terms of the GNU GPL, version 2.
  10. *
  11. * Generic code for virtio server in host kernel.
  12. */
  13. #include <linux/eventfd.h>
  14. #include <linux/vhost.h>
  15. #include <linux/virtio_net.h>
  16. #include <linux/mm.h>
  17. #include <linux/mmu_context.h>
  18. #include <linux/miscdevice.h>
  19. #include <linux/mutex.h>
  20. #include <linux/rcupdate.h>
  21. #include <linux/poll.h>
  22. #include <linux/file.h>
  23. #include <linux/highmem.h>
  24. #include <linux/slab.h>
  25. #include <linux/kthread.h>
  26. #include <linux/cgroup.h>
  27. #include <linux/net.h>
  28. #include <linux/if_packet.h>
  29. #include <linux/if_arp.h>
  30. #include "vhost.h"
  31. enum {
  32. VHOST_MEMORY_MAX_NREGIONS = 64,
  33. VHOST_MEMORY_F_LOG = 0x1,
  34. };
  35. static unsigned vhost_zcopy_mask __read_mostly;
  36. #define vhost_used_event(vq) ((u16 __user *)&vq->avail->ring[vq->num])
  37. #define vhost_avail_event(vq) ((u16 __user *)&vq->used->ring[vq->num])
  38. static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
  39. poll_table *pt)
  40. {
  41. struct vhost_poll *poll;
  42. poll = container_of(pt, struct vhost_poll, table);
  43. poll->wqh = wqh;
  44. add_wait_queue(wqh, &poll->wait);
  45. }
  46. static int vhost_poll_wakeup(wait_queue_t *wait, unsigned mode, int sync,
  47. void *key)
  48. {
  49. struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);
  50. if (!((unsigned long)key & poll->mask))
  51. return 0;
  52. vhost_poll_queue(poll);
  53. return 0;
  54. }
  55. static void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
  56. {
  57. INIT_LIST_HEAD(&work->node);
  58. work->fn = fn;
  59. init_waitqueue_head(&work->done);
  60. work->flushing = 0;
  61. work->queue_seq = work->done_seq = 0;
  62. }
  63. /* Init poll structure */
  64. void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
  65. unsigned long mask, struct vhost_dev *dev)
  66. {
  67. init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
  68. init_poll_funcptr(&poll->table, vhost_poll_func);
  69. poll->mask = mask;
  70. poll->dev = dev;
  71. vhost_work_init(&poll->work, fn);
  72. }
  73. /* Start polling a file. We add ourselves to file's wait queue. The caller must
  74. * keep a reference to a file until after vhost_poll_stop is called. */
  75. void vhost_poll_start(struct vhost_poll *poll, struct file *file)
  76. {
  77. unsigned long mask;
  78. mask = file->f_op->poll(file, &poll->table);
  79. if (mask)
  80. vhost_poll_wakeup(&poll->wait, 0, 0, (void *)mask);
  81. }
  82. /* Stop polling a file. After this function returns, it becomes safe to drop the
  83. * file reference. You must also flush afterwards. */
  84. void vhost_poll_stop(struct vhost_poll *poll)
  85. {
  86. remove_wait_queue(poll->wqh, &poll->wait);
  87. }
  88. static bool vhost_work_seq_done(struct vhost_dev *dev, struct vhost_work *work,
  89. unsigned seq)
  90. {
  91. int left;
  92. spin_lock_irq(&dev->work_lock);
  93. left = seq - work->done_seq;
  94. spin_unlock_irq(&dev->work_lock);
  95. return left <= 0;
  96. }
  97. static void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
  98. {
  99. unsigned seq;
  100. int flushing;
  101. spin_lock_irq(&dev->work_lock);
  102. seq = work->queue_seq;
  103. work->flushing++;
  104. spin_unlock_irq(&dev->work_lock);
  105. wait_event(work->done, vhost_work_seq_done(dev, work, seq));
  106. spin_lock_irq(&dev->work_lock);
  107. flushing = --work->flushing;
  108. spin_unlock_irq(&dev->work_lock);
  109. BUG_ON(flushing < 0);
  110. }
  111. /* Flush any work that has been scheduled. When calling this, don't hold any
  112. * locks that are also used by the callback. */
  113. void vhost_poll_flush(struct vhost_poll *poll)
  114. {
  115. vhost_work_flush(poll->dev, &poll->work);
  116. }
  117. static inline void vhost_work_queue(struct vhost_dev *dev,
  118. struct vhost_work *work)
  119. {
  120. unsigned long flags;
  121. spin_lock_irqsave(&dev->work_lock, flags);
  122. if (list_empty(&work->node)) {
  123. list_add_tail(&work->node, &dev->work_list);
  124. work->queue_seq++;
  125. wake_up_process(dev->worker);
  126. }
  127. spin_unlock_irqrestore(&dev->work_lock, flags);
  128. }
  129. void vhost_poll_queue(struct vhost_poll *poll)
  130. {
  131. vhost_work_queue(poll->dev, &poll->work);
  132. }
  133. static void vhost_vq_reset(struct vhost_dev *dev,
  134. struct vhost_virtqueue *vq)
  135. {
  136. vq->num = 1;
  137. vq->desc = NULL;
  138. vq->avail = NULL;
  139. vq->used = NULL;
  140. vq->last_avail_idx = 0;
  141. vq->avail_idx = 0;
  142. vq->last_used_idx = 0;
  143. vq->signalled_used = 0;
  144. vq->signalled_used_valid = false;
  145. vq->used_flags = 0;
  146. vq->log_used = false;
  147. vq->log_addr = -1ull;
  148. vq->vhost_hlen = 0;
  149. vq->sock_hlen = 0;
  150. vq->private_data = NULL;
  151. vq->log_base = NULL;
  152. vq->error_ctx = NULL;
  153. vq->error = NULL;
  154. vq->kick = NULL;
  155. vq->call_ctx = NULL;
  156. vq->call = NULL;
  157. vq->log_ctx = NULL;
  158. vq->upend_idx = 0;
  159. vq->done_idx = 0;
  160. vq->ubufs = NULL;
  161. }
  162. static int vhost_worker(void *data)
  163. {
  164. struct vhost_dev *dev = data;
  165. struct vhost_work *work = NULL;
  166. unsigned uninitialized_var(seq);
  167. use_mm(dev->mm);
  168. for (;;) {
  169. /* mb paired w/ kthread_stop */
  170. set_current_state(TASK_INTERRUPTIBLE);
  171. spin_lock_irq(&dev->work_lock);
  172. if (work) {
  173. work->done_seq = seq;
  174. if (work->flushing)
  175. wake_up_all(&work->done);
  176. }
  177. if (kthread_should_stop()) {
  178. spin_unlock_irq(&dev->work_lock);
  179. __set_current_state(TASK_RUNNING);
  180. break;
  181. }
  182. if (!list_empty(&dev->work_list)) {
  183. work = list_first_entry(&dev->work_list,
  184. struct vhost_work, node);
  185. list_del_init(&work->node);
  186. seq = work->queue_seq;
  187. } else
  188. work = NULL;
  189. spin_unlock_irq(&dev->work_lock);
  190. if (work) {
  191. __set_current_state(TASK_RUNNING);
  192. work->fn(work);
  193. if (need_resched())
  194. schedule();
  195. } else
  196. schedule();
  197. }
  198. unuse_mm(dev->mm);
  199. return 0;
  200. }
  201. static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
  202. {
  203. kfree(vq->indirect);
  204. vq->indirect = NULL;
  205. kfree(vq->log);
  206. vq->log = NULL;
  207. kfree(vq->heads);
  208. vq->heads = NULL;
  209. kfree(vq->ubuf_info);
  210. vq->ubuf_info = NULL;
  211. }
  212. void vhost_enable_zcopy(int vq)
  213. {
  214. vhost_zcopy_mask |= 0x1 << vq;
  215. }
  216. /* Helper to allocate iovec buffers for all vqs. */
  217. static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
  218. {
  219. int i;
  220. bool zcopy;
  221. for (i = 0; i < dev->nvqs; ++i) {
  222. dev->vqs[i].indirect = kmalloc(sizeof *dev->vqs[i].indirect *
  223. UIO_MAXIOV, GFP_KERNEL);
  224. dev->vqs[i].log = kmalloc(sizeof *dev->vqs[i].log * UIO_MAXIOV,
  225. GFP_KERNEL);
  226. dev->vqs[i].heads = kmalloc(sizeof *dev->vqs[i].heads *
  227. UIO_MAXIOV, GFP_KERNEL);
  228. zcopy = vhost_zcopy_mask & (0x1 << i);
  229. if (zcopy)
  230. dev->vqs[i].ubuf_info =
  231. kmalloc(sizeof *dev->vqs[i].ubuf_info *
  232. UIO_MAXIOV, GFP_KERNEL);
  233. if (!dev->vqs[i].indirect || !dev->vqs[i].log ||
  234. !dev->vqs[i].heads ||
  235. (zcopy && !dev->vqs[i].ubuf_info))
  236. goto err_nomem;
  237. }
  238. return 0;
  239. err_nomem:
  240. for (; i >= 0; --i)
  241. vhost_vq_free_iovecs(&dev->vqs[i]);
  242. return -ENOMEM;
  243. }
  244. static void vhost_dev_free_iovecs(struct vhost_dev *dev)
  245. {
  246. int i;
  247. for (i = 0; i < dev->nvqs; ++i)
  248. vhost_vq_free_iovecs(&dev->vqs[i]);
  249. }
  250. long vhost_dev_init(struct vhost_dev *dev,
  251. struct vhost_virtqueue *vqs, int nvqs)
  252. {
  253. int i;
  254. dev->vqs = vqs;
  255. dev->nvqs = nvqs;
  256. mutex_init(&dev->mutex);
  257. dev->log_ctx = NULL;
  258. dev->log_file = NULL;
  259. dev->memory = NULL;
  260. dev->mm = NULL;
  261. spin_lock_init(&dev->work_lock);
  262. INIT_LIST_HEAD(&dev->work_list);
  263. dev->worker = NULL;
  264. for (i = 0; i < dev->nvqs; ++i) {
  265. dev->vqs[i].log = NULL;
  266. dev->vqs[i].indirect = NULL;
  267. dev->vqs[i].heads = NULL;
  268. dev->vqs[i].ubuf_info = NULL;
  269. dev->vqs[i].dev = dev;
  270. mutex_init(&dev->vqs[i].mutex);
  271. vhost_vq_reset(dev, dev->vqs + i);
  272. if (dev->vqs[i].handle_kick)
  273. vhost_poll_init(&dev->vqs[i].poll,
  274. dev->vqs[i].handle_kick, POLLIN, dev);
  275. }
  276. return 0;
  277. }
  278. /* Caller should have device mutex */
  279. long vhost_dev_check_owner(struct vhost_dev *dev)
  280. {
  281. /* Are you the owner? If not, I don't think you mean to do that */
  282. return dev->mm == current->mm ? 0 : -EPERM;
  283. }
  284. struct vhost_attach_cgroups_struct {
  285. struct vhost_work work;
  286. struct task_struct *owner;
  287. int ret;
  288. };
  289. static void vhost_attach_cgroups_work(struct vhost_work *work)
  290. {
  291. struct vhost_attach_cgroups_struct *s;
  292. s = container_of(work, struct vhost_attach_cgroups_struct, work);
  293. s->ret = cgroup_attach_task_all(s->owner, current);
  294. }
  295. static int vhost_attach_cgroups(struct vhost_dev *dev)
  296. {
  297. struct vhost_attach_cgroups_struct attach;
  298. attach.owner = current;
  299. vhost_work_init(&attach.work, vhost_attach_cgroups_work);
  300. vhost_work_queue(dev, &attach.work);
  301. vhost_work_flush(dev, &attach.work);
  302. return attach.ret;
  303. }
  304. /* Caller should have device mutex */
  305. static long vhost_dev_set_owner(struct vhost_dev *dev)
  306. {
  307. struct task_struct *worker;
  308. int err;
  309. /* Is there an owner already? */
  310. if (dev->mm) {
  311. err = -EBUSY;
  312. goto err_mm;
  313. }
  314. /* No owner, become one */
  315. dev->mm = get_task_mm(current);
  316. worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
  317. if (IS_ERR(worker)) {
  318. err = PTR_ERR(worker);
  319. goto err_worker;
  320. }
  321. dev->worker = worker;
  322. wake_up_process(worker); /* avoid contributing to loadavg */
  323. err = vhost_attach_cgroups(dev);
  324. if (err)
  325. goto err_cgroup;
  326. err = vhost_dev_alloc_iovecs(dev);
  327. if (err)
  328. goto err_cgroup;
  329. return 0;
  330. err_cgroup:
  331. kthread_stop(worker);
  332. dev->worker = NULL;
  333. err_worker:
  334. if (dev->mm)
  335. mmput(dev->mm);
  336. dev->mm = NULL;
  337. err_mm:
  338. return err;
  339. }
  340. /* Caller should have device mutex */
  341. long vhost_dev_reset_owner(struct vhost_dev *dev)
  342. {
  343. struct vhost_memory *memory;
  344. /* Restore memory to default empty mapping. */
  345. memory = kmalloc(offsetof(struct vhost_memory, regions), GFP_KERNEL);
  346. if (!memory)
  347. return -ENOMEM;
  348. vhost_dev_cleanup(dev, true);
  349. memory->nregions = 0;
  350. RCU_INIT_POINTER(dev->memory, memory);
  351. return 0;
  352. }
  353. /* In case of DMA done not in order in lower device driver for some reason.
  354. * upend_idx is used to track end of used idx, done_idx is used to track head
  355. * of used idx. Once lower device DMA done contiguously, we will signal KVM
  356. * guest used idx.
  357. */
  358. int vhost_zerocopy_signal_used(struct vhost_virtqueue *vq)
  359. {
  360. int i;
  361. int j = 0;
  362. for (i = vq->done_idx; i != vq->upend_idx; i = (i + 1) % UIO_MAXIOV) {
  363. if ((vq->heads[i].len == VHOST_DMA_DONE_LEN)) {
  364. vq->heads[i].len = VHOST_DMA_CLEAR_LEN;
  365. vhost_add_used_and_signal(vq->dev, vq,
  366. vq->heads[i].id, 0);
  367. ++j;
  368. } else
  369. break;
  370. }
  371. if (j)
  372. vq->done_idx = i;
  373. return j;
  374. }
  375. /* Caller should have device mutex if and only if locked is set */
  376. void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
  377. {
  378. int i;
  379. for (i = 0; i < dev->nvqs; ++i) {
  380. if (dev->vqs[i].kick && dev->vqs[i].handle_kick) {
  381. vhost_poll_stop(&dev->vqs[i].poll);
  382. vhost_poll_flush(&dev->vqs[i].poll);
  383. }
  384. /* Wait for all lower device DMAs done. */
  385. if (dev->vqs[i].ubufs)
  386. vhost_ubuf_put_and_wait(dev->vqs[i].ubufs);
  387. /* Signal guest as appropriate. */
  388. vhost_zerocopy_signal_used(&dev->vqs[i]);
  389. if (dev->vqs[i].error_ctx)
  390. eventfd_ctx_put(dev->vqs[i].error_ctx);
  391. if (dev->vqs[i].error)
  392. fput(dev->vqs[i].error);
  393. if (dev->vqs[i].kick)
  394. fput(dev->vqs[i].kick);
  395. if (dev->vqs[i].call_ctx)
  396. eventfd_ctx_put(dev->vqs[i].call_ctx);
  397. if (dev->vqs[i].call)
  398. fput(dev->vqs[i].call);
  399. vhost_vq_reset(dev, dev->vqs + i);
  400. }
  401. vhost_dev_free_iovecs(dev);
  402. if (dev->log_ctx)
  403. eventfd_ctx_put(dev->log_ctx);
  404. dev->log_ctx = NULL;
  405. if (dev->log_file)
  406. fput(dev->log_file);
  407. dev->log_file = NULL;
  408. /* No one will access memory at this point */
  409. kfree(rcu_dereference_protected(dev->memory,
  410. locked ==
  411. lockdep_is_held(&dev->mutex)));
  412. RCU_INIT_POINTER(dev->memory, NULL);
  413. WARN_ON(!list_empty(&dev->work_list));
  414. if (dev->worker) {
  415. kthread_stop(dev->worker);
  416. dev->worker = NULL;
  417. }
  418. if (dev->mm)
  419. mmput(dev->mm);
  420. dev->mm = NULL;
  421. }
  422. static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
  423. {
  424. u64 a = addr / VHOST_PAGE_SIZE / 8;
  425. /* Make sure 64 bit math will not overflow. */
  426. if (a > ULONG_MAX - (unsigned long)log_base ||
  427. a + (unsigned long)log_base > ULONG_MAX)
  428. return 0;
  429. return access_ok(VERIFY_WRITE, log_base + a,
  430. (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
  431. }
  432. /* Caller should have vq mutex and device mutex. */
  433. static int vq_memory_access_ok(void __user *log_base, struct vhost_memory *mem,
  434. int log_all)
  435. {
  436. int i;
  437. if (!mem)
  438. return 0;
  439. for (i = 0; i < mem->nregions; ++i) {
  440. struct vhost_memory_region *m = mem->regions + i;
  441. unsigned long a = m->userspace_addr;
  442. if (m->memory_size > ULONG_MAX)
  443. return 0;
  444. else if (!access_ok(VERIFY_WRITE, (void __user *)a,
  445. m->memory_size))
  446. return 0;
  447. else if (log_all && !log_access_ok(log_base,
  448. m->guest_phys_addr,
  449. m->memory_size))
  450. return 0;
  451. }
  452. return 1;
  453. }
  454. /* Can we switch to this memory table? */
  455. /* Caller should have device mutex but not vq mutex */
  456. static int memory_access_ok(struct vhost_dev *d, struct vhost_memory *mem,
  457. int log_all)
  458. {
  459. int i;
  460. for (i = 0; i < d->nvqs; ++i) {
  461. int ok;
  462. mutex_lock(&d->vqs[i].mutex);
  463. /* If ring is inactive, will check when it's enabled. */
  464. if (d->vqs[i].private_data)
  465. ok = vq_memory_access_ok(d->vqs[i].log_base, mem,
  466. log_all);
  467. else
  468. ok = 1;
  469. mutex_unlock(&d->vqs[i].mutex);
  470. if (!ok)
  471. return 0;
  472. }
  473. return 1;
  474. }
  475. static int vq_access_ok(struct vhost_dev *d, unsigned int num,
  476. struct vring_desc __user *desc,
  477. struct vring_avail __user *avail,
  478. struct vring_used __user *used)
  479. {
  480. size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
  481. return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
  482. access_ok(VERIFY_READ, avail,
  483. sizeof *avail + num * sizeof *avail->ring + s) &&
  484. access_ok(VERIFY_WRITE, used,
  485. sizeof *used + num * sizeof *used->ring + s);
  486. }
  487. /* Can we log writes? */
  488. /* Caller should have device mutex but not vq mutex */
  489. int vhost_log_access_ok(struct vhost_dev *dev)
  490. {
  491. struct vhost_memory *mp;
  492. mp = rcu_dereference_protected(dev->memory,
  493. lockdep_is_held(&dev->mutex));
  494. return memory_access_ok(dev, mp, 1);
  495. }
  496. /* Verify access for write logging. */
  497. /* Caller should have vq mutex and device mutex */
  498. static int vq_log_access_ok(struct vhost_dev *d, struct vhost_virtqueue *vq,
  499. void __user *log_base)
  500. {
  501. struct vhost_memory *mp;
  502. size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
  503. mp = rcu_dereference_protected(vq->dev->memory,
  504. lockdep_is_held(&vq->mutex));
  505. return vq_memory_access_ok(log_base, mp,
  506. vhost_has_feature(vq->dev, VHOST_F_LOG_ALL)) &&
  507. (!vq->log_used || log_access_ok(log_base, vq->log_addr,
  508. sizeof *vq->used +
  509. vq->num * sizeof *vq->used->ring + s));
  510. }
  511. /* Can we start vq? */
  512. /* Caller should have vq mutex and device mutex */
  513. int vhost_vq_access_ok(struct vhost_virtqueue *vq)
  514. {
  515. return vq_access_ok(vq->dev, vq->num, vq->desc, vq->avail, vq->used) &&
  516. vq_log_access_ok(vq->dev, vq, vq->log_base);
  517. }
  518. static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
  519. {
  520. struct vhost_memory mem, *newmem, *oldmem;
  521. unsigned long size = offsetof(struct vhost_memory, regions);
  522. if (copy_from_user(&mem, m, size))
  523. return -EFAULT;
  524. if (mem.padding)
  525. return -EOPNOTSUPP;
  526. if (mem.nregions > VHOST_MEMORY_MAX_NREGIONS)
  527. return -E2BIG;
  528. newmem = kmalloc(size + mem.nregions * sizeof *m->regions, GFP_KERNEL);
  529. if (!newmem)
  530. return -ENOMEM;
  531. memcpy(newmem, &mem, size);
  532. if (copy_from_user(newmem->regions, m->regions,
  533. mem.nregions * sizeof *m->regions)) {
  534. kfree(newmem);
  535. return -EFAULT;
  536. }
  537. if (!memory_access_ok(d, newmem,
  538. vhost_has_feature(d, VHOST_F_LOG_ALL))) {
  539. kfree(newmem);
  540. return -EFAULT;
  541. }
  542. oldmem = rcu_dereference_protected(d->memory,
  543. lockdep_is_held(&d->mutex));
  544. rcu_assign_pointer(d->memory, newmem);
  545. synchronize_rcu();
  546. kfree(oldmem);
  547. return 0;
  548. }
  549. static long vhost_set_vring(struct vhost_dev *d, int ioctl, void __user *argp)
  550. {
  551. struct file *eventfp, *filep = NULL,
  552. *pollstart = NULL, *pollstop = NULL;
  553. struct eventfd_ctx *ctx = NULL;
  554. u32 __user *idxp = argp;
  555. struct vhost_virtqueue *vq;
  556. struct vhost_vring_state s;
  557. struct vhost_vring_file f;
  558. struct vhost_vring_addr a;
  559. u32 idx;
  560. long r;
  561. r = get_user(idx, idxp);
  562. if (r < 0)
  563. return r;
  564. if (idx >= d->nvqs)
  565. return -ENOBUFS;
  566. vq = d->vqs + idx;
  567. mutex_lock(&vq->mutex);
  568. switch (ioctl) {
  569. case VHOST_SET_VRING_NUM:
  570. /* Resizing ring with an active backend?
  571. * You don't want to do that. */
  572. if (vq->private_data) {
  573. r = -EBUSY;
  574. break;
  575. }
  576. if (copy_from_user(&s, argp, sizeof s)) {
  577. r = -EFAULT;
  578. break;
  579. }
  580. if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
  581. r = -EINVAL;
  582. break;
  583. }
  584. vq->num = s.num;
  585. break;
  586. case VHOST_SET_VRING_BASE:
  587. /* Moving base with an active backend?
  588. * You don't want to do that. */
  589. if (vq->private_data) {
  590. r = -EBUSY;
  591. break;
  592. }
  593. if (copy_from_user(&s, argp, sizeof s)) {
  594. r = -EFAULT;
  595. break;
  596. }
  597. if (s.num > 0xffff) {
  598. r = -EINVAL;
  599. break;
  600. }
  601. vq->last_avail_idx = s.num;
  602. /* Forget the cached index value. */
  603. vq->avail_idx = vq->last_avail_idx;
  604. break;
  605. case VHOST_GET_VRING_BASE:
  606. s.index = idx;
  607. s.num = vq->last_avail_idx;
  608. if (copy_to_user(argp, &s, sizeof s))
  609. r = -EFAULT;
  610. break;
  611. case VHOST_SET_VRING_ADDR:
  612. if (copy_from_user(&a, argp, sizeof a)) {
  613. r = -EFAULT;
  614. break;
  615. }
  616. if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
  617. r = -EOPNOTSUPP;
  618. break;
  619. }
  620. /* For 32bit, verify that the top 32bits of the user
  621. data are set to zero. */
  622. if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
  623. (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
  624. (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
  625. r = -EFAULT;
  626. break;
  627. }
  628. if ((a.avail_user_addr & (sizeof *vq->avail->ring - 1)) ||
  629. (a.used_user_addr & (sizeof *vq->used->ring - 1)) ||
  630. (a.log_guest_addr & (sizeof *vq->used->ring - 1))) {
  631. r = -EINVAL;
  632. break;
  633. }
  634. /* We only verify access here if backend is configured.
  635. * If it is not, we don't as size might not have been setup.
  636. * We will verify when backend is configured. */
  637. if (vq->private_data) {
  638. if (!vq_access_ok(d, vq->num,
  639. (void __user *)(unsigned long)a.desc_user_addr,
  640. (void __user *)(unsigned long)a.avail_user_addr,
  641. (void __user *)(unsigned long)a.used_user_addr)) {
  642. r = -EINVAL;
  643. break;
  644. }
  645. /* Also validate log access for used ring if enabled. */
  646. if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
  647. !log_access_ok(vq->log_base, a.log_guest_addr,
  648. sizeof *vq->used +
  649. vq->num * sizeof *vq->used->ring)) {
  650. r = -EINVAL;
  651. break;
  652. }
  653. }
  654. vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
  655. vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
  656. vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
  657. vq->log_addr = a.log_guest_addr;
  658. vq->used = (void __user *)(unsigned long)a.used_user_addr;
  659. break;
  660. case VHOST_SET_VRING_KICK:
  661. if (copy_from_user(&f, argp, sizeof f)) {
  662. r = -EFAULT;
  663. break;
  664. }
  665. eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
  666. if (IS_ERR(eventfp)) {
  667. r = PTR_ERR(eventfp);
  668. break;
  669. }
  670. if (eventfp != vq->kick) {
  671. pollstop = filep = vq->kick;
  672. pollstart = vq->kick = eventfp;
  673. } else
  674. filep = eventfp;
  675. break;
  676. case VHOST_SET_VRING_CALL:
  677. if (copy_from_user(&f, argp, sizeof f)) {
  678. r = -EFAULT;
  679. break;
  680. }
  681. eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
  682. if (IS_ERR(eventfp)) {
  683. r = PTR_ERR(eventfp);
  684. break;
  685. }
  686. if (eventfp != vq->call) {
  687. filep = vq->call;
  688. ctx = vq->call_ctx;
  689. vq->call = eventfp;
  690. vq->call_ctx = eventfp ?
  691. eventfd_ctx_fileget(eventfp) : NULL;
  692. } else
  693. filep = eventfp;
  694. break;
  695. case VHOST_SET_VRING_ERR:
  696. if (copy_from_user(&f, argp, sizeof f)) {
  697. r = -EFAULT;
  698. break;
  699. }
  700. eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
  701. if (IS_ERR(eventfp)) {
  702. r = PTR_ERR(eventfp);
  703. break;
  704. }
  705. if (eventfp != vq->error) {
  706. filep = vq->error;
  707. vq->error = eventfp;
  708. ctx = vq->error_ctx;
  709. vq->error_ctx = eventfp ?
  710. eventfd_ctx_fileget(eventfp) : NULL;
  711. } else
  712. filep = eventfp;
  713. break;
  714. default:
  715. r = -ENOIOCTLCMD;
  716. }
  717. if (pollstop && vq->handle_kick)
  718. vhost_poll_stop(&vq->poll);
  719. if (ctx)
  720. eventfd_ctx_put(ctx);
  721. if (filep)
  722. fput(filep);
  723. if (pollstart && vq->handle_kick)
  724. vhost_poll_start(&vq->poll, vq->kick);
  725. mutex_unlock(&vq->mutex);
  726. if (pollstop && vq->handle_kick)
  727. vhost_poll_flush(&vq->poll);
  728. return r;
  729. }
  730. /* Caller must have device mutex */
  731. long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, unsigned long arg)
  732. {
  733. void __user *argp = (void __user *)arg;
  734. struct file *eventfp, *filep = NULL;
  735. struct eventfd_ctx *ctx = NULL;
  736. u64 p;
  737. long r;
  738. int i, fd;
  739. /* If you are not the owner, you can become one */
  740. if (ioctl == VHOST_SET_OWNER) {
  741. r = vhost_dev_set_owner(d);
  742. goto done;
  743. }
  744. /* You must be the owner to do anything else */
  745. r = vhost_dev_check_owner(d);
  746. if (r)
  747. goto done;
  748. switch (ioctl) {
  749. case VHOST_SET_MEM_TABLE:
  750. r = vhost_set_memory(d, argp);
  751. break;
  752. case VHOST_SET_LOG_BASE:
  753. if (copy_from_user(&p, argp, sizeof p)) {
  754. r = -EFAULT;
  755. break;
  756. }
  757. if ((u64)(unsigned long)p != p) {
  758. r = -EFAULT;
  759. break;
  760. }
  761. for (i = 0; i < d->nvqs; ++i) {
  762. struct vhost_virtqueue *vq;
  763. void __user *base = (void __user *)(unsigned long)p;
  764. vq = d->vqs + i;
  765. mutex_lock(&vq->mutex);
  766. /* If ring is inactive, will check when it's enabled. */
  767. if (vq->private_data && !vq_log_access_ok(d, vq, base))
  768. r = -EFAULT;
  769. else
  770. vq->log_base = base;
  771. mutex_unlock(&vq->mutex);
  772. }
  773. break;
  774. case VHOST_SET_LOG_FD:
  775. r = get_user(fd, (int __user *)argp);
  776. if (r < 0)
  777. break;
  778. eventfp = fd == -1 ? NULL : eventfd_fget(fd);
  779. if (IS_ERR(eventfp)) {
  780. r = PTR_ERR(eventfp);
  781. break;
  782. }
  783. if (eventfp != d->log_file) {
  784. filep = d->log_file;
  785. ctx = d->log_ctx;
  786. d->log_ctx = eventfp ?
  787. eventfd_ctx_fileget(eventfp) : NULL;
  788. } else
  789. filep = eventfp;
  790. for (i = 0; i < d->nvqs; ++i) {
  791. mutex_lock(&d->vqs[i].mutex);
  792. d->vqs[i].log_ctx = d->log_ctx;
  793. mutex_unlock(&d->vqs[i].mutex);
  794. }
  795. if (ctx)
  796. eventfd_ctx_put(ctx);
  797. if (filep)
  798. fput(filep);
  799. break;
  800. default:
  801. r = vhost_set_vring(d, ioctl, argp);
  802. break;
  803. }
  804. done:
  805. return r;
  806. }
  807. static const struct vhost_memory_region *find_region(struct vhost_memory *mem,
  808. __u64 addr, __u32 len)
  809. {
  810. struct vhost_memory_region *reg;
  811. int i;
  812. /* linear search is not brilliant, but we really have on the order of 6
  813. * regions in practice */
  814. for (i = 0; i < mem->nregions; ++i) {
  815. reg = mem->regions + i;
  816. if (reg->guest_phys_addr <= addr &&
  817. reg->guest_phys_addr + reg->memory_size - 1 >= addr)
  818. return reg;
  819. }
  820. return NULL;
  821. }
  822. /* TODO: This is really inefficient. We need something like get_user()
  823. * (instruction directly accesses the data, with an exception table entry
  824. * returning -EFAULT). See Documentation/x86/exception-tables.txt.
  825. */
  826. static int set_bit_to_user(int nr, void __user *addr)
  827. {
  828. unsigned long log = (unsigned long)addr;
  829. struct page *page;
  830. void *base;
  831. int bit = nr + (log % PAGE_SIZE) * 8;
  832. int r;
  833. r = get_user_pages_fast(log, 1, 1, &page);
  834. if (r < 0)
  835. return r;
  836. BUG_ON(r != 1);
  837. base = kmap_atomic(page);
  838. set_bit(bit, base);
  839. kunmap_atomic(base);
  840. set_page_dirty_lock(page);
  841. put_page(page);
  842. return 0;
  843. }
  844. static int log_write(void __user *log_base,
  845. u64 write_address, u64 write_length)
  846. {
  847. u64 write_page = write_address / VHOST_PAGE_SIZE;
  848. int r;
  849. if (!write_length)
  850. return 0;
  851. write_length += write_address % VHOST_PAGE_SIZE;
  852. for (;;) {
  853. u64 base = (u64)(unsigned long)log_base;
  854. u64 log = base + write_page / 8;
  855. int bit = write_page % 8;
  856. if ((u64)(unsigned long)log != log)
  857. return -EFAULT;
  858. r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
  859. if (r < 0)
  860. return r;
  861. if (write_length <= VHOST_PAGE_SIZE)
  862. break;
  863. write_length -= VHOST_PAGE_SIZE;
  864. write_page += 1;
  865. }
  866. return r;
  867. }
  868. int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
  869. unsigned int log_num, u64 len)
  870. {
  871. int i, r;
  872. /* Make sure data written is seen before log. */
  873. smp_wmb();
  874. for (i = 0; i < log_num; ++i) {
  875. u64 l = min(log[i].len, len);
  876. r = log_write(vq->log_base, log[i].addr, l);
  877. if (r < 0)
  878. return r;
  879. len -= l;
  880. if (!len) {
  881. if (vq->log_ctx)
  882. eventfd_signal(vq->log_ctx, 1);
  883. return 0;
  884. }
  885. }
  886. /* Length written exceeds what we have stored. This is a bug. */
  887. BUG();
  888. return 0;
  889. }
  890. static int vhost_update_used_flags(struct vhost_virtqueue *vq)
  891. {
  892. void __user *used;
  893. if (__put_user(vq->used_flags, &vq->used->flags) < 0)
  894. return -EFAULT;
  895. if (unlikely(vq->log_used)) {
  896. /* Make sure the flag is seen before log. */
  897. smp_wmb();
  898. /* Log used flag write. */
  899. used = &vq->used->flags;
  900. log_write(vq->log_base, vq->log_addr +
  901. (used - (void __user *)vq->used),
  902. sizeof vq->used->flags);
  903. if (vq->log_ctx)
  904. eventfd_signal(vq->log_ctx, 1);
  905. }
  906. return 0;
  907. }
  908. static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
  909. {
  910. if (__put_user(vq->avail_idx, vhost_avail_event(vq)))
  911. return -EFAULT;
  912. if (unlikely(vq->log_used)) {
  913. void __user *used;
  914. /* Make sure the event is seen before log. */
  915. smp_wmb();
  916. /* Log avail event write */
  917. used = vhost_avail_event(vq);
  918. log_write(vq->log_base, vq->log_addr +
  919. (used - (void __user *)vq->used),
  920. sizeof *vhost_avail_event(vq));
  921. if (vq->log_ctx)
  922. eventfd_signal(vq->log_ctx, 1);
  923. }
  924. return 0;
  925. }
  926. int vhost_init_used(struct vhost_virtqueue *vq)
  927. {
  928. int r;
  929. if (!vq->private_data)
  930. return 0;
  931. r = vhost_update_used_flags(vq);
  932. if (r)
  933. return r;
  934. vq->signalled_used_valid = false;
  935. return get_user(vq->last_used_idx, &vq->used->idx);
  936. }
  937. static int translate_desc(struct vhost_dev *dev, u64 addr, u32 len,
  938. struct iovec iov[], int iov_size)
  939. {
  940. const struct vhost_memory_region *reg;
  941. struct vhost_memory *mem;
  942. struct iovec *_iov;
  943. u64 s = 0;
  944. int ret = 0;
  945. rcu_read_lock();
  946. mem = rcu_dereference(dev->memory);
  947. while ((u64)len > s) {
  948. u64 size;
  949. if (unlikely(ret >= iov_size)) {
  950. ret = -ENOBUFS;
  951. break;
  952. }
  953. reg = find_region(mem, addr, len);
  954. if (unlikely(!reg)) {
  955. ret = -EFAULT;
  956. break;
  957. }
  958. _iov = iov + ret;
  959. size = reg->memory_size - addr + reg->guest_phys_addr;
  960. _iov->iov_len = min((u64)len, size);
  961. _iov->iov_base = (void __user *)(unsigned long)
  962. (reg->userspace_addr + addr - reg->guest_phys_addr);
  963. s += size;
  964. addr += size;
  965. ++ret;
  966. }
  967. rcu_read_unlock();
  968. return ret;
  969. }
  970. /* Each buffer in the virtqueues is actually a chain of descriptors. This
  971. * function returns the next descriptor in the chain,
  972. * or -1U if we're at the end. */
  973. static unsigned next_desc(struct vring_desc *desc)
  974. {
  975. unsigned int next;
  976. /* If this descriptor says it doesn't chain, we're done. */
  977. if (!(desc->flags & VRING_DESC_F_NEXT))
  978. return -1U;
  979. /* Check they're not leading us off end of descriptors. */
  980. next = desc->next;
  981. /* Make sure compiler knows to grab that: we don't want it changing! */
  982. /* We will use the result as an index in an array, so most
  983. * architectures only need a compiler barrier here. */
  984. read_barrier_depends();
  985. return next;
  986. }
  987. static int get_indirect(struct vhost_dev *dev, struct vhost_virtqueue *vq,
  988. struct iovec iov[], unsigned int iov_size,
  989. unsigned int *out_num, unsigned int *in_num,
  990. struct vhost_log *log, unsigned int *log_num,
  991. struct vring_desc *indirect)
  992. {
  993. struct vring_desc desc;
  994. unsigned int i = 0, count, found = 0;
  995. int ret;
  996. /* Sanity check */
  997. if (unlikely(indirect->len % sizeof desc)) {
  998. vq_err(vq, "Invalid length in indirect descriptor: "
  999. "len 0x%llx not multiple of 0x%zx\n",
  1000. (unsigned long long)indirect->len,
  1001. sizeof desc);
  1002. return -EINVAL;
  1003. }
  1004. ret = translate_desc(dev, indirect->addr, indirect->len, vq->indirect,
  1005. UIO_MAXIOV);
  1006. if (unlikely(ret < 0)) {
  1007. vq_err(vq, "Translation failure %d in indirect.\n", ret);
  1008. return ret;
  1009. }
  1010. /* We will use the result as an address to read from, so most
  1011. * architectures only need a compiler barrier here. */
  1012. read_barrier_depends();
  1013. count = indirect->len / sizeof desc;
  1014. /* Buffers are chained via a 16 bit next field, so
  1015. * we can have at most 2^16 of these. */
  1016. if (unlikely(count > USHRT_MAX + 1)) {
  1017. vq_err(vq, "Indirect buffer length too big: %d\n",
  1018. indirect->len);
  1019. return -E2BIG;
  1020. }
  1021. do {
  1022. unsigned iov_count = *in_num + *out_num;
  1023. if (unlikely(++found > count)) {
  1024. vq_err(vq, "Loop detected: last one at %u "
  1025. "indirect size %u\n",
  1026. i, count);
  1027. return -EINVAL;
  1028. }
  1029. if (unlikely(memcpy_fromiovec((unsigned char *)&desc,
  1030. vq->indirect, sizeof desc))) {
  1031. vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
  1032. i, (size_t)indirect->addr + i * sizeof desc);
  1033. return -EINVAL;
  1034. }
  1035. if (unlikely(desc.flags & VRING_DESC_F_INDIRECT)) {
  1036. vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
  1037. i, (size_t)indirect->addr + i * sizeof desc);
  1038. return -EINVAL;
  1039. }
  1040. ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
  1041. iov_size - iov_count);
  1042. if (unlikely(ret < 0)) {
  1043. vq_err(vq, "Translation failure %d indirect idx %d\n",
  1044. ret, i);
  1045. return ret;
  1046. }
  1047. /* If this is an input descriptor, increment that count. */
  1048. if (desc.flags & VRING_DESC_F_WRITE) {
  1049. *in_num += ret;
  1050. if (unlikely(log)) {
  1051. log[*log_num].addr = desc.addr;
  1052. log[*log_num].len = desc.len;
  1053. ++*log_num;
  1054. }
  1055. } else {
  1056. /* If it's an output descriptor, they're all supposed
  1057. * to come before any input descriptors. */
  1058. if (unlikely(*in_num)) {
  1059. vq_err(vq, "Indirect descriptor "
  1060. "has out after in: idx %d\n", i);
  1061. return -EINVAL;
  1062. }
  1063. *out_num += ret;
  1064. }
  1065. } while ((i = next_desc(&desc)) != -1);
  1066. return 0;
  1067. }
  1068. /* This looks in the virtqueue and for the first available buffer, and converts
  1069. * it to an iovec for convenient access. Since descriptors consist of some
  1070. * number of output then some number of input descriptors, it's actually two
  1071. * iovecs, but we pack them into one and note how many of each there were.
  1072. *
  1073. * This function returns the descriptor number found, or vq->num (which is
  1074. * never a valid descriptor number) if none was found. A negative code is
  1075. * returned on error. */
  1076. int vhost_get_vq_desc(struct vhost_dev *dev, struct vhost_virtqueue *vq,
  1077. struct iovec iov[], unsigned int iov_size,
  1078. unsigned int *out_num, unsigned int *in_num,
  1079. struct vhost_log *log, unsigned int *log_num)
  1080. {
  1081. struct vring_desc desc;
  1082. unsigned int i, head, found = 0;
  1083. u16 last_avail_idx;
  1084. int ret;
  1085. /* Check it isn't doing very strange things with descriptor numbers. */
  1086. last_avail_idx = vq->last_avail_idx;
  1087. if (unlikely(__get_user(vq->avail_idx, &vq->avail->idx))) {
  1088. vq_err(vq, "Failed to access avail idx at %p\n",
  1089. &vq->avail->idx);
  1090. return -EFAULT;
  1091. }
  1092. if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
  1093. vq_err(vq, "Guest moved used index from %u to %u",
  1094. last_avail_idx, vq->avail_idx);
  1095. return -EFAULT;
  1096. }
  1097. /* If there's nothing new since last we looked, return invalid. */
  1098. if (vq->avail_idx == last_avail_idx)
  1099. return vq->num;
  1100. /* Only get avail ring entries after they have been exposed by guest. */
  1101. smp_rmb();
  1102. /* Grab the next descriptor number they're advertising, and increment
  1103. * the index we've seen. */
  1104. if (unlikely(__get_user(head,
  1105. &vq->avail->ring[last_avail_idx % vq->num]))) {
  1106. vq_err(vq, "Failed to read head: idx %d address %p\n",
  1107. last_avail_idx,
  1108. &vq->avail->ring[last_avail_idx % vq->num]);
  1109. return -EFAULT;
  1110. }
  1111. /* If their number is silly, that's an error. */
  1112. if (unlikely(head >= vq->num)) {
  1113. vq_err(vq, "Guest says index %u > %u is available",
  1114. head, vq->num);
  1115. return -EINVAL;
  1116. }
  1117. /* When we start there are none of either input nor output. */
  1118. *out_num = *in_num = 0;
  1119. if (unlikely(log))
  1120. *log_num = 0;
  1121. i = head;
  1122. do {
  1123. unsigned iov_count = *in_num + *out_num;
  1124. if (unlikely(i >= vq->num)) {
  1125. vq_err(vq, "Desc index is %u > %u, head = %u",
  1126. i, vq->num, head);
  1127. return -EINVAL;
  1128. }
  1129. if (unlikely(++found > vq->num)) {
  1130. vq_err(vq, "Loop detected: last one at %u "
  1131. "vq size %u head %u\n",
  1132. i, vq->num, head);
  1133. return -EINVAL;
  1134. }
  1135. ret = __copy_from_user(&desc, vq->desc + i, sizeof desc);
  1136. if (unlikely(ret)) {
  1137. vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
  1138. i, vq->desc + i);
  1139. return -EFAULT;
  1140. }
  1141. if (desc.flags & VRING_DESC_F_INDIRECT) {
  1142. ret = get_indirect(dev, vq, iov, iov_size,
  1143. out_num, in_num,
  1144. log, log_num, &desc);
  1145. if (unlikely(ret < 0)) {
  1146. vq_err(vq, "Failure detected "
  1147. "in indirect descriptor at idx %d\n", i);
  1148. return ret;
  1149. }
  1150. continue;
  1151. }
  1152. ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
  1153. iov_size - iov_count);
  1154. if (unlikely(ret < 0)) {
  1155. vq_err(vq, "Translation failure %d descriptor idx %d\n",
  1156. ret, i);
  1157. return ret;
  1158. }
  1159. if (desc.flags & VRING_DESC_F_WRITE) {
  1160. /* If this is an input descriptor,
  1161. * increment that count. */
  1162. *in_num += ret;
  1163. if (unlikely(log)) {
  1164. log[*log_num].addr = desc.addr;
  1165. log[*log_num].len = desc.len;
  1166. ++*log_num;
  1167. }
  1168. } else {
  1169. /* If it's an output descriptor, they're all supposed
  1170. * to come before any input descriptors. */
  1171. if (unlikely(*in_num)) {
  1172. vq_err(vq, "Descriptor has out after in: "
  1173. "idx %d\n", i);
  1174. return -EINVAL;
  1175. }
  1176. *out_num += ret;
  1177. }
  1178. } while ((i = next_desc(&desc)) != -1);
  1179. /* On success, increment avail index. */
  1180. vq->last_avail_idx++;
  1181. /* Assume notifications from guest are disabled at this point,
  1182. * if they aren't we would need to update avail_event index. */
  1183. BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
  1184. return head;
  1185. }
  1186. /* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
  1187. void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
  1188. {
  1189. vq->last_avail_idx -= n;
  1190. }
  1191. /* After we've used one of their buffers, we tell them about it. We'll then
  1192. * want to notify the guest, using eventfd. */
  1193. int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
  1194. {
  1195. struct vring_used_elem __user *used;
  1196. /* The virtqueue contains a ring of used buffers. Get a pointer to the
  1197. * next entry in that used ring. */
  1198. used = &vq->used->ring[vq->last_used_idx % vq->num];
  1199. if (__put_user(head, &used->id)) {
  1200. vq_err(vq, "Failed to write used id");
  1201. return -EFAULT;
  1202. }
  1203. if (__put_user(len, &used->len)) {
  1204. vq_err(vq, "Failed to write used len");
  1205. return -EFAULT;
  1206. }
  1207. /* Make sure buffer is written before we update index. */
  1208. smp_wmb();
  1209. if (__put_user(vq->last_used_idx + 1, &vq->used->idx)) {
  1210. vq_err(vq, "Failed to increment used idx");
  1211. return -EFAULT;
  1212. }
  1213. if (unlikely(vq->log_used)) {
  1214. /* Make sure data is seen before log. */
  1215. smp_wmb();
  1216. /* Log used ring entry write. */
  1217. log_write(vq->log_base,
  1218. vq->log_addr +
  1219. ((void __user *)used - (void __user *)vq->used),
  1220. sizeof *used);
  1221. /* Log used index update. */
  1222. log_write(vq->log_base,
  1223. vq->log_addr + offsetof(struct vring_used, idx),
  1224. sizeof vq->used->idx);
  1225. if (vq->log_ctx)
  1226. eventfd_signal(vq->log_ctx, 1);
  1227. }
  1228. vq->last_used_idx++;
  1229. /* If the driver never bothers to signal in a very long while,
  1230. * used index might wrap around. If that happens, invalidate
  1231. * signalled_used index we stored. TODO: make sure driver
  1232. * signals at least once in 2^16 and remove this. */
  1233. if (unlikely(vq->last_used_idx == vq->signalled_used))
  1234. vq->signalled_used_valid = false;
  1235. return 0;
  1236. }
  1237. static int __vhost_add_used_n(struct vhost_virtqueue *vq,
  1238. struct vring_used_elem *heads,
  1239. unsigned count)
  1240. {
  1241. struct vring_used_elem __user *used;
  1242. u16 old, new;
  1243. int start;
  1244. start = vq->last_used_idx % vq->num;
  1245. used = vq->used->ring + start;
  1246. if (__copy_to_user(used, heads, count * sizeof *used)) {
  1247. vq_err(vq, "Failed to write used");
  1248. return -EFAULT;
  1249. }
  1250. if (unlikely(vq->log_used)) {
  1251. /* Make sure data is seen before log. */
  1252. smp_wmb();
  1253. /* Log used ring entry write. */
  1254. log_write(vq->log_base,
  1255. vq->log_addr +
  1256. ((void __user *)used - (void __user *)vq->used),
  1257. count * sizeof *used);
  1258. }
  1259. old = vq->last_used_idx;
  1260. new = (vq->last_used_idx += count);
  1261. /* If the driver never bothers to signal in a very long while,
  1262. * used index might wrap around. If that happens, invalidate
  1263. * signalled_used index we stored. TODO: make sure driver
  1264. * signals at least once in 2^16 and remove this. */
  1265. if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
  1266. vq->signalled_used_valid = false;
  1267. return 0;
  1268. }
  1269. /* After we've used one of their buffers, we tell them about it. We'll then
  1270. * want to notify the guest, using eventfd. */
  1271. int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
  1272. unsigned count)
  1273. {
  1274. int start, n, r;
  1275. start = vq->last_used_idx % vq->num;
  1276. n = vq->num - start;
  1277. if (n < count) {
  1278. r = __vhost_add_used_n(vq, heads, n);
  1279. if (r < 0)
  1280. return r;
  1281. heads += n;
  1282. count -= n;
  1283. }
  1284. r = __vhost_add_used_n(vq, heads, count);
  1285. /* Make sure buffer is written before we update index. */
  1286. smp_wmb();
  1287. if (put_user(vq->last_used_idx, &vq->used->idx)) {
  1288. vq_err(vq, "Failed to increment used idx");
  1289. return -EFAULT;
  1290. }
  1291. if (unlikely(vq->log_used)) {
  1292. /* Log used index update. */
  1293. log_write(vq->log_base,
  1294. vq->log_addr + offsetof(struct vring_used, idx),
  1295. sizeof vq->used->idx);
  1296. if (vq->log_ctx)
  1297. eventfd_signal(vq->log_ctx, 1);
  1298. }
  1299. return r;
  1300. }
  1301. static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
  1302. {
  1303. __u16 old, new, event;
  1304. bool v;
  1305. /* Flush out used index updates. This is paired
  1306. * with the barrier that the Guest executes when enabling
  1307. * interrupts. */
  1308. smp_mb();
  1309. if (vhost_has_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
  1310. unlikely(vq->avail_idx == vq->last_avail_idx))
  1311. return true;
  1312. if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
  1313. __u16 flags;
  1314. if (__get_user(flags, &vq->avail->flags)) {
  1315. vq_err(vq, "Failed to get flags");
  1316. return true;
  1317. }
  1318. return !(flags & VRING_AVAIL_F_NO_INTERRUPT);
  1319. }
  1320. old = vq->signalled_used;
  1321. v = vq->signalled_used_valid;
  1322. new = vq->signalled_used = vq->last_used_idx;
  1323. vq->signalled_used_valid = true;
  1324. if (unlikely(!v))
  1325. return true;
  1326. if (get_user(event, vhost_used_event(vq))) {
  1327. vq_err(vq, "Failed to get used event idx");
  1328. return true;
  1329. }
  1330. return vring_need_event(event, new, old);
  1331. }
  1332. /* This actually signals the guest, using eventfd. */
  1333. void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
  1334. {
  1335. /* Signal the Guest tell them we used something up. */
  1336. if (vq->call_ctx && vhost_notify(dev, vq))
  1337. eventfd_signal(vq->call_ctx, 1);
  1338. }
  1339. /* And here's the combo meal deal. Supersize me! */
  1340. void vhost_add_used_and_signal(struct vhost_dev *dev,
  1341. struct vhost_virtqueue *vq,
  1342. unsigned int head, int len)
  1343. {
  1344. vhost_add_used(vq, head, len);
  1345. vhost_signal(dev, vq);
  1346. }
  1347. /* multi-buffer version of vhost_add_used_and_signal */
  1348. void vhost_add_used_and_signal_n(struct vhost_dev *dev,
  1349. struct vhost_virtqueue *vq,
  1350. struct vring_used_elem *heads, unsigned count)
  1351. {
  1352. vhost_add_used_n(vq, heads, count);
  1353. vhost_signal(dev, vq);
  1354. }
  1355. /* OK, now we need to know about added descriptors. */
  1356. bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
  1357. {
  1358. u16 avail_idx;
  1359. int r;
  1360. if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
  1361. return false;
  1362. vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
  1363. if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
  1364. r = vhost_update_used_flags(vq);
  1365. if (r) {
  1366. vq_err(vq, "Failed to enable notification at %p: %d\n",
  1367. &vq->used->flags, r);
  1368. return false;
  1369. }
  1370. } else {
  1371. r = vhost_update_avail_event(vq, vq->avail_idx);
  1372. if (r) {
  1373. vq_err(vq, "Failed to update avail event index at %p: %d\n",
  1374. vhost_avail_event(vq), r);
  1375. return false;
  1376. }
  1377. }
  1378. /* They could have slipped one in as we were doing that: make
  1379. * sure it's written, then check again. */
  1380. smp_mb();
  1381. r = __get_user(avail_idx, &vq->avail->idx);
  1382. if (r) {
  1383. vq_err(vq, "Failed to check avail idx at %p: %d\n",
  1384. &vq->avail->idx, r);
  1385. return false;
  1386. }
  1387. return avail_idx != vq->avail_idx;
  1388. }
  1389. /* We don't need to be notified again. */
  1390. void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
  1391. {
  1392. int r;
  1393. if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
  1394. return;
  1395. vq->used_flags |= VRING_USED_F_NO_NOTIFY;
  1396. if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
  1397. r = vhost_update_used_flags(vq);
  1398. if (r)
  1399. vq_err(vq, "Failed to enable notification at %p: %d\n",
  1400. &vq->used->flags, r);
  1401. }
  1402. }
  1403. static void vhost_zerocopy_done_signal(struct kref *kref)
  1404. {
  1405. struct vhost_ubuf_ref *ubufs = container_of(kref, struct vhost_ubuf_ref,
  1406. kref);
  1407. wake_up(&ubufs->wait);
  1408. }
  1409. struct vhost_ubuf_ref *vhost_ubuf_alloc(struct vhost_virtqueue *vq,
  1410. bool zcopy)
  1411. {
  1412. struct vhost_ubuf_ref *ubufs;
  1413. /* No zero copy backend? Nothing to count. */
  1414. if (!zcopy)
  1415. return NULL;
  1416. ubufs = kmalloc(sizeof *ubufs, GFP_KERNEL);
  1417. if (!ubufs)
  1418. return ERR_PTR(-ENOMEM);
  1419. kref_init(&ubufs->kref);
  1420. init_waitqueue_head(&ubufs->wait);
  1421. ubufs->vq = vq;
  1422. return ubufs;
  1423. }
  1424. void vhost_ubuf_put(struct vhost_ubuf_ref *ubufs)
  1425. {
  1426. kref_put(&ubufs->kref, vhost_zerocopy_done_signal);
  1427. }
  1428. void vhost_ubuf_put_and_wait(struct vhost_ubuf_ref *ubufs)
  1429. {
  1430. kref_put(&ubufs->kref, vhost_zerocopy_done_signal);
  1431. wait_event(ubufs->wait, !atomic_read(&ubufs->kref.refcount));
  1432. kfree(ubufs);
  1433. }
  1434. void vhost_zerocopy_callback(void *arg)
  1435. {
  1436. struct ubuf_info *ubuf = arg;
  1437. struct vhost_ubuf_ref *ubufs = ubuf->arg;
  1438. struct vhost_virtqueue *vq = ubufs->vq;
  1439. /* set len = 1 to mark this desc buffers done DMA */
  1440. vq->heads[ubuf->desc].len = VHOST_DMA_DONE_LEN;
  1441. kref_put(&ubufs->kref, vhost_zerocopy_done_signal);
  1442. }