4 * Copyright(c) 2010-2016 Intel Corporation.
5 * Copyright 2014-2016 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef _RTE_MBUF_PTYPE_H_
36 #define _RTE_MBUF_PTYPE_H_
40 * RTE Mbuf Packet Types
42 * This file contains declarations for features related to mbuf packet
43 * types. The packet type gives information about the data carried by the
44 * mbuf, and is stored in the mbuf in a 32 bits field.
46 * The 32 bits are divided into several fields to mark packet types. Note that
47 * each field is indexical.
48 * - Bit 3:0 is for L2 types.
49 * - Bit 7:4 is for L3 or outer L3 (for tunneling case) types.
50 * - Bit 11:8 is for L4 or outer L4 (for tunneling case) types.
51 * - Bit 15:12 is for tunnel types.
52 * - Bit 19:16 is for inner L2 types.
53 * - Bit 23:20 is for inner L3 types.
54 * - Bit 27:24 is for inner L4 types.
55 * - Bit 31:28 is reserved.
57 * To be compatible with Vector PMD, RTE_PTYPE_L3_IPV4, RTE_PTYPE_L3_IPV4_EXT,
58 * RTE_PTYPE_L3_IPV6, RTE_PTYPE_L3_IPV6_EXT, RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP
59 * and RTE_PTYPE_L4_SCTP should be kept as below in a contiguous 7 bits.
61 * Note that L3 types values are selected for checking IPV4/IPV6 header from
62 * performance point of view. Reading annotations of RTE_ETH_IS_IPV4_HDR and
63 * RTE_ETH_IS_IPV6_HDR is needed for any future changes of L3 type values.
65 * Note that the packet types of the same packet recognized by different
66 * hardware may be different, as different hardware may have different
67 * capability of packet type recognition.
70 * <'ether type'=0x0800
71 * | 'version'=4, 'protocol'=0x29
72 * | 'version'=6, 'next header'=0x3A
74 * will be recognized on i40e hardware as packet type combination of,
75 * RTE_PTYPE_L2_ETHER |
76 * RTE_PTYPE_L3_IPV4_EXT_UNKNOWN |
77 * RTE_PTYPE_TUNNEL_IP |
78 * RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN |
79 * RTE_PTYPE_INNER_L4_ICMP.
81 * <'ether type'=0x86DD
82 * | 'version'=6, 'next header'=0x2F
84 * | 'version'=6, 'next header'=0x11
86 * will be recognized on i40e hardware as packet type combination of,
87 * RTE_PTYPE_L2_ETHER |
88 * RTE_PTYPE_L3_IPV6_EXT_UNKNOWN |
89 * RTE_PTYPE_TUNNEL_GRENAT |
90 * RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN |
91 * RTE_PTYPE_INNER_L4_UDP.
99 * No packet type information.
101 #define RTE_PTYPE_UNKNOWN 0x00000000
103 * Ethernet packet type.
104 * It is used for outer packet for tunneling cases.
107 * <'ether type'=[0x0800|0x86DD]>
109 #define RTE_PTYPE_L2_ETHER 0x00000001
111 * Ethernet packet type for time sync.
114 * <'ether type'=0x88F7>
116 #define RTE_PTYPE_L2_ETHER_TIMESYNC 0x00000002
118 * ARP (Address Resolution Protocol) packet type.
121 * <'ether type'=0x0806>
123 #define RTE_PTYPE_L2_ETHER_ARP 0x00000003
125 * LLDP (Link Layer Discovery Protocol) packet type.
128 * <'ether type'=0x88CC>
130 #define RTE_PTYPE_L2_ETHER_LLDP 0x00000004
132 * NSH (Network Service Header) packet type.
135 * <'ether type'=0x894F>
137 #define RTE_PTYPE_L2_ETHER_NSH 0x00000005
142 * <'ether type'=[0x8100]>
144 #define RTE_PTYPE_L2_ETHER_VLAN 0x00000006
146 * Mask of layer 2 packet types.
147 * It is used for outer packet for tunneling cases.
149 #define RTE_PTYPE_L2_MASK 0x0000000f
151 * IP (Internet Protocol) version 4 packet type.
152 * It is used for outer packet for tunneling cases, and does not contain any
156 * <'ether type'=0x0800
157 * | 'version'=4, 'ihl'=5>
159 #define RTE_PTYPE_L3_IPV4 0x00000010
161 * IP (Internet Protocol) version 4 packet type.
162 * It is used for outer packet for tunneling cases, and contains header
166 * <'ether type'=0x0800
167 * | 'version'=4, 'ihl'=[6-15], 'options'>
169 #define RTE_PTYPE_L3_IPV4_EXT 0x00000030
171 * IP (Internet Protocol) version 6 packet type.
172 * It is used for outer packet for tunneling cases, and does not contain any
176 * <'ether type'=0x86DD
177 * | 'version'=6, 'next header'=0x3B>
179 #define RTE_PTYPE_L3_IPV6 0x00000040
181 * IP (Internet Protocol) version 4 packet type.
182 * It is used for outer packet for tunneling cases, and may or maynot contain
186 * <'ether type'=0x0800
187 * | 'version'=4, 'ihl'=[5-15], <'options'>>
189 #define RTE_PTYPE_L3_IPV4_EXT_UNKNOWN 0x00000090
191 * IP (Internet Protocol) version 6 packet type.
192 * It is used for outer packet for tunneling cases, and contains extension
196 * <'ether type'=0x86DD
197 * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
198 * 'extension headers'>
200 #define RTE_PTYPE_L3_IPV6_EXT 0x000000c0
202 * IP (Internet Protocol) version 6 packet type.
203 * It is used for outer packet for tunneling cases, and may or maynot contain
207 * <'ether type'=0x86DD
208 * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
209 * <'extension headers'>>
211 #define RTE_PTYPE_L3_IPV6_EXT_UNKNOWN 0x000000e0
213 * Mask of layer 3 packet types.
214 * It is used for outer packet for tunneling cases.
216 #define RTE_PTYPE_L3_MASK 0x000000f0
218 * TCP (Transmission Control Protocol) packet type.
219 * It is used for outer packet for tunneling cases.
222 * <'ether type'=0x0800
223 * | 'version'=4, 'protocol'=6, 'MF'=0>
225 * <'ether type'=0x86DD
226 * | 'version'=6, 'next header'=6>
228 #define RTE_PTYPE_L4_TCP 0x00000100
230 * UDP (User Datagram Protocol) packet type.
231 * It is used for outer packet for tunneling cases.
234 * <'ether type'=0x0800
235 * | 'version'=4, 'protocol'=17, 'MF'=0>
237 * <'ether type'=0x86DD
238 * | 'version'=6, 'next header'=17>
240 #define RTE_PTYPE_L4_UDP 0x00000200
242 * Fragmented IP (Internet Protocol) packet type.
243 * It is used for outer packet for tunneling cases.
245 * It refers to those packets of any IP types, which can be recognized as
246 * fragmented. A fragmented packet cannot be recognized as any other L4 types
247 * (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP,
248 * RTE_PTYPE_L4_NONFRAG).
251 * <'ether type'=0x0800
252 * | 'version'=4, 'MF'=1>
254 * <'ether type'=0x86DD
255 * | 'version'=6, 'next header'=44>
257 #define RTE_PTYPE_L4_FRAG 0x00000300
259 * SCTP (Stream Control Transmission Protocol) packet type.
260 * It is used for outer packet for tunneling cases.
263 * <'ether type'=0x0800
264 * | 'version'=4, 'protocol'=132, 'MF'=0>
266 * <'ether type'=0x86DD
267 * | 'version'=6, 'next header'=132>
269 #define RTE_PTYPE_L4_SCTP 0x00000400
271 * ICMP (Internet Control Message Protocol) packet type.
272 * It is used for outer packet for tunneling cases.
275 * <'ether type'=0x0800
276 * | 'version'=4, 'protocol'=1, 'MF'=0>
278 * <'ether type'=0x86DD
279 * | 'version'=6, 'next header'=1>
281 #define RTE_PTYPE_L4_ICMP 0x00000500
283 * Non-fragmented IP (Internet Protocol) packet type.
284 * It is used for outer packet for tunneling cases.
286 * It refers to those packets of any IP types, while cannot be recognized as
287 * any of above L4 types (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP,
288 * RTE_PTYPE_L4_FRAG, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP).
291 * <'ether type'=0x0800
292 * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0>
294 * <'ether type'=0x86DD
295 * | 'version'=6, 'next header'!=[6|17|44|132|1]>
297 #define RTE_PTYPE_L4_NONFRAG 0x00000600
299 * Mask of layer 4 packet types.
300 * It is used for outer packet for tunneling cases.
302 #define RTE_PTYPE_L4_MASK 0x00000f00
304 * IP (Internet Protocol) in IP (Internet Protocol) tunneling packet type.
307 * <'ether type'=0x0800
308 * | 'version'=4, 'protocol'=[4|41]>
310 * <'ether type'=0x86DD
311 * | 'version'=6, 'next header'=[4|41]>
313 #define RTE_PTYPE_TUNNEL_IP 0x00001000
315 * GRE (Generic Routing Encapsulation) tunneling packet type.
318 * <'ether type'=0x0800
319 * | 'version'=4, 'protocol'=47>
321 * <'ether type'=0x86DD
322 * | 'version'=6, 'next header'=47>
324 #define RTE_PTYPE_TUNNEL_GRE 0x00002000
326 * VXLAN (Virtual eXtensible Local Area Network) tunneling packet type.
329 * <'ether type'=0x0800
330 * | 'version'=4, 'protocol'=17
331 * | 'destination port'=4798>
333 * <'ether type'=0x86DD
334 * | 'version'=6, 'next header'=17
335 * | 'destination port'=4798>
337 #define RTE_PTYPE_TUNNEL_VXLAN 0x00003000
339 * NVGRE (Network Virtualization using Generic Routing Encapsulation) tunneling
343 * <'ether type'=0x0800
344 * | 'version'=4, 'protocol'=47
345 * | 'protocol type'=0x6558>
347 * <'ether type'=0x86DD
348 * | 'version'=6, 'next header'=47
349 * | 'protocol type'=0x6558'>
351 #define RTE_PTYPE_TUNNEL_NVGRE 0x00004000
353 * GENEVE (Generic Network Virtualization Encapsulation) tunneling packet type.
356 * <'ether type'=0x0800
357 * | 'version'=4, 'protocol'=17
358 * | 'destination port'=6081>
360 * <'ether type'=0x86DD
361 * | 'version'=6, 'next header'=17
362 * | 'destination port'=6081>
364 #define RTE_PTYPE_TUNNEL_GENEVE 0x00005000
366 * Tunneling packet type of Teredo, VXLAN (Virtual eXtensible Local Area
367 * Network) or GRE (Generic Routing Encapsulation) could be recognized as this
368 * packet type, if they can not be recognized independently as of hardware
371 #define RTE_PTYPE_TUNNEL_GRENAT 0x00006000
373 * Mask of tunneling packet types.
375 #define RTE_PTYPE_TUNNEL_MASK 0x0000f000
377 * Ethernet packet type.
378 * It is used for inner packet type only.
380 * Packet format (inner only):
381 * <'ether type'=[0x800|0x86DD]>
383 #define RTE_PTYPE_INNER_L2_ETHER 0x00010000
385 * Ethernet packet type with VLAN (Virtual Local Area Network) tag.
387 * Packet format (inner only):
388 * <'ether type'=[0x800|0x86DD], vlan=[1-4095]>
390 #define RTE_PTYPE_INNER_L2_ETHER_VLAN 0x00020000
392 * Mask of inner layer 2 packet types.
394 #define RTE_PTYPE_INNER_L2_MASK 0x000f0000
396 * IP (Internet Protocol) version 4 packet type.
397 * It is used for inner packet only, and does not contain any header option.
399 * Packet format (inner only):
400 * <'ether type'=0x0800
401 * | 'version'=4, 'ihl'=5>
403 #define RTE_PTYPE_INNER_L3_IPV4 0x00100000
405 * IP (Internet Protocol) version 4 packet type.
406 * It is used for inner packet only, and contains header options.
408 * Packet format (inner only):
409 * <'ether type'=0x0800
410 * | 'version'=4, 'ihl'=[6-15], 'options'>
412 #define RTE_PTYPE_INNER_L3_IPV4_EXT 0x00200000
414 * IP (Internet Protocol) version 6 packet type.
415 * It is used for inner packet only, and does not contain any extension header.
417 * Packet format (inner only):
418 * <'ether type'=0x86DD
419 * | 'version'=6, 'next header'=0x3B>
421 #define RTE_PTYPE_INNER_L3_IPV6 0x00300000
423 * IP (Internet Protocol) version 4 packet type.
424 * It is used for inner packet only, and may or maynot contain header options.
426 * Packet format (inner only):
427 * <'ether type'=0x0800
428 * | 'version'=4, 'ihl'=[5-15], <'options'>>
430 #define RTE_PTYPE_INNER_L3_IPV4_EXT_UNKNOWN 0x00400000
432 * IP (Internet Protocol) version 6 packet type.
433 * It is used for inner packet only, and contains extension headers.
435 * Packet format (inner only):
436 * <'ether type'=0x86DD
437 * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
438 * 'extension headers'>
440 #define RTE_PTYPE_INNER_L3_IPV6_EXT 0x00500000
442 * IP (Internet Protocol) version 6 packet type.
443 * It is used for inner packet only, and may or maynot contain extension
446 * Packet format (inner only):
447 * <'ether type'=0x86DD
448 * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
449 * <'extension headers'>>
451 #define RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN 0x00600000
453 * Mask of inner layer 3 packet types.
455 #define RTE_PTYPE_INNER_L3_MASK 0x00f00000
457 * TCP (Transmission Control Protocol) packet type.
458 * It is used for inner packet only.
460 * Packet format (inner only):
461 * <'ether type'=0x0800
462 * | 'version'=4, 'protocol'=6, 'MF'=0>
464 * <'ether type'=0x86DD
465 * | 'version'=6, 'next header'=6>
467 #define RTE_PTYPE_INNER_L4_TCP 0x01000000
469 * UDP (User Datagram Protocol) packet type.
470 * It is used for inner packet only.
472 * Packet format (inner only):
473 * <'ether type'=0x0800
474 * | 'version'=4, 'protocol'=17, 'MF'=0>
476 * <'ether type'=0x86DD
477 * | 'version'=6, 'next header'=17>
479 #define RTE_PTYPE_INNER_L4_UDP 0x02000000
481 * Fragmented IP (Internet Protocol) packet type.
482 * It is used for inner packet only, and may or maynot have layer 4 packet.
484 * Packet format (inner only):
485 * <'ether type'=0x0800
486 * | 'version'=4, 'MF'=1>
488 * <'ether type'=0x86DD
489 * | 'version'=6, 'next header'=44>
491 #define RTE_PTYPE_INNER_L4_FRAG 0x03000000
493 * SCTP (Stream Control Transmission Protocol) packet type.
494 * It is used for inner packet only.
496 * Packet format (inner only):
497 * <'ether type'=0x0800
498 * | 'version'=4, 'protocol'=132, 'MF'=0>
500 * <'ether type'=0x86DD
501 * | 'version'=6, 'next header'=132>
503 #define RTE_PTYPE_INNER_L4_SCTP 0x04000000
505 * ICMP (Internet Control Message Protocol) packet type.
506 * It is used for inner packet only.
508 * Packet format (inner only):
509 * <'ether type'=0x0800
510 * | 'version'=4, 'protocol'=1, 'MF'=0>
512 * <'ether type'=0x86DD
513 * | 'version'=6, 'next header'=1>
515 #define RTE_PTYPE_INNER_L4_ICMP 0x05000000
517 * Non-fragmented IP (Internet Protocol) packet type.
518 * It is used for inner packet only, and may or maynot have other unknown layer
521 * Packet format (inner only):
522 * <'ether type'=0x0800
523 * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0>
525 * <'ether type'=0x86DD
526 * | 'version'=6, 'next header'!=[6|17|44|132|1]>
528 #define RTE_PTYPE_INNER_L4_NONFRAG 0x06000000
530 * Mask of inner layer 4 packet types.
532 #define RTE_PTYPE_INNER_L4_MASK 0x0f000000
535 * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
536 * one, bit 4 is selected to be used for IPv4 only. Then checking bit 4 can
537 * determine if it is an IPV4 packet.
539 #define RTE_ETH_IS_IPV4_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV4)
542 * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
543 * one, bit 6 is selected to be used for IPv4 only. Then checking bit 6 can
544 * determine if it is an IPV4 packet.
546 #define RTE_ETH_IS_IPV6_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV6)
548 /* Check if it is a tunneling packet */
549 #define RTE_ETH_IS_TUNNEL_PKT(ptype) ((ptype) & \
550 (RTE_PTYPE_TUNNEL_MASK | \
551 RTE_PTYPE_INNER_L2_MASK | \
552 RTE_PTYPE_INNER_L3_MASK | \
553 RTE_PTYPE_INNER_L4_MASK))
559 #endif /* _RTE_MBUF_PTYPE_H_ */