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>
35 #include <vnet/devices/af_packet/af_packet.h>
37 af_packet_main_t af_packet_main;
39 #define AF_PACKET_TX_FRAMES_PER_BLOCK 1024
40 #define AF_PACKET_TX_FRAME_SIZE (2048 * 5)
41 #define AF_PACKET_TX_BLOCK_NR 1
42 #define AF_PACKET_TX_FRAME_NR (AF_PACKET_TX_BLOCK_NR * \
43 AF_PACKET_TX_FRAMES_PER_BLOCK)
44 #define AF_PACKET_TX_BLOCK_SIZE (AF_PACKET_TX_FRAME_SIZE * \
45 AF_PACKET_TX_FRAMES_PER_BLOCK)
47 #define AF_PACKET_RX_FRAMES_PER_BLOCK 1024
48 #define AF_PACKET_RX_FRAME_SIZE (2048 * 5)
49 #define AF_PACKET_RX_BLOCK_NR 1
50 #define AF_PACKET_RX_FRAME_NR (AF_PACKET_RX_BLOCK_NR * \
51 AF_PACKET_RX_FRAMES_PER_BLOCK)
52 #define AF_PACKET_RX_BLOCK_SIZE (AF_PACKET_RX_FRAME_SIZE * \
53 AF_PACKET_RX_FRAMES_PER_BLOCK)
55 /*defined in net/if.h but clashes with dpdk headers */
56 unsigned int if_nametoindex (const char *ifname);
58 typedef struct tpacket_req tpacket_req_t;
61 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
66 af_packet_main_t *apm = &af_packet_main;
67 af_packet_if_t *apif =
68 pool_elt_at_index (apm->interfaces, hi->dev_instance);
70 if (ETHERNET_INTERFACE_FLAG_MTU == (flags & ETHERNET_INTERFACE_FLAG_MTU))
72 s = format (0, "/sys/class/net/%s/mtu%c", apif->host_if_name, 0);
74 error = clib_sysfs_write ((char *) s, "%d", hi->max_packet_bytes);
79 vlib_log_err (apm->log_class,
80 "sysfs write failed to change MTU: %U",
81 format_clib_error, error);
82 clib_error_free (error);
83 return VNET_API_ERROR_SYSCALL_ERROR_1;
91 af_packet_fd_read_ready (clib_file_t * uf)
93 af_packet_main_t *apm = &af_packet_main;
94 vnet_main_t *vnm = vnet_get_main ();
95 u32 idx = uf->private_data;
96 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
98 apm->pending_input_bitmap =
99 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
101 /* Schedule the rx node */
102 vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
108 is_bridge (const u8 * host_if_name)
113 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
114 dir = opendir ((char *) s);
127 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
128 tpacket_req_t * tx_req, int *fd, u8 ** ring)
130 af_packet_main_t *apm = &af_packet_main;
132 struct sockaddr_ll sll;
133 int ver = TPACKET_V2;
134 socklen_t req_sz = sizeof (struct tpacket_req);
135 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
136 tx_req->tp_block_size * tx_req->tp_block_nr;
138 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
140 vlib_log_debug (apm->log_class,
141 "Failed to create AF_PACKET socket: %s (errno %d)",
142 strerror (errno), errno);
143 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
147 /* bind before rx ring is cfged so we don't receive packets from other interfaces */
148 clib_memset (&sll, 0, sizeof (sll));
149 sll.sll_family = PF_PACKET;
150 sll.sll_protocol = htons (ETH_P_ALL);
151 sll.sll_ifindex = host_if_index;
152 if (bind (*fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
154 vlib_log_debug (apm->log_class,
155 "Failed to bind rx packet socket: %s (errno %d)",
156 strerror (errno), errno);
157 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
161 if (setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver)) < 0)
163 vlib_log_debug (apm->log_class,
164 "Failed to set rx packet interface version: %s (errno %d)",
165 strerror (errno), errno);
166 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
171 if (setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt)) < 0)
173 vlib_log_debug (apm->log_class,
174 "Failed to set packet tx ring error handling option: %s (errno %d)",
175 strerror (errno), errno);
176 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
180 if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
182 vlib_log_debug (apm->log_class,
183 "Failed to set packet rx ring options: %s (errno %d)",
184 strerror (errno), errno);
185 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
189 if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
191 vlib_log_debug (apm->log_class,
192 "Failed to set packet tx ring options: %s (errno %d)",
193 strerror (errno), errno);
194 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
199 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
201 if (*ring == MAP_FAILED)
203 vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
204 strerror (errno), errno);
205 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
220 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
223 af_packet_main_t *apm = &af_packet_main;
224 int ret, fd = -1, fd2 = -1;
225 struct tpacket_req *rx_req = 0;
226 struct tpacket_req *tx_req = 0;
229 af_packet_if_t *apif = 0;
232 vnet_sw_interface_t *sw;
233 vnet_hw_interface_t *hw;
234 vlib_thread_main_t *tm = vlib_get_thread_main ();
235 vnet_main_t *vnm = vnet_get_main ();
238 u8 *host_if_name_dup = 0;
239 int host_if_index = -1;
241 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
244 apif = vec_elt_at_index (apm->interfaces, p[0]);
245 *sw_if_index = apif->sw_if_index;
246 return VNET_API_ERROR_IF_ALREADY_EXISTS;
249 host_if_name_dup = vec_dup (host_if_name);
251 vec_validate (rx_req, 0);
252 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
253 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
254 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
255 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
257 vec_validate (tx_req, 0);
258 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
259 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
260 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
261 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
264 * make sure host side of interface is 'UP' before binding AF_PACKET
267 if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
269 vlib_log_debug (apm->log_class,
270 "Failed to create AF_UNIX socket: %s (errno %d)",
271 strerror (errno), errno);
272 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
276 clib_memcpy (ifr.ifr_name, (const char *) host_if_name,
277 vec_len (host_if_name));
278 if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
280 vlib_log_debug (apm->log_class,
281 "Failed to retrieve the interface (%s) index: %s (errno %d)",
282 host_if_name, strerror (errno), errno);
283 ret = VNET_API_ERROR_INVALID_INTERFACE;
287 host_if_index = ifr.ifr_ifindex;
288 if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
290 vlib_log_debug (apm->log_class,
291 "Failed to get the active flag: %s (errno %d)",
292 strerror (errno), errno);
293 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
297 if (!(ifr.ifr_flags & IFF_UP))
299 ifr.ifr_flags |= IFF_UP;
300 if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
302 vlib_log_debug (apm->log_class,
303 "Failed to set the active flag: %s (errno %d)",
304 strerror (errno), errno);
305 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
316 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
321 ret = is_bridge (host_if_name);
323 if (ret == 0) /* is a bridge, ignore state */
326 /* So far everything looks good, let's create interface */
327 pool_get (apm->interfaces, apif);
328 if_index = apif - apm->interfaces;
330 apif->host_if_index = host_if_index;
332 apif->rx_ring = ring;
333 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
334 apif->rx_req = rx_req;
335 apif->tx_req = tx_req;
336 apif->host_if_name = host_if_name_dup;
337 apif->per_interface_next_index = ~0;
338 apif->next_tx_frame = 0;
339 apif->next_rx_frame = 0;
341 if (tm->n_vlib_mains > 1)
342 clib_spinlock_init (&apif->lockp);
345 clib_file_t template = { 0 };
346 template.read_function = af_packet_fd_read_ready;
347 template.file_descriptor = fd;
348 template.private_data = if_index;
349 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
350 template.description = format (0, "%U", format_af_packet_device_name,
352 apif->clib_file_index = clib_file_add (&file_main, &template);
355 /*use configured or generate random MAC address */
357 clib_memcpy (hw_addr, hw_addr_set, 6);
360 f64 now = vlib_time_now (vm);
362 rnd = (u32) (now * 1e6);
363 rnd = random_u32 (&rnd);
365 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
370 error = ethernet_register_interface (vnm, af_packet_device_class.index,
371 if_index, hw_addr, &apif->hw_if_index,
372 af_packet_eth_flag_change);
376 clib_memset (apif, 0, sizeof (*apif));
377 pool_put (apm->interfaces, apif);
378 vlib_log_err (apm->log_class, "Unable to register interface: %U",
379 format_clib_error, error);
380 clib_error_free (error);
381 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
385 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
386 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
387 apif->sw_if_index = sw->sw_if_index;
388 vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
389 af_packet_input_node.index);
391 vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0, /* queue */
394 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
395 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
396 VNET_HW_INTERFACE_FLAG_LINK_UP);
398 vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
399 VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
401 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
404 *sw_if_index = apif->sw_if_index;
414 vec_free (host_if_name_dup);
421 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
423 vnet_main_t *vnm = vnet_get_main ();
424 af_packet_main_t *apm = &af_packet_main;
425 af_packet_if_t *apif;
430 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
433 vlib_log_warn (apm->log_class, "Host interface %s does not exist",
435 return VNET_API_ERROR_SYSCALL_ERROR_1;
437 apif = pool_elt_at_index (apm->interfaces, p[0]);
438 if_index = apif - apm->interfaces;
440 /* bring down the interface */
441 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
442 vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
445 if (apif->clib_file_index != ~0)
447 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
448 apif->clib_file_index = ~0;
453 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
454 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
455 if (munmap (apif->rx_ring, ring_sz))
456 vlib_log_warn (apm->log_class,
457 "Host interface %s could not free rx/tx ring",
459 apif->rx_ring = NULL;
460 apif->tx_ring = NULL;
463 vec_free (apif->rx_req);
465 vec_free (apif->tx_req);
468 vec_free (apif->host_if_name);
469 apif->host_if_name = NULL;
470 apif->host_if_index = -1;
472 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
474 ethernet_delete_interface (vnm, apif->hw_if_index);
476 pool_put (apm->interfaces, apif);
482 af_packet_set_l4_cksum_offload (vlib_main_t * vm, u32 sw_if_index, u8 set)
484 vnet_main_t *vnm = vnet_get_main ();
485 vnet_hw_interface_t *hw;
487 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
489 if (hw->dev_class_index != af_packet_device_class.index)
490 return VNET_API_ERROR_INVALID_INTERFACE;
493 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
495 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
501 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
503 af_packet_main_t *apm = &af_packet_main;
504 af_packet_if_t *apif;
505 af_packet_if_detail_t *r_af_packet_ifs = NULL;
506 af_packet_if_detail_t *af_packet_if = NULL;
508 vec_foreach (apif, apm->interfaces)
510 vec_add2 (r_af_packet_ifs, af_packet_if, 1);
511 af_packet_if->sw_if_index = apif->sw_if_index;
512 if (apif->host_if_name)
514 clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
515 MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
516 strlen ((const char *) apif->host_if_name)));
520 *out_af_packet_ifs = r_af_packet_ifs;
525 static clib_error_t *
526 af_packet_init (vlib_main_t * vm)
528 af_packet_main_t *apm = &af_packet_main;
529 vlib_thread_main_t *tm = vlib_get_thread_main ();
531 clib_memset (apm, 0, sizeof (af_packet_main_t));
533 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
535 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
536 CLIB_CACHE_LINE_BYTES);
538 apm->log_class = vlib_log_register_class ("af_packet", 0);
539 vlib_log_debug (apm->log_class, "initialized");
544 VLIB_INIT_FUNCTION (af_packet_init);
547 * fd.io coding-style-patch-verification: ON
550 * eval: (c-set-style "gnu")