DPDK  20.11.4
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)
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)
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 
114 static inline uint8_t
115 rte_ipv4_hdr_len(const struct rte_ipv4_hdr *ipv4_hdr)
116 {
117  return (uint8_t)((ipv4_hdr->version_ihl & RTE_IPV4_HDR_IHL_MASK) *
119 }
120 
134 static inline uint32_t
135 __rte_raw_cksum(const void *buf, size_t len, uint32_t sum)
136 {
137  /* extend strict-aliasing rules */
138  typedef uint16_t __attribute__((__may_alias__)) u16_p;
139  const u16_p *u16_buf = (const u16_p *)buf;
140  const u16_p *end = u16_buf + len / sizeof(*u16_buf);
141 
142  for (; u16_buf != end; ++u16_buf)
143  sum += *u16_buf;
144 
145  /* if length is odd, keeping it byte order independent */
146  if (unlikely(len % 2)) {
147  uint16_t left = 0;
148  *(unsigned char *)&left = *(const unsigned char *)end;
149  sum += left;
150  }
151 
152  return sum;
153 }
154 
164 static inline uint16_t
165 __rte_raw_cksum_reduce(uint32_t sum)
166 {
167  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
168  sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
169  return (uint16_t)sum;
170 }
171 
182 static inline uint16_t
183 rte_raw_cksum(const void *buf, size_t len)
184 {
185  uint32_t sum;
186 
187  sum = __rte_raw_cksum(buf, len, 0);
188  return __rte_raw_cksum_reduce(sum);
189 }
190 
205 static inline int
206 rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len,
207  uint16_t *cksum)
208 {
209  const struct rte_mbuf *seg;
210  const char *buf;
211  uint32_t sum, tmp;
212  uint32_t seglen, done;
213 
214  /* easy case: all data in the first segment */
215  if (off + len <= rte_pktmbuf_data_len(m)) {
217  const char *, off), len);
218  return 0;
219  }
220 
221  if (unlikely(off + len > rte_pktmbuf_pkt_len(m)))
222  return -1; /* invalid params, return a dummy value */
223 
224  /* else browse the segment to find offset */
225  seglen = 0;
226  for (seg = m; seg != NULL; seg = seg->next) {
227  seglen = rte_pktmbuf_data_len(seg);
228  if (off < seglen)
229  break;
230  off -= seglen;
231  }
232  RTE_ASSERT(seg != NULL);
233  if (seg == NULL)
234  return -1;
235  seglen -= off;
236  buf = rte_pktmbuf_mtod_offset(seg, const char *, off);
237  if (seglen >= len) {
238  /* all in one segment */
239  *cksum = rte_raw_cksum(buf, len);
240  return 0;
241  }
242 
243  /* hard case: process checksum of several segments */
244  sum = 0;
245  done = 0;
246  for (;;) {
247  tmp = __rte_raw_cksum(buf, seglen, 0);
248  if (done & 1)
249  tmp = rte_bswap16((uint16_t)tmp);
250  sum += tmp;
251  done += seglen;
252  if (done == len)
253  break;
254  seg = seg->next;
255  buf = rte_pktmbuf_mtod(seg, const char *);
256  seglen = rte_pktmbuf_data_len(seg);
257  if (seglen > len - done)
258  seglen = len - done;
259  }
260 
261  *cksum = __rte_raw_cksum_reduce(sum);
262  return 0;
263 }
264 
275 static inline uint16_t
276 rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
277 {
278  uint16_t cksum;
279  cksum = rte_raw_cksum(ipv4_hdr, rte_ipv4_hdr_len(ipv4_hdr));
280  return (uint16_t)~cksum;
281 }
282 
301 static inline uint16_t
302 rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
303 {
304  struct ipv4_psd_header {
305  uint32_t src_addr; /* IP address of source host. */
306  uint32_t dst_addr; /* IP address of destination host. */
307  uint8_t zero; /* zero. */
308  uint8_t proto; /* L4 protocol type. */
309  uint16_t len; /* L4 length. */
310  } psd_hdr;
311 
312  uint32_t l3_len;
313 
314  psd_hdr.src_addr = ipv4_hdr->src_addr;
315  psd_hdr.dst_addr = ipv4_hdr->dst_addr;
316  psd_hdr.zero = 0;
317  psd_hdr.proto = ipv4_hdr->next_proto_id;
318  if (ol_flags & PKT_TX_TCP_SEG) {
319  psd_hdr.len = 0;
320  } else {
321  l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
322  psd_hdr.len = rte_cpu_to_be_16((uint16_t)(l3_len -
323  rte_ipv4_hdr_len(ipv4_hdr)));
324  }
325  return rte_raw_cksum(&psd_hdr, sizeof(psd_hdr));
326 }
327 
341 static inline uint16_t
342 rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
343 {
344  uint32_t cksum;
345  uint32_t l3_len, l4_len;
346  uint8_t ip_hdr_len;
347 
348  ip_hdr_len = rte_ipv4_hdr_len(ipv4_hdr);
349  l3_len = rte_be_to_cpu_16(ipv4_hdr->total_length);
350  if (l3_len < ip_hdr_len)
351  return 0;
352 
353  l4_len = l3_len - ip_hdr_len;
354 
355  cksum = rte_raw_cksum(l4_hdr, l4_len);
356  cksum += rte_ipv4_phdr_cksum(ipv4_hdr, 0);
357 
358  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
359  cksum = (~cksum) & 0xffff;
360  /*
361  * Per RFC 768:If the computed checksum is zero for UDP,
362  * it is transmitted as all ones
363  * (the equivalent in one's complement arithmetic).
364  */
365  if (cksum == 0 && ipv4_hdr->next_proto_id == IPPROTO_UDP)
366  cksum = 0xffff;
367 
368  return (uint16_t)cksum;
369 }
370 
374 struct rte_ipv6_hdr {
377  uint8_t proto;
378  uint8_t hop_limits;
379  uint8_t src_addr[16];
380  uint8_t dst_addr[16];
382 
383 /* IPv6 vtc_flow: IPv / TC / flow_label */
384 #define RTE_IPV6_HDR_FL_SHIFT 0
385 #define RTE_IPV6_HDR_TC_SHIFT 20
386 #define RTE_IPV6_HDR_FL_MASK ((1u << RTE_IPV6_HDR_TC_SHIFT) - 1)
387 #define RTE_IPV6_HDR_TC_MASK (0xff << RTE_IPV6_HDR_TC_SHIFT)
388 #define RTE_IPV6_HDR_DSCP_MASK (0xfc << RTE_IPV6_HDR_TC_SHIFT)
389 #define RTE_IPV6_HDR_ECN_MASK (0x03 << RTE_IPV6_HDR_TC_SHIFT)
390 #define RTE_IPV6_HDR_ECN_CE RTE_IPV6_HDR_ECN_MASK
391 
392 #define RTE_IPV6_MIN_MTU 1280
410 static inline uint16_t
411 rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
412 {
413  uint32_t sum;
414  struct {
415  rte_be32_t len; /* L4 length. */
416  rte_be32_t proto; /* L4 protocol - top 3 bytes must be zero */
417  } psd_hdr;
418 
419  psd_hdr.proto = (uint32_t)(ipv6_hdr->proto << 24);
420  if (ol_flags & PKT_TX_TCP_SEG) {
421  psd_hdr.len = 0;
422  } else {
423  psd_hdr.len = ipv6_hdr->payload_len;
424  }
425 
426  sum = __rte_raw_cksum(ipv6_hdr->src_addr,
427  sizeof(ipv6_hdr->src_addr) + sizeof(ipv6_hdr->dst_addr),
428  0);
429  sum = __rte_raw_cksum(&psd_hdr, sizeof(psd_hdr), sum);
430  return __rte_raw_cksum_reduce(sum);
431 }
432 
446 static inline uint16_t
447 rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
448 {
449  uint32_t cksum;
450  uint32_t l4_len;
451 
452  l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
453 
454  cksum = rte_raw_cksum(l4_hdr, l4_len);
455  cksum += rte_ipv6_phdr_cksum(ipv6_hdr, 0);
456 
457  cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
458  cksum = (~cksum) & 0xffff;
459  /*
460  * Per RFC 768: If the computed checksum is zero for UDP,
461  * it is transmitted as all ones
462  * (the equivalent in one's complement arithmetic).
463  */
464  if (cksum == 0 && ipv6_hdr->proto == IPPROTO_UDP)
465  cksum = 0xffff;
466 
467  return (uint16_t)cksum;
468 }
469 
471 #define RTE_IPV6_EHDR_MF_SHIFT 0
472 #define RTE_IPV6_EHDR_MF_MASK 1
473 #define RTE_IPV6_EHDR_FO_SHIFT 3
474 #define RTE_IPV6_EHDR_FO_MASK (~((1 << RTE_IPV6_EHDR_FO_SHIFT) - 1))
475 #define RTE_IPV6_EHDR_FO_ALIGN (1 << RTE_IPV6_EHDR_FO_SHIFT)
476 
477 #define RTE_IPV6_FRAG_USED_MASK (RTE_IPV6_EHDR_MF_MASK | RTE_IPV6_EHDR_FO_MASK)
478 
479 #define RTE_IPV6_GET_MF(x) ((x) & RTE_IPV6_EHDR_MF_MASK)
480 #define RTE_IPV6_GET_FO(x) ((x) >> RTE_IPV6_EHDR_FO_SHIFT)
481 
482 #define RTE_IPV6_SET_FRAG_DATA(fo, mf) \
483  (((fo) & RTE_IPV6_EHDR_FO_MASK) | ((mf) & RTE_IPV6_EHDR_MF_MASK))
484 
485 struct rte_ipv6_fragment_ext {
486  uint8_t next_header;
487  uint8_t reserved;
488  rte_be16_t frag_data;
489  rte_be32_t id;
490 } __rte_packed;
491 
492 /* IPv6 fragment extension header size */
493 #define RTE_IPV6_FRAG_HDR_SIZE sizeof(struct rte_ipv6_fragment_ext)
494 
511 __rte_experimental
512 static inline int
513 rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
514 {
515  int next_proto;
516 
517  switch (proto) {
518  case IPPROTO_AH:
519  next_proto = *p++;
520  *ext_len = (*p + 2) * sizeof(uint32_t);
521  break;
522 
523  case IPPROTO_HOPOPTS:
524  case IPPROTO_ROUTING:
525  case IPPROTO_DSTOPTS:
526  next_proto = *p++;
527  *ext_len = (*p + 1) * sizeof(uint64_t);
528  break;
529 
530  case IPPROTO_FRAGMENT:
531  next_proto = *p;
532  *ext_len = RTE_IPV6_FRAG_HDR_SIZE;
533  break;
534 
535  default:
536  return -EINVAL;
537  }
538 
539  return next_proto;
540 }
541 
542 #ifdef __cplusplus
543 }
544 #endif
545 
546 #endif /* _RTE_IP_H_ */
#define unlikely(x)
static uint16_t rte_be_to_cpu_16(rte_be16_t x)
static rte_be16_t rte_cpu_to_be_16(uint16_t x)
uint32_t rte_be32_t
static uint16_t rte_bswap16(uint16_t _x)
uint16_t rte_be16_t
#define __rte_packed
Definition: rte_common.h:84
static uint16_t rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
Definition: rte_ip.h:304
static __rte_experimental int rte_ipv6_get_next_ext(const uint8_t *p, int proto, size_t *ext_len)
Definition: rte_ip.h:515
static uint16_t rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
Definition: rte_ip.h:413
static uint16_t rte_raw_cksum(const void *buf, size_t len)
Definition: rte_ip.h:185
static uint16_t rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
Definition: rte_ip.h:449
static uint16_t rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
Definition: rte_ip.h:344
static uint16_t rte_ipv4_cksum(const struct rte_ipv4_hdr *ipv4_hdr)
Definition: rte_ip.h:278
static int rte_raw_cksum_mbuf(const struct rte_mbuf *m, uint32_t off, uint32_t len, uint16_t *cksum)
Definition: rte_ip.h:208
static uint8_t rte_ipv4_hdr_len(const struct rte_ipv4_hdr *ipv4_hdr)
Definition: rte_ip.h:117
#define RTE_IPV4_HDR_IHL_MASK
Definition: rte_ip.h:56
#define RTE_IPV4_IHL_MULTIPLIER
Definition: rte_ip.h:61
#define rte_pktmbuf_data_len(m)
Definition: rte_mbuf.h:1555
#define rte_pktmbuf_pkt_len(m)
Definition: rte_mbuf.h:1545
#define rte_pktmbuf_mtod(m, t)
#define rte_pktmbuf_mtod_offset(m, t, o)
#define PKT_TX_TCP_SEG
uint8_t time_to_live
Definition: rte_ip.h:39
uint8_t version_ihl
Definition: rte_ip.h:34
rte_be16_t hdr_checksum
Definition: rte_ip.h:41
uint8_t next_proto_id
Definition: rte_ip.h:40
rte_be32_t dst_addr
Definition: rte_ip.h:43
rte_be32_t src_addr
Definition: rte_ip.h:42
uint8_t type_of_service
Definition: rte_ip.h:35
rte_be16_t total_length
Definition: rte_ip.h:36
rte_be16_t fragment_offset
Definition: rte_ip.h:38
rte_be16_t packet_id
Definition: rte_ip.h:37
uint8_t hop_limits
Definition: rte_ip.h:380
uint8_t dst_addr[16]
Definition: rte_ip.h:382
rte_be32_t vtc_flow
Definition: rte_ip.h:377
uint8_t src_addr[16]
Definition: rte_ip.h:381
rte_be16_t payload_len
Definition: rte_ip.h:378
uint8_t proto
Definition: rte_ip.h:379
uint64_t ol_flags
struct rte_mbuf * next