631bbac111796dc8e5629fa1a17647b80f4cbfbf
[vpp.git] / src / vnet / devices / af_packet / node.c
1 /*
2  *------------------------------------------------------------------
3  * af_packet.c - linux kernel packet interface
4  *
5  * Copyright (c) 2016 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19
20 #include <linux/if_packet.h>
21
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ip/ip.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/interface/rx_queue_funcs.h>
27 #include <vnet/feature/feature.h>
28 #include <vnet/ethernet/packet.h>
29
30 #include <vnet/devices/af_packet/af_packet.h>
31 #include <vnet/devices/virtio/virtio_std.h>
32
33 #define foreach_af_packet_input_error                                         \
34   _ (PARTIAL_PKT, "partial packet")                                           \
35   _ (TIMEDOUT_BLK, "timed out block")                                         \
36   _ (TOTAL_RECV_BLK, "total received block")
37 typedef enum
38 {
39 #define _(f,s) AF_PACKET_INPUT_ERROR_##f,
40   foreach_af_packet_input_error
41 #undef _
42     AF_PACKET_INPUT_N_ERROR,
43 } af_packet_input_error_t;
44
45 static char *af_packet_input_error_strings[] = {
46 #define _(n,s) s,
47   foreach_af_packet_input_error
48 #undef _
49 };
50
51 typedef struct
52 {
53   u32 next_index;
54   u32 hw_if_index;
55   u16 queue_id;
56   int block;
57   u32 pkt_num;
58   void *block_start;
59   block_desc_t bd;
60   tpacket3_hdr_t tph;
61   vnet_virtio_net_hdr_t vnet_hdr;
62 } af_packet_input_trace_t;
63
64 static u8 *
65 format_af_packet_input_trace (u8 * s, va_list * args)
66 {
67   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
68   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
69   af_packet_input_trace_t *t = va_arg (*args, af_packet_input_trace_t *);
70   u32 indent = format_get_indent (s);
71
72   s = format (s, "af_packet: hw_if_index %d rx-queue %u next-index %d",
73               t->hw_if_index, t->queue_id, t->next_index);
74
75   s = format (
76     s, "\n%Ublock %u:\n%Uaddress %p version %u seq_num %lu pkt_num %u",
77     format_white_space, indent + 2, t->block, format_white_space, indent + 4,
78     t->block_start, t->bd.version, t->bd.hdr.bh1.seq_num, t->pkt_num);
79   s =
80     format (s,
81             "\n%Utpacket3_hdr:\n%Ustatus 0x%x len %u snaplen %u mac %u net %u"
82             "\n%Usec 0x%x nsec 0x%x vlan %U"
83 #ifdef TP_STATUS_VLAN_TPID_VALID
84             " vlan_tpid %u"
85 #endif
86             ,
87             format_white_space, indent + 2, format_white_space, indent + 4,
88             t->tph.tp_status, t->tph.tp_len, t->tph.tp_snaplen, t->tph.tp_mac,
89             t->tph.tp_net, format_white_space, indent + 4, t->tph.tp_sec,
90             t->tph.tp_nsec, format_ethernet_vlan_tci, t->tph.hv1.tp_vlan_tci
91 #ifdef TP_STATUS_VLAN_TPID_VALID
92             ,
93             t->tph.hv1.tp_vlan_tpid
94 #endif
95     );
96
97   s = format (s,
98               "\n%Uvnet-hdr:\n%Uflags 0x%02x gso_type 0x%02x hdr_len %u"
99               "\n%Ugso_size %u csum_start %u csum_offset %u",
100               format_white_space, indent + 2, format_white_space, indent + 4,
101               t->vnet_hdr.flags, t->vnet_hdr.gso_type, t->vnet_hdr.hdr_len,
102               format_white_space, indent + 4, t->vnet_hdr.gso_size,
103               t->vnet_hdr.csum_start, t->vnet_hdr.csum_offset);
104   return s;
105 }
106
107 always_inline void
108 buffer_add_to_chain (vlib_buffer_t *b, vlib_buffer_t *first_b,
109                      vlib_buffer_t *prev_b, u32 bi)
110 {
111   /* update first buffer */
112   first_b->total_length_not_including_first_buffer += b->current_length;
113
114   /* update previous buffer */
115   prev_b->next_buffer = bi;
116   prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
117
118   /* update current buffer */
119   b->next_buffer = ~0;
120 }
121
122 static_always_inline void
123 fill_gso_offload (vlib_buffer_t *b, u32 gso_size, u8 l4_hdr_sz)
124 {
125   b->flags |= VNET_BUFFER_F_GSO;
126   vnet_buffer2 (b)->gso_size = gso_size;
127   vnet_buffer2 (b)->gso_l4_hdr_sz = l4_hdr_sz;
128 }
129
130 static_always_inline void
131 fill_cksum_offload (vlib_buffer_t *b, u8 *l4_hdr_sz, u8 is_ip)
132 {
133   vnet_buffer_oflags_t oflags = 0;
134   u16 l2hdr_sz = 0;
135   u16 ethertype = 0;
136   u8 l4_proto = 0;
137
138   if (is_ip)
139     {
140       switch (b->data[0] & 0xf0)
141         {
142         case 0x40:
143           ethertype = ETHERNET_TYPE_IP4;
144           break;
145         case 0x60:
146           ethertype = ETHERNET_TYPE_IP6;
147           break;
148         }
149     }
150   else
151     {
152       ethernet_header_t *eth = vlib_buffer_get_current (b);
153       ethertype = clib_net_to_host_u16 (eth->type);
154       l2hdr_sz = sizeof (ethernet_header_t);
155       if (ethernet_frame_is_tagged (ethertype))
156         {
157           ethernet_vlan_header_t *vlan = (ethernet_vlan_header_t *) (eth + 1);
158
159           ethertype = clib_net_to_host_u16 (vlan->type);
160           l2hdr_sz += sizeof (*vlan);
161           if (ethertype == ETHERNET_TYPE_VLAN)
162             {
163               vlan++;
164               ethertype = clib_net_to_host_u16 (vlan->type);
165               l2hdr_sz += sizeof (*vlan);
166             }
167         }
168     }
169
170   vnet_buffer (b)->l2_hdr_offset = 0;
171   vnet_buffer (b)->l3_hdr_offset = l2hdr_sz;
172
173   if (ethertype == ETHERNET_TYPE_IP4)
174     {
175       ip4_header_t *ip4 = (vlib_buffer_get_current (b) + l2hdr_sz);
176       vnet_buffer (b)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
177       b->flags |= (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
178                    VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
179                    VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
180
181       l4_proto = ip4->protocol;
182     }
183   else if (ethertype == ETHERNET_TYPE_IP6)
184     {
185       ip6_header_t *ip6 = (vlib_buffer_get_current (b) + l2hdr_sz);
186       b->flags |= (VNET_BUFFER_F_IS_IP6 | VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
187                    VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
188                    VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
189       u16 ip6_hdr_len = sizeof (ip6_header_t);
190
191       if (ip6_ext_hdr (ip6->protocol))
192         {
193           ip6_ext_header_t *p = (void *) (ip6 + 1);
194           ip6_hdr_len += ip6_ext_header_len (p);
195           while (ip6_ext_hdr (p->next_hdr))
196             {
197               ip6_hdr_len += ip6_ext_header_len (p);
198               p = ip6_ext_next_header (p);
199             }
200           l4_proto = p->next_hdr;
201         }
202       else
203         l4_proto = ip6->protocol;
204       vnet_buffer (b)->l4_hdr_offset = l2hdr_sz + ip6_hdr_len;
205     }
206
207   if (l4_proto == IP_PROTOCOL_TCP)
208     {
209       oflags |= VNET_BUFFER_OFFLOAD_F_TCP_CKSUM;
210       tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b) +
211                                             vnet_buffer (b)->l4_hdr_offset);
212       *l4_hdr_sz = tcp_header_bytes (tcp);
213     }
214   else if (l4_proto == IP_PROTOCOL_UDP)
215     {
216       oflags |= VNET_BUFFER_OFFLOAD_F_UDP_CKSUM;
217       *l4_hdr_sz = sizeof (udp_header_t);
218     }
219
220   if (oflags)
221     vnet_buffer_offload_flags_set (b, oflags);
222 }
223
224 always_inline uword
225 af_packet_device_input_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
226                            vlib_frame_t *frame, af_packet_if_t *apif,
227                            u16 queue_id, u8 is_cksum_gso_enabled)
228 {
229   af_packet_main_t *apm = &af_packet_main;
230   af_packet_queue_t *rx_queue = vec_elt_at_index (apif->rx_queues, queue_id);
231   tpacket3_hdr_t *tph;
232   u32 next_index;
233   u32 n_free_bufs;
234   u32 n_rx_packets = 0;
235   u32 n_rx_bytes = 0;
236   u32 timedout_blk = 0;
237   u32 total = 0;
238   u32 *to_next = 0;
239   u32 block = rx_queue->next_rx_block;
240   u32 block_nr = rx_queue->rx_req->tp_block_nr;
241   u8 *block_start = 0;
242   uword n_trace = vlib_get_trace_count (vm, node);
243   u32 thread_index = vm->thread_index;
244   u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
245   u32 min_bufs = rx_queue->rx_req->tp_frame_size / n_buffer_bytes;
246   u32 num_pkts = 0;
247   u32 rx_frame_offset = 0;
248   block_desc_t *bd = 0;
249   vlib_buffer_t bt;
250   u8 is_ip = (apif->mode == AF_PACKET_IF_MODE_IP);
251
252   if (is_ip)
253     next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
254   else
255     {
256       next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
257       if (PREDICT_FALSE (apif->per_interface_next_index != ~0))
258         next_index = apif->per_interface_next_index;
259
260       /* redirect if feature path enabled */
261       vnet_feature_start_device_input_x1 (apif->sw_if_index, &next_index, &bt);
262     }
263
264   if ((((block_desc_t *) (block_start = rx_queue->rx_ring[block]))
265          ->hdr.bh1.block_status &
266        TP_STATUS_USER) != 0)
267     {
268       u32 n_required = 0;
269       bd = (block_desc_t *) block_start;
270
271       total++;
272
273       if (TP_STATUS_BLK_TMO & bd->hdr.bh1.block_status)
274         timedout_blk++;
275
276       if (PREDICT_FALSE (rx_queue->is_rx_pending))
277         {
278           num_pkts = rx_queue->num_rx_pkts;
279           rx_frame_offset = rx_queue->rx_frame_offset;
280           rx_queue->is_rx_pending = 0;
281         }
282       else
283         {
284           num_pkts = bd->hdr.bh1.num_pkts;
285           rx_frame_offset = sizeof (block_desc_t);
286         }
287
288       n_required = clib_max (num_pkts, VLIB_FRAME_SIZE);
289       n_free_bufs = vec_len (apm->rx_buffers[thread_index]);
290       if (PREDICT_FALSE (n_free_bufs < n_required))
291         {
292           vec_validate (apm->rx_buffers[thread_index],
293                         n_required + n_free_bufs - 1);
294           n_free_bufs += vlib_buffer_alloc (
295             vm, &apm->rx_buffers[thread_index][n_free_bufs], n_required);
296           vec_set_len (apm->rx_buffers[thread_index], n_free_bufs);
297         }
298
299       while (num_pkts && (n_free_bufs >= min_bufs))
300         {
301           u32 next0 = next_index;
302           u32 n_left_to_next;
303
304           vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
305
306           while (num_pkts && n_left_to_next && (n_free_bufs >= min_bufs))
307             {
308               tph = (tpacket3_hdr_t *) (block_start + rx_frame_offset);
309
310               if (num_pkts > 1)
311                 CLIB_PREFETCH (block_start + rx_frame_offset +
312                                  tph->tp_next_offset,
313                                2 * CLIB_CACHE_LINE_BYTES, LOAD);
314
315               vlib_buffer_t *b0 = 0, *first_b0 = 0, *prev_b0 = 0;
316               vnet_virtio_net_hdr_t *vnet_hdr = 0;
317               u32 data_len = tph->tp_snaplen;
318               u32 offset = 0;
319               u32 bi0 = ~0, first_bi0 = ~0;
320               u8 l4_hdr_sz = 0;
321
322               if (is_cksum_gso_enabled)
323                 vnet_hdr =
324                   (vnet_virtio_net_hdr_t *) ((u8 *) tph + tph->tp_mac -
325                                              sizeof (vnet_virtio_net_hdr_t));
326
327               // save current state and return
328               if (PREDICT_FALSE (((data_len / n_buffer_bytes) + 1) >
329                                  vec_len (apm->rx_buffers[thread_index])))
330                 {
331                   rx_queue->rx_frame_offset = rx_frame_offset;
332                   rx_queue->num_rx_pkts = num_pkts;
333                   rx_queue->is_rx_pending = 1;
334                   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
335                   goto done;
336                 }
337
338               while (data_len)
339                 {
340                   /* grab free buffer */
341                   u32 last_empty_buffer =
342                     vec_len (apm->rx_buffers[thread_index]) - 1;
343                   bi0 = apm->rx_buffers[thread_index][last_empty_buffer];
344                   vec_set_len (apm->rx_buffers[thread_index],
345                                last_empty_buffer);
346                   n_free_bufs--;
347
348                   /* copy data */
349                   u32 bytes_to_copy =
350                     data_len > n_buffer_bytes ? n_buffer_bytes : data_len;
351                   u32 vlan_len = 0;
352                   u32 bytes_copied = 0;
353
354                   b0 = vlib_get_buffer (vm, bi0);
355                   b0->current_data = 0;
356
357                   /* Kernel removes VLAN headers, so reconstruct VLAN */
358                   if (PREDICT_FALSE (tph->tp_status & TP_STATUS_VLAN_VALID))
359                     {
360                       if (PREDICT_TRUE (offset == 0))
361                         {
362                           clib_memcpy_fast (vlib_buffer_get_current (b0),
363                                             (u8 *) tph + tph->tp_mac,
364                                             sizeof (ethernet_header_t));
365                           ethernet_header_t *eth =
366                             vlib_buffer_get_current (b0);
367                           ethernet_vlan_header_t *vlan =
368                             (ethernet_vlan_header_t *) (eth + 1);
369                           vlan->priority_cfi_and_id =
370                             clib_host_to_net_u16 (tph->hv1.tp_vlan_tci);
371                           vlan->type = eth->type;
372                           eth->type =
373                             clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
374                           vlan_len = sizeof (ethernet_vlan_header_t);
375                           bytes_copied = sizeof (ethernet_header_t);
376                         }
377                     }
378                   clib_memcpy_fast (((u8 *) vlib_buffer_get_current (b0)) +
379                                       bytes_copied + vlan_len,
380                                     (u8 *) tph + tph->tp_mac + offset +
381                                       bytes_copied,
382                                     (bytes_to_copy - bytes_copied));
383
384                   /* fill buffer header */
385                   b0->current_length = bytes_to_copy + vlan_len;
386
387                   if (offset == 0)
388                     {
389                       b0->total_length_not_including_first_buffer = 0;
390                       b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
391                       vnet_buffer (b0)->sw_if_index[VLIB_RX] =
392                         apif->sw_if_index;
393                       vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~0;
394                       first_b0 = b0;
395                       first_bi0 = bi0;
396                       if (is_cksum_gso_enabled)
397                         {
398                           if (vnet_hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
399                             fill_cksum_offload (first_b0, &l4_hdr_sz, is_ip);
400                           if (vnet_hdr->gso_type & (VIRTIO_NET_HDR_GSO_TCPV4 |
401                                                     VIRTIO_NET_HDR_GSO_TCPV6))
402                             fill_gso_offload (first_b0, vnet_hdr->gso_size,
403                                               l4_hdr_sz);
404                         }
405                     }
406                   else
407                     buffer_add_to_chain (b0, first_b0, prev_b0, bi0);
408
409                   prev_b0 = b0;
410                   offset += bytes_to_copy;
411                   data_len -= bytes_to_copy;
412                 }
413               n_rx_packets++;
414               n_rx_bytes += tph->tp_snaplen;
415               to_next[0] = first_bi0;
416               to_next += 1;
417               n_left_to_next--;
418
419               /* drop partial packets */
420               if (PREDICT_FALSE (tph->tp_len != tph->tp_snaplen))
421                 {
422                   next0 = VNET_DEVICE_INPUT_NEXT_DROP;
423                   first_b0->error =
424                     node->errors[AF_PACKET_INPUT_ERROR_PARTIAL_PKT];
425                 }
426               else
427                 {
428                   if (PREDICT_FALSE (apif->mode == AF_PACKET_IF_MODE_IP))
429                     {
430                       switch (first_b0->data[0] & 0xf0)
431                         {
432                         case 0x40:
433                           next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
434                           break;
435                         case 0x60:
436                           next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
437                           break;
438                         default:
439                           next0 = VNET_DEVICE_INPUT_NEXT_DROP;
440                           break;
441                         }
442                       if (PREDICT_FALSE (apif->per_interface_next_index != ~0))
443                         next0 = apif->per_interface_next_index;
444                     }
445                   else
446                     {
447                       /* copy feature arc data from template */
448                       first_b0->current_config_index = bt.current_config_index;
449                       vnet_buffer (first_b0)->feature_arc_index =
450                         vnet_buffer (&bt)->feature_arc_index;
451                     }
452                 }
453
454               /* trace */
455               if (PREDICT_FALSE (n_trace > 0 &&
456                                  vlib_trace_buffer (vm, node, next0, first_b0,
457                                                     /* follow_chain */ 0)))
458                 {
459                   af_packet_input_trace_t *tr;
460                   vlib_set_trace_count (vm, node, --n_trace);
461                   tr = vlib_add_trace (vm, node, first_b0, sizeof (*tr));
462                   tr->next_index = next0;
463                   tr->hw_if_index = apif->hw_if_index;
464                   tr->queue_id = queue_id;
465                   tr->block = block;
466                   tr->block_start = bd;
467                   tr->pkt_num = bd->hdr.bh1.num_pkts - num_pkts;
468                   clib_memcpy_fast (&tr->bd, bd, sizeof (block_desc_t));
469                   clib_memcpy_fast (&tr->tph, tph, sizeof (tpacket3_hdr_t));
470                   if (is_cksum_gso_enabled)
471                     clib_memcpy_fast (&tr->vnet_hdr, vnet_hdr,
472                                       sizeof (vnet_virtio_net_hdr_t));
473                   else
474                     clib_memset_u8 (&tr->vnet_hdr, 0,
475                                     sizeof (vnet_virtio_net_hdr_t));
476                 }
477
478               /* enque and take next packet */
479               vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
480                                                n_left_to_next, first_bi0,
481                                                next0);
482
483               /* next packet */
484               num_pkts--;
485               rx_frame_offset += tph->tp_next_offset;
486             }
487
488           vlib_put_next_frame (vm, node, next_index, n_left_to_next);
489         }
490
491       if (PREDICT_TRUE (num_pkts == 0))
492         {
493           bd->hdr.bh1.block_status = TP_STATUS_KERNEL;
494           block = (block + 1) % block_nr;
495         }
496       else
497         {
498           rx_queue->rx_frame_offset = rx_frame_offset;
499           rx_queue->num_rx_pkts = num_pkts;
500           rx_queue->is_rx_pending = 1;
501         }
502     }
503
504   rx_queue->next_rx_block = block;
505
506 done:
507
508   if ((((block_desc_t *) (block_start = rx_queue->rx_ring[block]))
509          ->hdr.bh1.block_status &
510        TP_STATUS_USER) != 0)
511     vlib_node_set_state (vm, node->node_index, VLIB_NODE_STATE_POLLING);
512   else
513     vlib_node_set_state (vm, node->node_index, VLIB_NODE_STATE_INTERRUPT);
514
515   vlib_error_count (vm, node->node_index, AF_PACKET_INPUT_ERROR_TOTAL_RECV_BLK,
516                     total);
517   vlib_error_count (vm, node->node_index, AF_PACKET_INPUT_ERROR_TIMEDOUT_BLK,
518                     timedout_blk);
519
520   vlib_increment_combined_counter
521     (vnet_get_main ()->interface_main.combined_sw_if_counters
522      + VNET_INTERFACE_COUNTER_RX,
523      vlib_get_thread_index (), apif->hw_if_index, n_rx_packets, n_rx_bytes);
524
525   vnet_device_increment_rx_packets (thread_index, n_rx_packets);
526   return n_rx_packets;
527 }
528
529 VLIB_NODE_FN (af_packet_input_node) (vlib_main_t * vm,
530                                      vlib_node_runtime_t * node,
531                                      vlib_frame_t * frame)
532 {
533   u32 n_rx_packets = 0;
534   af_packet_main_t *apm = &af_packet_main;
535   vnet_hw_if_rxq_poll_vector_t *pv;
536   pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
537   for (int i = 0; i < vec_len (pv); i++)
538     {
539       af_packet_if_t *apif;
540       apif = vec_elt_at_index (apm->interfaces, pv[i].dev_instance);
541       if (apif->is_admin_up)
542         {
543           if (apif->is_cksum_gso_enabled)
544             n_rx_packets += af_packet_device_input_fn (vm, node, frame, apif,
545                                                        pv[i].queue_id, 1);
546           else
547             n_rx_packets += af_packet_device_input_fn (vm, node, frame, apif,
548                                                        pv[i].queue_id, 0);
549         }
550     }
551   return n_rx_packets;
552 }
553
554 VLIB_REGISTER_NODE (af_packet_input_node) = {
555   .name = "af-packet-input",
556   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
557   .sibling_of = "device-input",
558   .format_trace = format_af_packet_input_trace,
559   .type = VLIB_NODE_TYPE_INPUT,
560   .state = VLIB_NODE_STATE_INTERRUPT,
561   .n_errors = AF_PACKET_INPUT_N_ERROR,
562   .error_strings = af_packet_input_error_strings,
563 };
564
565
566 /*
567  * fd.io coding-style-patch-verification: ON
568  *
569  * Local Variables:
570  * eval: (c-set-style "gnu")
571  * End:
572  */