devices: af-packet v3 support
[vpp.git] / src / 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 #include <sys/ioctl.h>
23 #include <net/if.h>
24 #include <dirent.h>
25 #include <sys/stat.h>
26 #include <sys/types.h>
27 #include <fcntl.h>
28
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/devices/netlink.h>
34 #include <vnet/ethernet/ethernet.h>
35 #include <vnet/interface/rx_queue_funcs.h>
36
37 #include <vnet/devices/af_packet/af_packet.h>
38
39 af_packet_main_t af_packet_main;
40
41 VNET_HW_INTERFACE_CLASS (af_packet_ip_device_hw_interface_class, static) = {
42   .name = "af-packet-ip-device",
43   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
44 };
45
46 #define AF_PACKET_DEFAULT_TX_FRAMES_PER_BLOCK 1024
47 #define AF_PACKET_DEFAULT_TX_FRAME_SIZE       (2048 * 5)
48 #define AF_PACKET_TX_BLOCK_NR           1
49
50 #define AF_PACKET_DEFAULT_RX_FRAMES_PER_BLOCK 256
51 #define AF_PACKET_DEFAULT_RX_FRAME_SIZE       2048
52 #define AF_PACKET_RX_BLOCK_NR                 20
53
54 /*defined in net/if.h but clashes with dpdk headers */
55 unsigned int if_nametoindex (const char *ifname);
56
57 static clib_error_t *
58 af_packet_eth_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hi,
59                                   u32 frame_size)
60 {
61   clib_error_t *error, *rv;
62   af_packet_main_t *apm = &af_packet_main;
63   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, hi->dev_instance);
64
65   error = vnet_netlink_set_link_mtu (apif->host_if_index,
66                                      frame_size + hi->frame_overhead);
67
68   if (error)
69     {
70       vlib_log_err (apm->log_class, "netlink failed to change MTU: %U",
71                     format_clib_error, error);
72       rv = vnet_error (VNET_ERR_SYSCALL_ERROR_1, "netlink error: %U",
73                        format_clib_error, error);
74       clib_error_free (error);
75       return rv;
76     }
77   else
78     apif->host_mtu = frame_size + hi->frame_overhead;
79   return 0;
80 }
81
82 static int
83 af_packet_read_mtu (af_packet_if_t *apif)
84 {
85   af_packet_main_t *apm = &af_packet_main;
86   clib_error_t *error;
87   error = vnet_netlink_get_link_mtu (apif->host_if_index, &apif->host_mtu);
88   if (error)
89     {
90       vlib_log_err (apm->log_class, "netlink failed to get MTU: %U",
91                     format_clib_error, error);
92       clib_error_free (error);
93       return VNET_API_ERROR_SYSCALL_ERROR_1;
94     }
95   return 0;
96 }
97
98 static clib_error_t *
99 af_packet_fd_read_ready (clib_file_t * uf)
100 {
101   af_packet_main_t *apm = &af_packet_main;
102   vnet_main_t *vnm = vnet_get_main ();
103   u32 idx = uf->private_data;
104   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
105
106   /* Schedule the rx node */
107   vnet_hw_if_rx_queue_set_int_pending (vnm, apif->queue_index);
108   return 0;
109 }
110
111 static int
112 is_bridge (const u8 * host_if_name)
113 {
114   u8 *s;
115   DIR *dir = NULL;
116
117   s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
118   dir = opendir ((char *) s);
119   vec_free (s);
120
121   if (dir)
122     {
123       closedir (dir);
124       return 0;
125     }
126
127   return -1;
128 }
129
130 static int
131 create_packet_v3_sock (int host_if_index, tpacket_req3_t *rx_req,
132                        tpacket_req3_t *tx_req, int *fd, u8 **ring,
133                        u32 *hdrlen_ptr)
134 {
135   af_packet_main_t *apm = &af_packet_main;
136   struct sockaddr_ll sll;
137   socklen_t req_sz = sizeof (tpacket_req3_t);
138   int ret;
139   int ver = TPACKET_V3;
140   u32 hdrlen = 0;
141   u32 len = sizeof (hdrlen);
142   u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
143     tx_req->tp_block_size * tx_req->tp_block_nr;
144
145   if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
146     {
147       vlib_log_debug (apm->log_class,
148                       "Failed to create AF_PACKET socket: %s (errno %d)",
149                       strerror (errno), errno);
150       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
151       goto error;
152     }
153
154   /* bind before rx ring is cfged so we don't receive packets from other interfaces */
155   clib_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;
159   if (bind (*fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
160     {
161       vlib_log_debug (apm->log_class,
162                       "Failed to bind rx packet socket: %s (errno %d)",
163                       strerror (errno), errno);
164       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
165       goto error;
166     }
167
168   if (setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver)) < 0)
169     {
170       vlib_log_debug (
171         apm->log_class,
172         "Failed to set rx packet interface version: %s (errno %d)",
173         strerror (errno), errno);
174       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
175       goto error;
176     }
177
178   if (getsockopt (*fd, SOL_PACKET, PACKET_HDRLEN, &hdrlen, &len) < 0)
179     {
180       vlib_log_debug (
181         apm->log_class,
182         "Failed to get packet hdr len error handling option: %s (errno %d)",
183         strerror (errno), errno);
184       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
185       goto error;
186     }
187   else
188     *hdrlen_ptr = hdrlen;
189
190   int opt = 1;
191   if (setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt)) < 0)
192     {
193       vlib_log_debug (
194         apm->log_class,
195         "Failed to set packet tx ring error handling option: %s (errno %d)",
196         strerror (errno), errno);
197       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
198       goto error;
199     }
200
201 #if defined(PACKET_QDISC_BYPASS)
202   /* Introduced with Linux 3.14 so the ifdef should eventually be removed  */
203   if (setsockopt (*fd, SOL_PACKET, PACKET_QDISC_BYPASS, &opt, sizeof (opt)) <
204       0)
205     {
206       vlib_log_debug (apm->log_class,
207                       "Failed to set qdisc bypass error "
208                       "handling option: %s (errno %d)",
209                       strerror (errno), errno);
210     }
211 #endif
212
213   if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
214     {
215       vlib_log_debug (apm->log_class,
216                       "Failed to set packet rx ring options: %s (errno %d)",
217                       strerror (errno), errno);
218       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
219       goto error;
220     }
221
222   if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
223     {
224       vlib_log_debug (apm->log_class,
225                       "Failed to set packet tx ring options: %s (errno %d)",
226                       strerror (errno), errno);
227       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
228       goto error;
229     }
230
231   *ring = mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED,
232                 *fd, 0);
233   if (*ring == MAP_FAILED)
234     {
235       vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
236                       strerror (errno), errno);
237       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
238       goto error;
239     }
240
241   return 0;
242 error:
243   if (*fd >= 0)
244     {
245       close (*fd);
246       *fd = -1;
247     }
248   return ret;
249 }
250
251 int
252 af_packet_create_if (af_packet_create_if_arg_t *arg)
253 {
254   af_packet_main_t *apm = &af_packet_main;
255   vlib_main_t *vm = vlib_get_main ();
256   int ret, fd = -1, fd2 = -1;
257   tpacket_req3_t *rx_req = 0;
258   tpacket_req3_t *tx_req = 0;
259   struct ifreq ifr;
260   u8 *ring = 0;
261   af_packet_if_t *apif = 0;
262   u8 hw_addr[6];
263   vnet_sw_interface_t *sw;
264   vlib_thread_main_t *tm = vlib_get_thread_main ();
265   vnet_main_t *vnm = vnet_get_main ();
266   uword *p;
267   uword if_index;
268   u8 *host_if_name_dup = 0;
269   int host_if_index = -1;
270   u32 rx_frames_per_block, tx_frames_per_block;
271   u32 rx_frame_size, tx_frame_size;
272   u32 hdrlen = 0;
273   u32 i = 0;
274
275   p = mhash_get (&apm->if_index_by_host_if_name, arg->host_if_name);
276   if (p)
277     {
278       apif = vec_elt_at_index (apm->interfaces, p[0]);
279       arg->sw_if_index = apif->sw_if_index;
280       return VNET_API_ERROR_IF_ALREADY_EXISTS;
281     }
282
283   host_if_name_dup = vec_dup (arg->host_if_name);
284
285   rx_frames_per_block = arg->rx_frames_per_block ?
286                           arg->rx_frames_per_block :
287                           AF_PACKET_DEFAULT_RX_FRAMES_PER_BLOCK;
288   tx_frames_per_block = arg->tx_frames_per_block ?
289                           arg->tx_frames_per_block :
290                           AF_PACKET_DEFAULT_TX_FRAMES_PER_BLOCK;
291   rx_frame_size =
292     arg->rx_frame_size ? arg->rx_frame_size : AF_PACKET_DEFAULT_RX_FRAME_SIZE;
293   tx_frame_size =
294     arg->tx_frame_size ? arg->tx_frame_size : AF_PACKET_DEFAULT_TX_FRAME_SIZE;
295
296   vec_validate (rx_req, 0);
297   rx_req->tp_block_size = rx_frame_size * rx_frames_per_block;
298   rx_req->tp_frame_size = rx_frame_size;
299   rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
300   rx_req->tp_frame_nr = AF_PACKET_RX_BLOCK_NR * rx_frames_per_block;
301   rx_req->tp_retire_blk_tov = 0;
302   rx_req->tp_feature_req_word = 0;
303   rx_req->tp_sizeof_priv = 0;
304
305   vec_validate (tx_req, 0);
306   tx_req->tp_block_size = tx_frame_size * tx_frames_per_block;
307   tx_req->tp_frame_size = tx_frame_size;
308   tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
309   tx_req->tp_frame_nr = AF_PACKET_TX_BLOCK_NR * tx_frames_per_block;
310   tx_req->tp_retire_blk_tov = 0;
311   tx_req->tp_sizeof_priv = 0;
312   tx_req->tp_feature_req_word = 0;
313
314   /*
315    * make sure host side of interface is 'UP' before binding AF_PACKET
316    * socket on it.
317    */
318   if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
319     {
320       vlib_log_debug (apm->log_class,
321                       "Failed to create AF_UNIX socket: %s (errno %d)",
322                       strerror (errno), errno);
323       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
324       goto error;
325     }
326
327   clib_memcpy (ifr.ifr_name, (const char *) arg->host_if_name,
328                vec_len (arg->host_if_name));
329   if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
330     {
331       vlib_log_debug (
332         apm->log_class,
333         "Failed to retrieve the interface (%s) index: %s (errno %d)",
334         arg->host_if_name, strerror (errno), errno);
335       ret = VNET_API_ERROR_INVALID_INTERFACE;
336       goto error;
337     }
338
339   host_if_index = ifr.ifr_ifindex;
340   if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
341     {
342       vlib_log_debug (apm->log_class,
343                       "Failed to get the active flag: %s (errno %d)",
344                       strerror (errno), errno);
345       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
346       goto error;
347     }
348
349   if (!(ifr.ifr_flags & IFF_UP))
350     {
351       ifr.ifr_flags |= IFF_UP;
352       if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
353         {
354           vlib_log_debug (apm->log_class,
355                           "Failed to set the active flag: %s (errno %d)",
356                           strerror (errno), errno);
357           ret = VNET_API_ERROR_SYSCALL_ERROR_1;
358           goto error;
359         }
360     }
361
362   if (fd2 > -1)
363     {
364       close (fd2);
365       fd2 = -1;
366     }
367
368   ret =
369     create_packet_v3_sock (host_if_index, rx_req, tx_req, &fd, &ring, &hdrlen);
370
371   if (ret != 0)
372     goto error;
373
374   ret = is_bridge (arg->host_if_name);
375
376   if (ret == 0)                 /* is a bridge, ignore state */
377     host_if_index = -1;
378
379   /* So far everything looks good, let's create interface */
380   pool_get (apm->interfaces, apif);
381   if_index = apif - apm->interfaces;
382
383   apif->host_if_index = host_if_index;
384   apif->fd = fd;
385
386   vec_validate (apif->rx_ring, rx_req->tp_block_nr - 1);
387   vec_foreach_index (i, apif->rx_ring)
388     {
389       apif->rx_ring[i] = ring + i * rx_req->tp_block_size;
390     }
391
392   ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
393
394   vec_validate (apif->tx_ring, tx_req->tp_block_nr - 1);
395   vec_foreach_index (i, apif->tx_ring)
396     {
397       apif->tx_ring[i] = ring + i * tx_req->tp_block_size;
398     }
399
400   apif->rx_req = rx_req;
401   apif->tx_req = tx_req;
402   apif->host_if_name = host_if_name_dup;
403   apif->per_interface_next_index = ~0;
404   apif->next_tx_frame = 0;
405   apif->next_rx_block = 0;
406   apif->mode = arg->mode;
407   apif->hdrlen = hdrlen;
408
409   ret = af_packet_read_mtu (apif);
410   if (ret != 0)
411     goto error;
412
413   if (tm->n_vlib_mains > 1)
414     clib_spinlock_init (&apif->lockp);
415
416   if (apif->mode != AF_PACKET_IF_MODE_IP)
417     {
418       vnet_eth_interface_registration_t eir = {};
419       /*use configured or generate random MAC address */
420       if (arg->hw_addr)
421         clib_memcpy (hw_addr, arg->hw_addr, 6);
422       else
423         {
424           f64 now = vlib_time_now (vm);
425           u32 rnd;
426           rnd = (u32) (now * 1e6);
427           rnd = random_u32 (&rnd);
428
429           clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
430           hw_addr[0] = 2;
431           hw_addr[1] = 0xfe;
432         }
433
434       eir.dev_class_index = af_packet_device_class.index;
435       eir.dev_instance = if_index;
436       eir.address = hw_addr;
437       eir.cb.set_max_frame_size = af_packet_eth_set_max_frame_size;
438       apif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
439     }
440   else
441     {
442       apif->hw_if_index = vnet_register_interface (
443         vnm, af_packet_device_class.index, if_index,
444         af_packet_ip_device_hw_interface_class.index, if_index);
445     }
446   sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
447   apif->sw_if_index = sw->sw_if_index;
448   vnet_hw_if_set_input_node (vnm, apif->hw_if_index,
449                              af_packet_input_node.index);
450   apif->queue_index = vnet_hw_if_register_rx_queue (vnm, apif->hw_if_index, 0,
451                                                     VNET_HW_IF_RXQ_THREAD_ANY);
452
453   vnet_hw_if_set_caps (vnm, apif->hw_if_index, VNET_HW_IF_CAP_INT_MODE);
454   vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
455                                VNET_HW_INTERFACE_FLAG_LINK_UP);
456
457   vnet_hw_if_set_rx_queue_mode (vnm, apif->queue_index,
458                                 VNET_HW_IF_RX_MODE_INTERRUPT);
459   vnet_hw_if_update_runtime_data (vnm, apif->hw_if_index);
460   {
461     clib_file_t template = { 0 };
462     template.read_function = af_packet_fd_read_ready;
463     template.file_descriptor = fd;
464     template.private_data = if_index;
465     template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
466     template.description =
467       format (0, "%U", format_af_packet_device_name, if_index);
468     apif->clib_file_index = clib_file_add (&file_main, &template);
469   }
470   vnet_hw_if_set_rx_queue_file_index (vnm, apif->queue_index,
471                                       apif->clib_file_index);
472
473   mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
474                  0);
475   arg->sw_if_index = apif->sw_if_index;
476
477   return 0;
478
479 error:
480   if (fd2 > -1)
481     {
482       close (fd2);
483       fd2 = -1;
484     }
485   vec_free (host_if_name_dup);
486   vec_free (rx_req);
487   vec_free (tx_req);
488   return ret;
489 }
490
491 int
492 af_packet_delete_if (u8 *host_if_name)
493 {
494   vnet_main_t *vnm = vnet_get_main ();
495   af_packet_main_t *apm = &af_packet_main;
496   af_packet_if_t *apif;
497   uword *p;
498   uword if_index;
499   u32 ring_sz;
500
501   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
502   if (p == NULL)
503     {
504       vlib_log_warn (apm->log_class, "Host interface %s does not exist",
505                      host_if_name);
506       return VNET_API_ERROR_SYSCALL_ERROR_1;
507     }
508   apif = pool_elt_at_index (apm->interfaces, p[0]);
509   if_index = apif - apm->interfaces;
510
511   /* bring down the interface */
512   vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
513
514   /* clean up */
515   if (apif->clib_file_index != ~0)
516     {
517       clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
518       apif->clib_file_index = ~0;
519     }
520   else
521     close (apif->fd);
522
523   ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
524     apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
525   if (munmap (apif->rx_ring, ring_sz))
526     vlib_log_warn (apm->log_class,
527                    "Host interface %s could not free rx/tx ring",
528                    host_if_name);
529   apif->rx_ring = NULL;
530   apif->tx_ring = NULL;
531   apif->fd = -1;
532
533   vec_free (apif->rx_req);
534   apif->rx_req = NULL;
535   vec_free (apif->tx_req);
536   apif->tx_req = NULL;
537
538   vec_free (apif->host_if_name);
539   apif->host_if_name = NULL;
540   apif->host_if_index = -1;
541
542   mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
543
544   if (apif->mode != AF_PACKET_IF_MODE_IP)
545     ethernet_delete_interface (vnm, apif->hw_if_index);
546   else
547     vnet_delete_hw_interface (vnm, apif->hw_if_index);
548
549   pool_put (apm->interfaces, apif);
550
551   return 0;
552 }
553
554 int
555 af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set)
556 {
557   vnet_main_t *vnm = vnet_get_main ();
558   vnet_hw_interface_t *hw;
559   vnet_hw_if_caps_t caps =
560     VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM;
561   hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
562
563   if (hw->dev_class_index != af_packet_device_class.index)
564     return VNET_API_ERROR_INVALID_INTERFACE;
565
566   if (set)
567     vnet_hw_if_set_caps (vnm, hw->hw_if_index, caps);
568   else
569     vnet_hw_if_unset_caps (vnm, hw->hw_if_index, caps);
570
571   return 0;
572 }
573
574 int
575 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
576 {
577   af_packet_main_t *apm = &af_packet_main;
578   af_packet_if_t *apif;
579   af_packet_if_detail_t *r_af_packet_ifs = NULL;
580   af_packet_if_detail_t *af_packet_if = NULL;
581
582   pool_foreach (apif, apm->interfaces)
583      {
584       vec_add2 (r_af_packet_ifs, af_packet_if, 1);
585       af_packet_if->sw_if_index = apif->sw_if_index;
586       if (apif->host_if_name)
587         {
588           clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
589                        MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
590                        strlen ((const char *) apif->host_if_name)));
591         }
592     }
593
594   *out_af_packet_ifs = r_af_packet_ifs;
595
596   return 0;
597 }
598
599 static clib_error_t *
600 af_packet_init (vlib_main_t * vm)
601 {
602   af_packet_main_t *apm = &af_packet_main;
603   vlib_thread_main_t *tm = vlib_get_thread_main ();
604
605   clib_memset (apm, 0, sizeof (af_packet_main_t));
606
607   mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
608
609   vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
610                         CLIB_CACHE_LINE_BYTES);
611
612   apm->log_class = vlib_log_register_class ("af_packet", 0);
613   vlib_log_debug (apm->log_class, "initialized");
614
615   return 0;
616 }
617
618 VLIB_INIT_FUNCTION (af_packet_init);
619
620 /*
621  * fd.io coding-style-patch-verification: ON
622  *
623  * Local Variables:
624  * eval: (c-set-style "gnu")
625  * End:
626  */