interface: refactor interface capabilities code
[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 defined(PACKET_QDISC_BYPASS)
193   /* Introduced with Linux 3.14 so the ifdef should eventually be removed  */
194   if (setsockopt (*fd, SOL_PACKET, PACKET_QDISC_BYPASS, &opt, sizeof (opt)) <
195       0)
196     {
197       vlib_log_debug (apm->log_class,
198                       "Failed to set qdisc bypass error "
199                       "handling option: %s (errno %d)",
200                       strerror (errno), errno);
201     }
202 #endif
203
204   if (setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz) < 0)
205     {
206       vlib_log_debug (apm->log_class,
207                       "Failed to set packet rx ring options: %s (errno %d)",
208                       strerror (errno), errno);
209       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
210       goto error;
211     }
212
213   if (setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz) < 0)
214     {
215       vlib_log_debug (apm->log_class,
216                       "Failed to set packet tx ring options: %s (errno %d)",
217                       strerror (errno), errno);
218       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
219       goto error;
220     }
221
222   *ring =
223     mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
224           0);
225   if (*ring == MAP_FAILED)
226     {
227       vlib_log_debug (apm->log_class, "mmap failure: %s (errno %d)",
228                       strerror (errno), errno);
229       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
230       goto error;
231     }
232
233   return 0;
234 error:
235   if (*fd >= 0)
236     {
237       close (*fd);
238       *fd = -1;
239     }
240   return ret;
241 }
242
243 int
244 af_packet_create_if (af_packet_create_if_arg_t *arg)
245 {
246   af_packet_main_t *apm = &af_packet_main;
247   vlib_main_t *vm = vlib_get_main ();
248   int ret, fd = -1, fd2 = -1;
249   struct tpacket_req *rx_req = 0;
250   struct tpacket_req *tx_req = 0;
251   struct ifreq ifr;
252   u8 *ring = 0;
253   af_packet_if_t *apif = 0;
254   u8 hw_addr[6];
255   clib_error_t *error;
256   vnet_sw_interface_t *sw;
257   vnet_hw_interface_t *hw;
258   vlib_thread_main_t *tm = vlib_get_thread_main ();
259   vnet_main_t *vnm = vnet_get_main ();
260   uword *p;
261   uword if_index;
262   u8 *host_if_name_dup = 0;
263   int host_if_index = -1;
264   u32 rx_frames_per_block, tx_frames_per_block;
265   u32 rx_frame_size, tx_frame_size;
266
267   p = mhash_get (&apm->if_index_by_host_if_name, arg->host_if_name);
268   if (p)
269     {
270       apif = vec_elt_at_index (apm->interfaces, p[0]);
271       arg->sw_if_index = apif->sw_if_index;
272       return VNET_API_ERROR_IF_ALREADY_EXISTS;
273     }
274
275   host_if_name_dup = vec_dup (arg->host_if_name);
276
277   rx_frames_per_block = arg->rx_frames_per_block ?
278                           arg->rx_frames_per_block :
279                           AF_PACKET_DEFAULT_RX_FRAMES_PER_BLOCK;
280   tx_frames_per_block = arg->tx_frames_per_block ?
281                           arg->tx_frames_per_block :
282                           AF_PACKET_DEFAULT_TX_FRAMES_PER_BLOCK;
283   rx_frame_size =
284     arg->rx_frame_size ? arg->rx_frame_size : AF_PACKET_DEFAULT_RX_FRAME_SIZE;
285   tx_frame_size =
286     arg->tx_frame_size ? arg->tx_frame_size : AF_PACKET_DEFAULT_TX_FRAME_SIZE;
287
288   vec_validate (rx_req, 0);
289   rx_req->tp_block_size = rx_frame_size * rx_frames_per_block;
290   rx_req->tp_frame_size = rx_frame_size;
291   rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
292   rx_req->tp_frame_nr = AF_PACKET_RX_BLOCK_NR * rx_frames_per_block;
293
294   vec_validate (tx_req, 0);
295   tx_req->tp_block_size = tx_frame_size * tx_frames_per_block;
296   tx_req->tp_frame_size = tx_frame_size;
297   tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
298   tx_req->tp_frame_nr = AF_PACKET_TX_BLOCK_NR * tx_frames_per_block;
299
300   /*
301    * make sure host side of interface is 'UP' before binding AF_PACKET
302    * socket on it.
303    */
304   if ((fd2 = socket (AF_UNIX, SOCK_DGRAM, 0)) < 0)
305     {
306       vlib_log_debug (apm->log_class,
307                       "Failed to create AF_UNIX socket: %s (errno %d)",
308                       strerror (errno), errno);
309       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
310       goto error;
311     }
312
313   clib_memcpy (ifr.ifr_name, (const char *) arg->host_if_name,
314                vec_len (arg->host_if_name));
315   if (ioctl (fd2, SIOCGIFINDEX, &ifr) < 0)
316     {
317       vlib_log_debug (
318         apm->log_class,
319         "Failed to retrieve the interface (%s) index: %s (errno %d)",
320         arg->host_if_name, strerror (errno), errno);
321       ret = VNET_API_ERROR_INVALID_INTERFACE;
322       goto error;
323     }
324
325   host_if_index = ifr.ifr_ifindex;
326   if (ioctl (fd2, SIOCGIFFLAGS, &ifr) < 0)
327     {
328       vlib_log_debug (apm->log_class,
329                       "Failed to get the active flag: %s (errno %d)",
330                       strerror (errno), errno);
331       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
332       goto error;
333     }
334
335   if (!(ifr.ifr_flags & IFF_UP))
336     {
337       ifr.ifr_flags |= IFF_UP;
338       if (ioctl (fd2, SIOCSIFFLAGS, &ifr) < 0)
339         {
340           vlib_log_debug (apm->log_class,
341                           "Failed to set the active flag: %s (errno %d)",
342                           strerror (errno), errno);
343           ret = VNET_API_ERROR_SYSCALL_ERROR_1;
344           goto error;
345         }
346     }
347
348   if (fd2 > -1)
349     {
350       close (fd2);
351       fd2 = -1;
352     }
353
354   ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
355
356   if (ret != 0)
357     goto error;
358
359   ret = is_bridge (arg->host_if_name);
360
361   if (ret == 0)                 /* is a bridge, ignore state */
362     host_if_index = -1;
363
364   /* So far everything looks good, let's create interface */
365   pool_get (apm->interfaces, apif);
366   if_index = apif - apm->interfaces;
367
368   apif->host_if_index = host_if_index;
369   apif->fd = fd;
370   apif->rx_ring = ring;
371   apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
372   apif->rx_req = rx_req;
373   apif->tx_req = tx_req;
374   apif->host_if_name = host_if_name_dup;
375   apif->per_interface_next_index = ~0;
376   apif->next_tx_frame = 0;
377   apif->next_rx_frame = 0;
378   apif->mode = arg->mode;
379
380   ret = af_packet_read_mtu (apif);
381   if (ret != 0)
382     goto error;
383
384   if (tm->n_vlib_mains > 1)
385     clib_spinlock_init (&apif->lockp);
386
387   if (apif->mode != AF_PACKET_IF_MODE_IP)
388     {
389       /*use configured or generate random MAC address */
390       if (arg->hw_addr)
391         clib_memcpy (hw_addr, arg->hw_addr, 6);
392       else
393         {
394           f64 now = vlib_time_now (vm);
395           u32 rnd;
396           rnd = (u32) (now * 1e6);
397           rnd = random_u32 (&rnd);
398
399           clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
400           hw_addr[0] = 2;
401           hw_addr[1] = 0xfe;
402         }
403
404       error = ethernet_register_interface (
405         vnm, af_packet_device_class.index, if_index, hw_addr,
406         &apif->hw_if_index, af_packet_eth_flag_change);
407
408       if (error)
409         {
410           clib_memset (apif, 0, sizeof (*apif));
411           pool_put (apm->interfaces, apif);
412           vlib_log_err (apm->log_class, "Unable to register interface: %U",
413                         format_clib_error, error);
414           clib_error_free (error);
415           ret = VNET_API_ERROR_SYSCALL_ERROR_1;
416           goto error;
417         }
418     }
419   else
420     {
421       apif->hw_if_index = vnet_register_interface (
422         vnm, af_packet_device_class.index, if_index,
423         af_packet_ip_device_hw_interface_class.index, if_index);
424     }
425   sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
426   hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
427   apif->sw_if_index = sw->sw_if_index;
428   vnet_hw_if_set_input_node (vnm, apif->hw_if_index,
429                              af_packet_input_node.index);
430   apif->queue_index = vnet_hw_if_register_rx_queue (vnm, apif->hw_if_index, 0,
431                                                     VNET_HW_IF_RXQ_THREAD_ANY);
432
433   hw->caps |= VNET_HW_IF_CAP_INT_MODE;
434   vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
435                                VNET_HW_INTERFACE_FLAG_LINK_UP);
436
437   vnet_hw_if_set_rx_queue_mode (vnm, apif->queue_index,
438                                 VNET_HW_IF_RX_MODE_INTERRUPT);
439   vnet_hw_if_update_runtime_data (vnm, apif->hw_if_index);
440   {
441     clib_file_t template = { 0 };
442     template.read_function = af_packet_fd_read_ready;
443     template.file_descriptor = fd;
444     template.private_data = if_index;
445     template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
446     template.description =
447       format (0, "%U", format_af_packet_device_name, if_index);
448     apif->clib_file_index = clib_file_add (&file_main, &template);
449   }
450   vnet_hw_if_set_rx_queue_file_index (vnm, apif->queue_index,
451                                       apif->clib_file_index);
452
453   mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
454                  0);
455   arg->sw_if_index = apif->sw_if_index;
456
457   return 0;
458
459 error:
460   if (fd2 > -1)
461     {
462       close (fd2);
463       fd2 = -1;
464     }
465   vec_free (host_if_name_dup);
466   vec_free (rx_req);
467   vec_free (tx_req);
468   return ret;
469 }
470
471 int
472 af_packet_delete_if (u8 *host_if_name)
473 {
474   vnet_main_t *vnm = vnet_get_main ();
475   af_packet_main_t *apm = &af_packet_main;
476   af_packet_if_t *apif;
477   uword *p;
478   uword if_index;
479   u32 ring_sz;
480
481   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
482   if (p == NULL)
483     {
484       vlib_log_warn (apm->log_class, "Host interface %s does not exist",
485                      host_if_name);
486       return VNET_API_ERROR_SYSCALL_ERROR_1;
487     }
488   apif = pool_elt_at_index (apm->interfaces, p[0]);
489   if_index = apif - apm->interfaces;
490
491   /* bring down the interface */
492   vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
493
494   /* clean up */
495   if (apif->clib_file_index != ~0)
496     {
497       clib_file_del (&file_main, file_main.file_pool + apif->clib_file_index);
498       apif->clib_file_index = ~0;
499     }
500   else
501     close (apif->fd);
502
503   ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
504     apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
505   if (munmap (apif->rx_ring, ring_sz))
506     vlib_log_warn (apm->log_class,
507                    "Host interface %s could not free rx/tx ring",
508                    host_if_name);
509   apif->rx_ring = NULL;
510   apif->tx_ring = NULL;
511   apif->fd = -1;
512
513   vec_free (apif->rx_req);
514   apif->rx_req = NULL;
515   vec_free (apif->tx_req);
516   apif->tx_req = NULL;
517
518   vec_free (apif->host_if_name);
519   apif->host_if_name = NULL;
520   apif->host_if_index = -1;
521
522   mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
523
524   if (apif->mode != AF_PACKET_IF_MODE_IP)
525     ethernet_delete_interface (vnm, apif->hw_if_index);
526   else
527     vnet_delete_hw_interface (vnm, apif->hw_if_index);
528
529   pool_put (apm->interfaces, apif);
530
531   return 0;
532 }
533
534 int
535 af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set)
536 {
537   vnet_main_t *vnm = vnet_get_main ();
538   vnet_hw_interface_t *hw;
539
540   hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
541
542   if (hw->dev_class_index != af_packet_device_class.index)
543     return VNET_API_ERROR_INVALID_INTERFACE;
544
545   if (set)
546     {
547       hw->caps &= ~(VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM);
548     }
549   else
550     {
551       hw->caps |= (VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM);
552     }
553   return 0;
554 }
555
556 int
557 af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs)
558 {
559   af_packet_main_t *apm = &af_packet_main;
560   af_packet_if_t *apif;
561   af_packet_if_detail_t *r_af_packet_ifs = NULL;
562   af_packet_if_detail_t *af_packet_if = NULL;
563
564   pool_foreach (apif, apm->interfaces)
565      {
566       vec_add2 (r_af_packet_ifs, af_packet_if, 1);
567       af_packet_if->sw_if_index = apif->sw_if_index;
568       if (apif->host_if_name)
569         {
570           clib_memcpy (af_packet_if->host_if_name, apif->host_if_name,
571                        MIN (ARRAY_LEN (af_packet_if->host_if_name) - 1,
572                        strlen ((const char *) apif->host_if_name)));
573         }
574     }
575
576   *out_af_packet_ifs = r_af_packet_ifs;
577
578   return 0;
579 }
580
581 static clib_error_t *
582 af_packet_init (vlib_main_t * vm)
583 {
584   af_packet_main_t *apm = &af_packet_main;
585   vlib_thread_main_t *tm = vlib_get_thread_main ();
586
587   clib_memset (apm, 0, sizeof (af_packet_main_t));
588
589   mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
590
591   vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
592                         CLIB_CACHE_LINE_BYTES);
593
594   apm->log_class = vlib_log_register_class ("af_packet", 0);
595   vlib_log_debug (apm->log_class, "initialized");
596
597   return 0;
598 }
599
600 VLIB_INIT_FUNCTION (af_packet_init);
601
602 /*
603  * fd.io coding-style-patch-verification: ON
604  *
605  * Local Variables:
606  * eval: (c-set-style "gnu")
607  * End:
608  */