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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef VNET_CONTROL_H_
17 #define VNET_CONTROL_H_
19 #include <vnet/vnet.h>
20 #include <vnet/lisp-cp/gid_dictionary.h>
21 #include <vnet/lisp-cp/lisp_types.h>
22 #include <vppinfra/timing_wheel.h>
24 #define NUMBER_OF_RETRIES 1
25 #define PENDING_MREQ_EXPIRATION_TIME 3.0 /* seconds */
26 #define PENDING_MREQ_QUEUE_LEN 5
28 #define RLOC_PROBING_INTERVAL 60.0
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
36 /* normal map-register period */
37 #define MAP_REGISTER_INTERVAL 60.0
39 /* how many tries until next map-server election */
40 #define MAX_EXPIRED_MAP_REGISTERS_DEFAULT 3
42 #define PENDING_MREG_EXPIRATION_TIME 3.0 /* seconds */
45 #define MAP_REGISTER_DEFAULT_TTL 86400
56 } pending_map_request_t;
61 } pending_map_register_t;
68 locator_pair_t *locator_pairs;
83 /* map-server/map-resolver structure */
97 miss_packet_type_t type;
104 } lisp_api_l2_arp_entry_t;
108 MR_MODE_DST_ONLY = 0,
111 } map_request_mode_t;
113 #define foreach_lisp_flag_bit \
114 _(USE_PETR, "Use Proxy-ETR") \
115 _(STATS_ENABLED, "Statistics enabled")
117 typedef enum lisp_flag_bits
119 #define _(sym, str) LISP_FLAG_BIT_##sym,
120 foreach_lisp_flag_bit
124 typedef enum lisp_flags
126 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
127 foreach_lisp_flag_bit
149 /* LISP feature status */
153 gid_dictionary_t mapping_index_by_gid;
155 /* pool of mappings */
156 mapping_t *mapping_pool;
158 /* hash map of secret keys by mapping index */
159 u8 *key_by_mapping_index;
161 /* pool of locators */
162 locator_t *locator_pool;
164 /* pool of locator-sets */
165 locator_set_t *locator_set_pool;
167 /* vector of locator-set vectors composed of and indexed by locator index */
168 u32 **locator_to_locator_sets;
170 /* hash map of locators by name */
171 uword *locator_set_index_by_name;
173 /* vector of eid index vectors supported and indexed by locator-set index */
174 u32 **locator_set_to_eids;
176 /* vectors of indexes for local locator-sets and mappings */
177 u32 *local_mappings_indexes;
178 u32 *local_locator_set_indexes;
180 /* hash map of forwarding entries by mapping index */
181 u32 *fwd_entry_by_mapping_index;
183 /* pool of vectors of rmts per lcl mapping in adjacencies */
184 u32 **lcl_to_rmt_adjacencies;
186 /* hash of pool positions of vectors of rmts by lcl mapping index */
187 u32 *lcl_to_rmt_adjs_by_lcl_idx;
189 /* forwarding entries pool */
190 fwd_entry_t *fwd_entry_pool;
192 /* hash map keyed by nonce of pending map-requests */
193 uword *pending_map_requests_by_nonce;
195 /* pool of pending map requests */
196 pending_map_request_t *pending_map_requests_pool;
198 /* pool of pending map registers */
199 pending_map_register_t *pending_map_registers_pool;
201 /* hash map of sent map register messages */
202 uword *map_register_messages_by_nonce;
204 /* vector of map-resolvers */
205 lisp_msmr_t *map_resolvers;
207 /* vector of map-servers */
208 lisp_msmr_t *map_servers;
210 /* map resolver address currently being used for sending requests.
211 * This has to be an actual address and not an index to map_resolvers vector
212 * since the vector may be modified during request resend/retry procedure
213 * and break things :-) */
214 ip_address_t active_map_resolver;
215 ip_address_t active_map_server;
217 u8 do_map_resolver_election;
218 u8 do_map_server_election;
220 /* map-request locator set index */
223 /* vni to vrf hash tables */
224 uword *table_id_by_vni;
225 uword *vni_by_table_id;
227 /* vni to bd-index hash tables */
231 /* track l2 and l3 interfaces that have been created for vni */
232 uword *l2_dp_intf_by_vni;
234 /* Proxy ITR map index */
237 /** Proxy ETR map index */
243 /* mapping index for NSH */
246 /* map request mode */
249 /* enable/disable map registering */
252 /* enable/disable rloc-probing */
255 /* timing wheel for mappping timeouts */
256 timing_wheel_t wheel;
258 /** Per thread pool of records shared with thread0 */
259 map_records_arg_t **map_records_args_pool;
261 /* TTL used for all mappings when registering */
262 u32 map_register_ttl;
264 /* control variables for map server election */
265 u32 max_expired_map_registers;
266 u32 expired_map_registers;
271 vlib_main_t *vlib_main;
272 vnet_main_t *vnet_main;
275 /* lisp-gpe control plane */
276 extern lisp_cp_main_t lisp_control_main;
278 extern vlib_node_registration_t lisp_cp_input_node;
279 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
280 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
282 clib_error_t *lisp_cp_init ();
284 always_inline lisp_cp_main_t *
285 vnet_lisp_cp_get_main ()
287 return &lisp_control_main;
291 get_src_and_dst_eids_from_buffer (lisp_cp_main_t * lcm, vlib_buffer_t * b,
292 gid_address_t * src, gid_address_t * dst,
305 } vnet_lisp_add_del_locator_set_args_t;
308 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
311 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
312 locator_set_t * ls, u32 * ls_index);
318 u32 locator_set_index;
328 } vnet_lisp_add_del_mapping_args_t;
331 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
334 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
335 u32 * map_index_result);
338 vnet_lisp_add_mapping (vnet_lisp_add_del_mapping_args_t * a,
339 locator_t * rlocs, u32 * res_map_index,
342 int vnet_lisp_del_mapping (gid_address_t * eid, u32 * res_map_index);
349 } vnet_lisp_add_del_adjacency_args_t;
351 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
356 ip_address_t address;
357 } vnet_lisp_add_del_map_resolver_args_t;
360 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
361 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
363 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
364 u8 vnet_lisp_enable_disable_status (void);
366 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
367 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
372 u8 *locator_set_name;
373 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
376 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
378 int vnet_lisp_clear_all_remote_adjacencies (void);
380 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
381 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
383 int vnet_lisp_set_map_request_mode (u8 mode);
384 u8 vnet_lisp_get_map_request_mode (void);
385 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
386 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
387 int vnet_lisp_map_register_enable_disable (u8 is_enable);
388 u8 vnet_lisp_map_register_state_get (void);
389 u8 vnet_lisp_rloc_probe_state_get (void);
390 int vnet_lisp_add_del_l2_arp_entry (gid_address_t * key, u8 * mac, u8 is_add);
391 u32 *vnet_lisp_l2_arp_bds_get (void);
392 lisp_api_l2_arp_entry_t *vnet_lisp_l2_arp_entries_get_by_bd (u32 bd);
393 int vnet_lisp_nsh_set_locator_set (u8 * locator_set_name, u8 is_add);
394 int vnet_lisp_map_register_set_ttl (u32 ttl);
395 u32 vnet_lisp_map_register_get_ttl (void);
396 int vnet_lisp_map_register_fallback_threshold_set (u32 value);
397 u32 vnet_lisp_map_register_fallback_threshold_get (void);
399 map_records_arg_t *parse_map_reply (vlib_buffer_t * b);
401 always_inline mapping_t *
402 lisp_get_petr_mapping (lisp_cp_main_t * lcm)
404 return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
407 #endif /* VNET_CONTROL_H_ */
410 * fd.io coding-style-patch-verification: ON
413 * eval: (c-set-style "gnu")