ONE-13: Add CLI/API for LISP static remote mappings
[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 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 int ip_address_cmp (ip_address_t * ip1, ip_address_t * ip2);
39 void ip_address_copy (ip_address_t * dst , ip_address_t * src);
40 void ip_address_copy_addr (void * dst , ip_address_t * src);
41
42 typedef CLIB_PACKED(struct ip_prefix
43 {
44   ip_address_t addr;
45   u8 len;
46 }) ip_prefix_t;
47
48 #define ip_addr_addr(_a) (_a)->ip
49 #define ip_addr_v4(_a) (_a)->ip.v4
50 #define ip_addr_v6(_a) (_a)->ip.v6
51 #define ip_addr_version(_a) (_a)->version
52
53 #define ip_prefix_addr(_a) (_a)->addr
54 #define ip_prefix_version(_a) ip_addr_version(&ip_prefix_addr(_a))
55 #define ip_prefix_len(_a) (_a)->len
56 #define ip_prefix_v4(_a) ip_addr_v4(&ip_prefix_addr(_a))
57 #define ip_prefix_v6(_a) ip_addr_v6(&ip_prefix_addr(_a))
58
59 typedef enum
60 {
61   /* NOTE: ip addresses are left out on purpose. Use max masked ip-prefixes
62    * instead */
63   GID_ADDR_IP_PREFIX,
64   GID_ADDR_LCAF,
65   GID_ADDR_NO_ADDRESS,
66   GID_ADDR_TYPES
67 } gid_address_type_t;
68
69 typedef enum
70 {
71   /* make sure that values corresponds with RFC */
72   LCAF_NULL_BODY = 0,
73   LCAF_AFI_LIST_TYPE,
74   LCAF_INSTANCE_ID,
75   LCAF_TYPES
76 } lcaf_type_t;
77
78 struct _gid_address_t;
79
80 typedef struct
81 {
82   u8 vni_mask_len;
83   u32 vni;
84   struct _gid_address_t *gid_addr;
85 } vni_t;
86
87 #define vni_vni(_a) (_a)->vni
88 #define vni_mask_len(_a) (_a)->vni_mask_len
89 #define vni_gid(_a) (_a)->gid_addr
90
91 typedef struct
92 {
93   u8 src_len;
94   u8 dst_len;
95   struct _gid_address_t *src;
96   struct _gid_address_t *dst;
97 } source_dest_t;
98
99 typedef struct
100 {
101   /* the union needs to be at the beginning! */
102   union
103   {
104     source_dest_t sd;
105     vni_t uni;
106   };
107   u8 type;
108 } lcaf_t;
109
110 #define lcaf_type(_a) (_a)->type
111 #define lcaf_vni(_a) vni_vni(& (_a)->uni)
112 #define lcaf_vni_len(_a) vni_mask_len(& (_a)->uni)
113 #define lcaf_gid (_a) vni_gid(& (_a)->uni)
114
115 /* might want to expand this in the future :) */
116 typedef struct _gid_address_t
117 {
118   union
119   {
120     ip_prefix_t ippref;
121     lcaf_t lcaf;
122   };
123   u8 type;
124 } gid_address_t;
125
126 u8 * format_ip_address (u8 * s, va_list * args);
127 uword unformat_ip_address (unformat_input_t * input, va_list * args);
128 u8 * format_ip_prefix (u8 * s, va_list * args);
129 uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
130
131 u16 ip4_address_size_to_put ();
132 u16 ip6_address_size_to_put ();
133 u32 ip4_address_put (u8 * b, ip4_address_t * a);
134 u32 ip6_address_put (u8 * b, ip6_address_t * a);
135
136 u16 ip_address_size_to_write (ip_address_t * a);
137 u16 ip_address_iana_afi(ip_address_t *a);
138 u8 ip_address_max_len (u8 ver);
139 u32 ip_address_put (u8 * b, ip_address_t * a);
140
141 /* LISP AFI codes  */
142 typedef enum {
143     LISP_AFI_NO_ADDR,
144     LISP_AFI_IP,
145     LISP_AFI_IP6,
146     LISP_AFI_LCAF = 16387
147 } lisp_afi_e;
148
149 u8 *format_gid_address (u8 * s, va_list * args);
150 uword unformat_gid_address (unformat_input_t * input, va_list * args);
151 int gid_address_cmp (gid_address_t * a1, gid_address_t * a2);
152 void gid_address_free (gid_address_t *a);
153
154 u16 gid_address_size_to_put (gid_address_t * a);
155 u16 gid_address_put (u8 * b, gid_address_t * gid);
156 u8 gid_address_len (gid_address_t *a);
157 void * gid_address_cast (gid_address_t * gid, gid_address_type_t type);
158 void gid_address_copy(gid_address_t * dst, gid_address_t * src);
159 u32 gid_address_parse (u8 * offset, gid_address_t *a);
160
161 #define gid_address_type(_a) (_a)->type
162 #define gid_address_ippref(_a) (_a)->ippref
163 #define gid_address_ippref_len(_a) (_a)->ippref.len
164 #define gid_address_ip(_a) ip_prefix_addr(&gid_address_ippref(_a))
165 #define gid_address_lcaf(_a) (_a)->lcaf
166 #define gid_address_vni(_a) ( (GID_ADDR_LCAF == gid_address_type(_a)) ? \
167                               lcaf_vni(&gid_address_lcaf(_a)) : 0)
168 /* setter for vni  */
169 #define gid_address_set_vni(_a, _val) \
170   (lcaf_vni(&gid_address_lcaf(_a)) = (_val))
171
172 /* 'sub'address functions */
173 u16 ip_prefix_size_to_write (void * pref);
174 u16 ip_prefix_write (u8 * p, void * pref);
175 u8 ip_prefix_length (void *a);
176 void *ip_prefix_cast (gid_address_t * a);
177 void ip_prefix_copy (void * dst , void * src);
178
179 int lcaf_cmp (lcaf_t * lcaf1, lcaf_t * lcaf2);
180 u16 lcaf_size_to_write (void * pref);
181 u16 lcaf_write (u8 * p, void * pref);
182 u8 lcaf_prefix_length (void *a);
183 void *lcaf_cast (gid_address_t * a);
184 void lcaf_copy (void * dst , void * src);
185
186 typedef struct
187 {
188   /* mark locator as local as opposed to remote */
189   u8 local;
190   u8 state;
191   union {
192     u32 sw_if_index;
193     gid_address_t address;
194   };
195   u8 priority;
196   u8 weight;
197   u8 mpriority;
198   u8 mweight;
199 } locator_t;
200
201 u32 locator_parse (void * ptr, locator_t * loc);
202 void locator_copy (locator_t * dst, locator_t * src);
203 u32 locator_cmp (locator_t * l1, locator_t * l2);
204 void locator_free (locator_t * l);
205
206 typedef struct
207 {
208   /* locator-set name */
209   u8 * name;
210
211   /* vector of locator indices */
212   u32 * locator_indices;
213   u8 local;
214 } locator_set_t;
215
216 typedef struct
217 {
218   gid_address_t eid;
219
220   /* index of local locator set */
221   u32 locator_set_index;
222
223   u32 ttl;
224   u8 action;
225   u8 authoritative;
226
227   u8 local;
228 } mapping_t;
229
230 #endif /* VNET_LISP_GPE_LISP_TYPES_H_ */