FD.io VPP  v16.09
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_OUTPUT_FEAT_DONE LOG2_VLIB_BUFFER_FLAG_USER(5)
65 #define BUFFER_OUTPUT_FEAT_DONE (1 << LOG2_BUFFER_OUTPUT_FEAT_DONE)
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 foreach_buffer_opaque_union_subtype \
71 _(ethernet) \
72 _(ip) \
73 _(mcast) \
74 _(swt) \
75 _(l2) \
76 _(l2t) \
77 _(gre) \
78 _(l2_classify) \
79 _(handoff) \
80 _(policer) \
81 _(output_features) \
82 _(map) \
83 _(map_t) \
84 _(ip_frag)
85 
86 /*
87  * vnet stack buffer opaque array overlay structure.
88  * The vnet_buffer_opaque_t *must* be the same size as the
89  * vlib_buffer_t "opaque" structure member, 32 bytes.
90  *
91  * When adding a union type, please add a stanza to
92  * foreach_buffer_opaque_union_subtype (directly above).
93  * Code in vnet_interface_init(...) verifies the size
94  * of the union, and will announce any deviations in an
95  * impossible-to-miss manner.
96  */
97 typedef struct
98 {
99  u32 sw_if_index[VLIB_N_RX_TX];
100 
101  union
102  {
103  /* Ethernet. */
104  struct
105  {
106  /* Saved value of current header by ethernet-input. */
108  } ethernet;
109 
110  /* IP4/6 buffer opaque. */
111  struct
112  {
113  /* Adjacency from destination IP address lookup [VLIB_TX].
114  Adjacency from source IP address lookup [VLIB_RX].
115  This gets set to ~0 until source lookup is performed. */
116  u32 adj_index[VLIB_N_RX_TX];
117 
118  union
119  {
120  struct
121  {
122  /* Flow hash value for this packet computed from IP src/dst address
123  protocol and ports. */
125 
126  /* next protocol */
128  };
129 
130  /* Alternate used for local TCP packets. */
131  struct
132  {
134 
136 
138 
140  } tcp;
141 
142  /* ICMP */
143  struct
144  {
148  } icmp;
149  };
150  } ip;
151 
152  /* Multicast replication */
153  struct
154  {
155  u32 pad[3];
159  } mcast;
160 
161  /* ip4-in-ip6 softwire termination, only valid there */
162  struct
163  {
166  } swt;
167 
168  /* l2 bridging path, only valid there */
169  struct
170  {
172  u16 bd_index; // bridge-domain index
173  u8 l2_len; // ethernet header length
174  u8 shg; // split-horizon group
175  } l2;
176 
177  /* l2tpv3 softwire encap, only valid there */
178  struct
179  {
180  u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
183  } l2t;
184 
185  struct
186  {
187  u32 src, dst;
188  } gre;
189 
190  /* L2 classify */
191  struct
192  {
197  } l2_classify;
198 
199  /* IO - worker thread handoff */
200  struct
201  {
203  } handoff;
204 
205  /* vnet policer */
206  struct
207  {
208  u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
210  } policer;
211 
212  /* interface output features */
213  struct
214  {
217  u32 unused[3];
219  } output_features;
220 
221  /* vcgn udp inside input, only valid there */
222  struct
223  {
224  /* This part forms context of the packet. The structure should be
225  * exactly same as spp_ctx_t. Also this should be the first
226  * element of this vcgn_uii structure.
227  */
228  /****** BEGIN spp_ctx_t section ***********************/
229  union
230  { /* Roddick specific */
232  struct _tx_pkt_info
233  { /* Used by PI to PI communication for TX */
234  u32 uidb_index:16; /* uidb_index to transmit */
235  u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
236  u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
237  * segment size
238  * (set by 6rd defrag node)
239  */
240 
241  u32 dst_ip_port_idx:4; /* Index to dst_ip_port_table */
242  u32 from_node:4;
243  u32 calc_chksum:1;
244  u32 reserved:4;
245  } tx;
246  struct _rx_pkt_info
247  { /* Used by PD / PI communication */
248  u32 uidb_index:16; /* uidb_index received in packet */
249  u32 packet_type:2; /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
250  u32 icmp_type:1; /* 0-ICMP query type, 1-ICMP error type */
251  u32 protocol_type:2; /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
252  u32 ipv4_defrag:1; /* 0 - Normal, 1 - update first
253  * segment size
254  * (set by 6rd defrag node)
255  */
256 
257  u32 direction:1; /* 0-Outside, 1-Inside */
258  u32 frag:1; /*IP fragment-1, Otherwise-0 */
259  u32 option:1; /* 0-No IP option (v4) present, non-fragHdr
260  * option hdr present (v6)
261  */
262  u32 df_bit:1; /* IPv4 DF bit copied here */
263  u32 reserved1:6;
264  } rx;
265  } ru;
266  /****** END spp_ctx_t section ***********************/
267 
268  union
269  {
270  struct
271  {
274  u16 vrf; //bit0-13:i/f, bit14-15:protocol
275  } k;
276 
278  } key;
279 
281 
282  u16 ovrf; /* Exit interface */
285  } vcgn_uii;
286 
287  /* MAP */
288  struct
289  {
291  } map;
292 
293  /* MAP-T */
294  struct
295  {
297  struct
298  {
299  u32 saddr, daddr;
300  u16 frag_offset; //Fragmentation header offset
301  u16 l4_offset; //L4 header overall offset
302  u8 l4_protocol; //The final protocol number
303  } v6; //Used by ip6_map_t only
304  u16 checksum_offset; //L4 checksum overall offset
305  u16 mtu; //Exit MTU
306  } map_t;
307 
308  /* IP Fragmentation */
309  struct
310  {
312  u16 mtu;
313  u8 next_index;
314  u8 flags; //See ip_frag.h
315  } ip_frag;
316 
317  /* COP - configurable junk filter(s) */
318  struct
319  {
320  /* Current configuration index. */
322  } cop;
323 
324  /* LISP */
325  struct
326  {
327  /* overlay address family */
329  } lisp;
330 
331  u32 unused[6];
332  };
334 
335 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
336 
337 /* Full cache line (64 bytes) of additional space */
338 typedef struct
339 {
340  union
341  {
342  };
344 
345 
346 
347 #endif /* included_vnet_buffer_h */
348 
349 /*
350  * fd.io coding-style-patch-verification: ON
351  *
352  * Local Variables:
353  * eval: (c-set-style "gnu")
354  * End:
355  */
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
u32 mini_connection_index
Definition: buffer.h:137
u32 current_config_index
Definition: buffer.h:321
i32 start_of_ethernet_header
Definition: buffer.h:107
u32 established_connection_index
Definition: buffer.h:135
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
u32 original_free_list_index
Definition: buffer.h:158
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56