blob: 70ac58240ec0eaeffa37f5b1d3e31e2c04ed0f2a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Definitions for the 'struct sk_buff' memory handlers.
3 *
4 * Authors:
5 * Alan Cox, <gw4pts@gw4pts.ampr.org>
6 * Florian La Roche, <rzsfl@rz.uni-sb.de>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
12 */
13
14#ifndef _LINUX_SKBUFF_H
15#define _LINUX_SKBUFF_H
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/compiler.h>
19#include <linux/time.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050020#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/cache.h>
Eric Dumazet56b17422014-11-03 08:19:53 -080022#include <linux/rbtree.h>
David S. Miller51f3d022014-11-05 16:46:40 -050023#include <linux/socket.h>
Eric Dumazetc1d1b432017-08-31 16:48:22 -070024#include <linux/refcount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Arun Sharma600634972011-07-26 16:09:06 -070026#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <asm/types.h>
28#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/net.h>
Thomas Graf3fc7e8a2005-06-23 21:00:17 -070030#include <linux/textsearch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <net/checksum.h>
Al Viroa80958f2006-12-04 20:41:19 +000032#include <linux/rcupdate.h>
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -070033#include <linux/hrtimer.h>
Ian Campbell131ea662011-08-19 06:25:00 +000034#include <linux/dma-mapping.h>
Michał Mirosławc8f44af2011-11-15 15:29:55 +000035#include <linux/netdev_features.h>
Eric Dumazet363ec39232014-02-26 14:02:11 -080036#include <linux/sched.h>
Ingo Molnare6017572017-02-01 16:36:40 +010037#include <linux/sched/clock.h>
Jiri Pirko1bd758e2015-05-12 14:56:07 +020038#include <net/flow_dissector.h>
Hannes Frederic Sowaa60e3cc2015-05-21 17:00:00 +020039#include <linux/splice.h>
Bernhard Thaler72b31f72015-05-30 15:27:40 +020040#include <linux/in6.h>
Jamal Hadi Salim8b10cab2016-07-02 06:43:14 -040041#include <linux/if_packet.h>
Tom Herbertf70ea012015-07-31 16:52:10 -070042#include <net/flow.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Tom Herbert7a6ae712015-12-14 11:19:47 -080044/* The interface for checksum offload between the stack and networking drivers
45 * is as follows...
46 *
47 * A. IP checksum related features
48 *
49 * Drivers advertise checksum offload capabilities in the features of a device.
50 * From the stack's point of view these are capabilities offered by the driver,
51 * a driver typically only advertises features that it is capable of offloading
52 * to its device.
53 *
54 * The checksum related features are:
55 *
56 * NETIF_F_HW_CSUM - The driver (or its device) is able to compute one
57 * IP (one's complement) checksum for any combination
58 * of protocols or protocol layering. The checksum is
59 * computed and set in a packet per the CHECKSUM_PARTIAL
60 * interface (see below).
61 *
62 * NETIF_F_IP_CSUM - Driver (device) is only able to checksum plain
63 * TCP or UDP packets over IPv4. These are specifically
64 * unencapsulated packets of the form IPv4|TCP or
65 * IPv4|UDP where the Protocol field in the IPv4 header
66 * is TCP or UDP. The IPv4 header may contain IP options
67 * This feature cannot be set in features for a device
68 * with NETIF_F_HW_CSUM also set. This feature is being
69 * DEPRECATED (see below).
70 *
71 * NETIF_F_IPV6_CSUM - Driver (device) is only able to checksum plain
72 * TCP or UDP packets over IPv6. These are specifically
73 * unencapsulated packets of the form IPv6|TCP or
74 * IPv4|UDP where the Next Header field in the IPv6
75 * header is either TCP or UDP. IPv6 extension headers
76 * are not supported with this feature. This feature
77 * cannot be set in features for a device with
78 * NETIF_F_HW_CSUM also set. This feature is being
79 * DEPRECATED (see below).
80 *
81 * NETIF_F_RXCSUM - Driver (device) performs receive checksum offload.
82 * This flag is used only used to disable the RX checksum
83 * feature for a device. The stack will accept receive
84 * checksum indication in packets received on a device
85 * regardless of whether NETIF_F_RXCSUM is set.
86 *
87 * B. Checksumming of received packets by device. Indication of checksum
88 * verification is in set skb->ip_summed. Possible values are:
Daniel Borkmann78ea85f2013-12-16 23:27:09 +010089 *
90 * CHECKSUM_NONE:
91 *
Tom Herbert7a6ae712015-12-14 11:19:47 -080092 * Device did not checksum this packet e.g. due to lack of capabilities.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +010093 * The packet contains full (though not verified) checksum in packet but
94 * not in skb->csum. Thus, skb->csum is undefined in this case.
95 *
96 * CHECKSUM_UNNECESSARY:
97 *
98 * The hardware you're dealing with doesn't calculate the full checksum
99 * (as in CHECKSUM_COMPLETE), but it does parse headers and verify checksums
Tom Herbert77cffe22014-08-27 21:26:46 -0700100 * for specific protocols. For such packets it will set CHECKSUM_UNNECESSARY
101 * if their checksums are okay. skb->csum is still undefined in this case
Tom Herbert7a6ae712015-12-14 11:19:47 -0800102 * though. A driver or device must never modify the checksum field in the
103 * packet even if checksum is verified.
Tom Herbert77cffe22014-08-27 21:26:46 -0700104 *
105 * CHECKSUM_UNNECESSARY is applicable to following protocols:
106 * TCP: IPv6 and IPv4.
107 * UDP: IPv4 and IPv6. A device may apply CHECKSUM_UNNECESSARY to a
108 * zero UDP checksum for either IPv4 or IPv6, the networking stack
109 * may perform further validation in this case.
110 * GRE: only if the checksum is present in the header.
111 * SCTP: indicates the CRC in SCTP header has been validated.
Davide Carattib4759dc2017-05-18 15:44:43 +0200112 * FCOE: indicates the CRC in FC frame has been validated.
Tom Herbert77cffe22014-08-27 21:26:46 -0700113 *
114 * skb->csum_level indicates the number of consecutive checksums found in
115 * the packet minus one that have been verified as CHECKSUM_UNNECESSARY.
116 * For instance if a device receives an IPv6->UDP->GRE->IPv4->TCP packet
117 * and a device is able to verify the checksums for UDP (possibly zero),
118 * GRE (checksum flag is set), and TCP-- skb->csum_level would be set to
119 * two. If the device were only able to verify the UDP checksum and not
120 * GRE, either because it doesn't support GRE checksum of because GRE
121 * checksum is bad, skb->csum_level would be set to zero (TCP checksum is
122 * not considered in this case).
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100123 *
124 * CHECKSUM_COMPLETE:
125 *
126 * This is the most generic way. The device supplied checksum of the _whole_
127 * packet as seen by netif_rx() and fills out in skb->csum. Meaning, the
128 * hardware doesn't need to parse L3/L4 headers to implement this.
129 *
Davide Carattib4759dc2017-05-18 15:44:43 +0200130 * Notes:
131 * - Even if device supports only some protocols, but is able to produce
132 * skb->csum, it MUST use CHECKSUM_COMPLETE, not CHECKSUM_UNNECESSARY.
133 * - CHECKSUM_COMPLETE is not applicable to SCTP and FCoE protocols.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100134 *
135 * CHECKSUM_PARTIAL:
136 *
Tom Herbert6edec0e2015-02-10 16:30:28 -0800137 * A checksum is set up to be offloaded to a device as described in the
138 * output description for CHECKSUM_PARTIAL. This may occur on a packet
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100139 * received directly from another Linux OS, e.g., a virtualized Linux kernel
Tom Herbert6edec0e2015-02-10 16:30:28 -0800140 * on the same host, or it may be set in the input path in GRO or remote
141 * checksum offload. For the purposes of checksum verification, the checksum
142 * referred to by skb->csum_start + skb->csum_offset and any preceding
143 * checksums in the packet are considered verified. Any checksums in the
144 * packet that are after the checksum being offloaded are not considered to
145 * be verified.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100146 *
Tom Herbert7a6ae712015-12-14 11:19:47 -0800147 * C. Checksumming on transmit for non-GSO. The stack requests checksum offload
148 * in the skb->ip_summed for a packet. Values are:
149 *
150 * CHECKSUM_PARTIAL:
151 *
152 * The driver is required to checksum the packet as seen by hard_start_xmit()
153 * from skb->csum_start up to the end, and to record/write the checksum at
154 * offset skb->csum_start + skb->csum_offset. A driver may verify that the
155 * csum_start and csum_offset values are valid values given the length and
156 * offset of the packet, however they should not attempt to validate that the
157 * checksum refers to a legitimate transport layer checksum-- it is the
158 * purview of the stack to validate that csum_start and csum_offset are set
159 * correctly.
160 *
161 * When the stack requests checksum offload for a packet, the driver MUST
162 * ensure that the checksum is set correctly. A driver can either offload the
163 * checksum calculation to the device, or call skb_checksum_help (in the case
164 * that the device does not support offload for a particular checksum).
165 *
166 * NETIF_F_IP_CSUM and NETIF_F_IPV6_CSUM are being deprecated in favor of
167 * NETIF_F_HW_CSUM. New devices should use NETIF_F_HW_CSUM to indicate
Davide Caratti43c26a12017-05-18 15:44:41 +0200168 * checksum offload capability.
169 * skb_csum_hwoffload_help() can be called to resolve CHECKSUM_PARTIAL based
170 * on network device checksumming capabilities: if a packet does not match
171 * them, skb_checksum_help or skb_crc32c_help (depending on the value of
172 * csum_not_inet, see item D.) is called to resolve the checksum.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100173 *
174 * CHECKSUM_NONE:
175 *
176 * The skb was already checksummed by the protocol, or a checksum is not
177 * required.
178 *
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100179 * CHECKSUM_UNNECESSARY:
180 *
Tom Herbert7a6ae712015-12-14 11:19:47 -0800181 * This has the same meaning on as CHECKSUM_NONE for checksum offload on
182 * output.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100183 *
Tom Herbert7a6ae712015-12-14 11:19:47 -0800184 * CHECKSUM_COMPLETE:
185 * Not used in checksum output. If a driver observes a packet with this value
186 * set in skbuff, if should treat as CHECKSUM_NONE being set.
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100187 *
Tom Herbert7a6ae712015-12-14 11:19:47 -0800188 * D. Non-IP checksum (CRC) offloads
189 *
190 * NETIF_F_SCTP_CRC - This feature indicates that a device is capable of
191 * offloading the SCTP CRC in a packet. To perform this offload the stack
Davide Carattidba00302017-05-18 15:44:40 +0200192 * will set set csum_start and csum_offset accordingly, set ip_summed to
193 * CHECKSUM_PARTIAL and set csum_not_inet to 1, to provide an indication in
194 * the skbuff that the CHECKSUM_PARTIAL refers to CRC32c.
195 * A driver that supports both IP checksum offload and SCTP CRC32c offload
196 * must verify which offload is configured for a packet by testing the
197 * value of skb->csum_not_inet; skb_crc32c_csum_help is provided to resolve
198 * CHECKSUM_PARTIAL on skbs where csum_not_inet is set to 1.
Tom Herbert7a6ae712015-12-14 11:19:47 -0800199 *
200 * NETIF_F_FCOE_CRC - This feature indicates that a device is capable of
201 * offloading the FCOE CRC in a packet. To perform this offload the stack
202 * will set ip_summed to CHECKSUM_PARTIAL and set csum_start and csum_offset
203 * accordingly. Note the there is no indication in the skbuff that the
204 * CHECKSUM_PARTIAL refers to an FCOE checksum, a driver that supports
205 * both IP checksum offload and FCOE CRC offload must verify which offload
206 * is configured for a packet presumably by inspecting packet headers.
207 *
208 * E. Checksumming on output with GSO.
209 *
210 * In the case of a GSO packet (skb_is_gso(skb) is true), checksum offload
211 * is implied by the SKB_GSO_* flags in gso_type. Most obviously, if the
212 * gso_type is SKB_GSO_TCPV4 or SKB_GSO_TCPV6, TCP checksum offload as
213 * part of the GSO operation is implied. If a checksum is being offloaded
214 * with GSO then ip_summed is CHECKSUM_PARTIAL, csum_start and csum_offset
215 * are set to refer to the outermost checksum being offload (two offloaded
216 * checksums are possible with UDP encapsulation).
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100217 */
218
Herbert Xu60476372007-04-09 11:59:39 -0700219/* Don't change this without changing skb_csum_unnecessary! */
Daniel Borkmann78ea85f2013-12-16 23:27:09 +0100220#define CHECKSUM_NONE 0
221#define CHECKSUM_UNNECESSARY 1
222#define CHECKSUM_COMPLETE 2
223#define CHECKSUM_PARTIAL 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Tom Herbert77cffe22014-08-27 21:26:46 -0700225/* Maximum value in skb->csum_level */
226#define SKB_MAX_CSUM_LEVEL 3
227
Tobias Klauser0bec8c82014-07-22 12:06:23 +0200228#define SKB_DATA_ALIGN(X) ALIGN(X, SMP_CACHE_BYTES)
David S. Millerfc910a22007-03-25 20:27:59 -0700229#define SKB_WITH_OVERHEAD(X) \
Herbert Xudeea84b2007-10-21 16:27:46 -0700230 ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
David S. Millerfc910a22007-03-25 20:27:59 -0700231#define SKB_MAX_ORDER(X, ORDER) \
232 SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
234#define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
235
Eric Dumazet87fb4b72011-10-13 07:28:54 +0000236/* return minimum truesize of one skb containing X bytes of data */
237#define SKB_TRUESIZE(X) ((X) + \
238 SKB_DATA_ALIGN(sizeof(struct sk_buff)) + \
239 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241struct net_device;
David Howells716ea3a2007-04-02 20:19:53 -0700242struct scatterlist;
Jens Axboe9c55e012007-11-06 23:30:13 -0800243struct pipe_inode_info;
Herbert Xua8f820aa2014-11-07 21:22:22 +0800244struct iov_iter;
Alexander Duyckfd11a832014-12-09 19:40:49 -0800245struct napi_struct;
Petar Penkovd58e4682018-09-14 07:46:18 -0700246struct bpf_prog;
247union bpf_attr;
Florian Westphaldf5042f2018-12-18 17:15:16 +0100248struct skb_ext;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Yasuyuki Kozakai5f79e0f2007-03-23 11:17:07 -0700250#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251struct nf_conntrack {
252 atomic_t use;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253};
Yasuyuki Kozakai5f79e0f2007-03-23 11:17:07 -0700254#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Pablo Neira Ayuso34666d42014-09-18 11:29:03 +0200256#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257struct nf_bridge_info {
Florian Westphal3eaf4022015-04-02 14:31:44 +0200258 enum {
259 BRNF_PROTO_UNCHANGED,
260 BRNF_PROTO_8021Q,
261 BRNF_PROTO_PPPOE
Florian Westphal7fb48c52015-05-03 22:05:28 +0200262 } orig_proto:8;
Florian Westphal72b1e5e2015-07-23 16:21:30 +0200263 u8 pkt_otherhost:1;
264 u8 in_prerouting:1;
265 u8 bridged_dnat:1;
Bernhard Thaler411ffb42015-05-30 15:28:28 +0200266 __u16 frag_max_size;
Eric Dumazetbf1ac5c2012-04-18 23:19:25 +0000267 struct net_device *physindev;
Florian Westphal63cdbc02015-09-14 17:06:27 +0200268
269 /* always valid & non-NULL from FORWARD on, for physdev match */
270 struct net_device *physoutdev;
Florian Westphal7fb48c52015-05-03 22:05:28 +0200271 union {
Florian Westphal72b1e5e2015-07-23 16:21:30 +0200272 /* prerouting: detect dnat in orig/reply direction */
Bernhard Thaler72b31f72015-05-30 15:27:40 +0200273 __be32 ipv4_daddr;
274 struct in6_addr ipv6_daddr;
Florian Westphal72b1e5e2015-07-23 16:21:30 +0200275
276 /* after prerouting + nat detected: store original source
277 * mac since neigh resolution overwrites it, only used while
278 * skb is out in neigh layer.
279 */
280 char neigh_header[8];
Bernhard Thaler72b31f72015-05-30 15:27:40 +0200281 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282};
283#endif
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285struct sk_buff_head {
286 /* These two members must be first. */
287 struct sk_buff *next;
288 struct sk_buff *prev;
289
290 __u32 qlen;
291 spinlock_t lock;
292};
293
294struct sk_buff;
295
Ian Campbell9d4dde52011-12-22 23:39:14 +0000296/* To allow 64K frame to be packed as single skb without frag_list we
297 * require 64K/PAGE_SIZE pages plus 1 additional page to allow for
298 * buffers which do not start on a page boundary.
299 *
300 * Since GRO uses frags we allocate at least 16 regardless of page
301 * size.
Anton Blancharda715dea2011-03-27 14:57:26 +0000302 */
Ian Campbell9d4dde52011-12-22 23:39:14 +0000303#if (65536/PAGE_SIZE + 1) < 16
David S. Millereec00952011-03-29 23:34:08 -0700304#define MAX_SKB_FRAGS 16UL
Anton Blancharda715dea2011-03-27 14:57:26 +0000305#else
Ian Campbell9d4dde52011-12-22 23:39:14 +0000306#define MAX_SKB_FRAGS (65536/PAGE_SIZE + 1)
Anton Blancharda715dea2011-03-27 14:57:26 +0000307#endif
Hans Westgaard Ry5f74f82e2016-02-03 09:26:57 +0100308extern int sysctl_max_skb_frags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Marcelo Ricardo Leitner3953c462016-06-02 15:05:40 -0300310/* Set skb_shinfo(skb)->gso_size to this in case you want skb_segment to
311 * segment using its current segmentation instead.
312 */
313#define GSO_BY_FRAGS 0xFFFF
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315typedef struct skb_frag_struct skb_frag_t;
316
317struct skb_frag_struct {
Ian Campbella8605c62011-10-19 23:01:49 +0000318 struct {
319 struct page *p;
320 } page;
Eric Dumazetcb4dfe52010-09-23 05:06:54 +0000321#if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
David S. Millera309bb02007-07-30 18:47:03 -0700322 __u32 page_offset;
323 __u32 size;
Eric Dumazetcb4dfe52010-09-23 05:06:54 +0000324#else
325 __u16 page_offset;
326 __u16 size;
327#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328};
329
Eric Dumazet9e903e02011-10-18 21:00:24 +0000330static inline unsigned int skb_frag_size(const skb_frag_t *frag)
331{
332 return frag->size;
333}
334
335static inline void skb_frag_size_set(skb_frag_t *frag, unsigned int size)
336{
337 frag->size = size;
338}
339
340static inline void skb_frag_size_add(skb_frag_t *frag, int delta)
341{
342 frag->size += delta;
343}
344
345static inline void skb_frag_size_sub(skb_frag_t *frag, int delta)
346{
347 frag->size -= delta;
348}
349
Willem de Bruijnc613c202017-07-31 08:15:47 -0400350static inline bool skb_frag_must_loop(struct page *p)
351{
352#if defined(CONFIG_HIGHMEM)
353 if (PageHighMem(p))
354 return true;
355#endif
356 return false;
357}
358
359/**
360 * skb_frag_foreach_page - loop over pages in a fragment
361 *
362 * @f: skb frag to operate on
363 * @f_off: offset from start of f->page.p
364 * @f_len: length from f_off to loop over
365 * @p: (temp var) current page
366 * @p_off: (temp var) offset from start of current page,
367 * non-zero only on first page.
368 * @p_len: (temp var) length in current page,
369 * < PAGE_SIZE only on first and last page.
370 * @copied: (temp var) length so far, excluding current p_len.
371 *
372 * A fragment can hold a compound page, in which case per-page
373 * operations, notably kmap_atomic, must be called for each
374 * regular page.
375 */
376#define skb_frag_foreach_page(f, f_off, f_len, p, p_off, p_len, copied) \
377 for (p = skb_frag_page(f) + ((f_off) >> PAGE_SHIFT), \
378 p_off = (f_off) & (PAGE_SIZE - 1), \
379 p_len = skb_frag_must_loop(p) ? \
380 min_t(u32, f_len, PAGE_SIZE - p_off) : f_len, \
381 copied = 0; \
382 copied < f_len; \
383 copied += p_len, p++, p_off = 0, \
384 p_len = min_t(u32, f_len - copied, PAGE_SIZE)) \
385
Patrick Ohlyac45f602009-02-12 05:03:37 +0000386#define HAVE_HW_TIME_STAMP
387
388/**
Randy Dunlapd3a21be2009-03-02 03:15:58 -0800389 * struct skb_shared_hwtstamps - hardware time stamps
Patrick Ohlyac45f602009-02-12 05:03:37 +0000390 * @hwtstamp: hardware time stamp transformed into duration
391 * since arbitrary point in time
Patrick Ohlyac45f602009-02-12 05:03:37 +0000392 *
393 * Software time stamps generated by ktime_get_real() are stored in
Willem de Bruijn4d276eb2014-07-25 18:01:32 -0400394 * skb->tstamp.
Patrick Ohlyac45f602009-02-12 05:03:37 +0000395 *
396 * hwtstamps can only be compared against other hwtstamps from
397 * the same device.
398 *
399 * This structure is attached to packets as part of the
400 * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
401 */
402struct skb_shared_hwtstamps {
403 ktime_t hwtstamp;
Patrick Ohlyac45f602009-02-12 05:03:37 +0000404};
405
Oliver Hartkopp2244d072010-08-17 08:59:14 +0000406/* Definitions for tx_flags in struct skb_shared_info */
407enum {
408 /* generate hardware time stamp */
409 SKBTX_HW_TSTAMP = 1 << 0,
410
Willem de Bruijne7fd2882014-08-04 22:11:48 -0400411 /* generate software time stamp when queueing packet to NIC */
Oliver Hartkopp2244d072010-08-17 08:59:14 +0000412 SKBTX_SW_TSTAMP = 1 << 1,
413
414 /* device driver is going to provide hardware time stamp */
415 SKBTX_IN_PROGRESS = 1 << 2,
416
Shirley Maa6686f22011-07-06 12:22:12 +0000417 /* device driver supports TX zero-copy buffers */
Eric Dumazet62b1a8a2012-06-14 06:42:44 +0000418 SKBTX_DEV_ZEROCOPY = 1 << 3,
Johannes Berg6e3e9392011-11-09 10:15:42 +0100419
420 /* generate wifi status information (where possible) */
Eric Dumazet62b1a8a2012-06-14 06:42:44 +0000421 SKBTX_WIFI_STATUS = 1 << 4,
Pravin B Shelarc9af6db2013-02-11 09:27:41 +0000422
423 /* This indicates at least one fragment might be overwritten
424 * (as in vmsplice(), sendfile() ...)
425 * If we need to compute a TX checksum, we'll need to copy
426 * all frags to avoid possible bad checksum
427 */
428 SKBTX_SHARED_FRAG = 1 << 5,
Willem de Bruijne7fd2882014-08-04 22:11:48 -0400429
430 /* generate software time stamp when entering packet scheduling */
431 SKBTX_SCHED_TSTAMP = 1 << 6,
Shirley Maa6686f22011-07-06 12:22:12 +0000432};
433
Willem de Bruijn52267792017-08-03 16:29:39 -0400434#define SKBTX_ZEROCOPY_FRAG (SKBTX_DEV_ZEROCOPY | SKBTX_SHARED_FRAG)
Willem de Bruijne1c8a602014-08-04 22:11:50 -0400435#define SKBTX_ANY_SW_TSTAMP (SKBTX_SW_TSTAMP | \
Soheil Hassas Yeganeh0a2cf202016-04-27 23:39:01 -0400436 SKBTX_SCHED_TSTAMP)
Willem de Bruijnf24b9be2014-08-04 22:11:45 -0400437#define SKBTX_ANY_TSTAMP (SKBTX_HW_TSTAMP | SKBTX_ANY_SW_TSTAMP)
438
Shirley Maa6686f22011-07-06 12:22:12 +0000439/*
440 * The callback notifies userspace to release buffers when skb DMA is done in
441 * lower device, the skb last reference should be 0 when calling this.
Michael S. Tsirkine19d6762012-11-01 09:16:22 +0000442 * The zerocopy_success argument is true if zero copy transmit occurred,
443 * false on data copy or out of memory error caused by data copy attempt.
Michael S. Tsirkinca8f4fb2012-04-09 00:24:02 +0000444 * The ctx field is used to track device context.
445 * The desc field is used to track userspace buffer index.
Shirley Maa6686f22011-07-06 12:22:12 +0000446 */
447struct ubuf_info {
Michael S. Tsirkine19d6762012-11-01 09:16:22 +0000448 void (*callback)(struct ubuf_info *, bool zerocopy_success);
Willem de Bruijn4ab6c992017-08-03 16:29:42 -0400449 union {
450 struct {
451 unsigned long desc;
452 void *ctx;
453 };
454 struct {
455 u32 id;
456 u16 len;
457 u16 zerocopy:1;
458 u32 bytelen;
459 };
460 };
Eric Dumazetc1d1b432017-08-31 16:48:22 -0700461 refcount_t refcnt;
Willem de Bruijna91dbff2017-08-03 16:29:43 -0400462
463 struct mmpin {
464 struct user_struct *user;
465 unsigned int num_pg;
466 } mmp;
Patrick Ohlyac45f602009-02-12 05:03:37 +0000467};
468
Willem de Bruijn52267792017-08-03 16:29:39 -0400469#define skb_uarg(SKB) ((struct ubuf_info *)(skb_shinfo(SKB)->destructor_arg))
470
Sowmini Varadhan6f89dbc2018-02-15 10:49:32 -0800471int mm_account_pinned_pages(struct mmpin *mmp, size_t size);
472void mm_unaccount_pinned_pages(struct mmpin *mmp);
473
Willem de Bruijn52267792017-08-03 16:29:39 -0400474struct ubuf_info *sock_zerocopy_alloc(struct sock *sk, size_t size);
Willem de Bruijn4ab6c992017-08-03 16:29:42 -0400475struct ubuf_info *sock_zerocopy_realloc(struct sock *sk, size_t size,
476 struct ubuf_info *uarg);
Willem de Bruijn52267792017-08-03 16:29:39 -0400477
478static inline void sock_zerocopy_get(struct ubuf_info *uarg)
479{
Eric Dumazetc1d1b432017-08-31 16:48:22 -0700480 refcount_inc(&uarg->refcnt);
Willem de Bruijn52267792017-08-03 16:29:39 -0400481}
482
483void sock_zerocopy_put(struct ubuf_info *uarg);
Willem de Bruijn52900d22018-11-30 15:32:40 -0500484void sock_zerocopy_put_abort(struct ubuf_info *uarg, bool have_uref);
Willem de Bruijn52267792017-08-03 16:29:39 -0400485
486void sock_zerocopy_callback(struct ubuf_info *uarg, bool success);
487
Willem de Bruijnb5947e52018-11-30 15:32:39 -0500488int skb_zerocopy_iter_dgram(struct sk_buff *skb, struct msghdr *msg, int len);
Willem de Bruijn52267792017-08-03 16:29:39 -0400489int skb_zerocopy_iter_stream(struct sock *sk, struct sk_buff *skb,
490 struct msghdr *msg, int len,
491 struct ubuf_info *uarg);
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493/* This data is invariant across clones and lives at
494 * the end of the header data, ie. at skb->end.
495 */
496struct skb_shared_info {
Daniel Borkmannde8f3a82017-09-25 02:25:51 +0200497 __u8 __unused;
498 __u8 meta_len;
499 __u8 nr_frags;
Ian Campbell9f42f122012-01-05 07:13:39 +0000500 __u8 tx_flags;
Herbert Xu79671682006-06-22 02:40:14 -0700501 unsigned short gso_size;
502 /* Warning: this field is not always filled in (UFO)! */
503 unsigned short gso_segs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 struct sk_buff *frag_list;
Patrick Ohlyac45f602009-02-12 05:03:37 +0000505 struct skb_shared_hwtstamps hwtstamps;
Steffen Klassert7f564522017-04-08 20:36:24 +0200506 unsigned int gso_type;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400507 u32 tskey;
Eric Dumazetec7d2f22010-05-05 01:07:37 -0700508
509 /*
510 * Warning : all fields before dataref are cleared in __alloc_skb()
511 */
512 atomic_t dataref;
513
Johann Baudy69e3c752009-05-18 22:11:22 -0700514 /* Intermediate layers must ensure that destructor_arg
515 * remains valid until skb destructor */
516 void * destructor_arg;
Shirley Maa6686f22011-07-06 12:22:12 +0000517
Eric Dumazetfed66382010-07-22 19:09:08 +0000518 /* must be last field, see pskb_expand_head() */
519 skb_frag_t frags[MAX_SKB_FRAGS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520};
521
522/* We divide dataref into two halves. The higher 16 bits hold references
523 * to the payload part of skb->data. The lower 16 bits hold references to
Patrick McHardy334a8132007-06-25 04:35:20 -0700524 * the entire skb->data. A clone of a headerless skb holds the length of
525 * the header in skb->hdr_len.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 *
527 * All users must obey the rule that the skb->data reference count must be
528 * greater than or equal to the payload reference count.
529 *
530 * Holding a reference to the payload part means that the user does not
531 * care about modifications to the header part of skb->data.
532 */
533#define SKB_DATAREF_SHIFT 16
534#define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
535
David S. Millerd179cd12005-08-17 14:57:30 -0700536
537enum {
Vijay Subramanianc8753d52014-10-02 10:00:43 -0700538 SKB_FCLONE_UNAVAILABLE, /* skb has no fclone (from head_cache) */
539 SKB_FCLONE_ORIG, /* orig skb (from fclone_cache) */
540 SKB_FCLONE_CLONE, /* companion fclone skb (from fclone_cache) */
David S. Millerd179cd12005-08-17 14:57:30 -0700541};
542
Herbert Xu79671682006-06-22 02:40:14 -0700543enum {
544 SKB_GSO_TCPV4 = 1 << 0,
Herbert Xu576a30e2006-06-27 13:22:38 -0700545
546 /* This indicates the skb is from an untrusted source. */
David S. Millerd9d30ad2017-07-03 07:31:57 -0700547 SKB_GSO_DODGY = 1 << 1,
Michael Chanb0da85372006-06-29 12:30:00 -0700548
549 /* This indicates the tcp segment has CWR set. */
David S. Millerd9d30ad2017-07-03 07:31:57 -0700550 SKB_GSO_TCP_ECN = 1 << 2,
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700551
David S. Millerd9d30ad2017-07-03 07:31:57 -0700552 SKB_GSO_TCP_FIXEDID = 1 << 3,
Chris Leech01d5b2f2009-02-27 14:06:49 -0800553
David S. Millerd9d30ad2017-07-03 07:31:57 -0700554 SKB_GSO_TCPV6 = 1 << 4,
Pravin B Shelar68c33162013-02-14 14:02:41 +0000555
David S. Millerd9d30ad2017-07-03 07:31:57 -0700556 SKB_GSO_FCOE = 1 << 5,
Pravin B Shelar73136262013-03-07 13:21:51 +0000557
David S. Millerd9d30ad2017-07-03 07:31:57 -0700558 SKB_GSO_GRE = 1 << 6,
Simon Horman0d89d202013-05-23 21:02:52 +0000559
David S. Millerd9d30ad2017-07-03 07:31:57 -0700560 SKB_GSO_GRE_CSUM = 1 << 7,
Eric Dumazetcb32f512013-10-19 11:42:57 -0700561
David S. Millerd9d30ad2017-07-03 07:31:57 -0700562 SKB_GSO_IPXIP4 = 1 << 8,
Eric Dumazet61c1db72013-10-20 20:47:30 -0700563
David S. Millerd9d30ad2017-07-03 07:31:57 -0700564 SKB_GSO_IPXIP6 = 1 << 9,
Tom Herbert0f4f4ff2014-06-04 17:20:16 -0700565
David S. Millerd9d30ad2017-07-03 07:31:57 -0700566 SKB_GSO_UDP_TUNNEL = 1 << 10,
Tom Herbert4749c092014-06-04 17:20:23 -0700567
David S. Millerd9d30ad2017-07-03 07:31:57 -0700568 SKB_GSO_UDP_TUNNEL_CSUM = 1 << 11,
Alexander Duyckcbc53e02016-04-10 21:44:51 -0400569
David S. Millerd9d30ad2017-07-03 07:31:57 -0700570 SKB_GSO_PARTIAL = 1 << 12,
Alexander Duyck802ab552016-04-10 21:45:03 -0400571
David S. Millerd9d30ad2017-07-03 07:31:57 -0700572 SKB_GSO_TUNNEL_REMCSUM = 1 << 13,
Marcelo Ricardo Leitner90017ac2016-06-02 15:05:43 -0300573
David S. Millerd9d30ad2017-07-03 07:31:57 -0700574 SKB_GSO_SCTP = 1 << 14,
Steffen Klassertc7ef8f02017-04-14 10:05:36 +0200575
David S. Millerd9d30ad2017-07-03 07:31:57 -0700576 SKB_GSO_ESP = 1 << 15,
Willem de Bruijn0c19f8462017-11-21 10:22:25 -0500577
578 SKB_GSO_UDP = 1 << 16,
Willem de Bruijnee80d1e2018-04-26 13:42:16 -0400579
580 SKB_GSO_UDP_L4 = 1 << 17,
Herbert Xu79671682006-06-22 02:40:14 -0700581};
582
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -0700583#if BITS_PER_LONG > 32
584#define NET_SKBUFF_DATA_USES_OFFSET 1
585#endif
586
587#ifdef NET_SKBUFF_DATA_USES_OFFSET
588typedef unsigned int sk_buff_data_t;
589#else
590typedef unsigned char *sk_buff_data_t;
591#endif
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593/**
594 * struct sk_buff - socket buffer
595 * @next: Next buffer in list
596 * @prev: Previous buffer in list
Eric Dumazet363ec39232014-02-26 14:02:11 -0800597 * @tstamp: Time we arrived/left
Eric Dumazet56b17422014-11-03 08:19:53 -0800598 * @rbnode: RB tree node, alternative to next/prev for netem/tcp
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700599 * @sk: Socket we are owned by
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 * @dev: Device we arrived on/are leaving by
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700601 * @cb: Control buffer. Free for use by every layer. Put private vars here
Eric Dumazet7fee2262010-05-11 23:19:48 +0000602 * @_skb_refdst: destination entry (with norefcount bit)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700603 * @sp: the security path, used for xfrm
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 * @len: Length of actual data
605 * @data_len: Data length
606 * @mac_len: Length of link layer header
Patrick McHardy334a8132007-06-25 04:35:20 -0700607 * @hdr_len: writable header length of cloned skb
Herbert Xu663ead32007-04-09 11:59:07 -0700608 * @csum: Checksum (must include start/offset pair)
609 * @csum_start: Offset from skb->head where checksumming should start
610 * @csum_offset: Offset from csum_start where checksum should be stored
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700611 * @priority: Packet queueing priority
WANG Cong60ff7462014-05-04 16:39:18 -0700612 * @ignore_df: allow local fragmentation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 * @cloned: Head may be cloned (check refcnt to be sure)
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700614 * @ip_summed: Driver fed us an IP checksum
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 * @nohdr: Payload reference only, must not modify header
616 * @pkt_type: Packet class
Randy Dunlapc83c2482005-10-18 22:07:41 -0700617 * @fclone: skbuff clone status
Randy Dunlapc83c2482005-10-18 22:07:41 -0700618 * @ipvs_property: skbuff is owned by ipvs
Ido Schimmel875e8932018-12-04 08:15:10 +0000619 * @offload_fwd_mark: Packet was L2-forwarded in hardware
620 * @offload_l3_fwd_mark: Packet was L3-forwarded in hardware
Willem de Bruijne7246e12017-01-07 17:06:35 -0500621 * @tc_skip_classify: do not classify packet. set by IFB device
Willem de Bruijn8dc07fd2017-01-07 17:06:37 -0500622 * @tc_at_ingress: used within tc_classify to distinguish in/egress
Willem de Bruijnbc31c902017-01-07 17:06:38 -0500623 * @tc_redirected: packet was redirected by a tc action
624 * @tc_from_ingress: if tc_redirected, tc_at_ingress at time of redirect
Randy Dunlap31729362008-02-18 20:52:13 -0800625 * @peeked: this packet has been seen already, so stats have been
626 * done for it, don't do them again
Jozsef Kadlecsikba9dda32007-07-07 22:21:23 -0700627 * @nf_trace: netfilter packet trace flag
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700628 * @protocol: Packet protocol from driver
629 * @destructor: Destruct function
Eric Dumazete2080072017-10-04 12:59:58 -0700630 * @tcp_tsorted_anchor: list structure for TCP (tp->tsorted_sent_queue)
Florian Westphala9e419d2017-01-23 18:21:59 +0100631 * @_nfct: Associated connection, if any (with nfctinfo bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
Eric Dumazet8964be42009-11-20 15:35:04 -0800633 * @skb_iif: ifindex of device we arrived on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 * @tc_index: Traffic control index
Tom Herbert61b905d2014-03-24 15:34:47 -0700635 * @hash: the packet hash
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700636 * @queue_mapping: Queue mapping for multiqueue devices
David S. Miller0b725a22014-08-25 15:51:53 -0700637 * @xmit_more: More SKBs are pending for this queue
Stefano Brivio8b700862018-07-11 14:39:42 +0200638 * @pfmemalloc: skbuff was allocated from PFMEMALLOC reserves
Florian Westphaldf5042f2018-12-18 17:15:16 +0100639 * @active_extensions: active extensions (skb_ext_id types)
Randy Dunlap553a5672008-04-20 10:51:01 -0700640 * @ndisc_nodetype: router type (from link layer)
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700641 * @ooo_okay: allow the mapping of a socket to a queue to be changed
Tom Herbert61b905d2014-03-24 15:34:47 -0700642 * @l4_hash: indicate hash is a canonical 4-tuple hash over transport
Changli Gao4ca24622011-08-19 07:26:44 -0700643 * ports.
Tom Herberta3b18dd2014-07-01 21:33:17 -0700644 * @sw_hash: indicates hash was computed in software stack
Johannes Berg6e3e9392011-11-09 10:15:42 +0100645 * @wifi_acked_valid: wifi_acked was set
646 * @wifi_acked: whether frame was acked on wifi or not
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000647 * @no_fcs: Request NIC to treat last 4 bytes as Ethernet FCS
Davide Carattidba00302017-05-18 15:44:40 +0200648 * @csum_not_inet: use CRC32c to resolve CHECKSUM_PARTIAL
Julian Anastasov4ff06202017-02-06 23:14:12 +0200649 * @dst_pending_confirm: need to confirm neighbour
Stefano Brivioa48d1892018-07-17 11:52:57 +0200650 * @decrypted: Decrypted SKB
Eliezer Tamir06021292013-06-10 11:39:50 +0300651 * @napi_id: id of the NAPI struct this skb came from
James Morris984bc162006-06-09 00:29:17 -0700652 * @secmark: security marking
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700653 * @mark: Generic packet mark
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000654 * @vlan_proto: vlan encapsulation protocol
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700655 * @vlan_tci: vlan tag control information
Simon Horman0d89d202013-05-23 21:02:52 +0000656 * @inner_protocol: Protocol (encapsulation)
Joseph Gasparakis6a674e92012-12-07 14:14:14 +0000657 * @inner_transport_header: Inner transport layer header (encapsulation)
658 * @inner_network_header: Network layer header (encapsulation)
Pravin B Shelaraefbd2b2013-03-07 13:21:46 +0000659 * @inner_mac_header: Link layer header (encapsulation)
Daniel Balutad84e0bd2011-07-10 07:04:04 -0700660 * @transport_header: Transport layer header
661 * @network_header: Network layer header
662 * @mac_header: Link layer header
663 * @tail: Tail pointer
664 * @end: End pointer
665 * @head: Head of buffer
666 * @data: Data head pointer
667 * @truesize: Buffer size
668 * @users: User count - see {datagram,tcp}.c
Florian Westphaldf5042f2018-12-18 17:15:16 +0100669 * @extensions: allocated extensions, valid if active_extensions is nonzero
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 */
671
672struct sk_buff {
Eric Dumazet363ec39232014-02-26 14:02:11 -0800673 union {
Eric Dumazet56b17422014-11-03 08:19:53 -0800674 struct {
675 /* These two members must be first. */
676 struct sk_buff *next;
677 struct sk_buff *prev;
Felix Fietkauda3f5cf2010-02-23 11:45:51 +0000678
Eric Dumazet56b17422014-11-03 08:19:53 -0800679 union {
Eric Dumazetbffa72c2017-09-19 05:14:24 -0700680 struct net_device *dev;
681 /* Some protocols might use this space to store information,
682 * while device pointer would be NULL.
683 * UDP receive path is one user.
684 */
685 unsigned long dev_scratch;
Eric Dumazet56b17422014-11-03 08:19:53 -0800686 };
687 };
Peter Oskolkovfa0f5272018-08-02 23:34:39 +0000688 struct rb_node rbnode; /* used in netem, ip4 defrag, and tcp stack */
David Millerd4546c22018-06-24 14:13:49 +0900689 struct list_head list;
Eric Dumazet56b17422014-11-03 08:19:53 -0800690 };
Peter Oskolkovfa0f5272018-08-02 23:34:39 +0000691
692 union {
693 struct sock *sk;
694 int ip_defrag_offset;
695 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Eric Dumazetc84d9492016-12-08 11:41:55 -0800697 union {
Eric Dumazetbffa72c2017-09-19 05:14:24 -0700698 ktime_t tstamp;
Eric Dumazetd3edd062018-09-21 08:51:50 -0700699 u64 skb_mstamp_ns; /* earliest departure time */
Eric Dumazetc84d9492016-12-08 11:41:55 -0800700 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 /*
702 * This is the control buffer. It is free to use for every
703 * layer. Please put your private variables there. If you
704 * want to keep them across layers you have to do a skb_clone()
705 * first. This is owned by whoever has the skb queued ATM.
706 */
Felix Fietkauda3f5cf2010-02-23 11:45:51 +0000707 char cb[48] __aligned(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Eric Dumazete2080072017-10-04 12:59:58 -0700709 union {
710 struct {
711 unsigned long _skb_refdst;
712 void (*destructor)(struct sk_buff *skb);
713 };
714 struct list_head tcp_tsorted_anchor;
715 };
716
Felix Fietkauda3f5cf2010-02-23 11:45:51 +0000717#ifdef CONFIG_XFRM
718 struct sec_path *sp;
719#endif
Eric Dumazetb1937222014-09-28 22:18:47 -0700720#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Florian Westphala9e419d2017-01-23 18:21:59 +0100721 unsigned long _nfct;
Eric Dumazetb1937222014-09-28 22:18:47 -0700722#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 unsigned int len,
Patrick McHardy334a8132007-06-25 04:35:20 -0700724 data_len;
725 __u16 mac_len,
726 hdr_len;
Eric Dumazetb1937222014-09-28 22:18:47 -0700727
728 /* Following fields are _not_ copied in __copy_skb_header()
729 * Note that queue_mapping is here mostly to fill a hole.
730 */
Eric Dumazetb1937222014-09-28 22:18:47 -0700731 __u16 queue_mapping;
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200732
733/* if you move cloned around you also must adapt those constants */
734#ifdef __BIG_ENDIAN_BITFIELD
735#define CLONED_MASK (1 << 7)
736#else
737#define CLONED_MASK 1
738#endif
739#define CLONED_OFFSET() offsetof(struct sk_buff, __cloned_offset)
740
741 __u8 __cloned_offset[0];
Eric Dumazetb1937222014-09-28 22:18:47 -0700742 __u8 cloned:1,
Harald Welte6869c4d2005-08-09 19:24:19 -0700743 nohdr:1,
Patrick McHardyb84f4cc2005-11-20 21:19:21 -0800744 fclone:2,
Herbert Xua59322b2007-12-05 01:53:40 -0800745 peeked:1,
Eric Dumazetb1937222014-09-28 22:18:47 -0700746 head_frag:1,
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200747 xmit_more:1,
Stefano Brivio8b700862018-07-11 14:39:42 +0200748 pfmemalloc:1;
Florian Westphaldf5042f2018-12-18 17:15:16 +0100749#ifdef CONFIG_SKB_EXTENSIONS
750 __u8 active_extensions;
751#endif
Eric Dumazetb1937222014-09-28 22:18:47 -0700752 /* fields enclosed in headers_start/headers_end are copied
753 * using a single memcpy() in __copy_skb_header()
754 */
Randy Dunlapebcf34f2014-10-26 19:14:06 -0700755 /* private: */
Eric Dumazetb1937222014-09-28 22:18:47 -0700756 __u32 headers_start[0];
Randy Dunlapebcf34f2014-10-26 19:14:06 -0700757 /* public: */
Hannes Frederic Sowa233577a2014-09-12 14:04:43 +0200758
759/* if you move pkt_type around you also must adapt those constants */
760#ifdef __BIG_ENDIAN_BITFIELD
761#define PKT_TYPE_MAX (7 << 5)
762#else
763#define PKT_TYPE_MAX 7
KOVACS Krisztian2fc72c72011-01-12 20:25:08 +0100764#endif
Hannes Frederic Sowa233577a2014-09-12 14:04:43 +0200765#define PKT_TYPE_OFFSET() offsetof(struct sk_buff, __pkt_type_offset)
766
767 __u8 __pkt_type_offset[0];
Eric Dumazetb1937222014-09-28 22:18:47 -0700768 __u8 pkt_type:3;
Eric Dumazetb1937222014-09-28 22:18:47 -0700769 __u8 ignore_df:1;
Eric Dumazetb1937222014-09-28 22:18:47 -0700770 __u8 nf_trace:1;
771 __u8 ip_summed:2;
772 __u8 ooo_okay:1;
Stefano Brivio8b700862018-07-11 14:39:42 +0200773
Eric Dumazetb1937222014-09-28 22:18:47 -0700774 __u8 l4_hash:1;
775 __u8 sw_hash:1;
776 __u8 wifi_acked_valid:1;
777 __u8 wifi_acked:1;
Eric Dumazetb1937222014-09-28 22:18:47 -0700778 __u8 no_fcs:1;
779 /* Indicates the inner headers are valid in the skbuff. */
780 __u8 encapsulation:1;
781 __u8 encap_hdr_csum:1;
782 __u8 csum_valid:1;
Stefano Brivio8b700862018-07-11 14:39:42 +0200783
Michał Mirosław0c4b2d32018-11-10 19:58:36 +0100784#ifdef __BIG_ENDIAN_BITFIELD
785#define PKT_VLAN_PRESENT_BIT 7
786#else
787#define PKT_VLAN_PRESENT_BIT 0
788#endif
789#define PKT_VLAN_PRESENT_OFFSET() offsetof(struct sk_buff, __pkt_vlan_present_offset)
790 __u8 __pkt_vlan_present_offset[0];
791 __u8 vlan_present:1;
Eric Dumazetb1937222014-09-28 22:18:47 -0700792 __u8 csum_complete_sw:1;
793 __u8 csum_level:2;
Davide Carattidba00302017-05-18 15:44:40 +0200794 __u8 csum_not_inet:1;
Julian Anastasov4ff06202017-02-06 23:14:12 +0200795 __u8 dst_pending_confirm:1;
Eric Dumazetb1937222014-09-28 22:18:47 -0700796#ifdef CONFIG_IPV6_NDISC_NODETYPE
797 __u8 ndisc_nodetype:2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798#endif
Stefano Brivio8b700862018-07-11 14:39:42 +0200799
Michał Mirosław0c4b2d32018-11-10 19:58:36 +0100800 __u8 ipvs_property:1;
Tom Herbert8bce6d72014-09-29 20:22:29 -0700801 __u8 inner_protocol_type:1;
Tom Herberte585f232014-11-04 09:06:54 -0800802 __u8 remcsum_offload:1;
Ido Schimmel6bc506b2016-08-25 18:42:37 +0200803#ifdef CONFIG_NET_SWITCHDEV
804 __u8 offload_fwd_mark:1;
Ido Schimmel875e8932018-12-04 08:15:10 +0000805 __u8 offload_l3_fwd_mark:1;
Ido Schimmel6bc506b2016-08-25 18:42:37 +0200806#endif
Willem de Bruijne7246e12017-01-07 17:06:35 -0500807#ifdef CONFIG_NET_CLS_ACT
808 __u8 tc_skip_classify:1;
Willem de Bruijn8dc07fd2017-01-07 17:06:37 -0500809 __u8 tc_at_ingress:1;
Willem de Bruijnbc31c902017-01-07 17:06:38 -0500810 __u8 tc_redirected:1;
811 __u8 tc_from_ingress:1;
Willem de Bruijne7246e12017-01-07 17:06:35 -0500812#endif
Stefano Brivioa48d1892018-07-17 11:52:57 +0200813#ifdef CONFIG_TLS_DEVICE
814 __u8 decrypted:1;
815#endif
Alexander Duyck4031ae62012-01-27 06:22:53 +0000816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817#ifdef CONFIG_NET_SCHED
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700818 __u16 tc_index; /* traffic control index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819#endif
Vegard Nossumfe55f6d2008-08-30 12:16:35 +0200820
Eric Dumazetb1937222014-09-28 22:18:47 -0700821 union {
822 __wsum csum;
823 struct {
824 __u16 csum_start;
825 __u16 csum_offset;
826 };
827 };
828 __u32 priority;
829 int skb_iif;
830 __u32 hash;
831 __be16 vlan_proto;
832 __u16 vlan_tci;
Eric Dumazet2bd82482015-02-03 23:48:24 -0800833#if defined(CONFIG_NET_RX_BUSY_POLL) || defined(CONFIG_XPS)
834 union {
835 unsigned int napi_id;
836 unsigned int sender_cpu;
837 };
Chris Leech97fc2f02006-05-23 17:55:33 -0700838#endif
James Morris984bc162006-06-09 00:29:17 -0700839#ifdef CONFIG_NETWORK_SECMARK
Ido Schimmel6bc506b2016-08-25 18:42:37 +0200840 __u32 secmark;
James Morris984bc162006-06-09 00:29:17 -0700841#endif
Scott Feldman0c4f6912015-07-18 18:24:48 -0700842
Neil Horman3b885782009-10-12 13:26:31 -0700843 union {
844 __u32 mark;
Eric Dumazet16fad692013-03-14 05:40:32 +0000845 __u32 reserved_tailroom;
Neil Horman3b885782009-10-12 13:26:31 -0700846 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Tom Herbert8bce6d72014-09-29 20:22:29 -0700848 union {
849 __be16 inner_protocol;
850 __u8 inner_ipproto;
851 };
852
Simon Horman1a37e412013-05-23 21:02:51 +0000853 __u16 inner_transport_header;
854 __u16 inner_network_header;
855 __u16 inner_mac_header;
Eric Dumazetb1937222014-09-28 22:18:47 -0700856
857 __be16 protocol;
Simon Horman1a37e412013-05-23 21:02:51 +0000858 __u16 transport_header;
859 __u16 network_header;
860 __u16 mac_header;
Eric Dumazetb1937222014-09-28 22:18:47 -0700861
Randy Dunlapebcf34f2014-10-26 19:14:06 -0700862 /* private: */
Eric Dumazetb1937222014-09-28 22:18:47 -0700863 __u32 headers_end[0];
Randy Dunlapebcf34f2014-10-26 19:14:06 -0700864 /* public: */
Eric Dumazetb1937222014-09-28 22:18:47 -0700865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 /* These elements must be at the end, see alloc_skb() for details. */
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700867 sk_buff_data_t tail;
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -0700868 sk_buff_data_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 unsigned char *head,
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -0700870 *data;
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700871 unsigned int truesize;
Reshetova, Elena63354792017-06-30 13:07:58 +0300872 refcount_t users;
Florian Westphaldf5042f2018-12-18 17:15:16 +0100873
874#ifdef CONFIG_SKB_EXTENSIONS
875 /* only useable after checking ->active_extensions != 0 */
876 struct skb_ext *extensions;
877#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878};
879
880#ifdef __KERNEL__
881/*
882 * Handling routines are only of interest to the kernel
883 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Mel Gormanc93bdd02012-07-31 16:44:19 -0700885#define SKB_ALLOC_FCLONE 0x01
886#define SKB_ALLOC_RX 0x02
Alexander Duyckfd11a832014-12-09 19:40:49 -0800887#define SKB_ALLOC_NAPI 0x04
Mel Gormanc93bdd02012-07-31 16:44:19 -0700888
889/* Returns true if the skb was allocated from PFMEMALLOC reserves */
890static inline bool skb_pfmemalloc(const struct sk_buff *skb)
891{
892 return unlikely(skb->pfmemalloc);
893}
894
Eric Dumazet7fee2262010-05-11 23:19:48 +0000895/*
896 * skb might have a dst pointer attached, refcounted or not.
897 * _skb_refdst low order bit is set if refcount was _not_ taken
898 */
899#define SKB_DST_NOREF 1UL
900#define SKB_DST_PTRMASK ~(SKB_DST_NOREF)
901
Florian Westphala9e419d2017-01-23 18:21:59 +0100902#define SKB_NFCT_PTRMASK ~(7UL)
Eric Dumazet7fee2262010-05-11 23:19:48 +0000903/**
904 * skb_dst - returns skb dst_entry
905 * @skb: buffer
906 *
907 * Returns skb dst_entry, regardless of reference taken or not.
908 */
Eric Dumazetadf30902009-06-02 05:19:30 +0000909static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
910{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000911 /* If refdst was not refcounted, check we still are in a
912 * rcu_read_lock section
913 */
914 WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
915 !rcu_read_lock_held() &&
916 !rcu_read_lock_bh_held());
917 return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
Eric Dumazetadf30902009-06-02 05:19:30 +0000918}
919
Eric Dumazet7fee2262010-05-11 23:19:48 +0000920/**
921 * skb_dst_set - sets skb dst
922 * @skb: buffer
923 * @dst: dst entry
924 *
925 * Sets skb dst, assuming a reference was taken on dst and should
926 * be released by skb_dst_drop()
927 */
Eric Dumazetadf30902009-06-02 05:19:30 +0000928static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
929{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000930 skb->_skb_refdst = (unsigned long)dst;
931}
932
Julian Anastasov932bc4d2013-03-21 11:57:58 +0200933/**
934 * skb_dst_set_noref - sets skb dst, hopefully, without taking reference
935 * @skb: buffer
936 * @dst: dst entry
937 *
938 * Sets skb dst, assuming a reference was not taken on dst.
939 * If dst entry is cached, we do not take reference and dst_release
940 * will be avoided by refdst_drop. If dst entry is not cached, we take
941 * reference, so that last dst_release can destroy the dst immediately.
942 */
943static inline void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst)
944{
Hannes Frederic Sowadbfc4fb2014-12-06 19:19:42 +0100945 WARN_ON(!rcu_read_lock_held() && !rcu_read_lock_bh_held());
946 skb->_skb_refdst = (unsigned long)dst | SKB_DST_NOREF;
Julian Anastasov932bc4d2013-03-21 11:57:58 +0200947}
Eric Dumazet7fee2262010-05-11 23:19:48 +0000948
949/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300950 * skb_dst_is_noref - Test if skb dst isn't refcounted
Eric Dumazet7fee2262010-05-11 23:19:48 +0000951 * @skb: buffer
952 */
953static inline bool skb_dst_is_noref(const struct sk_buff *skb)
954{
955 return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
Eric Dumazetadf30902009-06-02 05:19:30 +0000956}
957
Eric Dumazet511c3f92009-06-02 05:14:27 +0000958static inline struct rtable *skb_rtable(const struct sk_buff *skb)
959{
Eric Dumazetadf30902009-06-02 05:19:30 +0000960 return (struct rtable *)skb_dst(skb);
Eric Dumazet511c3f92009-06-02 05:14:27 +0000961}
962
Jamal Hadi Salim8b10cab2016-07-02 06:43:14 -0400963/* For mangling skb->pkt_type from user space side from applications
964 * such as nft, tc, etc, we only allow a conservative subset of
965 * possible pkt_types to be set.
966*/
967static inline bool skb_pkt_type_ok(u32 ptype)
968{
969 return ptype <= PACKET_OTHERHOST;
970}
971
Miroslav Lichvar90b602f2017-05-19 17:52:37 +0200972static inline unsigned int skb_napi_id(const struct sk_buff *skb)
973{
974#ifdef CONFIG_NET_RX_BUSY_POLL
975 return skb->napi_id;
976#else
977 return 0;
978#endif
979}
980
Paolo Abeni3889a8032017-06-12 11:23:41 +0200981/* decrement the reference count and return true if we can free the skb */
982static inline bool skb_unref(struct sk_buff *skb)
983{
984 if (unlikely(!skb))
985 return false;
Reshetova, Elena63354792017-06-30 13:07:58 +0300986 if (likely(refcount_read(&skb->users) == 1))
Paolo Abeni3889a8032017-06-12 11:23:41 +0200987 smp_rmb();
Reshetova, Elena63354792017-06-30 13:07:58 +0300988 else if (likely(!refcount_dec_and_test(&skb->users)))
Paolo Abeni3889a8032017-06-12 11:23:41 +0200989 return false;
990
991 return true;
992}
993
Paolo Abeni0a463c72017-06-12 11:23:42 +0200994void skb_release_head_state(struct sk_buff *skb);
Joe Perches7965bd42013-09-26 14:48:15 -0700995void kfree_skb(struct sk_buff *skb);
996void kfree_skb_list(struct sk_buff *segs);
997void skb_tx_error(struct sk_buff *skb);
998void consume_skb(struct sk_buff *skb);
Paolo Abenica2c1412017-09-06 14:44:36 +0200999void __consume_stateless_skb(struct sk_buff *skb);
Joe Perches7965bd42013-09-26 14:48:15 -07001000void __kfree_skb(struct sk_buff *skb);
Eric Dumazetd7e88832012-04-30 08:10:34 +00001001extern struct kmem_cache *skbuff_head_cache;
Eric Dumazetbad43ca2012-05-19 03:02:02 +00001002
Joe Perches7965bd42013-09-26 14:48:15 -07001003void kfree_skb_partial(struct sk_buff *skb, bool head_stolen);
1004bool skb_try_coalesce(struct sk_buff *to, struct sk_buff *from,
1005 bool *fragstolen, int *delta_truesize);
Eric Dumazetbad43ca2012-05-19 03:02:02 +00001006
Joe Perches7965bd42013-09-26 14:48:15 -07001007struct sk_buff *__alloc_skb(unsigned int size, gfp_t priority, int flags,
1008 int node);
Eric Dumazet2ea2f622015-04-24 16:05:01 -07001009struct sk_buff *__build_skb(void *data, unsigned int frag_size);
Joe Perches7965bd42013-09-26 14:48:15 -07001010struct sk_buff *build_skb(void *data, unsigned int frag_size);
David S. Millerd179cd12005-08-17 14:57:30 -07001011static inline struct sk_buff *alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +01001012 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -07001013{
Eric Dumazet564824b2010-10-11 19:05:25 +00001014 return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
David S. Millerd179cd12005-08-17 14:57:30 -07001015}
1016
Eric Dumazet2e4e4412014-09-17 04:49:49 -07001017struct sk_buff *alloc_skb_with_frags(unsigned long header_len,
1018 unsigned long data_len,
1019 int max_page_order,
1020 int *errcode,
1021 gfp_t gfp_mask);
1022
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001023/* Layout of fast clones : [skb1][skb2][fclone_ref] */
1024struct sk_buff_fclones {
1025 struct sk_buff skb1;
1026
1027 struct sk_buff skb2;
1028
Reshetova, Elena26385952017-06-30 13:07:59 +03001029 refcount_t fclone_ref;
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001030};
1031
1032/**
1033 * skb_fclone_busy - check if fclone is busy
Stephen Hemminger293de7d2016-10-23 09:28:29 -07001034 * @sk: socket
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001035 * @skb: buffer
1036 *
Masanari Iidabda13fe2015-12-13 16:53:02 +09001037 * Returns true if skb is a fast clone, and its clone is not freed.
Eric Dumazet39bb5e62014-10-30 10:32:34 -07001038 * Some drivers call skb_orphan() in their ndo_start_xmit(),
1039 * so we also check that this didnt happen.
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001040 */
Eric Dumazet39bb5e62014-10-30 10:32:34 -07001041static inline bool skb_fclone_busy(const struct sock *sk,
1042 const struct sk_buff *skb)
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001043{
1044 const struct sk_buff_fclones *fclones;
1045
1046 fclones = container_of(skb, struct sk_buff_fclones, skb1);
1047
1048 return skb->fclone == SKB_FCLONE_ORIG &&
Reshetova, Elena26385952017-06-30 13:07:59 +03001049 refcount_read(&fclones->fclone_ref) > 1 &&
Eric Dumazet39bb5e62014-10-30 10:32:34 -07001050 fclones->skb2.sk == sk;
Eric Dumazetd0bf4a92014-09-29 13:29:15 -07001051}
1052
David S. Millerd179cd12005-08-17 14:57:30 -07001053static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +01001054 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -07001055{
Mel Gormanc93bdd02012-07-31 16:44:19 -07001056 return __alloc_skb(size, priority, SKB_ALLOC_FCLONE, NUMA_NO_NODE);
David S. Millerd179cd12005-08-17 14:57:30 -07001057}
1058
Joe Perches7965bd42013-09-26 14:48:15 -07001059struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
Toshiaki Makitab0768a82018-08-03 16:58:09 +09001060void skb_headers_offset_update(struct sk_buff *skb, int off);
Joe Perches7965bd42013-09-26 14:48:15 -07001061int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
1062struct sk_buff *skb_clone(struct sk_buff *skb, gfp_t priority);
Ilya Lesokhin08303c12018-04-30 10:16:11 +03001063void skb_copy_header(struct sk_buff *new, const struct sk_buff *old);
Joe Perches7965bd42013-09-26 14:48:15 -07001064struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
Octavian Purdilabad93e92014-06-12 01:36:26 +03001065struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
1066 gfp_t gfp_mask, bool fclone);
1067static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
1068 gfp_t gfp_mask)
1069{
1070 return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
1071}
Eric Dumazet117632e2011-12-03 21:39:53 +00001072
Joe Perches7965bd42013-09-26 14:48:15 -07001073int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
1074struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
1075 unsigned int headroom);
1076struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
1077 int newtailroom, gfp_t priority);
Jason A. Donenfeld48a1df62017-06-04 04:16:22 +02001078int __must_check skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
1079 int offset, int len);
1080int __must_check skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg,
1081 int offset, int len);
Joe Perches7965bd42013-09-26 14:48:15 -07001082int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
Florian Fainellicd0a1372017-08-22 15:12:14 -07001083int __skb_pad(struct sk_buff *skb, int pad, bool free_on_error);
1084
1085/**
1086 * skb_pad - zero pad the tail of an skb
1087 * @skb: buffer to pad
1088 * @pad: space to pad
1089 *
1090 * Ensure that a buffer is followed by a padding area that is zero
1091 * filled. Used by network drivers which may DMA or transfer data
1092 * beyond the buffer end onto the wire.
1093 *
1094 * May return error in out of memory cases. The skb is freed on error.
1095 */
1096static inline int skb_pad(struct sk_buff *skb, int pad)
1097{
1098 return __skb_pad(skb, pad, true);
1099}
Neil Hormanead2ceb2009-03-11 09:49:55 +00001100#define dev_kfree_skb(a) consume_skb(a)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Hannes Frederic Sowabe12a1f2015-05-21 16:59:58 +02001102int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
1103 int offset, size_t size);
1104
Eric Dumazetd94d9fe2009-11-04 09:50:58 -08001105struct skb_seq_state {
Thomas Graf677e90e2005-06-23 20:59:51 -07001106 __u32 lower_offset;
1107 __u32 upper_offset;
1108 __u32 frag_idx;
1109 __u32 stepped_offset;
1110 struct sk_buff *root_skb;
1111 struct sk_buff *cur_skb;
1112 __u8 *frag_data;
1113};
1114
Joe Perches7965bd42013-09-26 14:48:15 -07001115void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
1116 unsigned int to, struct skb_seq_state *st);
1117unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
1118 struct skb_seq_state *st);
1119void skb_abort_seq_read(struct skb_seq_state *st);
Thomas Graf677e90e2005-06-23 20:59:51 -07001120
Joe Perches7965bd42013-09-26 14:48:15 -07001121unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
Bojan Prtvar059a2442015-02-22 11:46:35 +01001122 unsigned int to, struct ts_config *config);
Thomas Graf3fc7e8a2005-06-23 21:00:17 -07001123
Tom Herbert09323cc2013-12-15 22:16:19 -08001124/*
1125 * Packet hash types specify the type of hash in skb_set_hash.
1126 *
1127 * Hash types refer to the protocol layer addresses which are used to
1128 * construct a packet's hash. The hashes are used to differentiate or identify
1129 * flows of the protocol layer for the hash type. Hash types are either
1130 * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
1131 *
1132 * Properties of hashes:
1133 *
1134 * 1) Two packets in different flows have different hash values
1135 * 2) Two packets in the same flow should have the same hash value
1136 *
1137 * A hash at a higher layer is considered to be more specific. A driver should
1138 * set the most specific hash possible.
1139 *
1140 * A driver cannot indicate a more specific hash than the layer at which a hash
1141 * was computed. For instance an L3 hash cannot be set as an L4 hash.
1142 *
1143 * A driver may indicate a hash level which is less specific than the
1144 * actual layer the hash was computed on. For instance, a hash computed
1145 * at L4 may be considered an L3 hash. This should only be done if the
1146 * driver can't unambiguously determine that the HW computed the hash at
1147 * the higher layer. Note that the "should" in the second property above
1148 * permits this.
1149 */
1150enum pkt_hash_types {
1151 PKT_HASH_TYPE_NONE, /* Undefined type */
1152 PKT_HASH_TYPE_L2, /* Input: src_MAC, dest_MAC */
1153 PKT_HASH_TYPE_L3, /* Input: src_IP, dst_IP */
1154 PKT_HASH_TYPE_L4, /* Input: src_IP, dst_IP, src_port, dst_port */
1155};
1156
Tom Herbertbcc83832015-09-01 09:24:24 -07001157static inline void skb_clear_hash(struct sk_buff *skb)
1158{
1159 skb->hash = 0;
1160 skb->sw_hash = 0;
1161 skb->l4_hash = 0;
1162}
1163
1164static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
1165{
1166 if (!skb->l4_hash)
1167 skb_clear_hash(skb);
1168}
1169
1170static inline void
1171__skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
1172{
1173 skb->l4_hash = is_l4;
1174 skb->sw_hash = is_sw;
1175 skb->hash = hash;
1176}
1177
Tom Herbert09323cc2013-12-15 22:16:19 -08001178static inline void
1179skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
1180{
Tom Herbertbcc83832015-09-01 09:24:24 -07001181 /* Used by drivers to set hash from HW */
1182 __skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
1183}
1184
1185static inline void
1186__skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
1187{
1188 __skb_set_hash(skb, hash, true, is_l4);
Tom Herbert09323cc2013-12-15 22:16:19 -08001189}
1190
Tom Herberte5276932015-09-01 09:24:23 -07001191void __skb_get_hash(struct sk_buff *skb);
Florian Westphalb9177832016-10-26 18:49:46 +02001192u32 __skb_get_hash_symmetric(const struct sk_buff *skb);
Tom Herberte5276932015-09-01 09:24:23 -07001193u32 skb_get_poff(const struct sk_buff *skb);
1194u32 __skb_get_poff(const struct sk_buff *skb, void *data,
Paolo Abeni72a338b2018-05-04 11:32:59 +02001195 const struct flow_keys_basic *keys, int hlen);
Tom Herberte5276932015-09-01 09:24:23 -07001196__be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
1197 void *data, int hlen_proto);
1198
1199static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
1200 int thoff, u8 ip_proto)
1201{
1202 return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
1203}
1204
1205void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
1206 const struct flow_dissector_key *key,
1207 unsigned int key_count);
1208
Willem de Bruijn2dfd1842018-09-18 16:20:18 -04001209#ifdef CONFIG_NET
Petar Penkovd58e4682018-09-14 07:46:18 -07001210int skb_flow_dissector_bpf_prog_attach(const union bpf_attr *attr,
1211 struct bpf_prog *prog);
1212
1213int skb_flow_dissector_bpf_prog_detach(const union bpf_attr *attr);
Willem de Bruijn2dfd1842018-09-18 16:20:18 -04001214#else
1215static inline int skb_flow_dissector_bpf_prog_attach(const union bpf_attr *attr,
1216 struct bpf_prog *prog)
1217{
1218 return -EOPNOTSUPP;
1219}
1220
1221static inline int skb_flow_dissector_bpf_prog_detach(const union bpf_attr *attr)
1222{
1223 return -EOPNOTSUPP;
1224}
1225#endif
Petar Penkovd58e4682018-09-14 07:46:18 -07001226
Tom Herberte5276932015-09-01 09:24:23 -07001227bool __skb_flow_dissect(const struct sk_buff *skb,
1228 struct flow_dissector *flow_dissector,
1229 void *target_container,
Tom Herbertcd79a232015-09-01 09:24:27 -07001230 void *data, __be16 proto, int nhoff, int hlen,
1231 unsigned int flags);
Tom Herberte5276932015-09-01 09:24:23 -07001232
1233static inline bool skb_flow_dissect(const struct sk_buff *skb,
1234 struct flow_dissector *flow_dissector,
Tom Herbertcd79a232015-09-01 09:24:27 -07001235 void *target_container, unsigned int flags)
Tom Herberte5276932015-09-01 09:24:23 -07001236{
1237 return __skb_flow_dissect(skb, flow_dissector, target_container,
Tom Herbertcd79a232015-09-01 09:24:27 -07001238 NULL, 0, 0, 0, flags);
Tom Herberte5276932015-09-01 09:24:23 -07001239}
1240
1241static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
Tom Herbertcd79a232015-09-01 09:24:27 -07001242 struct flow_keys *flow,
1243 unsigned int flags)
Tom Herberte5276932015-09-01 09:24:23 -07001244{
1245 memset(flow, 0, sizeof(*flow));
1246 return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
Tom Herbertcd79a232015-09-01 09:24:27 -07001247 NULL, 0, 0, 0, flags);
Tom Herberte5276932015-09-01 09:24:23 -07001248}
1249
Paolo Abeni72a338b2018-05-04 11:32:59 +02001250static inline bool
1251skb_flow_dissect_flow_keys_basic(const struct sk_buff *skb,
1252 struct flow_keys_basic *flow, void *data,
1253 __be16 proto, int nhoff, int hlen,
1254 unsigned int flags)
Tom Herberte5276932015-09-01 09:24:23 -07001255{
1256 memset(flow, 0, sizeof(*flow));
Paolo Abeni72a338b2018-05-04 11:32:59 +02001257 return __skb_flow_dissect(skb, &flow_keys_basic_dissector, flow,
Tom Herbertcd79a232015-09-01 09:24:27 -07001258 data, proto, nhoff, hlen, flags);
Tom Herberte5276932015-09-01 09:24:23 -07001259}
1260
Simon Horman62b32372017-12-04 11:31:48 +01001261void
1262skb_flow_dissect_tunnel_info(const struct sk_buff *skb,
1263 struct flow_dissector *flow_dissector,
1264 void *target_container);
1265
Tom Herbert3958afa1b2013-12-15 22:12:06 -08001266static inline __u32 skb_get_hash(struct sk_buff *skb)
Krishna Kumarbfb564e2010-08-04 06:15:52 +00001267{
Tom Herberta3b18dd2014-07-01 21:33:17 -07001268 if (!skb->l4_hash && !skb->sw_hash)
Tom Herbert3958afa1b2013-12-15 22:12:06 -08001269 __skb_get_hash(skb);
Krishna Kumarbfb564e2010-08-04 06:15:52 +00001270
Tom Herbert61b905d2014-03-24 15:34:47 -07001271 return skb->hash;
Krishna Kumarbfb564e2010-08-04 06:15:52 +00001272}
1273
David S. Miller20a17bf2015-09-01 21:19:17 -07001274static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
Tom Herbertf70ea012015-07-31 16:52:10 -07001275{
Tom Herbertc6cc1ca2015-09-01 09:24:25 -07001276 if (!skb->l4_hash && !skb->sw_hash) {
1277 struct flow_keys keys;
Tom Herbertde4c1f82015-09-01 18:11:04 -07001278 __u32 hash = __get_hash_from_flowi6(fl6, &keys);
Tom Herbertc6cc1ca2015-09-01 09:24:25 -07001279
Tom Herbertde4c1f82015-09-01 18:11:04 -07001280 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
Tom Herbertc6cc1ca2015-09-01 09:24:25 -07001281 }
Tom Herbertf70ea012015-07-31 16:52:10 -07001282
1283 return skb->hash;
1284}
1285
Tom Herbert50fb7992015-05-01 11:30:12 -07001286__u32 skb_get_hash_perturb(const struct sk_buff *skb, u32 perturb);
1287
Tom Herbert57bdf7f42014-01-15 08:57:54 -08001288static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1289{
Tom Herbert61b905d2014-03-24 15:34:47 -07001290 return skb->hash;
Tom Herbert57bdf7f42014-01-15 08:57:54 -08001291}
1292
Tom Herbert3df7a742013-12-15 22:16:29 -08001293static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1294{
Tom Herbert61b905d2014-03-24 15:34:47 -07001295 to->hash = from->hash;
Tom Herberta3b18dd2014-07-01 21:33:17 -07001296 to->sw_hash = from->sw_hash;
Tom Herbert61b905d2014-03-24 15:34:47 -07001297 to->l4_hash = from->l4_hash;
Tom Herbert3df7a742013-12-15 22:16:29 -08001298};
1299
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07001300#ifdef NET_SKBUFF_DATA_USES_OFFSET
1301static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1302{
1303 return skb->head + skb->end;
1304}
Alexander Duyckec47ea82012-05-04 14:26:56 +00001305
1306static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1307{
1308 return skb->end;
1309}
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07001310#else
1311static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1312{
1313 return skb->end;
1314}
Alexander Duyckec47ea82012-05-04 14:26:56 +00001315
1316static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1317{
1318 return skb->end - skb->head;
1319}
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07001320#endif
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322/* Internal */
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07001323#define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Patrick Ohlyac45f602009-02-12 05:03:37 +00001325static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1326{
1327 return &skb_shinfo(skb)->hwtstamps;
1328}
1329
Willem de Bruijn52267792017-08-03 16:29:39 -04001330static inline struct ubuf_info *skb_zcopy(struct sk_buff *skb)
1331{
1332 bool is_zcopy = skb && skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY;
1333
1334 return is_zcopy ? skb_uarg(skb) : NULL;
1335}
1336
Willem de Bruijn52900d22018-11-30 15:32:40 -05001337static inline void skb_zcopy_set(struct sk_buff *skb, struct ubuf_info *uarg,
1338 bool *have_ref)
Willem de Bruijn52267792017-08-03 16:29:39 -04001339{
1340 if (skb && uarg && !skb_zcopy(skb)) {
Willem de Bruijn52900d22018-11-30 15:32:40 -05001341 if (unlikely(have_ref && *have_ref))
1342 *have_ref = false;
1343 else
1344 sock_zerocopy_get(uarg);
Willem de Bruijn52267792017-08-03 16:29:39 -04001345 skb_shinfo(skb)->destructor_arg = uarg;
1346 skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1347 }
1348}
1349
Willem de Bruijn5cd8d462018-11-20 13:00:18 -05001350static inline void skb_zcopy_set_nouarg(struct sk_buff *skb, void *val)
1351{
1352 skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t) val | 0x1UL);
1353 skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1354}
1355
1356static inline bool skb_zcopy_is_nouarg(struct sk_buff *skb)
1357{
1358 return (uintptr_t) skb_shinfo(skb)->destructor_arg & 0x1UL;
1359}
1360
1361static inline void *skb_zcopy_get_nouarg(struct sk_buff *skb)
1362{
1363 return (void *)((uintptr_t) skb_shinfo(skb)->destructor_arg & ~0x1UL);
1364}
1365
Willem de Bruijn52267792017-08-03 16:29:39 -04001366/* Release a reference on a zerocopy structure */
1367static inline void skb_zcopy_clear(struct sk_buff *skb, bool zerocopy)
1368{
1369 struct ubuf_info *uarg = skb_zcopy(skb);
1370
1371 if (uarg) {
Willem de Bruijn0a4a0602017-08-09 19:09:44 -04001372 if (uarg->callback == sock_zerocopy_callback) {
1373 uarg->zerocopy = uarg->zerocopy && zerocopy;
1374 sock_zerocopy_put(uarg);
Willem de Bruijn5cd8d462018-11-20 13:00:18 -05001375 } else if (!skb_zcopy_is_nouarg(skb)) {
Willem de Bruijn0a4a0602017-08-09 19:09:44 -04001376 uarg->callback(uarg, zerocopy);
1377 }
1378
Willem de Bruijn52267792017-08-03 16:29:39 -04001379 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1380 }
1381}
1382
1383/* Abort a zerocopy operation and revert zckey on error in send syscall */
1384static inline void skb_zcopy_abort(struct sk_buff *skb)
1385{
1386 struct ubuf_info *uarg = skb_zcopy(skb);
1387
1388 if (uarg) {
Willem de Bruijn52900d22018-11-30 15:32:40 -05001389 sock_zerocopy_put_abort(uarg, false);
Willem de Bruijn52267792017-08-03 16:29:39 -04001390 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1391 }
1392}
1393
David S. Millera8305bf2018-07-29 20:42:53 -07001394static inline void skb_mark_not_on_list(struct sk_buff *skb)
1395{
1396 skb->next = NULL;
1397}
1398
David S. Miller992cba72018-07-31 15:27:56 -07001399static inline void skb_list_del_init(struct sk_buff *skb)
1400{
1401 __list_del_entry(&skb->list);
1402 skb_mark_not_on_list(skb);
1403}
1404
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405/**
1406 * skb_queue_empty - check if a queue is empty
1407 * @list: queue head
1408 *
1409 * Returns true if the queue is empty, false otherwise.
1410 */
1411static inline int skb_queue_empty(const struct sk_buff_head *list)
1412{
Daniel Borkmannfd44b932014-01-07 23:23:44 +01001413 return list->next == (const struct sk_buff *) list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
1415
1416/**
David S. Millerfc7ebb22008-09-23 00:34:07 -07001417 * skb_queue_is_last - check if skb is the last entry in the queue
1418 * @list: queue head
1419 * @skb: buffer
1420 *
1421 * Returns true if @skb is the last buffer on the list.
1422 */
1423static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1424 const struct sk_buff *skb)
1425{
Daniel Borkmannfd44b932014-01-07 23:23:44 +01001426 return skb->next == (const struct sk_buff *) list;
David S. Millerfc7ebb22008-09-23 00:34:07 -07001427}
1428
1429/**
Ilpo Järvinen832d11c2008-11-24 21:20:15 -08001430 * skb_queue_is_first - check if skb is the first entry in the queue
1431 * @list: queue head
1432 * @skb: buffer
1433 *
1434 * Returns true if @skb is the first buffer on the list.
1435 */
1436static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1437 const struct sk_buff *skb)
1438{
Daniel Borkmannfd44b932014-01-07 23:23:44 +01001439 return skb->prev == (const struct sk_buff *) list;
Ilpo Järvinen832d11c2008-11-24 21:20:15 -08001440}
1441
1442/**
David S. Miller249c8b42008-09-23 00:44:42 -07001443 * skb_queue_next - return the next packet in the queue
1444 * @list: queue head
1445 * @skb: current buffer
1446 *
1447 * Return the next packet in @list after @skb. It is only valid to
1448 * call this if skb_queue_is_last() evaluates to false.
1449 */
1450static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1451 const struct sk_buff *skb)
1452{
1453 /* This BUG_ON may seem severe, but if we just return then we
1454 * are going to dereference garbage.
1455 */
1456 BUG_ON(skb_queue_is_last(list, skb));
1457 return skb->next;
1458}
1459
1460/**
Ilpo Järvinen832d11c2008-11-24 21:20:15 -08001461 * skb_queue_prev - return the prev packet in the queue
1462 * @list: queue head
1463 * @skb: current buffer
1464 *
1465 * Return the prev packet in @list before @skb. It is only valid to
1466 * call this if skb_queue_is_first() evaluates to false.
1467 */
1468static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1469 const struct sk_buff *skb)
1470{
1471 /* This BUG_ON may seem severe, but if we just return then we
1472 * are going to dereference garbage.
1473 */
1474 BUG_ON(skb_queue_is_first(list, skb));
1475 return skb->prev;
1476}
1477
1478/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 * skb_get - reference buffer
1480 * @skb: buffer to reference
1481 *
1482 * Makes another reference to a socket buffer and returns a pointer
1483 * to the buffer.
1484 */
1485static inline struct sk_buff *skb_get(struct sk_buff *skb)
1486{
Reshetova, Elena63354792017-06-30 13:07:58 +03001487 refcount_inc(&skb->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 return skb;
1489}
1490
1491/*
Geert Uytterhoevenf8821f92017-11-30 14:33:56 +01001492 * If users == 1, we are the only owner and can avoid redundant atomic changes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 */
1494
1495/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 * skb_cloned - is the buffer a clone
1497 * @skb: buffer to check
1498 *
1499 * Returns true if the buffer was generated with skb_clone() and is
1500 * one of multiple shared copies of the buffer. Cloned buffers are
1501 * shared data so must not be written to under normal circumstances.
1502 */
1503static inline int skb_cloned(const struct sk_buff *skb)
1504{
1505 return skb->cloned &&
1506 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
1507}
1508
Pravin B Shelar14bbd6a2013-02-14 09:44:49 +00001509static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
1510{
Mel Gormand0164ad2015-11-06 16:28:21 -08001511 might_sleep_if(gfpflags_allow_blocking(pri));
Pravin B Shelar14bbd6a2013-02-14 09:44:49 +00001512
1513 if (skb_cloned(skb))
1514 return pskb_expand_head(skb, 0, 0, pri);
1515
1516 return 0;
1517}
1518
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519/**
1520 * skb_header_cloned - is the header a clone
1521 * @skb: buffer to check
1522 *
1523 * Returns true if modifying the header part of the buffer requires
1524 * the data to be copied.
1525 */
1526static inline int skb_header_cloned(const struct sk_buff *skb)
1527{
1528 int dataref;
1529
1530 if (!skb->cloned)
1531 return 0;
1532
1533 dataref = atomic_read(&skb_shinfo(skb)->dataref);
1534 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
1535 return dataref != 1;
1536}
1537
Eric Dumazet9580bf22016-04-30 10:19:29 -07001538static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri)
1539{
1540 might_sleep_if(gfpflags_allow_blocking(pri));
1541
1542 if (skb_header_cloned(skb))
1543 return pskb_expand_head(skb, 0, 0, pri);
1544
1545 return 0;
1546}
1547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548/**
Eric Dumazetf4a775d2014-09-22 16:29:32 -07001549 * __skb_header_release - release reference to header
1550 * @skb: buffer to operate on
Eric Dumazetf4a775d2014-09-22 16:29:32 -07001551 */
1552static inline void __skb_header_release(struct sk_buff *skb)
1553{
1554 skb->nohdr = 1;
1555 atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
1556}
1557
1558
1559/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 * skb_shared - is the buffer shared
1561 * @skb: buffer to check
1562 *
1563 * Returns true if more than one person has a reference to this
1564 * buffer.
1565 */
1566static inline int skb_shared(const struct sk_buff *skb)
1567{
Reshetova, Elena63354792017-06-30 13:07:58 +03001568 return refcount_read(&skb->users) != 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569}
1570
1571/**
1572 * skb_share_check - check if buffer is shared and if so clone it
1573 * @skb: buffer to check
1574 * @pri: priority for memory allocation
1575 *
1576 * If the buffer is shared the buffer is cloned and the old copy
1577 * drops a reference. A new clone with a single reference is returned.
1578 * If the buffer is not shared the original buffer is returned. When
1579 * being called from interrupt status or with spinlocks held pri must
1580 * be GFP_ATOMIC.
1581 *
1582 * NULL is returned on a memory allocation failure.
1583 */
Eric Dumazet47061bc2012-08-03 20:54:15 +00001584static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585{
Mel Gormand0164ad2015-11-06 16:28:21 -08001586 might_sleep_if(gfpflags_allow_blocking(pri));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 if (skb_shared(skb)) {
1588 struct sk_buff *nskb = skb_clone(skb, pri);
Eric Dumazet47061bc2012-08-03 20:54:15 +00001589
1590 if (likely(nskb))
1591 consume_skb(skb);
1592 else
1593 kfree_skb(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 skb = nskb;
1595 }
1596 return skb;
1597}
1598
1599/*
1600 * Copy shared buffers into a new sk_buff. We effectively do COW on
1601 * packets to handle cases where we have a local reader and forward
1602 * and a couple of other messy ones. The normal one is tcpdumping
1603 * a packet thats being forwarded.
1604 */
1605
1606/**
1607 * skb_unshare - make a copy of a shared buffer
1608 * @skb: buffer to check
1609 * @pri: priority for memory allocation
1610 *
1611 * If the socket buffer is a clone then this function creates a new
1612 * copy of the data, drops a reference count on the old copy and returns
1613 * the new copy with the reference count at 1. If the buffer is not a clone
1614 * the original buffer is returned. When called with a spinlock held or
1615 * from interrupt state @pri must be %GFP_ATOMIC
1616 *
1617 * %NULL is returned on a memory allocation failure.
1618 */
Victor Fuscoe2bf5212005-07-18 13:36:38 -07001619static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +01001620 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621{
Mel Gormand0164ad2015-11-06 16:28:21 -08001622 might_sleep_if(gfpflags_allow_blocking(pri));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 if (skb_cloned(skb)) {
1624 struct sk_buff *nskb = skb_copy(skb, pri);
Alexander Aring31eff812014-10-10 23:10:47 +02001625
1626 /* Free our shared copy */
1627 if (likely(nskb))
1628 consume_skb(skb);
1629 else
1630 kfree_skb(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 skb = nskb;
1632 }
1633 return skb;
1634}
1635
1636/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001637 * skb_peek - peek at the head of an &sk_buff_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 * @list_: list to peek at
1639 *
1640 * Peek an &sk_buff. Unlike most other operations you _MUST_
1641 * be careful with this one. A peek leaves the buffer on the
1642 * list and someone else may run off with it. You must hold
1643 * the appropriate locks or have a private queue to do this.
1644 *
1645 * Returns %NULL for an empty list or a pointer to the head element.
1646 * The reference count is not incremented and the reference is therefore
1647 * volatile. Use with caution.
1648 */
Eric Dumazet05bdd2f2011-10-20 17:45:43 -04001649static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Eric Dumazet18d07002012-04-30 16:31:46 +00001651 struct sk_buff *skb = list_->next;
1652
1653 if (skb == (struct sk_buff *)list_)
1654 skb = NULL;
1655 return skb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656}
1657
1658/**
David S. Miller8b69bd72018-08-11 18:43:38 -07001659 * __skb_peek - peek at the head of a non-empty &sk_buff_head
1660 * @list_: list to peek at
1661 *
1662 * Like skb_peek(), but the caller knows that the list is not empty.
1663 */
1664static inline struct sk_buff *__skb_peek(const struct sk_buff_head *list_)
1665{
1666 return list_->next;
1667}
1668
1669/**
Pavel Emelyanovda5ef6e2012-02-21 07:31:18 +00001670 * skb_peek_next - peek skb following the given one from a queue
1671 * @skb: skb to start from
1672 * @list_: list to peek at
1673 *
1674 * Returns %NULL when the end of the list is met or a pointer to the
1675 * next element. The reference count is not incremented and the
1676 * reference is therefore volatile. Use with caution.
1677 */
1678static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
1679 const struct sk_buff_head *list_)
1680{
1681 struct sk_buff *next = skb->next;
Eric Dumazet18d07002012-04-30 16:31:46 +00001682
Pavel Emelyanovda5ef6e2012-02-21 07:31:18 +00001683 if (next == (struct sk_buff *)list_)
1684 next = NULL;
1685 return next;
1686}
1687
1688/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001689 * skb_peek_tail - peek at the tail of an &sk_buff_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 * @list_: list to peek at
1691 *
1692 * Peek an &sk_buff. Unlike most other operations you _MUST_
1693 * be careful with this one. A peek leaves the buffer on the
1694 * list and someone else may run off with it. You must hold
1695 * the appropriate locks or have a private queue to do this.
1696 *
1697 * Returns %NULL for an empty list or a pointer to the tail element.
1698 * The reference count is not incremented and the reference is therefore
1699 * volatile. Use with caution.
1700 */
Eric Dumazet05bdd2f2011-10-20 17:45:43 -04001701static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702{
Eric Dumazet18d07002012-04-30 16:31:46 +00001703 struct sk_buff *skb = list_->prev;
1704
1705 if (skb == (struct sk_buff *)list_)
1706 skb = NULL;
1707 return skb;
1708
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709}
1710
1711/**
1712 * skb_queue_len - get queue length
1713 * @list_: list to measure
1714 *
1715 * Return the length of an &sk_buff queue.
1716 */
1717static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
1718{
1719 return list_->qlen;
1720}
1721
David S. Miller67fed452008-09-21 22:36:24 -07001722/**
1723 * __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
1724 * @list: queue to initialize
1725 *
1726 * This initializes only the list and queue length aspects of
1727 * an sk_buff_head object. This allows to initialize the list
1728 * aspects of an sk_buff_head without reinitializing things like
1729 * the spinlock. It can also be used for on-stack sk_buff_head
1730 * objects where the spinlock is known to not be used.
1731 */
1732static inline void __skb_queue_head_init(struct sk_buff_head *list)
1733{
1734 list->prev = list->next = (struct sk_buff *)list;
1735 list->qlen = 0;
1736}
1737
Arjan van de Ven76f10ad2006-08-02 14:06:55 -07001738/*
1739 * This function creates a split out lock class for each invocation;
1740 * this is needed for now since a whole lot of users of the skb-queue
1741 * infrastructure in drivers have different locking usage (in hardirq)
1742 * than the networking core (in softirq only). In the long run either the
1743 * network layer or drivers should need annotation to consolidate the
1744 * main types of usage into 3 classes.
1745 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746static inline void skb_queue_head_init(struct sk_buff_head *list)
1747{
1748 spin_lock_init(&list->lock);
David S. Miller67fed452008-09-21 22:36:24 -07001749 __skb_queue_head_init(list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750}
1751
Pavel Emelianovc2ecba72007-04-17 12:45:31 -07001752static inline void skb_queue_head_init_class(struct sk_buff_head *list,
1753 struct lock_class_key *class)
1754{
1755 skb_queue_head_init(list);
1756 lockdep_set_class(&list->lock, class);
1757}
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759/*
Gerrit Renkerbf299272008-04-14 00:04:51 -07001760 * Insert an sk_buff on a list.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 *
1762 * The "__skb_xxxx()" functions are the non-atomic ones that
1763 * can only be called with interrupts disabled.
1764 */
Gerrit Renkerbf299272008-04-14 00:04:51 -07001765static inline void __skb_insert(struct sk_buff *newsk,
1766 struct sk_buff *prev, struct sk_buff *next,
1767 struct sk_buff_head *list)
1768{
1769 newsk->next = next;
1770 newsk->prev = prev;
1771 next->prev = prev->next = newsk;
1772 list->qlen++;
1773}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
David S. Miller67fed452008-09-21 22:36:24 -07001775static inline void __skb_queue_splice(const struct sk_buff_head *list,
1776 struct sk_buff *prev,
1777 struct sk_buff *next)
1778{
1779 struct sk_buff *first = list->next;
1780 struct sk_buff *last = list->prev;
1781
1782 first->prev = prev;
1783 prev->next = first;
1784
1785 last->next = next;
1786 next->prev = last;
1787}
1788
1789/**
1790 * skb_queue_splice - join two skb lists, this is designed for stacks
1791 * @list: the new list to add
1792 * @head: the place to add it in the first list
1793 */
1794static inline void skb_queue_splice(const struct sk_buff_head *list,
1795 struct sk_buff_head *head)
1796{
1797 if (!skb_queue_empty(list)) {
1798 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
David S. Miller1d4a31d2008-09-22 21:57:21 -07001799 head->qlen += list->qlen;
David S. Miller67fed452008-09-21 22:36:24 -07001800 }
1801}
1802
1803/**
Eric Dumazetd961949662012-04-30 21:29:16 +00001804 * skb_queue_splice_init - join two skb lists and reinitialise the emptied list
David S. Miller67fed452008-09-21 22:36:24 -07001805 * @list: the new list to add
1806 * @head: the place to add it in the first list
1807 *
1808 * The list at @list is reinitialised
1809 */
1810static inline void skb_queue_splice_init(struct sk_buff_head *list,
1811 struct sk_buff_head *head)
1812{
1813 if (!skb_queue_empty(list)) {
1814 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
David S. Miller1d4a31d2008-09-22 21:57:21 -07001815 head->qlen += list->qlen;
David S. Miller67fed452008-09-21 22:36:24 -07001816 __skb_queue_head_init(list);
1817 }
1818}
1819
1820/**
1821 * skb_queue_splice_tail - join two skb lists, each list being a queue
1822 * @list: the new list to add
1823 * @head: the place to add it in the first list
1824 */
1825static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1826 struct sk_buff_head *head)
1827{
1828 if (!skb_queue_empty(list)) {
1829 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
David S. Miller1d4a31d2008-09-22 21:57:21 -07001830 head->qlen += list->qlen;
David S. Miller67fed452008-09-21 22:36:24 -07001831 }
1832}
1833
1834/**
Eric Dumazetd961949662012-04-30 21:29:16 +00001835 * skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
David S. Miller67fed452008-09-21 22:36:24 -07001836 * @list: the new list to add
1837 * @head: the place to add it in the first list
1838 *
1839 * Each of the lists is a queue.
1840 * The list at @list is reinitialised
1841 */
1842static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1843 struct sk_buff_head *head)
1844{
1845 if (!skb_queue_empty(list)) {
1846 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
David S. Miller1d4a31d2008-09-22 21:57:21 -07001847 head->qlen += list->qlen;
David S. Miller67fed452008-09-21 22:36:24 -07001848 __skb_queue_head_init(list);
1849 }
1850}
1851
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852/**
Stephen Hemminger300ce172005-10-30 13:47:34 -08001853 * __skb_queue_after - queue a buffer at the list head
1854 * @list: list to use
1855 * @prev: place after this buffer
1856 * @newsk: buffer to queue
1857 *
1858 * Queue a buffer int the middle of a list. This function takes no locks
1859 * and you must therefore hold required locks before calling it.
1860 *
1861 * A buffer cannot be placed on two lists at the same time.
1862 */
1863static inline void __skb_queue_after(struct sk_buff_head *list,
1864 struct sk_buff *prev,
1865 struct sk_buff *newsk)
1866{
Gerrit Renkerbf299272008-04-14 00:04:51 -07001867 __skb_insert(newsk, prev, prev->next, list);
Stephen Hemminger300ce172005-10-30 13:47:34 -08001868}
1869
Joe Perches7965bd42013-09-26 14:48:15 -07001870void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1871 struct sk_buff_head *list);
Gerrit Renker7de6c032008-04-14 00:05:09 -07001872
Gerrit Renkerf5572852008-04-14 00:05:28 -07001873static inline void __skb_queue_before(struct sk_buff_head *list,
1874 struct sk_buff *next,
1875 struct sk_buff *newsk)
1876{
1877 __skb_insert(newsk, next->prev, next, list);
1878}
1879
Stephen Hemminger300ce172005-10-30 13:47:34 -08001880/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 * __skb_queue_head - queue a buffer at the list head
1882 * @list: list to use
1883 * @newsk: buffer to queue
1884 *
1885 * Queue a buffer at the start of a list. This function takes no locks
1886 * and you must therefore hold required locks before calling it.
1887 *
1888 * A buffer cannot be placed on two lists at the same time.
1889 */
Joe Perches7965bd42013-09-26 14:48:15 -07001890void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891static inline void __skb_queue_head(struct sk_buff_head *list,
1892 struct sk_buff *newsk)
1893{
Stephen Hemminger300ce172005-10-30 13:47:34 -08001894 __skb_queue_after(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895}
1896
1897/**
1898 * __skb_queue_tail - queue a buffer at the list tail
1899 * @list: list to use
1900 * @newsk: buffer to queue
1901 *
1902 * Queue a buffer at the end of a list. This function takes no locks
1903 * and you must therefore hold required locks before calling it.
1904 *
1905 * A buffer cannot be placed on two lists at the same time.
1906 */
Joe Perches7965bd42013-09-26 14:48:15 -07001907void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908static inline void __skb_queue_tail(struct sk_buff_head *list,
1909 struct sk_buff *newsk)
1910{
Gerrit Renkerf5572852008-04-14 00:05:28 -07001911 __skb_queue_before(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912}
1913
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 * remove sk_buff from list. _Must_ be called atomically, and with
1916 * the list known..
1917 */
Joe Perches7965bd42013-09-26 14:48:15 -07001918void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1920{
1921 struct sk_buff *next, *prev;
1922
1923 list->qlen--;
1924 next = skb->next;
1925 prev = skb->prev;
1926 skb->next = skb->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 next->prev = prev;
1928 prev->next = next;
1929}
1930
Gerrit Renkerf525c062008-04-14 00:04:12 -07001931/**
1932 * __skb_dequeue - remove from the head of the queue
1933 * @list: list to dequeue from
1934 *
1935 * Remove the head of the list. This function does not take any locks
1936 * so must be used with appropriate locks held only. The head item is
1937 * returned or %NULL if the list is empty.
1938 */
Joe Perches7965bd42013-09-26 14:48:15 -07001939struct sk_buff *skb_dequeue(struct sk_buff_head *list);
Gerrit Renkerf525c062008-04-14 00:04:12 -07001940static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1941{
1942 struct sk_buff *skb = skb_peek(list);
1943 if (skb)
1944 __skb_unlink(skb, list);
1945 return skb;
1946}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
1948/**
1949 * __skb_dequeue_tail - remove from the tail of the queue
1950 * @list: list to dequeue from
1951 *
1952 * Remove the tail of the list. This function does not take any locks
1953 * so must be used with appropriate locks held only. The tail item is
1954 * returned or %NULL if the list is empty.
1955 */
Joe Perches7965bd42013-09-26 14:48:15 -07001956struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1958{
1959 struct sk_buff *skb = skb_peek_tail(list);
1960 if (skb)
1961 __skb_unlink(skb, list);
1962 return skb;
1963}
1964
1965
David S. Millerbdcc0922012-03-07 20:53:36 -05001966static inline bool skb_is_nonlinear(const struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967{
1968 return skb->data_len;
1969}
1970
1971static inline unsigned int skb_headlen(const struct sk_buff *skb)
1972{
1973 return skb->len - skb->data_len;
1974}
1975
Willem de Bruijn3ece7822017-08-03 16:29:38 -04001976static inline unsigned int __skb_pagelen(const struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977{
Alexey Dobriyanc72d8cd2016-11-19 04:08:08 +03001978 unsigned int i, len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Alexey Dobriyanc72d8cd2016-11-19 04:08:08 +03001980 for (i = skb_shinfo(skb)->nr_frags - 1; (int)i >= 0; i--)
Eric Dumazet9e903e02011-10-18 21:00:24 +00001981 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
Willem de Bruijn3ece7822017-08-03 16:29:38 -04001982 return len;
1983}
1984
1985static inline unsigned int skb_pagelen(const struct sk_buff *skb)
1986{
1987 return skb_headlen(skb) + __skb_pagelen(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988}
1989
Ian Campbell131ea662011-08-19 06:25:00 +00001990/**
1991 * __skb_fill_page_desc - initialise a paged fragment in an skb
1992 * @skb: buffer containing fragment to be initialised
1993 * @i: paged fragment index to initialise
1994 * @page: the page to use for this fragment
1995 * @off: the offset to the data with @page
1996 * @size: the length of the data
1997 *
1998 * Initialises the @i'th fragment of @skb to point to &size bytes at
1999 * offset @off within @page.
2000 *
2001 * Does not take any additional reference on the fragment.
2002 */
2003static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
2004 struct page *page, int off, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005{
2006 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
2007
Mel Gormanc48a11c2012-07-31 16:44:23 -07002008 /*
Michal Hocko2f064f32015-08-21 14:11:51 -07002009 * Propagate page pfmemalloc to the skb if we can. The problem is
2010 * that not all callers have unique ownership of the page but rely
2011 * on page_is_pfmemalloc doing the right thing(tm).
Mel Gormanc48a11c2012-07-31 16:44:23 -07002012 */
Ian Campbella8605c62011-10-19 23:01:49 +00002013 frag->page.p = page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 frag->page_offset = off;
Eric Dumazet9e903e02011-10-18 21:00:24 +00002015 skb_frag_size_set(frag, size);
Pavel Emelyanovcca7af32013-03-14 03:29:40 +00002016
2017 page = compound_head(page);
Michal Hocko2f064f32015-08-21 14:11:51 -07002018 if (page_is_pfmemalloc(page))
Pavel Emelyanovcca7af32013-03-14 03:29:40 +00002019 skb->pfmemalloc = true;
Ian Campbell131ea662011-08-19 06:25:00 +00002020}
2021
2022/**
2023 * skb_fill_page_desc - initialise a paged fragment in an skb
2024 * @skb: buffer containing fragment to be initialised
2025 * @i: paged fragment index to initialise
2026 * @page: the page to use for this fragment
2027 * @off: the offset to the data with @page
2028 * @size: the length of the data
2029 *
2030 * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
Mathias Krausebc323832013-11-07 14:18:26 +01002031 * @skb to point to @size bytes at offset @off within @page. In
Ian Campbell131ea662011-08-19 06:25:00 +00002032 * addition updates @skb such that @i is the last fragment.
2033 *
2034 * Does not take any additional reference on the fragment.
2035 */
2036static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
2037 struct page *page, int off, int size)
2038{
2039 __skb_fill_page_desc(skb, i, page, off, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 skb_shinfo(skb)->nr_frags = i + 1;
2041}
2042
Joe Perches7965bd42013-09-26 14:48:15 -07002043void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page, int off,
2044 int size, unsigned int truesize);
Peter Zijlstra654bed12008-10-07 14:22:33 -07002045
Jason Wangf8e617e2013-11-01 14:07:47 +08002046void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
2047 unsigned int truesize);
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049#define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
David S. Miller21dc3302010-08-23 00:13:46 -07002050#define SKB_FRAG_ASSERT(skb) BUG_ON(skb_has_frag_list(skb))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051#define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
2052
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07002053#ifdef NET_SKBUFF_DATA_USES_OFFSET
2054static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2055{
2056 return skb->head + skb->tail;
2057}
2058
2059static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2060{
2061 skb->tail = skb->data - skb->head;
2062}
2063
2064static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2065{
2066 skb_reset_tail_pointer(skb);
2067 skb->tail += offset;
2068}
Simon Horman7cc46192013-05-28 20:34:29 +00002069
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07002070#else /* NET_SKBUFF_DATA_USES_OFFSET */
2071static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2072{
2073 return skb->tail;
2074}
2075
2076static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2077{
2078 skb->tail = skb->data;
2079}
2080
2081static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2082{
2083 skb->tail = skb->data + offset;
2084}
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07002085
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07002086#endif /* NET_SKBUFF_DATA_USES_OFFSET */
2087
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088/*
2089 * Add data to an sk_buff
2090 */
Johannes Berg4df864c2017-06-16 14:29:21 +02002091void *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
2092void *skb_put(struct sk_buff *skb, unsigned int len);
2093static inline void *__skb_put(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Johannes Berg4df864c2017-06-16 14:29:21 +02002095 void *tmp = skb_tail_pointer(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 SKB_LINEAR_ASSERT(skb);
2097 skb->tail += len;
2098 skb->len += len;
2099 return tmp;
2100}
2101
yuan linyude77b962017-06-18 22:48:17 +08002102static inline void *__skb_put_zero(struct sk_buff *skb, unsigned int len)
2103{
2104 void *tmp = __skb_put(skb, len);
2105
2106 memset(tmp, 0, len);
2107 return tmp;
2108}
2109
2110static inline void *__skb_put_data(struct sk_buff *skb, const void *data,
2111 unsigned int len)
2112{
2113 void *tmp = __skb_put(skb, len);
2114
2115 memcpy(tmp, data, len);
2116 return tmp;
2117}
2118
2119static inline void __skb_put_u8(struct sk_buff *skb, u8 val)
2120{
2121 *(u8 *)__skb_put(skb, 1) = val;
2122}
2123
Johannes Berg83ad3572017-06-14 22:17:20 +02002124static inline void *skb_put_zero(struct sk_buff *skb, unsigned int len)
Johannes Berge45a79d2017-05-24 09:07:47 +02002125{
Johannes Berg83ad3572017-06-14 22:17:20 +02002126 void *tmp = skb_put(skb, len);
Johannes Berge45a79d2017-05-24 09:07:47 +02002127
2128 memset(tmp, 0, len);
2129
2130 return tmp;
2131}
2132
Johannes Berg59ae1d12017-06-16 14:29:20 +02002133static inline void *skb_put_data(struct sk_buff *skb, const void *data,
2134 unsigned int len)
2135{
2136 void *tmp = skb_put(skb, len);
2137
2138 memcpy(tmp, data, len);
2139
2140 return tmp;
2141}
2142
Johannes Berg634fef62017-06-16 14:29:24 +02002143static inline void skb_put_u8(struct sk_buff *skb, u8 val)
2144{
2145 *(u8 *)skb_put(skb, 1) = val;
2146}
2147
Johannes Bergd58ff352017-06-16 14:29:23 +02002148void *skb_push(struct sk_buff *skb, unsigned int len);
2149static inline void *__skb_push(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150{
2151 skb->data -= len;
2152 skb->len += len;
2153 return skb->data;
2154}
2155
Johannes Bergaf728682017-06-16 14:29:22 +02002156void *skb_pull(struct sk_buff *skb, unsigned int len);
2157static inline void *__skb_pull(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158{
2159 skb->len -= len;
2160 BUG_ON(skb->len < skb->data_len);
2161 return skb->data += len;
2162}
2163
Johannes Bergaf728682017-06-16 14:29:22 +02002164static inline void *skb_pull_inline(struct sk_buff *skb, unsigned int len)
David S. Miller47d29642010-05-02 02:21:44 -07002165{
2166 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
2167}
2168
Johannes Bergaf728682017-06-16 14:29:22 +02002169void *__pskb_pull_tail(struct sk_buff *skb, int delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
Johannes Bergaf728682017-06-16 14:29:22 +02002171static inline void *__pskb_pull(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172{
2173 if (len > skb_headlen(skb) &&
Gerrit Renker987c4022008-08-11 18:17:17 -07002174 !__pskb_pull_tail(skb, len - skb_headlen(skb)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 return NULL;
2176 skb->len -= len;
2177 return skb->data += len;
2178}
2179
Johannes Bergaf728682017-06-16 14:29:22 +02002180static inline void *pskb_pull(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181{
2182 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
2183}
2184
2185static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
2186{
2187 if (likely(len <= skb_headlen(skb)))
2188 return 1;
2189 if (unlikely(len > skb->len))
2190 return 0;
Gerrit Renker987c4022008-08-11 18:17:17 -07002191 return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192}
2193
Eric Dumazetc8c8b122016-12-07 09:19:33 -08002194void skb_condense(struct sk_buff *skb);
2195
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196/**
2197 * skb_headroom - bytes at buffer head
2198 * @skb: buffer to check
2199 *
2200 * Return the number of bytes of free space at the head of an &sk_buff.
2201 */
Chuck Leverc2636b42007-10-23 21:07:32 -07002202static inline unsigned int skb_headroom(const struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203{
2204 return skb->data - skb->head;
2205}
2206
2207/**
2208 * skb_tailroom - bytes at buffer end
2209 * @skb: buffer to check
2210 *
2211 * Return the number of bytes of free space at the tail of an sk_buff
2212 */
2213static inline int skb_tailroom(const struct sk_buff *skb)
2214{
Arnaldo Carvalho de Melo4305b542007-04-19 20:43:29 -07002215 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216}
2217
2218/**
Eric Dumazeta21d4572012-04-10 20:30:48 +00002219 * skb_availroom - bytes at buffer end
2220 * @skb: buffer to check
2221 *
2222 * Return the number of bytes of free space at the tail of an sk_buff
2223 * allocated by sk_stream_alloc()
2224 */
2225static inline int skb_availroom(const struct sk_buff *skb)
2226{
Eric Dumazet16fad692013-03-14 05:40:32 +00002227 if (skb_is_nonlinear(skb))
2228 return 0;
2229
2230 return skb->end - skb->tail - skb->reserved_tailroom;
Eric Dumazeta21d4572012-04-10 20:30:48 +00002231}
2232
2233/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 * skb_reserve - adjust headroom
2235 * @skb: buffer to alter
2236 * @len: bytes to move
2237 *
2238 * Increase the headroom of an empty &sk_buff by reducing the tail
2239 * room. This is only allowed for an empty buffer.
2240 */
David S. Miller8243126c2006-01-17 02:54:21 -08002241static inline void skb_reserve(struct sk_buff *skb, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242{
2243 skb->data += len;
2244 skb->tail += len;
2245}
2246
Benjamin Poirier1837b2e2016-02-29 15:03:33 -08002247/**
2248 * skb_tailroom_reserve - adjust reserved_tailroom
2249 * @skb: buffer to alter
2250 * @mtu: maximum amount of headlen permitted
2251 * @needed_tailroom: minimum amount of reserved_tailroom
2252 *
2253 * Set reserved_tailroom so that headlen can be as large as possible but
2254 * not larger than mtu and tailroom cannot be smaller than
2255 * needed_tailroom.
2256 * The required headroom should already have been reserved before using
2257 * this function.
2258 */
2259static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
2260 unsigned int needed_tailroom)
2261{
2262 SKB_LINEAR_ASSERT(skb);
2263 if (mtu < skb_tailroom(skb) - needed_tailroom)
2264 /* use at most mtu */
2265 skb->reserved_tailroom = skb_tailroom(skb) - mtu;
2266 else
2267 /* use up to all available space */
2268 skb->reserved_tailroom = needed_tailroom;
2269}
2270
Tom Herbert8bce6d72014-09-29 20:22:29 -07002271#define ENCAP_TYPE_ETHER 0
2272#define ENCAP_TYPE_IPPROTO 1
2273
2274static inline void skb_set_inner_protocol(struct sk_buff *skb,
2275 __be16 protocol)
2276{
2277 skb->inner_protocol = protocol;
2278 skb->inner_protocol_type = ENCAP_TYPE_ETHER;
2279}
2280
2281static inline void skb_set_inner_ipproto(struct sk_buff *skb,
2282 __u8 ipproto)
2283{
2284 skb->inner_ipproto = ipproto;
2285 skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
2286}
2287
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002288static inline void skb_reset_inner_headers(struct sk_buff *skb)
2289{
Pravin B Shelaraefbd2b2013-03-07 13:21:46 +00002290 skb->inner_mac_header = skb->mac_header;
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002291 skb->inner_network_header = skb->network_header;
2292 skb->inner_transport_header = skb->transport_header;
2293}
2294
Jiri Pirko0b5c9db2011-06-10 06:56:58 +00002295static inline void skb_reset_mac_len(struct sk_buff *skb)
2296{
2297 skb->mac_len = skb->network_header - skb->mac_header;
2298}
2299
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002300static inline unsigned char *skb_inner_transport_header(const struct sk_buff
2301 *skb)
2302{
2303 return skb->head + skb->inner_transport_header;
2304}
2305
Tom Herbert55dc5a92015-12-14 11:19:40 -08002306static inline int skb_inner_transport_offset(const struct sk_buff *skb)
2307{
2308 return skb_inner_transport_header(skb) - skb->data;
2309}
2310
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002311static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
2312{
2313 skb->inner_transport_header = skb->data - skb->head;
2314}
2315
2316static inline void skb_set_inner_transport_header(struct sk_buff *skb,
2317 const int offset)
2318{
2319 skb_reset_inner_transport_header(skb);
2320 skb->inner_transport_header += offset;
2321}
2322
2323static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
2324{
2325 return skb->head + skb->inner_network_header;
2326}
2327
2328static inline void skb_reset_inner_network_header(struct sk_buff *skb)
2329{
2330 skb->inner_network_header = skb->data - skb->head;
2331}
2332
2333static inline void skb_set_inner_network_header(struct sk_buff *skb,
2334 const int offset)
2335{
2336 skb_reset_inner_network_header(skb);
2337 skb->inner_network_header += offset;
2338}
2339
Pravin B Shelaraefbd2b2013-03-07 13:21:46 +00002340static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
2341{
2342 return skb->head + skb->inner_mac_header;
2343}
2344
2345static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
2346{
2347 skb->inner_mac_header = skb->data - skb->head;
2348}
2349
2350static inline void skb_set_inner_mac_header(struct sk_buff *skb,
2351 const int offset)
2352{
2353 skb_reset_inner_mac_header(skb);
2354 skb->inner_mac_header += offset;
2355}
Eric Dumazetfda55ec2013-01-07 09:28:21 +00002356static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
2357{
Cong Wang35d04612013-05-29 15:16:05 +08002358 return skb->transport_header != (typeof(skb->transport_header))~0U;
Eric Dumazetfda55ec2013-01-07 09:28:21 +00002359}
2360
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -07002361static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
2362{
2363 return skb->head + skb->transport_header;
2364}
2365
2366static inline void skb_reset_transport_header(struct sk_buff *skb)
2367{
2368 skb->transport_header = skb->data - skb->head;
2369}
2370
2371static inline void skb_set_transport_header(struct sk_buff *skb,
2372 const int offset)
2373{
2374 skb_reset_transport_header(skb);
2375 skb->transport_header += offset;
2376}
2377
2378static inline unsigned char *skb_network_header(const struct sk_buff *skb)
2379{
2380 return skb->head + skb->network_header;
2381}
2382
2383static inline void skb_reset_network_header(struct sk_buff *skb)
2384{
2385 skb->network_header = skb->data - skb->head;
2386}
2387
2388static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
2389{
2390 skb_reset_network_header(skb);
2391 skb->network_header += offset;
2392}
2393
2394static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
2395{
2396 return skb->head + skb->mac_header;
2397}
2398
Amir Vadaiea6da4f2017-02-07 09:56:06 +02002399static inline int skb_mac_offset(const struct sk_buff *skb)
2400{
2401 return skb_mac_header(skb) - skb->data;
2402}
2403
Daniel Borkmann0daf4342017-07-02 02:13:25 +02002404static inline u32 skb_mac_header_len(const struct sk_buff *skb)
2405{
2406 return skb->network_header - skb->mac_header;
2407}
2408
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -07002409static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2410{
Cong Wang35d04612013-05-29 15:16:05 +08002411 return skb->mac_header != (typeof(skb->mac_header))~0U;
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -07002412}
2413
2414static inline void skb_reset_mac_header(struct sk_buff *skb)
2415{
2416 skb->mac_header = skb->data - skb->head;
2417}
2418
2419static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
2420{
2421 skb_reset_mac_header(skb);
2422 skb->mac_header += offset;
2423}
2424
Timo Teräs0e3da5b2013-12-16 11:02:09 +02002425static inline void skb_pop_mac_header(struct sk_buff *skb)
2426{
2427 skb->mac_header = skb->network_header;
2428}
2429
Ying Xuefbbdb8f2013-03-27 16:46:06 +00002430static inline void skb_probe_transport_header(struct sk_buff *skb,
2431 const int offset_hint)
2432{
Paolo Abeni72a338b2018-05-04 11:32:59 +02002433 struct flow_keys_basic keys;
Ying Xuefbbdb8f2013-03-27 16:46:06 +00002434
2435 if (skb_transport_header_was_set(skb))
2436 return;
Paolo Abeni72a338b2018-05-04 11:32:59 +02002437
YueHaibing15693fd2018-08-08 19:40:31 +08002438 if (skb_flow_dissect_flow_keys_basic(skb, &keys, NULL, 0, 0, 0, 0))
Tom Herbert42aecaa2015-06-04 09:16:39 -07002439 skb_set_transport_header(skb, keys.control.thoff);
Ying Xuefbbdb8f2013-03-27 16:46:06 +00002440 else
2441 skb_set_transport_header(skb, offset_hint);
2442}
2443
Eric Dumazet03606892012-02-23 10:55:02 +00002444static inline void skb_mac_header_rebuild(struct sk_buff *skb)
2445{
2446 if (skb_mac_header_was_set(skb)) {
2447 const unsigned char *old_mac = skb_mac_header(skb);
2448
2449 skb_set_mac_header(skb, -skb->mac_len);
2450 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
2451 }
2452}
2453
Michał Mirosław04fb4512010-12-14 15:24:08 +00002454static inline int skb_checksum_start_offset(const struct sk_buff *skb)
2455{
2456 return skb->csum_start - skb_headroom(skb);
2457}
2458
Alexander Duyck08b64fc2016-02-05 15:27:49 -08002459static inline unsigned char *skb_checksum_start(const struct sk_buff *skb)
2460{
2461 return skb->head + skb->csum_start;
2462}
2463
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -07002464static inline int skb_transport_offset(const struct sk_buff *skb)
2465{
2466 return skb_transport_header(skb) - skb->data;
2467}
2468
2469static inline u32 skb_network_header_len(const struct sk_buff *skb)
2470{
2471 return skb->transport_header - skb->network_header;
2472}
2473
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002474static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
2475{
2476 return skb->inner_transport_header - skb->inner_network_header;
2477}
2478
Arnaldo Carvalho de Melo2e07fa92007-04-10 21:22:35 -07002479static inline int skb_network_offset(const struct sk_buff *skb)
2480{
2481 return skb_network_header(skb) - skb->data;
2482}
Arnaldo Carvalho de Melo48d49d0c2007-03-10 12:30:58 -03002483
Joseph Gasparakis6a674e92012-12-07 14:14:14 +00002484static inline int skb_inner_network_offset(const struct sk_buff *skb)
2485{
2486 return skb_inner_network_header(skb) - skb->data;
2487}
2488
Changli Gaof9599ce2010-08-04 04:43:44 +00002489static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
2490{
2491 return pskb_may_pull(skb, skb_network_offset(skb) + len);
2492}
2493
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494/*
2495 * CPUs often take a performance hit when accessing unaligned memory
2496 * locations. The actual performance hit varies, it can be small if the
2497 * hardware handles it or large if we have to take an exception and fix it
2498 * in software.
2499 *
2500 * Since an ethernet header is 14 bytes network drivers often end up with
2501 * the IP header at an unaligned offset. The IP header can be aligned by
2502 * shifting the start of the packet by 2 bytes. Drivers should do this
2503 * with:
2504 *
Tobias Klauser8660c122009-07-13 22:48:16 +00002505 * skb_reserve(skb, NET_IP_ALIGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 *
2507 * The downside to this alignment of the IP header is that the DMA is now
2508 * unaligned. On some architectures the cost of an unaligned DMA is high
2509 * and this cost outweighs the gains made by aligning the IP header.
Tobias Klauser8660c122009-07-13 22:48:16 +00002510 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
2512 * to be overridden.
2513 */
2514#ifndef NET_IP_ALIGN
2515#define NET_IP_ALIGN 2
2516#endif
2517
Anton Blanchard025be812006-03-31 02:27:06 -08002518/*
2519 * The networking layer reserves some headroom in skb data (via
2520 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
2521 * the header has to grow. In the default case, if the header has to grow
David S. Millerd6301d32009-02-08 19:24:13 -08002522 * 32 bytes or less we avoid the reallocation.
Anton Blanchard025be812006-03-31 02:27:06 -08002523 *
2524 * Unfortunately this headroom changes the DMA alignment of the resulting
2525 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
2526 * on some architectures. An architecture can override this value,
2527 * perhaps setting it to a cacheline in size (since that will maintain
2528 * cacheline alignment of the DMA). It must be a power of 2.
2529 *
David S. Millerd6301d32009-02-08 19:24:13 -08002530 * Various parts of the networking layer expect at least 32 bytes of
Anton Blanchard025be812006-03-31 02:27:06 -08002531 * headroom, you should not reduce this.
Eric Dumazet5933dd22010-06-15 18:16:43 -07002532 *
2533 * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
2534 * to reduce average number of cache lines per packet.
2535 * get_rps_cpus() for example only access one 64 bytes aligned block :
Eric Dumazet18e8c132010-05-06 21:58:51 -07002536 * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
Anton Blanchard025be812006-03-31 02:27:06 -08002537 */
2538#ifndef NET_SKB_PAD
Eric Dumazet5933dd22010-06-15 18:16:43 -07002539#define NET_SKB_PAD max(32, L1_CACHE_BYTES)
Anton Blanchard025be812006-03-31 02:27:06 -08002540#endif
2541
Joe Perches7965bd42013-09-26 14:48:15 -07002542int ___pskb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
Daniel Borkmann5293efe2016-08-18 01:00:39 +02002544static inline void __skb_set_length(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545{
Yangtao Li5e1abdc2018-11-06 10:45:36 -05002546 if (WARN_ON(skb_is_nonlinear(skb)))
Herbert Xu3cc0e872006-06-09 16:13:38 -07002547 return;
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07002548 skb->len = len;
2549 skb_set_tail_pointer(skb, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550}
2551
Daniel Borkmann5293efe2016-08-18 01:00:39 +02002552static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
2553{
2554 __skb_set_length(skb, len);
2555}
2556
Joe Perches7965bd42013-09-26 14:48:15 -07002557void skb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558
2559static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
2560{
Herbert Xu3cc0e872006-06-09 16:13:38 -07002561 if (skb->data_len)
2562 return ___pskb_trim(skb, len);
2563 __skb_trim(skb, len);
2564 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565}
2566
2567static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
2568{
2569 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
2570}
2571
2572/**
Herbert Xue9fa4f72006-08-13 20:12:58 -07002573 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
2574 * @skb: buffer to alter
2575 * @len: new length
2576 *
2577 * This is identical to pskb_trim except that the caller knows that
2578 * the skb is not cloned so we should never get an error due to out-
2579 * of-memory.
2580 */
2581static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
2582{
2583 int err = pskb_trim(skb, len);
2584 BUG_ON(err);
2585}
2586
Daniel Borkmann5293efe2016-08-18 01:00:39 +02002587static inline int __skb_grow(struct sk_buff *skb, unsigned int len)
2588{
2589 unsigned int diff = len - skb->len;
2590
2591 if (skb_tailroom(skb) < diff) {
2592 int ret = pskb_expand_head(skb, 0, diff - skb_tailroom(skb),
2593 GFP_ATOMIC);
2594 if (ret)
2595 return ret;
2596 }
2597 __skb_set_length(skb, len);
2598 return 0;
2599}
2600
Herbert Xue9fa4f72006-08-13 20:12:58 -07002601/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 * skb_orphan - orphan a buffer
2603 * @skb: buffer to orphan
2604 *
2605 * If a buffer currently has an owner then we call the owner's
2606 * destructor function and make the @skb unowned. The buffer continues
2607 * to exist but is no longer charged to its former owner.
2608 */
2609static inline void skb_orphan(struct sk_buff *skb)
2610{
Eric Dumazetc34a7612013-07-30 16:11:15 -07002611 if (skb->destructor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 skb->destructor(skb);
Eric Dumazetc34a7612013-07-30 16:11:15 -07002613 skb->destructor = NULL;
2614 skb->sk = NULL;
Eric Dumazet376c7312013-08-01 11:43:08 -07002615 } else {
2616 BUG_ON(skb->sk);
Eric Dumazetc34a7612013-07-30 16:11:15 -07002617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618}
2619
2620/**
Michael S. Tsirkina353e0c2012-07-20 09:23:07 +00002621 * skb_orphan_frags - orphan the frags contained in a buffer
2622 * @skb: buffer to orphan frags from
2623 * @gfp_mask: allocation mask for replacement pages
2624 *
2625 * For each frag in the SKB which needs a destructor (i.e. has an
2626 * owner) create a copy of that frag and release the original
2627 * page by calling the destructor.
2628 */
2629static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
2630{
Willem de Bruijn1f8b9772017-08-03 16:29:41 -04002631 if (likely(!skb_zcopy(skb)))
2632 return 0;
2633 if (skb_uarg(skb)->callback == sock_zerocopy_callback)
2634 return 0;
2635 return skb_copy_ubufs(skb, gfp_mask);
2636}
2637
2638/* Frags must be orphaned, even if refcounted, if skb might loop to rx path */
2639static inline int skb_orphan_frags_rx(struct sk_buff *skb, gfp_t gfp_mask)
2640{
2641 if (likely(!skb_zcopy(skb)))
Michael S. Tsirkina353e0c2012-07-20 09:23:07 +00002642 return 0;
2643 return skb_copy_ubufs(skb, gfp_mask);
2644}
2645
2646/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 * __skb_queue_purge - empty a list
2648 * @list: list to empty
2649 *
2650 * Delete all buffers on an &sk_buff list. Each buffer is removed from
2651 * the list and one reference dropped. This function does not take the
2652 * list lock and the caller must hold the relevant locks to use it.
2653 */
Joe Perches7965bd42013-09-26 14:48:15 -07002654void skb_queue_purge(struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655static inline void __skb_queue_purge(struct sk_buff_head *list)
2656{
2657 struct sk_buff *skb;
2658 while ((skb = __skb_dequeue(list)) != NULL)
2659 kfree_skb(skb);
2660}
2661
Peter Oskolkov385114d2018-08-02 23:34:38 +00002662unsigned int skb_rbtree_purge(struct rb_root *root);
Yaogong Wang9f5afea2016-09-07 14:49:28 -07002663
Joe Perches7965bd42013-09-26 14:48:15 -07002664void *netdev_alloc_frag(unsigned int fragsz);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665
Joe Perches7965bd42013-09-26 14:48:15 -07002666struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
2667 gfp_t gfp_mask);
Christoph Hellwig8af27452006-07-31 22:35:23 -07002668
2669/**
2670 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
2671 * @dev: network device to receive on
2672 * @length: length to allocate
2673 *
2674 * Allocate a new &sk_buff and assign it a usage count of one. The
2675 * buffer has unspecified headroom built in. Users should allocate
2676 * the headroom they think they need without accounting for the
2677 * built in space. The built in space is used for optimisations.
2678 *
2679 * %NULL is returned if there is no free memory. Although this function
2680 * allocates memory it can be called from an interrupt.
2681 */
2682static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
Eric Dumazet6f532612012-05-18 05:12:12 +00002683 unsigned int length)
Christoph Hellwig8af27452006-07-31 22:35:23 -07002684{
2685 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
2686}
2687
Eric Dumazet6f532612012-05-18 05:12:12 +00002688/* legacy helper around __netdev_alloc_skb() */
2689static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
2690 gfp_t gfp_mask)
2691{
2692 return __netdev_alloc_skb(NULL, length, gfp_mask);
2693}
2694
2695/* legacy helper around netdev_alloc_skb() */
2696static inline struct sk_buff *dev_alloc_skb(unsigned int length)
2697{
2698 return netdev_alloc_skb(NULL, length);
2699}
2700
2701
Eric Dumazet4915a0d2011-07-11 20:08:34 -07002702static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
2703 unsigned int length, gfp_t gfp)
Eric Dumazet61321bb2009-10-07 17:11:23 +00002704{
Eric Dumazet4915a0d2011-07-11 20:08:34 -07002705 struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
Eric Dumazet61321bb2009-10-07 17:11:23 +00002706
2707 if (NET_IP_ALIGN && skb)
2708 skb_reserve(skb, NET_IP_ALIGN);
2709 return skb;
2710}
2711
Eric Dumazet4915a0d2011-07-11 20:08:34 -07002712static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
2713 unsigned int length)
2714{
2715 return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
2716}
2717
Alexander Duyck181edb22015-05-06 21:12:03 -07002718static inline void skb_free_frag(void *addr)
2719{
Alexander Duyck8c2dd3e2017-01-10 16:58:06 -08002720 page_frag_free(addr);
Alexander Duyck181edb22015-05-06 21:12:03 -07002721}
2722
Alexander Duyckffde7322014-12-09 19:40:42 -08002723void *napi_alloc_frag(unsigned int fragsz);
Alexander Duyckfd11a832014-12-09 19:40:49 -08002724struct sk_buff *__napi_alloc_skb(struct napi_struct *napi,
2725 unsigned int length, gfp_t gfp_mask);
2726static inline struct sk_buff *napi_alloc_skb(struct napi_struct *napi,
2727 unsigned int length)
2728{
2729 return __napi_alloc_skb(napi, length, GFP_ATOMIC);
2730}
Jesper Dangaard Brouer795bb1c2016-02-08 13:14:59 +01002731void napi_consume_skb(struct sk_buff *skb, int budget);
2732
2733void __kfree_skb_flush(void);
Jesper Dangaard Brouer15fad712016-02-08 13:15:04 +01002734void __kfree_skb_defer(struct sk_buff *skb);
Alexander Duyckffde7322014-12-09 19:40:42 -08002735
Florian Fainellibc6fc9f2013-08-30 15:36:14 +01002736/**
Alexander Duyck71dfda52014-11-11 09:26:34 -08002737 * __dev_alloc_pages - allocate page for network Rx
2738 * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2739 * @order: size of the allocation
2740 *
2741 * Allocate a new page.
2742 *
2743 * %NULL is returned if there is no free memory.
2744*/
2745static inline struct page *__dev_alloc_pages(gfp_t gfp_mask,
2746 unsigned int order)
2747{
2748 /* This piece of code contains several assumptions.
2749 * 1. This is for device Rx, therefor a cold page is preferred.
2750 * 2. The expectation is the user wants a compound page.
2751 * 3. If requesting a order 0 page it will not be compound
2752 * due to the check to see if order has a value in prep_new_page
2753 * 4. __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
2754 * code in gfp_to_alloc_flags that should be enforcing this.
2755 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002756 gfp_mask |= __GFP_COMP | __GFP_MEMALLOC;
Alexander Duyck71dfda52014-11-11 09:26:34 -08002757
2758 return alloc_pages_node(NUMA_NO_NODE, gfp_mask, order);
2759}
2760
2761static inline struct page *dev_alloc_pages(unsigned int order)
2762{
Neil Horman95829b32016-05-19 11:30:54 -04002763 return __dev_alloc_pages(GFP_ATOMIC | __GFP_NOWARN, order);
Alexander Duyck71dfda52014-11-11 09:26:34 -08002764}
2765
2766/**
2767 * __dev_alloc_page - allocate a page for network Rx
2768 * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2769 *
2770 * Allocate a new page.
2771 *
2772 * %NULL is returned if there is no free memory.
2773 */
2774static inline struct page *__dev_alloc_page(gfp_t gfp_mask)
2775{
2776 return __dev_alloc_pages(gfp_mask, 0);
2777}
2778
2779static inline struct page *dev_alloc_page(void)
2780{
Neil Horman95829b32016-05-19 11:30:54 -04002781 return dev_alloc_pages(0);
Alexander Duyck71dfda52014-11-11 09:26:34 -08002782}
2783
2784/**
Mel Gorman06140022012-07-31 16:44:24 -07002785 * skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
2786 * @page: The page that was allocated from skb_alloc_page
2787 * @skb: The skb that may need pfmemalloc set
2788 */
2789static inline void skb_propagate_pfmemalloc(struct page *page,
2790 struct sk_buff *skb)
2791{
Michal Hocko2f064f32015-08-21 14:11:51 -07002792 if (page_is_pfmemalloc(page))
Mel Gorman06140022012-07-31 16:44:24 -07002793 skb->pfmemalloc = true;
2794}
2795
Eric Dumazet564824b2010-10-11 19:05:25 +00002796/**
Masanari Iidae2278672014-02-18 22:54:36 +09002797 * skb_frag_page - retrieve the page referred to by a paged fragment
Ian Campbell131ea662011-08-19 06:25:00 +00002798 * @frag: the paged fragment
2799 *
2800 * Returns the &struct page associated with @frag.
2801 */
2802static inline struct page *skb_frag_page(const skb_frag_t *frag)
2803{
Ian Campbella8605c62011-10-19 23:01:49 +00002804 return frag->page.p;
Ian Campbell131ea662011-08-19 06:25:00 +00002805}
2806
2807/**
2808 * __skb_frag_ref - take an addition reference on a paged fragment.
2809 * @frag: the paged fragment
2810 *
2811 * Takes an additional reference on the paged fragment @frag.
2812 */
2813static inline void __skb_frag_ref(skb_frag_t *frag)
2814{
2815 get_page(skb_frag_page(frag));
2816}
2817
2818/**
2819 * skb_frag_ref - take an addition reference on a paged fragment of an skb.
2820 * @skb: the buffer
2821 * @f: the fragment offset.
2822 *
2823 * Takes an additional reference on the @f'th paged fragment of @skb.
2824 */
2825static inline void skb_frag_ref(struct sk_buff *skb, int f)
2826{
2827 __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
2828}
2829
2830/**
2831 * __skb_frag_unref - release a reference on a paged fragment.
2832 * @frag: the paged fragment
2833 *
2834 * Releases a reference on the paged fragment @frag.
2835 */
2836static inline void __skb_frag_unref(skb_frag_t *frag)
2837{
2838 put_page(skb_frag_page(frag));
2839}
2840
2841/**
2842 * skb_frag_unref - release a reference on a paged fragment of an skb.
2843 * @skb: the buffer
2844 * @f: the fragment offset
2845 *
2846 * Releases a reference on the @f'th paged fragment of @skb.
2847 */
2848static inline void skb_frag_unref(struct sk_buff *skb, int f)
2849{
2850 __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
2851}
2852
2853/**
2854 * skb_frag_address - gets the address of the data contained in a paged fragment
2855 * @frag: the paged fragment buffer
2856 *
2857 * Returns the address of the data within @frag. The page must already
2858 * be mapped.
2859 */
2860static inline void *skb_frag_address(const skb_frag_t *frag)
2861{
2862 return page_address(skb_frag_page(frag)) + frag->page_offset;
2863}
2864
2865/**
2866 * skb_frag_address_safe - gets the address of the data contained in a paged fragment
2867 * @frag: the paged fragment buffer
2868 *
2869 * Returns the address of the data within @frag. Checks that the page
2870 * is mapped and returns %NULL otherwise.
2871 */
2872static inline void *skb_frag_address_safe(const skb_frag_t *frag)
2873{
2874 void *ptr = page_address(skb_frag_page(frag));
2875 if (unlikely(!ptr))
2876 return NULL;
2877
2878 return ptr + frag->page_offset;
2879}
2880
2881/**
2882 * __skb_frag_set_page - sets the page contained in a paged fragment
2883 * @frag: the paged fragment
2884 * @page: the page to set
2885 *
2886 * Sets the fragment @frag to contain @page.
2887 */
2888static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
2889{
Ian Campbella8605c62011-10-19 23:01:49 +00002890 frag->page.p = page;
Ian Campbell131ea662011-08-19 06:25:00 +00002891}
2892
2893/**
2894 * skb_frag_set_page - sets the page contained in a paged fragment of an skb
2895 * @skb: the buffer
2896 * @f: the fragment offset
2897 * @page: the page to set
2898 *
2899 * Sets the @f'th fragment of @skb to contain @page.
2900 */
2901static inline void skb_frag_set_page(struct sk_buff *skb, int f,
2902 struct page *page)
2903{
2904 __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
2905}
2906
Eric Dumazet400dfd32013-10-17 16:27:07 -07002907bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
2908
Ian Campbell131ea662011-08-19 06:25:00 +00002909/**
2910 * skb_frag_dma_map - maps a paged fragment via the DMA API
Marcos Paulo de Souzaf83347d2011-10-31 15:11:45 +00002911 * @dev: the device to map the fragment to
Ian Campbell131ea662011-08-19 06:25:00 +00002912 * @frag: the paged fragment to map
2913 * @offset: the offset within the fragment (starting at the
2914 * fragment's own offset)
2915 * @size: the number of bytes to map
Mauro Carvalho Chehab771b00a2017-05-12 09:19:29 -03002916 * @dir: the direction of the mapping (``PCI_DMA_*``)
Ian Campbell131ea662011-08-19 06:25:00 +00002917 *
2918 * Maps the page associated with @frag to @device.
2919 */
2920static inline dma_addr_t skb_frag_dma_map(struct device *dev,
2921 const skb_frag_t *frag,
2922 size_t offset, size_t size,
2923 enum dma_data_direction dir)
2924{
2925 return dma_map_page(dev, skb_frag_page(frag),
2926 frag->page_offset + offset, size, dir);
2927}
2928
Eric Dumazet117632e2011-12-03 21:39:53 +00002929static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
2930 gfp_t gfp_mask)
2931{
2932 return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
2933}
2934
Octavian Purdilabad93e92014-06-12 01:36:26 +03002935
2936static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
2937 gfp_t gfp_mask)
2938{
2939 return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
2940}
2941
2942
Ian Campbell131ea662011-08-19 06:25:00 +00002943/**
Patrick McHardy334a8132007-06-25 04:35:20 -07002944 * skb_clone_writable - is the header of a clone writable
2945 * @skb: buffer to check
2946 * @len: length up to which to write
2947 *
2948 * Returns true if modifying the header part of the cloned buffer
2949 * does not requires the data to be copied.
2950 */
Eric Dumazet05bdd2f2011-10-20 17:45:43 -04002951static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
Patrick McHardy334a8132007-06-25 04:35:20 -07002952{
2953 return !skb_header_cloned(skb) &&
2954 skb_headroom(skb) + len <= skb->hdr_len;
2955}
2956
Daniel Borkmann36976492016-02-19 23:05:25 +01002957static inline int skb_try_make_writable(struct sk_buff *skb,
2958 unsigned int write_len)
2959{
2960 return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
2961 pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
2962}
2963
Herbert Xud9cc2042007-09-16 16:21:16 -07002964static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
2965 int cloned)
2966{
2967 int delta = 0;
2968
Herbert Xud9cc2042007-09-16 16:21:16 -07002969 if (headroom > skb_headroom(skb))
2970 delta = headroom - skb_headroom(skb);
2971
2972 if (delta || cloned)
2973 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
2974 GFP_ATOMIC);
2975 return 0;
2976}
2977
Patrick McHardy334a8132007-06-25 04:35:20 -07002978/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979 * skb_cow - copy header of skb when it is required
2980 * @skb: buffer to cow
2981 * @headroom: needed headroom
2982 *
2983 * If the skb passed lacks sufficient headroom or its data part
2984 * is shared, data is reallocated. If reallocation fails, an error
2985 * is returned and original skb is not changed.
2986 *
2987 * The result is skb with writable area skb->head...skb->tail
2988 * and at least @headroom of space at head.
2989 */
2990static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
2991{
Herbert Xud9cc2042007-09-16 16:21:16 -07002992 return __skb_cow(skb, headroom, skb_cloned(skb));
2993}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994
Herbert Xud9cc2042007-09-16 16:21:16 -07002995/**
2996 * skb_cow_head - skb_cow but only making the head writable
2997 * @skb: buffer to cow
2998 * @headroom: needed headroom
2999 *
3000 * This function is identical to skb_cow except that we replace the
3001 * skb_cloned check by skb_header_cloned. It should be used when
3002 * you only need to push on some header and do not need to modify
3003 * the data.
3004 */
3005static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
3006{
3007 return __skb_cow(skb, headroom, skb_header_cloned(skb));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008}
3009
3010/**
3011 * skb_padto - pad an skbuff up to a minimal size
3012 * @skb: buffer to pad
3013 * @len: minimal length
3014 *
3015 * Pads up a buffer to ensure the trailing bytes exist and are
3016 * blanked. If the buffer already contains sufficient data it
Herbert Xu5b057c62006-06-23 02:06:41 -07003017 * is untouched. Otherwise it is extended. Returns zero on
3018 * success. The skb is freed on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 */
Herbert Xu5b057c62006-06-23 02:06:41 -07003020static inline int skb_padto(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003021{
3022 unsigned int size = skb->len;
3023 if (likely(size >= len))
Herbert Xu5b057c62006-06-23 02:06:41 -07003024 return 0;
Gerrit Renker987c4022008-08-11 18:17:17 -07003025 return skb_pad(skb, len - size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026}
3027
Alexander Duyck9c0c1122014-12-03 08:17:33 -08003028/**
3029 * skb_put_padto - increase size and pad an skbuff up to a minimal size
3030 * @skb: buffer to pad
3031 * @len: minimal length
Florian Fainellicd0a1372017-08-22 15:12:14 -07003032 * @free_on_error: free buffer on error
3033 *
3034 * Pads up a buffer to ensure the trailing bytes exist and are
3035 * blanked. If the buffer already contains sufficient data it
3036 * is untouched. Otherwise it is extended. Returns zero on
3037 * success. The skb is freed on error if @free_on_error is true.
3038 */
3039static inline int __skb_put_padto(struct sk_buff *skb, unsigned int len,
3040 bool free_on_error)
3041{
3042 unsigned int size = skb->len;
3043
3044 if (unlikely(size < len)) {
3045 len -= size;
3046 if (__skb_pad(skb, len, free_on_error))
3047 return -ENOMEM;
3048 __skb_put(skb, len);
3049 }
3050 return 0;
3051}
3052
3053/**
3054 * skb_put_padto - increase size and pad an skbuff up to a minimal size
3055 * @skb: buffer to pad
3056 * @len: minimal length
Alexander Duyck9c0c1122014-12-03 08:17:33 -08003057 *
3058 * Pads up a buffer to ensure the trailing bytes exist and are
3059 * blanked. If the buffer already contains sufficient data it
3060 * is untouched. Otherwise it is extended. Returns zero on
3061 * success. The skb is freed on error.
3062 */
3063static inline int skb_put_padto(struct sk_buff *skb, unsigned int len)
3064{
Florian Fainellicd0a1372017-08-22 15:12:14 -07003065 return __skb_put_padto(skb, len, true);
Alexander Duyck9c0c1122014-12-03 08:17:33 -08003066}
3067
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068static inline int skb_add_data(struct sk_buff *skb,
Al Viroaf2b0402014-11-27 21:44:24 -05003069 struct iov_iter *from, int copy)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070{
3071 const int off = skb->len;
3072
3073 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viroaf2b0402014-11-27 21:44:24 -05003074 __wsum csum = 0;
Al Viro15e6cb42016-11-01 22:42:45 -04003075 if (csum_and_copy_from_iter_full(skb_put(skb, copy), copy,
3076 &csum, from)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077 skb->csum = csum_block_add(skb->csum, csum, off);
3078 return 0;
3079 }
Al Viro15e6cb42016-11-01 22:42:45 -04003080 } else if (copy_from_iter_full(skb_put(skb, copy), copy, from))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081 return 0;
3082
3083 __skb_trim(skb, off);
3084 return -EFAULT;
3085}
3086
Eric Dumazet38ba0a62012-04-23 17:48:27 +00003087static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
3088 const struct page *page, int off)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089{
Willem de Bruijn1f8b9772017-08-03 16:29:41 -04003090 if (skb_zcopy(skb))
3091 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092 if (i) {
Eric Dumazet9e903e02011-10-18 21:00:24 +00003093 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094
Ian Campbellea2ab692011-08-22 23:44:58 +00003095 return page == skb_frag_page(frag) &&
Eric Dumazet9e903e02011-10-18 21:00:24 +00003096 off == frag->page_offset + skb_frag_size(frag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097 }
Eric Dumazet38ba0a62012-04-23 17:48:27 +00003098 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099}
3100
Herbert Xu364c6ba2006-06-09 16:10:40 -07003101static inline int __skb_linearize(struct sk_buff *skb)
3102{
3103 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
3104}
3105
Linus Torvalds1da177e2005-04-16 15:20:36 -07003106/**
3107 * skb_linearize - convert paged skb to linear one
3108 * @skb: buffer to linarize
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109 *
3110 * If there is no free memory -ENOMEM is returned, otherwise zero
3111 * is returned and the old skb data released.
3112 */
Herbert Xu364c6ba2006-06-09 16:10:40 -07003113static inline int skb_linearize(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114{
Herbert Xu364c6ba2006-06-09 16:10:40 -07003115 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
3116}
3117
3118/**
Eric Dumazetcef401d2013-01-25 20:34:37 +00003119 * skb_has_shared_frag - can any frag be overwritten
3120 * @skb: buffer to test
3121 *
3122 * Return true if the skb has at least one frag that might be modified
3123 * by an external entity (as in vmsplice()/sendfile())
3124 */
3125static inline bool skb_has_shared_frag(const struct sk_buff *skb)
3126{
Pravin B Shelarc9af6db2013-02-11 09:27:41 +00003127 return skb_is_nonlinear(skb) &&
3128 skb_shinfo(skb)->tx_flags & SKBTX_SHARED_FRAG;
Eric Dumazetcef401d2013-01-25 20:34:37 +00003129}
3130
3131/**
Herbert Xu364c6ba2006-06-09 16:10:40 -07003132 * skb_linearize_cow - make sure skb is linear and writable
3133 * @skb: buffer to process
3134 *
3135 * If there is no free memory -ENOMEM is returned, otherwise zero
3136 * is returned and the old skb data released.
3137 */
3138static inline int skb_linearize_cow(struct sk_buff *skb)
3139{
3140 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
3141 __skb_linearize(skb) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142}
3143
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003144static __always_inline void
3145__skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3146 unsigned int off)
3147{
3148 if (skb->ip_summed == CHECKSUM_COMPLETE)
3149 skb->csum = csum_block_sub(skb->csum,
3150 csum_partial(start, len, 0), off);
3151 else if (skb->ip_summed == CHECKSUM_PARTIAL &&
3152 skb_checksum_start_offset(skb) < 0)
3153 skb->ip_summed = CHECKSUM_NONE;
3154}
3155
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156/**
3157 * skb_postpull_rcsum - update checksum for received skb after pull
3158 * @skb: buffer to update
3159 * @start: start of data before pull
3160 * @len: length of data pulled
3161 *
3162 * After doing a pull on a received packet, you need to call this to
Patrick McHardy84fa7932006-08-29 16:44:56 -07003163 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
3164 * CHECKSUM_NONE so that it can be recomputed from scratch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166static inline void skb_postpull_rcsum(struct sk_buff *skb,
Herbert Xucbb042f2006-03-20 22:43:56 -08003167 const void *start, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168{
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003169 __skb_postpull_rcsum(skb, start, len, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170}
3171
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003172static __always_inline void
3173__skb_postpush_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3174 unsigned int off)
3175{
3176 if (skb->ip_summed == CHECKSUM_COMPLETE)
3177 skb->csum = csum_block_add(skb->csum,
3178 csum_partial(start, len, 0), off);
3179}
Herbert Xucbb042f2006-03-20 22:43:56 -08003180
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003181/**
3182 * skb_postpush_rcsum - update checksum for received skb after push
3183 * @skb: buffer to update
3184 * @start: start of data after push
3185 * @len: length of data pushed
3186 *
3187 * After doing a push on a received packet, you need to call this to
3188 * update the CHECKSUM_COMPLETE checksum.
3189 */
Daniel Borkmannf8ffad62016-01-07 15:50:23 +01003190static inline void skb_postpush_rcsum(struct sk_buff *skb,
3191 const void *start, unsigned int len)
3192{
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003193 __skb_postpush_rcsum(skb, start, len, 0);
Daniel Borkmannf8ffad62016-01-07 15:50:23 +01003194}
3195
Johannes Bergaf728682017-06-16 14:29:22 +02003196void *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
Daniel Borkmann479ffccc2016-08-05 00:11:12 +02003197
David S. Miller7ce5a272013-12-02 17:26:05 -05003198/**
WANG Cong82a31b92016-06-30 10:15:22 -07003199 * skb_push_rcsum - push skb and update receive checksum
3200 * @skb: buffer to update
3201 * @len: length of data pulled
3202 *
3203 * This function performs an skb_push on the packet and updates
3204 * the CHECKSUM_COMPLETE checksum. It should be used on
3205 * receive path processing instead of skb_push unless you know
3206 * that the checksum difference is zero (e.g., a valid IP header)
3207 * or you are setting ip_summed to CHECKSUM_NONE.
3208 */
Johannes Bergd58ff352017-06-16 14:29:23 +02003209static inline void *skb_push_rcsum(struct sk_buff *skb, unsigned int len)
WANG Cong82a31b92016-06-30 10:15:22 -07003210{
3211 skb_push(skb, len);
3212 skb_postpush_rcsum(skb, skb->data, len);
3213 return skb->data;
3214}
3215
Eric Dumazet88078d92018-04-18 11:43:15 -07003216int pskb_trim_rcsum_slow(struct sk_buff *skb, unsigned int len);
WANG Cong82a31b92016-06-30 10:15:22 -07003217/**
David S. Miller7ce5a272013-12-02 17:26:05 -05003218 * pskb_trim_rcsum - trim received skb and update checksum
3219 * @skb: buffer to trim
3220 * @len: new length
3221 *
3222 * This is exactly the same as pskb_trim except that it ensures the
3223 * checksum of received packets are still valid after the operation.
3224 */
3225
3226static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3227{
3228 if (likely(len >= skb->len))
3229 return 0;
Eric Dumazet88078d92018-04-18 11:43:15 -07003230 return pskb_trim_rcsum_slow(skb, len);
David S. Miller7ce5a272013-12-02 17:26:05 -05003231}
3232
Daniel Borkmann5293efe2016-08-18 01:00:39 +02003233static inline int __skb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3234{
3235 if (skb->ip_summed == CHECKSUM_COMPLETE)
3236 skb->ip_summed = CHECKSUM_NONE;
3237 __skb_trim(skb, len);
3238 return 0;
3239}
3240
3241static inline int __skb_grow_rcsum(struct sk_buff *skb, unsigned int len)
3242{
3243 if (skb->ip_summed == CHECKSUM_COMPLETE)
3244 skb->ip_summed = CHECKSUM_NONE;
3245 return __skb_grow(skb, len);
3246}
3247
Eric Dumazet18a4c0e2017-10-05 22:21:21 -07003248#define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
3249#define skb_rb_first(root) rb_to_skb(rb_first(root))
3250#define skb_rb_last(root) rb_to_skb(rb_last(root))
3251#define skb_rb_next(skb) rb_to_skb(rb_next(&(skb)->rbnode))
3252#define skb_rb_prev(skb) rb_to_skb(rb_prev(&(skb)->rbnode))
3253
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254#define skb_queue_walk(queue, skb) \
3255 for (skb = (queue)->next; \
Linus Torvaldsa1e48912011-05-22 16:51:43 -07003256 skb != (struct sk_buff *)(queue); \
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257 skb = skb->next)
3258
James Chapman46f89142007-04-30 00:07:31 -07003259#define skb_queue_walk_safe(queue, skb, tmp) \
3260 for (skb = (queue)->next, tmp = skb->next; \
3261 skb != (struct sk_buff *)(queue); \
3262 skb = tmp, tmp = skb->next)
3263
David S. Miller1164f522008-09-23 00:49:44 -07003264#define skb_queue_walk_from(queue, skb) \
Linus Torvaldsa1e48912011-05-22 16:51:43 -07003265 for (; skb != (struct sk_buff *)(queue); \
David S. Miller1164f522008-09-23 00:49:44 -07003266 skb = skb->next)
3267
Eric Dumazet18a4c0e2017-10-05 22:21:21 -07003268#define skb_rbtree_walk(skb, root) \
3269 for (skb = skb_rb_first(root); skb != NULL; \
3270 skb = skb_rb_next(skb))
3271
3272#define skb_rbtree_walk_from(skb) \
3273 for (; skb != NULL; \
3274 skb = skb_rb_next(skb))
3275
3276#define skb_rbtree_walk_from_safe(skb, tmp) \
3277 for (; tmp = skb ? skb_rb_next(skb) : NULL, (skb != NULL); \
3278 skb = tmp)
3279
David S. Miller1164f522008-09-23 00:49:44 -07003280#define skb_queue_walk_from_safe(queue, skb, tmp) \
3281 for (tmp = skb->next; \
3282 skb != (struct sk_buff *)(queue); \
3283 skb = tmp, tmp = skb->next)
3284
Stephen Hemminger300ce172005-10-30 13:47:34 -08003285#define skb_queue_reverse_walk(queue, skb) \
3286 for (skb = (queue)->prev; \
Linus Torvaldsa1e48912011-05-22 16:51:43 -07003287 skb != (struct sk_buff *)(queue); \
Stephen Hemminger300ce172005-10-30 13:47:34 -08003288 skb = skb->prev)
3289
David S. Miller686a2952011-01-20 22:47:32 -08003290#define skb_queue_reverse_walk_safe(queue, skb, tmp) \
3291 for (skb = (queue)->prev, tmp = skb->prev; \
3292 skb != (struct sk_buff *)(queue); \
3293 skb = tmp, tmp = skb->prev)
3294
3295#define skb_queue_reverse_walk_from_safe(queue, skb, tmp) \
3296 for (tmp = skb->prev; \
3297 skb != (struct sk_buff *)(queue); \
3298 skb = tmp, tmp = skb->prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299
David S. Miller21dc3302010-08-23 00:13:46 -07003300static inline bool skb_has_frag_list(const struct sk_buff *skb)
David S. Milleree039872009-06-09 00:17:13 -07003301{
3302 return skb_shinfo(skb)->frag_list != NULL;
3303}
3304
3305static inline void skb_frag_list_init(struct sk_buff *skb)
3306{
3307 skb_shinfo(skb)->frag_list = NULL;
3308}
3309
David S. Milleree039872009-06-09 00:17:13 -07003310#define skb_walk_frags(skb, iter) \
3311 for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
3312
Rainer Weikusatea3793e2015-12-06 21:11:34 +00003313
3314int __skb_wait_for_more_packets(struct sock *sk, int *err, long *timeo_p,
3315 const struct sk_buff *skb);
Paolo Abeni65101ae2017-05-16 11:20:13 +02003316struct sk_buff *__skb_try_recv_from_queue(struct sock *sk,
3317 struct sk_buff_head *queue,
3318 unsigned int flags,
3319 void (*destructor)(struct sock *sk,
3320 struct sk_buff *skb),
3321 int *peeked, int *off, int *err,
3322 struct sk_buff **last);
Rainer Weikusatea3793e2015-12-06 21:11:34 +00003323struct sk_buff *__skb_try_recv_datagram(struct sock *sk, unsigned flags,
Paolo Abeni7c13f972016-11-04 11:28:59 +01003324 void (*destructor)(struct sock *sk,
3325 struct sk_buff *skb),
Rainer Weikusatea3793e2015-12-06 21:11:34 +00003326 int *peeked, int *off, int *err,
3327 struct sk_buff **last);
Joe Perches7965bd42013-09-26 14:48:15 -07003328struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
Paolo Abeni7c13f972016-11-04 11:28:59 +01003329 void (*destructor)(struct sock *sk,
3330 struct sk_buff *skb),
Joe Perches7965bd42013-09-26 14:48:15 -07003331 int *peeked, int *off, int *err);
3332struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags, int noblock,
3333 int *err);
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07003334__poll_t datagram_poll(struct file *file, struct socket *sock,
3335 struct poll_table_struct *wait);
Al Viroc0371da2014-11-24 10:42:55 -05003336int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
3337 struct iov_iter *to, int size);
David S. Miller51f3d022014-11-05 16:46:40 -05003338static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
3339 struct msghdr *msg, int size)
3340{
Al Viroe5a4b0b2014-11-24 18:17:55 -05003341 return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
David S. Miller51f3d022014-11-05 16:46:40 -05003342}
Al Viroe5a4b0b2014-11-24 18:17:55 -05003343int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
3344 struct msghdr *msg);
Al Viro3a654f92014-06-19 14:15:22 -04003345int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
3346 struct iov_iter *from, int len);
Al Viro3a654f92014-06-19 14:15:22 -04003347int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
Joe Perches7965bd42013-09-26 14:48:15 -07003348void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
samanthakumar627d2d62016-04-05 12:41:16 -04003349void __skb_free_datagram_locked(struct sock *sk, struct sk_buff *skb, int len);
3350static inline void skb_free_datagram_locked(struct sock *sk,
3351 struct sk_buff *skb)
3352{
3353 __skb_free_datagram_locked(sk, skb, 0);
3354}
Joe Perches7965bd42013-09-26 14:48:15 -07003355int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
Joe Perches7965bd42013-09-26 14:48:15 -07003356int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
3357int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
3358__wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
3359 int len, __wsum csum);
Hannes Frederic Sowaa60e3cc2015-05-21 17:00:00 +02003360int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
Joe Perches7965bd42013-09-26 14:48:15 -07003361 struct pipe_inode_info *pipe, unsigned int len,
Al Viro25869262016-09-17 21:02:10 -04003362 unsigned int flags);
Tom Herbert20bf50d2017-07-28 16:22:42 -07003363int skb_send_sock_locked(struct sock *sk, struct sk_buff *skb, int offset,
3364 int len);
Joe Perches7965bd42013-09-26 14:48:15 -07003365void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
Thomas Grafaf2806f2013-12-13 15:22:17 +01003366unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
Zoltan Kiss36d5fe62014-03-26 22:37:45 +00003367int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
3368 int len, int hlen);
Joe Perches7965bd42013-09-26 14:48:15 -07003369void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
3370int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
3371void skb_scrub_packet(struct sk_buff *skb, bool xnet);
Daniel Axtens779b7932018-03-01 17:13:37 +11003372bool skb_gso_validate_network_len(const struct sk_buff *skb, unsigned int mtu);
Daniel Axtens2b16f042018-01-31 14:15:33 +11003373bool skb_gso_validate_mac_len(const struct sk_buff *skb, unsigned int len);
Joe Perches7965bd42013-09-26 14:48:15 -07003374struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
Vlad Yasevich0d5501c2014-08-08 14:42:13 -04003375struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
Jiri Pirkoe2195122014-11-19 14:05:01 +01003376int skb_ensure_writable(struct sk_buff *skb, int write_len);
Shmulik Ladkanibfca4c52016-09-19 19:11:09 +03003377int __skb_vlan_pop(struct sk_buff *skb, u16 *vlan_tci);
Jiri Pirko93515d52014-11-19 14:05:02 +01003378int skb_vlan_pop(struct sk_buff *skb);
3379int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
Sowmini Varadhan6fa01cc2016-04-22 18:36:35 -07003380struct sk_buff *pskb_extract(struct sk_buff *skb, int off, int to_copy,
3381 gfp_t gfp);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03003382
Al Viro6ce8e9c2014-04-06 21:25:44 -04003383static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
3384{
Al Viro3073f072017-02-17 23:13:25 -05003385 return copy_from_iter_full(data, len, &msg->msg_iter) ? 0 : -EFAULT;
Al Viro6ce8e9c2014-04-06 21:25:44 -04003386}
3387
Al Viro7eab8d92014-04-06 21:51:23 -04003388static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
3389{
Al Viroe5a4b0b2014-11-24 18:17:55 -05003390 return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
Al Viro7eab8d92014-04-06 21:51:23 -04003391}
3392
Daniel Borkmann2817a332013-10-30 11:50:51 +01003393struct skb_checksum_ops {
3394 __wsum (*update)(const void *mem, int len, __wsum wsum);
3395 __wsum (*combine)(__wsum csum, __wsum csum2, int offset, int len);
3396};
3397
Davide Caratti96178132017-05-18 15:44:37 +02003398extern const struct skb_checksum_ops *crc32c_csum_stub __read_mostly;
3399
Daniel Borkmann2817a332013-10-30 11:50:51 +01003400__wsum __skb_checksum(const struct sk_buff *skb, int offset, int len,
3401 __wsum csum, const struct skb_checksum_ops *ops);
3402__wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
3403 __wsum csum);
3404
Eric Dumazet1e98a0f2015-06-12 19:31:32 -07003405static inline void * __must_check
3406__skb_header_pointer(const struct sk_buff *skb, int offset,
3407 int len, void *data, int hlen, void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003408{
Patrick McHardy55820ee2005-07-05 14:08:10 -07003409 if (hlen - offset >= len)
David S. Miller690e36e2014-08-23 12:13:41 -07003410 return data + offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003411
David S. Miller690e36e2014-08-23 12:13:41 -07003412 if (!skb ||
3413 skb_copy_bits(skb, offset, buffer, len) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414 return NULL;
3415
3416 return buffer;
3417}
3418
Eric Dumazet1e98a0f2015-06-12 19:31:32 -07003419static inline void * __must_check
3420skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
David S. Miller690e36e2014-08-23 12:13:41 -07003421{
3422 return __skb_header_pointer(skb, offset, len, skb->data,
3423 skb_headlen(skb), buffer);
3424}
3425
Daniel Borkmann4262e5c2013-12-06 11:36:16 +01003426/**
3427 * skb_needs_linearize - check if we need to linearize a given skb
3428 * depending on the given device features.
3429 * @skb: socket buffer to check
3430 * @features: net device features
3431 *
3432 * Returns true if either:
3433 * 1. skb has frag_list and the device doesn't support FRAGLIST, or
3434 * 2. skb is fragmented and the device does not support SG.
3435 */
3436static inline bool skb_needs_linearize(struct sk_buff *skb,
3437 netdev_features_t features)
3438{
3439 return skb_is_nonlinear(skb) &&
3440 ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
3441 (skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
3442}
3443
Arnaldo Carvalho de Melod626f622007-03-27 18:55:52 -03003444static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
3445 void *to,
3446 const unsigned int len)
3447{
3448 memcpy(to, skb->data, len);
3449}
3450
3451static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
3452 const int offset, void *to,
3453 const unsigned int len)
3454{
3455 memcpy(to, skb->data + offset, len);
3456}
3457
Arnaldo Carvalho de Melo27d7ff42007-03-31 11:55:19 -03003458static inline void skb_copy_to_linear_data(struct sk_buff *skb,
3459 const void *from,
3460 const unsigned int len)
3461{
3462 memcpy(skb->data, from, len);
3463}
3464
3465static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
3466 const int offset,
3467 const void *from,
3468 const unsigned int len)
3469{
3470 memcpy(skb->data + offset, from, len);
3471}
3472
Joe Perches7965bd42013-09-26 14:48:15 -07003473void skb_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474
Patrick Ohlyac45f602009-02-12 05:03:37 +00003475static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
3476{
3477 return skb->tstamp;
3478}
3479
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003480/**
3481 * skb_get_timestamp - get timestamp from a skb
3482 * @skb: skb to get stamp from
3483 * @stamp: pointer to struct timeval to store stamp in
3484 *
3485 * Timestamps are stored in the skb as offsets to a base timestamp.
3486 * This function converts the offset back to a struct timeval and stores
3487 * it in stamp.
3488 */
Patrick Ohlyac45f602009-02-12 05:03:37 +00003489static inline void skb_get_timestamp(const struct sk_buff *skb,
3490 struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003491{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07003492 *stamp = ktime_to_timeval(skb->tstamp);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003493}
3494
Patrick Ohlyac45f602009-02-12 05:03:37 +00003495static inline void skb_get_timestampns(const struct sk_buff *skb,
3496 struct timespec *stamp)
3497{
3498 *stamp = ktime_to_timespec(skb->tstamp);
3499}
3500
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07003501static inline void __net_timestamp(struct sk_buff *skb)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003502{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07003503 skb->tstamp = ktime_get_real();
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003504}
3505
Stephen Hemminger164891a2007-04-23 22:26:16 -07003506static inline ktime_t net_timedelta(ktime_t t)
3507{
3508 return ktime_sub(ktime_get_real(), t);
3509}
3510
Ilpo Järvinenb9ce2042007-06-15 15:08:43 -07003511static inline ktime_t net_invalid_timestamp(void)
3512{
Thomas Gleixner8b0e1952016-12-25 12:30:41 +01003513 return 0;
Ilpo Järvinenb9ce2042007-06-15 15:08:43 -07003514}
Patrick McHardya61bbcf2005-08-14 17:24:31 -07003515
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003516static inline u8 skb_metadata_len(const struct sk_buff *skb)
3517{
3518 return skb_shinfo(skb)->meta_len;
3519}
3520
3521static inline void *skb_metadata_end(const struct sk_buff *skb)
3522{
3523 return skb_mac_header(skb);
3524}
3525
3526static inline bool __skb_metadata_differs(const struct sk_buff *skb_a,
3527 const struct sk_buff *skb_b,
3528 u8 meta_len)
3529{
3530 const void *a = skb_metadata_end(skb_a);
3531 const void *b = skb_metadata_end(skb_b);
3532 /* Using more efficient varaiant than plain call to memcmp(). */
3533#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
3534 u64 diffs = 0;
3535
3536 switch (meta_len) {
3537#define __it(x, op) (x -= sizeof(u##op))
3538#define __it_diff(a, b, op) (*(u##op *)__it(a, op)) ^ (*(u##op *)__it(b, op))
3539 case 32: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003540 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003541 case 24: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003542 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003543 case 16: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003544 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003545 case 8: diffs |= __it_diff(a, b, 64);
3546 break;
3547 case 28: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003548 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003549 case 20: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003550 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003551 case 12: diffs |= __it_diff(a, b, 64);
Gustavo A. R. Silva82385b02018-10-17 15:01:37 +02003552 /* fall through */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003553 case 4: diffs |= __it_diff(a, b, 32);
3554 break;
3555 }
3556 return diffs;
3557#else
3558 return memcmp(a - meta_len, b - meta_len, meta_len);
3559#endif
3560}
3561
3562static inline bool skb_metadata_differs(const struct sk_buff *skb_a,
3563 const struct sk_buff *skb_b)
3564{
3565 u8 len_a = skb_metadata_len(skb_a);
3566 u8 len_b = skb_metadata_len(skb_b);
3567
3568 if (!(len_a | len_b))
3569 return false;
3570
3571 return len_a != len_b ?
3572 true : __skb_metadata_differs(skb_a, skb_b, len_a);
3573}
3574
3575static inline void skb_metadata_set(struct sk_buff *skb, u8 meta_len)
3576{
3577 skb_shinfo(skb)->meta_len = meta_len;
3578}
3579
3580static inline void skb_metadata_clear(struct sk_buff *skb)
3581{
3582 skb_metadata_set(skb, 0);
3583}
3584
Alexander Duyck62bccb82014-09-04 13:31:35 -04003585struct sk_buff *skb_clone_sk(struct sk_buff *skb);
3586
Richard Cochranc1f19b52010-07-17 08:49:36 +00003587#ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
3588
Joe Perches7965bd42013-09-26 14:48:15 -07003589void skb_clone_tx_timestamp(struct sk_buff *skb);
3590bool skb_defer_rx_timestamp(struct sk_buff *skb);
Richard Cochranc1f19b52010-07-17 08:49:36 +00003591
3592#else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
3593
3594static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
3595{
3596}
3597
3598static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
3599{
3600 return false;
3601}
3602
3603#endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
3604
3605/**
3606 * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
3607 *
Richard Cochranda92b192011-10-21 00:49:15 +00003608 * PHY drivers may accept clones of transmitted packets for
3609 * timestamping via their phy_driver.txtstamp method. These drivers
Benjamin Poirier7a76a022015-08-07 09:32:21 -07003610 * must call this function to return the skb back to the stack with a
3611 * timestamp.
Richard Cochranda92b192011-10-21 00:49:15 +00003612 *
Richard Cochranc1f19b52010-07-17 08:49:36 +00003613 * @skb: clone of the the original outgoing packet
Benjamin Poirier7a76a022015-08-07 09:32:21 -07003614 * @hwtstamps: hardware time stamps
Richard Cochranc1f19b52010-07-17 08:49:36 +00003615 *
3616 */
3617void skb_complete_tx_timestamp(struct sk_buff *skb,
3618 struct skb_shared_hwtstamps *hwtstamps);
3619
Willem de Bruijne7fd2882014-08-04 22:11:48 -04003620void __skb_tstamp_tx(struct sk_buff *orig_skb,
3621 struct skb_shared_hwtstamps *hwtstamps,
3622 struct sock *sk, int tstype);
3623
Patrick Ohlyac45f602009-02-12 05:03:37 +00003624/**
3625 * skb_tstamp_tx - queue clone of skb with send time stamps
3626 * @orig_skb: the original outgoing packet
3627 * @hwtstamps: hardware time stamps, may be NULL if not available
3628 *
3629 * If the skb has a socket associated, then this function clones the
3630 * skb (thus sharing the actual data and optional structures), stores
3631 * the optional hardware time stamping information (if non NULL) or
3632 * generates a software time stamp (otherwise), then queues the clone
3633 * to the error queue of the socket. Errors are silently ignored.
3634 */
Joe Perches7965bd42013-09-26 14:48:15 -07003635void skb_tstamp_tx(struct sk_buff *orig_skb,
3636 struct skb_shared_hwtstamps *hwtstamps);
Patrick Ohlyac45f602009-02-12 05:03:37 +00003637
Richard Cochran4507a712010-07-17 08:48:28 +00003638/**
3639 * skb_tx_timestamp() - Driver hook for transmit timestamping
3640 *
3641 * Ethernet MAC Drivers should call this function in their hard_xmit()
Richard Cochran4ff75b72011-06-19 03:31:39 +00003642 * function immediately before giving the sk_buff to the MAC hardware.
Richard Cochran4507a712010-07-17 08:48:28 +00003643 *
David S. Miller73409f32013-12-27 13:04:33 -05003644 * Specifically, one should make absolutely sure that this function is
3645 * called before TX completion of this packet can trigger. Otherwise
3646 * the packet could potentially already be freed.
3647 *
Richard Cochran4507a712010-07-17 08:48:28 +00003648 * @skb: A socket buffer.
3649 */
3650static inline void skb_tx_timestamp(struct sk_buff *skb)
3651{
Richard Cochranc1f19b52010-07-17 08:49:36 +00003652 skb_clone_tx_timestamp(skb);
Miroslav Lichvarb50a5c72017-05-19 17:52:40 +02003653 if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP)
3654 skb_tstamp_tx(skb, NULL);
Richard Cochran4507a712010-07-17 08:48:28 +00003655}
3656
Johannes Berg6e3e9392011-11-09 10:15:42 +01003657/**
3658 * skb_complete_wifi_ack - deliver skb with wifi status
3659 *
3660 * @skb: the original outgoing packet
3661 * @acked: ack status
3662 *
3663 */
3664void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
3665
Joe Perches7965bd42013-09-26 14:48:15 -07003666__sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
3667__sum16 __skb_checksum_complete(struct sk_buff *skb);
Herbert Xufb286bb2005-11-10 13:01:24 -08003668
Herbert Xu60476372007-04-09 11:59:39 -07003669static inline int skb_csum_unnecessary(const struct sk_buff *skb)
3670{
Tom Herbert6edec0e2015-02-10 16:30:28 -08003671 return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
3672 skb->csum_valid ||
3673 (skb->ip_summed == CHECKSUM_PARTIAL &&
3674 skb_checksum_start_offset(skb) >= 0));
Herbert Xu60476372007-04-09 11:59:39 -07003675}
3676
Herbert Xufb286bb2005-11-10 13:01:24 -08003677/**
3678 * skb_checksum_complete - Calculate checksum of an entire packet
3679 * @skb: packet to process
3680 *
3681 * This function calculates the checksum over the entire packet plus
3682 * the value of skb->csum. The latter can be used to supply the
3683 * checksum of a pseudo header as used by TCP/UDP. It returns the
3684 * checksum.
3685 *
3686 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
3687 * this function can be used to verify that checksum on received
3688 * packets. In that case the function should return zero if the
3689 * checksum is correct. In particular, this function will return zero
3690 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
3691 * hardware has already verified the correctness of the checksum.
3692 */
Al Viro4381ca32007-07-15 21:00:11 +01003693static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
Herbert Xufb286bb2005-11-10 13:01:24 -08003694{
Herbert Xu60476372007-04-09 11:59:39 -07003695 return skb_csum_unnecessary(skb) ?
3696 0 : __skb_checksum_complete(skb);
Herbert Xufb286bb2005-11-10 13:01:24 -08003697}
3698
Tom Herbert77cffe22014-08-27 21:26:46 -07003699static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
3700{
3701 if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3702 if (skb->csum_level == 0)
3703 skb->ip_summed = CHECKSUM_NONE;
3704 else
3705 skb->csum_level--;
3706 }
3707}
3708
3709static inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
3710{
3711 if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3712 if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
3713 skb->csum_level++;
3714 } else if (skb->ip_summed == CHECKSUM_NONE) {
3715 skb->ip_summed = CHECKSUM_UNNECESSARY;
3716 skb->csum_level = 0;
3717 }
3718}
3719
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003720/* Check if we need to perform checksum complete validation.
3721 *
3722 * Returns true if checksum complete is needed, false otherwise
3723 * (either checksum is unnecessary or zero checksum is allowed).
3724 */
3725static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
3726 bool zero_okay,
3727 __sum16 check)
3728{
Tom Herbert5d0c2b92014-06-10 18:54:13 -07003729 if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
3730 skb->csum_valid = 1;
Tom Herbert77cffe22014-08-27 21:26:46 -07003731 __skb_decr_checksum_unnecessary(skb);
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003732 return false;
3733 }
3734
3735 return true;
3736}
3737
David S. Millerda279882018-02-16 15:52:42 -05003738/* For small packets <= CHECKSUM_BREAK perform checksum complete directly
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003739 * in checksum_init.
3740 */
3741#define CHECKSUM_BREAK 76
3742
Tom Herbert4e18b9a2015-04-20 14:10:04 -07003743/* Unset checksum-complete
3744 *
3745 * Unset checksum complete can be done when packet is being modified
3746 * (uncompressed for instance) and checksum-complete value is
3747 * invalidated.
3748 */
3749static inline void skb_checksum_complete_unset(struct sk_buff *skb)
3750{
3751 if (skb->ip_summed == CHECKSUM_COMPLETE)
3752 skb->ip_summed = CHECKSUM_NONE;
3753}
3754
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003755/* Validate (init) checksum based on checksum complete.
3756 *
3757 * Return values:
3758 * 0: checksum is validated or try to in skb_checksum_complete. In the latter
3759 * case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
3760 * checksum is stored in skb->csum for use in __skb_checksum_complete
3761 * non-zero: value of invalid checksum
3762 *
3763 */
3764static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
3765 bool complete,
3766 __wsum psum)
3767{
3768 if (skb->ip_summed == CHECKSUM_COMPLETE) {
3769 if (!csum_fold(csum_add(psum, skb->csum))) {
Tom Herbert5d0c2b92014-06-10 18:54:13 -07003770 skb->csum_valid = 1;
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003771 return 0;
3772 }
3773 }
3774
3775 skb->csum = psum;
3776
Tom Herbert5d0c2b92014-06-10 18:54:13 -07003777 if (complete || skb->len <= CHECKSUM_BREAK) {
3778 __sum16 csum;
3779
3780 csum = __skb_checksum_complete(skb);
3781 skb->csum_valid = !csum;
3782 return csum;
3783 }
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003784
3785 return 0;
3786}
3787
3788static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
3789{
3790 return 0;
3791}
3792
3793/* Perform checksum validate (init). Note that this is a macro since we only
3794 * want to calculate the pseudo header which is an input function if necessary.
3795 * First we try to validate without any computation (checksum unnecessary) and
3796 * then calculate based on checksum complete calling the function to compute
3797 * pseudo header.
3798 *
3799 * Return values:
3800 * 0: checksum is validated or try to in skb_checksum_complete
3801 * non-zero: value of invalid checksum
3802 */
3803#define __skb_checksum_validate(skb, proto, complete, \
3804 zero_okay, check, compute_pseudo) \
3805({ \
3806 __sum16 __ret = 0; \
Tom Herbert5d0c2b92014-06-10 18:54:13 -07003807 skb->csum_valid = 0; \
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003808 if (__skb_checksum_validate_needed(skb, zero_okay, check)) \
3809 __ret = __skb_checksum_validate_complete(skb, \
3810 complete, compute_pseudo(skb, proto)); \
3811 __ret; \
3812})
3813
3814#define skb_checksum_init(skb, proto, compute_pseudo) \
3815 __skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
3816
3817#define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo) \
3818 __skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
3819
3820#define skb_checksum_validate(skb, proto, compute_pseudo) \
3821 __skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
3822
3823#define skb_checksum_validate_zero_check(skb, proto, check, \
3824 compute_pseudo) \
Sabrina Dubroca096a4cf2015-02-06 18:54:19 +01003825 __skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
Tom Herbert76ba0aa2014-05-02 16:29:18 -07003826
3827#define skb_checksum_simple_validate(skb) \
3828 __skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
3829
Tom Herbertd96535a2014-08-31 15:12:42 -07003830static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
3831{
Davide Caratti219f1d792017-05-18 15:44:39 +02003832 return (skb->ip_summed == CHECKSUM_NONE && skb->csum_valid);
Tom Herbertd96535a2014-08-31 15:12:42 -07003833}
3834
3835static inline void __skb_checksum_convert(struct sk_buff *skb,
3836 __sum16 check, __wsum pseudo)
3837{
3838 skb->csum = ~pseudo;
3839 skb->ip_summed = CHECKSUM_COMPLETE;
3840}
3841
3842#define skb_checksum_try_convert(skb, proto, check, compute_pseudo) \
3843do { \
3844 if (__skb_checksum_convert_check(skb)) \
3845 __skb_checksum_convert(skb, check, \
3846 compute_pseudo(skb, proto)); \
3847} while (0)
3848
Tom Herbert15e23962015-02-10 16:30:31 -08003849static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
3850 u16 start, u16 offset)
3851{
3852 skb->ip_summed = CHECKSUM_PARTIAL;
3853 skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
3854 skb->csum_offset = offset - start;
3855}
3856
Tom Herbertdcdc8992015-02-02 16:07:34 -08003857/* Update skbuf and packet to reflect the remote checksum offload operation.
3858 * When called, ptr indicates the starting point for skb->csum when
3859 * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
3860 * here, skb_postpull_rcsum is done so skb->csum start is ptr.
3861 */
3862static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
Tom Herbert15e23962015-02-10 16:30:31 -08003863 int start, int offset, bool nopartial)
Tom Herbertdcdc8992015-02-02 16:07:34 -08003864{
3865 __wsum delta;
3866
Tom Herbert15e23962015-02-10 16:30:31 -08003867 if (!nopartial) {
3868 skb_remcsum_adjust_partial(skb, ptr, start, offset);
3869 return;
3870 }
3871
Tom Herbertdcdc8992015-02-02 16:07:34 -08003872 if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
3873 __skb_checksum_complete(skb);
3874 skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
3875 }
3876
3877 delta = remcsum_adjust(ptr, skb->csum, start, offset);
3878
3879 /* Adjust skb->csum since we changed the packet */
3880 skb->csum = csum_add(skb->csum, delta);
3881}
3882
Florian Westphalcb9c6832017-01-23 18:21:56 +01003883static inline struct nf_conntrack *skb_nfct(const struct sk_buff *skb)
3884{
3885#if IS_ENABLED(CONFIG_NF_CONNTRACK)
Florian Westphala9e419d2017-01-23 18:21:59 +01003886 return (void *)(skb->_nfct & SKB_NFCT_PTRMASK);
Florian Westphalcb9c6832017-01-23 18:21:56 +01003887#else
3888 return NULL;
3889#endif
3890}
3891
Yasuyuki Kozakai5f79e0f2007-03-23 11:17:07 -07003892#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Joe Perches7965bd42013-09-26 14:48:15 -07003893void nf_conntrack_destroy(struct nf_conntrack *nfct);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003894static inline void nf_conntrack_put(struct nf_conntrack *nfct)
3895{
3896 if (nfct && atomic_dec_and_test(&nfct->use))
Yasuyuki Kozakaide6e05c2007-03-23 11:17:27 -07003897 nf_conntrack_destroy(nfct);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003898}
3899static inline void nf_conntrack_get(struct nf_conntrack *nfct)
3900{
3901 if (nfct)
3902 atomic_inc(&nfct->use);
3903}
KOVACS Krisztian2fc72c72011-01-12 20:25:08 +01003904#endif
Florian Westphaldf5042f2018-12-18 17:15:16 +01003905
3906#ifdef CONFIG_SKB_EXTENSIONS
3907enum skb_ext_id {
3908#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3909 SKB_EXT_BRIDGE_NF,
3910#endif
3911 SKB_EXT_NUM, /* must be last */
3912};
3913
3914/**
3915 * struct skb_ext - sk_buff extensions
3916 * @refcnt: 1 on allocation, deallocated on 0
3917 * @offset: offset to add to @data to obtain extension address
3918 * @chunks: size currently allocated, stored in SKB_EXT_ALIGN_SHIFT units
3919 * @data: start of extension data, variable sized
3920 *
3921 * Note: offsets/lengths are stored in chunks of 8 bytes, this allows
3922 * to use 'u8' types while allowing up to 2kb worth of extension data.
3923 */
3924struct skb_ext {
3925 refcount_t refcnt;
3926 u8 offset[SKB_EXT_NUM]; /* in chunks of 8 bytes */
3927 u8 chunks; /* same */
3928 char data[0] __aligned(8);
3929};
3930
3931void *skb_ext_add(struct sk_buff *skb, enum skb_ext_id id);
3932void __skb_ext_del(struct sk_buff *skb, enum skb_ext_id id);
3933void __skb_ext_put(struct skb_ext *ext);
3934
3935static inline void skb_ext_put(struct sk_buff *skb)
3936{
3937 if (skb->active_extensions)
3938 __skb_ext_put(skb->extensions);
3939}
3940
3941static inline void skb_ext_get(struct sk_buff *skb)
3942{
3943 if (skb->active_extensions) {
3944 struct skb_ext *ext = skb->extensions;
3945
3946 if (ext)
3947 refcount_inc(&ext->refcnt);
3948 }
3949}
3950
3951static inline void __skb_ext_copy(struct sk_buff *dst,
3952 const struct sk_buff *src)
3953{
3954 dst->active_extensions = src->active_extensions;
3955
3956 if (src->active_extensions) {
3957 struct skb_ext *ext = src->extensions;
3958
3959 refcount_inc(&ext->refcnt);
3960 dst->extensions = ext;
3961 }
3962}
3963
3964static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *src)
3965{
3966 skb_ext_put(dst);
3967 __skb_ext_copy(dst, src);
3968}
3969
3970static inline bool __skb_ext_exist(const struct skb_ext *ext, enum skb_ext_id i)
3971{
3972 return !!ext->offset[i];
3973}
3974
3975static inline bool skb_ext_exist(const struct sk_buff *skb, enum skb_ext_id id)
3976{
3977 return skb->active_extensions & (1 << id);
3978}
3979
3980static inline void skb_ext_del(struct sk_buff *skb, enum skb_ext_id id)
3981{
3982 if (skb_ext_exist(skb, id))
3983 __skb_ext_del(skb, id);
3984}
3985
3986static inline void *skb_ext_find(const struct sk_buff *skb, enum skb_ext_id id)
3987{
3988 if (skb_ext_exist(skb, id)) {
3989 struct skb_ext *ext = skb->extensions;
3990
3991 return (void *)ext + (ext->offset[id] << 3);
3992 }
3993
3994 return NULL;
3995}
3996#else
3997static inline void skb_ext_put(struct sk_buff *skb) {}
3998static inline void skb_ext_get(struct sk_buff *skb) {}
3999static inline void skb_ext_del(struct sk_buff *skb, int unused) {}
4000static inline void __skb_ext_copy(struct sk_buff *d, const struct sk_buff *s) {}
4001static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *s) {}
4002#endif /* CONFIG_SKB_EXTENSIONS */
4003
Patrick McHardya193a4a2006-03-20 19:23:05 -08004004static inline void nf_reset(struct sk_buff *skb)
4005{
Yasuyuki Kozakai5f79e0f2007-03-23 11:17:07 -07004006#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Florian Westphala9e419d2017-01-23 18:21:59 +01004007 nf_conntrack_put(skb_nfct(skb));
4008 skb->_nfct = 0;
KOVACS Krisztian2fc72c72011-01-12 20:25:08 +01004009#endif
Pablo Neira Ayuso34666d42014-09-18 11:29:03 +02004010#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
Florian Westphalde8bda12018-12-18 17:15:17 +01004011 skb_ext_del(skb, SKB_EXT_BRIDGE_NF);
Patrick McHardya193a4a2006-03-20 19:23:05 -08004012#endif
4013}
4014
Patrick McHardy124dff02013-04-05 20:42:05 +02004015static inline void nf_reset_trace(struct sk_buff *skb)
4016{
Florian Westphal478b3602014-02-15 23:48:45 +01004017#if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
Gao feng130549fe2013-03-21 19:48:41 +00004018 skb->nf_trace = 0;
4019#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004020}
4021
Ye Yin2b5ec1a2017-10-26 16:57:05 +08004022static inline void ipvs_reset(struct sk_buff *skb)
4023{
4024#if IS_ENABLED(CONFIG_IP_VS)
4025 skb->ipvs_property = 0;
4026#endif
4027}
4028
Florian Westphalde8bda12018-12-18 17:15:17 +01004029/* Note: This doesn't put any conntrack info in dst. */
Eric Dumazetb1937222014-09-28 22:18:47 -07004030static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
4031 bool copy)
Yasuyuki Kozakaiedda5532007-03-14 16:43:37 -07004032{
Yasuyuki Kozakai5f79e0f2007-03-23 11:17:07 -07004033#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Florian Westphala9e419d2017-01-23 18:21:59 +01004034 dst->_nfct = src->_nfct;
4035 nf_conntrack_get(skb_nfct(src));
KOVACS Krisztian2fc72c72011-01-12 20:25:08 +01004036#endif
Florian Westphal478b3602014-02-15 23:48:45 +01004037#if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
Eric Dumazetb1937222014-09-28 22:18:47 -07004038 if (copy)
4039 dst->nf_trace = src->nf_trace;
Florian Westphal478b3602014-02-15 23:48:45 +01004040#endif
Yasuyuki Kozakaiedda5532007-03-14 16:43:37 -07004041}
4042
Yasuyuki Kozakaie7ac05f2007-03-14 16:44:01 -07004043static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
4044{
Yasuyuki Kozakaie7ac05f2007-03-14 16:44:01 -07004045#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
Florian Westphala9e419d2017-01-23 18:21:59 +01004046 nf_conntrack_put(skb_nfct(dst));
KOVACS Krisztian2fc72c72011-01-12 20:25:08 +01004047#endif
Eric Dumazetb1937222014-09-28 22:18:47 -07004048 __nf_copy(dst, src, true);
Yasuyuki Kozakaie7ac05f2007-03-14 16:44:01 -07004049}
4050
James Morris984bc162006-06-09 00:29:17 -07004051#ifdef CONFIG_NETWORK_SECMARK
4052static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
4053{
4054 to->secmark = from->secmark;
4055}
4056
4057static inline void skb_init_secmark(struct sk_buff *skb)
4058{
4059 skb->secmark = 0;
4060}
4061#else
4062static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
4063{ }
4064
4065static inline void skb_init_secmark(struct sk_buff *skb)
4066{ }
4067#endif
4068
Florian Westphal7af8f4c2018-12-18 17:15:19 +01004069static inline int secpath_exists(const struct sk_buff *skb)
4070{
4071#ifdef CONFIG_XFRM
4072 return skb->sp != NULL;
4073#else
4074 return 0;
4075#endif
4076}
4077
Eric W. Biederman574f7192014-04-01 12:20:24 -07004078static inline bool skb_irq_freeable(const struct sk_buff *skb)
4079{
4080 return !skb->destructor &&
Florian Westphal7af8f4c2018-12-18 17:15:19 +01004081 !secpath_exists(skb) &&
Florian Westphalcb9c6832017-01-23 18:21:56 +01004082 !skb_nfct(skb) &&
Eric W. Biederman574f7192014-04-01 12:20:24 -07004083 !skb->_skb_refdst &&
4084 !skb_has_frag_list(skb);
4085}
4086
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004087static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
4088{
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004089 skb->queue_mapping = queue_mapping;
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004090}
4091
Stephen Hemminger92477442009-03-21 13:39:26 -07004092static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
Pavel Emelyanov4e3ab472007-10-21 17:01:29 -07004093{
Pavel Emelyanov4e3ab472007-10-21 17:01:29 -07004094 return skb->queue_mapping;
Pavel Emelyanov4e3ab472007-10-21 17:01:29 -07004095}
4096
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004097static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
4098{
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004099 to->queue_mapping = from->queue_mapping;
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -07004100}
4101
David S. Millerd5a9e242009-01-27 16:22:11 -08004102static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
4103{
4104 skb->queue_mapping = rx_queue + 1;
4105}
4106
Stephen Hemminger92477442009-03-21 13:39:26 -07004107static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
David S. Millerd5a9e242009-01-27 16:22:11 -08004108{
4109 return skb->queue_mapping - 1;
4110}
4111
Stephen Hemminger92477442009-03-21 13:39:26 -07004112static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
David S. Millerd5a9e242009-01-27 16:22:11 -08004113{
Eric Dumazeta02cec22010-09-22 20:43:57 +00004114 return skb->queue_mapping != 0;
David S. Millerd5a9e242009-01-27 16:22:11 -08004115}
4116
Julian Anastasov4ff06202017-02-06 23:14:12 +02004117static inline void skb_set_dst_pending_confirm(struct sk_buff *skb, u32 val)
4118{
4119 skb->dst_pending_confirm = val;
4120}
4121
4122static inline bool skb_get_dst_pending_confirm(const struct sk_buff *skb)
4123{
4124 return skb->dst_pending_confirm != 0;
4125}
4126
Denis Kirjanov0b3d8e02013-10-02 05:58:32 +04004127static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
4128{
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004129#ifdef CONFIG_XFRM
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004130 return skb->sp;
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004131#else
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004132 return NULL;
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004133#endif
Denis Kirjanov0b3d8e02013-10-02 05:58:32 +04004134}
Alexey Dobriyandef8b4f2008-10-28 13:24:06 -07004135
Pravin B Shelar68c33162013-02-14 14:02:41 +00004136/* Keeps track of mac header offset relative to skb->head.
4137 * It is useful for TSO of Tunneling protocol. e.g. GRE.
4138 * For non-tunnel skb it points to skb_mac_header() and for
Eric Dumazet3347c962013-10-19 11:42:56 -07004139 * tunnel skb it points to outer mac header.
4140 * Keeps track of level of encapsulation of network headers.
4141 */
Pravin B Shelar68c33162013-02-14 14:02:41 +00004142struct skb_gso_cb {
Alexander Duyck802ab552016-04-10 21:45:03 -04004143 union {
4144 int mac_offset;
4145 int data_offset;
4146 };
Eric Dumazet3347c962013-10-19 11:42:56 -07004147 int encap_level;
Alexander Duyck76443452016-02-05 15:27:37 -08004148 __wsum csum;
Tom Herbert7e2b10c2014-06-04 17:20:02 -07004149 __u16 csum_start;
Pravin B Shelar68c33162013-02-14 14:02:41 +00004150};
Konstantin Khlebnikov9207f9d2016-01-08 15:21:46 +03004151#define SKB_SGO_CB_OFFSET 32
4152#define SKB_GSO_CB(skb) ((struct skb_gso_cb *)((skb)->cb + SKB_SGO_CB_OFFSET))
Pravin B Shelar68c33162013-02-14 14:02:41 +00004153
4154static inline int skb_tnl_header_len(const struct sk_buff *inner_skb)
4155{
4156 return (skb_mac_header(inner_skb) - inner_skb->head) -
4157 SKB_GSO_CB(inner_skb)->mac_offset;
4158}
4159
Pravin B Shelar1e2bd512013-05-30 06:45:27 +00004160static inline int gso_pskb_expand_head(struct sk_buff *skb, int extra)
4161{
4162 int new_headroom, headroom;
4163 int ret;
4164
4165 headroom = skb_headroom(skb);
4166 ret = pskb_expand_head(skb, extra, 0, GFP_ATOMIC);
4167 if (ret)
4168 return ret;
4169
4170 new_headroom = skb_headroom(skb);
4171 SKB_GSO_CB(skb)->mac_offset += (new_headroom - headroom);
4172 return 0;
4173}
4174
Alexander Duyck08b64fc2016-02-05 15:27:49 -08004175static inline void gso_reset_checksum(struct sk_buff *skb, __wsum res)
4176{
4177 /* Do not update partial checksums if remote checksum is enabled. */
4178 if (skb->remcsum_offload)
4179 return;
4180
4181 SKB_GSO_CB(skb)->csum = res;
4182 SKB_GSO_CB(skb)->csum_start = skb_checksum_start(skb) - skb->head;
4183}
4184
Tom Herbert7e2b10c2014-06-04 17:20:02 -07004185/* Compute the checksum for a gso segment. First compute the checksum value
4186 * from the start of transport header to SKB_GSO_CB(skb)->csum_start, and
4187 * then add in skb->csum (checksum from csum_start to end of packet).
4188 * skb->csum and csum_start are then updated to reflect the checksum of the
4189 * resultant packet starting from the transport header-- the resultant checksum
4190 * is in the res argument (i.e. normally zero or ~ of checksum of a pseudo
4191 * header.
4192 */
4193static inline __sum16 gso_make_checksum(struct sk_buff *skb, __wsum res)
4194{
Alexander Duyck76443452016-02-05 15:27:37 -08004195 unsigned char *csum_start = skb_transport_header(skb);
4196 int plen = (skb->head + SKB_GSO_CB(skb)->csum_start) - csum_start;
4197 __wsum partial = SKB_GSO_CB(skb)->csum;
Tom Herbert7e2b10c2014-06-04 17:20:02 -07004198
Alexander Duyck76443452016-02-05 15:27:37 -08004199 SKB_GSO_CB(skb)->csum = res;
4200 SKB_GSO_CB(skb)->csum_start = csum_start - skb->head;
Tom Herbert7e2b10c2014-06-04 17:20:02 -07004201
Alexander Duyck76443452016-02-05 15:27:37 -08004202 return csum_fold(csum_partial(csum_start, plen, partial));
Tom Herbert7e2b10c2014-06-04 17:20:02 -07004203}
4204
David S. Millerbdcc0922012-03-07 20:53:36 -05004205static inline bool skb_is_gso(const struct sk_buff *skb)
Herbert Xu89114af2006-07-08 13:34:32 -07004206{
4207 return skb_shinfo(skb)->gso_size;
4208}
4209
Eric Dumazet36a8f392013-09-29 01:21:32 -07004210/* Note: Should be called only if skb_is_gso(skb) is true */
David S. Millerbdcc0922012-03-07 20:53:36 -05004211static inline bool skb_is_gso_v6(const struct sk_buff *skb)
Brice Goglineabd7e32007-10-13 12:33:32 +02004212{
4213 return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
4214}
4215
Daniel Axtensd02f51c2018-03-03 03:03:46 +01004216/* Note: Should be called only if skb_is_gso(skb) is true */
4217static inline bool skb_is_gso_sctp(const struct sk_buff *skb)
4218{
4219 return skb_shinfo(skb)->gso_type & SKB_GSO_SCTP;
4220}
4221
Daniel Borkmann5293efe2016-08-18 01:00:39 +02004222static inline void skb_gso_reset(struct sk_buff *skb)
4223{
4224 skb_shinfo(skb)->gso_size = 0;
4225 skb_shinfo(skb)->gso_segs = 0;
4226 skb_shinfo(skb)->gso_type = 0;
4227}
4228
Daniel Axtensd02f51c2018-03-03 03:03:46 +01004229static inline void skb_increase_gso_size(struct skb_shared_info *shinfo,
4230 u16 increment)
4231{
4232 if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
4233 return;
4234 shinfo->gso_size += increment;
4235}
4236
4237static inline void skb_decrease_gso_size(struct skb_shared_info *shinfo,
4238 u16 decrement)
4239{
4240 if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
4241 return;
4242 shinfo->gso_size -= decrement;
4243}
4244
Joe Perches7965bd42013-09-26 14:48:15 -07004245void __skb_warn_lro_forwarding(const struct sk_buff *skb);
Ben Hutchings4497b072008-06-19 16:22:28 -07004246
4247static inline bool skb_warn_if_lro(const struct sk_buff *skb)
4248{
4249 /* LRO sets gso_size but not gso_type, whereas if GSO is really
4250 * wanted then gso_type will be set. */
Eric Dumazet05bdd2f2011-10-20 17:45:43 -04004251 const struct skb_shared_info *shinfo = skb_shinfo(skb);
4252
Alexander Duyckb78462e2010-06-02 12:24:37 +00004253 if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
4254 unlikely(shinfo->gso_type == 0)) {
Ben Hutchings4497b072008-06-19 16:22:28 -07004255 __skb_warn_lro_forwarding(skb);
4256 return true;
4257 }
4258 return false;
4259}
4260
Herbert Xu35fc92a2007-03-26 23:22:20 -07004261static inline void skb_forward_csum(struct sk_buff *skb)
4262{
4263 /* Unfortunately we don't support this one. Any brave souls? */
4264 if (skb->ip_summed == CHECKSUM_COMPLETE)
4265 skb->ip_summed = CHECKSUM_NONE;
4266}
4267
Eric Dumazetbc8acf22010-09-02 13:07:41 -07004268/**
4269 * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
4270 * @skb: skb to check
4271 *
4272 * fresh skbs have their ip_summed set to CHECKSUM_NONE.
4273 * Instead of forcing ip_summed to CHECKSUM_NONE, we can
4274 * use this helper, to document places where we make this assertion.
4275 */
Eric Dumazet05bdd2f2011-10-20 17:45:43 -04004276static inline void skb_checksum_none_assert(const struct sk_buff *skb)
Eric Dumazetbc8acf22010-09-02 13:07:41 -07004277{
4278#ifdef DEBUG
4279 BUG_ON(skb->ip_summed != CHECKSUM_NONE);
4280#endif
4281}
4282
Rusty Russellf35d9d82008-02-04 23:49:54 -05004283bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
Shirley Maa6686f22011-07-06 12:22:12 +00004284
Paul Durranted1f50c2014-01-09 10:02:46 +00004285int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
Linus Lüssing9afd85c2015-05-02 14:01:07 +02004286struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
4287 unsigned int transport_len,
4288 __sum16(*skb_chkf)(struct sk_buff *skb));
Paul Durranted1f50c2014-01-09 10:02:46 +00004289
Alexander Duyck3a7c1ee42012-05-03 01:09:42 +00004290/**
4291 * skb_head_is_locked - Determine if the skb->head is locked down
4292 * @skb: skb to check
4293 *
4294 * The head on skbs build around a head frag can be removed if they are
4295 * not cloned. This function returns true if the skb head is locked down
4296 * due to either being allocated via kmalloc, or by being a clone with
4297 * multiple references to the head.
4298 */
4299static inline bool skb_head_is_locked(const struct sk_buff *skb)
4300{
4301 return !skb->head_frag || skb_cloned(skb);
4302}
Florian Westphalfe6cc552014-02-13 23:09:12 +01004303
Edward Cree179bc672016-02-11 20:48:04 +00004304/* Local Checksum Offload.
4305 * Compute outer checksum based on the assumption that the
4306 * inner checksum will be offloaded later.
Edward Creee8ae7b02016-02-11 21:03:37 +00004307 * See Documentation/networking/checksum-offloads.txt for
4308 * explanation of how this works.
Edward Cree179bc672016-02-11 20:48:04 +00004309 * Fill in outer checksum adjustment (e.g. with sum of outer
4310 * pseudo-header) before calling.
4311 * Also ensure that inner checksum is in linear data area.
4312 */
4313static inline __wsum lco_csum(struct sk_buff *skb)
4314{
Alexander Duyck9e74a6d2016-02-17 11:23:55 -08004315 unsigned char *csum_start = skb_checksum_start(skb);
4316 unsigned char *l4_hdr = skb_transport_header(skb);
4317 __wsum partial;
Edward Cree179bc672016-02-11 20:48:04 +00004318
4319 /* Start with complement of inner checksum adjustment */
Alexander Duyck9e74a6d2016-02-17 11:23:55 -08004320 partial = ~csum_unfold(*(__force __sum16 *)(csum_start +
4321 skb->csum_offset));
4322
Edward Cree179bc672016-02-11 20:48:04 +00004323 /* Add in checksum of our headers (incl. outer checksum
Alexander Duyck9e74a6d2016-02-17 11:23:55 -08004324 * adjustment filled in by caller) and return result.
Edward Cree179bc672016-02-11 20:48:04 +00004325 */
Alexander Duyck9e74a6d2016-02-17 11:23:55 -08004326 return csum_partial(l4_hdr, csum_start - l4_hdr, partial);
Edward Cree179bc672016-02-11 20:48:04 +00004327}
4328
Linus Torvalds1da177e2005-04-16 15:20:36 -07004329#endif /* __KERNEL__ */
4330#endif /* _LINUX_SKBUFF_H */