memif: Process bad descriptors correctly in memif_process_desc
[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           n_rx_bytes += len;
227         }
228       xor_status |= desc_status[i].as_u8;
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 = -1;
251   int bad_packets = 0;
252
253   /* construct copy and packet vector out of ring slots */
254   while (n_left)
255     {
256       u32 dst_off, src_off, n_bytes_left;
257       void *mb0;
258       po->first_buffer_vec_index = n_buffers++;
259
260       packet_len = 0;
261       src_off = 0;
262       dst_off = start_offset;
263
264     next_slot:
265       i++; /* next descriptor */
266       n_bytes_left = desc_len[i];
267
268       packet_len += n_bytes_left;
269       mb0 = desc_data[i];
270
271       if (PREDICT_FALSE (desc_status[i].err))
272         {
273           vlib_error_count (vm, node->node_index, MEMIF_INPUT_ERROR_BAD_DESC,
274                             1);
275           bad_packets++;
276           ASSERT (n_buffers > 0);
277           n_buffers--;
278           goto next_packet;
279         }
280       else
281         do
282           {
283             u32 dst_free = buffer_size - dst_off;
284             if (dst_free == 0)
285               {
286                 dst_off = 0;
287                 dst_free = buffer_size;
288                 n_buffers++;
289               }
290             u32 bytes_to_copy = clib_min (dst_free, n_bytes_left);
291             memif_add_copy_op (ptd, mb0 + src_off, bytes_to_copy, dst_off,
292                                n_buffers - 1);
293             n_bytes_left -= bytes_to_copy;
294             src_off += bytes_to_copy;
295             dst_off += bytes_to_copy;
296           }
297         while (PREDICT_FALSE (n_bytes_left));
298
299       if (desc_status[i].next)
300         {
301           src_off = 0;
302           goto next_slot;
303         }
304
305       /* update packet op */
306       po->packet_len = packet_len;
307       po++;
308
309     next_packet:
310       /* next packet */
311       n_left--;
312     }
313   ASSERT (ptd->n_packets >= bad_packets);
314   ptd->n_packets -= bad_packets;
315   return n_buffers;
316 }
317 static_always_inline void
318 memif_fill_buffer_mdata_simple (vlib_node_runtime_t *node,
319                                 memif_per_thread_data_t *ptd,
320                                 vlib_buffer_t **b, u16 *next, int is_ip)
321 {
322   vlib_buffer_t bt;
323   u16 *dl = ptd->desc_len;
324   /* process buffer metadata */
325
326   u32 n_left = ptd->n_packets;
327
328   /* copy template into local variable - will save per packet load */
329   vlib_buffer_copy_template (&bt, &ptd->buffer_template);
330
331   while (n_left >= 8)
332     {
333       vlib_prefetch_buffer_header (b[4], STORE);
334       vlib_prefetch_buffer_header (b[5], STORE);
335       vlib_prefetch_buffer_header (b[6], STORE);
336       vlib_prefetch_buffer_header (b[7], STORE);
337
338       vlib_buffer_copy_template (b[0], &bt);
339       vlib_buffer_copy_template (b[1], &bt);
340       vlib_buffer_copy_template (b[2], &bt);
341       vlib_buffer_copy_template (b[3], &bt);
342
343       b[0]->current_length = dl[0];
344       b[1]->current_length = dl[1];
345       b[2]->current_length = dl[2];
346       b[3]->current_length = dl[3];
347
348       if (is_ip)
349         {
350           next[0] = memif_next_from_ip_hdr (node, b[0]);
351           next[1] = memif_next_from_ip_hdr (node, b[1]);
352           next[2] = memif_next_from_ip_hdr (node, b[2]);
353           next[3] = memif_next_from_ip_hdr (node, b[3]);
354         }
355
356       /* next */
357       n_left -= 4;
358       b += 4;
359       dl += 4;
360       next += 4;
361     }
362
363   while (n_left)
364     {
365       /* enqueue buffer */
366       vlib_buffer_copy_template (b[0], &bt);
367       b[0]->current_length = dl[0];
368       if (is_ip)
369         next[0] = memif_next_from_ip_hdr (node, b[0]);
370
371       /* next */
372       n_left -= 1;
373       b += 1;
374       dl += 1;
375       next += 1;
376     }
377 }
378
379 static_always_inline void
380 memif_fill_buffer_mdata (vlib_main_t *vm, vlib_node_runtime_t *node,
381                          memif_per_thread_data_t *ptd, memif_if_t *mif,
382                          u32 *bi, u16 *next, int is_ip)
383 {
384   u16 buffer_size = vlib_buffer_get_default_data_size (vm);
385   vlib_buffer_t *b0, *b1, *b2, *b3, bt;
386   memif_packet_op_t *po;
387   /* process buffer metadata */
388
389   u32 n_from = ptd->n_packets;
390   po = ptd->packet_ops;
391
392   /* copy template into local variable - will save per packet load */
393   vlib_buffer_copy_template (&bt, &ptd->buffer_template);
394
395   while (n_from >= 8)
396     {
397       b0 = vlib_get_buffer (vm, ptd->buffers[po[4].first_buffer_vec_index]);
398       b1 = vlib_get_buffer (vm, ptd->buffers[po[5].first_buffer_vec_index]);
399       b2 = vlib_get_buffer (vm, ptd->buffers[po[6].first_buffer_vec_index]);
400       b3 = vlib_get_buffer (vm, ptd->buffers[po[7].first_buffer_vec_index]);
401
402       vlib_prefetch_buffer_header (b0, STORE);
403       vlib_prefetch_buffer_header (b1, STORE);
404       vlib_prefetch_buffer_header (b2, STORE);
405       vlib_prefetch_buffer_header (b3, STORE);
406
407       /* enqueue buffer */
408       u32 fbvi[4];
409       fbvi[0] = po[0].first_buffer_vec_index;
410       fbvi[1] = po[1].first_buffer_vec_index;
411       fbvi[2] = po[2].first_buffer_vec_index;
412       fbvi[3] = po[3].first_buffer_vec_index;
413
414       bi[0] = ptd->buffers[fbvi[0]];
415       bi[1] = ptd->buffers[fbvi[1]];
416       bi[2] = ptd->buffers[fbvi[2]];
417       bi[3] = ptd->buffers[fbvi[3]];
418
419       b0 = vlib_get_buffer (vm, bi[0]);
420       b1 = vlib_get_buffer (vm, bi[1]);
421       b2 = vlib_get_buffer (vm, bi[2]);
422       b3 = vlib_get_buffer (vm, bi[3]);
423
424       vlib_buffer_copy_template (b0, &bt);
425       vlib_buffer_copy_template (b1, &bt);
426       vlib_buffer_copy_template (b2, &bt);
427       vlib_buffer_copy_template (b3, &bt);
428
429       b0->current_length = po[0].packet_len;
430       b1->current_length = po[1].packet_len;
431       b2->current_length = po[2].packet_len;
432       b3->current_length = po[3].packet_len;
433
434       memif_add_to_chain (vm, b0, ptd->buffers + fbvi[0] + 1, buffer_size);
435       memif_add_to_chain (vm, b1, ptd->buffers + fbvi[1] + 1, buffer_size);
436       memif_add_to_chain (vm, b2, ptd->buffers + fbvi[2] + 1, buffer_size);
437       memif_add_to_chain (vm, b3, ptd->buffers + fbvi[3] + 1, buffer_size);
438
439       if (is_ip)
440         {
441           next[0] = memif_next_from_ip_hdr (node, b0);
442           next[1] = memif_next_from_ip_hdr (node, b1);
443           next[2] = memif_next_from_ip_hdr (node, b2);
444           next[3] = memif_next_from_ip_hdr (node, b3);
445         }
446
447       /* next */
448       n_from -= 4;
449       po += 4;
450       bi += 4;
451       next += 4;
452     }
453   while (n_from)
454     {
455       u32 fbvi[1];
456       /* enqueue buffer */
457       fbvi[0] = po[0].first_buffer_vec_index;
458       bi[0] = ptd->buffers[fbvi[0]];
459       b0 = vlib_get_buffer (vm, bi[0]);
460       vlib_buffer_copy_template (b0, &bt);
461       b0->current_length = po->packet_len;
462
463       memif_add_to_chain (vm, b0, ptd->buffers + fbvi[0] + 1, buffer_size);
464
465       if (is_ip)
466         next[0] = memif_next_from_ip_hdr (node, b0);
467
468       /* next */
469       n_from -= 1;
470       po += 1;
471       bi += 1;
472       next += 1;
473     }
474 }
475
476 static_always_inline void
477 memif_advance_ring (memif_ring_type_t type, memif_queue_t *mq,
478                     memif_ring_t *ring, u16 cur_slot)
479 {
480   if (type == MEMIF_RING_S2M)
481     {
482       __atomic_store_n (&ring->tail, cur_slot, __ATOMIC_RELEASE);
483       mq->last_head = cur_slot;
484     }
485   else
486     {
487       mq->last_tail = cur_slot;
488     }
489 }
490
491 static_always_inline uword
492 memif_device_input_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
493                            memif_if_t *mif, memif_ring_type_t type, u16 qid,
494                            memif_interface_mode_t mode)
495 {
496   vnet_main_t *vnm = vnet_get_main ();
497   memif_main_t *mm = &memif_main;
498   memif_ring_t *ring;
499   memif_queue_t *mq;
500   u16 buffer_size = vlib_buffer_get_default_data_size (vm);
501   uword n_trace;
502   u16 nexts[MEMIF_RX_VECTOR_SZ], *next = nexts;
503   u32 _to_next_bufs[MEMIF_RX_VECTOR_SZ], *to_next_bufs = _to_next_bufs, *bi;
504   u32 n_left_to_next;
505   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
506   vlib_buffer_t *buffer_ptrs[MEMIF_RX_VECTOR_SZ];
507   u32 thread_index = vm->thread_index;
508   memif_per_thread_data_t *ptd =
509     vec_elt_at_index (mm->per_thread_data, thread_index);
510   u16 cur_slot, ring_size, n_slots, mask;
511   u16 n_buffers, n_alloc, n_desc;
512   i16 start_offset;
513   memif_copy_op_t *co;
514   int is_slave = (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) != 0;
515   int is_simple = 1;
516   int i;
517
518   mq = vec_elt_at_index (mif->rx_queues, qid);
519   ring = mq->ring;
520   ring_size = 1 << mq->log2_ring_size;
521   mask = ring_size - 1;
522
523   start_offset = (mode == MEMIF_INTERFACE_MODE_IP) ? MEMIF_IP_OFFSET : 0;
524
525   if (is_slave)
526     {
527       cur_slot = mq->last_tail;
528       n_slots = __atomic_load_n (&ring->tail, __ATOMIC_ACQUIRE) - cur_slot;
529     }
530   else
531     {
532       cur_slot = mq->last_head;
533       n_slots = __atomic_load_n (&ring->head, __ATOMIC_ACQUIRE) - cur_slot;
534     }
535
536   if (n_slots == 0)
537     goto refill;
538
539   n_desc = memif_parse_desc (ptd, mif, mq, cur_slot, n_slots);
540
541   if (n_desc != ptd->n_packets)
542     is_simple = 0;
543
544   cur_slot += n_desc;
545
546   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
547     memif_validate_desc_data (ptd, mif, n_desc, /* is_ethernet */ 1);
548   else
549     memif_validate_desc_data (ptd, mif, n_desc, /* is_ethernet */ 0);
550
551   if (ptd->max_desc_len > buffer_size - start_offset)
552     is_simple = 0;
553
554   if (ptd->xor_status != 0)
555     is_simple = 0;
556
557   if (is_simple)
558     n_buffers = ptd->n_packets;
559   else
560     n_buffers = memif_process_desc (vm, node, ptd, mif);
561
562   if (PREDICT_FALSE (n_buffers == 0))
563     {
564       /* All descriptors are bad. Release slots in the ring and bail */
565       memif_advance_ring (type, mq, ring, cur_slot);
566       goto refill;
567     }
568
569   /* allocate free buffers */
570   vec_validate_aligned (ptd->buffers, n_buffers - 1, CLIB_CACHE_LINE_BYTES);
571   n_alloc = vlib_buffer_alloc_from_pool (vm, ptd->buffers, n_buffers,
572                                          mq->buffer_pool_index);
573   if (PREDICT_FALSE (n_alloc != n_buffers))
574     {
575       if (n_alloc)
576         vlib_buffer_free (vm, ptd->buffers, n_alloc);
577       vlib_error_count (vm, node->node_index,
578                         MEMIF_INPUT_ERROR_BUFFER_ALLOC_FAIL, 1);
579       goto refill;
580     }
581
582   /* copy data */
583   if (is_simple)
584     {
585       int n_pkts = ptd->n_packets;
586       void **desc_data = ptd->desc_data;
587       u16 *desc_len = ptd->desc_len;
588
589       vlib_get_buffers (vm, ptd->buffers, buffer_ptrs, n_buffers);
590
591       for (i = 0; i + 8 < n_pkts; i++)
592         {
593           clib_prefetch_load (desc_data[i + 8]);
594           clib_prefetch_store (buffer_ptrs[i + 8]->data);
595           clib_memcpy_fast (buffer_ptrs[i]->data + start_offset, desc_data[i],
596                             desc_len[i]);
597         }
598       for (; i < n_pkts; i++)
599         clib_memcpy_fast (buffer_ptrs[i]->data + start_offset, desc_data[i],
600                           desc_len[i]);
601     }
602   else
603     {
604       vlib_buffer_t *b;
605       u32 n_pkts = vec_len (ptd->copy_ops);
606       co = ptd->copy_ops;
607
608       for (i = 0; i + 8 < n_pkts; i++)
609         {
610           clib_prefetch_load (co[i + 8].data);
611           b = vlib_get_buffer (vm, ptd->buffers[co[i].buffer_vec_index]);
612           clib_memcpy_fast (b->data + co[i].buffer_offset, co[i].data,
613                             co[i].data_len);
614         }
615       for (; i < n_pkts; i++)
616         {
617           b = vlib_get_buffer (vm, ptd->buffers[co[i].buffer_vec_index]);
618           clib_memcpy_fast (b->data + co[i].buffer_offset, co[i].data,
619                             co[i].data_len);
620         }
621     }
622
623   /* release slots from the ring */
624   memif_advance_ring (type, mq, ring, cur_slot);
625
626   /* prepare buffer template and next indices */
627   vnet_buffer (&ptd->buffer_template)->sw_if_index[VLIB_RX] = mif->sw_if_index;
628   vnet_buffer (&ptd->buffer_template)->feature_arc_index = 0;
629   ptd->buffer_template.current_data = start_offset;
630   ptd->buffer_template.current_config_index = 0;
631   ptd->buffer_template.buffer_pool_index = mq->buffer_pool_index;
632   ptd->buffer_template.ref_count = 1;
633
634   if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
635     {
636       next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
637       if (mif->per_interface_next_index != ~0)
638         next_index = mif->per_interface_next_index;
639       else
640         vnet_feature_start_device_input_x1 (mif->sw_if_index, &next_index,
641                                             &ptd->buffer_template);
642
643       vlib_get_new_next_frame (vm, node, next_index, to_next_bufs,
644                                n_left_to_next);
645       if (PREDICT_TRUE (next_index == VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT))
646         {
647           vlib_next_frame_t *nf;
648           vlib_frame_t *f;
649           ethernet_input_frame_t *ef;
650           nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
651           f = vlib_get_frame (vm, nf->frame);
652           f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
653
654           ef = vlib_frame_scalar_args (f);
655           ef->sw_if_index = mif->sw_if_index;
656           ef->hw_if_index = mif->hw_if_index;
657           vlib_frame_no_append (f);
658         }
659     }
660
661   if (is_simple)
662     {
663       vlib_buffer_copy_indices (to_next_bufs, ptd->buffers, ptd->n_packets);
664       if (mode == MEMIF_INTERFACE_MODE_IP)
665         memif_fill_buffer_mdata_simple (node, ptd, buffer_ptrs, nexts, 1);
666       else
667         memif_fill_buffer_mdata_simple (node, ptd, buffer_ptrs, nexts, 0);
668     }
669   else
670     {
671       if (mode == MEMIF_INTERFACE_MODE_IP)
672         memif_fill_buffer_mdata (vm, node, ptd, mif, to_next_bufs, nexts, 1);
673       else
674         memif_fill_buffer_mdata (vm, node, ptd, mif, to_next_bufs, nexts, 0);
675     }
676
677   /* packet trace if enabled */
678   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
679     {
680       u32 n_left = ptd->n_packets;
681       bi = to_next_bufs;
682       next = nexts;
683       u32 ni = next_index;
684       while (n_trace && n_left)
685         {
686           vlib_buffer_t *b;
687           memif_input_trace_t *tr;
688           if (mode != MEMIF_INTERFACE_MODE_ETHERNET)
689             ni = next[0];
690           b = vlib_get_buffer (vm, bi[0]);
691           if (PREDICT_TRUE
692               (vlib_trace_buffer (vm, node, ni, b, /* follow_chain */ 0)))
693             {
694               tr = vlib_add_trace (vm, node, b, sizeof (*tr));
695               tr->next_index = ni;
696               tr->hw_if_index = mif->hw_if_index;
697               tr->ring = qid;
698               n_trace--;
699             }
700
701           /* next */
702           n_left--;
703           bi++;
704           next++;
705         }
706       vlib_set_trace_count (vm, node, n_trace);
707     }
708
709   if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
710     {
711       n_left_to_next -= ptd->n_packets;
712       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
713     }
714   else
715     vlib_buffer_enqueue_to_next (vm, node, to_next_bufs, nexts,
716                                  ptd->n_packets);
717
718   vlib_increment_combined_counter (
719     vnm->interface_main.combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
720     thread_index, mif->sw_if_index, ptd->n_packets, ptd->n_rx_bytes);
721
722   /* refill ring with empty buffers */
723 refill:
724   vec_reset_length (ptd->buffers);
725   vec_reset_length (ptd->copy_ops);
726
727   if (type == MEMIF_RING_M2S)
728     {
729       u16 head = ring->head;
730       n_slots = ring_size - head + mq->last_tail;
731
732       while (n_slots--)
733         {
734           u16 s = head++ & mask;
735           memif_desc_t *d = &ring->desc[s];
736           d->length = mif->run.buffer_size;
737         }
738
739       __atomic_store_n (&ring->head, head, __ATOMIC_RELEASE);
740     }
741
742   return ptd->n_packets;
743 }
744
745 static_always_inline uword
746 memif_device_input_zc_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
747                               memif_if_t *mif, u16 qid,
748                               memif_interface_mode_t mode)
749 {
750   vnet_main_t *vnm = vnet_get_main ();
751   memif_main_t *mm = &memif_main;
752   memif_ring_t *ring;
753   memif_queue_t *mq;
754   u32 next_index;
755   uword n_trace = vlib_get_trace_count (vm, node);
756   u32 n_rx_packets = 0, n_rx_bytes = 0;
757   u32 *to_next = 0, *buffers;
758   u32 bi0, bi1, bi2, bi3;
759   u16 slot, s0;
760   memif_desc_t *d0;
761   vlib_buffer_t *b0, *b1, *b2, *b3;
762   u32 thread_index = vm->thread_index;
763   memif_per_thread_data_t *ptd = vec_elt_at_index (mm->per_thread_data,
764                                                    thread_index);
765   u16 cur_slot, last_slot, ring_size, n_slots, mask, head;
766   i16 start_offset;
767   u64 offset;
768   u32 buffer_length;
769   u16 n_alloc, n_from;
770
771   mq = vec_elt_at_index (mif->rx_queues, qid);
772   ring = mq->ring;
773   ring_size = 1 << mq->log2_ring_size;
774   mask = ring_size - 1;
775
776   next_index = (mode == MEMIF_INTERFACE_MODE_IP) ?
777     VNET_DEVICE_INPUT_NEXT_IP6_INPUT : VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
778
779   /* asume that somebody will want to add ethernet header on the packet
780      so start with IP header at offset 14 */
781   start_offset = (mode == MEMIF_INTERFACE_MODE_IP) ? 14 : 0;
782   buffer_length = vlib_buffer_get_default_data_size (vm) - start_offset;
783
784   cur_slot = mq->last_tail;
785   last_slot = __atomic_load_n (&ring->tail, __ATOMIC_ACQUIRE);
786   if (cur_slot == last_slot)
787     goto refill;
788   n_slots = last_slot - cur_slot;
789
790   /* process ring slots */
791   vec_validate_aligned (ptd->buffers, MEMIF_RX_VECTOR_SZ,
792                         CLIB_CACHE_LINE_BYTES);
793   while (n_slots && n_rx_packets < MEMIF_RX_VECTOR_SZ)
794     {
795       vlib_buffer_t *hb;
796
797       s0 = cur_slot & mask;
798       bi0 = mq->buffers[s0];
799       ptd->buffers[n_rx_packets++] = bi0;
800
801       clib_prefetch_load (&ring->desc[(cur_slot + 8) & mask]);
802       d0 = &ring->desc[s0];
803       hb = b0 = vlib_get_buffer (vm, bi0);
804       b0->current_data = start_offset;
805       b0->current_length = d0->length;
806       n_rx_bytes += d0->length;
807
808       cur_slot++;
809       n_slots--;
810       if (PREDICT_FALSE ((d0->flags & MEMIF_DESC_FLAG_NEXT) && n_slots))
811         {
812           hb->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
813           hb->total_length_not_including_first_buffer = 0;
814         next_slot:
815           s0 = cur_slot & mask;
816           d0 = &ring->desc[s0];
817           bi0 = mq->buffers[s0];
818
819           /* previous buffer */
820           b0->next_buffer = bi0;
821           b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
822
823           /* current buffer */
824           b0 = vlib_get_buffer (vm, bi0);
825           b0->current_data = start_offset;
826           b0->current_length = d0->length;
827           hb->total_length_not_including_first_buffer += d0->length;
828           n_rx_bytes += d0->length;
829
830           cur_slot++;
831           n_slots--;
832           if ((d0->flags & MEMIF_DESC_FLAG_NEXT) && n_slots)
833             goto next_slot;
834         }
835     }
836
837   /* release slots from the ring */
838   mq->last_tail = cur_slot;
839
840   n_from = n_rx_packets;
841   buffers = ptd->buffers;
842
843   while (n_from)
844     {
845       u32 n_left_to_next;
846       u32 next0, next1, next2, next3;
847
848       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
849       while (n_from >= 8 && n_left_to_next >= 4)
850         {
851           b0 = vlib_get_buffer (vm, buffers[4]);
852           b1 = vlib_get_buffer (vm, buffers[5]);
853           b2 = vlib_get_buffer (vm, buffers[6]);
854           b3 = vlib_get_buffer (vm, buffers[7]);
855           vlib_prefetch_buffer_header (b0, STORE);
856           vlib_prefetch_buffer_header (b1, STORE);
857           vlib_prefetch_buffer_header (b2, STORE);
858           vlib_prefetch_buffer_header (b3, STORE);
859
860           /* enqueue buffer */
861           to_next[0] = bi0 = buffers[0];
862           to_next[1] = bi1 = buffers[1];
863           to_next[2] = bi2 = buffers[2];
864           to_next[3] = bi3 = buffers[3];
865           to_next += 4;
866           n_left_to_next -= 4;
867           buffers += 4;
868
869           b0 = vlib_get_buffer (vm, bi0);
870           b1 = vlib_get_buffer (vm, bi1);
871           b2 = vlib_get_buffer (vm, bi2);
872           b3 = vlib_get_buffer (vm, bi3);
873
874           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
875           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
876           vnet_buffer (b1)->sw_if_index[VLIB_RX] = mif->sw_if_index;
877           vnet_buffer (b1)->sw_if_index[VLIB_TX] = ~0;
878           vnet_buffer (b2)->sw_if_index[VLIB_RX] = mif->sw_if_index;
879           vnet_buffer (b2)->sw_if_index[VLIB_TX] = ~0;
880           vnet_buffer (b3)->sw_if_index[VLIB_RX] = mif->sw_if_index;
881           vnet_buffer (b3)->sw_if_index[VLIB_TX] = ~0;
882
883           if (mode == MEMIF_INTERFACE_MODE_IP)
884             {
885               next0 = memif_next_from_ip_hdr (node, b0);
886               next1 = memif_next_from_ip_hdr (node, b1);
887               next2 = memif_next_from_ip_hdr (node, b2);
888               next3 = memif_next_from_ip_hdr (node, b3);
889             }
890           else if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
891             {
892               if (PREDICT_FALSE (mif->per_interface_next_index != ~0))
893                 {
894                   next0 = mif->per_interface_next_index;
895                   next1 = mif->per_interface_next_index;
896                   next2 = mif->per_interface_next_index;
897                   next3 = mif->per_interface_next_index;
898                 }
899               else
900                 {
901                   next0 = next1 = next2 = next3 = next_index;
902                   /* redirect if feature path enabled */
903                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
904                                                       &next0, b0);
905                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
906                                                       &next1, b1);
907                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
908                                                       &next2, b2);
909                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
910                                                       &next3, b3);
911                 }
912             }
913
914           /* trace */
915           if (PREDICT_FALSE (n_trace > 0))
916             {
917               memif_trace_buffer (vm, node, mif, b0, next0, qid, &n_trace);
918               if (PREDICT_FALSE (n_trace > 0))
919                 memif_trace_buffer (vm, node, mif, b1, next1, qid, &n_trace);
920               if (PREDICT_FALSE (n_trace > 0))
921                 memif_trace_buffer (vm, node, mif, b2, next2, qid, &n_trace);
922               if (PREDICT_FALSE (n_trace > 0))
923                 memif_trace_buffer (vm, node, mif, b3, next3, qid, &n_trace);
924             }
925
926           /* enqueue */
927           vlib_validate_buffer_enqueue_x4 (vm, node, next_index, to_next,
928                                            n_left_to_next, bi0, bi1, bi2, bi3,
929                                            next0, next1, next2, next3);
930
931           /* next */
932           n_from -= 4;
933         }
934       while (n_from && n_left_to_next)
935         {
936           /* enqueue buffer */
937           to_next[0] = bi0 = buffers[0];
938           to_next += 1;
939           n_left_to_next--;
940           buffers += 1;
941
942           b0 = vlib_get_buffer (vm, bi0);
943           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
944           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
945
946           if (mode == MEMIF_INTERFACE_MODE_IP)
947             {
948               next0 = memif_next_from_ip_hdr (node, b0);
949             }
950           else if (mode == MEMIF_INTERFACE_MODE_ETHERNET)
951             {
952               if (PREDICT_FALSE (mif->per_interface_next_index != ~0))
953                 next0 = mif->per_interface_next_index;
954               else
955                 {
956                   next0 = next_index;
957                   /* redirect if feature path enabled */
958                   vnet_feature_start_device_input_x1 (mif->sw_if_index,
959                                                       &next0, b0);
960                 }
961             }
962
963           /* trace */
964           if (PREDICT_FALSE (n_trace > 0))
965             memif_trace_buffer (vm, node, mif, b0, next0, qid, &n_trace);
966
967           /* enqueue */
968           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
969                                            n_left_to_next, bi0, next0);
970
971           /* next */
972           n_from--;
973         }
974       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
975     }
976
977   vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
978                                    + VNET_INTERFACE_COUNTER_RX, thread_index,
979                                    mif->sw_if_index, n_rx_packets,
980                                    n_rx_bytes);
981
982   /* refill ring with empty buffers */
983 refill:
984   vec_reset_length (ptd->buffers);
985
986   head = ring->head;
987   n_slots = ring_size - head + mq->last_tail;
988   slot = head & mask;
989
990   n_slots &= ~7;
991
992   if (n_slots < 32)
993     goto done;
994
995   memif_desc_t desc_template, *dt = &desc_template;
996   clib_memset (dt, 0, sizeof (memif_desc_t));
997   dt->length = buffer_length;
998
999   n_alloc = vlib_buffer_alloc_to_ring_from_pool (
1000     vm, mq->buffers, slot, ring_size, n_slots, mq->buffer_pool_index);
1001   dt->region = mq->buffer_pool_index + 1;
1002   offset = (u64) mif->regions[dt->region].shm - start_offset;
1003
1004   if (PREDICT_FALSE (n_alloc != n_slots))
1005     vlib_error_count (vm, node->node_index,
1006                       MEMIF_INPUT_ERROR_BUFFER_ALLOC_FAIL, 1);
1007
1008   head += n_alloc;
1009
1010   while (n_alloc)
1011     {
1012       memif_desc_t *d = ring->desc + slot;
1013       u32 *bi = mq->buffers + slot;
1014
1015       if (PREDICT_FALSE (((slot + 7 > mask) || (n_alloc < 8))))
1016         goto one_by_one;
1017
1018       clib_memcpy_fast (d + 0, dt, sizeof (memif_desc_t));
1019       clib_memcpy_fast (d + 1, dt, sizeof (memif_desc_t));
1020       clib_memcpy_fast (d + 2, dt, sizeof (memif_desc_t));
1021       clib_memcpy_fast (d + 3, dt, sizeof (memif_desc_t));
1022       clib_memcpy_fast (d + 4, dt, sizeof (memif_desc_t));
1023       clib_memcpy_fast (d + 5, dt, sizeof (memif_desc_t));
1024       clib_memcpy_fast (d + 6, dt, sizeof (memif_desc_t));
1025       clib_memcpy_fast (d + 7, dt, sizeof (memif_desc_t));
1026
1027       d[0].offset = (u64) vlib_get_buffer (vm, bi[0])->data - offset;
1028       d[1].offset = (u64) vlib_get_buffer (vm, bi[1])->data - offset;
1029       d[2].offset = (u64) vlib_get_buffer (vm, bi[2])->data - offset;
1030       d[3].offset = (u64) vlib_get_buffer (vm, bi[3])->data - offset;
1031       d[4].offset = (u64) vlib_get_buffer (vm, bi[4])->data - offset;
1032       d[5].offset = (u64) vlib_get_buffer (vm, bi[5])->data - offset;
1033       d[6].offset = (u64) vlib_get_buffer (vm, bi[6])->data - offset;
1034       d[7].offset = (u64) vlib_get_buffer (vm, bi[7])->data - offset;
1035
1036       slot = (slot + 8) & mask;
1037       n_alloc -= 8;
1038       continue;
1039
1040     one_by_one:
1041       clib_memcpy_fast (d, dt, sizeof (memif_desc_t));
1042       d[0].offset = (u64) vlib_get_buffer (vm, bi[0])->data - offset;
1043
1044       slot = (slot + 1) & mask;
1045       n_alloc -= 1;
1046     }
1047
1048   __atomic_store_n (&ring->head, head, __ATOMIC_RELEASE);
1049
1050 done:
1051   return n_rx_packets;
1052 }
1053
1054
1055 VLIB_NODE_FN (memif_input_node) (vlib_main_t * vm,
1056                                  vlib_node_runtime_t * node,
1057                                  vlib_frame_t * frame)
1058 {
1059   u32 n_rx = 0;
1060   memif_main_t *mm = &memif_main;
1061   memif_interface_mode_t mode_ip = MEMIF_INTERFACE_MODE_IP;
1062   memif_interface_mode_t mode_eth = MEMIF_INTERFACE_MODE_ETHERNET;
1063
1064   vnet_hw_if_rxq_poll_vector_t *pv;
1065   pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
1066   for (int i = 0; i < vec_len (pv); i++)
1067     {
1068       memif_if_t *mif;
1069       u32 qid;
1070       mif = vec_elt_at_index (mm->interfaces, pv[i].dev_instance);
1071       qid = pv[i].queue_id;
1072       if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) &&
1073           (mif->flags & MEMIF_IF_FLAG_CONNECTED))
1074         {
1075           if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
1076             {
1077               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1078                 n_rx +=
1079                   memif_device_input_zc_inline (vm, node, mif, qid, mode_ip);
1080               else
1081                 n_rx +=
1082                   memif_device_input_zc_inline (vm, node, mif, qid, mode_eth);
1083             }
1084           else if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
1085             {
1086               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1087                 n_rx += memif_device_input_inline (
1088                   vm, node, mif, MEMIF_RING_M2S, qid, mode_ip);
1089               else
1090                 n_rx += memif_device_input_inline (
1091                   vm, node, mif, MEMIF_RING_M2S, qid, mode_eth);
1092             }
1093           else
1094             {
1095               if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1096                 n_rx += memif_device_input_inline (
1097                   vm, node, mif, MEMIF_RING_S2M, qid, mode_ip);
1098               else
1099                 n_rx += memif_device_input_inline (
1100                   vm, node, mif, MEMIF_RING_S2M, qid, mode_eth);
1101             }
1102         }
1103     }
1104
1105   return n_rx;
1106 }
1107
1108 /* *INDENT-OFF* */
1109 VLIB_REGISTER_NODE (memif_input_node) = {
1110   .name = "memif-input",
1111   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1112   .sibling_of = "device-input",
1113   .format_trace = format_memif_input_trace,
1114   .type = VLIB_NODE_TYPE_INPUT,
1115   .state = VLIB_NODE_STATE_INTERRUPT,
1116   .n_errors = MEMIF_INPUT_N_ERROR,
1117   .error_counters = memif_input_error_counters,
1118 };
1119
1120 /* *INDENT-ON* */
1121
1122
1123 /*
1124  * fd.io coding-style-patch-verification: ON
1125  *
1126  * Local Variables:
1127  * eval: (c-set-style "gnu")
1128  * End:
1129  */