FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
vxlan_gbp.h
Go to the documentation of this file.
1 /*
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>
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* */
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;
41 
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;
47 /* *INDENT-ON* */
48 
49 /*
50 * Key fields: remote ip, vni on incoming VXLAN packet
51 * all fields in NET byte order
52 */
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 */
61 
62 typedef struct
63 {
64  /* Required for pool_get_aligned */
65  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
66 
67  /* FIB DPO for IP forwarding of VXLAN encap packet */
69 
70  /* Group Policy ID */
72 
73  /* flags */
75 
76  /* vxlan VNI in HOST byte order */
78 
79  /* tunnel src and dst addresses */
80  ip46_address_t src;
81  ip46_address_t dst;
82 
83  /* mcast packet output intfc index (used only if dst is mcast) */
85 
86  /* decap next index */
88 
89  /* The FIB index for src/dst addresses */
91 
92  /* vnet intfc index */
95 
96  /** Next node after VxLAN-GBP encap */
98 
99  /**
100  * Linkage into the FIB object graph
101  */
103 
104  /*
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
107  */
110 
111  /**
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
114  * changes.
115  * The tunnels sibling index on the FIB entry's dependency list.
116  */
118 
119  u32 dev_instance; /* Real device instance in tunnel vector */
120  u32 user_instance; /* Instance name being shown to user */
121 
124 
125 #define foreach_vxlan_gbp_input_next \
126 _(DROP, "error-drop") \
127 _(L2_INPUT, "l2-input")
128 
129 typedef enum
130 {
131 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
133 #undef _
136 
137 typedef enum
138 {
139 #define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
141 #undef vxlan_gbp_error
144 
145 typedef struct
146 {
147  /* vector of encap tunnel instances */
149 
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 */
153 
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 */
158 
159  /* mcast shared info */
160  uword *mcast_shared; /* keyed on mcast ip46 addr */
161 
162  /* Mapping from sw_if_index to tunnel index */
164 
165  /* convenience */
168 
169  /* Record used instances */
172 
174 
179 
180 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
181 
182 typedef struct
183 {
187  ip46_address_t src, dst;
193 
195  (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
196 
198  u8 is_enable);
199 
201 #endif /* included_vnet_vxlan_gbp_h */
202 
203 /*
204  * fd.io coding-style-patch-verification: ON
205  *
206  * Local Variables:
207  * eval: (c-set-style "gnu")
208  * End:
209  */
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key
Definition: vxlan_gbp.h:152
a
Definition: bitmap.h:538
u8 * format_vxlan_gbp_encap_trace(u8 *s, va_list *args)
Definition: encap.c:56
vxlan_gbp_input_next_t
Definition: vxlan_gbp.h:129
#define VLIB_BUFFER_PRE_DATA_SIZE
Definition: buffer.h:52
#define foreach_vxlan_gbp_input_next
Definition: vxlan_gbp.h:125
unsigned char u8
Definition: types.h:56
typedef CLIB_PACKED(struct{ip4_header_t ip4;udp_header_t udp;vxlan_gbp_header_t vxlan_gbp;}) ip4_vxlan_gbp_header_t
u32 sw_if_index
Definition: vxlan_gbp.api:39
vlib_main_t * vlib_main
Definition: vxlan_gbp.h:166
unsigned int u32
Definition: types.h:88
int vnet_vxlan_gbp_tunnel_add_del(vnet_vxlan_gbp_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: vxlan_gbp.c:356
void vnet_int_vxlan_gbp_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan_gbp.c:899
uword * mcast_shared
Definition: vxlan_gbp.h:160
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key
Definition: vxlan_gbp.h:151
adj_index_t mcast_adj_index
Definition: vxlan_gbp.h:109
dpo_id_t next_dpo
Definition: vxlan_gbp.h:68
unsigned short u16
Definition: types.h:57
vlib_node_registration_t vxlan6_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_encap_node)
Definition: encap.c:519
vlib_node_registration_t vxlan4_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_input_node)
Definition: decap.c:22
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: vxlan_gbp.h:117
An node in the FIB graph.
Definition: fib_node.h:289
fib_node_index_t fib_entry_index
Definition: vxlan_gbp.h:108
uword * instance_used
Definition: vxlan_gbp.h:170
clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t
Definition: vxlan_gbp.h:60
vl_api_address_t dst
Definition: vxlan_gbp.api:34
clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t
Definition: vxlan_gbp.h:53
vxlan_gbp_main_t vxlan_gbp_main
Definition: vxlan_gbp.c:33
vxlan_gbp_input_error_t
Definition: vxlan_gbp.h:137
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
uword encap_next_node
Next node after VxLAN-GBP encap.
Definition: vxlan_gbp.h:97
ip46_address_t dst
Definition: vxlan_gbp.h:81
fib_node_t node
Linkage into the FIB object graph.
Definition: vxlan_gbp.h:102
ip46_address_t src
Definition: vxlan_gbp.h:80
struct _vlib_node_registration vlib_node_registration_t
vlib_node_registration_t vxlan6_gbp_input_node
(constructor) VLIB_REGISTER_NODE (vxlan6_gbp_input_node)
Definition: decap.c:23
#define vnet_declare_rewrite(total_bytes)
Definition: rewrite.h:108
u64 uword
Definition: types.h:112
vxlan_gbp_tunnel_t * tunnels
Definition: vxlan_gbp.h:148
u32 vnet_vxlan_gbp_get_tunnel_index(u32 sw_if_index)
vlib_node_registration_t vxlan4_gbp_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan4_gbp_encap_node)
Definition: encap.c:502
u32 * tunnel_index_by_sw_if_index
Definition: vxlan_gbp.h:163
vnet_main_t * vnet_main
Definition: vxlan_gbp.h:167