2 * Copyright (c) 2015 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_h
16 #define included_vnet_vxlan_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/ip/vtep.h>
25 #include <vnet/l2/l2_input.h>
26 #include <vnet/l2/l2_output.h>
27 #include <vnet/l2/l2_bd.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/vxlan/vxlan_packet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/udp/udp_packet.h>
33 #include <vnet/dpo/dpo.h>
34 #include <vnet/adj/adj_types.h>
37 typedef CLIB_PACKED (struct {
38 ip4_header_t ip4; /* 20 bytes */
39 udp_header_t udp; /* 8 bytes */
40 vxlan_header_t vxlan; /* 8 bytes */
41 }) ip4_vxlan_header_t;
43 typedef CLIB_PACKED (struct {
44 ip6_header_t ip6; /* 40 bytes */
45 udp_header_t udp; /* 8 bytes */
46 vxlan_header_t vxlan; /* 8 bytes */
47 }) ip6_vxlan_header_t;
51 * Key fields: remote ip, vni on incoming VXLAN packet
52 * all fields in NET byte order
54 typedef clib_bihash_kv_16_8_t vxlan4_tunnel_key_t;
57 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
58 * ip, vni fields in NET byte order
59 * fib index field in host byte order
61 typedef clib_bihash_kv_24_8_t vxlan6_tunnel_key_t;
67 u32 sw_if_index; /* unicast - input interface / mcast - stats interface */
70 struct /* unicast action */
75 ip4_address_t local_ip; /* used as dst ip for mcast pkts to assign them to unicast tunnel */
83 /* Required for pool_get_aligned */
84 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
86 /* FIB DPO for IP forwarding of VXLAN encap packet */
89 /* vxlan VNI in HOST byte order */
92 /* tunnel src and dst addresses */
100 /* mcast packet output intfc index (used only if dst is mcast) */
101 u32 mcast_sw_if_index;
103 /* decap next index */
104 u16 decap_next_index;
106 /* The FIB index for src/dst addresses */
109 /* vnet intfc index */
114 * Linkage into the FIB object graph
119 * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
120 * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
122 fib_node_index_t fib_entry_index;
123 adj_index_t mcast_adj_index;
126 * The tunnel is a child of the FIB entry for its destination. This is
127 * so it receives updates when the forwarding information for that entry
129 * The tunnels sibling index on the FIB entry's dependency list.
133 u32 flow_index; /* infra flow index */
134 u32 dev_instance; /* Real device instance in tunnel vector */
135 u32 user_instance; /* Instance name being shown to user */
137 VNET_DECLARE_REWRITE;
140 #define foreach_vxlan_input_next \
141 _(DROP, "error-drop") \
142 _(L2_INPUT, "l2-input")
146 #define _(s,n) VXLAN_INPUT_NEXT_##s,
147 foreach_vxlan_input_next
150 } vxlan_input_next_t;
154 #define vxlan_error(n,s) VXLAN_ERROR_##n,
155 #include <vnet/vxlan/vxlan_error.def>
158 } vxlan_input_error_t;
162 /* vector of encap tunnel instances */
163 vxlan_tunnel_t *tunnels;
165 /* lookup tunnel by key */
167 vxlan4_tunnel_by_key; /* keyed on ipv4.dst + src_port + fib + vni */
169 vxlan6_tunnel_by_key; /* keyed on ipv6.dst + src_port + fib + vni */
171 /* local VTEP IPs ref count used by vxlan-bypass node to check if
172 received VXLAN packet DIP matches any local VTEP address */
173 vtep_table_t vtep_table;
175 /* mcast shared info */
176 uword *mcast_shared; /* keyed on mcast ip46 addr */
178 /* Mapping from sw_if_index to tunnel index */
179 u32 *tunnel_index_by_sw_if_index;
181 /* graph node state */
182 uword *bm_ip4_bypass_enabled_by_sw_if;
183 uword *bm_ip6_bypass_enabled_by_sw_if;
186 vlib_main_t *vlib_main;
187 vnet_main_t *vnet_main;
189 /* Record used instances */
190 uword *instance_used;
193 /* cache for last 8 vxlan tunnel */
194 vtep4_cache_t vtep4_u512;
198 extern vxlan_main_t vxlan_main;
200 extern vlib_node_registration_t vxlan4_input_node;
201 extern vlib_node_registration_t vxlan6_input_node;
202 extern vlib_node_registration_t vxlan4_encap_node;
203 extern vlib_node_registration_t vxlan6_encap_node;
204 extern vlib_node_registration_t vxlan4_flow_input_node;
206 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
212 /* we normally use is_ip4, but since this adds to the
213 * structure, this seems less of a breaking change */
217 ip46_address_t src, dst;
218 u32 mcast_sw_if_index;
220 u32 decap_next_index;
224 } vnet_vxlan_add_del_tunnel_args_t;
226 int vnet_vxlan_add_del_tunnel
227 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
229 void vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
231 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
233 u32 vnet_vxlan_get_tunnel_index (u32 sw_if_index);
234 #endif /* included_vnet_vxlan_h */
237 * fd.io coding-style-patch-verification: ON
240 * eval: (c-set-style "gnu")