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