lib/librte_net/rte_ip.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   Copyright 2014 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 /*
  36  * Copyright (c) 1982, 1986, 1990, 1993
  37  *      The Regents of the University of California.  All rights reserved.
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *      This product includes software developed by the University of
  50  *      California, Berkeley and its contributors.
  51  * 4. Neither the name of the University nor the names of its contributors
  52  *    may be used to endorse or promote products derived from this software
  53  *    without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  *
  67  *      @(#)in.h        8.3 (Berkeley) 1/3/94
  68  * $FreeBSD: src/sys/netinet/in.h,v 1.82 2003/10/25 09:37:10 ume Exp $
  69  */
  70
  71 #ifndef _RTE_IP_H_
  72 #define _RTE_IP_H_
  73
  74 /**
  75  * @file
  76  *
  77  * IP-related defines
  78  */
  79
  80 #include <stdint.h>
  81 #include <netinet/in.h>
  82
  83 #include <rte_memcpy.h>
  84 #include <rte_byteorder.h>
  85 #include <rte_mbuf.h>
  86
  87 #ifdef __cplusplus
  88 extern "C" {
  89 #endif
  90
  91 /**
  92  * IPv4 Header
  93  */
  94 struct ipv4_hdr {
  95         uint8_t  version_ihl;           /**< version and header length */
  96         uint8_t  type_of_service;       /**< type of service */
  97         uint16_t total_length;          /**< length of packet */
  98         uint16_t packet_id;             /**< packet ID */
  99         uint16_t fragment_offset;       /**< fragmentation offset */
 100         uint8_t  time_to_live;          /**< time to live */
 101         uint8_t  next_proto_id;         /**< protocol ID */
 102         uint16_t hdr_checksum;          /**< header checksum */
 103         uint32_t src_addr;              /**< source address */
 104         uint32_t dst_addr;              /**< destination address */
 105 } __attribute__((__packed__));
 106
 107 /** Create IPv4 address */
 108 #define IPv4(a,b,c,d) ((uint32_t)(((a) & 0xff) << 24) | \
 109                                            (((b) & 0xff) << 16) | \
 110                                            (((c) & 0xff) << 8)  | \
 111                                            ((d) & 0xff))
 112
 113 /* Fragment Offset * Flags. */
 114 #define IPV4_HDR_DF_SHIFT       14
 115 #define IPV4_HDR_MF_SHIFT       13
 116 #define IPV4_HDR_FO_SHIFT       3
 117
 118 #define IPV4_HDR_DF_FLAG        (1 << IPV4_HDR_DF_SHIFT)
 119 #define IPV4_HDR_MF_FLAG        (1 << IPV4_HDR_MF_SHIFT)
 120
 121 #define IPV4_HDR_OFFSET_MASK    ((1 << IPV4_HDR_MF_SHIFT) - 1)
 122
 123 #define IPV4_HDR_OFFSET_UNITS   8
 124
 125 /*
 126  * IPv4 address types
 127  */
 128 #define IPV4_ANY              ((uint32_t)0x00000000) /**< 0.0.0.0 */
 129 #define IPV4_LOOPBACK         ((uint32_t)0x7f000001) /**< 127.0.0.1 */
 130 #define IPV4_BROADCAST        ((uint32_t)0xe0000000) /**< 224.0.0.0 */
 131 #define IPV4_ALLHOSTS_GROUP   ((uint32_t)0xe0000001) /**< 224.0.0.1 */
 132 #define IPV4_ALLRTRS_GROUP    ((uint32_t)0xe0000002) /**< 224.0.0.2 */
 133 #define IPV4_MAX_LOCAL_GROUP  ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
 134
 135 /*
 136  * IPv4 Multicast-related macros
 137  */
 138 #define IPV4_MIN_MCAST  IPv4(224, 0, 0, 0)          /**< Minimal IPv4-multicast address */
 139 #define IPV4_MAX_MCAST  IPv4(239, 255, 255, 255)    /**< Maximum IPv4 multicast address */
 140
 141 #define IS_IPV4_MCAST(x) \
 142         ((x) >= IPV4_MIN_MCAST && (x) <= IPV4_MAX_MCAST) /**< check if IPv4 address is multicast */
 143
 144 /**
 145  * Process the non-complemented checksum of a buffer.
 146  *
 147  * @param buf
 148  *   Pointer to the buffer.
 149  * @param len
 150  *   Length of the buffer.
 151  * @return
 152  *   The non-complemented checksum.
 153  */
 154 static inline uint16_t
 155 rte_raw_cksum(const char *buf, size_t len)
 156 {
 157         const uint16_t *u16 = (const uint16_t *)buf;
 158         uint32_t sum = 0;
 159
 160         while (len >= (sizeof(*u16) * 4)) {
 161                 sum += u16[0];
 162                 sum += u16[1];
 163                 sum += u16[2];
 164                 sum += u16[3];
 165                 len -= sizeof(*u16) * 4;
 166                 u16 += 4;
 167         }
 168         while (len >= sizeof(*u16)) {
 169                 sum += *u16;
 170                 len -= sizeof(*u16);
 171                 u16 += 1;
 172         }
 173
 174         /* if length is in odd bytes */
 175         if (len == 1)
 176                 sum += *((const uint8_t *)u16);
 177
 178         sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
 179         sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
 180         return (uint16_t)sum;
 181 }
 182
 183 /**
 184  * Process the IPv4 checksum of an IPv4 header.
 185  *
 186  * The checksum field must be set to 0 by the caller.
 187  *
 188  * @param ipv4_hdr
 189  *   The pointer to the contiguous IPv4 header.
 190  * @return
 191  *   The complemented checksum to set in the IP packet.
 192  */
 193 static inline uint16_t
 194 rte_ipv4_cksum(const struct ipv4_hdr *ipv4_hdr)
 195 {
 196         uint16_t cksum;
 197         cksum = rte_raw_cksum((const char *)ipv4_hdr, sizeof(struct ipv4_hdr));
 198         return ((cksum == 0xffff) ? cksum : ~cksum);
 199 }
 200
 201 /**
 202  * Process the pseudo-header checksum of an IPv4 header.
 203  *
 204  * The checksum field must be set to 0 by the caller.
 205  *
 206  * Depending on the ol_flags, the pseudo-header checksum expected by the
 207  * drivers is not the same. For instance, when TSO is enabled, the IP
 208  * payload length must not be included in the packet.
 209  *
 210  * When ol_flags is 0, it computes the standard pseudo-header checksum.
 211  *
 212  * @param ipv4_hdr
 213  *   The pointer to the contiguous IPv4 header.
 214  * @param ol_flags
 215  *   The ol_flags of the associated mbuf.
 216  * @return
 217  *   The non-complemented checksum to set in the L4 header.
 218  */
 219 static inline uint16_t
 220 rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
 221 {
 222         struct ipv4_psd_header {
 223                 uint32_t src_addr; /* IP address of source host. */
 224                 uint32_t dst_addr; /* IP address of destination host. */
 225                 uint8_t  zero;     /* zero. */
 226                 uint8_t  proto;    /* L4 protocol type. */
 227                 uint16_t len;      /* L4 length. */
 228         } psd_hdr;
 229
 230         psd_hdr.src_addr = ipv4_hdr->src_addr;
 231         psd_hdr.dst_addr = ipv4_hdr->dst_addr;
 232         psd_hdr.zero = 0;
 233         psd_hdr.proto = ipv4_hdr->next_proto_id;
 234         if (ol_flags & PKT_TX_TCP_SEG) {
 235                 psd_hdr.len = 0;
 236         } else {
 237                 psd_hdr.len = rte_cpu_to_be_16(
 238                         (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
 239                                 - sizeof(struct ipv4_hdr)));
 240         }
 241         return rte_raw_cksum((const char *)&psd_hdr, sizeof(psd_hdr));
 242 }
 243
 244 /**
 245  * Process the IPv4 UDP or TCP checksum.
 246  *
 247  * The IPv4 header should not contains options. The IP and layer 4
 248  * checksum must be set to 0 in the packet by the caller.
 249  *
 250  * @param ipv4_hdr
 251  *   The pointer to the contiguous IPv4 header.
 252  * @param l4_hdr
 253  *   The pointer to the beginning of the L4 header.
 254  * @return
 255  *   The complemented checksum to set in the IP packet.
 256  */
 257 static inline uint16_t
 258 rte_ipv4_udptcp_cksum(const struct ipv4_hdr *ipv4_hdr, const void *l4_hdr)
 259 {
 260         uint32_t cksum;
 261         uint32_t l4_len;
 262
 263         l4_len = rte_be_to_cpu_16(ipv4_hdr->total_length) -
 264                 sizeof(struct ipv4_hdr);
 265
 266         cksum = rte_raw_cksum(l4_hdr, l4_len);
 267         cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
 268
 269         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 270         cksum = (~cksum) & 0xffff;
 271         if (cksum == 0)
 272                 cksum = 0xffff;
 273
 274         return cksum;
 275 }
 276
 277 /**
 278  * IPv6 Header
 279  */
 280 struct ipv6_hdr {
 281         uint32_t vtc_flow;     /**< IP version, traffic class & flow label. */
 282         uint16_t payload_len;  /**< IP packet length - includes sizeof(ip_header). */
 283         uint8_t  proto;        /**< Protocol, next header. */
 284         uint8_t  hop_limits;   /**< Hop limits. */
 285         uint8_t  src_addr[16]; /**< IP address of source host. */
 286         uint8_t  dst_addr[16]; /**< IP address of destination host(s). */
 287 } __attribute__((__packed__));
 288
 289 /**
 290  * Process the pseudo-header checksum of an IPv6 header.
 291  *
 292  * Depending on the ol_flags, the pseudo-header checksum expected by the
 293  * drivers is not the same. For instance, when TSO is enabled, the IPv6
 294  * payload length must not be included in the packet.
 295  *
 296  * When ol_flags is 0, it computes the standard pseudo-header checksum.
 297  *
 298  * @param ipv6_hdr
 299  *   The pointer to the contiguous IPv6 header.
 300  * @param ol_flags
 301  *   The ol_flags of the associated mbuf.
 302  * @return
 303  *   The non-complemented checksum to set in the L4 header.
 304  */
 305 static inline uint16_t
 306 rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
 307 {
 308         struct ipv6_psd_header {
 309                 uint8_t src_addr[16]; /* IP address of source host. */
 310                 uint8_t dst_addr[16]; /* IP address of destination host. */
 311                 uint32_t len;         /* L4 length. */
 312                 uint32_t proto;       /* L4 protocol - top 3 bytes must be zero */
 313         } psd_hdr;
 314
 315         rte_memcpy(&psd_hdr.src_addr, ipv6_hdr->src_addr,
 316                 sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr));
 317         psd_hdr.proto = (ipv6_hdr->proto << 24);
 318         if (ol_flags & PKT_TX_TCP_SEG) {
 319                 psd_hdr.len = 0;
 320         } else {
 321                 psd_hdr.len = ipv6_hdr->payload_len;
 322         }
 323
 324         return rte_raw_cksum((const char *)&psd_hdr, sizeof(psd_hdr));
 325 }
 326
 327 /**
 328  * Process the IPv6 UDP or TCP checksum.
 329  *
 330  * The IPv4 header should not contains options. The layer 4 checksum
 331  * must be set to 0 in the packet by the caller.
 332  *
 333  * @param ipv6_hdr
 334  *   The pointer to the contiguous IPv6 header.
 335  * @param l4_hdr
 336  *   The pointer to the beginning of the L4 header.
 337  * @return
 338  *   The complemented checksum to set in the IP packet.
 339  */
 340 static inline uint16_t
 341 rte_ipv6_udptcp_cksum(const struct ipv6_hdr *ipv6_hdr, const void *l4_hdr)
 342 {
 343         uint32_t cksum;
 344         uint32_t l4_len;
 345
 346         l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
 347
 348         cksum = rte_raw_cksum(l4_hdr, l4_len);
 349         cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
 350
 351         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 352         cksum = (~cksum) & 0xffff;
 353         if (cksum == 0)
 354                 cksum = 0xffff;
 355
 356         return cksum;
 357 }
 358
 359 #ifdef __cplusplus
 360 }
 361 #endif
 362
 363 #endif /* _RTE_IP_H_ */