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