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 <vlib/vlib.h>
25 #include <vlib/unix/unix.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/devices/af_packet/af_packet.h>
31 #define AF_PACKET_DEBUG_SOCKET 0
33 #define AF_PACKET_TX_FRAMES_PER_BLOCK 1024
34 #define AF_PACKET_TX_FRAME_SIZE (2048 * 5)
35 #define AF_PACKET_TX_BLOCK_NR 1
36 #define AF_PACKET_TX_FRAME_NR (AF_PACKET_TX_BLOCK_NR * \
37 AF_PACKET_TX_FRAMES_PER_BLOCK)
38 #define AF_PACKET_TX_BLOCK_SIZE (AF_PACKET_TX_FRAME_SIZE * \
39 AF_PACKET_TX_FRAMES_PER_BLOCK)
41 #define AF_PACKET_RX_FRAMES_PER_BLOCK 1024
42 #define AF_PACKET_RX_FRAME_SIZE (2048 * 5)
43 #define AF_PACKET_RX_BLOCK_NR 1
44 #define AF_PACKET_RX_FRAME_NR (AF_PACKET_RX_BLOCK_NR * \
45 AF_PACKET_RX_FRAMES_PER_BLOCK)
46 #define AF_PACKET_RX_BLOCK_SIZE (AF_PACKET_RX_FRAME_SIZE * \
47 AF_PACKET_RX_FRAMES_PER_BLOCK)
49 #if AF_PACKET_DEBUG_SOCKET == 1
50 #define DBG_SOCK(args...) clib_warning(args);
52 #define DBG_SOCK(args...)
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,
69 af_packet_fd_read_ready (unix_file_t * uf)
71 af_packet_main_t *apm = &af_packet_main;
72 vnet_main_t *vnm = vnet_get_main ();
73 u32 idx = uf->private_data;
74 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
76 apm->pending_input_bitmap =
77 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
79 /* Schedule the rx node */
80 vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
86 is_bridge (const u8 * host_if_name)
91 s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
92 dir = opendir ((char *) s);
105 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
106 tpacket_req_t * tx_req, int *fd, u8 ** ring)
109 struct sockaddr_ll sll;
110 int ver = TPACKET_V2;
111 socklen_t req_sz = sizeof (struct tpacket_req);
112 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
113 tx_req->tp_block_size * tx_req->tp_block_nr;
115 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
117 DBG_SOCK ("Failed to create socket");
118 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
123 setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
125 DBG_SOCK ("Failed to set rx packet interface version");
126 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
132 setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt))) < 0)
134 DBG_SOCK ("Failed to set packet tx ring error handling option");
135 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
140 setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
142 DBG_SOCK ("Failed to set packet rx ring options");
143 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
148 setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
150 DBG_SOCK ("Failed to set packet rx ring options");
151 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
156 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
158 if (*ring == MAP_FAILED)
160 DBG_SOCK ("mmap failure");
161 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
165 memset (&sll, 0, sizeof (sll));
166 sll.sll_family = PF_PACKET;
167 sll.sll_protocol = htons (ETH_P_ALL);
168 sll.sll_ifindex = host_if_index;
170 if ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
172 DBG_SOCK ("Failed to bind rx packet socket (error %d)", err);
173 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
186 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
189 af_packet_main_t *apm = &af_packet_main;
191 struct tpacket_req *rx_req = 0;
192 struct tpacket_req *tx_req = 0;
194 af_packet_if_t *apif = 0;
197 vnet_sw_interface_t *sw;
198 vnet_hw_interface_t *hw;
199 vlib_thread_main_t *tm = vlib_get_thread_main ();
200 vnet_main_t *vnm = vnet_get_main ();
203 u8 *host_if_name_dup = vec_dup (host_if_name);
204 int host_if_index = -1;
206 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
209 return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
212 vec_validate (rx_req, 0);
213 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
214 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
215 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
216 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
218 vec_validate (tx_req, 0);
219 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
220 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
221 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
222 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
224 host_if_index = if_nametoindex ((const char *) host_if_name);
228 DBG_SOCK ("Wrong host interface name");
229 return VNET_API_ERROR_INVALID_INTERFACE;
232 ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
237 ret = is_bridge (host_if_name);
239 if (ret == 0) /* is a bridge, ignore state */
242 /* So far everything looks good, let's create interface */
243 pool_get (apm->interfaces, apif);
244 if_index = apif - apm->interfaces;
246 apif->host_if_index = host_if_index;
248 apif->rx_ring = ring;
249 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
250 apif->rx_req = rx_req;
251 apif->tx_req = tx_req;
252 apif->host_if_name = host_if_name_dup;
253 apif->per_interface_next_index = ~0;
254 apif->next_tx_frame = 0;
255 apif->next_rx_frame = 0;
257 if (tm->n_vlib_mains > 1)
258 clib_spinlock_init (&apif->lockp);
261 unix_file_t template = { 0 };
262 template.read_function = af_packet_fd_read_ready;
263 template.file_descriptor = fd;
264 template.private_data = if_index;
265 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
266 apif->unix_file_index = unix_file_add (&unix_main, &template);
269 /*use configured or generate random MAC address */
271 clib_memcpy (hw_addr, hw_addr_set, 6);
274 f64 now = vlib_time_now (vm);
276 rnd = (u32) (now * 1e6);
277 rnd = random_u32 (&rnd);
279 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
284 error = ethernet_register_interface (vnm, af_packet_device_class.index,
285 if_index, hw_addr, &apif->hw_if_index,
286 af_packet_eth_flag_change);
290 memset (apif, 0, sizeof (*apif));
291 pool_put (apm->interfaces, apif);
292 clib_error_report (error);
293 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
297 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
298 hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
299 apif->sw_if_index = sw->sw_if_index;
300 vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
301 af_packet_input_node.index);
303 vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0, /* queue */
306 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
307 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
308 VNET_HW_INTERFACE_FLAG_LINK_UP);
310 vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
311 VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
313 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
316 *sw_if_index = apif->sw_if_index;
321 vec_free (host_if_name_dup);
328 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
330 vnet_main_t *vnm = vnet_get_main ();
331 af_packet_main_t *apm = &af_packet_main;
332 af_packet_if_t *apif;
337 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
340 clib_warning ("Host interface %s does not exist", host_if_name);
341 return VNET_API_ERROR_SYSCALL_ERROR_1;
343 apif = pool_elt_at_index (apm->interfaces, p[0]);
344 if_index = apif - apm->interfaces;
346 /* bring down the interface */
347 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
348 vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
351 if (apif->unix_file_index != ~0)
353 unix_file_del (&unix_main, unix_main.file_pool + apif->unix_file_index);
354 apif->unix_file_index = ~0;
359 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
360 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
361 if (munmap (apif->rx_ring, ring_sz))
362 clib_warning ("Host interface %s could not free rx/tx ring",
364 apif->rx_ring = NULL;
365 apif->tx_ring = NULL;
368 vec_free (apif->rx_req);
370 vec_free (apif->tx_req);
373 vec_free (apif->host_if_name);
374 apif->host_if_name = NULL;
375 apif->host_if_index = -1;
377 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
379 ethernet_delete_interface (vnm, apif->hw_if_index);
381 pool_put (apm->interfaces, apif);
386 static clib_error_t *
387 af_packet_init (vlib_main_t * vm)
389 af_packet_main_t *apm = &af_packet_main;
390 vlib_thread_main_t *tm = vlib_get_thread_main ();
392 memset (apm, 0, sizeof (af_packet_main_t));
394 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
396 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
397 CLIB_CACHE_LINE_BYTES);
402 VLIB_INIT_FUNCTION (af_packet_init);
405 * fd.io coding-style-patch-verification: ON
408 * eval: (c-set-style "gnu")