src/vnet/lisp-cp/lisp_types.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_LISP_GPE_LISP_TYPES_H_
  17 #define VNET_LISP_GPE_LISP_TYPES_H_
  18
  19 #include <vnet/ip/ip.h>
  20 #include <vnet/lisp-cp/lisp_cp_messages.h>
  21
  22 #define SHA1_AUTH_DATA_LEN                  20
  23 #define SHA256_AUTH_DATA_LEN                32
  24
  25 typedef enum
  26 {
  27   HMAC_NO_KEY = 0,
  28   HMAC_SHA_1_96,
  29   HMAC_SHA_256_128
  30 } lisp_key_type_t;
  31
  32 uword unformat_hmac_key_id (unformat_input_t * input, va_list * args);
  33 u8 *format_hmac_key_id (u8 * s, va_list * args);
  34
  35 typedef enum
  36 {
  37   IP4,
  38   IP6
  39 } ip_address_type_t;
  40
  41 /* *INDENT-OFF* */
  42 typedef CLIB_PACKED(struct ip_address
  43 {
  44   union
  45   {
  46     ip4_address_t v4;
  47     ip6_address_t v6;
  48   } ip;
  49   u8 version;
  50 }) ip_address_t;
  51 /* *INDENT-ON* */
  52
  53 #define ip_addr_addr(_a) (_a)->ip
  54 #define ip_addr_v4(_a) (_a)->ip.v4
  55 #define ip_addr_v6(_a) (_a)->ip.v6
  56 #define ip_addr_version(_a) (_a)->version
  57
  58 int ip_address_cmp (const ip_address_t * ip1, const ip_address_t * ip2);
  59 void ip_address_copy (ip_address_t * dst, const ip_address_t * src);
  60 void ip_address_copy_addr (void *dst, const ip_address_t * src);
  61 void ip_address_set (ip_address_t * dst, const void *src, u8 version);
  62
  63 /* *INDENT-OFF* */
  64 typedef CLIB_PACKED(struct ip_prefix
  65 {
  66   ip_address_t addr;
  67   u8 len;
  68 }) ip_prefix_t;
  69 /* *INDENT-ON* */
  70
  71 #define ip_prefix_addr(_a) (_a)->addr
  72 #define ip_prefix_version(_a) ip_addr_version(&ip_prefix_addr(_a))
  73 #define ip_prefix_len(_a) (_a)->len
  74 #define ip_prefix_v4(_a) ip_addr_v4(&ip_prefix_addr(_a))
  75 #define ip_prefix_v6(_a) ip_addr_v6(&ip_prefix_addr(_a))
  76
  77 void ip_prefix_normalize (ip_prefix_t * a);
  78
  79 extern void ip_address_to_fib_prefix (const ip_address_t * addr,
  80                                       fib_prefix_t * prefix);
  81 extern void ip_prefix_to_fib_prefix (const ip_prefix_t * ipp,
  82                                      fib_prefix_t * fibp);
  83
  84 typedef enum
  85 {
  86   /* NOTE: ip addresses are left out on purpose. Use max masked ip-prefixes
  87    * instead */
  88   GID_ADDR_IP_PREFIX,
  89   GID_ADDR_LCAF,
  90   GID_ADDR_MAC,
  91   GID_ADDR_SRC_DST,
  92   GID_ADDR_NO_ADDRESS,
  93   GID_ADDR_TYPES
  94 } gid_address_type_t;
  95
  96 typedef enum
  97 {
  98   /* make sure that values corresponds with RFC */
  99   LCAF_NULL_BODY = 0,
 100   LCAF_AFI_LIST_TYPE,
 101   LCAF_INSTANCE_ID,
 102   LCAF_SOURCE_DEST = 12,
 103   LCAF_TYPES
 104 } lcaf_type_t;
 105
 106 typedef enum fid_addr_type_t_
 107 {
 108   FID_ADDR_IP_PREF,
 109   FID_ADDR_MAC
 110 } __attribute__ ((packed)) fid_addr_type_t;
 111
 112 /* flat address type */
 113 typedef struct
 114 {
 115   union
 116   {
 117     ip_prefix_t ippref;
 118     u8 mac[6];
 119   };
 120   fid_addr_type_t type;
 121 } fid_address_t;
 122
 123 typedef fid_address_t dp_address_t;
 124
 125 #define fid_addr_ippref(_a) (_a)->ippref
 126 #define fid_addr_mac(_a) (_a)->mac
 127 #define fid_addr_type(_a) (_a)->type
 128 u8 *format_fid_address (u8 * s, va_list * args);
 129
 130 typedef struct
 131 {
 132   fid_address_t src;
 133   fid_address_t dst;
 134 } source_dest_t;
 135
 136 #define sd_dst(_a) (_a)->dst
 137 #define sd_src(_a) (_a)->src
 138 #define sd_src_ippref(_a) fid_addr_ippref(&sd_src(_a))
 139 #define sd_dst_ippref(_a) fid_addr_ippref(&sd_dst(_a))
 140 #define sd_src_mac(_a) fid_addr_mac(&sd_src(_a))
 141 #define sd_dst_mac(_a) fid_addr_mac(&sd_dst(_a))
 142 #define sd_src_type(_a) fid_addr_type(&sd_src(_a))
 143 #define sd_dst_type(_a) fid_addr_type(&sd_dst(_a))
 144
 145 typedef struct
 146 {
 147   u8 vni_mask_len;
 148   u32 vni;
 149   struct _gid_address_t *gid_addr;
 150 } vni_t;
 151
 152 #define vni_vni(_a) (_a)->vni
 153 #define vni_mask_len(_a) (_a)->vni_mask_len
 154 #define vni_gid(_a) (_a)->gid_addr
 155
 156 typedef struct
 157 {
 158   /* the union needs to be at the beginning! */
 159   union
 160   {
 161     source_dest_t sd;
 162     vni_t uni;
 163   };
 164   u8 type;
 165 } lcaf_t;
 166
 167 #define lcaf_type(_a) (_a)->type
 168 #define lcaf_vni(_a) vni_vni(& (_a)->uni)
 169 #define lcaf_vni_len(_a) vni_mask_len(& (_a)->uni)
 170
 171 /* might want to expand this in the future :) */
 172 typedef struct _gid_address_t
 173 {
 174   union
 175   {
 176     ip_prefix_t ippref;
 177     lcaf_t lcaf;
 178     u8 mac[6];
 179     source_dest_t sd;
 180   };
 181   u8 type;
 182   u32 vni;
 183   u8 vni_mask;
 184 } gid_address_t;
 185
 186 u8 *format_ip_address (u8 * s, va_list * args);
 187 uword unformat_ip_address (unformat_input_t * input, va_list * args);
 188 u8 *format_ip_prefix (u8 * s, va_list * args);
 189 uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
 190 u8 *format_mac_address (u8 * s, va_list * args);
 191 uword unformat_mac_address (unformat_input_t * input, va_list * args);
 192
 193 u16 ip4_address_size_to_put ();
 194 u16 ip6_address_size_to_put ();
 195 u32 ip4_address_put (u8 * b, ip4_address_t * a);
 196 u32 ip6_address_put (u8 * b, ip6_address_t * a);
 197
 198 u16 ip_address_size_to_write (ip_address_t * a);
 199 u16 ip_address_iana_afi (ip_address_t * a);
 200 u8 ip_address_max_len (u8 ver);
 201 u32 ip_address_put (u8 * b, ip_address_t * a);
 202 void ip_address_to_46 (const ip_address_t * addr,
 203                        ip46_address_t * a, fib_protocol_t * proto);
 204
 205 /* LISP AFI codes  */
 206 typedef enum
 207 {
 208   LISP_AFI_NO_ADDR,
 209   LISP_AFI_IP,
 210   LISP_AFI_IP6,
 211   LISP_AFI_LCAF = 16387,
 212   LISP_AFI_MAC = 16389
 213 } lisp_afi_e;
 214
 215 u8 *format_gid_address (u8 * s, va_list * args);
 216 uword unformat_gid_address (unformat_input_t * input, va_list * args);
 217 int gid_address_cmp (gid_address_t * a1, gid_address_t * a2);
 218 void gid_address_free (gid_address_t * a);
 219
 220 u16 gid_address_size_to_put (gid_address_t * a);
 221 u16 gid_address_put (u8 * b, gid_address_t * gid);
 222 u8 gid_address_len (gid_address_t * a);
 223 void *gid_address_cast (gid_address_t * gid, gid_address_type_t type);
 224 void gid_address_copy (gid_address_t * dst, gid_address_t * src);
 225 u32 gid_address_parse (u8 * offset, gid_address_t * a);
 226 void gid_address_ip_set (gid_address_t * dst, void *src, u8 version);
 227
 228 #define gid_address_type(_a) (_a)->type
 229 #define gid_address_ippref(_a) (_a)->ippref
 230 #define gid_address_ippref_len(_a) (_a)->ippref.len
 231 #define gid_address_ip(_a) ip_prefix_addr(&gid_address_ippref(_a))
 232 #define gid_address_ip_version(_a) ip_addr_version(&gid_address_ip(_a))
 233 #define gid_address_lcaf(_a) (_a)->lcaf
 234 #define gid_address_mac(_a) (_a)->mac
 235 #define gid_address_vni(_a) (_a)->vni
 236 #define gid_address_vni_mask(_a) (_a)->vni_mask
 237 #define gid_address_sd_dst_ippref(_a) sd_dst_ippref(&(_a)->sd)
 238 #define gid_address_sd_src_ippref(_a) sd_src_ippref(&(_a)->sd)
 239 #define gid_address_sd_dst_mac(_a) sd_dst_mac(&(_a)->sd)
 240 #define gid_address_sd_src_mac(_a) sd_src_mac(&(_a)->sd)
 241 #define gid_address_sd(_a) (_a)->sd
 242 #define gid_address_sd_src(_a) sd_src(&gid_address_sd(_a))
 243 #define gid_address_sd_dst(_a) sd_dst(&gid_address_sd(_a))
 244 #define gid_address_sd_src_type(_a) sd_src_type(&gid_address_sd(_a))
 245 #define gid_address_sd_dst_type(_a) sd_dst_type(&gid_address_sd(_a))
 246
 247 /* 'sub'address functions */
 248 #define foreach_gid_address_type_fcns  \
 249   _(ip_prefix)                    \
 250   _(lcaf)                         \
 251   _(mac)                          \
 252   _(sd)
 253
 254 /* *INDENT-OFF* */
 255 #define _(_n)                                 \
 256 u16    _n ## _size_to_write (void * pref);    \
 257 u16    _n ## _write (u8 * p, void * pref);    \
 258 u8     _n ## _length (void *a);               \
 259 void * _n ## _cast (gid_address_t * a);       \
 260 void   _n ## _copy (void * dst , void * src);
 261
 262 foreach_gid_address_type_fcns
 263 #undef _
 264 /* *INDENT-ON* */
 265
 266 always_inline u64
 267 mac_to_u64 (u8 * m)
 268 {
 269   return (*((u64 *) m) & 0xffffffffffff);
 270 }
 271
 272 typedef struct
 273 {
 274   /* mark locator as local as opposed to remote */
 275   u8 local;
 276   u8 state;
 277   union
 278   {
 279     u32 sw_if_index;
 280     gid_address_t address;
 281   };
 282   u8 priority;
 283   u8 weight;
 284   u8 mpriority;
 285   u8 mweight;
 286   u8 probed;
 287 } locator_t;
 288
 289 u32 locator_parse (void *ptr, locator_t * loc);
 290 void locator_copy (locator_t * dst, locator_t * src);
 291 u32 locator_cmp (locator_t * l1, locator_t * l2);
 292 void locator_free (locator_t * l);
 293
 294 typedef struct
 295 {
 296   /* locator-set name */
 297   u8 *name;
 298
 299   /* vector of locator indices */
 300   u32 *locator_indices;
 301   u8 local;
 302 } locator_set_t;
 303
 304 typedef struct
 305 {
 306   gid_address_t eid;
 307
 308   /* index of local locator set */
 309   union
 310   {
 311     u32 locator_set_index;
 312     locator_t *locators;        /* used for map register message */
 313   };
 314
 315   u32 ttl;
 316   u8 action;
 317   u8 authoritative;
 318
 319   u8 local;
 320   /* valid only for remote mappings */
 321   u8 is_static;
 322   u8 *key;
 323   lisp_key_type_t key_id;
 324   u8 timer_set;
 325 } mapping_t;
 326
 327 uword
 328 unformat_negative_mapping_action (unformat_input_t * input, va_list * args);
 329 u8 *format_negative_mapping_action (u8 *, va_list * args);
 330
 331 typedef struct locator_pair
 332 {
 333   /* local and remote locators (underlay attachment points) */
 334   ip_address_t lcl_loc;
 335   ip_address_t rmt_loc;
 336
 337   u8 priority;
 338   u8 weight;
 339 } locator_pair_t;
 340
 341 void
 342 build_src_dst (gid_address_t * sd, gid_address_t * src, gid_address_t * dst);
 343
 344 void gid_address_from_ip (gid_address_t * g, ip_address_t * ip);
 345
 346 #endif /* VNET_LISP_GPE_LISP_TYPES_H_ */
 347
 348 /*
 349  * fd.io coding-style-patch-verification: ON
 350  *
 351  * Local Variables:
 352  * eval: (c-set-style "gnu")
 353  * End:
 354  */