FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
lisp_types.h
Go to the documentation of this file.
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>
21 
22 #define SHA1_AUTH_DATA_LEN 20
23 #define SHA256_AUTH_DATA_LEN 32
24 
25 typedef enum
26 {
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,
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 */
98 
99 typedef enum
100 {
101  /* make sure that values corresponds with RFC */
106  LCAF_NSH = 17,
108 } lcaf_type_t;
109 
110 typedef enum fid_addr_type_t_
111 {
115 } __attribute__ ((packed)) fid_addr_type_t;
116 
117 /* flat address type */
118 typedef struct
119 {
120  union
121  {
122  ip_prefix_t ippref;
123  u8 mac[6];
125  };
126  fid_addr_type_t type;
127 } fid_address_t;
128 
130 
131 #define fid_addr_ippref(_a) (_a)->ippref
132 #define fid_addr_prefix_length(_a) ip_prefix_len(&fid_addr_ippref(_a))
133 #define fid_addr_ip_version(_a) ip_prefix_version(&fid_addr_ippref(_a))
134 #define fid_addr_mac(_a) (_a)->mac
135 #define fid_addr_nsh(_a) (_a)->nsh
136 #define fid_addr_type(_a) (_a)->type
137 u8 *format_fid_address (u8 * s, va_list * args);
138 
139 typedef struct
140 {
143 } source_dest_t;
144 
145 #define sd_dst(_a) (_a)->dst
146 #define sd_src(_a) (_a)->src
147 #define sd_src_ippref(_a) fid_addr_ippref(&sd_src(_a))
148 #define sd_dst_ippref(_a) fid_addr_ippref(&sd_dst(_a))
149 #define sd_src_mac(_a) fid_addr_mac(&sd_src(_a))
150 #define sd_dst_mac(_a) fid_addr_mac(&sd_dst(_a))
151 #define sd_src_type(_a) fid_addr_type(&sd_src(_a))
152 #define sd_dst_type(_a) fid_addr_type(&sd_dst(_a))
153 
154 typedef struct
155 {
158  struct _gid_address_t *gid_addr;
159 } vni_t;
160 
161 #define vni_vni(_a) (_a)->vni
162 #define vni_mask_len(_a) (_a)->vni_mask_len
163 #define vni_gid(_a) (_a)->gid_addr
164 
165 typedef struct
166 {
169 } nsh_t;
170 
171 #define nsh_spi(_a) (_a)->spi
172 #define nsh_si(_a) (_a)->si
173 
174 typedef struct
175 {
176  ip_address_t addr;
179 
180 #define lcaf_arp_ndp_ip(_a) (_a)->addr
181 #define lcaf_arp_ndp_ip_ver(_a) ip_addr_version(&lcaf_arp_ndp_ip(_a))
182 #define lcaf_arp_ndp_ip4(_a) ip_addr_v4(&lcaf_arp_ndp_ip(_a))
183 #define lcaf_arp_ndp_ip6(_a) ip_addr_v6(&lcaf_arp_ndp_ip(_a))
184 #define lcaf_arp_ndp_bd(_a) (_a)->bd
185 
186 typedef struct
187 {
188  /* the union needs to be at the beginning! */
189  union
190  {
194  };
196 } lcaf_t;
197 
198 #define lcaf_type(_a) (_a)->type
199 #define lcaf_vni(_a) vni_vni(& (_a)->uni)
200 #define lcaf_vni_len(_a) vni_mask_len(& (_a)->uni)
201 
202 /* might want to expand this in the future :) */
203 typedef struct _gid_address_t
204 {
205  union
206  {
207  ip_prefix_t ippref;
208  lcaf_t lcaf;
209  u8 mac[6];
210  source_dest_t sd;
211  lcaf_arp_ndp_t arp_ndp;
212  nsh_t nsh;
213  };
214  u8 type;
215  u32 vni;
216  u8 vni_mask;
217 } gid_address_t;
218 
219 u8 *format_ip_address (u8 * s, va_list * args);
220 uword unformat_ip_address (unformat_input_t * input, va_list * args);
221 u8 *format_ip_prefix (u8 * s, va_list * args);
222 uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
223 u8 *format_mac_address (u8 * s, va_list * args);
224 uword unformat_mac_address (unformat_input_t * input, va_list * args);
225 
230 
231 u16 ip_address_size_to_write (ip_address_t * a);
232 u16 ip_address_iana_afi (ip_address_t * a);
233 u8 ip_address_max_len (u8 ver);
234 u32 ip_address_put (u8 * b, ip_address_t * a);
235 void ip_address_to_46 (const ip_address_t * addr,
236  ip46_address_t * a, fib_protocol_t * proto);
237 
238 /* LISP AFI codes */
239 typedef enum
240 {
244  LISP_AFI_LCAF = 16387,
245  LISP_AFI_MAC = 16389
246 } lisp_afi_e;
247 
248 u8 *format_gid_address (u8 * s, va_list * args);
249 uword unformat_gid_address (unformat_input_t * input, va_list * args);
252 
254 u16 gid_address_put (u8 * b, gid_address_t * gid);
256 void *gid_address_cast (gid_address_t * gid, gid_address_type_t type);
257 void gid_address_copy (gid_address_t * dst, gid_address_t * src);
259 void gid_address_ip_set (gid_address_t * dst, void *src, u8 version);
260 
261 #define gid_address_type(_a) (_a)->type
262 #define gid_address_ippref(_a) (_a)->ippref
263 #define gid_address_ippref_len(_a) (_a)->ippref.len
264 #define gid_address_ip(_a) ip_prefix_addr(&gid_address_ippref(_a))
265 #define gid_address_ip_version(_a) ip_addr_version(&gid_address_ip(_a))
266 #define gid_address_lcaf(_a) (_a)->lcaf
267 #define gid_address_mac(_a) (_a)->mac
268 #define gid_address_nsh(_a) (_a)->nsh
269 #define gid_address_nsh_spi(_a) nsh_spi(&gid_address_nsh(_a))
270 #define gid_address_nsh_si(_a) nsh_si(&gid_address_nsh(_a))
271 #define gid_address_vni(_a) (_a)->vni
272 #define gid_address_vni_mask(_a) (_a)->vni_mask
273 #define gid_address_sd_dst_ippref(_a) sd_dst_ippref(&(_a)->sd)
274 #define gid_address_sd_src_ippref(_a) sd_src_ippref(&(_a)->sd)
275 #define gid_address_sd_dst_mac(_a) sd_dst_mac(&(_a)->sd)
276 #define gid_address_sd_src_mac(_a) sd_src_mac(&(_a)->sd)
277 #define gid_address_sd(_a) (_a)->sd
278 #define gid_address_sd_src(_a) sd_src(&gid_address_sd(_a))
279 #define gid_address_sd_dst(_a) sd_dst(&gid_address_sd(_a))
280 #define gid_address_sd_src_type(_a) sd_src_type(&gid_address_sd(_a))
281 #define gid_address_sd_dst_type(_a) sd_dst_type(&gid_address_sd(_a))
282 #define gid_address_arp_ndp(_a) (_a)->arp_ndp
283 #define gid_address_arp_ndp_bd(_a) lcaf_arp_ndp_bd(&gid_address_arp_ndp(_a))
284 #define gid_address_arp_ndp_ip(_a) lcaf_arp_ndp_ip(&gid_address_arp_ndp(_a))
285 #define gid_address_arp_ip4(_a) lcaf_arp_ndp_ip4(&gid_address_arp_ndp(_a))
286 #define gid_address_ndp_ip6(_a) lcaf_arp_ndp_ip6(&gid_address_arp_ndp(_a))
287 #define gid_address_ndp_bd gid_address_arp_ndp_bd
288 #define gid_address_arp_bd gid_address_arp_ndp_bd
289 
290 /* 'sub'address functions */
291 #define foreach_gid_address_type_fcns \
292  _(no_addr) \
293  _(ip_prefix) \
294  _(lcaf) \
295  _(mac) \
296  _(nsh) \
297  _(sd)
298 
299 /* *INDENT-OFF* */
300 #define _(_n) \
301 u16 _n ## _size_to_write (void * pref); \
302 u16 _n ## _write (u8 * p, void * pref); \
303 u8 _n ## _length (void *a); \
304 void * _n ## _cast (gid_address_t * a); \
305 void _n ## _copy (void * dst , void * src);
306 
308 #undef _
309 /* *INDENT-ON* */
310 
313 {
314  return (*((u64 *) m) & 0xffffffffffff);
315 }
316 
317 typedef struct
318 {
319  /* mark locator as local as opposed to remote */
322  union
323  {
326  };
332 } locator_t;
333 
334 u32 locator_parse (void *ptr, locator_t * loc);
335 void locator_copy (locator_t * dst, locator_t * src);
336 u32 locator_cmp (locator_t * l1, locator_t * l2);
337 void locator_free (locator_t * l);
338 
339 typedef struct
340 {
341  /* locator-set name */
343 
344  /* vector of locator indices */
347 } locator_set_t;
348 
349 typedef struct
350 {
352 
353  /* index of local locator set */
354  union
355  {
357  locator_t *locators; /* used for map register message */
358  };
359 
362 
363  u8 authoritative:1;
364  u8 local:1;
365  /* valid only for remote mappings */
366  u8 is_static:1;
367  u8 pitr_set:1;
368  u8 nsh_set:1;
369  u8 almost_expired:1;
370  u8 delete_after_expiration:1;
371  u8 rsvd:1;
372 
373  u8 *key;
374  lisp_key_type_t key_id;
377 } mapping_t;
378 
379 uword
380 unformat_negative_mapping_action (unformat_input_t * input, va_list * args);
381 u8 *format_negative_mapping_action (u8 *, va_list * args);
382 
383 typedef struct locator_pair
384 {
385  /* local and remote locators (underlay attachment points) */
386  ip_address_t lcl_loc;
387  ip_address_t rmt_loc;
388 
392 
393 void
395 
396 void gid_address_from_ip (gid_address_t * g, ip_address_t * ip);
397 void gid_to_dp_address (gid_address_t * g, dp_address_t * d);
398 
399 #endif /* VNET_LISP_GPE_LISP_TYPES_H_ */
400 
401 /*
402  * fd.io coding-style-patch-verification: ON
403  *
404  * Local Variables:
405  * eval: (c-set-style "gnu")
406  * End:
407  */
u8 vni_mask_len
Definition: lisp_types.h:156
u16 ip_address_iana_afi(ip_address_t *a)
Definition: lisp_types.c:543
void locator_free(locator_t *l)
Definition: lisp_types.c:1736
counter_t packets
Definition: lisp_types.h:376
u8 timer_set
Definition: lisp_types.h:375
fid_address_t dst
Definition: lisp_types.h:142
void gid_address_copy(gid_address_t *dst, gid_address_t *src)
Definition: lisp_types.c:1495
typedef CLIB_PACKED(struct ip_address{union{ip4_address_t v4;ip6_address_t v6;}ip;u8 version;}) ip_address_t
void ip_address_copy(ip_address_t *dst, const ip_address_t *src)
Definition: lisp_types.c:886
void build_src_dst(gid_address_t *sd, gid_address_t *src, gid_address_t *dst)
Definition: lisp_types.c:1743
uword unformat_mac_address(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:207
gid_address_type_t
Definition: lisp_types.h:84
lcaf_type_t
Definition: lisp_types.h:99
uword unformat_hmac_key_id(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:325
vni_t uni
Definition: lisp_types.h:193
u16 gid_address_put(u8 *b, gid_address_t *gid)
Definition: lisp_types.c:1464
struct locator_pair locator_pair_t
void gid_to_dp_address(gid_address_t *g, dp_address_t *d)
Definition: lisp_types.c:606
u8 mpriority
Definition: lisp_types.h:329
u32 vni
Definition: lisp_types.h:157
u16 ip6_address_size_to_put()
Definition: lisp_types.c:562
uword unformat_ip_address(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:164
enum fid_addr_type_t_ fid_addr_type_t
u16 ip_address_size_to_write(ip_address_t *a)
Definition: lisp_types.c:537
u8 * format_negative_mapping_action(u8 *, va_list *args)
Definition: lisp_types.c:438
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
ip_prefix_t ippref
Definition: lisp_types.h:122
u32 locator_parse(void *ptr, locator_t *loc)
Definition: lisp_types.c:1684
u32 spi
Definition: lisp_types.h:167
#define always_inline
Definition: clib.h:92
u32 gid_address_parse(u8 *offset, gid_address_t *a)
Definition: lisp_types.c:1515
uword unformat_negative_mapping_action(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:391
u8 * key
Definition: lisp_types.h:373
Aggregrate type for a prefix.
Definition: fib_types.h:172
static foreach_gid_address_type_fcns u64 mac_to_u64(u8 *m)
Definition: lisp_types.h:312
unsigned long u64
Definition: types.h:89
u8 type
Definition: lisp_types.h:195
struct _gid_address_t * gid_addr
Definition: lisp_types.h:158
u8 gid_address_len(gid_address_t *a)
Definition: lisp_types.c:1450
struct _unformat_input_t unformat_input_t
ip_address_t lcl_loc
Definition: lisp_types.h:386
lisp_afi_e
Definition: lisp_types.h:239
void ip_address_to_fib_prefix(const ip_address_t *addr, fib_prefix_t *prefix)
convert from a LISP address to a FIB prefix
Definition: control.c:146
uword unformat_gid_address(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:350
u32 ip4_address_put(u8 *b, ip4_address_t *a)
Definition: lisp_types.c:569
u8 * format_ip_prefix(u8 *s, va_list *args)
Definition: lisp_types.c:179
void ip_address_copy_addr(void *dst, const ip_address_t *src)
Definition: lisp_types.c:902
u32 sw_if_index
Definition: lisp_types.h:324
u32 ip_address_put(u8 *b, ip_address_t *a)
Definition: lisp_types.c:587
int ip_address_cmp(const ip_address_t *ip1, const ip_address_t *ip2)
Definition: lisp_types.c:869
fid_addr_type_t_
Definition: lisp_types.h:110
u32 locator_set_index
Definition: lisp_types.h:356
void gid_address_free(gid_address_t *a)
Definition: lisp_types.c:850
u16 gid_address_size_to_put(gid_address_t *a)
Definition: lisp_types.c:1480
u8 * format_gid_address(u8 *s, va_list *args)
Definition: lisp_types.c:265
int gid_address_cmp(gid_address_t *a1, gid_address_t *a2)
Definition: lisp_types.c:1632
void ip_address_set(ip_address_t *dst, const void *src, u8 version)
Definition: lisp_types.c:908
void gid_address_ip_set(gid_address_t *dst, void *src, u8 version)
Definition: lisp_types.c:1560
lisp_key_type_t key_id
Definition: lisp_types.h:374
fid_addr_type_t type
Definition: lisp_types.h:126
u8 si
Definition: lisp_types.h:168
void ip_prefix_normalize(ip_prefix_t *a)
Definition: lisp_types.c:988
struct _gid_address_t gid_address_t
void * gid_address_cast(gid_address_t *gid, gid_address_type_t type)
Definition: lisp_types.c:1489
unsigned int u32
Definition: types.h:88
lcaf_arp_ndp_t arp_ndp
Definition: lisp_types.h:192
u8 * format_mac_address(u8 *s, va_list *args)
Definition: lisp_types.c:215
fid_address_t dp_address_t
Definition: lisp_types.h:129
void ip_prefix_to_fib_prefix(const ip_prefix_t *ipp, fib_prefix_t *fibp)
convert from a LISP to a FIB prefix
Definition: control.c:167
u64 counter_t
64bit counters
Definition: counter.h:54
u8 ip_address_max_len(u8 ver)
Definition: lisp_types.c:549
u16 ip4_address_size_to_put()
Definition: lisp_types.c:555
u64 uword
Definition: types.h:112
template key/value backing page structure
Definition: bihash_doc.h:44
unsigned short u16
Definition: types.h:57
lisp_key_type_t
Definition: lisp_types.h:25
fid_address_t src
Definition: lisp_types.h:141
u8 * format_fid_address(u8 *s, va_list *args)
Definition: lisp_types.c:244
unsigned char u8
Definition: types.h:56
u8 * format_ip_address(u8 *s, va_list *args)
Definition: lisp_types.c:144
ip_address_t addr
Definition: lisp_types.h:176
void gid_address_from_ip(gid_address_t *g, ip_address_t *ip)
Definition: lisp_types.c:861
u32 locator_cmp(locator_t *l1, locator_t *l2)
Definition: lisp_types.c:1718
Definition: lisp_types.h:37
gid_address_t eid
Definition: lisp_types.h:351
gid_address_t address
Definition: lisp_types.h:325
#define foreach_gid_address_type_fcns
Definition: lisp_types.h:291
ip_address_t rmt_loc
Definition: lisp_types.h:387
u32 ip6_address_put(u8 *b, ip6_address_t *a)
Definition: lisp_types.c:578
void locator_copy(locator_t *dst, locator_t *src)
Definition: lisp_types.c:1709
vhost_vring_addr_t addr
Definition: vhost-user.h:83
Definition: lisp_types.h:38
ip_address_type_t
Definition: lisp_types.h:35
void ip_address_to_46(const ip_address_t *addr, ip46_address_t *a, fib_protocol_t *proto)
Definition: lisp_types.c:915
source_dest_t sd
Definition: lisp_types.h:191
u32 * locator_indices
Definition: lisp_types.h:345
uword unformat_ip_prefix(unformat_input_t *input, va_list *args)
Definition: lisp_types.c:187
locator_t * locators
Definition: lisp_types.h:357
u8 * format_hmac_key_id(u8 *s, va_list *args)
Definition: lisp_types.c:420