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