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, "offload", 0) \
60 _ (11, IS_NATED, "natted", 1) \
61 _ (12, L2_HDR_OFFSET_VALID, "l2_hdr_offset_valid", 0) \
62 _ (13, L3_HDR_OFFSET_VALID, "l3_hdr_offset_valid", 0) \
63 _ (14, L4_HDR_OFFSET_VALID, "l4_hdr_offset_valid", 0) \
64 _ (15, FLOW_REPORT, "flow-report", 1) \
65 _ (16, IS_DVR, "dvr", 1) \
66 _ (17, QOS_DATA_VALID, "qos-data-valid", 0) \
67 _ (18, GSO, "gso", 0) \
68 _ (19, AVAIL1, "avail1", 1) \
69 _ (20, AVAIL2, "avail2", 1) \
70 _ (21, AVAIL3, "avail3", 1) \
71 _ (22, AVAIL4, "avail4", 1) \
72 _ (23, AVAIL5, "avail5", 1) \
73 _ (24, AVAIL6, "avail6", 1) \
74 _ (25, AVAIL7, "avail7", 1) \
75 _ (26, AVAIL8, "avail8", 1) \
76 _ (27, AVAIL9, "avail9", 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 | \
87 VNET_BUFFER_F_AVAIL7 | VNET_BUFFER_F_AVAIL8 | VNET_BUFFER_F_AVAIL9)
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_vnet_buffer_offload_flag \
111 _ (0, IP_CKSUM, "offload-ip-cksum", 1) \
112 _ (1, TCP_CKSUM, "offload-tcp-cksum", 1) \
113 _ (2, UDP_CKSUM, "offload-udp-cksum", 1) \
114 _ (3, OUTER_IP_CKSUM, "offload-outer-ip-cksum", 1) \
115 _ (4, OUTER_UDP_CKSUM, "offload-outer-udp-cksum", 1) \
116 _ (5, TNL_VXLAN, "offload-vxlan-tunnel", 1) \
117 _ (6, TNL_IPIP, "offload-ipip-tunnel", 1)
121 #define _(bit, name, s, v) VNET_BUFFER_OFFLOAD_F_##name = (1 << bit),
122 foreach_vnet_buffer_offload_flag
124 } vnet_buffer_oflags_t;
126 #define VNET_BUFFER_OFFLOAD_F_TNL_MASK \
127 (VNET_BUFFER_OFFLOAD_F_TNL_VXLAN | VNET_BUFFER_OFFLOAD_F_TNL_IPIP)
129 #define foreach_buffer_opaque_union_subtype \
143 * vnet stack buffer opaque array overlay structure.
144 * The vnet_buffer_opaque_t *must* be the same size as the
145 * vlib_buffer_t "opaque" structure member, 32 bytes.
147 * When adding a union type, please add a stanza to
148 * foreach_buffer_opaque_union_subtype (directly above).
149 * Code in vnet_interface_init(...) verifies the size
150 * of the union, and will announce any deviations in an
151 * impossible-to-miss manner.
155 u32 sw_if_index[VLIB_N_RX_TX];
159 u8 feature_arc_index;
161 vnet_buffer_oflags_t oflags : 8;
165 /* IP4/6 buffer opaque. */
168 /* Adjacency from destination IP address lookup [VLIB_TX].
169 Adjacency from source IP address lookup [VLIB_RX].
170 This gets set to ~0 until source lookup is performed. */
171 u32 adj_index[VLIB_N_RX_TX];
177 /* Flow hash value for this packet computed from IP src/dst address
178 protocol and ports. */
186 /* Hint for transport protocols */
191 u8 save_rewrite_length;
208 /* group input/output to simplify the code, this way
209 * we can handoff while keeping input variables intact */
212 /* input variables */
215 u32 next_index; /* index of next node - used by custom apps */
216 u32 error_next_index; /* index of next node if error - used by custom apps */
218 /* handoff variables */
221 u16 owner_thread_index;
224 /* output variables */
229 /* shallow virtual reassembly output variables */
232 u16 l4_src_port; /* tcp/udp/icmp src port */
233 u16 l4_dst_port; /* tcp/udp/icmp dst port */
235 u8 save_rewrite_length;
236 u8 ip_proto; /* protocol in ip header */
237 u8 icmp_type_or_tcp_flags;
238 u8 is_non_first_fragment;
241 /* full reassembly output variables */
244 u16 estimated_mtu; /* estimated MTU calculated during reassembly */
248 /* internal variables used during reassembly */
256 u16 ip6_frag_hdr_offset;
264 * data copied from the MPLS header that was popped from the packet
265 * during the look-up.
269 /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
270 u32 pad[VLIB_N_RX_TX + 1];
274 u8 pyld_proto:3; /* dpo_proto_t */
277 u8 save_rewrite_length;
278 /* Save the mpls header length including all label stack */
281 * BIER - the number of bytes in the header.
282 * the len field in the header is not authoritative. It's the
283 * value in the table that counts.
291 /* l2 bridging path, only valid there */
295 u16 bd_index; /* bridge-domain index */
296 u16 l2fib_sn; /* l2fib bd/int seq_num */
297 u8 l2_len; /* ethernet header length */
298 u8 shg; /* split-horizon group */
299 u8 bd_age; /* aging enabled */
302 /* l2tpv3 softwire encap, only valid there */
305 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
313 struct opaque_l2 pad;
325 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
329 /* interface output features */
332 /* don't overlap the adjcencies nor flow-hash */
348 u32 map_domain_index;
352 u16 frag_offset; //Fragmentation header offset
353 u16 l4_offset; //L4 header overall offset
354 u8 l4_protocol; //The final protocol number
355 } v6; //Used by ip6_map_t only
356 u16 checksum_offset; //L4 checksum overall offset
360 /* IP Fragmentation */
363 u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
366 u8 flags; //See ip_frag.h
369 /* COP - configurable junk filter(s) */
372 /* Current configuration index. */
373 u32 current_config_index;
379 /* overlay address family */
386 u32 connection_index;
390 u32 next_node_opaque;
394 u16 hdr_offset; /**< offset relative to ip hdr */
395 u16 data_offset; /**< offset relative to ip hdr */
396 u16 data_len; /**< data len */
404 u32 required_thread_index;
409 } vnet_buffer_opaque_t;
411 #define VNET_REWRITE_TOTAL_BYTES (VLIB_BUFFER_PRE_DATA_SIZE)
413 STATIC_ASSERT (STRUCT_SIZE_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
414 == STRUCT_SIZE_OF (vnet_buffer_opaque_t,
415 ip.reass.save_rewrite_length)
416 && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
417 ip.reass.save_rewrite_length) ==
418 STRUCT_SIZE_OF (vnet_buffer_opaque_t, mpls.save_rewrite_length)
419 && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
420 mpls.save_rewrite_length) == 1
421 && VNET_REWRITE_TOTAL_BYTES < UINT8_MAX,
422 "save_rewrite_length member must be able to hold the max value of rewrite length");
424 STATIC_ASSERT (STRUCT_OFFSET_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
425 == STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
426 ip.reass.save_rewrite_length)
427 && STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
428 mpls.save_rewrite_length) ==
429 STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
430 ip.reass.save_rewrite_length),
431 "save_rewrite_length must be aligned so that reass doesn't overwrite it");
434 * The opaque field of the vlib_buffer_t is interpreted as a
435 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
437 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
438 STRUCT_SIZE_OF (vlib_buffer_t, opaque),
439 "VNET buffer meta-data too large for vlib_buffer");
441 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
443 /* Full cache line (64 bytes) of additional space */
447 * QoS marking data that needs to persist from the recording nodes
448 * (nominally in the ingress path) to the marking node (in the
460 /* Group Based Policy */
469 * The L4 payload size set on input on GSO enabled interfaces
470 * when we receive a GSO packet (a chain of buffers with the first one
471 * having GSO bit set), and needs to persist all the way to the interface-output,
472 * in case the egress interface is not GSO-enabled - then we need to perform
473 * the segmentation, and use this value to cut the payload appropriately.
478 /* size of L4 prototol header */
480 i16 outer_l3_hdr_offset;
481 i16 outer_l4_hdr_offset;
489 u32 cached_session_index;
490 u32 cached_dst_nat_session_index;
499 u64 pg_replay_timestamp;
503 } vnet_buffer_opaque2_t;
505 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
508 * The opaque2 field of the vlib_buffer_t is interpreted as a
509 * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
511 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
512 STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
513 "VNET buffer opaque2 meta-data too large for vlib_buffer");
515 #define gso_mtu_sz(b) (vnet_buffer2(b)->gso_size + \
516 vnet_buffer2(b)->gso_l4_hdr_sz + \
517 vnet_buffer(b)->l4_hdr_offset - \
518 vnet_buffer (b)->l3_hdr_offset)
520 format_function_t format_vnet_buffer_no_chain;
521 format_function_t format_vnet_buffer;
522 format_function_t format_vnet_buffer_offload;
523 format_function_t format_vnet_buffer_flags;
524 format_function_t format_vnet_buffer_opaque;
525 format_function_t format_vnet_buffer_opaque2;
527 static_always_inline void
528 vnet_buffer_offload_flags_set (vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
530 if (b->flags & VNET_BUFFER_F_OFFLOAD)
532 /* add a flag to existing offload */
533 vnet_buffer (b)->oflags |= oflags;
537 /* no offload yet: reset offload flags to new value */
538 vnet_buffer (b)->oflags = oflags;
539 b->flags |= VNET_BUFFER_F_OFFLOAD;
543 static_always_inline void
544 vnet_buffer_offload_flags_clear (vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
546 vnet_buffer (b)->oflags &= ~oflags;
547 if (0 == vnet_buffer (b)->oflags)
548 b->flags &= ~VNET_BUFFER_F_OFFLOAD;
551 #endif /* included_vnet_buffer_h */
554 * fd.io coding-style-patch-verification: ON
557 * eval: (c-set-style "gnu")