FD.io VPP  v17.01-9-ge7dcee4
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_VNET_BUFFER_RTE_MBUF_VALID LOG2_VLIB_BUFFER_FLAG_USER(5)
65 #define VNET_BUFFER_RTE_MBUF_VALID (1 << LOG2_VNET_BUFFER_RTE_MBUF_VALID)
66 
67 #define LOG2_BUFFER_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
68 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
69 
70 #define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
71 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
72 
73 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
74 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
75 
76 #define foreach_buffer_opaque_union_subtype \
77 _(ethernet) \
78 _(ip) \
79 _(mcast) \
80 _(swt) \
81 _(l2) \
82 _(l2t) \
83 _(gre) \
84 _(l2_classify) \
85 _(handoff) \
86 _(policer) \
87 _(ipsec) \
88 _(map) \
89 _(map_t) \
90 _(ip_frag)
91 
92 /*
93  * vnet stack buffer opaque array overlay structure.
94  * The vnet_buffer_opaque_t *must* be the same size as the
95  * vlib_buffer_t "opaque" structure member, 32 bytes.
96  *
97  * When adding a union type, please add a stanza to
98  * foreach_buffer_opaque_union_subtype (directly above).
99  * Code in vnet_interface_init(...) verifies the size
100  * of the union, and will announce any deviations in an
101  * impossible-to-miss manner.
102  */
103 typedef struct
104 {
105  u32 sw_if_index[VLIB_N_RX_TX];
106 
107  union
108  {
109  /* Ethernet. */
110  struct
111  {
112  /* Saved value of current header by ethernet-input. */
114  } ethernet;
115 
116  /* IP4/6 buffer opaque. */
117  struct
118  {
119  /* Adjacency from destination IP address lookup [VLIB_TX].
120  Adjacency from source IP address lookup [VLIB_RX].
121  This gets set to ~0 until source lookup is performed. */
122  u32 adj_index[VLIB_N_RX_TX];
123 
124  union
125  {
126  struct
127  {
128  /* Flow hash value for this packet computed from IP src/dst address
129  protocol and ports. */
131 
132  /* next protocol */
134 
135  /* Rewrite length */
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  /* Multicast replication */
166  struct
167  {
168  u32 pad[3];
172  } mcast;
173 
174  /* ip4-in-ip6 softwire termination, only valid there */
175  struct
176  {
179  } swt;
180 
181  /* l2 bridging path, only valid there */
182  struct
183  {
185  u16 bd_index; // bridge-domain index
186  u8 l2_len; // ethernet header length
187  u8 shg; // split-horizon group
188  } l2;
189 
190  /* l2tpv3 softwire encap, only valid there */
191  struct
192  {
193  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
196  } l2t;
197 
198  struct
199  {
200  u32 src, dst;
201  } gre;
202 
203  /* L2 classify */
204  struct
205  {
210  } l2_classify;
211 
212  /* IO - worker thread handoff */
213  struct
214  {
216  } handoff;
217 
218  /* vnet policer */
219  struct
220  {
221  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
223  } policer;
224 
225  /* interface output features */
226  struct
227  {
230  } ipsec;
231 
232  /* vcgn udp inside input, only valid there */
233  struct
234  {
235  /* This part forms context of the packet. The structure should be
236  * exactly same as spp_ctx_t. Also this should be the first
237  * element of this vcgn_uii structure.
238  */
239  /****** BEGIN spp_ctx_t section ***********************/
240  union
241  { /* Roddick specific */
243  struct _tx_pkt_info
244  { /* Used by PI to PI communication for TX */
245  u32 uidb_index:16; /* uidb_index to transmit */
246  u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
247  u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
248  * segment size
249  * (set by 6rd defrag node)
250  */
251 
252  u32 dst_ip_port_idx:4; /* Index to dst_ip_port_table */
253  u32 from_node:4;
254  u32 calc_chksum:1;
255  u32 reserved:4;
256  } tx;
257  struct _rx_pkt_info
258  { /* Used by PD / PI communication */
259  u32 uidb_index:16; /* uidb_index received in packet */
260  u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
261  u32 icmp_type:1; /* 0-ICMP query type, 1-ICMP error type */
262  u32 protocol_type:2; /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
263  u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
264  * segment size
265  * (set by 6rd defrag node)
266  */
267 
268  u32 direction:1; /* 0-Outside, 1-Inside */
269  u32 frag:1; /*IP fragment-1, Otherwise-0 */
270  u32 option:1; /* 0-No IP option (v4) present, non-fragHdr
271  * option hdr present (v6)
272  */
273  u32 df_bit:1; /* IPv4 DF bit copied here */
274  u32 reserved1:6;
275  } rx;
276  } ru;
277  /****** END spp_ctx_t section ***********************/
278 
279  union
280  {
281  struct
282  {
285  u16 vrf; //bit0-13:i/f, bit14-15:protocol
286  } k;
287 
289  } key;
290 
292 
293  u16 ovrf; /* Exit interface */
296  } vcgn_uii;
297 
298  /* MAP */
299  struct
300  {
302  } map;
303 
304  /* MAP-T */
305  struct
306  {
308  struct
309  {
310  u32 saddr, daddr;
311  u16 frag_offset; //Fragmentation header offset
312  u16 l4_offset; //L4 header overall offset
313  u8 l4_protocol; //The final protocol number
314  } v6; //Used by ip6_map_t only
315  u16 checksum_offset; //L4 checksum overall offset
316  u16 mtu; //Exit MTU
317  } map_t;
318 
319  /* IP Fragmentation */
320  struct
321  {
323  u16 mtu;
324  u8 next_index;
325  u8 flags; //See ip_frag.h
326  } ip_frag;
327 
328  /* COP - configurable junk filter(s) */
329  struct
330  {
331  /* Current configuration index. */
333  } cop;
334 
335  /* LISP */
336  struct
337  {
338  /* overlay address family */
340  } lisp;
341 
342  /* Driver rx feature */
343  struct
344  {
345  u32 saved_next_index; /**< saved by drivers for short-cut */
347  } device_input_feat;
348 
349  u32 unused[6];
350  };
352 
353 /*
354  * The opaque field of the vlib_buffer_t is intepreted as a
355  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
356  */
358  opaque),
359  "VNET buffer meta-data too large for vlib_buffer");
360 
361 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
362 
363 /* Full cache line (64 bytes) of additional space */
364 typedef struct
365 {
366  union
367  {
368  };
370 
371 
372 
373 #endif /* included_vnet_buffer_h */
374 
375 /*
376  * fd.io coding-style-patch-verification: ON
377  *
378  * Local Variables:
379  * eval: (c-set-style "gnu")
380  * End:
381  */
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
u32 current_config_index
Definition: buffer.h:332
u32 saved_next_index
saved by drivers for short-cut
Definition: buffer.h:345
i32 start_of_ethernet_header
Definition: buffer.h:113
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
STATIC_ASSERT(sizeof(vnet_buffer_opaque_t)<=STRUCT_SIZE_OF(vlib_buffer_t, opaque),"VNET buffer meta-data too large for vlib_buffer")
u32 original_free_list_index
Definition: buffer.h:171
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:64