4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright 2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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
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.
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.
36 * Copyright (c) 1982, 1986, 1990, 1993
37 * The Regents of the University of California. All rights reserved.
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
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.
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
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 $
81 #include <netinet/in.h>
83 #include <rte_byteorder.h>
94 uint8_t version_ihl; /**< version and header length */
95 uint8_t type_of_service; /**< type of service */
96 uint16_t total_length; /**< length of packet */
97 uint16_t packet_id; /**< packet ID */
98 uint16_t fragment_offset; /**< fragmentation offset */
99 uint8_t time_to_live; /**< time to live */
100 uint8_t next_proto_id; /**< protocol ID */
101 uint16_t hdr_checksum; /**< header checksum */
102 uint32_t src_addr; /**< source address */
103 uint32_t dst_addr; /**< destination address */
104 } __attribute__((__packed__));
106 /** Create IPv4 address */
107 #define IPv4(a,b,c,d) ((uint32_t)(((a) & 0xff) << 24) | \
108 (((b) & 0xff) << 16) | \
109 (((c) & 0xff) << 8) | \
112 /** Maximal IPv4 packet length (including a header) */
113 #define IPV4_MAX_PKT_LEN 65535
115 /** Internet header length mask for version_ihl field */
116 #define IPV4_HDR_IHL_MASK (0x0f)
118 * Internet header length field multiplier (IHL field specifies overall header
119 * length in number of 4-byte words)
121 #define IPV4_IHL_MULTIPLIER (4)
123 /* Fragment Offset * Flags. */
124 #define IPV4_HDR_DF_SHIFT 14
125 #define IPV4_HDR_MF_SHIFT 13
126 #define IPV4_HDR_FO_SHIFT 3
128 #define IPV4_HDR_DF_FLAG (1 << IPV4_HDR_DF_SHIFT)
129 #define IPV4_HDR_MF_FLAG (1 << IPV4_HDR_MF_SHIFT)
131 #define IPV4_HDR_OFFSET_MASK ((1 << IPV4_HDR_MF_SHIFT) - 1)
133 #define IPV4_HDR_OFFSET_UNITS 8
138 #define IPV4_ANY ((uint32_t)0x00000000) /**< 0.0.0.0 */
139 #define IPV4_LOOPBACK ((uint32_t)0x7f000001) /**< 127.0.0.1 */
140 #define IPV4_BROADCAST ((uint32_t)0xe0000000) /**< 224.0.0.0 */
141 #define IPV4_ALLHOSTS_GROUP ((uint32_t)0xe0000001) /**< 224.0.0.1 */
142 #define IPV4_ALLRTRS_GROUP ((uint32_t)0xe0000002) /**< 224.0.0.2 */
143 #define IPV4_MAX_LOCAL_GROUP ((uint32_t)0xe00000ff) /**< 224.0.0.255 */
146 * IPv4 Multicast-related macros
148 #define IPV4_MIN_MCAST IPv4(224, 0, 0, 0) /**< Minimal IPv4-multicast address */
149 #define IPV4_MAX_MCAST IPv4(239, 255, 255, 255) /**< Maximum IPv4 multicast address */
151 #define IS_IPV4_MCAST(x) \
152 ((x) >= IPV4_MIN_MCAST && (x) <= IPV4_MAX_MCAST) /**< check if IPv4 address is multicast */
155 * @internal Calculate a sum of all words in the buffer.
156 * Helper routine for the rte_raw_cksum().
159 * Pointer to the buffer.
161 * Length of the buffer.
163 * Initial value of the sum.
165 * sum += Sum of all words in the buffer.
167 static inline uint32_t
168 __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
170 /* workaround gcc strict-aliasing warning */
171 uintptr_t ptr = (uintptr_t)buf;
172 const uint16_t *u16 = (const uint16_t *)ptr;
174 while (len >= (sizeof(*u16) * 4)) {
179 len -= sizeof(*u16) * 4;
182 while (len >= sizeof(*u16)) {
188 /* if length is in odd bytes */
190 sum += *((const uint8_t *)u16);
196 * @internal Reduce a sum to the non-complemented checksum.
197 * Helper routine for the rte_raw_cksum().
202 * The non-complemented checksum.
204 static inline uint16_t
205 __rte_raw_cksum_reduce(uint32_t sum)
207 sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
208 sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
209 return (uint16_t)sum;
213 * Process the non-complemented checksum of a buffer.
216 * Pointer to the buffer.
218 * Length of the buffer.
220 * The non-complemented checksum.
222 static inline uint16_t
223 rte_raw_cksum(const void *buf, size_t len)
227 sum = __rte_raw_cksum(buf, len, 0);
228 return __rte_raw_cksum_reduce(sum);
232 * Process the IPv4 checksum of an IPv4 header.
234 * The checksum field must be set to 0 by the caller.
237 * The pointer to the contiguous IPv4 header.
239 * The complemented checksum to set in the IP packet.
241 static inline uint16_t
242 rte_ipv4_cksum(const struct ipv4_hdr *ipv4_hdr)
245 cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct ipv4_hdr));
246 return (cksum == 0xffff) ? cksum : ~cksum;
250 * Process the pseudo-header checksum of an IPv4 header.
252 * The checksum field must be set to 0 by the caller.
254 * Depending on the ol_flags, the pseudo-header checksum expected by the
255 * drivers is not the same. For instance, when TSO is enabled, the IP
256 * payload length must not be included in the packet.
258 * When ol_flags is 0, it computes the standard pseudo-header checksum.
261 * The pointer to the contiguous IPv4 header.
263 * The ol_flags of the associated mbuf.
265 * The non-complemented checksum to set in the L4 header.
267 static inline uint16_t
268 rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
270 struct ipv4_psd_header {
271 uint32_t src_addr; /* IP address of source host. */
272 uint32_t dst_addr; /* IP address of destination host. */
273 uint8_t zero; /* zero. */
274 uint8_t proto; /* L4 protocol type. */
275 uint16_t len; /* L4 length. */
278 psd_hdr.src_addr = ipv4_hdr->src_addr;
279 psd_hdr.dst_addr = ipv4_hdr->dst_addr;
281 psd_hdr.proto = ipv4_hdr->next_proto_id;
282 if (ol_flags & PKT_TX_TCP_SEG) {
285 psd_hdr.len = rte_cpu_to_be_16(
286 (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
287 - sizeof(struct ipv4_hdr)));
289 return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
293 * Process the IPv4 UDP or TCP checksum.
295 * The IPv4 header should not contains options. The IP and layer 4
296 * checksum must be set to 0 in the packet by the caller.
299 * The pointer to the contiguous IPv4 header.
301 * The pointer to the beginning of the L4 header.
303 * The complemented checksum to set in the IP packet.
305 static inline uint16_t
306 rte_ipv4_udptcp_cksum(const struct ipv4_hdr *ipv4_hdr, const void *l4_hdr)
311 l4_len = rte_be_to_cpu_16(ipv4_hdr->total_length) -
312 sizeof(struct ipv4_hdr);
314 cksum = rte_raw_cksum(l4_hdr, l4_len);
315 cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
317 cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
318 cksum = (~cksum) & 0xffff;
329 uint32_t vtc_flow; /**< IP version, traffic class & flow label. */
330 uint16_t payload_len; /**< IP packet length - includes sizeof(ip_header). */
331 uint8_t proto; /**< Protocol, next header. */
332 uint8_t hop_limits; /**< Hop limits. */
333 uint8_t src_addr[16]; /**< IP address of source host. */
334 uint8_t dst_addr[16]; /**< IP address of destination host(s). */
335 } __attribute__((__packed__));
338 * Process the pseudo-header checksum of an IPv6 header.
340 * Depending on the ol_flags, the pseudo-header checksum expected by the
341 * drivers is not the same. For instance, when TSO is enabled, the IPv6
342 * payload length must not be included in the packet.
344 * When ol_flags is 0, it computes the standard pseudo-header checksum.
347 * The pointer to the contiguous IPv6 header.
349 * The ol_flags of the associated mbuf.
351 * The non-complemented checksum to set in the L4 header.
353 static inline uint16_t
354 rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
358 uint32_t len; /* L4 length. */
359 uint32_t proto; /* L4 protocol - top 3 bytes must be zero */
362 psd_hdr.proto = (ipv6_hdr->proto << 24);
363 if (ol_flags & PKT_TX_TCP_SEG) {
366 psd_hdr.len = ipv6_hdr->payload_len;
369 sum = __rte_raw_cksum(ipv6_hdr->src_addr,
370 sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
372 sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
373 return __rte_raw_cksum_reduce(sum);
377 * Process the IPv6 UDP or TCP checksum.
379 * The IPv4 header should not contains options. The layer 4 checksum
380 * must be set to 0 in the packet by the caller.
383 * The pointer to the contiguous IPv6 header.
385 * The pointer to the beginning of the L4 header.
387 * The complemented checksum to set in the IP packet.
389 static inline uint16_t
390 rte_ipv6_udptcp_cksum(const struct ipv6_hdr *ipv6_hdr, const void *l4_hdr)
395 l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
397 cksum = rte_raw_cksum(l4_hdr, l4_len);
398 cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
400 cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
401 cksum = (~cksum) & 0xffff;
412 #endif /* _RTE_IP_H_ */