FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
control.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 #ifndef VNET_CONTROL_H_
17 #define VNET_CONTROL_H_
18 
19 #include <vnet/vnet.h>
22 #include <vppinfra/timing_wheel.h>
23 
24 #define NUMBER_OF_RETRIES 1
25 #define PENDING_MREQ_EXPIRATION_TIME 3.0 /* seconds */
26 #define PENDING_MREQ_QUEUE_LEN 5
27 
28 #define RLOC_PROBING_INTERVAL 60.0
29 
30 /* when map-registration is enabled "quick registration" takes place first.
31  In this mode ETR sends map-register messages at an increased frequency
32  until specified message count is reached */
33 #define QUICK_MAP_REGISTER_MSG_COUNT 5
34 #define QUICK_MAP_REGISTER_INTERVAL 3.0
35 
36 /* normal map-register period */
37 #define MAP_REGISTER_INTERVAL 60.0
38 
39 /* how many tries until next map-server election */
40 #define MAX_EXPIRED_MAP_REGISTERS_DEFAULT 3
41 
42 #define PENDING_MREG_EXPIRATION_TIME 3.0 /* seconds */
43 
44 /* 24 hours */
45 #define MAP_REGISTER_DEFAULT_TTL 86400
46 
47 typedef struct
48 {
57 
58 typedef struct
59 {
62 
63 typedef struct
64 {
69 } fwd_entry_t;
70 
71 typedef struct
72 {
76 
77 typedef enum
78 {
82 
83 /* map-server/map-resolver structure */
84 typedef struct
85 {
89  char *key;
90 } lisp_msmr_t;
91 
92 typedef struct
93 {
94  /* headers */
95  u8 data[100];
99 
100 typedef struct
101 {
102  u8 mac[6];
105 
106 typedef struct
107 {
108  u8 mac[6];
109  u8 ip6[16];
111 
112 typedef enum
113 {
116  _MR_MODE_MAX
118 
119 #define foreach_lisp_flag_bit \
120  _(USE_PETR, "Use Proxy-ETR") \
121  _(XTR_MODE, "ITR/ETR mode") \
122  _(PETR_MODE, "Proxy-ETR mode") \
123  _(PITR_MODE, "Proxy-ITR mode") \
124  _(STATS_ENABLED, "Statistics enabled")
125 
126 typedef enum lisp_flag_bits
127 {
128 #define _(sym, str) LISP_FLAG_BIT_##sym,
130 #undef _
132 
133 typedef enum lisp_flags
134 {
135 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
137 #undef _
138 } lisp_flags_e;
139 
140 typedef struct
141 {
145 
146 typedef enum
147 {
151 
152 typedef struct
153 {
157  volatile u8 is_free;
159 
160 typedef struct
161 {
163 
164  /* LISP feature status */
166 
167  /* eid table */
169 
170  /* pool of mappings */
172 
173  /* hash map of secret keys by mapping index */
175 
176  /* pool of locators */
178 
179  /* pool of locator-sets */
181 
182  /* vector of locator-set vectors composed of and indexed by locator index */
184 
185  /* hash map of locators by name */
187 
188  /* vector of eid index vectors supported and indexed by locator-set index */
190 
191  /* vectors of indexes for local locator-sets and mappings */
194 
195  /* hash map of forwarding entries by mapping index */
197 
198  /* pool of vectors of rmts per lcl mapping in adjacencies */
200 
201  /* hash of pool positions of vectors of rmts by lcl mapping index */
203 
204  /* forwarding entries pool */
206 
207  /* hash map keyed by nonce of pending map-requests */
209 
210  /* pool of pending map requests */
212 
213  /* pool of pending map registers */
215 
216  /* hash map of sent map register messages */
218 
219  /* vector of map-resolvers */
221 
222  /* vector of map-servers */
224 
225  /* map resolver address currently being used for sending requests.
226  * This has to be an actual address and not an index to map_resolvers vector
227  * since the vector may be modified during request resend/retry procedure
228  * and break things :-) */
231 
234 
235  /* map-request locator set index */
237 
238  /* vni to vrf hash tables */
241 
242  /* vni to bd-index hash tables */
245 
246  /* track l2 and l3 interfaces that have been created for vni */
248 
249  /* Proxy ITR map index */
251 
252  /** Proxy ETR map index used for 'use-petr'.
253  * Not related to PETR tunnel mode */
255 
256  /* mapping index for NSH */
258 
259  /* map request mode */
261 
262  /* enable/disable map registering */
264 
265  /* enable/disable rloc-probing */
267 
268  /* timing wheel for mapping timeouts */
270 
271  /** Per thread pool of records shared with thread0 */
273 
274  /* TTL used for all mappings when registering */
276 
277  /* control variables for map server election */
280 
281  /** either UDP based or binary API. Default is UDP */
283 
284  /** Retry service node index */
286 
287  /* commodity */
293 
294 /* lisp-gpe control plane */
296 
300 
302 
305 {
306  return &lisp_control_main;
307 }
308 
309 void
312  u16 type);
313 
314 typedef struct
315 {
317  union
318  {
321  };
325 
326 int
328  u32 * ls_index);
329 int
331  locator_set_t * ls, u32 * ls_index);
332 
333 typedef struct
334 {
338 
342 
345  u8 *key;
348 
349 int
351  u32 * map_index);
352 int
354  u32 * map_index_result);
355 
356 int
358  locator_t * rlocs, u32 * res_map_index,
359  u8 * is_changed);
360 
361 int vnet_lisp_del_mapping (gid_address_t * eid, u32 * res_map_index);
362 
363 typedef struct
364 {
369 
371 
372 typedef struct
373 {
377 
378 int
381 
385 
386 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
387 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
388 
389 typedef struct
390 {
394 
395 int
397 
399 
400 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
402  u8 is_add);
411  u8 is_add);
414 int vnet_lisp_nsh_set_locator_set (u8 * locator_set_name, u8 is_add);
419 u32 *vnet_lisp_ndp_bds_get (void);
423 
424 extern int vnet_lisp_enable_disable_xtr_mode (u8 is_enabled);
425 extern int vnet_lisp_enable_disable_pitr_mode (u8 is_enabled);
426 extern int vnet_lisp_enable_disable_petr_mode (u8 is_enabled);
427 extern u8 vnet_lisp_get_xtr_mode (void);
428 extern u8 vnet_lisp_get_pitr_mode (void);
429 extern u8 vnet_lisp_get_petr_mode (void);
430 
432 
435 {
436  return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
437 }
438 
439 #endif /* VNET_CONTROL_H_ */
440 
441 /*
442  * fd.io coding-style-patch-verification: ON
443  *
444  * Local Variables:
445  * eval: (c-set-style "gnu")
446  * End:
447  */
u8 vnet_lisp_map_register_state_get(void)
Definition: control.c:408
int vnet_lisp_add_mapping(vnet_lisp_add_del_mapping_args_t *a, locator_t *rlocs, u32 *res_map_index, u8 *is_changed)
Adds/updates mapping.
Definition: control.c:1268
u32 vnet_lisp_map_register_fallback_threshold_get(void)
Definition: control.c:1672
map_records_arg_t ** map_records_args_pool
Per thread pool of records shared with thread0.
Definition: control.h:272
u8 is_down
Definition: control.h:86
u32 pitr_map_index
Definition: control.h:250
gid_address_t leid
Definition: control.h:73
int vnet_lisp_del_mapping(gid_address_t *eid, u32 *res_map_index)
Removes a mapping.
Definition: control.c:1377
int vnet_lisp_enable_disable_pitr_mode(u8 is_enabled)
Definition: control.c:4984
vl_api_mac_address_t mac
Definition: l2.api:491
u32 * lcl_to_rmt_adjs_by_lcl_idx
Definition: control.h:202
int vnet_lisp_enable_disable_xtr_mode(u8 is_enabled)
Definition: control.c:4947
a
Definition: bitmap.h:538
int vnet_lisp_add_del_map_table_key(gid_address_t *eid, char *key, u8 is_add)
int vnet_lisp_add_del_locator(vnet_lisp_add_del_locator_set_args_t *a, locator_set_t *ls, u32 *ls_index)
Definition: control.c:1930
int vnet_lisp_add_del_map_server(ip_address_t *addr, u8 is_add)
Definition: control.c:665
ip_address_t active_map_resolver
Definition: control.h:229
lisp_msmr_t * map_resolvers
Definition: control.h:220
int vnet_lisp_add_del_l2_arp_ndp_entry(gid_address_t *key, u8 *mac, u8 is_add)
Definition: control.c:1029
locator_pair_t * locator_pairs
Definition: control.h:68
uword * table_id_by_vni
Definition: control.h:239
unsigned long u64
Definition: types.h:89
lisp_adjacency_t * vnet_lisp_adjacencies_get_by_vni(u32 vni)
Returns vector of adjacencies.
Definition: control.c:611
u32 retry_service_index
Retry service node index.
Definition: control.h:285
lisp_api_ndp_entry_t * vnet_lisp_ndp_entries_get_by_bd(u32 bd)
Definition: control.c:1014
u32 * local_mappings_indexes
Definition: control.h:192
locator_t * locator_pool
Definition: control.h:177
Definition: control.h:63
vl_api_address_t src
Definition: gre.api:60
vlib_node_registration_t lisp_cp_lookup_ip6_node
(constructor) VLIB_REGISTER_NODE (lisp_cp_lookup_ip6_node)
Definition: control.c:3664
clib_error_t * lisp_cp_init()
u32 ip4
Definition: control.h:103
u32 nsh_map_index
Definition: control.h:257
int vnet_lisp_map_register_enable_disable(u8 is_enable)
Definition: control.c:2183
ip_address_t address
Definition: control.h:88
uword * vni_by_table_id
Definition: control.h:240
vhost_vring_addr_t addr
Definition: vhost_user.h:147
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
enum lisp_flag_bits lisp_flag_bits_e
lisp_msmr_t * map_servers
Definition: control.h:223
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
u32 ** locator_to_locator_sets
Definition: control.h:183
vlib_main_t * vlib_main
Definition: control.h:290
vlib_node_registration_t lisp_cp_lookup_ip4_node
(constructor) VLIB_REGISTER_NODE (lisp_cp_lookup_ip4_node)
Definition: control.c:3644
void get_src_and_dst_eids_from_buffer(lisp_cp_main_t *lcm, vlib_buffer_t *b, gid_address_t *src, gid_address_t *dst, u16 type)
Definition: control.c:3308
u32 * fwd_entry_by_mapping_index
Definition: control.h:196
int vnet_lisp_map_register_set_ttl(u32 ttl)
Definition: control.c:2369
u32 expired_map_registers
Definition: control.h:279
#define foreach_lisp_flag_bit
Definition: control.h:119
unsigned int u32
Definition: types.h:88
uword * bd_id_by_vni
Definition: control.h:243
static lisp_cp_main_t * vnet_lisp_cp_get_main()
Definition: control.h:304
u8 do_map_server_election
Definition: control.h:233
uword * vni_by_bd_id
Definition: control.h:244
u8 vnet_lisp_get_map_request_mode(void)
Definition: control.c:57
lisp_flags
Definition: control.h:133
gid_address_t src
Definition: control.h:49
vl_api_gre_tunnel_mode_t mode
Definition: gre.api:55
u32 petr_map_index
Proxy ETR map index used for &#39;use-petr&#39;.
Definition: control.h:254
ip6_main_t * im6
Definition: control.h:289
enum lisp_flags lisp_flags_e
vl_api_fib_path_type_t type
Definition: fib_types.api:123
u8 is_src_dst
Definition: control.h:67
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:519
u8 vnet_lisp_enable_disable_status(void)
Definition: control.c:2314
u8 do_map_resolver_election
Definition: control.h:232
f64 last_update
Definition: control.h:87
void vnet_lisp_create_retry_process(lisp_cp_main_t *lcm)
Definition: control.c:4915
unsigned short u16
Definition: types.h:57
u8 vnet_lisp_get_pitr_mode(void)
Definition: control.c:5051
u32 vni
Definition: lisp_gpe.api:129
map_records_arg_t * parse_map_reply(vlib_buffer_t *b)
Definition: control.c:4348
int vnet_lisp_set_map_request_mode(u8 mode)
Definition: control.c:1548
u8 * key_by_mapping_index
Definition: control.h:174
u32 * local_locator_set_indexes
Definition: control.h:193
gid_address_t reid
Definition: control.h:66
#define always_inline
Definition: ipsec.h:28
lisp_api_l2_arp_entry_t * vnet_lisp_l2_arp_entries_get_by_bd(u32 bd)
Definition: control.c:978
u8 map_request_mode
Definition: control.h:260
volatile u8 is_free
Definition: control.h:157
lisp_transport_protocol_t vnet_lisp_get_transport_protocol(void)
Definition: control.c:4940
int vnet_lisp_rloc_probe_enable_disable(u8 is_enable)
Definition: control.c:2174
lisp_cp_main_t lisp_control_main
Definition: control.c:37
u32 vnet_lisp_set_transport_protocol(u8 protocol)
Definition: control.c:4927
vl_api_address_t dst
Definition: gre.api:61
u8 map_registering
Definition: control.h:263
int vnet_lisp_use_petr(ip_address_t *ip, u8 is_add)
Configure Proxy-ETR.
Definition: control.c:1687
u8 ip6[16]
Definition: one.api:477
uword * pending_map_requests_by_nonce
Definition: control.h:208
int vnet_lisp_map_cache_add_del(vnet_lisp_add_del_mapping_args_t *a, u32 *map_index)
Add/remove mapping to/from map-cache.
Definition: control.c:716
int vnet_lisp_eid_table_map(u32 vni, u32 vrf, u8 is_l2, u8 is_add)
Definition: control.c:1068
char * key
Definition: control.h:89
u8 ttl
Definition: fib_types.api:26
u32 * vnet_lisp_l2_arp_bds_get(void)
Definition: control.c:916
int vnet_lisp_nsh_set_locator_set(u8 *locator_set_name, u8 is_add)
Definition: control.c:1569
lisp_transport_protocol_t
Definition: control.h:146
ip_address_t addr
Definition: control.h:142
int vnet_lisp_pitr_set_locator_set(u8 *locator_set_name, u8 is_add)
Definition: control.c:1620
u8 vnet_lisp_rloc_probe_state_get(void)
Definition: control.c:415
int vnet_lisp_add_del_map_resolver(vnet_lisp_add_del_map_resolver_args_t *a)
Definition: control.c:2321
timing_wheel_t wheel
Definition: control.h:269
Definition: control.h:106
struct _gid_address_t gid_address_t
lisp_flag_bits
Definition: control.h:126
u8 value
Definition: qos.api:54
int vnet_lisp_add_del_local_mapping(vnet_lisp_add_del_mapping_args_t *a, u32 *map_index_result)
Add/update/delete mapping to/in/from map-cache.
Definition: control.c:869
int vnet_lisp_enable_disable_petr_mode(u8 is_enabled)
Definition: control.c:5013
u8 data[128]
Definition: ipsec_types.api:87
lisp_transport_protocol_t transport_protocol
either UDP based or binary API.
Definition: control.h:282
gid_dictionary_t mapping_index_by_gid
Definition: control.h:168
IPv4 main type.
Definition: ip4.h:105
uword * l2_dp_intf_by_vni
Definition: control.h:247
u32 vnet_lisp_map_register_get_ttl(void)
Definition: control.c:2377
locator_set_t * locator_set_pool
Definition: control.h:180
u32 ** locator_set_to_eids
Definition: control.h:189
Definition: control.h:100
pending_map_register_t * pending_map_registers_pool
Definition: control.h:214
u32 map_register_ttl
Definition: control.h:275
fwd_entry_t * fwd_entry_pool
Definition: control.h:205
pending_map_request_t * pending_map_requests_pool
Definition: control.h:211
typedef key
Definition: ipsec_types.api:83
struct _vlib_node_registration vlib_node_registration_t
miss_packet_type_t
Definition: control.h:77
int vnet_lisp_add_del_mreq_itr_rlocs(vnet_lisp_add_del_mreq_itr_rloc_args_t *a)
Definition: control.c:2384
vl_api_address_t ip
Definition: l2.api:490
map_request_mode_t
Definition: control.h:112
ip_address_t active_map_server
Definition: control.h:230
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static mapping_t * lisp_get_petr_mapping(lisp_cp_main_t *lcm)
Definition: control.h:434
mapping_t * mapping_pool
Definition: control.h:171
uword * locator_set_index_by_name
Definition: control.h:186
u8 vnet_lisp_get_petr_mode(void)
Definition: control.c:5058
int vnet_lisp_add_del_adjacency(vnet_lisp_add_del_adjacency_args_t *a)
Adds adjacency or removes forwarding entry associated to remote mapping.
Definition: control.c:1477
gid_address_t reid
Definition: control.h:74
vlib_node_registration_t lisp_cp_input_node
(constructor) VLIB_REGISTER_NODE (lisp_cp_input_node)
Definition: control.c:4493
gid_address_t dst
Definition: control.h:50
u32 ** lcl_to_rmt_adjacencies
Definition: control.h:199
uword * map_register_messages_by_nonce
Definition: control.h:217
clib_error_t * vnet_lisp_enable_disable(u8 is_enabled)
Definition: control.c:2249
u8 vnet_lisp_get_xtr_mode(void)
Definition: control.c:5044
int vnet_lisp_clear_all_remote_adjacencies(void)
Definition: control.c:1426
mapping_t * mappings
Definition: control.h:156
u32 max_expired_map_registers
Definition: control.h:278
u32 mreq_itr_rlocs
Definition: control.h:236
u32 * vnet_lisp_ndp_bds_get(void)
Definition: control.c:940
vnet_main_t * vnet_main
Definition: control.h:291
u32 length
Definition: control.h:96
ip4_main_t * im4
Definition: control.h:288
gid_address_t leid
Definition: control.h:65
int vnet_lisp_map_register_fallback_threshold_set(u32 value)
Definition: control.c:1659
miss_packet_type_t type
Definition: control.h:97
int vnet_lisp_add_del_locator_set(vnet_lisp_add_del_locator_set_args_t *a, u32 *ls_index)
Definition: control.c:2034