Add memif - packet memory interface for intra-host communication
[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/devices/devices.h>
28 #include <vnet/feature/feature.h>
29
30 #include <memif/memif.h>
31
32 #define foreach_memif_input_error
33
34 typedef enum
35 {
36 #define _(f,s) MEMIF_INPUT_ERROR_##f,
37   foreach_memif_input_error
38 #undef _
39     MEMIF_INPUT_N_ERROR,
40 } memif_input_error_t;
41
42 static char *memif_input_error_strings[] = {
43 #define _(n,s) s,
44   foreach_memif_input_error
45 #undef _
46 };
47
48 typedef struct
49 {
50   u32 next_index;
51   u32 hw_if_index;
52   u16 ring;
53 } memif_input_trace_t;
54
55 static u8 *
56 format_memif_input_trace (u8 * s, va_list * args)
57 {
58   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
59   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
60   memif_input_trace_t *t = va_arg (*args, memif_input_trace_t *);
61   uword indent = format_get_indent (s);
62
63   s = format (s, "memif: hw_if_index %d next-index %d",
64               t->hw_if_index, t->next_index);
65   s = format (s, "\n%Uslot: ring %u", format_white_space, indent + 2,
66               t->ring);
67   return s;
68 }
69
70 static_always_inline void
71 memif_prefetch (vlib_main_t * vm, u32 bi)
72 {
73   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
74   vlib_prefetch_buffer_header (b, STORE);
75   CLIB_PREFETCH (b->data, CLIB_CACHE_LINE_BYTES, STORE);
76 }
77
78 static_always_inline uword
79 memif_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
80                            vlib_frame_t * frame, memif_if_t * mif,
81                            memif_ring_type_t type)
82 {
83   vnet_main_t *vnm = vnet_get_main ();
84   u8 rid = 0;                   /* Ring id */
85   memif_ring_t *ring = memif_get_ring (mif, type, rid);
86   memif_ring_data_t *rd =
87     vec_elt_at_index (mif->ring_data, rid + type * mif->num_s2m_rings);
88   u16 head;
89
90   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
91   uword n_trace = vlib_get_trace_count (vm, node);
92   memif_main_t *nm = &memif_main;
93   u32 n_rx_packets = 0;
94   u32 n_rx_bytes = 0;
95   u32 *to_next = 0;
96   u32 n_free_bufs;
97   u32 cpu_index = os_get_cpu_number ();
98   u32 bi0, bi1;
99   vlib_buffer_t *b0, *b1;
100   u16 ring_size = 1 << mif->log2_ring_size;
101   u16 mask = ring_size - 1;
102   u16 num_slots;
103   void *mb0, *mb1;
104
105   if (mif->per_interface_next_index != ~0)
106     next_index = mif->per_interface_next_index;
107
108   n_free_bufs = vec_len (nm->rx_buffers[cpu_index]);
109   if (PREDICT_FALSE (n_free_bufs < ring_size))
110     {
111       vec_validate (nm->rx_buffers[cpu_index], ring_size + n_free_bufs - 1);
112       n_free_bufs +=
113         vlib_buffer_alloc (vm, &nm->rx_buffers[cpu_index][n_free_bufs],
114                            ring_size);
115       _vec_len (nm->rx_buffers[cpu_index]) = n_free_bufs;
116     }
117
118   head = ring->head;
119   if (head == rd->last_head)
120     return 0;
121
122   if (head > rd->last_head)
123     num_slots = head - rd->last_head;
124   else
125     num_slots = ring_size - rd->last_head + head;
126
127   while (num_slots)
128     {
129       u32 n_left_to_next;
130       u32 next0 = next_index;
131       u32 next1 = next_index;
132       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
133
134       while (num_slots > 5 && n_left_to_next > 2)
135         {
136           if (PREDICT_TRUE (rd->last_head + 5 < ring_size))
137             {
138               CLIB_PREFETCH (memif_get_buffer (mif, ring, rd->last_head + 2),
139                              CLIB_CACHE_LINE_BYTES, LOAD);
140               CLIB_PREFETCH (memif_get_buffer (mif, ring, rd->last_head + 3),
141                              CLIB_CACHE_LINE_BYTES, LOAD);
142               CLIB_PREFETCH (&ring->desc[rd->last_head + 4],
143                              CLIB_CACHE_LINE_BYTES, LOAD);
144               CLIB_PREFETCH (&ring->desc[rd->last_head + 5],
145                              CLIB_CACHE_LINE_BYTES, LOAD);
146             }
147           else
148             {
149               CLIB_PREFETCH (memif_get_buffer
150                              (mif, ring, (rd->last_head + 2) % mask),
151                              CLIB_CACHE_LINE_BYTES, LOAD);
152               CLIB_PREFETCH (memif_get_buffer
153                              (mif, ring, (rd->last_head + 3) % mask),
154                              CLIB_CACHE_LINE_BYTES, LOAD);
155               CLIB_PREFETCH (&ring->desc[(rd->last_head + 4) % mask],
156                              CLIB_CACHE_LINE_BYTES, LOAD);
157               CLIB_PREFETCH (&ring->desc[(rd->last_head + 5) % mask],
158                              CLIB_CACHE_LINE_BYTES, LOAD);
159             }
160           /* get empty buffer */
161           u32 last_buf = vec_len (nm->rx_buffers[cpu_index]) - 1;
162           bi0 = nm->rx_buffers[cpu_index][last_buf];
163           bi1 = nm->rx_buffers[cpu_index][last_buf - 1];
164           _vec_len (nm->rx_buffers[cpu_index]) -= 2;
165
166           if (last_buf > 4)
167             {
168               memif_prefetch (vm, nm->rx_buffers[cpu_index][last_buf - 2]);
169               memif_prefetch (vm, nm->rx_buffers[cpu_index][last_buf - 3]);
170             }
171
172           /* enqueue buffer */
173           to_next[0] = bi0;
174           to_next[1] = bi1;
175           to_next += 2;
176           n_left_to_next -= 2;
177
178           /* fill buffer metadata */
179           b0 = vlib_get_buffer (vm, bi0);
180           b1 = vlib_get_buffer (vm, bi1);
181
182           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
183           vnet_buffer (b1)->sw_if_index[VLIB_RX] = mif->sw_if_index;
184
185           vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
186           vnet_buffer (b1)->sw_if_index[VLIB_TX] = (u32) ~ 0;
187
188           /* copy buffer */
189           mb0 = memif_get_buffer (mif, ring, rd->last_head);
190           clib_memcpy (vlib_buffer_get_current (b0), mb0,
191                        CLIB_CACHE_LINE_BYTES);
192           b0->current_length = ring->desc[rd->last_head].length;
193           rd->last_head = (rd->last_head + 1) & mask;
194
195           mb1 = memif_get_buffer (mif, ring, rd->last_head);
196           clib_memcpy (vlib_buffer_get_current (b1), mb1,
197                        CLIB_CACHE_LINE_BYTES);
198           b1->current_length = ring->desc[rd->last_head].length;
199           rd->last_head = (rd->last_head + 1) & mask;
200
201           if (b0->current_length > CLIB_CACHE_LINE_BYTES)
202             clib_memcpy (vlib_buffer_get_current (b0) + CLIB_CACHE_LINE_BYTES,
203                          mb0 + CLIB_CACHE_LINE_BYTES,
204                          b0->current_length - CLIB_CACHE_LINE_BYTES);
205
206           if (b1->current_length > CLIB_CACHE_LINE_BYTES)
207             clib_memcpy (vlib_buffer_get_current (b1) + CLIB_CACHE_LINE_BYTES,
208                          mb1 + CLIB_CACHE_LINE_BYTES,
209                          b1->current_length - CLIB_CACHE_LINE_BYTES);
210
211           /* trace */
212           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
213           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
214
215           if (PREDICT_FALSE (n_trace > 0))
216             {
217               if (b0)
218                 {
219                   memif_input_trace_t *tr;
220                   vlib_trace_buffer (vm, node, next0, b0,
221                                      /* follow_chain */ 0);
222                   vlib_set_trace_count (vm, node, --n_trace);
223                   tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
224                   tr->next_index = next0;
225                   tr->hw_if_index = mif->hw_if_index;
226                   tr->ring = rid;
227                 }
228
229               if (n_trace && b1)
230                 {
231                   memif_input_trace_t *tr;
232                   vlib_trace_buffer (vm, node, next1, b1,
233                                      /* follow_chain */ 0);
234                   vlib_set_trace_count (vm, node, --n_trace);
235                   tr = vlib_add_trace (vm, node, b1, sizeof (*tr));
236                   tr->next_index = next1;
237                   tr->hw_if_index = mif->hw_if_index;
238                   tr->ring = rid;
239                 }
240             }
241
242           /* redirect if feature path enabled */
243           vnet_feature_start_device_input_x2 (mif->sw_if_index,
244                                               &next0, &next1, b0, b1);
245
246           /* enqueue */
247           vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
248                                            n_left_to_next,
249                                            bi0, bi1, next0, next1);
250
251           /* next packet */
252           num_slots -= 2;
253           n_rx_packets += 2;
254           n_rx_bytes += b0->current_length;
255           n_rx_bytes += b1->current_length;
256         }
257       while (num_slots && n_left_to_next)
258         {
259           /* get empty buffer */
260           u32 last_buf = vec_len (nm->rx_buffers[cpu_index]) - 1;
261           bi0 = nm->rx_buffers[cpu_index][last_buf];
262           _vec_len (nm->rx_buffers[cpu_index]) = last_buf;
263
264           /* enqueue buffer */
265           to_next[0] = bi0;
266           to_next += 1;
267           n_left_to_next--;
268
269           /* fill buffer metadata */
270           b0 = vlib_get_buffer (vm, bi0);
271           b0->current_length = ring->desc[rd->last_head].length;
272           vnet_buffer (b0)->sw_if_index[VLIB_RX] = mif->sw_if_index;
273           vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
274
275           /* copy buffer */
276           mb0 = memif_get_buffer (mif, ring, rd->last_head);
277           clib_memcpy (vlib_buffer_get_current (b0), mb0,
278                        CLIB_CACHE_LINE_BYTES);
279           if (b0->current_length > CLIB_CACHE_LINE_BYTES)
280             clib_memcpy (vlib_buffer_get_current (b0) + CLIB_CACHE_LINE_BYTES,
281                          mb0 + CLIB_CACHE_LINE_BYTES,
282                          b0->current_length - CLIB_CACHE_LINE_BYTES);
283
284           /* trace */
285           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
286
287           if (PREDICT_FALSE (n_trace > 0))
288             {
289               if (b0)
290                 {
291                   memif_input_trace_t *tr;
292                   vlib_trace_buffer (vm, node, next0, b0,
293                                      /* follow_chain */ 0);
294                   vlib_set_trace_count (vm, node, --n_trace);
295                   tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
296                   tr->next_index = next0;
297                   tr->hw_if_index = mif->hw_if_index;
298                   tr->ring = rid;
299                 }
300             }
301
302
303           /* redirect if feature path enabled */
304           vnet_feature_start_device_input_x1 (mif->sw_if_index, &next0, b0);
305
306           /* enqueue */
307           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
308                                            n_left_to_next, bi0, next0);
309
310           /* next packet */
311           rd->last_head = (rd->last_head + 1) & mask;
312           num_slots--;
313           n_rx_packets++;
314           n_rx_bytes += b0->current_length;
315         }
316       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
317     }
318   CLIB_MEMORY_STORE_BARRIER ();
319   ring->tail = head;
320
321   vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
322                                    + VNET_INTERFACE_COUNTER_RX, cpu_index,
323                                    mif->hw_if_index, n_rx_packets,
324                                    n_rx_bytes);
325
326   return n_rx_packets;
327 }
328
329 static uword
330 memif_input_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
331                 vlib_frame_t * frame)
332 {
333   u32 n_rx_packets = 0;
334   u32 cpu_index = os_get_cpu_number ();
335   memif_main_t *nm = &memif_main;
336   memif_if_t *mif;
337
338   /* *INDENT-OFF* */
339   pool_foreach (mif, nm->interfaces,
340     ({
341       if (mif->flags & MEMIF_IF_FLAG_ADMIN_UP &&
342           mif->flags & MEMIF_IF_FLAG_CONNECTED &&
343           (mif->if_index % nm->input_cpu_count) ==
344           (cpu_index - nm->input_cpu_first_index))
345         {
346           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
347             n_rx_packets +=
348               memif_device_input_inline (vm, node, frame, mif,
349                                          MEMIF_RING_M2S);
350           else
351             n_rx_packets +=
352               memif_device_input_inline (vm, node, frame, mif,
353                                          MEMIF_RING_S2M);
354         }
355     }));
356   /* *INDENT-ON* */
357
358   return n_rx_packets;
359 }
360
361 /* *INDENT-OFF* */
362 VLIB_REGISTER_NODE (memif_input_node) = {
363   .function = memif_input_fn,
364   .name = "memif-input",
365   .sibling_of = "device-input",
366   .format_trace = format_memif_input_trace,
367   .type = VLIB_NODE_TYPE_INPUT,
368   .state = VLIB_NODE_STATE_INTERRUPT,
369   .n_errors = MEMIF_INPUT_N_ERROR,
370   .error_strings = memif_input_error_strings,
371 };
372
373 VLIB_NODE_FUNCTION_MULTIARCH (memif_input_node, memif_input_fn)
374 /* *INDENT-ON* */
375
376
377 /*
378  * fd.io coding-style-patch-verification: ON
379  *
380  * Local Variables:
381  * eval: (c-set-style "gnu")
382  * End:
383  */