blob: d17f75799d6d9fe58e8640e822691b60dbe3d0bf [file] [log] [blame]
Mohsin Kazmi61b94c62018-08-20 18:32:39 +02001/*
2 * Copyright (c) 2018 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#ifndef included_vnet_vxlan_gbp_h
16#define included_vnet_vxlan_gbp_h
17
18#include <vppinfra/error.h>
19#include <vppinfra/hash.h>
20#include <vppinfra/bihash_16_8.h>
21#include <vppinfra/bihash_24_8.h>
22#include <vnet/vnet.h>
23#include <vnet/ip/ip.h>
24#include <vnet/l2/l2_input.h>
25#include <vnet/l2/l2_output.h>
26#include <vnet/l2/l2_bd.h>
27#include <vnet/ethernet/ethernet.h>
28#include <vnet/vxlan-gbp/vxlan_gbp_packet.h>
29#include <vnet/ip/ip4_packet.h>
30#include <vnet/ip/ip6_packet.h>
31#include <vnet/udp/udp.h>
32#include <vnet/dpo/dpo.h>
33#include <vnet/adj/adj_types.h>
34
35/* *INDENT-OFF* */
36typedef CLIB_PACKED (struct {
37 ip4_header_t ip4; /* 20 bytes */
38 udp_header_t udp; /* 8 bytes */
39 vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
40}) ip4_vxlan_gbp_header_t;
41
42typedef CLIB_PACKED (struct {
43 ip6_header_t ip6; /* 40 bytes */
44 udp_header_t udp; /* 8 bytes */
45 vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
46}) ip6_vxlan_gbp_header_t;
47/* *INDENT-ON* */
48
49/*
50* Key fields: remote ip, vni on incoming VXLAN packet
51* all fields in NET byte order
52*/
53typedef clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t;
54
55/*
56* Key fields: remote ip, vni and fib index on incoming VXLAN packet
57* ip, vni fields in NET byte order
58* fib index field in host byte order
59*/
60typedef clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t;
61
Neale Ranns93cc3ee2018-10-10 07:22:51 -070062typedef enum vxlan_gbp_tunnel_mode_t_
63{
64 VXLAN_GBP_TUNNEL_MODE_L2,
65 VXLAN_GBP_TUNNEL_MODE_L3,
66} vxlan_gbp_tunnel_mode_t;
67
68extern u8 *format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args);
69
Mohsin Kazmi61b94c62018-08-20 18:32:39 +020070typedef struct
71{
72 /* Required for pool_get_aligned */
73 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
74
75 /* FIB DPO for IP forwarding of VXLAN encap packet */
76 dpo_id_t next_dpo;
77
Mohsin Kazmi61b94c62018-08-20 18:32:39 +020078 /* flags */
79 u16 flags;
80
81 /* vxlan VNI in HOST byte order */
82 u32 vni;
83
84 /* tunnel src and dst addresses */
85 ip46_address_t src;
86 ip46_address_t dst;
87
88 /* mcast packet output intfc index (used only if dst is mcast) */
89 u32 mcast_sw_if_index;
90
Mohsin Kazmi61b94c62018-08-20 18:32:39 +020091 /* The FIB index for src/dst addresses */
92 u32 encap_fib_index;
93
94 /* vnet intfc index */
95 u32 sw_if_index;
96 u32 hw_if_index;
97
98 /** Next node after VxLAN-GBP encap */
99 uword encap_next_node;
100
101 /**
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700102 * Tunnel mode.
103 * L2 tunnels decap to L2 path, L3 tunnels to the L3 path
104 */
105 vxlan_gbp_tunnel_mode_t mode;
106
107 /**
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200108 * Linkage into the FIB object graph
109 */
110 fib_node_t node;
111
112 /*
113 * The FIB entry for (depending on VXLAN-GBP tunnel is unicast or mcast)
114 * sending unicast VXLAN-GBP encap packets or receiving mcast VXLAN-GBP packets
115 */
116 fib_node_index_t fib_entry_index;
117 adj_index_t mcast_adj_index;
118
119 /**
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700120 * The tunnel is a child of the FIB entry for its destination. This is
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200121 * so it receives updates when the forwarding information for that entry
122 * changes.
123 * The tunnels sibling index on the FIB entry's dependency list.
124 */
125 u32 sibling_index;
126
127 u32 dev_instance; /* Real device instance in tunnel vector */
128 u32 user_instance; /* Instance name being shown to user */
129
Klement Sekera7dbf9a12019-11-21 10:31:03 +0000130 VNET_DECLARE_REWRITE;
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200131} vxlan_gbp_tunnel_t;
132
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700133#define foreach_vxlan_gbp_input_next \
134 _(DROP, "error-drop") \
Neale Ranns76b56492018-09-28 15:16:14 +0000135 _(PUNT, "punt-dispatch") \
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700136 _(L2_INPUT, "l2-input") \
137 _(IP4_INPUT, "ip4-input") \
138 _(IP6_INPUT, "ip6-input")
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200139
140typedef enum
141{
142#define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
143 foreach_vxlan_gbp_input_next
144#undef _
145 VXLAN_GBP_INPUT_N_NEXT,
146} vxlan_gbp_input_next_t;
147
148typedef enum
149{
150#define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
151#include <vnet/vxlan-gbp/vxlan_gbp_error.def>
152#undef vxlan_gbp_error
153 VXLAN_GBP_N_ERROR,
154} vxlan_gbp_input_error_t;
155
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700156/**
157 * Call back function packets that do not match a configured tunnel
158 */
159typedef vxlan_gbp_input_next_t (*vxlan_bgp_no_tunnel_t) (vlib_buffer_t * b,
160 u32 thread_index,
161 u8 is_ip6);
162
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200163typedef struct
164{
165 /* vector of encap tunnel instances */
166 vxlan_gbp_tunnel_t *tunnels;
167
168 /* lookup tunnel by key */
169 clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key; /* keyed on ipv4.dst + fib + vni */
170 clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key; /* keyed on ipv6.dst + fib + vni */
171
172 /* local VTEP IPs ref count used by vxlan-bypass node to check if
173 received VXLAN packet DIP matches any local VTEP address */
174 uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
175 uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
176
177 /* mcast shared info */
178 uword *mcast_shared; /* keyed on mcast ip46 addr */
179
180 /* Mapping from sw_if_index to tunnel index */
181 u32 *tunnel_index_by_sw_if_index;
182
Mohsin Kazmif208b022018-10-24 12:17:50 +0200183 /* On demand udp port registration */
184 u32 udp_ports_registered;
185
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200186 /* convenience */
187 vlib_main_t *vlib_main;
188 vnet_main_t *vnet_main;
189
190 /* Record used instances */
191 uword *instance_used;
Neale Ranns76b56492018-09-28 15:16:14 +0000192
193 /**
194 * Punt reasons for no such tunnel
195 */
196 vlib_punt_reason_t punt_no_such_tunnel[FIB_PROTOCOL_IP_MAX];
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200197} vxlan_gbp_main_t;
198
199extern vxlan_gbp_main_t vxlan_gbp_main;
200
201extern vlib_node_registration_t vxlan4_gbp_input_node;
202extern vlib_node_registration_t vxlan6_gbp_input_node;
203extern vlib_node_registration_t vxlan4_gbp_encap_node;
204extern vlib_node_registration_t vxlan6_gbp_encap_node;
Mohsin Kazmif208b022018-10-24 12:17:50 +0200205extern void vxlan_gbp_register_udp_ports (void);
206extern void vxlan_gbp_unregister_udp_ports (void);
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200207
208u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
209
210typedef struct
211{
212 u8 is_add;
213 u8 is_ip6;
214 u32 instance;
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700215 vxlan_gbp_tunnel_mode_t mode;
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200216 ip46_address_t src, dst;
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200217 u32 mcast_sw_if_index;
218 u32 encap_fib_index;
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200219 u32 vni;
Neale Ranns79a05f52018-09-11 07:39:43 -0700220} vnet_vxlan_gbp_tunnel_add_del_args_t;
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200221
Neale Ranns79a05f52018-09-11 07:39:43 -0700222int vnet_vxlan_gbp_tunnel_add_del
223 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
Neale Ranns93cc3ee2018-10-10 07:22:51 -0700224int vnet_vxlan_gbp_tunnel_del (u32 sw_if_indexp);
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200225
226void vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6,
227 u8 is_enable);
228
Neale Ranns2b600182019-03-29 05:08:27 -0700229always_inline u32
230vxlan_gbp_tunnel_by_sw_if_index (u32 sw_if_index)
231{
232 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
233
234 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
235 return ~0;
236
237 return (vxm->tunnel_index_by_sw_if_index[sw_if_index]);
238}
239
Mohsin Kazmi61b94c62018-08-20 18:32:39 +0200240#endif /* included_vnet_vxlan_gbp_h */
241
242/*
243 * fd.io coding-style-patch-verification: ON
244 *
245 * Local Variables:
246 * eval: (c-set-style "gnu")
247 * End:
248 */