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