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