FD.io VPP  v18.07-rc0-415-g6c78436
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, HANDOFF_NEXT_VALID, "handoff-next-valid") \
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 _(handoff) \
92 _(policer) \
93 _(ipsec) \
94 _(map) \
95 _(map_t) \
96 _(ip_frag) \
97 _(mpls) \
98 _(tcp)
99 
100 /*
101  * vnet stack buffer opaque array overlay structure.
102  * The vnet_buffer_opaque_t *must* be the same size as the
103  * vlib_buffer_t "opaque" structure member, 32 bytes.
104  *
105  * When adding a union type, please add a stanza to
106  * foreach_buffer_opaque_union_subtype (directly above).
107  * Code in vnet_interface_init(...) verifies the size
108  * of the union, and will announce any deviations in an
109  * impossible-to-miss manner.
110  */
111 typedef struct
112 {
113  u32 sw_if_index[VLIB_N_RX_TX];
119 
120  union
121  {
122  /* IP4/6 buffer opaque. */
123  struct
124  {
125  /* Adjacency from destination IP address lookup [VLIB_TX].
126  Adjacency from source IP address lookup [VLIB_RX].
127  This gets set to ~0 until source lookup is performed. */
128  u32 adj_index[VLIB_N_RX_TX];
129 
130  union
131  {
132  struct
133  {
134  /* Flow hash value for this packet computed from IP src/dst address
135  protocol and ports. */
137 
138  union
139  {
140  /* next protocol */
142 
143  /* Hint for transport protocols */
145  };
146 
147  /* Rewrite length */
149 
150  /* MFIB RPF ID */
152  };
153 
154  /* ICMP */
155  struct
156  {
160  } icmp;
161 
162  /* reassembly */
163  union
164  {
165  u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
166  /* in/out variables */
167  struct
168  {
169  u32 next_index; /* index of next node - ignored if "feature" node */
170  u16 estimated_mtu; /* estimated MTU calculated during reassembly */
171  };
172  /* internal variables used during reassembly */
173  struct
174  {
181  };
182  } reass;
183  };
184 
185  } ip;
186 
187  /*
188  * MPLS:
189  * data copied from the MPLS header that was popped from the packet
190  * during the look-up.
191  */
192  struct
193  {
194  /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
195  u32 pad[VLIB_N_RX_TX + 1];
199  /* Rewrite length */
200  u32 save_rewrite_length;
201  /*
202  * BIER - the nubmer of bytes in the header.
203  * the len field inthe header is not authoritative. It's the
204  * value in the table that counts.
205  */
206  struct
207  {
209  } bier;
210  } mpls;
211 
212  /* l2 bridging path, only valid there */
213  struct opaque_l2
214  {
216  u16 bd_index; /* bridge-domain index */
217  u8 l2_len; /* ethernet header length */
218  u8 shg; /* split-horizon group */
219  u16 l2fib_sn; /* l2fib bd/int seq_num */
220  u8 bd_age; /* aging enabled */
221  } l2;
222 
223  /* l2tpv3 softwire encap, only valid there */
224  struct
225  {
226  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
229  } l2t;
230 
231  /* L2 classify */
232  struct
233  {
234  struct opaque_l2 pad;
235  union
236  {
239  };
241  } l2_classify;
242 
243  /* IO - worker thread handoff */
244  struct
245  {
246  u32 next_index;
247  } handoff;
248 
249  /* vnet policer */
250  struct
251  {
252  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
254  } policer;
255 
256  /* interface output features */
257  struct
258  {
261  } ipsec;
262 
263  /* MAP */
264  struct
265  {
267  } map;
268 
269  /* MAP-T */
270  struct
271  {
273  struct
274  {
275  u32 saddr, daddr;
276  u16 frag_offset; //Fragmentation header offset
277  u16 l4_offset; //L4 header overall offset
278  u8 l4_protocol; //The final protocol number
279  } v6; //Used by ip6_map_t only
280  u16 checksum_offset; //L4 checksum overall offset
281  u16 mtu; //Exit MTU
282  } map_t;
283 
284  /* IP Fragmentation */
285  struct
286  {
287  u32 pad[2]; /* do not overlay w/ ip.adj_index[0,1] */
289  u16 mtu;
290  u8 next_index;
291  u8 flags; //See ip_frag.h
292  } ip_frag;
293 
294  /* COP - configurable junk filter(s) */
295  struct
296  {
297  /* Current configuration index. */
299  } cop;
300 
301  /* LISP */
302  struct
303  {
304  /* overlay address family */
306  } lisp;
307 
308  /* Driver rx feature */
309  struct
310  {
311  u32 saved_next_index; /**< saved by drivers for short-cut */
313  } device_input_feat;
314 
315  /* TCP */
316  struct
317  {
322  u16 hdr_offset; /**< offset relative to ip hdr */
323  u16 data_offset; /**< offset relative to ip hdr */
324  u16 data_len; /**< data len */
325  u8 flags;
326  } tcp;
327 
328  /* SCTP */
329  struct
330  {
331  u32 connection_index;
332  u16 sid; /**< Stream ID */
333  u16 ssn; /**< Stream Sequence Number */
334  u32 tsn; /**< Transmission Sequence Number */
335  u16 hdr_offset; /**< offset relative to ip hdr */
336  u16 data_offset; /**< offset relative to ip hdr */
337  u16 data_len; /**< data len */
338  u8 subconn_idx; /**< index of the sub_connection being used */
339  u8 flags;
340  } sctp;
341 
342  /* SNAT */
343  struct
344  {
345  u32 flags;
346  } snat;
347 
348  u32 unused[6];
349  };
351 
352 /*
353  * The opaque field of the vlib_buffer_t is intepreted as a
354  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
355  */
357  STRUCT_SIZE_OF (vlib_buffer_t, opaque),
358  "VNET buffer meta-data too large for vlib_buffer");
359 
360 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
361 
362 /* Full cache line (64 bytes) of additional space */
363 typedef struct
364 {
365  /**
366  * QoS marking data that needs to persist from the recording nodes
367  * (nominally in the ingress path) to the marking node (in the
368  * egress path)
369  */
370  struct
371  {
374  } qos;
375 
376  u8 __unused[2];
377 
378  /* Group Based Policy */
379  struct
380  {
382  } gbp;
383 
384  union
385  {
386  struct
387  {
388 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
389  /* buffer trajectory tracing */
390  u16 *trajectory_trace;
391 #endif
392  };
393  struct
394  {
395  u64 pad[1];
397  };
398  u32 unused[10];
399  };
401 
402 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
403 
404 /*
405  * The opaque2 field of the vlib_buffer_t is intepreted as a
406  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
407  */
409  STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
410  "VNET buffer opaque2 meta-data too large for vlib_buffer");
411 
413 
414 #endif /* included_vnet_buffer_h */
415 
416 /*
417  * fd.io coding-style-patch-verification: ON
418  *
419  * Local Variables:
420  * eval: (c-set-style "gnu")
421  * End:
422  */
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
u32 current_config_index
Definition: buffer.h:298
unsigned long u64
Definition: types.h:89
u32 saved_next_index
saved by drivers for short-cut
Definition: buffer.h:311
u16 data_offset
offset relative to ip hdr
Definition: buffer.h:323
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
unsigned int u32
Definition: types.h:88
u32 tsn
Transmission Sequence Number.
Definition: buffer.h:334
format_function_t format_vnet_buffer
Definition: buffer.h:412
unsigned short u16
Definition: types.h:57
u16 sid
Stream ID.
Definition: buffer.h:332
u16 ssn
Stream Sequence Number.
Definition: buffer.h:333
#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:322
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:64
u32 flags
Definition: vhost-user.h:77
u8 subconn_idx
index of the sub_connection being used
Definition: buffer.h:338
u16 data_len
data len
Definition: buffer.h:324
signed short i16
Definition: types.h:46