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/physmem.h>
35 #include <vlib/unix/unix.h>
36 #include <vnet/ethernet/ethernet.h>
37 #include <vnet/ip/ip4_packet.h>
38 #include <vnet/ip/ip6_packet.h>
39 #include <vnet/devices/netlink.h>
40 #include <vnet/devices/virtio/virtio.h>
41 #include <vnet/devices/tap/tap.h>
45 #define _IOCTL(fd,a,...) \
46 if (ioctl (fd, a, __VA_ARGS__) < 0) \
48 err = clib_error_return_unix (0, "ioctl(" #a ")"); \
53 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
57 //TODO On MTU change call vnet_netlink_set_if_mtu
61 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
64 call_tap_read_ready (clib_file_t * uf)
71 tap_delete_if_cp (u32 * sw_if_index)
73 vlib_main_t *vm = vlib_get_main ();
74 tap_delete_if (vm, *sw_if_index);
78 * Tap clean-up routine:
79 * Linux side of tap interface can be deleted i.e. tap is
80 * attached to container and if someone will delete this
81 * container, will also removes tap interface. While VPP
82 * will have other side of tap. This function will RPC
83 * main thread to call the tap_delete_if to cleanup tap.
86 call_tap_error_ready (clib_file_t * uf)
88 vl_api_rpc_call_main_thread (tap_delete_if_cp, (u8 *) & uf->private_data,
89 sizeof (uf->private_data));
94 open_netns_fd (char *netns)
99 if (strncmp (netns, "pid:", 4) == 0)
100 s = format (0, "/proc/%u/ns/net%c", atoi (netns + 4), 0);
101 else if (netns[0] == '/')
102 s = format (0, "%s%c", netns, 0);
104 s = format (0, "/var/run/netns/%s%c", netns, 0);
106 fd = open ((char *) s, O_RDONLY);
111 #define TAP_MAX_INSTANCE 1024
114 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
116 vlib_physmem_main_t *vpm = &vm->physmem_main;
117 vnet_main_t *vnm = vnet_get_main ();
118 virtio_main_t *vim = &virtio_main;
119 tap_main_t *tm = &tap_main;
120 vnet_sw_interface_t *sw;
121 vnet_hw_interface_t *hw;
123 int old_netns_fd = -1;
126 struct vhost_memory *vhost_mem = 0;
127 virtio_if_t *vif = 0;
128 clib_file_t t = { 0 };
129 clib_error_t *err = 0;
131 char *host_if_name = 0;
135 if (clib_bitmap_get (tm->tap_ids, args->id))
137 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
138 args->error = clib_error_return (0, "interface already exists");
144 args->id = clib_bitmap_first_clear (tm->tap_ids);
147 if (args->id > TAP_MAX_INSTANCE)
149 args->rv = VNET_API_ERROR_UNSPECIFIED;
150 args->error = clib_error_return (0, "cannot find free interface id");
154 clib_memset (&ifr, 0, sizeof (ifr));
155 pool_get (vim->interfaces, vif);
156 vif->dev_instance = vif - vim->interfaces;
160 if ((vif->fd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
162 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
163 args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
167 _IOCTL (vif->fd, VHOST_GET_FEATURES, &vif->remote_features);
169 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
171 args->rv = VNET_API_ERROR_UNSUPPORTED;
172 args->error = clib_error_return (0, "vhost-net backend doesn't support "
173 "VIRTIO_NET_F_MRG_RXBUF feature");
177 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
180 args->rv = VNET_API_ERROR_UNSUPPORTED;
181 args->error = clib_error_return (0, "vhost-net backend doesn't support "
182 "VIRTIO_RING_F_INDIRECT_DESC feature");
186 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1)) == 0)
188 args->rv = VNET_API_ERROR_UNSUPPORTED;
189 args->error = clib_error_return (0, "vhost-net backend doesn't support "
190 "VIRTIO_F_VERSION_1 features");
194 vif->features |= VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
195 vif->features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
196 vif->features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
198 virtio_set_net_hdr_size (vif);
200 _IOCTL (vif->fd, VHOST_SET_FEATURES, &vif->features);
202 if ((vif->tap_fd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
204 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
205 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
209 ifr.ifr_flags = IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR;
210 _IOCTL (vif->tap_fd, TUNSETIFF, (void *) &ifr);
211 vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
213 if (!args->host_if_name)
214 host_if_name = ifr.ifr_ifrn.ifrn_name;
216 host_if_name = (char *) args->host_if_name;
218 unsigned int offload = 0;
219 hdrsz = sizeof (struct virtio_net_hdr_v1);
220 if (args->tap_flags & TAP_FLAG_GSO)
222 offload = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
223 vif->gso_enabled = 1;
227 vif->gso_enabled = 0;
230 _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
231 _IOCTL (vif->tap_fd, TUNSETVNETHDRSZ, &hdrsz);
232 _IOCTL (vif->fd, VHOST_SET_OWNER, 0);
234 /* if namespace is specified, all further netlink messages should be excuted
235 after we change our net namespace */
236 if (args->host_namespace)
238 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
239 if ((fd = open_netns_fd ((char *) args->host_namespace)) == -1)
241 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
242 args->error = clib_error_return_unix (0, "open_netns_fd '%s'",
243 args->host_namespace);
246 args->error = vnet_netlink_set_link_netns (vif->ifindex, fd,
250 args->rv = VNET_API_ERROR_NETLINK_ERROR;
253 if (setns (fd, CLONE_NEWNET) == -1)
255 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
256 args->error = clib_error_return_unix (0, "setns '%s'",
257 args->host_namespace);
260 if ((vif->ifindex = if_nametoindex (host_if_name)) == 0)
262 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
263 args->error = clib_error_return_unix (0, "if_nametoindex '%s'",
272 args->error = vnet_netlink_set_link_name (vif->ifindex,
276 args->rv = VNET_API_ERROR_NETLINK_ERROR;
282 if (!ethernet_mac_address_is_zero (args->host_mac_addr))
284 args->error = vnet_netlink_set_link_addr (vif->ifindex,
285 args->host_mac_addr);
288 args->rv = VNET_API_ERROR_NETLINK_ERROR;
293 if (args->host_bridge)
295 args->error = vnet_netlink_set_link_master (vif->ifindex,
296 (char *) args->host_bridge);
299 args->rv = VNET_API_ERROR_NETLINK_ERROR;
305 if (args->host_ip4_prefix_len)
307 args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
308 &args->host_ip4_addr,
309 args->host_ip4_prefix_len);
312 args->rv = VNET_API_ERROR_NETLINK_ERROR;
317 if (args->host_ip6_prefix_len)
319 args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
320 &args->host_ip6_addr,
321 args->host_ip6_prefix_len);
324 args->rv = VNET_API_ERROR_NETLINK_ERROR;
329 args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
332 args->rv = VNET_API_ERROR_NETLINK_ERROR;
336 if (args->host_ip4_gw_set)
338 args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
341 args->rv = VNET_API_ERROR_NETLINK_ERROR;
346 if (args->host_ip6_gw_set)
348 args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
351 args->rv = VNET_API_ERROR_NETLINK_ERROR;
356 /* switch back to old net namespace */
357 if (args->host_namespace)
359 if (setns (old_netns_fd, CLONE_NEWNET) == -1)
361 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
362 args->error = clib_error_return_unix (0, "setns '%s'",
363 args->host_namespace);
368 if (args->host_mtu_set)
371 vnet_netlink_set_link_mtu (vif->ifindex, args->host_mtu_size);
374 args->rv = VNET_API_ERROR_NETLINK_ERROR;
378 else if (tm->host_mtu_size != 0)
381 vnet_netlink_set_link_mtu (vif->ifindex, tm->host_mtu_size);
384 args->rv = VNET_API_ERROR_NETLINK_ERROR;
387 args->host_mtu_set = 1;
388 args->host_mtu_size = tm->host_mtu_size;
391 /* Set vhost memory table */
392 i = sizeof (struct vhost_memory) + sizeof (struct vhost_memory_region);
393 vhost_mem = clib_mem_alloc (i);
394 clib_memset (vhost_mem, 0, i);
395 vhost_mem->nregions = 1;
396 vhost_mem->regions[0].memory_size = vpm->max_size;
397 vhost_mem->regions[0].guest_phys_addr = vpm->base_addr;
398 vhost_mem->regions[0].userspace_addr =
399 vhost_mem->regions[0].guest_phys_addr;
400 _IOCTL (vif->fd, VHOST_SET_MEM_TABLE, vhost_mem);
403 virtio_vring_init (vm, vif, RX_QUEUE (0), args->rx_ring_sz)))
405 args->rv = VNET_API_ERROR_INIT_FAILED;
411 virtio_vring_init (vm, vif, TX_QUEUE (0), args->tx_ring_sz)))
413 args->rv = VNET_API_ERROR_INIT_FAILED;
418 if (!args->mac_addr_set)
419 ethernet_mac_address_generate (args->mac_addr);
421 clib_memcpy (vif->mac_addr, args->mac_addr, 6);
423 vif->host_if_name = format (0, "%s%c", host_if_name, 0);
424 vif->net_ns = format (0, "%s%c", args->host_namespace, 0);
425 vif->host_bridge = format (0, "%s%c", args->host_bridge, 0);
426 vif->host_mtu_size = args->host_mtu_size;
427 clib_memcpy (vif->host_mac_addr, args->host_mac_addr, 6);
428 vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
429 vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
430 if (args->host_ip4_prefix_len)
431 clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
432 if (args->host_ip6_prefix_len)
433 clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
435 vif->type = VIRTIO_IF_TYPE_TAP;
436 args->error = ethernet_register_interface (vnm, virtio_device_class.index,
440 virtio_eth_flag_change);
443 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
447 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
448 sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
449 vif->sw_if_index = sw->sw_if_index;
450 args->sw_if_index = vif->sw_if_index;
452 hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
453 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
454 if (args->tap_flags & TAP_FLAG_GSO)
456 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
457 vnm->interface_main.gso_interface_count++;
459 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
460 virtio_input_node.index);
461 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, 0, ~0);
462 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, 0,
463 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
464 vif->per_interface_next_index = ~0;
465 virtio_vring_set_numa_node (vm, vif, RX_QUEUE (0));
466 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
467 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
468 VNET_HW_INTERFACE_FLAG_LINK_UP);
469 vif->cxq_vring = NULL;
471 t.read_function = call_tap_read_ready;
472 t.error_function = call_tap_error_ready;
473 t.file_descriptor = vif->tap_fd;
474 t.private_data = vif->sw_if_index;
475 t.description = format (0, "tap sw_if_index %u fd: %u",
476 vif->sw_if_index, vif->tap_fd);
477 vif->tap_file_index = clib_file_add (&file_main, &t);
484 ASSERT (args->error == 0);
486 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
488 if (vif->tap_fd != -1)
492 vec_foreach_index (i, vif->rxq_vrings) virtio_vring_free_rx (vm, vif,
494 vec_foreach_index (i, vif->txq_vrings) virtio_vring_free_tx (vm, vif,
496 vec_free (vif->rxq_vrings);
497 vec_free (vif->txq_vrings);
499 vec_free (vif->host_if_name);
500 vec_free (vif->net_ns);
501 vec_free (vif->host_bridge);
503 clib_memset (vif, 0, sizeof (virtio_if_t));
504 pool_put (vim->interfaces, vif);
508 clib_mem_free (vhost_mem);
509 if (old_netns_fd != -1)
510 close (old_netns_fd);
516 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
518 vnet_main_t *vnm = vnet_get_main ();
519 virtio_main_t *mm = &virtio_main;
520 tap_main_t *tm = &tap_main;
523 vnet_hw_interface_t *hw;
525 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
526 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
527 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
529 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
531 if (vif->type != VIRTIO_IF_TYPE_TAP)
532 return VNET_API_ERROR_INVALID_INTERFACE;
534 /* decrement if this was a GSO interface */
535 if (hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO)
536 vnm->interface_main.gso_interface_count--;
538 clib_file_del_by_index (&file_main, vif->tap_file_index);
539 /* bring down the interface */
540 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
541 vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
542 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, RX_QUEUE (0));
544 ethernet_delete_interface (vnm, vif->hw_if_index);
545 vif->hw_if_index = ~0;
547 if (vif->tap_fd != -1)
552 vec_foreach_index (i, vif->rxq_vrings) virtio_vring_free_rx (vm, vif,
554 vec_foreach_index (i, vif->txq_vrings) virtio_vring_free_tx (vm, vif,
556 vec_free (vif->rxq_vrings);
557 vec_free (vif->txq_vrings);
559 vec_free (vif->host_if_name);
560 vec_free (vif->net_ns);
561 vec_free (vif->host_bridge);
563 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
564 clib_memset (vif, 0, sizeof (*vif));
565 pool_put (mm->interfaces, vif);
571 tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index, int enable_disable)
573 vnet_main_t *vnm = vnet_get_main ();
574 virtio_main_t *mm = &virtio_main;
576 vnet_hw_interface_t *hw;
577 clib_error_t *err = 0;
579 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
581 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
582 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
584 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
586 const unsigned int gso_on = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
587 const unsigned int gso_off = 0;
588 unsigned int offload = enable_disable ? gso_on : gso_off;
589 _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
590 vif->gso_enabled = enable_disable ? 1 : 0;
593 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0)
595 vnm->interface_main.gso_interface_count++;
596 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
601 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) != 0)
603 vnm->interface_main.gso_interface_count--;
604 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
611 clib_warning ("Error %s gso on sw_if_index %d",
612 enable_disable ? "enabling" : "disabling", sw_if_index);
613 return VNET_API_ERROR_SYSCALL_ERROR_3;
619 tap_dump_ifs (tap_interface_details_t ** out_tapids)
621 vnet_main_t *vnm = vnet_get_main ();
622 virtio_main_t *mm = &virtio_main;
624 virtio_vring_t *vring;
625 vnet_hw_interface_t *hi;
626 tap_interface_details_t *r_tapids = NULL;
627 tap_interface_details_t *tapid = NULL;
630 pool_foreach (vif, mm->interfaces,
631 if (vif->type != VIRTIO_IF_TYPE_TAP)
633 vec_add2(r_tapids, tapid, 1);
634 clib_memset (tapid, 0, sizeof (*tapid));
636 tapid->sw_if_index = vif->sw_if_index;
637 hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
638 clib_memcpy(tapid->dev_name, hi->name,
639 MIN (ARRAY_LEN (tapid->dev_name) - 1,
640 strlen ((const char *) hi->name)));
641 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS(0));
642 tapid->rx_ring_sz = vring->size;
643 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS(0));
644 tapid->tx_ring_sz = vring->size;
645 clib_memcpy(tapid->host_mac_addr, vif->host_mac_addr, 6);
646 if (vif->host_if_name)
648 clib_memcpy(tapid->host_if_name, vif->host_if_name,
649 MIN (ARRAY_LEN (tapid->host_if_name) - 1,
650 strlen ((const char *) vif->host_if_name)));
654 clib_memcpy(tapid->host_namespace, vif->net_ns,
655 MIN (ARRAY_LEN (tapid->host_namespace) - 1,
656 strlen ((const char *) vif->net_ns)));
658 if (vif->host_bridge)
660 clib_memcpy(tapid->host_bridge, vif->host_bridge,
661 MIN (ARRAY_LEN (tapid->host_bridge) - 1,
662 strlen ((const char *) vif->host_bridge)));
664 if (vif->host_ip4_prefix_len)
665 clib_memcpy(tapid->host_ip4_addr, &vif->host_ip4_addr, 4);
666 tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
667 if (vif->host_ip6_prefix_len)
668 clib_memcpy(tapid->host_ip6_addr, &vif->host_ip6_addr, 16);
669 tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
670 tapid->host_mtu_size = vif->host_mtu_size;
674 *out_tapids = r_tapids;
679 static clib_error_t *
680 tap_mtu_config (vlib_main_t * vm, unformat_input_t * input)
682 tap_main_t *tm = &tap_main;
684 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
686 if (unformat (input, "host-mtu %d", &tm->host_mtu_size))
689 return clib_error_return (0, "unknown input `%U'",
690 format_unformat_error, input);
696 /* tap { host-mtu <size> } configuration. */
697 VLIB_CONFIG_FUNCTION (tap_mtu_config, "tap");
699 static clib_error_t *
700 tap_init (vlib_main_t * vm)
702 tap_main_t *tm = &tap_main;
703 clib_error_t *error = 0;
705 tm->log_default = vlib_log_register_class ("tap", 0);
706 vlib_log_debug (tm->log_default, "initialized");
708 tm->host_mtu_size = 0;
713 VLIB_INIT_FUNCTION (tap_init);
716 * fd.io coding-style-patch-verification: ON
719 * eval: (c-set-style "gnu")