FD.io VPP  v20.09-64-g4f7b92f0a
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.h>
32 #include <vnet/dpo/dpo.h>
33 #include <vnet/adj/adj_types.h>
34 
35 /* *INDENT-OFF* */
36 typedef CLIB_PACKED (struct {
37  ip4_header_t ip4; /* 20 bytes */
38  udp_header_t udp; /* 8 bytes */
39  vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
40 }) ip4_vxlan_gbp_header_t;
41 
42 typedef CLIB_PACKED (struct {
43  ip6_header_t ip6; /* 40 bytes */
44  udp_header_t udp; /* 8 bytes */
45  vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
46 }) ip6_vxlan_gbp_header_t;
47 /* *INDENT-ON* */
48 
49 /*
50 * Key fields: remote ip, vni on incoming VXLAN packet
51 * all fields in NET byte order
52 */
54 
55 /*
56 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
57 * ip, vni fields in NET byte order
58 * fib index field in host byte order
59 */
61 
63 {
67 
68 extern u8 *format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args);
69 
70 typedef struct
71 {
72  /* Required for pool_get_aligned */
73  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
74 
75  /* FIB DPO for IP forwarding of VXLAN encap packet */
77 
78  /* flags */
80 
81  /* vxlan VNI in HOST byte order */
83 
84  /* tunnel src and dst addresses */
85  ip46_address_t src;
86  ip46_address_t dst;
87 
88  /* mcast packet output intfc index (used only if dst is mcast) */
90 
91  /* The FIB index for src/dst addresses */
93 
94  /* vnet intfc index */
97 
98  /** Next node after VxLAN-GBP encap */
100 
101  /**
102  * Tunnel mode.
103  * L2 tunnels decap to L2 path, L3 tunnels to the L3 path
104  */
105  vxlan_gbp_tunnel_mode_t mode;
106 
107  /**
108  * Linkage into the FIB object graph
109  */
111 
112  /*
113  * The FIB entry for (depending on VXLAN-GBP tunnel is unicast or mcast)
114  * sending unicast VXLAN-GBP encap packets or receiving mcast VXLAN-GBP packets
115  */
118 
119  /**
120  * The tunnel is a child of the FIB entry for its destination. This is
121  * so it receives updates when the forwarding information for that entry
122  * changes.
123  * The tunnels sibling index on the FIB entry's dependency list.
124  */
126 
127  u32 dev_instance; /* Real device instance in tunnel vector */
128  u32 user_instance; /* Instance name being shown to user */
129 
130 
133 
134 #define foreach_vxlan_gbp_input_next \
135  _(DROP, "error-drop") \
136  _(PUNT, "punt-dispatch") \
137  _(L2_INPUT, "l2-input") \
138  _(IP4_INPUT, "ip4-input") \
139  _(IP6_INPUT, "ip6-input")
140 
141 typedef enum
142 {
143 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
145 #undef _
148 
149 typedef enum
150 {
151 #define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
153 #undef vxlan_gbp_error
156 
157 /**
158  * Call back function packets that do not match a configured tunnel
159  */
161  u32 thread_index,
162  u8 is_ip6);
163 
164 typedef struct
165 {
166  /* vector of encap tunnel instances */
168 
169  /* lookup tunnel by key */
170  clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key; /* keyed on ipv4.dst + fib + vni */
171  clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key; /* keyed on ipv6.dst + fib + vni */
172 
173  /* local VTEP IPs ref count used by vxlan-bypass node to check if
174  received VXLAN packet DIP matches any local VTEP address */
175  uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
176  uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
177 
178  /* mcast shared info */
179  uword *mcast_shared; /* keyed on mcast ip46 addr */
180 
181  /* Mapping from sw_if_index to tunnel index */
183 
184  /* On demand udp port registration */
186 
187  /* convenience */
190 
191  /* Record used instances */
193 
194  /**
195  * Punt reasons for no such tunnel
196  */
199 
201 
206 extern void vxlan_gbp_register_udp_ports (void);
207 extern void vxlan_gbp_unregister_udp_ports (void);
208 
209 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
210 
211 typedef struct
212 {
216  vxlan_gbp_tunnel_mode_t mode;
217  ip46_address_t src, dst;
222 
224  (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
225 int vnet_vxlan_gbp_tunnel_del (u32 sw_if_indexp);
226 
228  u8 is_enable);
229 
232 {
234 
235  if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
236  return ~0;
237 
238  return (vxm->tunnel_index_by_sw_if_index[sw_if_index]);
239 }
240 
241 #endif /* included_vnet_vxlan_gbp_h */
242 
243 /*
244  * fd.io coding-style-patch-verification: ON
245  *
246  * Local Variables:
247  * eval: (c-set-style "gnu")
248  * End:
249  */
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;vxlan_gbp_header_t vxlan_gbp;}) ip4_vxlan_gbp_header_t
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key
Definition: vxlan_gbp.h:171
a
Definition: bitmap.h:538
u8 * format_vxlan_gbp_encap_trace(u8 *s, va_list *args)
Definition: encap.c:59
vxlan_gbp_input_next_t
Definition: vxlan_gbp.h:141
#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:58
enum vxlan_gbp_tunnel_mode_t_ vxlan_gbp_tunnel_mode_t
#define foreach_vxlan_gbp_input_next
Definition: vxlan_gbp.h:134
unsigned char u8
Definition: types.h:56
int vnet_vxlan_gbp_tunnel_del(u32 sw_if_indexp)
Definition: vxlan_gbp.c:665
vl_api_ip6_address_t ip6
Definition: one.api:424
static u32 vxlan_gbp_tunnel_by_sw_if_index(u32 sw_if_index)
Definition: vxlan_gbp.h:231
vlib_main_t * vlib_main
Definition: vxlan_gbp.h:188
unsigned int u32
Definition: types.h:88
int vnet_vxlan_gbp_tunnel_add_del(vnet_vxlan_gbp_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: vxlan_gbp.c:384
void vnet_int_vxlan_gbp_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan_gbp.c:970
bool is_ip6
Definition: ip.api:43
uword * mcast_shared
Definition: vxlan_gbp.h:179
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key
Definition: vxlan_gbp.h:170
adj_index_t mcast_adj_index
Definition: vxlan_gbp.h:117
dpo_id_t next_dpo
Definition: vxlan_gbp.h:76
unsigned short u16
Definition: types.h:57
vlib_node_registration_t vxlan6_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_encap_node)
Definition: encap.c:574
vlib_node_registration_t vxlan4_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_input_node)
Definition: decap.c:541
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: vxlan_gbp.h:125
#define always_inline
Definition: ipsec.h:28
vl_api_ip4_address_t ip4
Definition: one.api:376
An node in the FIB graph.
Definition: fib_node.h:295
vl_api_address_t dst
Definition: gre.api:55
fib_node_index_t fib_entry_index
Definition: vxlan_gbp.h:116
void vxlan_gbp_register_udp_ports(void)
Definition: vxlan_gbp.c:348
u8 * format_vxlan_gbp_tunnel_mode(u8 *s, va_list *args)
Definition: vxlan_gbp.c:37
uword * instance_used
Definition: vxlan_gbp.h:192
clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t
Definition: vxlan_gbp.h:60
u32 udp_ports_registered
Definition: vxlan_gbp.h:185
clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t
Definition: vxlan_gbp.h:53
vxlan_gbp_main_t vxlan_gbp_main
Definition: vxlan_gbp.c:34
vxlan_gbp_input_error_t
Definition: vxlan_gbp.h:149
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
uword encap_next_node
Next node after VxLAN-GBP encap.
Definition: vxlan_gbp.h:99
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:160
ip46_address_t dst
Definition: vxlan_gbp.h:86
fib_node_t node
Linkage into the FIB object graph.
Definition: vxlan_gbp.h:110
ip46_address_t src
Definition: vxlan_gbp.h:85
struct _vlib_node_registration vlib_node_registration_t
vlib_node_registration_t vxlan6_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_input_node)
Definition: decap.c:556
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
vxlan_gbp_tunnel_t * tunnels
Definition: vxlan_gbp.h:167
vxlan_gbp_tunnel_mode_t_
Definition: vxlan_gbp.h:62
vxlan_gbp_tunnel_mode_t mode
Tunnel mode.
Definition: vxlan_gbp.h:105
void vxlan_gbp_unregister_udp_ports(void)
Definition: vxlan_gbp.c:366
enum vlib_punt_reason_t_ vlib_punt_reason_t
The &#39;syatem&#39; defined punt reasons.
vxlan_gbp_tunnel_mode_t mode
Definition: vxlan_gbp.h:216
vlib_node_registration_t vxlan4_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_encap_node)
Definition: encap.c:560
u32 * tunnel_index_by_sw_if_index
Definition: vxlan_gbp.h:182
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
vnet_main_t * vnet_main
Definition: vxlan_gbp.h:189