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;
64 /* Required for pool_get_aligned */
65 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
67 /* FIB DPO for IP forwarding of VXLAN encap packet */
76 /* vxlan VNI in HOST byte order */
79 /* tunnel src and dst addresses */
83 /* mcast packet output intfc index (used only if dst is mcast) */
84 u32 mcast_sw_if_index;
86 /* decap next index */
89 /* The FIB index for src/dst addresses */
92 /* vnet intfc index */
96 /** Next node after VxLAN-GBP encap */
97 uword encap_next_node;
100 * Linkage into the FIB object graph
105 * The FIB entry for (depending on VXLAN-GBP tunnel is unicast or mcast)
106 * sending unicast VXLAN-GBP encap packets or receiving mcast VXLAN-GBP packets
108 fib_node_index_t fib_entry_index;
109 adj_index_t mcast_adj_index;
112 * The tunnel is a child of the FIB entry for its destination. This is
113 * so it receives updates when the forwarding information for that entry
115 * The tunnels sibling index on the FIB entry's dependency list.
119 u32 dev_instance; /* Real device instance in tunnel vector */
120 u32 user_instance; /* Instance name being shown to user */
122 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
123 } vxlan_gbp_tunnel_t;
125 #define foreach_vxlan_gbp_input_next \
126 _(DROP, "error-drop") \
127 _(L2_INPUT, "l2-input")
131 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
132 foreach_vxlan_gbp_input_next
134 VXLAN_GBP_INPUT_N_NEXT,
135 } vxlan_gbp_input_next_t;
139 #define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
140 #include <vnet/vxlan-gbp/vxlan_gbp_error.def>
141 #undef vxlan_gbp_error
143 } vxlan_gbp_input_error_t;
147 /* vector of encap tunnel instances */
148 vxlan_gbp_tunnel_t *tunnels;
150 /* lookup tunnel by key */
151 clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key; /* keyed on ipv4.dst + fib + vni */
152 clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key; /* keyed on ipv6.dst + fib + vni */
154 /* local VTEP IPs ref count used by vxlan-bypass node to check if
155 received VXLAN packet DIP matches any local VTEP address */
156 uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
157 uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
159 /* mcast shared info */
160 uword *mcast_shared; /* keyed on mcast ip46 addr */
162 /* Mapping from sw_if_index to tunnel index */
163 u32 *tunnel_index_by_sw_if_index;
166 vlib_main_t *vlib_main;
167 vnet_main_t *vnet_main;
169 /* Record used instances */
170 uword *instance_used;
173 extern vxlan_gbp_main_t vxlan_gbp_main;
175 extern vlib_node_registration_t vxlan4_gbp_input_node;
176 extern vlib_node_registration_t vxlan6_gbp_input_node;
177 extern vlib_node_registration_t vxlan4_gbp_encap_node;
178 extern vlib_node_registration_t vxlan6_gbp_encap_node;
180 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
187 ip46_address_t src, dst;
188 u32 mcast_sw_if_index;
190 u32 decap_next_index;
192 } vnet_vxlan_gbp_tunnel_add_del_args_t;
194 int vnet_vxlan_gbp_tunnel_add_del
195 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
197 void vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6,
200 u32 vnet_vxlan_gbp_get_tunnel_index (u32 sw_if_index);
201 #endif /* included_vnet_vxlan_gbp_h */
204 * fd.io coding-style-patch-verification: ON
207 * eval: (c-set-style "gnu")