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