FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
lisp_gpe.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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  * @brief LISP-GPE definitions.
18  */
19 
20 #ifndef included_vnet_lisp_gpe_h
21 #define included_vnet_lisp_gpe_h
22 
23 #include <vppinfra/error.h>
24 #include <vppinfra/mhash.h>
25 #include <vnet/vnet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/ip/ip4_packet.h>
30 #include <vnet/udp/udp.h>
33 #include <vnet/adj/adj_types.h>
34 #include <vppinfra/bihash_24_8.h>
36 
37 /** IP4-UDP-LISP encap header */
38 /* *INDENT-OFF* */
39 typedef CLIB_PACKED (struct {
40  ip4_header_t ip4; /* 20 bytes */
41  udp_header_t udp; /* 8 bytes */
42  lisp_gpe_header_t lisp; /* 8 bytes */
43 }) ip4_udp_lisp_gpe_header_t;
44 /* *INDENT-ON* */
45 
46 /** IP6-UDP-LISP encap header */
47 /* *INDENT-OFF* */
48 typedef CLIB_PACKED (struct {
49  ip6_header_t ip6; /* 40 bytes */
50  udp_header_t udp; /* 8 bytes */
51  lisp_gpe_header_t lisp; /* 8 bytes */
52 }) ip6_udp_lisp_gpe_header_t;
53 /* *INDENT-ON* */
54 
55 #define foreach_lisp_gpe_ip_input_next \
56 _(DROP, "error-drop") \
57 _(IP4_INPUT, "ip4-input") \
58 _(IP6_INPUT, "ip6-input") \
59 _(L2_INPUT, "l2-input")
60 
61 /** Enum of possible next nodes post LISP-GPE decap */
62 typedef enum
63 {
64 #define _(s,n) LISP_GPE_INPUT_NEXT_##s,
66 #undef _
69 
70 /* Arc to nsh-input added only if nsh-input exists */
71 #define LISP_GPE_INPUT_NEXT_NSH_INPUT 4
72 
73 typedef enum
74 {
75 #define lisp_gpe_error(n,s) LISP_GPE_ERROR_##n,
77 #undef lisp_gpe_error
80 
81 typedef struct tunnel_lookup
82 {
83  /** Lookup lisp-gpe interfaces by dp table (eg. vrf/bridge index) */
85 
86  /** lookup decap tunnel termination sw_if_index by vni and vice versa */
88 
89  // FIXME - Need this?
92 
93 typedef struct
94 {
98 
99 typedef struct
100 {
106 
109 
110 typedef enum gpe_encap_mode_e
111 {
116 
117 /** LISP-GPE global state*/
118 typedef struct lisp_gpe_main
119 {
120  /**
121  * @brief DB of all forwarding entries. The Key is:{l-EID,r-EID,vni}
122  * where the EID encodes L2 or L3
123  */
125 
126  /**
127  * @brief A Pool of all LISP forwarding entries
128  */
130 
131  /** Free vlib hw_if_indices */
133 
135 
136  /* L3 data structures
137  * ================== */
139 
140  /* L2 data structures
141  * ================== */
142 
143  /** L2 LISP FIB */
144  BVT (clib_bihash) l2_fib;
145 
147 
148  /** Load-balance for a miss in the table */
150 
151  /* NSH data structures
152  * ================== */
153 
154  BVT (clib_bihash) nsh_fib;
155 
157 
159 
160  gpe_encap_mode_t encap_mode;
161 
165 
166  /** Native fwd data structures */
167  fib_route_path_t *native_fwd_rpath[2];
168  u32 *native_fwd_lfes[2];
169 
170  /** convenience */
178 
179 /** LISP-GPE global state*/
181 
184 {
185  return &lisp_gpe_main;
186 }
187 
188 
192 
193 u8 *format_lisp_gpe_header_with_length (u8 * s, va_list * args);
194 
195 /** Read LISP-GPE status */
197 
198 u32
200  u32 overlay_table_id, u32 vni);
201 
202 /** Add/del LISP-GPE interface. */
203 extern void lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
204 extern u32 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
205 extern void lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
206 extern u32 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id,
207  u8 with_default_route);
208 
209 
210 typedef struct
211 {
214 
217 
218 typedef enum
219 {
225 
226 /** */
227 typedef struct
228 {
229  /** forwarding entry index of */
231 
233 
235 
236  /** type of mapping */
238 
239  /** action for negative mappings */
240  negative_fwd_actions_e action;
241 
242  /** local eid */
244 
245  /** remote eid */
247 
248  /** vector of locator pairs */
250 
251  /** FIB index to lookup remote locator at encap */
253 
254  /** FIB index to lookup inner IP at decap */
256 
257  /* TODO remove */
259 
260  /** VNI/tenant id in HOST byte order */
262 
263  /** vrf or bd where fwd entry should be inserted */
264  union
265  {
266  /** table (vrf) id */
268 
269  /** bridge domain id */
271 
272  /** generic access */
274  };
276 
277 typedef struct
278 {
282 
283 typedef struct
284 {
292 
293 #define foreach_lgpe_ip4_lookup_next \
294  _(DROP, "error-drop") \
295  _(LISP_CP_LOOKUP, "lisp-cp-lookup")
296 
298 {
299 #define _(sym,str) LGPE_IP4_LOOKUP_NEXT_##sym,
301 #undef _
304 
305 #define foreach_lgpe_ip6_lookup_next \
306  _(DROP, "error-drop") \
307  _(LISP_CP_LOOKUP, "lisp-cp-lookup")
308 
310 {
311 #define _(sym,str) LGPE_IP6_LOOKUP_NEXT_##sym,
313 #undef _
316 
317 u8 *format_vnet_lisp_gpe_status (u8 * s, va_list * args);
318 
320 gpe_encap_mode_t vnet_gpe_get_encap_mode (void);
321 int vnet_gpe_set_encap_mode (gpe_encap_mode_t mode);
322 
326 int vnet_lisp_flush_stats (void);
330 
331 #endif /* included_vnet_lisp_gpe_h */
332 
333 /*
334  * fd.io coding-style-patch-verification: ON
335  *
336  * Local Variables:
337  * eval: (c-set-style "gnu")
338  * End:
339  */
u32 fwd_entry_index
Definition: lisp_gpe.h:285
#define foreach_lisp_gpe_ip_input_next
Definition: lisp_gpe.h:55
u32 * free_tunnel_hw_if_indices
Free vlib hw_if_indices.
Definition: lisp_gpe.h:132
lisp_gpe_main_t lisp_gpe_main
LISP-GPE global state.
Definition: lisp_gpe.c:30
vnet_api_error_t
Definition: api_errno.h:162
int vnet_gpe_set_encap_mode(gpe_encap_mode_t mode)
Set GPE encapsulation mode.
Definition: lisp_gpe.c:224
a
Definition: bitmap.h:538
gpe_encap_mode_t vnet_gpe_get_encap_mode(void)
Definition: lisp_gpe.c:631
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;lisp_gpe_header_t lisp;}) ip4_udp_lisp_gpe_header_t
IP4-UDP-LISP encap header.
A representation of a path as described by a route producer.
Definition: fib_types.h:490
u32 bd_id
bridge domain id
Definition: lisp_gpe.h:270
u8 vnet_lisp_stats_enable_disable_state(void)
Definition: control.c:4865
u8 action
Definition: lisp_gpe.h:288
vnet_api_error_t vnet_lisp_stats_enable_disable(u8 enable)
Definition: control.c:4849
dp_address_t seid
Definition: lisp_gpe.h:103
LISP-GPE global state.
Definition: lisp_gpe.h:118
u32 encap_fib_index
FIB index to lookup remote locator at encap.
Definition: lisp_gpe.h:252
ip_address_t loc_rloc
Definition: lisp_gpe.h:104
clib_error_t * vnet_lisp_gpe_enable_disable(vnet_lisp_gpe_enable_disable_args_t *a)
Enable/disable LISP-GPE.
Definition: lisp_gpe.c:193
Combined counter to hold both packets and byte differences.
Definition: counter_types.h:26
void vnet_lisp_gpe_del_nsh_iface(lisp_gpe_main_t *lgm)
Del LISP-GPE NSH interface.
Definition: interface.c:794
vnet_hw_interface_class_t lisp_gpe_hw_class
uword * vni_by_sw_if_index
Definition: lisp_gpe.h:90
unsigned char u8
Definition: types.h:56
void lisp_gpe_del_l2_iface(lisp_gpe_main_t *lgm, u32 vni, u32 bd_id)
Add/del LISP-GPE interface.
Definition: interface.c:720
vlib_main_t * vlib_main
convenience
Definition: lisp_gpe.h:171
vlib_node_registration_t lisp_gpe_ip4_input_node
(constructor) VLIB_REGISTER_NODE (lisp_gpe_ip4_input_node)
Definition: decap.c:461
static lisp_gpe_main_t * vnet_lisp_gpe_get_main()
Definition: lisp_gpe.h:183
const dpo_id_t * nsh_cp_lkup
Definition: lisp_gpe.h:158
lgpe_ip6_lookup_next
Definition: lisp_gpe.h:309
lisp_api_stats_t * vnet_lisp_get_stats(void)
Definition: control.c:4550
ip6_main_t * im6
Definition: lisp_gpe.h:174
u32 fwd_entry_index
Definition: lisp_gpe.h:95
vl_api_ip6_address_t ip6
Definition: one.api:424
ip_address_t rmt_rloc
Definition: lisp_gpe.h:105
vlib_combined_counter_main_t counters
Definition: lisp_gpe.h:164
u8 is_add
Definition: lisp_gpe.h:234
int vnet_lisp_flush_stats(void)
gpe_encap_mode_e
Definition: lisp_gpe.h:110
uword * lisp_gpe_fwd_entries
DB of all forwarding entries.
Definition: lisp_gpe.h:124
unsigned int u32
Definition: types.h:88
enum gpe_encap_mode_e gpe_encap_mode_t
struct tunnel_lookup tunnel_lookup_t
Definition: lisp_gpe.h:227
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
u32 table_id
table (vrf) id
Definition: lisp_gpe.h:267
vlib_node_registration_t lisp_gpe_ip6_input_node
(constructor) VLIB_REGISTER_NODE (lisp_gpe_ip6_input_node)
Definition: decap.c:483
lisp_api_gpe_fwd_entry_t * vnet_lisp_gpe_fwd_entries_get_by_vni(u32 vni)
#define always_inline
Definition: ipsec.h:28
vl_api_ip4_address_t ip4
Definition: one.api:376
u32 vni
Definition: lisp_gpe.h:287
vl_api_tunnel_mode_t mode
Definition: gre.api:48
u32 decap_next_index
Definition: lisp_gpe.h:258
LISP-GPE packet header structure.
Definition: lisp_gpe.h:283
u8 * format_lisp_gpe_header_with_length(u8 *s, va_list *args)
Definition: interface.c:171
dp_address_t deid
Definition: lisp_gpe.h:102
u8 is_negative
type of mapping
Definition: lisp_gpe.h:237
uword * sw_if_index_by_vni
lookup decap tunnel termination sw_if_index by vni and vice versa
Definition: lisp_gpe.h:87
BVT(clib_bihash)
Definition: l2_fib.c:972
u32 vni
VNI/tenant id in HOST byte order.
Definition: lisp_gpe.h:261
u32 fwd_entry_index
forwarding entry index of
Definition: lisp_gpe.h:230
vlib_counter_t counters
Definition: lisp_gpe.h:107
void lisp_gpe_del_l3_iface(lisp_gpe_main_t *lgm, u32 vni, u32 bd_id)
Definition: interface.c:620
lisp_gpe_input_next_t
Enum of possible next nodes post LISP-GPE decap.
Definition: lisp_gpe.h:62
u32 decap_fib_index
FIB index to lookup inner IP at decap.
Definition: lisp_gpe.h:255
dp_address_t reid
Definition: lisp_gpe.h:290
tunnel_lookup_t l2_ifaces
Definition: lisp_gpe.h:146
vnet_main_t * vnet_main
Definition: lisp_gpe.h:172
enum lgpe_ip6_lookup_next lgpe_ip6_lookup_next_t
LISP-GPE header.
#define foreach_lgpe_ip4_lookup_next
Definition: lisp_gpe.h:293
struct _gid_address_t gid_address_t
u8 * placeholder_stats_pool
Definition: lisp_gpe.h:162
enum lgpe_ip4_lookup_next lgpe_ip4_lookup_next_t
struct lisp_gpe_main lisp_gpe_main_t
LISP-GPE global state.
gpe_encap_mode_t encap_mode
Definition: lisp_gpe.h:160
IPv4 main type.
Definition: ip4.h:106
uword * hw_if_index_by_dp_table
Lookup lisp-gpe interfaces by dp table (eg.
Definition: lisp_gpe.h:84
u8 is_src_dst
Definition: lisp_gpe.h:232
lisp_gpe_error_t
Definition: lisp_gpe.h:73
#define foreach_lgpe_ip6_lookup_next
Definition: lisp_gpe.h:305
gid_address_t rmt_eid
remote eid
Definition: lisp_gpe.h:246
u32 lisp_gpe_l3_iface_find_or_create(lisp_gpe_main_t *lgm, u32 overlay_table_id, u32 vni)
struct _vlib_node_registration vlib_node_registration_t
negative_fwd_actions_e action
action for negative mappings
Definition: lisp_gpe.h:240
Definition: lisp_gpe.h:223
struct lisp_gpe_fwd_entry_t_ * lisp_fwd_entry_pool
A Pool of all LISP forwarding entries.
Definition: lisp_gpe.h:129
u32 vnet_lisp_gpe_add_nsh_iface(lisp_gpe_main_t *lgm)
Add LISP-GPE NSH interface.
Definition: interface.c:754
u32 lisp_gpe_add_l2_iface(lisp_gpe_main_t *lgm, u32 vni, u32 bd_id)
Add/del LISP-GPE L2 interface.
Definition: interface.c:657
ip_lookup_main_t * lm4
Definition: lisp_gpe.h:175
struct _vnet_hw_interface_class vnet_hw_interface_class_t
tunnel_lookup_t l3_ifaces
Definition: lisp_gpe.h:138
ip4_main_t * im4
Definition: lisp_gpe.h:173
dpo_id_t l2_lb_cp_lkup
Load-balance for a miss in the table.
Definition: lisp_gpe.h:149
u8 * format_vnet_lisp_gpe_status(u8 *s, va_list *args)
Format LISP-GPE status.
Definition: lisp_gpe.c:592
u32 dp_table
generic access
Definition: lisp_gpe.h:273
negative_fwd_actions_e
Definition: lisp_gpe.h:218
u64 uword
Definition: types.h:112
locator_pair_t * locator_pairs
vector of locator pairs
Definition: lisp_gpe.h:249
int vnet_gpe_add_del_native_fwd_rpath(vnet_gpe_native_fwd_rpath_args_t *a)
Definition: lisp_gpe.c:458
A collection of combined counters.
Definition: counter.h:188
u32 lisp_gpe_add_l3_iface(lisp_gpe_main_t *lgm, u32 vni, u32 bd_id, u8 with_default_route)
Add/del LISP-GPE L3 interface.
Definition: interface.c:578
u8 vnet_lisp_gpe_enable_disable_status(void)
Read LISP-GPE status.
Definition: lisp_gpe.c:184
dp_address_t leid
Definition: lisp_gpe.h:289
lgpe_ip4_lookup_next
Definition: lisp_gpe.h:297
uword * lisp_stats_index_by_key
Definition: lisp_gpe.h:163
ip_lookup_main_t * lm6
Definition: lisp_gpe.h:176
gid_address_t lcl_eid
local eid
Definition: lisp_gpe.h:243
tunnel_lookup_t nsh_ifaces
Definition: lisp_gpe.h:156
A LISP Forwarding Entry.
u32 dp_table
Definition: lisp_gpe.h:286