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.
20 #ifdef RTE_EXEC_ENV_WINDOWS
23 #include <sys/socket.h>
24 #include <sys/types.h>
25 #include <netinet/in.h>
26 #include <arpa/inet.h>
27 #include <netinet/ip.h>
30 #include <rte_byteorder.h>
41 uint8_t version_ihl; /**< version and header length */
42 uint8_t type_of_service; /**< type of service */
43 rte_be16_t total_length; /**< length of packet */
44 rte_be16_t packet_id; /**< packet ID */
45 rte_be16_t fragment_offset; /**< fragmentation offset */
46 uint8_t time_to_live; /**< time to live */
47 uint8_t next_proto_id; /**< protocol ID */
48 rte_be16_t hdr_checksum; /**< header checksum */
49 rte_be32_t src_addr; /**< source address */
50 rte_be32_t dst_addr; /**< destination address */
53 /** Create IPv4 address */
54 #define RTE_IPV4(a, b, c, d) ((uint32_t)(((a) & 0xff) << 24) | \
55 (((b) & 0xff) << 16) | \
56 (((c) & 0xff) << 8) | \
59 /** Maximal IPv4 packet length (including a header) */
60 #define RTE_IPV4_MAX_PKT_LEN 65535
62 /** Internet header length mask for version_ihl field */
63 #define RTE_IPV4_HDR_IHL_MASK (0x0f)
65 * Internet header length field multiplier (IHL field specifies overall header
66 * length in number of 4-byte words)
68 #define RTE_IPV4_IHL_MULTIPLIER (4)
70 /* Type of Service fields */
71 #define RTE_IPV4_HDR_DSCP_MASK (0xfc)
72 #define RTE_IPV4_HDR_ECN_MASK (0x03)
73 #define RTE_IPV4_HDR_ECN_CE RTE_IPV4_HDR_ECN_MASK
75 /* Fragment Offset * Flags. */
76 #define RTE_IPV4_HDR_DF_SHIFT 14
77 #define RTE_IPV4_HDR_MF_SHIFT 13
78 #define RTE_IPV4_HDR_FO_SHIFT 3
80 #define RTE_IPV4_HDR_DF_FLAG (1 << RTE_IPV4_HDR_DF_SHIFT)
81 #define RTE_IPV4_HDR_MF_FLAG (1 << RTE_IPV4_HDR_MF_SHIFT)
83 #define RTE_IPV4_HDR_OFFSET_MASK ((1 << RTE_IPV4_HDR_MF_SHIFT) - 1)
85 #define RTE_IPV4_HDR_OFFSET_UNITS 8
90 #define RTE_IPV4_ANY ((uint32_t)0x00000000) /**< 0.0.0.0 */
91 #define RTE_IPV4_LOOPBACK ((uint32_t)0x7f000001) /**< 127.0.0.1 */
92 #define RTE_IPV4_BROADCAST ((uint32_t)0xe0000000) /**< 224.0.0.0 */
93 #define RTE_IPV4_ALLHOSTS_GROUP ((uint32_t)0xe0000001) /**< 224.0.0.1 */
94 #define RTE_IPV4_ALLRTRS_GROUP ((uint32_t)0xe0000002) /**< 224.0.0.2 */
95 #define RTE_IPV4_MAX_LOCAL_GROUP ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
98 * IPv4 Multicast-related macros
100 #define RTE_IPV4_MIN_MCAST \
101 RTE_IPV4(224, 0, 0, 0) /**< Minimal IPv4-multicast address */
102 #define RTE_IPV4_MAX_MCAST \
103 RTE_IPV4(239, 255, 255, 255) /**< Maximum IPv4 multicast address */
105 #define RTE_IS_IPV4_MCAST(x) \
106 ((x) >= RTE_IPV4_MIN_MCAST && (x) <= RTE_IPV4_MAX_MCAST)
107 /**< check if IPv4 address is multicast */
109 /* IPv4 default fields values */
110 #define RTE_IPV4_MIN_IHL (0x5)
111 #define RTE_IPV4_VHL_DEF ((IPVERSION << 4) | RTE_IPV4_MIN_IHL)
114 * Get the length of an IPv4 header.
117 * Pointer to the IPv4 header.
119 * The length of the IPv4 header (with options if present) in bytes.
121 static inline uint8_t
122 rte_ipv4_hdr_len(const struct rte_ipv4_hdr *ipv4_hdr)
124 return (uint8_t)((ipv4_hdr->version_ihl & RTE_IPV4_HDR_IHL_MASK) *
125 RTE_IPV4_IHL_MULTIPLIER);
129 * @internal Calculate a sum of all words in the buffer.
130 * Helper routine for the rte_raw_cksum().
133 * Pointer to the buffer.
135 * Length of the buffer.
137 * Initial value of the sum.
139 * sum += Sum of all words in the buffer.
141 static inline uint32_t
142 __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
144 /* workaround gcc strict-aliasing warning */
145 uintptr_t ptr = (uintptr_t)buf;
146 typedef uint16_t __attribute__((__may_alias__)) u16_p;
147 const u16_p *u16_buf = (const u16_p *)ptr;
149 while (len >= (sizeof(*u16_buf) * 4)) {
154 len -= sizeof(*u16_buf) * 4;
157 while (len >= sizeof(*u16_buf)) {
159 len -= sizeof(*u16_buf);
163 /* if length is in odd bytes */
166 *(uint8_t *)&left = *(const uint8_t *)u16_buf;
174 * @internal Reduce a sum to the non-complemented checksum.
175 * Helper routine for the rte_raw_cksum().
180 * The non-complemented checksum.
182 static inline uint16_t
183 __rte_raw_cksum_reduce(uint32_t sum)
185 sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
186 sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
187 return (uint16_t)sum;
191 * Process the non-complemented checksum of a buffer.
194 * Pointer to the buffer.
196 * Length of the buffer.
198 * The non-complemented checksum.
200 static inline uint16_t
201 rte_raw_cksum(const void *buf, size_t len)
205 sum = __rte_raw_cksum(buf, len, 0);
206 return __rte_raw_cksum_reduce(sum);
210 * Compute the raw (non complemented) checksum of a packet.
213 * The pointer to the mbuf.
215 * The offset in bytes to start the checksum.
217 * The length in bytes of the data to checksum.
219 * A pointer to the checksum, filled on success.
221 * 0 on success, -1 on error (bad length or offset).
224 rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
227 const struct rte_mbuf *seg;
230 uint32_t seglen, done;
232 /* easy case: all data in the first segment */
233 if (off + len <= rte_pktmbuf_data_len(m)) {
234 *cksum = rte_raw_cksum(rte_pktmbuf_mtod_offset(m,
235 const char *, off), len);
239 if (unlikely(off + len > rte_pktmbuf_pkt_len(m)))
240 return -1; /* invalid params, return a dummy value */
242 /* else browse the segment to find offset */
244 for (seg = m; seg != NULL; seg = seg->next) {
245 seglen = rte_pktmbuf_data_len(seg);
250 RTE_ASSERT(seg != NULL);
254 buf = rte_pktmbuf_mtod_offset(seg, const char *, off);
256 /* all in one segment */
257 *cksum = rte_raw_cksum(buf, len);
261 /* hard case: process checksum of several segments */
265 tmp = __rte_raw_cksum(buf, seglen, 0);
267 tmp = rte_bswap16((uint16_t)tmp);
273 buf = rte_pktmbuf_mtod(seg, const char *);
274 seglen = rte_pktmbuf_data_len(seg);
275 if (seglen > len - done)
279 *cksum = __rte_raw_cksum_reduce(sum);
284 * Process the IPv4 checksum of an IPv4 header.
286 * The checksum field must be set to 0 by the caller.
289 * The pointer to the contiguous IPv4 header.
291 * The complemented checksum to set in the IP packet.
293 static inline uint16_t
294 rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
297 cksum = rte_raw_cksum(ipv4_hdr, rte_ipv4_hdr_len(ipv4_hdr));
298 return (uint16_t)~cksum;
302 * Process the pseudo-header checksum of an IPv4 header.
304 * The checksum field must be set to 0 by the caller.
306 * Depending on the ol_flags, the pseudo-header checksum expected by the
307 * drivers is not the same. For instance, when TSO is enabled, the IP
308 * payload length must not be included in the packet.
310 * When ol_flags is 0, it computes the standard pseudo-header checksum.
313 * The pointer to the contiguous IPv4 header.
315 * The ol_flags of the associated mbuf.
317 * The non-complemented checksum to set in the L4 header.
319 static inline uint16_t
320 rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
322 struct ipv4_psd_header {
323 uint32_t src_addr; /* IP address of source host. */
324 uint32_t dst_addr; /* IP address of destination host. */
325 uint8_t zero; /* zero. */
326 uint8_t proto; /* L4 protocol type. */
327 uint16_t len; /* L4 length. */
332 psd_hdr.src_addr = ipv4_hdr->src_addr;
333 psd_hdr.dst_addr = ipv4_hdr->dst_addr;
335 psd_hdr.proto = ipv4_hdr->next_proto_id;
336 if (ol_flags & PKT_TX_TCP_SEG) {
339 l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
340 psd_hdr.len = rte_cpu_to_be_16((uint16_t)(l3_len -
341 rte_ipv4_hdr_len(ipv4_hdr)));
343 return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
347 * @internal Calculate the non-complemented IPv4 L4 checksum
349 static inline uint16_t
350 __rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
353 uint32_t l3_len, l4_len;
356 ip_hdr_len = rte_ipv4_hdr_len(ipv4_hdr);
357 l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
358 if (l3_len < ip_hdr_len)
361 l4_len = l3_len - ip_hdr_len;
363 cksum = rte_raw_cksum(l4_hdr, l4_len);
364 cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
366 cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
368 return (uint16_t)cksum;
372 * Process the IPv4 UDP or TCP checksum.
374 * The IP and layer 4 checksum must be set to 0 in the packet by
378 * The pointer to the contiguous IPv4 header.
380 * The pointer to the beginning of the L4 header.
382 * The complemented checksum to set in the IP packet.
384 static inline uint16_t
385 rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
387 uint16_t cksum = __rte_ipv4_udptcp_cksum(ipv4_hdr, l4_hdr);
392 * Per RFC 768: If the computed checksum is zero for UDP,
393 * it is transmitted as all ones
394 * (the equivalent in one's complement arithmetic).
396 if (cksum == 0 && ipv4_hdr->next_proto_id == IPPROTO_UDP)
403 * Validate the IPv4 UDP or TCP checksum.
405 * In case of UDP, the caller must first check if udp_hdr->dgram_cksum is 0
406 * (i.e. no checksum).
409 * The pointer to the contiguous IPv4 header.
411 * The pointer to the beginning of the L4 header.
413 * Return 0 if the checksum is correct, else -1.
417 rte_ipv4_udptcp_cksum_verify(const struct rte_ipv4_hdr *ipv4_hdr,
420 uint16_t cksum = __rte_ipv4_udptcp_cksum(ipv4_hdr, l4_hdr);
431 struct rte_ipv6_hdr {
432 rte_be32_t vtc_flow; /**< IP version, traffic class & flow label. */
433 rte_be16_t payload_len; /**< IP payload size, including ext. headers */
434 uint8_t proto; /**< Protocol, next header. */
435 uint8_t hop_limits; /**< Hop limits. */
436 uint8_t src_addr[16]; /**< IP address of source host. */
437 uint8_t dst_addr[16]; /**< IP address of destination host(s). */
440 /* IPv6 vtc_flow: IPv / TC / flow_label */
441 #define RTE_IPV6_HDR_FL_SHIFT 0
442 #define RTE_IPV6_HDR_TC_SHIFT 20
443 #define RTE_IPV6_HDR_FL_MASK ((1u << RTE_IPV6_HDR_TC_SHIFT) - 1)
444 #define RTE_IPV6_HDR_TC_MASK (0xff << RTE_IPV6_HDR_TC_SHIFT)
445 #define RTE_IPV6_HDR_DSCP_MASK (0xfc << RTE_IPV6_HDR_TC_SHIFT)
446 #define RTE_IPV6_HDR_ECN_MASK (0x03 << RTE_IPV6_HDR_TC_SHIFT)
447 #define RTE_IPV6_HDR_ECN_CE RTE_IPV6_HDR_ECN_MASK
449 #define RTE_IPV6_MIN_MTU 1280 /**< Minimum MTU for IPv6, see RFC 8200. */
452 * Process the pseudo-header checksum of an IPv6 header.
454 * Depending on the ol_flags, the pseudo-header checksum expected by the
455 * drivers is not the same. For instance, when TSO is enabled, the IPv6
456 * payload length must not be included in the packet.
458 * When ol_flags is 0, it computes the standard pseudo-header checksum.
461 * The pointer to the contiguous IPv6 header.
463 * The ol_flags of the associated mbuf.
465 * The non-complemented checksum to set in the L4 header.
467 static inline uint16_t
468 rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
472 rte_be32_t len; /* L4 length. */
473 rte_be32_t proto; /* L4 protocol - top 3 bytes must be zero */
476 psd_hdr.proto = (uint32_t)(ipv6_hdr->proto << 24);
477 if (ol_flags & PKT_TX_TCP_SEG) {
480 psd_hdr.len = ipv6_hdr->payload_len;
483 sum = __rte_raw_cksum(ipv6_hdr->src_addr,
484 sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
486 sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
487 return __rte_raw_cksum_reduce(sum);
491 * @internal Calculate the non-complemented IPv4 L4 checksum
493 static inline uint16_t
494 __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
499 l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
501 cksum = rte_raw_cksum(l4_hdr, l4_len);
502 cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
504 cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
506 return (uint16_t)cksum;
510 * Process the IPv6 UDP or TCP checksum.
512 * The IPv4 header should not contains options. The layer 4 checksum
513 * must be set to 0 in the packet by the caller.
516 * The pointer to the contiguous IPv6 header.
518 * The pointer to the beginning of the L4 header.
520 * The complemented checksum to set in the IP packet.
522 static inline uint16_t
523 rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
525 uint16_t cksum = __rte_ipv6_udptcp_cksum(ipv6_hdr, l4_hdr);
530 * Per RFC 768: If the computed checksum is zero for UDP,
531 * it is transmitted as all ones
532 * (the equivalent in one's complement arithmetic).
534 if (cksum == 0 && ipv6_hdr->proto == IPPROTO_UDP)
541 * Validate the IPv6 UDP or TCP checksum.
543 * In case of UDP, the caller must first check if udp_hdr->dgram_cksum is 0:
544 * this is either invalid or means no checksum in some situations. See 8.1
545 * (Upper-Layer Checksums) in RFC 8200.
548 * The pointer to the contiguous IPv6 header.
550 * The pointer to the beginning of the L4 header.
552 * Return 0 if the checksum is correct, else -1.
556 rte_ipv6_udptcp_cksum_verify(const struct rte_ipv6_hdr *ipv6_hdr,
559 uint16_t cksum = __rte_ipv6_udptcp_cksum(ipv6_hdr, l4_hdr);
567 /** IPv6 fragment extension header. */
568 #define RTE_IPV6_EHDR_MF_SHIFT 0
569 #define RTE_IPV6_EHDR_MF_MASK 1
570 #define RTE_IPV6_EHDR_FO_SHIFT 3
571 #define RTE_IPV6_EHDR_FO_MASK (~((1 << RTE_IPV6_EHDR_FO_SHIFT) - 1))
572 #define RTE_IPV6_EHDR_FO_ALIGN (1 << RTE_IPV6_EHDR_FO_SHIFT)
574 #define RTE_IPV6_FRAG_USED_MASK (RTE_IPV6_EHDR_MF_MASK | RTE_IPV6_EHDR_FO_MASK)
576 #define RTE_IPV6_GET_MF(x) ((x) & RTE_IPV6_EHDR_MF_MASK)
577 #define RTE_IPV6_GET_FO(x) ((x) >> RTE_IPV6_EHDR_FO_SHIFT)
579 #define RTE_IPV6_SET_FRAG_DATA(fo, mf) \
580 (((fo) & RTE_IPV6_EHDR_FO_MASK) | ((mf) & RTE_IPV6_EHDR_MF_MASK))
582 struct rte_ipv6_fragment_ext {
583 uint8_t next_header; /**< Next header type */
584 uint8_t reserved; /**< Reserved */
585 rte_be16_t frag_data; /**< All fragmentation data */
586 rte_be32_t id; /**< Packet ID */
589 /* IPv6 fragment extension header size */
590 #define RTE_IPV6_FRAG_HDR_SIZE sizeof(struct rte_ipv6_fragment_ext)
593 * Parse next IPv6 header extension
595 * This function checks if proto number is an IPv6 extensions and parses its
596 * data if so, providing information on next header and extension length.
599 * Pointer to an extension raw data.
601 * Protocol number extracted from the "next header" field from
602 * the IPv6 header or the previous extension.
604 * Extension data length.
606 * next protocol number if proto is an IPv6 extension, -EINVAL otherwise
610 rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
617 *ext_len = (*p + 2) * sizeof(uint32_t);
620 case IPPROTO_HOPOPTS:
621 case IPPROTO_ROUTING:
622 case IPPROTO_DSTOPTS:
624 *ext_len = (*p + 1) * sizeof(uint64_t);
627 case IPPROTO_FRAGMENT:
629 *ext_len = RTE_IPV6_FRAG_HDR_SIZE;
643 #endif /* _RTE_IP_H_ */