2 *------------------------------------------------------------------
3 * tapcli.c - dynamic tap interface hookup
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 dynamic tap interface hookup
24 #include <fcntl.h> /* for open */
25 #include <sys/ioctl.h>
26 #include <sys/socket.h>
28 #include <sys/types.h>
29 #include <sys/uio.h> /* for iovec */
30 #include <netinet/in.h>
32 #include <linux/if_arp.h>
33 #include <linux/if_tun.h>
35 #include <vlib/vlib.h>
36 #include <vlib/unix/unix.h>
38 #include <vnet/ip/ip.h>
40 #include <vnet/ethernet/ethernet.h>
42 #include <vnet/feature/feature.h>
43 #include <vnet/devices/devices.h>
44 #include <vnet/unix/tuntap.h>
45 #include <vnet/unix/tapcli.h>
47 static vnet_device_class_t tapcli_dev_class;
48 static vnet_hw_interface_class_t tapcli_interface_class;
49 static vlib_node_registration_t tapcli_rx_node;
51 static void tapcli_nopunt_frame (vlib_main_t * vm,
52 vlib_node_runtime_t * node,
53 vlib_frame_t * frame);
55 * @brief Struct for the tapcli interface
66 u32 per_interface_next_index;
72 * @brief Struct for RX trace
79 * @brief Function to format TAP CLI trace
81 * @param *s - u8 - formatting string
82 * @param *va - va_list
84 * @return *s - u8 - formatted string
87 u8 * format_tapcli_rx_trace (u8 * s, va_list * va)
89 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
90 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
91 vnet_main_t * vnm = vnet_get_main();
92 tapcli_rx_trace_t * t = va_arg (*va, tapcli_rx_trace_t *);
93 s = format (s, "%U", format_vnet_sw_if_index_name,
99 * @brief TAPCLI per thread struct
103 /** Vector of VLIB rx buffers to use. We allocate them in blocks
104 of VLIB_FRAME_SIZE (256). */
107 /** Vector of iovecs for readv/writev calls. */
108 struct iovec * iovecs;
109 } tapcli_per_thread_t;
112 * @brief TAPCLI main state struct
115 /** per thread variables */
116 tapcli_per_thread_t * threads;
118 /** tap device destination MAC address. Required, or Linux drops pkts */
121 /** Interface MTU in bytes and # of default sized buffers. */
122 u32 mtu_bytes, mtu_buffers;
124 /** Vector of tap interfaces */
125 tapcli_interface_t * tapcli_interfaces;
127 /** Vector of deleted tap interfaces */
128 u32 * tapcli_inactive_interfaces;
130 /** Bitmap of tap interfaces with pending reads */
131 uword * pending_read_bitmap;
133 /** Hash table to find tapcli interface given hw_if_index */
134 uword * tapcli_interface_index_by_sw_if_index;
136 /** Hash table to find tapcli interface given unix fd */
137 uword * tapcli_interface_index_by_unix_fd;
139 /** renumbering table */
140 u32 * show_dev_instance_by_real_dev_instance;
142 /** 1 => disable CLI */
145 /** convenience - vlib_main_t */
146 vlib_main_t * vlib_main;
147 /** convenience - vnet_main_t */
148 vnet_main_t * vnet_main;
151 static tapcli_main_t tapcli_main;
154 * @brief tapcli TX node function
157 * Output node, writes the buffers comprising the incoming frame
158 * to the tun/tap device, aka hands them to the Linux kernel stack.
160 * @param *vm - vlib_main_t
161 * @param *node - vlib_node_runtime_t
162 * @param *frame - vlib_frame_t
164 * @return n_packets - uword
168 tapcli_tx (vlib_main_t * vm,
169 vlib_node_runtime_t * node,
170 vlib_frame_t * frame)
172 u32 * buffers = vlib_frame_args (frame);
173 uword n_packets = frame->n_vectors;
174 tapcli_main_t * tm = &tapcli_main;
175 tapcli_interface_t * ti;
177 u16 thread_index = vlib_get_thread_index ();
179 for (i = 0; i < n_packets; i++)
184 vnet_hw_interface_t * hw;
188 b = vlib_get_buffer (vm, buffers[i]);
190 tx_sw_if_index = vnet_buffer(b)->sw_if_index[VLIB_TX];
191 if (tx_sw_if_index == (u32)~0)
192 tx_sw_if_index = vnet_buffer(b)->sw_if_index[VLIB_RX];
194 ASSERT(tx_sw_if_index != (u32)~0);
196 /* Use the sup intfc to finesse vlan subifs */
197 hw = vnet_get_sup_hw_interface (tm->vnet_main, tx_sw_if_index);
198 tx_sw_if_index = hw->sw_if_index;
200 p = hash_get (tm->tapcli_interface_index_by_sw_if_index,
204 clib_warning ("sw_if_index %d unknown", tx_sw_if_index);
205 /* $$$ leak, but this should never happen... */
209 ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
211 /* Re-set iovecs if present. */
212 if (tm->threads[thread_index].iovecs)
213 _vec_len (tm->threads[thread_index].iovecs) = 0;
215 /* VLIB buffer chain -> Unix iovec(s). */
216 vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
217 iov->iov_base = b->data + b->current_data;
218 iov->iov_len = l = b->current_length;
220 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
223 b = vlib_get_buffer (vm, b->next_buffer);
225 vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
227 iov->iov_base = b->data + b->current_data;
228 iov->iov_len = b->current_length;
229 l += b->current_length;
230 } while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
233 if (writev (ti->unix_fd, tm->threads[thread_index].iovecs,
234 vec_len (tm->threads[thread_index].iovecs)) < l)
235 clib_unix_warning ("writev");
238 vlib_buffer_free(vm, vlib_frame_vector_args(frame), frame->n_vectors);
243 VLIB_REGISTER_NODE (tapcli_tx_node,static) = {
244 .function = tapcli_tx,
246 .type = VLIB_NODE_TYPE_INTERNAL,
251 * @brief Dispatch tapcli RX node function for node tap_cli_rx
254 * @param *vm - vlib_main_t
255 * @param *node - vlib_node_runtime_t
256 * @param *ti - tapcli_interface_t
258 * @return n_packets - uword
261 static uword tapcli_rx_iface(vlib_main_t * vm,
262 vlib_node_runtime_t * node,
263 tapcli_interface_t * ti)
265 tapcli_main_t * tm = &tapcli_main;
266 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
267 u32 n_trace = vlib_get_trace_count (vm, node);
269 u16 thread_index = vlib_get_thread_index ();
271 vnet_sw_interface_t * si;
273 u32 next = node->cached_next_index;
274 u32 n_left_to_next, next_index;
277 vnm = vnet_get_main();
278 si = vnet_get_sw_interface (vnm, ti->sw_if_index);
279 admin_down = !(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
281 vlib_get_next_frame(vm, node, next, to_next, n_left_to_next);
283 while (n_left_to_next) { // Fill at most one vector
284 vlib_buffer_t *b_first, *b, *prev;
286 word n_bytes_in_packet;
289 if (PREDICT_FALSE(vec_len(tm->threads[thread_index].rx_buffers) <
291 uword len = vec_len(tm->threads[thread_index].rx_buffers);
292 _vec_len(tm->threads[thread_index].rx_buffers) +=
293 vlib_buffer_alloc_from_free_list(vm, &tm->threads[thread_index].rx_buffers[len],
294 VLIB_FRAME_SIZE - len, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
295 if (PREDICT_FALSE(vec_len(tm->threads[thread_index].rx_buffers) <
297 vlib_node_increment_counter(vm, tapcli_rx_node.index,
298 TAPCLI_ERROR_BUFFER_ALLOC,
300 vec_len(tm->threads[thread_index].rx_buffers));
305 uword i_rx = vec_len (tm->threads[thread_index].rx_buffers) - 1;
307 /* Allocate RX buffers from end of rx_buffers.
308 Turn them into iovecs to pass to readv. */
309 vec_validate (tm->threads[thread_index].iovecs, tm->mtu_buffers - 1);
310 for (j = 0; j < tm->mtu_buffers; j++) {
311 b = vlib_get_buffer (vm, tm->threads[thread_index].rx_buffers[i_rx - j]);
312 tm->threads[thread_index].iovecs[j].iov_base = b->data;
313 tm->threads[thread_index].iovecs[j].iov_len = buffer_size;
316 n_bytes_left = readv (ti->unix_fd, tm->threads[thread_index].iovecs,
318 n_bytes_in_packet = n_bytes_left;
319 if (n_bytes_left <= 0) {
320 if (errno != EAGAIN) {
321 vlib_node_increment_counter(vm, tapcli_rx_node.index,
322 TAPCLI_ERROR_READ, 1);
327 bi_first = tm->threads[thread_index].rx_buffers[i_rx];
328 b = b_first = vlib_get_buffer (vm,
329 tm->threads[thread_index].rx_buffers[i_rx]);
333 b->current_length = n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
334 n_bytes_left -= buffer_size;
337 prev->next_buffer = bi;
338 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
343 if (n_bytes_left <= 0)
347 bi = tm->threads[thread_index].rx_buffers[i_rx];
348 b = vlib_get_buffer (vm, bi);
351 _vec_len (tm->threads[thread_index].rx_buffers) = i_rx;
353 b_first->total_length_not_including_first_buffer =
354 (n_bytes_in_packet > buffer_size) ? n_bytes_in_packet - buffer_size : 0;
355 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
357 VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b_first);
359 vnet_buffer (b_first)->sw_if_index[VLIB_RX] = ti->sw_if_index;
360 vnet_buffer (b_first)->sw_if_index[VLIB_TX] = (u32)~0;
362 b_first->error = node->errors[TAPCLI_ERROR_NONE];
363 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
364 next_index = (ti->per_interface_next_index != ~0) ?
365 ti->per_interface_next_index : next_index;
366 next_index = admin_down ? VNET_DEVICE_INPUT_NEXT_DROP : next_index;
368 to_next[0] = bi_first;
372 vnet_feature_start_device_input_x1 (ti->sw_if_index, &next_index, b_first);
374 vlib_validate_buffer_enqueue_x1 (vm, node, next,
375 to_next, n_left_to_next,
376 bi_first, next_index);
378 /* Interface counters for tapcli interface. */
379 if (PREDICT_TRUE(!admin_down)) {
380 vlib_increment_combined_counter (
381 vnet_main.interface_main.combined_sw_if_counters
382 + VNET_INTERFACE_COUNTER_RX,
383 thread_index, ti->sw_if_index,
384 1, n_bytes_in_packet);
386 if (PREDICT_FALSE(n_trace > 0)) {
387 vlib_trace_buffer (vm, node, next_index,
388 b_first, /* follow_chain */ 1);
391 tapcli_rx_trace_t *t0 = vlib_add_trace (vm, node, b_first, sizeof (*t0));
392 t0->sw_if_index = si->sw_if_index;
396 vlib_put_next_frame (vm, node, next, n_left_to_next);
398 vlib_set_trace_count (vm, node, n_trace);
399 return VLIB_FRAME_SIZE - n_left_to_next;
403 * @brief tapcli RX node function
406 * Input node from the Kernel tun/tap device
408 * @param *vm - vlib_main_t
409 * @param *node - vlib_node_runtime_t
410 * @param *frame - vlib_frame_t
412 * @return n_packets - uword
416 tapcli_rx (vlib_main_t * vm,
417 vlib_node_runtime_t * node,
418 vlib_frame_t * frame)
420 tapcli_main_t * tm = &tapcli_main;
421 static u32 * ready_interface_indices;
422 tapcli_interface_t * ti;
426 vec_reset_length (ready_interface_indices);
427 clib_bitmap_foreach (i, tm->pending_read_bitmap,
429 vec_add1 (ready_interface_indices, i);
432 if (vec_len (ready_interface_indices) == 0)
435 for (i = 0; i < vec_len(ready_interface_indices); i++)
437 tm->pending_read_bitmap =
438 clib_bitmap_set (tm->pending_read_bitmap,
439 ready_interface_indices[i], 0);
441 ti = vec_elt_at_index (tm->tapcli_interfaces, ready_interface_indices[i]);
442 total_count += tapcli_rx_iface(vm, node, ti);
444 return total_count; //This might return more than 256.
447 /** TAPCLI error strings */
448 static char * tapcli_rx_error_strings[] = {
449 #define _(sym,string) string,
454 VLIB_REGISTER_NODE (tapcli_rx_node, static) = {
455 .function = tapcli_rx,
457 .sibling_of = "device-input",
458 .type = VLIB_NODE_TYPE_INPUT,
459 .state = VLIB_NODE_STATE_INTERRUPT,
461 .n_errors = TAPCLI_N_ERROR,
462 .error_strings = tapcli_rx_error_strings,
463 .format_trace = format_tapcli_rx_trace,
468 * @brief Gets called when file descriptor is ready from epoll.
470 * @param *uf - clib_file_t
472 * @return error - clib_error_t
475 static clib_error_t * tapcli_read_ready (clib_file_t * uf)
477 vlib_main_t * vm = vlib_get_main();
478 tapcli_main_t * tm = &tapcli_main;
481 /** Schedule the rx node */
482 vlib_node_set_interrupt_pending (vm, tapcli_rx_node.index);
484 p = hash_get (tm->tapcli_interface_index_by_unix_fd, uf->file_descriptor);
486 /** Mark the specific tap interface ready-to-read */
488 tm->pending_read_bitmap = clib_bitmap_set (tm->pending_read_bitmap,
491 clib_warning ("fd %d not in hash table", uf->file_descriptor);
497 * @brief CLI function for TAPCLI configuration
499 * @param *vm - vlib_main_t
500 * @param *input - unformat_input_t
502 * @return error - clib_error_t
505 static clib_error_t *
506 tapcli_config (vlib_main_t * vm, unformat_input_t * input)
508 tapcli_main_t *tm = &tapcli_main;
509 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
511 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
513 if (unformat (input, "mtu %d", &tm->mtu_bytes))
515 else if (unformat (input, "disable"))
518 return clib_error_return (0, "unknown input `%U'",
519 format_unformat_error, input);
527 clib_warning ("tapcli disabled: must be superuser");
532 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
538 * @brief Renumber TAPCLI interface
540 * @param *hi - vnet_hw_interface_t
541 * @param new_dev_instance - u32
546 static int tap_name_renumber (vnet_hw_interface_t * hi,
547 u32 new_dev_instance)
549 tapcli_main_t *tm = &tapcli_main;
551 vec_validate_init_empty (tm->show_dev_instance_by_real_dev_instance,
552 hi->dev_instance, ~0);
554 tm->show_dev_instance_by_real_dev_instance [hi->dev_instance] =
560 VLIB_CONFIG_FUNCTION (tapcli_config, "tapcli");
563 * @brief Free "no punt" frame
565 * @param *vm - vlib_main_t
566 * @param *node - vlib_node_runtime_t
567 * @param *frame - vlib_frame_t
571 tapcli_nopunt_frame (vlib_main_t * vm,
572 vlib_node_runtime_t * node,
573 vlib_frame_t * frame)
575 u32 * buffers = vlib_frame_args (frame);
576 uword n_packets = frame->n_vectors;
577 vlib_buffer_free (vm, buffers, n_packets);
578 vlib_frame_free (vm, node, frame);
581 VNET_HW_INTERFACE_CLASS (tapcli_interface_class,static) = {
583 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
587 * @brief Formatter for TAPCLI interface name
589 * @param *s - formatter string
590 * @param *args - va_list
592 * @return *s - formatted string
595 static u8 * format_tapcli_interface_name (u8 * s, va_list * args)
597 u32 i = va_arg (*args, u32);
598 u32 show_dev_instance = ~0;
599 tapcli_main_t * tm = &tapcli_main;
601 if (i < vec_len (tm->show_dev_instance_by_real_dev_instance))
602 show_dev_instance = tm->show_dev_instance_by_real_dev_instance[i];
604 if (show_dev_instance != ~0)
605 i = show_dev_instance;
607 s = format (s, "tap-%d", i);
612 * @brief Modify interface flags for TAPCLI interface
614 * @param *vnm - vnet_main_t
615 * @param *hw - vnet_hw_interface_t
621 static u32 tapcli_flag_change (vnet_main_t * vnm,
622 vnet_hw_interface_t * hw,
625 tapcli_main_t *tm = &tapcli_main;
626 tapcli_interface_t *ti;
628 ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
630 if (flags & ETHERNET_INTERFACE_FLAG_MTU)
632 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
633 tm->mtu_bytes = hw->max_packet_bytes;
634 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
641 memcpy (&ifr, &ti->ifr, sizeof (ifr));
643 /* get flags, modify to bring up interface... */
644 if (ioctl (ti->provision_fd, SIOCGIFFLAGS, &ifr) < 0)
646 clib_unix_warning ("Couldn't get interface flags for %s", hw->name);
650 want_promisc = (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) != 0;
652 if (want_promisc == ti->is_promisc)
655 if (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL)
656 ifr.ifr_flags |= IFF_PROMISC;
658 ifr.ifr_flags &= ~(IFF_PROMISC);
660 /* get flags, modify to bring up interface... */
661 if (ioctl (ti->provision_fd, SIOCSIFFLAGS, &ifr) < 0)
663 clib_unix_warning ("Couldn't set interface flags for %s", hw->name);
667 ti->is_promisc = want_promisc;
674 * @brief Setting the TAP interface's next processing node
676 * @param *vnm - vnet_main_t
677 * @param hw_if_index - u32
678 * @param node_index - u32
681 static void tapcli_set_interface_next_node (vnet_main_t *vnm,
685 tapcli_main_t *tm = &tapcli_main;
686 tapcli_interface_t *ti;
687 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
689 ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
691 /** Shut off redirection */
692 if (node_index == ~0)
694 ti->per_interface_next_index = node_index;
698 ti->per_interface_next_index =
699 vlib_node_add_next (tm->vlib_main, tapcli_rx_node.index, node_index);
703 * @brief Set link_state == admin_state otherwise things like ip6 neighbor discovery breaks
705 * @param *vnm - vnet_main_t
706 * @param hw_if_index - u32
709 * @return error - clib_error_t
711 static clib_error_t *
712 tapcli_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
714 uword is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
716 u32 speed_duplex = VNET_HW_INTERFACE_FLAG_FULL_DUPLEX
717 | VNET_HW_INTERFACE_FLAG_SPEED_1G;
720 hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP | speed_duplex;
722 hw_flags = speed_duplex;
724 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
728 VNET_DEVICE_CLASS (tapcli_dev_class,static) = {
730 .tx_function = tapcli_tx,
731 .format_device_name = format_tapcli_interface_name,
732 .rx_redirect_to_node = tapcli_set_interface_next_node,
733 .name_renumber = tap_name_renumber,
734 .admin_up_down_function = tapcli_interface_admin_up_down,
738 * @brief Dump TAP interfaces
740 * @param **out_tapids - tapcli_interface_details_t
745 int vnet_tap_dump_ifs (tapcli_interface_details_t **out_tapids)
747 tapcli_main_t * tm = &tapcli_main;
748 tapcli_interface_t * ti;
750 tapcli_interface_details_t * r_tapids = NULL;
751 tapcli_interface_details_t * tapid = NULL;
753 vec_foreach (ti, tm->tapcli_interfaces) {
756 vec_add2(r_tapids, tapid, 1);
757 tapid->sw_if_index = ti->sw_if_index;
758 strncpy((char *)tapid->dev_name, ti->ifr.ifr_name, sizeof (ti->ifr.ifr_name)-1);
761 *out_tapids = r_tapids;
767 * @brief Get tap interface from inactive interfaces or create new
769 * @return interface - tapcli_interface_t
772 static tapcli_interface_t *tapcli_get_new_tapif()
774 tapcli_main_t * tm = &tapcli_main;
775 tapcli_interface_t *ti = NULL;
777 int inactive_cnt = vec_len(tm->tapcli_inactive_interfaces);
778 // if there are any inactive ifaces
779 if (inactive_cnt > 0) {
781 u32 ti_idx = tm->tapcli_inactive_interfaces[inactive_cnt - 1];
782 if (vec_len(tm->tapcli_interfaces) > ti_idx) {
783 ti = vec_elt_at_index (tm->tapcli_interfaces, ti_idx);
784 clib_warning("reusing tap interface");
786 // "remove" from inactive list
787 _vec_len(tm->tapcli_inactive_interfaces) -= 1;
790 // ti was not retrieved from inactive ifaces - create new
792 vec_add2 (tm->tapcli_interfaces, ti, 1);
801 unsigned int ifindex;
805 * @brief Connect a TAP interface
807 * @param vm - vlib_main_t
808 * @param ap - vnet_tap_connect_args_t
813 int vnet_tap_connect (vlib_main_t * vm, vnet_tap_connect_args_t *ap)
815 tapcli_main_t * tm = &tapcli_main;
816 tapcli_interface_t * ti = NULL;
821 clib_error_t * error;
827 return VNET_API_ERROR_FEATURE_DISABLED;
830 flags = IFF_TAP | IFF_NO_PI;
832 if ((dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
833 return VNET_API_ERROR_SYSCALL_ERROR_1;
835 memset (&ifr, 0, sizeof (ifr));
836 strncpy(ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name)-1);
837 ifr.ifr_flags = flags;
838 if (ioctl (dev_net_tun_fd, TUNSETIFF, (void *)&ifr) < 0)
840 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
844 /* Open a provisioning socket */
845 if ((dev_tap_fd = socket(PF_PACKET, SOCK_RAW,
846 htons(ETH_P_ALL))) < 0 )
848 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
852 /* Find the interface index. */
855 struct sockaddr_ll sll;
857 memset (&ifr, 0, sizeof(ifr));
858 strncpy (ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name)-1);
859 if (ioctl (dev_tap_fd, SIOCGIFINDEX, &ifr) < 0 )
861 rv = VNET_API_ERROR_SYSCALL_ERROR_4;
865 /* Bind the provisioning socket to the interface. */
866 memset(&sll, 0, sizeof(sll));
867 sll.sll_family = AF_PACKET;
868 sll.sll_ifindex = ifr.ifr_ifindex;
869 sll.sll_protocol = htons(ETH_P_ALL);
871 if (bind(dev_tap_fd, (struct sockaddr*) &sll, sizeof(sll)) < 0)
873 rv = VNET_API_ERROR_SYSCALL_ERROR_5;
878 /* non-blocking I/O on /dev/tapX */
881 if (ioctl (dev_net_tun_fd, FIONBIO, &one) < 0)
883 rv = VNET_API_ERROR_SYSCALL_ERROR_6;
887 ifr.ifr_mtu = tm->mtu_bytes;
888 if (ioctl (dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
890 rv = VNET_API_ERROR_SYSCALL_ERROR_7;
894 /* get flags, modify to bring up interface... */
895 if (ioctl (dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
897 rv = VNET_API_ERROR_SYSCALL_ERROR_8;
901 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
903 if (ioctl (dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
905 rv = VNET_API_ERROR_SYSCALL_ERROR_9;
909 if (ap->ip4_address_set)
911 struct sockaddr_in sin;
912 /* ip4: mask defaults to /24 */
913 u32 mask = clib_host_to_net_u32 (0xFFFFFF00);
915 memset(&sin, 0, sizeof(sin));
916 sin.sin_family = AF_INET;
917 /* sin.sin_port = 0; */
918 sin.sin_addr.s_addr = ap->ip4_address->as_u32;
919 memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
921 if (ioctl (dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
923 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
927 if (ap->ip4_mask_width > 0 && ap->ip4_mask_width < 33)
930 mask <<= (32 - ap->ip4_mask_width);
933 mask = clib_host_to_net_u32(mask);
934 sin.sin_family = AF_INET;
936 sin.sin_addr.s_addr = mask;
937 memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
939 if (ioctl (dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
941 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
946 if (ap->ip6_address_set)
952 sockfd6 = socket(AF_INET6, SOCK_DGRAM, IPPROTO_IP);
955 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
959 memset (&ifr2, 0, sizeof(ifr));
960 strncpy (ifr2.ifr_name, (char *) ap->intfc_name,
961 sizeof (ifr2.ifr_name)-1);
962 if (ioctl (sockfd6, SIOCGIFINDEX, &ifr2) < 0 )
965 rv = VNET_API_ERROR_SYSCALL_ERROR_4;
969 memcpy (&ifr6.addr, ap->ip6_address, sizeof (ip6_address_t));
970 ifr6.mask_width = ap->ip6_mask_width;
971 ifr6.ifindex = ifr2.ifr_ifindex;
973 if (ioctl (sockfd6, SIOCSIFADDR, &ifr6) < 0)
976 clib_unix_warning ("ifr6");
977 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
983 ti = tapcli_get_new_tapif();
984 ti->per_interface_next_index = ~0;
986 if (ap->hwaddr_arg != 0)
987 clib_memcpy(hwaddr, ap->hwaddr_arg, 6);
990 f64 now = vlib_time_now(vm);
992 rnd = (u32) (now * 1e6);
993 rnd = random_u32 (&rnd);
995 memcpy (hwaddr+2, &rnd, sizeof(rnd));
1000 error = ethernet_register_interface
1002 tapcli_dev_class.index,
1003 ti - tm->tapcli_interfaces /* device instance */,
1004 hwaddr /* ethernet address */,
1006 tapcli_flag_change);
1010 clib_error_report (error);
1011 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1016 clib_file_t template = {0};
1017 template.read_function = tapcli_read_ready;
1018 template.file_descriptor = dev_net_tun_fd;
1019 ti->clib_file_index = clib_file_add (&file_main, &template);
1020 ti->unix_fd = dev_net_tun_fd;
1021 ti->provision_fd = dev_tap_fd;
1022 clib_memcpy (&ti->ifr, &ifr, sizeof (ifr));
1026 vnet_hw_interface_t * hw;
1027 hw = vnet_get_hw_interface (tm->vnet_main, ti->hw_if_index);
1028 hw->min_supported_packet_bytes = TAP_MTU_MIN;
1029 hw->max_supported_packet_bytes = TAP_MTU_MAX;
1030 hw->max_l3_packet_bytes[VLIB_RX] = hw->max_l3_packet_bytes[VLIB_TX] = hw->max_supported_packet_bytes - sizeof(ethernet_header_t);
1031 ti->sw_if_index = hw->sw_if_index;
1032 if (ap->sw_if_indexp)
1033 *(ap->sw_if_indexp) = hw->sw_if_index;
1038 hash_set (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index,
1039 ti - tm->tapcli_interfaces);
1041 hash_set (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd,
1042 ti - tm->tapcli_interfaces);
1047 close (dev_net_tun_fd);
1048 if (dev_tap_fd >= 0)
1055 * @brief Renumber a TAP interface
1057 * @param *vm - vlib_main_t
1058 * @param *intfc_name - u8
1059 * @param *hwaddr_arg - u8
1060 * @param *sw_if_indexp - u32
1061 * @param renumber - u8
1062 * @param custom_dev_instance - u32
1067 int vnet_tap_connect_renumber (vlib_main_t * vm,
1068 vnet_tap_connect_args_t *ap)
1070 int rv = vnet_tap_connect(vm, ap);
1072 if (!rv && ap->renumber)
1073 vnet_interface_name_renumber (*(ap->sw_if_indexp), ap->custom_dev_instance);
1079 * @brief Disconnect TAP CLI interface
1081 * @param *ti - tapcli_interface_t
1086 static int tapcli_tap_disconnect (tapcli_interface_t *ti)
1089 vnet_main_t * vnm = vnet_get_main();
1090 tapcli_main_t * tm = &tapcli_main;
1091 u32 sw_if_index = ti->sw_if_index;
1093 // bring interface down
1094 vnet_sw_interface_set_flags (vnm, sw_if_index, 0);
1096 if (ti->clib_file_index != ~0) {
1097 clib_file_del (&file_main, file_main.file_pool + ti->clib_file_index);
1098 ti->clib_file_index = ~0;
1103 hash_unset (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd);
1104 hash_unset (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index);
1105 close(ti->provision_fd);
1107 ti->provision_fd = -1;
1113 * @brief Delete TAP interface
1115 * @param *vm - vlib_main_t
1116 * @param sw_if_index - u32
1121 int vnet_tap_delete(vlib_main_t *vm, u32 sw_if_index)
1124 tapcli_main_t * tm = &tapcli_main;
1125 tapcli_interface_t *ti;
1128 p = hash_get (tm->tapcli_interface_index_by_sw_if_index,
1131 clib_warning ("sw_if_index %d unknown", sw_if_index);
1132 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1134 ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
1138 tapcli_tap_disconnect(ti);
1139 // add to inactive list
1140 vec_add1(tm->tapcli_inactive_interfaces, ti - tm->tapcli_interfaces);
1142 // reset renumbered iface
1143 if (p[0] < vec_len (tm->show_dev_instance_by_real_dev_instance))
1144 tm->show_dev_instance_by_real_dev_instance[p[0]] = ~0;
1146 ethernet_delete_interface (tm->vnet_main, ti->hw_if_index);
1151 * @brief CLI function to delete TAP interface
1153 * @param *vm - vlib_main_t
1154 * @param *input - unformat_input_t
1155 * @param *cmd - vlib_cli_command_t
1157 * @return error - clib_error_t
1160 static clib_error_t *
1161 tap_delete_command_fn (vlib_main_t * vm,
1162 unformat_input_t * input,
1163 vlib_cli_command_t * cmd)
1165 tapcli_main_t * tm = &tapcli_main;
1166 u32 sw_if_index = ~0;
1168 if (tm->is_disabled)
1170 return clib_error_return (0, "device disabled...");
1173 if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1177 return clib_error_return (0, "unknown input `%U'",
1178 format_unformat_error, input);
1181 int rc = vnet_tap_delete (vm, sw_if_index);
1184 vlib_cli_output (vm, "Deleted.");
1186 vlib_cli_output (vm, "Error during deletion of tap interface. (rc: %d)", rc);
1192 VLIB_CLI_COMMAND (tap_delete_command, static) = {
1193 .path = "tap delete",
1194 .short_help = "tap delete <vpp-tap-intfc-name>",
1195 .function = tap_delete_command_fn,
1199 * @brief Modifies tap interface - can result in new interface being created
1201 * @param *vm - vlib_main_t
1202 * @param orig_sw_if_index - u32
1203 * @param *intfc_name - u8
1204 * @param *hwaddr_arg - u8
1205 * @param *sw_if_indexp - u32
1206 * @param renumber - u8
1207 * @param custom_dev_instance - u32
1212 int vnet_tap_modify (vlib_main_t * vm, vnet_tap_connect_args_t *ap)
1214 int rv = vnet_tap_delete (vm, ap->orig_sw_if_index);
1219 rv = vnet_tap_connect_renumber(vm, ap);
1225 * @brief CLI function to modify TAP interface
1227 * @param *vm - vlib_main_t
1228 * @param *input - unformat_input_t
1229 * @param *cmd - vlib_cli_command_t
1231 * @return error - clib_error_t
1234 static clib_error_t *
1235 tap_modify_command_fn (vlib_main_t * vm,
1236 unformat_input_t * input,
1237 vlib_cli_command_t * cmd)
1240 tapcli_main_t * tm = &tapcli_main;
1241 u32 sw_if_index = ~0;
1242 u32 new_sw_if_index = ~0;
1243 int user_hwaddr = 0;
1245 vnet_tap_connect_args_t _a, *ap= &_a;
1247 if (tm->is_disabled)
1249 return clib_error_return (0, "device disabled...");
1252 if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1256 return clib_error_return (0, "unknown input `%U'",
1257 format_unformat_error, input);
1259 if (unformat (input, "%s", &intfc_name))
1262 return clib_error_return (0, "unknown input `%U'",
1263 format_unformat_error, input);
1265 if (unformat(input, "hwaddr %U", unformat_ethernet_address,
1270 memset (ap, 0, sizeof(*ap));
1271 ap->orig_sw_if_index = sw_if_index;
1272 ap->intfc_name = intfc_name;
1273 ap->sw_if_indexp = &new_sw_if_index;
1275 ap->hwaddr_arg = hwaddr;
1277 int rc = vnet_tap_modify (vm, ap);
1280 vlib_cli_output (vm, "Modified %U for Linux tap '%s'",
1281 format_vnet_sw_if_index_name, tm->vnet_main,
1282 *(ap->sw_if_indexp), ap->intfc_name);
1284 vlib_cli_output (vm, "Error during modification of tap interface. (rc: %d)", rc);
1290 VLIB_CLI_COMMAND (tap_modify_command, static) = {
1291 .path = "tap modify",
1292 .short_help = "tap modify <vpp-tap-intfc-name> <linux-intfc-name> [hwaddr <addr>]",
1293 .function = tap_modify_command_fn,
1297 * @brief CLI function to connect TAP interface
1299 * @param *vm - vlib_main_t
1300 * @param *input - unformat_input_t
1301 * @param *cmd - vlib_cli_command_t
1303 * @return error - clib_error_t
1306 static clib_error_t *
1307 tap_connect_command_fn (vlib_main_t * vm,
1308 unformat_input_t * input,
1309 vlib_cli_command_t * cmd)
1311 u8 * intfc_name = 0;
1312 unformat_input_t _line_input, *line_input = &_line_input;
1313 vnet_tap_connect_args_t _a, *ap= &_a;
1314 tapcli_main_t * tm = &tapcli_main;
1318 ip4_address_t ip4_address;
1319 int ip4_address_set = 0;
1320 ip6_address_t ip6_address;
1321 int ip6_address_set = 0;
1322 u32 ip4_mask_width = 0;
1323 u32 ip6_mask_width = 0;
1324 clib_error_t *error = NULL;
1326 if (tm->is_disabled)
1327 return clib_error_return (0, "device disabled...");
1329 if (!unformat_user (input, unformat_line_input, line_input))
1332 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1334 if (unformat(line_input, "hwaddr %U", unformat_ethernet_address,
1336 hwaddr_arg = hwaddr;
1338 /* It is here for backward compatibility */
1339 else if (unformat(line_input, "hwaddr random"))
1342 else if (unformat (line_input, "address %U/%d",
1343 unformat_ip4_address, &ip4_address, &ip4_mask_width))
1344 ip4_address_set = 1;
1346 else if (unformat (line_input, "address %U/%d",
1347 unformat_ip6_address, &ip6_address, &ip6_mask_width))
1348 ip6_address_set = 1;
1350 else if (unformat (line_input, "%s", &intfc_name))
1354 error = clib_error_return (0, "unknown input `%U'",
1355 format_unformat_error, line_input);
1360 if (intfc_name == 0)
1362 error = clib_error_return (0, "interface name must be specified");
1366 memset (ap, 0, sizeof (*ap));
1368 ap->intfc_name = intfc_name;
1369 ap->hwaddr_arg = hwaddr_arg;
1370 if (ip4_address_set)
1372 ap->ip4_address = &ip4_address;
1373 ap->ip4_mask_width = ip4_mask_width;
1374 ap->ip4_address_set = 1;
1376 if (ip6_address_set)
1378 ap->ip6_address = &ip6_address;
1379 ap->ip6_mask_width = ip6_mask_width;
1380 ap->ip6_address_set = 1;
1383 ap->sw_if_indexp = &sw_if_index;
1385 int rv = vnet_tap_connect(vm, ap);
1389 case VNET_API_ERROR_SYSCALL_ERROR_1:
1390 error = clib_error_return (0, "Couldn't open /dev/net/tun");
1393 case VNET_API_ERROR_SYSCALL_ERROR_2:
1394 error = clib_error_return (0, "Error setting flags on '%s'", intfc_name);
1397 case VNET_API_ERROR_SYSCALL_ERROR_3:
1398 error = clib_error_return (0, "Couldn't open provisioning socket");
1401 case VNET_API_ERROR_SYSCALL_ERROR_4:
1402 error = clib_error_return (0, "Couldn't get if_index");
1405 case VNET_API_ERROR_SYSCALL_ERROR_5:
1406 error = clib_error_return (0, "Couldn't bind provisioning socket");
1409 case VNET_API_ERROR_SYSCALL_ERROR_6:
1410 error = clib_error_return (0, "Couldn't set device non-blocking flag");
1413 case VNET_API_ERROR_SYSCALL_ERROR_7:
1414 error = clib_error_return (0, "Couldn't set device MTU");
1417 case VNET_API_ERROR_SYSCALL_ERROR_8:
1418 error = clib_error_return (0, "Couldn't get interface flags");
1421 case VNET_API_ERROR_SYSCALL_ERROR_9:
1422 error = clib_error_return (0, "Couldn't set intfc admin state up");
1425 case VNET_API_ERROR_SYSCALL_ERROR_10:
1426 error = clib_error_return (0, "Couldn't set intfc address/mask");
1429 case VNET_API_ERROR_INVALID_REGISTRATION:
1430 error = clib_error_return (0, "Invalid registration");
1437 error = clib_error_return (0, "Unknown error: %d", rv);
1441 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
1442 vnet_get_main(), sw_if_index);
1445 unformat_free (line_input);
1450 VLIB_CLI_COMMAND (tap_connect_command, static) = {
1451 .path = "tap connect",
1453 "tap connect <intfc-name> [address <ip-addr>/mw] [hwaddr <addr>]",
1454 .function = tap_connect_command_fn,
1458 * @brief TAPCLI main init
1460 * @param *vm - vlib_main_t
1462 * @return error - clib_error_t
1466 tapcli_init (vlib_main_t * vm)
1468 tapcli_main_t * tm = &tapcli_main;
1469 vlib_thread_main_t * m = vlib_get_thread_main ();
1470 tapcli_per_thread_t * thread;
1473 tm->vnet_main = vnet_get_main();
1474 tm->mtu_bytes = TAP_MTU_DEFAULT;
1475 tm->tapcli_interface_index_by_sw_if_index = hash_create (0, sizeof(uword));
1476 tm->tapcli_interface_index_by_unix_fd = hash_create (0, sizeof (uword));
1477 vm->os_punt_frame = tapcli_nopunt_frame;
1478 vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1479 CLIB_CACHE_LINE_BYTES);
1480 vec_foreach (thread, tm->threads)
1483 thread->rx_buffers = 0;
1484 vec_alloc(thread->rx_buffers, VLIB_FRAME_SIZE);
1485 vec_reset_length(thread->rx_buffers);
1491 VLIB_INIT_FUNCTION (tapcli_init);