lib/librte_mbuf/rte_mbuf_ptype.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 Intel Corporation.
   5  *   Copyright 2014-2016 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  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
  17  *       distribution.
  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.
  21  *
  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.
  33  */
  34
  35 #ifndef _RTE_MBUF_PTYPE_H_
  36 #define _RTE_MBUF_PTYPE_H_
  37
  38 /**
  39  * @file
  40  * RTE Mbuf Packet Types
  41  *
  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.
  45  *
  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.
  56  *
  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.
  60  *
  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.
  64  *
  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.
  68  *
  69  * examples:
  70  * <'ether type'=0x0800
  71  * | 'version'=4, 'protocol'=0x29
  72  * | 'version'=6, 'next header'=0x3A
  73  * | 'ICMPv6 header'>
  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.
  80  *
  81  * <'ether type'=0x86DD
  82  * | 'version'=6, 'next header'=0x2F
  83  * | 'GRE header'
  84  * | 'version'=6, 'next header'=0x11
  85  * | 'UDP header'>
  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.
  92  */
  93
  94 #include <stddef.h>
  95 #include <stdint.h>
  96
  97 #ifdef __cplusplus
  98 extern "C" {
  99 #endif
 100
 101 /**
 102  * No packet type information.
 103  */
 104 #define RTE_PTYPE_UNKNOWN                   0x00000000
 105 /**
 106  * Ethernet packet type.
 107  * It is used for outer packet for tunneling cases.
 108  *
 109  * Packet format:
 110  * <'ether type'=[0x0800|0x86DD]>
 111  */
 112 #define RTE_PTYPE_L2_ETHER                  0x00000001
 113 /**
 114  * Ethernet packet type for time sync.
 115  *
 116  * Packet format:
 117  * <'ether type'=0x88F7>
 118  */
 119 #define RTE_PTYPE_L2_ETHER_TIMESYNC         0x00000002
 120 /**
 121  * ARP (Address Resolution Protocol) packet type.
 122  *
 123  * Packet format:
 124  * <'ether type'=0x0806>
 125  */
 126 #define RTE_PTYPE_L2_ETHER_ARP              0x00000003
 127 /**
 128  * LLDP (Link Layer Discovery Protocol) packet type.
 129  *
 130  * Packet format:
 131  * <'ether type'=0x88CC>
 132  */
 133 #define RTE_PTYPE_L2_ETHER_LLDP             0x00000004
 134 /**
 135  * NSH (Network Service Header) packet type.
 136  *
 137  * Packet format:
 138  * <'ether type'=0x894F>
 139  */
 140 #define RTE_PTYPE_L2_ETHER_NSH              0x00000005
 141 /**
 142  * VLAN packet type.
 143  *
 144  * Packet format:
 145  * <'ether type'=[0x8100]>
 146  */
 147 #define RTE_PTYPE_L2_ETHER_VLAN             0x00000006
 148 /**
 149  * QinQ packet type.
 150  *
 151  * Packet format:
 152  * <'ether type'=[0x88A8]>
 153  */
 154 #define RTE_PTYPE_L2_ETHER_QINQ             0x00000007
 155 /**
 156  * Mask of layer 2 packet types.
 157  * It is used for outer packet for tunneling cases.
 158  */
 159 #define RTE_PTYPE_L2_MASK                   0x0000000f
 160 /**
 161  * IP (Internet Protocol) version 4 packet type.
 162  * It is used for outer packet for tunneling cases, and does not contain any
 163  * header option.
 164  *
 165  * Packet format:
 166  * <'ether type'=0x0800
 167  * | 'version'=4, 'ihl'=5>
 168  */
 169 #define RTE_PTYPE_L3_IPV4                   0x00000010
 170 /**
 171  * IP (Internet Protocol) version 4 packet type.
 172  * It is used for outer packet for tunneling cases, and contains header
 173  * options.
 174  *
 175  * Packet format:
 176  * <'ether type'=0x0800
 177  * | 'version'=4, 'ihl'=[6-15], 'options'>
 178  */
 179 #define RTE_PTYPE_L3_IPV4_EXT               0x00000030
 180 /**
 181  * IP (Internet Protocol) version 6 packet type.
 182  * It is used for outer packet for tunneling cases, and does not contain any
 183  * extension header.
 184  *
 185  * Packet format:
 186  * <'ether type'=0x86DD
 187  * | 'version'=6, 'next header'=0x3B>
 188  */
 189 #define RTE_PTYPE_L3_IPV6                   0x00000040
 190 /**
 191  * IP (Internet Protocol) version 4 packet type.
 192  * It is used for outer packet for tunneling cases, and may or maynot contain
 193  * header options.
 194  *
 195  * Packet format:
 196  * <'ether type'=0x0800
 197  * | 'version'=4, 'ihl'=[5-15], <'options'>>
 198  */
 199 #define RTE_PTYPE_L3_IPV4_EXT_UNKNOWN       0x00000090
 200 /**
 201  * IP (Internet Protocol) version 6 packet type.
 202  * It is used for outer packet for tunneling cases, and contains extension
 203  * headers.
 204  *
 205  * Packet format:
 206  * <'ether type'=0x86DD
 207  * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
 208  *   'extension headers'>
 209  */
 210 #define RTE_PTYPE_L3_IPV6_EXT               0x000000c0
 211 /**
 212  * IP (Internet Protocol) version 6 packet type.
 213  * It is used for outer packet for tunneling cases, and may or maynot contain
 214  * extension headers.
 215  *
 216  * Packet format:
 217  * <'ether type'=0x86DD
 218  * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
 219  *   <'extension headers'>>
 220  */
 221 #define RTE_PTYPE_L3_IPV6_EXT_UNKNOWN       0x000000e0
 222 /**
 223  * Mask of layer 3 packet types.
 224  * It is used for outer packet for tunneling cases.
 225  */
 226 #define RTE_PTYPE_L3_MASK                   0x000000f0
 227 /**
 228  * TCP (Transmission Control Protocol) packet type.
 229  * It is used for outer packet for tunneling cases.
 230  *
 231  * Packet format:
 232  * <'ether type'=0x0800
 233  * | 'version'=4, 'protocol'=6, 'MF'=0, 'frag_offset'=0>
 234  * or,
 235  * <'ether type'=0x86DD
 236  * | 'version'=6, 'next header'=6>
 237  */
 238 #define RTE_PTYPE_L4_TCP                    0x00000100
 239 /**
 240  * UDP (User Datagram Protocol) packet type.
 241  * It is used for outer packet for tunneling cases.
 242  *
 243  * Packet format:
 244  * <'ether type'=0x0800
 245  * | 'version'=4, 'protocol'=17, 'MF'=0, 'frag_offset'=0>
 246  * or,
 247  * <'ether type'=0x86DD
 248  * | 'version'=6, 'next header'=17>
 249  */
 250 #define RTE_PTYPE_L4_UDP                    0x00000200
 251 /**
 252  * Fragmented IP (Internet Protocol) packet type.
 253  * It is used for outer packet for tunneling cases.
 254  *
 255  * It refers to those packets of any IP types, which can be recognized as
 256  * fragmented. A fragmented packet cannot be recognized as any other L4 types
 257  * (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP,
 258  * RTE_PTYPE_L4_NONFRAG).
 259  *
 260  * Packet format:
 261  * <'ether type'=0x0800
 262  * | 'version'=4, 'MF'=1>
 263  * or,
 264  * <'ether type'=0x0800
 265  * | 'version'=4, 'frag_offset'!=0>
 266  * or,
 267  * <'ether type'=0x86DD
 268  * | 'version'=6, 'next header'=44>
 269  */
 270 #define RTE_PTYPE_L4_FRAG                   0x00000300
 271 /**
 272  * SCTP (Stream Control Transmission Protocol) packet type.
 273  * It is used for outer packet for tunneling cases.
 274  *
 275  * Packet format:
 276  * <'ether type'=0x0800
 277  * | 'version'=4, 'protocol'=132, 'MF'=0, 'frag_offset'=0>
 278  * or,
 279  * <'ether type'=0x86DD
 280  * | 'version'=6, 'next header'=132>
 281  */
 282 #define RTE_PTYPE_L4_SCTP                   0x00000400
 283 /**
 284  * ICMP (Internet Control Message Protocol) packet type.
 285  * It is used for outer packet for tunneling cases.
 286  *
 287  * Packet format:
 288  * <'ether type'=0x0800
 289  * | 'version'=4, 'protocol'=1, 'MF'=0, 'frag_offset'=0>
 290  * or,
 291  * <'ether type'=0x86DD
 292  * | 'version'=6, 'next header'=1>
 293  */
 294 #define RTE_PTYPE_L4_ICMP                   0x00000500
 295 /**
 296  * Non-fragmented IP (Internet Protocol) packet type.
 297  * It is used for outer packet for tunneling cases.
 298  *
 299  * It refers to those packets of any IP types, while cannot be recognized as
 300  * any of above L4 types (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP,
 301  * RTE_PTYPE_L4_FRAG, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP).
 302  *
 303  * Packet format:
 304  * <'ether type'=0x0800
 305  * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0, 'frag_offset'=0>
 306  * or,
 307  * <'ether type'=0x86DD
 308  * | 'version'=6, 'next header'!=[6|17|44|132|1]>
 309  */
 310 #define RTE_PTYPE_L4_NONFRAG                0x00000600
 311 /**
 312  * Mask of layer 4 packet types.
 313  * It is used for outer packet for tunneling cases.
 314  */
 315 #define RTE_PTYPE_L4_MASK                   0x00000f00
 316 /**
 317  * IP (Internet Protocol) in IP (Internet Protocol) tunneling packet type.
 318  *
 319  * Packet format:
 320  * <'ether type'=0x0800
 321  * | 'version'=4, 'protocol'=[4|41]>
 322  * or,
 323  * <'ether type'=0x86DD
 324  * | 'version'=6, 'next header'=[4|41]>
 325  */
 326 #define RTE_PTYPE_TUNNEL_IP                 0x00001000
 327 /**
 328  * GRE (Generic Routing Encapsulation) tunneling packet type.
 329  *
 330  * Packet format:
 331  * <'ether type'=0x0800
 332  * | 'version'=4, 'protocol'=47>
 333  * or,
 334  * <'ether type'=0x86DD
 335  * | 'version'=6, 'next header'=47>
 336  */
 337 #define RTE_PTYPE_TUNNEL_GRE                0x00002000
 338 /**
 339  * VXLAN (Virtual eXtensible Local Area Network) tunneling packet type.
 340  *
 341  * Packet format:
 342  * <'ether type'=0x0800
 343  * | 'version'=4, 'protocol'=17
 344  * | 'destination port'=4789>
 345  * or,
 346  * <'ether type'=0x86DD
 347  * | 'version'=6, 'next header'=17
 348  * | 'destination port'=4789>
 349  */
 350 #define RTE_PTYPE_TUNNEL_VXLAN              0x00003000
 351 /**
 352  * NVGRE (Network Virtualization using Generic Routing Encapsulation) tunneling
 353  * packet type.
 354  *
 355  * Packet format:
 356  * <'ether type'=0x0800
 357  * | 'version'=4, 'protocol'=47
 358  * | 'protocol type'=0x6558>
 359  * or,
 360  * <'ether type'=0x86DD
 361  * | 'version'=6, 'next header'=47
 362  * | 'protocol type'=0x6558'>
 363  */
 364 #define RTE_PTYPE_TUNNEL_NVGRE              0x00004000
 365 /**
 366  * GENEVE (Generic Network Virtualization Encapsulation) tunneling packet type.
 367  *
 368  * Packet format:
 369  * <'ether type'=0x0800
 370  * | 'version'=4, 'protocol'=17
 371  * | 'destination port'=6081>
 372  * or,
 373  * <'ether type'=0x86DD
 374  * | 'version'=6, 'next header'=17
 375  * | 'destination port'=6081>
 376  */
 377 #define RTE_PTYPE_TUNNEL_GENEVE             0x00005000
 378 /**
 379  * Tunneling packet type of Teredo, VXLAN (Virtual eXtensible Local Area
 380  * Network) or GRE (Generic Routing Encapsulation) could be recognized as this
 381  * packet type, if they can not be recognized independently as of hardware
 382  * capability.
 383  */
 384 #define RTE_PTYPE_TUNNEL_GRENAT             0x00006000
 385 /**
 386  * GTP-C (GPRS Tunnelling Protocol) control tunneling packet type.
 387  * Packet format:
 388  * <'ether type'=0x0800
 389  * | 'version'=4, 'protocol'=17
 390  * | 'destination port'=2123>
 391  * or,
 392  * <'ether type'=0x86DD
 393  * | 'version'=6, 'next header'=17
 394  * | 'destination port'=2123>
 395  * or,
 396  * <'ether type'=0x0800
 397  * | 'version'=4, 'protocol'=17
 398  * | 'source port'=2123>
 399  * or,
 400  * <'ether type'=0x86DD
 401  * | 'version'=6, 'next header'=17
 402  * | 'source port'=2123>
 403  */
 404 #define RTE_PTYPE_TUNNEL_GTPC               0x00007000
 405 /**
 406  * GTP-U (GPRS Tunnelling Protocol) user data tunneling packet type.
 407  * Packet format:
 408  * <'ether type'=0x0800
 409  * | 'version'=4, 'protocol'=17
 410  * | 'destination port'=2152>
 411  * or,
 412  * <'ether type'=0x86DD
 413  * | 'version'=6, 'next header'=17
 414  * | 'destination port'=2152>
 415  */
 416 #define RTE_PTYPE_TUNNEL_GTPU               0x00008000
 417 /**
 418  * Mask of tunneling packet types.
 419  */
 420 #define RTE_PTYPE_TUNNEL_MASK               0x0000f000
 421 /**
 422  * Ethernet packet type.
 423  * It is used for inner packet type only.
 424  *
 425  * Packet format (inner only):
 426  * <'ether type'=[0x800|0x86DD]>
 427  */
 428 #define RTE_PTYPE_INNER_L2_ETHER            0x00010000
 429 /**
 430  * Ethernet packet type with VLAN (Virtual Local Area Network) tag.
 431  *
 432  * Packet format (inner only):
 433  * <'ether type'=[0x800|0x86DD], vlan=[1-4095]>
 434  */
 435 #define RTE_PTYPE_INNER_L2_ETHER_VLAN       0x00020000
 436 /**
 437  * QinQ packet type.
 438  *
 439  * Packet format:
 440  * <'ether type'=[0x88A8]>
 441  */
 442 #define RTE_PTYPE_INNER_L2_ETHER_QINQ       0x00030000
 443 /**
 444  * Mask of inner layer 2 packet types.
 445  */
 446 #define RTE_PTYPE_INNER_L2_MASK             0x000f0000
 447 /**
 448  * IP (Internet Protocol) version 4 packet type.
 449  * It is used for inner packet only, and does not contain any header option.
 450  *
 451  * Packet format (inner only):
 452  * <'ether type'=0x0800
 453  * | 'version'=4, 'ihl'=5>
 454  */
 455 #define RTE_PTYPE_INNER_L3_IPV4             0x00100000
 456 /**
 457  * IP (Internet Protocol) version 4 packet type.
 458  * It is used for inner packet only, and contains header options.
 459  *
 460  * Packet format (inner only):
 461  * <'ether type'=0x0800
 462  * | 'version'=4, 'ihl'=[6-15], 'options'>
 463  */
 464 #define RTE_PTYPE_INNER_L3_IPV4_EXT         0x00200000
 465 /**
 466  * IP (Internet Protocol) version 6 packet type.
 467  * It is used for inner packet only, and does not contain any extension header.
 468  *
 469  * Packet format (inner only):
 470  * <'ether type'=0x86DD
 471  * | 'version'=6, 'next header'=0x3B>
 472  */
 473 #define RTE_PTYPE_INNER_L3_IPV6             0x00300000
 474 /**
 475  * IP (Internet Protocol) version 4 packet type.
 476  * It is used for inner packet only, and may or maynot contain header options.
 477  *
 478  * Packet format (inner only):
 479  * <'ether type'=0x0800
 480  * | 'version'=4, 'ihl'=[5-15], <'options'>>
 481  */
 482 #define RTE_PTYPE_INNER_L3_IPV4_EXT_UNKNOWN 0x00400000
 483 /**
 484  * IP (Internet Protocol) version 6 packet type.
 485  * It is used for inner packet only, and contains extension headers.
 486  *
 487  * Packet format (inner only):
 488  * <'ether type'=0x86DD
 489  * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
 490  *   'extension headers'>
 491  */
 492 #define RTE_PTYPE_INNER_L3_IPV6_EXT         0x00500000
 493 /**
 494  * IP (Internet Protocol) version 6 packet type.
 495  * It is used for inner packet only, and may or maynot contain extension
 496  * headers.
 497  *
 498  * Packet format (inner only):
 499  * <'ether type'=0x86DD
 500  * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
 501  *   <'extension headers'>>
 502  */
 503 #define RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN 0x00600000
 504 /**
 505  * Mask of inner layer 3 packet types.
 506  */
 507 #define RTE_PTYPE_INNER_L3_MASK             0x00f00000
 508 /**
 509  * TCP (Transmission Control Protocol) packet type.
 510  * It is used for inner packet only.
 511  *
 512  * Packet format (inner only):
 513  * <'ether type'=0x0800
 514  * | 'version'=4, 'protocol'=6, 'MF'=0, 'frag_offset'=0>
 515  * or,
 516  * <'ether type'=0x86DD
 517  * | 'version'=6, 'next header'=6>
 518  */
 519 #define RTE_PTYPE_INNER_L4_TCP              0x01000000
 520 /**
 521  * UDP (User Datagram Protocol) packet type.
 522  * It is used for inner packet only.
 523  *
 524  * Packet format (inner only):
 525  * <'ether type'=0x0800
 526  * | 'version'=4, 'protocol'=17, 'MF'=0, 'frag_offset'=0>
 527  * or,
 528  * <'ether type'=0x86DD
 529  * | 'version'=6, 'next header'=17>
 530  */
 531 #define RTE_PTYPE_INNER_L4_UDP              0x02000000
 532 /**
 533  * Fragmented IP (Internet Protocol) packet type.
 534  * It is used for inner packet only, and may or maynot have layer 4 packet.
 535  *
 536  * Packet format (inner only):
 537  * <'ether type'=0x0800
 538  * | 'version'=4, 'MF'=1>
 539  * or,
 540  * <'ether type'=0x0800
 541  * | 'version'=4, 'frag_offset'!=0>
 542  * or,
 543  * <'ether type'=0x86DD
 544  * | 'version'=6, 'next header'=44>
 545  */
 546 #define RTE_PTYPE_INNER_L4_FRAG             0x03000000
 547 /**
 548  * SCTP (Stream Control Transmission Protocol) packet type.
 549  * It is used for inner packet only.
 550  *
 551  * Packet format (inner only):
 552  * <'ether type'=0x0800
 553  * | 'version'=4, 'protocol'=132, 'MF'=0, 'frag_offset'=0>
 554  * or,
 555  * <'ether type'=0x86DD
 556  * | 'version'=6, 'next header'=132>
 557  */
 558 #define RTE_PTYPE_INNER_L4_SCTP             0x04000000
 559 /**
 560  * ICMP (Internet Control Message Protocol) packet type.
 561  * It is used for inner packet only.
 562  *
 563  * Packet format (inner only):
 564  * <'ether type'=0x0800
 565  * | 'version'=4, 'protocol'=1, 'MF'=0, 'frag_offset'=0>
 566  * or,
 567  * <'ether type'=0x86DD
 568  * | 'version'=6, 'next header'=1>
 569  */
 570 #define RTE_PTYPE_INNER_L4_ICMP             0x05000000
 571 /**
 572  * Non-fragmented IP (Internet Protocol) packet type.
 573  * It is used for inner packet only, and may or maynot have other unknown layer
 574  * 4 packet types.
 575  *
 576  * Packet format (inner only):
 577  * <'ether type'=0x0800
 578  * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0, 'frag_offset'=0>
 579  * or,
 580  * <'ether type'=0x86DD
 581  * | 'version'=6, 'next header'!=[6|17|44|132|1]>
 582  */
 583 #define RTE_PTYPE_INNER_L4_NONFRAG          0x06000000
 584 /**
 585  * Mask of inner layer 4 packet types.
 586  */
 587 #define RTE_PTYPE_INNER_L4_MASK             0x0f000000
 588 /**
 589  * All valid layer masks.
 590  */
 591 #define RTE_PTYPE_ALL_MASK                  0x0fffffff
 592
 593 /**
 594  * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
 595  * one, bit 4 is selected to be used for IPv4 only. Then checking bit 4 can
 596  * determine if it is an IPV4 packet.
 597  */
 598 #define  RTE_ETH_IS_IPV4_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV4)
 599
 600 /**
 601  * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
 602  * one, bit 6 is selected to be used for IPv4 only. Then checking bit 6 can
 603  * determine if it is an IPV4 packet.
 604  */
 605 #define  RTE_ETH_IS_IPV6_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV6)
 606
 607 /* Check if it is a tunneling packet */
 608 #define RTE_ETH_IS_TUNNEL_PKT(ptype) ((ptype) &                         \
 609         (RTE_PTYPE_TUNNEL_MASK |                                        \
 610                 RTE_PTYPE_INNER_L2_MASK |                               \
 611                 RTE_PTYPE_INNER_L3_MASK |                               \
 612                 RTE_PTYPE_INNER_L4_MASK))
 613
 614 /**
 615  * Get the name of the l2 packet type
 616  *
 617  * @param ptype
 618  *   The packet type value.
 619  * @return
 620  *   A non-null string describing the packet type.
 621  */
 622 const char *rte_get_ptype_l2_name(uint32_t ptype);
 623
 624 /**
 625  * Get the name of the l3 packet type
 626  *
 627  * @param ptype
 628  *   The packet type value.
 629  * @return
 630  *   A non-null string describing the packet type.
 631  */
 632 const char *rte_get_ptype_l3_name(uint32_t ptype);
 633
 634 /**
 635  * Get the name of the l4 packet type
 636  *
 637  * @param ptype
 638  *   The packet type value.
 639  * @return
 640  *   A non-null string describing the packet type.
 641  */
 642 const char *rte_get_ptype_l4_name(uint32_t ptype);
 643
 644 /**
 645  * Get the name of the tunnel packet type
 646  *
 647  * @param ptype
 648  *   The packet type value.
 649  * @return
 650  *   A non-null string describing the packet type.
 651  */
 652 const char *rte_get_ptype_tunnel_name(uint32_t ptype);
 653
 654 /**
 655  * Get the name of the inner_l2 packet type
 656  *
 657  * @param ptype
 658  *   The packet type value.
 659  * @return
 660  *   A non-null string describing the packet type.
 661  */
 662 const char *rte_get_ptype_inner_l2_name(uint32_t ptype);
 663
 664 /**
 665  * Get the name of the inner_l3 packet type
 666  *
 667  * @param ptype
 668  *   The packet type value.
 669  * @return
 670  *   A non-null string describing the packet type.
 671  */
 672 const char *rte_get_ptype_inner_l3_name(uint32_t ptype);
 673
 674 /**
 675  * Get the name of the inner_l4 packet type
 676  *
 677  * @param ptype
 678  *   The packet type value.
 679  * @return
 680  *   A non-null string describing the packet type.
 681  */
 682 const char *rte_get_ptype_inner_l4_name(uint32_t ptype);
 683
 684 /**
 685  * Write the packet type name into the buffer
 686  *
 687  * @param ptype
 688  *   The packet type value.
 689  * @param buf
 690  *   The buffer where the string is written.
 691  * @param buflen
 692  *   The length of the buffer.
 693  * @return
 694  *   - 0 on success
 695  *   - (-1) if the buffer is too small
 696  */
 697 int rte_get_ptype_name(uint32_t ptype, char *buf, size_t buflen);
 698
 699 #ifdef __cplusplus
 700 }
 701 #endif
 702
 703 #endif /* _RTE_MBUF_PTYPE_H_ */