FD.io VPP  v21.01.1
Vector Packet Processing
tapv2.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 /** \file
17 
18  This file defines vpe control-plane API messages for
19  the Linux kernel TAP device driver
20 */
21 
22 option version = "4.0.0";
23 
24 import "vnet/interface_types.api";
25 import "vnet/ethernet/ethernet_types.api";
26 import "vnet/ip/ip_types.api";
27 
28 enum tap_flags {
29  TAP_API_FLAG_GSO = 1, /* enable gso on the interface */
30  TAP_API_FLAG_CSUM_OFFLOAD = 2, /* enable checksum offload without gso on the interface */
31  TAP_API_FLAG_PERSIST = 4, /* make the interface persistence to exist in linux even vpp crash/restart */
32  TAP_API_FLAG_ATTACH = 8, /* attach to the existing persistence interface after vpp crash/restart */
33  TAP_API_FLAG_TUN = 16, /* create TUN interface instead of tap */
34  TAP_API_FLAG_GRO_COALESCE = 32, /* enable packet coalescing on tx side, provided gso enabled */
35  TAP_API_FLAG_PACKED = 64 [backwards_compatible], /* enable packed ring support */
36  TAP_API_FLAG_IN_ORDER = 128 [backwards_compatible], /* enable in-order desc support */
37 };
38 
39 /** \brief Initialize a new tap interface with the given parameters
40  @param client_index - opaque cookie to identify the sender
41  @param context - sender context, to match reply w/ request
42  @param id - interface id, 0xffffffff means auto
43  @param use_random_mac - let the system generate a unique mac address
44  @param mac_address - mac addr to assign to the interface if use_random not set
45  @param num_rx_queues - number of rx queues
46  @param tx_ring_sz - the number of entries of TX ring, optional, default is 256 entries, must be power of 2
47  @param rx_ring_sz - the number of entries of RX ring, optional, default is 256 entries, must be power of 2
48  @param host_mtu_set - host MTU should be set
49  @param host_mtu_size - host MTU size
50  @param host_mac_addr_set - host side interface mac address should be set
51  @param host_mac_addr - host side interface mac address
52  @param host_ip4_prefix_set - host IPv4 ip address should be set
53  @param host_ip4_prefix - host IPv4 ip address
54  @param host_ip6_prefix_set - host IPv6 ip address should be set
55  @param host_ip6_prefix - host IPv6 ip address
56  @param host_ip4_gw_set - host IPv4 default gateway should be set
57  @param host_ip4_gw - host IPv4 default gateway
58  @param host_ip6_gw_set - host IPv6 default gateway should be set
59  @param host_ip6_gw - host IPv6 default gateway
60  @param tap_flags - flags for the TAP interface creation
61  @param host_if_name_set - host side interface name should be set
62  @param host_if_name - host side interface name
63  @param host_namespace_set - host namespace should be set
64  @param host_namespace - host namespace to attach interface to
65  @param host_bridge_set - host bridge should be set
66  @param host_bridge - host bridge to attach interface to
67  @param tag - tag
68 */
69 define tap_create_v2
70 {
73  u32 id [default=0xffffffff];
74  bool use_random_mac [default=true];
75  vl_api_mac_address_t mac_address;
76  u8 num_rx_queues [default=1];
77  u16 tx_ring_sz [default=256];
78  u16 rx_ring_sz [default=256];
82  vl_api_mac_address_t host_mac_addr;
84  vl_api_ip4_address_with_prefix_t host_ip4_prefix;
86  vl_api_ip6_address_with_prefix_t host_ip6_prefix;
88  vl_api_ip4_address_t host_ip4_gw;
90  vl_api_ip6_address_t host_ip6_gw;
91  vl_api_tap_flags_t tap_flags;
93  string host_namespace[64];
95  string host_if_name[64];
97  string host_bridge[64];
98  string tag[];
99 };
100 
101 /** \brief Reply for tap create reply
102  @param context - returned sender context, to match reply w/ request
103  @param retval - return code
104  @param sw_if_index - software index allocated for the new tap interface
105 */
106 define tap_create_v2_reply
107 {
110  vl_api_interface_index_t sw_if_index;
111 };
112 
113 /** \brief Delete tap interface
114  @param client_index - opaque cookie to identify the sender
115  @param context - sender context, to match reply w/ request
116  @param sw_if_index - interface index of existing tap interface
117 */
118 autoreply define tap_delete_v2
119 {
122  vl_api_interface_index_t sw_if_index;
123 };
124 
125 /** \brief Dump tap interfaces request
126  @param sw_if_index - filter by sw_if_index
127 */
128 define sw_interface_tap_v2_dump
129 {
132  vl_api_interface_index_t sw_if_index [default=0xffffffff];
133 };
134 
135 /** \brief Reply for tap dump request
136  @param sw_if_index - software index of tap interface
137  @param id - interface id
138  @param tx_ring_sz - the number of entries of TX ring
139  @param rx_ring_sz - the number of entries of RX ring
140  @param host_mtu_size - host mtu size
141  @param host_mac_addr - mac address assigned to the host side of the interface
142  @param host_ip4_prefix - host IPv4 ip address
143  @param host_ip6_prefix - host IPv6 ip address
144  @param tap_flags - flags for the TAP interface creation
145  @param dev_name - Linux tap device name
146  @param host_if_name - host side interface name
147  @param host_namespace - host namespace the interface is attached into
148  @param host_bridge - host bridge the interface is attached into
149 */
150 define sw_interface_tap_v2_details
151 {
158  vl_api_mac_address_t host_mac_addr;
159  vl_api_ip4_address_with_prefix_t host_ip4_prefix;
160  vl_api_ip6_address_with_prefix_t host_ip6_prefix;
161  vl_api_tap_flags_t tap_flags;
162  string dev_name[64];
163  string host_if_name[64];
164  string host_namespace[64];
165  string host_bridge[64];
166 };
167 
168 /*
169  * Local Variables:
170  * eval: (c-set-style "gnu")
171  * End:
172  */
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:159
vl_api_mac_address_t mac_address
Definition: tapv2.api:75
unsigned char u8
Definition: types.h:56
vl_api_ip6_address_t host_ip6_gw
Definition: tapv2.api:90
unsigned int u32
Definition: types.h:88
tap_flags
Definition: tapv2.api:28
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:110
vl_api_tap_flags_t tap_flags
Definition: tapv2.api:161
unsigned short u16
Definition: types.h:57
option version
Definition: tapv2.api:22
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:84
vl_api_tap_flags_t tap_flags
Definition: tapv2.api:91
vl_api_ip4_address_t host_ip4_gw
Definition: tapv2.api:88
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:122
signed int i32
Definition: types.h:77
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:82
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:158
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vl_api_ip6_address_with_prefix_t host_ip6_prefix
Definition: tapv2.api:160
vl_api_ip6_address_with_prefix_t host_ip6_prefix
Definition: tapv2.api:86