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