FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
vxlan.h
Go to the documentation of this file.
1 /*
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:
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_h
16 #define included_vnet_vxlan_h
17 
18 #include <vppinfra/error.h>
19 #include <vppinfra/hash.h>
20 #include <vnet/vnet.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/l2/l2_input.h>
23 #include <vnet/l2/l2_output.h>
24 #include <vnet/l2/l2_bd.h>
25 #include <vnet/ethernet/ethernet.h>
27 #include <vnet/ip/ip4_packet.h>
28 #include <vnet/ip/ip6_packet.h>
29 #include <vnet/udp/udp.h>
30 #include <vnet/dpo/dpo.h>
31 #include <vnet/adj/adj_types.h>
32 
33 typedef CLIB_PACKED (struct {
34  ip4_header_t ip4; /* 20 bytes */
35  udp_header_t udp; /* 8 bytes */
36  vxlan_header_t vxlan; /* 8 bytes */
37 }) ip4_vxlan_header_t;
38 
39 typedef CLIB_PACKED (struct {
40  ip6_header_t ip6; /* 40 bytes */
41  udp_header_t udp; /* 8 bytes */
42  vxlan_header_t vxlan; /* 8 bytes */
43 }) ip6_vxlan_header_t;
44 
45 typedef CLIB_PACKED(struct {
46  /*
47  * Key fields: ip src and vxlan vni on incoming VXLAN packet
48  * all fields in NET byte order
49  */
50  union {
51  struct {
52  u32 src;
53  u32 vni; /* shifted left 8 bits */
54  };
55  u64 as_u64;
56  };
57 }) vxlan4_tunnel_key_t;
58 
59 typedef CLIB_PACKED(struct {
60  /*
61  * Key fields: ip src and vxlan vni on incoming VXLAN packet
62  * all fields in NET byte order
63  */
64  ip6_address_t src;
65  u32 vni; /* shifted left 8 bits */
66 }) vxlan6_tunnel_key_t;
67 
68 typedef struct {
69  /* Rewrite string. $$$$ embed vnet_rewrite header */
71 
72  /* FIB DPO for IP forwarding of VXLAN encap packet */
74 
75  /* vxlan VNI in HOST byte order */
77 
78  /* tunnel src and dst addresses */
79  ip46_address_t src;
80  ip46_address_t dst;
81 
82  /* mcast packet output intfc index (used only if dst is mcast) */
84 
85  /* decap next index */
87 
88  /* The FIB index for src/dst addresses */
90 
91  /* vnet intfc index */
94 
95  /**
96  * Linkage into the FIB object graph
97  */
99 
100  /*
101  * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
102  * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
103  */
106 
107  /**
108  * The tunnel is a child of the FIB entry for its desintion. This is
109  * so it receives updates when the forwarding information for that entry
110  * changes.
111  * The tunnels sibling index on the FIB entry's dependency list.
112  */
115 
116 #define foreach_vxlan_input_next \
117 _(DROP, "error-drop") \
118 _(L2_INPUT, "l2-input")
119 
120 typedef enum {
121 #define _(s,n) VXLAN_INPUT_NEXT_##s,
123 #undef _
126 
127 typedef enum {
128 #define vxlan_error(n,s) VXLAN_ERROR_##n,
130 #undef vxlan_error
133 
134 typedef struct {
135  /* vector of encap tunnel instances */
137 
138  /* lookup tunnel by key */
139  uword * vxlan4_tunnel_by_key; /* keyed on ipv4.dst + vni */
140  uword * vxlan6_tunnel_by_key; /* keyed on ipv6.dst + vni */
141 
142  /* local VTEP IPs ref count used by vxlan-bypass node to check if
143  received VXLAN packet DIP matches any local VTEP address */
144  uword * vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
145  uword * vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
146 
147  /* mcast shared info */
148  uword * mcast_shared; /* keyed on mcast ip46 addr */
149 
150  /* Free vlib hw_if_indices */
152 
153  /* Mapping from sw_if_index to tunnel index */
155 
156  /* convenience */
159 } vxlan_main_t;
160 
162 
167 
168 u8 * format_vxlan_encap_trace (u8 * s, va_list * args);
169 
170 typedef struct {
172 
173  /* we normally use is_ip4, but since this adds to the
174  * structure, this seems less of abreaking change */
176  ip46_address_t src, dst;
182 
184 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
185 
187 (u32 sw_if_index, u8 is_ip6, u8 is_enable);
188 #endif /* included_vnet_vxlan_h */
int vnet_vxlan_add_del_tunnel(vnet_vxlan_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: vxlan.c:363
u32 sibling_index
The tunnel is a child of the FIB entry for its desintion.
Definition: vxlan.h:113
a
Definition: bitmap.h:516
uword * vtep6
Definition: vxlan.h:145
u64 as_u64
Definition: bihash_doc.h:63
#define foreach_vxlan_input_next
Definition: vxlan.h:116
vlib_node_registration_t vxlan4_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan4_encap_node)
Definition: encap.c:522
uword * mcast_shared
Definition: vxlan.h:148
ip46_address_t dst
Definition: vxlan.h:80
struct _vlib_node_registration vlib_node_registration_t
vlib_node_registration_t vxlan4_input_node
(constructor) VLIB_REGISTER_NODE (vxlan4_input_node)
Definition: decap.c:22
u8 * format_vxlan_encap_trace(u8 *s, va_list *args)
Definition: encap.c:49
vnet_main_t * vnet_main
Definition: vxlan.h:158
vlib_main_t * vlib_main
Definition: vxlan.h:157
unsigned long u64
Definition: types.h:89
fib_node_t node
Linkage into the FIB object graph.
Definition: vxlan.h:98
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:152
u8 * rewrite
Definition: vxlan.h:70
adj_index_t mcast_adj_index
Definition: vxlan.h:105
vlib_node_registration_t vxlan6_input_node
(constructor) VLIB_REGISTER_NODE (vxlan6_input_node)
Definition: decap.c:23
uword * vxlan4_tunnel_by_key
Definition: vxlan.h:139
vlib_node_registration_t vxlan6_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan6_encap_node)
Definition: encap.c:538
An node in the FIB graph.
Definition: fib_node.h:279
u32 mcast_sw_if_index
Definition: vxlan.h:83
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
u32 decap_next_index
Definition: vxlan.h:86
vxlan_input_next_t
Definition: vxlan.h:120
unsigned int u32
Definition: types.h:88
uword * vtep4
Definition: vxlan.h:144
uword * vxlan6_tunnel_by_key
Definition: vxlan.h:140
u32 sw_if_index
Definition: vxlan.h:92
u32 hw_if_index
Definition: vxlan.h:93
void vnet_int_vxlan_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan.c:912
u64 uword
Definition: types.h:112
unsigned char u8
Definition: types.h:56
fib_node_index_t fib_entry_index
Definition: vxlan.h:104
u32 encap_fib_index
Definition: vxlan.h:89
u32 * tunnel_index_by_sw_if_index
Definition: vxlan.h:154
typedef CLIB_PACKED(struct{ip4_header_t ip4;udp_header_t udp;vxlan_header_t vxlan;}) ip4_vxlan_header_t
dpo_id_t next_dpo
Definition: vxlan.h:73
vxlan_input_error_t
Definition: vxlan.h:127
vxlan_tunnel_t * tunnels
Definition: vxlan.h:136
u32 * free_vxlan_tunnel_hw_if_indices
Definition: vxlan.h:151
ip46_address_t src
Definition: vxlan.h:79
vxlan_main_t vxlan_main
Definition: vxlan.h:161