DPDK  20.05.0
rte_ip.h
Go to the documentation of this file.
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 
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 
33 struct rte_ipv4_hdr {
34  uint8_t version_ihl;
35  uint8_t type_of_service;
39  uint8_t time_to_live;
40  uint8_t next_proto_id;
44 } __rte_packed;
45 
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 
53 #define RTE_IPV4_MAX_PKT_LEN 65535
54 
56 #define RTE_IPV4_HDR_IHL_MASK (0x0f)
57 
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)
84 #define RTE_IPV4_LOOPBACK ((uint32_t)0x7f000001)
85 #define RTE_IPV4_BROADCAST ((uint32_t)0xe0000000)
86 #define RTE_IPV4_ALLHOSTS_GROUP ((uint32_t)0xe0000001)
87 #define RTE_IPV4_ALLRTRS_GROUP ((uint32_t)0xe0000002)
88 #define RTE_IPV4_MAX_LOCAL_GROUP ((uint32_t)0xe00000ff)
90 /*
91  * IPv4 Multicast-related macros
92  */
93 #define RTE_IPV4_MIN_MCAST \
94  RTE_IPV4(224, 0, 0, 0)
95 #define RTE_IPV4_MAX_MCAST \
96  RTE_IPV4(239, 255, 255, 255)
98 #define RTE_IS_IPV4_MCAST(x) \
99  ((x) >= RTE_IPV4_MIN_MCAST && (x) <= RTE_IPV4_MAX_MCAST)
100 
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 
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  sum += *((const uint8_t *)u16_buf);
144 
145  return sum;
146 }
147 
157 static inline uint16_t
158 __rte_raw_cksum_reduce(uint32_t sum)
159 {
160  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
161  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
162  return (uint16_t)sum;
163 }
164 
175 static inline uint16_t
176 rte_raw_cksum(const void *buf, size_t len)
177 {
178  uint32_t sum;
179 
180  sum = __rte_raw_cksum(buf, len, 0);
181  return __rte_raw_cksum_reduce(sum);
182 }
183 
198 static inline int
199 rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
200  uint16_t *cksum)
201 {
202  const struct rte_mbuf *seg;
203  const char *buf;
204  uint32_t sum, tmp;
205  uint32_t seglen, done;
206 
207  /* easy case: all data in the first segment */
208  if (off + len <= rte_pktmbuf_data_len(m)) {
210  const char *, off), len);
211  return 0;
212  }
213 
214  if (unlikely(off + len > rte_pktmbuf_pkt_len(m)))
215  return -1; /* invalid params, return a dummy value */
216 
217  /* else browse the segment to find offset */
218  seglen = 0;
219  for (seg = m; seg != NULL; seg = seg->next) {
220  seglen = rte_pktmbuf_data_len(seg);
221  if (off < seglen)
222  break;
223  off -= seglen;
224  }
225  seglen -= off;
226  buf = rte_pktmbuf_mtod_offset(seg, const char *, off);
227  if (seglen >= len) {
228  /* all in one segment */
229  *cksum = rte_raw_cksum(buf, len);
230  return 0;
231  }
232 
233  /* hard case: process checksum of several segments */
234  sum = 0;
235  done = 0;
236  for (;;) {
237  tmp = __rte_raw_cksum(buf, seglen, 0);
238  if (done & 1)
239  tmp = rte_bswap16((uint16_t)tmp);
240  sum += tmp;
241  done += seglen;
242  if (done == len)
243  break;
244  seg = seg->next;
245  buf = rte_pktmbuf_mtod(seg, const char *);
246  seglen = rte_pktmbuf_data_len(seg);
247  if (seglen > len - done)
248  seglen = len - done;
249  }
250 
251  *cksum = __rte_raw_cksum_reduce(sum);
252  return 0;
253 }
254 
265 static inline uint16_t
266 rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
267 {
268  uint16_t cksum;
269  cksum = rte_raw_cksum(ipv4_hdr, sizeof(struct rte_ipv4_hdr));
270  return (cksum == 0xffff) ? cksum : (uint16_t)~cksum;
271 }
272 
291 static inline uint16_t
292 rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
293 {
294  struct ipv4_psd_header {
295  uint32_t src_addr; /* IP address of source host. */
296  uint32_t dst_addr; /* IP address of destination host. */
297  uint8_t zero; /* zero. */
298  uint8_t proto; /* L4 protocol type. */
299  uint16_t len; /* L4 length. */
300  } psd_hdr;
301 
302  psd_hdr.src_addr = ipv4_hdr->src_addr;
303  psd_hdr.dst_addr = ipv4_hdr->dst_addr;
304  psd_hdr.zero = 0;
305  psd_hdr.proto = ipv4_hdr->next_proto_id;
306  if (ol_flags & PKT_TX_TCP_SEG) {
307  psd_hdr.len = 0;
308  } else {
309  psd_hdr.len = rte_cpu_to_be_16(
310  (uint16_t)(rte_be_to_cpu_16(ipv4_hdr->total_length)
311  - sizeof(struct rte_ipv4_hdr)));
312  }
313  return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
314 }
315 
330 static inline uint16_t
331 rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
332 {
333  uint32_t cksum;
334  uint32_t l3_len, l4_len;
335 
336  l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
337  if (l3_len < sizeof(struct rte_ipv4_hdr))
338  return 0;
339 
340  l4_len = l3_len - sizeof(struct rte_ipv4_hdr);
341 
342  cksum = rte_raw_cksum(l4_hdr, l4_len);
343  cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
344 
345  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
346  cksum = (~cksum) & 0xffff;
347  if (cksum == 0)
348  cksum = 0xffff;
349 
350  return (uint16_t)cksum;
351 }
352 
356 struct rte_ipv6_hdr {
359  uint8_t proto;
360  uint8_t hop_limits;
361  uint8_t src_addr[16];
362  uint8_t dst_addr[16];
365 /* IPv6 vtc_flow: IPv / TC / flow_label */
366 #define RTE_IPV6_HDR_FL_SHIFT 0
367 #define RTE_IPV6_HDR_TC_SHIFT 20
368 #define RTE_IPV6_HDR_FL_MASK ((1u << RTE_IPV6_HDR_TC_SHIFT) - 1)
369 #define RTE_IPV6_HDR_TC_MASK (0xff << RTE_IPV6_HDR_TC_SHIFT)
370 #define RTE_IPV6_HDR_DSCP_MASK (0xfc << RTE_IPV6_HDR_TC_SHIFT)
371 #define RTE_IPV6_HDR_ECN_MASK (0x03 << RTE_IPV6_HDR_TC_SHIFT)
372 #define RTE_IPV6_HDR_ECN_CE RTE_IPV6_HDR_ECN_MASK
373 
374 #define RTE_IPV6_MIN_MTU 1280
392 static inline uint16_t
393 rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
394 {
395  uint32_t sum;
396  struct {
397  rte_be32_t len; /* L4 length. */
398  rte_be32_t proto; /* L4 protocol - top 3 bytes must be zero */
399  } psd_hdr;
400 
401  psd_hdr.proto = (uint32_t)(ipv6_hdr->proto << 24);
402  if (ol_flags & PKT_TX_TCP_SEG) {
403  psd_hdr.len = 0;
404  } else {
405  psd_hdr.len = ipv6_hdr->payload_len;
406  }
407 
408  sum = __rte_raw_cksum(ipv6_hdr->src_addr,
409  sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
410  0);
411  sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
412  return __rte_raw_cksum_reduce(sum);
413 }
414 
428 static inline uint16_t
429 rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
430 {
431  uint32_t cksum;
432  uint32_t l4_len;
433 
434  l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
435 
436  cksum = rte_raw_cksum(l4_hdr, l4_len);
437  cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
438 
439  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
440  cksum = (~cksum) & 0xffff;
441  if (cksum == 0)
442  cksum = 0xffff;
443 
444  return (uint16_t)cksum;
445 }
446 
447 /* IPv6 fragmentation header size */
448 #define RTE_IPV6_FRAG_HDR_SIZE 8
449 
466 __rte_experimental
467 static inline int
468 rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
469 {
470  int next_proto;
471 
472  switch (proto) {
473  case IPPROTO_AH:
474  next_proto = *p++;
475  *ext_len = (*p + 2) * sizeof(uint32_t);
476  break;
477 
478  case IPPROTO_HOPOPTS:
479  case IPPROTO_ROUTING:
480  case IPPROTO_DSTOPTS:
481  next_proto = *p++;
482  *ext_len = (*p + 1) * sizeof(uint64_t);
483  break;
484 
485  case IPPROTO_FRAGMENT:
486  next_proto = *p;
487  *ext_len = RTE_IPV6_FRAG_HDR_SIZE;
488  break;
489 
490  default:
491  return -EINVAL;
492  }
493 
494  return next_proto;
495 }
496 
497 #ifdef __cplusplus
498 }
499 #endif
500 
501 #endif /* _RTE_IP_H_ */
struct rte_mbuf * next
#define __rte_packed
Definition: rte_common.h:84
static int rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len, uint16_t *cksum)
Definition: rte_ip.h:201
static uint16_t rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
Definition: rte_ip.h:333
uint32_t rte_be32_t
uint8_t dst_addr[16]
Definition: rte_ip.h:364
rte_be16_t fragment_offset
Definition: rte_ip.h:38
uint8_t hop_limits
Definition: rte_ip.h:362
uint8_t version_ihl
Definition: rte_ip.h:34
static uint16_t rte_bswap16(uint16_t _x)
rte_be32_t dst_addr
Definition: rte_ip.h:43
rte_be32_t vtc_flow
Definition: rte_ip.h:359
rte_be32_t src_addr
Definition: rte_ip.h:42
uint8_t src_addr[16]
Definition: rte_ip.h:363
static __rte_experimental int rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
Definition: rte_ip.h:470
#define rte_pktmbuf_mtod_offset(m, t, o)
static rte_be16_t rte_cpu_to_be_16(uint16_t x)
#define unlikely(x)
static uint16_t rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
Definition: rte_ip.h:294
static uint16_t rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
Definition: rte_ip.h:395
#define PKT_TX_TCP_SEG
#define rte_pktmbuf_mtod(m, t)
#define rte_pktmbuf_pkt_len(m)
Definition: rte_mbuf.h:1554
uint8_t type_of_service
Definition: rte_ip.h:35
uint8_t time_to_live
Definition: rte_ip.h:39
uint8_t proto
Definition: rte_ip.h:361
rte_be16_t packet_id
Definition: rte_ip.h:37
static uint16_t rte_raw_cksum(const void *buf, size_t len)
Definition: rte_ip.h:178
uint64_t ol_flags
#define rte_pktmbuf_data_len(m)
Definition: rte_mbuf.h:1564
uint8_t next_proto_id
Definition: rte_ip.h:40
rte_be16_t payload_len
Definition: rte_ip.h:360
rte_be16_t total_length
Definition: rte_ip.h:36
uint16_t rte_be16_t
static uint16_t rte_be_to_cpu_16(rte_be16_t x)
rte_be16_t hdr_checksum
Definition: rte_ip.h:41
static uint16_t rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
Definition: rte_ip.h:268
static uint16_t rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
Definition: rte_ip.h:431