dpdk: remove support for dpdk 16.04
[vpp.git] / vnet / vnet / devices / virtio / vhost-user.c
1 /*
2  *------------------------------------------------------------------
3  * vhost.c - vhost-user
4  *
5  * Copyright (c) 2014 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19
20 #include <fcntl.h>              /* for open */
21 #include <sys/ioctl.h>
22 #include <sys/socket.h>
23 #include <sys/un.h>
24 #include <sys/stat.h>
25 #include <sys/types.h>
26 #include <sys/uio.h>            /* for iovec */
27 #include <netinet/in.h>
28 #include <sys/vfs.h>
29
30 #include <linux/if_arp.h>
31 #include <linux/if_tun.h>
32
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
35
36 #include <vnet/ip/ip.h>
37
38 #include <vnet/ethernet/ethernet.h>
39
40 #include <vnet/devices/virtio/vhost-user.h>
41
42 #define VHOST_USER_DEBUG_SOCKET 0
43 #define VHOST_USER_DEBUG_VQ 0
44
45 /* Set to get virtio_net_hdr in buffer pre-data
46    details will be shown in  packet trace */
47 #define VHOST_USER_COPY_TX_HDR 0
48
49 #if VHOST_USER_DEBUG_SOCKET == 1
50 #define DBG_SOCK(args...) clib_warning(args);
51 #else
52 #define DBG_SOCK(args...)
53 #endif
54
55 #if VHOST_USER_DEBUG_VQ == 1
56 #define DBG_VQ(args...) clib_warning(args);
57 #else
58 #define DBG_VQ(args...)
59 #endif
60
61 vlib_node_registration_t vhost_user_input_node;
62
63 #define foreach_vhost_user_tx_func_error      \
64   _(NONE, "no error")  \
65   _(NOT_READY, "vhost user state error")  \
66   _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)")  \
67   _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)")  \
68   _(MMAP_FAIL, "mmap failure") \
69   _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
70
71 typedef enum
72 {
73 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
74   foreach_vhost_user_tx_func_error
75 #undef _
76     VHOST_USER_TX_FUNC_N_ERROR,
77 } vhost_user_tx_func_error_t;
78
79 static char *vhost_user_tx_func_error_strings[] = {
80 #define _(n,s) s,
81   foreach_vhost_user_tx_func_error
82 #undef _
83 };
84
85 #define foreach_vhost_user_input_func_error      \
86   _(NO_ERROR, "no error")  \
87   _(NO_BUFFER, "no available buffer")  \
88   _(MMAP_FAIL, "mmap failure")  \
89   _(INDIRECT_OVERFLOW, "indirect descriptor overflows table")  \
90   _(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
91   _(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")
92
93 typedef enum
94 {
95 #define _(f,s) VHOST_USER_INPUT_FUNC_ERROR_##f,
96   foreach_vhost_user_input_func_error
97 #undef _
98     VHOST_USER_INPUT_FUNC_N_ERROR,
99 } vhost_user_input_func_error_t;
100
101 static char *vhost_user_input_func_error_strings[] = {
102 #define _(n,s) s,
103   foreach_vhost_user_input_func_error
104 #undef _
105 };
106
107 /* *INDENT-OFF* */
108 static vhost_user_main_t vhost_user_main = {
109   .mtu_bytes = 1518,
110 };
111
112 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
113   .name = "vhost-user",
114 };
115 /* *INDENT-ON* */
116
117 static u8 *
118 format_vhost_user_interface_name (u8 * s, va_list * args)
119 {
120   u32 i = va_arg (*args, u32);
121   u32 show_dev_instance = ~0;
122   vhost_user_main_t *vum = &vhost_user_main;
123
124   if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
125     show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
126
127   if (show_dev_instance != ~0)
128     i = show_dev_instance;
129
130   s = format (s, "VirtualEthernet0/0/%d", i);
131   return s;
132 }
133
134 static int
135 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
136 {
137   vhost_user_main_t *vum = &vhost_user_main;
138
139   vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
140                            hi->dev_instance, ~0);
141
142   vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
143     new_dev_instance;
144
145   DBG_SOCK ("renumbered vhost-user interface dev_instance %d to %d",
146             hi->dev_instance, new_dev_instance);
147
148   return 0;
149 }
150
151 static_always_inline void *
152 map_guest_mem (vhost_user_intf_t * vui, uword addr, u32 * hint)
153 {
154   int i = *hint;
155   if (PREDICT_TRUE ((vui->regions[i].guest_phys_addr <= addr) &&
156                     ((vui->regions[i].guest_phys_addr +
157                       vui->regions[i].memory_size) > addr)))
158     {
159       return (void *) (vui->region_mmap_addr[i] + addr -
160                        vui->regions[i].guest_phys_addr);
161     }
162 #if __SSE4_2__
163   __m128i rl, rh, al, ah, r;
164   al = _mm_set1_epi64x (addr + 1);
165   ah = _mm_set1_epi64x (addr);
166
167   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[0]);
168   rl = _mm_cmpgt_epi64 (al, rl);
169   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[0]);
170   rh = _mm_cmpgt_epi64 (rh, ah);
171   r = _mm_and_si128 (rl, rh);
172
173   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[2]);
174   rl = _mm_cmpgt_epi64 (al, rl);
175   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[2]);
176   rh = _mm_cmpgt_epi64 (rh, ah);
177   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x22);
178
179   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[4]);
180   rl = _mm_cmpgt_epi64 (al, rl);
181   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[4]);
182   rh = _mm_cmpgt_epi64 (rh, ah);
183   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x44);
184
185   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[6]);
186   rl = _mm_cmpgt_epi64 (al, rl);
187   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[6]);
188   rh = _mm_cmpgt_epi64 (rh, ah);
189   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x88);
190
191   r = _mm_shuffle_epi8 (r, _mm_set_epi64x (0, 0x0e060c040a020800));
192   i = __builtin_ctzll (_mm_movemask_epi8 (r));
193
194   if (i < vui->nregions)
195     {
196       *hint = i;
197       return (void *) (vui->region_mmap_addr[i] + addr -
198                        vui->regions[i].guest_phys_addr);
199     }
200
201 #else
202   for (i = 0; i < vui->nregions; i++)
203     {
204       if ((vui->regions[i].guest_phys_addr <= addr) &&
205           ((vui->regions[i].guest_phys_addr + vui->regions[i].memory_size) >
206            addr))
207         {
208           *hint = i;
209           return (void *) (vui->region_mmap_addr[i] + addr -
210                            vui->regions[i].guest_phys_addr);
211         }
212     }
213 #endif
214   DBG_VQ ("failed to map guest mem addr %llx", addr);
215   *hint = 0;
216   return 0;
217 }
218
219 static inline void *
220 map_user_mem (vhost_user_intf_t * vui, uword addr)
221 {
222   int i;
223   for (i = 0; i < vui->nregions; i++)
224     {
225       if ((vui->regions[i].userspace_addr <= addr) &&
226           ((vui->regions[i].userspace_addr + vui->regions[i].memory_size) >
227            addr))
228         {
229           return (void *) (vui->region_mmap_addr[i] + addr -
230                            vui->regions[i].userspace_addr);
231         }
232     }
233   return 0;
234 }
235
236 static long
237 get_huge_page_size (int fd)
238 {
239   struct statfs s;
240   fstatfs (fd, &s);
241   return s.f_bsize;
242 }
243
244 static void
245 unmap_all_mem_regions (vhost_user_intf_t * vui)
246 {
247   int i, r;
248   for (i = 0; i < vui->nregions; i++)
249     {
250       if (vui->region_mmap_addr[i] != (void *) -1)
251         {
252
253           long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
254
255           ssize_t map_sz = (vui->regions[i].memory_size +
256                             vui->regions[i].mmap_offset +
257                             page_sz) & ~(page_sz - 1);
258
259           r =
260             munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
261                     map_sz);
262
263           DBG_SOCK
264             ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
265              vui->region_mmap_addr[i], map_sz, page_sz);
266
267           vui->region_mmap_addr[i] = (void *) -1;
268
269           if (r == -1)
270             {
271               clib_warning ("failed to unmap memory region (errno %d)",
272                             errno);
273             }
274           close (vui->region_mmap_fd[i]);
275         }
276     }
277   vui->nregions = 0;
278 }
279
280
281 static clib_error_t *
282 vhost_user_callfd_read_ready (unix_file_t * uf)
283 {
284   __attribute__ ((unused)) int n;
285   u8 buff[8];
286   n = read (uf->file_descriptor, ((char *) &buff), 8);
287   return 0;
288 }
289
290 static inline void
291 vhost_user_if_disconnect (vhost_user_intf_t * vui)
292 {
293   vhost_user_main_t *vum = &vhost_user_main;
294   vnet_main_t *vnm = vnet_get_main ();
295   int q;
296
297   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
298
299   if (vui->unix_file_index != ~0)
300     {
301       unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
302       vui->unix_file_index = ~0;
303     }
304   else
305     close (vui->unix_fd);
306
307   hash_unset (vum->vhost_user_interface_index_by_sock_fd, vui->unix_fd);
308   hash_unset (vum->vhost_user_interface_index_by_listener_fd, vui->unix_fd);
309   vui->unix_fd = -1;
310   vui->is_up = 0;
311   for (q = 0; q < vui->num_vrings; q++)
312     {
313       if (vui->vrings[q].callfd > -1)
314         {
315           unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
316                                                vui->vrings[q].callfd_idx);
317           unix_file_del (&unix_main, uf);
318         }
319
320       if (vui->vrings[q].kickfd > -1)
321         close (vui->vrings[q].kickfd);
322
323       vui->vrings[q].callfd = -1;
324       vui->vrings[q].kickfd = -1;
325       vui->vrings[q].desc = NULL;
326       vui->vrings[q].avail = NULL;
327       vui->vrings[q].used = NULL;
328       vui->vrings[q].log_guest_addr = 0;
329       vui->vrings[q].log_used = 0;
330     }
331
332   unmap_all_mem_regions (vui);
333   DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
334 }
335
336 #define VHOST_LOG_PAGE 0x1000
337 always_inline void
338 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
339 {
340   if (PREDICT_TRUE (vui->log_base_addr == 0
341                     || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
342     {
343       return;
344     }
345   if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
346     {
347       DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
348       return;
349     }
350
351   CLIB_MEMORY_BARRIER ();
352   u64 page = addr / VHOST_LOG_PAGE;
353   while (page * VHOST_LOG_PAGE < addr + len)
354     {
355       ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
356       page++;
357     }
358 }
359
360 #define vhost_user_log_dirty_ring(vui, vq, member) \
361   if (PREDICT_FALSE(vq->log_used)) { \
362     vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
363                              sizeof(vq->used->member)); \
364   }
365
366 static clib_error_t *
367 vhost_user_socket_read (unix_file_t * uf)
368 {
369   int n, i;
370   int fd, number_of_fds = 0;
371   int fds[VHOST_MEMORY_MAX_NREGIONS];
372   vhost_user_msg_t msg;
373   struct msghdr mh;
374   struct iovec iov[1];
375   vhost_user_main_t *vum = &vhost_user_main;
376   vhost_user_intf_t *vui;
377   struct cmsghdr *cmsg;
378   uword *p;
379   u8 q;
380   unix_file_t template = { 0 };
381   vnet_main_t *vnm = vnet_get_main ();
382
383   p = hash_get (vum->vhost_user_interface_index_by_sock_fd,
384                 uf->file_descriptor);
385   if (p == 0)
386     {
387       DBG_SOCK ("FD %d doesn't belong to any interface", uf->file_descriptor);
388       return 0;
389     }
390   else
391     vui = vec_elt_at_index (vum->vhost_user_interfaces, p[0]);
392
393   char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
394
395   memset (&mh, 0, sizeof (mh));
396   memset (control, 0, sizeof (control));
397
398   for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
399     fds[i] = -1;
400
401   /* set the payload */
402   iov[0].iov_base = (void *) &msg;
403   iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
404
405   mh.msg_iov = iov;
406   mh.msg_iovlen = 1;
407   mh.msg_control = control;
408   mh.msg_controllen = sizeof (control);
409
410   n = recvmsg (uf->file_descriptor, &mh, 0);
411
412   if (n != VHOST_USER_MSG_HDR_SZ)
413     goto close_socket;
414
415   if (mh.msg_flags & MSG_CTRUNC)
416     {
417       goto close_socket;
418     }
419
420   cmsg = CMSG_FIRSTHDR (&mh);
421
422   if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
423       (cmsg->cmsg_type == SCM_RIGHTS) &&
424       (cmsg->cmsg_len - CMSG_LEN (0) <=
425        VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
426     {
427       number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
428       clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
429     }
430
431   /* version 1, no reply bit set */
432   if ((msg.flags & 7) != 1)
433     {
434       DBG_SOCK ("malformed message received. closing socket");
435       goto close_socket;
436     }
437
438   {
439     int rv __attribute__ ((unused));
440     /* $$$$ pay attention to rv */
441     rv = read (uf->file_descriptor, ((char *) &msg) + n, msg.size);
442   }
443
444   switch (msg.request)
445     {
446     case VHOST_USER_GET_FEATURES:
447       DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES", vui->hw_if_index);
448
449       msg.flags |= 4;
450       msg.u64 = (1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
451         (1 << FEAT_VIRTIO_F_ANY_LAYOUT) |
452         (1 << FEAT_VIRTIO_F_INDIRECT_DESC) |
453         (1 << FEAT_VHOST_F_LOG_ALL) |
454         (1 << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
455         (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
456         (1UL << FEAT_VIRTIO_F_VERSION_1);
457       msg.u64 &= vui->feature_mask;
458
459       msg.size = sizeof (msg.u64);
460       break;
461
462     case VHOST_USER_SET_FEATURES:
463       DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
464                 vui->hw_if_index, msg.u64);
465
466       vui->features = msg.u64;
467
468       if (vui->features & (1 << FEAT_VIRTIO_NET_F_MRG_RXBUF))
469         vui->virtio_net_hdr_sz = 12;
470       else
471         vui->virtio_net_hdr_sz = 10;
472
473       vui->is_any_layout =
474         (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
475
476       ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
477       vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
478       vui->is_up = 0;
479
480       for (q = 0; q < 2; q++)
481         {
482           vui->vrings[q].desc = 0;
483           vui->vrings[q].avail = 0;
484           vui->vrings[q].used = 0;
485           vui->vrings[q].log_guest_addr = 0;
486           vui->vrings[q].log_used = 0;
487         }
488
489       DBG_SOCK ("interface %d disconnected", vui->sw_if_index);
490
491       break;
492
493     case VHOST_USER_SET_MEM_TABLE:
494       DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
495                 vui->hw_if_index, msg.memory.nregions);
496
497       if ((msg.memory.nregions < 1) ||
498           (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
499         {
500
501           DBG_SOCK ("number of mem regions must be between 1 and %i",
502                     VHOST_MEMORY_MAX_NREGIONS);
503
504           goto close_socket;
505         }
506
507       if (msg.memory.nregions != number_of_fds)
508         {
509           DBG_SOCK ("each memory region must have FD");
510           goto close_socket;
511         }
512       unmap_all_mem_regions (vui);
513       for (i = 0; i < msg.memory.nregions; i++)
514         {
515           clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
516                        sizeof (vhost_user_memory_region_t));
517
518           long page_sz = get_huge_page_size (fds[i]);
519
520           /* align size to 2M page */
521           ssize_t map_sz = (vui->regions[i].memory_size +
522                             vui->regions[i].mmap_offset +
523                             page_sz) & ~(page_sz - 1);
524
525           vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
526                                            MAP_SHARED, fds[i], 0);
527           vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
528           vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
529             vui->regions[i].memory_size;
530
531           DBG_SOCK
532             ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
533              "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
534              page_sz);
535
536           if (vui->region_mmap_addr[i] == MAP_FAILED)
537             {
538               clib_warning ("failed to map memory. errno is %d", errno);
539               goto close_socket;
540             }
541           vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
542           vui->region_mmap_fd[i] = fds[i];
543         }
544       vui->nregions = msg.memory.nregions;
545       break;
546
547     case VHOST_USER_SET_VRING_NUM:
548       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
549                 vui->hw_if_index, msg.state.index, msg.state.num);
550
551       if ((msg.state.num > 32768) ||    /* maximum ring size is 32768 */
552           (msg.state.num == 0) ||       /* it cannot be zero */
553           (msg.state.num % 2))  /* must be power of 2 */
554         goto close_socket;
555       vui->vrings[msg.state.index].qsz = msg.state.num;
556       break;
557
558     case VHOST_USER_SET_VRING_ADDR:
559       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
560                 vui->hw_if_index, msg.state.index);
561
562       vui->vrings[msg.state.index].desc = (vring_desc_t *)
563         map_user_mem (vui, msg.addr.desc_user_addr);
564       vui->vrings[msg.state.index].used = (vring_used_t *)
565         map_user_mem (vui, msg.addr.used_user_addr);
566       vui->vrings[msg.state.index].avail = (vring_avail_t *)
567         map_user_mem (vui, msg.addr.avail_user_addr);
568
569       if ((vui->vrings[msg.state.index].desc == NULL) ||
570           (vui->vrings[msg.state.index].used == NULL) ||
571           (vui->vrings[msg.state.index].avail == NULL))
572         {
573           DBG_SOCK ("failed to map user memory for hw_if_index %d",
574                     vui->hw_if_index);
575           goto close_socket;
576         }
577
578       vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
579       vui->vrings[msg.state.index].log_used =
580         (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
581
582       /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
583          the ring is initialized in an enabled state. */
584
585       if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
586         {
587           vui->vrings[msg.state.index].enabled = 1;
588         }
589
590       vui->vrings[msg.state.index].last_used_idx =
591         vui->vrings[msg.state.index].last_avail_idx =
592         vui->vrings[msg.state.index].used->idx;
593
594       /* tell driver that we don't want interrupts */
595       vui->vrings[msg.state.index].used->flags |= 1;
596       break;
597
598     case VHOST_USER_SET_OWNER:
599       DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
600       break;
601
602     case VHOST_USER_RESET_OWNER:
603       DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
604       break;
605
606     case VHOST_USER_SET_VRING_CALL:
607       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL u64 %d",
608                 vui->hw_if_index, msg.u64);
609
610       q = (u8) (msg.u64 & 0xFF);
611
612       if (!(msg.u64 & 0x100))
613         {
614           if (number_of_fds != 1)
615             goto close_socket;
616
617           /* if there is old fd, delete it */
618           if (vui->vrings[q].callfd > -1)
619             {
620               unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
621                                                    vui->vrings[q].callfd_idx);
622               unix_file_del (&unix_main, uf);
623             }
624           vui->vrings[q].callfd = fds[0];
625           template.read_function = vhost_user_callfd_read_ready;
626           template.file_descriptor = fds[0];
627           vui->vrings[q].callfd_idx = unix_file_add (&unix_main, &template);
628         }
629       else
630         vui->vrings[q].callfd = -1;
631       break;
632
633     case VHOST_USER_SET_VRING_KICK:
634       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK u64 %d",
635                 vui->hw_if_index, msg.u64);
636
637       q = (u8) (msg.u64 & 0xFF);
638
639       if (!(msg.u64 & 0x100))
640         {
641           if (number_of_fds != 1)
642             goto close_socket;
643
644           if (vui->vrings[q].kickfd > -1)
645             close (vui->vrings[q].kickfd);
646
647           vui->vrings[q].kickfd = fds[0];
648         }
649       else
650         vui->vrings[q].kickfd = -1;
651       break;
652
653     case VHOST_USER_SET_VRING_ERR:
654       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR u64 %d",
655                 vui->hw_if_index, msg.u64);
656
657       q = (u8) (msg.u64 & 0xFF);
658
659       if (!(msg.u64 & 0x100))
660         {
661           if (number_of_fds != 1)
662             goto close_socket;
663
664           fd = fds[0];
665         }
666       else
667         fd = -1;
668
669       vui->vrings[q].errfd = fd;
670       break;
671
672     case VHOST_USER_SET_VRING_BASE:
673       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
674                 vui->hw_if_index, msg.state.index, msg.state.num);
675
676       vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
677       break;
678
679     case VHOST_USER_GET_VRING_BASE:
680       DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
681                 vui->hw_if_index, msg.state.index, msg.state.num);
682
683       /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
684       vui->vrings[msg.state.index].enabled = 0;
685
686       msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
687       msg.flags |= 4;
688       msg.size = sizeof (msg.state);
689       break;
690
691     case VHOST_USER_NONE:
692       DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
693
694       break;
695
696     case VHOST_USER_SET_LOG_BASE:
697       {
698         DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
699
700         if (msg.size != sizeof (msg.log))
701           {
702             DBG_SOCK
703               ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
704                msg.size, sizeof (msg.log));
705             goto close_socket;
706           }
707
708         if (!
709             (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
710           {
711             DBG_SOCK
712               ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
713             goto close_socket;
714           }
715
716         fd = fds[0];
717         /* align size to 2M page */
718         long page_sz = get_huge_page_size (fd);
719         ssize_t map_sz =
720           (msg.log.size + msg.log.offset + page_sz) & ~(page_sz - 1);
721
722         vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
723                                    MAP_SHARED, fd, 0);
724
725         DBG_SOCK
726           ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
727            map_sz, msg.log.offset, fd, vui->log_base_addr);
728
729         if (vui->log_base_addr == MAP_FAILED)
730           {
731             clib_warning ("failed to map memory. errno is %d", errno);
732             goto close_socket;
733           }
734
735         vui->log_base_addr += msg.log.offset;
736         vui->log_size = msg.log.size;
737
738         msg.flags |= 4;
739         msg.size = sizeof (msg.u64);
740
741         break;
742       }
743
744     case VHOST_USER_SET_LOG_FD:
745       DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
746
747       break;
748
749     case VHOST_USER_GET_PROTOCOL_FEATURES:
750       DBG_SOCK ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
751                 vui->hw_if_index);
752
753       msg.flags |= 4;
754       msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD);
755       msg.size = sizeof (msg.u64);
756       break;
757
758     case VHOST_USER_SET_PROTOCOL_FEATURES:
759       DBG_SOCK ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%lx",
760                 vui->hw_if_index, msg.u64);
761
762       vui->protocol_features = msg.u64;
763
764       break;
765
766     case VHOST_USER_SET_VRING_ENABLE:
767       DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE, enable: %d",
768                 vui->hw_if_index, msg.state.num);
769       vui->vrings[msg.state.index].enabled = msg.state.num;
770       break;
771
772     default:
773       DBG_SOCK ("unknown vhost-user message %d received. closing socket",
774                 msg.request);
775       goto close_socket;
776     }
777
778   /* if we have pointers to descriptor table, go up */
779   if (!vui->is_up &&
780       vui->vrings[VHOST_NET_VRING_IDX_TX].desc &&
781       vui->vrings[VHOST_NET_VRING_IDX_RX].desc)
782     {
783
784       DBG_SOCK ("interface %d connected", vui->sw_if_index);
785
786       vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
787                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
788       vui->is_up = 1;
789
790     }
791
792   /* if we need to reply */
793   if (msg.flags & 4)
794     {
795       n =
796         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
797       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
798         goto close_socket;
799     }
800
801   return 0;
802
803 close_socket:
804   vhost_user_if_disconnect (vui);
805   return 0;
806 }
807
808 static clib_error_t *
809 vhost_user_socket_error (unix_file_t * uf)
810 {
811   vhost_user_main_t *vum = &vhost_user_main;
812   vhost_user_intf_t *vui;
813   uword *p;
814
815   p = hash_get (vum->vhost_user_interface_index_by_sock_fd,
816                 uf->file_descriptor);
817   if (p == 0)
818     {
819       DBG_SOCK ("fd %d doesn't belong to any interface", uf->file_descriptor);
820       return 0;
821     }
822   else
823     vui = vec_elt_at_index (vum->vhost_user_interfaces, p[0]);
824
825   vhost_user_if_disconnect (vui);
826   return 0;
827 }
828
829 static clib_error_t *
830 vhost_user_socksvr_accept_ready (unix_file_t * uf)
831 {
832   int client_fd, client_len;
833   struct sockaddr_un client;
834   unix_file_t template = { 0 };
835   vhost_user_main_t *vum = &vhost_user_main;
836   vhost_user_intf_t *vui;
837   uword *p;
838
839   p = hash_get (vum->vhost_user_interface_index_by_listener_fd,
840                 uf->file_descriptor);
841   if (p == 0)
842     {
843       DBG_SOCK ("fd %d doesn't belong to any interface", uf->file_descriptor);
844       return 0;
845     }
846   else
847     vui = vec_elt_at_index (vum->vhost_user_interfaces, p[0]);
848
849   client_len = sizeof (client);
850   client_fd = accept (uf->file_descriptor,
851                       (struct sockaddr *) &client,
852                       (socklen_t *) & client_len);
853
854   if (client_fd < 0)
855     return clib_error_return_unix (0, "accept");
856
857   template.read_function = vhost_user_socket_read;
858   template.error_function = vhost_user_socket_error;
859   template.file_descriptor = client_fd;
860   vui->unix_file_index = unix_file_add (&unix_main, &template);
861
862   vui->client_fd = client_fd;
863   hash_set (vum->vhost_user_interface_index_by_sock_fd, vui->client_fd,
864             vui - vum->vhost_user_interfaces);
865
866   return 0;
867 }
868
869 static clib_error_t *
870 vhost_user_init (vlib_main_t * vm)
871 {
872   clib_error_t *error;
873   vhost_user_main_t *vum = &vhost_user_main;
874   vlib_thread_main_t *tm = vlib_get_thread_main ();
875   vlib_thread_registration_t *tr;
876   uword *p;
877
878   error = vlib_call_init_function (vm, ip4_init);
879   if (error)
880     return error;
881
882   vum->vhost_user_interface_index_by_listener_fd =
883     hash_create (0, sizeof (uword));
884   vum->vhost_user_interface_index_by_sock_fd =
885     hash_create (0, sizeof (uword));
886   vum->vhost_user_interface_index_by_sw_if_index =
887     hash_create (0, sizeof (uword));
888   vum->coalesce_frames = 32;
889   vum->coalesce_time = 1e-3;
890
891   vec_validate_aligned (vum->rx_buffers, tm->n_vlib_mains - 1,
892                         CLIB_CACHE_LINE_BYTES);
893
894   /* find out which cpus will be used for input */
895   vum->input_cpu_first_index = 0;
896   vum->input_cpu_count = 1;
897   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
898   tr = p ? (vlib_thread_registration_t *) p[0] : 0;
899
900   if (tr && tr->count > 0)
901     {
902       vum->input_cpu_first_index = tr->first_index;
903       vum->input_cpu_count = tr->count;
904     }
905
906   return 0;
907 }
908
909 VLIB_INIT_FUNCTION (vhost_user_init);
910
911 static clib_error_t *
912 vhost_user_exit (vlib_main_t * vm)
913 {
914   /* TODO cleanup */
915   return 0;
916 }
917
918 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
919
920 enum
921 {
922   VHOST_USER_RX_NEXT_ETHERNET_INPUT,
923   VHOST_USER_RX_NEXT_DROP,
924   VHOST_USER_RX_N_NEXT,
925 };
926
927
928 typedef struct
929 {
930   u16 virtqueue;
931   u16 device_index;
932 #if VHOST_USER_COPY_TX_HDR == 1
933   virtio_net_hdr_t hdr;
934 #endif
935 } vhost_user_input_trace_t;
936
937 static u8 *
938 format_vhost_user_input_trace (u8 * s, va_list * va)
939 {
940   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
941   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
942   CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
943   vhost_user_main_t *vum = &vhost_user_main;
944   vhost_user_input_trace_t *t = va_arg (*va, vhost_user_input_trace_t *);
945   vhost_user_intf_t *vui = vec_elt_at_index (vum->vhost_user_interfaces,
946                                              t->device_index);
947
948   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
949
950 #if VHOST_USER_COPY_TX_HDR == 1
951   uword indent = format_get_indent (s);
952 #endif
953
954   s = format (s, "%U virtqueue %d",
955               format_vnet_sw_interface_name, vnm, sw, t->virtqueue);
956
957 #if VHOST_USER_COPY_TX_HDR == 1
958   s = format (s, "\n%Uvirtio_net_hdr flags 0x%02x gso_type %u hdr_len %u",
959               format_white_space, indent,
960               t->hdr.flags, t->hdr.gso_type, t->hdr.hdr_len);
961 #endif
962
963   return s;
964 }
965
966 void
967 vhost_user_rx_trace (vlib_main_t * vm,
968                      vlib_node_runtime_t * node,
969                      vhost_user_intf_t * vui, i16 virtqueue)
970 {
971   u32 *b, n_left;
972   vhost_user_main_t *vum = &vhost_user_main;
973
974   u32 next_index = VHOST_USER_RX_NEXT_ETHERNET_INPUT;
975
976   n_left = vec_len (vui->d_trace_buffers);
977   b = vui->d_trace_buffers;
978
979   while (n_left >= 1)
980     {
981       u32 bi0;
982       vlib_buffer_t *b0;
983       vhost_user_input_trace_t *t0;
984
985       bi0 = b[0];
986       n_left -= 1;
987
988       b0 = vlib_get_buffer (vm, bi0);
989       vlib_trace_buffer (vm, node, next_index, b0, /* follow_chain */ 0);
990       t0 = vlib_add_trace (vm, node, b0, sizeof (t0[0]));
991       t0->virtqueue = virtqueue;
992       t0->device_index = vui - vum->vhost_user_interfaces;
993 #if VHOST_USER_COPY_TX_HDR == 1
994       clib_memcpy (&t0->hdr, b0->pre_data, sizeof (virtio_net_hdr_t));
995 #endif
996
997       b += 1;
998     }
999 }
1000
1001 static inline void
1002 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1003 {
1004   vhost_user_main_t *vum = &vhost_user_main;
1005   u64 x = 1;
1006   int rv __attribute__ ((unused));
1007   /* $$$$ pay attention to rv */
1008   rv = write (vq->callfd, &x, sizeof (x));
1009   vq->n_since_last_int = 0;
1010   vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1011 }
1012
1013
1014 static u32
1015 vhost_user_if_input (vlib_main_t * vm,
1016                      vhost_user_main_t * vum,
1017                      vhost_user_intf_t * vui, vlib_node_runtime_t * node)
1018 {
1019   vhost_user_vring_t *txvq = &vui->vrings[VHOST_NET_VRING_IDX_TX];
1020   vhost_user_vring_t *rxvq = &vui->vrings[VHOST_NET_VRING_IDX_RX];
1021   uword n_rx_packets = 0, n_rx_bytes = 0;
1022   uword n_left;
1023   u32 n_left_to_next, *to_next;
1024   u32 next_index = 0;
1025   u32 next0;
1026   uword n_trace = vlib_get_trace_count (vm, node);
1027   u16 qsz_mask;
1028   u32 cpu_index, rx_len, drops, flush;
1029   f64 now = vlib_time_now (vm);
1030   u32 map_guest_hint_desc = 0;
1031   u32 map_guest_hint_indirect = 0;
1032   u32 *map_guest_hint_p = &map_guest_hint_desc;
1033
1034   vec_reset_length (vui->d_trace_buffers);
1035
1036   /* no descriptor ptr - bail out */
1037   if (PREDICT_FALSE (!txvq->desc || !txvq->avail || !txvq->enabled))
1038     return 0;
1039
1040   /* do we have pending intterupts ? */
1041   if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1042     vhost_user_send_call (vm, txvq);
1043
1044   if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1045     vhost_user_send_call (vm, rxvq);
1046
1047   /* only bit 0 of avail.flags is used so we don't want to deal with this
1048      interface if any other bit is set */
1049   if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1050     return 0;
1051
1052   n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1053
1054   /* nothing to do */
1055   if (PREDICT_FALSE (n_left == 0))
1056     return 0;
1057
1058   if (PREDICT_FALSE (n_left == txvq->qsz))
1059     {
1060       //Informational error logging when VPP is not receiving packets fast enough
1061       vlib_error_count (vm, node->node_index,
1062                         VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1063     }
1064
1065   if (PREDICT_FALSE (!vui->admin_up))
1066     {
1067       /* if intf is admin down, just drop all packets waiting in the ring */
1068       txvq->last_avail_idx = txvq->last_used_idx = txvq->avail->idx;
1069       CLIB_MEMORY_BARRIER ();
1070       txvq->used->idx = txvq->last_used_idx;
1071       vhost_user_log_dirty_ring (vui, txvq, idx);
1072       vhost_user_send_call (vm, txvq);
1073       return 0;
1074     }
1075
1076   qsz_mask = txvq->qsz - 1;
1077   cpu_index = os_get_cpu_number ();
1078   drops = 0;
1079   flush = 0;
1080
1081   if (n_left > VLIB_FRAME_SIZE)
1082     n_left = VLIB_FRAME_SIZE;
1083
1084   /* Allocate some buffers.
1085    * Note that buffers that are chained for jumbo
1086    * frames are allocated separately using a slower path.
1087    * The idea is to be certain to have enough buffers at least
1088    * to cycle through the descriptors without having to check for errors.
1089    * For jumbo frames, the bottleneck is memory copy anyway.
1090    */
1091   if (PREDICT_FALSE (!vum->rx_buffers[cpu_index]))
1092     {
1093       vec_alloc (vum->rx_buffers[cpu_index], 2 * VLIB_FRAME_SIZE);
1094
1095       if (PREDICT_FALSE (!vum->rx_buffers[cpu_index]))
1096         flush = n_left;         //Drop all input
1097     }
1098
1099   if (PREDICT_FALSE (_vec_len (vum->rx_buffers[cpu_index]) < n_left))
1100     {
1101       u32 curr_len = _vec_len (vum->rx_buffers[cpu_index]);
1102       _vec_len (vum->rx_buffers[cpu_index]) +=
1103         vlib_buffer_alloc_from_free_list (vm,
1104                                           vum->rx_buffers[cpu_index] +
1105                                           curr_len,
1106                                           2 * VLIB_FRAME_SIZE - curr_len,
1107                                           VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1108
1109       if (PREDICT_FALSE (n_left > _vec_len (vum->rx_buffers[cpu_index])))
1110         flush = n_left - _vec_len (vum->rx_buffers[cpu_index]);
1111     }
1112
1113   if (PREDICT_FALSE (flush))
1114     {
1115       //Remove some input buffers
1116       drops += flush;
1117       n_left -= flush;
1118       vlib_error_count (vm, vhost_user_input_node.index,
1119                         VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1120       while (flush)
1121         {
1122           u16 desc_chain_head =
1123             txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1124           txvq->last_avail_idx++;
1125           txvq->used->ring[txvq->last_used_idx & qsz_mask].id =
1126             desc_chain_head;
1127           txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1128           vhost_user_log_dirty_ring (vui, txvq,
1129                                      ring[txvq->last_used_idx & qsz_mask]);
1130           txvq->last_used_idx++;
1131           flush--;
1132         }
1133     }
1134
1135   rx_len = vec_len (vum->rx_buffers[cpu_index]);        //vector might be null
1136   while (n_left > 0)
1137     {
1138       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1139
1140       while (n_left > 0 && n_left_to_next > 0)
1141         {
1142           vlib_buffer_t *b_head, *b_current;
1143           u32 bi_head, bi_current;
1144           u16 desc_chain_head, desc_current;
1145           u8 error = VHOST_USER_INPUT_FUNC_ERROR_NO_ERROR;
1146
1147           if (PREDICT_TRUE (n_left > 1))
1148             {
1149               u32 next_desc =
1150                 txvq->avail->ring[(txvq->last_avail_idx + 1) & qsz_mask];
1151               void *buffer_addr =
1152                 map_guest_mem (vui, txvq->desc[next_desc].addr,
1153                                &map_guest_hint_desc);
1154               if (PREDICT_TRUE (buffer_addr != 0))
1155                 CLIB_PREFETCH (buffer_addr, 64, STORE);
1156
1157               u32 bi = vum->rx_buffers[cpu_index][rx_len - 2];
1158               vlib_prefetch_buffer_with_index (vm, bi, STORE);
1159               CLIB_PREFETCH (vlib_get_buffer (vm, bi)->data, 128, STORE);
1160             }
1161
1162           desc_chain_head = desc_current =
1163             txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1164           bi_head = bi_current = vum->rx_buffers[cpu_index][--rx_len];
1165           b_head = b_current = vlib_get_buffer (vm, bi_head);
1166           vlib_buffer_chain_init (b_head);
1167
1168           uword offset;
1169           if (PREDICT_TRUE (vui->is_any_layout) ||
1170               (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1171                !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)))
1172             {
1173               /* ANYLAYOUT or single buffer */
1174               offset = vui->virtio_net_hdr_sz;
1175             }
1176           else
1177             {
1178               /* CSR case without ANYLAYOUT, skip 1st buffer */
1179               offset = txvq->desc[desc_current].len;
1180             }
1181
1182           vring_desc_t *desc_table = txvq->desc;
1183           u32 desc_index = desc_current;
1184           map_guest_hint_p = &map_guest_hint_desc;
1185
1186           if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1187             {
1188               desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1189                                           &map_guest_hint_desc);
1190               desc_index = 0;
1191               map_guest_hint_p = &map_guest_hint_indirect;
1192               if (PREDICT_FALSE (desc_table == 0))
1193                 {
1194                   error = VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL;
1195                   goto out;
1196                 }
1197             }
1198
1199           while (1)
1200             {
1201               void *buffer_addr =
1202                 map_guest_mem (vui, desc_table[desc_index].addr,
1203                                map_guest_hint_p);
1204               if (PREDICT_FALSE (buffer_addr == 0))
1205                 {
1206                   error = VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL;
1207                   goto out;
1208                 }
1209
1210               if (PREDICT_TRUE
1211                   (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT))
1212                 {
1213                   CLIB_PREFETCH (&desc_table[desc_table[desc_index].next],
1214                                  sizeof (vring_desc_t), STORE);
1215                 }
1216
1217 #if VHOST_USER_COPY_TX_HDR == 1
1218               if (PREDICT_TRUE (offset))
1219                 clib_memcpy (b->pre_data, buffer_addr, sizeof (virtio_net_hdr_t));      /* 12 byte hdr is not used on tx */
1220 #endif
1221
1222               if (desc_table[desc_index].len > offset)
1223                 {
1224                   u16 len = desc_table[desc_index].len - offset;
1225                   u16 copied = vlib_buffer_chain_append_data_with_alloc (vm,
1226                                                                          VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX,
1227                                                                          b_head,
1228                                                                          &b_current,
1229                                                                          buffer_addr
1230                                                                          +
1231                                                                          offset,
1232                                                                          len);
1233                   if (copied != len)
1234                     {
1235                       error = VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER;
1236                       break;
1237                     }
1238                 }
1239               offset = 0;
1240
1241               /* if next flag is set, take next desc in the chain */
1242               if ((desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT))
1243                 desc_index = desc_table[desc_index].next;
1244               else
1245                 goto out;
1246             }
1247         out:
1248
1249           /* consume the descriptor and return it as used */
1250           txvq->last_avail_idx++;
1251           txvq->used->ring[txvq->last_used_idx & qsz_mask].id =
1252             desc_chain_head;
1253           txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1254           vhost_user_log_dirty_ring (vui, txvq,
1255                                      ring[txvq->last_used_idx & qsz_mask]);
1256           txvq->last_used_idx++;
1257
1258           //It is important to free RX as fast as possible such that the TX
1259           //process does not drop packets
1260           if ((txvq->last_used_idx & 0x3f) == 0)        // Every 64 packets
1261             txvq->used->idx = txvq->last_used_idx;
1262
1263           if (PREDICT_FALSE (b_head->current_length < 14 &&
1264                              error == VHOST_USER_INPUT_FUNC_ERROR_NO_ERROR))
1265             error = VHOST_USER_INPUT_FUNC_ERROR_UNDERSIZED_FRAME;
1266
1267           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1268
1269           vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1270           vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1271           b_head->error = node->errors[error];
1272
1273           if (PREDICT_FALSE (n_trace > n_rx_packets))
1274             vec_add1 (vui->d_trace_buffers, bi_head);
1275
1276           if (PREDICT_FALSE (error))
1277             {
1278               drops++;
1279               next0 = VHOST_USER_RX_NEXT_DROP;
1280             }
1281           else
1282             {
1283               n_rx_bytes +=
1284                 b_head->current_length +
1285                 b_head->total_length_not_including_first_buffer;
1286               n_rx_packets++;
1287               next0 = VHOST_USER_RX_NEXT_ETHERNET_INPUT;
1288             }
1289
1290           to_next[0] = bi_head;
1291           to_next++;
1292           n_left_to_next--;
1293           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1294                                            to_next, n_left_to_next,
1295                                            bi_head, next0);
1296           n_left--;
1297         }
1298
1299       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1300
1301     }
1302
1303   if (PREDICT_TRUE (vum->rx_buffers[cpu_index] != 0))
1304     _vec_len (vum->rx_buffers[cpu_index]) = rx_len;
1305
1306   /* give buffers back to driver */
1307   CLIB_MEMORY_BARRIER ();
1308   txvq->used->idx = txvq->last_used_idx;
1309   vhost_user_log_dirty_ring (vui, txvq, idx);
1310
1311   if (PREDICT_FALSE (vec_len (vui->d_trace_buffers) > 0))
1312     {
1313       vhost_user_rx_trace (vm, node, vui, VHOST_NET_VRING_IDX_TX);
1314       vlib_set_trace_count (vm, node,
1315                             n_trace - vec_len (vui->d_trace_buffers));
1316     }
1317
1318   /* interrupt (call) handling */
1319   if ((txvq->callfd > -1) && !(txvq->avail->flags & 1))
1320     {
1321       txvq->n_since_last_int += n_rx_packets;
1322
1323       if (txvq->n_since_last_int > vum->coalesce_frames)
1324         vhost_user_send_call (vm, txvq);
1325     }
1326
1327   if (PREDICT_FALSE (drops))
1328     {
1329       vlib_increment_simple_counter
1330         (vnet_main.interface_main.sw_if_counters
1331          + VNET_INTERFACE_COUNTER_DROP, os_get_cpu_number (),
1332          vui->sw_if_index, drops);
1333     }
1334
1335   /* increase rx counters */
1336   vlib_increment_combined_counter
1337     (vnet_main.interface_main.combined_sw_if_counters
1338      + VNET_INTERFACE_COUNTER_RX,
1339      os_get_cpu_number (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1340
1341   return n_rx_packets;
1342 }
1343
1344 static uword
1345 vhost_user_input (vlib_main_t * vm,
1346                   vlib_node_runtime_t * node, vlib_frame_t * f)
1347 {
1348   vhost_user_main_t *vum = &vhost_user_main;
1349   u32 cpu_index = os_get_cpu_number ();
1350   vhost_user_intf_t *vui;
1351   uword n_rx_packets = 0;
1352   int i;
1353
1354   for (i = 0; i < vec_len (vum->vhost_user_interfaces); i++)
1355     {
1356       vui = vec_elt_at_index (vum->vhost_user_interfaces, i);
1357       if (vui->is_up)
1358         {
1359           if ((i % vum->input_cpu_count) ==
1360               (cpu_index - vum->input_cpu_first_index))
1361             n_rx_packets += vhost_user_if_input (vm, vum, vui, node);
1362         }
1363     }
1364   return n_rx_packets;
1365 }
1366
1367 /* *INDENT-OFF* */
1368 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1369   .function = vhost_user_input,
1370   .type = VLIB_NODE_TYPE_INPUT,
1371   .name = "vhost-user-input",
1372
1373   /* Will be enabled if/when hardware is detected. */
1374   .state = VLIB_NODE_STATE_DISABLED,
1375
1376   .format_buffer = format_ethernet_header_with_length,
1377   .format_trace = format_vhost_user_input_trace,
1378
1379   .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1380   .error_strings = vhost_user_input_func_error_strings,
1381
1382   .n_next_nodes = VHOST_USER_RX_N_NEXT,
1383   .next_nodes = {
1384     [VHOST_USER_RX_NEXT_DROP] = "error-drop",
1385     [VHOST_USER_RX_NEXT_ETHERNET_INPUT] = "ethernet-input",
1386   },
1387 };
1388
1389 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
1390 /* *INDENT-ON* */
1391
1392 static uword
1393 vhost_user_intfc_tx (vlib_main_t * vm,
1394                      vlib_node_runtime_t * node, vlib_frame_t * frame)
1395 {
1396   u32 *buffers = vlib_frame_args (frame);
1397   u32 n_left = 0;
1398   vhost_user_main_t *vum = &vhost_user_main;
1399   uword n_packets = 0;
1400   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
1401   vhost_user_intf_t *vui =
1402     vec_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
1403   vhost_user_vring_t *rxvq = &vui->vrings[VHOST_NET_VRING_IDX_RX];
1404   u16 qsz_mask;
1405   u8 error = VHOST_USER_TX_FUNC_ERROR_NONE;
1406
1407   n_left = n_packets = frame->n_vectors;
1408   u32 map_guest_hint_desc = 0;
1409   u32 map_guest_hint_indirect = 0;
1410   u32 *map_guest_hint_p = &map_guest_hint_desc;
1411
1412   if (PREDICT_FALSE (!vui->is_up))
1413     goto done2;
1414
1415   if (PREDICT_FALSE
1416       (!rxvq->desc || !rxvq->avail || vui->sock_errno != 0 || !rxvq->enabled))
1417     {
1418       error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
1419       goto done2;
1420     }
1421
1422   if (PREDICT_FALSE (vui->lockp != 0))
1423     {
1424       while (__sync_lock_test_and_set (vui->lockp, 1))
1425         ;
1426     }
1427
1428   /* only bit 0 of avail.flags is used so we don't want to deal with this
1429      interface if any other bit is set */
1430   if (PREDICT_FALSE (rxvq->avail->flags & 0xFFFE))
1431     {
1432       error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
1433       goto done2;
1434     }
1435
1436   if (PREDICT_FALSE ((rxvq->avail->idx == rxvq->last_avail_idx)))
1437     {
1438       error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
1439       goto done2;
1440     }
1441
1442   qsz_mask = rxvq->qsz - 1;     /* qsz is always power of 2 */
1443
1444   while (n_left > 0)
1445     {
1446       vlib_buffer_t *b0, *current_b0;
1447       u16 desc_head, desc_index, desc_len;
1448       vring_desc_t *desc_table;
1449       void *buffer_addr;
1450       u32 buffer_len;
1451
1452       b0 = vlib_get_buffer (vm, buffers[0]);
1453       buffers++;
1454
1455       if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
1456         {
1457           error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
1458           goto done;
1459         }
1460
1461       desc_table = rxvq->desc;
1462       map_guest_hint_p = &map_guest_hint_desc;
1463       desc_head = desc_index =
1464         rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
1465       if (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT)
1466         {
1467           if (PREDICT_FALSE
1468               (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
1469             {
1470               error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
1471               goto done;
1472             }
1473           if (PREDICT_FALSE
1474               (!(desc_table =
1475                  map_guest_mem (vui, rxvq->desc[desc_index].addr,
1476                                 &map_guest_hint_desc))))
1477             {
1478               error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
1479               goto done;
1480             }
1481           desc_index = 0;
1482           map_guest_hint_p = &map_guest_hint_indirect;
1483         }
1484
1485       desc_len = vui->virtio_net_hdr_sz;
1486
1487       if (PREDICT_FALSE
1488           (!(buffer_addr =
1489              map_guest_mem (vui, desc_table[desc_index].addr,
1490                             map_guest_hint_p))))
1491         {
1492           error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
1493           goto done;
1494         }
1495       buffer_len = desc_table[desc_index].len;
1496
1497       CLIB_PREFETCH (buffer_addr, CLIB_CACHE_LINE_BYTES, STORE);
1498
1499       virtio_net_hdr_mrg_rxbuf_t *hdr =
1500         (virtio_net_hdr_mrg_rxbuf_t *) buffer_addr;
1501       hdr->hdr.flags = 0;
1502       hdr->hdr.gso_type = 0;
1503       if (vui->virtio_net_hdr_sz == 12)
1504         hdr->num_buffers = 1;
1505
1506       vhost_user_log_dirty_pages (vui, desc_table[desc_index].addr,
1507                                   vui->virtio_net_hdr_sz);
1508
1509       u16 bytes_left = b0->current_length;
1510       buffer_addr += vui->virtio_net_hdr_sz;
1511       buffer_len -= vui->virtio_net_hdr_sz;
1512       current_b0 = b0;
1513       while (1)
1514         {
1515           if (!bytes_left)
1516             {                   //Get new input
1517               if (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT)
1518                 {
1519                   current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
1520                   bytes_left = current_b0->current_length;
1521                 }
1522               else
1523                 {
1524                   //End of packet
1525                   break;
1526                 }
1527             }
1528
1529           if (buffer_len == 0)
1530             {                   //Get new output
1531               if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
1532                 {
1533                   //Next one is chained
1534                   desc_index = desc_table[desc_index].next;
1535                   if (PREDICT_FALSE
1536                       (!(buffer_addr =
1537                          map_guest_mem (vui, desc_table[desc_index].addr,
1538                                         map_guest_hint_p))))
1539                     {
1540                       rxvq->last_used_idx -= hdr->num_buffers - 1;
1541                       rxvq->last_avail_idx -= hdr->num_buffers - 1;
1542                       error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
1543                       goto done;
1544                     }
1545                   buffer_len = desc_table[desc_index].len;
1546                 }
1547               else if (vui->virtio_net_hdr_sz == 12)    //MRG is available
1548                 {
1549                   //Move from available to used buffer
1550                   rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id =
1551                     desc_head;
1552                   rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len =
1553                     desc_len;
1554                   vhost_user_log_dirty_ring (vui, rxvq,
1555                                              ring[rxvq->last_used_idx &
1556                                                   qsz_mask]);
1557                   rxvq->last_avail_idx++;
1558                   rxvq->last_used_idx++;
1559                   hdr->num_buffers++;
1560
1561                   if (PREDICT_FALSE
1562                       (rxvq->last_avail_idx == rxvq->avail->idx))
1563                     {
1564                       //Dequeue queued descriptors for this packet
1565                       rxvq->last_used_idx -= hdr->num_buffers - 1;
1566                       rxvq->last_avail_idx -= hdr->num_buffers - 1;
1567                       error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
1568                       goto done;
1569                     }
1570
1571                   desc_table = rxvq->desc;
1572                   map_guest_hint_p = &map_guest_hint_desc;
1573                   desc_head = desc_index =
1574                     rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
1575                   if (PREDICT_FALSE
1576                       (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
1577                     {
1578                       //It is seriously unlikely that a driver will put indirect descriptor
1579                       //after non-indirect descriptor.
1580                       if (PREDICT_FALSE
1581                           (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
1582                         {
1583                           error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
1584                           goto done;
1585                         }
1586                       if (PREDICT_FALSE
1587                           (!(desc_table =
1588                              map_guest_mem (vui,
1589                                             rxvq->desc[desc_index].addr,
1590                                             &map_guest_hint_desc))))
1591                         {
1592                           error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
1593                           goto done;
1594                         }
1595                       desc_index = 0;
1596                       map_guest_hint_p = &map_guest_hint_indirect;
1597                     }
1598
1599                   if (PREDICT_FALSE
1600                       (!(buffer_addr =
1601                          map_guest_mem (vui, desc_table[desc_index].addr,
1602                                         map_guest_hint_p))))
1603                     {
1604                       error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
1605                       goto done;
1606                     }
1607                   buffer_len = desc_table[desc_index].len;
1608                   CLIB_PREFETCH (buffer_addr, CLIB_CACHE_LINE_BYTES, STORE);
1609                 }
1610               else
1611                 {
1612                   error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
1613                   goto done;
1614                 }
1615             }
1616
1617           u16 bytes_to_copy = bytes_left;
1618           bytes_to_copy =
1619             (bytes_to_copy > buffer_len) ? buffer_len : bytes_to_copy;
1620           clib_memcpy (buffer_addr,
1621                        vlib_buffer_get_current (current_b0) +
1622                        current_b0->current_length - bytes_left,
1623                        bytes_to_copy);
1624
1625           vhost_user_log_dirty_pages (vui,
1626                                       desc_table[desc_index].addr +
1627                                       desc_table[desc_index].len -
1628                                       bytes_left - bytes_to_copy,
1629                                       bytes_to_copy);
1630
1631           bytes_left -= bytes_to_copy;
1632           buffer_len -= bytes_to_copy;
1633           buffer_addr += bytes_to_copy;
1634           desc_len += bytes_to_copy;
1635         }
1636
1637       if (PREDICT_TRUE (n_left >= 2))
1638         {
1639           vlib_prefetch_buffer_with_index (vm, buffers[1], STORE);
1640           CLIB_PREFETCH (&n_left, sizeof (n_left), STORE);
1641         }
1642
1643       //Move from available to used ring
1644       rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id = desc_head;
1645       rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len = desc_len;
1646       vhost_user_log_dirty_ring (vui, rxvq,
1647                                  ring[rxvq->last_used_idx & qsz_mask]);
1648
1649       rxvq->last_avail_idx++;
1650       rxvq->last_used_idx++;
1651
1652       n_left--;                 //At the end for error counting when 'goto done' is invoked
1653     }
1654
1655 done:
1656   CLIB_MEMORY_BARRIER ();
1657   rxvq->used->idx = rxvq->last_used_idx;
1658   vhost_user_log_dirty_ring (vui, rxvq, idx);
1659
1660   /* interrupt (call) handling */
1661   if ((rxvq->callfd > -1) && !(rxvq->avail->flags & 1))
1662     {
1663       rxvq->n_since_last_int += n_packets - n_left;
1664
1665       if (rxvq->n_since_last_int > vum->coalesce_frames)
1666         vhost_user_send_call (vm, rxvq);
1667     }
1668
1669 done2:
1670
1671   if (PREDICT_FALSE (vui->lockp != 0))
1672     *vui->lockp = 0;
1673
1674   if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
1675     {
1676       vlib_error_count (vm, node->node_index, error, n_left);
1677       vlib_increment_simple_counter
1678         (vnet_main.interface_main.sw_if_counters
1679          + VNET_INTERFACE_COUNTER_DROP,
1680          os_get_cpu_number (), vui->sw_if_index, n_left);
1681     }
1682
1683   vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
1684   return frame->n_vectors;
1685 }
1686
1687 static clib_error_t *
1688 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
1689                                     u32 flags)
1690 {
1691   vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
1692   uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
1693   vhost_user_main_t *vum = &vhost_user_main;
1694   vhost_user_intf_t *vui =
1695     vec_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
1696
1697   vui->admin_up = is_up;
1698
1699   if (is_up)
1700     vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
1701                                  VNET_HW_INTERFACE_FLAG_LINK_UP);
1702
1703   return /* no error */ 0;
1704 }
1705
1706 /* *INDENT-OFF* */
1707 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
1708   .name = "vhost-user",
1709   .tx_function = vhost_user_intfc_tx,
1710   .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
1711   .tx_function_error_strings = vhost_user_tx_func_error_strings,
1712   .format_device_name = format_vhost_user_interface_name,
1713   .name_renumber = vhost_user_name_renumber,
1714   .admin_up_down_function = vhost_user_interface_admin_up_down,
1715   .no_flatten_output_chains = 1,
1716 };
1717
1718 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
1719                                    vhost_user_intfc_tx)
1720 /* *INDENT-ON* */
1721
1722 static uword
1723 vhost_user_process (vlib_main_t * vm,
1724                     vlib_node_runtime_t * rt, vlib_frame_t * f)
1725 {
1726   vhost_user_main_t *vum = &vhost_user_main;
1727   vhost_user_intf_t *vui;
1728   struct sockaddr_un sun;
1729   int sockfd;
1730   unix_file_t template = { 0 };
1731   f64 timeout = 3153600000.0 /* 100 years */ ;
1732   uword *event_data = 0;
1733
1734   sockfd = socket (AF_UNIX, SOCK_STREAM, 0);
1735   sun.sun_family = AF_UNIX;
1736   template.read_function = vhost_user_socket_read;
1737   template.error_function = vhost_user_socket_error;
1738
1739
1740   if (sockfd < 0)
1741     return 0;
1742
1743   while (1)
1744     {
1745       vlib_process_wait_for_event_or_clock (vm, timeout);
1746       vlib_process_get_events (vm, &event_data);
1747       vec_reset_length (event_data);
1748
1749       timeout = 3.0;
1750
1751       vec_foreach (vui, vum->vhost_user_interfaces)
1752       {
1753
1754         if (vui->sock_is_server || !vui->active)
1755           continue;
1756
1757         if (vui->unix_fd == -1)
1758           {
1759             /* try to connect */
1760
1761             strncpy (sun.sun_path, (char *) vui->sock_filename,
1762                      sizeof (sun.sun_path) - 1);
1763
1764             if (connect
1765                 (sockfd, (struct sockaddr *) &sun,
1766                  sizeof (struct sockaddr_un)) == 0)
1767               {
1768                 vui->sock_errno = 0;
1769                 vui->unix_fd = sockfd;
1770                 template.file_descriptor = sockfd;
1771                 vui->unix_file_index = unix_file_add (&unix_main, &template);
1772                 hash_set (vum->vhost_user_interface_index_by_sock_fd, sockfd,
1773                           vui - vum->vhost_user_interfaces);
1774
1775                 sockfd = socket (AF_UNIX, SOCK_STREAM, 0);
1776                 if (sockfd < 0)
1777                   return 0;
1778               }
1779             else
1780               {
1781                 vui->sock_errno = errno;
1782               }
1783           }
1784         else
1785           {
1786             /* check if socket is alive */
1787             int error = 0;
1788             socklen_t len = sizeof (error);
1789             int retval =
1790               getsockopt (vui->unix_fd, SOL_SOCKET, SO_ERROR, &error, &len);
1791
1792             if (retval)
1793               vhost_user_if_disconnect (vui);
1794           }
1795       }
1796     }
1797   return 0;
1798 }
1799
1800 /* *INDENT-OFF* */
1801 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
1802     .function = vhost_user_process,
1803     .type = VLIB_NODE_TYPE_PROCESS,
1804     .name = "vhost-user-process",
1805 };
1806 /* *INDENT-ON* */
1807
1808 int
1809 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
1810 {
1811   vhost_user_main_t *vum = &vhost_user_main;
1812   vhost_user_intf_t *vui;
1813   uword *p = NULL;
1814   int rv = 0;
1815
1816   p = hash_get (vum->vhost_user_interface_index_by_sw_if_index, sw_if_index);
1817   if (p == 0)
1818     {
1819       return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1820     }
1821   else
1822     {
1823       vui = vec_elt_at_index (vum->vhost_user_interfaces, p[0]);
1824     }
1825
1826   // interface is inactive
1827   vui->active = 0;
1828   // disconnect interface sockets
1829   vhost_user_if_disconnect (vui);
1830   // add to inactive interface list
1831   vec_add1 (vum->vhost_user_inactive_interfaces_index, p[0]);
1832
1833   // reset renumbered iface
1834   if (p[0] < vec_len (vum->show_dev_instance_by_real_dev_instance))
1835     vum->show_dev_instance_by_real_dev_instance[p[0]] = ~0;
1836
1837   ethernet_delete_interface (vnm, vui->hw_if_index);
1838   DBG_SOCK ("deleted (deactivated) vhost-user interface instance %d", p[0]);
1839
1840   return rv;
1841 }
1842
1843 // init server socket on specified sock_filename
1844 static int
1845 vhost_user_init_server_sock (const char *sock_filename, int *sockfd)
1846 {
1847   int rv = 0;
1848   struct sockaddr_un un = { };
1849   int fd;
1850   /* create listening socket */
1851   fd = socket (AF_UNIX, SOCK_STREAM, 0);
1852
1853   if (fd < 0)
1854     {
1855       return VNET_API_ERROR_SYSCALL_ERROR_1;
1856     }
1857
1858   un.sun_family = AF_UNIX;
1859   strncpy ((char *) un.sun_path, (char *) sock_filename,
1860            sizeof (un.sun_path) - 1);
1861
1862   /* remove if exists */
1863   unlink ((char *) sock_filename);
1864
1865   if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
1866     {
1867       rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1868       goto error;
1869     }
1870
1871   if (listen (fd, 1) == -1)
1872     {
1873       rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1874       goto error;
1875     }
1876
1877   unix_file_t template = { 0 };
1878   template.read_function = vhost_user_socksvr_accept_ready;
1879   template.file_descriptor = fd;
1880   unix_file_add (&unix_main, &template);
1881   *sockfd = fd;
1882   return rv;
1883
1884 error:
1885   close (fd);
1886   return rv;
1887 }
1888
1889 // get new vhost_user_intf_t from inactive interfaces or create new one
1890 static vhost_user_intf_t *
1891 vhost_user_vui_new ()
1892 {
1893   vhost_user_main_t *vum = &vhost_user_main;
1894   vhost_user_intf_t *vui = NULL;
1895   int inactive_cnt = vec_len (vum->vhost_user_inactive_interfaces_index);
1896   // if there are any inactive ifaces
1897   if (inactive_cnt > 0)
1898     {
1899       // take last
1900       u32 vui_idx =
1901         vum->vhost_user_inactive_interfaces_index[inactive_cnt - 1];
1902       if (vec_len (vum->vhost_user_interfaces) > vui_idx)
1903         {
1904           vui = vec_elt_at_index (vum->vhost_user_interfaces, vui_idx);
1905           DBG_SOCK ("reusing inactive vhost-user interface index %d",
1906                     vui_idx);
1907         }
1908       // "remove" from inactive list
1909       _vec_len (vum->vhost_user_inactive_interfaces_index) -= 1;
1910     }
1911
1912   // vui was not retrieved from inactive ifaces - create new
1913   if (!vui)
1914     vec_add2 (vum->vhost_user_interfaces, vui, 1);
1915   return vui;
1916 }
1917
1918 // create ethernet interface for vhost user intf
1919 static void
1920 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
1921                             vhost_user_intf_t * vui, u8 * hwaddress)
1922 {
1923   vhost_user_main_t *vum = &vhost_user_main;
1924   u8 hwaddr[6];
1925   clib_error_t *error;
1926
1927   /* create hw and sw interface */
1928   if (hwaddress)
1929     {
1930       clib_memcpy (hwaddr, hwaddress, 6);
1931     }
1932   else
1933     {
1934       f64 now = vlib_time_now (vm);
1935       u32 rnd;
1936       rnd = (u32) (now * 1e6);
1937       rnd = random_u32 (&rnd);
1938
1939       clib_memcpy (hwaddr + 2, &rnd, sizeof (rnd));
1940       hwaddr[0] = 2;
1941       hwaddr[1] = 0xfe;
1942     }
1943
1944   error = ethernet_register_interface
1945     (vnm,
1946      vhost_user_dev_class.index,
1947      vui - vum->vhost_user_interfaces /* device instance */ ,
1948      hwaddr /* ethernet address */ ,
1949      &vui->hw_if_index, 0 /* flag change */ );
1950   if (error)
1951     clib_error_report (error);
1952
1953   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, vui->hw_if_index);
1954   hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
1955 }
1956
1957 // initialize vui with specified attributes
1958 static void
1959 vhost_user_vui_init (vnet_main_t * vnm,
1960                      vhost_user_intf_t * vui, int sockfd,
1961                      const char *sock_filename,
1962                      u8 is_server, u64 feature_mask, u32 * sw_if_index)
1963 {
1964   vnet_sw_interface_t *sw;
1965   sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
1966   vlib_thread_main_t *tm = vlib_get_thread_main ();
1967   int q;
1968
1969   vui->unix_fd = sockfd;
1970   vui->sw_if_index = sw->sw_if_index;
1971   vui->num_vrings = 2;
1972   vui->sock_is_server = is_server;
1973   strncpy (vui->sock_filename, sock_filename,
1974            ARRAY_LEN (vui->sock_filename) - 1);
1975   vui->sock_errno = 0;
1976   vui->is_up = 0;
1977   vui->feature_mask = feature_mask;
1978   vui->active = 1;
1979   vui->unix_file_index = ~0;
1980   vui->log_base_addr = 0;
1981
1982   for (q = 0; q < 2; q++)
1983     {
1984       vui->vrings[q].enabled = 0;
1985       vui->vrings[q].callfd = -1;
1986       vui->vrings[q].kickfd = -1;
1987     }
1988
1989   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
1990
1991   if (sw_if_index)
1992     *sw_if_index = vui->sw_if_index;
1993
1994   if (tm->n_vlib_mains > 1)
1995     {
1996       vui->lockp = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
1997                                            CLIB_CACHE_LINE_BYTES);
1998       memset ((void *) vui->lockp, 0, CLIB_CACHE_LINE_BYTES);
1999     }
2000 }
2001
2002 // register vui and start polling on it
2003 static void
2004 vhost_user_vui_register (vlib_main_t * vm, vhost_user_intf_t * vui)
2005 {
2006   vhost_user_main_t *vum = &vhost_user_main;
2007   int cpu_index;
2008   vlib_thread_main_t *tm = vlib_get_thread_main ();
2009
2010   hash_set (vum->vhost_user_interface_index_by_listener_fd, vui->unix_fd,
2011             vui - vum->vhost_user_interfaces);
2012   hash_set (vum->vhost_user_interface_index_by_sw_if_index, vui->sw_if_index,
2013             vui - vum->vhost_user_interfaces);
2014
2015   /* start polling */
2016   cpu_index = vum->input_cpu_first_index +
2017     (vui - vum->vhost_user_interfaces) % vum->input_cpu_count;
2018
2019   if (tm->n_vlib_mains == 1)
2020     vlib_node_set_state (vm, vhost_user_input_node.index,
2021                          VLIB_NODE_STATE_POLLING);
2022   else
2023     vlib_node_set_state (vlib_mains[cpu_index], vhost_user_input_node.index,
2024                          VLIB_NODE_STATE_POLLING);
2025
2026   /* tell process to start polling for sockets */
2027   vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2028 }
2029
2030 int
2031 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2032                       const char *sock_filename,
2033                       u8 is_server,
2034                       u32 * sw_if_index,
2035                       u64 feature_mask,
2036                       u8 renumber, u32 custom_dev_instance, u8 * hwaddr)
2037 {
2038   vhost_user_intf_t *vui = NULL;
2039   u32 sw_if_idx = ~0;
2040   int sockfd = -1;
2041   int rv = 0;
2042
2043   if (is_server)
2044     {
2045       if ((rv = vhost_user_init_server_sock (sock_filename, &sockfd)) != 0)
2046         {
2047           return rv;
2048         }
2049     }
2050
2051   vui = vhost_user_vui_new ();
2052   ASSERT (vui != NULL);
2053
2054   vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2055   vhost_user_vui_init (vnm, vui, sockfd, sock_filename, is_server,
2056                        feature_mask, &sw_if_idx);
2057
2058   if (renumber)
2059     {
2060       vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2061     }
2062
2063   vhost_user_vui_register (vm, vui);
2064
2065   if (sw_if_index)
2066     *sw_if_index = sw_if_idx;
2067
2068   return rv;
2069 }
2070
2071 int
2072 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2073                       const char *sock_filename,
2074                       u8 is_server,
2075                       u32 sw_if_index,
2076                       u64 feature_mask, u8 renumber, u32 custom_dev_instance)
2077 {
2078   vhost_user_main_t *vum = &vhost_user_main;
2079   vhost_user_intf_t *vui = NULL;
2080   u32 sw_if_idx = ~0;
2081   int sockfd = -1;
2082   int rv = 0;
2083   uword *p = NULL;
2084
2085   p = hash_get (vum->vhost_user_interface_index_by_sw_if_index, sw_if_index);
2086   if (p == 0)
2087     {
2088       return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2089     }
2090   else
2091     {
2092       vui = vec_elt_at_index (vum->vhost_user_interfaces, p[0]);
2093     }
2094
2095   // interface is inactive
2096   vui->active = 0;
2097   // disconnect interface sockets
2098   vhost_user_if_disconnect (vui);
2099
2100   if (is_server)
2101     {
2102       if ((rv = vhost_user_init_server_sock (sock_filename, &sockfd)) != 0)
2103         {
2104           return rv;
2105         }
2106     }
2107
2108   vhost_user_vui_init (vnm, vui, sockfd, sock_filename, is_server,
2109                        feature_mask, &sw_if_idx);
2110
2111   if (renumber)
2112     {
2113       vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2114     }
2115
2116   vhost_user_vui_register (vm, vui);
2117
2118   return rv;
2119 }
2120
2121 clib_error_t *
2122 vhost_user_connect_command_fn (vlib_main_t * vm,
2123                                unformat_input_t * input,
2124                                vlib_cli_command_t * cmd)
2125 {
2126   unformat_input_t _line_input, *line_input = &_line_input;
2127   u8 *sock_filename = NULL;
2128   u32 sw_if_index;
2129   u8 is_server = 0;
2130   u64 feature_mask = (u64) ~ 0;
2131   u8 renumber = 0;
2132   u32 custom_dev_instance = ~0;
2133   u8 hwaddr[6];
2134   u8 *hw = NULL;
2135
2136   /* Get a line of input. */
2137   if (!unformat_user (input, unformat_line_input, line_input))
2138     return 0;
2139
2140   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2141     {
2142       if (unformat (line_input, "socket %s", &sock_filename))
2143         ;
2144       else if (unformat (line_input, "server"))
2145         is_server = 1;
2146       else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
2147         ;
2148       else
2149         if (unformat
2150             (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
2151         hw = hwaddr;
2152       else if (unformat (line_input, "renumber %d", &custom_dev_instance))
2153         {
2154           renumber = 1;
2155         }
2156       else
2157         return clib_error_return (0, "unknown input `%U'",
2158                                   format_unformat_error, input);
2159     }
2160   unformat_free (line_input);
2161
2162   vnet_main_t *vnm = vnet_get_main ();
2163
2164   int rv;
2165   if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
2166                                   is_server, &sw_if_index, feature_mask,
2167                                   renumber, custom_dev_instance, hw)))
2168     {
2169       vec_free (sock_filename);
2170       return clib_error_return (0, "vhost_user_create_if returned %d", rv);
2171     }
2172
2173   vec_free (sock_filename);
2174   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
2175                    sw_if_index);
2176   return 0;
2177 }
2178
2179 clib_error_t *
2180 vhost_user_delete_command_fn (vlib_main_t * vm,
2181                               unformat_input_t * input,
2182                               vlib_cli_command_t * cmd)
2183 {
2184   unformat_input_t _line_input, *line_input = &_line_input;
2185   u32 sw_if_index = ~0;
2186
2187   /* Get a line of input. */
2188   if (!unformat_user (input, unformat_line_input, line_input))
2189     return 0;
2190
2191   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2192     {
2193       if (unformat (line_input, "sw_if_index %d", &sw_if_index))
2194         ;
2195       else
2196         return clib_error_return (0, "unknown input `%U'",
2197                                   format_unformat_error, input);
2198     }
2199   unformat_free (line_input);
2200
2201   vnet_main_t *vnm = vnet_get_main ();
2202
2203   vhost_user_delete_if (vnm, vm, sw_if_index);
2204
2205   return 0;
2206 }
2207
2208 int
2209 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
2210                      vhost_user_intf_details_t ** out_vuids)
2211 {
2212   int rv = 0;
2213   vhost_user_main_t *vum = &vhost_user_main;
2214   vhost_user_intf_t *vui;
2215   vhost_user_intf_details_t *r_vuids = NULL;
2216   vhost_user_intf_details_t *vuid = NULL;
2217   u32 *hw_if_indices = 0;
2218   vnet_hw_interface_t *hi;
2219   u8 *s = NULL;
2220   int i;
2221
2222   if (!out_vuids)
2223     return -1;
2224
2225   vec_foreach (vui, vum->vhost_user_interfaces)
2226   {
2227     if (vui->active)
2228       vec_add1 (hw_if_indices, vui->hw_if_index);
2229   }
2230
2231   for (i = 0; i < vec_len (hw_if_indices); i++)
2232     {
2233       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2234       vui = vec_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2235
2236       vec_add2 (r_vuids, vuid, 1);
2237       vuid->sw_if_index = vui->sw_if_index;
2238       vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
2239       vuid->features = vui->features;
2240       vuid->is_server = vui->sock_is_server;
2241       vuid->num_regions = vui->nregions;
2242       vuid->sock_errno = vui->sock_errno;
2243       strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
2244                ARRAY_LEN (vuid->sock_filename) - 1);
2245
2246       s = format (s, "%v%c", hi->name, 0);
2247
2248       strncpy ((char *) vuid->if_name, (char *) s,
2249                ARRAY_LEN (vuid->if_name) - 1);
2250       _vec_len (s) = 0;
2251     }
2252
2253   vec_free (s);
2254   vec_free (hw_if_indices);
2255
2256   *out_vuids = r_vuids;
2257
2258   return rv;
2259 }
2260
2261 clib_error_t *
2262 show_vhost_user_command_fn (vlib_main_t * vm,
2263                             unformat_input_t * input,
2264                             vlib_cli_command_t * cmd)
2265 {
2266   clib_error_t *error = 0;
2267   vnet_main_t *vnm = vnet_get_main ();
2268   vhost_user_main_t *vum = &vhost_user_main;
2269   vhost_user_intf_t *vui;
2270   u32 hw_if_index, *hw_if_indices = 0;
2271   vnet_hw_interface_t *hi;
2272   int i, j, q;
2273   int show_descr = 0;
2274   struct feat_struct
2275   {
2276     u8 bit;
2277     char *str;
2278   };
2279   struct feat_struct *feat_entry;
2280
2281   static struct feat_struct feat_array[] = {
2282 #define _(s,b) { .str = #s, .bit = b, },
2283     foreach_virtio_net_feature
2284 #undef _
2285     {.str = NULL}
2286   };
2287
2288   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2289     {
2290       if (unformat
2291           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
2292         {
2293           vec_add1 (hw_if_indices, hw_if_index);
2294           vlib_cli_output (vm, "add %d", hw_if_index);
2295         }
2296       else if (unformat (input, "descriptors") || unformat (input, "desc"))
2297         show_descr = 1;
2298       else
2299         {
2300           error = clib_error_return (0, "unknown input `%U'",
2301                                      format_unformat_error, input);
2302           goto done;
2303         }
2304     }
2305   if (vec_len (hw_if_indices) == 0)
2306     {
2307       vec_foreach (vui, vum->vhost_user_interfaces)
2308       {
2309         if (vui->active)
2310           vec_add1 (hw_if_indices, vui->hw_if_index);
2311       }
2312     }
2313   vlib_cli_output (vm, "Virtio vhost-user interfaces");
2314   vlib_cli_output (vm, "Global:\n  coalesce frames %d time %e\n\n",
2315                    vum->coalesce_frames, vum->coalesce_time);
2316
2317   for (i = 0; i < vec_len (hw_if_indices); i++)
2318     {
2319       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2320       vui = vec_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2321       vlib_cli_output (vm, "Interface: %s (ifindex %d)",
2322                        hi->name, hw_if_indices[i]);
2323
2324       vlib_cli_output (vm, "virtio_net_hdr_sz %d\n features (0x%llx): \n",
2325                        vui->virtio_net_hdr_sz, vui->features);
2326
2327       feat_entry = (struct feat_struct *) &feat_array;
2328       while (feat_entry->str)
2329         {
2330           if (vui->features & (1 << feat_entry->bit))
2331             vlib_cli_output (vm, "   %s (%d)", feat_entry->str,
2332                              feat_entry->bit);
2333           feat_entry++;
2334         }
2335
2336       vlib_cli_output (vm, "\n");
2337
2338
2339       vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
2340                        vui->sock_filename,
2341                        vui->sock_is_server ? "server" : "client",
2342                        strerror (vui->sock_errno));
2343
2344       vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
2345
2346       if (vui->nregions)
2347         {
2348           vlib_cli_output (vm,
2349                            " region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr\n");
2350           vlib_cli_output (vm,
2351                            " ====== ===== ================== ================== ================== ================== ==================\n");
2352         }
2353       for (j = 0; j < vui->nregions; j++)
2354         {
2355           vlib_cli_output (vm,
2356                            "  %d     %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
2357                            j, vui->region_mmap_fd[j],
2358                            vui->regions[j].guest_phys_addr,
2359                            vui->regions[j].memory_size,
2360                            vui->regions[j].userspace_addr,
2361                            vui->regions[j].mmap_offset,
2362                            pointer_to_uword (vui->region_mmap_addr[j]));
2363         }
2364       for (q = 0; q < vui->num_vrings; q++)
2365         {
2366           vlib_cli_output (vm, "\n Virtqueue %d\n", q);
2367
2368           vlib_cli_output (vm,
2369                            "  qsz %d last_avail_idx %d last_used_idx %d\n",
2370                            vui->vrings[q].qsz, vui->vrings[q].last_avail_idx,
2371                            vui->vrings[q].last_used_idx);
2372
2373           if (vui->vrings[q].avail && vui->vrings[q].used)
2374             vlib_cli_output (vm,
2375                              "  avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
2376                              vui->vrings[q].avail->flags,
2377                              vui->vrings[q].avail->idx,
2378                              vui->vrings[q].used->flags,
2379                              vui->vrings[q].used->idx);
2380
2381           vlib_cli_output (vm, "  kickfd %d callfd %d errfd %d\n",
2382                            vui->vrings[q].kickfd,
2383                            vui->vrings[q].callfd, vui->vrings[q].errfd);
2384
2385           if (show_descr)
2386             {
2387               vlib_cli_output (vm, "\n  descriptor table:\n");
2388               vlib_cli_output (vm,
2389                                "   id          addr         len  flags  next      user_addr\n");
2390               vlib_cli_output (vm,
2391                                "  ===== ================== ===== ====== ===== ==================\n");
2392               for (j = 0; j < vui->vrings[q].qsz; j++)
2393                 {
2394                   u32 mem_hint = 0;
2395                   vlib_cli_output (vm,
2396                                    "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
2397                                    j, vui->vrings[q].desc[j].addr,
2398                                    vui->vrings[q].desc[j].len,
2399                                    vui->vrings[q].desc[j].flags,
2400                                    vui->vrings[q].desc[j].next,
2401                                    pointer_to_uword (map_guest_mem
2402                                                      (vui,
2403                                                       vui->vrings[q].desc[j].
2404                                                       addr, &mem_hint)));
2405                 }
2406             }
2407         }
2408       vlib_cli_output (vm, "\n");
2409     }
2410 done:
2411   vec_free (hw_if_indices);
2412   return error;
2413 }
2414
2415 /*
2416  * CLI functions
2417  */
2418
2419 /* *INDENT-OFF* */
2420 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
2421     .path = "create vhost-user",
2422     .short_help = "create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [renumber <dev_instance>]",
2423     .function = vhost_user_connect_command_fn,
2424 };
2425
2426 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
2427     .path = "delete vhost-user",
2428     .short_help = "delete vhost-user sw_if_index <nn>",
2429     .function = vhost_user_delete_command_fn,
2430 };
2431
2432 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
2433     .path = "show vhost-user",
2434     .short_help = "show vhost-user interface",
2435     .function = show_vhost_user_command_fn,
2436 };
2437 /* *INDENT-ON* */
2438
2439 static clib_error_t *
2440 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
2441 {
2442   vhost_user_main_t *vum = &vhost_user_main;
2443
2444   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2445     {
2446       if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
2447         ;
2448       else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
2449         ;
2450       else if (unformat (input, "dont-dump-memory"))
2451         vum->dont_dump_vhost_user_memory = 1;
2452       else
2453         return clib_error_return (0, "unknown input `%U'",
2454                                   format_unformat_error, input);
2455     }
2456
2457   return 0;
2458 }
2459
2460 /* vhost-user { ... } configuration. */
2461 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
2462
2463 void
2464 vhost_user_unmap_all (void)
2465 {
2466   vhost_user_main_t *vum = &vhost_user_main;
2467   vhost_user_intf_t *vui;
2468
2469   if (vum->dont_dump_vhost_user_memory)
2470     {
2471       vec_foreach (vui, vum->vhost_user_interfaces)
2472       {
2473         unmap_all_mem_regions (vui);
2474       }
2475     }
2476 }
2477
2478 /*
2479  * fd.io coding-style-patch-verification: ON
2480  *
2481  * Local Variables:
2482  * eval: (c-set-style "gnu")
2483  * End:
2484  */