Implement LISP control plane messages
[vpp.git] / vnet / vnet / lisp-cp / control.h
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>
20 #include <vnet/lisp-cp/gid_dictionary.h>
21 #include <vnet/lisp-cp/lisp_types.h>
22
23 #define NUMBER_OF_RETRIES                   1
24 #define PENDING_MREQ_EXPIRATION_TIME        3.0 /* seconds */
25 #define PENDING_MREQ_QUEUE_LEN              5
26
27 #define PENDING_MREG_EXPIRATION_TIME        3.0 /* seconds */
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        3
34 #define QUICK_MAP_REGISTER_INTERVAL         3.0
35
36 /* normal map-register period */
37 #define MAP_REGISTER_INTERVAL               60.0
38
39
40 typedef struct
41 {
42   gid_address_t src;
43   gid_address_t dst;
44   u32 retries_num;
45   f64 time_to_expire;
46   u8 is_smr_invoked;
47   u64 *nonces;
48   u8 to_be_removed;
49 } pending_map_request_t;
50
51 typedef struct
52 {
53   gid_address_t leid;
54   gid_address_t reid;
55   u8 is_src_dst;
56   locator_pair_t *locator_pairs;
57 } fwd_entry_t;
58
59 typedef struct
60 {
61   gid_address_t leid;
62   gid_address_t reid;
63 } lisp_adjacency_t;
64
65 typedef enum
66 {
67   IP4_MISS_PACKET,
68   IP6_MISS_PACKET
69 } miss_packet_type_t;
70
71 /* map-server/map-resolver structure */
72 typedef struct
73 {
74   u8 is_down;
75   f64 last_update;
76   ip_address_t address;
77   char *key;
78 } lisp_msmr_t;
79
80 typedef struct
81 {
82   /* headers */
83   u8 data[100];
84   u32 length;
85   miss_packet_type_t type;
86 } miss_packet_t;
87
88 typedef enum
89 {
90   MR_MODE_DST_ONLY = 0,
91   MR_MODE_SRC_DST,
92   _MR_MODE_MAX
93 } map_request_mode_t;
94
95 typedef struct
96 {
97   /* LISP feature status */
98   u8 is_enabled;
99
100   /* eid table */
101   gid_dictionary_t mapping_index_by_gid;
102
103   /* pool of mappings */
104   mapping_t *mapping_pool;
105
106   /* hash map of secret keys by mapping index */
107   u8 *key_by_mapping_index;
108
109   /* pool of locators */
110   locator_t *locator_pool;
111
112   /* pool of locator-sets */
113   locator_set_t *locator_set_pool;
114
115   /* vector of locator-set vectors composed of and indexed by locator index */
116   u32 **locator_to_locator_sets;
117
118   /* hash map of locators by name */
119   uword *locator_set_index_by_name;
120
121   /* vector of eid index vectors supported and indexed by locator-set index */
122   u32 **locator_set_to_eids;
123
124   /* vectors of indexes for local locator-sets and mappings */
125   u32 *local_mappings_indexes;
126   u32 *local_locator_set_indexes;
127
128   /* hash map of forwarding entries by mapping index */
129   u32 *fwd_entry_by_mapping_index;
130
131   /* forwarding entries pool */
132   fwd_entry_t *fwd_entry_pool;
133
134   /* hash map keyed by nonce of pending map-requests */
135   uword *pending_map_requests_by_nonce;
136
137   /* pool of pending map requests */
138   pending_map_request_t *pending_map_requests_pool;
139   volatile u32 *pending_map_request_lock;
140
141   /* hash map of sent map register messages */
142   uword *map_register_messages_by_nonce;
143
144   /* vector of map-resolvers */
145   lisp_msmr_t *map_resolvers;
146
147   /* vector of map-servers */
148   lisp_msmr_t *map_servers;
149
150   /* map resolver address currently being used for sending requests.
151    * This has to be an actual address and not an index to map_resolvers vector
152    * since the vector may be modified during request resend/retry procedure
153    * and break things :-) */
154   ip_address_t active_map_resolver;
155
156   u8 do_map_resolver_election;
157
158   /* map-request  locator set index */
159   u32 mreq_itr_rlocs;
160
161   /* vni to vrf hash tables */
162   uword *table_id_by_vni;
163   uword *vni_by_table_id;
164
165   /* vni to bd-index hash tables */
166   uword *bd_id_by_vni;
167   uword *vni_by_bd_id;
168
169   /* track l2 and l3 interfaces that have been created for vni */
170   uword *l2_dp_intf_by_vni;
171
172   /* Proxy ETR map index */
173   u32 pitr_map_index;
174
175   /* LISP PITR mode */
176   u8 lisp_pitr;
177
178   /* map request mode */
179   u8 map_request_mode;
180
181   /* enable/disable map registering */
182   u8 map_registering;
183
184   /* enable/disable rloc-probing */
185   u8 rloc_probing;
186
187   /* commodity */
188   ip4_main_t *im4;
189   ip6_main_t *im6;
190   vlib_main_t *vlib_main;
191   vnet_main_t *vnet_main;
192 } lisp_cp_main_t;
193
194 /* lisp-gpe control plane */
195 lisp_cp_main_t lisp_control_main;
196
197 extern vlib_node_registration_t lisp_cp_input_node;
198 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
199 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
200
201 clib_error_t *lisp_cp_init ();
202
203 always_inline lisp_cp_main_t *
204 vnet_lisp_cp_get_main ()
205 {
206   return &lisp_control_main;
207 }
208
209 typedef struct
210 {
211   u8 is_add;
212   union
213   {
214     u8 *name;
215     u32 index;
216   };
217   locator_t *locators;
218   u8 local;
219 } vnet_lisp_add_del_locator_set_args_t;
220
221 int
222 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
223                                u32 * ls_index);
224 int
225 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
226                            locator_set_t * ls, u32 * ls_index);
227
228 typedef struct
229 {
230   u8 is_add;
231   gid_address_t eid;
232   u32 locator_set_index;
233
234   u32 ttl;
235   u8 action;
236   u8 authoritative;
237
238   u8 local;
239   u8 is_static;
240   u8 *key;
241   u8 key_id;
242 } vnet_lisp_add_del_mapping_args_t;
243
244 int
245 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
246                              u32 * map_index);
247 int
248 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
249                                  u32 * map_index_result);
250
251 int
252 vnet_lisp_add_del_mapping (gid_address_t * deid, locator_t * dlocs, u8 action,
253                            u8 authoritative, u32 ttl, u8 is_add, u8 is_static,
254                            u32 * res_map_index);
255
256 typedef struct
257 {
258   gid_address_t reid;
259   gid_address_t leid;
260   u8 is_add;
261 } vnet_lisp_add_del_adjacency_args_t;
262
263 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
264
265 typedef struct
266 {
267   u8 is_add;
268   ip_address_t address;
269 } vnet_lisp_add_del_map_resolver_args_t;
270
271 int
272 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
273 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
274
275 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
276 u8 vnet_lisp_enable_disable_status (void);
277
278 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
279
280 typedef struct
281 {
282   u8 is_add;
283   u8 *locator_set_name;
284 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
285
286 int
287 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
288
289 int vnet_lisp_clear_all_remote_adjacencies (void);
290
291 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
292 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
293                                      u8 is_add);
294 int vnet_lisp_set_map_request_mode (u8 mode);
295 u8 vnet_lisp_get_map_request_mode (void);
296 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
297 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
298 int vnet_lisp_map_register_enable_disable (u8 is_enable);
299 u8 vnet_lisp_map_register_state_get (void);
300 u8 vnet_lisp_rloc_probe_state_get (void);
301
302 static inline void
303 lisp_pending_map_request_lock (lisp_cp_main_t * lcm)
304 {
305   if (lcm->pending_map_request_lock)
306     while (__sync_lock_test_and_set (lcm->pending_map_request_lock, 1))
307       /* sweet dreams */ ;
308 }
309
310 static inline void
311 lisp_pending_map_request_unlock (lisp_cp_main_t * lcm)
312 {
313   if (lcm->pending_map_request_lock)
314     *lcm->pending_map_request_lock = 0;
315 }
316
317 #endif /* VNET_CONTROL_H_ */
318
319 /*
320  * fd.io coding-style-patch-verification: ON
321  *
322  * Local Variables:
323  * eval: (c-set-style "gnu")
324  * End:
325  */