FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
vxlan_gbp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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_gbp_h
16 #define included_vnet_vxlan_gbp_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/l2/l2_input.h>
25 #include <vnet/l2/l2_output.h>
26 #include <vnet/l2/l2_bd.h>
27 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/ip/ip4_packet.h>
30 #include <vnet/ip/ip6_packet.h>
31 #include <vnet/udp/udp_local.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_gbp_header_t vxlan_gbp; /* 8 bytes */
41 }) ip4_vxlan_gbp_header_t;
42 
43 typedef CLIB_PACKED (struct {
44  ip6_header_t ip6; /* 40 bytes */
45  udp_header_t udp; /* 8 bytes */
46  vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
47 }) ip6_vxlan_gbp_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 
64 {
68 
69 extern u8 *format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args);
70 
71 typedef struct
72 {
73  /* Required for pool_get_aligned */
74  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
75 
76  /* FIB DPO for IP forwarding of VXLAN encap packet */
78 
79  /* flags */
81 
82  /* vxlan VNI in HOST byte order */
84 
85  /* tunnel src and dst addresses */
86  ip46_address_t src;
87  ip46_address_t dst;
88 
89  /* mcast packet output intfc index (used only if dst is mcast) */
91 
92  /* The FIB index for src/dst addresses */
94 
95  /* vnet intfc index */
98 
99  /** Next node after VxLAN-GBP encap */
101 
102  /**
103  * Tunnel mode.
104  * L2 tunnels decap to L2 path, L3 tunnels to the L3 path
105  */
107 
108  /**
109  * Linkage into the FIB object graph
110  */
112 
113  /*
114  * The FIB entry for (depending on VXLAN-GBP tunnel is unicast or mcast)
115  * sending unicast VXLAN-GBP encap packets or receiving mcast VXLAN-GBP packets
116  */
119 
120  /**
121  * The tunnel is a child of the FIB entry for its destination. This is
122  * so it receives updates when the forwarding information for that entry
123  * changes.
124  * The tunnels sibling index on the FIB entry's dependency list.
125  */
127 
128  u32 dev_instance; /* Real device instance in tunnel vector */
129  u32 user_instance; /* Instance name being shown to user */
130 
131 
134 
135 #define foreach_vxlan_gbp_input_next \
136  _(DROP, "error-drop") \
137  _(PUNT, "punt-dispatch") \
138  _(L2_INPUT, "l2-input") \
139  _(IP4_INPUT, "ip4-input") \
140  _(IP6_INPUT, "ip6-input")
141 
142 typedef enum
143 {
144 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
146 #undef _
149 
150 typedef enum
151 {
152 #define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
154 #undef vxlan_gbp_error
157 
158 /**
159  * Call back function packets that do not match a configured tunnel
160  */
163  u8 is_ip6);
164 
165 typedef struct
166 {
167  /* vector of encap tunnel instances */
169 
170  /* lookup tunnel by key */
171  clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key; /* keyed on ipv4.dst + fib + vni */
172  clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key; /* keyed on ipv6.dst + fib + vni */
173 
174  /* local VTEP IPs ref count used by vxlan-bypass node to check if
175  received VXLAN packet DIP matches any local VTEP address */
176  uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
177  uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
178 
179  /* mcast shared info */
180  uword *mcast_shared; /* keyed on mcast ip46 addr */
181 
182  /* Mapping from sw_if_index to tunnel index */
184 
185  /* On demand udp port registration */
187 
188  /* convenience */
191 
192  /* Record used instances */
194 
195  /**
196  * Punt reasons for no such tunnel
197  */
200 
202 
207 extern void vxlan_gbp_register_udp_ports (void);
208 extern void vxlan_gbp_unregister_udp_ports (void);
209 
210 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
211 
212 typedef struct
213 {
218  ip46_address_t src, dst;
223 
225  (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
226 int vnet_vxlan_gbp_tunnel_del (u32 sw_if_indexp);
227 
229  u8 is_enable);
230 
233 {
235 
237  return ~0;
238 
240 }
241 
242 #endif /* included_vnet_vxlan_gbp_h */
243 
244 /*
245  * fd.io coding-style-patch-verification: ON
246  *
247  * Local Variables:
248  * eval: (c-set-style "gnu")
249  * End:
250  */
vxlan_bgp_no_tunnel_t
vxlan_gbp_input_next_t(* vxlan_bgp_no_tunnel_t)(vlib_buffer_t *b, u32 thread_index, u8 is_ip6)
Call back function packets that do not match a configured tunnel.
Definition: vxlan_gbp.h:161
vlib_punt_reason_t
enum vlib_punt_reason_t_ vlib_punt_reason_t
The 'syatem' defined punt reasons.
vxlan_gbp_tunnel_t::sibling_index
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: vxlan_gbp.h:126
bihash_24_8.h
vxlan4_gbp_tunnel_key_t
clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t
Definition: vxlan_gbp.h:54
adj_types.h
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:492
vnet_vxlan_gbp_tunnel_add_del_args_t::vni
u32 vni
Definition: vxlan_gbp.h:221
foreach_vxlan_gbp_input_next
#define foreach_vxlan_gbp_input_next
Definition: vxlan_gbp.h:135
vxlan_gbp_tunnel_by_sw_if_index
static u32 vxlan_gbp_tunnel_by_sw_if_index(u32 sw_if_index)
Definition: vxlan_gbp.h:232
vxlan_gbp_tunnel_t::hw_if_index
u32 hw_if_index
Definition: vxlan_gbp.h:97
ip4
vl_api_ip4_address_t ip4
Definition: one.api:376
vxlan_gbp_main_t::tunnels
vxlan_gbp_tunnel_t * tunnels
Definition: vxlan_gbp.h:168
CLIB_CACHE_LINE_ALIGN_MARK
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
vnet_vxlan_gbp_tunnel_add_del_args_t::is_add
u8 is_add
Definition: vxlan_gbp.h:214
VXLAN_GBP_TUNNEL_MODE_L2
@ VXLAN_GBP_TUNNEL_MODE_L2
Definition: vxlan_gbp.h:65
vxlan_gbp_tunnel_t::fib_entry_index
fib_node_index_t fib_entry_index
Definition: vxlan_gbp.h:117
clib_bihash_kv_24_8_t
Definition: bihash_24_8.h:40
u16
unsigned short u16
Definition: types.h:57
vxlan_gbp_tunnel_t::vni
u32 vni
Definition: vxlan_gbp.h:83
vxlan_gbp_unregister_udp_ports
void vxlan_gbp_unregister_udp_ports(void)
Definition: vxlan_gbp.c:367
vnet_vxlan_gbp_tunnel_add_del_args_t::is_ip6
u8 is_ip6
Definition: vxlan_gbp.h:215
vxlan4_gbp_encap_node
vlib_node_registration_t vxlan4_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_encap_node)
Definition: encap.c:566
vxlan_gbp_main_t::vnet_main
vnet_main_t * vnet_main
Definition: vxlan_gbp.h:190
vxlan_gbp_tunnel_mode_t
enum vxlan_gbp_tunnel_mode_t_ vxlan_gbp_tunnel_mode_t
VXLAN_GBP_TUNNEL_MODE_L3
@ VXLAN_GBP_TUNNEL_MODE_L3
Definition: vxlan_gbp.h:66
udp_header_t
Definition: udp_packet.h:45
ip4_header_t
Definition: ip4_packet.h:87
ethernet.h
vxlan_gbp_tunnel_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: vxlan_gbp.h:90
vxlan4_gbp_input_node
vlib_node_registration_t vxlan4_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_input_node)
Definition: decap.c:541
ip6_packet.h
vnet_vxlan_gbp_tunnel_del
int vnet_vxlan_gbp_tunnel_del(u32 sw_if_indexp)
Definition: vxlan_gbp.c:666
vxlan_gbp_main
vxlan_gbp_main_t vxlan_gbp_main
Definition: vxlan_gbp.c:35
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
vxlan_gbp_tunnel_t::encap_fib_index
u32 encap_fib_index
Definition: vxlan_gbp.h:93
vxlan_gbp_input_next_t
vxlan_gbp_input_next_t
Definition: vxlan_gbp.h:142
error.h
dpo.h
vxlan_gbp_tunnel_t::mode
vxlan_gbp_tunnel_mode_t mode
Tunnel mode.
Definition: vxlan_gbp.h:106
vxlan_gbp_tunnel_t::dev_instance
u32 dev_instance
Definition: vxlan_gbp.h:128
l2_output.h
FIB_PROTOCOL_IP_MAX
#define FIB_PROTOCOL_IP_MAX
Definition outside of enum so it does not need to be included in non-defaulted switch statements.
Definition: fib_types.h:57
vnet_vxlan_gbp_tunnel_add_del_args_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: vxlan_gbp.h:219
vxlan_gbp_main_t::vtep6
uword * vtep6
Definition: vxlan_gbp.h:177
vnet_vxlan_gbp_tunnel_add_del_args_t::mode
vxlan_gbp_tunnel_mode_t mode
Definition: vxlan_gbp.h:217
vnet_int_vxlan_gbp_bypass_mode
void vnet_int_vxlan_gbp_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan_gbp.c:971
vxlan6_gbp_encap_node
vlib_node_registration_t vxlan6_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_encap_node)
Definition: encap.c:580
vxlan_gbp_error.def
vxlan_gbp_tunnel_t::dst
ip46_address_t dst
Definition: vxlan_gbp.h:87
vxlan_gbp_main_t::vxlan6_gbp_tunnel_by_key
clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key
Definition: vxlan_gbp.h:172
udp_local.h
fib_node_index_t
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
udp_packet.h
vxlan_gbp_tunnel_mode_t_
vxlan_gbp_tunnel_mode_t_
Definition: vxlan_gbp.h:63
uword
u64 uword
Definition: types.h:112
VXLAN_GBP_N_ERROR
@ VXLAN_GBP_N_ERROR
Definition: vxlan_gbp.h:155
vxlan_gbp_register_udp_ports
void vxlan_gbp_register_udp_ports(void)
Definition: vxlan_gbp.c:349
vxlan6_gbp_input_node
vlib_node_registration_t vxlan6_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_input_node)
Definition: decap.c:556
vxlan_gbp_packet.h
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
vxlan_gbp_tunnel_t::node
fib_node_t node
Linkage into the FIB object graph.
Definition: vxlan_gbp.h:111
vxlan_gbp_tunnel_t::VNET_DECLARE_REWRITE
VNET_DECLARE_REWRITE
Definition: vxlan_gbp.h:132
vxlan_gbp_tunnel_t::sw_if_index
u32 sw_if_index
Definition: vxlan_gbp.h:96
l2_input.h
vnet_vxlan_gbp_tunnel_add_del_args_t
Definition: vxlan_gbp.h:212
ip4_packet.h
is_ip6
bool is_ip6
Definition: ip.api:43
vnet_main_t
Definition: vnet.h:76
vxlan_gbp_tunnel_t
Definition: vxlan_gbp.h:71
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
vxlan_gbp_header_t
Definition: vxlan_gbp_packet.h:73
clib_bihash_kv_16_8_t
Definition: bihash_16_8.h:40
vxlan_gbp_main_t
Definition: vxlan_gbp.h:165
ip.h
u32
unsigned int u32
Definition: types.h:88
vxlan_gbp_tunnel_t::next_dpo
dpo_id_t next_dpo
Definition: vxlan_gbp.h:77
vxlan_gbp_main_t::tunnel_index_by_sw_if_index
u32 * tunnel_index_by_sw_if_index
Definition: vxlan_gbp.h:183
ip6
vl_api_ip6_address_t ip6
Definition: one.api:424
vxlan_gbp_main_t::vxlan4_gbp_tunnel_by_key
clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key
Definition: vxlan_gbp.h:171
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
vxlan_gbp_tunnel_t::encap_next_node
uword encap_next_node
Next node after VxLAN-GBP encap.
Definition: vxlan_gbp.h:100
vnet_vxlan_gbp_tunnel_add_del_args_t::encap_fib_index
u32 encap_fib_index
Definition: vxlan_gbp.h:220
bihash_16_8.h
ip6_header_t
Definition: ip6_packet.h:294
vxlan_gbp_main_t::vlib_main
vlib_main_t * vlib_main
Definition: vxlan_gbp.h:189
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
VXLAN_GBP_INPUT_N_NEXT
@ VXLAN_GBP_INPUT_N_NEXT
Definition: vxlan_gbp.h:147
vlib_main_t
Definition: main.h:102
hash.h
b
vlib_buffer_t ** b
Definition: nat44_ei_out2in.c:717
u8
unsigned char u8
Definition: types.h:56
vnet_vxlan_gbp_tunnel_add_del_args_t::instance
u32 instance
Definition: vxlan_gbp.h:216
a
a
Definition: bitmap.h:544
vxlan_gbp_tunnel_t::mcast_adj_index
adj_index_t mcast_adj_index
Definition: vxlan_gbp.h:118
CLIB_PACKED
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;vxlan_gbp_header_t vxlan_gbp;}) ip4_vxlan_gbp_header_t
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_gbp_tunnel_t::user_instance
u32 user_instance
Definition: vxlan_gbp.h:129
vxlan_gbp_input_error_t
vxlan_gbp_input_error_t
Definition: vxlan_gbp.h:150
vnet.h
vxlan_gbp_main_t::vtep4
uword * vtep4
Definition: vxlan_gbp.h:176
vxlan_gbp_tunnel_t::flags
u16 flags
Definition: vxlan_gbp.h:80
vxlan_gbp_tunnel_t::src
ip46_address_t src
Definition: vxlan_gbp.h:86
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vxlan_gbp_main_t::instance_used
uword * instance_used
Definition: vxlan_gbp.h:193
l2_bd.h
vxlan_gbp_main_t::udp_ports_registered
u32 udp_ports_registered
Definition: vxlan_gbp.h:186
vnet_vxlan_gbp_tunnel_add_del_args_t::src
ip46_address_t src
Definition: vxlan_gbp.h:218
format_vxlan_gbp_encap_trace
u8 * format_vxlan_gbp_encap_trace(u8 *s, va_list *args)
Definition: encap.c:59
vnet_vxlan_gbp_tunnel_add_del
int vnet_vxlan_gbp_tunnel_add_del(vnet_vxlan_gbp_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: vxlan_gbp.c:385
vxlan6_gbp_tunnel_key_t
clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t
Definition: vxlan_gbp.h:61
format_vxlan_gbp_tunnel_mode
u8 * format_vxlan_gbp_tunnel_mode(u8 *s, va_list *args)
Definition: vxlan_gbp.c:38
vlib_buffer_t
VLIB buffer representation.
Definition: buffer.h:111
vxlan_gbp_main_t::mcast_shared
uword * mcast_shared
Definition: vxlan_gbp.h:180