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, "Failed to create socket");
141 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
145 /* bind before rx ring is cfged so we don't receive packets from other interfaces */
146 clib_memset (&sll, 0, sizeof (sll));
147 sll.sll_family = PF_PACKET;
148 sll.sll_protocol = htons (ETH_P_ALL);
149 sll.sll_ifindex = host_if_index;
150 if ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
152 vlib_log_debug (apm->log_class,
153 "Failed to bind rx packet socket (error %d)", err);
154 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
159 setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
161 vlib_log_debug (apm->log_class,
162 "Failed to set rx packet interface version");
163 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
169 setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt))) < 0)
171 vlib_log_debug (apm->log_class,
172 "Failed to set packet tx ring error handling option");
173 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
178 setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
180 vlib_log_debug (apm->log_class, "Failed to set packet rx ring options");
181 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
186 setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
188 vlib_log_debug (apm->log_class, "Failed to set packet tx ring options");
189 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
194 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
196 if (*ring == MAP_FAILED)
198 vlib_log_debug (apm->log_class, "mmap failure");
199 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
212 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
215 af_packet_main_t *apm = &af_packet_main;
216 int ret, fd = -1, fd2 = -1;
217 struct tpacket_req *rx_req = 0;
218 struct tpacket_req *tx_req = 0;
221 af_packet_if_t *apif = 0;
224 vnet_sw_interface_t *sw;
225 vnet_hw_interface_t *hw;
226 vlib_thread_main_t *tm = vlib_get_thread_main ();
227 vnet_main_t *vnm = vnet_get_main ();
230 u8 *host_if_name_dup = vec_dup (host_if_name);
231 int host_if_index = -1;
233 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
236 apif = vec_elt_at_index (apm->interfaces, p[0]);
237 *sw_if_index = apif->sw_if_index;
238 return VNET_API_ERROR_IF_ALREADY_EXISTS;
241 vec_validate (rx_req, 0);
242 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
243 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
244 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
245 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
247 vec_validate (tx_req, 0);
248 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
249 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
250 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
251 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
254 * make sure host side of interface is 'UP' before binding AF_PACKET
257 if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
259 vlib_log_debug (apm->log_class, "Failed to create socket");
260 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
264 clib_memcpy (ifr.ifr_name, (const char *) host_if_name,
265 vec_len (host_if_name));
266 if ((ret = ioctl (fd2, SIOCGIFINDEX, &ifr)) < 0)
268 vlib_log_debug (apm->log_class, "af_packet_create error: %d", ret);
270 return VNET_API_ERROR_INVALID_INTERFACE;
273 host_if_index = ifr.ifr_ifindex;
274 if ((ret = ioctl (fd2, SIOCGIFFLAGS, &ifr)) < 0)
276 vlib_log_warn (apm->log_class, "af_packet_create error: %d", ret);
280 if (!(ifr.ifr_flags & IFF_UP))
282 ifr.ifr_flags |= IFF_UP;
283 if ((ret = ioctl (fd2, SIOCSIFFLAGS, &ifr)) < 0)
285 vlib_log_warn (apm->log_class, "af_packet_create error: %d", ret);
293 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
298 ret = is_bridge (host_if_name);
300 if (ret == 0) /* is a bridge, ignore state */
303 /* So far everything looks good, let's create interface */
304 pool_get (apm->interfaces, apif);
305 if_index = apif - apm->interfaces;
307 apif->host_if_index = host_if_index;
309 apif->rx_ring = ring;
310 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
311 apif->rx_req = rx_req;
312 apif->tx_req = tx_req;
313 apif->host_if_name = host_if_name_dup;
314 apif->per_interface_next_index = ~0;
315 apif->next_tx_frame = 0;
316 apif->next_rx_frame = 0;
318 if (tm->n_vlib_mains > 1)
319 clib_spinlock_init (&apif->lockp);
322 clib_file_t template = { 0 };
323 template.read_function = af_packet_fd_read_ready;
324 template.file_descriptor = fd;
325 template.private_data = if_index;
326 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
327 template.description = format (0, "%U", format_af_packet_device_name,
329 apif->clib_file_index = clib_file_add (&file_main, &template);
332 /*use configured or generate random MAC address */
334 clib_memcpy (hw_addr, hw_addr_set, 6);
337 f64 now = vlib_time_now (vm);
339 rnd = (u32) (now * 1e6);
340 rnd = random_u32 (&rnd);
342 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
347 error = ethernet_register_interface (vnm, af_packet_device_class.index,
348 if_index, hw_addr, &apif->hw_if_index,
349 af_packet_eth_flag_change);
353 clib_memset (apif, 0, sizeof (*apif));
354 pool_put (apm->interfaces, apif);
355 vlib_log_err (apm->log_class, "Unable to register interface: %U",
356 format_clib_error, error);
357 clib_error_free (error);
358 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
362 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
363 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
364 apif->sw_if_index = sw->sw_if_index;
365 vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
366 af_packet_input_node.index);
368 vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0, /* queue */
371 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
372 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
373 VNET_HW_INTERFACE_FLAG_LINK_UP);
375 vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
376 VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
378 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
381 *sw_if_index = apif->sw_if_index;
388 vec_free (host_if_name_dup);
395 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
397 vnet_main_t *vnm = vnet_get_main ();
398 af_packet_main_t *apm = &af_packet_main;
399 af_packet_if_t *apif;
404 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
407 vlib_log_warn (apm->log_class, "Host interface %s does not exist",
409 return VNET_API_ERROR_SYSCALL_ERROR_1;
411 apif = pool_elt_at_index (apm->interfaces, p[0]);
412 if_index = apif - apm->interfaces;
414 /* bring down the interface */
415 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
416 vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
419 if (apif->clib_file_index != ~0)
421 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
422 apif->clib_file_index = ~0;
427 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
428 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
429 if (munmap (apif->rx_ring, ring_sz))
430 vlib_log_warn (apm->log_class,
431 "Host interface %s could not free rx/tx ring",
433 apif->rx_ring = NULL;
434 apif->tx_ring = NULL;
437 vec_free (apif->rx_req);
439 vec_free (apif->tx_req);
442 vec_free (apif->host_if_name);
443 apif->host_if_name = NULL;
444 apif->host_if_index = -1;
446 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
448 ethernet_delete_interface (vnm, apif->hw_if_index);
450 pool_put (apm->interfaces, apif);
456 af_packet_set_l4_cksum_offload (vlib_main_t * vm, u32 sw_if_index, u8 set)
458 vnet_main_t *vnm = vnet_get_main ();
459 vnet_hw_interface_t *hw;
461 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
463 if (hw->dev_class_index != af_packet_device_class.index)
464 return VNET_API_ERROR_INVALID_INTERFACE;
467 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
469 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
475 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
477 af_packet_main_t *apm = &af_packet_main;
478 af_packet_if_t *apif;
479 af_packet_if_detail_t *r_af_packet_ifs = NULL;
480 af_packet_if_detail_t *af_packet_if = NULL;
482 vec_foreach (apif, apm->interfaces)
484 vec_add2 (r_af_packet_ifs, af_packet_if, 1);
485 af_packet_if->sw_if_index = apif->sw_if_index;
486 if (apif->host_if_name)
488 clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
489 MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
490 strlen ((const char *) apif->host_if_name)));
494 *out_af_packet_ifs = r_af_packet_ifs;
499 static clib_error_t *
500 af_packet_init (vlib_main_t * vm)
502 af_packet_main_t *apm = &af_packet_main;
503 vlib_thread_main_t *tm = vlib_get_thread_main ();
505 clib_memset (apm, 0, sizeof (af_packet_main_t));
507 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
509 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
510 CLIB_CACHE_LINE_BYTES);
512 apm->log_class = vlib_log_register_class ("af_packet", 0);
513 vlib_log_debug (apm->log_class, "initialized");
518 VLIB_INIT_FUNCTION (af_packet_init);
521 * fd.io coding-style-patch-verification: ON
524 * eval: (c-set-style "gnu")