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 main state struct
102 /** Vector of iovecs for readv/writev calls. */
103 struct iovec * iovecs;
105 /** Vector of VLIB rx buffers to use. We allocate them in blocks
106 of VLIB_FRAME_SIZE (256). */
109 /** tap device destination MAC address. Required, or Linux drops pkts */
112 /** Interface MTU in bytes and # of default sized buffers. */
113 u32 mtu_bytes, mtu_buffers;
115 /** Vector of tap interfaces */
116 tapcli_interface_t * tapcli_interfaces;
118 /** Vector of deleted tap interfaces */
119 u32 * tapcli_inactive_interfaces;
121 /** Bitmap of tap interfaces with pending reads */
122 uword * pending_read_bitmap;
124 /** Hash table to find tapcli interface given hw_if_index */
125 uword * tapcli_interface_index_by_sw_if_index;
127 /** Hash table to find tapcli interface given unix fd */
128 uword * tapcli_interface_index_by_unix_fd;
130 /** renumbering table */
131 u32 * show_dev_instance_by_real_dev_instance;
133 /** 1 => disable CLI */
136 /** convenience - vlib_main_t */
137 vlib_main_t * vlib_main;
138 /** convenience - vnet_main_t */
139 vnet_main_t * vnet_main;
142 static tapcli_main_t tapcli_main;
145 * @brief tapcli TX node function
148 * Output node, writes the buffers comprising the incoming frame
149 * to the tun/tap device, aka hands them to the Linux kernel stack.
151 * @param *vm - vlib_main_t
152 * @param *node - vlib_node_runtime_t
153 * @param *frame - vlib_frame_t
155 * @return n_packets - uword
159 tapcli_tx (vlib_main_t * vm,
160 vlib_node_runtime_t * node,
161 vlib_frame_t * frame)
163 u32 * buffers = vlib_frame_args (frame);
164 uword n_packets = frame->n_vectors;
165 tapcli_main_t * tm = &tapcli_main;
166 tapcli_interface_t * ti;
169 for (i = 0; i < n_packets; i++)
174 vnet_hw_interface_t * hw;
178 b = vlib_get_buffer (vm, buffers[i]);
180 tx_sw_if_index = vnet_buffer(b)->sw_if_index[VLIB_TX];
181 if (tx_sw_if_index == (u32)~0)
182 tx_sw_if_index = vnet_buffer(b)->sw_if_index[VLIB_RX];
184 ASSERT(tx_sw_if_index != (u32)~0);
186 /* Use the sup intfc to finesse vlan subifs */
187 hw = vnet_get_sup_hw_interface (tm->vnet_main, tx_sw_if_index);
188 tx_sw_if_index = hw->sw_if_index;
190 p = hash_get (tm->tapcli_interface_index_by_sw_if_index,
194 clib_warning ("sw_if_index %d unknown", tx_sw_if_index);
195 /* $$$ leak, but this should never happen... */
199 ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
201 /* Re-set iovecs if present. */
203 _vec_len (tm->iovecs) = 0;
205 /* VLIB buffer chain -> Unix iovec(s). */
206 vec_add2 (tm->iovecs, iov, 1);
207 iov->iov_base = b->data + b->current_data;
208 iov->iov_len = l = b->current_length;
210 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
213 b = vlib_get_buffer (vm, b->next_buffer);
215 vec_add2 (tm->iovecs, iov, 1);
217 iov->iov_base = b->data + b->current_data;
218 iov->iov_len = b->current_length;
219 l += b->current_length;
220 } while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
223 if (writev (ti->unix_fd, tm->iovecs, vec_len (tm->iovecs)) < l)
224 clib_unix_warning ("writev");
227 vlib_buffer_free(vm, vlib_frame_vector_args(frame), frame->n_vectors);
232 VLIB_REGISTER_NODE (tapcli_tx_node,static) = {
233 .function = tapcli_tx,
235 .type = VLIB_NODE_TYPE_INTERNAL,
240 * @brief Dispatch tapcli RX node function for node tap_cli_rx
243 * @param *vm - vlib_main_t
244 * @param *node - vlib_node_runtime_t
245 * @param *ti - tapcli_interface_t
247 * @return n_packets - uword
250 static uword tapcli_rx_iface(vlib_main_t * vm,
251 vlib_node_runtime_t * node,
252 tapcli_interface_t * ti)
254 tapcli_main_t * tm = &tapcli_main;
255 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
256 u32 n_trace = vlib_get_trace_count (vm, node);
260 vnet_sw_interface_t * si;
262 u32 next = node->cached_next_index;
263 u32 n_left_to_next, next_index;
266 vnm = vnet_get_main();
267 si = vnet_get_sw_interface (vnm, ti->sw_if_index);
268 admin_down = !(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
270 vlib_get_next_frame(vm, node, next, to_next, n_left_to_next);
272 while (n_left_to_next) { // Fill at most one vector
273 vlib_buffer_t *b_first, *b, *prev;
275 word n_bytes_in_packet;
278 if (PREDICT_FALSE(vec_len(tm->rx_buffers) < tm->mtu_buffers)) {
279 uword len = vec_len(tm->rx_buffers);
280 _vec_len(tm->rx_buffers) +=
281 vlib_buffer_alloc_from_free_list(vm, &tm->rx_buffers[len],
282 VLIB_FRAME_SIZE - len, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
283 if (PREDICT_FALSE(vec_len(tm->rx_buffers) < tm->mtu_buffers)) {
284 vlib_node_increment_counter(vm, tapcli_rx_node.index,
285 TAPCLI_ERROR_BUFFER_ALLOC,
286 tm->mtu_buffers - vec_len(tm->rx_buffers));
291 uword i_rx = vec_len (tm->rx_buffers) - 1;
293 /* Allocate RX buffers from end of rx_buffers.
294 Turn them into iovecs to pass to readv. */
295 vec_validate (tm->iovecs, tm->mtu_buffers - 1);
296 for (j = 0; j < tm->mtu_buffers; j++) {
297 b = vlib_get_buffer (vm, tm->rx_buffers[i_rx - j]);
298 tm->iovecs[j].iov_base = b->data;
299 tm->iovecs[j].iov_len = buffer_size;
302 n_bytes_left = readv (ti->unix_fd, tm->iovecs, tm->mtu_buffers);
303 n_bytes_in_packet = n_bytes_left;
304 if (n_bytes_left <= 0) {
305 if (errno != EAGAIN) {
306 vlib_node_increment_counter(vm, tapcli_rx_node.index,
307 TAPCLI_ERROR_READ, 1);
312 bi_first = tm->rx_buffers[i_rx];
313 b = b_first = vlib_get_buffer (vm, tm->rx_buffers[i_rx]);
317 b->current_length = n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
318 n_bytes_left -= buffer_size;
321 prev->next_buffer = bi;
322 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
327 if (n_bytes_left <= 0)
331 bi = tm->rx_buffers[i_rx];
332 b = vlib_get_buffer (vm, bi);
335 _vec_len (tm->rx_buffers) = i_rx;
337 b_first->total_length_not_including_first_buffer =
338 (n_bytes_in_packet > buffer_size) ? n_bytes_in_packet - buffer_size : 0;
339 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
341 VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b_first);
343 vnet_buffer (b_first)->sw_if_index[VLIB_RX] = ti->sw_if_index;
344 vnet_buffer (b_first)->sw_if_index[VLIB_TX] = (u32)~0;
346 b_first->error = node->errors[TAPCLI_ERROR_NONE];
347 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
348 next_index = (ti->per_interface_next_index != ~0) ?
349 ti->per_interface_next_index : next_index;
350 next_index = admin_down ? VNET_DEVICE_INPUT_NEXT_DROP : next_index;
352 to_next[0] = bi_first;
356 vnet_feature_start_device_input_x1 (ti->sw_if_index, &next_index, b_first);
358 vlib_validate_buffer_enqueue_x1 (vm, node, next,
359 to_next, n_left_to_next,
360 bi_first, next_index);
362 /* Interface counters for tapcli interface. */
363 if (PREDICT_TRUE(!admin_down)) {
364 vlib_increment_combined_counter (
365 vnet_main.interface_main.combined_sw_if_counters
366 + VNET_INTERFACE_COUNTER_RX,
367 vlib_get_thread_index(), ti->sw_if_index,
368 1, n_bytes_in_packet);
370 if (PREDICT_FALSE(n_trace > 0)) {
371 vlib_trace_buffer (vm, node, next_index,
372 b_first, /* follow_chain */ 1);
375 tapcli_rx_trace_t *t0 = vlib_add_trace (vm, node, b_first, sizeof (*t0));
376 t0->sw_if_index = si->sw_if_index;
380 vlib_put_next_frame (vm, node, next, n_left_to_next);
382 vlib_set_trace_count (vm, node, n_trace);
383 return VLIB_FRAME_SIZE - n_left_to_next;
387 * @brief tapcli RX node function
390 * Input node from the Kernel tun/tap device
392 * @param *vm - vlib_main_t
393 * @param *node - vlib_node_runtime_t
394 * @param *frame - vlib_frame_t
396 * @return n_packets - uword
400 tapcli_rx (vlib_main_t * vm,
401 vlib_node_runtime_t * node,
402 vlib_frame_t * frame)
404 tapcli_main_t * tm = &tapcli_main;
405 static u32 * ready_interface_indices;
406 tapcli_interface_t * ti;
410 vec_reset_length (ready_interface_indices);
411 clib_bitmap_foreach (i, tm->pending_read_bitmap,
413 vec_add1 (ready_interface_indices, i);
416 if (vec_len (ready_interface_indices) == 0)
419 for (i = 0; i < vec_len(ready_interface_indices); i++)
421 tm->pending_read_bitmap =
422 clib_bitmap_set (tm->pending_read_bitmap,
423 ready_interface_indices[i], 0);
425 ti = vec_elt_at_index (tm->tapcli_interfaces, ready_interface_indices[i]);
426 total_count += tapcli_rx_iface(vm, node, ti);
428 return total_count; //This might return more than 256.
431 /** TAPCLI error strings */
432 static char * tapcli_rx_error_strings[] = {
433 #define _(sym,string) string,
438 VLIB_REGISTER_NODE (tapcli_rx_node, static) = {
439 .function = tapcli_rx,
441 .sibling_of = "device-input",
442 .type = VLIB_NODE_TYPE_INPUT,
443 .state = VLIB_NODE_STATE_INTERRUPT,
445 .n_errors = TAPCLI_N_ERROR,
446 .error_strings = tapcli_rx_error_strings,
447 .format_trace = format_tapcli_rx_trace,
452 * @brief Gets called when file descriptor is ready from epoll.
454 * @param *uf - clib_file_t
456 * @return error - clib_error_t
459 static clib_error_t * tapcli_read_ready (clib_file_t * uf)
461 vlib_main_t * vm = vlib_get_main();
462 tapcli_main_t * tm = &tapcli_main;
465 /** Schedule the rx node */
466 vlib_node_set_interrupt_pending (vm, tapcli_rx_node.index);
468 p = hash_get (tm->tapcli_interface_index_by_unix_fd, uf->file_descriptor);
470 /** Mark the specific tap interface ready-to-read */
472 tm->pending_read_bitmap = clib_bitmap_set (tm->pending_read_bitmap,
475 clib_warning ("fd %d not in hash table", uf->file_descriptor);
481 * @brief CLI function for TAPCLI configuration
483 * @param *vm - vlib_main_t
484 * @param *input - unformat_input_t
486 * @return error - clib_error_t
489 static clib_error_t *
490 tapcli_config (vlib_main_t * vm, unformat_input_t * input)
492 tapcli_main_t *tm = &tapcli_main;
493 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
495 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
497 if (unformat (input, "mtu %d", &tm->mtu_bytes))
499 else if (unformat (input, "disable"))
502 return clib_error_return (0, "unknown input `%U'",
503 format_unformat_error, input);
511 clib_warning ("tapcli disabled: must be superuser");
516 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
522 * @brief Renumber TAPCLI interface
524 * @param *hi - vnet_hw_interface_t
525 * @param new_dev_instance - u32
530 static int tap_name_renumber (vnet_hw_interface_t * hi,
531 u32 new_dev_instance)
533 tapcli_main_t *tm = &tapcli_main;
535 vec_validate_init_empty (tm->show_dev_instance_by_real_dev_instance,
536 hi->dev_instance, ~0);
538 tm->show_dev_instance_by_real_dev_instance [hi->dev_instance] =
544 VLIB_CONFIG_FUNCTION (tapcli_config, "tapcli");
547 * @brief Free "no punt" frame
549 * @param *vm - vlib_main_t
550 * @param *node - vlib_node_runtime_t
551 * @param *frame - vlib_frame_t
555 tapcli_nopunt_frame (vlib_main_t * vm,
556 vlib_node_runtime_t * node,
557 vlib_frame_t * frame)
559 u32 * buffers = vlib_frame_args (frame);
560 uword n_packets = frame->n_vectors;
561 vlib_buffer_free (vm, buffers, n_packets);
562 vlib_frame_free (vm, node, frame);
565 VNET_HW_INTERFACE_CLASS (tapcli_interface_class,static) = {
567 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
571 * @brief Formatter for TAPCLI interface name
573 * @param *s - formatter string
574 * @param *args - va_list
576 * @return *s - formatted string
579 static u8 * format_tapcli_interface_name (u8 * s, va_list * args)
581 u32 i = va_arg (*args, u32);
582 u32 show_dev_instance = ~0;
583 tapcli_main_t * tm = &tapcli_main;
585 if (i < vec_len (tm->show_dev_instance_by_real_dev_instance))
586 show_dev_instance = tm->show_dev_instance_by_real_dev_instance[i];
588 if (show_dev_instance != ~0)
589 i = show_dev_instance;
591 s = format (s, "tap-%d", i);
596 * @brief Modify interface flags for TAPCLI interface
598 * @param *vnm - vnet_main_t
599 * @param *hw - vnet_hw_interface_t
605 static u32 tapcli_flag_change (vnet_main_t * vnm,
606 vnet_hw_interface_t * hw,
609 tapcli_main_t *tm = &tapcli_main;
610 tapcli_interface_t *ti;
612 ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
614 if (flags & ETHERNET_INTERFACE_FLAG_MTU)
616 const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
617 tm->mtu_bytes = hw->max_packet_bytes;
618 tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
625 memcpy (&ifr, &ti->ifr, sizeof (ifr));
627 /* get flags, modify to bring up interface... */
628 if (ioctl (ti->provision_fd, SIOCGIFFLAGS, &ifr) < 0)
630 clib_unix_warning ("Couldn't get interface flags for %s", hw->name);
634 want_promisc = (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) != 0;
636 if (want_promisc == ti->is_promisc)
639 if (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL)
640 ifr.ifr_flags |= IFF_PROMISC;
642 ifr.ifr_flags &= ~(IFF_PROMISC);
644 /* get flags, modify to bring up interface... */
645 if (ioctl (ti->provision_fd, SIOCSIFFLAGS, &ifr) < 0)
647 clib_unix_warning ("Couldn't set interface flags for %s", hw->name);
651 ti->is_promisc = want_promisc;
658 * @brief Setting the TAP interface's next processing node
660 * @param *vnm - vnet_main_t
661 * @param hw_if_index - u32
662 * @param node_index - u32
665 static void tapcli_set_interface_next_node (vnet_main_t *vnm,
669 tapcli_main_t *tm = &tapcli_main;
670 tapcli_interface_t *ti;
671 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
673 ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
675 /** Shut off redirection */
676 if (node_index == ~0)
678 ti->per_interface_next_index = node_index;
682 ti->per_interface_next_index =
683 vlib_node_add_next (tm->vlib_main, tapcli_rx_node.index, node_index);
687 * @brief Set link_state == admin_state otherwise things like ip6 neighbor discovery breaks
689 * @param *vnm - vnet_main_t
690 * @param hw_if_index - u32
693 * @return error - clib_error_t
695 static clib_error_t *
696 tapcli_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
698 uword is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
700 u32 speed_duplex = VNET_HW_INTERFACE_FLAG_FULL_DUPLEX
701 | VNET_HW_INTERFACE_FLAG_SPEED_1G;
704 hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP | speed_duplex;
706 hw_flags = speed_duplex;
708 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
712 VNET_DEVICE_CLASS (tapcli_dev_class,static) = {
714 .tx_function = tapcli_tx,
715 .format_device_name = format_tapcli_interface_name,
716 .rx_redirect_to_node = tapcli_set_interface_next_node,
717 .name_renumber = tap_name_renumber,
718 .admin_up_down_function = tapcli_interface_admin_up_down,
722 * @brief Dump TAP interfaces
724 * @param **out_tapids - tapcli_interface_details_t
729 int vnet_tap_dump_ifs (tapcli_interface_details_t **out_tapids)
731 tapcli_main_t * tm = &tapcli_main;
732 tapcli_interface_t * ti;
734 tapcli_interface_details_t * r_tapids = NULL;
735 tapcli_interface_details_t * tapid = NULL;
737 vec_foreach (ti, tm->tapcli_interfaces) {
740 vec_add2(r_tapids, tapid, 1);
741 tapid->sw_if_index = ti->sw_if_index;
742 strncpy((char *)tapid->dev_name, ti->ifr.ifr_name, sizeof (ti->ifr.ifr_name)-1);
745 *out_tapids = r_tapids;
751 * @brief Get tap interface from inactive interfaces or create new
753 * @return interface - tapcli_interface_t
756 static tapcli_interface_t *tapcli_get_new_tapif()
758 tapcli_main_t * tm = &tapcli_main;
759 tapcli_interface_t *ti = NULL;
761 int inactive_cnt = vec_len(tm->tapcli_inactive_interfaces);
762 // if there are any inactive ifaces
763 if (inactive_cnt > 0) {
765 u32 ti_idx = tm->tapcli_inactive_interfaces[inactive_cnt - 1];
766 if (vec_len(tm->tapcli_interfaces) > ti_idx) {
767 ti = vec_elt_at_index (tm->tapcli_interfaces, ti_idx);
768 clib_warning("reusing tap interface");
770 // "remove" from inactive list
771 _vec_len(tm->tapcli_inactive_interfaces) -= 1;
774 // ti was not retrieved from inactive ifaces - create new
776 vec_add2 (tm->tapcli_interfaces, ti, 1);
785 unsigned int ifindex;
789 * @brief Connect a TAP interface
791 * @param vm - vlib_main_t
792 * @param ap - vnet_tap_connect_args_t
797 int vnet_tap_connect (vlib_main_t * vm, vnet_tap_connect_args_t *ap)
799 tapcli_main_t * tm = &tapcli_main;
800 tapcli_interface_t * ti = NULL;
805 clib_error_t * error;
811 return VNET_API_ERROR_FEATURE_DISABLED;
814 flags = IFF_TAP | IFF_NO_PI;
816 if ((dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
817 return VNET_API_ERROR_SYSCALL_ERROR_1;
819 memset (&ifr, 0, sizeof (ifr));
820 strncpy(ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name)-1);
821 ifr.ifr_flags = flags;
822 if (ioctl (dev_net_tun_fd, TUNSETIFF, (void *)&ifr) < 0)
824 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
828 /* Open a provisioning socket */
829 if ((dev_tap_fd = socket(PF_PACKET, SOCK_RAW,
830 htons(ETH_P_ALL))) < 0 )
832 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
836 /* Find the interface index. */
839 struct sockaddr_ll sll;
841 memset (&ifr, 0, sizeof(ifr));
842 strncpy (ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name)-1);
843 if (ioctl (dev_tap_fd, SIOCGIFINDEX, &ifr) < 0 )
845 rv = VNET_API_ERROR_SYSCALL_ERROR_4;
849 /* Bind the provisioning socket to the interface. */
850 memset(&sll, 0, sizeof(sll));
851 sll.sll_family = AF_PACKET;
852 sll.sll_ifindex = ifr.ifr_ifindex;
853 sll.sll_protocol = htons(ETH_P_ALL);
855 if (bind(dev_tap_fd, (struct sockaddr*) &sll, sizeof(sll)) < 0)
857 rv = VNET_API_ERROR_SYSCALL_ERROR_5;
862 /* non-blocking I/O on /dev/tapX */
865 if (ioctl (dev_net_tun_fd, FIONBIO, &one) < 0)
867 rv = VNET_API_ERROR_SYSCALL_ERROR_6;
871 ifr.ifr_mtu = tm->mtu_bytes;
872 if (ioctl (dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
874 rv = VNET_API_ERROR_SYSCALL_ERROR_7;
878 /* get flags, modify to bring up interface... */
879 if (ioctl (dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
881 rv = VNET_API_ERROR_SYSCALL_ERROR_8;
885 ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
887 if (ioctl (dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
889 rv = VNET_API_ERROR_SYSCALL_ERROR_9;
893 if (ap->ip4_address_set)
895 struct sockaddr_in sin;
896 /* ip4: mask defaults to /24 */
897 u32 mask = clib_host_to_net_u32 (0xFFFFFF00);
899 memset(&sin, 0, sizeof(sin));
900 sin.sin_family = AF_INET;
901 /* sin.sin_port = 0; */
902 sin.sin_addr.s_addr = ap->ip4_address->as_u32;
903 memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
905 if (ioctl (dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
907 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
911 if (ap->ip4_mask_width > 0 && ap->ip4_mask_width < 33)
914 mask <<= (32 - ap->ip4_mask_width);
917 mask = clib_host_to_net_u32(mask);
918 sin.sin_family = AF_INET;
920 sin.sin_addr.s_addr = mask;
921 memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
923 if (ioctl (dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
925 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
930 if (ap->ip6_address_set)
936 sockfd6 = socket(AF_INET6, SOCK_DGRAM, IPPROTO_IP);
939 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
943 memset (&ifr2, 0, sizeof(ifr));
944 strncpy (ifr2.ifr_name, (char *) ap->intfc_name,
945 sizeof (ifr2.ifr_name)-1);
946 if (ioctl (sockfd6, SIOCGIFINDEX, &ifr2) < 0 )
949 rv = VNET_API_ERROR_SYSCALL_ERROR_4;
953 memcpy (&ifr6.addr, ap->ip6_address, sizeof (ip6_address_t));
954 ifr6.mask_width = ap->ip6_mask_width;
955 ifr6.ifindex = ifr2.ifr_ifindex;
957 if (ioctl (sockfd6, SIOCSIFADDR, &ifr6) < 0)
960 clib_unix_warning ("ifr6");
961 rv = VNET_API_ERROR_SYSCALL_ERROR_10;
967 ti = tapcli_get_new_tapif();
968 ti->per_interface_next_index = ~0;
970 if (ap->hwaddr_arg != 0)
971 clib_memcpy(hwaddr, ap->hwaddr_arg, 6);
974 f64 now = vlib_time_now(vm);
976 rnd = (u32) (now * 1e6);
977 rnd = random_u32 (&rnd);
979 memcpy (hwaddr+2, &rnd, sizeof(rnd));
984 error = ethernet_register_interface
986 tapcli_dev_class.index,
987 ti - tm->tapcli_interfaces /* device instance */,
988 hwaddr /* ethernet address */,
994 clib_error_report (error);
995 rv = VNET_API_ERROR_INVALID_REGISTRATION;
1000 clib_file_t template = {0};
1001 template.read_function = tapcli_read_ready;
1002 template.file_descriptor = dev_net_tun_fd;
1003 ti->clib_file_index = clib_file_add (&file_main, &template);
1004 ti->unix_fd = dev_net_tun_fd;
1005 ti->provision_fd = dev_tap_fd;
1006 clib_memcpy (&ti->ifr, &ifr, sizeof (ifr));
1010 vnet_hw_interface_t * hw;
1011 hw = vnet_get_hw_interface (tm->vnet_main, ti->hw_if_index);
1012 hw->min_supported_packet_bytes = TAP_MTU_MIN;
1013 hw->max_supported_packet_bytes = TAP_MTU_MAX;
1014 hw->max_l3_packet_bytes[VLIB_RX] = hw->max_l3_packet_bytes[VLIB_TX] = hw->max_supported_packet_bytes - sizeof(ethernet_header_t);
1015 ti->sw_if_index = hw->sw_if_index;
1016 if (ap->sw_if_indexp)
1017 *(ap->sw_if_indexp) = hw->sw_if_index;
1022 hash_set (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index,
1023 ti - tm->tapcli_interfaces);
1025 hash_set (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd,
1026 ti - tm->tapcli_interfaces);
1031 close (dev_net_tun_fd);
1032 if (dev_tap_fd >= 0)
1039 * @brief Renumber a TAP interface
1041 * @param *vm - vlib_main_t
1042 * @param *intfc_name - u8
1043 * @param *hwaddr_arg - u8
1044 * @param *sw_if_indexp - u32
1045 * @param renumber - u8
1046 * @param custom_dev_instance - u32
1051 int vnet_tap_connect_renumber (vlib_main_t * vm,
1052 vnet_tap_connect_args_t *ap)
1054 int rv = vnet_tap_connect(vm, ap);
1056 if (!rv && ap->renumber)
1057 vnet_interface_name_renumber (*(ap->sw_if_indexp), ap->custom_dev_instance);
1063 * @brief Disconnect TAP CLI interface
1065 * @param *ti - tapcli_interface_t
1070 static int tapcli_tap_disconnect (tapcli_interface_t *ti)
1073 vnet_main_t * vnm = vnet_get_main();
1074 tapcli_main_t * tm = &tapcli_main;
1075 u32 sw_if_index = ti->sw_if_index;
1077 // bring interface down
1078 vnet_sw_interface_set_flags (vnm, sw_if_index, 0);
1080 if (ti->clib_file_index != ~0) {
1081 clib_file_del (&file_main, file_main.file_pool + ti->clib_file_index);
1082 ti->clib_file_index = ~0;
1087 hash_unset (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd);
1088 hash_unset (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index);
1089 close(ti->provision_fd);
1091 ti->provision_fd = -1;
1097 * @brief Delete TAP interface
1099 * @param *vm - vlib_main_t
1100 * @param sw_if_index - u32
1105 int vnet_tap_delete(vlib_main_t *vm, u32 sw_if_index)
1108 tapcli_main_t * tm = &tapcli_main;
1109 tapcli_interface_t *ti;
1112 p = hash_get (tm->tapcli_interface_index_by_sw_if_index,
1115 clib_warning ("sw_if_index %d unknown", sw_if_index);
1116 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1118 ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
1122 tapcli_tap_disconnect(ti);
1123 // add to inactive list
1124 vec_add1(tm->tapcli_inactive_interfaces, ti - tm->tapcli_interfaces);
1126 // reset renumbered iface
1127 if (p[0] < vec_len (tm->show_dev_instance_by_real_dev_instance))
1128 tm->show_dev_instance_by_real_dev_instance[p[0]] = ~0;
1130 ethernet_delete_interface (tm->vnet_main, ti->hw_if_index);
1135 * @brief CLI function to delete TAP interface
1137 * @param *vm - vlib_main_t
1138 * @param *input - unformat_input_t
1139 * @param *cmd - vlib_cli_command_t
1141 * @return error - clib_error_t
1144 static clib_error_t *
1145 tap_delete_command_fn (vlib_main_t * vm,
1146 unformat_input_t * input,
1147 vlib_cli_command_t * cmd)
1149 tapcli_main_t * tm = &tapcli_main;
1150 u32 sw_if_index = ~0;
1152 if (tm->is_disabled)
1154 return clib_error_return (0, "device disabled...");
1157 if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1161 return clib_error_return (0, "unknown input `%U'",
1162 format_unformat_error, input);
1165 int rc = vnet_tap_delete (vm, sw_if_index);
1168 vlib_cli_output (vm, "Deleted.");
1170 vlib_cli_output (vm, "Error during deletion of tap interface. (rc: %d)", rc);
1176 VLIB_CLI_COMMAND (tap_delete_command, static) = {
1177 .path = "tap delete",
1178 .short_help = "tap delete <vpp-tap-intfc-name>",
1179 .function = tap_delete_command_fn,
1183 * @brief Modifies tap interface - can result in new interface being created
1185 * @param *vm - vlib_main_t
1186 * @param orig_sw_if_index - u32
1187 * @param *intfc_name - u8
1188 * @param *hwaddr_arg - u8
1189 * @param *sw_if_indexp - u32
1190 * @param renumber - u8
1191 * @param custom_dev_instance - u32
1196 int vnet_tap_modify (vlib_main_t * vm, vnet_tap_connect_args_t *ap)
1198 int rv = vnet_tap_delete (vm, ap->orig_sw_if_index);
1203 rv = vnet_tap_connect_renumber(vm, ap);
1209 * @brief CLI function to modify TAP interface
1211 * @param *vm - vlib_main_t
1212 * @param *input - unformat_input_t
1213 * @param *cmd - vlib_cli_command_t
1215 * @return error - clib_error_t
1218 static clib_error_t *
1219 tap_modify_command_fn (vlib_main_t * vm,
1220 unformat_input_t * input,
1221 vlib_cli_command_t * cmd)
1224 tapcli_main_t * tm = &tapcli_main;
1225 u32 sw_if_index = ~0;
1226 u32 new_sw_if_index = ~0;
1227 int user_hwaddr = 0;
1229 vnet_tap_connect_args_t _a, *ap= &_a;
1231 if (tm->is_disabled)
1233 return clib_error_return (0, "device disabled...");
1236 if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1240 return clib_error_return (0, "unknown input `%U'",
1241 format_unformat_error, input);
1243 if (unformat (input, "%s", &intfc_name))
1246 return clib_error_return (0, "unknown input `%U'",
1247 format_unformat_error, input);
1249 if (unformat(input, "hwaddr %U", unformat_ethernet_address,
1254 memset (ap, 0, sizeof(*ap));
1255 ap->orig_sw_if_index = sw_if_index;
1256 ap->intfc_name = intfc_name;
1257 ap->sw_if_indexp = &new_sw_if_index;
1259 ap->hwaddr_arg = hwaddr;
1261 int rc = vnet_tap_modify (vm, ap);
1264 vlib_cli_output (vm, "Modified %U for Linux tap '%s'",
1265 format_vnet_sw_if_index_name, tm->vnet_main,
1266 *(ap->sw_if_indexp), ap->intfc_name);
1268 vlib_cli_output (vm, "Error during modification of tap interface. (rc: %d)", rc);
1274 VLIB_CLI_COMMAND (tap_modify_command, static) = {
1275 .path = "tap modify",
1276 .short_help = "tap modify <vpp-tap-intfc-name> <linux-intfc-name> [hwaddr <addr>]",
1277 .function = tap_modify_command_fn,
1281 * @brief CLI function to connect TAP interface
1283 * @param *vm - vlib_main_t
1284 * @param *input - unformat_input_t
1285 * @param *cmd - vlib_cli_command_t
1287 * @return error - clib_error_t
1290 static clib_error_t *
1291 tap_connect_command_fn (vlib_main_t * vm,
1292 unformat_input_t * input,
1293 vlib_cli_command_t * cmd)
1295 u8 * intfc_name = 0;
1296 unformat_input_t _line_input, *line_input = &_line_input;
1297 vnet_tap_connect_args_t _a, *ap= &_a;
1298 tapcli_main_t * tm = &tapcli_main;
1302 ip4_address_t ip4_address;
1303 int ip4_address_set = 0;
1304 ip6_address_t ip6_address;
1305 int ip6_address_set = 0;
1306 u32 ip4_mask_width = 0;
1307 u32 ip6_mask_width = 0;
1308 clib_error_t *error = NULL;
1310 if (tm->is_disabled)
1311 return clib_error_return (0, "device disabled...");
1313 if (!unformat_user (input, unformat_line_input, line_input))
1316 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1318 if (unformat(line_input, "hwaddr %U", unformat_ethernet_address,
1320 hwaddr_arg = hwaddr;
1322 /* It is here for backward compatibility */
1323 else if (unformat(line_input, "hwaddr random"))
1326 else if (unformat (line_input, "address %U/%d",
1327 unformat_ip4_address, &ip4_address, &ip4_mask_width))
1328 ip4_address_set = 1;
1330 else if (unformat (line_input, "address %U/%d",
1331 unformat_ip6_address, &ip6_address, &ip6_mask_width))
1332 ip6_address_set = 1;
1334 else if (unformat (line_input, "%s", &intfc_name))
1338 error = clib_error_return (0, "unknown input `%U'",
1339 format_unformat_error, line_input);
1344 if (intfc_name == 0)
1346 error = clib_error_return (0, "interface name must be specified");
1350 memset (ap, 0, sizeof (*ap));
1352 ap->intfc_name = intfc_name;
1353 ap->hwaddr_arg = hwaddr_arg;
1354 if (ip4_address_set)
1356 ap->ip4_address = &ip4_address;
1357 ap->ip4_mask_width = ip4_mask_width;
1358 ap->ip4_address_set = 1;
1360 if (ip6_address_set)
1362 ap->ip6_address = &ip6_address;
1363 ap->ip6_mask_width = ip6_mask_width;
1364 ap->ip6_address_set = 1;
1367 ap->sw_if_indexp = &sw_if_index;
1369 int rv = vnet_tap_connect(vm, ap);
1373 case VNET_API_ERROR_SYSCALL_ERROR_1:
1374 error = clib_error_return (0, "Couldn't open /dev/net/tun");
1377 case VNET_API_ERROR_SYSCALL_ERROR_2:
1378 error = clib_error_return (0, "Error setting flags on '%s'", intfc_name);
1381 case VNET_API_ERROR_SYSCALL_ERROR_3:
1382 error = clib_error_return (0, "Couldn't open provisioning socket");
1385 case VNET_API_ERROR_SYSCALL_ERROR_4:
1386 error = clib_error_return (0, "Couldn't get if_index");
1389 case VNET_API_ERROR_SYSCALL_ERROR_5:
1390 error = clib_error_return (0, "Couldn't bind provisioning socket");
1393 case VNET_API_ERROR_SYSCALL_ERROR_6:
1394 error = clib_error_return (0, "Couldn't set device non-blocking flag");
1397 case VNET_API_ERROR_SYSCALL_ERROR_7:
1398 error = clib_error_return (0, "Couldn't set device MTU");
1401 case VNET_API_ERROR_SYSCALL_ERROR_8:
1402 error = clib_error_return (0, "Couldn't get interface flags");
1405 case VNET_API_ERROR_SYSCALL_ERROR_9:
1406 error = clib_error_return (0, "Couldn't set intfc admin state up");
1409 case VNET_API_ERROR_SYSCALL_ERROR_10:
1410 error = clib_error_return (0, "Couldn't set intfc address/mask");
1413 case VNET_API_ERROR_INVALID_REGISTRATION:
1414 error = clib_error_return (0, "Invalid registration");
1421 error = clib_error_return (0, "Unknown error: %d", rv);
1425 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
1426 vnet_get_main(), sw_if_index);
1429 unformat_free (line_input);
1434 VLIB_CLI_COMMAND (tap_connect_command, static) = {
1435 .path = "tap connect",
1437 "tap connect <intfc-name> [address <ip-addr>/mw] [hwaddr <addr>]",
1438 .function = tap_connect_command_fn,
1442 * @brief TAPCLI main init
1444 * @param *vm - vlib_main_t
1446 * @return error - clib_error_t
1450 tapcli_init (vlib_main_t * vm)
1452 tapcli_main_t * tm = &tapcli_main;
1455 tm->vnet_main = vnet_get_main();
1456 tm->mtu_bytes = TAP_MTU_DEFAULT;
1457 tm->tapcli_interface_index_by_sw_if_index = hash_create (0, sizeof(uword));
1458 tm->tapcli_interface_index_by_unix_fd = hash_create (0, sizeof (uword));
1460 vec_alloc(tm->rx_buffers, VLIB_FRAME_SIZE);
1461 vec_reset_length(tm->rx_buffers);
1462 vm->os_punt_frame = tapcli_nopunt_frame;
1466 VLIB_INIT_FUNCTION (tapcli_init);