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)
52 #define LOG2_HGSHM_BUFFER_USER_INDEX_VALID LOG2_VLIB_BUFFER_FLAG_USER(3)
53 #define VNET_HGSHM_BUFFER_USER_INDEX_VALID (1 << LOG2_HGSHM_BUFFER_USER_INDEX_VALID)
55 #define foreach_buffer_opaque_union_subtype \
75 * vnet stack buffer opaque array overlay structure.
76 * The vnet_buffer_opaque_t *must* be the same size as the
77 * vlib_buffer_t "opaque" structure member, 32 bytes.
79 * When adding a union type, please add a stanza to
80 * foreach_buffer_opaque_union_subtype (directly above).
81 * Code in vnet_interface_init(...) verifies the size
82 * of the union, and will announce any deviations in an
83 * impossible-to-miss manner.
86 u32 sw_if_index[VLIB_N_RX_TX];
91 /* Saved value of current header by ethernet-input. */
92 i32 start_of_ethernet_header;
95 /* IP4/6 buffer opaque. */
97 /* Adjacency from destination IP address lookup [VLIB_TX].
98 Adjacency from source IP address lookup [VLIB_RX].
99 This gets set to ~0 until source lookup is performed. */
100 u32 adj_index[VLIB_N_RX_TX];
104 /* Current configuration index. */
105 u32 current_config_index;
107 /* Flow hash value for this packet computed from IP src/dst address
108 protocol and ports. */
115 /* Alternate used for local TCP packets. */
119 u32 established_connection_index;
121 u32 mini_connection_index;
135 /* Multicast replication */
138 u32 mcast_group_index;
139 u32 mcast_current_index;
140 u32 original_free_list_index;
143 /* ipv6 shallow-pkt-inspection load-balancer, only valid there */
150 /* ipv4 DPI load-balancer, only valid there */
157 /* ip4-in-ip6 softwire termination, only valid there */
163 /* l2 bridging path, only valid there */
166 u16 bd_index; // bridge-domain index
167 u8 l2_len; // ethernet header length
168 u8 shg; // split-horizon group
171 /* l2tpv3 softwire encap, only valid there */
173 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
178 /* hgshm, valid if packet sent through iface */
180 u32 pad[8 -VLIB_N_RX_TX -1]; /* to end of opaque */
181 u32 user_index; /* client id borrowing buffer */
196 /* IO - worker thread handoff */
203 u32 pad[8 -VLIB_N_RX_TX -1]; /* to end of opaque */
207 /* interface output features */
215 /* vcgn udp inside input, only valid there */
217 /* This part forms context of the packet. The structure should be
218 * exactly same as spp_ctx_t. Also this should be the first
219 * element of this vcgn_uii structure.
221 /****** BEGIN spp_ctx_t section ***********************/
222 union { /* Roddick specific */
224 struct _tx_pkt_info { /* Used by PI to PI communication for TX */
225 u32 uidb_index:16; /* uidb_index to transmit */
226 u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
227 u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
229 * (set by 6rd defrag node)
232 u32 dst_ip_port_idx:4;/* Index to dst_ip_port_table */
237 struct _rx_pkt_info { /* Used by PD / PI communication */
238 u32 uidb_index:16; /* uidb_index received in packet */
239 u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
240 u32 icmp_type:1; /* 0-ICMP query type, 1-ICMP error type */
241 u32 protocol_type:2; /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
242 u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
244 * (set by 6rd defrag node)
247 u32 direction:1; /* 0-Outside, 1-Inside */
248 u32 frag:1; /*IP fragment-1, Otherwise-0*/
249 u32 option:1; /* 0-No IP option (v4) present, non-fragHdr
250 * option hdr present (v6)
252 u32 df_bit:1; /* IPv4 DF bit copied here */
256 /****** END spp_ctx_t section ***********************/
262 u16 vrf; //bit0-13:i/f, bit14-15:protocol
270 u16 ovrf; /* Exit interface */
282 u32 map_domain_index;
285 u16 frag_offset; //Fragmentation header offset
286 u16 l4_offset; //L4 header overall offset
287 u8 l4_protocol; //The final protocol number
288 } v6; //Used by ip6_map_t only
289 u16 checksum_offset; //L4 checksum overall offset
293 /* IP Fragmentation */
298 u8 flags; //See ip_frag.h
303 } vnet_buffer_opaque_t;
305 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
307 /* Full cache line (64 bytes) of additional space */
311 } vnet_buffer_opaque2_t;
315 #endif /* included_vnet_buffer_h */