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_NSH,
  93   GID_ADDR_ARP,
  94   GID_ADDR_NO_ADDRESS,
  95   GID_ADDR_TYPES
  96 } gid_address_type_t;
  97
  98 typedef enum
  99 {
 100   /* make sure that values corresponds with RFC */
 101   LCAF_NULL_BODY = 0,
 102   LCAF_AFI_LIST_TYPE,
 103   LCAF_INSTANCE_ID,
 104   LCAF_SOURCE_DEST = 12,
 105   LCAF_TYPES
 106 } lcaf_type_t;
 107
 108 typedef enum fid_addr_type_t_
 109 {
 110   FID_ADDR_IP_PREF,
 111   FID_ADDR_MAC,
 112   FID_ADDR_NSH
 113 } __attribute__ ((packed)) fid_addr_type_t;
 114
 115 /* flat address type */
 116 typedef struct
 117 {
 118   union
 119   {
 120     ip_prefix_t ippref;
 121     u8 mac[6];
 122     u32 nsh;
 123   };
 124   fid_addr_type_t type;
 125 } fid_address_t;
 126
 127 typedef fid_address_t dp_address_t;
 128
 129 #define fid_addr_ippref(_a) (_a)->ippref
 130 #define fid_addr_prefix_length(_a) ip_prefix_len(&fid_addr_ippref(_a))
 131 #define fid_addr_ip_version(_a) ip_prefix_version(&fid_addr_ippref(_a))
 132 #define fid_addr_mac(_a) (_a)->mac
 133 #define fid_addr_nsh(_a) (_a)->nsh
 134 #define fid_addr_type(_a) (_a)->type
 135 u8 *format_fid_address (u8 * s, va_list * args);
 136
 137 typedef struct
 138 {
 139   fid_address_t src;
 140   fid_address_t dst;
 141 } source_dest_t;
 142
 143 #define sd_dst(_a) (_a)->dst
 144 #define sd_src(_a) (_a)->src
 145 #define sd_src_ippref(_a) fid_addr_ippref(&sd_src(_a))
 146 #define sd_dst_ippref(_a) fid_addr_ippref(&sd_dst(_a))
 147 #define sd_src_mac(_a) fid_addr_mac(&sd_src(_a))
 148 #define sd_dst_mac(_a) fid_addr_mac(&sd_dst(_a))
 149 #define sd_src_type(_a) fid_addr_type(&sd_src(_a))
 150 #define sd_dst_type(_a) fid_addr_type(&sd_dst(_a))
 151
 152 typedef struct
 153 {
 154   u8 vni_mask_len;
 155   u32 vni;
 156   struct _gid_address_t *gid_addr;
 157 } vni_t;
 158
 159 #define vni_vni(_a) (_a)->vni
 160 #define vni_mask_len(_a) (_a)->vni_mask_len
 161 #define vni_gid(_a) (_a)->gid_addr
 162
 163 typedef struct
 164 {
 165   u32 spi;
 166   u8 si;
 167 } nsh_t;
 168
 169 typedef struct
 170 {
 171   ip4_address_t addr;
 172   u32 bd;
 173 } lcaf_arp_t;
 174
 175 #define lcaf_arp_ip4(_a) (_a)->addr
 176 #define lcaf_arp_bd(_a) (_a)->bd
 177
 178 typedef struct
 179 {
 180   /* the union needs to be at the beginning! */
 181   union
 182   {
 183     source_dest_t sd;
 184     lcaf_arp_t arp;
 185     vni_t uni;
 186   };
 187   u8 type;
 188 } lcaf_t;
 189
 190 #define lcaf_type(_a) (_a)->type
 191 #define lcaf_vni(_a) vni_vni(& (_a)->uni)
 192 #define lcaf_vni_len(_a) vni_mask_len(& (_a)->uni)
 193
 194 /* might want to expand this in the future :) */
 195 typedef struct _gid_address_t
 196 {
 197   union
 198   {
 199     ip_prefix_t ippref;
 200     lcaf_t lcaf;
 201     u8 mac[6];
 202     source_dest_t sd;
 203     lcaf_arp_t arp;
 204     nsh_t nsh;
 205   };
 206   u8 type;
 207   u32 vni;
 208   u8 vni_mask;
 209 } gid_address_t;
 210
 211 u8 *format_ip_address (u8 * s, va_list * args);
 212 uword unformat_ip_address (unformat_input_t * input, va_list * args);
 213 u8 *format_ip_prefix (u8 * s, va_list * args);
 214 uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
 215 u8 *format_mac_address (u8 * s, va_list * args);
 216 uword unformat_mac_address (unformat_input_t * input, va_list * args);
 217
 218 u16 ip4_address_size_to_put ();
 219 u16 ip6_address_size_to_put ();
 220 u32 ip4_address_put (u8 * b, ip4_address_t * a);
 221 u32 ip6_address_put (u8 * b, ip6_address_t * a);
 222
 223 u16 ip_address_size_to_write (ip_address_t * a);
 224 u16 ip_address_iana_afi (ip_address_t * a);
 225 u8 ip_address_max_len (u8 ver);
 226 u32 ip_address_put (u8 * b, ip_address_t * a);
 227 void ip_address_to_46 (const ip_address_t * addr,
 228                        ip46_address_t * a, fib_protocol_t * proto);
 229
 230 /* LISP AFI codes  */
 231 typedef enum
 232 {
 233   LISP_AFI_NO_ADDR,
 234   LISP_AFI_IP,
 235   LISP_AFI_IP6,
 236   LISP_AFI_LCAF = 16387,
 237   LISP_AFI_MAC = 16389
 238 } lisp_afi_e;
 239
 240 u8 *format_gid_address (u8 * s, va_list * args);
 241 uword unformat_gid_address (unformat_input_t * input, va_list * args);
 242 int gid_address_cmp (gid_address_t * a1, gid_address_t * a2);
 243 void gid_address_free (gid_address_t * a);
 244
 245 u16 gid_address_size_to_put (gid_address_t * a);
 246 u16 gid_address_put (u8 * b, gid_address_t * gid);
 247 u8 gid_address_len (gid_address_t * a);
 248 void *gid_address_cast (gid_address_t * gid, gid_address_type_t type);
 249 void gid_address_copy (gid_address_t * dst, gid_address_t * src);
 250 u32 gid_address_parse (u8 * offset, gid_address_t * a);
 251 void gid_address_ip_set (gid_address_t * dst, void *src, u8 version);
 252
 253 #define gid_address_type(_a) (_a)->type
 254 #define gid_address_ippref(_a) (_a)->ippref
 255 #define gid_address_ippref_len(_a) (_a)->ippref.len
 256 #define gid_address_ip(_a) ip_prefix_addr(&gid_address_ippref(_a))
 257 #define gid_address_ip_version(_a) ip_addr_version(&gid_address_ip(_a))
 258 #define gid_address_lcaf(_a) (_a)->lcaf
 259 #define gid_address_mac(_a) (_a)->mac
 260 #define gid_address_nsh(_a) (_a)->nsh
 261 #define gid_address_vni(_a) (_a)->vni
 262 #define gid_address_vni_mask(_a) (_a)->vni_mask
 263 #define gid_address_sd_dst_ippref(_a) sd_dst_ippref(&(_a)->sd)
 264 #define gid_address_sd_src_ippref(_a) sd_src_ippref(&(_a)->sd)
 265 #define gid_address_sd_dst_mac(_a) sd_dst_mac(&(_a)->sd)
 266 #define gid_address_sd_src_mac(_a) sd_src_mac(&(_a)->sd)
 267 #define gid_address_sd(_a) (_a)->sd
 268 #define gid_address_sd_src(_a) sd_src(&gid_address_sd(_a))
 269 #define gid_address_sd_dst(_a) sd_dst(&gid_address_sd(_a))
 270 #define gid_address_sd_src_type(_a) sd_src_type(&gid_address_sd(_a))
 271 #define gid_address_sd_dst_type(_a) sd_dst_type(&gid_address_sd(_a))
 272 #define gid_address_arp(_a) (_a)->arp
 273 #define gid_address_arp_ip4(_a) lcaf_arp_ip4(&gid_address_arp (_a))
 274 #define gid_address_arp_bd(_a) lcaf_arp_bd(&gid_address_arp (_a))
 275
 276 /* 'sub'address functions */
 277 #define foreach_gid_address_type_fcns  \
 278   _(ip_prefix)                    \
 279   _(lcaf)                         \
 280   _(mac)                          \
 281   _(nsh)                          \
 282   _(sd)
 283
 284 /* *INDENT-OFF* */
 285 #define _(_n)                                 \
 286 u16    _n ## _size_to_write (void * pref);    \
 287 u16    _n ## _write (u8 * p, void * pref);    \
 288 u8     _n ## _length (void *a);               \
 289 void * _n ## _cast (gid_address_t * a);       \
 290 void   _n ## _copy (void * dst , void * src);
 291
 292 foreach_gid_address_type_fcns
 293 #undef _
 294 /* *INDENT-ON* */
 295
 296 always_inline u64
 297 mac_to_u64 (u8 * m)
 298 {
 299   return (*((u64 *) m) & 0xffffffffffff);
 300 }
 301
 302 typedef struct
 303 {
 304   /* mark locator as local as opposed to remote */
 305   u8 local;
 306   u8 state;
 307   union
 308   {
 309     u32 sw_if_index;
 310     gid_address_t address;
 311   };
 312   u8 priority;
 313   u8 weight;
 314   u8 mpriority;
 315   u8 mweight;
 316   u8 probed;
 317 } locator_t;
 318
 319 u32 locator_parse (void *ptr, locator_t * loc);
 320 void locator_copy (locator_t * dst, locator_t * src);
 321 u32 locator_cmp (locator_t * l1, locator_t * l2);
 322 void locator_free (locator_t * l);
 323
 324 typedef struct
 325 {
 326   /* locator-set name */
 327   u8 *name;
 328
 329   /* vector of locator indices */
 330   u32 *locator_indices;
 331   u8 local;
 332 } locator_set_t;
 333
 334 typedef struct
 335 {
 336   gid_address_t eid;
 337
 338   /* index of local locator set */
 339   union
 340   {
 341     u32 locator_set_index;
 342     locator_t *locators;        /* used for map register message */
 343   };
 344
 345   u32 ttl;
 346   u8 action;
 347
 348   u8 authoritative:1;
 349   u8 local:1;
 350   /* valid only for remote mappings */
 351   u8 is_static:1;
 352   u8 pitr_set:1;
 353   u8 rsvd:4;
 354
 355
 356   u8 *key;
 357   lisp_key_type_t key_id;
 358   u8 timer_set;
 359 } mapping_t;
 360
 361 uword
 362 unformat_negative_mapping_action (unformat_input_t * input, va_list * args);
 363 u8 *format_negative_mapping_action (u8 *, va_list * args);
 364
 365 typedef struct locator_pair
 366 {
 367   /* local and remote locators (underlay attachment points) */
 368   ip_address_t lcl_loc;
 369   ip_address_t rmt_loc;
 370
 371   u8 priority;
 372   u8 weight;
 373 } locator_pair_t;
 374
 375 void
 376 build_src_dst (gid_address_t * sd, gid_address_t * src, gid_address_t * dst);
 377
 378 void gid_address_from_ip (gid_address_t * g, ip_address_t * ip);
 379 void gid_to_dp_address (gid_address_t * g, dp_address_t * d);
 380
 381 #endif /* VNET_LISP_GPE_LISP_TYPES_H_ */
 382
 383 /*
 384  * fd.io coding-style-patch-verification: ON
 385  *
 386  * Local Variables:
 387  * eval: (c-set-style "gnu")
 388  * End:
 389  */