2 *------------------------------------------------------------------
3 * af_packet.c - linux kernel packet interface
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <linux/if_packet.h>
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>
30 #include <vnet/devices/af_packet/af_packet.h>
31 #include <vnet/devices/virtio/virtio_std.h>
33 #define foreach_af_packet_input_error \
34 _(PARTIAL_PKT, "partial packet")
38 #define _(f,s) AF_PACKET_INPUT_ERROR_##f,
39 foreach_af_packet_input_error
41 AF_PACKET_INPUT_N_ERROR,
42 } af_packet_input_error_t;
44 static char *af_packet_input_error_strings[] = {
46 foreach_af_packet_input_error
59 vnet_virtio_net_hdr_t vnet_hdr;
60 } af_packet_input_trace_t;
63 format_af_packet_input_trace (u8 * s, va_list * args)
65 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
66 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
67 af_packet_input_trace_t *t = va_arg (*args, af_packet_input_trace_t *);
68 u32 indent = format_get_indent (s);
70 s = format (s, "af_packet: hw_if_index %d next-index %d",
71 t->hw_if_index, t->next_index);
74 s, "\n%Ublock %u:\n%Uaddress %p version %u seq_num %lu pkt_num %u",
75 format_white_space, indent + 2, t->block, format_white_space, indent + 4,
76 t->block_start, t->bd.version, t->bd.hdr.bh1.seq_num, t->pkt_num);
79 "\n%Utpacket3_hdr:\n%Ustatus 0x%x len %u snaplen %u mac %u net %u"
80 "\n%Usec 0x%x nsec 0x%x vlan %U"
81 #ifdef TP_STATUS_VLAN_TPID_VALID
85 format_white_space, indent + 2, format_white_space, indent + 4,
86 t->tph.tp_status, t->tph.tp_len, t->tph.tp_snaplen, t->tph.tp_mac,
87 t->tph.tp_net, format_white_space, indent + 4, t->tph.tp_sec,
88 t->tph.tp_nsec, format_ethernet_vlan_tci, t->tph.hv1.tp_vlan_tci
89 #ifdef TP_STATUS_VLAN_TPID_VALID
91 t->tph.hv1.tp_vlan_tpid
96 "\n%Uvnet-hdr:\n%Uflags 0x%02x gso_type 0x%02x hdr_len %u"
97 "\n%Ugso_size %u csum_start %u csum_offset %u",
98 format_white_space, indent + 2, format_white_space, indent + 4,
99 t->vnet_hdr.flags, t->vnet_hdr.gso_type, t->vnet_hdr.hdr_len,
100 format_white_space, indent + 4, t->vnet_hdr.gso_size,
101 t->vnet_hdr.csum_start, t->vnet_hdr.csum_offset);
106 buffer_add_to_chain (vlib_buffer_t *b, vlib_buffer_t *first_b,
107 vlib_buffer_t *prev_b, u32 bi)
109 /* update first buffer */
110 first_b->total_length_not_including_first_buffer += b->current_length;
112 /* update previous buffer */
113 prev_b->next_buffer = bi;
114 prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
116 /* update current buffer */
120 static_always_inline void
121 fill_gso_offload (vlib_buffer_t *b, u32 gso_size, u8 l4_hdr_sz)
123 b->flags |= VNET_BUFFER_F_GSO;
124 vnet_buffer2 (b)->gso_size = gso_size;
125 vnet_buffer2 (b)->gso_l4_hdr_sz = l4_hdr_sz;
128 static_always_inline void
129 fill_cksum_offload (vlib_buffer_t *b, u8 *l4_hdr_sz, u8 is_ip)
131 vnet_buffer_oflags_t oflags = 0;
138 switch (b->data[0] & 0xf0)
141 ethertype = ETHERNET_TYPE_IP4;
144 ethertype = ETHERNET_TYPE_IP6;
150 ethernet_header_t *eth = vlib_buffer_get_current (b);
151 ethertype = clib_net_to_host_u16 (eth->type);
152 l2hdr_sz = sizeof (ethernet_header_t);
153 if (ethernet_frame_is_tagged (ethertype))
155 ethernet_vlan_header_t *vlan = (ethernet_vlan_header_t *) (eth + 1);
157 ethertype = clib_net_to_host_u16 (vlan->type);
158 l2hdr_sz += sizeof (*vlan);
159 if (ethertype == ETHERNET_TYPE_VLAN)
162 ethertype = clib_net_to_host_u16 (vlan->type);
163 l2hdr_sz += sizeof (*vlan);
168 vnet_buffer (b)->l2_hdr_offset = 0;
169 vnet_buffer (b)->l3_hdr_offset = l2hdr_sz;
171 if (ethertype == ETHERNET_TYPE_IP4)
173 ip4_header_t *ip4 = (vlib_buffer_get_current (b) + l2hdr_sz);
174 vnet_buffer (b)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
175 b->flags |= (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
176 VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
177 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
179 l4_proto = ip4->protocol;
181 else if (ethertype == ETHERNET_TYPE_IP6)
183 ip6_header_t *ip6 = (vlib_buffer_get_current (b) + l2hdr_sz);
184 b->flags |= (VNET_BUFFER_F_IS_IP6 | VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
185 VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
186 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
187 u16 ip6_hdr_len = sizeof (ip6_header_t);
189 if (ip6_ext_hdr (ip6->protocol))
191 ip6_ext_header_t *p = (void *) (ip6 + 1);
192 ip6_hdr_len += ip6_ext_header_len (p);
193 while (ip6_ext_hdr (p->next_hdr))
195 ip6_hdr_len += ip6_ext_header_len (p);
196 p = ip6_ext_next_header (p);
198 l4_proto = p->next_hdr;
201 l4_proto = ip6->protocol;
202 vnet_buffer (b)->l4_hdr_offset = l2hdr_sz + ip6_hdr_len;
205 if (l4_proto == IP_PROTOCOL_TCP)
207 oflags |= VNET_BUFFER_OFFLOAD_F_TCP_CKSUM;
208 tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b) +
209 vnet_buffer (b)->l4_hdr_offset);
210 *l4_hdr_sz = tcp_header_bytes (tcp);
212 else if (l4_proto == IP_PROTOCOL_UDP)
214 oflags |= VNET_BUFFER_OFFLOAD_F_UDP_CKSUM;
215 *l4_hdr_sz = sizeof (udp_header_t);
219 vnet_buffer_offload_flags_set (b, oflags);
223 af_packet_device_input_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
224 vlib_frame_t *frame, af_packet_if_t *apif,
225 u8 is_cksum_gso_enabled)
227 af_packet_main_t *apm = &af_packet_main;
231 u32 n_rx_packets = 0;
234 u32 block = apif->next_rx_block;
235 u32 block_nr = apif->rx_req->tp_block_nr;
237 uword n_trace = vlib_get_trace_count (vm, node);
238 u32 thread_index = vm->thread_index;
239 u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
240 u32 min_bufs = apif->rx_req->tp_frame_size / n_buffer_bytes;
242 u32 rx_frame_offset = 0;
243 block_desc_t *bd = 0;
245 u8 is_ip = (apif->mode == AF_PACKET_IF_MODE_IP);
248 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
251 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
252 if (PREDICT_FALSE (apif->per_interface_next_index != ~0))
253 next_index = apif->per_interface_next_index;
255 /* redirect if feature path enabled */
256 vnet_feature_start_device_input_x1 (apif->sw_if_index, &next_index, &bt);
259 if ((((block_desc_t *) (block_start = apif->rx_ring[block]))
260 ->hdr.bh1.block_status &
261 TP_STATUS_USER) != 0)
264 bd = (block_desc_t *) block_start;
266 if (PREDICT_FALSE (apif->ss.is_save))
268 num_pkts = apif->ss.num_pkts;
269 rx_frame_offset = apif->ss.rx_frame_offset;
270 apif->ss.is_save = 0;
274 num_pkts = bd->hdr.bh1.num_pkts;
275 rx_frame_offset = sizeof (block_desc_t);
278 n_required = clib_max (num_pkts, VLIB_FRAME_SIZE);
279 n_free_bufs = vec_len (apm->rx_buffers[thread_index]);
280 if (PREDICT_FALSE (n_free_bufs < n_required))
282 vec_validate (apm->rx_buffers[thread_index],
283 n_required + n_free_bufs - 1);
284 n_free_bufs += vlib_buffer_alloc (
285 vm, &apm->rx_buffers[thread_index][n_free_bufs], n_required);
286 _vec_len (apm->rx_buffers[thread_index]) = n_free_bufs;
289 while (num_pkts && (n_free_bufs >= min_bufs))
291 u32 next0 = next_index;
294 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
296 while (num_pkts && n_left_to_next && (n_free_bufs >= min_bufs))
298 tph = (tpacket3_hdr_t *) (block_start + rx_frame_offset);
301 CLIB_PREFETCH (block_start + rx_frame_offset +
303 2 * CLIB_CACHE_LINE_BYTES, LOAD);
305 vlib_buffer_t *b0 = 0, *first_b0 = 0, *prev_b0 = 0;
306 vnet_virtio_net_hdr_t *vnet_hdr = 0;
307 u32 data_len = tph->tp_snaplen;
309 u32 bi0 = ~0, first_bi0 = ~0;
312 if (is_cksum_gso_enabled)
314 (vnet_virtio_net_hdr_t *) ((u8 *) tph + tph->tp_mac -
315 sizeof (vnet_virtio_net_hdr_t));
317 // save current state and return
318 if (PREDICT_FALSE (((data_len / n_buffer_bytes) + 1) >
319 vec_len (apm->rx_buffers[thread_index])))
321 apif->ss.rx_frame_offset = rx_frame_offset;
322 apif->ss.num_pkts = num_pkts;
323 apif->ss.is_save = 1;
324 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
330 /* grab free buffer */
331 u32 last_empty_buffer =
332 vec_len (apm->rx_buffers[thread_index]) - 1;
333 bi0 = apm->rx_buffers[thread_index][last_empty_buffer];
334 _vec_len (apm->rx_buffers[thread_index]) = last_empty_buffer;
339 data_len > n_buffer_bytes ? n_buffer_bytes : data_len;
341 u32 bytes_copied = 0;
343 b0 = vlib_get_buffer (vm, bi0);
344 b0->current_data = 0;
346 /* Kernel removes VLAN headers, so reconstruct VLAN */
347 if (PREDICT_FALSE (tph->tp_status & TP_STATUS_VLAN_VALID))
349 if (PREDICT_TRUE (offset == 0))
351 clib_memcpy_fast (vlib_buffer_get_current (b0),
352 (u8 *) tph + tph->tp_mac,
353 sizeof (ethernet_header_t));
354 ethernet_header_t *eth =
355 vlib_buffer_get_current (b0);
356 ethernet_vlan_header_t *vlan =
357 (ethernet_vlan_header_t *) (eth + 1);
358 vlan->priority_cfi_and_id =
359 clib_host_to_net_u16 (tph->hv1.tp_vlan_tci);
360 vlan->type = eth->type;
362 clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
363 vlan_len = sizeof (ethernet_vlan_header_t);
364 bytes_copied = sizeof (ethernet_header_t);
367 clib_memcpy_fast (((u8 *) vlib_buffer_get_current (b0)) +
368 bytes_copied + vlan_len,
369 (u8 *) tph + tph->tp_mac + offset +
371 (bytes_to_copy - bytes_copied));
373 /* fill buffer header */
374 b0->current_length = bytes_to_copy + vlan_len;
378 b0->total_length_not_including_first_buffer = 0;
379 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
380 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
382 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~0;
385 if (is_cksum_gso_enabled)
387 if (vnet_hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
388 fill_cksum_offload (first_b0, &l4_hdr_sz, is_ip);
389 if (vnet_hdr->gso_type & (VIRTIO_NET_HDR_GSO_TCPV4 |
390 VIRTIO_NET_HDR_GSO_TCPV6))
391 fill_gso_offload (first_b0, vnet_hdr->gso_size,
396 buffer_add_to_chain (b0, first_b0, prev_b0, bi0);
399 offset += bytes_to_copy;
400 data_len -= bytes_to_copy;
403 n_rx_bytes += tph->tp_snaplen;
404 to_next[0] = first_bi0;
408 /* drop partial packets */
409 if (PREDICT_FALSE (tph->tp_len != tph->tp_snaplen))
411 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
413 node->errors[AF_PACKET_INPUT_ERROR_PARTIAL_PKT];
417 if (PREDICT_FALSE (apif->mode == AF_PACKET_IF_MODE_IP))
419 switch (first_b0->data[0] & 0xf0)
422 next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
425 next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
428 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
431 if (PREDICT_FALSE (apif->per_interface_next_index != ~0))
432 next0 = apif->per_interface_next_index;
436 /* copy feature arc data from template */
437 first_b0->current_config_index = bt.current_config_index;
438 vnet_buffer (first_b0)->feature_arc_index =
439 vnet_buffer (&bt)->feature_arc_index;
444 if (PREDICT_FALSE (n_trace > 0 &&
445 vlib_trace_buffer (vm, node, next0, first_b0,
446 /* follow_chain */ 0)))
448 af_packet_input_trace_t *tr;
449 vlib_set_trace_count (vm, node, --n_trace);
450 tr = vlib_add_trace (vm, node, first_b0, sizeof (*tr));
451 tr->next_index = next0;
452 tr->hw_if_index = apif->hw_if_index;
454 tr->block_start = bd;
455 tr->pkt_num = bd->hdr.bh1.num_pkts - num_pkts;
456 clib_memcpy_fast (&tr->bd, bd, sizeof (block_desc_t));
457 clib_memcpy_fast (&tr->tph, tph, sizeof (tpacket3_hdr_t));
458 if (is_cksum_gso_enabled)
459 clib_memcpy_fast (&tr->vnet_hdr, vnet_hdr,
460 sizeof (vnet_virtio_net_hdr_t));
462 clib_memset_u8 (&tr->vnet_hdr, 0,
463 sizeof (vnet_virtio_net_hdr_t));
466 /* enque and take next packet */
467 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
468 n_left_to_next, first_bi0,
473 rx_frame_offset += tph->tp_next_offset;
476 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
479 if (PREDICT_TRUE (num_pkts == 0))
481 bd->hdr.bh1.block_status = TP_STATUS_KERNEL;
482 block = (block + 1) % block_nr;
486 apif->ss.rx_frame_offset = rx_frame_offset;
487 apif->ss.num_pkts = num_pkts;
488 apif->ss.is_save = 1;
492 apif->next_rx_block = block;
496 if ((((block_desc_t *) (block_start = apif->rx_ring[block]))
497 ->hdr.bh1.block_status &
498 TP_STATUS_USER) != 0)
499 vlib_node_set_state (vm, node->node_index, VLIB_NODE_STATE_POLLING);
501 vlib_node_set_state (vm, node->node_index, VLIB_NODE_STATE_INTERRUPT);
503 vlib_increment_combined_counter
504 (vnet_get_main ()->interface_main.combined_sw_if_counters
505 + VNET_INTERFACE_COUNTER_RX,
506 vlib_get_thread_index (), apif->hw_if_index, n_rx_packets, n_rx_bytes);
508 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
512 VLIB_NODE_FN (af_packet_input_node) (vlib_main_t * vm,
513 vlib_node_runtime_t * node,
514 vlib_frame_t * frame)
516 u32 n_rx_packets = 0;
517 af_packet_main_t *apm = &af_packet_main;
518 vnet_hw_if_rxq_poll_vector_t *pv;
519 pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
520 for (int i = 0; i < vec_len (pv); i++)
522 af_packet_if_t *apif;
523 apif = vec_elt_at_index (apm->interfaces, pv[i].dev_instance);
524 if (apif->is_admin_up)
526 if (apif->is_cksum_gso_enabled)
528 af_packet_device_input_fn (vm, node, frame, apif, 1);
531 af_packet_device_input_fn (vm, node, frame, apif, 0);
537 VLIB_REGISTER_NODE (af_packet_input_node) = {
538 .name = "af-packet-input",
539 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
540 .sibling_of = "device-input",
541 .format_trace = format_af_packet_input_trace,
542 .type = VLIB_NODE_TYPE_INPUT,
543 .state = VLIB_NODE_STATE_INTERRUPT,
544 .n_errors = AF_PACKET_INPUT_N_ERROR,
545 .error_strings = af_packet_input_error_strings,
550 * fd.io coding-style-patch-verification: ON
553 * eval: (c-set-style "gnu")