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>
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
62 open_netns_fd (char *netns)
67 if (strncmp (netns, "pid:", 4) == 0)
68 s = format (0, "/proc/%u/ns/net%c", atoi (netns + 4), 0);
69 else if (netns[0] == '/')
70 s = format (0, "%s%c", netns, 0);
72 s = format (0, "/var/run/netns/%s%c", netns, 0);
74 fd = open ((char *) s, O_RDONLY);
79 #define TAP_MAX_INSTANCE 1024
82 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
84 vnet_main_t *vnm = vnet_get_main ();
85 vlib_thread_main_t *thm = vlib_get_thread_main ();
86 virtio_main_t *vim = &virtio_main;
87 tap_main_t *tm = &tap_main;
88 vnet_sw_interface_t *sw;
89 vnet_hw_interface_t *hw;
91 int old_netns_fd = -1;
94 struct vhost_memory *vhost_mem = 0;
96 clib_error_t *err = 0;
100 if (clib_bitmap_get (tm->tap_ids, args->id))
102 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
103 args->error = clib_error_return (0, "interface already exists");
109 args->id = clib_bitmap_first_clear (tm->tap_ids);
112 if (args->id > TAP_MAX_INSTANCE)
114 args->rv = VNET_API_ERROR_UNSPECIFIED;
115 args->error = clib_error_return (0, "cannot find free interface id");
119 memset (&ifr, 0, sizeof (ifr));
120 pool_get (vim->interfaces, vif);
121 vif->dev_instance = vif - vim->interfaces;
125 if ((vif->fd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
127 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
128 args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
132 _IOCTL (vif->fd, VHOST_GET_FEATURES, &vif->remote_features);
134 if ((vif->remote_features & (1ULL << VIRTIO_NET_F_MRG_RXBUF)) == 0)
136 args->rv = VNET_API_ERROR_UNSUPPORTED;
137 args->error = clib_error_return (0, "vhost-net backend doesn't support "
138 "VIRTIO_NET_F_MRG_RXBUF feature");
142 if ((vif->remote_features & (1ULL << VIRTIO_RING_F_INDIRECT_DESC)) == 0)
144 args->rv = VNET_API_ERROR_UNSUPPORTED;
145 args->error = clib_error_return (0, "vhost-net backend doesn't support "
146 "VIRTIO_RING_F_INDIRECT_DESC feature");
150 if ((vif->remote_features & (1ULL << VIRTIO_F_VERSION_1)) == 0)
152 args->rv = VNET_API_ERROR_UNSUPPORTED;
153 args->error = clib_error_return (0, "vhost-net backend doesn't support "
154 "VIRTIO_F_VERSION_1 features");
158 vif->features |= 1ULL << VIRTIO_NET_F_MRG_RXBUF;
159 vif->features |= 1ULL << VIRTIO_F_VERSION_1;
160 vif->features |= 1ULL << VIRTIO_RING_F_INDIRECT_DESC;
162 _IOCTL (vif->fd, VHOST_SET_FEATURES, &vif->features);
164 if ((vif->tap_fd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
166 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
167 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
171 ifr.ifr_flags = IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR;
172 _IOCTL (vif->tap_fd, TUNSETIFF, (void *) &ifr);
173 vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
175 unsigned int offload = 0;
176 hdrsz = sizeof (struct virtio_net_hdr_v1);
177 _IOCTL (vif->tap_fd, TUNSETOFFLOAD, offload);
178 _IOCTL (vif->tap_fd, TUNSETVNETHDRSZ, &hdrsz);
179 _IOCTL (vif->fd, VHOST_SET_OWNER, 0);
181 /* if namespace is specified, all further netlink messages should be excuted
182 after we change our net namespace */
183 if (args->host_namespace)
186 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
187 if ((fd = open_netns_fd ((char *) args->host_namespace)) == -1)
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);
194 args->error = vnet_netlink_set_link_netns (vif->ifindex, fd,
195 (char *) args->host_if_name);
198 args->rv = VNET_API_ERROR_NETLINK_ERROR;
201 if (setns (fd, CLONE_NEWNET) == -1)
203 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
204 args->error = clib_error_return_unix (0, "setns '%s'",
205 args->host_namespace);
209 if ((vif->ifindex = if_nametoindex ((char *) args->host_if_name)) == 0)
211 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
212 args->error = clib_error_return_unix (0, "if_nametoindex '%s'",
219 if (args->host_if_name)
221 args->error = vnet_netlink_set_link_name (vif->ifindex,
226 args->rv = VNET_API_ERROR_NETLINK_ERROR;
232 if (!ethernet_mac_address_is_zero (args->host_mac_addr))
234 args->error = vnet_netlink_set_link_addr (vif->ifindex,
235 args->host_mac_addr);
238 args->rv = VNET_API_ERROR_NETLINK_ERROR;
243 if (args->host_bridge)
245 args->error = vnet_netlink_set_link_master (vif->ifindex,
246 (char *) args->host_bridge);
249 args->rv = VNET_API_ERROR_NETLINK_ERROR;
255 if (args->host_ip4_prefix_len)
257 args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
258 &args->host_ip4_addr,
259 args->host_ip4_prefix_len);
262 args->rv = VNET_API_ERROR_NETLINK_ERROR;
267 if (args->host_ip6_prefix_len)
269 args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
270 &args->host_ip6_addr,
271 args->host_ip6_prefix_len);
274 args->rv = VNET_API_ERROR_NETLINK_ERROR;
279 args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
282 args->rv = VNET_API_ERROR_NETLINK_ERROR;
286 if (args->host_ip4_gw_set)
288 args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
291 args->rv = VNET_API_ERROR_NETLINK_ERROR;
296 if (args->host_ip6_gw_set)
298 args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
301 args->rv = VNET_API_ERROR_NETLINK_ERROR;
306 /* switch back to old net namespace */
307 if (args->host_namespace)
309 if (setns (old_netns_fd, CLONE_NEWNET) == -1)
311 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
312 args->error = clib_error_return_unix (0, "setns '%s'",
313 args->host_namespace);
318 /* Set vhost memory table */
319 i = sizeof (struct vhost_memory) + sizeof (struct vhost_memory_region);
320 vhost_mem = clib_mem_alloc (i);
321 memset (vhost_mem, 0, i);
322 vhost_mem->nregions = 1;
323 vhost_mem->regions[0].memory_size = (1ULL << 47) - 4096;
324 _IOCTL (vif->fd, VHOST_SET_MEM_TABLE, vhost_mem);
326 if ((args->error = virtio_vring_init (vm, vif, 0, args->rx_ring_sz)))
328 args->rv = VNET_API_ERROR_INIT_FAILED;
332 if ((args->error = virtio_vring_init (vm, vif, 1, args->tx_ring_sz)))
334 args->rv = VNET_API_ERROR_INIT_FAILED;
338 if (!args->mac_addr_set)
340 f64 now = vlib_time_now (vm);
342 rnd = (u32) (now * 1e6);
343 rnd = random_u32 (&rnd);
345 memcpy (args->mac_addr + 2, &rnd, sizeof (rnd));
346 args->mac_addr[0] = 2;
347 args->mac_addr[1] = 0xfe;
349 vif->rx_ring_sz = args->rx_ring_sz != 0 ? args->rx_ring_sz : 256;
350 vif->tx_ring_sz = args->tx_ring_sz != 0 ? args->tx_ring_sz : 256;
351 vif->host_if_name = args->host_if_name;
352 args->host_if_name = 0;
353 vif->net_ns = args->host_namespace;
354 args->host_namespace = 0;
355 vif->host_bridge = args->host_bridge;
356 args->host_bridge = 0;
357 clib_memcpy (vif->host_mac_addr, args->host_mac_addr, 6);
358 vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
359 vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
360 if (args->host_ip4_prefix_len)
361 clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
362 if (args->host_ip6_prefix_len)
363 clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
365 args->error = ethernet_register_interface (vnm, virtio_device_class.index,
369 virtio_eth_flag_change);
372 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
376 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
377 sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
378 vif->sw_if_index = sw->sw_if_index;
379 args->sw_if_index = vif->sw_if_index;
380 hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
381 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
382 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
383 virtio_input_node.index);
384 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, 0, ~0);
385 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, 0,
386 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
387 vif->per_interface_next_index = ~0;
388 vif->type = VIRTIO_IF_TYPE_TAP;
389 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
390 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
391 VNET_HW_INTERFACE_FLAG_LINK_UP);
392 if (thm->n_vlib_mains > 1)
393 clib_spinlock_init (&vif->lockp);
399 ASSERT (args->error == 0);
401 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
403 if (vif->tap_fd != -1)
407 vec_foreach_index (i, vif->vrings) virtio_vring_free (vm, vif, i);
408 vec_free (vif->vrings);
409 memset (vif, 0, sizeof (virtio_if_t));
410 pool_put (vim->interfaces, vif);
414 clib_mem_free (vhost_mem);
415 if (old_netns_fd != -1)
416 close (old_netns_fd);
420 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
422 vnet_main_t *vnm = vnet_get_main ();
423 virtio_main_t *mm = &virtio_main;
424 tap_main_t *tm = &tap_main;
427 vnet_hw_interface_t *hw;
429 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
430 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
431 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
433 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
435 /* bring down the interface */
436 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
437 vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
438 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, 0);
440 ethernet_delete_interface (vnm, vif->hw_if_index);
441 vif->hw_if_index = ~0;
443 if (vif->tap_fd != -1)
448 vec_foreach_index (i, vif->vrings) virtio_vring_free (vm, vif, i);
449 vec_free (vif->vrings);
451 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
452 clib_spinlock_free (&vif->lockp);
453 memset (vif, 0, sizeof (*vif));
454 pool_put (mm->interfaces, vif);
460 tap_dump_ifs (tap_interface_details_t ** out_tapids)
462 vnet_main_t *vnm = vnet_get_main ();
463 virtio_main_t *mm = &virtio_main;
465 vnet_hw_interface_t *hi;
466 tap_interface_details_t *r_tapids = NULL;
467 tap_interface_details_t *tapid = NULL;
470 pool_foreach (vif, mm->interfaces,
471 vec_add2(r_tapids, tapid, 1);
472 memset (tapid, 0, sizeof (*tapid));
474 tapid->sw_if_index = vif->sw_if_index;
475 hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
476 clib_memcpy(tapid->dev_name, hi->name,
477 MIN (ARRAY_LEN (tapid->dev_name) - 1,
478 strlen ((const char *) hi->name)));
479 tapid->rx_ring_sz = vif->rx_ring_sz;
480 tapid->tx_ring_sz = vif->tx_ring_sz;
481 clib_memcpy(tapid->host_mac_addr, vif->host_mac_addr, 6);
482 if (vif->host_if_name)
484 clib_memcpy(tapid->host_if_name, vif->host_if_name,
485 MIN (ARRAY_LEN (tapid->host_if_name) - 1,
486 strlen ((const char *) vif->host_if_name)));
490 clib_memcpy(tapid->host_namespace, vif->net_ns,
491 MIN (ARRAY_LEN (tapid->host_namespace) - 1,
492 strlen ((const char *) vif->net_ns)));
494 if (vif->host_bridge)
496 clib_memcpy(tapid->host_bridge, vif->host_bridge,
497 MIN (ARRAY_LEN (tapid->host_bridge) - 1,
498 strlen ((const char *) vif->host_bridge)));
500 if (vif->host_ip4_prefix_len)
501 clib_memcpy(tapid->host_ip4_addr, &vif->host_ip4_addr, 4);
502 tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
503 if (vif->host_ip6_prefix_len)
504 clib_memcpy(tapid->host_ip6_addr, &vif->host_ip6_addr, 16);
505 tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
509 *out_tapids = r_tapids;
514 #define vlib_log_info(...) vlib_log(VLIB_LOG_LEVEL_INFO, __VA_ARGS__)
516 static clib_error_t *
517 tap_init (vlib_main_t * vm)
519 tap_main_t *tm = &tap_main;
521 error = vlib_call_init_function (vm, vlib_log_init);
525 tm->log_default = vlib_log_register_class ("tap", 0);
526 vlib_log_info (tm->log_default, "initialized");
531 VLIB_INIT_FUNCTION (tap_init);
534 * fd.io coding-style-patch-verification: ON
537 * eval: (c-set-style "gnu")