FD.io VPP
v20.05.1-6-gf53edbc3b
Vector Packet Processing
tap.h
Go to the documentation of this file.
1
/*
2
*------------------------------------------------------------------
3
* Copyright (c) 2017 Cisco and/or its affiliates.
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
* you may not use this file except in compliance with the License.
6
* You may obtain a copy of the License at:
7
*
8
* http://www.apache.org/licenses/LICENSE-2.0
9
*
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
15
*------------------------------------------------------------------
16
*/
17
18
#ifndef _VNET_DEVICES_VIRTIO_TAP_H_
19
#define _VNET_DEVICES_VIRTIO_TAP_H_
20
21
#ifndef MIN
22
#define MIN(x,y) (((x)<(y))?(x):(y))
23
#endif
24
25
#define foreach_tapv2_flags \
26
_ (GSO, 0) \
27
_ (CSUM_OFFLOAD, 1) \
28
_ (PERSIST, 2) \
29
_ (ATTACH, 3) \
30
_ (TUN, 4) \
31
_ (GRO_COALESCE, 5)
32
33
typedef
enum
34
{
35
#define _(a, b) TAP_FLAG_##a = (1 << b),
36
foreach_tapv2_flags
37
#undef _
38
}
tap_flag_t
;
39
40
typedef
struct
41
{
42
u32
id
;
43
u8
mac_addr_set
;
44
mac_address_t
mac_addr
;
45
u8
num_rx_queues
;
46
u16
rx_ring_sz
;
47
u16
tx_ring_sz
;
48
u32
tap_flags
;
49
u8
*
host_namespace
;
50
u8
*
host_if_name
;
51
mac_address_t
host_mac_addr
;
52
u8
*
host_bridge
;
53
ip4_address_t
host_ip4_addr
;
54
u8
host_ip4_prefix_len
;
55
ip4_address_t
host_ip4_gw
;
56
u8
host_ip4_gw_set
;
57
ip6_address_t
host_ip6_addr
;
58
u8
host_ip6_prefix_len
;
59
ip6_address_t
host_ip6_gw
;
60
u8
host_ip6_gw_set
;
61
u8
host_mtu_set
;
62
u32
host_mtu_size
;
63
/* return */
64
u32
sw_if_index
;
65
int
rv
;
66
clib_error_t
*
error
;
67
}
tap_create_if_args_t
;
68
69
/** TAP interface details struct */
70
typedef
struct
71
{
72
u32
id
;
73
u32
sw_if_index
;
74
u32
tap_flags
;
75
u8
dev_name[64];
76
u16
tx_ring_sz
;
77
u16
rx_ring_sz
;
78
mac_address_t
host_mac_addr
;
79
u8
host_if_name[64];
80
u8
host_namespace[64];
81
u8
host_bridge[64];
82
ip4_address_t
host_ip4_addr
;
83
u8
host_ip4_prefix_len
;
84
ip6_address_t
host_ip6_addr
;
85
u8
host_ip6_prefix_len
;
86
u32
host_mtu_size
;
87
}
tap_interface_details_t
;
88
89
typedef
struct
90
{
91
/* logging */
92
vlib_log_class_t
log_default
;
93
94
/* bit-map of in-use IDs */
95
uword
*
tap_ids
;
96
97
/* host mtu size, configurable through startup.conf */
98
int
host_mtu_size
;
99
}
tap_main_t
;
100
101
void
tap_create_if
(
vlib_main_t
*
vm
,
tap_create_if_args_t
* args);
102
int
tap_delete_if
(
vlib_main_t
*
vm
,
u32
sw_if_index
);
103
int
tap_gso_enable_disable
(
vlib_main_t
*
vm
,
u32
sw_if_index
,
104
int
enable_disable);
105
int
106
tap_csum_offload_enable_disable
(
vlib_main_t
*
vm
,
u32
sw_if_index
,
107
int
enable_disable);
108
int
tap_dump_ifs
(
tap_interface_details_t
** out_tapids);
109
110
#endif
/* _VNET_DEVICES_VIRTIO_TAP_H_ */
111
112
/*
113
* fd.io coding-style-patch-verification: ON
114
*
115
* Local Variables:
116
* eval: (c-set-style "gnu")
117
* End:
118
*/
tap_interface_details_t::tap_flags
u32 tap_flags
Definition:
tap.h:74
tap_main_t::tap_ids
uword * tap_ids
Definition:
tap.h:95
tap_main_t::host_mtu_size
int host_mtu_size
Definition:
tap.h:98
tap_main_t::log_default
vlib_log_class_t log_default
Definition:
tap.h:92
tap_create_if_args_t::host_ip4_addr
ip4_address_t host_ip4_addr
Definition:
tap.h:53
tap_create_if_args_t::tap_flags
u32 tap_flags
Definition:
tap.h:48
tap_interface_details_t::host_ip6_prefix_len
u8 host_ip6_prefix_len
Definition:
tap.h:85
tap_create_if_args_t::rx_ring_sz
u16 rx_ring_sz
Definition:
tap.h:46
tap_create_if_args_t::host_ip6_prefix_len
u8 host_ip6_prefix_len
Definition:
tap.h:58
tap_create_if_args_t::host_ip4_gw_set
u8 host_ip4_gw_set
Definition:
tap.h:56
u8
unsigned char u8
Definition:
types.h:56
vlib_log_class_t
u32 vlib_log_class_t
Definition:
vlib.h:51
tap_create_if
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition:
tap.c:133
sw_if_index
vl_api_interface_index_t sw_if_index
Definition:
gre.api:53
tap_interface_details_t::host_ip4_prefix_len
u8 host_ip4_prefix_len
Definition:
tap.h:83
tap_csum_offload_enable_disable
int tap_csum_offload_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable)
Definition:
tap.c:808
tap_delete_if
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition:
tap.c:773
u32
unsigned int u32
Definition:
types.h:88
tap_create_if_args_t::sw_if_index
u32 sw_if_index
Definition:
tap.h:64
ip4_address_t
Definition:
ip4_packet.h:49
tap_create_if_args_t::num_rx_queues
u8 num_rx_queues
Definition:
tap.h:45
tap_dump_ifs
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition:
tap.c:923
tap_create_if_args_t::tx_ring_sz
u16 tx_ring_sz
Definition:
tap.h:47
tap_interface_details_t::host_mac_addr
mac_address_t host_mac_addr
Definition:
tap.h:78
u16
unsigned short u16
Definition:
types.h:57
tap_create_if_args_t::rv
int rv
Definition:
tap.h:65
tap_create_if_args_t::mac_addr_set
u8 mac_addr_set
Definition:
tap.h:43
tap_interface_details_t::host_mtu_size
u32 host_mtu_size
Definition:
tap.h:86
tap_create_if_args_t::host_ip4_gw
ip4_address_t host_ip4_gw
Definition:
tap.h:55
tap_create_if_args_t::host_ip6_addr
ip6_address_t host_ip6_addr
Definition:
tap.h:57
tap_create_if_args_t::host_ip4_prefix_len
u8 host_ip4_prefix_len
Definition:
tap.h:54
vm
vlib_main_t * vm
Definition:
in2out_ed.c:1599
mac_address_t_
Definition:
mac_address.h:21
tap_interface_details_t::host_ip4_addr
ip4_address_t host_ip4_addr
Definition:
tap.h:82
tap_flag_t
tap_flag_t
Definition:
tap.h:33
tap_create_if_args_t::host_mtu_size
u32 host_mtu_size
Definition:
tap.h:62
tap_gso_enable_disable
int tap_gso_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable)
Definition:
tap.c:869
tap_create_if_args_t::host_bridge
u8 * host_bridge
Definition:
tap.h:52
tap_create_if_args_t::host_ip6_gw
ip6_address_t host_ip6_gw
Definition:
tap.h:59
tap_create_if_args_t::host_if_name
u8 * host_if_name
Definition:
tap.h:50
tap_interface_details_t::id
u32 id
Definition:
tap.h:72
tap_create_if_args_t::host_ip6_gw_set
u8 host_ip6_gw_set
Definition:
tap.h:60
clib_error_t
Definition:
clib_error.h:21
vlib_main_t
Definition:
main.h:83
uword
u64 uword
Definition:
types.h:112
tap_main_t
Definition:
tap.h:89
tap_create_if_args_t::host_mac_addr
mac_address_t host_mac_addr
Definition:
tap.h:51
foreach_tapv2_flags
#define foreach_tapv2_flags
Definition:
tap.h:25
tap_create_if_args_t::mac_addr
mac_address_t mac_addr
Definition:
tap.h:44
tap_create_if_args_t::host_mtu_set
u8 host_mtu_set
Definition:
tap.h:61
tap_create_if_args_t::error
clib_error_t * error
Definition:
tap.h:66
tap_interface_details_t::host_ip6_addr
ip6_address_t host_ip6_addr
Definition:
tap.h:84
tap_interface_details_t
TAP interface details struct.
Definition:
tap.h:70
tap_interface_details_t::tx_ring_sz
u16 tx_ring_sz
Definition:
tap.h:76
tap_interface_details_t::rx_ring_sz
u16 rx_ring_sz
Definition:
tap.h:77
tap_create_if_args_t::host_namespace
u8 * host_namespace
Definition:
tap.h:49
tap_create_if_args_t::id
u32 id
Definition:
tap.h:42
tap_interface_details_t::sw_if_index
u32 sw_if_index
Definition:
tap.h:73
tap_create_if_args_t
Definition:
tap.h:40
src
vnet
devices
tap
tap.h
Generated on Mon Oct 12 2020 16:04:45 for FD.io VPP by
1.8.13