2 *------------------------------------------------------------------
3 * tuntap.c - kernel stack (reverse) punt/inject path
5 * Copyright (c) 2009 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
21 * @brief TunTap Kernel stack (reverse) punt/inject path.
23 * This driver runs in one of two distinct modes:
24 * - "punt/inject" mode, where we send pkts not otherwise processed
25 * by the forwarding to the Linux kernel stack, and
27 * - "normal interface" mode, where we treat the Linux kernel stack
30 * By default, we select punt/inject mode.
33 #include <fcntl.h> /* for open */
34 #include <sys/ioctl.h>
35 #include <sys/socket.h>
37 #include <sys/types.h>
38 #include <sys/uio.h> /* for iovec */
39 #include <netinet/in.h>
41 #include <linux/if_arp.h>
42 #include <linux/if_tun.h>
44 #include <vlib/vlib.h>
45 #include <vlib/unix/unix.h>
47 #include <vnet/ip/ip.h>
48 #include <vnet/fib/fib_table.h>
50 #include <vnet/ethernet/ethernet.h>
51 #include <vnet/devices/devices.h>
52 #include <vnet/feature/feature.h>
54 static vnet_device_class_t tuntap_dev_class;
55 static vnet_hw_interface_class_t tuntap_interface_class;
57 static void tuntap_punt_frame (vlib_main_t * vm,
58 vlib_node_runtime_t * node,
59 vlib_frame_t * frame);
60 static void tuntap_nopunt_frame (vlib_main_t * vm,
61 vlib_node_runtime_t * node,
62 vlib_frame_t * frame);
71 * @brief TUNTAP per thread struct
75 /** Vector of VLIB rx buffers to use. We allocate them in blocks
76 of VLIB_FRAME_SIZE (256). */
79 /** Vector of iovecs for readv/writev calls. */
80 struct iovec * iovecs;
81 } tuntap_per_thread_t;
84 * @brief TUNTAP node main state
87 /** per thread variables */
88 tuntap_per_thread_t * threads;
90 /** File descriptors for /dev/net/tun and provisioning socket. */
91 int dev_net_tun_fd, dev_tap_fd;
93 /** Create a "tap" [ethernet] encaps device */
96 /** 1 if a "normal" routed intfc, 0 if a punt/inject interface */
98 int have_normal_interface;
100 /** tap device destination MAC address. Required, or Linux drops pkts */
103 /** Interface MTU in bytes and # of default sized buffers. */
104 u32 mtu_bytes, mtu_buffers;
106 /** Linux interface name for tun device. */
109 /** Pool of subinterface addresses */
110 subif_address_t *subifs;
112 /** Hash for subif addresses */
115 /** Unix file index */
118 /** For the "normal" interface, if configured */
119 u32 hw_if_index, sw_if_index;
123 static tuntap_main_t tuntap_main = {
126 /** Suitable defaults for an Ethernet-like tun/tap device */
127 .mtu_bytes = 4096 + 256,
134 * Output node, writes the buffers comprising the incoming frame
135 * to the tun/tap device, aka hands them to the Linux kernel stack.
137 * @param *vm - vlib_main_t
138 * @param *node - vlib_node_runtime_t
139 * @param *frame - vlib_frame_t
145 tuntap_tx (vlib_main_t * vm,
146 vlib_node_runtime_t * node,
147 vlib_frame_t * frame)
149 u32 * buffers = vlib_frame_args (frame);
150 uword n_packets = frame->n_vectors;
151 tuntap_main_t * tm = &tuntap_main;
152 vnet_main_t *vnm = vnet_get_main ();
153 vnet_interface_main_t *im = &vnm->interface_main;
156 u16 thread_index = vlib_get_thread_index ();
158 for (i = 0; i < n_packets; i++)
164 b = vlib_get_buffer (vm, buffers[i]);
166 if (tm->is_ether && (!tm->have_normal_interface))
168 vlib_buffer_reset(b);
169 clib_memcpy (vlib_buffer_get_current (b), tm->ether_dst_mac, 6);
172 /* Re-set iovecs if present. */
173 if (tm->threads[thread_index].iovecs)
174 _vec_len (tm->threads[thread_index].iovecs) = 0;
176 /** VLIB buffer chain -> Unix iovec(s). */
177 vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
178 iov->iov_base = b->data + b->current_data;
179 iov->iov_len = l = b->current_length;
181 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
184 b = vlib_get_buffer (vm, b->next_buffer);
186 vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
188 iov->iov_base = b->data + b->current_data;
189 iov->iov_len = b->current_length;
190 l += b->current_length;
191 } while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
194 if (writev (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
195 vec_len (tm->threads[thread_index].iovecs)) < l)
196 clib_unix_warning ("writev");
201 /* Update tuntap interface output stats. */
202 vlib_increment_combined_counter (im->combined_sw_if_counters
203 + VNET_INTERFACE_COUNTER_TX,
205 tm->sw_if_index, n_packets, n_bytes);
208 /** The normal interface path flattens the buffer chain */
209 if (tm->have_normal_interface)
210 vlib_buffer_free_no_next (vm, buffers, n_packets);
212 vlib_buffer_free (vm, buffers, n_packets);
217 VLIB_REGISTER_NODE (tuntap_tx_node,static) = {
218 .function = tuntap_tx,
220 .type = VLIB_NODE_TYPE_INTERNAL,
225 * @brief TUNTAP receive node
228 * @param *vm - vlib_main_t
229 * @param *node - vlib_node_runtime_t
230 * @param *frame - vlib_frame_t
236 tuntap_rx (vlib_main_t * vm,
237 vlib_node_runtime_t * node,
238 vlib_frame_t * frame)
240 tuntap_main_t * tm = &tuntap_main;
243 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
244 u16 thread_index = vlib_get_thread_index ();
246 /** Make sure we have some RX buffers. */
248 uword n_left = vec_len (tm->threads[thread_index].rx_buffers);
251 if (n_left < VLIB_FRAME_SIZE / 2)
253 if (! tm->threads[thread_index].rx_buffers)
254 vec_alloc (tm->threads[thread_index].rx_buffers, VLIB_FRAME_SIZE);
256 n_alloc = vlib_buffer_alloc (vm, tm->threads[thread_index].rx_buffers + n_left, VLIB_FRAME_SIZE - n_left);
257 _vec_len (tm->threads[thread_index].rx_buffers) = n_left + n_alloc;
261 /** Allocate RX buffers from end of rx_buffers.
262 Turn them into iovecs to pass to readv. */
264 uword i_rx = vec_len (tm->threads[thread_index].rx_buffers) - 1;
266 word i, n_bytes_left, n_bytes_in_packet;
268 /** We should have enough buffers left for an MTU sized packet. */
269 ASSERT (vec_len (tm->threads[thread_index].rx_buffers) >= tm->mtu_buffers);
271 vec_validate (tm->threads[thread_index].iovecs, tm->mtu_buffers - 1);
272 for (i = 0; i < tm->mtu_buffers; i++)
274 b = vlib_get_buffer (vm, tm->threads[thread_index].rx_buffers[i_rx - i]);
275 tm->threads[thread_index].iovecs[i].iov_base = b->data;
276 tm->threads[thread_index].iovecs[i].iov_len = buffer_size;
279 n_bytes_left = readv (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
281 n_bytes_in_packet = n_bytes_left;
282 if (n_bytes_left <= 0)
285 clib_unix_warning ("readv %d", n_bytes_left);
289 bi = tm->threads[thread_index].rx_buffers[i_rx];
293 b = vlib_get_buffer (vm, tm->threads[thread_index].rx_buffers[i_rx]);
296 b->current_length = n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
298 n_bytes_left -= buffer_size;
300 if (n_bytes_left <= 0)
306 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
307 b->next_buffer = tm->threads[thread_index].rx_buffers[i_rx];
310 /** Interface counters for tuntap interface. */
311 vlib_increment_combined_counter
312 (vnet_main.interface_main.combined_sw_if_counters
313 + VNET_INTERFACE_COUNTER_RX,
316 1, n_bytes_in_packet);
318 _vec_len (tm->threads[thread_index].rx_buffers) = i_rx;
321 b = vlib_get_buffer (vm, bi);
325 uword n_trace = vlib_get_trace_count (vm, node);
327 vnet_buffer (b)->sw_if_index[VLIB_RX] = tm->sw_if_index;
328 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32)~0;
331 * Turn this on if you run into
332 * "bad monkey" contexts, and you want to know exactly
333 * which nodes they've visited...
335 if (VLIB_BUFFER_TRACE_TRAJECTORY)
338 b->error = node->errors[0];
342 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
345 switch (b->data[0] & 0xf0)
348 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
351 next_index = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
354 next_index = VNET_DEVICE_INPUT_NEXT_DROP;
358 /* The linux kernel couldn't care less if our interface is up */
359 if (tm->have_normal_interface)
361 vnet_main_t *vnm = vnet_get_main();
362 vnet_sw_interface_t * si;
363 si = vnet_get_sw_interface (vnm, tm->sw_if_index);
364 if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
365 next_index = VNET_DEVICE_INPUT_NEXT_DROP;
368 vnet_feature_start_device_input_x1 (tm->sw_if_index, &next_index, b);
370 vlib_set_next_frame_buffer (vm, node, next_index, bi);
374 vlib_trace_buffer (vm, node, next_index,
375 b, /* follow_chain */ 1);
376 vlib_set_trace_count (vm, node, n_trace - 1);
384 * @brief TUNTAP_RX error strings
386 static char * tuntap_rx_error_strings[] = {
387 "unknown packet type",
390 VLIB_REGISTER_NODE (tuntap_rx_node,static) = {
391 .function = tuntap_rx,
393 .sibling_of = "device-input",
394 .type = VLIB_NODE_TYPE_INPUT,
395 .state = VLIB_NODE_STATE_INTERRUPT,
398 .error_strings = tuntap_rx_error_strings,
402 * @brief Gets called when file descriptor is ready from epoll.
404 * @param *uf - clib_file_t
406 * @return error - clib_error_t
408 static clib_error_t * tuntap_read_ready (clib_file_t * uf)
410 vlib_main_t * vm = vlib_get_main();
411 vlib_node_set_interrupt_pending (vm, tuntap_rx_node.index);
416 * @brief Clean up the tun/tap device
418 * @param *vm - vlib_main_t
420 * @return error - clib_error_t
423 static clib_error_t *
424 tuntap_exit (vlib_main_t * vm)
426 tuntap_main_t *tm = &tuntap_main;
431 if (! tm->dev_net_tun_fd || tm->dev_net_tun_fd < 0)
434 sfd = socket (AF_INET, SOCK_STREAM, 0);
436 clib_unix_warning("provisioning socket");
438 memset(&ifr, 0, sizeof (ifr));
439 strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name)-1);
441 /* get flags, modify to bring down interface... */
442 if (ioctl (sfd, SIOCGIFFLAGS, &ifr) < 0)
443 clib_unix_warning ("SIOCGIFFLAGS");
445 ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
447 if (ioctl (sfd, SIOCSIFFLAGS, &ifr) < 0)
448 clib_unix_warning ("SIOCSIFFLAGS");
450 /* Turn off persistence */
451 if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 0) < 0)
452 clib_unix_warning ("TUNSETPERSIST");
453 close(tm->dev_tap_fd);
454 if (tm->dev_net_tun_fd >= 0)
455 close(tm->dev_net_tun_fd);
462 VLIB_MAIN_LOOP_EXIT_FUNCTION (tuntap_exit);
465 * @brief CLI function for tun/tap config
467 * @param *vm - vlib_main_t
468 * @param *input - unformat_input_t
470 * @return error - clib_error_t
473 static clib_error_t *
474 tuntap_config (vlib_main_t * vm, unformat_input_t * input)
476 tuntap_main_t *tm = &tuntap_main;
477 clib_error_t * error = 0;
480 int flags = IFF_TUN | IFF_NO_PI;
481 int is_enabled = 0, is_ether = 0, have_normal_interface = 0;
482 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
484 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
486 if (unformat (input, "mtu %d", &tm->mtu_bytes))
488 else if (unformat (input, "enable"))
490 else if (unformat (input, "disable"))
492 else if (unformat (input, "ethernet") ||
493 unformat (input, "ether"))
495 else if (unformat (input, "have-normal-interface") ||
496 unformat (input, "have-normal"))
497 have_normal_interface = 1;
498 else if (unformat (input, "name %s", &name))
499 tm->tun_name = (char *) name;
501 return clib_error_return (0, "unknown input `%U'",
502 format_unformat_error, input);
505 tm->dev_net_tun_fd = -1;
513 clib_warning ("tuntap disabled: must be superuser");
517 tm->is_ether = is_ether;
518 tm->have_normal_interface = have_normal_interface;
521 flags = IFF_TAP | IFF_NO_PI;
523 if ((tm->dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
525 error = clib_error_return_unix (0, "open /dev/net/tun");
529 memset (&ifr, 0, sizeof (ifr));
530 strncpy(ifr.ifr_name, tm->tun_name, sizeof(ifr.ifr_name)-1);
531 ifr.ifr_flags = flags;
532 if (ioctl (tm->dev_net_tun_fd, TUNSETIFF, (void *)&ifr) < 0)
534 error = clib_error_return_unix (0, "ioctl TUNSETIFF");
538 /* Make it persistent, at least until we split. */
539 if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 1) < 0)
541 error = clib_error_return_unix (0, "TUNSETPERSIST");
545 /* Open a provisioning socket */
546 if ((tm->dev_tap_fd = socket(PF_PACKET, SOCK_RAW,
547 htons(ETH_P_ALL))) < 0 )
549 error = clib_error_return_unix (0, "socket");
553 /* Find the interface index. */
556 struct sockaddr_ll sll;
558 memset (&ifr, 0, sizeof(ifr));
559 strncpy (ifr.ifr_name, tm->tun_name, sizeof(ifr.ifr_name)-1);
560 if (ioctl (tm->dev_tap_fd, SIOCGIFINDEX, &ifr) < 0 )
562 error = clib_error_return_unix (0, "ioctl SIOCGIFINDEX");
566 /* Bind the provisioning socket to the interface. */
567 memset(&sll, 0, sizeof(sll));
568 sll.sll_family = AF_PACKET;
569 sll.sll_ifindex = ifr.ifr_ifindex;
570 sll.sll_protocol = htons(ETH_P_ALL);
572 if (bind(tm->dev_tap_fd, (struct sockaddr*) &sll, sizeof(sll)) < 0)
574 error = clib_error_return_unix (0, "bind");
579 /* non-blocking I/O on /dev/tapX */
582 if (ioctl (tm->dev_net_tun_fd, FIONBIO, &one) < 0)
584 error = clib_error_return_unix (0, "ioctl FIONBIO");
589 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
591 ifr.ifr_mtu = tm->mtu_bytes;
592 if (ioctl (tm->dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
594 error = clib_error_return_unix (0, "ioctl SIOCSIFMTU");
598 /* get flags, modify to bring up interface... */
599 if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
601 error = clib_error_return_unix (0, "ioctl SIOCGIFFLAGS");
605 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
607 if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
609 error = clib_error_return_unix (0, "ioctl SIOCSIFFLAGS");
615 if (ioctl (tm->dev_tap_fd, SIOCGIFHWADDR, &ifr) < 0)
617 error = clib_error_return_unix (0, "ioctl SIOCGIFHWADDR");
621 clib_memcpy (tm->ether_dst_mac, ifr.ifr_hwaddr.sa_data, 6);
624 if (have_normal_interface)
626 vnet_main_t *vnm = vnet_get_main();
627 error = ethernet_register_interface
629 tuntap_dev_class.index,
630 0 /* device instance */,
631 tm->ether_dst_mac /* ethernet address */,
633 0 /* flag change */);
635 clib_error_report (error);
636 tm->sw_if_index = tm->hw_if_index;
637 vm->os_punt_frame = tuntap_nopunt_frame;
641 vnet_main_t *vnm = vnet_get_main();
642 vnet_hw_interface_t * hi;
644 vm->os_punt_frame = tuntap_punt_frame;
646 tm->hw_if_index = vnet_register_interface
648 tuntap_dev_class.index, 0 /* device instance */,
649 tuntap_interface_class.index, 0);
650 hi = vnet_get_hw_interface (vnm, tm->hw_if_index);
651 tm->sw_if_index = hi->sw_if_index;
653 /* Interface is always up. */
654 vnet_hw_interface_set_flags (vnm, tm->hw_if_index,
655 VNET_HW_INTERFACE_FLAG_LINK_UP);
656 vnet_sw_interface_set_flags (vnm, tm->sw_if_index,
657 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
661 clib_file_t template = {0};
662 template.read_function = tuntap_read_ready;
663 template.file_descriptor = tm->dev_net_tun_fd;
664 tm->clib_file_index = clib_file_add (&file_main, &template);
670 if (tm->dev_net_tun_fd >= 0)
671 close (tm->dev_net_tun_fd);
672 if (tm->dev_tap_fd >= 0)
673 close (tm->dev_tap_fd);
679 VLIB_CONFIG_FUNCTION (tuntap_config, "tuntap");
682 * @brief Add or Del IP4 address to tun/tap interface
684 * @param *im - ip4_main_t
685 * @param opaque - uword
686 * @param sw_if_index - u32
687 * @param *address - ip4_address_t
688 * @param is_delete - u32
692 tuntap_ip4_add_del_interface_address (ip4_main_t * im,
695 ip4_address_t * address,
697 u32 if_address_index,
700 tuntap_main_t * tm = &tuntap_main;
702 subif_address_t subif_addr, * ap;
705 /** Tuntap disabled, or using a "normal" interface. */
706 if (tm->have_normal_interface || tm->dev_tap_fd < 0)
709 /* if the address is being applied to an interface that is not in
710 * the same table/VRF as this tap, then ignore it.
711 * If we don't do this overlapping address spaces in the diferent tables
712 * breaks the linux host's routing tables */
713 if (fib_table_get_index_for_sw_if_index(FIB_PROTOCOL_IP4,
715 fib_table_get_index_for_sw_if_index(FIB_PROTOCOL_IP4,
719 /** See if we already know about this subif */
720 memset (&subif_addr, 0, sizeof (subif_addr));
721 subif_addr.sw_if_index = sw_if_index;
722 clib_memcpy (&subif_addr.addr, address, sizeof (*address));
724 p = mhash_get (&tm->subif_mhash, &subif_addr);
727 ap = pool_elt_at_index (tm->subifs, p[0]);
730 pool_get (tm->subifs, ap);
732 mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
735 /* Use subif pool index to select alias device. */
736 memset (&ifr, 0, sizeof (ifr));
737 snprintf (ifr.ifr_name, sizeof(ifr.ifr_name),
738 "%s:%d", tm->tun_name, (int)(ap - tm->subifs));
740 /* the tuntap punt/inject is enabled for IPv4 RX so long as
741 * any vpp interface has an IPv4 address.
742 * this is also ref counted.
744 ip4_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
748 struct sockaddr_in * sin;
750 sin = (struct sockaddr_in *)&ifr.ifr_addr;
752 /* Set ipv4 address, netmask. */
753 sin->sin_family = AF_INET;
754 clib_memcpy (&sin->sin_addr.s_addr, address, 4);
755 if (ioctl (tm->dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
756 clib_unix_warning ("ioctl SIOCSIFADDR");
758 sin->sin_addr.s_addr = im->fib_masks[address_length];
759 if (ioctl (tm->dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
760 clib_unix_warning ("ioctl SIOCSIFNETMASK");
764 mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */);
765 pool_put (tm->subifs, ap);
768 /* get flags, modify to bring up interface... */
769 if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
770 clib_unix_warning ("ioctl SIOCGIFFLAGS");
773 ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
775 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
777 if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
778 clib_unix_warning ("ioctl SIOCSIFFLAGS");
782 * @brief workaround for a known include file bug.
783 * including @c <linux/ipv6.h> causes multiple definitions if
784 * @c <netinet/in.h is also included.
787 struct in6_addr ifr6_addr;
793 * @brief Add or Del tun/tap interface address.
795 * Both the v6 interface address API and the way ifconfig
796 * displays subinterfaces differ from their v4 couterparts.
797 * The code given here seems to work but YMMV.
799 * @param *im - ip6_main_t
800 * @param opaque - uword
801 * @param sw_if_index - u32
802 * @param *address - ip6_address_t
803 * @param address_length - u32
804 * @param if_address_index - u32
805 * @param is_delete - u32
808 tuntap_ip6_add_del_interface_address (ip6_main_t * im,
811 ip6_address_t * address,
813 u32 if_address_index,
816 tuntap_main_t * tm = &tuntap_main;
818 struct in6_ifreq ifr6;
819 subif_address_t subif_addr, * ap;
822 /* Tuntap disabled, or using a "normal" interface. */
823 if (tm->have_normal_interface || tm->dev_tap_fd < 0)
826 /* if the address is being applied to an interface that is not in
827 * the same table/VRF as this tap, then ignore it.
828 * If we don't do this overlapping address spaces in the diferent tables
829 * breaks the linux host's routing tables */
830 if (fib_table_get_index_for_sw_if_index(FIB_PROTOCOL_IP6,
832 fib_table_get_index_for_sw_if_index(FIB_PROTOCOL_IP6,
836 /* See if we already know about this subif */
837 memset (&subif_addr, 0, sizeof (subif_addr));
838 subif_addr.sw_if_index = sw_if_index;
839 subif_addr.is_v6 = 1;
840 clib_memcpy (&subif_addr.addr, address, sizeof (*address));
842 p = mhash_get (&tm->subif_mhash, &subif_addr);
845 ap = pool_elt_at_index (tm->subifs, p[0]);
848 pool_get (tm->subifs, ap);
850 mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
853 /* Use subif pool index to select alias device. */
854 memset (&ifr, 0, sizeof (ifr));
855 memset (&ifr6, 0, sizeof (ifr6));
856 snprintf (ifr.ifr_name, sizeof(ifr.ifr_name),
857 "%s:%d", tm->tun_name, (int)(ap - tm->subifs));
859 /* the tuntap punt/inject is enabled for IPv6 RX so long as
860 * any vpp interface has an IPv6 address.
861 * this is also ref counted.
863 ip6_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
867 int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
869 clib_unix_warning ("get ifindex socket");
871 if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
872 clib_unix_warning ("get ifindex");
874 ifr6.ifr6_ifindex = ifr.ifr_ifindex;
875 ifr6.ifr6_prefixlen = address_length;
876 clib_memcpy (&ifr6.ifr6_addr, address, 16);
878 if (ioctl (sockfd, SIOCSIFADDR, &ifr6) < 0)
879 clib_unix_warning ("set address");
886 int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
888 clib_unix_warning ("get ifindex socket");
890 if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
891 clib_unix_warning ("get ifindex");
893 ifr6.ifr6_ifindex = ifr.ifr_ifindex;
894 ifr6.ifr6_prefixlen = address_length;
895 clib_memcpy (&ifr6.ifr6_addr, address, 16);
897 if (ioctl (sockfd, SIOCDIFADDR, &ifr6) < 0)
898 clib_unix_warning ("del address");
903 mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */);
904 pool_put (tm->subifs, ap);
909 * @brief TX the tun/tap frame
911 * @param *vm - vlib_main_t
912 * @param *node - vlib_node_runtime_t
913 * @param *frame - vlib_frame_t
917 tuntap_punt_frame (vlib_main_t * vm,
918 vlib_node_runtime_t * node,
919 vlib_frame_t * frame)
921 tuntap_tx (vm, node, frame);
922 vlib_frame_free (vm, node, frame);
926 * @brief Free the tun/tap frame
928 * @param *vm - vlib_main_t
929 * @param *node - vlib_node_runtime_t
930 * @param *frame - vlib_frame_t
934 tuntap_nopunt_frame (vlib_main_t * vm,
935 vlib_node_runtime_t * node,
936 vlib_frame_t * frame)
938 u32 * buffers = vlib_frame_args (frame);
939 uword n_packets = frame->n_vectors;
940 vlib_buffer_free (vm, buffers, n_packets);
941 vlib_frame_free (vm, node, frame);
944 VNET_HW_INTERFACE_CLASS (tuntap_interface_class,static) = {
946 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
950 * @brief Format tun/tap interface name
952 * @param *s - u8 - formatter string
953 * @param *args - va_list
955 * @return *s - u8 - formatted string
958 static u8 * format_tuntap_interface_name (u8 * s, va_list * args)
960 u32 i = va_arg (*args, u32);
962 s = format (s, "tuntap-%d", i);
967 * @brief TX packet out tun/tap
969 * @param *vm - vlib_main_t
970 * @param *node - vlib_node_runtime_t
971 * @param *frame - vlib_frame_t
973 * @return n_buffers - uword - Packets transmitted
977 tuntap_intfc_tx (vlib_main_t * vm,
978 vlib_node_runtime_t * node,
979 vlib_frame_t * frame)
981 tuntap_main_t * tm = &tuntap_main;
982 u32 * buffers = vlib_frame_args (frame);
983 uword n_buffers = frame->n_vectors;
985 /* Normal interface transmit happens only on the normal interface... */
986 if (tm->have_normal_interface)
987 return tuntap_tx (vm, node, frame);
989 vlib_buffer_free (vm, buffers, n_buffers);
993 VNET_DEVICE_CLASS (tuntap_dev_class,static) = {
995 .tx_function = tuntap_intfc_tx,
996 .format_device_name = format_tuntap_interface_name,
1000 * @brief tun/tap node init
1002 * @param *vm - vlib_main_t
1004 * @return error - clib_error_t
1007 static clib_error_t *
1008 tuntap_init (vlib_main_t * vm)
1010 clib_error_t * error;
1011 ip4_main_t * im4 = &ip4_main;
1012 ip6_main_t * im6 = &ip6_main;
1013 ip4_add_del_interface_address_callback_t cb4;
1014 ip6_add_del_interface_address_callback_t cb6;
1015 tuntap_main_t * tm = &tuntap_main;
1016 vlib_thread_main_t * m = vlib_get_thread_main ();
1018 error = vlib_call_init_function (vm, ip4_init);
1022 mhash_init (&tm->subif_mhash, sizeof (u32), sizeof(subif_address_t));
1024 cb4.function = tuntap_ip4_add_del_interface_address;
1025 cb4.function_opaque = 0;
1026 vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1028 cb6.function = tuntap_ip6_add_del_interface_address;
1029 cb6.function_opaque = 0;
1030 vec_add1 (im6->add_del_interface_address_callbacks, cb6);
1031 vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1032 CLIB_CACHE_LINE_BYTES);
1037 VLIB_INIT_FUNCTION (tuntap_init);