Add unit test infrastructure for LISP protocol
[vpp.git] / 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 struct
29 {
30   union
31   {
32     ip4_address_t v4;
33     ip6_address_t v6;
34   } ip;
35   ip_address_type_t version;
36 } ip_address_t;
37
38 typedef struct
39 {
40   ip_address_t addr;
41   u8 len;
42 } ip_prefix_t;
43
44 #define ip_addr_addr(_a) (_a)->ip
45 #define ip_addr_v4(_a) (_a)->ip.v4
46 #define ip_addr_v6(_a) (_a)->ip.v6
47 #define ip_addr_version(_a) (_a)->version
48
49 #define ip_prefix_addr(_a) (_a)->addr
50 #define ip_prefix_version(_a) ip_addr_version(&ip_prefix_addr(_a))
51 #define ip_prefix_len(_a) (_a)->len
52 #define ip_prefix_v4(_a) ip_addr_v4(&ip_prefix_addr(_a))
53 #define ip_prefix_v6(_a) ip_addr_v6(&ip_prefix_addr(_a))
54
55 typedef enum
56 {
57   /* NOTE: ip addresses are left out on purpose. Use max masked ip-prefixes
58    * instead */
59   IP_PREFIX,
60   NO_ADDRESS,
61   GID_ADDR_TYPES
62 } gid_address_type_t;
63
64 /* might want to expand this in the future :) */
65 typedef struct
66 {
67   union
68   {
69     ip_prefix_t ippref;
70   };
71   u8 type;
72 } gid_address_t;
73
74 u8 * format_ip_address (u8 * s, va_list * args);
75 uword unformat_ip_address (unformat_input_t * input, va_list * args);
76 u8 * format_ip_prefix (u8 * s, va_list * args);
77 uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
78
79 u16 ip4_address_size_to_put ();
80 u16 ip6_address_size_to_put ();
81 u32 ip4_address_put (u8 * b, ip4_address_t * a);
82 u32 ip6_address_put (u8 * b, ip6_address_t * a);
83
84 u16 ip_address_size_to_write (ip_address_t * a);
85 u16 ip_address_iana_afi(ip_address_t *a);
86 u8 ip_address_max_len (u8 ver);
87 u32 ip_address_put (u8 * b, ip_address_t * a);
88
89 /* LISP AFI codes  */
90 typedef enum {
91     LISP_AFI_NO_ADDR,
92     LISP_AFI_IP,
93     LISP_AFI_IP6,
94     LISP_AFI_LCAF = 16387
95 } lisp_afi_e;
96
97 u8 *format_gid_address (u8 * s, va_list * args);
98 uword unformat_gid_address (unformat_input_t * input, va_list * args);
99 int gid_address_cmp (gid_address_t * a1, gid_address_t * a2);
100
101 u16 gid_address_size_to_put (gid_address_t * a);
102 u16 gid_address_put (u8 * b, gid_address_t * gid);
103 u8 gid_address_len (gid_address_t *a);
104 void * gid_address_cast (gid_address_t * gid, gid_address_type_t type);
105 void gid_address_copy(gid_address_t * dst, gid_address_t * src);
106 u32 gid_address_parse (u8 * offset, gid_address_t *a);
107
108 #define gid_address_type(_a) (_a)->type
109 #define gid_address_ippref(_a) (_a)->ippref
110 #define gid_address_ippref_len(_a) (_a)->ippref.len
111 #define gid_address_ip(_a) ip_prefix_addr(&gid_address_ippref(_a))
112
113 /* 'sub'address functions */
114 int ip_address_cmp (ip_address_t * ip1, ip_address_t * ip2);
115 u16 ip_prefix_size_to_write (void * pref);
116 u16 ip_prefix_write (u8 * p, void * pref);
117 u8 ip_prefix_length (void *a);
118 void *ip_prefix_cast (gid_address_t * a);
119 void ip_prefix_copy (void * dst , void * src);
120
121 typedef struct
122 {
123   /* mark locator as local as opposed to remote */
124   u8 local;
125   u8 state;
126   union {
127     u32 sw_if_index;
128     gid_address_t address;
129   };
130   u8 priority;
131   u8 weight;
132   u8 mpriority;
133   u8 mweight;
134 } locator_t;
135
136 u32 locator_parse (void * ptr, locator_t * loc);
137 void locator_copy (locator_t * dst, locator_t * src);
138 u32 locator_cmp (locator_t * l1, locator_t * l2);
139
140 typedef struct
141 {
142   /* locator-set name */
143   u8 * name;
144
145   /* vector of locator indices */
146   u32 * locator_indices;
147   u8 local;
148 } locator_set_t;
149
150 typedef struct
151 {
152   gid_address_t eid;
153
154   /* index of local locator set */
155   u32 locator_set_index;
156
157   u32 ttl;
158   u8 action;
159   u8 authoritative;
160
161   u8 local;
162 } mapping_t;
163
164 #endif /* VNET_LISP_GPE_LISP_TYPES_H_ */