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/ethernet/ethernet.h>
34 #include <vnet/interface/rx_queue_funcs.h>
36 #include <vnet/devices/af_packet/af_packet.h>
38 af_packet_main_t af_packet_main;
40 #define AF_PACKET_TX_FRAMES_PER_BLOCK 1024
41 #define AF_PACKET_TX_FRAME_SIZE (2048 * 5)
42 #define AF_PACKET_TX_BLOCK_NR 1
43 #define AF_PACKET_TX_FRAME_NR (AF_PACKET_TX_BLOCK_NR * \
44 AF_PACKET_TX_FRAMES_PER_BLOCK)
45 #define AF_PACKET_TX_BLOCK_SIZE (AF_PACKET_TX_FRAME_SIZE * \
46 AF_PACKET_TX_FRAMES_PER_BLOCK)
48 #define AF_PACKET_RX_FRAMES_PER_BLOCK 1024
49 #define AF_PACKET_RX_FRAME_SIZE (2048 * 5)
50 #define AF_PACKET_RX_BLOCK_NR 1
51 #define AF_PACKET_RX_FRAME_NR (AF_PACKET_RX_BLOCK_NR * \
52 AF_PACKET_RX_FRAMES_PER_BLOCK)
53 #define AF_PACKET_RX_BLOCK_SIZE (AF_PACKET_RX_FRAME_SIZE * \
54 AF_PACKET_RX_FRAMES_PER_BLOCK)
56 /*defined in net/if.h but clashes with dpdk headers */
57 unsigned int if_nametoindex (const char *ifname);
59 typedef struct tpacket_req tpacket_req_t;
62 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)
73 s = format (0, "/sys/class/net/%s/mtu%c", apif->host_if_name, 0);
75 error = clib_sysfs_write ((char *) s, "%d", hi->max_packet_bytes);
80 vlib_log_err (apm->log_class,
81 "sysfs write failed to change MTU: %U",
82 format_clib_error, error);
83 clib_error_free (error);
84 return VNET_API_ERROR_SYSCALL_ERROR_1;
87 apif->host_mtu = hi->max_packet_bytes;
94 af_packet_read_mtu (af_packet_if_t *apif)
96 af_packet_main_t *apm = &af_packet_main;
99 s = format (0, "/sys/class/net/%s/mtu%c", apif->host_if_name, 0);
100 error = clib_sysfs_read ((char *) s, "%d", &apif->host_mtu);
104 vlib_log_err (apm->log_class, "sysfs read failed to get MTU: %U",
105 format_clib_error, error);
106 clib_error_free (error);
107 return VNET_API_ERROR_SYSCALL_ERROR_1;
112 static clib_error_t *
113 af_packet_fd_read_ready (clib_file_t * uf)
115 af_packet_main_t *apm = &af_packet_main;
116 vnet_main_t *vnm = vnet_get_main ();
117 u32 idx = uf->private_data;
118 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
120 apm->pending_input_bitmap =
121 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
123 /* Schedule the rx node */
124 vnet_hw_if_rx_queue_set_int_pending (vnm, apif->queue_index);
129 is_bridge (const u8 * host_if_name)
134 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
135 dir = opendir ((char *) s);
148 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
149 tpacket_req_t * tx_req, int *fd, u8 ** ring)
151 af_packet_main_t *apm = &af_packet_main;
153 struct sockaddr_ll sll;
154 int ver = TPACKET_V2;
155 socklen_t req_sz = sizeof (struct tpacket_req);
156 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
157 tx_req->tp_block_size * tx_req->tp_block_nr;
159 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
161 vlib_log_debug (apm->log_class,
162 "Failed to create AF_PACKET socket: %s (errno %d)",
163 strerror (errno), errno);
164 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
168 /* bind before rx ring is cfged so we don't receive packets from other interfaces */
169 clib_memset (&sll, 0, sizeof (sll));
170 sll.sll_family = PF_PACKET;
171 sll.sll_protocol = htons (ETH_P_ALL);
172 sll.sll_ifindex = host_if_index;
173 if (bind (*fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
175 vlib_log_debug (apm->log_class,
176 "Failed to bind rx packet socket: %s (errno %d)",
177 strerror (errno), errno);
178 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
182 if (setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver)) < 0)
184 vlib_log_debug (apm->log_class,
185 "Failed to set rx packet interface version: %s (errno %d)",
186 strerror (errno), errno);
187 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
192 if (setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt)) < 0)
194 vlib_log_debug (apm->log_class,
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;
201 if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
203 vlib_log_debug (apm->log_class,
204 "Failed to set packet rx ring options: %s (errno %d)",
205 strerror (errno), errno);
206 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
210 if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
212 vlib_log_debug (apm->log_class,
213 "Failed to set packet tx ring options: %s (errno %d)",
214 strerror (errno), errno);
215 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
220 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
222 if (*ring == MAP_FAILED)
224 vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
225 strerror (errno), errno);
226 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
241 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
244 af_packet_main_t *apm = &af_packet_main;
245 int ret, fd = -1, fd2 = -1;
246 struct tpacket_req *rx_req = 0;
247 struct tpacket_req *tx_req = 0;
250 af_packet_if_t *apif = 0;
253 vnet_sw_interface_t *sw;
254 vnet_hw_interface_t *hw;
255 vlib_thread_main_t *tm = vlib_get_thread_main ();
256 vnet_main_t *vnm = vnet_get_main ();
259 u8 *host_if_name_dup = 0;
260 int host_if_index = -1;
262 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
265 apif = vec_elt_at_index (apm->interfaces, p[0]);
266 *sw_if_index = apif->sw_if_index;
267 return VNET_API_ERROR_IF_ALREADY_EXISTS;
270 host_if_name_dup = vec_dup (host_if_name);
272 vec_validate (rx_req, 0);
273 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
274 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
275 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
276 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
278 vec_validate (tx_req, 0);
279 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
280 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
281 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
282 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
285 * make sure host side of interface is 'UP' before binding AF_PACKET
288 if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
290 vlib_log_debug (apm->log_class,
291 "Failed to create AF_UNIX socket: %s (errno %d)",
292 strerror (errno), errno);
293 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
297 clib_memcpy (ifr.ifr_name, (const char *) host_if_name,
298 vec_len (host_if_name));
299 if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
301 vlib_log_debug (apm->log_class,
302 "Failed to retrieve the interface (%s) index: %s (errno %d)",
303 host_if_name, strerror (errno), errno);
304 ret = VNET_API_ERROR_INVALID_INTERFACE;
308 host_if_index = ifr.ifr_ifindex;
309 if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
311 vlib_log_debug (apm->log_class,
312 "Failed to get the active flag: %s (errno %d)",
313 strerror (errno), errno);
314 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
318 if (!(ifr.ifr_flags & IFF_UP))
320 ifr.ifr_flags |= IFF_UP;
321 if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
323 vlib_log_debug (apm->log_class,
324 "Failed to set the active flag: %s (errno %d)",
325 strerror (errno), errno);
326 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
337 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
342 ret = is_bridge (host_if_name);
344 if (ret == 0) /* is a bridge, ignore state */
347 /* So far everything looks good, let's create interface */
348 pool_get (apm->interfaces, apif);
349 if_index = apif - apm->interfaces;
351 apif->host_if_index = host_if_index;
353 apif->rx_ring = ring;
354 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
355 apif->rx_req = rx_req;
356 apif->tx_req = tx_req;
357 apif->host_if_name = host_if_name_dup;
358 apif->per_interface_next_index = ~0;
359 apif->next_tx_frame = 0;
360 apif->next_rx_frame = 0;
362 ret = af_packet_read_mtu (apif);
366 if (tm->n_vlib_mains > 1)
367 clib_spinlock_init (&apif->lockp);
369 /*use configured or generate random MAC address */
371 clib_memcpy (hw_addr, hw_addr_set, 6);
374 f64 now = vlib_time_now (vm);
376 rnd = (u32) (now * 1e6);
377 rnd = random_u32 (&rnd);
379 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
384 error = ethernet_register_interface (vnm, af_packet_device_class.index,
385 if_index, hw_addr, &apif->hw_if_index,
386 af_packet_eth_flag_change);
390 clib_memset (apif, 0, sizeof (*apif));
391 pool_put (apm->interfaces, apif);
392 vlib_log_err (apm->log_class, "Unable to register interface: %U",
393 format_clib_error, error);
394 clib_error_free (error);
395 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
399 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
400 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
401 apif->sw_if_index = sw->sw_if_index;
402 vnet_hw_if_set_input_node (vnm, apif->hw_if_index,
403 af_packet_input_node.index);
404 apif->queue_index = vnet_hw_if_register_rx_queue (vnm, apif->hw_if_index, 0,
405 VNET_HW_IF_RXQ_THREAD_ANY);
407 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
408 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
409 VNET_HW_INTERFACE_FLAG_LINK_UP);
411 vnet_hw_if_set_rx_queue_mode (vnm, apif->queue_index,
412 VNET_HW_IF_RX_MODE_INTERRUPT);
413 vnet_hw_if_update_runtime_data (vnm, apif->hw_if_index);
415 clib_file_t template = { 0 };
416 template.read_function = af_packet_fd_read_ready;
417 template.file_descriptor = fd;
418 template.private_data = if_index;
419 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
420 template.description =
421 format (0, "%U", format_af_packet_device_name, if_index);
422 apif->clib_file_index = clib_file_add (&file_main, &template);
424 vnet_hw_if_set_rx_queue_file_index (vnm, apif->queue_index,
425 apif->clib_file_index);
427 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
430 *sw_if_index = apif->sw_if_index;
440 vec_free (host_if_name_dup);
447 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
449 vnet_main_t *vnm = vnet_get_main ();
450 af_packet_main_t *apm = &af_packet_main;
451 af_packet_if_t *apif;
456 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
459 vlib_log_warn (apm->log_class, "Host interface %s does not exist",
461 return VNET_API_ERROR_SYSCALL_ERROR_1;
463 apif = pool_elt_at_index (apm->interfaces, p[0]);
464 if_index = apif - apm->interfaces;
466 /* bring down the interface */
467 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
470 if (apif->clib_file_index != ~0)
472 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
473 apif->clib_file_index = ~0;
478 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
479 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
480 if (munmap (apif->rx_ring, ring_sz))
481 vlib_log_warn (apm->log_class,
482 "Host interface %s could not free rx/tx ring",
484 apif->rx_ring = NULL;
485 apif->tx_ring = NULL;
488 vec_free (apif->rx_req);
490 vec_free (apif->tx_req);
493 vec_free (apif->host_if_name);
494 apif->host_if_name = NULL;
495 apif->host_if_index = -1;
497 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
499 ethernet_delete_interface (vnm, apif->hw_if_index);
501 pool_put (apm->interfaces, apif);
507 af_packet_set_l4_cksum_offload (vlib_main_t * vm, u32 sw_if_index, u8 set)
509 vnet_main_t *vnm = vnet_get_main ();
510 vnet_hw_interface_t *hw;
512 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
514 if (hw->dev_class_index != af_packet_device_class.index)
515 return VNET_API_ERROR_INVALID_INTERFACE;
518 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
520 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
526 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
528 af_packet_main_t *apm = &af_packet_main;
529 af_packet_if_t *apif;
530 af_packet_if_detail_t *r_af_packet_ifs = NULL;
531 af_packet_if_detail_t *af_packet_if = NULL;
534 pool_foreach (apif, apm->interfaces)
536 vec_add2 (r_af_packet_ifs, af_packet_if, 1);
537 af_packet_if->sw_if_index = apif->sw_if_index;
538 if (apif->host_if_name)
540 clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
541 MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
542 strlen ((const char *) apif->host_if_name)));
547 *out_af_packet_ifs = r_af_packet_ifs;
552 static clib_error_t *
553 af_packet_init (vlib_main_t * vm)
555 af_packet_main_t *apm = &af_packet_main;
556 vlib_thread_main_t *tm = vlib_get_thread_main ();
558 clib_memset (apm, 0, sizeof (af_packet_main_t));
560 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
562 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
563 CLIB_CACHE_LINE_BYTES);
565 apm->log_class = vlib_log_register_class ("af_packet", 0);
566 vlib_log_debug (apm->log_class, "initialized");
571 VLIB_INIT_FUNCTION (af_packet_init);
574 * fd.io coding-style-patch-verification: ON
577 * eval: (c-set-style "gnu")