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>
24 #include <sys/types.h>
27 #include <vppinfra/linux/sysfs.h>
28 #include <vlib/vlib.h>
29 #include <vlib/unix/unix.h>
30 #include <vnet/ip/ip.h>
31 #include <vnet/ethernet/ethernet.h>
33 #include <vnet/devices/af_packet/af_packet.h>
35 af_packet_main_t af_packet_main;
37 #define AF_PACKET_DEBUG_SOCKET 0
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 #if AF_PACKET_DEBUG_SOCKET == 1
56 #define DBG_SOCK(args...) clib_warning(args);
58 #define DBG_SOCK(args...)
61 /*defined in net/if.h but clashes with dpdk headers */
62 unsigned int if_nametoindex (const char *ifname);
64 typedef struct tpacket_req tpacket_req_t;
67 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
72 af_packet_main_t *apm = &af_packet_main;
73 af_packet_if_t *apif =
74 pool_elt_at_index (apm->interfaces, hi->dev_instance);
76 if (ETHERNET_INTERFACE_FLAG_MTU == (flags & ETHERNET_INTERFACE_FLAG_MTU))
78 s = format (0, "/sys/class/net/%s/mtu%c", apif->host_if_name, 0);
80 error = clib_sysfs_write ((char *) s, "%d", hi->max_packet_bytes);
85 clib_error_report (error);
86 return VNET_API_ERROR_SYSCALL_ERROR_1;
94 af_packet_fd_read_ready (clib_file_t * uf)
96 af_packet_main_t *apm = &af_packet_main;
97 vnet_main_t *vnm = vnet_get_main ();
98 u32 idx = uf->private_data;
99 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
101 apm->pending_input_bitmap =
102 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
104 /* Schedule the rx node */
105 vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
111 is_bridge (const u8 * host_if_name)
116 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
117 dir = opendir ((char *) s);
130 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
131 tpacket_req_t * tx_req, int *fd, u8 ** ring)
134 struct sockaddr_ll sll;
135 int ver = TPACKET_V2;
136 socklen_t req_sz = sizeof (struct tpacket_req);
137 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
138 tx_req->tp_block_size * tx_req->tp_block_nr;
140 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
142 DBG_SOCK ("Failed to create socket");
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 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 ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
154 DBG_SOCK ("Failed to bind rx packet socket (error %d)", err);
155 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
160 setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
162 DBG_SOCK ("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 DBG_SOCK ("Failed to set packet tx ring error handling option");
172 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
177 setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
179 DBG_SOCK ("Failed to set packet rx ring options");
180 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
185 setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
187 DBG_SOCK ("Failed to set packet tx ring options");
188 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
193 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
195 if (*ring == MAP_FAILED)
197 DBG_SOCK ("mmap failure");
198 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
211 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
214 af_packet_main_t *apm = &af_packet_main;
216 struct tpacket_req *rx_req = 0;
217 struct tpacket_req *tx_req = 0;
219 af_packet_if_t *apif = 0;
222 vnet_sw_interface_t *sw;
223 vnet_hw_interface_t *hw;
224 vlib_thread_main_t *tm = vlib_get_thread_main ();
225 vnet_main_t *vnm = vnet_get_main ();
228 u8 *host_if_name_dup = vec_dup (host_if_name);
229 int host_if_index = -1;
231 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
234 return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
237 vec_validate (rx_req, 0);
238 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
239 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
240 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
241 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
243 vec_validate (tx_req, 0);
244 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
245 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
246 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
247 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
249 host_if_index = if_nametoindex ((const char *) host_if_name);
253 DBG_SOCK ("Wrong host interface name");
254 return VNET_API_ERROR_INVALID_INTERFACE;
257 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
262 ret = is_bridge (host_if_name);
264 if (ret == 0) /* is a bridge, ignore state */
267 /* So far everything looks good, let's create interface */
268 pool_get (apm->interfaces, apif);
269 if_index = apif - apm->interfaces;
271 apif->host_if_index = host_if_index;
273 apif->rx_ring = ring;
274 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
275 apif->rx_req = rx_req;
276 apif->tx_req = tx_req;
277 apif->host_if_name = host_if_name_dup;
278 apif->per_interface_next_index = ~0;
279 apif->next_tx_frame = 0;
280 apif->next_rx_frame = 0;
282 if (tm->n_vlib_mains > 1)
283 clib_spinlock_init (&apif->lockp);
286 clib_file_t template = { 0 };
287 template.read_function = af_packet_fd_read_ready;
288 template.file_descriptor = fd;
289 template.private_data = if_index;
290 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
291 template.description = format (0, "%U", format_af_packet_device_name,
293 apif->clib_file_index = clib_file_add (&file_main, &template);
296 /*use configured or generate random MAC address */
298 clib_memcpy (hw_addr, hw_addr_set, 6);
301 f64 now = vlib_time_now (vm);
303 rnd = (u32) (now * 1e6);
304 rnd = random_u32 (&rnd);
306 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
311 error = ethernet_register_interface (vnm, af_packet_device_class.index,
312 if_index, hw_addr, &apif->hw_if_index,
313 af_packet_eth_flag_change);
317 memset (apif, 0, sizeof (*apif));
318 pool_put (apm->interfaces, apif);
319 clib_error_report (error);
320 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
324 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
325 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
326 apif->sw_if_index = sw->sw_if_index;
327 vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
328 af_packet_input_node.index);
330 vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0, /* queue */
333 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
334 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
335 VNET_HW_INTERFACE_FLAG_LINK_UP);
337 vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
338 VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
340 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
343 *sw_if_index = apif->sw_if_index;
348 vec_free (host_if_name_dup);
355 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
357 vnet_main_t *vnm = vnet_get_main ();
358 af_packet_main_t *apm = &af_packet_main;
359 af_packet_if_t *apif;
364 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
367 clib_warning ("Host interface %s does not exist", host_if_name);
368 return VNET_API_ERROR_SYSCALL_ERROR_1;
370 apif = pool_elt_at_index (apm->interfaces, p[0]);
371 if_index = apif - apm->interfaces;
373 /* bring down the interface */
374 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
375 vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
378 if (apif->clib_file_index != ~0)
380 clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
381 apif->clib_file_index = ~0;
386 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
387 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
388 if (munmap (apif->rx_ring, ring_sz))
389 clib_warning ("Host interface %s could not free rx/tx ring",
391 apif->rx_ring = NULL;
392 apif->tx_ring = NULL;
395 vec_free (apif->rx_req);
397 vec_free (apif->tx_req);
400 vec_free (apif->host_if_name);
401 apif->host_if_name = NULL;
402 apif->host_if_index = -1;
404 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
406 ethernet_delete_interface (vnm, apif->hw_if_index);
408 pool_put (apm->interfaces, apif);
414 af_packet_set_l4_cksum_offload (vlib_main_t * vm, u32 sw_if_index, u8 set)
416 vnet_main_t *vnm = vnet_get_main ();
417 vnet_hw_interface_t *hw;
419 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
421 if (hw->dev_class_index != af_packet_device_class.index)
422 return VNET_API_ERROR_INVALID_INTERFACE;
425 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
427 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
432 static clib_error_t *
433 af_packet_init (vlib_main_t * vm)
435 af_packet_main_t *apm = &af_packet_main;
436 vlib_thread_main_t *tm = vlib_get_thread_main ();
438 memset (apm, 0, sizeof (af_packet_main_t));
440 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
442 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
443 CLIB_CACHE_LINE_BYTES);
448 VLIB_INIT_FUNCTION (af_packet_init);
451 * fd.io coding-style-patch-verification: ON
454 * eval: (c-set-style "gnu")