rte_mbuf_ptype.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2016 Intel Corporation.
 *   Copyright 2014-2016 6WIND S.A.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_MBUF_PTYPE_H_
#define _RTE_MBUF_PTYPE_H_

#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_PTYPE_UNKNOWN                   0x00000000

#define RTE_PTYPE_L2_ETHER                  0x00000001

#define RTE_PTYPE_L2_ETHER_TIMESYNC         0x00000002

#define RTE_PTYPE_L2_ETHER_ARP              0x00000003

#define RTE_PTYPE_L2_ETHER_LLDP             0x00000004

#define RTE_PTYPE_L2_ETHER_NSH              0x00000005

#define RTE_PTYPE_L2_ETHER_VLAN             0x00000006

#define RTE_PTYPE_L2_ETHER_QINQ             0x00000007

#define RTE_PTYPE_L2_MASK                   0x0000000f

#define RTE_PTYPE_L3_IPV4                   0x00000010

#define RTE_PTYPE_L3_IPV4_EXT               0x00000030

#define RTE_PTYPE_L3_IPV6                   0x00000040

#define RTE_PTYPE_L3_IPV4_EXT_UNKNOWN       0x00000090

#define RTE_PTYPE_L3_IPV6_EXT               0x000000c0

#define RTE_PTYPE_L3_IPV6_EXT_UNKNOWN       0x000000e0

#define RTE_PTYPE_L3_MASK                   0x000000f0

#define RTE_PTYPE_L4_TCP                    0x00000100

#define RTE_PTYPE_L4_UDP                    0x00000200

#define RTE_PTYPE_L4_FRAG                   0x00000300

#define RTE_PTYPE_L4_SCTP                   0x00000400

#define RTE_PTYPE_L4_ICMP                   0x00000500

#define RTE_PTYPE_L4_NONFRAG                0x00000600

#define RTE_PTYPE_L4_MASK                   0x00000f00

#define RTE_PTYPE_TUNNEL_IP                 0x00001000

#define RTE_PTYPE_TUNNEL_GRE                0x00002000

#define RTE_PTYPE_TUNNEL_VXLAN              0x00003000

#define RTE_PTYPE_TUNNEL_NVGRE              0x00004000

#define RTE_PTYPE_TUNNEL_GENEVE             0x00005000

#define RTE_PTYPE_TUNNEL_GRENAT             0x00006000

#define RTE_PTYPE_TUNNEL_MASK               0x0000f000

#define RTE_PTYPE_INNER_L2_ETHER            0x00010000

#define RTE_PTYPE_INNER_L2_ETHER_VLAN       0x00020000

#define RTE_PTYPE_INNER_L2_ETHER_QINQ       0x00030000

#define RTE_PTYPE_INNER_L2_MASK             0x000f0000

#define RTE_PTYPE_INNER_L3_IPV4             0x00100000

#define RTE_PTYPE_INNER_L3_IPV4_EXT         0x00200000

#define RTE_PTYPE_INNER_L3_IPV6             0x00300000

#define RTE_PTYPE_INNER_L3_IPV4_EXT_UNKNOWN 0x00400000

#define RTE_PTYPE_INNER_L3_IPV6_EXT         0x00500000

#define RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN 0x00600000

#define RTE_PTYPE_INNER_L3_MASK             0x00f00000

#define RTE_PTYPE_INNER_L4_TCP              0x01000000

#define RTE_PTYPE_INNER_L4_UDP              0x02000000

#define RTE_PTYPE_INNER_L4_FRAG             0x03000000

#define RTE_PTYPE_INNER_L4_SCTP             0x04000000

#define RTE_PTYPE_INNER_L4_ICMP             0x05000000

#define RTE_PTYPE_INNER_L4_NONFRAG          0x06000000

#define RTE_PTYPE_INNER_L4_MASK             0x0f000000

#define RTE_PTYPE_ALL_MASK                  0x0fffffff

#define  RTE_ETH_IS_IPV4_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV4)

#define  RTE_ETH_IS_IPV6_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV6)

/* Check if it is a tunneling packet */
#define RTE_ETH_IS_TUNNEL_PKT(ptype) ((ptype) &                         \
        (RTE_PTYPE_TUNNEL_MASK |                                        \
                RTE_PTYPE_INNER_L2_MASK |                               \
                RTE_PTYPE_INNER_L3_MASK |                               \
                RTE_PTYPE_INNER_L4_MASK))

const char *rte_get_ptype_l2_name(uint32_t ptype);

const char *rte_get_ptype_l3_name(uint32_t ptype);

const char *rte_get_ptype_l4_name(uint32_t ptype);

const char *rte_get_ptype_tunnel_name(uint32_t ptype);

const char *rte_get_ptype_inner_l2_name(uint32_t ptype);

const char *rte_get_ptype_inner_l3_name(uint32_t ptype);

const char *rte_get_ptype_inner_l4_name(uint32_t ptype);

int rte_get_ptype_name(uint32_t ptype, char *buf, size_t buflen);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_MBUF_PTYPE_H_ */