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