DPDK  17.02.1
rte_ip.h
Go to the documentation of this file.
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 
80 #include <stdint.h>
81 #include <netinet/in.h>
82 
83 #include <rte_byteorder.h>
84 #include <rte_mbuf.h>
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
93 struct ipv4_hdr {
94  uint8_t version_ihl;
95  uint8_t type_of_service;
96  uint16_t total_length;
97  uint16_t packet_id;
98  uint16_t fragment_offset;
99  uint8_t time_to_live;
100  uint8_t next_proto_id;
101  uint16_t hdr_checksum;
102  uint32_t src_addr;
103  uint32_t dst_addr;
104 } __attribute__((__packed__));
105 
107 #define IPv4(a,b,c,d) ((uint32_t)(((a) & 0xff) << 24) | \
108  (((b) & 0xff) << 16) | \
109  (((c) & 0xff) << 8) | \
110  ((d) & 0xff))
111 
113 #define IPV4_MAX_PKT_LEN 65535
114 
116 #define IPV4_HDR_IHL_MASK (0x0f)
117 
121 #define IPV4_IHL_MULTIPLIER (4)
122 
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
127 
128 #define IPV4_HDR_DF_FLAG (1 << IPV4_HDR_DF_SHIFT)
129 #define IPV4_HDR_MF_FLAG (1 << IPV4_HDR_MF_SHIFT)
130 
131 #define IPV4_HDR_OFFSET_MASK ((1 << IPV4_HDR_MF_SHIFT) - 1)
132 
133 #define IPV4_HDR_OFFSET_UNITS 8
134 
135 /*
136  * IPv4 address types
137  */
138 #define IPV4_ANY ((uint32_t)0x00000000)
139 #define IPV4_LOOPBACK ((uint32_t)0x7f000001)
140 #define IPV4_BROADCAST ((uint32_t)0xe0000000)
141 #define IPV4_ALLHOSTS_GROUP ((uint32_t)0xe0000001)
142 #define IPV4_ALLRTRS_GROUP ((uint32_t)0xe0000002)
143 #define IPV4_MAX_LOCAL_GROUP ((uint32_t)0xe00000ff)
145 /*
146  * IPv4 Multicast-related macros
147  */
148 #define IPV4_MIN_MCAST IPv4(224, 0, 0, 0)
149 #define IPV4_MAX_MCAST IPv4(239, 255, 255, 255)
151 #define IS_IPV4_MCAST(x) \
152  ((x) >= IPV4_MIN_MCAST && (x) <= IPV4_MAX_MCAST)
167 static inline uint32_t
168 __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
169 {
170  /* workaround gcc strict-aliasing warning */
171  uintptr_t ptr = (uintptr_t)buf;
172  typedef uint16_t __attribute__((__may_alias__)) u16_p;
173  const u16_p *u16 = (const u16_p *)ptr;
174 
175  while (len >= (sizeof(*u16) * 4)) {
176  sum += u16[0];
177  sum += u16[1];
178  sum += u16[2];
179  sum += u16[3];
180  len -= sizeof(*u16) * 4;
181  u16 += 4;
182  }
183  while (len >= sizeof(*u16)) {
184  sum += *u16;
185  len -= sizeof(*u16);
186  u16 += 1;
187  }
188 
189  /* if length is in odd bytes */
190  if (len == 1)
191  sum += *((const uint8_t *)u16);
192 
193  return sum;
194 }
195 
205 static inline uint16_t
206 __rte_raw_cksum_reduce(uint32_t sum)
207 {
208  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
209  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
210  return (uint16_t)sum;
211 }
212 
223 static inline uint16_t
224 rte_raw_cksum(const void *buf, size_t len)
225 {
226  uint32_t sum;
227 
228  sum = __rte_raw_cksum(buf, len, 0);
229  return __rte_raw_cksum_reduce(sum);
230 }
231 
246 static inline int
247 rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
248  uint16_t *cksum)
249 {
250  const struct rte_mbuf *seg;
251  const char *buf;
252  uint32_t sum, tmp;
253  uint32_t seglen, done;
254 
255  /* easy case: all data in the first segment */
256  if (off + len <= rte_pktmbuf_data_len(m)) {
257  *cksum = rte_raw_cksum(rte_pktmbuf_mtod_offset(m,
258  const char *, off), len);
259  return 0;
260  }
261 
262  if (unlikely(off + len > rte_pktmbuf_pkt_len(m)))
263  return -1; /* invalid params, return a dummy value */
264 
265  /* else browse the segment to find offset */
266  seglen = 0;
267  for (seg = m; seg != NULL; seg = seg->next) {
268  seglen = rte_pktmbuf_data_len(seg);
269  if (off < seglen)
270  break;
271  off -= seglen;
272  }
273  seglen -= off;
274  buf = rte_pktmbuf_mtod_offset(seg, const char *, off);
275  if (seglen >= len) {
276  /* all in one segment */
277  *cksum = rte_raw_cksum(buf, len);
278  return 0;
279  }
280 
281  /* hard case: process checksum of several segments */
282  sum = 0;
283  done = 0;
284  for (;;) {
285  tmp = __rte_raw_cksum(buf, seglen, 0);
286  if (done & 1)
287  tmp = rte_bswap16(tmp);
288  sum += tmp;
289  done += seglen;
290  if (done == len)
291  break;
292  seg = seg->next;
293  buf = rte_pktmbuf_mtod(seg, const char *);
294  seglen = rte_pktmbuf_data_len(seg);
295  if (seglen > len - done)
296  seglen = len - done;
297  }
298 
299  *cksum = __rte_raw_cksum_reduce(sum);
300  return 0;
301 }
302 
313 static inline uint16_t
314 rte_ipv4_cksum(const struct ipv4_hdr *ipv4_hdr)
315 {
316  uint16_t cksum;
317  cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct ipv4_hdr));
318  return (cksum == 0xffff) ? cksum : ~cksum;
319 }
320 
339 static inline uint16_t
340 rte_ipv4_phdr_cksum(const struct ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
341 {
342  struct ipv4_psd_header {
343  uint32_t src_addr; /* IP address of source host. */
344  uint32_t dst_addr; /* IP address of destination host. */
345  uint8_t zero; /* zero. */
346  uint8_t proto; /* L4 protocol type. */
347  uint16_t len; /* L4 length. */
348  } psd_hdr;
349 
350  psd_hdr.src_addr = ipv4_hdr->src_addr;
351  psd_hdr.dst_addr = ipv4_hdr->dst_addr;
352  psd_hdr.zero = 0;
353  psd_hdr.proto = ipv4_hdr->next_proto_id;
354  if (ol_flags & PKT_TX_TCP_SEG) {
355  psd_hdr.len = 0;
356  } else {
357  psd_hdr.len = rte_cpu_to_be_16(
358  (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
359  - sizeof(struct ipv4_hdr)));
360  }
361  return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
362 }
363 
377 static inline uint16_t
378 rte_ipv4_udptcp_cksum(const struct ipv4_hdr *ipv4_hdr, const void *l4_hdr)
379 {
380  uint32_t cksum;
381  uint32_t l4_len;
382 
383  l4_len = rte_be_to_cpu_16(ipv4_hdr->total_length) -
384  sizeof(struct ipv4_hdr);
385 
386  cksum = rte_raw_cksum(l4_hdr, l4_len);
387  cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
388 
389  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
390  cksum = (~cksum) & 0xffff;
391  if (cksum == 0)
392  cksum = 0xffff;
393 
394  return cksum;
395 }
396 
400 struct ipv6_hdr {
401  uint32_t vtc_flow;
402  uint16_t payload_len;
403  uint8_t proto;
404  uint8_t hop_limits;
405  uint8_t src_addr[16];
406  uint8_t dst_addr[16];
407 } __attribute__((__packed__));
408 
425 static inline uint16_t
426 rte_ipv6_phdr_cksum(const struct ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
427 {
428  uint32_t sum;
429  struct {
430  uint32_t len; /* L4 length. */
431  uint32_t proto; /* L4 protocol - top 3 bytes must be zero */
432  } psd_hdr;
433 
434  psd_hdr.proto = (ipv6_hdr->proto << 24);
435  if (ol_flags & PKT_TX_TCP_SEG) {
436  psd_hdr.len = 0;
437  } else {
438  psd_hdr.len = ipv6_hdr->payload_len;
439  }
440 
441  sum = __rte_raw_cksum(ipv6_hdr->src_addr,
442  sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
443  0);
444  sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
445  return __rte_raw_cksum_reduce(sum);
446 }
447 
461 static inline uint16_t
462 rte_ipv6_udptcp_cksum(const struct ipv6_hdr *ipv6_hdr, const void *l4_hdr)
463 {
464  uint32_t cksum;
465  uint32_t l4_len;
466 
467  l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
468 
469  cksum = rte_raw_cksum(l4_hdr, l4_len);
470  cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
471 
472  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
473  cksum = (~cksum) & 0xffff;
474  if (cksum == 0)
475  cksum = 0xffff;
476 
477  return cksum;
478 }
479 
480 #ifdef __cplusplus
481 }
482 #endif
483 
484 #endif /* _RTE_IP_H_ */
Generated by   doxygen 1.8.1.2