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);
72 * @brief TUNTAP per thread struct
76 /** Vector of VLIB rx buffers to use. We allocate them in blocks
77 of VLIB_FRAME_SIZE (256). */
80 /** Vector of iovecs for readv/writev calls. */
82 } tuntap_per_thread_t;
85 * @brief TUNTAP node main state
89 /** per thread variables */
90 tuntap_per_thread_t *threads;
92 /** File descriptors for /dev/net/tun and provisioning socket. */
93 int dev_net_tun_fd, dev_tap_fd;
95 /** Create a "tap" [ethernet] encaps device */
98 /** 1 if a "normal" routed intfc, 0 if a punt/inject interface */
100 int have_normal_interface;
102 /** tap device destination MAC address. Required, or Linux drops pkts */
105 /** Interface MTU in bytes and # of default sized buffers. */
106 u32 mtu_bytes, mtu_buffers;
108 /** Linux interface name for tun device. */
111 /** Pool of subinterface addresses */
112 subif_address_t *subifs;
114 /** Hash for subif addresses */
117 /** Unix file index */
120 /** For the "normal" interface, if configured */
121 u32 hw_if_index, sw_if_index;
125 static tuntap_main_t tuntap_main = {
128 /** Suitable defaults for an Ethernet-like tun/tap device */
129 .mtu_bytes = 4096 + 256,
136 * Output node, writes the buffers comprising the incoming frame
137 * to the tun/tap device, aka hands them to the Linux kernel stack.
139 * @param *vm - vlib_main_t
140 * @param *node - vlib_node_runtime_t
141 * @param *frame - vlib_frame_t
147 tuntap_tx (vlib_main_t * vm, vlib_node_runtime_t * node, 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))
185 b = vlib_get_buffer (vm, b->next_buffer);
187 vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
189 iov->iov_base = b->data + b->current_data;
190 iov->iov_len = b->current_length;
191 l += b->current_length;
193 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
196 if (writev (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
197 vec_len (tm->threads[thread_index].iovecs)) < l)
198 clib_unix_warning ("writev");
203 /* Update tuntap interface output stats. */
204 vlib_increment_combined_counter (im->combined_sw_if_counters
205 + VNET_INTERFACE_COUNTER_TX,
207 tm->sw_if_index, n_packets, n_bytes);
210 /** The normal interface path flattens the buffer chain */
211 if (tm->have_normal_interface)
212 vlib_buffer_free_no_next (vm, buffers, n_packets);
214 vlib_buffer_free (vm, buffers, n_packets);
220 VLIB_REGISTER_NODE (tuntap_tx_node,static) = {
221 .function = tuntap_tx,
223 .type = VLIB_NODE_TYPE_INTERNAL,
229 * @brief TUNTAP receive node
232 * @param *vm - vlib_main_t
233 * @param *node - vlib_node_runtime_t
234 * @param *frame - vlib_frame_t
240 tuntap_rx (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
242 tuntap_main_t *tm = &tuntap_main;
245 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
246 u16 thread_index = vlib_get_thread_index ();
248 /** Make sure we have some RX buffers. */
250 uword n_left = vec_len (tm->threads[thread_index].rx_buffers);
253 if (n_left < VLIB_FRAME_SIZE / 2)
255 if (!tm->threads[thread_index].rx_buffers)
256 vec_alloc (tm->threads[thread_index].rx_buffers, VLIB_FRAME_SIZE);
259 vlib_buffer_alloc (vm,
260 tm->threads[thread_index].rx_buffers + n_left,
261 VLIB_FRAME_SIZE - n_left);
262 _vec_len (tm->threads[thread_index].rx_buffers) = n_left + n_alloc;
266 /** Allocate RX buffers from end of rx_buffers.
267 Turn them into iovecs to pass to readv. */
269 uword i_rx = vec_len (tm->threads[thread_index].rx_buffers) - 1;
271 word i, n_bytes_left, n_bytes_in_packet;
273 /** We should have enough buffers left for an MTU sized packet. */
274 ASSERT (vec_len (tm->threads[thread_index].rx_buffers) >=
277 vec_validate (tm->threads[thread_index].iovecs, tm->mtu_buffers - 1);
278 for (i = 0; i < tm->mtu_buffers; i++)
282 tm->threads[thread_index].rx_buffers[i_rx - i]);
283 tm->threads[thread_index].iovecs[i].iov_base = b->data;
284 tm->threads[thread_index].iovecs[i].iov_len = buffer_size;
288 readv (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
290 n_bytes_in_packet = n_bytes_left;
291 if (n_bytes_left <= 0)
294 clib_unix_warning ("readv %d", n_bytes_left);
298 bi = tm->threads[thread_index].rx_buffers[i_rx];
302 b = vlib_get_buffer (vm, tm->threads[thread_index].rx_buffers[i_rx]);
306 n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
308 n_bytes_left -= buffer_size;
310 if (n_bytes_left <= 0)
316 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
317 b->next_buffer = tm->threads[thread_index].rx_buffers[i_rx];
320 /** Interface counters for tuntap interface. */
321 vlib_increment_combined_counter
322 (vnet_main.interface_main.combined_sw_if_counters
323 + VNET_INTERFACE_COUNTER_RX,
324 thread_index, tm->sw_if_index, 1, n_bytes_in_packet);
326 _vec_len (tm->threads[thread_index].rx_buffers) = i_rx;
329 b = vlib_get_buffer (vm, bi);
333 uword n_trace = vlib_get_trace_count (vm, node);
335 vnet_buffer (b)->sw_if_index[VLIB_RX] = tm->sw_if_index;
336 vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
339 * Turn this on if you run into
340 * "bad monkey" contexts, and you want to know exactly
341 * which nodes they've visited...
343 if (VLIB_BUFFER_TRACE_TRAJECTORY)
346 b->error = node->errors[0];
350 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
353 switch (b->data[0] & 0xf0)
356 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
359 next_index = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
362 next_index = VNET_DEVICE_INPUT_NEXT_DROP;
366 /* The linux kernel couldn't care less if our interface is up */
367 if (tm->have_normal_interface)
369 vnet_main_t *vnm = vnet_get_main ();
370 vnet_sw_interface_t *si;
371 si = vnet_get_sw_interface (vnm, tm->sw_if_index);
372 if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
373 next_index = VNET_DEVICE_INPUT_NEXT_DROP;
376 vnet_feature_start_device_input_x1 (tm->sw_if_index, &next_index, b);
378 vlib_set_next_frame_buffer (vm, node, next_index, bi);
382 vlib_trace_buffer (vm, node, next_index, b, /* follow_chain */ 1);
383 vlib_set_trace_count (vm, node, n_trace - 1);
391 * @brief TUNTAP_RX error strings
393 static char *tuntap_rx_error_strings[] = {
394 "unknown packet type",
398 VLIB_REGISTER_NODE (tuntap_rx_node,static) = {
399 .function = tuntap_rx,
401 .sibling_of = "device-input",
402 .type = VLIB_NODE_TYPE_INPUT,
403 .state = VLIB_NODE_STATE_INTERRUPT,
406 .error_strings = tuntap_rx_error_strings,
411 * @brief Gets called when file descriptor is ready from epoll.
413 * @param *uf - clib_file_t
415 * @return error - clib_error_t
417 static clib_error_t *
418 tuntap_read_ready (clib_file_t * uf)
420 vlib_main_t *vm = vlib_get_main ();
421 vlib_node_set_interrupt_pending (vm, tuntap_rx_node.index);
426 * @brief Clean up the tun/tap device
428 * @param *vm - vlib_main_t
430 * @return error - clib_error_t
433 static clib_error_t *
434 tuntap_exit (vlib_main_t * vm)
436 tuntap_main_t *tm = &tuntap_main;
441 if (!tm->dev_net_tun_fd || tm->dev_net_tun_fd < 0)
444 sfd = socket (AF_INET, SOCK_STREAM, 0);
446 clib_unix_warning ("provisioning socket");
448 memset (&ifr, 0, sizeof (ifr));
449 strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
451 /* get flags, modify to bring down interface... */
452 if (ioctl (sfd, SIOCGIFFLAGS, &ifr) < 0)
453 clib_unix_warning ("SIOCGIFFLAGS");
455 ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
457 if (ioctl (sfd, SIOCSIFFLAGS, &ifr) < 0)
458 clib_unix_warning ("SIOCSIFFLAGS");
460 /* Turn off persistence */
461 if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 0) < 0)
462 clib_unix_warning ("TUNSETPERSIST");
463 close (tm->dev_tap_fd);
464 if (tm->dev_net_tun_fd >= 0)
465 close (tm->dev_net_tun_fd);
472 VLIB_MAIN_LOOP_EXIT_FUNCTION (tuntap_exit);
475 * @brief CLI function for tun/tap config
477 * @param *vm - vlib_main_t
478 * @param *input - unformat_input_t
480 * @return error - clib_error_t
483 static clib_error_t *
484 tuntap_config (vlib_main_t * vm, unformat_input_t * input)
486 tuntap_main_t *tm = &tuntap_main;
487 clib_error_t *error = 0;
490 int flags = IFF_TUN | IFF_NO_PI;
491 int is_enabled = 0, is_ether = 0, have_normal_interface = 0;
492 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
494 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
496 if (unformat (input, "mtu %d", &tm->mtu_bytes))
498 else if (unformat (input, "enable"))
500 else if (unformat (input, "disable"))
502 else if (unformat (input, "ethernet") || unformat (input, "ether"))
504 else if (unformat (input, "have-normal-interface") ||
505 unformat (input, "have-normal"))
506 have_normal_interface = 1;
507 else if (unformat (input, "name %s", &name))
508 tm->tun_name = (char *) name;
510 return clib_error_return (0, "unknown input `%U'",
511 format_unformat_error, input);
514 tm->dev_net_tun_fd = -1;
522 clib_warning ("tuntap disabled: must be superuser");
526 tm->is_ether = is_ether;
527 tm->have_normal_interface = have_normal_interface;
530 flags = IFF_TAP | IFF_NO_PI;
532 if ((tm->dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
534 error = clib_error_return_unix (0, "open /dev/net/tun");
538 memset (&ifr, 0, sizeof (ifr));
539 strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
540 ifr.ifr_flags = flags;
541 if (ioctl (tm->dev_net_tun_fd, TUNSETIFF, (void *) &ifr) < 0)
543 error = clib_error_return_unix (0, "ioctl TUNSETIFF");
547 /* Make it persistent, at least until we split. */
548 if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 1) < 0)
550 error = clib_error_return_unix (0, "TUNSETPERSIST");
554 /* Open a provisioning socket */
555 if ((tm->dev_tap_fd = socket (PF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
557 error = clib_error_return_unix (0, "socket");
561 /* Find the interface index. */
564 struct sockaddr_ll sll;
566 memset (&ifr, 0, sizeof (ifr));
567 strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
568 if (ioctl (tm->dev_tap_fd, SIOCGIFINDEX, &ifr) < 0)
570 error = clib_error_return_unix (0, "ioctl SIOCGIFINDEX");
574 /* Bind the provisioning socket to the interface. */
575 memset (&sll, 0, sizeof (sll));
576 sll.sll_family = AF_PACKET;
577 sll.sll_ifindex = ifr.ifr_ifindex;
578 sll.sll_protocol = htons (ETH_P_ALL);
580 if (bind (tm->dev_tap_fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
582 error = clib_error_return_unix (0, "bind");
587 /* non-blocking I/O on /dev/tapX */
590 if (ioctl (tm->dev_net_tun_fd, FIONBIO, &one) < 0)
592 error = clib_error_return_unix (0, "ioctl FIONBIO");
597 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
599 ifr.ifr_mtu = tm->mtu_bytes;
600 if (ioctl (tm->dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
602 error = clib_error_return_unix (0, "ioctl SIOCSIFMTU");
606 /* get flags, modify to bring up interface... */
607 if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
609 error = clib_error_return_unix (0, "ioctl SIOCGIFFLAGS");
613 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
615 if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
617 error = clib_error_return_unix (0, "ioctl SIOCSIFFLAGS");
623 if (ioctl (tm->dev_tap_fd, SIOCGIFHWADDR, &ifr) < 0)
625 error = clib_error_return_unix (0, "ioctl SIOCGIFHWADDR");
629 clib_memcpy (tm->ether_dst_mac, ifr.ifr_hwaddr.sa_data, 6);
632 if (have_normal_interface)
634 vnet_main_t *vnm = vnet_get_main ();
635 error = ethernet_register_interface
636 (vnm, tuntap_dev_class.index, 0 /* device instance */ ,
637 tm->ether_dst_mac /* ethernet address */ ,
638 &tm->hw_if_index, 0 /* flag change */ );
640 clib_error_report (error);
641 tm->sw_if_index = tm->hw_if_index;
642 vm->os_punt_frame = tuntap_nopunt_frame;
646 vnet_main_t *vnm = vnet_get_main ();
647 vnet_hw_interface_t *hi;
649 vm->os_punt_frame = tuntap_punt_frame;
651 tm->hw_if_index = vnet_register_interface
652 (vnm, tuntap_dev_class.index, 0 /* device instance */ ,
653 tuntap_interface_class.index, 0);
654 hi = vnet_get_hw_interface (vnm, tm->hw_if_index);
655 tm->sw_if_index = hi->sw_if_index;
657 /* Interface is always up. */
658 vnet_hw_interface_set_flags (vnm, tm->hw_if_index,
659 VNET_HW_INTERFACE_FLAG_LINK_UP);
660 vnet_sw_interface_set_flags (vnm, tm->sw_if_index,
661 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
665 clib_file_t template = { 0 };
666 template.read_function = tuntap_read_ready;
667 template.file_descriptor = tm->dev_net_tun_fd;
668 tm->clib_file_index = clib_file_add (&file_main, &template);
674 if (tm->dev_net_tun_fd >= 0)
675 close (tm->dev_net_tun_fd);
676 if (tm->dev_tap_fd >= 0)
677 close (tm->dev_tap_fd);
683 VLIB_CONFIG_FUNCTION (tuntap_config, "tuntap");
686 * @brief Add or Del IP4 address to tun/tap interface
688 * @param *im - ip4_main_t
689 * @param opaque - uword
690 * @param sw_if_index - u32
691 * @param *address - ip4_address_t
692 * @param is_delete - u32
696 tuntap_ip4_add_del_interface_address (ip4_main_t * im,
699 ip4_address_t * address,
701 u32 if_address_index, u32 is_delete)
703 tuntap_main_t *tm = &tuntap_main;
705 subif_address_t subif_addr, *ap;
708 /** Tuntap disabled, or using a "normal" interface. */
709 if (tm->have_normal_interface || tm->dev_tap_fd < 0)
712 /* if the address is being applied to an interface that is not in
713 * the same table/VRF as this tap, then ignore it.
714 * If we don't do this overlapping address spaces in the diferent tables
715 * breaks the linux host's routing tables */
716 if (fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
718 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, tm->sw_if_index))
721 /** See if we already know about this subif */
722 memset (&subif_addr, 0, sizeof (subif_addr));
723 subif_addr.sw_if_index = sw_if_index;
724 clib_memcpy (&subif_addr.addr, address, sizeof (*address));
726 p = mhash_get (&tm->subif_mhash, &subif_addr);
729 ap = pool_elt_at_index (tm->subifs, p[0]);
732 pool_get (tm->subifs, ap);
734 mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
737 /* Use subif pool index to select alias device. */
738 memset (&ifr, 0, sizeof (ifr));
739 snprintf (ifr.ifr_name, sizeof (ifr.ifr_name),
740 "%s:%d", tm->tun_name, (int) (ap - tm->subifs));
742 /* the tuntap punt/inject is enabled for IPv4 RX so long as
743 * any vpp interface has an IPv4 address.
744 * this is also ref counted.
746 ip4_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
750 struct sockaddr_in *sin;
752 sin = (struct sockaddr_in *) &ifr.ifr_addr;
754 /* Set ipv4 address, netmask. */
755 sin->sin_family = AF_INET;
756 clib_memcpy (&sin->sin_addr.s_addr, address, 4);
757 if (ioctl (tm->dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
758 clib_unix_warning ("ioctl SIOCSIFADDR");
760 sin->sin_addr.s_addr = im->fib_masks[address_length];
761 if (ioctl (tm->dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
762 clib_unix_warning ("ioctl SIOCSIFNETMASK");
766 mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */ );
767 pool_put (tm->subifs, ap);
770 /* get flags, modify to bring up interface... */
771 if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
772 clib_unix_warning ("ioctl SIOCGIFFLAGS");
775 ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
777 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
779 if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
780 clib_unix_warning ("ioctl SIOCSIFFLAGS");
784 * @brief workaround for a known include file bug.
785 * including @c <linux/ipv6.h> causes multiple definitions if
786 * @c <netinet/in.h is also included.
790 struct in6_addr ifr6_addr;
796 * @brief Add or Del tun/tap interface address.
798 * Both the v6 interface address API and the way ifconfig
799 * displays subinterfaces differ from their v4 couterparts.
800 * The code given here seems to work but YMMV.
802 * @param *im - ip6_main_t
803 * @param opaque - uword
804 * @param sw_if_index - u32
805 * @param *address - ip6_address_t
806 * @param address_length - u32
807 * @param if_address_index - u32
808 * @param is_delete - u32
811 tuntap_ip6_add_del_interface_address (ip6_main_t * im,
814 ip6_address_t * address,
816 u32 if_address_index, u32 is_delete)
818 tuntap_main_t *tm = &tuntap_main;
820 struct in6_ifreq ifr6;
821 subif_address_t subif_addr, *ap;
824 /* Tuntap disabled, or using a "normal" interface. */
825 if (tm->have_normal_interface || tm->dev_tap_fd < 0)
828 /* if the address is being applied to an interface that is not in
829 * the same table/VRF as this tap, then ignore it.
830 * If we don't do this overlapping address spaces in the diferent tables
831 * breaks the linux host's routing tables */
832 if (fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP6,
834 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP6, tm->sw_if_index))
837 /* See if we already know about this subif */
838 memset (&subif_addr, 0, sizeof (subif_addr));
839 subif_addr.sw_if_index = sw_if_index;
840 subif_addr.is_v6 = 1;
841 clib_memcpy (&subif_addr.addr, address, sizeof (*address));
843 p = mhash_get (&tm->subif_mhash, &subif_addr);
846 ap = pool_elt_at_index (tm->subifs, p[0]);
849 pool_get (tm->subifs, ap);
851 mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
854 /* Use subif pool index to select alias device. */
855 memset (&ifr, 0, sizeof (ifr));
856 memset (&ifr6, 0, sizeof (ifr6));
857 snprintf (ifr.ifr_name, sizeof (ifr.ifr_name),
858 "%s:%d", tm->tun_name, (int) (ap - tm->subifs));
860 /* the tuntap punt/inject is enabled for IPv6 RX so long as
861 * any vpp interface has an IPv6 address.
862 * this is also ref counted.
864 ip6_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
868 int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
870 clib_unix_warning ("get ifindex socket");
872 if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
873 clib_unix_warning ("get ifindex");
875 ifr6.ifr6_ifindex = ifr.ifr_ifindex;
876 ifr6.ifr6_prefixlen = address_length;
877 clib_memcpy (&ifr6.ifr6_addr, address, 16);
879 if (ioctl (sockfd, SIOCSIFADDR, &ifr6) < 0)
880 clib_unix_warning ("set address");
887 int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
889 clib_unix_warning ("get ifindex socket");
891 if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
892 clib_unix_warning ("get ifindex");
894 ifr6.ifr6_ifindex = ifr.ifr_ifindex;
895 ifr6.ifr6_prefixlen = address_length;
896 clib_memcpy (&ifr6.ifr6_addr, address, 16);
898 if (ioctl (sockfd, SIOCDIFADDR, &ifr6) < 0)
899 clib_unix_warning ("del address");
904 mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */ );
905 pool_put (tm->subifs, ap);
910 * @brief TX the tun/tap frame
912 * @param *vm - vlib_main_t
913 * @param *node - vlib_node_runtime_t
914 * @param *frame - vlib_frame_t
918 tuntap_punt_frame (vlib_main_t * vm,
919 vlib_node_runtime_t * node, 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, vlib_frame_t * frame)
937 u32 *buffers = vlib_frame_args (frame);
938 uword n_packets = frame->n_vectors;
939 vlib_buffer_free (vm, buffers, n_packets);
940 vlib_frame_free (vm, node, frame);
944 VNET_HW_INTERFACE_CLASS (tuntap_interface_class,static) = {
946 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
951 * @brief Format tun/tap interface name
953 * @param *s - u8 - formatter string
954 * @param *args - va_list
956 * @return *s - u8 - formatted string
960 format_tuntap_interface_name (u8 * s, va_list * args)
962 u32 i = va_arg (*args, u32);
964 s = format (s, "tuntap-%d", i);
969 * @brief TX packet out tun/tap
971 * @param *vm - vlib_main_t
972 * @param *node - vlib_node_runtime_t
973 * @param *frame - vlib_frame_t
975 * @return n_buffers - uword - Packets transmitted
979 tuntap_intfc_tx (vlib_main_t * vm,
980 vlib_node_runtime_t * node, vlib_frame_t * frame)
982 tuntap_main_t *tm = &tuntap_main;
983 u32 *buffers = vlib_frame_args (frame);
984 uword n_buffers = frame->n_vectors;
986 /* Normal interface transmit happens only on the normal interface... */
987 if (tm->have_normal_interface)
988 return tuntap_tx (vm, node, frame);
990 vlib_buffer_free (vm, buffers, n_buffers);
995 VNET_DEVICE_CLASS (tuntap_dev_class,static) = {
997 .tx_function = tuntap_intfc_tx,
998 .format_device_name = format_tuntap_interface_name,
1003 * @brief tun/tap node init
1005 * @param *vm - vlib_main_t
1007 * @return error - clib_error_t
1010 static clib_error_t *
1011 tuntap_init (vlib_main_t * vm)
1013 clib_error_t *error;
1014 ip4_main_t *im4 = &ip4_main;
1015 ip6_main_t *im6 = &ip6_main;
1016 ip4_add_del_interface_address_callback_t cb4;
1017 ip6_add_del_interface_address_callback_t cb6;
1018 tuntap_main_t *tm = &tuntap_main;
1019 vlib_thread_main_t *m = vlib_get_thread_main ();
1021 error = vlib_call_init_function (vm, ip4_init);
1025 mhash_init (&tm->subif_mhash, sizeof (u32), sizeof (subif_address_t));
1027 cb4.function = tuntap_ip4_add_del_interface_address;
1028 cb4.function_opaque = 0;
1029 vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1031 cb6.function = tuntap_ip6_add_del_interface_address;
1032 cb6.function_opaque = 0;
1033 vec_add1 (im6->add_del_interface_address_callbacks, cb6);
1034 vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1035 CLIB_CACHE_LINE_BYTES);
1040 VLIB_INIT_FUNCTION (tuntap_init);
1043 * fd.io coding-style-patch-verification: ON
1046 * eval: (c-set-style "gnu")