vmxnet3: auto bind support
[vpp.git] / src / plugins / vmxnet3 / input.c
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2018 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 <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vlib/pci/pci.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/devices/devices.h>
23 #include <vnet/ip/ip6_packet.h>
24 #include <vnet/ip/ip4_packet.h>
25 #include <vnet/udp/udp_packet.h>
26
27 #include <vmxnet3/vmxnet3.h>
28
29 #define foreach_vmxnet3_input_error \
30   _(BUFFER_ALLOC, "buffer alloc error") \
31   _(RX_PACKET_NO_SOP, "Rx packet error - no SOP") \
32   _(RX_PACKET, "Rx packet error") \
33   _(RX_PACKET_EOP, "Rx packet error found on EOP") \
34   _(NO_BUFFER, "Rx no buffer error")
35
36 typedef enum
37 {
38 #define _(f,s) VMXNET3_INPUT_ERROR_##f,
39   foreach_vmxnet3_input_error
40 #undef _
41     VMXNET3_INPUT_N_ERROR,
42 } vmxnet3_input_error_t;
43
44 static __clib_unused char *vmxnet3_input_error_strings[] = {
45 #define _(n,s) s,
46   foreach_vmxnet3_input_error
47 #undef _
48 };
49
50 static_always_inline u16
51 vmxnet3_find_rid (vmxnet3_device_t * vd, vmxnet3_rx_comp * rx_comp)
52 {
53   u32 rid;
54
55   // rid is bits 16-25 (10 bits number)
56   rid = rx_comp->index & (0xffffffff >> 6);
57   rid >>= 16;
58   if ((rid >= vd->num_rx_queues) && (rid < (vd->num_rx_queues << 1)))
59     return 1;
60   else
61     return 0;
62 }
63
64 static_always_inline void
65 vmxnet3_rx_comp_ring_advance_next (vmxnet3_rxq_t * rxq)
66 {
67   vmxnet3_rx_comp_ring *comp_ring = &rxq->rx_comp_ring;
68
69   comp_ring->next++;
70   if (PREDICT_FALSE (comp_ring->next == rxq->size))
71     {
72       comp_ring->next = 0;
73       comp_ring->gen ^= VMXNET3_RXCF_GEN;
74     }
75 }
76
77 static_always_inline void
78 vmxnet3_handle_offload (vmxnet3_rx_comp * rx_comp, vlib_buffer_t * hb,
79                         u16 * next, u16 gso_size)
80 {
81   u8 l4_hdr_sz = 0;
82
83   if (gso_size)
84     {
85       if (rx_comp->flags & VMXNET3_RXCF_TCP)
86         {
87           tcp_header_t *tcp =
88             (tcp_header_t *) (hb->data + vnet_buffer (hb)->l4_hdr_offset);
89           l4_hdr_sz = tcp_header_bytes (tcp);
90         }
91       else if (rx_comp->flags & VMXNET3_RXCF_UDP)
92         {
93           udp_header_t *udp =
94             (udp_header_t *) (hb->data + vnet_buffer (hb)->l4_hdr_offset);
95           l4_hdr_sz = sizeof (*udp);
96         }
97     }
98
99   if (rx_comp->flags & VMXNET3_RXCF_IP4)
100     {
101       ip4_header_t *ip4 = (ip4_header_t *) (hb->data +
102                                             sizeof (ethernet_header_t));
103
104       vnet_buffer (hb)->l2_hdr_offset = 0;
105       vnet_buffer (hb)->l3_hdr_offset = sizeof (ethernet_header_t);
106       vnet_buffer (hb)->l4_hdr_offset = sizeof (ethernet_header_t) +
107         ip4_header_bytes (ip4);
108       hb->flags |= VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
109         VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
110         VNET_BUFFER_F_L4_HDR_OFFSET_VALID | VNET_BUFFER_F_IS_IP4;
111       next[0] = VNET_DEVICE_INPUT_NEXT_IP4_NCS_INPUT;
112
113       /* checksum offload */
114       if (!(rx_comp->index & VMXNET3_RXCI_CNC))
115         {
116           if (!(rx_comp->flags & VMXNET3_RXCF_IPC))
117             {
118               hb->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
119               ip4->checksum = 0;
120             }
121           if (!(rx_comp->flags & VMXNET3_RXCF_TUC))
122             {
123               if (rx_comp->flags & VMXNET3_RXCF_TCP)
124                 {
125                   tcp_header_t *tcp =
126                     (tcp_header_t *) (hb->data +
127                                       vnet_buffer (hb)->l4_hdr_offset);
128                   hb->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
129                   tcp->checksum = 0;
130                 }
131               else if (rx_comp->flags & VMXNET3_RXCF_UDP)
132                 {
133                   udp_header_t *udp =
134                     (udp_header_t *) (hb->data +
135                                       vnet_buffer (hb)->l4_hdr_offset);
136                   hb->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
137                   udp->checksum = 0;
138                 }
139             }
140         }
141
142       if (gso_size)
143         {
144           vnet_buffer2 (hb)->gso_size = gso_size;
145           vnet_buffer2 (hb)->gso_l4_hdr_sz = l4_hdr_sz;
146           hb->flags |= VNET_BUFFER_F_GSO;
147         }
148       vlib_buffer_advance (hb, device_input_next_node_advance[next[0]]);
149     }
150   else if (rx_comp->flags & VMXNET3_RXCF_IP6)
151     {
152       vnet_buffer (hb)->l2_hdr_offset = 0;
153       vnet_buffer (hb)->l3_hdr_offset = sizeof (ethernet_header_t);
154       vnet_buffer (hb)->l4_hdr_offset = sizeof (ethernet_header_t) +
155         sizeof (ip6_header_t);
156       hb->flags |= VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
157         VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
158         VNET_BUFFER_F_L4_HDR_OFFSET_VALID | VNET_BUFFER_F_IS_IP6;
159       next[0] = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
160
161       /* checksum offload */
162       if (!(rx_comp->index & VMXNET3_RXCI_CNC))
163         {
164           if (!(rx_comp->flags & VMXNET3_RXCF_TUC))
165             {
166               if (rx_comp->flags & VMXNET3_RXCF_TCP)
167                 {
168                   tcp_header_t *tcp =
169                     (tcp_header_t *) (hb->data +
170                                       vnet_buffer (hb)->l4_hdr_offset);
171                   hb->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
172                   tcp->checksum = 0;
173                 }
174               else if (rx_comp->flags & VMXNET3_RXCF_UDP)
175                 {
176                   udp_header_t *udp =
177                     (udp_header_t *) (hb->data +
178                                       vnet_buffer (hb)->l4_hdr_offset);
179                   hb->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
180                   udp->checksum = 0;
181                 }
182             }
183         }
184
185       if (gso_size)
186         {
187           vnet_buffer2 (hb)->gso_size = gso_size;
188           vnet_buffer2 (hb)->gso_l4_hdr_sz = l4_hdr_sz;
189           hb->flags |= VNET_BUFFER_F_GSO;
190         }
191       vlib_buffer_advance (hb, device_input_next_node_advance[next[0]]);
192     }
193   else
194     next[0] = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
195 }
196
197 static_always_inline uword
198 vmxnet3_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
199                              vlib_frame_t * frame, vmxnet3_device_t * vd,
200                              u16 qid)
201 {
202   vnet_main_t *vnm = vnet_get_main ();
203   uword n_trace = vlib_get_trace_count (vm, node);
204   u32 n_rx_packets = 0, n_rx_bytes = 0;
205   vmxnet3_rx_comp *rx_comp;
206   u32 desc_idx;
207   vmxnet3_rxq_t *rxq;
208   u32 thread_index = vm->thread_index;
209   u32 buffer_indices[VLIB_FRAME_SIZE], *bi;
210   u16 nexts[VLIB_FRAME_SIZE], *next;
211   vmxnet3_rx_ring *ring;
212   vmxnet3_rx_comp_ring *comp_ring;
213   u16 rid;
214   vlib_buffer_t *prev_b0 = 0, *hb = 0;
215   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
216   u8 known_next = 0, got_packet = 0;
217   vmxnet3_rx_desc *rxd;
218   clib_error_t *error;
219   u16 gso_size = 0;
220
221   rxq = vec_elt_at_index (vd->rxqs, qid);
222   comp_ring = &rxq->rx_comp_ring;
223   bi = buffer_indices;
224   next = nexts;
225   rx_comp = &rxq->rx_comp[comp_ring->next];
226
227   while (PREDICT_TRUE ((n_rx_packets < VLIB_FRAME_SIZE) &&
228                        (comp_ring->gen ==
229                         (rx_comp->flags & VMXNET3_RXCF_GEN))))
230     {
231       vlib_buffer_t *b0;
232       u32 bi0;
233
234       rid = vmxnet3_find_rid (vd, rx_comp);
235       ring = &rxq->rx_ring[rid];
236
237       if (PREDICT_TRUE (ring->fill >= 1))
238         ring->fill--;
239       else
240         {
241           vlib_error_count (vm, node->node_index,
242                             VMXNET3_INPUT_ERROR_NO_BUFFER, 1);
243           if (hb)
244             {
245               vlib_buffer_free_one (vm, vlib_get_buffer_index (vm, hb));
246               hb = 0;
247             }
248           prev_b0 = 0;
249           break;
250         }
251
252       desc_idx = rx_comp->index & VMXNET3_RXC_INDEX;
253       ring->consume = desc_idx;
254       rxd = &rxq->rx_desc[rid][desc_idx];
255
256       bi0 = ring->bufs[desc_idx];
257       ring->bufs[desc_idx] = ~0;
258
259       b0 = vlib_get_buffer (vm, bi0);
260       vnet_buffer (b0)->sw_if_index[VLIB_RX] = vd->sw_if_index;
261       vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
262       vnet_buffer (b0)->feature_arc_index = 0;
263       b0->current_length = rx_comp->len & VMXNET3_RXCL_LEN_MASK;
264       b0->current_data = 0;
265       b0->total_length_not_including_first_buffer = 0;
266       b0->next_buffer = 0;
267       b0->flags = 0;
268       b0->error = 0;
269       b0->current_config_index = 0;
270       ASSERT (b0->current_length != 0);
271
272       if (PREDICT_FALSE ((rx_comp->index & VMXNET3_RXCI_EOP) &&
273                          (rx_comp->len & VMXNET3_RXCL_ERROR)))
274         {
275           vlib_buffer_free_one (vm, bi0);
276           vlib_error_count (vm, node->node_index,
277                             VMXNET3_INPUT_ERROR_RX_PACKET_EOP, 1);
278           if (hb && vlib_get_buffer_index (vm, hb) != bi0)
279             {
280               vlib_buffer_free_one (vm, vlib_get_buffer_index (vm, hb));
281               hb = 0;
282             }
283           prev_b0 = 0;
284           goto next;
285         }
286
287       if (rx_comp->index & VMXNET3_RXCI_SOP)
288         {
289           ASSERT (!(rxd->flags & VMXNET3_RXF_BTYPE));
290           /* start segment */
291           if ((vd->lro_enable) &&
292               (rx_comp->flags & VMXNET3_RXCF_CT) == VMXNET3_RXCOMP_TYPE_LRO)
293             {
294               vmxnet3_rx_comp_ext *lro = (vmxnet3_rx_comp_ext *) rx_comp;
295
296               gso_size = lro->flags & VMXNET3_RXECF_MSS_MASK;
297             }
298
299           hb = b0;
300           bi[0] = bi0;
301           if (!(rx_comp->index & VMXNET3_RXCI_EOP))
302             {
303               hb->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
304               prev_b0 = b0;
305             }
306           else
307             {
308               /*
309                * Both start and end of packet is set. It is a complete packet
310                */
311               prev_b0 = 0;
312               got_packet = 1;
313             }
314         }
315       else if (rx_comp->index & VMXNET3_RXCI_EOP)
316         {
317           /* end of segment */
318           if (prev_b0)
319             {
320               prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
321               prev_b0->next_buffer = bi0;
322               hb->total_length_not_including_first_buffer +=
323                 b0->current_length;
324               prev_b0 = 0;
325               got_packet = 1;
326             }
327           else
328             {
329               /* EOP without SOP, error */
330               vlib_error_count (vm, node->node_index,
331                                 VMXNET3_INPUT_ERROR_RX_PACKET_NO_SOP, 1);
332               vlib_buffer_free_one (vm, bi0);
333               if (hb && vlib_get_buffer_index (vm, hb) != bi0)
334                 {
335                   vlib_buffer_free_one (vm, vlib_get_buffer_index (vm, hb));
336                   hb = 0;
337                 }
338               goto next;
339             }
340         }
341       else if (prev_b0)         // !sop && !eop
342         {
343           /* mid chain */
344           ASSERT (rxd->flags & VMXNET3_RXF_BTYPE);
345           prev_b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
346           prev_b0->next_buffer = bi0;
347           prev_b0 = b0;
348           hb->total_length_not_including_first_buffer += b0->current_length;
349         }
350       else
351         {
352           vlib_error_count (vm, node->node_index,
353                             VMXNET3_INPUT_ERROR_RX_PACKET, 1);
354           vlib_buffer_free_one (vm, bi0);
355           if (hb && vlib_get_buffer_index (vm, hb) != bi0)
356             {
357               vlib_buffer_free_one (vm, vlib_get_buffer_index (vm, hb));
358               hb = 0;
359             }
360           goto next;
361         }
362
363       n_rx_bytes += b0->current_length;
364
365       if (got_packet)
366         {
367           if (PREDICT_FALSE (vd->per_interface_next_index != ~0))
368             {
369               next_index = vd->per_interface_next_index;
370               known_next = 1;
371             }
372
373           if (PREDICT_FALSE
374               (vnet_device_input_have_features (vd->sw_if_index)))
375             {
376               vnet_feature_start_device_input_x1 (vd->sw_if_index,
377                                                   &next_index, hb);
378               known_next = 1;
379             }
380
381           if (PREDICT_FALSE (known_next))
382             {
383               next[0] = next_index;
384             }
385           else
386             {
387               ethernet_header_t *e = (ethernet_header_t *) hb->data;
388
389               if (ethernet_frame_is_tagged (e->type))
390                 next[0] = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
391               else
392                 vmxnet3_handle_offload (rx_comp, hb, next, gso_size);
393             }
394
395           n_rx_packets++;
396           next++;
397           bi++;
398           hb = 0;
399           got_packet = 0;
400           gso_size = 0;
401         }
402
403     next:
404       vmxnet3_rx_comp_ring_advance_next (rxq);
405       rx_comp = &rxq->rx_comp[comp_ring->next];
406     }
407
408   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
409     {
410       u32 n_left = n_rx_packets;
411
412       bi = buffer_indices;
413       next = nexts;
414       while (n_trace && n_left)
415         {
416           vlib_buffer_t *b;
417           vmxnet3_input_trace_t *tr;
418
419           b = vlib_get_buffer (vm, bi[0]);
420           vlib_trace_buffer (vm, node, next[0], b, /* follow_chain */ 0);
421           tr = vlib_add_trace (vm, node, b, sizeof (*tr));
422           tr->next_index = next[0];
423           tr->hw_if_index = vd->hw_if_index;
424           tr->buffer = *b;
425
426           n_trace--;
427           n_left--;
428           bi++;
429           next++;
430         }
431       vlib_set_trace_count (vm, node, n_trace);
432     }
433
434   if (PREDICT_TRUE (n_rx_packets))
435     {
436       vlib_buffer_enqueue_to_next (vm, node, buffer_indices, nexts,
437                                    n_rx_packets);
438       vlib_increment_combined_counter
439         (vnm->interface_main.combined_sw_if_counters +
440          VNET_INTERFACE_COUNTER_RX, thread_index,
441          vd->hw_if_index, n_rx_packets, n_rx_bytes);
442     }
443
444   error = vmxnet3_rxq_refill_ring0 (vm, vd, rxq);
445   if (PREDICT_FALSE (error != 0))
446     {
447       vlib_error_count (vm, node->node_index,
448                         VMXNET3_INPUT_ERROR_BUFFER_ALLOC, 1);
449     }
450   error = vmxnet3_rxq_refill_ring1 (vm, vd, rxq);
451   if (PREDICT_FALSE (error != 0))
452     {
453       vlib_error_count (vm, node->node_index,
454                         VMXNET3_INPUT_ERROR_BUFFER_ALLOC, 1);
455     }
456
457   return n_rx_packets;
458 }
459
460 VLIB_NODE_FN (vmxnet3_input_node) (vlib_main_t * vm,
461                                    vlib_node_runtime_t * node,
462                                    vlib_frame_t * frame)
463 {
464   u32 n_rx = 0;
465   vmxnet3_main_t *vmxm = &vmxnet3_main;
466   vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
467   vnet_device_and_queue_t *dq;
468
469   foreach_device_and_queue (dq, rt->devices_and_queues)
470   {
471     vmxnet3_device_t *vd;
472     vd = vec_elt_at_index (vmxm->devices, dq->dev_instance);
473     if ((vd->flags & VMXNET3_DEVICE_F_ADMIN_UP) == 0)
474       continue;
475     n_rx += vmxnet3_device_input_inline (vm, node, frame, vd, dq->queue_id);
476   }
477   return n_rx;
478 }
479
480 #ifndef CLIB_MARCH_VARIANT
481 /* *INDENT-OFF* */
482 VLIB_REGISTER_NODE (vmxnet3_input_node) = {
483   .name = "vmxnet3-input",
484   .sibling_of = "device-input",
485   .format_trace = format_vmxnet3_input_trace,
486   .type = VLIB_NODE_TYPE_INPUT,
487   .state = VLIB_NODE_STATE_DISABLED,
488   .n_errors = VMXNET3_INPUT_N_ERROR,
489   .error_strings = vmxnet3_input_error_strings,
490 };
491 #endif
492
493 /* *INDENT-ON* */
494
495 /*
496  * fd.io coding-style-patch-verification: ON
497  *
498  * Local Variables:
499  * eval: (c-set-style "gnu")
500  * End:
501  */