FD.io VPP  v17.07.01-10-g3be13f0
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 /* VLIB buffer flags for ip4/ip6 packets. Set by input interfaces for ip4/ip6
46  tcp/udp packets with hardware computed checksums. */
47 #define LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED LOG2_VLIB_BUFFER_FLAG_USER(1)
48 #define LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT LOG2_VLIB_BUFFER_FLAG_USER(2)
49 #define IP_BUFFER_L4_CHECKSUM_COMPUTED (1 << LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED)
50 #define IP_BUFFER_L4_CHECKSUM_CORRECT (1 << LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT)
51 
52 /* VLAN header flags.
53  * These bits are zeroed in vlib_buffer_init_for_free_list()
54  * meaning wherever the buffer comes from they have a reasonable
55  * value (eg, if ip4/ip6 generates the packet.)
56  */
57 #define LOG2_ETH_BUFFER_VLAN_2_DEEP LOG2_VLIB_BUFFER_FLAG_USER(3)
58 #define LOG2_ETH_BUFFER_VLAN_1_DEEP LOG2_VLIB_BUFFER_FLAG_USER(4)
59 #define ETH_BUFFER_VLAN_2_DEEP (1 << LOG2_ETH_BUFFER_VLAN_2_DEEP)
60 #define ETH_BUFFER_VLAN_1_DEEP (1 << LOG2_ETH_BUFFER_VLAN_1_DEEP)
61 #define ETH_BUFFER_VLAN_BITS (ETH_BUFFER_VLAN_1_DEEP | \
62  ETH_BUFFER_VLAN_2_DEEP)
63 
64 #define LOG2_BUFFER_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
65 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
66 
67 #define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
68 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
69 
70 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
71 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
72 
73 #define foreach_buffer_opaque_union_subtype \
74 _(ethernet) \
75 _(ip) \
76 _(swt) \
77 _(l2) \
78 _(l2t) \
79 _(gre) \
80 _(l2_classify) \
81 _(handoff) \
82 _(policer) \
83 _(ipsec) \
84 _(map) \
85 _(map_t) \
86 _(ip_frag) \
87 _(tcp)
88 
89 /*
90  * vnet stack buffer opaque array overlay structure.
91  * The vnet_buffer_opaque_t *must* be the same size as the
92  * vlib_buffer_t "opaque" structure member, 32 bytes.
93  *
94  * When adding a union type, please add a stanza to
95  * foreach_buffer_opaque_union_subtype (directly above).
96  * Code in vnet_interface_init(...) verifies the size
97  * of the union, and will announce any deviations in an
98  * impossible-to-miss manner.
99  */
100 typedef struct
101 {
102  u32 sw_if_index[VLIB_N_RX_TX];
103 
104  union
105  {
106  /* Ethernet. */
107  struct
108  {
109  /* Saved value of current header by ethernet-input. */
111  } ethernet;
112 
113  /* IP4/6 buffer opaque. */
114  struct
115  {
116  /* Adjacency from destination IP address lookup [VLIB_TX].
117  Adjacency from source IP address lookup [VLIB_RX].
118  This gets set to ~0 until source lookup is performed. */
119  u32 adj_index[VLIB_N_RX_TX];
120 
121  union
122  {
123  struct
124  {
125  /* Flow hash value for this packet computed from IP src/dst address
126  protocol and ports. */
128 
129  /* next protocol */
131 
132  /* Rewrite length */
134 
135  /* MFIB RPF ID */
137  };
138 
139  /* ICMP */
140  struct
141  {
145  } icmp;
146 
147  /* IP header offset from vlib_buffer.data - saved by ip*_local nodes */
149  };
150 
151  } ip;
152 
153  /*
154  * MPLS:
155  * data copied from the MPLS header that was popped from the packet
156  * during the look-up.
157  */
158  struct
159  {
163  } mpls;
164 
165  /* ip4-in-ip6 softwire termination, only valid there */
166  struct
167  {
170  } swt;
171 
172  /* l2 bridging path, only valid there */
173  struct opaque_l2
174  {
176  u16 bd_index; /* bridge-domain index */
177  u8 l2_len; /* ethernet header length */
178  u8 shg; /* split-horizon group */
179  u16 l2fib_sn; /* l2fib bd/int seq_num */
180  u8 bd_age; /* aging enabled */
181  } l2;
182 
183  /* l2tpv3 softwire encap, only valid there */
184  struct
185  {
186  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
189  } l2t;
190 
191  struct
192  {
193  u32 src, dst;
194  } gre;
195 
196  /* L2 classify */
197  struct
198  {
199  struct opaque_l2 pad;
200  union
201  {
204  };
206  } l2_classify;
207 
208  /* IO - worker thread handoff */
209  struct
210  {
212  } handoff;
213 
214  /* vnet policer */
215  struct
216  {
217  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
219  } policer;
220 
221  /* interface output features */
222  struct
223  {
226  } ipsec;
227 
228  /* MAP */
229  struct
230  {
232  } map;
233 
234  /* MAP-T */
235  struct
236  {
238  struct
239  {
240  u32 saddr, daddr;
241  u16 frag_offset; //Fragmentation header offset
242  u16 l4_offset; //L4 header overall offset
243  u8 l4_protocol; //The final protocol number
244  } v6; //Used by ip6_map_t only
245  u16 checksum_offset; //L4 checksum overall offset
246  u16 mtu; //Exit MTU
247  } map_t;
248 
249  /* IP Fragmentation */
250  struct
251  {
253  u16 mtu;
254  u8 next_index;
255  u8 flags; //See ip_frag.h
256  } ip_frag;
257 
258  /* COP - configurable junk filter(s) */
259  struct
260  {
261  /* Current configuration index. */
263  } cop;
264 
265  /* LISP */
266  struct
267  {
268  /* overlay address family */
270  } lisp;
271 
272  /* Driver rx feature */
273  struct
274  {
275  u32 saved_next_index; /**< saved by drivers for short-cut */
277  } device_input_feat;
278 
279  /* TCP */
280  struct
281  {
286  u16 hdr_offset; /**< offset relative to ip hdr */
287  u16 data_offset; /**< offset relative to ip hdr */
288  u16 data_len; /**< data len */
289  u8 flags;
290  } tcp;
291 
292  u32 unused[6];
293  };
295 
296 /*
297  * The opaque field of the vlib_buffer_t is intepreted as a
298  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
299  */
301  STRUCT_SIZE_OF (vlib_buffer_t, opaque),
302  "VNET buffer meta-data too large for vlib_buffer");
303 
304 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
305 
306 /* Full cache line (64 bytes) of additional space */
307 typedef struct
308 {
309  union
310  {
311  };
313 
314 
315 
316 #endif /* included_vnet_buffer_h */
317 
318 /*
319  * fd.io coding-style-patch-verification: ON
320  *
321  * Local Variables:
322  * eval: (c-set-style "gnu")
323  * End:
324  */
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
u32 current_config_index
Definition: buffer.h:262
u32 saved_next_index
saved by drivers for short-cut
Definition: buffer.h:275
i32 start_of_ethernet_header
Definition: buffer.h:110
u16 data_offset
offset relative to ip hdr
Definition: buffer.h:287
STATIC_ASSERT(sizeof(vnet_buffer_opaque_t)<=STRUCT_SIZE_OF(vlib_buffer_t, opaque),"VNET buffer meta-data too large for vlib_buffer")
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
u16 hdr_offset
offset relative to ip hdr
Definition: buffer.h:286
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:64
u32 flags
Definition: vhost-user.h:76
u16 data_len
data len
Definition: buffer.h:288