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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef included_vnet_vxlan_gbp_h
16 #define included_vnet_vxlan_gbp_h
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>
36 typedef 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;
42 typedef 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;
50 * Key fields: remote ip, vni on incoming VXLAN packet
51 * all fields in NET byte order
53 typedef clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t;
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
60 typedef clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t;
62 typedef enum vxlan_gbp_tunnel_mode_t_
64 VXLAN_GBP_TUNNEL_MODE_L2,
65 VXLAN_GBP_TUNNEL_MODE_L3,
66 } vxlan_gbp_tunnel_mode_t;
68 extern u8 *format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args);
72 /* Required for pool_get_aligned */
73 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
75 /* FIB DPO for IP forwarding of VXLAN encap packet */
81 /* vxlan VNI in HOST byte order */
84 /* tunnel src and dst addresses */
88 /* mcast packet output intfc index (used only if dst is mcast) */
89 u32 mcast_sw_if_index;
91 /* The FIB index for src/dst addresses */
94 /* vnet intfc index */
98 /** Next node after VxLAN-GBP encap */
99 uword encap_next_node;
103 * L2 tunnels decap to L2 path, L3 tunnels to the L3 path
105 vxlan_gbp_tunnel_mode_t mode;
108 * Linkage into the FIB object graph
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
116 fib_node_index_t fib_entry_index;
117 adj_index_t mcast_adj_index;
120 * The tunnel is a child of the FIB entry for its destination. This is
121 * so it receives updates when the forwarding information for that entry
123 * The tunnels sibling index on the FIB entry's dependency list.
127 u32 dev_instance; /* Real device instance in tunnel vector */
128 u32 user_instance; /* Instance name being shown to user */
130 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
131 } vxlan_gbp_tunnel_t;
133 #define foreach_vxlan_gbp_input_next \
134 _(DROP, "error-drop") \
135 _(PUNT, "punt-dispatch") \
136 _(L2_INPUT, "l2-input") \
137 _(IP4_INPUT, "ip4-input") \
138 _(IP6_INPUT, "ip6-input")
142 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
143 foreach_vxlan_gbp_input_next
145 VXLAN_GBP_INPUT_N_NEXT,
146 } vxlan_gbp_input_next_t;
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
154 } vxlan_gbp_input_error_t;
157 * Call back function packets that do not match a configured tunnel
159 typedef vxlan_gbp_input_next_t (*vxlan_bgp_no_tunnel_t) (vlib_buffer_t * b,
165 /* vector of encap tunnel instances */
166 vxlan_gbp_tunnel_t *tunnels;
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 */
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 */
177 /* mcast shared info */
178 uword *mcast_shared; /* keyed on mcast ip46 addr */
180 /* Mapping from sw_if_index to tunnel index */
181 u32 *tunnel_index_by_sw_if_index;
183 /* On demand udp port registration */
184 u32 udp_ports_registered;
187 vlib_main_t *vlib_main;
188 vnet_main_t *vnet_main;
190 /* Record used instances */
191 uword *instance_used;
194 * Punt reasons for no such tunnel
196 vlib_punt_reason_t punt_no_such_tunnel[FIB_PROTOCOL_IP_MAX];
199 extern vxlan_gbp_main_t vxlan_gbp_main;
201 extern vlib_node_registration_t vxlan4_gbp_input_node;
202 extern vlib_node_registration_t vxlan6_gbp_input_node;
203 extern vlib_node_registration_t vxlan4_gbp_encap_node;
204 extern vlib_node_registration_t vxlan6_gbp_encap_node;
205 extern void vxlan_gbp_register_udp_ports (void);
206 extern void vxlan_gbp_unregister_udp_ports (void);
208 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
215 vxlan_gbp_tunnel_mode_t mode;
216 ip46_address_t src, dst;
217 u32 mcast_sw_if_index;
220 } vnet_vxlan_gbp_tunnel_add_del_args_t;
222 int vnet_vxlan_gbp_tunnel_add_del
223 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
224 int vnet_vxlan_gbp_tunnel_del (u32 sw_if_indexp);
226 void vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6,
230 vxlan_gbp_tunnel_by_sw_if_index (u32 sw_if_index)
232 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
234 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
237 return (vxm->tunnel_index_by_sw_if_index[sw_if_index]);
240 #endif /* included_vnet_vxlan_gbp_h */
243 * fd.io coding-style-patch-verification: ON
246 * eval: (c-set-style "gnu")