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>
23 #include <vlib/vlib.h>
24 #include <vlib/unix/unix.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ethernet/ethernet.h>
28 #include <vnet/devices/af_packet/af_packet.h>
30 #define AF_PACKET_DEBUG_SOCKET 0
32 #define AF_PACKET_TX_FRAMES_PER_BLOCK 1024
33 #define AF_PACKET_TX_FRAME_SIZE (2048 * 5)
34 #define AF_PACKET_TX_BLOCK_NR 1
35 #define AF_PACKET_TX_FRAME_NR (AF_PACKET_TX_BLOCK_NR * \
36 AF_PACKET_TX_FRAMES_PER_BLOCK)
37 #define AF_PACKET_TX_BLOCK_SIZE (AF_PACKET_TX_FRAME_SIZE * \
38 AF_PACKET_TX_FRAMES_PER_BLOCK)
40 #define AF_PACKET_RX_FRAMES_PER_BLOCK 1024
41 #define AF_PACKET_RX_FRAME_SIZE (2048 * 5)
42 #define AF_PACKET_RX_BLOCK_NR 1
43 #define AF_PACKET_RX_FRAME_NR (AF_PACKET_RX_BLOCK_NR * \
44 AF_PACKET_RX_FRAMES_PER_BLOCK)
45 #define AF_PACKET_RX_BLOCK_SIZE (AF_PACKET_RX_FRAME_SIZE * \
46 AF_PACKET_RX_FRAMES_PER_BLOCK)
48 #if AF_PACKET_DEBUG_SOCKET == 1
49 #define DBG_SOCK(args...) clib_warning(args);
51 #define DBG_SOCK(args...)
54 /*defined in net/if.h but clashes with dpdk headers */
55 unsigned int if_nametoindex (const char *ifname);
57 typedef struct tpacket_req tpacket_req_t;
60 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
68 af_packet_fd_read_ready (unix_file_t * uf)
70 af_packet_main_t *apm = &af_packet_main;
71 vnet_main_t *vnm = vnet_get_main ();
72 u32 idx = uf->private_data;
73 af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
75 apm->pending_input_bitmap =
76 clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
78 /* Schedule the rx node */
79 vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
85 create_packet_v2_sock (u8 * name, tpacket_req_t * rx_req,
86 tpacket_req_t * tx_req, int *fd, u8 ** ring)
89 struct sockaddr_ll sll;
92 socklen_t req_sz = sizeof (struct tpacket_req);
93 u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
94 tx_req->tp_block_size * tx_req->tp_block_nr;
96 host_if_index = if_nametoindex ((const char *) name);
100 DBG_SOCK ("Wrong host interface name");
101 ret = VNET_API_ERROR_INVALID_INTERFACE;
105 if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
107 DBG_SOCK ("Failed to create socket");
108 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
113 setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
115 DBG_SOCK ("Failed to set rx packet interface version");
116 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
122 setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt))) < 0)
124 DBG_SOCK ("Failed to set packet tx ring error handling option");
125 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
130 setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
132 DBG_SOCK ("Failed to set packet rx ring options");
133 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
138 setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
140 DBG_SOCK ("Failed to set packet rx ring options");
141 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
146 mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
148 if (*ring == MAP_FAILED)
150 DBG_SOCK ("mmap failure");
151 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
155 memset (&sll, 0, sizeof (sll));
156 sll.sll_family = PF_PACKET;
157 sll.sll_protocol = htons (ETH_P_ALL);
158 sll.sll_ifindex = host_if_index;
160 if ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
162 DBG_SOCK ("Failed to bind rx packet socket (error %d)", err);
163 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
176 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
179 af_packet_main_t *apm = &af_packet_main;
181 struct tpacket_req *rx_req = 0;
182 struct tpacket_req *tx_req = 0;
184 af_packet_if_t *apif = 0;
187 vnet_sw_interface_t *sw;
188 vlib_thread_main_t *tm = vlib_get_thread_main ();
189 vnet_main_t *vnm = vnet_get_main ();
192 u8 *host_if_name_dup = vec_dup (host_if_name);
194 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
197 return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
200 vec_validate (rx_req, 0);
201 rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
202 rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
203 rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
204 rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
206 vec_validate (tx_req, 0);
207 tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
208 tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
209 tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
210 tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
212 ret = create_packet_v2_sock (host_if_name, rx_req, tx_req, &fd, &ring);
217 /* So far everything looks good, let's create interface */
218 pool_get (apm->interfaces, apif);
219 if_index = apif - apm->interfaces;
222 apif->rx_ring = ring;
223 apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
224 apif->rx_req = rx_req;
225 apif->tx_req = tx_req;
226 apif->host_if_name = host_if_name_dup;
227 apif->per_interface_next_index = ~0;
228 apif->next_tx_frame = 0;
229 apif->next_rx_frame = 0;
231 if (tm->n_vlib_mains > 1)
232 clib_spinlock_init (&apif->lockp);
235 unix_file_t template = { 0 };
236 template.read_function = af_packet_fd_read_ready;
237 template.file_descriptor = fd;
238 template.private_data = if_index;
239 template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
240 apif->unix_file_index = unix_file_add (&unix_main, &template);
243 /*use configured or generate random MAC address */
245 clib_memcpy (hw_addr, hw_addr_set, 6);
248 f64 now = vlib_time_now (vm);
250 rnd = (u32) (now * 1e6);
251 rnd = random_u32 (&rnd);
253 clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
258 error = ethernet_register_interface (vnm, af_packet_device_class.index,
259 if_index, hw_addr, &apif->hw_if_index,
260 af_packet_eth_flag_change);
264 memset (apif, 0, sizeof (*apif));
265 pool_put (apm->interfaces, apif);
266 clib_error_report (error);
267 ret = VNET_API_ERROR_SYSCALL_ERROR_1;
271 sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
272 apif->sw_if_index = sw->sw_if_index;
273 vnet_set_device_input_node (apif->hw_if_index, af_packet_input_node.index);
274 vnet_device_input_assign_thread (apif->hw_if_index, 0, /* queue */
277 vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
278 VNET_HW_INTERFACE_FLAG_LINK_UP);
280 mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
283 *sw_if_index = apif->sw_if_index;
288 vec_free (host_if_name_dup);
295 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
297 vnet_main_t *vnm = vnet_get_main ();
298 af_packet_main_t *apm = &af_packet_main;
299 af_packet_if_t *apif;
304 p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
307 clib_warning ("Host interface %s does not exist", host_if_name);
308 return VNET_API_ERROR_SYSCALL_ERROR_1;
310 apif = pool_elt_at_index (apm->interfaces, p[0]);
311 if_index = apif - apm->interfaces;
313 /* bring down the interface */
314 vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
317 if (apif->unix_file_index != ~0)
319 unix_file_del (&unix_main, unix_main.file_pool + apif->unix_file_index);
320 apif->unix_file_index = ~0;
325 ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
326 apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
327 if (munmap (apif->rx_ring, ring_sz))
328 clib_warning ("Host interface %s could not free rx/tx ring",
330 apif->rx_ring = NULL;
331 apif->tx_ring = NULL;
334 vec_free (apif->rx_req);
336 vec_free (apif->tx_req);
339 vec_free (apif->host_if_name);
340 apif->host_if_name = NULL;
342 mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
344 ethernet_delete_interface (vnm, apif->hw_if_index);
346 pool_put (apm->interfaces, apif);
351 static clib_error_t *
352 af_packet_init (vlib_main_t * vm)
354 af_packet_main_t *apm = &af_packet_main;
355 vlib_thread_main_t *tm = vlib_get_thread_main ();
357 memset (apm, 0, sizeof (af_packet_main_t));
359 mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
361 vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
362 CLIB_CACHE_LINE_BYTES);
367 VLIB_INIT_FUNCTION (af_packet_init);
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")