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 #define foreach_vnet_buffer_field \
46 _( 1, L4_CHECKSUM_COMPUTED) \
47 _( 2, L4_CHECKSUM_CORRECT) \
51 _( 6, HANDOFF_NEXT_VALID) \
52 _( 7, LOCALLY_ORIGINATED) \
55 _(10, OFFLOAD_IP_CKSUM) \
56 _(11, OFFLOAD_TCP_CKSUM) \
57 _(12, OFFLOAD_UDP_CKSUM) \
60 #define VNET_BUFFER_FLAGS_VLAN_BITS \
61 (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
65 #define _(bit, name) VNET_BUFFER_F_##name = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
66 foreach_vnet_buffer_field
72 #define _(bit, name) VNET_BUFFER_F_LOG2_##name = LOG2_VLIB_BUFFER_FLAG_USER(bit),
73 foreach_vnet_buffer_field
78 #define foreach_buffer_opaque_union_subtype \
94 * vnet stack buffer opaque array overlay structure.
95 * The vnet_buffer_opaque_t *must* be the same size as the
96 * vlib_buffer_t "opaque" structure member, 32 bytes.
98 * When adding a union type, please add a stanza to
99 * foreach_buffer_opaque_union_subtype (directly above).
100 * Code in vnet_interface_init(...) verifies the size
101 * of the union, and will announce any deviations in an
102 * impossible-to-miss manner.
106 u32 sw_if_index[VLIB_N_RX_TX];
113 /* IP4/6 buffer opaque. */
116 /* Adjacency from destination IP address lookup [VLIB_TX].
117 Adjacency from source IP address lookup [VLIB_RX].
118 This gets set to ~0 until source lookup is performed. */
119 u32 adj_index[VLIB_N_RX_TX];
125 /* Flow hash value for this packet computed from IP src/dst address
126 protocol and ports. */
134 /* Hint for transport protocols */
139 u32 save_rewrite_length;
158 * data copied from the MPLS header that was popped from the packet
159 * during the look-up.
168 /* ip4-in-ip6 softwire termination, only valid there */
175 /* l2 bridging path, only valid there */
179 u16 bd_index; /* bridge-domain index */
180 u8 l2_len; /* ethernet header length */
181 u8 shg; /* split-horizon group */
182 u16 l2fib_sn; /* l2fib bd/int seq_num */
183 u8 bd_age; /* aging enabled */
186 /* l2tpv3 softwire encap, only valid there */
189 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
202 struct opaque_l2 pad;
211 /* IO - worker thread handoff */
220 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
224 /* interface output features */
240 u32 map_domain_index;
244 u16 frag_offset; //Fragmentation header offset
245 u16 l4_offset; //L4 header overall offset
246 u8 l4_protocol; //The final protocol number
247 } v6; //Used by ip6_map_t only
248 u16 checksum_offset; //L4 checksum overall offset
252 /* IP Fragmentation */
258 u8 flags; //See ip_frag.h
261 /* COP - configurable junk filter(s) */
264 /* Current configuration index. */
265 u32 current_config_index;
271 /* overlay address family */
275 /* Driver rx feature */
278 u32 saved_next_index; /**< saved by drivers for short-cut */
285 u32 connection_index;
289 u16 hdr_offset; /**< offset relative to ip hdr */
290 u16 data_offset; /**< offset relative to ip hdr */
291 u16 data_len; /**< data len */
303 } vnet_buffer_opaque_t;
306 * The opaque field of the vlib_buffer_t is intepreted as a
307 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
309 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
310 STRUCT_SIZE_OF (vlib_buffer_t, opaque),
311 "VNET buffer meta-data too large for vlib_buffer");
313 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
315 /* Full cache line (64 bytes) of additional space */
321 } vnet_buffer_opaque2_t;
325 #endif /* included_vnet_buffer_h */
328 * fd.io coding-style-patch-verification: ON
331 * eval: (c-set-style "gnu")