memif: Fix underflow
[vpp.git] / src / plugins / memif / node.c
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2016 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17
18 #define _GNU_SOURCE
19 #include <stdint.h>
20 #include <net/if.h>
21 #include <sys/ioctl.h>
22 #include <sys/uio.h>
23
24 #include <vlib/vlib.h>
25 #include <vlib/unix/unix.h>
26 #include <vnet/ethernet/ethernet.h>
27 #include <vnet/interface/rx_queue_funcs.h>
28 #include <vnet/feature/feature.h>
29
30 #include <memif/memif.h>
31 #include <memif/private.h>
32
33 #define MEMIF_IP_OFFSET 14
34
35 #define foreach_memif_input_error                                             \
36   _ (BUFFER_ALLOC_FAIL, buffer_alloc, ERROR, "buffer allocation failed")      \
37   _ (BAD_DESC, bad_desc, ERROR, "bad descriptor")                             \
38   _ (NOT_IP, not_ip, INFO, "not ip packet")
39
40 typedef enum
41 {
42 #define _(f, n, s, d) MEMIF_INPUT_ERROR_##f,
43   foreach_memif_input_error
44 #undef _
45     MEMIF_INPUT_N_ERROR,
46 } memif_input_error_t;
47
48 static vlib_error_desc_t memif_input_error_counters[] = {
49 #define _(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
50   foreach_memif_input_error
51 #undef _
52 };
53
54 typedef struct
55 {
56   u32 next_index;
57   u32 hw_if_index;
58   u16 ring;
59 } memif_input_trace_t;
60
61 static __clib_unused u8 *
62 format_memif_input_trace (u8 * s, va_list * args)
63 {
64   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
65   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
66   memif_input_trace_t *t = va_arg (*args, memif_input_trace_t *);
67   u32 indent = format_get_indent (s);
68
69   s = format (s, "memif: hw_if_index %d next-index %d",
70               t->hw_if_index, t->next_index);
71   s = format (s, "\n%Uslot: ring %u", format_white_space, indent + 2,
72               t->ring);
73   return s;
74 }
75
76 static_always_inline u32
77 memif_next_from_ip_hdr (vlib_node_runtime_t * node, vlib_buffer_t * b)
78 {
79   u8 *ptr = vlib_buffer_get_current (b);
80   u8 v = *ptr & 0xf0;
81
82   if (PREDICT_TRUE (v == 0x40))
83     return VNET_DEVICE_INPUT_NEXT_IP4_NCS_INPUT;
84   else if (PREDICT_TRUE (v == 0x60))
85     return VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
86
87   b->error = node->errors[MEMIF_INPUT_ERROR_NOT_IP];
88   return VNET_DEVICE_INPUT_NEXT_DROP;
89 }
90
91 static_always_inline void
92 memif_trace_buffer (vlib_main_t * vm, vlib_node_runtime_t * node,
93                     memif_if_t * mif, vlib_buffer_t * b, u32 next, u16 qid,
94                     uword * n_tracep)
95 {
96   if (PREDICT_TRUE
97       (b != 0 && vlib_trace_buffer (vm, node, next, b, /* follow_chain */ 0)))
98     {
99       memif_input_trace_t *tr;
100       vlib_set_trace_count (vm, node, --(*n_tracep));
101       tr = vlib_add_trace (vm, node, b, sizeof (*tr));
102       tr->next_index = next;
103       tr->hw_if_index = mif->hw_if_index;
104       tr->ring = qid;
105     }
106 }
107
108 static_always_inline void
109 memif_add_copy_op (memif_per_thread_data_t * ptd, void *data, u32 len,
110                    u16 buffer_offset, u16 buffer_vec_index)
111 {
112   memif_copy_op_t *co;
113   vec_add2_aligned (ptd->copy_ops, co, 1, CLIB_CACHE_LINE_BYTES);
114   co->data = data;
115   co->data_len = len;
116   co->buffer_offset = buffer_offset;
117   co->buffer_vec_index = buffer_vec_index;
118 }
119
120 static_always_inline void
121 memif_add_to_chain (vlib_main_t * vm, vlib_buffer_t * b, u32 * buffers,
122                     u32 buffer_size)
123 {
124   vlib_buffer_t *seg = b;
125   i32 bytes_left = b->current_length - buffer_size + b->current_data;
126
127   if (PREDICT_TRUE (bytes_left <= 0))
128     return;
129
130   b->current_length -= bytes_left;
131   b->total_length_not_including_first_buffer = bytes_left;
132
133   while (bytes_left)
134     {
135       seg->flags |= VLIB_BUFFER_NEXT_PRESENT;
136       seg->next_buffer = buffers[0];
137       seg = vlib_get_buffer (vm, buffers[0]);
138       buffers++;
139       seg->current_data = 0;
140       seg->current_length = clib_min (buffer_size, bytes_left);
141       bytes_left -= seg->current_length;
142     }
143 }
144
145 static_always_inline u16
146 memif_parse_desc (memif_per_thread_data_t *ptd, memif_if_t *mif,
147                   memif_queue_t *mq, u16 next, u16 n_avail)
148 {
149   memif_ring_t *ring = mq->ring;
150   memif_desc_t *descs = ring->desc;
151   void **desc_data = ptd->desc_data;
152   u16 *desc_len = ptd->desc_len;
153   memif_desc_status_t *desc_status = ptd->desc_status;
154   u16 n_desc = 0, n_pkts = 0;
155   u32 i = 0;
156   u16 mask = pow2_mask (mq->log2_ring_size);
157   memif_desc_t *d = 0;
158   u32 slot = next;
159
160   while (i < n_avail)
161     {
162       u8 flags;
163       d = descs + (slot++ & mask);
164       desc_data[i] = (void *) ((u64) d->region << 32 | d->offset);
165       desc_len[i] = d->length;
166       desc_status[i].as_u8 = flags = d->flags;
167       i++;
168       if (PREDICT_FALSE ((flags & MEMIF_DESC_FLAG_NEXT)) == 0)
169         {
170           n_desc = i;
171           if (++n_pkts == MEMIF_RX_VECTOR_SZ)
172             goto frame_full;
173         }
174     }
175 frame_full:
176
177   /* done */
178   ptd->n_packets = n_pkts;
179   return n_desc;
180 }
181
182 static_always_inline void
183 memif_desc_status_set_err (memif_desc_status_t *p,
184                            memif_desc_status_err_code_t e)
185 {
186   memif_desc_status_t s = { .err = 1, .err_code = e };
187   p->as_u8 |= s.as_u8;
188 }
189
190 static_always_inline void
191 memif_validate_desc_data (memif_per_thread_data_t *ptd, memif_if_t *mif,
192                           u16 n_desc, int is_ethernet)
193 {
194   void **desc_data = ptd->desc_data;
195   u16 *desc_len = ptd->desc_len;
196   memif_desc_status_t *desc_status = ptd->desc_status;
197   u16 n_regions = vec_len (mif->regions);
198   u32 n_rx_bytes = 0;
199   u16 max_len = 0;
200   u8 xor_status = 0;
201
202   for (u32 i = 0; i < n_desc; i++)
203     {
204       u16 region = ((u64) desc_data[i]) >> 32;
205       u32 offset = (u64) desc_data[i];
206       u16 len = desc_len[i];
207       memif_region_t *r = mif->regions + region;
208
209       if (region >= n_regions)
210         memif_desc_status_set_err (desc_status + i,
211                                    MEMIF_DESC_STATUS_ERR_BAD_REGION);
212       else if (offset + len > r->region_size)
213         memif_desc_status_set_err (desc_status + i,
214                                    MEMIF_DESC_STATUS_ERR_REGION_OVERRUN);
215       else if (is_ethernet && len > ETHERNET_MAX_PACKET_BYTES)
216         memif_desc_status_set_err (desc_status + i,
217                                    MEMIF_DESC_STATUS_ERR_DATA_TOO_BIG);
218       else if (len == 0)
219         memif_desc_status_set_err (desc_status + i,
220                                    MEMIF_DESC_STATUS_ERR_ZERO_LENGTH);
221       else
222         {
223           desc_data[i] = r->shm + offset;
224           if (len > max_len)
225             max_len = len;
226           xor_status |= desc_status[i].as_u8;
227           n_rx_bytes += len;
228         }
229     }
230
231   ptd->max_desc_len = max_len;
232   ptd->xor_status = xor_status;
233   ptd->n_rx_bytes = n_rx_bytes;
234 }
235
236 static_always_inline u32
237 memif_process_desc (vlib_main_t *vm, vlib_node_runtime_t *node,
238                     memif_per_thread_data_t *ptd, memif_if_t *mif)
239 {
240   u16 buffer_size = vlib_buffer_get_default_data_size (vm);
241   int is_ip = mif->mode == MEMIF_INTERFACE_MODE_IP;
242   i16 start_offset = (is_ip) ? MEMIF_IP_OFFSET : 0;
243   memif_packet_op_t *po = ptd->packet_ops;
244   void **desc_data = ptd->desc_data;
245   u16 *desc_len = ptd->desc_len;
246   memif_desc_status_t *desc_status = ptd->desc_status;
247   u32 n_buffers = 0;
248   u32 n_left = ptd->n_packets;
249   u32 packet_len;
250   int i = 0;
251
252   /* construct copy and packet vector out of ring slots */
253   while (n_left)
254     {
255       u32 dst_off, src_off, n_bytes_left;
256       void *mb0;
257       po->first_buffer_vec_index = n_buffers++;
258
259       packet_len = 0;
260       src_off = 0;
261       dst_off = start_offset;
262
263     next_slot:
264       n_bytes_left = desc_len[i];
265
266       packet_len += n_bytes_left;
267       mb0 = desc_data[i];
268
269       if (PREDICT_FALSE (desc_status[i].err))
270         vlib_error_count (vm, node->node_index, MEMIF_INPUT_ERROR_BAD_DESC, 1);
271       else
272         do
273           {
274             u32 dst_free = buffer_size - dst_off;
275             if (dst_free == 0)
276               {
277                 dst_off = 0;
278                 dst_free = buffer_size;
279                 n_buffers++;
280               }
281             u32 bytes_to_copy = clib_min (dst_free, n_bytes_left);
282             memif_add_copy_op (ptd, mb0 + src_off, bytes_to_copy, dst_off,
283                                n_buffers - 1);
284             n_bytes_left -= bytes_to_copy;
285             src_off += bytes_to_copy;
286             dst_off += bytes_to_copy;
287           }
288         while (PREDICT_FALSE (n_bytes_left));
289
290       /* next descriptor */
291       i++;
292
293       if (desc_status[i].next)
294         {
295           src_off = 0;
296           goto next_slot;
297         }
298
299       /* update packet op */
300       po->packet_len = packet_len;
301       po++;
302
303       /* next packet */
304       n_left--;
305     }
306   return n_buffers;
307 }
308 static_always_inline void
309 memif_fill_buffer_mdata_simple (vlib_node_runtime_t *node,
310                                 memif_per_thread_data_t *ptd,
311                                 vlib_buffer_t **b, u16 *next, int is_ip)
312 {
313   vlib_buffer_t bt;
314   u16 *dl = ptd->desc_len;
315   /* process buffer metadata */
316
317   u32 n_left = ptd->n_packets;
318
319   /* copy template into local variable - will save per packet load */
320   vlib_buffer_copy_template (&bt, &ptd->buffer_template);
321
322   while (n_left >= 8)
323     {
324       vlib_prefetch_buffer_header (b[4], STORE);
325       vlib_prefetch_buffer_header (b[5], STORE);
326       vlib_prefetch_buffer_header (b[6], STORE);
327       vlib_prefetch_buffer_header (b[7], STORE);
328
329       vlib_buffer_copy_template (b[0], &bt);
330       vlib_buffer_copy_template (b[1], &bt);
331       vlib_buffer_copy_template (b[2], &bt);
332       vlib_buffer_copy_template (b[3], &bt);
333
334       b[0]->current_length = dl[0];
335       b[1]->current_length = dl[1];
336       b[2]->current_length = dl[2];
337       b[3]->current_length = dl[3];
338
339       if (is_ip)
340         {
341           next[0] = memif_next_from_ip_hdr (node, b[0]);
342           next[1] = memif_next_from_ip_hdr (node, b[1]);
343           next[2] = memif_next_from_ip_hdr (node, b[2]);
344           next[3] = memif_next_from_ip_hdr (node, b[3]);
345         }
346
347       /* next */
348       n_left -= 4;
349       b += 4;
350       dl += 4;
351       next += 4;
352     }
353
354   while (n_left)
355     {
356       /* enqueue buffer */
357       vlib_buffer_copy_template (b[0], &bt);
358       b[0]->current_length = dl[0];
359       if (is_ip)
360         next[0] = memif_next_from_ip_hdr (node, b[0]);
361
362       /* next */
363       n_left -= 1;
364       b += 1;
365       dl += 1;
366       next += 1;
367     }
368 }
369
370 static_always_inline void
371 memif_fill_buffer_mdata (vlib_main_t *vm, vlib_node_runtime_t *node,
372                          memif_per_thread_data_t *ptd, memif_if_t *mif,
373                          u32 *bi, u16 *next, int is_ip)
374 {
375   u16 buffer_size = vlib_buffer_get_default_data_size (vm);
376   vlib_buffer_t *b0, *b1, *b2, *b3, bt;
377   memif_packet_op_t *po;
378   /* process buffer metadata */
379
380   u32 n_from = ptd->n_packets;
381   po = ptd->packet_ops;
382
383   /* copy template into local variable - will save per packet load */
384   vlib_buffer_copy_template (&bt, &ptd->buffer_template);
385
386   while (n_from >= 8)
387     {
388       b0 = vlib_get_buffer (vm, ptd->buffers[po[4].first_buffer_vec_index]);
389       b1 = vlib_get_buffer (vm, ptd->buffers[po[5].first_buffer_vec_index]);
390       b2 = vlib_get_buffer (vm, ptd->buffers[po[6].first_buffer_vec_index]);
391       b3 = vlib_get_buffer (vm, ptd->buffers[po[7].first_buffer_vec_index]);
392
393       vlib_prefetch_buffer_header (b0, STORE);
394       vlib_prefetch_buffer_header (b1, STORE);
395       vlib_prefetch_buffer_header (b2, STORE);
396       vlib_prefetch_buffer_header (b3, STORE);
397
398       /* enqueue buffer */
399       u32 fbvi[4];
400       fbvi[0] = po[0].first_buffer_vec_index;
401       fbvi[1] = po[1].first_buffer_vec_index;
402       fbvi[2] = po[2].first_buffer_vec_index;
403       fbvi[3] = po[3].first_buffer_vec_index;
404
405       bi[0] = ptd->buffers[fbvi[0]];
406       bi[1] = ptd->buffers[fbvi[1]];
407       bi[2] = ptd->buffers[fbvi[2]];
408       bi[3] = ptd->buffers[fbvi[3]];
409
410       b0 = vlib_get_buffer (vm, bi[0]);
411       b1 = vlib_get_buffer (vm, bi[1]);
412       b2 = vlib_get_buffer (vm, bi[2]);
413       b3 = vlib_get_buffer (vm, bi[3]);
414
415       vlib_buffer_copy_template (b0, &bt);
416       vlib_buffer_copy_template (b1, &bt);
417       vlib_buffer_copy_template (b2, &bt);
418       vlib_buffer_copy_template (b3, &bt);
419
420       b0->current_length = po[0].packet_len;
421       b1->current_length = po[1].packet_len;
422       b2->current_length = po[2].packet_len;
423       b3->current_length = po[3].packet_len;
424
425       memif_add_to_chain (vm, b0, ptd->buffers + fbvi[0] + 1, buffer_size);
426       memif_add_to_chain (vm, b1, ptd->buffers + fbvi[1] + 1, buffer_size);
427       memif_add_to_chain (vm, b2, ptd->buffers + fbvi[2] + 1, buffer_size);
428       memif_add_to_chain (vm, b3, ptd->buffers + fbvi[3] + 1, buffer_size);
429
430       if (is_ip)
431         {
432           next[0] = memif_next_from_ip_hdr (node, b0);
433           next[1] = memif_next_from_ip_hdr (node, b1);
434           next[2] = memif_next_from_ip_hdr (node, b2);
435           next[3] = memif_next_from_ip_hdr (node, b3);
436         }
437
438       /* next */
439       n_from -= 4;
440       po += 4;
441       bi += 4;
442       next += 4;
443     }
444   while (n_from)
445     {
446       u32 fbvi[1];
447       /* enqueue buffer */
448       fbvi[0] = po[0].first_buffer_vec_index;
449       bi[0] = ptd->buffers[fbvi[0]];
450       b0 = vlib_get_buffer (vm, bi[0]);
451       vlib_buffer_copy_template (b0, &bt);
452       b0->current_length = po->packet_len;
453
454       memif_add_to_chain (vm, b0, ptd->buffers + fbvi[0] + 1, buffer_size);
455
456       if (is_ip)
457         next[0] = memif_next_from_ip_hdr (node, b0);
458
459       /* next */
460       n_from -= 1;
461       po += 1;
462       bi += 1;
463       next += 1;
464     }
465 }
466
467 static_always_inline uword
468 memif_device_input_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
469                            memif_if_t *mif, memif_ring_type_t type, u16 qid,
470                            memif_interface_mode_t mode)
471 {
472   vnet_main_t *vnm = vnet_get_main ();
473   memif_main_t *mm = &memif_main;
474   memif_ring_t *ring;
475   memif_queue_t *mq;
476   u16 buffer_size = vlib_buffer_get_default_data_size (vm);
477   uword n_trace;
478   u16 nexts[MEMIF_RX_VECTOR_SZ], *next = nexts;
479   u32 _to_next_bufs[MEMIF_RX_VECTOR_SZ], *to_next_bufs = _to_next_bufs, *bi;
480   u32 n_left_to_next;
481   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
482   vlib_buffer_t *buffer_ptrs[MEMIF_RX_VECTOR_SZ];
483   u32 thread_index = vm->thread_index;
484   memif_per_thread_data_t *ptd =
485     vec_elt_at_index (mm->per_thread_data, thread_index);
486   u16 cur_slot, ring_size, n_slots, mask;
487   u16 n_buffers, n_alloc, n_desc;
488   i16 start_offset;
489   memif_copy_op_t *co;
490   int is_slave = (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) != 0;
491   int is_simple = 1;
492   int i;
493
494   mq = vec_elt_at_index (mif->rx_queues, qid);
495   ring = mq->ring;
496   ring_size = 1 << mq->log2_ring_size;
497   mask = ring_size - 1;
498
499   start_offset = (mode == MEMIF_INTERFACE_MODE_IP) ? MEMIF_IP_OFFSET : 0;
500
501   if (is_slave)
502     {
503       cur_slot = mq->last_tail;
504       n_slots = __atomic_load_n (&ring->tail, __ATOMIC_ACQUIRE) - cur_slot;
505     }
506   else
507     {
508       cur_slot = mq->last_head;
509       n_slots = __atomic_load_n (&ring->head, __ATOMIC_ACQUIRE) - cur_slot;
510     }
511
512   if (n_slots == 0)
513     goto refill;
514
515   n_desc = memif_parse_desc (ptd, mif, mq, cur_slot, n_slots);
516
517   if (n_desc != ptd->n_packets)
518     is_simple = 0;
519
520   cur_slot += n_desc;
521
522   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
523     memif_validate_desc_data (ptd, mif, n_desc, /* is_ethernet */ 1);
524   else
525     memif_validate_desc_data (ptd, mif, n_desc, /* is_ethernet */ 0);
526
527   if (ptd->max_desc_len > buffer_size - start_offset)
528     is_simple = 0;
529
530   if (ptd->xor_status != 0)
531     is_simple = 0;
532
533   if (is_simple)
534     n_buffers = ptd->n_packets;
535   else
536     n_buffers = memif_process_desc (vm, node, ptd, mif);
537
538   /* allocate free buffers */
539   vec_validate_aligned (ptd->buffers, n_buffers - 1, CLIB_CACHE_LINE_BYTES);
540   n_alloc = vlib_buffer_alloc_from_pool (vm, ptd->buffers, n_buffers,
541                                          mq->buffer_pool_index);
542   if (PREDICT_FALSE (n_alloc != n_buffers))
543     {
544       if (n_alloc)
545         vlib_buffer_free (vm, ptd->buffers, n_alloc);
546       vlib_error_count (vm, node->node_index,
547                         MEMIF_INPUT_ERROR_BUFFER_ALLOC_FAIL, 1);
548       goto refill;
549     }
550
551   /* copy data */
552   if (is_simple)
553     {
554       int n_pkts = ptd->n_packets;
555       void **desc_data = ptd->desc_data;
556       u16 *desc_len = ptd->desc_len;
557
558       vlib_get_buffers (vm, ptd->buffers, buffer_ptrs, n_buffers);
559
560       for (i = 0; i + 8 < n_pkts; i++)
561         {
562           clib_prefetch_load (desc_data[i + 8]);
563           clib_prefetch_store (buffer_ptrs[i + 8]->data);
564           clib_memcpy_fast (buffer_ptrs[i]->data + start_offset, desc_data[i],
565                             desc_len[i]);
566         }
567       for (; i < n_pkts; i++)
568         clib_memcpy_fast (buffer_ptrs[i]->data + start_offset, desc_data[i],
569                           desc_len[i]);
570     }
571   else
572     {
573       vlib_buffer_t *b;
574       u32 n_pkts = vec_len (ptd->copy_ops);
575       co = ptd->copy_ops;
576
577       for (i = 0; i + 8 < n_pkts; i++)
578         {
579           clib_prefetch_load (co[i + 8].data);
580           b = vlib_get_buffer (vm, ptd->buffers[co[i].buffer_vec_index]);
581           clib_memcpy_fast (b->data + co[i].buffer_offset, co[i].data,
582                             co[i].data_len);
583         }
584       for (; i < n_pkts; i++)
585         {
586           b = vlib_get_buffer (vm, ptd->buffers[co[i].buffer_vec_index]);
587           clib_memcpy_fast (b->data + co[i].buffer_offset, co[i].data,
588                             co[i].data_len);
589         }
590     }
591
592   /* release slots from the ring */
593   if (type == MEMIF_RING_S2M)
594     {
595       __atomic_store_n (&ring->tail, cur_slot, __ATOMIC_RELEASE);
596       mq->last_head = cur_slot;
597     }
598   else
599     {
600       mq->last_tail = cur_slot;
601     }
602
603   /* prepare buffer template and next indices */
604   vnet_buffer (&ptd->buffer_template)->sw_if_index[VLIB_RX] = mif->sw_if_index;
605   vnet_buffer (&ptd->buffer_template)->feature_arc_index = 0;
606   ptd->buffer_template.current_data = start_offset;
607   ptd->buffer_template.current_config_index = 0;
608   ptd->buffer_template.buffer_pool_index = mq->buffer_pool_index;
609   ptd->buffer_template.ref_count = 1;
610
611   if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
612     {
613       next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
614       if (mif->per_interface_next_index != ~0)
615         next_index = mif->per_interface_next_index;
616       else
617         vnet_feature_start_device_input_x1 (mif->sw_if_index, &next_index,
618                                             &ptd->buffer_template);
619
620       vlib_get_new_next_frame (vm, node, next_index, to_next_bufs,
621                                n_left_to_next);
622       if (PREDICT_TRUE (next_index == VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT))
623         {
624           vlib_next_frame_t *nf;
625           vlib_frame_t *f;
626           ethernet_input_frame_t *ef;
627           nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
628           f = vlib_get_frame (vm, nf->frame);
629           f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
630
631           ef = vlib_frame_scalar_args (f);
632           ef->sw_if_index = mif->sw_if_index;
633           ef->hw_if_index = mif->hw_if_index;
634           vlib_frame_no_append (f);
635         }
636     }
637
638   if (is_simple)
639     {
640       vlib_buffer_copy_indices (to_next_bufs, ptd->buffers, ptd->n_packets);
641       if (mode == MEMIF_INTERFACE_MODE_IP)
642         memif_fill_buffer_mdata_simple (node, ptd, buffer_ptrs, nexts, 1);
643       else
644         memif_fill_buffer_mdata_simple (node, ptd, buffer_ptrs, nexts, 0);
645     }
646   else
647     {
648       if (mode == MEMIF_INTERFACE_MODE_IP)
649         memif_fill_buffer_mdata (vm, node, ptd, mif, to_next_bufs, nexts, 1);
650       else
651         memif_fill_buffer_mdata (vm, node, ptd, mif, to_next_bufs, nexts, 0);
652     }
653
654   /* packet trace if enabled */
655   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
656     {
657       u32 n_left = ptd->n_packets;
658       bi = to_next_bufs;
659       next = nexts;
660       u32 ni = next_index;
661       while (n_trace && n_left)
662         {
663           vlib_buffer_t *b;
664           memif_input_trace_t *tr;
665           if (mode != MEMIF_INTERFACE_MODE_ETHERNET)
666             ni = next[0];
667           b = vlib_get_buffer (vm, bi[0]);
668           if (PREDICT_TRUE
669               (vlib_trace_buffer (vm, node, ni, b, /* follow_chain */ 0)))
670             {
671               tr = vlib_add_trace (vm, node, b, sizeof (*tr));
672               tr->next_index = ni;
673               tr->hw_if_index = mif->hw_if_index;
674               tr->ring = qid;
675               n_trace--;
676             }
677
678           /* next */
679           n_left--;
680           bi++;
681           next++;
682         }
683       vlib_set_trace_count (vm, node, n_trace);
684     }
685
686   if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
687     {
688       n_left_to_next -= ptd->n_packets;
689       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
690     }
691   else
692     vlib_buffer_enqueue_to_next (vm, node, to_next_bufs, nexts,
693                                  ptd->n_packets);
694
695   vlib_increment_combined_counter (
696     vnm->interface_main.combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
697     thread_index, mif->sw_if_index, ptd->n_packets, ptd->n_rx_bytes);
698
699   /* refill ring with empty buffers */
700 refill:
701   vec_reset_length (ptd->buffers);
702   vec_reset_length (ptd->copy_ops);
703
704   if (type == MEMIF_RING_M2S)
705     {
706       u16 head = ring->head;
707       n_slots = ring_size - head + mq->last_tail;
708
709       while (n_slots--)
710         {
711           u16 s = head++ & mask;
712           memif_desc_t *d = &ring->desc[s];
713           d->length = mif->run.buffer_size;
714         }
715
716       __atomic_store_n (&ring->head, head, __ATOMIC_RELEASE);
717     }
718
719   return ptd->n_packets;
720 }
721
722 static_always_inline uword
723 memif_device_input_zc_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
724                               memif_if_t *mif, u16 qid,
725                               memif_interface_mode_t mode)
726 {
727   vnet_main_t *vnm = vnet_get_main ();
728   memif_main_t *mm = &memif_main;
729   memif_ring_t *ring;
730   memif_queue_t *mq;
731   u32 next_index;
732   uword n_trace = vlib_get_trace_count (vm, node);
733   u32 n_rx_packets = 0, n_rx_bytes = 0;
734   u32 *to_next = 0, *buffers;
735   u32 bi0, bi1, bi2, bi3;
736   u16 slot, s0;
737   memif_desc_t *d0;
738   vlib_buffer_t *b0, *b1, *b2, *b3;
739   u32 thread_index = vm->thread_index;
740   memif_per_thread_data_t *ptd = vec_elt_at_index (mm->per_thread_data,
741                                                    thread_index);
742   u16 cur_slot, last_slot, ring_size, n_slots, mask, head;
743   i16 start_offset;
744   u64 offset;
745   u32 buffer_length;
746   u16 n_alloc, n_from;
747
748   mq = vec_elt_at_index (mif->rx_queues, qid);
749   ring = mq->ring;
750   ring_size = 1 << mq->log2_ring_size;
751   mask = ring_size - 1;
752
753   next_index = (mode == MEMIF_INTERFACE_MODE_IP) ?
754     VNET_DEVICE_INPUT_NEXT_IP6_INPUT : VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
755
756   /* asume that somebody will want to add ethernet header on the packet
757      so start with IP header at offset 14 */
758   start_offset = (mode == MEMIF_INTERFACE_MODE_IP) ? 14 : 0;
759   buffer_length = vlib_buffer_get_default_data_size (vm) - start_offset;
760
761   cur_slot = mq->last_tail;
762   last_slot = __atomic_load_n (&ring->tail, __ATOMIC_ACQUIRE);
763   if (cur_slot == last_slot)
764     goto refill;
765   n_slots = last_slot - cur_slot;
766
767   /* process ring slots */
768   vec_validate_aligned (ptd->buffers, MEMIF_RX_VECTOR_SZ,
769                         CLIB_CACHE_LINE_BYTES);
770   while (n_slots && n_rx_packets < MEMIF_RX_VECTOR_SZ)
771     {
772       vlib_buffer_t *hb;
773
774       s0 = cur_slot & mask;
775       bi0 = mq->buffers[s0];
776       ptd->buffers[n_rx_packets++] = bi0;
777
778       clib_prefetch_load (&ring->desc[(cur_slot + 8) & mask]);
779       d0 = &ring->desc[s0];
780       hb = b0 = vlib_get_buffer (vm, bi0);
781       b0->current_data = start_offset;
782       b0->current_length = d0->length;
783       n_rx_bytes += d0->length;
784
785       cur_slot++;
786       n_slots--;
787       if (PREDICT_FALSE ((d0->flags & MEMIF_DESC_FLAG_NEXT) && n_slots))
788         {
789           hb->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
790           hb->total_length_not_including_first_buffer = 0;
791         next_slot:
792           s0 = cur_slot & mask;
793           d0 = &ring->desc[s0];
794           bi0 = mq->buffers[s0];
795
796           /* previous buffer */
797           b0->next_buffer = bi0;
798           b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
799
800           /* current buffer */
801           b0 = vlib_get_buffer (vm, bi0);
802           b0->current_data = start_offset;
803           b0->current_length = d0->length;
804           hb->total_length_not_including_first_buffer += d0->length;
805           n_rx_bytes += d0->length;
806
807           cur_slot++;
808           n_slots--;
809           if ((d0->flags & MEMIF_DESC_FLAG_NEXT) && n_slots)
810             goto next_slot;
811         }
812     }
813
814   /* release slots from the ring */
815   mq->last_tail = cur_slot;
816
817   n_from = n_rx_packets;
818   buffers = ptd->buffers;
819
820   while (n_from)
821     {
822       u32 n_left_to_next;
823       u32 next0, next1, next2, next3;
824
825       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
826       while (n_from >= 8 && n_left_to_next >= 4)
827         {
828           b0 = vlib_get_buffer (vm, buffers[4]);
829           b1 = vlib_get_buffer (vm, buffers[5]);
830           b2 = vlib_get_buffer (vm, buffers[6]);
831           b3 = vlib_get_buffer (vm, buffers[7]);
832           vlib_prefetch_buffer_header (b0, STORE);
833           vlib_prefetch_buffer_header (b1, STORE);
834           vlib_prefetch_buffer_header (b2, STORE);
835           vlib_prefetch_buffer_header (b3, STORE);
836
837           /* enqueue buffer */
838           to_next[0] = bi0 = buffers[0];
839           to_next[1] = bi1 = buffers[1];
840           to_next[2] = bi2 = buffers[2];
841           to_next[3] = bi3 = buffers[3];
842           to_next += 4;
843           n_left_to_next -= 4;
844           buffers += 4;
845
846           b0 = vlib_get_buffer (vm, bi0);
847           b1 = vlib_get_buffer (vm, bi1);
848           b2 = vlib_get_buffer (vm, bi2);
849           b3 = vlib_get_buffer (vm, bi3);
850
851           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
852           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
853           vnet_buffer (b1)->sw_if_index[VLIB_RX] = mif->sw_if_index;
854           vnet_buffer (b1)->sw_if_index[VLIB_TX] = ~0;
855           vnet_buffer (b2)->sw_if_index[VLIB_RX] = mif->sw_if_index;
856           vnet_buffer (b2)->sw_if_index[VLIB_TX] = ~0;
857           vnet_buffer (b3)->sw_if_index[VLIB_RX] = mif->sw_if_index;
858           vnet_buffer (b3)->sw_if_index[VLIB_TX] = ~0;
859
860           if (mode == MEMIF_INTERFACE_MODE_IP)
861             {
862               next0 = memif_next_from_ip_hdr (node, b0);
863               next1 = memif_next_from_ip_hdr (node, b1);
864               next2 = memif_next_from_ip_hdr (node, b2);
865               next3 = memif_next_from_ip_hdr (node, b3);
866             }
867           else if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
868             {
869               if (PREDICT_FALSE (mif->per_interface_next_index != ~0))
870                 {
871                   next0 = mif->per_interface_next_index;
872                   next1 = mif->per_interface_next_index;
873                   next2 = mif->per_interface_next_index;
874                   next3 = mif->per_interface_next_index;
875                 }
876               else
877                 {
878                   next0 = next1 = next2 = next3 = next_index;
879                   /* redirect if feature path enabled */
880                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
881                                                       &next0, b0);
882                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
883                                                       &next1, b1);
884                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
885                                                       &next2, b2);
886                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
887                                                       &next3, b3);
888                 }
889             }
890
891           /* trace */
892           if (PREDICT_FALSE (n_trace > 0))
893             {
894               memif_trace_buffer (vm, node, mif, b0, next0, qid, &n_trace);
895               if (PREDICT_FALSE (n_trace > 0))
896                 memif_trace_buffer (vm, node, mif, b1, next1, qid, &n_trace);
897               if (PREDICT_FALSE (n_trace > 0))
898                 memif_trace_buffer (vm, node, mif, b2, next2, qid, &n_trace);
899               if (PREDICT_FALSE (n_trace > 0))
900                 memif_trace_buffer (vm, node, mif, b3, next3, qid, &n_trace);
901             }
902
903           /* enqueue */
904           vlib_validate_buffer_enqueue_x4 (vm, node, next_index, to_next,
905                                            n_left_to_next, bi0, bi1, bi2, bi3,
906                                            next0, next1, next2, next3);
907
908           /* next */
909           n_from -= 4;
910         }
911       while (n_from && n_left_to_next)
912         {
913           /* enqueue buffer */
914           to_next[0] = bi0 = buffers[0];
915           to_next += 1;
916           n_left_to_next--;
917           buffers += 1;
918
919           b0 = vlib_get_buffer (vm, bi0);
920           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
921           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
922
923           if (mode == MEMIF_INTERFACE_MODE_IP)
924             {
925               next0 = memif_next_from_ip_hdr (node, b0);
926             }
927           else if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
928             {
929               if (PREDICT_FALSE (mif->per_interface_next_index != ~0))
930                 next0 = mif->per_interface_next_index;
931               else
932                 {
933                   next0 = next_index;
934                   /* redirect if feature path enabled */
935                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
936                                                       &next0, b0);
937                 }
938             }
939
940           /* trace */
941           if (PREDICT_FALSE (n_trace > 0))
942             memif_trace_buffer (vm, node, mif, b0, next0, qid, &n_trace);
943
944           /* enqueue */
945           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
946                                            n_left_to_next, bi0, next0);
947
948           /* next */
949           n_from--;
950         }
951       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
952     }
953
954   vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
955                                    + VNET_INTERFACE_COUNTER_RX, thread_index,
956                                    mif->sw_if_index, n_rx_packets,
957                                    n_rx_bytes);
958
959   /* refill ring with empty buffers */
960 refill:
961   vec_reset_length (ptd->buffers);
962
963   head = ring->head;
964   n_slots = ring_size - head + mq->last_tail;
965   slot = head & mask;
966
967   n_slots &= ~7;
968
969   if (n_slots < 32)
970     goto done;
971
972   memif_desc_t desc_template, *dt = &desc_template;
973   clib_memset (dt, 0, sizeof (memif_desc_t));
974   dt->length = buffer_length;
975
976   n_alloc = vlib_buffer_alloc_to_ring_from_pool (
977     vm, mq->buffers, slot, ring_size, n_slots, mq->buffer_pool_index);
978   dt->region = mq->buffer_pool_index + 1;
979   offset = (u64) mif->regions[dt->region].shm - start_offset;
980
981   if (PREDICT_FALSE (n_alloc != n_slots))
982     vlib_error_count (vm, node->node_index,
983                       MEMIF_INPUT_ERROR_BUFFER_ALLOC_FAIL, 1);
984
985   head += n_alloc;
986
987   while (n_alloc)
988     {
989       memif_desc_t *d = ring->desc + slot;
990       u32 *bi = mq->buffers + slot;
991
992       if (PREDICT_FALSE (((slot + 7 > mask) || (n_alloc < 8))))
993         goto one_by_one;
994
995       clib_memcpy_fast (d + 0, dt, sizeof (memif_desc_t));
996       clib_memcpy_fast (d + 1, dt, sizeof (memif_desc_t));
997       clib_memcpy_fast (d + 2, dt, sizeof (memif_desc_t));
998       clib_memcpy_fast (d + 3, dt, sizeof (memif_desc_t));
999       clib_memcpy_fast (d + 4, dt, sizeof (memif_desc_t));
1000       clib_memcpy_fast (d + 5, dt, sizeof (memif_desc_t));
1001       clib_memcpy_fast (d + 6, dt, sizeof (memif_desc_t));
1002       clib_memcpy_fast (d + 7, dt, sizeof (memif_desc_t));
1003
1004       d[0].offset = (u64) vlib_get_buffer (vm, bi[0])->data - offset;
1005       d[1].offset = (u64) vlib_get_buffer (vm, bi[1])->data - offset;
1006       d[2].offset = (u64) vlib_get_buffer (vm, bi[2])->data - offset;
1007       d[3].offset = (u64) vlib_get_buffer (vm, bi[3])->data - offset;
1008       d[4].offset = (u64) vlib_get_buffer (vm, bi[4])->data - offset;
1009       d[5].offset = (u64) vlib_get_buffer (vm, bi[5])->data - offset;
1010       d[6].offset = (u64) vlib_get_buffer (vm, bi[6])->data - offset;
1011       d[7].offset = (u64) vlib_get_buffer (vm, bi[7])->data - offset;
1012
1013       slot = (slot + 8) & mask;
1014       n_alloc -= 8;
1015       continue;
1016
1017     one_by_one:
1018       clib_memcpy_fast (d, dt, sizeof (memif_desc_t));
1019       d[0].offset = (u64) vlib_get_buffer (vm, bi[0])->data - offset;
1020
1021       slot = (slot + 1) & mask;
1022       n_alloc -= 1;
1023     }
1024
1025   __atomic_store_n (&ring->head, head, __ATOMIC_RELEASE);
1026
1027 done:
1028   return n_rx_packets;
1029 }
1030
1031
1032 VLIB_NODE_FN (memif_input_node) (vlib_main_t * vm,
1033                                  vlib_node_runtime_t * node,
1034                                  vlib_frame_t * frame)
1035 {
1036   u32 n_rx = 0;
1037   memif_main_t *mm = &memif_main;
1038   memif_interface_mode_t mode_ip = MEMIF_INTERFACE_MODE_IP;
1039   memif_interface_mode_t mode_eth = MEMIF_INTERFACE_MODE_ETHERNET;
1040
1041   vnet_hw_if_rxq_poll_vector_t *pv;
1042   pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
1043   for (int i = 0; i < vec_len (pv); i++)
1044     {
1045       memif_if_t *mif;
1046       u32 qid;
1047       mif = vec_elt_at_index (mm->interfaces, pv[i].dev_instance);
1048       qid = pv[i].queue_id;
1049       if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) &&
1050           (mif->flags & MEMIF_IF_FLAG_CONNECTED))
1051         {
1052           if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
1053             {
1054               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1055                 n_rx +=
1056                   memif_device_input_zc_inline (vm, node, mif, qid, mode_ip);
1057               else
1058                 n_rx +=
1059                   memif_device_input_zc_inline (vm, node, mif, qid, mode_eth);
1060             }
1061           else if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
1062             {
1063               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1064                 n_rx += memif_device_input_inline (
1065                   vm, node, mif, MEMIF_RING_M2S, qid, mode_ip);
1066               else
1067                 n_rx += memif_device_input_inline (
1068                   vm, node, mif, MEMIF_RING_M2S, qid, mode_eth);
1069             }
1070           else
1071             {
1072               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1073                 n_rx += memif_device_input_inline (
1074                   vm, node, mif, MEMIF_RING_S2M, qid, mode_ip);
1075               else
1076                 n_rx += memif_device_input_inline (
1077                   vm, node, mif, MEMIF_RING_S2M, qid, mode_eth);
1078             }
1079         }
1080     }
1081
1082   return n_rx;
1083 }
1084
1085 /* *INDENT-OFF* */
1086 VLIB_REGISTER_NODE (memif_input_node) = {
1087   .name = "memif-input",
1088   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1089   .sibling_of = "device-input",
1090   .format_trace = format_memif_input_trace,
1091   .type = VLIB_NODE_TYPE_INPUT,
1092   .state = VLIB_NODE_STATE_INTERRUPT,
1093   .n_errors = MEMIF_INPUT_N_ERROR,
1094   .error_counters = memif_input_error_counters,
1095 };
1096
1097 /* *INDENT-ON* */
1098
1099
1100 /*
1101  * fd.io coding-style-patch-verification: ON
1102  *
1103  * Local Variables:
1104  * eval: (c-set-style "gnu")
1105  * End:
1106  */