tapv2: coverity woe
[vpp.git] / src / vnet / devices / tap / tap.c
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2017 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17
18 #define _GNU_SOURCE
19 #include <sys/types.h>
20 #include <sys/stat.h>
21 #include <fcntl.h>
22 #include <net/if.h>
23 #include <linux/if_tun.h>
24 #include <sys/ioctl.h>
25 #include <linux/virtio_net.h>
26 #include <linux/vhost.h>
27 #include <sys/eventfd.h>
28 #include <sched.h>
29
30 #include <linux/netlink.h>
31 #include <linux/rtnetlink.h>
32
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
35 #include <vnet/ethernet/ethernet.h>
36 #include <vnet/ip/ip4_packet.h>
37 #include <vnet/ip/ip6_packet.h>
38 #include <vnet/devices/netlink.h>
39 #include <vnet/devices/virtio/virtio.h>
40 #include <vnet/devices/tap/tap.h>
41
42 tap_main_t tap_main;
43
44 #define _IOCTL(fd,a,...) \
45   if (ioctl (fd, a, __VA_ARGS__) < 0) \
46     { \
47       err = clib_error_return_unix (0, "ioctl(" #a ")"); \
48       goto error; \
49     }
50
51 static u32
52 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
53                         u32 flags)
54 {
55   /* nothing for now */
56   //TODO On MTU change call vnet_netlink_set_if_mtu
57   return 0;
58 }
59
60 static int
61 open_netns_fd (char *netns)
62 {
63   u8 *s = 0;
64   int fd;
65
66   if (strncmp (netns, "pid:", 4) == 0)
67     s = format (0, "/proc/%u/ns/net%c", atoi (netns + 4), 0);
68   else if (netns[0] == '/')
69     s = format (0, "%s%c", netns, 0);
70   else
71     s = format (0, "/var/run/netns/%s%c", netns, 0);
72
73   fd = open ((char *) s, O_RDONLY);
74   vec_free (s);
75   return fd;
76 }
77
78 #define TAP_MAX_INSTANCE 1024
79
80 void
81 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
82 {
83   vnet_main_t *vnm = vnet_get_main ();
84   vlib_thread_main_t *thm = vlib_get_thread_main ();
85   virtio_main_t *vim = &virtio_main;
86   tap_main_t *tm = &tap_main;
87   vnet_sw_interface_t *sw;
88   vnet_hw_interface_t *hw;
89   int i;
90   int old_netns_fd = -1;
91   struct ifreq ifr;
92   size_t hdrsz;
93   struct vhost_memory *vhost_mem = 0;
94   virtio_if_t *vif = 0;
95   clib_error_t *err = 0;
96
97   if (args->id != ~0)
98     {
99       if (clib_bitmap_get (tm->tap_ids, args->id))
100         {
101           args->rv = VNET_API_ERROR_INVALID_INTERFACE;
102           args->error = clib_error_return (0, "interface already exists");
103           return;
104         }
105     }
106   else
107     {
108       args->id = clib_bitmap_first_clear (tm->tap_ids);
109     }
110
111   if (args->id > TAP_MAX_INSTANCE)
112     {
113       args->rv = VNET_API_ERROR_UNSPECIFIED;
114       args->error = clib_error_return (0, "cannot find free interface id");
115       return;
116     }
117
118   clib_memset (&ifr, 0, sizeof (ifr));
119   pool_get (vim->interfaces, vif);
120   vif->dev_instance = vif - vim->interfaces;
121   vif->tap_fd = -1;
122   vif->id = args->id;
123
124   if ((vif->fd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
125     {
126       args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
127       args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
128       goto error;
129     }
130
131   _IOCTL (vif->fd, VHOST_GET_FEATURES, &vif->remote_features);
132
133   if ((vif->remote_features & (1ULL << VIRTIO_NET_F_MRG_RXBUF)) == 0)
134     {
135       args->rv = VNET_API_ERROR_UNSUPPORTED;
136       args->error = clib_error_return (0, "vhost-net backend doesn't support "
137                                        "VIRTIO_NET_F_MRG_RXBUF feature");
138       goto error;
139     }
140
141   if ((vif->remote_features & (1ULL << VIRTIO_RING_F_INDIRECT_DESC)) == 0)
142     {
143       args->rv = VNET_API_ERROR_UNSUPPORTED;
144       args->error = clib_error_return (0, "vhost-net backend doesn't support "
145                                        "VIRTIO_RING_F_INDIRECT_DESC feature");
146       goto error;
147     }
148
149   if ((vif->remote_features & (1ULL << VIRTIO_F_VERSION_1)) == 0)
150     {
151       args->rv = VNET_API_ERROR_UNSUPPORTED;
152       args->error = clib_error_return (0, "vhost-net backend doesn't support "
153                                        "VIRTIO_F_VERSION_1 features");
154       goto error;
155     }
156
157   vif->features |= 1ULL << VIRTIO_NET_F_MRG_RXBUF;
158   vif->features |= 1ULL << VIRTIO_F_VERSION_1;
159   vif->features |= 1ULL << VIRTIO_RING_F_INDIRECT_DESC;
160
161   _IOCTL (vif->fd, VHOST_SET_FEATURES, &vif->features);
162
163   if ((vif->tap_fd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
164     {
165       args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
166       args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
167       goto error;
168     }
169
170   ifr.ifr_flags = IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR;
171   _IOCTL (vif->tap_fd, TUNSETIFF, (void *) &ifr);
172   vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
173
174   unsigned int offload = 0;
175   hdrsz = sizeof (struct virtio_net_hdr_v1);
176   _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
177   _IOCTL (vif->tap_fd, TUNSETVNETHDRSZ, &hdrsz);
178   _IOCTL (vif->fd, VHOST_SET_OWNER, 0);
179
180   /* if namespace is specified, all further netlink messages should be excuted
181      after we change our net namespace */
182   if (args->host_namespace)
183     {
184       int fd;
185       int rc;
186       old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
187       if ((fd = open_netns_fd ((char *) args->host_namespace)) == -1)
188         {
189           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
190           args->error = clib_error_return_unix (0, "open_netns_fd '%s'",
191                                                 args->host_namespace);
192           goto error;
193         }
194       args->error = vnet_netlink_set_link_netns (vif->ifindex, fd,
195                                                  (char *) args->host_if_name);
196       if (args->error)
197         {
198           args->rv = VNET_API_ERROR_NETLINK_ERROR;
199           goto error;
200         }
201       rc = setns (fd, CLONE_NEWNET);
202       close (fd);
203       if (rc == -1)
204         {
205           args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
206           args->error = clib_error_return_unix (0, "setns '%s'",
207                                                 args->host_namespace);
208           goto error;
209         }
210       if ((vif->ifindex = if_nametoindex ((char *) args->host_if_name)) == 0)
211         {
212           args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
213           args->error = clib_error_return_unix (0, "if_nametoindex '%s'",
214                                                 args->host_if_name);
215           goto error;
216         }
217     }
218   else
219     {
220       if (args->host_if_name)
221         {
222           args->error = vnet_netlink_set_link_name (vif->ifindex,
223                                                     (char *)
224                                                     args->host_if_name);
225           if (args->error)
226             {
227               args->rv = VNET_API_ERROR_NETLINK_ERROR;
228               goto error;
229             }
230         }
231     }
232
233   if (!ethernet_mac_address_is_zero (args->host_mac_addr))
234     {
235       args->error = vnet_netlink_set_link_addr (vif->ifindex,
236                                                 args->host_mac_addr);
237       if (args->error)
238         {
239           args->rv = VNET_API_ERROR_NETLINK_ERROR;
240           goto error;
241         }
242     }
243
244   if (args->host_bridge)
245     {
246       args->error = vnet_netlink_set_link_master (vif->ifindex,
247                                                   (char *) args->host_bridge);
248       if (args->error)
249         {
250           args->rv = VNET_API_ERROR_NETLINK_ERROR;
251           goto error;
252         }
253     }
254
255
256   if (args->host_ip4_prefix_len)
257     {
258       args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
259                                                &args->host_ip4_addr,
260                                                args->host_ip4_prefix_len);
261       if (args->error)
262         {
263           args->rv = VNET_API_ERROR_NETLINK_ERROR;
264           goto error;
265         }
266     }
267
268   if (args->host_ip6_prefix_len)
269     {
270       args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
271                                                &args->host_ip6_addr,
272                                                args->host_ip6_prefix_len);
273       if (args->error)
274         {
275           args->rv = VNET_API_ERROR_NETLINK_ERROR;
276           goto error;
277         }
278     }
279
280   args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
281   if (args->error)
282     {
283       args->rv = VNET_API_ERROR_NETLINK_ERROR;
284       goto error;
285     }
286
287   if (args->host_ip4_gw_set)
288     {
289       args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
290       if (args->error)
291         {
292           args->rv = VNET_API_ERROR_NETLINK_ERROR;
293           goto error;
294         }
295     }
296
297   if (args->host_ip6_gw_set)
298     {
299       args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
300       if (args->error)
301         {
302           args->rv = VNET_API_ERROR_NETLINK_ERROR;
303           goto error;
304         }
305     }
306
307   /* switch back to old net namespace */
308   if (args->host_namespace)
309     {
310       if (setns (old_netns_fd, CLONE_NEWNET) == -1)
311         {
312           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
313           args->error = clib_error_return_unix (0, "setns '%s'",
314                                                 args->host_namespace);
315           goto error;
316         }
317     }
318
319   /* Set vhost memory table */
320   i = sizeof (struct vhost_memory) + sizeof (struct vhost_memory_region);
321   vhost_mem = clib_mem_alloc (i);
322   clib_memset (vhost_mem, 0, i);
323   vhost_mem->nregions = 1;
324   vhost_mem->regions[0].memory_size = (1ULL << 47) - 4096;
325   _IOCTL (vif->fd, VHOST_SET_MEM_TABLE, vhost_mem);
326
327   if ((args->error = virtio_vring_init (vm, vif, 0, args->rx_ring_sz)))
328     {
329       args->rv = VNET_API_ERROR_INIT_FAILED;
330       goto error;
331     }
332
333   if ((args->error = virtio_vring_init (vm, vif, 1, args->tx_ring_sz)))
334     {
335       args->rv = VNET_API_ERROR_INIT_FAILED;
336       goto error;
337     }
338
339   if (!args->mac_addr_set)
340     {
341       f64 now = vlib_time_now (vm);
342       u32 rnd;
343       rnd = (u32) (now * 1e6);
344       rnd = random_u32 (&rnd);
345
346       memcpy (args->mac_addr + 2, &rnd, sizeof (rnd));
347       args->mac_addr[0] = 2;
348       args->mac_addr[1] = 0xfe;
349     }
350   vif->rx_ring_sz = args->rx_ring_sz != 0 ? args->rx_ring_sz : 256;
351   vif->tx_ring_sz = args->tx_ring_sz != 0 ? args->tx_ring_sz : 256;
352   vif->host_if_name = args->host_if_name;
353   args->host_if_name = 0;
354   vif->net_ns = args->host_namespace;
355   args->host_namespace = 0;
356   vif->host_bridge = args->host_bridge;
357   args->host_bridge = 0;
358   clib_memcpy (vif->host_mac_addr, args->host_mac_addr, 6);
359   vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
360   vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
361   if (args->host_ip4_prefix_len)
362     clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
363   if (args->host_ip6_prefix_len)
364     clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
365
366   args->error = ethernet_register_interface (vnm, virtio_device_class.index,
367                                              vif->dev_instance,
368                                              args->mac_addr,
369                                              &vif->hw_if_index,
370                                              virtio_eth_flag_change);
371   if (args->error)
372     {
373       args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
374       goto error;
375     }
376
377   tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
378   sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
379   vif->sw_if_index = sw->sw_if_index;
380   args->sw_if_index = vif->sw_if_index;
381   hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
382   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
383   vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
384                                     virtio_input_node.index);
385   vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, 0, ~0);
386   vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, 0,
387                                  VNET_HW_INTERFACE_RX_MODE_DEFAULT);
388   vif->per_interface_next_index = ~0;
389   vif->type = VIRTIO_IF_TYPE_TAP;
390   vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
391   vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
392                                VNET_HW_INTERFACE_FLAG_LINK_UP);
393   if (thm->n_vlib_mains > 1)
394     clib_spinlock_init (&vif->lockp);
395   goto done;
396
397 error:
398   if (err)
399     {
400       ASSERT (args->error == 0);
401       args->error = err;
402       args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
403     }
404   if (vif->tap_fd != -1)
405     close (vif->tap_fd);
406   if (vif->fd != -1)
407     close (vif->fd);
408   vec_foreach_index (i, vif->vrings) virtio_vring_free (vm, vif, i);
409   vec_free (vif->vrings);
410   clib_memset (vif, 0, sizeof (virtio_if_t));
411   pool_put (vim->interfaces, vif);
412
413 done:
414   if (vhost_mem)
415     clib_mem_free (vhost_mem);
416   if (old_netns_fd != -1)
417     close (old_netns_fd);
418 }
419
420 int
421 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
422 {
423   vnet_main_t *vnm = vnet_get_main ();
424   virtio_main_t *mm = &virtio_main;
425   tap_main_t *tm = &tap_main;
426   int i;
427   virtio_if_t *vif;
428   vnet_hw_interface_t *hw;
429
430   hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
431   if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
432     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
433
434   vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
435
436   /* bring down the interface */
437   vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
438   vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
439   vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, 0);
440
441   ethernet_delete_interface (vnm, vif->hw_if_index);
442   vif->hw_if_index = ~0;
443
444   if (vif->tap_fd != -1)
445     close (vif->tap_fd);
446   if (vif->fd != -1)
447     close (vif->fd);
448
449   vec_foreach_index (i, vif->vrings) virtio_vring_free (vm, vif, i);
450   vec_free (vif->vrings);
451
452   tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
453   clib_spinlock_free (&vif->lockp);
454   clib_memset (vif, 0, sizeof (*vif));
455   pool_put (mm->interfaces, vif);
456
457   return 0;
458 }
459
460 int
461 tap_dump_ifs (tap_interface_details_t ** out_tapids)
462 {
463   vnet_main_t *vnm = vnet_get_main ();
464   virtio_main_t *mm = &virtio_main;
465   virtio_if_t *vif;
466   vnet_hw_interface_t *hi;
467   tap_interface_details_t *r_tapids = NULL;
468   tap_interface_details_t *tapid = NULL;
469
470   /* *INDENT-OFF* */
471   pool_foreach (vif, mm->interfaces,
472     vec_add2(r_tapids, tapid, 1);
473     clib_memset (tapid, 0, sizeof (*tapid));
474     tapid->id = vif->id;
475     tapid->sw_if_index = vif->sw_if_index;
476     hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
477     clib_memcpy(tapid->dev_name, hi->name,
478                 MIN (ARRAY_LEN (tapid->dev_name) - 1,
479                      strlen ((const char *) hi->name)));
480     tapid->rx_ring_sz = vif->rx_ring_sz;
481     tapid->tx_ring_sz = vif->tx_ring_sz;
482     clib_memcpy(tapid->host_mac_addr, vif->host_mac_addr, 6);
483     if (vif->host_if_name)
484       {
485         clib_memcpy(tapid->host_if_name, vif->host_if_name,
486                     MIN (ARRAY_LEN (tapid->host_if_name) - 1,
487                     strlen ((const char *) vif->host_if_name)));
488       }
489     if (vif->net_ns)
490       {
491         clib_memcpy(tapid->host_namespace, vif->net_ns,
492                     MIN (ARRAY_LEN (tapid->host_namespace) - 1,
493                     strlen ((const char *) vif->net_ns)));
494       }
495     if (vif->host_bridge)
496       {
497         clib_memcpy(tapid->host_bridge, vif->host_bridge,
498                     MIN (ARRAY_LEN (tapid->host_bridge) - 1,
499                     strlen ((const char *) vif->host_bridge)));
500       }
501     if (vif->host_ip4_prefix_len)
502       clib_memcpy(tapid->host_ip4_addr, &vif->host_ip4_addr, 4);
503     tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
504     if (vif->host_ip6_prefix_len)
505       clib_memcpy(tapid->host_ip6_addr, &vif->host_ip6_addr, 16);
506     tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
507   );
508   /* *INDENT-ON* */
509
510   *out_tapids = r_tapids;
511
512   return 0;
513 }
514
515 static clib_error_t *
516 tap_init (vlib_main_t * vm)
517 {
518   tap_main_t *tm = &tap_main;
519   clib_error_t *error = 0;
520
521   tm->log_default = vlib_log_register_class ("tap", 0);
522   vlib_log_debug (tm->log_default, "initialized");
523
524   return error;
525 }
526
527 VLIB_INIT_FUNCTION (tap_init);
528
529 /*
530  * fd.io coding-style-patch-verification: ON
531  *
532  * Local Variables:
533  * eval: (c-set-style "gnu")
534  * End:
535  */