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 #define AF_PACKET_TX_FRAMES_PER_BLOCK 1024
42 #define AF_PACKET_TX_FRAME_SIZE (2048 * 5)
43 #define AF_PACKET_TX_BLOCK_NR 1
44 #define AF_PACKET_TX_FRAME_NR (AF_PACKET_TX_BLOCK_NR * \
45 AF_PACKET_TX_FRAMES_PER_BLOCK)
46 #define AF_PACKET_TX_BLOCK_SIZE (AF_PACKET_TX_FRAME_SIZE * \
47 AF_PACKET_TX_FRAMES_PER_BLOCK)
49 #define AF_PACKET_RX_FRAMES_PER_BLOCK 1024
50 #define AF_PACKET_RX_FRAME_SIZE (2048 * 5)
51 #define AF_PACKET_RX_BLOCK_NR 1
52 #define AF_PACKET_RX_FRAME_NR (AF_PACKET_RX_BLOCK_NR * \
53 AF_PACKET_RX_FRAMES_PER_BLOCK)
54 #define AF_PACKET_RX_BLOCK_SIZE (AF_PACKET_RX_FRAME_SIZE * \
55 AF_PACKET_RX_FRAMES_PER_BLOCK)
57 /*defined in net/if.h but clashes with dpdk headers */
58 unsigned int if_nametoindex (const char *ifname);
60 typedef struct tpacket_req tpacket_req_t;
63 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
67 af_packet_main_t *apm = &af_packet_main;
68 af_packet_if_t *apif =
69 pool_elt_at_index (apm->interfaces, hi->dev_instance);
71 if (flags == ETHERNET_INTERFACE_FLAG_MTU)
74 vnet_netlink_set_link_mtu (apif->host_if_index, hi->max_packet_bytes);
78 vlib_log_err (apm->log_class, "netlink failed to change MTU: %U",
79 format_clib_error, error);
80 clib_error_free (error);
81 return VNET_API_ERROR_SYSCALL_ERROR_1;
84 apif->host_mtu = hi->max_packet_bytes;
91 af_packet_read_mtu (af_packet_if_t *apif)
93 af_packet_main_t *apm = &af_packet_main;
95 error = vnet_netlink_get_link_mtu (apif->host_if_index, &apif->host_mtu);
98 vlib_log_err (apm->log_class, "netlink failed to get MTU: %U",
99 format_clib_error, error);
100 clib_error_free (error);
101 return VNET_API_ERROR_SYSCALL_ERROR_1;
106 static clib_error_t *
107 af_packet_fd_read_ready (clib_file_t * uf)
109 af_packet_main_t *apm = &af_packet_main;
110 vnet_main_t *vnm = vnet_get_main ();
111 u32 idx = uf->private_data;
112 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
114 apm->pending_input_bitmap =
115 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
117 /* Schedule the rx node */
118 vnet_hw_if_rx_queue_set_int_pending (vnm, apif->queue_index);
123 is_bridge (const u8 * host_if_name)
128 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
129 dir = opendir ((char *) s);
142 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
143 tpacket_req_t * tx_req, int *fd, u8 ** ring)
145 af_packet_main_t *apm = &af_packet_main;
147 struct sockaddr_ll sll;
148 int ver = TPACKET_V2;
149 socklen_t req_sz = sizeof (struct tpacket_req);
150 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
151 tx_req->tp_block_size * tx_req->tp_block_nr;
153 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
155 vlib_log_debug (apm->log_class,
156 "Failed to create AF_PACKET socket: %s (errno %d)",
157 strerror (errno), errno);
158 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
162 /* bind before rx ring is cfged so we don't receive packets from other interfaces */
163 clib_memset (&sll, 0, sizeof (sll));
164 sll.sll_family = PF_PACKET;
165 sll.sll_protocol = htons (ETH_P_ALL);
166 sll.sll_ifindex = host_if_index;
167 if (bind (*fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
169 vlib_log_debug (apm->log_class,
170 "Failed to bind rx packet socket: %s (errno %d)",
171 strerror (errno), errno);
172 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
176 if (setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver)) < 0)
178 vlib_log_debug (apm->log_class,
179 "Failed to set rx packet interface version: %s (errno %d)",
180 strerror (errno), errno);
181 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
186 if (setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt)) < 0)
188 vlib_log_debug (apm->log_class,
189 "Failed to set packet tx ring error handling option: %s (errno %d)",
190 strerror (errno), errno);
191 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
195 if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
197 vlib_log_debug (apm->log_class,
198 "Failed to set packet rx ring options: %s (errno %d)",
199 strerror (errno), errno);
200 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
204 if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
206 vlib_log_debug (apm->log_class,
207 "Failed to set packet tx ring options: %s (errno %d)",
208 strerror (errno), errno);
209 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
214 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
216 if (*ring == MAP_FAILED)
218 vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
219 strerror (errno), errno);
220 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
235 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
238 af_packet_main_t *apm = &af_packet_main;
239 int ret, fd = -1, fd2 = -1;
240 struct tpacket_req *rx_req = 0;
241 struct tpacket_req *tx_req = 0;
244 af_packet_if_t *apif = 0;
247 vnet_sw_interface_t *sw;
248 vnet_hw_interface_t *hw;
249 vlib_thread_main_t *tm = vlib_get_thread_main ();
250 vnet_main_t *vnm = vnet_get_main ();
253 u8 *host_if_name_dup = 0;
254 int host_if_index = -1;
256 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
259 apif = vec_elt_at_index (apm->interfaces, p[0]);
260 *sw_if_index = apif->sw_if_index;
261 return VNET_API_ERROR_IF_ALREADY_EXISTS;
264 host_if_name_dup = vec_dup (host_if_name);
266 vec_validate (rx_req, 0);
267 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
268 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
269 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
270 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
272 vec_validate (tx_req, 0);
273 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
274 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
275 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
276 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
279 * make sure host side of interface is 'UP' before binding AF_PACKET
282 if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
284 vlib_log_debug (apm->log_class,
285 "Failed to create AF_UNIX socket: %s (errno %d)",
286 strerror (errno), errno);
287 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
291 clib_memcpy (ifr.ifr_name, (const char *) host_if_name,
292 vec_len (host_if_name));
293 if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
295 vlib_log_debug (apm->log_class,
296 "Failed to retrieve the interface (%s) index: %s (errno %d)",
297 host_if_name, strerror (errno), errno);
298 ret = VNET_API_ERROR_INVALID_INTERFACE;
302 host_if_index = ifr.ifr_ifindex;
303 if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
305 vlib_log_debug (apm->log_class,
306 "Failed to get the active flag: %s (errno %d)",
307 strerror (errno), errno);
308 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
312 if (!(ifr.ifr_flags & IFF_UP))
314 ifr.ifr_flags |= IFF_UP;
315 if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
317 vlib_log_debug (apm->log_class,
318 "Failed to set the active flag: %s (errno %d)",
319 strerror (errno), errno);
320 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
331 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
336 ret = is_bridge (host_if_name);
338 if (ret == 0) /* is a bridge, ignore state */
341 /* So far everything looks good, let's create interface */
342 pool_get (apm->interfaces, apif);
343 if_index = apif - apm->interfaces;
345 apif->host_if_index = host_if_index;
347 apif->rx_ring = ring;
348 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
349 apif->rx_req = rx_req;
350 apif->tx_req = tx_req;
351 apif->host_if_name = host_if_name_dup;
352 apif->per_interface_next_index = ~0;
353 apif->next_tx_frame = 0;
354 apif->next_rx_frame = 0;
356 ret = af_packet_read_mtu (apif);
360 if (tm->n_vlib_mains > 1)
361 clib_spinlock_init (&apif->lockp);
363 /*use configured or generate random MAC address */
365 clib_memcpy (hw_addr, hw_addr_set, 6);
368 f64 now = vlib_time_now (vm);
370 rnd = (u32) (now * 1e6);
371 rnd = random_u32 (&rnd);
373 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
378 error = ethernet_register_interface (vnm, af_packet_device_class.index,
379 if_index, hw_addr, &apif->hw_if_index,
380 af_packet_eth_flag_change);
384 clib_memset (apif, 0, sizeof (*apif));
385 pool_put (apm->interfaces, apif);
386 vlib_log_err (apm->log_class, "Unable to register interface: %U",
387 format_clib_error, error);
388 clib_error_free (error);
389 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
393 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
394 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
395 apif->sw_if_index = sw->sw_if_index;
396 vnet_hw_if_set_input_node (vnm, apif->hw_if_index,
397 af_packet_input_node.index);
398 apif->queue_index = vnet_hw_if_register_rx_queue (vnm, apif->hw_if_index, 0,
399 VNET_HW_IF_RXQ_THREAD_ANY);
401 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE;
402 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
403 VNET_HW_INTERFACE_FLAG_LINK_UP);
405 vnet_hw_if_set_rx_queue_mode (vnm, apif->queue_index,
406 VNET_HW_IF_RX_MODE_INTERRUPT);
407 vnet_hw_if_update_runtime_data (vnm, apif->hw_if_index);
409 clib_file_t template = { 0 };
410 template.read_function = af_packet_fd_read_ready;
411 template.file_descriptor = fd;
412 template.private_data = if_index;
413 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
414 template.description =
415 format (0, "%U", format_af_packet_device_name, if_index);
416 apif->clib_file_index = clib_file_add (&file_main, &template);
418 vnet_hw_if_set_rx_queue_file_index (vnm, apif->queue_index,
419 apif->clib_file_index);
421 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
424 *sw_if_index = apif->sw_if_index;
434 vec_free (host_if_name_dup);
441 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
443 vnet_main_t *vnm = vnet_get_main ();
444 af_packet_main_t *apm = &af_packet_main;
445 af_packet_if_t *apif;
450 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
453 vlib_log_warn (apm->log_class, "Host interface %s does not exist",
455 return VNET_API_ERROR_SYSCALL_ERROR_1;
457 apif = pool_elt_at_index (apm->interfaces, p[0]);
458 if_index = apif - apm->interfaces;
460 /* bring down the interface */
461 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
464 if (apif->clib_file_index != ~0)
466 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
467 apif->clib_file_index = ~0;
472 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
473 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
474 if (munmap (apif->rx_ring, ring_sz))
475 vlib_log_warn (apm->log_class,
476 "Host interface %s could not free rx/tx ring",
478 apif->rx_ring = NULL;
479 apif->tx_ring = NULL;
482 vec_free (apif->rx_req);
484 vec_free (apif->tx_req);
487 vec_free (apif->host_if_name);
488 apif->host_if_name = NULL;
489 apif->host_if_index = -1;
491 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
493 ethernet_delete_interface (vnm, apif->hw_if_index);
495 pool_put (apm->interfaces, apif);
501 af_packet_set_l4_cksum_offload (vlib_main_t * vm, u32 sw_if_index, u8 set)
503 vnet_main_t *vnm = vnet_get_main ();
504 vnet_hw_interface_t *hw;
506 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
508 if (hw->dev_class_index != af_packet_device_class.index)
509 return VNET_API_ERROR_INVALID_INTERFACE;
513 hw->caps &= ~(VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
514 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM);
518 hw->caps |= (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
519 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM);
525 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
527 af_packet_main_t *apm = &af_packet_main;
528 af_packet_if_t *apif;
529 af_packet_if_detail_t *r_af_packet_ifs = NULL;
530 af_packet_if_detail_t *af_packet_if = NULL;
533 pool_foreach (apif, apm->interfaces)
535 vec_add2 (r_af_packet_ifs, af_packet_if, 1);
536 af_packet_if->sw_if_index = apif->sw_if_index;
537 if (apif->host_if_name)
539 clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
540 MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
541 strlen ((const char *) apif->host_if_name)));
546 *out_af_packet_ifs = r_af_packet_ifs;
551 static clib_error_t *
552 af_packet_init (vlib_main_t * vm)
554 af_packet_main_t *apm = &af_packet_main;
555 vlib_thread_main_t *tm = vlib_get_thread_main ();
557 clib_memset (apm, 0, sizeof (af_packet_main_t));
559 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
561 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
562 CLIB_CACHE_LINE_BYTES);
564 apm->log_class = vlib_log_register_class ("af_packet", 0);
565 vlib_log_debug (apm->log_class, "initialized");
570 VLIB_INIT_FUNCTION (af_packet_init);
573 * fd.io coding-style-patch-verification: ON
576 * eval: (c-set-style "gnu")