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 #include <vppinfra/timing_wheel.h>
  23
  24 #define NUMBER_OF_RETRIES                   1
  25 #define PENDING_MREQ_EXPIRATION_TIME        3.0 /* seconds */
  26 #define PENDING_MREQ_QUEUE_LEN              5
  27
  28 #define PENDING_MREG_EXPIRATION_TIME        3.0 /* seconds */
  29 #define RLOC_PROBING_INTERVAL               60.0
  30
  31 /* when map-registration is enabled "quick registration" takes place first.
  32    In this mode ETR sends map-register messages at an increased frequency
  33    until specified message count is reached */
  34 #define QUICK_MAP_REGISTER_MSG_COUNT        3
  35 #define QUICK_MAP_REGISTER_INTERVAL         3.0
  36
  37 /* normal map-register period */
  38 #define MAP_REGISTER_INTERVAL               60.0
  39
  40 /* 24 hours */
  41 #define MAP_REGISTER_DEFAULT_TTL            86400
  42
  43 typedef struct
  44 {
  45   gid_address_t src;
  46   gid_address_t dst;
  47   u32 retries_num;
  48   f64 time_to_expire;
  49   u8 is_smr_invoked;
  50   u64 *nonces;
  51   u8 to_be_removed;
  52 } pending_map_request_t;
  53
  54 typedef struct
  55 {
  56   gid_address_t leid;
  57   gid_address_t reid;
  58   u8 is_src_dst;
  59   locator_pair_t *locator_pairs;
  60 } fwd_entry_t;
  61
  62 typedef struct
  63 {
  64   gid_address_t leid;
  65   gid_address_t reid;
  66 } lisp_adjacency_t;
  67
  68 typedef enum
  69 {
  70   IP4_MISS_PACKET,
  71   IP6_MISS_PACKET
  72 } miss_packet_type_t;
  73
  74 /* map-server/map-resolver structure */
  75 typedef struct
  76 {
  77   u8 is_down;
  78   f64 last_update;
  79   ip_address_t address;
  80   char *key;
  81 } lisp_msmr_t;
  82
  83 typedef struct
  84 {
  85   /* headers */
  86   u8 data[100];
  87   u32 length;
  88   miss_packet_type_t type;
  89 } miss_packet_t;
  90
  91 typedef struct
  92 {
  93   u8 mac[6];
  94   u32 ip4;
  95 } lisp_api_l2_arp_entry_t;
  96
  97 typedef enum
  98 {
  99   MR_MODE_DST_ONLY = 0,
 100   MR_MODE_SRC_DST,
 101   _MR_MODE_MAX
 102 } map_request_mode_t;
 103
 104 #define foreach_lisp_flag_bit       \
 105   _(USE_PETR, "Use Proxy-ETR")                  \
 106   _(STATS_ENABLED, "Statistics enabled")
 107
 108 typedef enum lisp_flag_bits
 109 {
 110 #define _(sym, str) LISP_FLAG_BIT_##sym,
 111   foreach_lisp_flag_bit
 112 #undef _
 113 } lisp_flag_bits_e;
 114
 115 typedef enum lisp_flags
 116 {
 117 #define _(sym, str) LISP_FLAG_##sym = 1 << LISP_FLAG_BIT_##sym,
 118   foreach_lisp_flag_bit
 119 #undef _
 120 } lisp_flags_e;
 121
 122 typedef struct
 123 {
 124   ip_address_t addr;
 125   u32 bd;
 126 } lisp_l2_arp_key_t;
 127
 128 typedef struct
 129 {
 130   u64 nonce;
 131   u8 is_rloc_probe;
 132   mapping_t *mappings;
 133   volatile u8 is_free;
 134 } map_records_arg_t;
 135
 136 typedef struct
 137 {
 138   u32 flags;
 139
 140   /* LISP feature status */
 141   u8 is_enabled;
 142
 143   /* eid table */
 144   gid_dictionary_t mapping_index_by_gid;
 145
 146   /* pool of mappings */
 147   mapping_t *mapping_pool;
 148
 149   /* hash map of secret keys by mapping index */
 150   u8 *key_by_mapping_index;
 151
 152   /* pool of locators */
 153   locator_t *locator_pool;
 154
 155   /* pool of locator-sets */
 156   locator_set_t *locator_set_pool;
 157
 158   /* vector of locator-set vectors composed of and indexed by locator index */
 159   u32 **locator_to_locator_sets;
 160
 161   /* hash map of locators by name */
 162   uword *locator_set_index_by_name;
 163
 164   /* vector of eid index vectors supported and indexed by locator-set index */
 165   u32 **locator_set_to_eids;
 166
 167   /* vectors of indexes for local locator-sets and mappings */
 168   u32 *local_mappings_indexes;
 169   u32 *local_locator_set_indexes;
 170
 171   /* hash map of forwarding entries by mapping index */
 172   u32 *fwd_entry_by_mapping_index;
 173
 174   /* forwarding entries pool */
 175   fwd_entry_t *fwd_entry_pool;
 176
 177   /* hash map keyed by nonce of pending map-requests */
 178   uword *pending_map_requests_by_nonce;
 179
 180   /* pool of pending map requests */
 181   pending_map_request_t *pending_map_requests_pool;
 182
 183   /* hash map of sent map register messages */
 184   uword *map_register_messages_by_nonce;
 185
 186   /* vector of map-resolvers */
 187   lisp_msmr_t *map_resolvers;
 188
 189   /* vector of map-servers */
 190   lisp_msmr_t *map_servers;
 191
 192   /* map resolver address currently being used for sending requests.
 193    * This has to be an actual address and not an index to map_resolvers vector
 194    * since the vector may be modified during request resend/retry procedure
 195    * and break things :-) */
 196   ip_address_t active_map_resolver;
 197
 198   u8 do_map_resolver_election;
 199
 200   /* map-request  locator set index */
 201   u32 mreq_itr_rlocs;
 202
 203   /* vni to vrf hash tables */
 204   uword *table_id_by_vni;
 205   uword *vni_by_table_id;
 206
 207   /* vni to bd-index hash tables */
 208   uword *bd_id_by_vni;
 209   uword *vni_by_bd_id;
 210
 211   /* track l2 and l3 interfaces that have been created for vni */
 212   uword *l2_dp_intf_by_vni;
 213
 214   /* Proxy ITR map index */
 215   u32 pitr_map_index;
 216
 217   /** Proxy ETR map index */
 218   u32 petr_map_index;
 219
 220   /* LISP PITR mode */
 221   u8 lisp_pitr;
 222
 223   /* mapping index for NSH */
 224   u32 nsh_map_index;
 225
 226   /* map request mode */
 227   u8 map_request_mode;
 228
 229   /* enable/disable map registering */
 230   u8 map_registering;
 231
 232   /* enable/disable rloc-probing */
 233   u8 rloc_probing;
 234
 235   /* timing wheel for mappping timeouts */
 236   timing_wheel_t wheel;
 237
 238   /** Per thread pool of records shared with thread0 */
 239   map_records_arg_t **map_records_args_pool;
 240
 241   /* commodity */
 242   ip4_main_t *im4;
 243   ip6_main_t *im6;
 244   vlib_main_t *vlib_main;
 245   vnet_main_t *vnet_main;
 246 } lisp_cp_main_t;
 247
 248 /* lisp-gpe control plane */
 249 extern lisp_cp_main_t lisp_control_main;
 250
 251 extern vlib_node_registration_t lisp_cp_input_node;
 252 extern vlib_node_registration_t lisp_cp_lookup_ip4_node;
 253 extern vlib_node_registration_t lisp_cp_lookup_ip6_node;
 254
 255 clib_error_t *lisp_cp_init ();
 256
 257 always_inline lisp_cp_main_t *
 258 vnet_lisp_cp_get_main ()
 259 {
 260   return &lisp_control_main;
 261 }
 262
 263 void
 264 get_src_and_dst_eids_from_buffer (lisp_cp_main_t * lcm, vlib_buffer_t * b,
 265                                   gid_address_t * src, gid_address_t * dst,
 266                                   u16 type);
 267
 268 typedef struct
 269 {
 270   u8 is_add;
 271   union
 272   {
 273     u8 *name;
 274     u32 index;
 275   };
 276   locator_t *locators;
 277   u8 local;
 278 } vnet_lisp_add_del_locator_set_args_t;
 279
 280 int
 281 vnet_lisp_add_del_locator_set (vnet_lisp_add_del_locator_set_args_t * a,
 282                                u32 * ls_index);
 283 int
 284 vnet_lisp_add_del_locator (vnet_lisp_add_del_locator_set_args_t * a,
 285                            locator_set_t * ls, u32 * ls_index);
 286
 287 typedef struct
 288 {
 289   u8 is_add;
 290   gid_address_t eid;
 291   u32 locator_set_index;
 292
 293   u32 ttl;
 294   u8 action;
 295   u8 authoritative;
 296
 297   u8 local;
 298   u8 is_static;
 299   u8 *key;
 300   u8 key_id;
 301 } vnet_lisp_add_del_mapping_args_t;
 302
 303 int
 304 vnet_lisp_map_cache_add_del (vnet_lisp_add_del_mapping_args_t * a,
 305                              u32 * map_index);
 306 int
 307 vnet_lisp_add_del_local_mapping (vnet_lisp_add_del_mapping_args_t * a,
 308                                  u32 * map_index_result);
 309
 310 int
 311 vnet_lisp_add_del_mapping (gid_address_t * deid, locator_t * dlocs, u8 action,
 312                            u8 authoritative, u32 ttl, u8 is_add, u8 is_static,
 313                            u32 * res_map_index);
 314
 315 typedef struct
 316 {
 317   gid_address_t reid;
 318   gid_address_t leid;
 319   u8 is_add;
 320 } vnet_lisp_add_del_adjacency_args_t;
 321
 322 int vnet_lisp_add_del_adjacency (vnet_lisp_add_del_adjacency_args_t * a);
 323
 324 typedef struct
 325 {
 326   u8 is_add;
 327   ip_address_t address;
 328 } vnet_lisp_add_del_map_resolver_args_t;
 329
 330 int
 331 vnet_lisp_add_del_map_resolver (vnet_lisp_add_del_map_resolver_args_t * a);
 332 int vnet_lisp_add_del_map_server (ip_address_t * addr, u8 is_add);
 333
 334 clib_error_t *vnet_lisp_enable_disable (u8 is_enabled);
 335 u8 vnet_lisp_enable_disable_status (void);
 336
 337 int vnet_lisp_pitr_set_locator_set (u8 * locator_set_name, u8 is_add);
 338 int vnet_lisp_use_petr (ip_address_t * ip, u8 is_add);
 339
 340 typedef struct
 341 {
 342   u8 is_add;
 343   u8 *locator_set_name;
 344 } vnet_lisp_add_del_mreq_itr_rloc_args_t;
 345
 346 int
 347 vnet_lisp_add_del_mreq_itr_rlocs (vnet_lisp_add_del_mreq_itr_rloc_args_t * a);
 348
 349 int vnet_lisp_clear_all_remote_adjacencies (void);
 350
 351 int vnet_lisp_eid_table_map (u32 vni, u32 vrf, u8 is_l2, u8 is_add);
 352 int vnet_lisp_add_del_map_table_key (gid_address_t * eid, char *key,
 353                                      u8 is_add);
 354 int vnet_lisp_set_map_request_mode (u8 mode);
 355 u8 vnet_lisp_get_map_request_mode (void);
 356 lisp_adjacency_t *vnet_lisp_adjacencies_get_by_vni (u32 vni);
 357 int vnet_lisp_rloc_probe_enable_disable (u8 is_enable);
 358 int vnet_lisp_map_register_enable_disable (u8 is_enable);
 359 u8 vnet_lisp_map_register_state_get (void);
 360 u8 vnet_lisp_rloc_probe_state_get (void);
 361 int vnet_lisp_add_del_l2_arp_entry (gid_address_t * key, u8 * mac, u8 is_add);
 362 u32 *vnet_lisp_l2_arp_bds_get (void);
 363 lisp_api_l2_arp_entry_t *vnet_lisp_l2_arp_entries_get_by_bd (u32 bd);
 364 int vnet_lisp_nsh_set_locator_set (u8 * locator_set_name, u8 is_add);
 365
 366 map_records_arg_t *parse_map_reply (vlib_buffer_t * b);
 367
 368 always_inline mapping_t *
 369 lisp_get_petr_mapping (lisp_cp_main_t * lcm)
 370 {
 371   return pool_elt_at_index (lcm->mapping_pool, lcm->petr_map_index);
 372 }
 373
 374 #endif /* VNET_CONTROL_H_ */
 375
 376 /*
 377  * fd.io coding-style-patch-verification: ON
 378  *
 379  * Local Variables:
 380  * eval: (c-set-style "gnu")
 381  * End:
 382  */