20c61295bb03386fce5621776cd558e817661b9b
[vpp.git] / vnet / vnet / devices / af_packet / af_packet.c
1 /*
2  *------------------------------------------------------------------
3  * af_packet.c - linux kernel packet interface
4  *
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:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
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  *------------------------------------------------------------------
18  */
19
20 #include <linux/if_ether.h>
21 #include <linux/if_packet.h>
22
23 #include <vlib/vlib.h>
24 #include <vlib/unix/unix.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ethernet/ethernet.h>
27
28 #include <vnet/devices/af_packet/af_packet.h>
29
30 #define AF_PACKET_DEBUG_SOCKET          0
31
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)
39
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)
47
48 #if AF_PACKET_DEBUG_SOCKET == 1
49 #define DBG_SOCK(args...) clib_warning(args);
50 #else
51 #define DBG_SOCK(args...)
52 #endif
53
54 /*defined in net/if.h but clashes with dpdk headers */
55 unsigned int if_nametoindex(const char *ifname);
56
57 typedef struct tpacket_req tpacket_req_t;
58
59 static u32
60 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
61 {
62   /* nothing for now */
63   return 0;
64 }
65
66 static clib_error_t * af_packet_fd_read_ready (unix_file_t * uf)
67 {
68   vlib_main_t * vm = vlib_get_main();
69   af_packet_main_t * apm = &af_packet_main;
70   u32 idx = uf->private_data;
71
72   apm->pending_input_bitmap = clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
73
74   /* Schedule the rx node */
75   vlib_node_set_interrupt_pending (vm, af_packet_input_node.index);
76
77   return 0;
78 }
79
80 static int
81 create_packet_v2_sock(u8 * name, tpacket_req_t * rx_req, tpacket_req_t * tx_req,
82                       int *fd, u8 ** ring)
83 {
84   int ret, err;
85   struct sockaddr_ll sll;
86   uint host_if_index;
87   int ver = TPACKET_V2;
88   socklen_t req_sz = sizeof(struct tpacket_req);
89   u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
90                 tx_req->tp_block_size * tx_req->tp_block_nr;
91
92   host_if_index = if_nametoindex((const char *) name);
93
94   if (!host_if_index)
95     {
96       DBG_SOCK("Wrong host interface name");
97       ret = VNET_API_ERROR_INVALID_INTERFACE;
98       goto error;
99     }
100
101   if ((*fd = socket(AF_PACKET, SOCK_RAW, htons(ETH_P_ALL))) < 0)
102     {
103       DBG_SOCK("Failed to create socket");
104       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
105       goto error;
106     }
107
108   if ((err = setsockopt(*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof(ver))) < 0)
109     {
110       DBG_SOCK("Failed to set rx packet interface version");
111       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
112       goto error;
113     }
114
115   int opt = 1;
116   if ((err = setsockopt(*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof(opt))) < 0)
117     {
118       DBG_SOCK("Failed to set rx packet interface version");
119       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
120       goto error;
121     }
122
123   if ((err = setsockopt(*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
124     {
125       DBG_SOCK("Failed to set packet rx ring options");
126       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
127       goto error;
128     }
129
130   if ((err = setsockopt(*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
131     {
132       DBG_SOCK("Failed to set packet rx ring options");
133       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
134       goto error;
135     }
136
137   *ring = mmap(NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd, 0);
138   if (*ring == MAP_FAILED)
139     {
140       DBG_SOCK("mmap failure");
141       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
142       goto error;
143     }
144
145   memset(&sll, 0, sizeof(sll));
146   sll.sll_family = PF_PACKET;
147   sll.sll_protocol = htons(ETH_P_ALL);
148   sll.sll_ifindex = host_if_index;
149
150   if ((err = bind(*fd, (struct sockaddr *) &sll, sizeof(sll))) < 0)
151     {
152       DBG_SOCK("Failed to bind rx packet socket (error %d)", err);
153       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
154       goto error;
155     }
156
157   return 0;
158 error:
159   close(*fd);
160   *fd = -1;
161   return ret;
162 }
163
164 int
165 af_packet_create_if(vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set)
166 {
167   af_packet_main_t * apm = &af_packet_main;
168   int ret, fd = -1;
169   struct tpacket_req * rx_req = 0;
170   struct tpacket_req * tx_req = 0;
171   u8 * ring = 0;
172   af_packet_if_t * apif = 0;
173   u8 hw_addr[6];
174   clib_error_t * error;
175   vnet_sw_interface_t * sw;
176   vnet_main_t *vnm = vnet_get_main();
177   uword * p;
178   uword if_index;
179
180   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
181   if (p)
182     {
183       return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
184     }
185
186   vec_validate(rx_req, 0);
187   rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
188   rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
189   rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
190   rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
191
192   vec_validate(tx_req, 0);
193   tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
194   tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
195   tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
196   tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
197
198   ret = create_packet_v2_sock(host_if_name, rx_req, tx_req, &fd, &ring);
199
200   if (ret != 0)
201     goto error;
202
203   /* So far everything looks good, let's create interface */
204   pool_get (apm->interfaces, apif);
205   if_index = apif - apm->interfaces;
206
207   apif->fd = fd;
208   apif->rx_ring = ring;
209   apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
210   apif->rx_req = rx_req;
211   apif->tx_req = tx_req;
212   apif->host_if_name = host_if_name;
213   apif->per_interface_next_index = ~0;
214   apif->next_tx_frame = 0;
215   apif->next_rx_frame = 0;
216
217   {
218     unix_file_t template = {0};
219     template.read_function = af_packet_fd_read_ready;
220     template.file_descriptor = fd;
221     template.private_data = if_index;
222     template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
223     apif->unix_file_index = unix_file_add (&unix_main, &template);
224   }
225
226   /*use configured or generate random MAC address */
227   if (hw_addr_set)
228     clib_memcpy(hw_addr, hw_addr_set, 6);
229   else
230     {
231       f64 now = vlib_time_now(vm);
232       u32 rnd;
233       rnd = (u32) (now * 1e6);
234       rnd = random_u32 (&rnd);
235
236       clib_memcpy (hw_addr+2, &rnd, sizeof(rnd));
237       hw_addr[0] = 2;
238       hw_addr[1] = 0xfe;
239     }
240
241   error = ethernet_register_interface(vnm, af_packet_device_class.index,
242                                       if_index, hw_addr, &apif->hw_if_index,
243                                       af_packet_eth_flag_change);
244
245   if (error)
246     {
247       memset(apif, 0, sizeof(*apif));
248       pool_put(apm->interfaces, apif);
249       clib_error_report (error);
250       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
251       goto error;
252     }
253
254   sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
255   apif->sw_if_index = sw->sw_if_index;
256
257   vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
258                                VNET_HW_INTERFACE_FLAG_LINK_UP);
259
260   mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name, &if_index, 0);
261
262   return 0;
263
264 error:
265   vec_free(host_if_name);
266   vec_free(rx_req);
267   vec_free(tx_req);
268   return ret;
269 }
270
271 int
272 af_packet_delete_if(vlib_main_t *vm, u8 *host_if_name)
273 {
274   vnet_main_t *vnm = vnet_get_main();
275   af_packet_main_t *apm = &af_packet_main;
276   af_packet_if_t *apif;
277   uword *p;
278   uword if_index;
279   u32 ring_sz;
280
281   p = mhash_get(&apm->if_index_by_host_if_name, host_if_name);
282   if (p == NULL) {
283     clib_warning("Host interface %s does not exist", host_if_name);
284     return VNET_API_ERROR_SYSCALL_ERROR_1;
285   }
286   apif = pool_elt_at_index(apm->interfaces, p[0]);
287   if_index = apif - apm->interfaces;
288
289   /* bring down the interface */
290   vnet_hw_interface_set_flags(vnm, apif->hw_if_index, 0);
291
292   /* clean up */
293   if (apif->unix_file_index != ~0) {
294     unix_file_del(&unix_main, unix_main.file_pool + apif->unix_file_index);
295     apif->unix_file_index = ~0;
296   }
297   ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
298             apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
299   if (munmap(apif->rx_ring, ring_sz))
300     clib_warning("Host interface %s could not free rx/tx ring", host_if_name);
301   apif->rx_ring = NULL;
302   apif->tx_ring = NULL;
303   close(apif->fd);
304   apif->fd = -1;
305
306   vec_free(apif->rx_req);
307   apif->rx_req = NULL;
308   vec_free(apif->tx_req);
309   apif->tx_req = NULL;
310
311   vec_free(apif->host_if_name);
312   apif->host_if_name = NULL;
313
314   mhash_unset(&apm->if_index_by_host_if_name, host_if_name, &if_index);
315
316   ethernet_delete_interface(vnm, apif->hw_if_index);
317
318   pool_put(apm->interfaces, apif);
319
320   return 0;
321 }
322
323 static clib_error_t *
324 af_packet_init (vlib_main_t * vm)
325 {
326   af_packet_main_t * apm = &af_packet_main;
327
328   memset (apm, 0, sizeof (af_packet_main_t));
329
330   mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
331
332   return 0;
333 }
334
335 VLIB_INIT_FUNCTION (af_packet_init);