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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
19 #include <sys/types.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>
30 #include <linux/netlink.h>
31 #include <linux/rtnetlink.h>
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>
44 #define _IOCTL(fd,a,...) \
45 if (ioctl (fd, a, __VA_ARGS__) < 0) \
47 err = clib_error_return_unix (0, "ioctl(" #a ")"); \
52 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
56 //TODO On MTU change call vnet_netlink_set_if_mtu
60 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
63 call_tap_read_ready (clib_file_t * uf)
70 tap_delete_if_cp (u32 * sw_if_index)
72 vlib_main_t *vm = vlib_get_main ();
73 tap_delete_if (vm, *sw_if_index);
77 * Tap clean-up routine:
78 * Linux side of tap interface can be deleted i.e. tap is
79 * attached to container and if someone will delete this
80 * container, will also removes tap interface. While VPP
81 * will have other side of tap. This function will RPC
82 * main thread to call the tap_delete_if to cleanup tap.
85 call_tap_error_ready (clib_file_t * uf)
87 vl_api_rpc_call_main_thread (tap_delete_if_cp, (u8 *) & uf->private_data,
88 sizeof (uf->private_data));
93 open_netns_fd (char *netns)
98 if (strncmp (netns, "pid:", 4) == 0)
99 s = format (0, "/proc/%u/ns/net%c", atoi (netns + 4), 0);
100 else if (netns[0] == '/')
101 s = format (0, "%s%c", netns, 0);
103 s = format (0, "/var/run/netns/%s%c", netns, 0);
105 fd = open ((char *) s, O_RDONLY);
110 #define TAP_MAX_INSTANCE 1024
113 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
115 vnet_main_t *vnm = vnet_get_main ();
116 virtio_main_t *vim = &virtio_main;
117 tap_main_t *tm = &tap_main;
118 vnet_sw_interface_t *sw;
119 vnet_hw_interface_t *hw;
121 int old_netns_fd = -1;
124 struct vhost_memory *vhost_mem = 0;
125 virtio_if_t *vif = 0;
126 clib_file_t t = { 0 };
127 clib_error_t *err = 0;
129 char *host_if_name = 0;
133 if (clib_bitmap_get (tm->tap_ids, args->id))
135 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
136 args->error = clib_error_return (0, "interface already exists");
142 args->id = clib_bitmap_first_clear (tm->tap_ids);
145 if (args->id > TAP_MAX_INSTANCE)
147 args->rv = VNET_API_ERROR_UNSPECIFIED;
148 args->error = clib_error_return (0, "cannot find free interface id");
152 clib_memset (&ifr, 0, sizeof (ifr));
153 pool_get (vim->interfaces, vif);
154 vif->dev_instance = vif - vim->interfaces;
158 if ((vif->fd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
160 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
161 args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
165 _IOCTL (vif->fd, VHOST_GET_FEATURES, &vif->remote_features);
167 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
169 args->rv = VNET_API_ERROR_UNSUPPORTED;
170 args->error = clib_error_return (0, "vhost-net backend doesn't support "
171 "VIRTIO_NET_F_MRG_RXBUF feature");
175 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
178 args->rv = VNET_API_ERROR_UNSUPPORTED;
179 args->error = clib_error_return (0, "vhost-net backend doesn't support "
180 "VIRTIO_RING_F_INDIRECT_DESC feature");
184 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1)) == 0)
186 args->rv = VNET_API_ERROR_UNSUPPORTED;
187 args->error = clib_error_return (0, "vhost-net backend doesn't support "
188 "VIRTIO_F_VERSION_1 features");
192 vif->features |= VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
193 vif->features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
194 vif->features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
196 virtio_set_net_hdr_size (vif);
198 _IOCTL (vif->fd, VHOST_SET_FEATURES, &vif->features);
200 if ((vif->tap_fd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
202 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
203 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
207 ifr.ifr_flags = IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR;
208 _IOCTL (vif->tap_fd, TUNSETIFF, (void *) &ifr);
209 vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
211 if (!args->host_if_name)
212 host_if_name = ifr.ifr_ifrn.ifrn_name;
214 host_if_name = (char *) args->host_if_name;
216 unsigned int offload = 0;
217 hdrsz = sizeof (struct virtio_net_hdr_v1);
218 if (args->tap_flags & TAP_FLAG_GSO)
220 offload = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
221 vif->gso_enabled = 1;
225 vif->gso_enabled = 0;
228 _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
229 _IOCTL (vif->tap_fd, TUNSETVNETHDRSZ, &hdrsz);
230 _IOCTL (vif->fd, VHOST_SET_OWNER, 0);
232 /* if namespace is specified, all further netlink messages should be excuted
233 after we change our net namespace */
234 if (args->host_namespace)
236 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
237 if ((fd = open_netns_fd ((char *) args->host_namespace)) == -1)
239 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
240 args->error = clib_error_return_unix (0, "open_netns_fd '%s'",
241 args->host_namespace);
244 args->error = vnet_netlink_set_link_netns (vif->ifindex, fd,
248 args->rv = VNET_API_ERROR_NETLINK_ERROR;
251 if (setns (fd, CLONE_NEWNET) == -1)
253 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
254 args->error = clib_error_return_unix (0, "setns '%s'",
255 args->host_namespace);
258 if ((vif->ifindex = if_nametoindex (host_if_name)) == 0)
260 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
261 args->error = clib_error_return_unix (0, "if_nametoindex '%s'",
270 args->error = vnet_netlink_set_link_name (vif->ifindex,
274 args->rv = VNET_API_ERROR_NETLINK_ERROR;
280 if (!ethernet_mac_address_is_zero (args->host_mac_addr))
282 args->error = vnet_netlink_set_link_addr (vif->ifindex,
283 args->host_mac_addr);
286 args->rv = VNET_API_ERROR_NETLINK_ERROR;
291 if (args->host_bridge)
293 args->error = vnet_netlink_set_link_master (vif->ifindex,
294 (char *) args->host_bridge);
297 args->rv = VNET_API_ERROR_NETLINK_ERROR;
303 if (args->host_ip4_prefix_len)
305 args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
306 &args->host_ip4_addr,
307 args->host_ip4_prefix_len);
310 args->rv = VNET_API_ERROR_NETLINK_ERROR;
315 if (args->host_ip6_prefix_len)
317 args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
318 &args->host_ip6_addr,
319 args->host_ip6_prefix_len);
322 args->rv = VNET_API_ERROR_NETLINK_ERROR;
327 args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
330 args->rv = VNET_API_ERROR_NETLINK_ERROR;
334 if (args->host_ip4_gw_set)
336 args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
339 args->rv = VNET_API_ERROR_NETLINK_ERROR;
344 if (args->host_ip6_gw_set)
346 args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
349 args->rv = VNET_API_ERROR_NETLINK_ERROR;
354 /* switch back to old net namespace */
355 if (args->host_namespace)
357 if (setns (old_netns_fd, CLONE_NEWNET) == -1)
359 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
360 args->error = clib_error_return_unix (0, "setns '%s'",
361 args->host_namespace);
366 if (args->host_mtu_set)
369 vnet_netlink_set_link_mtu (vif->ifindex, args->host_mtu_size);
372 args->rv = VNET_API_ERROR_NETLINK_ERROR;
376 else if (tm->host_mtu_size != 0)
379 vnet_netlink_set_link_mtu (vif->ifindex, tm->host_mtu_size);
382 args->rv = VNET_API_ERROR_NETLINK_ERROR;
385 args->host_mtu_set = 1;
386 args->host_mtu_size = tm->host_mtu_size;
389 /* Set vhost memory table */
390 i = sizeof (struct vhost_memory) + sizeof (struct vhost_memory_region);
391 vhost_mem = clib_mem_alloc (i);
392 clib_memset (vhost_mem, 0, i);
393 vhost_mem->nregions = 1;
394 vhost_mem->regions[0].memory_size = (1ULL << 47) - 4096;
395 _IOCTL (vif->fd, VHOST_SET_MEM_TABLE, vhost_mem);
398 virtio_vring_init (vm, vif, RX_QUEUE (0), args->rx_ring_sz)))
400 args->rv = VNET_API_ERROR_INIT_FAILED;
406 virtio_vring_init (vm, vif, TX_QUEUE (0), args->tx_ring_sz)))
408 args->rv = VNET_API_ERROR_INIT_FAILED;
413 if (!args->mac_addr_set)
414 ethernet_mac_address_generate (args->mac_addr);
416 clib_memcpy (vif->mac_addr, args->mac_addr, 6);
418 vif->host_if_name = format (0, "%s%c", host_if_name, 0);
419 vif->net_ns = format (0, "%s%c", args->host_namespace, 0);
420 vif->host_bridge = format (0, "%s%c", args->host_bridge, 0);
421 vif->host_mtu_size = args->host_mtu_size;
422 clib_memcpy (vif->host_mac_addr, args->host_mac_addr, 6);
423 vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
424 vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
425 if (args->host_ip4_prefix_len)
426 clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
427 if (args->host_ip6_prefix_len)
428 clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
430 vif->type = VIRTIO_IF_TYPE_TAP;
431 args->error = ethernet_register_interface (vnm, virtio_device_class.index,
435 virtio_eth_flag_change);
438 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
442 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
443 sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
444 vif->sw_if_index = sw->sw_if_index;
445 args->sw_if_index = vif->sw_if_index;
447 hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
448 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
449 if (args->tap_flags & TAP_FLAG_GSO)
451 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
452 vnm->interface_main.gso_interface_count++;
454 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
455 virtio_input_node.index);
456 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, 0, ~0);
457 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, 0,
458 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
459 vif->per_interface_next_index = ~0;
460 virtio_vring_set_numa_node (vm, vif, RX_QUEUE (0));
461 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
462 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
463 VNET_HW_INTERFACE_FLAG_LINK_UP);
464 vif->cxq_vring = NULL;
466 t.read_function = call_tap_read_ready;
467 t.error_function = call_tap_error_ready;
468 t.file_descriptor = vif->tap_fd;
469 t.private_data = vif->sw_if_index;
470 t.description = format (0, "tap sw_if_index %u fd: %u",
471 vif->sw_if_index, vif->tap_fd);
472 vif->tap_file_index = clib_file_add (&file_main, &t);
479 ASSERT (args->error == 0);
481 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
483 if (vif->tap_fd != -1)
487 vec_foreach_index (i, vif->rxq_vrings) virtio_vring_free_rx (vm, vif,
489 vec_foreach_index (i, vif->txq_vrings) virtio_vring_free_tx (vm, vif,
491 vec_free (vif->rxq_vrings);
492 vec_free (vif->txq_vrings);
494 vec_free (vif->host_if_name);
495 vec_free (vif->net_ns);
496 vec_free (vif->host_bridge);
498 clib_memset (vif, 0, sizeof (virtio_if_t));
499 pool_put (vim->interfaces, vif);
503 clib_mem_free (vhost_mem);
504 if (old_netns_fd != -1)
505 close (old_netns_fd);
511 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
513 vnet_main_t *vnm = vnet_get_main ();
514 virtio_main_t *mm = &virtio_main;
515 tap_main_t *tm = &tap_main;
518 vnet_hw_interface_t *hw;
520 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
521 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
522 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
524 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
526 if (vif->type != VIRTIO_IF_TYPE_TAP)
527 return VNET_API_ERROR_INVALID_INTERFACE;
529 /* decrement if this was a GSO interface */
530 if (hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO)
531 vnm->interface_main.gso_interface_count--;
533 clib_file_del_by_index (&file_main, vif->tap_file_index);
534 /* bring down the interface */
535 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
536 vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
537 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, RX_QUEUE (0));
539 ethernet_delete_interface (vnm, vif->hw_if_index);
540 vif->hw_if_index = ~0;
542 if (vif->tap_fd != -1)
547 vec_foreach_index (i, vif->rxq_vrings) virtio_vring_free_rx (vm, vif,
549 vec_foreach_index (i, vif->txq_vrings) virtio_vring_free_tx (vm, vif,
551 vec_free (vif->rxq_vrings);
552 vec_free (vif->txq_vrings);
554 vec_free (vif->host_if_name);
555 vec_free (vif->net_ns);
556 vec_free (vif->host_bridge);
558 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
559 clib_memset (vif, 0, sizeof (*vif));
560 pool_put (mm->interfaces, vif);
566 tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index, int enable_disable)
568 vnet_main_t *vnm = vnet_get_main ();
569 virtio_main_t *mm = &virtio_main;
571 vnet_hw_interface_t *hw;
572 clib_error_t *err = 0;
574 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
576 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
577 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
579 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
581 const unsigned int gso_on = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
582 const unsigned int gso_off = 0;
583 unsigned int offload = enable_disable ? gso_on : gso_off;
584 _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
585 vif->gso_enabled = enable_disable ? 1 : 0;
588 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0)
590 vnm->interface_main.gso_interface_count++;
591 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
596 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) != 0)
598 vnm->interface_main.gso_interface_count--;
599 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
606 clib_warning ("Error %s gso on sw_if_index %d",
607 enable_disable ? "enabling" : "disabling", sw_if_index);
608 return VNET_API_ERROR_SYSCALL_ERROR_3;
614 tap_dump_ifs (tap_interface_details_t ** out_tapids)
616 vnet_main_t *vnm = vnet_get_main ();
617 virtio_main_t *mm = &virtio_main;
619 virtio_vring_t *vring;
620 vnet_hw_interface_t *hi;
621 tap_interface_details_t *r_tapids = NULL;
622 tap_interface_details_t *tapid = NULL;
625 pool_foreach (vif, mm->interfaces,
626 if (vif->type != VIRTIO_IF_TYPE_TAP)
628 vec_add2(r_tapids, tapid, 1);
629 clib_memset (tapid, 0, sizeof (*tapid));
631 tapid->sw_if_index = vif->sw_if_index;
632 hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
633 clib_memcpy(tapid->dev_name, hi->name,
634 MIN (ARRAY_LEN (tapid->dev_name) - 1,
635 strlen ((const char *) hi->name)));
636 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS(0));
637 tapid->rx_ring_sz = vring->size;
638 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS(0));
639 tapid->tx_ring_sz = vring->size;
640 clib_memcpy(tapid->host_mac_addr, vif->host_mac_addr, 6);
641 if (vif->host_if_name)
643 clib_memcpy(tapid->host_if_name, vif->host_if_name,
644 MIN (ARRAY_LEN (tapid->host_if_name) - 1,
645 strlen ((const char *) vif->host_if_name)));
649 clib_memcpy(tapid->host_namespace, vif->net_ns,
650 MIN (ARRAY_LEN (tapid->host_namespace) - 1,
651 strlen ((const char *) vif->net_ns)));
653 if (vif->host_bridge)
655 clib_memcpy(tapid->host_bridge, vif->host_bridge,
656 MIN (ARRAY_LEN (tapid->host_bridge) - 1,
657 strlen ((const char *) vif->host_bridge)));
659 if (vif->host_ip4_prefix_len)
660 clib_memcpy(tapid->host_ip4_addr, &vif->host_ip4_addr, 4);
661 tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
662 if (vif->host_ip6_prefix_len)
663 clib_memcpy(tapid->host_ip6_addr, &vif->host_ip6_addr, 16);
664 tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
665 tapid->host_mtu_size = vif->host_mtu_size;
669 *out_tapids = r_tapids;
674 static clib_error_t *
675 tap_mtu_config (vlib_main_t * vm, unformat_input_t * input)
677 tap_main_t *tm = &tap_main;
679 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
681 if (unformat (input, "host-mtu %d", &tm->host_mtu_size))
684 return clib_error_return (0, "unknown input `%U'",
685 format_unformat_error, input);
691 /* tap { host-mtu <size> } configuration. */
692 VLIB_CONFIG_FUNCTION (tap_mtu_config, "tap");
694 static clib_error_t *
695 tap_init (vlib_main_t * vm)
697 tap_main_t *tm = &tap_main;
698 clib_error_t *error = 0;
700 tm->log_default = vlib_log_register_class ("tap", 0);
701 vlib_log_debug (tm->log_default, "initialized");
703 tm->host_mtu_size = 0;
708 VLIB_INIT_FUNCTION (tap_init);
711 * fd.io coding-style-patch-verification: ON
714 * eval: (c-set-style "gnu")