net: add rte prefix to IP defines
[dpdk.git] / lib / librte_net / rte_ip.h
index 9a62ff6..9b1944b 100644 (file)
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * IPv4 Header
  */
-struct ipv4_hdr {
+struct rte_ipv4_hdr {
        uint8_t  version_ihl;           /**< version and header length */
        uint8_t  type_of_service;       /**< type of service */
        uint16_t total_length;          /**< length of packet */
@@ -42,52 +42,55 @@ struct ipv4_hdr {
 } __attribute__((__packed__));
 
 /** Create IPv4 address */
-#define IPv4(a,b,c,d) ((uint32_t)(((a) & 0xff) << 24) | \
+#define RTE_IPv4(a, b, c, d) ((uint32_t)(((a) & 0xff) << 24) | \
                                           (((b) & 0xff) << 16) | \
                                           (((c) & 0xff) << 8)  | \
                                           ((d) & 0xff))
 
 /** Maximal IPv4 packet length (including a header) */
-#define IPV4_MAX_PKT_LEN        65535
+#define RTE_IPV4_MAX_PKT_LEN        65535
 
 /** Internet header length mask for version_ihl field */
-#define IPV4_HDR_IHL_MASK      (0x0f)
+#define RTE_IPV4_HDR_IHL_MASK  (0x0f)
 /**
  * Internet header length field multiplier (IHL field specifies overall header
  * length in number of 4-byte words)
  */
-#define IPV4_IHL_MULTIPLIER    (4)
+#define RTE_IPV4_IHL_MULTIPLIER        (4)
 
 /* Fragment Offset * Flags. */
-#define        IPV4_HDR_DF_SHIFT       14
-#define        IPV4_HDR_MF_SHIFT       13
-#define        IPV4_HDR_FO_SHIFT       3
+#define        RTE_IPV4_HDR_DF_SHIFT   14
+#define        RTE_IPV4_HDR_MF_SHIFT   13
+#define        RTE_IPV4_HDR_FO_SHIFT   3
 
-#define        IPV4_HDR_DF_FLAG        (1 << IPV4_HDR_DF_SHIFT)
-#define        IPV4_HDR_MF_FLAG        (1 << IPV4_HDR_MF_SHIFT)
+#define        RTE_IPV4_HDR_DF_FLAG    (1 << RTE_IPV4_HDR_DF_SHIFT)
+#define        RTE_IPV4_HDR_MF_FLAG    (1 << RTE_IPV4_HDR_MF_SHIFT)
 
-#define        IPV4_HDR_OFFSET_MASK    ((1 << IPV4_HDR_MF_SHIFT) - 1)
+#define        RTE_IPV4_HDR_OFFSET_MASK        ((1 << RTE_IPV4_HDR_MF_SHIFT) - 1)
 
-#define        IPV4_HDR_OFFSET_UNITS   8
+#define        RTE_IPV4_HDR_OFFSET_UNITS       8
 
 /*
  * IPv4 address types
  */
-#define IPV4_ANY              ((uint32_t)0x00000000) /**< 0.0.0.0 */
-#define IPV4_LOOPBACK         ((uint32_t)0x7f000001) /**< 127.0.0.1 */
-#define IPV4_BROADCAST        ((uint32_t)0xe0000000) /**< 224.0.0.0 */
-#define IPV4_ALLHOSTS_GROUP   ((uint32_t)0xe0000001) /**< 224.0.0.1 */
-#define IPV4_ALLRTRS_GROUP    ((uint32_t)0xe0000002) /**< 224.0.0.2 */
-#define IPV4_MAX_LOCAL_GROUP  ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
+#define RTE_IPV4_ANY              ((uint32_t)0x00000000) /**< 0.0.0.0 */
+#define RTE_IPV4_LOOPBACK         ((uint32_t)0x7f000001) /**< 127.0.0.1 */
+#define RTE_IPV4_BROADCAST        ((uint32_t)0xe0000000) /**< 224.0.0.0 */
+#define RTE_IPV4_ALLHOSTS_GROUP   ((uint32_t)0xe0000001) /**< 224.0.0.1 */
+#define RTE_IPV4_ALLRTRS_GROUP    ((uint32_t)0xe0000002) /**< 224.0.0.2 */
+#define RTE_IPV4_MAX_LOCAL_GROUP  ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
 
 /*
  * IPv4 Multicast-related macros
  */
-#define IPV4_MIN_MCAST  IPv4(224, 0, 0, 0)          /**< Minimal IPv4-multicast address */
-#define IPV4_MAX_MCAST  IPv4(239, 255, 255, 255)    /**< Maximum IPv4 multicast address */
+#define RTE_IPV4_MIN_MCAST \
+       RTE_IPv4(224, 0, 0, 0)          /**< Minimal IPv4-multicast address */
+#define RTE_IPV4_MAX_MCAST \
+       RTE_IPv4(239, 255, 255, 255)    /**< Maximum IPv4 multicast address */
 
-#define IS_IPV4_MCAST(x) \
-       ((x) >= IPV4_MIN_MCAST && (x) <= IPV4_MAX_MCAST) /**< check if IPv4 address is multicast */
+#define RTE_IS_IPV4_MCAST(x) \
+       ((x) >= RTE_IPV4_MIN_MCAST && (x) <= RTE_IPV4_MAX_MCAST)
+       /**< check if IPv4 address is multicast */
 
 /**
  * @internal Calculate a sum of all words in the buffer.
@@ -108,25 +111,25 @@ __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
        /* workaround gcc strict-aliasing warning */
        uintptr_t ptr = (uintptr_t)buf;
        typedef uint16_t __attribute__((__may_alias__)) u16_p;
-       const u16_p *u16 = (const u16_p *)ptr;
-
-       while (len >= (sizeof(*u16) * 4)) {
-               sum += u16[0];
-               sum += u16[1];
-               sum += u16[2];
-               sum += u16[3];
-               len -= sizeof(*u16) * 4;
-               u16 += 4;
+       const u16_p *u16_buf = (const u16_p *)ptr;
+
+       while (len >= (sizeof(*u16_buf) * 4)) {
+               sum += u16_buf[0];
+               sum += u16_buf[1];
+               sum += u16_buf[2];
+               sum += u16_buf[3];
+               len -= sizeof(*u16_buf) * 4;
+               u16_buf += 4;
        }
-       while (len >= sizeof(*u16)) {
-               sum += *u16;
-               len -= sizeof(*u16);
-               u16 += 1;
+       while (len >= sizeof(*u16_buf)) {
+               sum += *u16_buf;
+               len -= sizeof(*u16_buf);
+               u16_buf += 1;
        }
 
        /* if length is in odd bytes */
        if (len == 1)
-               sum += *((const uint8_t *)u16);
+               sum += *((const uint8_t *)u16_buf);
 
        return sum;
 }
@@ -222,7 +225,7 @@ rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
        for (;;) {
                tmp = __rte_raw_cksum(buf, seglen, 0);
                if (done & 1)
-                       tmp = rte_bswap16(tmp);
+                       tmp = rte_bswap16((uint16_t)tmp);
                sum += tmp;
                done += seglen;
                if (done == len)
@@ -249,11 +252,11 @@ rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
  *   The complemented checksum to set in the IP packet.
  */
 static inline uint16_t
-rte_ipv4_cksum(const struct ipv4_hdr *ipv4_hdr)
+rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
 {
        uint16_t cksum;
-       cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct ipv4_hdr));
-       return (cksum == 0xffff) ? cksum : ~cksum;
+       cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct rte_ipv4_hdr));
+       return (cksum == 0xffff) ? cksum : (uint16_t)~cksum;
 }
 
 /**
@@ -275,7 +278,7 @@ rte_ipv4_cksum(const struct ipv4_hdr *ipv4_hdr)
  *   The non-complemented checksum to set in the L4 header.
  */
 static inline uint16_t
-rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
+rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
 {
        struct ipv4_psd_header {
                uint32_t src_addr; /* IP address of source host. */
@@ -294,7 +297,7 @@ rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
        } else {
                psd_hdr.len = rte_cpu_to_be_16(
                        (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
-                               - sizeof(struct ipv4_hdr)));
+                               - sizeof(struct rte_ipv4_hdr)));
        }
        return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
 }
@@ -310,16 +313,20 @@ rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
  * @param l4_hdr
  *   The pointer to the beginning of the L4 header.
  * @return
- *   The complemented checksum to set in the IP packet.
+ *   The complemented checksum to set in the IP packet
+ *   or 0 on error
  */
 static inline uint16_t
-rte_ipv4_udptcp_cksum(const struct ipv4_hdr *ipv4_hdr, const void *l4_hdr)
+rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
 {
        uint32_t cksum;
-       uint32_t l4_len;
+       uint32_t l3_len, l4_len;
 
-       l4_len = rte_be_to_cpu_16(ipv4_hdr->total_length) -
-               sizeof(struct ipv4_hdr);
+       l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
+       if (l3_len < sizeof(struct rte_ipv4_hdr))
+               return 0;
+
+       l4_len = l3_len - sizeof(struct rte_ipv4_hdr);
 
        cksum = rte_raw_cksum(l4_hdr, l4_len);
        cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
@@ -329,13 +336,13 @@ rte_ipv4_udptcp_cksum(const struct ipv4_hdr *ipv4_hdr, const void *l4_hdr)
        if (cksum == 0)
                cksum = 0xffff;
 
-       return cksum;
+       return (uint16_t)cksum;
 }
 
 /**
  * IPv6 Header
  */
-struct ipv6_hdr {
+struct rte_ipv6_hdr {
        uint32_t vtc_flow;     /**< IP version, traffic class & flow label. */
        uint16_t payload_len;  /**< IP packet length - includes sizeof(ip_header). */
        uint8_t  proto;        /**< Protocol, next header. */
@@ -344,6 +351,12 @@ struct ipv6_hdr {
        uint8_t  dst_addr[16]; /**< IP address of destination host(s). */
 } __attribute__((__packed__));
 
+/* IPv6 vtc_flow: IPv / TC / flow_label */
+#define RTE_IPV6_HDR_FL_SHIFT 0
+#define RTE_IPV6_HDR_TC_SHIFT 20
+#define RTE_IPV6_HDR_FL_MASK ((1u << RTE_IPV6_HDR_TC_SHIFT) - 1)
+#define RTE_IPV6_HDR_TC_MASK (0xf << RTE_IPV6_HDR_TC_SHIFT)
+
 /**
  * Process the pseudo-header checksum of an IPv6 header.
  *
@@ -361,7 +374,7 @@ struct ipv6_hdr {
  *   The non-complemented checksum to set in the L4 header.
  */
 static inline uint16_t
-rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
+rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
 {
        uint32_t sum;
        struct {
@@ -369,7 +382,7 @@ rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
                uint32_t proto; /* L4 protocol - top 3 bytes must be zero */
        } psd_hdr;
 
-       psd_hdr.proto = (ipv6_hdr->proto << 24);
+       psd_hdr.proto = (uint32_t)(ipv6_hdr->proto << 24);
        if (ol_flags & PKT_TX_TCP_SEG) {
                psd_hdr.len = 0;
        } else {
@@ -397,7 +410,7 @@ rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
  *   The complemented checksum to set in the IP packet.
  */
 static inline uint16_t
-rte_ipv6_udptcp_cksum(const struct ipv6_hdr *ipv6_hdr, const void *l4_hdr)
+rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
 {
        uint32_t cksum;
        uint32_t l4_len;
@@ -412,7 +425,7 @@ rte_ipv6_udptcp_cksum(const struct ipv6_hdr *ipv6_hdr, const void *l4_hdr)
        if (cksum == 0)
                cksum = 0xffff;
 
-       return cksum;
+       return (uint16_t)cksum;
 }
 
 #ifdef __cplusplus