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