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>
21 #include <sys/socket.h>
24 #include <linux/if_tun.h>
25 #include <sys/ioctl.h>
26 #include <linux/ethtool.h>
27 #include <linux/sockios.h>
28 #include <sys/eventfd.h>
29 #include <net/if_arp.h>
33 #include <linux/netlink.h>
34 #include <linux/rtnetlink.h>
36 #include <vlib/vlib.h>
37 #include <vlib/physmem.h>
38 #include <vlib/unix/unix.h>
39 #include <vnet/ethernet/ethernet.h>
40 #include <vnet/ip/ip4_packet.h>
41 #include <vnet/ip/ip6_packet.h>
42 #include <vnet/devices/netlink.h>
43 #include <vnet/devices/virtio/virtio.h>
44 #include <vnet/devices/tap/tap.h>
48 #define tap_log_err(dev, f, ...) \
49 vlib_log (VLIB_LOG_LEVEL_ERR, tap_main.log_default, "tap%u: " f, dev->dev_instance, ## __VA_ARGS__)
50 #define tap_log_dbg(dev, f, ...) \
51 vlib_log (VLIB_LOG_LEVEL_DEBUG, tap_main.log_default, "tap%u: " f, dev->dev_instance, ## __VA_ARGS__)
53 #define _IOCTL(fd,a,...) \
54 if (ioctl (fd, a, __VA_ARGS__) < 0) \
56 err = clib_error_return_unix (0, "ioctl(" #a ")"); \
57 tap_log_err (vif, "%U", format_clib_error, err); \
62 VNET_HW_INTERFACE_CLASS (tun_device_hw_interface_class, static) =
65 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
70 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
74 //TODO On MTU change call vnet_netlink_set_if_mtu
79 open_netns_fd (char *netns)
84 if (strncmp (netns, "pid:", 4) == 0)
85 s = format (0, "/proc/%u/ns/net%c", atoi (netns + 4), 0);
86 else if (netns[0] == '/')
87 s = format (0, "%s%c", netns, 0);
89 s = format (0, "/var/run/netns/%s%c", netns, 0);
91 fd = open ((char *) s, O_RDONLY);
96 #define TAP_MAX_INSTANCE 1024
99 tap_free (vlib_main_t * vm, virtio_if_t * vif)
101 virtio_main_t *mm = &virtio_main;
102 tap_main_t *tm = &tap_main;
103 clib_error_t *err = 0;
107 vec_foreach_index (i, vif->vhost_fds) if (vif->vhost_fds[i] != -1)
108 close (vif->vhost_fds[i]);
109 vec_foreach_index (i, vif->rxq_vrings)
110 virtio_vring_free_rx (vm, vif, RX_QUEUE (i));
111 vec_foreach_index (i, vif->txq_vrings)
112 virtio_vring_free_tx (vm, vif, TX_QUEUE (i));
117 _IOCTL (vif->tap_fds[0], TUNSETPERSIST, (void *) (uintptr_t) 0);
118 tap_log_dbg (vif, "TUNSETPERSIST: unset");
121 vec_foreach_index (i, vif->tap_fds) close (vif->tap_fds[i]);
123 vec_free (vif->vhost_fds);
124 vec_free (vif->rxq_vrings);
125 vec_free (vif->txq_vrings);
126 vec_free (vif->host_if_name);
127 vec_free (vif->net_ns);
128 vec_free (vif->host_bridge);
129 clib_error_free (vif->error);
131 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
132 clib_memset (vif, 0, sizeof (*vif));
133 pool_put (mm->interfaces, vif);
137 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
139 vlib_thread_main_t *thm = vlib_get_thread_main ();
140 vlib_physmem_main_t *vpm = &vm->physmem_main;
141 vnet_main_t *vnm = vnet_get_main ();
142 virtio_main_t *vim = &virtio_main;
143 tap_main_t *tm = &tap_main;
144 vnet_sw_interface_t *sw;
145 vnet_hw_interface_t *hw;
146 int i, num_vhost_queues;
147 int old_netns_fd = -1;
148 struct ifreq ifr = {.ifr_flags = IFF_NO_PI | IFF_VNET_HDR };
149 struct ifreq get_ifr = {.ifr_flags = 0 };
151 vhost_memory_t *vhost_mem = 0;
152 virtio_if_t *vif = 0;
153 clib_error_t *err = 0;
154 unsigned int tap_features;
155 int tfd = -1, qfd = -1, vfd = -1, nfd = -1;
156 char *host_if_name = 0;
157 unsigned int offload = 0;
162 if (clib_bitmap_get (tm->tap_ids, args->id))
164 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
165 args->error = clib_error_return (0, "interface already exists");
171 args->id = clib_bitmap_first_clear (tm->tap_ids);
174 if (args->id > TAP_MAX_INSTANCE)
176 args->rv = VNET_API_ERROR_UNSPECIFIED;
177 args->error = clib_error_return (0, "cannot find free interface id");
181 pool_get_zero (vim->interfaces, vif);
183 if (args->tap_flags & TAP_FLAG_TUN)
185 vif->type = VIRTIO_IF_TYPE_TUN;
186 ifr.ifr_flags |= IFF_TUN;
189 * From kernel 4.20, xdp support has been added in tun_sendmsg.
190 * If sndbuf == INT_MAX, vhost batches the packet and processes
191 * them using xdp data path for tun driver. It assumes packets
192 * are ethernet frames (It needs to be fixed).
193 * To avoid xdp data path in tun driver, sndbuf value should
196 sndbuf = INT_MAX - 1;
200 vif->type = VIRTIO_IF_TYPE_TAP;
201 ifr.ifr_flags |= IFF_TAP;
205 vif->dev_instance = vif - vim->interfaces;
207 vif->num_txqs = thm->n_vlib_mains;
208 vif->num_rxqs = clib_max (args->num_rx_queues, 1);
210 if (args->tap_flags & TAP_FLAG_ATTACH)
212 if (args->host_if_name != NULL)
214 host_if_name = (char *) args->host_if_name;
215 clib_memcpy (ifr.ifr_name, host_if_name,
216 clib_min (IFNAMSIZ, vec_len (host_if_name)));
220 args->rv = VNET_API_ERROR_NO_MATCHING_INTERFACE;
221 err = clib_error_return (0, "host_if_name is not provided");
224 if (args->host_namespace)
226 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
227 if ((nfd = open_netns_fd ((char *) args->host_namespace)) == -1)
229 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
230 args->error = clib_error_return_unix (0, "open_netns_fd '%s'",
231 args->host_namespace);
234 if (setns (nfd, CLONE_NEWNET) == -1)
236 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
237 args->error = clib_error_return_unix (0, "setns '%s'",
238 args->host_namespace);
244 if ((tfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
246 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
247 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
250 vec_add1 (vif->tap_fds, tfd);
251 tap_log_dbg (vif, "open tap fd %d", tfd);
253 _IOCTL (tfd, TUNGETFEATURES, &tap_features);
254 tap_log_dbg (vif, "TUNGETFEATURES: features 0x%lx", tap_features);
255 if ((tap_features & IFF_VNET_HDR) == 0)
257 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
258 args->error = clib_error_return (0, "vhost-net backend not available");
262 if ((tap_features & IFF_MULTI_QUEUE) == 0)
264 if (vif->num_rxqs > 1)
266 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
267 args->error = clib_error_return (0, "multiqueue not supported");
270 vif->num_rxqs = vif->num_txqs = 1;
273 ifr.ifr_flags |= IFF_MULTI_QUEUE;
275 hdrsz = sizeof (virtio_net_hdr_v1_t);
276 if (args->tap_flags & TAP_FLAG_GSO)
278 offload = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
279 vif->gso_enabled = 1;
281 else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
283 offload = TUN_F_CSUM;
284 vif->csum_offload_enabled = 1;
287 _IOCTL (tfd, TUNSETIFF, (void *) &ifr);
288 tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", tfd,
289 ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
291 vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
292 tap_log_dbg (vif, "ifindex %d", vif->ifindex);
294 if (!args->host_if_name)
295 host_if_name = ifr.ifr_ifrn.ifrn_name;
297 host_if_name = (char *) args->host_if_name;
300 * unset the persistence when attaching to existing
303 if (args->tap_flags & TAP_FLAG_ATTACH)
305 _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 0);
306 tap_log_dbg (vif, "TUNSETPERSIST: unset");
309 /* set the persistence */
310 if (args->tap_flags & TAP_FLAG_PERSIST)
312 _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 1);
313 tap_log_dbg (vif, "TUNSETPERSIST: set");
315 /* verify persistence is set, read the flags */
316 _IOCTL (tfd, TUNGETIFF, (void *) &get_ifr);
317 tap_log_dbg (vif, "TUNGETIFF: flags 0x%lx", get_ifr.ifr_flags);
318 if ((get_ifr.ifr_flags & IFF_PERSIST) == 0)
320 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
321 args->error = clib_error_return (0, "persistence not supported");
326 /* create additional queues on the linux side.
327 * we create as many linux queue pairs as we have rx queues
329 for (i = 1; i < vif->num_rxqs; i++)
331 if ((qfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
333 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
334 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
337 _IOCTL (qfd, TUNSETIFF, (void *) &ifr);
338 tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", qfd,
339 ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
340 vec_add1 (vif->tap_fds, qfd);
343 for (i = 0; i < vif->num_rxqs; i++)
345 tap_log_dbg (vif, "TUNSETVNETHDRSZ: fd %d vnet_hdr_sz %u",
346 vif->tap_fds[i], hdrsz);
347 _IOCTL (vif->tap_fds[i], TUNSETVNETHDRSZ, &hdrsz);
349 tap_log_dbg (vif, "TUNSETSNDBUF: fd %d sndbuf %d", vif->tap_fds[i],
351 _IOCTL (vif->tap_fds[i], TUNSETSNDBUF, &sndbuf);
353 tap_log_dbg (vif, "TUNSETOFFLOAD: fd %d offload 0x%lx", vif->tap_fds[i],
355 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
357 if (fcntl (vif->tap_fds[i], F_SETFL, O_NONBLOCK) < 0)
359 err = clib_error_return_unix (0, "fcntl(tfd, F_SETFL, O_NONBLOCK)");
360 tap_log_err (vif, "set nonblocking: %U", format_clib_error, err);
365 /* open as many vhost-net fds as required and set ownership */
366 num_vhost_queues = clib_max (vif->num_rxqs, vif->num_txqs);
367 for (i = 0; i < num_vhost_queues; i++)
369 if ((vfd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
371 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
372 args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
375 vec_add1 (vif->vhost_fds, vfd);
376 virtio_log_debug (vif, "open vhost-net fd %d qpair %u", vfd, i);
377 _IOCTL (vfd, VHOST_SET_OWNER, 0);
378 virtio_log_debug (vif, "VHOST_SET_OWNER: fd %u", vfd);
381 _IOCTL (vif->vhost_fds[0], VHOST_GET_FEATURES, &vif->remote_features);
382 virtio_log_debug (vif, "VHOST_GET_FEATURES: features 0x%lx",
383 vif->remote_features);
385 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
387 args->rv = VNET_API_ERROR_UNSUPPORTED;
388 args->error = clib_error_return (0, "vhost-net backend doesn't support "
389 "VIRTIO_NET_F_MRG_RXBUF feature");
393 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
396 args->rv = VNET_API_ERROR_UNSUPPORTED;
397 args->error = clib_error_return (0, "vhost-net backend doesn't support "
398 "VIRTIO_RING_F_INDIRECT_DESC feature");
402 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1)) == 0)
404 args->rv = VNET_API_ERROR_UNSUPPORTED;
405 args->error = clib_error_return (0, "vhost-net backend doesn't support "
406 "VIRTIO_F_VERSION_1 features");
410 vif->features |= VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
411 vif->features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
412 vif->features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
414 virtio_set_net_hdr_size (vif);
416 if (!(args->tap_flags & TAP_FLAG_ATTACH))
418 /* if namespace is specified, all further netlink messages should be executed
419 after we change our net namespace */
420 if (args->host_namespace)
422 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
423 if ((nfd = open_netns_fd ((char *) args->host_namespace)) == -1)
425 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
426 args->error = clib_error_return_unix (0, "open_netns_fd '%s'",
427 args->host_namespace);
430 args->error = vnet_netlink_set_link_netns (vif->ifindex, nfd,
434 args->rv = VNET_API_ERROR_NETLINK_ERROR;
437 if (setns (nfd, CLONE_NEWNET) == -1)
439 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
440 args->error = clib_error_return_unix (0, "setns '%s'",
441 args->host_namespace);
444 if ((vif->ifindex = if_nametoindex (host_if_name)) == 0)
446 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
447 args->error = clib_error_return_unix (0, "if_nametoindex '%s'",
452 else if (host_if_name)
455 vnet_netlink_set_link_name (vif->ifindex, host_if_name);
458 args->rv = VNET_API_ERROR_NETLINK_ERROR;
464 if (vif->type == VIRTIO_IF_TYPE_TAP)
466 if (ethernet_mac_address_is_zero (args->host_mac_addr.bytes))
467 ethernet_mac_address_generate (args->host_mac_addr.bytes);
468 args->error = vnet_netlink_set_link_addr (vif->ifindex,
469 args->host_mac_addr.bytes);
472 args->rv = VNET_API_ERROR_NETLINK_ERROR;
476 if (args->host_bridge)
478 args->error = vnet_netlink_set_link_master (vif->ifindex,
483 args->rv = VNET_API_ERROR_NETLINK_ERROR;
489 if (args->host_ip4_prefix_len)
491 args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
492 &args->host_ip4_addr,
493 args->host_ip4_prefix_len);
496 args->rv = VNET_API_ERROR_NETLINK_ERROR;
501 if (args->host_ip6_prefix_len)
503 args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
504 &args->host_ip6_addr,
505 args->host_ip6_prefix_len);
508 args->rv = VNET_API_ERROR_NETLINK_ERROR;
513 args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
516 args->rv = VNET_API_ERROR_NETLINK_ERROR;
520 if (args->host_ip4_gw_set)
522 args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
525 args->rv = VNET_API_ERROR_NETLINK_ERROR;
530 if (args->host_ip6_gw_set)
532 args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
535 args->rv = VNET_API_ERROR_NETLINK_ERROR;
540 if (args->host_mtu_set)
543 vnet_netlink_set_link_mtu (vif->ifindex, args->host_mtu_size);
546 args->rv = VNET_API_ERROR_NETLINK_ERROR;
550 else if (tm->host_mtu_size != 0)
553 vnet_netlink_set_link_mtu (vif->ifindex, tm->host_mtu_size);
556 args->rv = VNET_API_ERROR_NETLINK_ERROR;
559 args->host_mtu_set = 1;
560 args->host_mtu_size = tm->host_mtu_size;
563 /* switch back to old net namespace */
564 if (args->host_namespace)
566 if (setns (old_netns_fd, CLONE_NEWNET) == -1)
568 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
569 args->error = clib_error_return_unix (0, "setns '%s'",
570 args->host_namespace);
575 for (i = 0; i < num_vhost_queues; i++)
577 if (i < vif->num_rxqs && (args->error =
578 virtio_vring_init (vm, vif, RX_QUEUE (i),
581 args->rv = VNET_API_ERROR_INIT_FAILED;
585 if (i < vif->num_txqs && (args->error =
586 virtio_vring_init (vm, vif, TX_QUEUE (i),
589 args->rv = VNET_API_ERROR_INIT_FAILED;
594 /* setup features and memtable */
595 i = sizeof (vhost_memory_t) + sizeof (vhost_memory_region_t);
596 vhost_mem = clib_mem_alloc (i);
597 clib_memset (vhost_mem, 0, i);
598 vhost_mem->nregions = 1;
599 vhost_mem->regions[0].memory_size = vpm->max_size;
600 vhost_mem->regions[0].guest_phys_addr = vpm->base_addr;
601 vhost_mem->regions[0].userspace_addr =
602 vhost_mem->regions[0].guest_phys_addr;
604 for (i = 0; i < vhost_mem->nregions; i++)
605 virtio_log_debug (vif, "memtable region %u memory_size 0x%lx "
606 "guest_phys_addr 0x%lx userspace_addr 0x%lx", i,
607 vhost_mem->regions[0].memory_size,
608 vhost_mem->regions[0].guest_phys_addr,
609 vhost_mem->regions[0].userspace_addr);
612 for (i = 0; i < num_vhost_queues; i++)
614 int fd = vif->vhost_fds[i];
615 _IOCTL (fd, VHOST_SET_FEATURES, &vif->features);
616 virtio_log_debug (vif, "VHOST_SET_FEATURES: fd %u features 0x%lx",
618 _IOCTL (fd, VHOST_SET_MEM_TABLE, vhost_mem);
619 virtio_log_debug (vif, "VHOST_SET_MEM_TABLE: fd %u", fd);
622 /* finish initializing queue pair */
623 for (i = 0; i < num_vhost_queues * 2; i++)
625 vhost_vring_addr_t addr = { 0 };
626 vhost_vring_state_t state = { 0 };
627 vhost_vring_file_t file = { 0 };
628 virtio_vring_t *vring;
630 int fd = vif->vhost_fds[qp];
634 if (qp >= vif->num_txqs)
636 vring = vec_elt_at_index (vif->txq_vrings, qp);
640 if (qp >= vif->num_rxqs)
642 vring = vec_elt_at_index (vif->rxq_vrings, qp);
645 addr.index = state.index = file.index = vring->queue_id & 1;
646 state.num = vring->size;
647 virtio_log_debug (vif, "VHOST_SET_VRING_NUM fd %d index %u num %u", fd,
648 state.index, state.num);
649 _IOCTL (fd, VHOST_SET_VRING_NUM, &state);
652 addr.desc_user_addr = pointer_to_uword (vring->desc);
653 addr.avail_user_addr = pointer_to_uword (vring->avail);
654 addr.used_user_addr = pointer_to_uword (vring->used);
656 virtio_log_debug (vif, "VHOST_SET_VRING_ADDR fd %d index %u flags 0x%x "
657 "desc_user_addr 0x%lx avail_user_addr 0x%lx "
658 "used_user_addr 0x%lx", fd, addr.index,
659 addr.flags, addr.desc_user_addr, addr.avail_user_addr,
660 addr.used_user_addr);
661 _IOCTL (fd, VHOST_SET_VRING_ADDR, &addr);
663 file.fd = vring->call_fd;
664 virtio_log_debug (vif, "VHOST_SET_VRING_CALL fd %d index %u call_fd %d",
665 fd, file.index, file.fd);
666 _IOCTL (fd, VHOST_SET_VRING_CALL, &file);
668 file.fd = vring->kick_fd;
669 virtio_log_debug (vif, "VHOST_SET_VRING_KICK fd %d index %u kick_fd %d",
670 fd, file.index, file.fd);
671 _IOCTL (fd, VHOST_SET_VRING_KICK, &file);
673 file.fd = vif->tap_fds[qp % vif->num_rxqs];
674 virtio_log_debug (vif, "VHOST_NET_SET_BACKEND fd %d index %u tap_fd %d",
675 fd, file.index, file.fd);
676 _IOCTL (fd, VHOST_NET_SET_BACKEND, &file);
679 if (vif->type == VIRTIO_IF_TYPE_TAP)
681 if (!args->mac_addr_set)
682 ethernet_mac_address_generate (args->mac_addr.bytes);
684 clib_memcpy (vif->mac_addr, args->mac_addr.bytes, 6);
685 vif->host_bridge = format (0, "%s%c", args->host_bridge, 0);
687 vif->host_if_name = format (0, "%s%c", host_if_name, 0);
688 vif->net_ns = format (0, "%s%c", args->host_namespace, 0);
689 vif->host_mtu_size = args->host_mtu_size;
690 vif->tap_flags = args->tap_flags;
691 clib_memcpy (vif->host_mac_addr, args->host_mac_addr.bytes, 6);
692 vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
693 vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
694 if (args->host_ip4_prefix_len)
695 clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
696 if (args->host_ip6_prefix_len)
697 clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
699 if (vif->type != VIRTIO_IF_TYPE_TUN)
702 ethernet_register_interface (vnm, virtio_device_class.index,
703 vif->dev_instance, vif->mac_addr,
705 virtio_eth_flag_change);
708 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
715 vif->hw_if_index = vnet_register_interface
716 (vnm, virtio_device_class.index,
717 vif->dev_instance /* device instance */ ,
718 tun_device_hw_interface_class.index, vif->dev_instance);
721 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
722 sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
723 vif->sw_if_index = sw->sw_if_index;
724 args->sw_if_index = vif->sw_if_index;
726 hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
727 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
728 if (args->tap_flags & TAP_FLAG_GSO)
730 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
731 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
733 else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
735 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
737 if ((args->tap_flags & TAP_FLAG_GSO)
738 && (args->tap_flags & TAP_FLAG_GRO_COALESCE))
740 virtio_set_packet_coalesce (vif);
742 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
743 virtio_input_node.index);
745 for (i = 0; i < vif->num_rxqs; i++)
747 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, i, ~0);
748 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, i,
749 VNET_HW_IF_RX_MODE_DEFAULT);
750 virtio_vring_set_numa_node (vm, vif, RX_QUEUE (i));
753 vif->per_interface_next_index = ~0;
754 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
755 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
756 VNET_HW_INTERFACE_FLAG_LINK_UP);
758 * Host tun/tap driver link carrier state is "up" at creation. The
759 * driver never changes this unless the backend (VPP) changes it using
760 * TUNSETCARRIER ioctl(). See tap_set_carrier().
762 vif->host_carrier_up = 1;
763 vif->cxq_vring = NULL;
770 ASSERT (args->error == 0);
772 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
775 tap_log_err (vif, "%U", format_clib_error, args->error);
779 clib_mem_free (vhost_mem);
780 if (old_netns_fd != -1)
781 close (old_netns_fd);
787 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
789 vnet_main_t *vnm = vnet_get_main ();
790 virtio_main_t *mm = &virtio_main;
793 vnet_hw_interface_t *hw;
795 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
796 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
797 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
799 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
801 if ((vif->type != VIRTIO_IF_TYPE_TAP) && (vif->type != VIRTIO_IF_TYPE_TUN))
802 return VNET_API_ERROR_INVALID_INTERFACE;
804 /* bring down the interface */
805 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
806 vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
807 for (i = 0; i < vif->num_rxqs; i++)
808 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, i);
810 if (vif->type == VIRTIO_IF_TYPE_TAP)
811 ethernet_delete_interface (vnm, vif->hw_if_index);
812 else /* VIRTIO_IF_TYPE_TUN */
813 vnet_delete_hw_interface (vnm, vif->hw_if_index);
814 vif->hw_if_index = ~0;
822 tap_csum_offload_enable_disable (vlib_main_t * vm, u32 sw_if_index,
825 vnet_main_t *vnm = vnet_get_main ();
826 virtio_main_t *mm = &virtio_main;
828 vnet_hw_interface_t *hw;
829 clib_error_t *err = 0;
832 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
834 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
835 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
837 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
839 const unsigned int csum_offload_on = TUN_F_CSUM;
840 const unsigned int csum_offload_off = 0;
841 unsigned int offload = enable_disable ? csum_offload_on : csum_offload_off;
842 vec_foreach_index (i, vif->tap_fds)
843 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
844 vif->gso_enabled = 0;
845 vif->packet_coalesce = 0;
846 vif->csum_offload_enabled = enable_disable ? 1 : 0;
848 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) != 0)
850 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
855 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD) ==
858 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
863 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD) !=
866 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
873 clib_warning ("Error %s checksum offload on sw_if_index %d",
874 enable_disable ? "enabling" : "disabling", sw_if_index);
875 return VNET_API_ERROR_SYSCALL_ERROR_3;
881 tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index, int enable_disable,
882 int is_packet_coalesce)
884 vnet_main_t *vnm = vnet_get_main ();
885 virtio_main_t *mm = &virtio_main;
887 vnet_hw_interface_t *hw;
888 clib_error_t *err = 0;
891 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
893 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
894 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
896 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
898 const unsigned int gso_on = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
899 const unsigned int gso_off = 0;
900 unsigned int offload = enable_disable ? gso_on : gso_off;
901 vec_foreach_index (i, vif->tap_fds)
902 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
903 vif->gso_enabled = enable_disable ? 1 : 0;
904 vif->csum_offload_enabled = 0;
907 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0)
909 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
910 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
912 if (is_packet_coalesce)
914 virtio_set_packet_coalesce (vif);
919 if ((hw->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) != 0)
921 hw->flags &= ~(VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
922 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
924 vif->packet_coalesce = 0;
930 clib_warning ("Error %s gso on sw_if_index %d",
931 enable_disable ? "enabling" : "disabling", sw_if_index);
932 return VNET_API_ERROR_SYSCALL_ERROR_3;
938 tap_dump_ifs (tap_interface_details_t ** out_tapids)
940 vnet_main_t *vnm = vnet_get_main ();
941 virtio_main_t *mm = &virtio_main;
943 virtio_vring_t *vring;
944 vnet_hw_interface_t *hi;
945 tap_interface_details_t *r_tapids = NULL;
946 tap_interface_details_t *tapid = NULL;
949 pool_foreach (vif, mm->interfaces,
950 if ((vif->type != VIRTIO_IF_TYPE_TAP)
951 && (vif->type != VIRTIO_IF_TYPE_TUN))
953 vec_add2(r_tapids, tapid, 1);
954 clib_memset (tapid, 0, sizeof (*tapid));
956 tapid->sw_if_index = vif->sw_if_index;
957 hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
958 clib_memcpy(tapid->dev_name, hi->name,
959 MIN (ARRAY_LEN (tapid->dev_name) - 1, vec_len (hi->name)));
960 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS(0));
961 tapid->rx_ring_sz = vring->size;
962 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS(0));
963 tapid->tx_ring_sz = vring->size;
964 tapid->tap_flags = vif->tap_flags;
965 clib_memcpy(&tapid->host_mac_addr, vif->host_mac_addr, 6);
966 if (vif->host_if_name)
968 clib_memcpy(tapid->host_if_name, vif->host_if_name,
969 MIN (ARRAY_LEN (tapid->host_if_name) - 1,
970 vec_len (vif->host_if_name)));
974 clib_memcpy(tapid->host_namespace, vif->net_ns,
975 MIN (ARRAY_LEN (tapid->host_namespace) - 1,
976 vec_len (vif->net_ns)));
978 if (vif->host_bridge)
980 clib_memcpy(tapid->host_bridge, vif->host_bridge,
981 MIN (ARRAY_LEN (tapid->host_bridge) - 1,
982 vec_len (vif->host_bridge)));
984 if (vif->host_ip4_prefix_len)
985 clib_memcpy(tapid->host_ip4_addr.as_u8, &vif->host_ip4_addr, 4);
986 tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
987 if (vif->host_ip6_prefix_len)
988 clib_memcpy(tapid->host_ip6_addr.as_u8, &vif->host_ip6_addr, 16);
989 tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
990 tapid->host_mtu_size = vif->host_mtu_size;
994 *out_tapids = r_tapids;
1000 * Set host tap/tun interface carrier state so it will appear to host
1001 * applications that the interface's link state changed.
1003 * If the kernel we're building against does not have support for the
1004 * TUNSETCARRIER ioctl command, do nothing.
1007 tap_set_carrier (u32 hw_if_index, u32 carrier_up)
1010 #ifdef TUNSETCARRIER
1011 vnet_main_t *vnm = vnet_get_main ();
1012 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1013 virtio_main_t *mm = &virtio_main;
1017 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
1018 vec_foreach (fd, vif->tap_fds)
1020 ret = ioctl (*fd, TUNSETCARRIER, &carrier_up);
1023 clib_warning ("ioctl (TUNSETCARRIER) returned %d", ret);
1028 vif->host_carrier_up = (carrier_up != 0);
1034 static clib_error_t *
1035 tap_mtu_config (vlib_main_t * vm, unformat_input_t * input)
1037 tap_main_t *tm = &tap_main;
1039 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1041 if (unformat (input, "host-mtu %d", &tm->host_mtu_size))
1044 return clib_error_return (0, "unknown input `%U'",
1045 format_unformat_error, input);
1052 * Set host tap/tun interface speed in Mbps.
1055 tap_set_speed (u32 hw_if_index, u32 speed)
1057 vnet_main_t *vnm = vnet_get_main ();
1058 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1059 virtio_main_t *mm = &virtio_main;
1061 int old_netns_fd = -1;
1065 struct ethtool_cmd ecmd;
1068 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
1072 old_netns_fd = open ("/proc/self/ns/net", O_RDONLY);
1073 if ((nfd = open_netns_fd ((char *) vif->net_ns)) == -1)
1075 clib_warning ("Cannot open netns");
1078 if (setns (nfd, CLONE_NEWNET) == -1)
1080 clib_warning ("Cannot set ns");
1085 if ((ctl_fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
1087 clib_warning ("Cannot open control socket");
1091 ecmd.cmd = ETHTOOL_GSET;
1092 clib_memset (&ifr, 0, sizeof (ifr));
1093 clib_memcpy (ifr.ifr_name, vif->host_if_name,
1094 strlen ((const char *) vif->host_if_name));
1095 ifr.ifr_data = (void *) &ecmd;
1096 if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1098 clib_warning ("Cannot get device settings");
1102 if (ethtool_cmd_speed (&ecmd) != speed)
1104 ecmd.cmd = ETHTOOL_SSET;
1105 ethtool_cmd_speed_set (&ecmd, speed);
1106 if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1108 clib_warning ("Cannot set device settings");
1114 if (old_netns_fd != -1)
1116 if (setns (old_netns_fd, CLONE_NEWNET) == -1)
1118 clib_warning ("Cannot set old ns");
1120 close (old_netns_fd);
1130 /* tap { host-mtu <size> } configuration. */
1131 VLIB_CONFIG_FUNCTION (tap_mtu_config, "tap");
1133 static clib_error_t *
1134 tap_init (vlib_main_t * vm)
1136 tap_main_t *tm = &tap_main;
1137 clib_error_t *error = 0;
1139 tm->log_default = vlib_log_register_class ("tap", 0);
1140 vlib_log_debug (tm->log_default, "initialized");
1142 tm->host_mtu_size = 0;
1147 VLIB_INIT_FUNCTION (tap_init);
1150 * fd.io coding-style-patch-verification: ON
1153 * eval: (c-set-style "gnu")