lib/librte_net/rte_net.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2016 6WIND S.A.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_NET_PTYPE_H_
  35 #define _RTE_NET_PTYPE_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * Structure containing header lengths associated to a packet, filled
  43  * by rte_net_get_ptype().
  44  */
  45 struct rte_net_hdr_lens {
  46         uint8_t l2_len;
  47         uint8_t l3_len;
  48         uint8_t l4_len;
  49         uint8_t tunnel_len;
  50         uint8_t inner_l2_len;
  51         uint8_t inner_l3_len;
  52         uint8_t inner_l4_len;
  53 };
  54
  55 /**
  56  * Parse an Ethernet packet to get its packet type.
  57  *
  58  * This function parses the network headers in mbuf data and return its
  59  * packet type.
  60  *
  61  * If it is provided by the user, it also fills a rte_net_hdr_lens
  62  * structure that contains the lengths of the parsed network
  63  * headers. Each length field is valid only if the associated packet
  64  * type is set. For instance, hdr_lens->l2_len is valid only if
  65  * (retval & RTE_PTYPE_L2_MASK) != RTE_PTYPE_UNKNOWN.
  66  *
  67  * Supported packet types are:
  68  *   L2: Ether, Vlan, QinQ
  69  *   L3: IPv4, IPv6
  70  *   L4: TCP, UDP, SCTP
  71  *   Tunnels: IPv4, IPv6, Gre, Nvgre
  72  *
  73  * @param m
  74  *   The packet mbuf to be parsed.
  75  * @param hdr_lens
  76  *   A pointer to a structure where the header lengths will be returned,
  77  *   or NULL.
  78  * @param layers
  79  *   List of layers to parse. The function will stop at the first
  80  *   empty layer. Examples:
  81  *   - To parse all known layers, use RTE_PTYPE_ALL_MASK.
  82  *   - To parse only L2 and L3, use RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK
  83  * @return
  84  *   The packet type of the packet.
  85  */
  86 uint32_t rte_net_get_ptype(const struct rte_mbuf *m,
  87         struct rte_net_hdr_lens *hdr_lens, uint32_t layers);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93
  94 #endif /* _RTE_NET_PTYPE_H_ */