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>
46 * Flags that are set in the high order bits of ((vlib_buffer*)b)->flags
48 #define foreach_vnet_buffer_field \
49 _( 1, L4_CHECKSUM_COMPUTED, "l4-cksum-computed") \
50 _( 2, L4_CHECKSUM_CORRECT, "l4-cksum-correct") \
51 _( 3, VLAN_2_DEEP, "vlan-2-deep") \
52 _( 4, VLAN_1_DEEP, "vlan-1-deep") \
53 _( 5, SPAN_CLONE, "span-clone") \
54 _( 6, HANDOFF_NEXT_VALID, "handoff-next-valid") \
55 _( 7, LOCALLY_ORIGINATED, "local") \
56 _( 8, IS_IP4, "ip4") \
57 _( 9, IS_IP6, "ip6") \
58 _(10, OFFLOAD_IP_CKSUM, "offload-ip-cksum") \
59 _(11, OFFLOAD_TCP_CKSUM, "offload-tcp-cksum") \
60 _(12, OFFLOAD_UDP_CKSUM, "offload-udp-cksum") \
61 _(13, IS_NATED, "nated") \
62 _(14, L2_HDR_OFFSET_VALID, 0) \
63 _(15, L3_HDR_OFFSET_VALID, 0) \
64 _(16, L4_HDR_OFFSET_VALID, 0)
66 #define VNET_BUFFER_FLAGS_VLAN_BITS \
67 (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
71 #define _(bit, name, v) VNET_BUFFER_F_##name = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
72 foreach_vnet_buffer_field
78 #define _(bit, name, v) VNET_BUFFER_F_LOG2_##name = LOG2_VLIB_BUFFER_FLAG_USER(bit),
79 foreach_vnet_buffer_field
84 * @brief Flags set in ((vnet_buffer(b)->flags
86 #define foreach_vnet_opaque_flag \
87 _( 1, IS_DVR, "DVR-processed")
91 #define _(bit, name, v) VNET_OPAQUE_F_##name = (1 << bit),
92 foreach_vnet_opaque_flag
98 #define _(bit, name, v) VNET_OPAQUE_F_LOG2_##name = bit,
99 foreach_vnet_opaque_flag
104 #define foreach_buffer_opaque_union_subtype \
121 * vnet stack buffer opaque array overlay structure.
122 * The vnet_buffer_opaque_t *must* be the same size as the
123 * vlib_buffer_t "opaque" structure member, 32 bytes.
125 * When adding a union type, please add a stanza to
126 * foreach_buffer_opaque_union_subtype (directly above).
127 * Code in vnet_interface_init(...) verifies the size
128 * of the union, and will announce any deviations in an
129 * impossible-to-miss manner.
133 u32 sw_if_index[VLIB_N_RX_TX];
141 /* IP4/6 buffer opaque. */
144 /* Adjacency from destination IP address lookup [VLIB_TX].
145 Adjacency from source IP address lookup [VLIB_RX].
146 This gets set to ~0 until source lookup is performed. */
147 u32 adj_index[VLIB_N_RX_TX];
153 /* Flow hash value for this packet computed from IP src/dst address
154 protocol and ports. */
162 /* Hint for transport protocols */
167 u32 save_rewrite_length;
189 u16 ip6_frag_hdr_offset;
198 * data copied from the MPLS header that was popped from the packet
199 * during the look-up.
207 * BIER - the nubmer of bytes in the header.
208 * the len field inthe header is not authoritative. It's the
209 * value in the table that counts.
217 /* ip4-in-ip6 softwire termination, only valid there */
224 /* l2 bridging path, only valid there */
228 u16 bd_index; /* bridge-domain index */
229 u8 l2_len; /* ethernet header length */
230 u8 shg; /* split-horizon group */
231 u16 l2fib_sn; /* l2fib bd/int seq_num */
232 u8 bd_age; /* aging enabled */
235 /* l2tpv3 softwire encap, only valid there */
238 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
251 struct opaque_l2 pad;
260 /* IO - worker thread handoff */
269 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
273 /* interface output features */
289 u32 map_domain_index;
293 u16 frag_offset; //Fragmentation header offset
294 u16 l4_offset; //L4 header overall offset
295 u8 l4_protocol; //The final protocol number
296 } v6; //Used by ip6_map_t only
297 u16 checksum_offset; //L4 checksum overall offset
301 /* IP Fragmentation */
304 u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
308 u8 flags; //See ip_frag.h
311 /* COP - configurable junk filter(s) */
314 /* Current configuration index. */
315 u32 current_config_index;
321 /* overlay address family */
325 /* Driver rx feature */
328 u32 saved_next_index; /**< saved by drivers for short-cut */
335 u32 connection_index;
339 u16 hdr_offset; /**< offset relative to ip hdr */
340 u16 data_offset; /**< offset relative to ip hdr */
341 u16 data_len; /**< data len */
348 u32 connection_index;
349 u16 sid; /**< Stream ID */
350 u16 ssn; /**< Stream Sequence Number */
351 u32 tsn; /**< Transmission Sequence Number */
352 u16 hdr_offset; /**< offset relative to ip hdr */
353 u16 data_offset; /**< offset relative to ip hdr */
354 u16 data_len; /**< data len */
366 } vnet_buffer_opaque_t;
369 * The opaque field of the vlib_buffer_t is intepreted as a
370 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
372 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
373 STRUCT_SIZE_OF (vlib_buffer_t, opaque),
374 "VNET buffer meta-data too large for vlib_buffer");
376 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
378 /* Full cache line (64 bytes) of additional space */
383 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
384 /* buffer trajectory tracing */
387 u16 *trajectory_trace;
392 } vnet_buffer_opaque2_t;
394 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
397 * The opaque2 field of the vlib_buffer_t is intepreted as a
398 * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
400 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
401 STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
402 "VNET buffer opaque2 meta-data too large for vlib_buffer");
404 format_function_t format_vnet_buffer;
406 #endif /* included_vnet_buffer_h */
409 * fd.io coding-style-patch-verification: ON
412 * eval: (c-set-style "gnu")