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/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/vxlan_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_header_t vxlan; /* 8 bytes */
40 }) ip4_vxlan_header_t;
42 typedef CLIB_PACKED (struct {
43 ip6_header_t ip6; /* 40 bytes */
44 udp_header_t udp; /* 8 bytes */
45 vxlan_header_t vxlan; /* 8 bytes */
46 }) ip6_vxlan_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_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_tunnel_key_t;
64 /* Required for pool_get_aligned */
65 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
67 /* FIB DPO for IP forwarding of VXLAN encap packet */
70 /* vxlan VNI in HOST byte order */
73 /* tunnel src and dst addresses */
77 /* mcast packet output intfc index (used only if dst is mcast) */
78 u32 mcast_sw_if_index;
80 /* decap next index */
83 /* The FIB index for src/dst addresses */
86 /* vnet intfc index */
91 * Linkage into the FIB object graph
96 * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
97 * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
99 fib_node_index_t fib_entry_index;
100 adj_index_t mcast_adj_index;
103 * The tunnel is a child of the FIB entry for its desintion. This is
104 * so it receives updates when the forwarding information for that entry
106 * The tunnels sibling index on the FIB entry's dependency list.
110 u32 flow_index; /* infra flow index */
111 u32 dev_instance; /* Real device instance in tunnel vector */
112 u32 user_instance; /* Instance name being shown to user */
114 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
117 #define foreach_vxlan_input_next \
118 _(DROP, "error-drop") \
119 _(L2_INPUT, "l2-input")
123 #define _(s,n) VXLAN_INPUT_NEXT_##s,
124 foreach_vxlan_input_next
127 } vxlan_input_next_t;
131 #define vxlan_error(n,s) VXLAN_ERROR_##n,
132 #include <vnet/vxlan/vxlan_error.def>
135 } vxlan_input_error_t;
139 /* vector of encap tunnel instances */
140 vxlan_tunnel_t *tunnels;
142 /* lookup tunnel by key */
143 clib_bihash_16_8_t vxlan4_tunnel_by_key; /* keyed on ipv4.dst + fib + vni */
144 clib_bihash_24_8_t vxlan6_tunnel_by_key; /* keyed on ipv6.dst + fib + vni */
146 /* local VTEP IPs ref count used by vxlan-bypass node to check if
147 received VXLAN packet DIP matches any local VTEP address */
148 uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
149 uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
151 /* mcast shared info */
152 uword *mcast_shared; /* keyed on mcast ip46 addr */
154 /* Mapping from sw_if_index to tunnel index */
155 u32 *tunnel_index_by_sw_if_index;
158 vlib_main_t *vlib_main;
159 vnet_main_t *vnet_main;
161 /* Record used instances */
162 uword *instance_used;
166 extern vxlan_main_t vxlan_main;
168 extern vlib_node_registration_t vxlan4_input_node;
169 extern vlib_node_registration_t vxlan6_input_node;
170 extern vlib_node_registration_t vxlan4_encap_node;
171 extern vlib_node_registration_t vxlan6_encap_node;
172 extern vlib_node_registration_t vxlan4_flow_input_node;
174 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
180 /* we normally use is_ip4, but since this adds to the
181 * structure, this seems less of abreaking change */
184 ip46_address_t src, dst;
185 u32 mcast_sw_if_index;
187 u32 decap_next_index;
189 } vnet_vxlan_add_del_tunnel_args_t;
191 int vnet_vxlan_add_del_tunnel
192 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
194 void vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
196 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
198 u32 vnet_vxlan_get_tunnel_index (u32 sw_if_index);
199 #endif /* included_vnet_vxlan_h */
202 * fd.io coding-style-patch-verification: ON
205 * eval: (c-set-style "gnu")