1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016 6WIND S.A.
5 #ifndef _RTE_NET_PTYPE_H_
6 #define _RTE_NET_PTYPE_H_
18 * Structure containing header lengths associated to a packet, filled
19 * by rte_net_get_ptype().
21 struct rte_net_hdr_lens {
32 * Skip IPv6 header extensions.
34 * This function skips all IPv6 extensions, returning size of
35 * complete header including options and final protocol value.
38 * @b EXPERIMENTAL: this API may change without prior notice
41 * Protocol field of IPv6 header.
43 * The packet mbuf to be parsed.
45 * On input, must contain the offset to the first byte following
46 * IPv6 header, on output, contains offset to the first byte
47 * of next layer (after any IPv6 extension header)
49 * Contains 1 in output if packet is an IPv6 fragment.
51 * Protocol that follows IPv6 header.
52 * -1 if an error occurs during mbuf parsing.
54 int __rte_experimental
55 rte_net_skip_ip6_ext(uint16_t proto, const struct rte_mbuf *m, uint32_t *off,
59 * Parse an Ethernet packet to get its packet type.
61 * This function parses the network headers in mbuf data and return its
64 * If it is provided by the user, it also fills a rte_net_hdr_lens
65 * structure that contains the lengths of the parsed network
66 * headers. Each length field is valid only if the associated packet
67 * type is set. For instance, hdr_lens->l2_len is valid only if
68 * (retval & RTE_PTYPE_L2_MASK) != RTE_PTYPE_UNKNOWN.
70 * Supported packet types are:
71 * L2: Ether, Vlan, QinQ
74 * Tunnels: IPv4, IPv6, Gre, Nvgre
77 * The packet mbuf to be parsed.
79 * A pointer to a structure where the header lengths will be returned,
82 * List of layers to parse. The function will stop at the first
83 * empty layer. Examples:
84 * - To parse all known layers, use RTE_PTYPE_ALL_MASK.
85 * - To parse only L2 and L3, use RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK
87 * The packet type of the packet.
89 uint32_t rte_net_get_ptype(const struct rte_mbuf *m,
90 struct rte_net_hdr_lens *hdr_lens, uint32_t layers);
93 * Prepare pseudo header checksum
95 * This function prepares pseudo header checksum for TSO and non-TSO tcp/udp in
96 * provided mbufs packet data and based on the requested offload flags.
98 * - for non-TSO tcp/udp packets full pseudo-header checksum is counted and set
100 * - for TSO the IP payload length is not included in pseudo header.
102 * This function expects that used headers are in the first data segment of
103 * mbuf, are not fragmented and can be safely modified.
106 * The packet mbuf to be fixed.
108 * TX offloads flags to use with this packet.
110 * 0 if checksum is initialized properly
113 rte_net_intel_cksum_flags_prepare(struct rte_mbuf *m, uint64_t ol_flags)
115 struct rte_ipv4_hdr *ipv4_hdr;
116 struct rte_ipv6_hdr *ipv6_hdr;
117 struct rte_tcp_hdr *tcp_hdr;
118 struct rte_udp_hdr *udp_hdr;
119 uint64_t inner_l3_offset = m->l2_len;
121 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
123 * Does packet set any of available offloads?
124 * Mainly it is required to avoid fragmented headers check if
125 * no offloads are requested.
127 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
131 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) ||
132 (ol_flags & PKT_TX_OUTER_IPV6))
133 inner_l3_offset += m->outer_l2_len + m->outer_l3_len;
135 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
137 * Check if headers are fragmented.
138 * The check could be less strict depending on which offloads are
139 * requested and headers to be used, but let's keep it simple.
141 if (unlikely(rte_pktmbuf_data_len(m) <
142 inner_l3_offset + m->l3_len + m->l4_len))
146 if (ol_flags & PKT_TX_IPV4) {
147 ipv4_hdr = rte_pktmbuf_mtod_offset(m, struct rte_ipv4_hdr *,
150 if (ol_flags & PKT_TX_IP_CKSUM)
151 ipv4_hdr->hdr_checksum = 0;
154 if ((ol_flags & PKT_TX_UDP_CKSUM) == PKT_TX_UDP_CKSUM) {
155 if (ol_flags & PKT_TX_IPV4) {
156 udp_hdr = (struct rte_udp_hdr *)((char *)ipv4_hdr +
158 udp_hdr->dgram_cksum = rte_ipv4_phdr_cksum(ipv4_hdr,
161 ipv6_hdr = rte_pktmbuf_mtod_offset(m,
162 struct rte_ipv6_hdr *, inner_l3_offset);
164 udp_hdr = rte_pktmbuf_mtod_offset(m,
165 struct rte_udp_hdr *,
166 inner_l3_offset + m->l3_len);
167 udp_hdr->dgram_cksum = rte_ipv6_phdr_cksum(ipv6_hdr,
170 } else if ((ol_flags & PKT_TX_TCP_CKSUM) ||
171 (ol_flags & PKT_TX_TCP_SEG)) {
172 if (ol_flags & PKT_TX_IPV4) {
173 /* non-TSO tcp or TSO */
174 tcp_hdr = (struct rte_tcp_hdr *)((char *)ipv4_hdr +
176 tcp_hdr->cksum = rte_ipv4_phdr_cksum(ipv4_hdr,
179 ipv6_hdr = rte_pktmbuf_mtod_offset(m,
180 struct rte_ipv6_hdr *, inner_l3_offset);
181 /* non-TSO tcp or TSO */
182 tcp_hdr = rte_pktmbuf_mtod_offset(m,
183 struct rte_tcp_hdr *,
184 inner_l3_offset + m->l3_len);
185 tcp_hdr->cksum = rte_ipv6_phdr_cksum(ipv6_hdr,
194 * Prepare pseudo header checksum
196 * This function prepares pseudo header checksum for TSO and non-TSO tcp/udp in
197 * provided mbufs packet data.
199 * - for non-TSO tcp/udp packets full pseudo-header checksum is counted and set
201 * - for TSO the IP payload length is not included in pseudo header.
203 * This function expects that used headers are in the first data segment of
204 * mbuf, are not fragmented and can be safely modified.
207 * The packet mbuf to be fixed.
209 * 0 if checksum is initialized properly
212 rte_net_intel_cksum_prepare(struct rte_mbuf *m)
214 return rte_net_intel_cksum_flags_prepare(m, m->ol_flags);
222 #endif /* _RTE_NET_PTYPE_H_ */