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>
21 #include <sys/socket.h>
22 #include <sys/ioctl.h>
24 #include <net/if_arp.h>
26 #include <vlib/vlib.h>
27 #include <vlib/unix/unix.h>
28 #include <vnet/ip/ip.h>
29 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/ip/ip_psh_cksum.h>
33 #include <vnet/tcp/tcp_packet.h>
34 #include <vnet/udp/udp_packet.h>
36 #include <vnet/devices/af_packet/af_packet.h>
37 #include <vnet/devices/virtio/virtio_std.h>
39 #define foreach_af_packet_tx_func_error \
40 _(FRAME_NOT_READY, "tx frame not ready") \
41 _(TXRING_EAGAIN, "tx sendto temporary failure") \
42 _(TXRING_FATAL, "tx sendto fatal failure") \
43 _(TXRING_OVERRUN, "tx ring overrun")
47 #define _(f,s) AF_PACKET_TX_ERROR_##f,
48 foreach_af_packet_tx_func_error
51 } af_packet_tx_func_error_t;
53 static char *af_packet_tx_func_error_strings[] = {
55 foreach_af_packet_tx_func_error
65 vnet_virtio_net_hdr_t vnet_hdr;
67 } af_packet_tx_trace_t;
69 #ifndef CLIB_MARCH_VARIANT
71 format_af_packet_device_name (u8 * s, va_list * args)
73 u32 i = va_arg (*args, u32);
74 af_packet_main_t *apm = &af_packet_main;
75 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, i);
77 s = format (s, "host-%s", apif->host_if_name);
80 #endif /* CLIB_MARCH_VARIANT */
83 format_af_packet_device (u8 * s, va_list * args)
85 u32 dev_instance = va_arg (*args, u32);
86 u32 indent = format_get_indent (s);
87 int __clib_unused verbose = va_arg (*args, int);
89 af_packet_main_t *apm = &af_packet_main;
90 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, dev_instance);
91 af_packet_queue_t *rx_queue = 0;
92 af_packet_queue_t *tx_queue = 0;
94 s = format (s, "Linux PACKET socket interface");
95 s = format (s, "\n%UFEATURES:", format_white_space, indent);
96 if (apif->is_qdisc_bypass_enabled)
97 s = format (s, "\n%Uqdisc-bpass-enabled", format_white_space, indent + 2);
98 if (apif->is_cksum_gso_enabled)
99 s = format (s, "\n%Ucksum-gso-enabled", format_white_space, indent + 2);
101 vec_foreach (rx_queue, apif->rx_queues)
103 u32 rx_block_size = rx_queue->rx_req->tp_block_size;
104 u32 rx_frame_size = rx_queue->rx_req->tp_frame_size;
105 u32 rx_frame_nr = rx_queue->rx_req->tp_frame_nr;
106 u32 rx_block_nr = rx_queue->rx_req->tp_block_nr;
108 s = format (s, "\n%URX Queue %u:", format_white_space, indent,
110 s = format (s, "\n%Ublock size:%d nr:%d frame size:%d nr:%d",
111 format_white_space, indent + 2, rx_block_size, rx_block_nr,
112 rx_frame_size, rx_frame_nr);
113 s = format (s, " next block:%d", rx_queue->next_rx_block);
114 if (rx_queue->is_rx_pending)
117 s, "\n%UPending Request: num-rx-pkts:%d next-frame-offset:%d",
118 format_white_space, indent + 2, rx_queue->num_rx_pkts,
119 rx_queue->rx_frame_offset);
123 vec_foreach (tx_queue, apif->tx_queues)
125 clib_spinlock_lock (&tx_queue->lockp);
126 u32 tx_block_sz = tx_queue->tx_req->tp_block_size;
127 u32 tx_frame_sz = tx_queue->tx_req->tp_frame_size;
128 u32 tx_frame_nr = tx_queue->tx_req->tp_frame_nr;
129 u32 tx_block_nr = tx_queue->tx_req->tp_block_nr;
131 int n_send_req = 0, n_avail = 0, n_sending = 0, n_tot = 0, n_wrong = 0;
132 u8 *tx_block_start = tx_queue->tx_ring[block];
133 u32 tx_frame = tx_queue->next_tx_frame;
136 s = format (s, "\n%UTX Queue %u:", format_white_space, indent,
138 s = format (s, "\n%Ublock size:%d nr:%d frame size:%d nr:%d",
139 format_white_space, indent + 2, tx_block_sz, tx_block_nr,
140 tx_frame_sz, tx_frame_nr);
141 s = format (s, " next frame:%d", tx_queue->next_tx_frame);
145 tph = (tpacket3_hdr_t *) (tx_block_start + tx_frame * tx_frame_sz);
146 tx_frame = (tx_frame + 1) % tx_frame_nr;
147 if (tph->tp_status == 0)
149 else if (tph->tp_status & TP_STATUS_SEND_REQUEST)
151 else if (tph->tp_status & TP_STATUS_SENDING)
157 while (tx_frame != tx_queue->next_tx_frame);
159 format (s, "\n%Uavailable:%d request:%d sending:%d wrong:%d total:%d",
160 format_white_space, indent + 2, n_avail, n_send_req, n_sending,
162 clib_spinlock_unlock (&tx_queue->lockp);
168 format_af_packet_tx_trace (u8 *s, va_list *va)
170 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
171 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
172 af_packet_tx_trace_t *t = va_arg (*va, af_packet_tx_trace_t *);
173 u32 indent = format_get_indent (s);
175 s = format (s, "af_packet: hw_if_index %u tx-queue %u", t->hw_if_index,
180 "\n%Utpacket3_hdr:\n%Ustatus 0x%x len %u snaplen %u mac %u net %u"
181 "\n%Usec 0x%x nsec 0x%x vlan %U"
182 #ifdef TP_STATUS_VLAN_TPID_VALID
186 format_white_space, indent + 2, format_white_space, indent + 4,
187 t->tph.tp_status, t->tph.tp_len, t->tph.tp_snaplen, t->tph.tp_mac,
188 t->tph.tp_net, format_white_space, indent + 4, t->tph.tp_sec,
189 t->tph.tp_nsec, format_ethernet_vlan_tci, t->tph.hv1.tp_vlan_tci
190 #ifdef TP_STATUS_VLAN_TPID_VALID
192 t->tph.hv1.tp_vlan_tpid
197 "\n%Uvnet-hdr:\n%Uflags 0x%02x gso_type 0x%02x hdr_len %u"
198 "\n%Ugso_size %u csum_start %u csum_offset %u",
199 format_white_space, indent + 2, format_white_space, indent + 4,
200 t->vnet_hdr.flags, t->vnet_hdr.gso_type, t->vnet_hdr.hdr_len,
201 format_white_space, indent + 4, t->vnet_hdr.gso_size,
202 t->vnet_hdr.csum_start, t->vnet_hdr.csum_offset);
204 s = format (s, "\n%Ubuffer 0x%x:\n%U%U", format_white_space, indent + 2,
205 t->buffer_index, format_white_space, indent + 4,
206 format_vnet_buffer_no_chain, &t->buffer);
207 s = format (s, "\n%U%U", format_white_space, indent + 2,
208 format_ethernet_header_with_length, t->buffer.pre_data,
209 sizeof (t->buffer.pre_data));
214 af_packet_tx_trace (vlib_main_t *vm, vlib_node_runtime_t *node,
215 vlib_buffer_t *b0, u32 bi, tpacket3_hdr_t *tph,
216 vnet_virtio_net_hdr_t *vnet_hdr, u32 hw_if_index,
219 af_packet_tx_trace_t *t;
220 t = vlib_add_trace (vm, node, b0, sizeof (t[0]));
221 t->hw_if_index = hw_if_index;
222 t->queue_id = queue_id;
223 t->buffer_index = bi;
225 clib_memcpy_fast (&t->tph, tph, sizeof (*tph));
226 clib_memcpy_fast (&t->vnet_hdr, vnet_hdr, sizeof (*vnet_hdr));
227 clib_memcpy_fast (&t->buffer, b0, sizeof (*b0) - sizeof (b0->pre_data));
228 clib_memcpy_fast (t->buffer.pre_data, vlib_buffer_get_current (b0),
229 sizeof (t->buffer.pre_data));
232 static_always_inline void
233 fill_gso_offload (vlib_buffer_t *b0, vnet_virtio_net_hdr_t *vnet_hdr)
235 vnet_buffer_oflags_t oflags = vnet_buffer (b0)->oflags;
236 if (b0->flags & VNET_BUFFER_F_IS_IP4)
239 vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
240 vnet_hdr->gso_size = vnet_buffer2 (b0)->gso_size;
242 vnet_buffer (b0)->l4_hdr_offset + vnet_buffer2 (b0)->gso_l4_hdr_sz;
243 vnet_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
244 vnet_hdr->csum_start = vnet_buffer (b0)->l4_hdr_offset; // 0x22;
245 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
246 ip4 = (ip4_header_t *) (b0->data + vnet_buffer (b0)->l3_hdr_offset);
247 if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
248 ip4->checksum = ip4_header_checksum (ip4);
250 else if (b0->flags & VNET_BUFFER_F_IS_IP6)
252 vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
253 vnet_hdr->gso_size = vnet_buffer2 (b0)->gso_size;
255 vnet_buffer (b0)->l4_hdr_offset + vnet_buffer2 (b0)->gso_l4_hdr_sz;
256 vnet_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
257 vnet_hdr->csum_start = vnet_buffer (b0)->l4_hdr_offset; // 0x36;
258 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
262 static_always_inline void
263 fill_cksum_offload (vlib_buffer_t *b0, vnet_virtio_net_hdr_t *vnet_hdr)
265 vnet_buffer_oflags_t oflags = vnet_buffer (b0)->oflags;
266 if (b0->flags & VNET_BUFFER_F_IS_IP4)
269 ip4 = (ip4_header_t *) (b0->data + vnet_buffer (b0)->l3_hdr_offset);
270 if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
271 ip4->checksum = ip4_header_checksum (ip4);
272 vnet_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
273 vnet_hdr->csum_start = 0x22;
274 if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
277 (tcp_header_t *) (b0->data + vnet_buffer (b0)->l4_hdr_offset);
278 tcp->checksum = ip4_pseudo_header_cksum (ip4);
279 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
281 else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
284 (udp_header_t *) (b0->data + vnet_buffer (b0)->l4_hdr_offset);
285 udp->checksum = ip4_pseudo_header_cksum (ip4);
286 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
289 else if (b0->flags & VNET_BUFFER_F_IS_IP6)
292 vnet_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
293 vnet_hdr->csum_start = 0x36;
294 ip6 = (ip6_header_t *) (b0->data + vnet_buffer (b0)->l3_hdr_offset);
295 if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
298 (tcp_header_t *) (b0->data + vnet_buffer (b0)->l4_hdr_offset);
299 tcp->checksum = ip6_pseudo_header_cksum (ip6);
300 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
302 else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
305 (udp_header_t *) (b0->data + vnet_buffer (b0)->l4_hdr_offset);
306 udp->checksum = ip6_pseudo_header_cksum (ip6);
307 vnet_hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
312 VNET_DEVICE_CLASS_TX_FN (af_packet_device_class) (vlib_main_t * vm,
313 vlib_node_runtime_t * node,
314 vlib_frame_t * frame)
316 af_packet_main_t *apm = &af_packet_main;
317 vnet_hw_if_tx_frame_t *tf = vlib_frame_scalar_args (frame);
318 u32 *buffers = vlib_frame_vector_args (frame);
319 u32 n_left = frame->n_vectors;
321 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
322 af_packet_if_t *apif =
323 pool_elt_at_index (apm->interfaces, rd->dev_instance);
324 u16 queue_id = tf->queue_id;
325 af_packet_queue_t *tx_queue = vec_elt_at_index (apif->tx_queues, queue_id);
326 u32 block = 0, frame_size = 0, frame_num = 0, tx_frame = 0;
328 tpacket3_hdr_t *tph = 0;
329 u32 frame_not_ready = 0;
330 u8 is_cksum_gso_enabled = (apif->is_cksum_gso_enabled == 1) ? 1 : 0;
332 if (tf->shared_queue)
333 clib_spinlock_lock (&tx_queue->lockp);
335 frame_size = tx_queue->tx_req->tp_frame_size;
336 frame_num = tx_queue->tx_req->tp_frame_nr;
337 block_start = tx_queue->tx_ring[block];
338 tx_frame = tx_queue->next_tx_frame;
343 vnet_virtio_net_hdr_t *vnet_hdr = 0;
345 vlib_buffer_t *b0 = 0, *b0_first = 0;
348 bi = bi_first = buffers[0];
352 tph = (tpacket3_hdr_t *) (block_start + tx_frame * frame_size);
353 if (PREDICT_FALSE (tph->tp_status &
354 (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING)))
360 b0_first = b0 = vlib_get_buffer (vm, bi);
362 if (PREDICT_TRUE (is_cksum_gso_enabled))
365 (vnet_virtio_net_hdr_t *) ((u8 *) tph + TPACKET_ALIGN (sizeof (
368 clib_memset_u8 (vnet_hdr, 0, sizeof (vnet_virtio_net_hdr_t));
369 offset = sizeof (vnet_virtio_net_hdr_t);
371 if (b0->flags & VNET_BUFFER_F_GSO)
372 fill_gso_offload (b0, vnet_hdr);
373 else if (b0->flags & VNET_BUFFER_F_OFFLOAD)
374 fill_cksum_offload (b0, vnet_hdr);
377 len = b0->current_length;
378 clib_memcpy_fast ((u8 *) tph + TPACKET_ALIGN (sizeof (tpacket3_hdr_t)) +
380 vlib_buffer_get_current (b0), len);
383 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
385 b0 = vlib_get_buffer (vm, b0->next_buffer);
386 len = b0->current_length;
387 clib_memcpy_fast ((u8 *) tph +
388 TPACKET_ALIGN (sizeof (tpacket3_hdr_t)) + offset,
389 vlib_buffer_get_current (b0), len);
393 tph->tp_len = tph->tp_snaplen = offset;
394 tph->tp_status = TP_STATUS_SEND_REQUEST;
397 if (PREDICT_FALSE (b0_first->flags & VLIB_BUFFER_IS_TRACED))
399 if (PREDICT_TRUE (is_cksum_gso_enabled))
400 af_packet_tx_trace (vm, node, b0_first, bi_first, tph, vnet_hdr,
401 apif->hw_if_index, queue_id);
404 vnet_virtio_net_hdr_t vnet_hdr2 = {};
405 af_packet_tx_trace (vm, node, b0_first, bi_first, tph,
406 &vnet_hdr2, apif->hw_if_index, queue_id);
409 tx_frame = (tx_frame + 1) % frame_num;
412 /* check if we've exhausted the ring */
413 if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
417 CLIB_MEMORY_BARRIER ();
419 if (PREDICT_TRUE (n_sent))
421 tx_queue->next_tx_frame = tx_frame;
424 sendto (tx_queue->fd, NULL, 0, MSG_DONTWAIT, NULL, 0) == -1))
426 /* Uh-oh, drop & move on, but count whether it was fatal or not.
427 * Note that we have no reliable way to properly determine the
428 * disposition of the packets we just enqueued for delivery.
430 vlib_error_count (vm, node->node_index,
431 unix_error_is_fatal (errno) ?
432 AF_PACKET_TX_ERROR_TXRING_FATAL :
433 AF_PACKET_TX_ERROR_TXRING_EAGAIN,
438 if (tf->shared_queue)
439 clib_spinlock_unlock (&tx_queue->lockp);
441 if (PREDICT_FALSE (frame_not_ready))
442 vlib_error_count (vm, node->node_index,
443 AF_PACKET_TX_ERROR_FRAME_NOT_READY, frame_not_ready);
445 if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
446 vlib_error_count (vm, node->node_index, AF_PACKET_TX_ERROR_TXRING_OVERRUN,
449 vlib_buffer_free (vm, vlib_frame_vector_args (frame), frame->n_vectors);
450 return frame->n_vectors;
454 af_packet_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
457 af_packet_main_t *apm = &af_packet_main;
458 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
459 af_packet_if_t *apif =
460 pool_elt_at_index (apm->interfaces, hw->dev_instance);
462 /* Shut off redirection */
463 if (node_index == ~0)
465 apif->per_interface_next_index = node_index;
469 apif->per_interface_next_index =
470 vlib_node_add_next (vlib_get_main (), af_packet_input_node.index,
475 af_packet_clear_hw_interface_counters (u32 instance)
477 /* Nothing for now */
480 static clib_error_t *
481 af_packet_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
484 af_packet_main_t *apm = &af_packet_main;
485 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
486 af_packet_if_t *apif =
487 pool_elt_at_index (apm->interfaces, hw->dev_instance);
489 int rv, fd = socket (AF_UNIX, SOCK_DGRAM, 0);
494 vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
499 /* if interface is a bridge ignore */
500 if (apif->host_if_index < 0)
501 goto error; /* no error */
503 /* use host_if_index in case host name has changed */
504 ifr.ifr_ifindex = apif->host_if_index;
505 if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
507 vlib_log_warn (apm->log_class,
508 "af_packet_%s ioctl could not retrieve eth name",
513 apif->is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
515 if ((rv = ioctl (fd, SIOCGIFFLAGS, &ifr)) < 0)
517 vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
518 apif->is_admin_up ? "up" : "down", rv);
522 if (apif->is_admin_up)
524 hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP;
525 ifr.ifr_flags |= IFF_UP;
530 ifr.ifr_flags &= ~IFF_UP;
533 if ((rv = ioctl (fd, SIOCSIFFLAGS, &ifr)) < 0)
535 vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
536 apif->is_admin_up ? "up" : "down", rv);
540 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
546 return 0; /* no error */
549 static clib_error_t *
550 af_packet_subif_add_del_function (vnet_main_t * vnm,
552 struct vnet_sw_interface_t *st, int is_add)
554 /* Nothing for now */
558 static clib_error_t *af_packet_set_mac_address_function
559 (struct vnet_hw_interface_t *hi, const u8 * old_address, const u8 * address)
561 af_packet_main_t *apm = &af_packet_main;
562 af_packet_if_t *apif =
563 pool_elt_at_index (apm->interfaces, hi->dev_instance);
567 if (apif->mode == AF_PACKET_IF_MODE_IP)
569 vlib_log_warn (apm->log_class, "af_packet_%s interface is in IP mode",
571 return clib_error_return (0,
572 " MAC update failed, interface is in IP mode");
575 fd = socket (AF_UNIX, SOCK_DGRAM, 0);
578 vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
583 /* if interface is a bridge ignore */
584 if (apif->host_if_index < 0)
585 goto error; /* no error */
587 /* use host_if_index in case host name has changed */
588 ifr.ifr_ifindex = apif->host_if_index;
589 if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
593 "af_packet_%s ioctl could not retrieve eth name, error: %d",
594 apif->host_if_name, rv);
598 clib_memcpy (ifr.ifr_hwaddr.sa_data, address, 6);
599 ifr.ifr_hwaddr.sa_family = ARPHRD_ETHER;
601 if ((rv = ioctl (fd, SIOCSIFHWADDR, &ifr)) < 0)
603 vlib_log_warn (apm->log_class,
604 "af_packet_%s ioctl could not set mac, error: %d",
605 apif->host_if_name, rv);
614 return 0; /* no error */
617 VNET_DEVICE_CLASS (af_packet_device_class) = {
619 .format_device_name = format_af_packet_device_name,
620 .format_device = format_af_packet_device,
621 .format_tx_trace = format_af_packet_tx_trace,
622 .tx_function_n_errors = AF_PACKET_TX_N_ERROR,
623 .tx_function_error_strings = af_packet_tx_func_error_strings,
624 .rx_redirect_to_node = af_packet_set_interface_next_node,
625 .clear_counters = af_packet_clear_hw_interface_counters,
626 .admin_up_down_function = af_packet_interface_admin_up_down,
627 .subif_add_del_function = af_packet_subif_add_del_function,
628 .mac_addr_change_function = af_packet_set_mac_address_function,
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")