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