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