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 #define foreach_lisp_flag_bit       \
  98   _(USE_PETR, "Use Proxy-ETR")
  99
 100 typedef enum lisp_flag_bits
 101 {
 102 #define _(sym, str) LISP_FLAG_BIT_##sym,
 103   foreach_lisp_flag_bit
 104 #undef _
 105 } lisp_flag_bits_e;
 106
 107 typedef enum lisp_flags
 108 {
 109 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
 110   foreach_lisp_flag_bit
 111 #undef _
 112 } lisp_flags_e;
 113
 114 typedef struct
 115 {
 116   u32 flags;
 117
 118   /* LISP feature status */
 119   u8 is_enabled;
 120
 121   /* eid table */
 122   gid_dictionary_t mapping_index_by_gid;
 123
 124   /* pool of mappings */
 125   mapping_t *mapping_pool;
 126
 127   /* hash map of secret keys by mapping index */
 128   u8 *key_by_mapping_index;
 129
 130   /* pool of locators */
 131   locator_t *locator_pool;
 132
 133   /* pool of locator-sets */
 134   locator_set_t *locator_set_pool;
 135
 136   /* vector of locator-set vectors composed of and indexed by locator index */
 137   u32 **locator_to_locator_sets;
 138
 139   /* hash map of locators by name */
 140   uword *locator_set_index_by_name;
 141
 142   /* vector of eid index vectors supported and indexed by locator-set index */
 143   u32 **locator_set_to_eids;
 144
 145   /* vectors of indexes for local locator-sets and mappings */
 146   u32 *local_mappings_indexes;
 147   u32 *local_locator_set_indexes;
 148
 149   /* hash map of forwarding entries by mapping index */
 150   u32 *fwd_entry_by_mapping_index;
 151
 152   /* forwarding entries pool */
 153   fwd_entry_t *fwd_entry_pool;
 154
 155   /* hash map keyed by nonce of pending map-requests */
 156   uword *pending_map_requests_by_nonce;
 157
 158   /* pool of pending map requests */
 159   pending_map_request_t *pending_map_requests_pool;
 160
 161   /* hash map of sent map register messages */
 162   uword *map_register_messages_by_nonce;
 163
 164   /* vector of map-resolvers */
 165   lisp_msmr_t *map_resolvers;
 166
 167   /* vector of map-servers */
 168   lisp_msmr_t *map_servers;
 169
 170   /* map resolver address currently being used for sending requests.
 171    * This has to be an actual address and not an index to map_resolvers vector
 172    * since the vector may be modified during request resend/retry procedure
 173    * and break things :-) */
 174   ip_address_t active_map_resolver;
 175
 176   u8 do_map_resolver_election;
 177
 178   /* map-request  locator set index */
 179   u32 mreq_itr_rlocs;
 180
 181   /* vni to vrf hash tables */
 182   uword *table_id_by_vni;
 183   uword *vni_by_table_id;
 184
 185   /* vni to bd-index hash tables */
 186   uword *bd_id_by_vni;
 187   uword *vni_by_bd_id;
 188
 189   /* track l2 and l3 interfaces that have been created for vni */
 190   uword *l2_dp_intf_by_vni;
 191
 192   /* Proxy ITR map index */
 193   u32 pitr_map_index;
 194
 195   /** Proxy ETR map index */
 196   u32 petr_map_index;
 197
 198   /* LISP PITR mode */
 199   u8 lisp_pitr;
 200
 201   /* map request mode */
 202   u8 map_request_mode;
 203
 204   /* enable/disable map registering */
 205   u8 map_registering;
 206
 207   /* enable/disable rloc-probing */
 208   u8 rloc_probing;
 209
 210   /* timing wheel for mappping timeouts */
 211   timing_wheel_t wheel;
 212
 213   /* statistics */
 214   u8 stats_enabled;
 215
 216   /* commodity */
 217   ip4_main_t *im4;
 218   ip6_main_t *im6;
 219   vlib_main_t *vlib_main;
 220   vnet_main_t *vnet_main;
 221 } lisp_cp_main_t;
 222
 223 /* lisp-gpe control plane */
 224 extern lisp_cp_main_t lisp_control_main;
 225
 226 extern vlib_node_registration_t lisp_cp_input_node;
 227 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
 228 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
 229
 230 clib_error_t *lisp_cp_init ();
 231
 232 always_inline lisp_cp_main_t *
 233 vnet_lisp_cp_get_main ()
 234 {
 235   return &lisp_control_main;
 236 }
 237
 238 typedef struct
 239 {
 240   u8 is_add;
 241   union
 242   {
 243     u8 *name;
 244     u32 index;
 245   };
 246   locator_t *locators;
 247   u8 local;
 248 } vnet_lisp_add_del_locator_set_args_t;
 249
 250 int
 251 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
 252                                u32 * ls_index);
 253 int
 254 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
 255                            locator_set_t * ls, u32 * ls_index);
 256
 257 typedef struct
 258 {
 259   u8 is_add;
 260   gid_address_t eid;
 261   u32 locator_set_index;
 262
 263   u32 ttl;
 264   u8 action;
 265   u8 authoritative;
 266
 267   u8 local;
 268   u8 is_static;
 269   u8 *key;
 270   u8 key_id;
 271 } vnet_lisp_add_del_mapping_args_t;
 272
 273 int
 274 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
 275                              u32 * map_index);
 276 int
 277 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
 278                                  u32 * map_index_result);
 279
 280 int
 281 vnet_lisp_add_del_mapping (gid_address_t * deid, locator_t * dlocs, u8 action,
 282                            u8 authoritative, u32 ttl, u8 is_add, u8 is_static,
 283                            u32 * res_map_index);
 284
 285 typedef struct
 286 {
 287   gid_address_t reid;
 288   gid_address_t leid;
 289   u8 is_add;
 290 } vnet_lisp_add_del_adjacency_args_t;
 291
 292 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
 293
 294 typedef struct
 295 {
 296   u8 is_add;
 297   ip_address_t address;
 298 } vnet_lisp_add_del_map_resolver_args_t;
 299
 300 int
 301 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
 302 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
 303
 304 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
 305 u8 vnet_lisp_enable_disable_status (void);
 306
 307 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
 308 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
 309
 310 typedef struct
 311 {
 312   u8 is_add;
 313   u8 *locator_set_name;
 314 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
 315
 316 int
 317 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
 318
 319 int vnet_lisp_clear_all_remote_adjacencies (void);
 320
 321 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
 322 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
 323                                      u8 is_add);
 324 int vnet_lisp_set_map_request_mode (u8 mode);
 325 u8 vnet_lisp_get_map_request_mode (void);
 326 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
 327 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
 328 int vnet_lisp_map_register_enable_disable (u8 is_enable);
 329 u8 vnet_lisp_map_register_state_get (void);
 330 u8 vnet_lisp_rloc_probe_state_get (void);
 331
 332 always_inline mapping_t *
 333 lisp_get_petr_mapping (lisp_cp_main_t * lcm)
 334 {
 335   return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
 336 }
 337
 338 u8 vnet_lisp_stats_enable_disable_state (void);
 339 vnet_api_error_t vnet_lisp_stats_enable_disable (u8 enable);
 340
 341 #endif /* VNET_CONTROL_H_ */
 342
 343 /*
 344  * fd.io coding-style-patch-verification: ON
 345  *
 346  * Local Variables:
 347  * eval: (c-set-style "gnu")
 348  * End:
 349  */