FD.io VPP  v18.10-34-gcce845e
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 #define foreach_vnet_buffer_flag \
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, LOOP_COUNTER_VALID, 0) \
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) \
65  _(17, FLOW_REPORT, "flow-report") \
66  _(18, IS_DVR, "dvr") \
67  _(19, QOS_DATA_VALID, 0)
68 
69 #define VNET_BUFFER_FLAGS_VLAN_BITS \
70  (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
71 
72 enum
73 {
74 #define _(bit, name, v) VNET_BUFFER_F_##name = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
76 #undef _
77 };
78 
79 enum
80 {
81 #define _(bit, name, v) VNET_BUFFER_F_LOG2_##name = LOG2_VLIB_BUFFER_FLAG_USER(bit),
83 #undef _
84 };
85 
86 #define foreach_buffer_opaque_union_subtype \
87 _(ip) \
88 _(l2) \
89 _(l2t) \
90 _(l2_classify) \
91 _(policer) \
92 _(ipsec) \
93 _(map) \
94 _(map_t) \
95 _(ip_frag) \
96 _(mpls) \
97 _(tcp)
98 
99 /*
100  * vnet stack buffer opaque array overlay structure.
101  * The vnet_buffer_opaque_t *must* be the same size as the
102  * vlib_buffer_t "opaque" structure member, 32 bytes.
103  *
104  * When adding a union type, please add a stanza to
105  * foreach_buffer_opaque_union_subtype (directly above).
106  * Code in vnet_interface_init(...) verifies the size
107  * of the union, and will announce any deviations in an
108  * impossible-to-miss manner.
109  */
110 typedef struct
111 {
118 
119  union
120  {
121  /* IP4/6 buffer opaque. */
122  struct
123  {
124  /* Adjacency from destination IP address lookup [VLIB_TX].
125  Adjacency from source IP address lookup [VLIB_RX].
126  This gets set to ~0 until source lookup is performed. */
127  u32 adj_index[VLIB_N_RX_TX];
128 
129  union
130  {
131  struct
132  {
133  /* Flow hash value for this packet computed from IP src/dst address
134  protocol and ports. */
136 
137  union
138  {
139  /* next protocol */
141 
142  /* Hint for transport protocols */
144  };
145 
146  /* Rewrite length */
148 
149  /* MFIB RPF ID */
151  };
152 
153  /* ICMP */
154  struct
155  {
159  } icmp;
160 
161  /* reassembly */
162  union
163  {
164  /* in/out variables */
165  struct
166  {
167  u32 next_index; /* index of next node - ignored if "feature" node */
168  u16 estimated_mtu; /* estimated MTU calculated during reassembly */
169  };
170  /* internal variables used during reassembly */
171  struct
172  {
179  };
180  } reass;
181  };
182 
183  } ip;
184 
185  /*
186  * MPLS:
187  * data copied from the MPLS header that was popped from the packet
188  * during the look-up.
189  */
190  struct
191  {
192  /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
197  /* Rewrite length */
198  u32 save_rewrite_length;
199  /*
200  * BIER - the number of bytes in the header.
201  * the len field in the header is not authoritative. It's the
202  * value in the table that counts.
203  */
204  struct
205  {
207  } bier;
208  } mpls;
209 
210  /* l2 bridging path, only valid there */
211  struct opaque_l2
212  {
214  u16 bd_index; /* bridge-domain index */
215  u8 l2_len; /* ethernet header length */
216  u8 shg; /* split-horizon group */
217  u16 l2fib_sn; /* l2fib bd/int seq_num */
218  u8 bd_age; /* aging enabled */
219  } l2;
220 
221  /* l2tpv3 softwire encap, only valid there */
222  struct
223  {
224  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
227  } l2t;
228 
229  /* L2 classify */
230  struct
231  {
232  struct opaque_l2 pad;
233  union
234  {
237  };
239  } l2_classify;
240 
241  /* vnet policer */
242  struct
243  {
244  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
246  } policer;
247 
248  /* interface output features */
249  struct
250  {
253  } ipsec;
254 
255  /* MAP */
256  struct
257  {
259  } map;
260 
261  /* MAP-T */
262  struct
263  {
265  struct
266  {
267  u32 saddr, daddr;
268  u16 frag_offset; //Fragmentation header offset
269  u16 l4_offset; //L4 header overall offset
270  u8 l4_protocol; //The final protocol number
271  } v6; //Used by ip6_map_t only
272  u16 checksum_offset; //L4 checksum overall offset
273  u16 mtu; //Exit MTU
274  } map_t;
275 
276  /* IP Fragmentation */
277  struct
278  {
279  u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
280  u16 mtu;
281  u8 next_index;
282  u8 flags; //See ip_frag.h
283  } ip_frag;
284 
285  /* COP - configurable junk filter(s) */
286  struct
287  {
288  /* Current configuration index. */
290  } cop;
291 
292  /* LISP */
293  struct
294  {
295  /* overlay address family */
297  } lisp;
298 
299  /* TCP */
300  struct
301  {
306  u16 hdr_offset; /**< offset relative to ip hdr */
307  u16 data_offset; /**< offset relative to ip hdr */
308  u16 data_len; /**< data len */
309  u8 flags;
310  } tcp;
311 
312  /* SCTP */
313  struct
314  {
315  u32 connection_index;
316  u16 sid; /**< Stream ID */
317  u16 ssn; /**< Stream Sequence Number */
318  u32 tsn; /**< Transmission Sequence Number */
319  u16 hdr_offset; /**< offset relative to ip hdr */
320  u16 data_offset; /**< offset relative to ip hdr */
321  u16 data_len; /**< data len */
322  u8 subconn_idx; /**< index of the sub_connection being used */
323  u8 flags;
324  } sctp;
325 
326  /* SNAT */
327  struct
328  {
329  u32 flags;
330  } snat;
331 
332  u32 unused[6];
333  };
335 
336 /*
337  * The opaque field of the vlib_buffer_t is interpreted as a
338  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
339  */
341  STRUCT_SIZE_OF (vlib_buffer_t, opaque),
342  "VNET buffer meta-data too large for vlib_buffer");
343 
344 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
345 
346 /* Full cache line (64 bytes) of additional space */
347 typedef struct
348 {
349  /**
350  * QoS marking data that needs to persist from the recording nodes
351  * (nominally in the ingress path) to the marking node (in the
352  * egress path)
353  */
354  struct
355  {
358  } qos;
359 
361  u8 __unused[1];
362 
363  /* Group Based Policy */
364  struct
365  {
366  u8 __unused;
369  } gbp;
370 
371  union
372  {
373  struct
374  {
375 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
376  /* buffer trajectory tracing */
377  u16 *trajectory_trace;
378 #endif
379  };
380  struct
381  {
382  u64 pad[1];
384  };
385  u32 unused[10];
386  };
388 
389 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
390 
391 /*
392  * The opaque2 field of the vlib_buffer_t is interpreted as a
393  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
394  */
396  STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
397  "VNET buffer opaque2 meta-data too large for vlib_buffer");
398 
400 
401 #endif /* included_vnet_buffer_h */
402 
403 /*
404  * fd.io coding-style-patch-verification: ON
405  *
406  * Local Variables:
407  * eval: (c-set-style "gnu")
408  * End:
409  */
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
u32 current_config_index
Definition: buffer.h:289
unsigned long u64
Definition: types.h:89
u16 data_offset
offset relative to ip hdr
Definition: buffer.h:307
STATIC_ASSERT(sizeof(vnet_buffer_opaque_t)<=STRUCT_SIZE_OF(vlib_buffer_t, opaque),"VNET buffer meta-data too large for vlib_buffer")
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
unsigned char u8
Definition: types.h:56
u32 sw_if_index
Definition: vxlan_gbp.api:39
unsigned int u32
Definition: types.h:88
u32 tsn
Transmission Sequence Number.
Definition: buffer.h:318
format_function_t format_vnet_buffer
Definition: buffer.h:399
unsigned short u16
Definition: types.h:57
u32 flags
Definition: vhost_user.h:115
u16 sid
Stream ID.
Definition: buffer.h:316
u16 ssn
Stream Sequence Number.
Definition: buffer.h:317
#define foreach_vnet_buffer_flag
Flags that are set in the high order bits of ((vlib_buffer*)b)->flags.
Definition: buffer.h:48
u16 hdr_offset
offset relative to ip hdr
Definition: buffer.h:306
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:66
u8 subconn_idx
index of the sub_connection being used
Definition: buffer.h:322
u16 data_len
data len
Definition: buffer.h:308
signed short i16
Definition: types.h:46