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 PENDING_MREG_EXPIRATION_TIME 3.0 /* seconds */
29 #define RLOC_PROBING_INTERVAL 60.0
31 /* when map-registration is enabled "quick registration" takes place first.
32 In this mode ETR sends map-register messages at an increased frequency
33 until specified message count is reached */
34 #define QUICK_MAP_REGISTER_MSG_COUNT 3
35 #define QUICK_MAP_REGISTER_INTERVAL 3.0
37 /* normal map-register period */
38 #define MAP_REGISTER_INTERVAL 60.0
41 #define MAP_REGISTER_DEFAULT_TTL 86400
52 } pending_map_request_t;
59 locator_pair_t *locator_pairs;
74 /* map-server/map-resolver structure */
88 miss_packet_type_t type;
95 } lisp_api_l2_arp_entry_t;
102 } map_request_mode_t;
104 #define foreach_lisp_flag_bit \
105 _(USE_PETR, "Use Proxy-ETR") \
106 _(STATS_ENABLED, "Statistics enabled")
108 typedef enum lisp_flag_bits
110 #define _(sym, str) LISP_FLAG_BIT_##sym,
111 foreach_lisp_flag_bit
115 typedef enum lisp_flags
117 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
118 foreach_lisp_flag_bit
140 /* LISP feature status */
144 gid_dictionary_t mapping_index_by_gid;
146 /* pool of mappings */
147 mapping_t *mapping_pool;
149 /* hash map of secret keys by mapping index */
150 u8 *key_by_mapping_index;
152 /* pool of locators */
153 locator_t *locator_pool;
155 /* pool of locator-sets */
156 locator_set_t *locator_set_pool;
158 /* vector of locator-set vectors composed of and indexed by locator index */
159 u32 **locator_to_locator_sets;
161 /* hash map of locators by name */
162 uword *locator_set_index_by_name;
164 /* vector of eid index vectors supported and indexed by locator-set index */
165 u32 **locator_set_to_eids;
167 /* vectors of indexes for local locator-sets and mappings */
168 u32 *local_mappings_indexes;
169 u32 *local_locator_set_indexes;
171 /* hash map of forwarding entries by mapping index */
172 u32 *fwd_entry_by_mapping_index;
174 /* forwarding entries pool */
175 fwd_entry_t *fwd_entry_pool;
177 /* hash map keyed by nonce of pending map-requests */
178 uword *pending_map_requests_by_nonce;
180 /* pool of pending map requests */
181 pending_map_request_t *pending_map_requests_pool;
183 /* hash map of sent map register messages */
184 uword *map_register_messages_by_nonce;
186 /* vector of map-resolvers */
187 lisp_msmr_t *map_resolvers;
189 /* vector of map-servers */
190 lisp_msmr_t *map_servers;
192 /* map resolver address currently being used for sending requests.
193 * This has to be an actual address and not an index to map_resolvers vector
194 * since the vector may be modified during request resend/retry procedure
195 * and break things :-) */
196 ip_address_t active_map_resolver;
198 u8 do_map_resolver_election;
200 /* map-request locator set index */
203 /* vni to vrf hash tables */
204 uword *table_id_by_vni;
205 uword *vni_by_table_id;
207 /* vni to bd-index hash tables */
211 /* track l2 and l3 interfaces that have been created for vni */
212 uword *l2_dp_intf_by_vni;
214 /* Proxy ITR map index */
217 /** Proxy ETR map index */
223 /* mapping index for NSH */
226 /* map request mode */
229 /* enable/disable map registering */
232 /* enable/disable rloc-probing */
235 /* timing wheel for mappping timeouts */
236 timing_wheel_t wheel;
238 /** Per thread pool of records shared with thread0 */
239 map_records_arg_t **map_records_args_pool;
244 vlib_main_t *vlib_main;
245 vnet_main_t *vnet_main;
248 /* lisp-gpe control plane */
249 extern lisp_cp_main_t lisp_control_main;
251 extern vlib_node_registration_t lisp_cp_input_node;
252 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
253 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
255 clib_error_t *lisp_cp_init ();
257 always_inline lisp_cp_main_t *
258 vnet_lisp_cp_get_main ()
260 return &lisp_control_main;
264 get_src_and_dst_eids_from_buffer (lisp_cp_main_t * lcm, vlib_buffer_t * b,
265 gid_address_t * src, gid_address_t * dst,
278 } vnet_lisp_add_del_locator_set_args_t;
281 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
284 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
285 locator_set_t * ls, u32 * ls_index);
291 u32 locator_set_index;
301 } vnet_lisp_add_del_mapping_args_t;
304 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
307 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
308 u32 * map_index_result);
311 vnet_lisp_add_del_mapping (gid_address_t * deid, locator_t * dlocs, u8 action,
312 u8 authoritative, u32 ttl, u8 is_add, u8 is_static,
313 u32 * res_map_index);
320 } vnet_lisp_add_del_adjacency_args_t;
322 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
327 ip_address_t address;
328 } vnet_lisp_add_del_map_resolver_args_t;
331 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
332 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
334 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
335 u8 vnet_lisp_enable_disable_status (void);
337 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
338 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
343 u8 *locator_set_name;
344 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
347 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
349 int vnet_lisp_clear_all_remote_adjacencies (void);
351 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
352 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
354 int vnet_lisp_set_map_request_mode (u8 mode);
355 u8 vnet_lisp_get_map_request_mode (void);
356 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
357 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
358 int vnet_lisp_map_register_enable_disable (u8 is_enable);
359 u8 vnet_lisp_map_register_state_get (void);
360 u8 vnet_lisp_rloc_probe_state_get (void);
361 int vnet_lisp_add_del_l2_arp_entry (gid_address_t * key, u8 * mac, u8 is_add);
362 u32 *vnet_lisp_l2_arp_bds_get (void);
363 lisp_api_l2_arp_entry_t *vnet_lisp_l2_arp_entries_get_by_bd (u32 bd);
364 int vnet_lisp_nsh_set_locator_set (u8 * locator_set_name, u8 is_add);
366 map_records_arg_t *parse_map_reply (vlib_buffer_t * b);
368 always_inline mapping_t *
369 lisp_get_petr_mapping (lisp_cp_main_t * lcm)
371 return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
374 #endif /* VNET_CONTROL_H_ */
377 * fd.io coding-style-patch-verification: ON
380 * eval: (c-set-style "gnu")