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;
110 } lisp_api_ndp_entry_t;
114 MR_MODE_DST_ONLY = 0,
117 } map_request_mode_t;
119 #define foreach_lisp_flag_bit \
120 _(USE_PETR, "Use Proxy-ETR") \
121 _(STATS_ENABLED, "Statistics enabled")
123 typedef enum lisp_flag_bits
125 #define _(sym, str) LISP_FLAG_BIT_##sym,
126 foreach_lisp_flag_bit
130 typedef enum lisp_flags
132 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
133 foreach_lisp_flag_bit
155 /* LISP feature status */
159 gid_dictionary_t mapping_index_by_gid;
161 /* pool of mappings */
162 mapping_t *mapping_pool;
164 /* hash map of secret keys by mapping index */
165 u8 *key_by_mapping_index;
167 /* pool of locators */
168 locator_t *locator_pool;
170 /* pool of locator-sets */
171 locator_set_t *locator_set_pool;
173 /* vector of locator-set vectors composed of and indexed by locator index */
174 u32 **locator_to_locator_sets;
176 /* hash map of locators by name */
177 uword *locator_set_index_by_name;
179 /* vector of eid index vectors supported and indexed by locator-set index */
180 u32 **locator_set_to_eids;
182 /* vectors of indexes for local locator-sets and mappings */
183 u32 *local_mappings_indexes;
184 u32 *local_locator_set_indexes;
186 /* hash map of forwarding entries by mapping index */
187 u32 *fwd_entry_by_mapping_index;
189 /* pool of vectors of rmts per lcl mapping in adjacencies */
190 u32 **lcl_to_rmt_adjacencies;
192 /* hash of pool positions of vectors of rmts by lcl mapping index */
193 u32 *lcl_to_rmt_adjs_by_lcl_idx;
195 /* forwarding entries pool */
196 fwd_entry_t *fwd_entry_pool;
198 /* hash map keyed by nonce of pending map-requests */
199 uword *pending_map_requests_by_nonce;
201 /* pool of pending map requests */
202 pending_map_request_t *pending_map_requests_pool;
204 /* pool of pending map registers */
205 pending_map_register_t *pending_map_registers_pool;
207 /* hash map of sent map register messages */
208 uword *map_register_messages_by_nonce;
210 /* vector of map-resolvers */
211 lisp_msmr_t *map_resolvers;
213 /* vector of map-servers */
214 lisp_msmr_t *map_servers;
216 /* map resolver address currently being used for sending requests.
217 * This has to be an actual address and not an index to map_resolvers vector
218 * since the vector may be modified during request resend/retry procedure
219 * and break things :-) */
220 ip_address_t active_map_resolver;
221 ip_address_t active_map_server;
223 u8 do_map_resolver_election;
224 u8 do_map_server_election;
226 /* map-request locator set index */
229 /* vni to vrf hash tables */
230 uword *table_id_by_vni;
231 uword *vni_by_table_id;
233 /* vni to bd-index hash tables */
237 /* track l2 and l3 interfaces that have been created for vni */
238 uword *l2_dp_intf_by_vni;
240 /* Proxy ITR map index */
243 /** Proxy ETR map index */
249 /* mapping index for NSH */
252 /* map request mode */
255 /* enable/disable map registering */
258 /* enable/disable rloc-probing */
261 /* timing wheel for mappping timeouts */
262 timing_wheel_t wheel;
264 /** Per thread pool of records shared with thread0 */
265 map_records_arg_t **map_records_args_pool;
267 /* TTL used for all mappings when registering */
268 u32 map_register_ttl;
270 /* control variables for map server election */
271 u32 max_expired_map_registers;
272 u32 expired_map_registers;
277 vlib_main_t *vlib_main;
278 vnet_main_t *vnet_main;
281 /* lisp-gpe control plane */
282 extern lisp_cp_main_t lisp_control_main;
284 extern vlib_node_registration_t lisp_cp_input_node;
285 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
286 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
288 clib_error_t *lisp_cp_init ();
290 always_inline lisp_cp_main_t *
291 vnet_lisp_cp_get_main ()
293 return &lisp_control_main;
297 get_src_and_dst_eids_from_buffer (lisp_cp_main_t * lcm, vlib_buffer_t * b,
298 gid_address_t * src, gid_address_t * dst,
311 } vnet_lisp_add_del_locator_set_args_t;
314 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
317 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
318 locator_set_t * ls, u32 * ls_index);
324 u32 locator_set_index;
334 } vnet_lisp_add_del_mapping_args_t;
337 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
340 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
341 u32 * map_index_result);
344 vnet_lisp_add_mapping (vnet_lisp_add_del_mapping_args_t * a,
345 locator_t * rlocs, u32 * res_map_index,
348 int vnet_lisp_del_mapping (gid_address_t * eid, u32 * res_map_index);
355 } vnet_lisp_add_del_adjacency_args_t;
357 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
362 ip_address_t address;
363 } vnet_lisp_add_del_map_resolver_args_t;
366 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
367 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
369 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
370 u8 vnet_lisp_enable_disable_status (void);
372 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
373 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
378 u8 *locator_set_name;
379 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
382 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
384 int vnet_lisp_clear_all_remote_adjacencies (void);
386 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
387 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
389 int vnet_lisp_set_map_request_mode (u8 mode);
390 u8 vnet_lisp_get_map_request_mode (void);
391 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
392 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
393 int vnet_lisp_map_register_enable_disable (u8 is_enable);
394 u8 vnet_lisp_map_register_state_get (void);
395 u8 vnet_lisp_rloc_probe_state_get (void);
396 int vnet_lisp_add_del_l2_arp_entry (gid_address_t * key, u8 * mac, u8 is_add);
397 u32 *vnet_lisp_l2_arp_bds_get (void);
398 lisp_api_l2_arp_entry_t *vnet_lisp_l2_arp_entries_get_by_bd (u32 bd);
399 int vnet_lisp_nsh_set_locator_set (u8 * locator_set_name, u8 is_add);
400 int vnet_lisp_map_register_set_ttl (u32 ttl);
401 u32 vnet_lisp_map_register_get_ttl (void);
402 int vnet_lisp_map_register_fallback_threshold_set (u32 value);
403 u32 vnet_lisp_map_register_fallback_threshold_get (void);
404 u32 *vnet_lisp_ndp_bds_get (void);
405 lisp_api_ndp_entry_t *vnet_lisp_ndp_entries_get_by_bd (u32 bd);
407 map_records_arg_t *parse_map_reply (vlib_buffer_t * b);
409 always_inline mapping_t *
410 lisp_get_petr_mapping (lisp_cp_main_t * lcm)
412 return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
415 #endif /* VNET_CONTROL_H_ */
418 * fd.io coding-style-patch-verification: ON
421 * eval: (c-set-style "gnu")