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>
32 #include <linux/netlink.h>
33 #include <linux/rtnetlink.h>
35 #include <vlib/vlib.h>
36 #include <vlib/physmem.h>
37 #include <vlib/unix/unix.h>
38 #include <vppinfra/linux/netns.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); \
61 VNET_HW_INTERFACE_CLASS (tun_device_hw_interface_class, static) = {
63 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
64 .tx_hash_fn_type = VNET_HASH_FN_TYPE_IP,
67 #define TUN_MAX_PACKET_BYTES 65355
68 #define TUN_MIN_PACKET_BYTES 64
69 #define TUN_DEFAULT_PACKET_BYTES 1500
72 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
76 //TODO On MTU change call vnet_netlink_set_if_mtu
80 #define TAP_MAX_INSTANCE 1024
83 tap_free (vlib_main_t * vm, virtio_if_t * vif)
85 virtio_main_t *mm = &virtio_main;
86 tap_main_t *tm = &tap_main;
87 clib_error_t *err = 0;
90 virtio_pre_input_node_disable (vm, vif);
93 vec_foreach_index (i, vif->vhost_fds) if (vif->vhost_fds[i] != -1)
94 close (vif->vhost_fds[i]);
95 vec_foreach_index (i, vif->rxq_vrings)
96 virtio_vring_free_rx (vm, vif, RX_QUEUE (i));
97 vec_foreach_index (i, vif->txq_vrings)
98 virtio_vring_free_tx (vm, vif, TX_QUEUE (i));
103 _IOCTL (vif->tap_fds[0], TUNSETPERSIST, (void *) (uintptr_t) 0);
104 tap_log_dbg (vif, "TUNSETPERSIST: unset");
107 vec_foreach_index (i, vif->tap_fds) close (vif->tap_fds[i]);
109 vec_free (vif->tap_fds);
110 vec_free (vif->vhost_fds);
111 vec_free (vif->rxq_vrings);
112 vec_free (vif->txq_vrings);
113 vec_free (vif->host_if_name);
114 vec_free (vif->net_ns);
115 vec_free (vif->host_bridge);
116 clib_error_free (vif->error);
118 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
119 clib_memset (vif, 0, sizeof (*vif));
120 pool_put (mm->interfaces, vif);
124 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
126 vlib_thread_main_t *thm = vlib_get_thread_main ();
127 vlib_physmem_main_t *vpm = &vm->physmem_main;
128 vnet_main_t *vnm = vnet_get_main ();
129 virtio_main_t *vim = &virtio_main;
130 tap_main_t *tm = &tap_main;
131 vnet_sw_interface_t *sw;
132 vnet_hw_interface_t *hw;
133 int i, num_vhost_queues;
134 int old_netns_fd = -1;
135 struct ifreq ifr = {.ifr_flags = IFF_NO_PI | IFF_VNET_HDR };
136 struct ifreq get_ifr = {.ifr_flags = 0 };
138 vhost_memory_t *vhost_mem = 0;
139 virtio_if_t *vif = 0;
140 clib_error_t *err = 0;
141 unsigned int tap_features;
142 int tfd = -1, qfd = -1, vfd = -1, nfd = -1;
143 char *host_if_name = 0;
144 unsigned int offload = 0;
149 if (clib_bitmap_get (tm->tap_ids, args->id))
151 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
152 args->error = clib_error_return (0, "interface already exists");
158 args->id = clib_bitmap_first_clear (tm->tap_ids);
161 if (args->id > TAP_MAX_INSTANCE)
163 args->rv = VNET_API_ERROR_UNSPECIFIED;
164 args->error = clib_error_return (0, "cannot find free interface id");
168 pool_get_zero (vim->interfaces, vif);
170 if (args->tap_flags & TAP_FLAG_TUN)
172 vif->type = VIRTIO_IF_TYPE_TUN;
173 ifr.ifr_flags |= IFF_TUN;
176 * From kernel 4.20, xdp support has been added in tun_sendmsg.
177 * If sndbuf == INT_MAX, vhost batches the packet and processes
178 * them using xdp data path for tun driver. It assumes packets
179 * are ethernet frames (It needs to be fixed).
180 * To avoid xdp data path in tun driver, sndbuf value should
183 sndbuf = INT_MAX - 1;
187 vif->type = VIRTIO_IF_TYPE_TAP;
188 ifr.ifr_flags |= IFF_TAP;
192 vif->dev_instance = vif - vim->interfaces;
194 vif->num_txqs = thm->n_vlib_mains;
195 vif->num_rxqs = clib_max (args->num_rx_queues, 1);
197 if (args->tap_flags & TAP_FLAG_ATTACH)
199 if (args->host_if_name == NULL)
201 args->rv = VNET_API_ERROR_NO_MATCHING_INTERFACE;
202 err = clib_error_return (0, "host_if_name is not provided");
207 /* if namespace is specified, all further netlink messages should be executed
208 * after we change our net namespace */
209 if (args->host_namespace)
211 old_netns_fd = clib_netns_open (NULL /* self */);
212 if ((nfd = clib_netns_open (args->host_namespace)) == -1)
214 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
215 args->error = clib_error_return_unix (0, "clib_netns_open '%s'",
216 args->host_namespace);
219 if (clib_setns (nfd) == -1)
221 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
223 clib_error_return_unix (0, "setns '%s'", args->host_namespace);
228 if (args->host_if_name != NULL)
230 host_if_name = (char *) args->host_if_name;
231 clib_memcpy (ifr.ifr_name, host_if_name,
232 clib_min (IFNAMSIZ, vec_len (host_if_name)));
235 if ((tfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
237 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
238 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
241 vec_add1 (vif->tap_fds, tfd);
242 tap_log_dbg (vif, "open tap fd %d", tfd);
244 _IOCTL (tfd, TUNGETFEATURES, &tap_features);
245 tap_log_dbg (vif, "TUNGETFEATURES: features 0x%lx", tap_features);
246 if ((tap_features & IFF_VNET_HDR) == 0)
248 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
249 args->error = clib_error_return (0, "vhost-net backend not available");
253 if ((tap_features & IFF_MULTI_QUEUE) == 0)
255 if (vif->num_rxqs > 1)
257 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
258 args->error = clib_error_return (0, "multiqueue not supported");
261 vif->num_rxqs = vif->num_txqs = 1;
264 ifr.ifr_flags |= IFF_MULTI_QUEUE;
266 hdrsz = sizeof (virtio_net_hdr_v1_t);
267 if (args->tap_flags & TAP_FLAG_GSO)
269 offload = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
270 vif->gso_enabled = 1;
272 else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
274 offload = TUN_F_CSUM;
275 vif->csum_offload_enabled = 1;
278 _IOCTL (tfd, TUNSETIFF, (void *) &ifr);
279 tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", tfd,
280 ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
282 vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
283 tap_log_dbg (vif, "ifindex %d", vif->ifindex);
285 if (!args->host_if_name)
286 host_if_name = ifr.ifr_ifrn.ifrn_name;
288 host_if_name = (char *) args->host_if_name;
291 * unset the persistence when attaching to existing
294 if (args->tap_flags & TAP_FLAG_ATTACH)
296 _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 0);
297 tap_log_dbg (vif, "TUNSETPERSIST: unset");
300 /* set the persistence */
301 if (args->tap_flags & TAP_FLAG_PERSIST)
303 _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 1);
304 tap_log_dbg (vif, "TUNSETPERSIST: set");
306 /* verify persistence is set, read the flags */
307 _IOCTL (tfd, TUNGETIFF, (void *) &get_ifr);
308 tap_log_dbg (vif, "TUNGETIFF: flags 0x%lx", get_ifr.ifr_flags);
309 if ((get_ifr.ifr_flags & IFF_PERSIST) == 0)
311 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
312 args->error = clib_error_return (0, "persistence not supported");
317 /* create additional queues on the linux side.
318 * we create as many linux queue pairs as we have rx queues
320 for (i = 1; i < vif->num_rxqs; i++)
322 if ((qfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
324 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
325 args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
328 _IOCTL (qfd, TUNSETIFF, (void *) &ifr);
329 tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", qfd,
330 ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
331 vec_add1 (vif->tap_fds, qfd);
334 for (i = 0; i < vif->num_rxqs; i++)
336 tap_log_dbg (vif, "TUNSETVNETHDRSZ: fd %d vnet_hdr_sz %u",
337 vif->tap_fds[i], hdrsz);
338 _IOCTL (vif->tap_fds[i], TUNSETVNETHDRSZ, &hdrsz);
340 tap_log_dbg (vif, "TUNSETSNDBUF: fd %d sndbuf %d", vif->tap_fds[i],
342 _IOCTL (vif->tap_fds[i], TUNSETSNDBUF, &sndbuf);
344 tap_log_dbg (vif, "TUNSETOFFLOAD: fd %d offload 0x%lx", vif->tap_fds[i],
346 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
348 if (fcntl (vif->tap_fds[i], F_SETFL, O_NONBLOCK) < 0)
350 err = clib_error_return_unix (0, "fcntl(tfd, F_SETFL, O_NONBLOCK)");
351 tap_log_err (vif, "set nonblocking: %U", format_clib_error, err);
356 /* open as many vhost-net fds as required and set ownership */
357 num_vhost_queues = clib_max (vif->num_rxqs, vif->num_txqs);
358 for (i = 0; i < num_vhost_queues; i++)
360 if ((vfd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
362 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
363 args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
366 vec_add1 (vif->vhost_fds, vfd);
367 virtio_log_debug (vif, "open vhost-net fd %d qpair %u", vfd, i);
368 _IOCTL (vfd, VHOST_SET_OWNER, 0);
369 virtio_log_debug (vif, "VHOST_SET_OWNER: fd %u", vfd);
372 _IOCTL (vif->vhost_fds[0], VHOST_GET_FEATURES, &vif->remote_features);
373 virtio_log_debug (vif, "VHOST_GET_FEATURES: features 0x%lx",
374 vif->remote_features);
376 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
378 args->rv = VNET_API_ERROR_UNSUPPORTED;
379 args->error = clib_error_return (0, "vhost-net backend doesn't support "
380 "VIRTIO_NET_F_MRG_RXBUF feature");
384 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
387 args->rv = VNET_API_ERROR_UNSUPPORTED;
388 args->error = clib_error_return (0, "vhost-net backend doesn't support "
389 "VIRTIO_RING_F_INDIRECT_DESC feature");
393 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1)) == 0)
395 args->rv = VNET_API_ERROR_UNSUPPORTED;
396 args->error = clib_error_return (0, "vhost-net backend doesn't support "
397 "VIRTIO_F_VERSION_1 features");
401 vif->features |= VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
402 vif->features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
403 vif->features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
405 virtio_set_net_hdr_size (vif);
407 if (vif->type == VIRTIO_IF_TYPE_TAP)
409 if (ethernet_mac_address_is_zero (args->host_mac_addr.bytes))
410 ethernet_mac_address_generate (args->host_mac_addr.bytes);
411 args->error = vnet_netlink_set_link_addr (vif->ifindex,
412 args->host_mac_addr.bytes);
415 args->rv = VNET_API_ERROR_NETLINK_ERROR;
419 if (args->host_bridge)
421 args->error = vnet_netlink_set_link_master (vif->ifindex,
426 args->rv = VNET_API_ERROR_NETLINK_ERROR;
432 if (args->host_ip4_prefix_len)
434 args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
435 &args->host_ip4_addr,
436 args->host_ip4_prefix_len);
439 args->rv = VNET_API_ERROR_NETLINK_ERROR;
444 if (args->host_ip6_prefix_len)
446 args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
447 &args->host_ip6_addr,
448 args->host_ip6_prefix_len);
451 args->rv = VNET_API_ERROR_NETLINK_ERROR;
456 args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
459 args->rv = VNET_API_ERROR_NETLINK_ERROR;
463 if (args->host_ip4_gw_set)
465 args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
468 args->rv = VNET_API_ERROR_NETLINK_ERROR;
473 if (args->host_ip6_gw_set)
475 args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
478 args->rv = VNET_API_ERROR_NETLINK_ERROR;
483 if (args->host_mtu_set)
486 vnet_netlink_set_link_mtu (vif->ifindex, args->host_mtu_size);
489 args->rv = VNET_API_ERROR_NETLINK_ERROR;
493 else if (tm->host_mtu_size != 0)
496 vnet_netlink_set_link_mtu (vif->ifindex, tm->host_mtu_size);
499 args->rv = VNET_API_ERROR_NETLINK_ERROR;
502 args->host_mtu_set = 1;
503 args->host_mtu_size = tm->host_mtu_size;
506 /* switch back to old net namespace */
507 if (args->host_namespace)
509 if (clib_setns (old_netns_fd) == -1)
511 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
512 args->error = clib_error_return_unix (0, "setns '%s'",
513 args->host_namespace);
518 for (i = 0; i < num_vhost_queues; i++)
520 if (i < vif->num_rxqs && (args->error =
521 virtio_vring_init (vm, vif, RX_QUEUE (i),
524 args->rv = VNET_API_ERROR_INIT_FAILED;
528 if (i < vif->num_txqs && (args->error =
529 virtio_vring_init (vm, vif, TX_QUEUE (i),
532 args->rv = VNET_API_ERROR_INIT_FAILED;
537 /* setup features and memtable */
538 i = sizeof (vhost_memory_t) + sizeof (vhost_memory_region_t);
539 vhost_mem = clib_mem_alloc (i);
540 clib_memset (vhost_mem, 0, i);
541 vhost_mem->nregions = 1;
542 vhost_mem->regions[0].memory_size = vpm->max_size;
543 vhost_mem->regions[0].guest_phys_addr = vpm->base_addr;
544 vhost_mem->regions[0].userspace_addr =
545 vhost_mem->regions[0].guest_phys_addr;
547 for (i = 0; i < vhost_mem->nregions; i++)
548 virtio_log_debug (vif, "memtable region %u memory_size 0x%lx "
549 "guest_phys_addr 0x%lx userspace_addr 0x%lx", i,
550 vhost_mem->regions[0].memory_size,
551 vhost_mem->regions[0].guest_phys_addr,
552 vhost_mem->regions[0].userspace_addr);
555 for (i = 0; i < num_vhost_queues; i++)
557 int fd = vif->vhost_fds[i];
558 _IOCTL (fd, VHOST_SET_FEATURES, &vif->features);
559 virtio_log_debug (vif, "VHOST_SET_FEATURES: fd %u features 0x%lx",
561 _IOCTL (fd, VHOST_SET_MEM_TABLE, vhost_mem);
562 virtio_log_debug (vif, "VHOST_SET_MEM_TABLE: fd %u", fd);
565 /* finish initializing queue pair */
566 for (i = 0; i < num_vhost_queues * 2; i++)
568 vhost_vring_addr_t addr = { 0 };
569 vhost_vring_state_t state = { 0 };
570 vhost_vring_file_t file = { 0 };
571 virtio_vring_t *vring;
573 int fd = vif->vhost_fds[qp];
577 if (qp >= vif->num_txqs)
579 vring = vec_elt_at_index (vif->txq_vrings, qp);
583 if (qp >= vif->num_rxqs)
585 vring = vec_elt_at_index (vif->rxq_vrings, qp);
588 addr.index = state.index = file.index = vring->queue_id & 1;
589 state.num = vring->size;
590 virtio_log_debug (vif, "VHOST_SET_VRING_NUM fd %d index %u num %u", fd,
591 state.index, state.num);
592 _IOCTL (fd, VHOST_SET_VRING_NUM, &state);
595 addr.desc_user_addr = pointer_to_uword (vring->desc);
596 addr.avail_user_addr = pointer_to_uword (vring->avail);
597 addr.used_user_addr = pointer_to_uword (vring->used);
599 virtio_log_debug (vif, "VHOST_SET_VRING_ADDR fd %d index %u flags 0x%x "
600 "desc_user_addr 0x%lx avail_user_addr 0x%lx "
601 "used_user_addr 0x%lx", fd, addr.index,
602 addr.flags, addr.desc_user_addr, addr.avail_user_addr,
603 addr.used_user_addr);
604 _IOCTL (fd, VHOST_SET_VRING_ADDR, &addr);
606 file.fd = vring->call_fd;
607 virtio_log_debug (vif, "VHOST_SET_VRING_CALL fd %d index %u call_fd %d",
608 fd, file.index, file.fd);
609 _IOCTL (fd, VHOST_SET_VRING_CALL, &file);
611 file.fd = vring->kick_fd;
612 virtio_log_debug (vif, "VHOST_SET_VRING_KICK fd %d index %u kick_fd %d",
613 fd, file.index, file.fd);
614 _IOCTL (fd, VHOST_SET_VRING_KICK, &file);
616 file.fd = vif->tap_fds[qp % vif->num_rxqs];
617 virtio_log_debug (vif, "VHOST_NET_SET_BACKEND fd %d index %u tap_fd %d",
618 fd, file.index, file.fd);
619 _IOCTL (fd, VHOST_NET_SET_BACKEND, &file);
622 if (vif->type == VIRTIO_IF_TYPE_TAP)
624 if (!args->mac_addr_set)
625 ethernet_mac_address_generate (args->mac_addr.bytes);
627 clib_memcpy (vif->mac_addr, args->mac_addr.bytes, 6);
628 if (args->host_bridge)
629 vif->host_bridge = format (0, "%s%c", args->host_bridge, 0);
631 vif->host_if_name = format (0, "%s%c", host_if_name, 0);
632 if (args->host_namespace)
633 vif->net_ns = format (0, "%s%c", args->host_namespace, 0);
634 vif->host_mtu_size = args->host_mtu_size;
635 vif->tap_flags = args->tap_flags;
636 clib_memcpy (vif->host_mac_addr, args->host_mac_addr.bytes, 6);
637 vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
638 vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
639 if (args->host_ip4_prefix_len)
640 clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
641 if (args->host_ip6_prefix_len)
642 clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
644 if (vif->type != VIRTIO_IF_TYPE_TUN)
647 ethernet_register_interface (vnm, virtio_device_class.index,
648 vif->dev_instance, vif->mac_addr,
650 virtio_eth_flag_change);
653 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
660 vif->hw_if_index = vnet_register_interface
661 (vnm, virtio_device_class.index,
662 vif->dev_instance /* device instance */ ,
663 tun_device_hw_interface_class.index, vif->dev_instance);
666 tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
667 sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
668 vif->sw_if_index = sw->sw_if_index;
669 args->sw_if_index = vif->sw_if_index;
671 hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
672 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE;
673 if (args->tap_flags & TAP_FLAG_GSO)
675 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
676 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
677 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM;
679 else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
681 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
682 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM;
684 if ((args->tap_flags & TAP_FLAG_GSO)
685 && (args->tap_flags & TAP_FLAG_GRO_COALESCE))
687 virtio_set_packet_coalesce (vif);
689 if (vif->type == VIRTIO_IF_TYPE_TUN)
691 hw->max_supported_packet_bytes = TUN_MAX_PACKET_BYTES;
692 hw->min_packet_bytes = hw->min_supported_packet_bytes =
693 TUN_MIN_PACKET_BYTES;
694 hw->max_packet_bytes =
695 args->host_mtu_size ? args->host_mtu_size : TUN_DEFAULT_PACKET_BYTES;
696 vnet_sw_interface_set_mtu (vnm, hw->sw_if_index, hw->max_packet_bytes);
699 virtio_pre_input_node_enable (vm, vif);
700 virtio_vring_set_rx_queues (vm, vif);
701 virtio_vring_set_tx_queues (vm, vif);
703 vif->per_interface_next_index = ~0;
704 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
705 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
706 VNET_HW_INTERFACE_FLAG_LINK_UP);
708 * Host tun/tap driver link carrier state is "up" at creation. The
709 * driver never changes this unless the backend (VPP) changes it using
710 * TUNSETCARRIER ioctl(). See tap_set_carrier().
712 vif->host_carrier_up = 1;
719 ASSERT (args->error == 0);
721 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
724 tap_log_err (vif, "%U", format_clib_error, args->error);
728 clib_mem_free (vhost_mem);
729 if (old_netns_fd != -1)
731 /* in case we errored with a switched netns */
732 clib_setns (old_netns_fd);
733 close (old_netns_fd);
740 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
742 vnet_main_t *vnm = vnet_get_main ();
743 virtio_main_t *mm = &virtio_main;
745 vnet_hw_interface_t *hw;
747 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
748 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
749 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
751 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
753 if ((vif->type != VIRTIO_IF_TYPE_TAP) && (vif->type != VIRTIO_IF_TYPE_TUN))
754 return VNET_API_ERROR_INVALID_INTERFACE;
756 /* bring down the interface */
757 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
758 vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
760 if (vif->type == VIRTIO_IF_TYPE_TAP)
761 ethernet_delete_interface (vnm, vif->hw_if_index);
762 else /* VIRTIO_IF_TYPE_TUN */
763 vnet_delete_hw_interface (vnm, vif->hw_if_index);
764 vif->hw_if_index = ~0;
772 tap_csum_offload_enable_disable (vlib_main_t * vm, u32 sw_if_index,
775 vnet_main_t *vnm = vnet_get_main ();
776 virtio_main_t *mm = &virtio_main;
778 vnet_hw_interface_t *hw;
779 clib_error_t *err = 0;
782 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
784 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
785 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
787 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
789 const unsigned int csum_offload_on = TUN_F_CSUM;
790 const unsigned int csum_offload_off = 0;
791 unsigned int offload = enable_disable ? csum_offload_on : csum_offload_off;
792 vec_foreach_index (i, vif->tap_fds)
793 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
794 vif->gso_enabled = 0;
795 vif->packet_coalesce = 0;
796 vif->csum_offload_enabled = enable_disable ? 1 : 0;
798 if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) != 0)
800 hw->caps &= ~VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO;
805 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
809 hw->caps &= ~VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
815 clib_warning ("Error %s checksum offload on sw_if_index %d",
816 enable_disable ? "enabling" : "disabling", sw_if_index);
817 return VNET_API_ERROR_SYSCALL_ERROR_3;
823 tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index, int enable_disable,
824 int is_packet_coalesce)
826 vnet_main_t *vnm = vnet_get_main ();
827 virtio_main_t *mm = &virtio_main;
829 vnet_hw_interface_t *hw;
830 clib_error_t *err = 0;
833 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
835 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
836 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
838 vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
840 const unsigned int gso_on = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
841 const unsigned int gso_off = 0;
842 unsigned int offload = enable_disable ? gso_on : gso_off;
843 vec_foreach_index (i, vif->tap_fds)
844 _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
845 vif->gso_enabled = enable_disable ? 1 : 0;
846 vif->csum_offload_enabled = 0;
849 if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) == 0)
851 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
852 VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
854 if (is_packet_coalesce)
856 virtio_set_packet_coalesce (vif);
861 if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) != 0)
863 hw->caps &= ~(VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
864 VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM);
866 vif->packet_coalesce = 0;
872 clib_warning ("Error %s gso on sw_if_index %d",
873 enable_disable ? "enabling" : "disabling", sw_if_index);
874 return VNET_API_ERROR_SYSCALL_ERROR_3;
880 tap_dump_ifs (tap_interface_details_t ** out_tapids)
882 vnet_main_t *vnm = vnet_get_main ();
883 virtio_main_t *mm = &virtio_main;
885 virtio_vring_t *vring;
886 vnet_hw_interface_t *hi;
887 tap_interface_details_t *r_tapids = NULL;
888 tap_interface_details_t *tapid = NULL;
891 pool_foreach (vif, mm->interfaces) {
892 if ((vif->type != VIRTIO_IF_TYPE_TAP)
893 && (vif->type != VIRTIO_IF_TYPE_TUN))
895 vec_add2(r_tapids, tapid, 1);
896 clib_memset (tapid, 0, sizeof (*tapid));
898 tapid->sw_if_index = vif->sw_if_index;
899 hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
900 clib_memcpy(tapid->dev_name, hi->name,
901 MIN (ARRAY_LEN (tapid->dev_name) - 1, vec_len (hi->name)));
902 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS(0));
903 tapid->rx_ring_sz = vring->size;
904 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS(0));
905 tapid->tx_ring_sz = vring->size;
906 tapid->tap_flags = vif->tap_flags;
907 clib_memcpy(&tapid->host_mac_addr, vif->host_mac_addr, 6);
908 if (vif->host_if_name)
910 clib_memcpy(tapid->host_if_name, vif->host_if_name,
911 MIN (ARRAY_LEN (tapid->host_if_name) - 1,
912 vec_len (vif->host_if_name)));
916 clib_memcpy(tapid->host_namespace, vif->net_ns,
917 MIN (ARRAY_LEN (tapid->host_namespace) - 1,
918 vec_len (vif->net_ns)));
920 if (vif->host_bridge)
922 clib_memcpy(tapid->host_bridge, vif->host_bridge,
923 MIN (ARRAY_LEN (tapid->host_bridge) - 1,
924 vec_len (vif->host_bridge)));
926 if (vif->host_ip4_prefix_len)
927 clib_memcpy(tapid->host_ip4_addr.as_u8, &vif->host_ip4_addr, 4);
928 tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
929 if (vif->host_ip6_prefix_len)
930 clib_memcpy(tapid->host_ip6_addr.as_u8, &vif->host_ip6_addr, 16);
931 tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
932 tapid->host_mtu_size = vif->host_mtu_size;
936 *out_tapids = r_tapids;
942 * Set host tap/tun interface carrier state so it will appear to host
943 * applications that the interface's link state changed.
945 * If the kernel we're building against does not have support for the
946 * TUNSETCARRIER ioctl command, do nothing.
949 tap_set_carrier (u32 hw_if_index, u32 carrier_up)
953 vnet_main_t *vnm = vnet_get_main ();
954 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
955 virtio_main_t *mm = &virtio_main;
959 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
960 vec_foreach (fd, vif->tap_fds)
962 ret = ioctl (*fd, TUNSETCARRIER, &carrier_up);
965 clib_warning ("ioctl (TUNSETCARRIER) returned %d", ret);
970 vif->host_carrier_up = (carrier_up != 0);
976 static clib_error_t *
977 tap_mtu_config (vlib_main_t * vm, unformat_input_t * input)
979 tap_main_t *tm = &tap_main;
981 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
983 if (unformat (input, "host-mtu %d", &tm->host_mtu_size))
986 return clib_error_return (0, "unknown input `%U'",
987 format_unformat_error, input);
994 * Set host tap/tun interface speed in Mbps.
997 tap_set_speed (u32 hw_if_index, u32 speed)
999 vnet_main_t *vnm = vnet_get_main ();
1000 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1001 virtio_main_t *mm = &virtio_main;
1003 int old_netns_fd = -1;
1007 struct ethtool_cmd ecmd;
1010 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
1014 old_netns_fd = clib_netns_open (NULL /* self */);
1015 if ((nfd = clib_netns_open (vif->net_ns)) == -1)
1017 clib_warning ("Cannot open netns");
1020 if (clib_setns (nfd) == -1)
1022 clib_warning ("Cannot set ns");
1027 if ((ctl_fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
1029 clib_warning ("Cannot open control socket");
1033 ecmd.cmd = ETHTOOL_GSET;
1034 clib_memset (&ifr, 0, sizeof (ifr));
1035 clib_memcpy (ifr.ifr_name, vif->host_if_name,
1036 strlen ((const char *) vif->host_if_name));
1037 ifr.ifr_data = (void *) &ecmd;
1038 if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1040 clib_warning ("Cannot get device settings");
1044 if (ethtool_cmd_speed (&ecmd) != speed)
1046 ecmd.cmd = ETHTOOL_SSET;
1047 ethtool_cmd_speed_set (&ecmd, speed);
1048 if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1050 clib_warning ("Cannot set device settings");
1056 if (old_netns_fd != -1)
1058 if (clib_setns (old_netns_fd) == -1)
1060 clib_warning ("Cannot set old ns");
1062 close (old_netns_fd);
1072 /* tap { host-mtu <size> } configuration. */
1073 VLIB_CONFIG_FUNCTION (tap_mtu_config, "tap");
1075 static clib_error_t *
1076 tap_init (vlib_main_t * vm)
1078 tap_main_t *tm = &tap_main;
1079 clib_error_t *error = 0;
1081 tm->log_default = vlib_log_register_class ("tap", 0);
1082 vlib_log_debug (tm->log_default, "initialized");
1084 tm->host_mtu_size = 0;
1089 VLIB_INIT_FUNCTION (tap_init);
1092 * fd.io coding-style-patch-verification: ON
1095 * eval: (c-set-style "gnu")