FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
vxlan.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 #ifndef included_vnet_vxlan_h
16 #define included_vnet_vxlan_h
17 
18 #include <vppinfra/error.h>
19 #include <vppinfra/hash.h>
20 #include <vppinfra/bihash_16_8.h>
21 #include <vppinfra/bihash_24_8.h>
22 #include <vnet/vnet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ip/vtep.h>
25 #include <vnet/l2/l2_input.h>
26 #include <vnet/l2/l2_output.h>
27 #include <vnet/l2/l2_bd.h>
28 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/udp/udp_packet.h>
33 #include <vnet/dpo/dpo.h>
34 #include <vnet/adj/adj_types.h>
35 
36 /* *INDENT-OFF* */
37 typedef CLIB_PACKED (struct {
38  ip4_header_t ip4; /* 20 bytes */
39  udp_header_t udp; /* 8 bytes */
40  vxlan_header_t vxlan; /* 8 bytes */
41 }) ip4_vxlan_header_t;
42 
43 typedef CLIB_PACKED (struct {
44  ip6_header_t ip6; /* 40 bytes */
45  udp_header_t udp; /* 8 bytes */
46  vxlan_header_t vxlan; /* 8 bytes */
47 }) ip6_vxlan_header_t;
48 /* *INDENT-ON* */
49 
50 /*
51 * Key fields: remote ip, vni on incoming VXLAN packet
52 * all fields in NET byte order
53 */
55 
56 /*
57 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
58 * ip, vni fields in NET byte order
59 * fib index field in host byte order
60 */
62 
63 typedef union
64 {
65  struct
66  {
67  u32 sw_if_index; /* unicast - input interface / mcast - stats interface */
68  union
69  {
70  struct /* unicast action */
71  {
74  };
75  ip4_address_t local_ip; /* used as dst ip for mcast pkts to assign them to unicast tunnel */
76  };
77  };
80 
81 typedef struct
82 {
83  /* Required for pool_get_aligned */
84  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
85 
86  /* FIB DPO for IP forwarding of VXLAN encap packet */
88 
89  /* vxlan VNI in HOST byte order */
91 
92  /* tunnel src and dst addresses */
93  ip46_address_t src;
94  ip46_address_t dst;
95 
96  /* udp-ports */
99 
100  /* mcast packet output intfc index (used only if dst is mcast) */
102 
103  /* decap next index */
105 
106  /* The FIB index for src/dst addresses */
108 
109  /* vnet intfc index */
112 
113  /**
114  * Linkage into the FIB object graph
115  */
117 
118  /*
119  * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
120  * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
121  */
124 
125  /**
126  * The tunnel is a child of the FIB entry for its destination. This is
127  * so it receives updates when the forwarding information for that entry
128  * changes.
129  * The tunnels sibling index on the FIB entry's dependency list.
130  */
132 
133  u32 flow_index; /* infra flow index */
134  u32 dev_instance; /* Real device instance in tunnel vector */
135  u32 user_instance; /* Instance name being shown to user */
136 
139 
140 #define foreach_vxlan_input_next \
141 _(DROP, "error-drop") \
142 _(L2_INPUT, "l2-input")
143 
144 typedef enum
145 {
146 #define _(s,n) VXLAN_INPUT_NEXT_##s,
148 #undef _
151 
152 typedef enum
153 {
154 #define vxlan_error(n,s) VXLAN_ERROR_##n,
156 #undef vxlan_error
159 
160 typedef struct
161 {
162  /* vector of encap tunnel instances */
164 
165  /* lookup tunnel by key */
166  clib_bihash_16_8_t
167  vxlan4_tunnel_by_key; /* keyed on ipv4.dst + src_port + fib + vni */
168  clib_bihash_24_8_t
169  vxlan6_tunnel_by_key; /* keyed on ipv6.dst + src_port + fib + vni */
170 
171  /* local VTEP IPs ref count used by vxlan-bypass node to check if
172  received VXLAN packet DIP matches any local VTEP address */
174 
175  /* mcast shared info */
176  uword *mcast_shared; /* keyed on mcast ip46 addr */
177 
178  /* Mapping from sw_if_index to tunnel index */
180 
181  /* graph node state */
184 
185  /* convenience */
188 
189  /* Record used instances */
192 
193  /* cache for last 8 vxlan tunnel */
194 #ifdef CLIB_HAVE_VEC512
195  vtep4_cache_t vtep4_u512;
196 #endif
197 
198 } vxlan_main_t;
199 
200 extern vxlan_main_t vxlan_main;
201 
207 
208 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
209 
210 typedef struct
211 {
213 
214  /* we normally use is_ip4, but since this adds to the
215  * structure, this seems less of a breaking change */
219  ip46_address_t src, dst;
227 
229  (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
230 
232 
233 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
234 
236 #endif /* included_vnet_vxlan_h */
237 
238 /*
239  * fd.io coding-style-patch-verification: ON
240  *
241  * Local Variables:
242  * eval: (c-set-style "gnu")
243  * End:
244  */
bihash_24_8.h
vnet_vxlan_add_del_rx_flow
int vnet_vxlan_add_del_rx_flow(u32 hw_if_index, u32 t_imdex, int is_add)
Definition: vxlan.c:1181
adj_types.h
vnet_vxlan_add_del_tunnel_args_t::dst_port
u16 dst_port
Definition: vxlan.h:225
vnet_int_vxlan_bypass_mode
void vnet_int_vxlan_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan.c:985
vnet_vxlan_add_del_tunnel_args_t::vni
u32 vni
Definition: vxlan.h:223
vnet_vxlan_add_del_tunnel_args_t
Definition: vxlan.h:210
vnet_vxlan_add_del_tunnel_args_t::is_add
u8 is_add
Definition: vxlan.h:212
ip4
vl_api_ip4_address_t ip4
Definition: one.api:376
vxlan_tunnel_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: vxlan.h:101
vnet_vxlan_add_del_tunnel_args_t::decap_next_index
u32 decap_next_index
Definition: vxlan.h:222
format_vxlan_encap_trace
u8 * format_vxlan_encap_trace(u8 *s, va_list *args)
Definition: encap.c:58
vxlan_tunnel_t::fib_entry_index
fib_node_index_t fib_entry_index
Definition: vxlan.h:122
vnet_vxlan_add_del_tunnel_args_t::instance
u32 instance
Definition: vxlan.h:218
CLIB_CACHE_LINE_ALIGN_MARK
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
vxlan_tunnel_t::src_port
u16 src_port
Definition: vxlan.h:97
vnet_vxlan_add_del_tunnel_args_t::is_l3
u8 is_l3
Definition: vxlan.h:217
vxlan_main_t::tunnel_index_by_sw_if_index
u32 * tunnel_index_by_sw_if_index
Definition: vxlan.h:179
vxlan_header_t
Definition: vxlan_packet.h:44
vxlan_tunnel_t::dst
ip46_address_t dst
Definition: vxlan.h:94
vxlan_main_t::vxlan4_tunnel_by_key
clib_bihash_16_8_t vxlan4_tunnel_by_key
Definition: vxlan.h:167
clib_bihash_kv_24_8_t
Definition: bihash_24_8.h:40
u16
unsigned short u16
Definition: types.h:57
vxlan_main_t::mcast_shared
uword * mcast_shared
Definition: vxlan.h:176
vxlan_tunnel_t::VNET_DECLARE_REWRITE
VNET_DECLARE_REWRITE
Definition: vxlan.h:137
vxlan_tunnel_t::dev_instance
u32 dev_instance
Definition: vxlan.h:134
VXLAN_N_ERROR
@ VXLAN_N_ERROR
Definition: vxlan.h:157
vxlan_main_t::flow_id_start
u32 flow_id_start
Definition: vxlan.h:191
vxlan_decap_info_t::as_u64
u64 as_u64
Definition: vxlan.h:78
udp_header_t
Definition: udp_packet.h:45
ip4_header_t
Definition: ip4_packet.h:87
ethernet.h
CLIB_PACKED
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;vxlan_header_t vxlan;}) ip4_vxlan_header_t
vnet_vxlan_add_del_tunnel_args_t::src_port
u16 src_port
Definition: vxlan.h:224
ip6_packet.h
vxlan6_encap_node
vlib_node_registration_t vxlan6_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan6_encap_node)
Definition: encap.c:557
VXLAN_INPUT_N_NEXT
@ VXLAN_INPUT_N_NEXT
Definition: vxlan.h:149
vxlan_tunnel_t::vni
u32 vni
Definition: vxlan.h:90
vxlan_input_next_t
vxlan_input_next_t
Definition: vxlan.h:144
error.h
dpo.h
l2_output.h
vnet_vxlan_add_del_tunnel_args_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: vxlan.h:220
vxlan_decap_info_t
Definition: vxlan.h:63
vxlan_decap_info_t::error
u8 error
Definition: vxlan.h:73
vxlan_tunnel_t::sibling_index
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: vxlan.h:131
fib_node_index_t
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
vxlan_tunnel_t::mcast_adj_index
adj_index_t mcast_adj_index
Definition: vxlan.h:123
udp_packet.h
uword
u64 uword
Definition: types.h:112
vxlan_main_t::bm_ip6_bypass_enabled_by_sw_if
uword * bm_ip6_bypass_enabled_by_sw_if
Definition: vxlan.h:183
vxlan_decap_info_t::next_index
u16 next_index
Definition: vxlan.h:72
vxlan_tunnel_t::node
fib_node_t node
Linkage into the FIB object graph.
Definition: vxlan.h:116
ip4_address_t
Definition: ip4_packet.h:50
foreach_vxlan_input_next
#define foreach_vxlan_input_next
Definition: vxlan.h:140
vxlan_tunnel_t
Definition: vxlan.h:81
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
vxlan_tunnel_t::decap_next_index
u16 decap_next_index
Definition: vxlan.h:104
vxlan_main_t::vxlan6_tunnel_by_key
clib_bihash_24_8_t vxlan6_tunnel_by_key
Definition: vxlan.h:169
l2_input.h
vxlan_tunnel_t::next_dpo
dpo_id_t next_dpo
Definition: vxlan.h:87
vxlan_main_t
Definition: vxlan.h:160
ip4_packet.h
vnet_vxlan_get_tunnel_index
u32 vnet_vxlan_get_tunnel_index(u32 sw_if_index)
Definition: vxlan.c:1220
is_ip6
bool is_ip6
Definition: ip.api:43
vxlan_tunnel_t::sw_if_index
u32 sw_if_index
Definition: vxlan.h:110
vnet_vxlan_add_del_tunnel_args_t::is_ip6
u8 is_ip6
Definition: vxlan.h:216
vnet_main_t
Definition: vnet.h:76
vxlan_tunnel_t::encap_fib_index
u32 encap_fib_index
Definition: vxlan.h:107
clib_bihash_kv_16_8_t
Definition: bihash_16_8.h:40
vxlan_decap_info_t::local_ip
ip4_address_t local_ip
Definition: vxlan.h:75
u64
unsigned long u64
Definition: types.h:89
vxlan4_encap_node
vlib_node_registration_t vxlan4_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan4_encap_node)
Definition: encap.c:544
vxlan_packet.h
vxlan_main_t::vtep_table
vtep_table_t vtep_table
Definition: vxlan.h:173
ip.h
u32
unsigned int u32
Definition: types.h:88
vxlan4_flow_input_node
vlib_node_registration_t vxlan4_flow_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_flow_input_node)
Definition: decap.c:1304
ip6
vl_api_ip6_address_t ip6
Definition: one.api:424
vxlan4_input_node
vlib_node_registration_t vxlan4_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_input_node)
Definition: decap.c:23
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
bihash_16_8.h
ip6_header_t
Definition: ip6_packet.h:294
fib_node_t_
An node in the FIB graph.
Definition: fib_node.h:301
adj_index_t
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
vlib_main_t
Definition: main.h:102
vnet_vxlan_add_del_tunnel
int vnet_vxlan_add_del_tunnel(vnet_vxlan_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: vxlan.c:358
vxlan_main_t::vnet_main
vnet_main_t * vnet_main
Definition: vxlan.h:187
hash.h
vxlan4_tunnel_key_t
clib_bihash_kv_16_8_t vxlan4_tunnel_key_t
Definition: vxlan.h:54
u8
unsigned char u8
Definition: types.h:56
a
a
Definition: bitmap.h:544
vtep_table_t
Definition: vtep.h:62
vxlan_tunnel_t::user_instance
u32 user_instance
Definition: vxlan.h:135
vxlan_error.def
dpo_id_t_
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:172
vxlan_tunnel_t::hw_if_index
u32 hw_if_index
Definition: vxlan.h:111
vtep.h
vxlan_main_t::vlib_main
vlib_main_t * vlib_main
Definition: vxlan.h:186
vxlan_main
vxlan_main_t vxlan_main
Definition: vxlan.c:46
vnet.h
vxlan_main_t::tunnels
vxlan_tunnel_t * tunnels
Definition: vxlan.h:163
vxlan_main_t::instance_used
uword * instance_used
Definition: vxlan.h:190
vxlan_tunnel_t::src
ip46_address_t src
Definition: vxlan.h:93
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vxlan_tunnel_t::flow_index
u32 flow_index
Definition: vxlan.h:133
vxlan6_tunnel_key_t
clib_bihash_kv_24_8_t vxlan6_tunnel_key_t
Definition: vxlan.h:61
vnet_vxlan_add_del_tunnel_args_t::encap_fib_index
u32 encap_fib_index
Definition: vxlan.h:221
l2_bd.h
vxlan_main_t::bm_ip4_bypass_enabled_by_sw_if
uword * bm_ip4_bypass_enabled_by_sw_if
Definition: vxlan.h:182
vxlan_input_error_t
vxlan_input_error_t
Definition: vxlan.h:152
vxlan_tunnel_t::dst_port
u16 dst_port
Definition: vxlan.h:98
vxlan_decap_info_t::sw_if_index
u32 sw_if_index
Definition: vxlan.h:67
vxlan6_input_node
vlib_node_registration_t vxlan6_input_node
(constructor) VLIB_REGISTER_NODE (vxlan6_input_node)
Definition: decap.c:24
vnet_vxlan_add_del_tunnel_args_t::src
ip46_address_t src
Definition: vxlan.h:219