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.
16 * vnet/buffer.h: vnet buffer flags
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_vnet_buffer_h
41 #define included_vnet_buffer_h
43 #include <vlib/vlib.h>
45 /* VLIB buffer flags for ip4/ip6 packets. Set by input interfaces for ip4/ip6
46 tcp/udp packets with hardware computed checksums. */
47 #define LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED LOG2_VLIB_BUFFER_FLAG_USER(1)
48 #define LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT LOG2_VLIB_BUFFER_FLAG_USER(2)
49 #define IP_BUFFER_L4_CHECKSUM_COMPUTED (1 << LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED)
50 #define IP_BUFFER_L4_CHECKSUM_CORRECT (1 << LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT)
53 * These bits are zeroed in vlib_buffer_init_for_free_list()
54 * meaning wherever the buffer comes from they have a reasonable
55 * value (eg, if ip4/ip6 generates the packet.)
57 #define LOG2_ETH_BUFFER_VLAN_2_DEEP LOG2_VLIB_BUFFER_FLAG_USER(3)
58 #define LOG2_ETH_BUFFER_VLAN_1_DEEP LOG2_VLIB_BUFFER_FLAG_USER(4)
59 #define ETH_BUFFER_VLAN_2_DEEP (1 << LOG2_ETH_BUFFER_VLAN_2_DEEP)
60 #define ETH_BUFFER_VLAN_1_DEEP (1 << LOG2_ETH_BUFFER_VLAN_1_DEEP)
61 #define ETH_BUFFER_VLAN_BITS (ETH_BUFFER_VLAN_1_DEEP | \
62 ETH_BUFFER_VLAN_2_DEEP)
64 #define LOG2_VNET_BUFFER_RTE_MBUF_VALID LOG2_VLIB_BUFFER_FLAG_USER(5)
65 #define VNET_BUFFER_RTE_MBUF_VALID (1 << LOG2_VNET_BUFFER_RTE_MBUF_VALID)
67 #define LOG2_BUFFER_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
68 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
70 #define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
71 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
73 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
74 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
76 #define foreach_buffer_opaque_union_subtype \
93 * vnet stack buffer opaque array overlay structure.
94 * The vnet_buffer_opaque_t *must* be the same size as the
95 * vlib_buffer_t "opaque" structure member, 32 bytes.
97 * When adding a union type, please add a stanza to
98 * foreach_buffer_opaque_union_subtype (directly above).
99 * Code in vnet_interface_init(...) verifies the size
100 * of the union, and will announce any deviations in an
101 * impossible-to-miss manner.
105 u32 sw_if_index[VLIB_N_RX_TX];
112 /* Saved value of current header by ethernet-input. */
113 i32 start_of_ethernet_header;
116 /* IP4/6 buffer opaque. */
119 /* Adjacency from destination IP address lookup [VLIB_TX].
120 Adjacency from source IP address lookup [VLIB_RX].
121 This gets set to ~0 until source lookup is performed. */
122 u32 adj_index[VLIB_N_RX_TX];
128 /* Flow hash value for this packet computed from IP src/dst address
129 protocol and ports. */
136 u32 save_rewrite_length;
147 /* IP header offset from vlib_buffer.data - saved by ip*_local nodes */
148 i32 start_of_ip_header;
155 * data copied from the MPLS header that was popped from the packet
156 * during the look-up.
165 /* Multicast replication */
169 u32 mcast_group_index;
170 u32 mcast_current_index;
171 u32 original_free_list_index;
174 /* ip4-in-ip6 softwire termination, only valid there */
181 /* l2 bridging path, only valid there */
185 u16 bd_index; // bridge-domain index
186 u8 l2_len; // ethernet header length
187 u8 shg; // split-horizon group
190 /* l2tpv3 softwire encap, only valid there */
193 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
212 /* IO - worker thread handoff */
221 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
225 /* interface output features */
232 /* vcgn udp inside input, only valid there */
235 /* This part forms context of the packet. The structure should be
236 * exactly same as spp_ctx_t. Also this should be the first
237 * element of this vcgn_uii structure.
239 /****** BEGIN spp_ctx_t section ***********************/
241 { /* Roddick specific */
244 { /* Used by PI to PI communication for TX */
245 u32 uidb_index:16; /* uidb_index to transmit */
246 u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
247 u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
249 * (set by 6rd defrag node)
252 u32 dst_ip_port_idx:4; /* Index to dst_ip_port_table */
258 { /* Used by PD / PI communication */
259 u32 uidb_index:16; /* uidb_index received in packet */
260 u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
261 u32 icmp_type:1; /* 0-ICMP query type, 1-ICMP error type */
262 u32 protocol_type:2; /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
263 u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
265 * (set by 6rd defrag node)
268 u32 direction:1; /* 0-Outside, 1-Inside */
269 u32 frag:1; /*IP fragment-1, Otherwise-0 */
270 u32 option:1; /* 0-No IP option (v4) present, non-fragHdr
271 * option hdr present (v6)
273 u32 df_bit:1; /* IPv4 DF bit copied here */
277 /****** END spp_ctx_t section ***********************/
285 u16 vrf; //bit0-13:i/f, bit14-15:protocol
293 u16 ovrf; /* Exit interface */
307 u32 map_domain_index;
311 u16 frag_offset; //Fragmentation header offset
312 u16 l4_offset; //L4 header overall offset
313 u8 l4_protocol; //The final protocol number
314 } v6; //Used by ip6_map_t only
315 u16 checksum_offset; //L4 checksum overall offset
319 /* IP Fragmentation */
325 u8 flags; //See ip_frag.h
328 /* COP - configurable junk filter(s) */
331 /* Current configuration index. */
332 u32 current_config_index;
338 /* overlay address family */
342 /* Driver rx feature */
345 u32 saved_next_index; /**< saved by drivers for short-cut */
351 } vnet_buffer_opaque_t;
354 * The opaque field of the vlib_buffer_t is intepreted as a
355 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
357 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <= STRUCT_SIZE_OF (vlib_buffer_t,
359 "VNET buffer meta-data too large for vlib_buffer");
361 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
363 /* Full cache line (64 bytes) of additional space */
369 } vnet_buffer_opaque2_t;
373 #endif /* included_vnet_buffer_h */
376 * fd.io coding-style-patch-verification: ON
379 * eval: (c-set-style "gnu")