lib/librte_net/rte_ip.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 1982, 1986, 1990, 1993
   3  *      The Regents of the University of California.
   4  * Copyright(c) 2010-2014 Intel Corporation.
   5  * Copyright(c) 2014 6WIND S.A.
   6  * All rights reserved.
   7  */
   8
   9 #ifndef _RTE_IP_H_
  10 #define _RTE_IP_H_
  11
  12 /**
  13  * @file
  14  *
  15  * IP-related defines
  16  */
  17
  18 #include <stdint.h>
  19 #include <sys/types.h>
  20 #include <netinet/in.h>
  21 #include <netinet/ip.h>
  22
  23 #include <rte_byteorder.h>
  24 #include <rte_mbuf.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /**
  31  * IPv4 Header
  32  */
  33 struct rte_ipv4_hdr {
  34         uint8_t  version_ihl;           /**< version and header length */
  35         uint8_t  type_of_service;       /**< type of service */
  36         rte_be16_t total_length;        /**< length of packet */
  37         rte_be16_t packet_id;           /**< packet ID */
  38         rte_be16_t fragment_offset;     /**< fragmentation offset */
  39         uint8_t  time_to_live;          /**< time to live */
  40         uint8_t  next_proto_id;         /**< protocol ID */
  41         rte_be16_t hdr_checksum;        /**< header checksum */
  42         rte_be32_t src_addr;            /**< source address */
  43         rte_be32_t dst_addr;            /**< destination address */
  44 } __rte_packed;
  45
  46 /** Create IPv4 address */
  47 #define RTE_IPV4(a, b, c, d) ((uint32_t)(((a) & 0xff) << 24) | \
  48                                            (((b) & 0xff) << 16) | \
  49                                            (((c) & 0xff) << 8)  | \
  50                                            ((d) & 0xff))
  51
  52 /** Maximal IPv4 packet length (including a header) */
  53 #define RTE_IPV4_MAX_PKT_LEN        65535
  54
  55 /** Internet header length mask for version_ihl field */
  56 #define RTE_IPV4_HDR_IHL_MASK   (0x0f)
  57 /**
  58  * Internet header length field multiplier (IHL field specifies overall header
  59  * length in number of 4-byte words)
  60  */
  61 #define RTE_IPV4_IHL_MULTIPLIER (4)
  62
  63 /* Type of Service fields */
  64 #define RTE_IPV4_HDR_DSCP_MASK  (0xfc)
  65 #define RTE_IPV4_HDR_ECN_MASK   (0x03)
  66 #define RTE_IPV4_HDR_ECN_CE     RTE_IPV4_HDR_ECN_MASK
  67
  68 /* Fragment Offset * Flags. */
  69 #define RTE_IPV4_HDR_DF_SHIFT   14
  70 #define RTE_IPV4_HDR_MF_SHIFT   13
  71 #define RTE_IPV4_HDR_FO_SHIFT   3
  72
  73 #define RTE_IPV4_HDR_DF_FLAG    (1 << RTE_IPV4_HDR_DF_SHIFT)
  74 #define RTE_IPV4_HDR_MF_FLAG    (1 << RTE_IPV4_HDR_MF_SHIFT)
  75
  76 #define RTE_IPV4_HDR_OFFSET_MASK        ((1 << RTE_IPV4_HDR_MF_SHIFT) - 1)
  77
  78 #define RTE_IPV4_HDR_OFFSET_UNITS       8
  79
  80 /*
  81  * IPv4 address types
  82  */
  83 #define RTE_IPV4_ANY              ((uint32_t)0x00000000) /**< 0.0.0.0 */
  84 #define RTE_IPV4_LOOPBACK         ((uint32_t)0x7f000001) /**< 127.0.0.1 */
  85 #define RTE_IPV4_BROADCAST        ((uint32_t)0xe0000000) /**< 224.0.0.0 */
  86 #define RTE_IPV4_ALLHOSTS_GROUP   ((uint32_t)0xe0000001) /**< 224.0.0.1 */
  87 #define RTE_IPV4_ALLRTRS_GROUP    ((uint32_t)0xe0000002) /**< 224.0.0.2 */
  88 #define RTE_IPV4_MAX_LOCAL_GROUP  ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
  89
  90 /*
  91  * IPv4 Multicast-related macros
  92  */
  93 #define RTE_IPV4_MIN_MCAST \
  94         RTE_IPV4(224, 0, 0, 0)          /**< Minimal IPv4-multicast address */
  95 #define RTE_IPV4_MAX_MCAST \
  96         RTE_IPV4(239, 255, 255, 255)    /**< Maximum IPv4 multicast address */
  97
  98 #define RTE_IS_IPV4_MCAST(x) \
  99         ((x) >= RTE_IPV4_MIN_MCAST && (x) <= RTE_IPV4_MAX_MCAST)
 100         /**< check if IPv4 address is multicast */
 101
 102 /* IPv4 default fields values */
 103 #define RTE_IPV4_MIN_IHL    (0x5)
 104 #define RTE_IPV4_VHL_DEF    ((IPVERSION << 4) | RTE_IPV4_MIN_IHL)
 105
 106 /**
 107  * @internal Calculate a sum of all words in the buffer.
 108  * Helper routine for the rte_raw_cksum().
 109  *
 110  * @param buf
 111  *   Pointer to the buffer.
 112  * @param len
 113  *   Length of the buffer.
 114  * @param sum
 115  *   Initial value of the sum.
 116  * @return
 117  *   sum += Sum of all words in the buffer.
 118  */
 119 static inline uint32_t
 120 __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
 121 {
 122         /* workaround gcc strict-aliasing warning */
 123         uintptr_t ptr = (uintptr_t)buf;
 124         typedef uint16_t __attribute__((__may_alias__)) u16_p;
 125         const u16_p *u16_buf = (const u16_p *)ptr;
 126
 127         while (len >= (sizeof(*u16_buf) * 4)) {
 128                 sum += u16_buf[0];
 129                 sum += u16_buf[1];
 130                 sum += u16_buf[2];
 131                 sum += u16_buf[3];
 132                 len -= sizeof(*u16_buf) * 4;
 133                 u16_buf += 4;
 134         }
 135         while (len >= sizeof(*u16_buf)) {
 136                 sum += *u16_buf;
 137                 len -= sizeof(*u16_buf);
 138                 u16_buf += 1;
 139         }
 140
 141         /* if length is in odd bytes */
 142         if (len == 1) {
 143                 uint16_t left = 0;
 144                 *(uint8_t *)&left = *(const uint8_t *)u16_buf;
 145                 sum += left;
 146         }
 147
 148         return sum;
 149 }
 150
 151 /**
 152  * @internal Reduce a sum to the non-complemented checksum.
 153  * Helper routine for the rte_raw_cksum().
 154  *
 155  * @param sum
 156  *   Value of the sum.
 157  * @return
 158  *   The non-complemented checksum.
 159  */
 160 static inline uint16_t
 161 __rte_raw_cksum_reduce(uint32_t sum)
 162 {
 163         sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
 164         sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
 165         return (uint16_t)sum;
 166 }
 167
 168 /**
 169  * Process the non-complemented checksum of a buffer.
 170  *
 171  * @param buf
 172  *   Pointer to the buffer.
 173  * @param len
 174  *   Length of the buffer.
 175  * @return
 176  *   The non-complemented checksum.
 177  */
 178 static inline uint16_t
 179 rte_raw_cksum(const void *buf, size_t len)
 180 {
 181         uint32_t sum;
 182
 183         sum = __rte_raw_cksum(buf, len, 0);
 184         return __rte_raw_cksum_reduce(sum);
 185 }
 186
 187 /**
 188  * Compute the raw (non complemented) checksum of a packet.
 189  *
 190  * @param m
 191  *   The pointer to the mbuf.
 192  * @param off
 193  *   The offset in bytes to start the checksum.
 194  * @param len
 195  *   The length in bytes of the data to checksum.
 196  * @param cksum
 197  *   A pointer to the checksum, filled on success.
 198  * @return
 199  *   0 on success, -1 on error (bad length or offset).
 200  */
 201 static inline int
 202 rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
 203         uint16_t *cksum)
 204 {
 205         const struct rte_mbuf *seg;
 206         const char *buf;
 207         uint32_t sum, tmp;
 208         uint32_t seglen, done;
 209
 210         /* easy case: all data in the first segment */
 211         if (off + len <= rte_pktmbuf_data_len(m)) {
 212                 *cksum = rte_raw_cksum(rte_pktmbuf_mtod_offset(m,
 213                                 const char *, off), len);
 214                 return 0;
 215         }
 216
 217         if (unlikely(off + len > rte_pktmbuf_pkt_len(m)))
 218                 return -1; /* invalid params, return a dummy value */
 219
 220         /* else browse the segment to find offset */
 221         seglen = 0;
 222         for (seg = m; seg != NULL; seg = seg->next) {
 223                 seglen = rte_pktmbuf_data_len(seg);
 224                 if (off < seglen)
 225                         break;
 226                 off -= seglen;
 227         }
 228         seglen -= off;
 229         buf = rte_pktmbuf_mtod_offset(seg, const char *, off);
 230         if (seglen >= len) {
 231                 /* all in one segment */
 232                 *cksum = rte_raw_cksum(buf, len);
 233                 return 0;
 234         }
 235
 236         /* hard case: process checksum of several segments */
 237         sum = 0;
 238         done = 0;
 239         for (;;) {
 240                 tmp = __rte_raw_cksum(buf, seglen, 0);
 241                 if (done & 1)
 242                         tmp = rte_bswap16((uint16_t)tmp);
 243                 sum += tmp;
 244                 done += seglen;
 245                 if (done == len)
 246                         break;
 247                 seg = seg->next;
 248                 buf = rte_pktmbuf_mtod(seg, const char *);
 249                 seglen = rte_pktmbuf_data_len(seg);
 250                 if (seglen > len - done)
 251                         seglen = len - done;
 252         }
 253
 254         *cksum = __rte_raw_cksum_reduce(sum);
 255         return 0;
 256 }
 257
 258 /**
 259  * Process the IPv4 checksum of an IPv4 header.
 260  *
 261  * The checksum field must be set to 0 by the caller.
 262  *
 263  * @param ipv4_hdr
 264  *   The pointer to the contiguous IPv4 header.
 265  * @return
 266  *   The complemented checksum to set in the IP packet.
 267  */
 268 static inline uint16_t
 269 rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
 270 {
 271         uint16_t cksum;
 272         cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct rte_ipv4_hdr));
 273         return (uint16_t)~cksum;
 274 }
 275
 276 /**
 277  * Process the pseudo-header checksum of an IPv4 header.
 278  *
 279  * The checksum field must be set to 0 by the caller.
 280  *
 281  * Depending on the ol_flags, the pseudo-header checksum expected by the
 282  * drivers is not the same. For instance, when TSO is enabled, the IP
 283  * payload length must not be included in the packet.
 284  *
 285  * When ol_flags is 0, it computes the standard pseudo-header checksum.
 286  *
 287  * @param ipv4_hdr
 288  *   The pointer to the contiguous IPv4 header.
 289  * @param ol_flags
 290  *   The ol_flags of the associated mbuf.
 291  * @return
 292  *   The non-complemented checksum to set in the L4 header.
 293  */
 294 static inline uint16_t
 295 rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
 296 {
 297         struct ipv4_psd_header {
 298                 uint32_t src_addr; /* IP address of source host. */
 299                 uint32_t dst_addr; /* IP address of destination host. */
 300                 uint8_t  zero;     /* zero. */
 301                 uint8_t  proto;    /* L4 protocol type. */
 302                 uint16_t len;      /* L4 length. */
 303         } psd_hdr;
 304
 305         psd_hdr.src_addr = ipv4_hdr->src_addr;
 306         psd_hdr.dst_addr = ipv4_hdr->dst_addr;
 307         psd_hdr.zero = 0;
 308         psd_hdr.proto = ipv4_hdr->next_proto_id;
 309         if (ol_flags & PKT_TX_TCP_SEG) {
 310                 psd_hdr.len = 0;
 311         } else {
 312                 psd_hdr.len = rte_cpu_to_be_16(
 313                         (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
 314                                 - sizeof(struct rte_ipv4_hdr)));
 315         }
 316         return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
 317 }
 318
 319 /**
 320  * Process the IPv4 UDP or TCP checksum.
 321  *
 322  * The IPv4 header should not contains options. The IP and layer 4
 323  * checksum must be set to 0 in the packet by the caller.
 324  *
 325  * @param ipv4_hdr
 326  *   The pointer to the contiguous IPv4 header.
 327  * @param l4_hdr
 328  *   The pointer to the beginning of the L4 header.
 329  * @return
 330  *   The complemented checksum to set in the IP packet.
 331  */
 332 static inline uint16_t
 333 rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
 334 {
 335         uint32_t cksum;
 336         uint32_t l3_len, l4_len;
 337
 338         l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
 339         if (l3_len < sizeof(struct rte_ipv4_hdr))
 340                 return 0;
 341
 342         l4_len = l3_len - sizeof(struct rte_ipv4_hdr);
 343
 344         cksum = rte_raw_cksum(l4_hdr, l4_len);
 345         cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
 346
 347         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 348         cksum = (~cksum) & 0xffff;
 349         /*
 350          * Per RFC 768:If the computed checksum is zero for UDP,
 351          * it is transmitted as all ones
 352          * (the equivalent in one's complement arithmetic).
 353          */
 354         if (cksum == 0 && ipv4_hdr->next_proto_id == IPPROTO_UDP)
 355                 cksum = 0xffff;
 356
 357         return (uint16_t)cksum;
 358 }
 359
 360 /**
 361  * IPv6 Header
 362  */
 363 struct rte_ipv6_hdr {
 364         rte_be32_t vtc_flow;    /**< IP version, traffic class & flow label. */
 365         rte_be16_t payload_len; /**< IP packet length - includes header size */
 366         uint8_t  proto;         /**< Protocol, next header. */
 367         uint8_t  hop_limits;    /**< Hop limits. */
 368         uint8_t  src_addr[16];  /**< IP address of source host. */
 369         uint8_t  dst_addr[16];  /**< IP address of destination host(s). */
 370 } __rte_packed;
 371
 372 /* IPv6 vtc_flow: IPv / TC / flow_label */
 373 #define RTE_IPV6_HDR_FL_SHIFT 0
 374 #define RTE_IPV6_HDR_TC_SHIFT 20
 375 #define RTE_IPV6_HDR_FL_MASK    ((1u << RTE_IPV6_HDR_TC_SHIFT) - 1)
 376 #define RTE_IPV6_HDR_TC_MASK    (0xff << RTE_IPV6_HDR_TC_SHIFT)
 377 #define RTE_IPV6_HDR_DSCP_MASK  (0xfc << RTE_IPV6_HDR_TC_SHIFT)
 378 #define RTE_IPV6_HDR_ECN_MASK   (0x03 << RTE_IPV6_HDR_TC_SHIFT)
 379 #define RTE_IPV6_HDR_ECN_CE     RTE_IPV6_HDR_ECN_MASK
 380
 381 #define RTE_IPV6_MIN_MTU 1280 /**< Minimum MTU for IPv6, see RFC 8200. */
 382
 383 /**
 384  * Process the pseudo-header checksum of an IPv6 header.
 385  *
 386  * Depending on the ol_flags, the pseudo-header checksum expected by the
 387  * drivers is not the same. For instance, when TSO is enabled, the IPv6
 388  * payload length must not be included in the packet.
 389  *
 390  * When ol_flags is 0, it computes the standard pseudo-header checksum.
 391  *
 392  * @param ipv6_hdr
 393  *   The pointer to the contiguous IPv6 header.
 394  * @param ol_flags
 395  *   The ol_flags of the associated mbuf.
 396  * @return
 397  *   The non-complemented checksum to set in the L4 header.
 398  */
 399 static inline uint16_t
 400 rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
 401 {
 402         uint32_t sum;
 403         struct {
 404                 rte_be32_t len;   /* L4 length. */
 405                 rte_be32_t proto; /* L4 protocol - top 3 bytes must be zero */
 406         } psd_hdr;
 407
 408         psd_hdr.proto = (uint32_t)(ipv6_hdr->proto << 24);
 409         if (ol_flags & PKT_TX_TCP_SEG) {
 410                 psd_hdr.len = 0;
 411         } else {
 412                 psd_hdr.len = ipv6_hdr->payload_len;
 413         }
 414
 415         sum = __rte_raw_cksum(ipv6_hdr->src_addr,
 416                 sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
 417                 0);
 418         sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
 419         return __rte_raw_cksum_reduce(sum);
 420 }
 421
 422 /**
 423  * Process the IPv6 UDP or TCP checksum.
 424  *
 425  * The IPv4 header should not contains options. The layer 4 checksum
 426  * must be set to 0 in the packet by the caller.
 427  *
 428  * @param ipv6_hdr
 429  *   The pointer to the contiguous IPv6 header.
 430  * @param l4_hdr
 431  *   The pointer to the beginning of the L4 header.
 432  * @return
 433  *   The complemented checksum to set in the IP packet.
 434  */
 435 static inline uint16_t
 436 rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
 437 {
 438         uint32_t cksum;
 439         uint32_t l4_len;
 440
 441         l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
 442
 443         cksum = rte_raw_cksum(l4_hdr, l4_len);
 444         cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
 445
 446         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 447         cksum = (~cksum) & 0xffff;
 448         /*
 449          * Per RFC 768: If the computed checksum is zero for UDP,
 450          * it is transmitted as all ones
 451          * (the equivalent in one's complement arithmetic).
 452          */
 453         if (cksum == 0 && ipv6_hdr->proto == IPPROTO_UDP)
 454                 cksum = 0xffff;
 455
 456         return (uint16_t)cksum;
 457 }
 458
 459 /* IPv6 fragmentation header size */
 460 #define RTE_IPV6_FRAG_HDR_SIZE 8
 461
 462 /**
 463  * Parse next IPv6 header extension
 464  *
 465  * This function checks if proto number is an IPv6 extensions and parses its
 466  * data if so, providing information on next header and extension length.
 467  *
 468  * @param p
 469  *   Pointer to an extension raw data.
 470  * @param proto
 471  *   Protocol number extracted from the "next header" field from
 472  *   the IPv6 header or the previous extension.
 473  * @param ext_len
 474  *   Extension data length.
 475  * @return
 476  *   next protocol number if proto is an IPv6 extension, -EINVAL otherwise
 477  */
 478 __rte_experimental
 479 static inline int
 480 rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
 481 {
 482         int next_proto;
 483
 484         switch (proto) {
 485         case IPPROTO_AH:
 486                 next_proto = *p++;
 487                 *ext_len = (*p + 2) * sizeof(uint32_t);
 488                 break;
 489
 490         case IPPROTO_HOPOPTS:
 491         case IPPROTO_ROUTING:
 492         case IPPROTO_DSTOPTS:
 493                 next_proto = *p++;
 494                 *ext_len = (*p + 1) * sizeof(uint64_t);
 495                 break;
 496
 497         case IPPROTO_FRAGMENT:
 498                 next_proto = *p;
 499                 *ext_len = RTE_IPV6_FRAG_HDR_SIZE;
 500                 break;
 501
 502         default:
 503                 return -EINVAL;
 504         }
 505
 506         return next_proto;
 507 }
 508
 509 #ifdef __cplusplus
 510 }
 511 #endif
 512
 513 #endif /* _RTE_IP_H_ */