vlib: refactor trajectory trace debug feature
[vpp.git] / extras / deprecated / netmap / 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 #include <stdint.h>
19 #include <net/if.h>
20 #include <sys/ioctl.h>
21
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/devices/devices.h>
26 #include <vnet/feature/feature.h>
27
28 #include <vnet/devices/netmap/net_netmap.h>
29 #include <vnet/devices/netmap/netmap.h>
30
31 #define foreach_netmap_input_error
32
33 typedef enum
34 {
35 #define _(f,s) NETMAP_INPUT_ERROR_##f,
36   foreach_netmap_input_error
37 #undef _
38     NETMAP_INPUT_N_ERROR,
39 } netmap_input_error_t;
40
41 static char *netmap_input_error_strings[] = {
42 #define _(n,s) s,
43   foreach_netmap_input_error
44 #undef _
45 };
46
47 typedef struct
48 {
49   u32 next_index;
50   u32 hw_if_index;
51   struct netmap_slot slot;
52 } netmap_input_trace_t;
53
54 static u8 *
55 format_netmap_input_trace (u8 * s, va_list * args)
56 {
57   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
58   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
59   netmap_input_trace_t *t = va_arg (*args, netmap_input_trace_t *);
60   u32 indent = format_get_indent (s);
61
62   s = format (s, "netmap: hw_if_index %d next-index %d",
63               t->hw_if_index, t->next_index);
64   s = format (s, "\n%Uslot: flags 0x%x len %u buf_idx %u",
65               format_white_space, indent + 2,
66               t->slot.flags, t->slot.len, t->slot.buf_idx);
67   return s;
68 }
69
70 always_inline void
71 buffer_add_to_chain (vlib_main_t * vm, u32 bi, u32 first_bi, u32 prev_bi)
72 {
73   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
74   vlib_buffer_t *first_b = vlib_get_buffer (vm, first_bi);
75   vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_bi);
76
77   /* update first buffer */
78   first_b->total_length_not_including_first_buffer += b->current_length;
79
80   /* update previous buffer */
81   prev_b->next_buffer = bi;
82   prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
83
84   /* update current buffer */
85   b->next_buffer = 0;
86 }
87
88 always_inline uword
89 netmap_device_input_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
90                         vlib_frame_t * frame, netmap_if_t * nif)
91 {
92   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
93   uword n_trace = vlib_get_trace_count (vm, node);
94   netmap_main_t *nm = &netmap_main;
95   u32 n_rx_packets = 0;
96   u32 n_rx_bytes = 0;
97   u32 *to_next = 0;
98   u32 n_free_bufs;
99   struct netmap_ring *ring;
100   int cur_ring;
101   u32 thread_index = vm->thread_index;
102   u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
103
104   if (nif->per_interface_next_index != ~0)
105     next_index = nif->per_interface_next_index;
106
107   n_free_bufs = vec_len (nm->rx_buffers[thread_index]);
108   if (PREDICT_FALSE (n_free_bufs < VLIB_FRAME_SIZE))
109     {
110       vec_validate (nm->rx_buffers[thread_index],
111                     VLIB_FRAME_SIZE + n_free_bufs - 1);
112       n_free_bufs +=
113         vlib_buffer_alloc (vm, &nm->rx_buffers[thread_index][n_free_bufs],
114                            VLIB_FRAME_SIZE);
115       _vec_len (nm->rx_buffers[thread_index]) = n_free_bufs;
116     }
117
118   cur_ring = nif->first_rx_ring;
119   while (cur_ring <= nif->last_rx_ring && n_free_bufs)
120     {
121       int r = 0;
122       u32 cur_slot_index;
123       ring = NETMAP_RXRING (nif->nifp, cur_ring);
124       r = nm_ring_space (ring);
125
126       if (!r)
127         {
128           cur_ring++;
129           continue;
130         }
131
132       if (r > n_free_bufs)
133         r = n_free_bufs;
134
135       cur_slot_index = ring->cur;
136       while (r)
137         {
138           u32 n_left_to_next;
139           u32 next0 = next_index;
140           vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
141
142           while (r && n_left_to_next)
143             {
144               vlib_buffer_t *first_b0 = 0;
145               u32 offset = 0;
146               u32 bi0 = 0, first_bi0 = 0, prev_bi0;
147               u32 next_slot_index = (cur_slot_index + 1) % ring->num_slots;
148               u32 next2_slot_index = (cur_slot_index + 2) % ring->num_slots;
149               struct netmap_slot *slot = &ring->slot[cur_slot_index];
150               u32 data_len = slot->len;
151
152               /* prefetch 2 slots in advance */
153               CLIB_PREFETCH (&ring->slot[next2_slot_index],
154                              CLIB_CACHE_LINE_BYTES, LOAD);
155               /* prefetch start of next packet */
156               CLIB_PREFETCH (NETMAP_BUF
157                              (ring, ring->slot[next_slot_index].buf_idx),
158                              CLIB_CACHE_LINE_BYTES, LOAD);
159
160               while (data_len && n_free_bufs)
161                 {
162                   vlib_buffer_t *b0;
163                   /* grab free buffer */
164                   u32 last_empty_buffer =
165                     vec_len (nm->rx_buffers[thread_index]) - 1;
166                   prev_bi0 = bi0;
167                   bi0 = nm->rx_buffers[thread_index][last_empty_buffer];
168                   b0 = vlib_get_buffer (vm, bi0);
169                   _vec_len (nm->rx_buffers[thread_index]) = last_empty_buffer;
170                   n_free_bufs--;
171
172                   /* copy data */
173                   u32 bytes_to_copy =
174                     data_len > n_buffer_bytes ? n_buffer_bytes : data_len;
175                   b0->current_data = 0;
176                   clib_memcpy_fast (vlib_buffer_get_current (b0),
177                                     (u8 *) NETMAP_BUF (ring, slot->buf_idx) +
178                                     offset, bytes_to_copy);
179
180                   /* fill buffer header */
181                   b0->current_length = bytes_to_copy;
182
183                   if (offset == 0)
184                     {
185                       b0->total_length_not_including_first_buffer = 0;
186                       b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
187                       vnet_buffer (b0)->sw_if_index[VLIB_RX] =
188                         nif->sw_if_index;
189                       vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
190                       first_bi0 = bi0;
191                       first_b0 = vlib_get_buffer (vm, first_bi0);
192                     }
193                   else
194                     buffer_add_to_chain (vm, bi0, first_bi0, prev_bi0);
195
196                   offset += bytes_to_copy;
197                   data_len -= bytes_to_copy;
198                 }
199
200               /* trace */
201               if (PREDICT_FALSE (n_trace > 0))
202                 {
203                   if (PREDICT_TRUE (first_b0 != 0))
204                     {
205                       netmap_input_trace_t *tr;
206                       vlib_trace_buffer (vm, node, next0, first_b0,
207                                          /* follow_chain */ 0);
208                       vlib_set_trace_count (vm, node, --n_trace);
209                       tr = vlib_add_trace (vm, node, first_b0, sizeof (*tr));
210                       tr->next_index = next0;
211                       tr->hw_if_index = nif->hw_if_index;
212                       memcpy (&tr->slot, slot, sizeof (struct netmap_slot));
213                     }
214                 }
215
216               /* redirect if feature path enabled */
217               vnet_feature_start_device_input_x1 (nif->sw_if_index, &next0,
218                                                   first_b0);
219
220               /* enque and take next packet */
221               vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
222                                                n_left_to_next, first_bi0,
223                                                next0);
224
225               /* next packet */
226               n_rx_packets++;
227               n_rx_bytes += slot->len;
228               to_next[0] = first_bi0;
229               to_next += 1;
230               n_left_to_next--;
231               cur_slot_index = next_slot_index;
232
233               r--;
234             }
235           vlib_put_next_frame (vm, node, next_index, n_left_to_next);
236         }
237       ring->head = ring->cur = cur_slot_index;
238       cur_ring++;
239     }
240
241   if (n_rx_packets)
242     ioctl (nif->fd, NIOCRXSYNC, NULL);
243
244   vlib_increment_combined_counter
245     (vnet_get_main ()->interface_main.combined_sw_if_counters
246      + VNET_INTERFACE_COUNTER_RX,
247      vlib_get_thread_index (), nif->hw_if_index, n_rx_packets, n_rx_bytes);
248
249   vnet_device_increment_rx_packets (thread_index, n_rx_packets);
250
251   return n_rx_packets;
252 }
253
254 VLIB_NODE_FN (netmap_input_node) (vlib_main_t * vm,
255                                   vlib_node_runtime_t * node,
256                                   vlib_frame_t * frame)
257 {
258   int i;
259   u32 n_rx_packets = 0;
260   u32 thread_index = vm->thread_index;
261   netmap_main_t *nm = &netmap_main;
262   netmap_if_t *nmi;
263
264   for (i = 0; i < vec_len (nm->interfaces); i++)
265     {
266       nmi = vec_elt_at_index (nm->interfaces, i);
267       if (nmi->is_admin_up &&
268           (i % nm->input_cpu_count) ==
269           (thread_index - nm->input_cpu_first_index))
270         n_rx_packets += netmap_device_input_fn (vm, node, frame, nmi);
271     }
272
273   return n_rx_packets;
274 }
275
276 /* *INDENT-OFF* */
277 VLIB_REGISTER_NODE (netmap_input_node) = {
278   .name = "netmap-input",
279   .sibling_of = "device-input",
280   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
281   .format_trace = format_netmap_input_trace,
282   .type = VLIB_NODE_TYPE_INPUT,
283   /* default state is INTERRUPT mode, switch to POLLING if worker threads are enabled */
284   .state = VLIB_NODE_STATE_INTERRUPT,
285   .n_errors = NETMAP_INPUT_N_ERROR,
286   .error_strings = netmap_input_error_strings,
287 };
288 /* *INDENT-ON* */
289
290
291 /*
292  * fd.io coding-style-patch-verification: ON
293  *
294  * Local Variables:
295  * eval: (c-set-style "gnu")
296  * End:
297  */