FD.io VPP  v21.01.1
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_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)
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)
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_buffer_opaque_union_subtype \
111 _(ip) \
112 _(l2) \
113 _(l2t) \
114 _(l2_classify) \
115 _(policer) \
116 _(ipsec) \
117 _(map) \
118 _(map_t) \
119 _(ip_frag) \
120 _(mpls) \
121 _(tcp)
122 
123 /*
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.
127  *
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.
133  */
134 typedef struct
135 {
142 
143  union
144  {
145  /* IP4/6 buffer opaque. */
146  struct
147  {
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];
152 
153  union
154  {
155  struct
156  {
157  /* Flow hash value for this packet computed from IP src/dst address
158  protocol and ports. */
160 
161  union
162  {
163  /* next protocol */
165 
166  /* Hint for transport protocols */
168  };
169 
170  /* Rewrite length */
172 
173  /* MFIB RPF ID */
175  };
176 
177  /* ICMP */
178  struct
179  {
183  } icmp;
184 
185  /* reassembly */
186  union
187  {
188  /* group input/output to simplify the code, this way
189  * we can handoff while keeping input variables intact */
190  struct
191  {
192  /* input variables */
193  struct
194  {
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 */
197  };
198  /* handoff variables */
199  struct
200  {
202  };
203  };
204  /* output variables */
205  struct
206  {
207  union
208  {
209  /* shallow virtual reassembly output variables */
210  struct
211  {
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 */
220  };
221  /* full reassembly output variables */
222  struct
223  {
224  u16 estimated_mtu; /* estimated MTU calculated during reassembly */
225  };
226  };
227  };
228  /* internal variables used during reassembly */
229  struct
230  {
237  };
238  } reass;
239  };
240  } ip;
241 
242  /*
243  * MPLS:
244  * data copied from the MPLS header that was popped from the packet
245  * during the look-up.
246  */
247  struct
248  {
249  /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
254  u8 pyld_proto:3; /* dpo_proto_t */
255  u8 rsvd:5;
256  /* Rewrite length */
257  u8 save_rewrite_length;
258  /* Save the mpls header length including all label stack */
260  /*
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.
264  */
265  struct
266  {
268  } bier;
269  } mpls;
270 
271  /* l2 bridging path, only valid there */
272  struct opaque_l2
273  {
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 */
280  } l2;
281 
282  /* l2tpv3 softwire encap, only valid there */
283  struct
284  {
285  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
288  } l2t;
289 
290  /* L2 classify */
291  struct
292  {
293  struct opaque_l2 pad;
294  union
295  {
298  };
300  } l2_classify;
301 
302  /* vnet policer */
303  struct
304  {
305  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
307  } policer;
308 
309  /* interface output features */
310  struct
311  {
314  } ipsec;
315 
316  /* MAP */
317  struct
318  {
320  } map;
321 
322  /* MAP-T */
323  struct
324  {
326  struct
327  {
328  u32 saddr, daddr;
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
334  u16 mtu; //Exit MTU
335  } map_t;
336 
337  /* IP Fragmentation */
338  struct
339  {
340  u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
341  u16 mtu;
342  u8 next_index;
343  u8 flags; //See ip_frag.h
344  } ip_frag;
345 
346  /* COP - configurable junk filter(s) */
347  struct
348  {
349  /* Current configuration index. */
351  } cop;
352 
353  /* LISP */
354  struct
355  {
356  /* overlay address family */
358  } lisp;
359 
360  /* TCP */
361  struct
362  {
364  union
365  {
368  };
371  u16 hdr_offset; /**< offset relative to ip hdr */
372  u16 data_offset; /**< offset relative to ip hdr */
373  u16 data_len; /**< data len */
374  u8 flags;
375  } tcp;
376 
377  /* SNAT */
378  struct
379  {
381  } snat;
382 
383  u32 unused[6];
384  };
386 
387 #define VNET_REWRITE_TOTAL_BYTES (VLIB_BUFFER_PRE_DATA_SIZE)
388 
389 STATIC_ASSERT (STRUCT_SIZE_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
391  ip.reass.save_rewrite_length)
393  ip.reass.save_rewrite_length) ==
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");
399 
402  ip.reass.save_rewrite_length)
404  mpls.save_rewrite_length) ==
406  ip.reass.save_rewrite_length),
407  "save_rewrite_length must be aligned so that reass doesn't overwrite it");
408 
409 /*
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.
412  */
414  STRUCT_SIZE_OF (vlib_buffer_t, opaque),
415  "VNET buffer meta-data too large for vlib_buffer");
416 
417 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
418 
419 /* Full cache line (64 bytes) of additional space */
420 typedef struct
421 {
422  /**
423  * QoS marking data that needs to persist from the recording nodes
424  * (nominally in the ingress path) to the marking node (in the
425  * egress path)
426  */
427  struct
428  {
431  } qos;
432 
434  u8 __unused[1];
435 
436  /* Group Based Policy */
437  struct
438  {
439  u8 __unused;
442  } gbp;
443 
444  /**
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.
450  */
452  /* size of L4 prototol header */
454 
455  struct
456  {
461  } nat;
462 
463  union
464  {
465  struct
466  {
467 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
468  /* buffer trajectory tracing */
469  u16 *trajectory_trace;
470 #endif
471  };
472  struct
473  {
474  u64 pad[1];
476  };
477  u32 unused[8];
478  };
480 
481 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
482 
483 /*
484  * The opaque2 field of the vlib_buffer_t is interpreted as a
485  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
486  */
488  STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
489  "VNET buffer opaque2 meta-data too large for vlib_buffer");
490 
491 #define gso_mtu_sz(b) (vnet_buffer2(b)->gso_size + \
492  vnet_buffer2(b)->gso_l4_hdr_sz + \
493  vnet_buffer(b)->l4_hdr_offset - \
494  vnet_buffer (b)->l3_hdr_offset)
495 
496 
498 
499 #endif /* included_vnet_buffer_h */
500 
501 /*
502  * fd.io coding-style-patch-verification: ON
503  *
504  * Local Variables:
505  * eval: (c-set-style "gnu")
506  * End:
507  */
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:350
unsigned long u64
Definition: types.h:89
u16 data_offset
offset relative to ip hdr
Definition: buffer.h:372
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:70
unsigned char u8
Definition: types.h:56
#define VNET_BUFFER_FLAGS_ALL_AVAIL
Definition: buffer.h:84
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u16 gso_size
The L4 payload size set on input on GSO enabled interfaces when we receive a GSO packet (a chain of b...
Definition: buffer.h:451
unsigned int u32
Definition: types.h:88
u32 ed_out2in_nat_session_index
Definition: buffer.h:460
format_function_t format_vnet_buffer
Definition: buffer.h:497
icmp
Definition: map.api:387
unsigned short u16
Definition: types.h:57
#define VNET_REWRITE_TOTAL_BYTES
Definition: buffer.h:387
counters map
Definition: map.api:356
vl_api_address_t ip
Definition: l2.api:501
VLIB buffer representation.
Definition: buffer.h:102
#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:371
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:72
u16 data_len
data len
Definition: buffer.h:373
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
STATIC_ASSERT(((VNET_BUFFER_FLAGS_ALL_AVAIL &VLIB_BUFFER_FLAGS_ALL)==0), "VLIB / VNET buffer flags overlap")
signed short i16
Definition: types.h:46