blob: ed869d1f768065f9974ab1ff5571702ffa0eee06 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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
Chris Luke194ebc52016-04-25 14:26:55 -040052/* 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
Damjan Marion0247b462016-06-08 01:37:11 +020064#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
Neale Rannsf06aea52016-11-29 06:51:37 -080067#define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
68#define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
Damjan Marion67655492016-11-15 12:50:28 +010069
Pavel Kotucek3a2a1c42016-12-06 10:10:10 +010070#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
Ed Warnickecb9cada2015-12-08 15:45:58 -070073#define foreach_buffer_opaque_union_subtype \
74_(ethernet) \
75_(ip) \
Ed Warnickecb9cada2015-12-08 15:45:58 -070076_(swt) \
77_(l2) \
78_(l2t) \
Ed Warnickecb9cada2015-12-08 15:45:58 -070079_(gre) \
80_(l2_classify) \
Damjan Marion0247b462016-06-08 01:37:11 +020081_(handoff) \
Ed Warnickecb9cada2015-12-08 15:45:58 -070082_(policer) \
Damjan Marion9c6ae5f2016-11-15 23:20:01 +010083_(ipsec) \
Ole Troancda94822016-01-07 14:37:25 +010084_(map) \
85_(map_t) \
86_(ip_frag)
Ed Warnickecb9cada2015-12-08 15:45:58 -070087
Dave Barachba868bb2016-08-08 09:51:21 -040088/*
Ed Warnickecb9cada2015-12-08 15:45:58 -070089 * vnet stack buffer opaque array overlay structure.
90 * The vnet_buffer_opaque_t *must* be the same size as the
91 * vlib_buffer_t "opaque" structure member, 32 bytes.
92 *
93 * When adding a union type, please add a stanza to
94 * foreach_buffer_opaque_union_subtype (directly above).
95 * Code in vnet_interface_init(...) verifies the size
96 * of the union, and will announce any deviations in an
97 * impossible-to-miss manner.
98 */
Dave Barachba868bb2016-08-08 09:51:21 -040099typedef struct
100{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700101 u32 sw_if_index[VLIB_N_RX_TX];
102
Dave Barachba868bb2016-08-08 09:51:21 -0400103 union
104 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105 /* Ethernet. */
Dave Barachba868bb2016-08-08 09:51:21 -0400106 struct
107 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700108 /* Saved value of current header by ethernet-input. */
109 i32 start_of_ethernet_header;
110 } ethernet;
111
112 /* IP4/6 buffer opaque. */
Dave Barachba868bb2016-08-08 09:51:21 -0400113 struct
114 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115 /* Adjacency from destination IP address lookup [VLIB_TX].
Dave Barachba868bb2016-08-08 09:51:21 -0400116 Adjacency from source IP address lookup [VLIB_RX].
117 This gets set to ~0 until source lookup is performed. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118 u32 adj_index[VLIB_N_RX_TX];
119
Dave Barachba868bb2016-08-08 09:51:21 -0400120 union
121 {
122 struct
123 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700124 /* Flow hash value for this packet computed from IP src/dst address
125 protocol and ports. */
126 u32 flow_hash;
127
Dave Barachba868bb2016-08-08 09:51:21 -0400128 /* next protocol */
129 u32 save_protocol;
Dave Barachc7493e12016-08-24 18:36:03 -0400130
131 /* Rewrite length */
132 u32 save_rewrite_length;
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800133
134 /* MFIB RPF ID */
135 u32 rpf_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136 };
137
Ole Troancda94822016-01-07 14:37:25 +0100138 /* ICMP */
Dave Barachba868bb2016-08-08 09:51:21 -0400139 struct
140 {
Ole Troancda94822016-01-07 14:37:25 +0100141 u8 type;
142 u8 code;
143 u32 data;
144 } icmp;
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200145
Klement Sekera0c1519b2016-12-08 05:03:32 +0100146 /* IP header offset from vlib_buffer.data - saved by ip*_local nodes */
147 i32 start_of_ip_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148 };
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200149
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150 } ip;
151
Neale Rannsad422ed2016-11-02 14:20:04 +0000152 /*
153 * MPLS:
154 * data copied from the MPLS header that was popped from the packet
155 * during the look-up.
156 */
157 struct
158 {
159 u8 ttl;
160 u8 exp;
161 u8 first;
162 } mpls;
163
Ed Warnickecb9cada2015-12-08 15:45:58 -0700164 /* ip4-in-ip6 softwire termination, only valid there */
Dave Barachba868bb2016-08-08 09:51:21 -0400165 struct
166 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167 u8 swt_disable;
168 u32 mapping_index;
169 } swt;
170
171 /* l2 bridging path, only valid there */
Dave Barachba868bb2016-08-08 09:51:21 -0400172 struct
173 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700174 u32 feature_bitmap;
John Loda1f2c72017-03-24 20:11:15 -0400175 u16 bd_index; /* bridge-domain index */
176 u8 l2_len; /* ethernet header length */
177 u8 shg; /* split-horizon group */
178 u8 bd_sn; /* bridge domain seq# */
179 u8 int_sn; /* interface seq# */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180 } l2;
181
182 /* l2tpv3 softwire encap, only valid there */
Dave Barachba868bb2016-08-08 09:51:21 -0400183 struct
184 {
185 u32 pad[4]; /* do not overlay w/ ip.adj_index[0,1] */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700186 u8 next_index;
187 u32 session_index;
188 } l2t;
189
Dave Barachba868bb2016-08-08 09:51:21 -0400190 struct
191 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700192 u32 src, dst;
193 } gre;
194
195 /* L2 classify */
Dave Barachba868bb2016-08-08 09:51:21 -0400196 struct
197 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198 u64 pad;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700199 u32 table_index;
AkshayaNadahallied4a2fd2016-08-09 13:38:04 +0530200 u32 opaque_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201 u64 hash;
202 } l2_classify;
203
204 /* IO - worker thread handoff */
Dave Barachba868bb2016-08-08 09:51:21 -0400205 struct
206 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700207 u32 next_index;
Damjan Marion0247b462016-06-08 01:37:11 +0200208 } handoff;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700209
210 /* vnet policer */
Dave Barachba868bb2016-08-08 09:51:21 -0400211 struct
212 {
213 u32 pad[8 - VLIB_N_RX_TX - 1]; /* to end of opaque */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700214 u32 index;
215 } policer;
216
217 /* interface output features */
Dave Barachba868bb2016-08-08 09:51:21 -0400218 struct
219 {
Damjan Marion9c6ae5f2016-11-15 23:20:01 +0100220 u32 flags;
221 u32 sad_index;
222 } ipsec;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700223
Ed Warnickecb9cada2015-12-08 15:45:58 -0700224 /* MAP */
Dave Barachba868bb2016-08-08 09:51:21 -0400225 struct
226 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700227 u16 mtu;
228 } map;
229
230 /* MAP-T */
Dave Barachba868bb2016-08-08 09:51:21 -0400231 struct
232 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233 u32 map_domain_index;
Dave Barachba868bb2016-08-08 09:51:21 -0400234 struct
235 {
236 u32 saddr, daddr;
237 u16 frag_offset; //Fragmentation header offset
238 u16 l4_offset; //L4 header overall offset
239 u8 l4_protocol; //The final protocol number
240 } v6; //Used by ip6_map_t only
241 u16 checksum_offset; //L4 checksum overall offset
242 u16 mtu; //Exit MTU
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243 } map_t;
244
245 /* IP Fragmentation */
Dave Barachba868bb2016-08-08 09:51:21 -0400246 struct
247 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248 u16 header_offset;
249 u16 mtu;
250 u8 next_index;
Dave Barachba868bb2016-08-08 09:51:21 -0400251 u8 flags; //See ip_frag.h
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252 } ip_frag;
253
Dave Barachc07bf5d2016-02-17 17:52:26 -0500254 /* COP - configurable junk filter(s) */
Dave Barachba868bb2016-08-08 09:51:21 -0400255 struct
256 {
257 /* Current configuration index. */
258 u32 current_config_index;
Dave Barachc07bf5d2016-02-17 17:52:26 -0500259 } cop;
260
Florin Coras1a1adc72016-07-22 01:45:30 +0200261 /* LISP */
Dave Barachba868bb2016-08-08 09:51:21 -0400262 struct
263 {
Florin Coras1a1adc72016-07-22 01:45:30 +0200264 /* overlay address family */
265 u16 overlay_afi;
266 } lisp;
267
Damjan Marion22311502016-10-28 20:30:15 +0200268 /* Driver rx feature */
269 struct
270 {
271 u32 saved_next_index; /**< saved by drivers for short-cut */
272 u16 buffer_advance;
273 } device_input_feat;
274
Dave Barach68b0fb02017-02-28 15:15:56 -0500275 /* TCP */
276 struct
277 {
278 u32 connection_index;
279 u32 seq_number;
280 u32 seq_end;
281 u32 ack_number;
282 u8 flags;
283 } tcp;
284
Ed Warnickecb9cada2015-12-08 15:45:58 -0700285 u32 unused[6];
286 };
287} vnet_buffer_opaque_t;
288
Neale Rannsad422ed2016-11-02 14:20:04 +0000289/*
290 * The opaque field of the vlib_buffer_t is intepreted as a
291 * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
292 */
293STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <= STRUCT_SIZE_OF (vlib_buffer_t,
294 opaque),
295 "VNET buffer meta-data too large for vlib_buffer");
296
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297#define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
298
299/* Full cache line (64 bytes) of additional space */
Dave Barachba868bb2016-08-08 09:51:21 -0400300typedef struct
301{
302 union
303 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700304 };
305} vnet_buffer_opaque2_t;
306
307
308
309#endif /* included_vnet_buffer_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400310
311/*
312 * fd.io coding-style-patch-verification: ON
313 *
314 * Local Variables:
315 * eval: (c-set-style "gnu")
316 * End:
317 */