FD.io VPP  v21.06-1-gbb7418cf9
Vector Packet Processing
buffer.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * vnet/buffer.h: vnet buffer flags
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #ifndef included_vnet_buffer_h
41 #define included_vnet_buffer_h
42 
43 #include <vlib/vlib.h>
44 
45 /**
46  * Flags that are set in the high order bits of ((vlib_buffer*)b)->flags
47  *
48  */
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)
77 
78 /*
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.
82  */
83 
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)
88 
89 #define VNET_BUFFER_FLAGS_VLAN_BITS \
90  (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
91 
92 enum
93 {
94 #define _(bit, name, s, v) VNET_BUFFER_F_##name = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
96 #undef _
97 };
98 
99 enum
100 {
101 #define _(bit, name, s, v) VNET_BUFFER_F_LOG2_##name = LOG2_VLIB_BUFFER_FLAG_USER(bit),
103 #undef _
104 };
105 
106 /* Make sure that the vnet and vlib bits are disjoint */
108  "VLIB / VNET buffer flags overlap");
109 
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_TCP_CKSUM, "offload-outer-tcp-cksum", 1) \
116  _ (5, OUTER_UDP_CKSUM, "offload-outer-udp-cksum", 1)
117 
118 typedef enum
119 {
120 #define _(bit, name, s, v) VNET_BUFFER_OFFLOAD_F_##name = (1 << bit),
122 #undef _
124 
125 #define foreach_buffer_opaque_union_subtype \
126 _(ip) \
127 _(l2) \
128 _(l2t) \
129 _(l2_classify) \
130 _(policer) \
131 _(ipsec) \
132 _(map) \
133 _(map_t) \
134 _(ip_frag) \
135 _(mpls) \
136 _(tcp)
137 
138 /*
139  * vnet stack buffer opaque array overlay structure.
140  * The vnet_buffer_opaque_t *must* be the same size as the
141  * vlib_buffer_t "opaque" structure member, 32 bytes.
142  *
143  * When adding a union type, please add a stanza to
144  * foreach_buffer_opaque_union_subtype (directly above).
145  * Code in vnet_interface_init(...) verifies the size
146  * of the union, and will announce any deviations in an
147  * impossible-to-miss manner.
148  */
149 typedef struct
150 {
156  /* offload flags */
157  vnet_buffer_oflags_t oflags : 8;
158 
159  union
160  {
161  /* IP4/6 buffer opaque. */
162  struct
163  {
164  /* Adjacency from destination IP address lookup [VLIB_TX].
165  Adjacency from source IP address lookup [VLIB_RX].
166  This gets set to ~0 until source lookup is performed. */
167  u32 adj_index[VLIB_N_RX_TX];
168 
169  union
170  {
171  struct
172  {
173  /* Flow hash value for this packet computed from IP src/dst address
174  protocol and ports. */
176 
177  union
178  {
179  /* next protocol */
181 
182  /* Hint for transport protocols */
184  };
185 
186  /* Rewrite length */
188 
189  /* MFIB RPF ID */
191  };
192 
193  /* ICMP */
194  struct
195  {
199  } icmp;
200 
201  /* reassembly */
202  union
203  {
204  /* group input/output to simplify the code, this way
205  * we can handoff while keeping input variables intact */
206  struct
207  {
208  /* input variables */
209  struct
210  {
211  u32 next_index; /* index of next node - used by custom apps */
212  u32 error_next_index; /* index of next node if error - used by custom apps */
213  };
214  /* handoff variables */
215  struct
216  {
218  };
219  };
220  /* output variables */
221  struct
222  {
223  union
224  {
225  /* shallow virtual reassembly output variables */
226  struct
227  {
228  u16 l4_src_port; /* tcp/udp/icmp src port */
229  u16 l4_dst_port; /* tcp/udp/icmp dst port */
231  u8 save_rewrite_length;
232  u8 ip_proto; /* protocol in ip header */
236  };
237  /* full reassembly output variables */
238  struct
239  {
240  u16 estimated_mtu; /* estimated MTU calculated during reassembly */
241  };
242  };
243  };
244  /* internal variables used during reassembly */
245  struct
246  {
253  };
254  } reass;
255  };
256  } ip;
257 
258  /*
259  * MPLS:
260  * data copied from the MPLS header that was popped from the packet
261  * during the look-up.
262  */
263  struct
264  {
265  /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
270  u8 pyld_proto:3; /* dpo_proto_t */
271  u8 rsvd:5;
272  /* Rewrite length */
273  u8 save_rewrite_length;
274  /* Save the mpls header length including all label stack */
276  /*
277  * BIER - the number of bytes in the header.
278  * the len field in the header is not authoritative. It's the
279  * value in the table that counts.
280  */
281  struct
282  {
284  } bier;
285  } mpls;
286 
287  /* l2 bridging path, only valid there */
288  struct opaque_l2
289  {
291  u16 bd_index; /* bridge-domain index */
292  u16 l2fib_sn; /* l2fib bd/int seq_num */
293  u8 l2_len; /* ethernet header length */
294  u8 shg; /* split-horizon group */
295  u8 bd_age; /* aging enabled */
296  } l2;
297 
298  /* l2tpv3 softwire encap, only valid there */
299  struct
300  {
301  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
304  } l2t;
305 
306  /* L2 classify */
307  struct
308  {
309  struct opaque_l2 pad;
310  union
311  {
314  };
316  } l2_classify;
317 
318  /* vnet policer */
319  struct
320  {
321  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
323  } policer;
324 
325  /* interface output features */
326  struct
327  {
328  /* don't overlap the adjcencies nor flow-hash */
329  u32 __pad[3];
333  } ipsec;
334 
335  /* MAP */
336  struct
337  {
339  } map;
340 
341  /* MAP-T */
342  struct
343  {
345  struct
346  {
347  u32 saddr, daddr;
348  u16 frag_offset; //Fragmentation header offset
349  u16 l4_offset; //L4 header overall offset
350  u8 l4_protocol; //The final protocol number
351  } v6; //Used by ip6_map_t only
352  u16 checksum_offset; //L4 checksum overall offset
353  u16 mtu; //Exit MTU
354  } map_t;
355 
356  /* IP Fragmentation */
357  struct
358  {
359  u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
360  u16 mtu;
361  u8 next_index;
362  u8 flags; //See ip_frag.h
363  } ip_frag;
364 
365  /* COP - configurable junk filter(s) */
366  struct
367  {
368  /* Current configuration index. */
370  } cop;
371 
372  /* LISP */
373  struct
374  {
375  /* overlay address family */
377  } lisp;
378 
379  /* TCP */
380  struct
381  {
383  union
384  {
387  };
390  u16 hdr_offset; /**< offset relative to ip hdr */
391  u16 data_offset; /**< offset relative to ip hdr */
392  u16 data_len; /**< data len */
393  u8 flags;
394  } tcp;
395 
396  /* SNAT */
397  struct
398  {
401  } snat;
402 
403  u32 unused[6];
404  };
406 
407 #define VNET_REWRITE_TOTAL_BYTES (VLIB_BUFFER_PRE_DATA_SIZE)
408 
409 STATIC_ASSERT (STRUCT_SIZE_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
411  ip.reass.save_rewrite_length)
413  ip.reass.save_rewrite_length) ==
416  mpls.save_rewrite_length) == 1
417  && VNET_REWRITE_TOTAL_BYTES < UINT8_MAX,
418  "save_rewrite_length member must be able to hold the max value of rewrite length");
419 
422  ip.reass.save_rewrite_length)
424  mpls.save_rewrite_length) ==
426  ip.reass.save_rewrite_length),
427  "save_rewrite_length must be aligned so that reass doesn't overwrite it");
428 
429 /*
430  * The opaque field of the vlib_buffer_t is interpreted as a
431  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
432  */
434  STRUCT_SIZE_OF (vlib_buffer_t, opaque),
435  "VNET buffer meta-data too large for vlib_buffer");
436 
437 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
438 
439 /* Full cache line (64 bytes) of additional space */
440 typedef struct
441 {
442  /**
443  * QoS marking data that needs to persist from the recording nodes
444  * (nominally in the ingress path) to the marking node (in the
445  * egress path)
446  */
447  struct
448  {
451  } qos;
452 
454  u8 __unused[1];
455 
456  /* Group Based Policy */
457  struct
458  {
459  u8 __unused;
462  } gbp;
463 
464  /**
465  * The L4 payload size set on input on GSO enabled interfaces
466  * when we receive a GSO packet (a chain of buffers with the first one
467  * having GSO bit set), and needs to persist all the way to the interface-output,
468  * in case the egress interface is not GSO-enabled - then we need to perform
469  * the segmentation, and use this value to cut the payload appropriately.
470  */
471  struct
472  {
474  /* size of L4 prototol header */
476  };
477 
478  struct
479  {
481  union
482  {
485  };
486  } nat;
487 
488  union
489  {
490  struct
491  {
492  u64 pad[1];
494  };
495  u32 unused[8];
496  };
498 
499 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
500 
501 /*
502  * The opaque2 field of the vlib_buffer_t is interpreted as a
503  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
504  */
506  STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
507  "VNET buffer opaque2 meta-data too large for vlib_buffer");
508 
509 #define gso_mtu_sz(b) (vnet_buffer2(b)->gso_size + \
510  vnet_buffer2(b)->gso_l4_hdr_sz + \
511  vnet_buffer(b)->l4_hdr_offset - \
512  vnet_buffer (b)->l3_hdr_offset)
513 
514 
520 
522 vnet_buffer_offload_flags_set (vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
523 {
524  if (b->flags & VNET_BUFFER_F_OFFLOAD)
525  {
526  /* add a flag to existing offload */
527  vnet_buffer (b)->oflags |= oflags;
528  }
529  else
530  {
531  /* no offload yet: reset offload flags to new value */
532  vnet_buffer (b)->oflags = oflags;
533  b->flags |= VNET_BUFFER_F_OFFLOAD;
534  }
535 }
536 
538 vnet_buffer_offload_flags_clear (vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
539 {
540  vnet_buffer (b)->oflags &= ~oflags;
541  if (0 == vnet_buffer (b)->oflags)
542  b->flags &= ~VNET_BUFFER_F_OFFLOAD;
543 }
544 
545 #endif /* included_vnet_buffer_h */
546 
547 /*
548  * fd.io coding-style-patch-verification: ON
549  *
550  * Local Variables:
551  * eval: (c-set-style "gnu")
552  * End:
553  */
vnet_buffer_oflags_t
Definition: buffer.h:118
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:133
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
#define VLIB_BUFFER_FLAGS_ALL
Definition: buffer.h:99
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
u32 current_config_index
Definition: buffer.h:369
unsigned long u64
Definition: types.h:89
u16 data_offset
offset relative to ip hdr
Definition: buffer.h:391
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:73
#define foreach_vnet_buffer_offload_flag
Definition: buffer.h:110
unsigned char u8
Definition: types.h:56
vlib_buffer_t ** b
#define VNET_BUFFER_FLAGS_ALL_AVAIL
Definition: buffer.h:84
unsigned int u32
Definition: types.h:88
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
#define static_always_inline
Definition: clib.h:112
format_function_t format_vnet_buffer_opaque2
Definition: buffer.h:519
format_function_t format_vnet_buffer_flags
Definition: buffer.h:517
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
format_function_t format_vnet_buffer_opaque
Definition: buffer.h:518
format_function_t format_vnet_buffer
Definition: buffer.h:515
icmp
Definition: map.api:387
unsigned short u16
Definition: types.h:57
format_function_t format_vnet_buffer_offload
Definition: buffer.h:516
#define VNET_REWRITE_TOTAL_BYTES
Definition: buffer.h:407
counters map
Definition: map.api:356
u32 cached_dst_nat_session_index
Definition: buffer.h:484
nat44_ei_hairpin_src_next_t next_index
vl_api_address_t ip
Definition: l2.api:558
VLIB buffer representation.
Definition: buffer.h:111
#define foreach_vnet_buffer_flag
Flags that are set in the high order bits of ((vlib_buffer*)b)->flags.
Definition: buffer.h:49
u16 hdr_offset
offset relative to ip hdr
Definition: buffer.h:390
static_always_inline void vnet_buffer_offload_flags_clear(vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
Definition: buffer.h:538
#define vnet_buffer(b)
Definition: buffer.h:437
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:75
u32 required_thread_index
Definition: buffer.h:400
static_always_inline void vnet_buffer_offload_flags_set(vlib_buffer_t *b, vnet_buffer_oflags_t oflags)
Definition: buffer.h:522
u16 data_len
data len
Definition: buffer.h:392
vnet_buffer_oflags_t oflags
Definition: buffer.h:157
STATIC_ASSERT(((VNET_BUFFER_FLAGS_ALL_AVAIL &VLIB_BUFFER_FLAGS_ALL)==0), "VLIB / VNET buffer flags overlap")
signed short i16
Definition: types.h:46