c498b7c3d99a430054c9279094e3fae4e623b102
[vpp.git] / src / vnet / lisp-gpe / lisp_gpe.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  * @file
17  * @brief LISP-GPE definitions.
18  */
19
20 #ifndef included_vnet_lisp_gpe_h
21 #define included_vnet_lisp_gpe_h
22
23 #include <vppinfra/error.h>
24 #include <vppinfra/mhash.h>
25 #include <vnet/vnet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/ip/ip4_packet.h>
30 #include <vnet/ip/udp.h>
31 #include <vnet/lisp-cp/lisp_types.h>
32 #include <vnet/lisp-gpe/lisp_gpe_packet.h>
33 #include <vnet/adj/adj_types.h>
34
35 /** IP4-UDP-LISP encap header */
36 /* *INDENT-OFF* */
37 typedef CLIB_PACKED (struct {
38   ip4_header_t ip4;             /* 20 bytes */
39   udp_header_t udp;             /* 8 bytes */
40   lisp_gpe_header_t lisp;       /* 8 bytes */
41 }) ip4_udp_lisp_gpe_header_t;
42 /* *INDENT-ON* */
43
44 /** IP6-UDP-LISP encap header */
45 /* *INDENT-OFF* */
46 typedef CLIB_PACKED (struct {
47   ip6_header_t ip6;             /* 40 bytes */
48   udp_header_t udp;             /* 8 bytes */
49   lisp_gpe_header_t lisp;       /* 8 bytes */
50 }) ip6_udp_lisp_gpe_header_t;
51 /* *INDENT-ON* */
52
53 #define foreach_lisp_gpe_ip_input_next          \
54 _(DROP, "error-drop")                           \
55 _(IP4_INPUT, "ip4-input")                       \
56 _(IP6_INPUT, "ip6-input")                       \
57 _(L2_INPUT, "l2-input")
58
59 /** Enum of possible next nodes post LISP-GPE decap */
60 typedef enum
61 {
62 #define _(s,n) LISP_GPE_INPUT_NEXT_##s,
63   foreach_lisp_gpe_ip_input_next
64 #undef _
65     LISP_GPE_INPUT_N_NEXT,
66 } lisp_gpe_input_next_t;
67
68 /* Arc to nsh-input added only if nsh-input exists */
69 #define LISP_GPE_INPUT_NEXT_NSH_INPUT 4
70
71 typedef enum
72 {
73 #define lisp_gpe_error(n,s) LISP_GPE_ERROR_##n,
74 #include <vnet/lisp-gpe/lisp_gpe_error.def>
75 #undef lisp_gpe_error
76   LISP_GPE_N_ERROR,
77 } lisp_gpe_error_t;
78
79 typedef struct tunnel_lookup
80 {
81   /** Lookup lisp-gpe interfaces by dp table (eg. vrf/bridge index) */
82   uword *hw_if_index_by_dp_table;
83
84   /** lookup decap tunnel termination sw_if_index by vni and vice versa */
85   uword *sw_if_index_by_vni;
86
87   // FIXME - Need this?
88   uword *vni_by_sw_if_index;
89 } tunnel_lookup_t;
90
91 /** LISP-GPE global state*/
92 typedef struct lisp_gpe_main
93 {
94   /**
95    * @brief DB of all forwarding entries. The Key is:{l-EID,r-EID,vni}
96    * where the EID encodes L2 or L3
97    */
98   uword *lisp_gpe_fwd_entries;
99
100   /**
101    * @brief A Pool of all LISP forwarding entries
102    */
103   struct lisp_gpe_fwd_entry_t_ *lisp_fwd_entry_pool;
104
105   /** Free vlib hw_if_indices */
106   u32 *free_tunnel_hw_if_indices;
107
108   u8 is_en;
109
110   /* L3 data structures
111    * ================== */
112   tunnel_lookup_t l3_ifaces;
113
114   /* L2 data structures
115    * ================== */
116
117   /** L2 LISP FIB */
118     BVT (clib_bihash) l2_fib;
119
120   tunnel_lookup_t l2_ifaces;
121
122   /** Load-balance for a miss in the table */
123   dpo_id_t l2_lb_cp_lkup;
124
125   /* NSH data structures
126    * ================== */
127
128     BVT (clib_bihash) nsh_fib;
129
130   tunnel_lookup_t nsh_ifaces;
131
132   const dpo_id_t *nsh_cp_lkup;
133
134   /** convenience */
135   vlib_main_t *vlib_main;
136   vnet_main_t *vnet_main;
137   ip4_main_t *im4;
138   ip6_main_t *im6;
139   ip_lookup_main_t *lm4;
140   ip_lookup_main_t *lm6;
141 } lisp_gpe_main_t;
142
143 /** LISP-GPE global state*/
144 lisp_gpe_main_t lisp_gpe_main;
145
146 always_inline lisp_gpe_main_t *
147 vnet_lisp_gpe_get_main ()
148 {
149   return &lisp_gpe_main;
150 }
151
152
153 extern vlib_node_registration_t lisp_gpe_ip4_input_node;
154 extern vlib_node_registration_t lisp_gpe_ip6_input_node;
155 extern vnet_hw_interface_class_t lisp_gpe_hw_class;
156
157 u8 *format_lisp_gpe_header_with_length (u8 * s, va_list * args);
158
159 /** Read LISP-GPE status */
160 u8 vnet_lisp_gpe_enable_disable_status (void);
161
162 u32
163 lisp_gpe_l3_iface_find_or_create (lisp_gpe_main_t * lgm,
164                                   u32 overlay_table_id, u32 vni);
165
166 /** Add/del LISP-GPE interface. */
167 extern void lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
168 extern u32 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
169 extern void lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
170 extern u32 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
171
172
173 typedef struct
174 {
175   u8 is_en;
176 } vnet_lisp_gpe_enable_disable_args_t;
177
178 clib_error_t
179   * vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t * a);
180
181 typedef enum
182 {
183   NO_ACTION,
184   FORWARD_NATIVE,
185   SEND_MAP_REQUEST,
186   DROP
187 } negative_fwd_actions_e;
188
189 /** */
190 typedef struct
191 {
192   u8 is_add;
193
194   /** type of mapping */
195   u8 is_negative;
196
197   /** action for negative mappings */
198   negative_fwd_actions_e action;
199
200   /** local eid */
201   gid_address_t lcl_eid;
202
203   /** remote eid */
204   gid_address_t rmt_eid;
205
206   /** vector of locator pairs */
207   locator_pair_t *locator_pairs;
208
209   /** FIB index to lookup remote locator at encap */
210   u32 encap_fib_index;
211
212   /** FIB index to lookup inner IP at decap */
213   u32 decap_fib_index;
214
215   /* TODO remove */
216   u32 decap_next_index;
217
218   /** VNI/tenant id in HOST byte order */
219   u32 vni;
220
221   /** vrf or bd where fwd entry should be inserted */
222   union
223   {
224     /** table (vrf) id */
225     u32 table_id;
226
227     /** bridge domain id */
228     u16 bd_id;
229
230     /** generic access */
231     u32 dp_table;
232   };
233 } vnet_lisp_gpe_add_del_fwd_entry_args_t;
234
235 typedef struct
236 {
237   u32 fwd_entry_index;
238   u32 dp_table;
239   u32 vni;
240   dp_address_t leid;
241   dp_address_t reid;
242 } lisp_api_gpe_fwd_entry_t;
243
244 #define foreach_lgpe_ip4_lookup_next    \
245   _(DROP, "error-drop")                 \
246   _(LISP_CP_LOOKUP, "lisp-cp-lookup")
247
248 typedef enum lgpe_ip4_lookup_next
249 {
250 #define _(sym,str) LGPE_IP4_LOOKUP_NEXT_##sym,
251   foreach_lgpe_ip4_lookup_next
252 #undef _
253     LGPE_IP4_LOOKUP_N_NEXT,
254 } lgpe_ip4_lookup_next_t;
255
256 #define foreach_lgpe_ip6_lookup_next    \
257   _(DROP, "error-drop")                 \
258   _(LISP_CP_LOOKUP, "lisp-cp-lookup")
259
260 typedef enum lgpe_ip6_lookup_next
261 {
262 #define _(sym,str) LGPE_IP6_LOOKUP_NEXT_##sym,
263   foreach_lgpe_ip6_lookup_next
264 #undef _
265     LGPE_IP6_LOOKUP_N_NEXT,
266 } lgpe_ip6_lookup_next_t;
267
268 u8 *format_vnet_lisp_gpe_status (u8 * s, va_list * args);
269
270 lisp_api_gpe_fwd_entry_t *vnet_lisp_gpe_fwd_entries_get_by_vni (u32 vni);
271
272 #endif /* included_vnet_lisp_gpe_h */
273
274 /*
275  * fd.io coding-style-patch-verification: ON
276  *
277  * Local Variables:
278  * eval: (c-set-style "gnu")
279  * End:
280  */