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