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
49 #define foreach_vnet_buffer_flag \
50 _( 1, L4_CHECKSUM_COMPUTED, "l4-cksum-computed", 1) \
51 _( 2, L4_CHECKSUM_CORRECT, "l4-cksum-correct", 1) \
52 _( 3, VLAN_2_DEEP, "vlan-2-deep", 1) \
53 _( 4, VLAN_1_DEEP, "vlan-1-deep", 1) \
54 _( 5, SPAN_CLONE, "span-clone", 1) \
55 _( 6, LOOP_COUNTER_VALID, "loop-counter-valid", 0) \
56 _( 7, LOCALLY_ORIGINATED, "local", 1) \
57 _( 8, IS_IP4, "ip4", 1) \
58 _( 9, IS_IP6, "ip6", 1) \
59 _(10, OFFLOAD_IP_CKSUM, "offload-ip-cksum", 1) \
60 _(11, OFFLOAD_TCP_CKSUM, "offload-tcp-cksum", 1) \
61 _(12, OFFLOAD_UDP_CKSUM, "offload-udp-cksum", 1) \
62 _(13, IS_NATED, "natted", 1) \
63 _(14, L2_HDR_OFFSET_VALID, "l2_hdr_offset_valid", 0) \
64 _(15, L3_HDR_OFFSET_VALID, "l3_hdr_offset_valid", 0) \
65 _(16, L4_HDR_OFFSET_VALID, "l4_hdr_offset_valid", 0) \
66 _(17, FLOW_REPORT, "flow-report", 1) \
67 _(18, IS_DVR, "dvr", 1) \
68 _(19, QOS_DATA_VALID, "qos-data-valid", 0) \
69 _(20, GSO, "gso", 0) \
70 _(21, AVAIL1, "avail1", 1) \
71 _(22, AVAIL2, "avail2", 1) \
72 _(23, AVAIL3, "avail3", 1) \
73 _(24, AVAIL4, "avail4", 1) \
74 _(25, AVAIL5, "avail5", 1) \
75 _(26, AVAIL6, "avail6", 1) \
76 _(27, AVAIL7, "avail7", 1)
79 * Please allocate the FIRST available bit, redefine
80 * AVAIL 1 ... AVAILn-1, and remove AVAILn. Please maintain the
81 * VNET_BUFFER_FLAGS_ALL_AVAIL definition.
84 #define VNET_BUFFER_FLAGS_ALL_AVAIL \
85 (VNET_BUFFER_F_AVAIL1 | VNET_BUFFER_F_AVAIL2 | VNET_BUFFER_F_AVAIL3 | \
86 VNET_BUFFER_F_AVAIL4 | VNET_BUFFER_F_AVAIL5 | VNET_BUFFER_F_AVAIL6 | \
89 #define VNET_BUFFER_FLAGS_VLAN_BITS \
90 (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
94 #define _(bit, name, s, v) VNET_BUFFER_F_##name = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
95 foreach_vnet_buffer_flag
101 #define _(bit, name, s, v) VNET_BUFFER_F_LOG2_##name = LOG2_VLIB_BUFFER_FLAG_USER(bit),
102 foreach_vnet_buffer_flag
106 /* Make sure that the vnet and vlib bits are disjoint */
107 STATIC_ASSERT (((VNET_BUFFER_FLAGS_ALL_AVAIL & VLIB_BUFFER_FLAGS_ALL) == 0),
108 "VLIB / VNET buffer flags overlap");
110 #define foreach_buffer_opaque_union_subtype \
124 * vnet stack buffer opaque array overlay structure.
125 * The vnet_buffer_opaque_t *must* be the same size as the
126 * vlib_buffer_t "opaque" structure member, 32 bytes.
128 * When adding a union type, please add a stanza to
129 * foreach_buffer_opaque_union_subtype (directly above).
130 * Code in vnet_interface_init(...) verifies the size
131 * of the union, and will announce any deviations in an
132 * impossible-to-miss manner.
136 u32 sw_if_index[VLIB_N_RX_TX];
140 u8 feature_arc_index;
145 /* IP4/6 buffer opaque. */
148 /* Adjacency from destination IP address lookup [VLIB_TX].
149 Adjacency from source IP address lookup [VLIB_RX].
150 This gets set to ~0 until source lookup is performed. */
151 u32 adj_index[VLIB_N_RX_TX];
157 /* Flow hash value for this packet computed from IP src/dst address
158 protocol and ports. */
166 /* Hint for transport protocols */
171 u8 save_rewrite_length;
188 /* group input/output to simplify the code, this way
189 * we can handoff while keeping input variables intact */
192 /* input variables */
195 u32 next_index; /* index of next node - used by custom apps */
196 u32 error_next_index; /* index of next node if error - used by custom apps */
198 /* handoff variables */
201 u16 owner_thread_index;
204 /* output variables */
209 /* shallow virtual reassembly output variables */
212 u16 l4_src_port; /* tcp/udp/icmp src port */
213 u16 l4_dst_port; /* tcp/udp/icmp dst port */
215 u8 save_rewrite_length;
216 u8 ip_proto; /* protocol in ip header */
217 u8 icmp_type_or_tcp_flags;
218 u8 is_non_first_fragment;
221 /* full reassembly output variables */
224 u16 estimated_mtu; /* estimated MTU calculated during reassembly */
228 /* internal variables used during reassembly */
236 u16 ip6_frag_hdr_offset;
244 * data copied from the MPLS header that was popped from the packet
245 * during the look-up.
249 /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
250 u32 pad[VLIB_N_RX_TX + 1];
254 u8 pyld_proto:3; /* dpo_proto_t */
257 u8 save_rewrite_length;
258 /* Save the mpls header length including all label stack */
261 * BIER - the number of bytes in the header.
262 * the len field in the header is not authoritative. It's the
263 * value in the table that counts.
271 /* l2 bridging path, only valid there */
275 u16 bd_index; /* bridge-domain index */
276 u16 l2fib_sn; /* l2fib bd/int seq_num */
277 u8 l2_len; /* ethernet header length */
278 u8 shg; /* split-horizon group */
279 u8 bd_age; /* aging enabled */
282 /* l2tpv3 softwire encap, only valid there */
285 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
293 struct opaque_l2 pad;
305 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
309 /* interface output features */
325 u32 map_domain_index;
329 u16 frag_offset; //Fragmentation header offset
330 u16 l4_offset; //L4 header overall offset
331 u8 l4_protocol; //The final protocol number
332 } v6; //Used by ip6_map_t only
333 u16 checksum_offset; //L4 checksum overall offset
337 /* IP Fragmentation */
340 u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
343 u8 flags; //See ip_frag.h
346 /* COP - configurable junk filter(s) */
349 /* Current configuration index. */
350 u32 current_config_index;
356 /* overlay address family */
363 u32 connection_index;
367 u32 next_node_opaque;
371 u16 hdr_offset; /**< offset relative to ip hdr */
372 u16 data_offset; /**< offset relative to ip hdr */
373 u16 data_len; /**< data len */
385 } vnet_buffer_opaque_t;
387 #define VNET_REWRITE_TOTAL_BYTES (VLIB_BUFFER_PRE_DATA_SIZE)
389 STATIC_ASSERT (STRUCT_SIZE_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
390 == STRUCT_SIZE_OF (vnet_buffer_opaque_t,
391 ip.reass.save_rewrite_length)
392 && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
393 ip.reass.save_rewrite_length) ==
394 STRUCT_SIZE_OF (vnet_buffer_opaque_t, mpls.save_rewrite_length)
395 && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
396 mpls.save_rewrite_length) == 1
397 && VNET_REWRITE_TOTAL_BYTES < UINT8_MAX,
398 "save_rewrite_length member must be able to hold the max value of rewrite length");
400 STATIC_ASSERT (STRUCT_OFFSET_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
401 == STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
402 ip.reass.save_rewrite_length)
403 && STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
404 mpls.save_rewrite_length) ==
405 STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
406 ip.reass.save_rewrite_length),
407 "save_rewrite_length must be aligned so that reass doesn't overwrite it");
410 * The opaque field of the vlib_buffer_t is interpreted as a
411 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
413 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
414 STRUCT_SIZE_OF (vlib_buffer_t, opaque),
415 "VNET buffer meta-data too large for vlib_buffer");
417 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
419 /* Full cache line (64 bytes) of additional space */
423 * QoS marking data that needs to persist from the recording nodes
424 * (nominally in the ingress path) to the marking node (in the
436 /* Group Based Policy */
445 * The L4 payload size set on input on GSO enabled interfaces
446 * when we receive a GSO packet (a chain of buffers with the first one
447 * having GSO bit set), and needs to persist all the way to the interface-output,
448 * in case the egress interface is not GSO-enabled - then we need to perform
449 * the segmentation, and use this value to cut the payload appropriately.
452 /* size of L4 prototol header */
455 /* The union below has a u64 alignment, so this space is unused */
461 u32 ed_out2in_nat_session_index;
468 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
469 /* buffer trajectory tracing */
470 u16 *trajectory_trace;
476 u64 pg_replay_timestamp;
480 } vnet_buffer_opaque2_t;
482 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
485 * The opaque2 field of the vlib_buffer_t is interpreted as a
486 * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
488 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
489 STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
490 "VNET buffer opaque2 meta-data too large for vlib_buffer");
492 #define gso_mtu_sz(b) (vnet_buffer2(b)->gso_size + \
493 vnet_buffer2(b)->gso_l4_hdr_sz + \
494 vnet_buffer(b)->l4_hdr_offset - \
495 vnet_buffer (b)->l3_hdr_offset)
498 format_function_t format_vnet_buffer;
500 #endif /* included_vnet_buffer_h */
503 * fd.io coding-style-patch-verification: ON
506 * eval: (c-set-style "gnu")