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_ether.h>
21 #include <linux/if_packet.h>
22 #include <sys/ioctl.h>
26 #include <sys/types.h>
29 #include <vppinfra/linux/sysfs.h>
30 #include <vlib/vlib.h>
31 #include <vlib/unix/unix.h>
32 #include <vnet/ip/ip.h>
33 #include <vnet/devices/netlink.h>
34 #include <vnet/ethernet/ethernet.h>
35 #include <vnet/interface/rx_queue_funcs.h>
37 #include <vnet/devices/af_packet/af_packet.h>
39 af_packet_main_t af_packet_main;
41 VNET_HW_INTERFACE_CLASS (af_packet_ip_device_hw_interface_class, static) = {
42 .name = "af-packet-ip-device",
43 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
46 #define AF_PACKET_DEFAULT_TX_FRAMES_PER_BLOCK 1024
47 #define AF_PACKET_DEFAULT_TX_FRAME_SIZE (2048 * 33) // GSO packet of 64KB
48 #define AF_PACKET_TX_BLOCK_NR 1
50 #define AF_PACKET_DEFAULT_RX_FRAMES_PER_BLOCK 256
51 #define AF_PACKET_DEFAULT_RX_FRAME_SIZE 2048
52 #define AF_PACKET_RX_BLOCK_NR 20
54 /*defined in net/if.h but clashes with dpdk headers */
55 unsigned int if_nametoindex (const char *ifname);
58 af_packet_eth_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hi,
61 clib_error_t *error, *rv;
62 af_packet_main_t *apm = &af_packet_main;
63 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, hi->dev_instance);
65 error = vnet_netlink_set_link_mtu (apif->host_if_index,
66 frame_size + hi->frame_overhead);
70 vlib_log_err (apm->log_class, "netlink failed to change MTU: %U",
71 format_clib_error, error);
72 rv = vnet_error (VNET_ERR_SYSCALL_ERROR_1, "netlink error: %U",
73 format_clib_error, error);
74 clib_error_free (error);
78 apif->host_mtu = frame_size + hi->frame_overhead;
83 af_packet_read_mtu (af_packet_if_t *apif)
85 af_packet_main_t *apm = &af_packet_main;
87 error = vnet_netlink_get_link_mtu (apif->host_if_index, &apif->host_mtu);
90 vlib_log_err (apm->log_class, "netlink failed to get MTU: %U",
91 format_clib_error, error);
92 clib_error_free (error);
93 return VNET_API_ERROR_SYSCALL_ERROR_1;
99 af_packet_fd_read_ready (clib_file_t * uf)
101 af_packet_main_t *apm = &af_packet_main;
102 vnet_main_t *vnm = vnet_get_main ();
103 u32 idx = uf->private_data;
104 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
106 /* Schedule the rx node */
107 vnet_hw_if_rx_queue_set_int_pending (vnm, apif->queue_index);
112 is_bridge (const u8 * host_if_name)
117 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
118 dir = opendir ((char *) s);
131 create_packet_v3_sock (int host_if_index, tpacket_req3_t *rx_req,
132 tpacket_req3_t *tx_req, int *fd, u8 **ring,
133 u32 *hdrlen_ptr, u8 *is_cksum_gso_enabled)
135 af_packet_main_t *apm = &af_packet_main;
136 struct sockaddr_ll sll;
137 socklen_t req_sz = sizeof (tpacket_req3_t);
139 int ver = TPACKET_V3;
141 u32 len = sizeof (hdrlen);
142 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
143 tx_req->tp_block_size * tx_req->tp_block_nr;
145 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
147 vlib_log_debug (apm->log_class,
148 "Failed to create AF_PACKET socket: %s (errno %d)",
149 strerror (errno), errno);
150 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
154 /* bind before rx ring is cfged so we don't receive packets from other interfaces */
155 clib_memset (&sll, 0, sizeof (sll));
156 sll.sll_family = PF_PACKET;
157 sll.sll_protocol = htons (ETH_P_ALL);
158 sll.sll_ifindex = host_if_index;
159 if (bind (*fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
161 vlib_log_debug (apm->log_class,
162 "Failed to bind rx packet socket: %s (errno %d)",
163 strerror (errno), errno);
164 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
168 if (setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver)) < 0)
172 "Failed to set rx packet interface version: %s (errno %d)",
173 strerror (errno), errno);
174 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
178 if (getsockopt (*fd, SOL_PACKET, PACKET_HDRLEN, &hdrlen, &len) < 0)
182 "Failed to get packet hdr len error handling option: %s (errno %d)",
183 strerror (errno), errno);
184 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
188 *hdrlen_ptr = hdrlen;
191 if (setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt)) < 0)
195 "Failed to set packet tx ring error handling option: %s (errno %d)",
196 strerror (errno), errno);
197 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
202 if (setsockopt (*fd, SOL_PACKET, PACKET_VNET_HDR, &opt2, sizeof (opt2)) < 0)
206 "Failed to set packet vnet hdr error handling option: %s (errno %d)",
207 strerror (errno), errno);
210 *is_cksum_gso_enabled = 1;
212 #if defined(PACKET_QDISC_BYPASS)
213 /* Introduced with Linux 3.14 so the ifdef should eventually be removed */
214 if (setsockopt (*fd, SOL_PACKET, PACKET_QDISC_BYPASS, &opt, sizeof (opt)) <
217 vlib_log_debug (apm->log_class,
218 "Failed to set qdisc bypass error "
219 "handling option: %s (errno %d)",
220 strerror (errno), errno);
224 if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
226 vlib_log_debug (apm->log_class,
227 "Failed to set packet rx ring options: %s (errno %d)",
228 strerror (errno), errno);
229 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
233 if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
235 vlib_log_debug (apm->log_class,
236 "Failed to set packet tx ring options: %s (errno %d)",
237 strerror (errno), errno);
238 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
242 *ring = mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED,
244 if (*ring == MAP_FAILED)
246 vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
247 strerror (errno), errno);
248 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
263 af_packet_create_if (af_packet_create_if_arg_t *arg)
265 af_packet_main_t *apm = &af_packet_main;
266 vlib_main_t *vm = vlib_get_main ();
267 int ret, fd = -1, fd2 = -1;
268 tpacket_req3_t *rx_req = 0;
269 tpacket_req3_t *tx_req = 0;
272 af_packet_if_t *apif = 0;
274 vnet_sw_interface_t *sw;
275 vlib_thread_main_t *tm = vlib_get_thread_main ();
276 vnet_main_t *vnm = vnet_get_main ();
277 vnet_hw_if_caps_t caps = VNET_HW_IF_CAP_INT_MODE;
280 u8 *host_if_name_dup = 0;
281 int host_if_index = -1;
282 u32 rx_frames_per_block, tx_frames_per_block;
283 u32 rx_frame_size, tx_frame_size;
286 u8 is_cksum_gso_enabled = 0;
288 p = mhash_get (&apm->if_index_by_host_if_name, arg->host_if_name);
291 apif = vec_elt_at_index (apm->interfaces, p[0]);
292 arg->sw_if_index = apif->sw_if_index;
293 return VNET_API_ERROR_IF_ALREADY_EXISTS;
296 host_if_name_dup = vec_dup (arg->host_if_name);
298 rx_frames_per_block = arg->rx_frames_per_block ?
299 arg->rx_frames_per_block :
300 AF_PACKET_DEFAULT_RX_FRAMES_PER_BLOCK;
301 tx_frames_per_block = arg->tx_frames_per_block ?
302 arg->tx_frames_per_block :
303 AF_PACKET_DEFAULT_TX_FRAMES_PER_BLOCK;
305 arg->rx_frame_size ? arg->rx_frame_size : AF_PACKET_DEFAULT_RX_FRAME_SIZE;
307 arg->tx_frame_size ? arg->tx_frame_size : AF_PACKET_DEFAULT_TX_FRAME_SIZE;
309 vec_validate (rx_req, 0);
310 rx_req->tp_block_size = rx_frame_size * rx_frames_per_block;
311 rx_req->tp_frame_size = rx_frame_size;
312 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
313 rx_req->tp_frame_nr = AF_PACKET_RX_BLOCK_NR * rx_frames_per_block;
314 rx_req->tp_retire_blk_tov = 0;
315 rx_req->tp_feature_req_word = 0;
316 rx_req->tp_sizeof_priv = 0;
318 vec_validate (tx_req, 0);
319 tx_req->tp_block_size = tx_frame_size * tx_frames_per_block;
320 tx_req->tp_frame_size = tx_frame_size;
321 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
322 tx_req->tp_frame_nr = AF_PACKET_TX_BLOCK_NR * tx_frames_per_block;
323 tx_req->tp_retire_blk_tov = 0;
324 tx_req->tp_sizeof_priv = 0;
325 tx_req->tp_feature_req_word = 0;
328 * make sure host side of interface is 'UP' before binding AF_PACKET
331 if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
333 vlib_log_debug (apm->log_class,
334 "Failed to create AF_UNIX socket: %s (errno %d)",
335 strerror (errno), errno);
336 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
340 clib_memcpy (ifr.ifr_name, (const char *) arg->host_if_name,
341 vec_len (arg->host_if_name));
342 if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
346 "Failed to retrieve the interface (%s) index: %s (errno %d)",
347 arg->host_if_name, strerror (errno), errno);
348 ret = VNET_API_ERROR_INVALID_INTERFACE;
352 host_if_index = ifr.ifr_ifindex;
353 if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
355 vlib_log_debug (apm->log_class,
356 "Failed to get the active flag: %s (errno %d)",
357 strerror (errno), errno);
358 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
362 if (!(ifr.ifr_flags & IFF_UP))
364 ifr.ifr_flags |= IFF_UP;
365 if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
367 vlib_log_debug (apm->log_class,
368 "Failed to set the active flag: %s (errno %d)",
369 strerror (errno), errno);
370 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
381 ret = create_packet_v3_sock (host_if_index, rx_req, tx_req, &fd, &ring,
382 &hdrlen, &is_cksum_gso_enabled);
387 ret = is_bridge (arg->host_if_name);
389 if (ret == 0) /* is a bridge, ignore state */
392 /* So far everything looks good, let's create interface */
393 pool_get (apm->interfaces, apif);
394 if_index = apif - apm->interfaces;
396 apif->host_if_index = host_if_index;
399 vec_validate (apif->rx_ring, rx_req->tp_block_nr - 1);
400 vec_foreach_index (i, apif->rx_ring)
402 apif->rx_ring[i] = ring + i * rx_req->tp_block_size;
405 ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
407 vec_validate (apif->tx_ring, tx_req->tp_block_nr - 1);
408 vec_foreach_index (i, apif->tx_ring)
410 apif->tx_ring[i] = ring + i * tx_req->tp_block_size;
413 apif->rx_req = rx_req;
414 apif->tx_req = tx_req;
415 apif->host_if_name = host_if_name_dup;
416 apif->per_interface_next_index = ~0;
417 apif->next_tx_frame = 0;
418 apif->next_rx_block = 0;
419 apif->mode = arg->mode;
420 apif->hdrlen = hdrlen;
421 apif->is_cksum_gso_enabled = is_cksum_gso_enabled;
422 apif->ss.is_save = 0;
424 ret = af_packet_read_mtu (apif);
428 if (tm->n_vlib_mains > 1)
429 clib_spinlock_init (&apif->lockp);
431 if (apif->mode != AF_PACKET_IF_MODE_IP)
433 vnet_eth_interface_registration_t eir = {};
434 /*use configured or generate random MAC address */
436 clib_memcpy (hw_addr, arg->hw_addr, 6);
439 f64 now = vlib_time_now (vm);
441 rnd = (u32) (now * 1e6);
442 rnd = random_u32 (&rnd);
444 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
449 eir.dev_class_index = af_packet_device_class.index;
450 eir.dev_instance = if_index;
451 eir.address = hw_addr;
452 eir.cb.set_max_frame_size = af_packet_eth_set_max_frame_size;
453 apif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
457 apif->hw_if_index = vnet_register_interface (
458 vnm, af_packet_device_class.index, if_index,
459 af_packet_ip_device_hw_interface_class.index, if_index);
461 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
462 apif->sw_if_index = sw->sw_if_index;
463 vnet_hw_if_set_input_node (vnm, apif->hw_if_index,
464 af_packet_input_node.index);
465 apif->queue_index = vnet_hw_if_register_rx_queue (vnm, apif->hw_if_index, 0,
466 VNET_HW_IF_RXQ_THREAD_ANY);
468 if (apif->is_cksum_gso_enabled)
469 caps |= VNET_HW_IF_CAP_TCP_GSO | VNET_HW_IF_CAP_TX_IP4_CKSUM |
470 VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM;
472 vnet_hw_if_set_caps (vnm, apif->hw_if_index, caps);
473 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
474 VNET_HW_INTERFACE_FLAG_LINK_UP);
476 vnet_hw_if_set_rx_queue_mode (vnm, apif->queue_index,
477 VNET_HW_IF_RX_MODE_INTERRUPT);
478 vnet_hw_if_update_runtime_data (vnm, apif->hw_if_index);
480 clib_file_t template = { 0 };
481 template.read_function = af_packet_fd_read_ready;
482 template.file_descriptor = fd;
483 template.private_data = if_index;
484 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
485 template.description =
486 format (0, "%U", format_af_packet_device_name, if_index);
487 apif->clib_file_index = clib_file_add (&file_main, &template);
489 vnet_hw_if_set_rx_queue_file_index (vnm, apif->queue_index,
490 apif->clib_file_index);
492 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
494 arg->sw_if_index = apif->sw_if_index;
504 vec_free (host_if_name_dup);
511 af_packet_delete_if (u8 *host_if_name)
513 vnet_main_t *vnm = vnet_get_main ();
514 af_packet_main_t *apm = &af_packet_main;
515 af_packet_if_t *apif;
520 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
523 vlib_log_warn (apm->log_class, "Host interface %s does not exist",
525 return VNET_API_ERROR_SYSCALL_ERROR_1;
527 apif = pool_elt_at_index (apm->interfaces, p[0]);
528 if_index = apif - apm->interfaces;
530 /* bring down the interface */
531 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
534 if (apif->clib_file_index != ~0)
536 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
537 apif->clib_file_index = ~0;
542 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
543 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
544 if (munmap (apif->rx_ring, ring_sz))
545 vlib_log_warn (apm->log_class,
546 "Host interface %s could not free rx/tx ring",
548 apif->rx_ring = NULL;
549 apif->tx_ring = NULL;
552 vec_free (apif->rx_req);
554 vec_free (apif->tx_req);
557 vec_free (apif->host_if_name);
558 apif->host_if_name = NULL;
559 apif->host_if_index = -1;
561 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
563 if (apif->mode != AF_PACKET_IF_MODE_IP)
564 ethernet_delete_interface (vnm, apif->hw_if_index);
566 vnet_delete_hw_interface (vnm, apif->hw_if_index);
568 pool_put (apm->interfaces, apif);
574 af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set)
581 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
583 af_packet_main_t *apm = &af_packet_main;
584 af_packet_if_t *apif;
585 af_packet_if_detail_t *r_af_packet_ifs = NULL;
586 af_packet_if_detail_t *af_packet_if = NULL;
588 pool_foreach (apif, apm->interfaces)
590 vec_add2 (r_af_packet_ifs, af_packet_if, 1);
591 af_packet_if->sw_if_index = apif->sw_if_index;
592 if (apif->host_if_name)
594 clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
595 MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
596 strlen ((const char *) apif->host_if_name)));
600 *out_af_packet_ifs = r_af_packet_ifs;
605 static clib_error_t *
606 af_packet_init (vlib_main_t * vm)
608 af_packet_main_t *apm = &af_packet_main;
609 vlib_thread_main_t *tm = vlib_get_thread_main ();
611 clib_memset (apm, 0, sizeof (af_packet_main_t));
613 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
615 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
616 CLIB_CACHE_LINE_BYTES);
618 apm->log_class = vlib_log_register_class ("af_packet", 0);
619 vlib_log_debug (apm->log_class, "initialized");
624 VLIB_INIT_FUNCTION (af_packet_init);
627 * fd.io coding-style-patch-verification: ON
630 * eval: (c-set-style "gnu")