xref: /linux/include/linux/skbuff.h (revision 546b928da0427b0d6c663cbb992bd7bfa9ac7971)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *	Definitions for the 'struct sk_buff' memory handlers.
4  *
5  *	Authors:
6  *		Alan Cox, <gw4pts@gw4pts.ampr.org>
7  *		Florian La Roche, <rzsfl@rz.uni-sb.de>
8  */
9 
10 #ifndef _LINUX_SKBUFF_H
11 #define _LINUX_SKBUFF_H
12 
13 #include <linux/kernel.h>
14 #include <linux/compiler.h>
15 #include <linux/time.h>
16 #include <linux/bug.h>
17 #include <linux/bvec.h>
18 #include <linux/cache.h>
19 #include <linux/rbtree.h>
20 #include <linux/socket.h>
21 #include <linux/refcount.h>
22 
23 #include <linux/atomic.h>
24 #include <asm/types.h>
25 #include <linux/spinlock.h>
26 #include <net/checksum.h>
27 #include <linux/rcupdate.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/netdev_features.h>
30 #include <net/flow_dissector.h>
31 #include <linux/in6.h>
32 #include <linux/if_packet.h>
33 #include <linux/llist.h>
34 #include <linux/page_frag_cache.h>
35 #include <net/flow.h>
36 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
37 #include <linux/netfilter/nf_conntrack_common.h>
38 #endif
39 #include <net/net_debug.h>
40 #include <net/dropreason-core.h>
41 #include <net/netmem.h>
42 
43 /**
44  * DOC: skb checksums
45  *
46  * The interface for checksum offload between the stack and networking drivers
47  * is as follows...
48  *
49  * IP checksum related features
50  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51  *
52  * Drivers advertise checksum offload capabilities in the features of a device.
53  * From the stack's point of view these are capabilities offered by the driver.
54  * A driver typically only advertises features that it is capable of offloading
55  * to its device.
56  *
57  * .. flat-table:: Checksum related device features
58  *   :widths: 1 10
59  *
60  *   * - %NETIF_F_HW_CSUM
61  *     - The driver (or its device) is able to compute one
62  *	 IP (one's complement) checksum for any combination
63  *	 of protocols or protocol layering. The checksum is
64  *	 computed and set in a packet per the CHECKSUM_PARTIAL
65  *	 interface (see below).
66  *
67  *   * - %NETIF_F_IP_CSUM
68  *     - Driver (device) is only able to checksum plain
69  *	 TCP or UDP packets over IPv4. These are specifically
70  *	 unencapsulated packets of the form IPv4|TCP or
71  *	 IPv4|UDP where the Protocol field in the IPv4 header
72  *	 is TCP or UDP. The IPv4 header may contain IP options.
73  *	 This feature cannot be set in features for a device
74  *	 with NETIF_F_HW_CSUM also set. This feature is being
75  *	 DEPRECATED (see below).
76  *
77  *   * - %NETIF_F_IPV6_CSUM
78  *     - Driver (device) is only able to checksum plain
79  *	 TCP or UDP packets over IPv6. These are specifically
80  *	 unencapsulated packets of the form IPv6|TCP or
81  *	 IPv6|UDP where the Next Header field in the IPv6
82  *	 header is either TCP or UDP. IPv6 extension headers
83  *	 are not supported with this feature. This feature
84  *	 cannot be set in features for a device with
85  *	 NETIF_F_HW_CSUM also set. This feature is being
86  *	 DEPRECATED (see below).
87  *
88  *   * - %NETIF_F_RXCSUM
89  *     - Driver (device) performs receive checksum offload.
90  *	 This flag is only used to disable the RX checksum
91  *	 feature for a device. The stack will accept receive
92  *	 checksum indication in packets received on a device
93  *	 regardless of whether NETIF_F_RXCSUM is set.
94  *
95  * Checksumming of received packets by device
96  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97  *
98  * Indication of checksum verification is set in &sk_buff.ip_summed.
99  * Possible values are:
100  *
101  * - %CHECKSUM_NONE
102  *
103  *   Device did not checksum this packet e.g. due to lack of capabilities.
104  *   The packet contains full (though not verified) checksum in packet but
105  *   not in skb->csum. Thus, skb->csum is undefined in this case.
106  *
107  * - %CHECKSUM_UNNECESSARY
108  *
109  *   The hardware you're dealing with doesn't calculate the full checksum
110  *   (as in %CHECKSUM_COMPLETE), but it does parse headers and verify checksums
111  *   for specific protocols. For such packets it will set %CHECKSUM_UNNECESSARY
112  *   if their checksums are okay. &sk_buff.csum is still undefined in this case
113  *   though. A driver or device must never modify the checksum field in the
114  *   packet even if checksum is verified.
115  *
116  *   %CHECKSUM_UNNECESSARY is applicable to following protocols:
117  *
118  *     - TCP: IPv6 and IPv4.
119  *     - UDP: IPv4 and IPv6. A device may apply CHECKSUM_UNNECESSARY to a
120  *       zero UDP checksum for either IPv4 or IPv6, the networking stack
121  *       may perform further validation in this case.
122  *     - GRE: only if the checksum is present in the header.
123  *     - SCTP: indicates the CRC in SCTP header has been validated.
124  *     - FCOE: indicates the CRC in FC frame has been validated.
125  *
126  *   &sk_buff.csum_level indicates the number of consecutive checksums found in
127  *   the packet minus one that have been verified as %CHECKSUM_UNNECESSARY.
128  *   For instance if a device receives an IPv6->UDP->GRE->IPv4->TCP packet
129  *   and a device is able to verify the checksums for UDP (possibly zero),
130  *   GRE (checksum flag is set) and TCP, &sk_buff.csum_level would be set to
131  *   two. If the device were only able to verify the UDP checksum and not
132  *   GRE, either because it doesn't support GRE checksum or because GRE
133  *   checksum is bad, skb->csum_level would be set to zero (TCP checksum is
134  *   not considered in this case).
135  *
136  * - %CHECKSUM_COMPLETE
137  *
138  *   This is the most generic way. The device supplied checksum of the _whole_
139  *   packet as seen by netif_rx() and fills in &sk_buff.csum. This means the
140  *   hardware doesn't need to parse L3/L4 headers to implement this.
141  *
142  *   Notes:
143  *
144  *   - Even if device supports only some protocols, but is able to produce
145  *     skb->csum, it MUST use CHECKSUM_COMPLETE, not CHECKSUM_UNNECESSARY.
146  *   - CHECKSUM_COMPLETE is not applicable to SCTP and FCoE protocols.
147  *
148  * - %CHECKSUM_PARTIAL
149  *
150  *   A checksum is set up to be offloaded to a device as described in the
151  *   output description for CHECKSUM_PARTIAL. This may occur on a packet
152  *   received directly from another Linux OS, e.g., a virtualized Linux kernel
153  *   on the same host, or it may be set in the input path in GRO or remote
154  *   checksum offload. For the purposes of checksum verification, the checksum
155  *   referred to by skb->csum_start + skb->csum_offset and any preceding
156  *   checksums in the packet are considered verified. Any checksums in the
157  *   packet that are after the checksum being offloaded are not considered to
158  *   be verified.
159  *
160  * Checksumming on transmit for non-GSO
161  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162  *
163  * The stack requests checksum offload in the &sk_buff.ip_summed for a packet.
164  * Values are:
165  *
166  * - %CHECKSUM_PARTIAL
167  *
168  *   The driver is required to checksum the packet as seen by hard_start_xmit()
169  *   from &sk_buff.csum_start up to the end, and to record/write the checksum at
170  *   offset &sk_buff.csum_start + &sk_buff.csum_offset.
171  *   A driver may verify that the
172  *   csum_start and csum_offset values are valid values given the length and
173  *   offset of the packet, but it should not attempt to validate that the
174  *   checksum refers to a legitimate transport layer checksum -- it is the
175  *   purview of the stack to validate that csum_start and csum_offset are set
176  *   correctly.
177  *
178  *   When the stack requests checksum offload for a packet, the driver MUST
179  *   ensure that the checksum is set correctly. A driver can either offload the
180  *   checksum calculation to the device, or call skb_checksum_help (in the case
181  *   that the device does not support offload for a particular checksum).
182  *
183  *   %NETIF_F_IP_CSUM and %NETIF_F_IPV6_CSUM are being deprecated in favor of
184  *   %NETIF_F_HW_CSUM. New devices should use %NETIF_F_HW_CSUM to indicate
185  *   checksum offload capability.
186  *   skb_csum_hwoffload_help() can be called to resolve %CHECKSUM_PARTIAL based
187  *   on network device checksumming capabilities: if a packet does not match
188  *   them, skb_checksum_help() or skb_crc32c_help() (depending on the value of
189  *   &sk_buff.csum_not_inet, see :ref:`crc`)
190  *   is called to resolve the checksum.
191  *
192  * - %CHECKSUM_NONE
193  *
194  *   The skb was already checksummed by the protocol, or a checksum is not
195  *   required.
196  *
197  * - %CHECKSUM_UNNECESSARY
198  *
199  *   This has the same meaning as CHECKSUM_NONE for checksum offload on
200  *   output.
201  *
202  * - %CHECKSUM_COMPLETE
203  *
204  *   Not used in checksum output. If a driver observes a packet with this value
205  *   set in skbuff, it should treat the packet as if %CHECKSUM_NONE were set.
206  *
207  * .. _crc:
208  *
209  * Non-IP checksum (CRC) offloads
210  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211  *
212  * .. flat-table::
213  *   :widths: 1 10
214  *
215  *   * - %NETIF_F_SCTP_CRC
216  *     - This feature indicates that a device is capable of
217  *	 offloading the SCTP CRC in a packet. To perform this offload the stack
218  *	 will set csum_start and csum_offset accordingly, set ip_summed to
219  *	 %CHECKSUM_PARTIAL and set csum_not_inet to 1, to provide an indication
220  *	 in the skbuff that the %CHECKSUM_PARTIAL refers to CRC32c.
221  *	 A driver that supports both IP checksum offload and SCTP CRC32c offload
222  *	 must verify which offload is configured for a packet by testing the
223  *	 value of &sk_buff.csum_not_inet; skb_crc32c_csum_help() is provided to
224  *	 resolve %CHECKSUM_PARTIAL on skbs where csum_not_inet is set to 1.
225  *
226  *   * - %NETIF_F_FCOE_CRC
227  *     - This feature indicates that a device is capable of offloading the FCOE
228  *	 CRC in a packet. To perform this offload the stack will set ip_summed
229  *	 to %CHECKSUM_PARTIAL and set csum_start and csum_offset
230  *	 accordingly. Note that there is no indication in the skbuff that the
231  *	 %CHECKSUM_PARTIAL refers to an FCOE checksum, so a driver that supports
232  *	 both IP checksum offload and FCOE CRC offload must verify which offload
233  *	 is configured for a packet, presumably by inspecting packet headers.
234  *
235  * Checksumming on output with GSO
236  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237  *
238  * In the case of a GSO packet (skb_is_gso() is true), checksum offload
239  * is implied by the SKB_GSO_* flags in gso_type. Most obviously, if the
240  * gso_type is %SKB_GSO_TCPV4 or %SKB_GSO_TCPV6, TCP checksum offload as
241  * part of the GSO operation is implied. If a checksum is being offloaded
242  * with GSO then ip_summed is %CHECKSUM_PARTIAL, and both csum_start and
243  * csum_offset are set to refer to the outermost checksum being offloaded
244  * (two offloaded checksums are possible with UDP encapsulation).
245  */
246 
247 /* Don't change this without changing skb_csum_unnecessary! */
248 #define CHECKSUM_NONE		0
249 #define CHECKSUM_UNNECESSARY	1
250 #define CHECKSUM_COMPLETE	2
251 #define CHECKSUM_PARTIAL	3
252 
253 /* Maximum value in skb->csum_level */
254 #define SKB_MAX_CSUM_LEVEL	3
255 
256 #define SKB_DATA_ALIGN(X)	ALIGN(X, SMP_CACHE_BYTES)
257 #define SKB_WITH_OVERHEAD(X)	\
258 	((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
259 
260 /* For X bytes available in skb->head, what is the minimal
261  * allocation needed, knowing struct skb_shared_info needs
262  * to be aligned.
263  */
264 #define SKB_HEAD_ALIGN(X) (SKB_DATA_ALIGN(X) + \
265 	SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
266 
267 #define SKB_MAX_ORDER(X, ORDER) \
268 	SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
269 #define SKB_MAX_HEAD(X)		(SKB_MAX_ORDER((X), 0))
270 #define SKB_MAX_ALLOC		(SKB_MAX_ORDER(0, 2))
271 
272 /* return minimum truesize of one skb containing X bytes of data */
273 #define SKB_TRUESIZE(X) ((X) +						\
274 			 SKB_DATA_ALIGN(sizeof(struct sk_buff)) +	\
275 			 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
276 
277 struct net_device;
278 struct scatterlist;
279 struct pipe_inode_info;
280 struct iov_iter;
281 struct napi_struct;
282 struct bpf_prog;
283 union bpf_attr;
284 struct skb_ext;
285 struct ts_config;
286 
287 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
288 struct nf_bridge_info {
289 	enum {
290 		BRNF_PROTO_UNCHANGED,
291 		BRNF_PROTO_8021Q,
292 		BRNF_PROTO_PPPOE
293 	} orig_proto:8;
294 	u8			pkt_otherhost:1;
295 	u8			in_prerouting:1;
296 	u8			bridged_dnat:1;
297 	u8			sabotage_in_done:1;
298 	__u16			frag_max_size;
299 	int			physinif;
300 
301 	/* always valid & non-NULL from FORWARD on, for physdev match */
302 	struct net_device	*physoutdev;
303 	union {
304 		/* prerouting: detect dnat in orig/reply direction */
305 		__be32          ipv4_daddr;
306 		struct in6_addr ipv6_daddr;
307 
308 		/* after prerouting + nat detected: store original source
309 		 * mac since neigh resolution overwrites it, only used while
310 		 * skb is out in neigh layer.
311 		 */
312 		char neigh_header[8];
313 	};
314 };
315 #endif
316 
317 #if IS_ENABLED(CONFIG_NET_TC_SKB_EXT)
318 /* Chain in tc_skb_ext will be used to share the tc chain with
319  * ovs recirc_id. It will be set to the current chain by tc
320  * and read by ovs to recirc_id.
321  */
322 struct tc_skb_ext {
323 	union {
324 		u64 act_miss_cookie;
325 		__u32 chain;
326 	};
327 	__u16 mru;
328 	__u16 zone;
329 	u8 post_ct:1;
330 	u8 post_ct_snat:1;
331 	u8 post_ct_dnat:1;
332 	u8 act_miss:1; /* Set if act_miss_cookie is used */
333 	u8 l2_miss:1; /* Set by bridge upon FDB or MDB miss */
334 };
335 #endif
336 
337 struct sk_buff_head {
338 	/* These two members must be first to match sk_buff. */
339 	struct_group_tagged(sk_buff_list, list,
340 		struct sk_buff	*next;
341 		struct sk_buff	*prev;
342 	);
343 
344 	__u32		qlen;
345 	spinlock_t	lock;
346 };
347 
348 struct sk_buff;
349 
350 #ifndef CONFIG_MAX_SKB_FRAGS
351 # define CONFIG_MAX_SKB_FRAGS 17
352 #endif
353 
354 #define MAX_SKB_FRAGS CONFIG_MAX_SKB_FRAGS
355 
356 /* Set skb_shinfo(skb)->gso_size to this in case you want skb_segment to
357  * segment using its current segmentation instead.
358  */
359 #define GSO_BY_FRAGS	0xFFFF
360 
361 typedef struct skb_frag {
362 	netmem_ref netmem;
363 	unsigned int len;
364 	unsigned int offset;
365 } skb_frag_t;
366 
367 /**
368  * skb_frag_size() - Returns the size of a skb fragment
369  * @frag: skb fragment
370  */
skb_frag_size(const skb_frag_t * frag)371 static inline unsigned int skb_frag_size(const skb_frag_t *frag)
372 {
373 	return frag->len;
374 }
375 
376 /**
377  * skb_frag_size_set() - Sets the size of a skb fragment
378  * @frag: skb fragment
379  * @size: size of fragment
380  */
skb_frag_size_set(skb_frag_t * frag,unsigned int size)381 static inline void skb_frag_size_set(skb_frag_t *frag, unsigned int size)
382 {
383 	frag->len = size;
384 }
385 
386 /**
387  * skb_frag_size_add() - Increments the size of a skb fragment by @delta
388  * @frag: skb fragment
389  * @delta: value to add
390  */
skb_frag_size_add(skb_frag_t * frag,int delta)391 static inline void skb_frag_size_add(skb_frag_t *frag, int delta)
392 {
393 	frag->len += delta;
394 }
395 
396 /**
397  * skb_frag_size_sub() - Decrements the size of a skb fragment by @delta
398  * @frag: skb fragment
399  * @delta: value to subtract
400  */
skb_frag_size_sub(skb_frag_t * frag,int delta)401 static inline void skb_frag_size_sub(skb_frag_t *frag, int delta)
402 {
403 	frag->len -= delta;
404 }
405 
406 /**
407  * skb_frag_must_loop - Test if %p is a high memory page
408  * @p: fragment's page
409  */
skb_frag_must_loop(struct page * p)410 static inline bool skb_frag_must_loop(struct page *p)
411 {
412 #if defined(CONFIG_HIGHMEM)
413 	if (IS_ENABLED(CONFIG_DEBUG_KMAP_LOCAL_FORCE_MAP) || PageHighMem(p))
414 		return true;
415 #endif
416 	return false;
417 }
418 
419 /**
420  *	skb_frag_foreach_page - loop over pages in a fragment
421  *
422  *	@f:		skb frag to operate on
423  *	@f_off:		offset from start of f->netmem
424  *	@f_len:		length from f_off to loop over
425  *	@p:		(temp var) current page
426  *	@p_off:		(temp var) offset from start of current page,
427  *	                           non-zero only on first page.
428  *	@p_len:		(temp var) length in current page,
429  *				   < PAGE_SIZE only on first and last page.
430  *	@copied:	(temp var) length so far, excluding current p_len.
431  *
432  *	A fragment can hold a compound page, in which case per-page
433  *	operations, notably kmap_atomic, must be called for each
434  *	regular page.
435  */
436 #define skb_frag_foreach_page(f, f_off, f_len, p, p_off, p_len, copied)	\
437 	for (p = skb_frag_page(f) + ((f_off) >> PAGE_SHIFT),		\
438 	     p_off = (f_off) & (PAGE_SIZE - 1),				\
439 	     p_len = skb_frag_must_loop(p) ?				\
440 	     min_t(u32, f_len, PAGE_SIZE - p_off) : f_len,		\
441 	     copied = 0;						\
442 	     copied < f_len;						\
443 	     copied += p_len, p++, p_off = 0,				\
444 	     p_len = min_t(u32, f_len - copied, PAGE_SIZE))		\
445 
446 /**
447  * struct skb_shared_hwtstamps - hardware time stamps
448  * @hwtstamp:		hardware time stamp transformed into duration
449  *			since arbitrary point in time
450  * @netdev_data:	address/cookie of network device driver used as
451  *			reference to actual hardware time stamp
452  *
453  * Software time stamps generated by ktime_get_real() are stored in
454  * skb->tstamp.
455  *
456  * hwtstamps can only be compared against other hwtstamps from
457  * the same device.
458  *
459  * This structure is attached to packets as part of the
460  * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
461  */
462 struct skb_shared_hwtstamps {
463 	union {
464 		ktime_t	hwtstamp;
465 		void *netdev_data;
466 	};
467 };
468 
469 /* Definitions for tx_flags in struct skb_shared_info */
470 enum {
471 	/* generate hardware time stamp */
472 	SKBTX_HW_TSTAMP_NOBPF = 1 << 0,
473 
474 	/* generate software time stamp when queueing packet to NIC */
475 	SKBTX_SW_TSTAMP = 1 << 1,
476 
477 	/* device driver is going to provide hardware time stamp */
478 	SKBTX_IN_PROGRESS = 1 << 2,
479 
480 	/* generate software time stamp on packet tx completion */
481 	SKBTX_COMPLETION_TSTAMP = 1 << 3,
482 
483 	/* determine hardware time stamp based on time or cycles */
484 	SKBTX_HW_TSTAMP_NETDEV = 1 << 5,
485 
486 	/* generate software time stamp when entering packet scheduling */
487 	SKBTX_SCHED_TSTAMP = 1 << 6,
488 
489 	/* used for bpf extension when a bpf program is loaded */
490 	SKBTX_BPF = 1 << 7,
491 };
492 
493 #define SKBTX_HW_TSTAMP		(SKBTX_HW_TSTAMP_NOBPF | SKBTX_BPF)
494 
495 #define SKBTX_ANY_SW_TSTAMP	(SKBTX_SW_TSTAMP    | \
496 				 SKBTX_SCHED_TSTAMP | \
497 				 SKBTX_BPF          | \
498 				 SKBTX_COMPLETION_TSTAMP)
499 #define SKBTX_ANY_TSTAMP	(SKBTX_HW_TSTAMP | \
500 				 SKBTX_ANY_SW_TSTAMP)
501 
502 /* Definitions for flags in struct skb_shared_info */
503 enum {
504 	/* use zcopy routines */
505 	SKBFL_ZEROCOPY_ENABLE = BIT(0),
506 
507 	/* This indicates at least one fragment might be overwritten
508 	 * (as in vmsplice(), sendfile() ...)
509 	 * If we need to compute a TX checksum, we'll need to copy
510 	 * all frags to avoid possible bad checksum
511 	 */
512 	SKBFL_SHARED_FRAG = BIT(1),
513 
514 	/* segment contains only zerocopy data and should not be
515 	 * charged to the kernel memory.
516 	 */
517 	SKBFL_PURE_ZEROCOPY = BIT(2),
518 
519 	SKBFL_DONT_ORPHAN = BIT(3),
520 
521 	/* page references are managed by the ubuf_info, so it's safe to
522 	 * use frags only up until ubuf_info is released
523 	 */
524 	SKBFL_MANAGED_FRAG_REFS = BIT(4),
525 };
526 
527 #define SKBFL_ZEROCOPY_FRAG	(SKBFL_ZEROCOPY_ENABLE | SKBFL_SHARED_FRAG)
528 #define SKBFL_ALL_ZEROCOPY	(SKBFL_ZEROCOPY_FRAG | SKBFL_PURE_ZEROCOPY | \
529 				 SKBFL_DONT_ORPHAN | SKBFL_MANAGED_FRAG_REFS)
530 
531 struct ubuf_info_ops {
532 	void (*complete)(struct sk_buff *, struct ubuf_info *,
533 			 bool zerocopy_success);
534 	/* has to be compatible with skb_zcopy_set() */
535 	int (*link_skb)(struct sk_buff *skb, struct ubuf_info *uarg);
536 };
537 
538 /*
539  * The callback notifies userspace to release buffers when skb DMA is done in
540  * lower device, the skb last reference should be 0 when calling this.
541  * The zerocopy_success argument is true if zero copy transmit occurred,
542  * false on data copy or out of memory error caused by data copy attempt.
543  * The ctx field is used to track device context.
544  * The desc field is used to track userspace buffer index.
545  */
546 struct ubuf_info {
547 	const struct ubuf_info_ops *ops;
548 	refcount_t refcnt;
549 	u8 flags;
550 };
551 
552 struct ubuf_info_msgzc {
553 	struct ubuf_info ubuf;
554 
555 	union {
556 		struct {
557 			unsigned long desc;
558 			void *ctx;
559 		};
560 		struct {
561 			u32 id;
562 			u16 len;
563 			u16 zerocopy:1;
564 			u32 bytelen;
565 		};
566 	};
567 
568 	struct mmpin {
569 		struct user_struct *user;
570 		unsigned int num_pg;
571 	} mmp;
572 };
573 
574 #define skb_uarg(SKB)	((struct ubuf_info *)(skb_shinfo(SKB)->destructor_arg))
575 #define uarg_to_msgzc(ubuf_ptr)	container_of((ubuf_ptr), struct ubuf_info_msgzc, \
576 					     ubuf)
577 
578 int mm_account_pinned_pages(struct mmpin *mmp, size_t size);
579 void mm_unaccount_pinned_pages(struct mmpin *mmp);
580 
581 /* Preserve some data across TX submission and completion.
582  *
583  * Note, this state is stored in the driver. Extending the layout
584  * might need some special care.
585  */
586 struct xsk_tx_metadata_compl {
587 	__u64 *tx_timestamp;
588 };
589 
590 /* This data is invariant across clones and lives at
591  * the end of the header data, ie. at skb->end.
592  */
593 struct skb_shared_info {
594 	__u8		flags;
595 	__u8		meta_len;
596 	__u8		nr_frags;
597 	__u8		tx_flags;
598 	unsigned short	gso_size;
599 	/* Warning: this field is not always filled in (UFO)! */
600 	unsigned short	gso_segs;
601 	struct sk_buff	*frag_list;
602 	union {
603 		struct skb_shared_hwtstamps hwtstamps;
604 		struct xsk_tx_metadata_compl xsk_meta;
605 	};
606 	unsigned int	gso_type;
607 	u32		tskey;
608 
609 	/*
610 	 * Warning : all fields before dataref are cleared in __alloc_skb()
611 	 */
612 	atomic_t	dataref;
613 
614 	union {
615 		struct {
616 			u32		xdp_frags_size;
617 			u32		xdp_frags_truesize;
618 		};
619 
620 		/*
621 		 * Intermediate layers must ensure that destructor_arg
622 		 * remains valid until skb destructor.
623 		 */
624 		void		*destructor_arg;
625 	};
626 
627 	/* must be last field, see pskb_expand_head() */
628 	skb_frag_t	frags[MAX_SKB_FRAGS];
629 };
630 
631 /**
632  * DOC: dataref and headerless skbs
633  *
634  * Transport layers send out clones of payload skbs they hold for
635  * retransmissions. To allow lower layers of the stack to prepend their headers
636  * we split &skb_shared_info.dataref into two halves.
637  * The lower 16 bits count the overall number of references.
638  * The higher 16 bits indicate how many of the references are payload-only.
639  * skb_header_cloned() checks if skb is allowed to add / write the headers.
640  *
641  * The creator of the skb (e.g. TCP) marks its skb as &sk_buff.nohdr
642  * (via __skb_header_release()). Any clone created from marked skb will get
643  * &sk_buff.hdr_len populated with the available headroom.
644  * If there's the only clone in existence it's able to modify the headroom
645  * at will. The sequence of calls inside the transport layer is::
646  *
647  *  <alloc skb>
648  *  skb_reserve()
649  *  __skb_header_release()
650  *  skb_clone()
651  *  // send the clone down the stack
652  *
653  * This is not a very generic construct and it depends on the transport layers
654  * doing the right thing. In practice there's usually only one payload-only skb.
655  * Having multiple payload-only skbs with different lengths of hdr_len is not
656  * possible. The payload-only skbs should never leave their owner.
657  */
658 #define SKB_DATAREF_SHIFT 16
659 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
660 
661 
662 enum {
663 	SKB_FCLONE_UNAVAILABLE,	/* skb has no fclone (from head_cache) */
664 	SKB_FCLONE_ORIG,	/* orig skb (from fclone_cache) */
665 	SKB_FCLONE_CLONE,	/* companion fclone skb (from fclone_cache) */
666 };
667 
668 enum {
669 	SKB_GSO_TCPV4 = 1 << 0,
670 
671 	/* This indicates the skb is from an untrusted source. */
672 	SKB_GSO_DODGY = 1 << 1,
673 
674 	/* This indicates the tcp segment has CWR set. */
675 	SKB_GSO_TCP_ECN = 1 << 2,
676 
677 	__SKB_GSO_TCP_FIXEDID = 1 << 3,
678 
679 	SKB_GSO_TCPV6 = 1 << 4,
680 
681 	SKB_GSO_FCOE = 1 << 5,
682 
683 	SKB_GSO_GRE = 1 << 6,
684 
685 	SKB_GSO_GRE_CSUM = 1 << 7,
686 
687 	SKB_GSO_IPXIP4 = 1 << 8,
688 
689 	SKB_GSO_IPXIP6 = 1 << 9,
690 
691 	SKB_GSO_UDP_TUNNEL = 1 << 10,
692 
693 	SKB_GSO_UDP_TUNNEL_CSUM = 1 << 11,
694 
695 	SKB_GSO_PARTIAL = 1 << 12,
696 
697 	SKB_GSO_TUNNEL_REMCSUM = 1 << 13,
698 
699 	SKB_GSO_SCTP = 1 << 14,
700 
701 	SKB_GSO_ESP = 1 << 15,
702 
703 	SKB_GSO_UDP = 1 << 16,
704 
705 	SKB_GSO_UDP_L4 = 1 << 17,
706 
707 	SKB_GSO_FRAGLIST = 1 << 18,
708 
709 	SKB_GSO_TCP_ACCECN = 1 << 19,
710 
711 	/* These indirectly map onto the same netdev feature.
712 	 * If NETIF_F_TSO_MANGLEID is set it may mangle both inner and outer IDs.
713 	 */
714 	SKB_GSO_TCP_FIXEDID = 1 << 30,
715 	SKB_GSO_TCP_FIXEDID_INNER = 1 << 31,
716 };
717 
718 #if BITS_PER_LONG > 32
719 #define NET_SKBUFF_DATA_USES_OFFSET 1
720 #endif
721 
722 #ifdef NET_SKBUFF_DATA_USES_OFFSET
723 typedef unsigned int sk_buff_data_t;
724 #else
725 typedef unsigned char *sk_buff_data_t;
726 #endif
727 
728 enum skb_tstamp_type {
729 	SKB_CLOCK_REALTIME,
730 	SKB_CLOCK_MONOTONIC,
731 	SKB_CLOCK_TAI,
732 	__SKB_CLOCK_MAX = SKB_CLOCK_TAI,
733 };
734 
735 /**
736  * DOC: Basic sk_buff geometry
737  *
738  * struct sk_buff itself is a metadata structure and does not hold any packet
739  * data. All the data is held in associated buffers.
740  *
741  * &sk_buff.head points to the main "head" buffer. The head buffer is divided
742  * into two parts:
743  *
744  *  - data buffer, containing headers and sometimes payload;
745  *    this is the part of the skb operated on by the common helpers
746  *    such as skb_put() or skb_pull();
747  *  - shared info (struct skb_shared_info) which holds an array of pointers
748  *    to read-only data in the (page, offset, length) format.
749  *
750  * Optionally &skb_shared_info.frag_list may point to another skb.
751  *
752  * Basic diagram may look like this::
753  *
754  *                                  ---------------
755  *                                 | sk_buff       |
756  *                                  ---------------
757  *     ,---------------------------  + head
758  *    /          ,-----------------  + data
759  *   /          /      ,-----------  + tail
760  *  |          |      |            , + end
761  *  |          |      |           |
762  *  v          v      v           v
763  *   -----------------------------------------------
764  *  | headroom | data |  tailroom | skb_shared_info |
765  *   -----------------------------------------------
766  *                                 + [page frag]
767  *                                 + [page frag]
768  *                                 + [page frag]
769  *                                 + [page frag]       ---------
770  *                                 + frag_list    --> | sk_buff |
771  *                                                     ---------
772  *
773  */
774 
775 /**
776  *	struct sk_buff - socket buffer
777  *	@next: Next buffer in list
778  *	@prev: Previous buffer in list
779  *	@tstamp: Time we arrived/left
780  *	@skb_mstamp_ns: (aka @tstamp) earliest departure time; start point
781  *		for retransmit timer
782  *	@rbnode: RB tree node, alternative to next/prev for netem/tcp
783  *	@list: queue head
784  *	@ll_node: anchor in an llist (eg socket defer_list)
785  *	@sk: Socket we are owned by
786  *	@dev: Device we arrived on/are leaving by
787  *	@dev_scratch: (aka @dev) alternate use of @dev when @dev would be %NULL
788  *	@cb: Control buffer. Free for use by every layer. Put private vars here
789  *	@_skb_refdst: destination entry (with norefcount bit)
790  *	@len: Length of actual data
791  *	@data_len: Data length
792  *	@mac_len: Length of link layer header
793  *	@hdr_len: writable header length of cloned skb
794  *	@csum: Checksum (must include start/offset pair)
795  *	@csum_start: Offset from skb->head where checksumming should start
796  *	@csum_offset: Offset from csum_start where checksum should be stored
797  *	@priority: Packet queueing priority
798  *	@ignore_df: allow local fragmentation
799  *	@cloned: Head may be cloned (check refcnt to be sure)
800  *	@ip_summed: Driver fed us an IP checksum
801  *	@nohdr: Payload reference only, must not modify header
802  *	@pkt_type: Packet class
803  *	@fclone: skbuff clone status
804  *	@ipvs_property: skbuff is owned by ipvs
805  *	@inner_protocol_type: whether the inner protocol is
806  *		ENCAP_TYPE_ETHER or ENCAP_TYPE_IPPROTO
807  *	@remcsum_offload: remote checksum offload is enabled
808  *	@offload_fwd_mark: Packet was L2-forwarded in hardware
809  *	@offload_l3_fwd_mark: Packet was L3-forwarded in hardware
810  *	@tc_skip_classify: do not classify packet. set by IFB device
811  *	@tc_at_ingress: used within tc_classify to distinguish in/egress
812  *	@redirected: packet was redirected by packet classifier
813  *	@from_ingress: packet was redirected from the ingress path
814  *	@nf_skip_egress: packet shall skip nf egress - see netfilter_netdev.h
815  *	@peeked: this packet has been seen already, so stats have been
816  *		done for it, don't do them again
817  *	@nf_trace: netfilter packet trace flag
818  *	@protocol: Packet protocol from driver
819  *	@destructor: Destruct function
820  *	@tcp_tsorted_anchor: list structure for TCP (tp->tsorted_sent_queue)
821  *	@_sk_redir: socket redirection information for skmsg
822  *	@_nfct: Associated connection, if any (with nfctinfo bits)
823  *	@skb_iif: ifindex of device we arrived on
824  *	@tc_depth: counter for packet duplication
825  *	@tc_index: Traffic control index
826  *	@hash: the packet hash
827  *	@queue_mapping: Queue mapping for multiqueue devices
828  *	@head_frag: skb was allocated from page fragments,
829  *		not allocated by kmalloc() or vmalloc().
830  *	@pfmemalloc: skbuff was allocated from PFMEMALLOC reserves
831  *	@pp_recycle: mark the packet for recycling instead of freeing (implies
832  *		page_pool support on driver)
833  *	@active_extensions: active extensions (skb_ext_id types)
834  *	@ndisc_nodetype: router type (from link layer)
835  *	@ooo_okay: allow the mapping of a socket to a queue to be changed
836  *	@l4_hash: indicate hash is a canonical 4-tuple hash over transport
837  *		ports.
838  *	@sw_hash: indicates hash was computed in software stack
839  *	@wifi_acked_valid: wifi_acked was set
840  *	@wifi_acked: whether frame was acked on wifi or not
841  *	@no_fcs:  Request NIC to treat last 4 bytes as Ethernet FCS
842  *	@encapsulation: indicates the inner headers in the skbuff are valid
843  *	@encap_hdr_csum: software checksum is needed
844  *	@csum_valid: checksum is already valid
845  *	@csum_not_inet: use CRC32c to resolve CHECKSUM_PARTIAL
846  *	@csum_complete_sw: checksum was completed by software
847  *	@csum_level: indicates the number of consecutive checksums found in
848  *		the packet minus one that have been verified as
849  *		CHECKSUM_UNNECESSARY (max 3)
850  *	@unreadable: indicates that at least 1 of the fragments in this skb is
851  *		unreadable.
852  *	@dst_pending_confirm: need to confirm neighbour
853  *	@decrypted: Decrypted SKB
854  *	@slow_gro: state present at GRO time, slower prepare step required
855  *	@tstamp_type: When set, skb->tstamp has the
856  *		delivery_time clock base of skb->tstamp.
857  *	@napi_id: id of the NAPI struct this skb came from
858  *	@sender_cpu: (aka @napi_id) source CPU in XPS
859  *	@alloc_cpu: CPU which did the skb allocation.
860  *	@secmark: security marking
861  *	@mark: Generic packet mark
862  *	@reserved_tailroom: (aka @mark) number of bytes of free space available
863  *		at the tail of an sk_buff
864  *	@vlan_all: vlan fields (proto & tci)
865  *	@vlan_proto: vlan encapsulation protocol
866  *	@vlan_tci: vlan tag control information
867  *	@inner_protocol: Protocol (encapsulation)
868  *	@inner_ipproto: (aka @inner_protocol) stores ipproto when
869  *		skb->inner_protocol_type == ENCAP_TYPE_IPPROTO;
870  *	@inner_transport_header: Inner transport layer header (encapsulation)
871  *	@inner_network_header: Network layer header (encapsulation)
872  *	@inner_mac_header: Link layer header (encapsulation)
873  *	@transport_header: Transport layer header
874  *	@network_header: Network layer header
875  *	@mac_header: Link layer header
876  *	@kcov_handle: KCOV remote handle for remote coverage collection
877  *	@tail: Tail pointer
878  *	@end: End pointer
879  *	@head: Head of buffer
880  *	@data: Data head pointer
881  *	@truesize: Buffer size
882  *	@users: User count - see {datagram,tcp}.c
883  *	@extensions: allocated extensions, valid if active_extensions is nonzero
884  */
885 
886 struct sk_buff {
887 	union {
888 		struct {
889 			/* These two members must be first to match sk_buff_head. */
890 			struct sk_buff		*next;
891 			struct sk_buff		*prev;
892 
893 			union {
894 				struct net_device	*dev;
895 				/* Some protocols might use this space to store information,
896 				 * while device pointer would be NULL.
897 				 * UDP receive path is one user.
898 				 */
899 				unsigned long		dev_scratch;
900 			};
901 		};
902 		struct rb_node		rbnode; /* used in netem, ip4 defrag, and tcp stack */
903 		struct list_head	list;
904 		struct llist_node	ll_node;
905 	};
906 
907 	struct sock		*sk;
908 
909 	union {
910 		ktime_t		tstamp;
911 		u64		skb_mstamp_ns; /* earliest departure time */
912 	};
913 	/*
914 	 * This is the control buffer. It is free to use for every
915 	 * layer. Please put your private variables there. If you
916 	 * want to keep them across layers you have to do a skb_clone()
917 	 * first. This is owned by whoever has the skb queued ATM.
918 	 */
919 	char			cb[48] __aligned(8);
920 
921 	union {
922 		struct {
923 			unsigned long	_skb_refdst;
924 			void		(*destructor)(struct sk_buff *skb);
925 		};
926 		struct list_head	tcp_tsorted_anchor;
927 #ifdef CONFIG_NET_SOCK_MSG
928 		unsigned long		_sk_redir;
929 #endif
930 	};
931 
932 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
933 	unsigned long		 _nfct;
934 #endif
935 	unsigned int		len,
936 				data_len;
937 	__u16			mac_len,
938 				hdr_len;
939 
940 	/* Following fields are _not_ copied in __copy_skb_header()
941 	 * Note that queue_mapping is here mostly to fill a hole.
942 	 */
943 	__u16			queue_mapping;
944 
945 /* if you move cloned around you also must adapt those constants */
946 #ifdef __BIG_ENDIAN_BITFIELD
947 #define CLONED_MASK	(1 << 7)
948 #else
949 #define CLONED_MASK	1
950 #endif
951 #define CLONED_OFFSET		offsetof(struct sk_buff, __cloned_offset)
952 
953 	/* private: */
954 	__u8			__cloned_offset[0];
955 	/* public: */
956 	__u8			cloned:1,
957 				nohdr:1,
958 				fclone:2,
959 				peeked:1,
960 				head_frag:1,
961 				pfmemalloc:1,
962 				pp_recycle:1; /* page_pool recycle indicator */
963 #ifdef CONFIG_SKB_EXTENSIONS
964 	__u8			active_extensions;
965 #endif
966 
967 	/* Fields enclosed in headers group are copied
968 	 * using a single memcpy() in __copy_skb_header()
969 	 */
970 	struct_group(headers,
971 
972 	/* private: */
973 	__u8			__pkt_type_offset[0];
974 	/* public: */
975 	__u8			pkt_type:3; /* see PKT_TYPE_MAX */
976 	__u8			ignore_df:1;
977 	__u8			dst_pending_confirm:1;
978 	__u8			ip_summed:2;
979 	__u8			ooo_okay:1;
980 
981 	/* private: */
982 	__u8			__mono_tc_offset[0];
983 	/* public: */
984 	__u8			tstamp_type:2;	/* See skb_tstamp_type */
985 #ifdef CONFIG_NET_XGRESS
986 	__u8			tc_at_ingress:1;	/* See TC_AT_INGRESS_MASK */
987 	__u8			tc_skip_classify:1;
988 #endif
989 	__u8			remcsum_offload:1;
990 	__u8			csum_complete_sw:1;
991 	__u8			csum_level:2;
992 	__u8			inner_protocol_type:1;
993 
994 	__u8			l4_hash:1;
995 	__u8			sw_hash:1;
996 #ifdef CONFIG_WIRELESS
997 	__u8			wifi_acked_valid:1;
998 	__u8			wifi_acked:1;
999 #endif
1000 	__u8			no_fcs:1;
1001 	/* Indicates the inner headers are valid in the skbuff. */
1002 	__u8			encapsulation:1;
1003 	__u8			encap_hdr_csum:1;
1004 	__u8			csum_valid:1;
1005 #ifdef CONFIG_IPV6_NDISC_NODETYPE
1006 	__u8			ndisc_nodetype:2;
1007 #endif
1008 
1009 #if IS_ENABLED(CONFIG_IP_VS)
1010 	__u8			ipvs_property:1;
1011 #endif
1012 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || IS_ENABLED(CONFIG_NF_TABLES)
1013 	__u8			nf_trace:1;
1014 #endif
1015 #ifdef CONFIG_NET_SWITCHDEV
1016 	__u8			offload_fwd_mark:1;
1017 	__u8			offload_l3_fwd_mark:1;
1018 #endif
1019 	__u8			redirected:1;
1020 #ifdef CONFIG_NET_REDIRECT
1021 	__u8			from_ingress:1;
1022 #endif
1023 #ifdef CONFIG_NETFILTER_SKIP_EGRESS
1024 	__u8			nf_skip_egress:1;
1025 #endif
1026 #ifdef CONFIG_SKB_DECRYPTED
1027 	__u8			decrypted:1;
1028 #endif
1029 	__u8			slow_gro:1;
1030 #if IS_ENABLED(CONFIG_IP_SCTP)
1031 	__u8			csum_not_inet:1;
1032 #endif
1033 	__u8			unreadable:1;
1034 	__u8			tc_depth:2;
1035 #if defined(CONFIG_NET_SCHED) || defined(CONFIG_NET_XGRESS)
1036 	__u16			tc_index;	/* traffic control index */
1037 #endif
1038 
1039 	u16			alloc_cpu;
1040 
1041 	union {
1042 		__wsum		csum;
1043 		struct {
1044 			__u16	csum_start;
1045 			__u16	csum_offset;
1046 		};
1047 	};
1048 	__u32			priority;
1049 	int			skb_iif;
1050 	__u32			hash;
1051 	union {
1052 		u32		vlan_all;
1053 		struct {
1054 			__be16	vlan_proto;
1055 			__u16	vlan_tci;
1056 		};
1057 	};
1058 #if defined(CONFIG_NET_RX_BUSY_POLL) || defined(CONFIG_XPS)
1059 	union {
1060 		unsigned int	napi_id;
1061 		unsigned int	sender_cpu;
1062 	};
1063 #endif
1064 #ifdef CONFIG_NETWORK_SECMARK
1065 	__u32		secmark;
1066 #endif
1067 
1068 	union {
1069 		__u32		mark;
1070 		__u32		reserved_tailroom;
1071 	};
1072 
1073 	union {
1074 		__be16		inner_protocol;
1075 		__u8		inner_ipproto;
1076 	};
1077 
1078 	__u16			inner_transport_header;
1079 	__u16			inner_network_header;
1080 	__u16			inner_mac_header;
1081 
1082 	__be16			protocol;
1083 	__u16			transport_header;
1084 	__u16			network_header;
1085 	__u16			mac_header;
1086 
1087 	struct kcov_common_handle_id kcov_handle;
1088 
1089 	); /* end headers group */
1090 
1091 	/* These elements must be at the end, see alloc_skb() for details.  */
1092 	sk_buff_data_t		tail;
1093 	sk_buff_data_t		end;
1094 	unsigned char		*head,
1095 				*data;
1096 	unsigned int		truesize;
1097 	refcount_t		users;
1098 
1099 #ifdef CONFIG_SKB_EXTENSIONS
1100 	/* only usable after checking ->active_extensions != 0 */
1101 	struct skb_ext		*extensions;
1102 #endif
1103 };
1104 
1105 /* if you move pkt_type around you also must adapt those constants */
1106 #ifdef __BIG_ENDIAN_BITFIELD
1107 #define PKT_TYPE_MAX	(7 << 5)
1108 #else
1109 #define PKT_TYPE_MAX	7
1110 #endif
1111 #define PKT_TYPE_OFFSET		offsetof(struct sk_buff, __pkt_type_offset)
1112 
1113 /* if you move tc_at_ingress or tstamp_type
1114  * around, you also must adapt these constants.
1115  */
1116 #ifdef __BIG_ENDIAN_BITFIELD
1117 #define SKB_TSTAMP_TYPE_MASK		(3 << 6)
1118 #define SKB_TSTAMP_TYPE_RSHIFT		(6)
1119 #define TC_AT_INGRESS_MASK		(1 << 5)
1120 #else
1121 #define SKB_TSTAMP_TYPE_MASK		(3)
1122 #define TC_AT_INGRESS_MASK		(1 << 2)
1123 #endif
1124 #define SKB_BF_MONO_TC_OFFSET		offsetof(struct sk_buff, __mono_tc_offset)
1125 
1126 #ifdef __KERNEL__
1127 /*
1128  *	Handling routines are only of interest to the kernel
1129  */
1130 
1131 #define SKB_ALLOC_FCLONE	0x01
1132 #define SKB_ALLOC_RX		0x02
1133 #define SKB_ALLOC_NAPI		0x04
1134 
1135 /**
1136  * skb_pfmemalloc - Test if the skb was allocated from PFMEMALLOC reserves
1137  * @skb: buffer
1138  */
skb_pfmemalloc(const struct sk_buff * skb)1139 static inline bool skb_pfmemalloc(const struct sk_buff *skb)
1140 {
1141 	return unlikely(skb->pfmemalloc);
1142 }
1143 
1144 /*
1145  * skb might have a dst pointer attached, refcounted or not.
1146  * _skb_refdst low order bit is set if refcount was _not_ taken
1147  */
1148 #define SKB_DST_NOREF	1UL
1149 #define SKB_DST_PTRMASK	~(SKB_DST_NOREF)
1150 
1151 /**
1152  * skb_dst - returns skb dst_entry
1153  * @skb: buffer
1154  *
1155  * Returns: skb dst_entry, regardless of reference taken or not.
1156  */
skb_dst(const struct sk_buff * skb)1157 static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
1158 {
1159 	/* If refdst was not refcounted, check we still are in a
1160 	 * rcu_read_lock section
1161 	 */
1162 	WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
1163 		!rcu_read_lock_held() &&
1164 		!rcu_read_lock_bh_held());
1165 	return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
1166 }
1167 
skb_dst_check_unset(struct sk_buff * skb)1168 static inline void skb_dst_check_unset(struct sk_buff *skb)
1169 {
1170 	DEBUG_NET_WARN_ON_ONCE((skb->_skb_refdst & SKB_DST_PTRMASK) &&
1171 			       !(skb->_skb_refdst & SKB_DST_NOREF));
1172 }
1173 
1174 /**
1175  * skb_dstref_steal() - return current dst_entry value and clear it
1176  * @skb: buffer
1177  *
1178  * Resets skb dst_entry without adjusting its reference count. Useful in
1179  * cases where dst_entry needs to be temporarily reset and restored.
1180  * Note that the returned value cannot be used directly because it
1181  * might contain SKB_DST_NOREF bit.
1182  *
1183  * When in doubt, prefer skb_dst_drop() over skb_dstref_steal() to correctly
1184  * handle dst_entry reference counting.
1185  *
1186  * Returns: original skb dst_entry.
1187  */
skb_dstref_steal(struct sk_buff * skb)1188 static inline unsigned long skb_dstref_steal(struct sk_buff *skb)
1189 {
1190 	unsigned long refdst = skb->_skb_refdst;
1191 
1192 	skb->_skb_refdst = 0;
1193 	return refdst;
1194 }
1195 
1196 /**
1197  * skb_dstref_restore() - restore skb dst_entry removed via skb_dstref_steal()
1198  * @skb: buffer
1199  * @refdst: dst entry from a call to skb_dstref_steal()
1200  */
skb_dstref_restore(struct sk_buff * skb,unsigned long refdst)1201 static inline void skb_dstref_restore(struct sk_buff *skb, unsigned long refdst)
1202 {
1203 	skb_dst_check_unset(skb);
1204 	skb->_skb_refdst = refdst;
1205 }
1206 
1207 /**
1208  * skb_dst_set - sets skb dst
1209  * @skb: buffer
1210  * @dst: dst entry
1211  *
1212  * Sets skb dst, assuming a reference was taken on dst and should
1213  * be released by skb_dst_drop()
1214  */
skb_dst_set(struct sk_buff * skb,struct dst_entry * dst)1215 static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
1216 {
1217 	skb_dst_check_unset(skb);
1218 	skb->slow_gro |= !!dst;
1219 	skb->_skb_refdst = (unsigned long)dst;
1220 }
1221 
1222 /**
1223  * skb_dst_set_noref - sets skb dst, hopefully, without taking reference
1224  * @skb: buffer
1225  * @dst: dst entry
1226  *
1227  * Sets skb dst, assuming a reference was not taken on dst.
1228  * If dst entry is cached, we do not take reference and dst_release
1229  * will be avoided by refdst_drop. If dst entry is not cached, we take
1230  * reference, so that last dst_release can destroy the dst immediately.
1231  */
skb_dst_set_noref(struct sk_buff * skb,struct dst_entry * dst)1232 static inline void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst)
1233 {
1234 	skb_dst_check_unset(skb);
1235 	WARN_ON(!rcu_read_lock_held() && !rcu_read_lock_bh_held());
1236 	skb->slow_gro |= !!dst;
1237 	skb->_skb_refdst = (unsigned long)dst | SKB_DST_NOREF;
1238 }
1239 
1240 /**
1241  * skb_dst_is_noref - Test if skb dst isn't refcounted
1242  * @skb: buffer
1243  */
skb_dst_is_noref(const struct sk_buff * skb)1244 static inline bool skb_dst_is_noref(const struct sk_buff *skb)
1245 {
1246 	return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
1247 }
1248 
1249 /* For mangling skb->pkt_type from user space side from applications
1250  * such as nft, tc, etc, we only allow a conservative subset of
1251  * possible pkt_types to be set.
1252 */
skb_pkt_type_ok(u32 ptype)1253 static inline bool skb_pkt_type_ok(u32 ptype)
1254 {
1255 	return ptype <= PACKET_OTHERHOST;
1256 }
1257 
1258 /**
1259  * skb_napi_id - Returns the skb's NAPI id
1260  * @skb: buffer
1261  */
skb_napi_id(const struct sk_buff * skb)1262 static inline unsigned int skb_napi_id(const struct sk_buff *skb)
1263 {
1264 #ifdef CONFIG_NET_RX_BUSY_POLL
1265 	return skb->napi_id;
1266 #else
1267 	return 0;
1268 #endif
1269 }
1270 
skb_wifi_acked_valid(const struct sk_buff * skb)1271 static inline bool skb_wifi_acked_valid(const struct sk_buff *skb)
1272 {
1273 #ifdef CONFIG_WIRELESS
1274 	return skb->wifi_acked_valid;
1275 #else
1276 	return 0;
1277 #endif
1278 }
1279 
1280 /**
1281  * skb_unref - decrement the skb's reference count
1282  * @skb: buffer
1283  *
1284  * Returns: true if we can free the skb.
1285  */
skb_unref(struct sk_buff * skb)1286 static inline bool skb_unref(struct sk_buff *skb)
1287 {
1288 	if (unlikely(!skb))
1289 		return false;
1290 	if (!IS_ENABLED(CONFIG_DEBUG_NET) && likely(refcount_read(&skb->users) == 1))
1291 		smp_rmb();
1292 	else if (likely(!refcount_dec_and_test(&skb->users)))
1293 		return false;
1294 
1295 	return true;
1296 }
1297 
skb_data_unref(const struct sk_buff * skb,struct skb_shared_info * shinfo)1298 static inline bool skb_data_unref(const struct sk_buff *skb,
1299 				  struct skb_shared_info *shinfo)
1300 {
1301 	int bias;
1302 
1303 	if (!skb->cloned)
1304 		return true;
1305 
1306 	bias = skb->nohdr ? (1 << SKB_DATAREF_SHIFT) + 1 : 1;
1307 
1308 	if (atomic_read(&shinfo->dataref) == bias)
1309 		smp_rmb();
1310 	else if (atomic_sub_return(bias, &shinfo->dataref))
1311 		return false;
1312 
1313 	return true;
1314 }
1315 
1316 void __fix_address sk_skb_reason_drop(const struct sock *sk,
1317 				      struct sk_buff *skb,
1318 				      enum skb_drop_reason reason);
1319 
1320 static inline void
kfree_skb_reason(struct sk_buff * skb,enum skb_drop_reason reason)1321 kfree_skb_reason(struct sk_buff *skb, enum skb_drop_reason reason)
1322 {
1323 	sk_skb_reason_drop(NULL, skb, reason);
1324 }
1325 
1326 /**
1327  *	kfree_skb - free an sk_buff with 'NOT_SPECIFIED' reason
1328  *	@skb: buffer to free
1329  */
kfree_skb(struct sk_buff * skb)1330 static inline void kfree_skb(struct sk_buff *skb)
1331 {
1332 	kfree_skb_reason(skb, SKB_DROP_REASON_NOT_SPECIFIED);
1333 }
1334 
1335 void skb_release_head_state(struct sk_buff *skb);
1336 void kfree_skb_list_reason(struct sk_buff *segs,
1337 			   enum skb_drop_reason reason);
1338 void skb_dump(const char *level, const struct sk_buff *skb, bool full_pkt);
1339 void skb_tx_error(struct sk_buff *skb);
1340 
kfree_skb_list(struct sk_buff * segs)1341 static inline void kfree_skb_list(struct sk_buff *segs)
1342 {
1343 	kfree_skb_list_reason(segs, SKB_DROP_REASON_NOT_SPECIFIED);
1344 }
1345 
1346 #ifdef CONFIG_TRACEPOINTS
1347 void consume_skb(struct sk_buff *skb);
1348 #else
consume_skb(struct sk_buff * skb)1349 static inline void consume_skb(struct sk_buff *skb)
1350 {
1351 	return kfree_skb(skb);
1352 }
1353 #endif
1354 
1355 void __consume_stateless_skb(struct sk_buff *skb);
1356 void  __kfree_skb(struct sk_buff *skb);
1357 
1358 void kfree_skb_partial(struct sk_buff *skb, bool head_stolen);
1359 bool skb_try_coalesce(struct sk_buff *to, struct sk_buff *from,
1360 		      bool *fragstolen, int *delta_truesize);
1361 
1362 struct sk_buff *__alloc_skb(unsigned int size, gfp_t priority, int flags,
1363 			    int node);
1364 struct sk_buff *__build_skb(void *data, unsigned int frag_size);
1365 struct sk_buff *build_skb(void *data, unsigned int frag_size);
1366 struct sk_buff *build_skb_around(struct sk_buff *skb,
1367 				 void *data, unsigned int frag_size);
1368 void skb_attempt_defer_free(struct sk_buff *skb);
1369 
1370 u32 napi_skb_cache_get_bulk(void **skbs, u32 n);
1371 struct sk_buff *napi_build_skb(void *data, unsigned int frag_size);
1372 struct sk_buff *slab_build_skb(void *data);
1373 
1374 /**
1375  * alloc_skb - allocate a network buffer
1376  * @size: size to allocate
1377  * @priority: allocation mask
1378  *
1379  * This function is a convenient wrapper around __alloc_skb().
1380  */
alloc_skb(unsigned int size,gfp_t priority)1381 static inline struct sk_buff *alloc_skb(unsigned int size,
1382 					gfp_t priority)
1383 {
1384 	return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
1385 }
1386 
1387 struct sk_buff *alloc_skb_with_frags(unsigned long header_len,
1388 				     unsigned long data_len,
1389 				     int max_page_order,
1390 				     int *errcode,
1391 				     gfp_t gfp_mask);
1392 struct sk_buff *alloc_skb_for_msg(struct sk_buff *first);
1393 
1394 /* Layout of fast clones : [skb1][skb2][fclone_ref] */
1395 struct sk_buff_fclones {
1396 	struct sk_buff	skb1;
1397 
1398 	struct sk_buff	skb2;
1399 
1400 	refcount_t	fclone_ref;
1401 };
1402 
1403 /**
1404  *	skb_fclone_busy - check if fclone is busy
1405  *	@sk: socket
1406  *	@skb: buffer
1407  *
1408  * Returns: true if skb is a fast clone, and its clone is not freed.
1409  * Some drivers call skb_orphan() in their ndo_start_xmit(),
1410  * so we also check that didn't happen.
1411  */
skb_fclone_busy(const struct sock * sk,const struct sk_buff * skb)1412 static inline bool skb_fclone_busy(const struct sock *sk,
1413 				   const struct sk_buff *skb)
1414 {
1415 	const struct sk_buff_fclones *fclones;
1416 
1417 	fclones = container_of(skb, struct sk_buff_fclones, skb1);
1418 
1419 	return skb->fclone == SKB_FCLONE_ORIG &&
1420 	       refcount_read(&fclones->fclone_ref) > 1 &&
1421 	       READ_ONCE(fclones->skb2.sk) == sk;
1422 }
1423 
1424 /**
1425  * alloc_skb_fclone - allocate a network buffer from fclone cache
1426  * @size: size to allocate
1427  * @priority: allocation mask
1428  *
1429  * This function is a convenient wrapper around __alloc_skb().
1430  */
alloc_skb_fclone(unsigned int size,gfp_t priority)1431 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
1432 					       gfp_t priority)
1433 {
1434 	return __alloc_skb(size, priority, SKB_ALLOC_FCLONE, NUMA_NO_NODE);
1435 }
1436 
1437 struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
1438 void skb_headers_offset_update(struct sk_buff *skb, int off);
1439 int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
1440 struct sk_buff *skb_clone(struct sk_buff *skb, gfp_t priority);
1441 void skb_copy_header(struct sk_buff *new, const struct sk_buff *old);
1442 struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
1443 struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
1444 				   gfp_t gfp_mask, bool fclone);
__pskb_copy(struct sk_buff * skb,int headroom,gfp_t gfp_mask)1445 static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
1446 					  gfp_t gfp_mask)
1447 {
1448 	return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
1449 }
1450 
1451 int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
1452 struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
1453 				     unsigned int headroom);
1454 struct sk_buff *skb_expand_head(struct sk_buff *skb, unsigned int headroom);
1455 struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
1456 				int newtailroom, gfp_t priority);
1457 int __must_check skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
1458 				     int offset, int len);
1459 int __must_check skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg,
1460 			      int offset, int len);
1461 int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
1462 int __skb_pad(struct sk_buff *skb, int pad, bool free_on_error);
1463 
1464 /**
1465  *	skb_pad			-	zero pad the tail of an skb
1466  *	@skb: buffer to pad
1467  *	@pad: space to pad
1468  *
1469  *	Ensure that a buffer is followed by a padding area that is zero
1470  *	filled. Used by network drivers which may DMA or transfer data
1471  *	beyond the buffer end onto the wire.
1472  *
1473  *	May return error in out of memory cases. The skb is freed on error.
1474  */
skb_pad(struct sk_buff * skb,int pad)1475 static inline int skb_pad(struct sk_buff *skb, int pad)
1476 {
1477 	return __skb_pad(skb, pad, true);
1478 }
1479 #define dev_kfree_skb(a)	consume_skb(a)
1480 
1481 int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
1482 			 int offset, size_t size, size_t max_frags);
1483 
1484 struct skb_seq_state {
1485 	__u32		lower_offset;
1486 	__u32		upper_offset;
1487 	__u32		frag_idx;
1488 	__u32		stepped_offset;
1489 	struct sk_buff	*root_skb;
1490 	struct sk_buff	*cur_skb;
1491 	__u8		*frag_data;
1492 	__u32		frag_off;
1493 };
1494 
1495 void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
1496 			  unsigned int to, struct skb_seq_state *st);
1497 unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
1498 			  struct skb_seq_state *st);
1499 void skb_abort_seq_read(struct skb_seq_state *st);
1500 int skb_copy_seq_read(struct skb_seq_state *st, int offset, void *to, int len);
1501 
1502 unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
1503 			   unsigned int to, struct ts_config *config);
1504 
1505 /*
1506  * Packet hash types specify the type of hash in skb_set_hash.
1507  *
1508  * Hash types refer to the protocol layer addresses which are used to
1509  * construct a packet's hash. The hashes are used to differentiate or identify
1510  * flows of the protocol layer for the hash type. Hash types are either
1511  * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
1512  *
1513  * Properties of hashes:
1514  *
1515  * 1) Two packets in different flows have different hash values
1516  * 2) Two packets in the same flow should have the same hash value
1517  *
1518  * A hash at a higher layer is considered to be more specific. A driver should
1519  * set the most specific hash possible.
1520  *
1521  * A driver cannot indicate a more specific hash than the layer at which a hash
1522  * was computed. For instance an L3 hash cannot be set as an L4 hash.
1523  *
1524  * A driver may indicate a hash level which is less specific than the
1525  * actual layer the hash was computed on. For instance, a hash computed
1526  * at L4 may be considered an L3 hash. This should only be done if the
1527  * driver can't unambiguously determine that the HW computed the hash at
1528  * the higher layer. Note that the "should" in the second property above
1529  * permits this.
1530  */
1531 enum pkt_hash_types {
1532 	PKT_HASH_TYPE_NONE,	/* Undefined type */
1533 	PKT_HASH_TYPE_L2,	/* Input: src_MAC, dest_MAC */
1534 	PKT_HASH_TYPE_L3,	/* Input: src_IP, dst_IP */
1535 	PKT_HASH_TYPE_L4,	/* Input: src_IP, dst_IP, src_port, dst_port */
1536 };
1537 
skb_clear_hash(struct sk_buff * skb)1538 static inline void skb_clear_hash(struct sk_buff *skb)
1539 {
1540 	skb->hash = 0;
1541 	skb->sw_hash = 0;
1542 	skb->l4_hash = 0;
1543 }
1544 
skb_clear_hash_if_not_l4(struct sk_buff * skb)1545 static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
1546 {
1547 	if (!skb->l4_hash)
1548 		skb_clear_hash(skb);
1549 }
1550 
1551 static inline void
__skb_set_hash(struct sk_buff * skb,__u32 hash,bool is_sw,bool is_l4)1552 __skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
1553 {
1554 	skb->l4_hash = is_l4;
1555 	skb->sw_hash = is_sw;
1556 	skb->hash = hash;
1557 }
1558 
1559 static inline void
skb_set_hash(struct sk_buff * skb,__u32 hash,enum pkt_hash_types type)1560 skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
1561 {
1562 	/* Used by drivers to set hash from HW */
1563 	__skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
1564 }
1565 
1566 static inline void
__skb_set_sw_hash(struct sk_buff * skb,__u32 hash,bool is_l4)1567 __skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
1568 {
1569 	__skb_set_hash(skb, hash, true, is_l4);
1570 }
1571 
1572 u32 __skb_get_hash_symmetric_net(const struct net *net, const struct sk_buff *skb);
1573 
__skb_get_hash_symmetric(const struct sk_buff * skb)1574 static inline u32 __skb_get_hash_symmetric(const struct sk_buff *skb)
1575 {
1576 	return __skb_get_hash_symmetric_net(NULL, skb);
1577 }
1578 
1579 void __skb_get_hash_net(const struct net *net, struct sk_buff *skb);
1580 u32 skb_get_poff(const struct sk_buff *skb);
1581 u32 __skb_get_poff(const struct sk_buff *skb, const void *data,
1582 		   const struct flow_keys_basic *keys, int hlen);
1583 __be32 skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
1584 			  const void *data, int hlen_proto);
1585 
1586 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
1587 			     const struct flow_dissector_key *key,
1588 			     unsigned int key_count);
1589 
1590 struct bpf_flow_dissector;
1591 u32 bpf_flow_dissect(struct bpf_prog *prog, struct bpf_flow_dissector *ctx,
1592 		     __be16 proto, int nhoff, int hlen, unsigned int flags);
1593 
1594 bool __skb_flow_dissect(const struct net *net,
1595 			const struct sk_buff *skb,
1596 			struct flow_dissector *flow_dissector,
1597 			void *target_container, const void *data,
1598 			__be16 proto, int nhoff, int hlen, unsigned int flags);
1599 
skb_flow_dissect(const struct sk_buff * skb,struct flow_dissector * flow_dissector,void * target_container,unsigned int flags)1600 static inline bool skb_flow_dissect(const struct sk_buff *skb,
1601 				    struct flow_dissector *flow_dissector,
1602 				    void *target_container, unsigned int flags)
1603 {
1604 	return __skb_flow_dissect(NULL, skb, flow_dissector,
1605 				  target_container, NULL, 0, 0, 0, flags);
1606 }
1607 
skb_flow_dissect_flow_keys(const struct sk_buff * skb,struct flow_keys * flow,unsigned int flags)1608 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
1609 					      struct flow_keys *flow,
1610 					      unsigned int flags)
1611 {
1612 	memset(flow, 0, sizeof(*flow));
1613 	return __skb_flow_dissect(NULL, skb, &flow_keys_dissector,
1614 				  flow, NULL, 0, 0, 0, flags);
1615 }
1616 
1617 static inline bool
skb_flow_dissect_flow_keys_basic(const struct net * net,const struct sk_buff * skb,struct flow_keys_basic * flow,const void * data,__be16 proto,int nhoff,int hlen,unsigned int flags)1618 skb_flow_dissect_flow_keys_basic(const struct net *net,
1619 				 const struct sk_buff *skb,
1620 				 struct flow_keys_basic *flow,
1621 				 const void *data, __be16 proto,
1622 				 int nhoff, int hlen, unsigned int flags)
1623 {
1624 	memset(flow, 0, sizeof(*flow));
1625 	return __skb_flow_dissect(net, skb, &flow_keys_basic_dissector, flow,
1626 				  data, proto, nhoff, hlen, flags);
1627 }
1628 
1629 void skb_flow_dissect_meta(const struct sk_buff *skb,
1630 			   struct flow_dissector *flow_dissector,
1631 			   void *target_container);
1632 
1633 /* Gets a skb connection tracking info, ctinfo map should be a
1634  * map of mapsize to translate enum ip_conntrack_info states
1635  * to user states.
1636  */
1637 void
1638 skb_flow_dissect_ct(const struct sk_buff *skb,
1639 		    struct flow_dissector *flow_dissector,
1640 		    void *target_container,
1641 		    u16 *ctinfo_map, size_t mapsize,
1642 		    bool post_ct, u16 zone);
1643 void
1644 skb_flow_dissect_tunnel_info(const struct sk_buff *skb,
1645 			     struct flow_dissector *flow_dissector,
1646 			     void *target_container);
1647 
1648 void skb_flow_dissect_hash(const struct sk_buff *skb,
1649 			   struct flow_dissector *flow_dissector,
1650 			   void *target_container);
1651 
skb_get_hash_net(const struct net * net,struct sk_buff * skb)1652 static inline __u32 skb_get_hash_net(const struct net *net, struct sk_buff *skb)
1653 {
1654 	if (!skb->l4_hash && !skb->sw_hash)
1655 		__skb_get_hash_net(net, skb);
1656 
1657 	return skb->hash;
1658 }
1659 
skb_get_hash(struct sk_buff * skb)1660 static inline __u32 skb_get_hash(struct sk_buff *skb)
1661 {
1662 	if (!skb->l4_hash && !skb->sw_hash)
1663 		__skb_get_hash_net(NULL, skb);
1664 
1665 	return skb->hash;
1666 }
1667 
skb_get_hash_flowi6(struct sk_buff * skb,const struct flowi6 * fl6)1668 static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
1669 {
1670 	if (!skb->l4_hash && !skb->sw_hash) {
1671 		struct flow_keys keys;
1672 		__u32 hash = __get_hash_from_flowi6(fl6, &keys);
1673 
1674 		__skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1675 	}
1676 
1677 	return skb->hash;
1678 }
1679 
1680 __u32 skb_get_hash_perturb(const struct sk_buff *skb,
1681 			   const siphash_key_t *perturb);
1682 
skb_get_hash_raw(const struct sk_buff * skb)1683 static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1684 {
1685 	return skb->hash;
1686 }
1687 
skb_copy_hash(struct sk_buff * to,const struct sk_buff * from)1688 static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1689 {
1690 	to->hash = from->hash;
1691 	to->sw_hash = from->sw_hash;
1692 	to->l4_hash = from->l4_hash;
1693 };
1694 
skb_cmp_decrypted(const struct sk_buff * skb1,const struct sk_buff * skb2)1695 static inline int skb_cmp_decrypted(const struct sk_buff *skb1,
1696 				    const struct sk_buff *skb2)
1697 {
1698 #ifdef CONFIG_SKB_DECRYPTED
1699 	return skb2->decrypted - skb1->decrypted;
1700 #else
1701 	return 0;
1702 #endif
1703 }
1704 
skb_is_decrypted(const struct sk_buff * skb)1705 static inline bool skb_is_decrypted(const struct sk_buff *skb)
1706 {
1707 #ifdef CONFIG_SKB_DECRYPTED
1708 	return skb->decrypted;
1709 #else
1710 	return false;
1711 #endif
1712 }
1713 
skb_copy_decrypted(struct sk_buff * to,const struct sk_buff * from)1714 static inline void skb_copy_decrypted(struct sk_buff *to,
1715 				      const struct sk_buff *from)
1716 {
1717 #ifdef CONFIG_SKB_DECRYPTED
1718 	to->decrypted = from->decrypted;
1719 #endif
1720 }
1721 
1722 #ifdef NET_SKBUFF_DATA_USES_OFFSET
skb_end_pointer(const struct sk_buff * skb)1723 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1724 {
1725 	return skb->head + skb->end;
1726 }
1727 
skb_end_offset(const struct sk_buff * skb)1728 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1729 {
1730 	return skb->end;
1731 }
1732 
skb_set_end_offset(struct sk_buff * skb,unsigned int offset)1733 static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
1734 {
1735 	skb->end = offset;
1736 }
1737 #else
skb_end_pointer(const struct sk_buff * skb)1738 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1739 {
1740 	return skb->end;
1741 }
1742 
skb_end_offset(const struct sk_buff * skb)1743 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1744 {
1745 	return skb->end - skb->head;
1746 }
1747 
skb_set_end_offset(struct sk_buff * skb,unsigned int offset)1748 static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
1749 {
1750 	skb->end = skb->head + offset;
1751 }
1752 #endif
1753 
1754 extern const struct ubuf_info_ops msg_zerocopy_ubuf_ops;
1755 
1756 struct ubuf_info *msg_zerocopy_realloc(struct sock *sk, size_t size,
1757 				       struct ubuf_info *uarg, bool devmem);
1758 
1759 void msg_zerocopy_put_abort(struct ubuf_info *uarg, bool have_uref);
1760 
1761 struct net_devmem_dmabuf_binding;
1762 
1763 int __zerocopy_sg_from_iter(struct msghdr *msg, struct sock *sk,
1764 			    struct sk_buff *skb, struct iov_iter *from,
1765 			    size_t length,
1766 			    struct net_devmem_dmabuf_binding *binding);
1767 
1768 int zerocopy_fill_skb_from_iter(struct sk_buff *skb,
1769 				struct iov_iter *from, size_t length);
1770 
skb_zerocopy_iter_dgram(struct sk_buff * skb,struct msghdr * msg,int len)1771 static inline int skb_zerocopy_iter_dgram(struct sk_buff *skb,
1772 					  struct msghdr *msg, int len)
1773 {
1774 	return __zerocopy_sg_from_iter(msg, skb->sk, skb, &msg->msg_iter, len,
1775 				       NULL);
1776 }
1777 
1778 int skb_zerocopy_iter_stream(struct sock *sk, struct sk_buff *skb,
1779 			     struct msghdr *msg, int len,
1780 			     struct ubuf_info *uarg,
1781 			     struct net_devmem_dmabuf_binding *binding);
1782 
1783 /* Internal */
1784 #define skb_shinfo(SKB)	((struct skb_shared_info *)(skb_end_pointer(SKB)))
1785 
skb_hwtstamps(struct sk_buff * skb)1786 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1787 {
1788 	return &skb_shinfo(skb)->hwtstamps;
1789 }
1790 
skb_zcopy(struct sk_buff * skb)1791 static inline struct ubuf_info *skb_zcopy(struct sk_buff *skb)
1792 {
1793 	bool is_zcopy = skb && skb_shinfo(skb)->flags & SKBFL_ZEROCOPY_ENABLE;
1794 
1795 	return is_zcopy ? skb_uarg(skb) : NULL;
1796 }
1797 
skb_zcopy_pure(const struct sk_buff * skb)1798 static inline bool skb_zcopy_pure(const struct sk_buff *skb)
1799 {
1800 	return skb_shinfo(skb)->flags & SKBFL_PURE_ZEROCOPY;
1801 }
1802 
skb_zcopy_managed(const struct sk_buff * skb)1803 static inline bool skb_zcopy_managed(const struct sk_buff *skb)
1804 {
1805 	return skb_shinfo(skb)->flags & SKBFL_MANAGED_FRAG_REFS;
1806 }
1807 
skb_pure_zcopy_same(const struct sk_buff * skb1,const struct sk_buff * skb2)1808 static inline bool skb_pure_zcopy_same(const struct sk_buff *skb1,
1809 				       const struct sk_buff *skb2)
1810 {
1811 	return skb_zcopy_pure(skb1) == skb_zcopy_pure(skb2);
1812 }
1813 
net_zcopy_get(struct ubuf_info * uarg)1814 static inline void net_zcopy_get(struct ubuf_info *uarg)
1815 {
1816 	refcount_inc(&uarg->refcnt);
1817 }
1818 
skb_zcopy_init(struct sk_buff * skb,struct ubuf_info * uarg)1819 static inline void skb_zcopy_init(struct sk_buff *skb, struct ubuf_info *uarg)
1820 {
1821 	skb_shinfo(skb)->destructor_arg = uarg;
1822 	skb_shinfo(skb)->flags |= uarg->flags;
1823 }
1824 
skb_zcopy_set(struct sk_buff * skb,struct ubuf_info * uarg,bool * have_ref)1825 static inline void skb_zcopy_set(struct sk_buff *skb, struct ubuf_info *uarg,
1826 				 bool *have_ref)
1827 {
1828 	if (skb && uarg && !skb_zcopy(skb)) {
1829 		if (unlikely(have_ref && *have_ref))
1830 			*have_ref = false;
1831 		else
1832 			net_zcopy_get(uarg);
1833 		skb_zcopy_init(skb, uarg);
1834 	}
1835 }
1836 
skb_zcopy_set_nouarg(struct sk_buff * skb,void * val)1837 static inline void skb_zcopy_set_nouarg(struct sk_buff *skb, void *val)
1838 {
1839 	skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t) val | 0x1UL);
1840 	skb_shinfo(skb)->flags |= SKBFL_ZEROCOPY_FRAG;
1841 }
1842 
skb_zcopy_is_nouarg(struct sk_buff * skb)1843 static inline bool skb_zcopy_is_nouarg(struct sk_buff *skb)
1844 {
1845 	return (uintptr_t) skb_shinfo(skb)->destructor_arg & 0x1UL;
1846 }
1847 
skb_zcopy_get_nouarg(struct sk_buff * skb)1848 static inline void *skb_zcopy_get_nouarg(struct sk_buff *skb)
1849 {
1850 	return (void *)((uintptr_t) skb_shinfo(skb)->destructor_arg & ~0x1UL);
1851 }
1852 
net_zcopy_put(struct ubuf_info * uarg)1853 static inline void net_zcopy_put(struct ubuf_info *uarg)
1854 {
1855 	if (uarg)
1856 		uarg->ops->complete(NULL, uarg, true);
1857 }
1858 
net_zcopy_put_abort(struct ubuf_info * uarg,bool have_uref)1859 static inline void net_zcopy_put_abort(struct ubuf_info *uarg, bool have_uref)
1860 {
1861 	if (uarg) {
1862 		if (uarg->ops == &msg_zerocopy_ubuf_ops)
1863 			msg_zerocopy_put_abort(uarg, have_uref);
1864 		else if (have_uref)
1865 			net_zcopy_put(uarg);
1866 	}
1867 }
1868 
1869 /* Release a reference on a zerocopy structure */
skb_zcopy_clear(struct sk_buff * skb,bool zerocopy_success)1870 static inline void skb_zcopy_clear(struct sk_buff *skb, bool zerocopy_success)
1871 {
1872 	struct ubuf_info *uarg = skb_zcopy(skb);
1873 
1874 	if (uarg) {
1875 		if (!skb_zcopy_is_nouarg(skb))
1876 			uarg->ops->complete(skb, uarg, zerocopy_success);
1877 
1878 		skb_shinfo(skb)->flags &= ~SKBFL_ALL_ZEROCOPY;
1879 	}
1880 }
1881 
1882 void __skb_zcopy_downgrade_managed(struct sk_buff *skb);
1883 
skb_zcopy_downgrade_managed(struct sk_buff * skb)1884 static inline void skb_zcopy_downgrade_managed(struct sk_buff *skb)
1885 {
1886 	if (unlikely(skb_zcopy_managed(skb)))
1887 		__skb_zcopy_downgrade_managed(skb);
1888 }
1889 
1890 /* Return true if frags in this skb are readable by the host. */
skb_frags_readable(const struct sk_buff * skb)1891 static inline bool skb_frags_readable(const struct sk_buff *skb)
1892 {
1893 	return !skb->unreadable;
1894 }
1895 
skb_mark_not_on_list(struct sk_buff * skb)1896 static inline void skb_mark_not_on_list(struct sk_buff *skb)
1897 {
1898 	skb->next = NULL;
1899 }
1900 
skb_poison_list(struct sk_buff * skb)1901 static inline void skb_poison_list(struct sk_buff *skb)
1902 {
1903 #ifdef CONFIG_DEBUG_NET
1904 	skb->next = SKB_LIST_POISON_NEXT;
1905 #endif
1906 }
1907 
1908 /* Iterate through singly-linked GSO fragments of an skb. */
1909 #define skb_list_walk_safe(first, skb, next_skb)                               \
1910 	for ((skb) = (first), (next_skb) = (skb) ? (skb)->next : NULL; (skb);  \
1911 	     (skb) = (next_skb), (next_skb) = (skb) ? (skb)->next : NULL)
1912 
skb_list_del_init(struct sk_buff * skb)1913 static inline void skb_list_del_init(struct sk_buff *skb)
1914 {
1915 	__list_del_entry(&skb->list);
1916 	skb_mark_not_on_list(skb);
1917 }
1918 
1919 /**
1920  *	skb_queue_empty - check if a queue is empty
1921  *	@list: queue head
1922  *
1923  *	Returns true if the queue is empty, false otherwise.
1924  */
skb_queue_empty(const struct sk_buff_head * list)1925 static inline int skb_queue_empty(const struct sk_buff_head *list)
1926 {
1927 	return list->next == (const struct sk_buff *) list;
1928 }
1929 
1930 /**
1931  *	skb_queue_empty_lockless - check if a queue is empty
1932  *	@list: queue head
1933  *
1934  *	Returns true if the queue is empty, false otherwise.
1935  *	This variant can be used in lockless contexts.
1936  */
skb_queue_empty_lockless(const struct sk_buff_head * list)1937 static inline bool skb_queue_empty_lockless(const struct sk_buff_head *list)
1938 {
1939 	return READ_ONCE(list->next) == (const struct sk_buff *) list;
1940 }
1941 
1942 
1943 /**
1944  *	skb_queue_is_last - check if skb is the last entry in the queue
1945  *	@list: queue head
1946  *	@skb: buffer
1947  *
1948  *	Returns true if @skb is the last buffer on the list.
1949  */
skb_queue_is_last(const struct sk_buff_head * list,const struct sk_buff * skb)1950 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1951 				     const struct sk_buff *skb)
1952 {
1953 	return skb->next == (const struct sk_buff *) list;
1954 }
1955 
1956 /**
1957  *	skb_queue_is_first - check if skb is the first entry in the queue
1958  *	@list: queue head
1959  *	@skb: buffer
1960  *
1961  *	Returns true if @skb is the first buffer on the list.
1962  */
skb_queue_is_first(const struct sk_buff_head * list,const struct sk_buff * skb)1963 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1964 				      const struct sk_buff *skb)
1965 {
1966 	return skb->prev == (const struct sk_buff *) list;
1967 }
1968 
1969 /**
1970  *	skb_queue_next - return the next packet in the queue
1971  *	@list: queue head
1972  *	@skb: current buffer
1973  *
1974  *	Return the next packet in @list after @skb.  It is only valid to
1975  *	call this if skb_queue_is_last() evaluates to false.
1976  */
skb_queue_next(const struct sk_buff_head * list,const struct sk_buff * skb)1977 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1978 					     const struct sk_buff *skb)
1979 {
1980 	/* This BUG_ON may seem severe, but if we just return then we
1981 	 * are going to dereference garbage.
1982 	 */
1983 	BUG_ON(skb_queue_is_last(list, skb));
1984 	return skb->next;
1985 }
1986 
1987 /**
1988  *	skb_queue_prev - return the prev packet in the queue
1989  *	@list: queue head
1990  *	@skb: current buffer
1991  *
1992  *	Return the prev packet in @list before @skb.  It is only valid to
1993  *	call this if skb_queue_is_first() evaluates to false.
1994  */
skb_queue_prev(const struct sk_buff_head * list,const struct sk_buff * skb)1995 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1996 					     const struct sk_buff *skb)
1997 {
1998 	/* This BUG_ON may seem severe, but if we just return then we
1999 	 * are going to dereference garbage.
2000 	 */
2001 	BUG_ON(skb_queue_is_first(list, skb));
2002 	return skb->prev;
2003 }
2004 
2005 /**
2006  *	skb_get - reference buffer
2007  *	@skb: buffer to reference
2008  *
2009  *	Makes another reference to a socket buffer and returns a pointer
2010  *	to the buffer.
2011  */
skb_get(struct sk_buff * skb)2012 static inline struct sk_buff *skb_get(struct sk_buff *skb)
2013 {
2014 	refcount_inc(&skb->users);
2015 	return skb;
2016 }
2017 
2018 /*
2019  * If users == 1, we are the only owner and can avoid redundant atomic changes.
2020  */
2021 
2022 /**
2023  *	skb_cloned - is the buffer a clone
2024  *	@skb: buffer to check
2025  *
2026  *	Returns true if the buffer was generated with skb_clone() and is
2027  *	one of multiple shared copies of the buffer. Cloned buffers are
2028  *	shared data so must not be written to under normal circumstances.
2029  */
skb_cloned(const struct sk_buff * skb)2030 static inline int skb_cloned(const struct sk_buff *skb)
2031 {
2032 	return skb->cloned &&
2033 	       (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
2034 }
2035 
skb_unclone(struct sk_buff * skb,gfp_t pri)2036 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
2037 {
2038 	might_sleep_if(gfpflags_allow_blocking(pri));
2039 
2040 	if (skb_cloned(skb))
2041 		return pskb_expand_head(skb, 0, 0, pri);
2042 
2043 	return 0;
2044 }
2045 
2046 /* This variant of skb_unclone() makes sure skb->truesize
2047  * and skb_end_offset() are not changed, whenever a new skb->head is needed.
2048  *
2049  * Indeed there is no guarantee that ksize(kmalloc(X)) == ksize(kmalloc(X))
2050  * when various debugging features are in place.
2051  */
2052 int __skb_unclone_keeptruesize(struct sk_buff *skb, gfp_t pri);
skb_unclone_keeptruesize(struct sk_buff * skb,gfp_t pri)2053 static inline int skb_unclone_keeptruesize(struct sk_buff *skb, gfp_t pri)
2054 {
2055 	might_sleep_if(gfpflags_allow_blocking(pri));
2056 
2057 	if (skb_cloned(skb))
2058 		return __skb_unclone_keeptruesize(skb, pri);
2059 	return 0;
2060 }
2061 
2062 /**
2063  *	skb_header_cloned - is the header a clone
2064  *	@skb: buffer to check
2065  *
2066  *	Returns true if modifying the header part of the buffer requires
2067  *	the data to be copied.
2068  */
skb_header_cloned(const struct sk_buff * skb)2069 static inline int skb_header_cloned(const struct sk_buff *skb)
2070 {
2071 	int dataref;
2072 
2073 	if (!skb->cloned)
2074 		return 0;
2075 
2076 	dataref = atomic_read(&skb_shinfo(skb)->dataref);
2077 	dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
2078 	return dataref != 1;
2079 }
2080 
skb_header_unclone(struct sk_buff * skb,gfp_t pri)2081 static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri)
2082 {
2083 	might_sleep_if(gfpflags_allow_blocking(pri));
2084 
2085 	if (skb_header_cloned(skb))
2086 		return pskb_expand_head(skb, 0, 0, pri);
2087 
2088 	return 0;
2089 }
2090 
2091 /**
2092  * __skb_header_release() - allow clones to use the headroom
2093  * @skb: buffer to operate on
2094  *
2095  * See "DOC: dataref and headerless skbs".
2096  */
__skb_header_release(struct sk_buff * skb)2097 static inline void __skb_header_release(struct sk_buff *skb)
2098 {
2099 	skb->nohdr = 1;
2100 	atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
2101 }
2102 
2103 
2104 /**
2105  *	skb_shared - is the buffer shared
2106  *	@skb: buffer to check
2107  *
2108  *	Returns true if more than one person has a reference to this
2109  *	buffer.
2110  */
skb_shared(const struct sk_buff * skb)2111 static inline int skb_shared(const struct sk_buff *skb)
2112 {
2113 	return refcount_read(&skb->users) != 1;
2114 }
2115 
2116 /**
2117  *	skb_share_check - check if buffer is shared and if so clone it
2118  *	@skb: buffer to check
2119  *	@pri: priority for memory allocation
2120  *
2121  *	If the buffer is shared the buffer is cloned and the old copy
2122  *	drops a reference. A new clone with a single reference is returned.
2123  *	If the buffer is not shared the original buffer is returned. When
2124  *	being called from interrupt status or with spinlocks held pri must
2125  *	be GFP_ATOMIC.
2126  *
2127  *	NULL is returned on a memory allocation failure.
2128  */
skb_share_check(struct sk_buff * skb,gfp_t pri)2129 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
2130 {
2131 	might_sleep_if(gfpflags_allow_blocking(pri));
2132 	if (skb_shared(skb)) {
2133 		struct sk_buff *nskb = skb_clone(skb, pri);
2134 
2135 		if (likely(nskb))
2136 			consume_skb(skb);
2137 		else
2138 			kfree_skb(skb);
2139 		skb = nskb;
2140 	}
2141 	return skb;
2142 }
2143 
2144 /*
2145  *	Copy shared buffers into a new sk_buff. We effectively do COW on
2146  *	packets to handle cases where we have a local reader and forward
2147  *	and a couple of other messy ones. The normal one is tcpdumping
2148  *	a packet that's being forwarded.
2149  */
2150 
2151 /**
2152  *	skb_unshare - make a copy of a shared buffer
2153  *	@skb: buffer to check
2154  *	@pri: priority for memory allocation
2155  *
2156  *	If the socket buffer is a clone then this function creates a new
2157  *	copy of the data, drops a reference count on the old copy and returns
2158  *	the new copy with the reference count at 1. If the buffer is not a clone
2159  *	the original buffer is returned. When called with a spinlock held or
2160  *	from interrupt state @pri must be %GFP_ATOMIC
2161  *
2162  *	%NULL is returned on a memory allocation failure.
2163  */
skb_unshare(struct sk_buff * skb,gfp_t pri)2164 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
2165 					  gfp_t pri)
2166 {
2167 	might_sleep_if(gfpflags_allow_blocking(pri));
2168 	if (skb_cloned(skb)) {
2169 		struct sk_buff *nskb = skb_copy(skb, pri);
2170 
2171 		/* Free our shared copy */
2172 		if (likely(nskb))
2173 			consume_skb(skb);
2174 		else
2175 			kfree_skb(skb);
2176 		skb = nskb;
2177 	}
2178 	return skb;
2179 }
2180 
2181 /**
2182  *	skb_peek - peek at the head of an &sk_buff_head
2183  *	@list_: list to peek at
2184  *
2185  *	Peek an &sk_buff. Unlike most other operations you _MUST_
2186  *	be careful with this one. A peek leaves the buffer on the
2187  *	list and someone else may run off with it. You must hold
2188  *	the appropriate locks or have a private queue to do this.
2189  *
2190  *	Returns %NULL for an empty list or a pointer to the head element.
2191  *	The reference count is not incremented and the reference is therefore
2192  *	volatile. Use with caution.
2193  */
skb_peek(const struct sk_buff_head * list_)2194 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
2195 {
2196 	struct sk_buff *skb = list_->next;
2197 
2198 	if (skb == (struct sk_buff *)list_)
2199 		skb = NULL;
2200 	return skb;
2201 }
2202 
2203 /**
2204  *	__skb_peek - peek at the head of a non-empty &sk_buff_head
2205  *	@list_: list to peek at
2206  *
2207  *	Like skb_peek(), but the caller knows that the list is not empty.
2208  */
__skb_peek(const struct sk_buff_head * list_)2209 static inline struct sk_buff *__skb_peek(const struct sk_buff_head *list_)
2210 {
2211 	return list_->next;
2212 }
2213 
2214 /**
2215  *	skb_peek_next - peek skb following the given one from a queue
2216  *	@skb: skb to start from
2217  *	@list_: list to peek at
2218  *
2219  *	Returns %NULL when the end of the list is met or a pointer to the
2220  *	next element. The reference count is not incremented and the
2221  *	reference is therefore volatile. Use with caution.
2222  */
skb_peek_next(struct sk_buff * skb,const struct sk_buff_head * list_)2223 static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
2224 		const struct sk_buff_head *list_)
2225 {
2226 	struct sk_buff *next = skb->next;
2227 
2228 	if (next == (struct sk_buff *)list_)
2229 		next = NULL;
2230 	return next;
2231 }
2232 
2233 /**
2234  *	skb_peek_tail - peek at the tail of an &sk_buff_head
2235  *	@list_: list to peek at
2236  *
2237  *	Peek an &sk_buff. Unlike most other operations you _MUST_
2238  *	be careful with this one. A peek leaves the buffer on the
2239  *	list and someone else may run off with it. You must hold
2240  *	the appropriate locks or have a private queue to do this.
2241  *
2242  *	Returns %NULL for an empty list or a pointer to the tail element.
2243  *	The reference count is not incremented and the reference is therefore
2244  *	volatile. Use with caution.
2245  */
skb_peek_tail(const struct sk_buff_head * list_)2246 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
2247 {
2248 	struct sk_buff *skb = READ_ONCE(list_->prev);
2249 
2250 	if (skb == (struct sk_buff *)list_)
2251 		skb = NULL;
2252 	return skb;
2253 
2254 }
2255 
2256 /**
2257  *	skb_queue_len	- get queue length
2258  *	@list_: list to measure
2259  *
2260  *	Return the length of an &sk_buff queue.
2261  */
skb_queue_len(const struct sk_buff_head * list_)2262 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
2263 {
2264 	return list_->qlen;
2265 }
2266 
2267 /**
2268  *	skb_queue_len_lockless	- get queue length
2269  *	@list_: list to measure
2270  *
2271  *	Return the length of an &sk_buff queue.
2272  *	This variant can be used in lockless contexts.
2273  */
skb_queue_len_lockless(const struct sk_buff_head * list_)2274 static inline __u32 skb_queue_len_lockless(const struct sk_buff_head *list_)
2275 {
2276 	return READ_ONCE(list_->qlen);
2277 }
2278 
2279 /**
2280  *	__skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
2281  *	@list: queue to initialize
2282  *
2283  *	This initializes only the list and queue length aspects of
2284  *	an sk_buff_head object.  This allows to initialize the list
2285  *	aspects of an sk_buff_head without reinitializing things like
2286  *	the spinlock.  It can also be used for on-stack sk_buff_head
2287  *	objects where the spinlock is known to not be used.
2288  */
__skb_queue_head_init(struct sk_buff_head * list)2289 static inline void __skb_queue_head_init(struct sk_buff_head *list)
2290 {
2291 	list->prev = list->next = (struct sk_buff *)list;
2292 	list->qlen = 0;
2293 }
2294 
2295 /*
2296  * This function creates a split out lock class for each invocation;
2297  * this is needed for now since a whole lot of users of the skb-queue
2298  * infrastructure in drivers have different locking usage (in hardirq)
2299  * than the networking core (in softirq only). In the long run either the
2300  * network layer or drivers should need annotation to consolidate the
2301  * main types of usage into 3 classes.
2302  */
skb_queue_head_init(struct sk_buff_head * list)2303 static inline void skb_queue_head_init(struct sk_buff_head *list)
2304 {
2305 	spin_lock_init(&list->lock);
2306 	__skb_queue_head_init(list);
2307 }
2308 
skb_queue_head_init_class(struct sk_buff_head * list,struct lock_class_key * class)2309 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
2310 		struct lock_class_key *class)
2311 {
2312 	skb_queue_head_init(list);
2313 	lockdep_set_class(&list->lock, class);
2314 }
2315 
2316 /*
2317  *	Insert an sk_buff on a list.
2318  *
2319  *	The "__skb_xxxx()" functions are the non-atomic ones that
2320  *	can only be called with interrupts disabled.
2321  */
__skb_insert(struct sk_buff * newsk,struct sk_buff * prev,struct sk_buff * next,struct sk_buff_head * list)2322 static inline void __skb_insert(struct sk_buff *newsk,
2323 				struct sk_buff *prev, struct sk_buff *next,
2324 				struct sk_buff_head *list)
2325 {
2326 	/* See skb_queue_empty_lockless() and skb_peek_tail()
2327 	 * for the opposite READ_ONCE()
2328 	 */
2329 	WRITE_ONCE(newsk->next, next);
2330 	WRITE_ONCE(newsk->prev, prev);
2331 	WRITE_ONCE(((struct sk_buff_list *)next)->prev, newsk);
2332 	WRITE_ONCE(((struct sk_buff_list *)prev)->next, newsk);
2333 	WRITE_ONCE(list->qlen, list->qlen + 1);
2334 }
2335 
__skb_queue_splice(const struct sk_buff_head * list,struct sk_buff * prev,struct sk_buff * next)2336 static inline void __skb_queue_splice(const struct sk_buff_head *list,
2337 				      struct sk_buff *prev,
2338 				      struct sk_buff *next)
2339 {
2340 	struct sk_buff *first = list->next;
2341 	struct sk_buff *last = list->prev;
2342 
2343 	WRITE_ONCE(first->prev, prev);
2344 	WRITE_ONCE(prev->next, first);
2345 
2346 	WRITE_ONCE(last->next, next);
2347 	WRITE_ONCE(next->prev, last);
2348 }
2349 
2350 /**
2351  *	skb_queue_splice - join two skb lists, this is designed for stacks
2352  *	@list: the new list to add
2353  *	@head: the place to add it in the first list
2354  */
skb_queue_splice(const struct sk_buff_head * list,struct sk_buff_head * head)2355 static inline void skb_queue_splice(const struct sk_buff_head *list,
2356 				    struct sk_buff_head *head)
2357 {
2358 	if (!skb_queue_empty(list)) {
2359 		__skb_queue_splice(list, (struct sk_buff *) head, head->next);
2360 		head->qlen += list->qlen;
2361 	}
2362 }
2363 
2364 /**
2365  *	skb_queue_splice_init - join two skb lists and reinitialise the emptied list
2366  *	@list: the new list to add
2367  *	@head: the place to add it in the first list
2368  *
2369  *	The list at @list is reinitialised
2370  */
skb_queue_splice_init(struct sk_buff_head * list,struct sk_buff_head * head)2371 static inline void skb_queue_splice_init(struct sk_buff_head *list,
2372 					 struct sk_buff_head *head)
2373 {
2374 	if (!skb_queue_empty(list)) {
2375 		__skb_queue_splice(list, (struct sk_buff *) head, head->next);
2376 		head->qlen += list->qlen;
2377 		__skb_queue_head_init(list);
2378 	}
2379 }
2380 
2381 /**
2382  *	skb_queue_splice_tail - join two skb lists, each list being a queue
2383  *	@list: the new list to add
2384  *	@head: the place to add it in the first list
2385  */
skb_queue_splice_tail(const struct sk_buff_head * list,struct sk_buff_head * head)2386 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
2387 					 struct sk_buff_head *head)
2388 {
2389 	if (!skb_queue_empty(list)) {
2390 		__skb_queue_splice(list, head->prev, (struct sk_buff *) head);
2391 		head->qlen += list->qlen;
2392 	}
2393 }
2394 
2395 /**
2396  *	skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
2397  *	@list: the new list to add
2398  *	@head: the place to add it in the first list
2399  *
2400  *	Each of the lists is a queue.
2401  *	The list at @list is reinitialised
2402  */
skb_queue_splice_tail_init(struct sk_buff_head * list,struct sk_buff_head * head)2403 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
2404 					      struct sk_buff_head *head)
2405 {
2406 	if (!skb_queue_empty(list)) {
2407 		__skb_queue_splice(list, head->prev, (struct sk_buff *) head);
2408 		head->qlen += list->qlen;
2409 		__skb_queue_head_init(list);
2410 	}
2411 }
2412 
2413 /**
2414  *	__skb_queue_after - queue a buffer at the list head
2415  *	@list: list to use
2416  *	@prev: place after this buffer
2417  *	@newsk: buffer to queue
2418  *
2419  *	Queue a buffer int the middle of a list. This function takes no locks
2420  *	and you must therefore hold required locks before calling it.
2421  *
2422  *	A buffer cannot be placed on two lists at the same time.
2423  */
__skb_queue_after(struct sk_buff_head * list,struct sk_buff * prev,struct sk_buff * newsk)2424 static inline void __skb_queue_after(struct sk_buff_head *list,
2425 				     struct sk_buff *prev,
2426 				     struct sk_buff *newsk)
2427 {
2428 	__skb_insert(newsk, prev, ((struct sk_buff_list *)prev)->next, list);
2429 }
2430 
2431 void skb_append(struct sk_buff *old, struct sk_buff *newsk,
2432 		struct sk_buff_head *list);
2433 
__skb_queue_before(struct sk_buff_head * list,struct sk_buff * next,struct sk_buff * newsk)2434 static inline void __skb_queue_before(struct sk_buff_head *list,
2435 				      struct sk_buff *next,
2436 				      struct sk_buff *newsk)
2437 {
2438 	__skb_insert(newsk, ((struct sk_buff_list *)next)->prev, next, list);
2439 }
2440 
2441 /**
2442  *	__skb_queue_head - queue a buffer at the list head
2443  *	@list: list to use
2444  *	@newsk: buffer to queue
2445  *
2446  *	Queue a buffer at the start of a list. This function takes no locks
2447  *	and you must therefore hold required locks before calling it.
2448  *
2449  *	A buffer cannot be placed on two lists at the same time.
2450  */
__skb_queue_head(struct sk_buff_head * list,struct sk_buff * newsk)2451 static inline void __skb_queue_head(struct sk_buff_head *list,
2452 				    struct sk_buff *newsk)
2453 {
2454 	__skb_queue_after(list, (struct sk_buff *)list, newsk);
2455 }
2456 void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
2457 
2458 /**
2459  *	__skb_queue_tail - queue a buffer at the list tail
2460  *	@list: list to use
2461  *	@newsk: buffer to queue
2462  *
2463  *	Queue a buffer at the end of a list. This function takes no locks
2464  *	and you must therefore hold required locks before calling it.
2465  *
2466  *	A buffer cannot be placed on two lists at the same time.
2467  */
__skb_queue_tail(struct sk_buff_head * list,struct sk_buff * newsk)2468 static inline void __skb_queue_tail(struct sk_buff_head *list,
2469 				   struct sk_buff *newsk)
2470 {
2471 	__skb_queue_before(list, (struct sk_buff *)list, newsk);
2472 }
2473 void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
2474 
2475 /*
2476  * remove sk_buff from list. _Must_ be called atomically, and with
2477  * the list known..
2478  */
2479 void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
__skb_unlink(struct sk_buff * skb,struct sk_buff_head * list)2480 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
2481 {
2482 	struct sk_buff *next, *prev;
2483 
2484 	WRITE_ONCE(list->qlen, list->qlen - 1);
2485 	next	   = skb->next;
2486 	prev	   = skb->prev;
2487 	skb->next  = skb->prev = NULL;
2488 	WRITE_ONCE(next->prev, prev);
2489 	WRITE_ONCE(prev->next, next);
2490 }
2491 
2492 /**
2493  *	__skb_dequeue - remove from the head of the queue
2494  *	@list: list to dequeue from
2495  *
2496  *	Remove the head of the list. This function does not take any locks
2497  *	so must be used with appropriate locks held only. The head item is
2498  *	returned or %NULL if the list is empty.
2499  */
__skb_dequeue(struct sk_buff_head * list)2500 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
2501 {
2502 	struct sk_buff *skb = skb_peek(list);
2503 	if (skb)
2504 		__skb_unlink(skb, list);
2505 	return skb;
2506 }
2507 struct sk_buff *skb_dequeue(struct sk_buff_head *list);
2508 
2509 /**
2510  *	__skb_dequeue_tail - remove from the tail of the queue
2511  *	@list: list to dequeue from
2512  *
2513  *	Remove the tail of the list. This function does not take any locks
2514  *	so must be used with appropriate locks held only. The tail item is
2515  *	returned or %NULL if the list is empty.
2516  */
__skb_dequeue_tail(struct sk_buff_head * list)2517 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
2518 {
2519 	struct sk_buff *skb = skb_peek_tail(list);
2520 	if (skb)
2521 		__skb_unlink(skb, list);
2522 	return skb;
2523 }
2524 struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
2525 
2526 
skb_is_nonlinear(const struct sk_buff * skb)2527 static inline bool skb_is_nonlinear(const struct sk_buff *skb)
2528 {
2529 	return skb->data_len;
2530 }
2531 
skb_headlen(const struct sk_buff * skb)2532 static inline unsigned int skb_headlen(const struct sk_buff *skb)
2533 {
2534 	return skb->len - skb->data_len;
2535 }
2536 
__skb_pagelen(const struct sk_buff * skb)2537 static inline unsigned int __skb_pagelen(const struct sk_buff *skb)
2538 {
2539 	unsigned int i, len = 0;
2540 
2541 	for (i = skb_shinfo(skb)->nr_frags - 1; (int)i >= 0; i--)
2542 		len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
2543 	return len;
2544 }
2545 
skb_pagelen(const struct sk_buff * skb)2546 static inline unsigned int skb_pagelen(const struct sk_buff *skb)
2547 {
2548 	return skb_headlen(skb) + __skb_pagelen(skb);
2549 }
2550 
skb_frag_fill_netmem_desc(skb_frag_t * frag,netmem_ref netmem,int off,int size)2551 static inline void skb_frag_fill_netmem_desc(skb_frag_t *frag,
2552 					     netmem_ref netmem, int off,
2553 					     int size)
2554 {
2555 	frag->netmem = netmem;
2556 	frag->offset = off;
2557 	skb_frag_size_set(frag, size);
2558 }
2559 
skb_frag_fill_page_desc(skb_frag_t * frag,struct page * page,int off,int size)2560 static inline void skb_frag_fill_page_desc(skb_frag_t *frag,
2561 					   struct page *page,
2562 					   int off, int size)
2563 {
2564 	skb_frag_fill_netmem_desc(frag, page_to_netmem(page), off, size);
2565 }
2566 
__skb_fill_netmem_desc_noacc(struct skb_shared_info * shinfo,int i,netmem_ref netmem,int off,int size)2567 static inline void __skb_fill_netmem_desc_noacc(struct skb_shared_info *shinfo,
2568 						int i, netmem_ref netmem,
2569 						int off, int size)
2570 {
2571 	skb_frag_t *frag = &shinfo->frags[i];
2572 
2573 	skb_frag_fill_netmem_desc(frag, netmem, off, size);
2574 }
2575 
__skb_fill_page_desc_noacc(struct skb_shared_info * shinfo,int i,struct page * page,int off,int size)2576 static inline void __skb_fill_page_desc_noacc(struct skb_shared_info *shinfo,
2577 					      int i, struct page *page,
2578 					      int off, int size)
2579 {
2580 	__skb_fill_netmem_desc_noacc(shinfo, i, page_to_netmem(page), off,
2581 				     size);
2582 }
2583 
2584 /**
2585  * skb_len_add - adds a number to len fields of skb
2586  * @skb: buffer to add len to
2587  * @delta: number of bytes to add
2588  */
skb_len_add(struct sk_buff * skb,int delta)2589 static inline void skb_len_add(struct sk_buff *skb, int delta)
2590 {
2591 	skb->len += delta;
2592 	skb->data_len += delta;
2593 	skb->truesize += delta;
2594 }
2595 
2596 /**
2597  * __skb_fill_netmem_desc - initialise a fragment in an skb
2598  * @skb: buffer containing fragment to be initialised
2599  * @i: fragment index to initialise
2600  * @netmem: the netmem to use for this fragment
2601  * @off: the offset to the data with @page
2602  * @size: the length of the data
2603  *
2604  * Initialises the @i'th fragment of @skb to point to &size bytes at
2605  * offset @off within @page.
2606  *
2607  * Does not take any additional reference on the fragment.
2608  */
2609 static __always_inline void
__skb_fill_netmem_desc(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size)2610 __skb_fill_netmem_desc(struct sk_buff *skb, int i, netmem_ref netmem,
2611 		       int off, int size)
2612 {
2613 	struct page *page;
2614 
2615 	__skb_fill_netmem_desc_noacc(skb_shinfo(skb), i, netmem, off, size);
2616 
2617 	if (netmem_is_net_iov(netmem)) {
2618 		skb->unreadable = true;
2619 		return;
2620 	}
2621 
2622 	page = netmem_to_page(netmem);
2623 
2624 	/* Propagate page pfmemalloc to the skb if we can. The problem is
2625 	 * that not all callers have unique ownership of the page but rely
2626 	 * on page_is_pfmemalloc doing the right thing(tm).
2627 	 */
2628 	page = compound_head(page);
2629 	if (page_is_pfmemalloc(page))
2630 		skb->pfmemalloc = true;
2631 }
2632 
2633 static __always_inline void
__skb_fill_page_desc(struct sk_buff * skb,int i,struct page * page,int off,int size)2634 __skb_fill_page_desc(struct sk_buff *skb, int i, struct page *page,
2635 		     int off, int size)
2636 {
2637 	__skb_fill_netmem_desc(skb, i, page_to_netmem(page), off, size);
2638 }
2639 
2640 static __always_inline void
skb_fill_netmem_desc(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size)2641 skb_fill_netmem_desc(struct sk_buff *skb, int i, netmem_ref netmem,
2642 		     int off, int size)
2643 {
2644 	__skb_fill_netmem_desc(skb, i, netmem, off, size);
2645 	skb_shinfo(skb)->nr_frags = i + 1;
2646 }
2647 
2648 /**
2649  * skb_fill_page_desc - initialise a paged fragment in an skb
2650  * @skb: buffer containing fragment to be initialised
2651  * @i: paged fragment index to initialise
2652  * @page: the page to use for this fragment
2653  * @off: the offset to the data with @page
2654  * @size: the length of the data
2655  *
2656  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
2657  * @skb to point to @size bytes at offset @off within @page. In
2658  * addition updates @skb such that @i is the last fragment.
2659  *
2660  * Does not take any additional reference on the fragment.
2661  */
2662 static __always_inline void
skb_fill_page_desc(struct sk_buff * skb,int i,struct page * page,int off,int size)2663 skb_fill_page_desc(struct sk_buff *skb, int i, struct page *page,
2664 		   int off, int size)
2665 {
2666 	skb_fill_netmem_desc(skb, i, page_to_netmem(page), off, size);
2667 }
2668 
2669 /**
2670  * skb_fill_page_desc_noacc - initialise a paged fragment in an skb
2671  * @skb: buffer containing fragment to be initialised
2672  * @i: paged fragment index to initialise
2673  * @page: the page to use for this fragment
2674  * @off: the offset to the data with @page
2675  * @size: the length of the data
2676  *
2677  * Variant of skb_fill_page_desc() which does not deal with
2678  * pfmemalloc, if page is not owned by us.
2679  */
skb_fill_page_desc_noacc(struct sk_buff * skb,int i,struct page * page,int off,int size)2680 static inline void skb_fill_page_desc_noacc(struct sk_buff *skb, int i,
2681 					    struct page *page, int off,
2682 					    int size)
2683 {
2684 	struct skb_shared_info *shinfo = skb_shinfo(skb);
2685 
2686 	__skb_fill_page_desc_noacc(shinfo, i, page, off, size);
2687 	shinfo->nr_frags = i + 1;
2688 }
2689 
skb_add_rx_frag_netmem(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size,unsigned int truesize)2690 static inline void skb_add_rx_frag_netmem(struct sk_buff *skb, int i,
2691 					  netmem_ref netmem, int off,
2692 					  int size, unsigned int truesize)
2693 {
2694 	DEBUG_NET_WARN_ON_ONCE(size > truesize);
2695 
2696 	skb_fill_netmem_desc(skb, i, netmem, off, size);
2697 	skb->len += size;
2698 	skb->data_len += size;
2699 	skb->truesize += truesize;
2700 }
2701 
skb_add_rx_frag(struct sk_buff * skb,int i,struct page * page,int off,int size,unsigned int truesize)2702 static inline void skb_add_rx_frag(struct sk_buff *skb, int i,
2703 				   struct page *page, int off, int size,
2704 				   unsigned int truesize)
2705 {
2706 	skb_add_rx_frag_netmem(skb, i, page_to_netmem(page), off, size,
2707 			       truesize);
2708 }
2709 
2710 void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
2711 			  unsigned int truesize);
2712 
2713 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
2714 
2715 #ifdef NET_SKBUFF_DATA_USES_OFFSET
skb_tail_pointer(const struct sk_buff * skb)2716 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2717 {
2718 	return skb->head + skb->tail;
2719 }
2720 
skb_reset_tail_pointer(struct sk_buff * skb)2721 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2722 {
2723 	skb->tail = skb->data - skb->head;
2724 }
2725 
skb_set_tail_pointer(struct sk_buff * skb,const int offset)2726 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2727 {
2728 	skb_reset_tail_pointer(skb);
2729 	skb->tail += offset;
2730 }
2731 
2732 #else /* NET_SKBUFF_DATA_USES_OFFSET */
skb_tail_pointer(const struct sk_buff * skb)2733 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2734 {
2735 	return skb->tail;
2736 }
2737 
skb_reset_tail_pointer(struct sk_buff * skb)2738 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2739 {
2740 	skb->tail = skb->data;
2741 }
2742 
skb_set_tail_pointer(struct sk_buff * skb,const int offset)2743 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2744 {
2745 	skb->tail = skb->data + offset;
2746 }
2747 
2748 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
2749 
skb_assert_len(struct sk_buff * skb)2750 static inline void skb_assert_len(struct sk_buff *skb)
2751 {
2752 #ifdef CONFIG_DEBUG_NET
2753 	if (WARN_ONCE(!skb->len, "%s\n", __func__))
2754 		DO_ONCE_LITE(skb_dump, KERN_ERR, skb, false);
2755 #endif /* CONFIG_DEBUG_NET */
2756 }
2757 
2758 #if defined(CONFIG_FAIL_SKB_REALLOC)
2759 void skb_might_realloc(struct sk_buff *skb);
2760 #else
skb_might_realloc(struct sk_buff * skb)2761 static inline void skb_might_realloc(struct sk_buff *skb) {}
2762 #endif
2763 
2764 /*
2765  *	Add data to an sk_buff
2766  */
2767 void *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
2768 void *skb_put(struct sk_buff *skb, unsigned int len);
__skb_put(struct sk_buff * skb,unsigned int len)2769 static inline void *__skb_put(struct sk_buff *skb, unsigned int len)
2770 {
2771 	void *tmp = skb_tail_pointer(skb);
2772 	SKB_LINEAR_ASSERT(skb);
2773 	skb->tail += len;
2774 	skb->len  += len;
2775 	return tmp;
2776 }
2777 
__skb_put_zero(struct sk_buff * skb,unsigned int len)2778 static inline void *__skb_put_zero(struct sk_buff *skb, unsigned int len)
2779 {
2780 	void *tmp = __skb_put(skb, len);
2781 
2782 	memset(tmp, 0, len);
2783 	return tmp;
2784 }
2785 
__skb_put_data(struct sk_buff * skb,const void * data,unsigned int len)2786 static inline void *__skb_put_data(struct sk_buff *skb, const void *data,
2787 				   unsigned int len)
2788 {
2789 	void *tmp = __skb_put(skb, len);
2790 
2791 	memcpy(tmp, data, len);
2792 	return tmp;
2793 }
2794 
__skb_put_u8(struct sk_buff * skb,u8 val)2795 static inline void __skb_put_u8(struct sk_buff *skb, u8 val)
2796 {
2797 	*(u8 *)__skb_put(skb, 1) = val;
2798 }
2799 
skb_put_zero(struct sk_buff * skb,unsigned int len)2800 static inline void *skb_put_zero(struct sk_buff *skb, unsigned int len)
2801 {
2802 	void *tmp = skb_put(skb, len);
2803 
2804 	memset(tmp, 0, len);
2805 
2806 	return tmp;
2807 }
2808 
skb_put_data(struct sk_buff * skb,const void * data,unsigned int len)2809 static inline void *skb_put_data(struct sk_buff *skb, const void *data,
2810 				 unsigned int len)
2811 {
2812 	void *tmp = skb_put(skb, len);
2813 
2814 	memcpy(tmp, data, len);
2815 
2816 	return tmp;
2817 }
2818 
skb_put_u8(struct sk_buff * skb,u8 val)2819 static inline void skb_put_u8(struct sk_buff *skb, u8 val)
2820 {
2821 	*(u8 *)skb_put(skb, 1) = val;
2822 }
2823 
2824 void *skb_push(struct sk_buff *skb, unsigned int len);
__skb_push(struct sk_buff * skb,unsigned int len)2825 static inline void *__skb_push(struct sk_buff *skb, unsigned int len)
2826 {
2827 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2828 
2829 	skb->data -= len;
2830 	DEBUG_NET_WARN_ON_ONCE(skb->data < skb->head);
2831 	skb->len  += len;
2832 	return skb->data;
2833 }
2834 
2835 void *skb_pull(struct sk_buff *skb, unsigned int len);
__skb_pull(struct sk_buff * skb,unsigned int len)2836 static __always_inline void *__skb_pull(struct sk_buff *skb, unsigned int len)
2837 {
2838 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2839 
2840 	skb->len -= len;
2841 	if (unlikely(skb->len < skb->data_len)) {
2842 #if defined(CONFIG_DEBUG_NET)
2843 		skb->len += len;
2844 		pr_err("__skb_pull(len=%u)\n", len);
2845 		skb_dump(KERN_ERR, skb, false);
2846 #endif
2847 		BUG();
2848 	}
2849 	return skb->data += len;
2850 }
2851 
skb_pull_inline(struct sk_buff * skb,unsigned int len)2852 static inline void *skb_pull_inline(struct sk_buff *skb, unsigned int len)
2853 {
2854 	return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
2855 }
2856 
2857 void *skb_pull_data(struct sk_buff *skb, size_t len);
2858 
2859 void *__pskb_pull_tail(struct sk_buff *skb, int delta);
2860 
2861 static __always_inline enum skb_drop_reason
pskb_may_pull_reason(struct sk_buff * skb,unsigned int len)2862 pskb_may_pull_reason(struct sk_buff *skb, unsigned int len)
2863 {
2864 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2865 	skb_might_realloc(skb);
2866 
2867 	if (likely(len <= skb_headlen(skb)))
2868 		return SKB_NOT_DROPPED_YET;
2869 
2870 	if (unlikely(len > skb->len))
2871 		return SKB_DROP_REASON_PKT_TOO_SMALL;
2872 
2873 	if (unlikely(!__pskb_pull_tail(skb, len - skb_headlen(skb))))
2874 		return SKB_DROP_REASON_NOMEM;
2875 
2876 	return SKB_NOT_DROPPED_YET;
2877 }
2878 
2879 static __always_inline bool
pskb_may_pull(struct sk_buff * skb,unsigned int len)2880 pskb_may_pull(struct sk_buff *skb, unsigned int len)
2881 {
2882 	return pskb_may_pull_reason(skb, len) == SKB_NOT_DROPPED_YET;
2883 }
2884 
pskb_pull(struct sk_buff * skb,unsigned int len)2885 static __always_inline void *pskb_pull(struct sk_buff *skb, unsigned int len)
2886 {
2887 	if (!pskb_may_pull(skb, len))
2888 		return NULL;
2889 
2890 	skb->len -= len;
2891 	return skb->data += len;
2892 }
2893 
2894 void skb_condense(struct sk_buff *skb);
2895 
2896 /**
2897  *	skb_headroom - bytes at buffer head
2898  *	@skb: buffer to check
2899  *
2900  *	Return the number of bytes of free space at the head of an &sk_buff.
2901  */
skb_headroom(const struct sk_buff * skb)2902 static inline unsigned int skb_headroom(const struct sk_buff *skb)
2903 {
2904 	return skb->data - skb->head;
2905 }
2906 
2907 /**
2908  *	skb_tailroom - bytes at buffer end
2909  *	@skb: buffer to check
2910  *
2911  *	Return the number of bytes of free space at the tail of an sk_buff
2912  */
skb_tailroom(const struct sk_buff * skb)2913 static inline int skb_tailroom(const struct sk_buff *skb)
2914 {
2915 	return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
2916 }
2917 
2918 /**
2919  *	skb_availroom - bytes at buffer end
2920  *	@skb: buffer to check
2921  *
2922  *	Return the number of bytes of free space at the tail of an sk_buff
2923  *	allocated by sk_stream_alloc()
2924  */
skb_availroom(const struct sk_buff * skb)2925 static inline int skb_availroom(const struct sk_buff *skb)
2926 {
2927 	if (skb_is_nonlinear(skb))
2928 		return 0;
2929 
2930 	return skb->end - skb->tail - skb->reserved_tailroom;
2931 }
2932 
2933 /**
2934  *	skb_reserve - adjust headroom
2935  *	@skb: buffer to alter
2936  *	@len: bytes to move
2937  *
2938  *	Increase the headroom of an empty &sk_buff by reducing the tail
2939  *	room. This is only allowed for an empty buffer.
2940  */
skb_reserve(struct sk_buff * skb,int len)2941 static inline void skb_reserve(struct sk_buff *skb, int len)
2942 {
2943 	skb->data += len;
2944 	skb->tail += len;
2945 }
2946 
2947 /**
2948  *	skb_tailroom_reserve - adjust reserved_tailroom
2949  *	@skb: buffer to alter
2950  *	@mtu: maximum amount of headlen permitted
2951  *	@needed_tailroom: minimum amount of reserved_tailroom
2952  *
2953  *	Set reserved_tailroom so that headlen can be as large as possible but
2954  *	not larger than mtu and tailroom cannot be smaller than
2955  *	needed_tailroom.
2956  *	The required headroom should already have been reserved before using
2957  *	this function.
2958  */
skb_tailroom_reserve(struct sk_buff * skb,unsigned int mtu,unsigned int needed_tailroom)2959 static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
2960 					unsigned int needed_tailroom)
2961 {
2962 	SKB_LINEAR_ASSERT(skb);
2963 	if (mtu < skb_tailroom(skb) - needed_tailroom)
2964 		/* use at most mtu */
2965 		skb->reserved_tailroom = skb_tailroom(skb) - mtu;
2966 	else
2967 		/* use up to all available space */
2968 		skb->reserved_tailroom = needed_tailroom;
2969 }
2970 
2971 #define ENCAP_TYPE_ETHER	0
2972 #define ENCAP_TYPE_IPPROTO	1
2973 
skb_set_inner_protocol(struct sk_buff * skb,__be16 protocol)2974 static inline void skb_set_inner_protocol(struct sk_buff *skb,
2975 					  __be16 protocol)
2976 {
2977 	skb->inner_protocol = protocol;
2978 	skb->inner_protocol_type = ENCAP_TYPE_ETHER;
2979 }
2980 
skb_set_inner_ipproto(struct sk_buff * skb,__u8 ipproto)2981 static inline void skb_set_inner_ipproto(struct sk_buff *skb,
2982 					 __u8 ipproto)
2983 {
2984 	skb->inner_ipproto = ipproto;
2985 	skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
2986 }
2987 
skb_reset_inner_headers(struct sk_buff * skb)2988 static inline void skb_reset_inner_headers(struct sk_buff *skb)
2989 {
2990 	skb->inner_mac_header = skb->mac_header;
2991 	skb->inner_network_header = skb->network_header;
2992 	skb->inner_transport_header = skb->transport_header;
2993 }
2994 
skb_mac_header_was_set(const struct sk_buff * skb)2995 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2996 {
2997 	return skb->mac_header != (typeof(skb->mac_header))~0U;
2998 }
2999 
skb_reset_mac_len(struct sk_buff * skb)3000 static inline void skb_reset_mac_len(struct sk_buff *skb)
3001 {
3002 	if (!skb_mac_header_was_set(skb)) {
3003 		DEBUG_NET_WARN_ON_ONCE(1);
3004 		skb->mac_len = 0;
3005 	} else {
3006 		skb->mac_len = skb->network_header - skb->mac_header;
3007 	}
3008 }
3009 
skb_inner_transport_header(const struct sk_buff * skb)3010 static inline unsigned char *skb_inner_transport_header(const struct sk_buff
3011 							*skb)
3012 {
3013 	return skb->head + skb->inner_transport_header;
3014 }
3015 
skb_inner_transport_offset(const struct sk_buff * skb)3016 static inline int skb_inner_transport_offset(const struct sk_buff *skb)
3017 {
3018 	return skb_inner_transport_header(skb) - skb->data;
3019 }
3020 
skb_reset_inner_transport_header(struct sk_buff * skb)3021 static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
3022 {
3023 	long offset = skb->data - skb->head;
3024 
3025 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_transport_header))offset);
3026 	skb->inner_transport_header = offset;
3027 }
3028 
skb_set_inner_transport_header(struct sk_buff * skb,const int offset)3029 static inline void skb_set_inner_transport_header(struct sk_buff *skb,
3030 						   const int offset)
3031 {
3032 	skb_reset_inner_transport_header(skb);
3033 	skb->inner_transport_header += offset;
3034 }
3035 
skb_inner_network_header(const struct sk_buff * skb)3036 static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
3037 {
3038 	return skb->head + skb->inner_network_header;
3039 }
3040 
skb_reset_inner_network_header(struct sk_buff * skb)3041 static inline void skb_reset_inner_network_header(struct sk_buff *skb)
3042 {
3043 	long offset = skb->data - skb->head;
3044 
3045 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_network_header))offset);
3046 	skb->inner_network_header = offset;
3047 }
3048 
skb_set_inner_network_header(struct sk_buff * skb,const int offset)3049 static inline void skb_set_inner_network_header(struct sk_buff *skb,
3050 						const int offset)
3051 {
3052 	skb_reset_inner_network_header(skb);
3053 	skb->inner_network_header += offset;
3054 }
3055 
skb_inner_network_header_was_set(const struct sk_buff * skb)3056 static inline bool skb_inner_network_header_was_set(const struct sk_buff *skb)
3057 {
3058 	return skb->inner_network_header > 0;
3059 }
3060 
skb_inner_mac_header(const struct sk_buff * skb)3061 static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
3062 {
3063 	return skb->head + skb->inner_mac_header;
3064 }
3065 
skb_reset_inner_mac_header(struct sk_buff * skb)3066 static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
3067 {
3068 	long offset = skb->data - skb->head;
3069 
3070 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_mac_header))offset);
3071 	skb->inner_mac_header = offset;
3072 }
3073 
skb_set_inner_mac_header(struct sk_buff * skb,const int offset)3074 static inline void skb_set_inner_mac_header(struct sk_buff *skb,
3075 					    const int offset)
3076 {
3077 	skb_reset_inner_mac_header(skb);
3078 	skb->inner_mac_header += offset;
3079 }
skb_transport_header_was_set(const struct sk_buff * skb)3080 static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
3081 {
3082 	return skb->transport_header != (typeof(skb->transport_header))~0U;
3083 }
3084 
skb_unset_transport_header(struct sk_buff * skb)3085 static inline void skb_unset_transport_header(struct sk_buff *skb)
3086 {
3087 	skb->transport_header = (typeof(skb->transport_header))~0U;
3088 }
3089 
skb_transport_header(const struct sk_buff * skb)3090 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
3091 {
3092 	DEBUG_NET_WARN_ON_ONCE(!skb_transport_header_was_set(skb));
3093 	return skb->head + skb->transport_header;
3094 }
3095 
skb_reset_transport_header(struct sk_buff * skb)3096 static inline void skb_reset_transport_header(struct sk_buff *skb)
3097 {
3098 	long offset = skb->data - skb->head;
3099 
3100 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->transport_header))offset);
3101 	skb->transport_header = offset;
3102 }
3103 
3104 /**
3105  * skb_reset_transport_header_careful - conditionally reset transport header
3106  * @skb: buffer to alter
3107  *
3108  * Hardened version of skb_reset_transport_header().
3109  *
3110  * Returns: true if the operation was a success.
3111  */
3112 static inline bool __must_check
skb_reset_transport_header_careful(struct sk_buff * skb)3113 skb_reset_transport_header_careful(struct sk_buff *skb)
3114 {
3115 	long offset = skb->data - skb->head;
3116 
3117 	if (unlikely(offset != (typeof(skb->transport_header))offset))
3118 		return false;
3119 
3120 	if (unlikely(offset == (typeof(skb->transport_header))~0U))
3121 		return false;
3122 
3123 	skb->transport_header = offset;
3124 	return true;
3125 }
3126 
skb_set_transport_header(struct sk_buff * skb,const int offset)3127 static inline void skb_set_transport_header(struct sk_buff *skb,
3128 					    const int offset)
3129 {
3130 	skb_reset_transport_header(skb);
3131 	skb->transport_header += offset;
3132 }
3133 
3134 /**
3135  * skb_set_transport_header_careful - conditionally set transport header
3136  * @skb: buffer to alter
3137  * @offset: offset to add to skb->data
3138  *
3139  * Hardened version of skb_set_transport_header().
3140  *
3141  * Returns: true if the operation was a success.
3142  */
3143 static inline bool __must_check
skb_set_transport_header_careful(struct sk_buff * skb,const int offset)3144 skb_set_transport_header_careful(struct sk_buff *skb, const int offset)
3145 {
3146 	long thoff = skb->data - skb->head + offset;
3147 
3148 	if (unlikely(thoff != (typeof(skb->transport_header))thoff))
3149 		return false;
3150 
3151 	if (unlikely(thoff == (typeof(skb->transport_header))~0U))
3152 		return false;
3153 
3154 	skb->transport_header = thoff;
3155 	return true;
3156 }
3157 
skb_network_header(const struct sk_buff * skb)3158 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
3159 {
3160 	return skb->head + skb->network_header;
3161 }
3162 
skb_reset_network_header(struct sk_buff * skb)3163 static inline void skb_reset_network_header(struct sk_buff *skb)
3164 {
3165 	long offset = skb->data - skb->head;
3166 
3167 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->network_header))offset);
3168 	skb->network_header = offset;
3169 }
3170 
skb_set_network_header(struct sk_buff * skb,const int offset)3171 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
3172 {
3173 	skb_reset_network_header(skb);
3174 	skb->network_header += offset;
3175 }
3176 
skb_mac_header(const struct sk_buff * skb)3177 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
3178 {
3179 	DEBUG_NET_WARN_ON_ONCE(!skb_mac_header_was_set(skb));
3180 	return skb->head + skb->mac_header;
3181 }
3182 
skb_mac_offset(const struct sk_buff * skb)3183 static inline int skb_mac_offset(const struct sk_buff *skb)
3184 {
3185 	return skb_mac_header(skb) - skb->data;
3186 }
3187 
skb_mac_header_len(const struct sk_buff * skb)3188 static inline u32 skb_mac_header_len(const struct sk_buff *skb)
3189 {
3190 	DEBUG_NET_WARN_ON_ONCE(!skb_mac_header_was_set(skb));
3191 	return skb->network_header - skb->mac_header;
3192 }
3193 
skb_unset_mac_header(struct sk_buff * skb)3194 static inline void skb_unset_mac_header(struct sk_buff *skb)
3195 {
3196 	skb->mac_header = (typeof(skb->mac_header))~0U;
3197 }
3198 
skb_reset_mac_header(struct sk_buff * skb)3199 static inline void skb_reset_mac_header(struct sk_buff *skb)
3200 {
3201 	long offset = skb->data - skb->head;
3202 
3203 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->mac_header))offset);
3204 	skb->mac_header = offset;
3205 }
3206 
skb_set_mac_header(struct sk_buff * skb,const int offset)3207 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
3208 {
3209 	skb_reset_mac_header(skb);
3210 	skb->mac_header += offset;
3211 }
3212 
skb_pop_mac_header(struct sk_buff * skb)3213 static inline void skb_pop_mac_header(struct sk_buff *skb)
3214 {
3215 	skb->mac_header = skb->network_header;
3216 }
3217 
skb_probe_transport_header(struct sk_buff * skb)3218 static inline void skb_probe_transport_header(struct sk_buff *skb)
3219 {
3220 	struct flow_keys_basic keys;
3221 
3222 	if (skb_transport_header_was_set(skb))
3223 		return;
3224 
3225 	if (skb_flow_dissect_flow_keys_basic(NULL, skb, &keys,
3226 					     NULL, 0, 0, 0, 0))
3227 		skb_set_transport_header(skb, keys.control.thoff);
3228 }
3229 
skb_mac_header_rebuild(struct sk_buff * skb)3230 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
3231 {
3232 	if (skb_mac_header_was_set(skb)) {
3233 		const unsigned char *old_mac = skb_mac_header(skb);
3234 
3235 		skb_set_mac_header(skb, -skb->mac_len);
3236 		memmove(skb_mac_header(skb), old_mac, skb->mac_len);
3237 	}
3238 }
3239 
3240 /* Move the full mac header up to current network_header.
3241  * Leaves skb->data pointing at offset skb->mac_len into the mac_header.
3242  * Must be provided the complete mac header length.
3243  */
skb_mac_header_rebuild_full(struct sk_buff * skb,u32 full_mac_len)3244 static inline void skb_mac_header_rebuild_full(struct sk_buff *skb, u32 full_mac_len)
3245 {
3246 	if (skb_mac_header_was_set(skb)) {
3247 		const unsigned char *old_mac = skb_mac_header(skb);
3248 
3249 		skb_set_mac_header(skb, -full_mac_len);
3250 		memmove(skb_mac_header(skb), old_mac, full_mac_len);
3251 		__skb_push(skb, full_mac_len - skb->mac_len);
3252 	}
3253 }
3254 
skb_checksum_start_offset(const struct sk_buff * skb)3255 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
3256 {
3257 	return skb->csum_start - skb_headroom(skb);
3258 }
3259 
skb_checksum_start(const struct sk_buff * skb)3260 static inline unsigned char *skb_checksum_start(const struct sk_buff *skb)
3261 {
3262 	return skb->head + skb->csum_start;
3263 }
3264 
skb_transport_offset(const struct sk_buff * skb)3265 static inline int skb_transport_offset(const struct sk_buff *skb)
3266 {
3267 	return skb_transport_header(skb) - skb->data;
3268 }
3269 
skb_network_header_len(const struct sk_buff * skb)3270 static inline u32 skb_network_header_len(const struct sk_buff *skb)
3271 {
3272 	DEBUG_NET_WARN_ON_ONCE(!skb_transport_header_was_set(skb));
3273 	return skb->transport_header - skb->network_header;
3274 }
3275 
skb_inner_network_header_len(const struct sk_buff * skb)3276 static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
3277 {
3278 	return skb->inner_transport_header - skb->inner_network_header;
3279 }
3280 
skb_network_offset(const struct sk_buff * skb)3281 static inline int skb_network_offset(const struct sk_buff *skb)
3282 {
3283 	return skb_network_header(skb) - skb->data;
3284 }
3285 
skb_inner_network_offset(const struct sk_buff * skb)3286 static inline int skb_inner_network_offset(const struct sk_buff *skb)
3287 {
3288 	return skb_inner_network_header(skb) - skb->data;
3289 }
3290 
3291 static inline enum skb_drop_reason
pskb_network_may_pull_reason(struct sk_buff * skb,unsigned int len)3292 pskb_network_may_pull_reason(struct sk_buff *skb, unsigned int len)
3293 {
3294 	return pskb_may_pull_reason(skb, skb_network_offset(skb) + len);
3295 }
3296 
pskb_network_may_pull(struct sk_buff * skb,unsigned int len)3297 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
3298 {
3299 	return pskb_network_may_pull_reason(skb, len) == SKB_NOT_DROPPED_YET;
3300 }
3301 
3302 /*
3303  * CPUs often take a performance hit when accessing unaligned memory
3304  * locations. The actual performance hit varies, it can be small if the
3305  * hardware handles it or large if we have to take an exception and fix it
3306  * in software.
3307  *
3308  * Since an ethernet header is 14 bytes network drivers often end up with
3309  * the IP header at an unaligned offset. The IP header can be aligned by
3310  * shifting the start of the packet by 2 bytes. Drivers should do this
3311  * with:
3312  *
3313  * skb_reserve(skb, NET_IP_ALIGN);
3314  *
3315  * The downside to this alignment of the IP header is that the DMA is now
3316  * unaligned. On some architectures the cost of an unaligned DMA is high
3317  * and this cost outweighs the gains made by aligning the IP header.
3318  *
3319  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
3320  * to be overridden.
3321  */
3322 #ifndef NET_IP_ALIGN
3323 #define NET_IP_ALIGN	2
3324 #endif
3325 
3326 /*
3327  * The networking layer reserves some headroom in skb data (via
3328  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
3329  * the header has to grow. In the default case, if the header has to grow
3330  * 32 bytes or less we avoid the reallocation.
3331  *
3332  * Unfortunately this headroom changes the DMA alignment of the resulting
3333  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
3334  * on some architectures. An architecture can override this value,
3335  * perhaps setting it to a cacheline in size (since that will maintain
3336  * cacheline alignment of the DMA). It must be a power of 2.
3337  *
3338  * Various parts of the networking layer expect at least 32 bytes of
3339  * headroom, you should not reduce this.
3340  *
3341  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
3342  * to reduce average number of cache lines per packet.
3343  * get_rps_cpu() for example only access one 64 bytes aligned block :
3344  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
3345  */
3346 #ifndef NET_SKB_PAD
3347 #define NET_SKB_PAD	max(32, L1_CACHE_BYTES)
3348 #endif
3349 
3350 int ___pskb_trim(struct sk_buff *skb, unsigned int len);
3351 
__skb_set_length(struct sk_buff * skb,unsigned int len)3352 static inline void __skb_set_length(struct sk_buff *skb, unsigned int len)
3353 {
3354 	if (WARN_ON(skb_is_nonlinear(skb)))
3355 		return;
3356 	skb->len = len;
3357 	skb_set_tail_pointer(skb, len);
3358 }
3359 
__skb_trim(struct sk_buff * skb,unsigned int len)3360 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
3361 {
3362 	__skb_set_length(skb, len);
3363 }
3364 
3365 void skb_trim(struct sk_buff *skb, unsigned int len);
3366 
__pskb_trim(struct sk_buff * skb,unsigned int len)3367 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
3368 {
3369 	if (skb->data_len)
3370 		return ___pskb_trim(skb, len);
3371 	__skb_trim(skb, len);
3372 	return 0;
3373 }
3374 
pskb_trim(struct sk_buff * skb,unsigned int len)3375 static __always_inline int pskb_trim(struct sk_buff *skb, unsigned int len)
3376 {
3377 	skb_might_realloc(skb);
3378 	return (len < skb->len) ? __pskb_trim(skb, len) : 0;
3379 }
3380 
3381 /**
3382  *	pskb_trim_unique - remove end from a paged unique (not cloned) buffer
3383  *	@skb: buffer to alter
3384  *	@len: new length
3385  *
3386  *	This is identical to pskb_trim except that the caller knows that
3387  *	the skb is not cloned so we should never get an error due to out-
3388  *	of-memory.
3389  */
pskb_trim_unique(struct sk_buff * skb,unsigned int len)3390 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
3391 {
3392 	int err = pskb_trim(skb, len);
3393 	BUG_ON(err);
3394 }
3395 
__skb_grow(struct sk_buff * skb,unsigned int len)3396 static inline int __skb_grow(struct sk_buff *skb, unsigned int len)
3397 {
3398 	unsigned int diff = len - skb->len;
3399 
3400 	if (skb_tailroom(skb) < diff) {
3401 		int ret = pskb_expand_head(skb, 0, diff - skb_tailroom(skb),
3402 					   GFP_ATOMIC);
3403 		if (ret)
3404 			return ret;
3405 	}
3406 	__skb_set_length(skb, len);
3407 	return 0;
3408 }
3409 
3410 /**
3411  *	skb_orphan - orphan a buffer
3412  *	@skb: buffer to orphan
3413  *
3414  *	If a buffer currently has an owner then we call the owner's
3415  *	destructor function and make the @skb unowned. The buffer continues
3416  *	to exist but is no longer charged to its former owner.
3417  */
skb_orphan(struct sk_buff * skb)3418 static __always_inline void skb_orphan(struct sk_buff *skb)
3419 {
3420 	if (skb->destructor) {
3421 		skb->destructor(skb);
3422 		skb->destructor = NULL;
3423 		skb->sk		= NULL;
3424 	} else {
3425 		BUG_ON(skb->sk);
3426 	}
3427 }
3428 
3429 /**
3430  *	skb_orphan_frags - orphan the frags contained in a buffer
3431  *	@skb: buffer to orphan frags from
3432  *	@gfp_mask: allocation mask for replacement pages
3433  *
3434  *	For each frag in the SKB which needs a destructor (i.e. has an
3435  *	owner) create a copy of that frag and release the original
3436  *	page by calling the destructor.
3437  */
skb_orphan_frags(struct sk_buff * skb,gfp_t gfp_mask)3438 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
3439 {
3440 	if (likely(!skb_zcopy(skb)))
3441 		return 0;
3442 	if (skb_shinfo(skb)->flags & SKBFL_DONT_ORPHAN)
3443 		return 0;
3444 	return skb_copy_ubufs(skb, gfp_mask);
3445 }
3446 
3447 /* Frags must be orphaned, even if refcounted, if skb might loop to rx path */
skb_orphan_frags_rx(struct sk_buff * skb,gfp_t gfp_mask)3448 static inline int skb_orphan_frags_rx(struct sk_buff *skb, gfp_t gfp_mask)
3449 {
3450 	if (likely(!skb_zcopy(skb)))
3451 		return 0;
3452 	return skb_copy_ubufs(skb, gfp_mask);
3453 }
3454 
3455 /**
3456  *	__skb_queue_purge_reason - empty a list
3457  *	@list: list to empty
3458  *	@reason: drop reason
3459  *
3460  *	Delete all buffers on an &sk_buff list. Each buffer is removed from
3461  *	the list and one reference dropped. This function does not take the
3462  *	list lock and the caller must hold the relevant locks to use it.
3463  */
__skb_queue_purge_reason(struct sk_buff_head * list,enum skb_drop_reason reason)3464 static inline void __skb_queue_purge_reason(struct sk_buff_head *list,
3465 					    enum skb_drop_reason reason)
3466 {
3467 	struct sk_buff *skb;
3468 
3469 	while ((skb = __skb_dequeue(list)) != NULL)
3470 		kfree_skb_reason(skb, reason);
3471 }
3472 
__skb_queue_purge(struct sk_buff_head * list)3473 static inline void __skb_queue_purge(struct sk_buff_head *list)
3474 {
3475 	__skb_queue_purge_reason(list, SKB_DROP_REASON_QUEUE_PURGE);
3476 }
3477 
3478 void skb_queue_purge_reason(struct sk_buff_head *list,
3479 			    enum skb_drop_reason reason);
3480 
skb_queue_purge(struct sk_buff_head * list)3481 static inline void skb_queue_purge(struct sk_buff_head *list)
3482 {
3483 	skb_queue_purge_reason(list, SKB_DROP_REASON_QUEUE_PURGE);
3484 }
3485 
3486 unsigned int skb_rbtree_purge(struct rb_root *root);
3487 void skb_errqueue_purge(struct sk_buff_head *list);
3488 
3489 void *__netdev_alloc_frag_align(unsigned int fragsz, unsigned int align_mask);
3490 
3491 /**
3492  * netdev_alloc_frag - allocate a page fragment
3493  * @fragsz: fragment size
3494  *
3495  * Allocates a frag from a page for receive buffer.
3496  * Uses GFP_ATOMIC allocations.
3497  */
netdev_alloc_frag(unsigned int fragsz)3498 static inline void *netdev_alloc_frag(unsigned int fragsz)
3499 {
3500 	return __netdev_alloc_frag_align(fragsz, ~0u);
3501 }
3502 
netdev_alloc_frag_align(unsigned int fragsz,unsigned int align)3503 static inline void *netdev_alloc_frag_align(unsigned int fragsz,
3504 					    unsigned int align)
3505 {
3506 	WARN_ON_ONCE(!is_power_of_2(align));
3507 	return __netdev_alloc_frag_align(fragsz, -align);
3508 }
3509 
3510 struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
3511 				   gfp_t gfp_mask);
3512 
3513 /**
3514  *	netdev_alloc_skb - allocate an skbuff for rx on a specific device
3515  *	@dev: network device to receive on
3516  *	@length: length to allocate
3517  *
3518  *	Allocate a new &sk_buff and assign it a usage count of one. The
3519  *	buffer has unspecified headroom built in. Users should allocate
3520  *	the headroom they think they need without accounting for the
3521  *	built in space. The built in space is used for optimisations.
3522  *
3523  *	%NULL is returned if there is no free memory. Although this function
3524  *	allocates memory it can be called from an interrupt.
3525  */
netdev_alloc_skb(struct net_device * dev,unsigned int length)3526 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
3527 					       unsigned int length)
3528 {
3529 	return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
3530 }
3531 
3532 /* legacy helper around __netdev_alloc_skb() */
__dev_alloc_skb(unsigned int length,gfp_t gfp_mask)3533 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
3534 					      gfp_t gfp_mask)
3535 {
3536 	return __netdev_alloc_skb(NULL, length, gfp_mask);
3537 }
3538 
3539 /* legacy helper around netdev_alloc_skb() */
dev_alloc_skb(unsigned int length)3540 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
3541 {
3542 	return netdev_alloc_skb(NULL, length);
3543 }
3544 
3545 
__netdev_alloc_skb_ip_align(struct net_device * dev,unsigned int length,gfp_t gfp)3546 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
3547 		unsigned int length, gfp_t gfp)
3548 {
3549 	struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
3550 
3551 	if (NET_IP_ALIGN && skb)
3552 		skb_reserve(skb, NET_IP_ALIGN);
3553 	return skb;
3554 }
3555 
netdev_alloc_skb_ip_align(struct net_device * dev,unsigned int length)3556 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
3557 		unsigned int length)
3558 {
3559 	return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
3560 }
3561 
skb_free_frag(void * addr)3562 static inline void skb_free_frag(void *addr)
3563 {
3564 	page_frag_free(addr);
3565 }
3566 
3567 void *__napi_alloc_frag_align(unsigned int fragsz, unsigned int align_mask);
3568 
napi_alloc_frag(unsigned int fragsz)3569 static inline void *napi_alloc_frag(unsigned int fragsz)
3570 {
3571 	return __napi_alloc_frag_align(fragsz, ~0u);
3572 }
3573 
napi_alloc_frag_align(unsigned int fragsz,unsigned int align)3574 static inline void *napi_alloc_frag_align(unsigned int fragsz,
3575 					  unsigned int align)
3576 {
3577 	WARN_ON_ONCE(!is_power_of_2(align));
3578 	return __napi_alloc_frag_align(fragsz, -align);
3579 }
3580 
3581 struct sk_buff *napi_alloc_skb(struct napi_struct *napi, unsigned int length);
3582 void napi_consume_skb(struct sk_buff *skb, int budget);
3583 
3584 void napi_skb_free_stolen_head(struct sk_buff *skb);
3585 void __napi_kfree_skb(struct sk_buff *skb, enum skb_drop_reason reason);
3586 
3587 /**
3588  * __dev_alloc_pages - allocate page for network Rx
3589  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
3590  * @order: size of the allocation
3591  *
3592  * Allocate a new page.
3593  *
3594  * %NULL is returned if there is no free memory.
3595 */
__dev_alloc_pages_noprof(gfp_t gfp_mask,unsigned int order)3596 static inline struct page *__dev_alloc_pages_noprof(gfp_t gfp_mask,
3597 					     unsigned int order)
3598 {
3599 	/* This piece of code contains several assumptions.
3600 	 * 1.  This is for device Rx, therefore a cold page is preferred.
3601 	 * 2.  The expectation is the user wants a compound page.
3602 	 * 3.  If requesting a order 0 page it will not be compound
3603 	 *     due to the check to see if order has a value in prep_new_page
3604 	 * 4.  __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
3605 	 *     code in alloc_flags_slowpath() that should be enforcing this.
3606 	 */
3607 	gfp_mask |= __GFP_COMP | __GFP_MEMALLOC;
3608 
3609 	return alloc_pages_node_noprof(NUMA_NO_NODE, gfp_mask, order);
3610 }
3611 #define __dev_alloc_pages(...)	alloc_hooks(__dev_alloc_pages_noprof(__VA_ARGS__))
3612 
3613 /*
3614  * This specialized allocator has to be a macro for its allocations to be
3615  * accounted separately (to have a separate alloc_tag).
3616  */
3617 #define dev_alloc_pages(_order) __dev_alloc_pages(GFP_ATOMIC | __GFP_NOWARN, _order)
3618 
3619 /**
3620  * __dev_alloc_page - allocate a page for network Rx
3621  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
3622  *
3623  * Allocate a new page.
3624  *
3625  * %NULL is returned if there is no free memory.
3626  */
__dev_alloc_page_noprof(gfp_t gfp_mask)3627 static inline struct page *__dev_alloc_page_noprof(gfp_t gfp_mask)
3628 {
3629 	return __dev_alloc_pages_noprof(gfp_mask, 0);
3630 }
3631 #define __dev_alloc_page(...)	alloc_hooks(__dev_alloc_page_noprof(__VA_ARGS__))
3632 
3633 /*
3634  * This specialized allocator has to be a macro for its allocations to be
3635  * accounted separately (to have a separate alloc_tag).
3636  */
3637 #define dev_alloc_page()	dev_alloc_pages(0)
3638 
3639 /**
3640  * dev_page_is_reusable - check whether a page can be reused for network Rx
3641  * @page: the page to test
3642  *
3643  * A page shouldn't be considered for reusing/recycling if it was allocated
3644  * under memory pressure or at a distant memory node.
3645  *
3646  * Returns: false if this page should be returned to page allocator, true
3647  * otherwise.
3648  */
dev_page_is_reusable(const struct page * page)3649 static inline bool dev_page_is_reusable(const struct page *page)
3650 {
3651 	return likely(page_to_nid(page) == numa_mem_id() &&
3652 		      !page_is_pfmemalloc(page));
3653 }
3654 
3655 /**
3656  *	skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
3657  *	@page: The page that was allocated from skb_alloc_page
3658  *	@skb: The skb that may need pfmemalloc set
3659  */
skb_propagate_pfmemalloc(const struct page * page,struct sk_buff * skb)3660 static inline void skb_propagate_pfmemalloc(const struct page *page,
3661 					    struct sk_buff *skb)
3662 {
3663 	if (page_is_pfmemalloc(page))
3664 		skb->pfmemalloc = true;
3665 }
3666 
3667 /**
3668  * skb_frag_off() - Returns the offset of a skb fragment
3669  * @frag: the paged fragment
3670  */
skb_frag_off(const skb_frag_t * frag)3671 static inline unsigned int skb_frag_off(const skb_frag_t *frag)
3672 {
3673 	return frag->offset;
3674 }
3675 
3676 /**
3677  * skb_frag_off_add() - Increments the offset of a skb fragment by @delta
3678  * @frag: skb fragment
3679  * @delta: value to add
3680  */
skb_frag_off_add(skb_frag_t * frag,int delta)3681 static inline void skb_frag_off_add(skb_frag_t *frag, int delta)
3682 {
3683 	frag->offset += delta;
3684 }
3685 
3686 /**
3687  * skb_frag_off_set() - Sets the offset of a skb fragment
3688  * @frag: skb fragment
3689  * @offset: offset of fragment
3690  */
skb_frag_off_set(skb_frag_t * frag,unsigned int offset)3691 static inline void skb_frag_off_set(skb_frag_t *frag, unsigned int offset)
3692 {
3693 	frag->offset = offset;
3694 }
3695 
3696 /**
3697  * skb_frag_off_copy() - Sets the offset of a skb fragment from another fragment
3698  * @fragto: skb fragment where offset is set
3699  * @fragfrom: skb fragment offset is copied from
3700  */
skb_frag_off_copy(skb_frag_t * fragto,const skb_frag_t * fragfrom)3701 static inline void skb_frag_off_copy(skb_frag_t *fragto,
3702 				     const skb_frag_t *fragfrom)
3703 {
3704 	fragto->offset = fragfrom->offset;
3705 }
3706 
3707 /* Return: true if the skb_frag contains a net_iov. */
skb_frag_is_net_iov(const skb_frag_t * frag)3708 static inline bool skb_frag_is_net_iov(const skb_frag_t *frag)
3709 {
3710 	return netmem_is_net_iov(frag->netmem);
3711 }
3712 
3713 /**
3714  * skb_frag_net_iov - retrieve the net_iov referred to by fragment
3715  * @frag: the fragment
3716  *
3717  * Return: the &struct net_iov associated with @frag. Returns NULL if this
3718  * frag has no associated net_iov.
3719  */
skb_frag_net_iov(const skb_frag_t * frag)3720 static inline struct net_iov *skb_frag_net_iov(const skb_frag_t *frag)
3721 {
3722 	if (!skb_frag_is_net_iov(frag))
3723 		return NULL;
3724 
3725 	return netmem_to_net_iov(frag->netmem);
3726 }
3727 
3728 /**
3729  * skb_frag_page - retrieve the page referred to by a paged fragment
3730  * @frag: the paged fragment
3731  *
3732  * Return: the &struct page associated with @frag. Returns NULL if this frag
3733  * has no associated page.
3734  */
skb_frag_page(const skb_frag_t * frag)3735 static inline struct page *skb_frag_page(const skb_frag_t *frag)
3736 {
3737 	if (skb_frag_is_net_iov(frag))
3738 		return NULL;
3739 
3740 	return netmem_to_page(frag->netmem);
3741 }
3742 
3743 /**
3744  * skb_frag_netmem - retrieve the netmem referred to by a fragment
3745  * @frag: the fragment
3746  *
3747  * Return: the &netmem_ref associated with @frag.
3748  */
skb_frag_netmem(const skb_frag_t * frag)3749 static inline netmem_ref skb_frag_netmem(const skb_frag_t *frag)
3750 {
3751 	return frag->netmem;
3752 }
3753 
3754 int skb_pp_cow_data(struct page_pool *pool, struct sk_buff **pskb,
3755 		    unsigned int headroom);
3756 int skb_cow_data_for_xdp(struct page_pool *pool, struct sk_buff **pskb,
3757 			 const struct bpf_prog *prog);
3758 
3759 /**
3760  * skb_frag_address - gets the address of the data contained in a paged fragment
3761  * @frag: the paged fragment buffer
3762  *
3763  * Returns: the address of the data within @frag. The page must already
3764  * be mapped.
3765  */
skb_frag_address(const skb_frag_t * frag)3766 static inline void *skb_frag_address(const skb_frag_t *frag)
3767 {
3768 	if (!skb_frag_page(frag))
3769 		return NULL;
3770 
3771 	return page_address(skb_frag_page(frag)) + skb_frag_off(frag);
3772 }
3773 
3774 /**
3775  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
3776  * @frag: the paged fragment buffer
3777  *
3778  * Returns: the address of the data within @frag. Checks that the page
3779  * is mapped and returns %NULL otherwise.
3780  */
skb_frag_address_safe(const skb_frag_t * frag)3781 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
3782 {
3783 	struct page *page = skb_frag_page(frag);
3784 	void *ptr;
3785 
3786 	if (!page)
3787 		return NULL;
3788 
3789 	ptr = page_address(page);
3790 	if (unlikely(!ptr))
3791 		return NULL;
3792 
3793 	return ptr + skb_frag_off(frag);
3794 }
3795 
3796 /**
3797  * skb_frag_phys - gets the physical address of the data in a paged fragment
3798  * @frag: the paged fragment buffer
3799  *
3800  * Returns: the physical address of the data within @frag.
3801  */
skb_frag_phys(const skb_frag_t * frag)3802 static inline phys_addr_t skb_frag_phys(const skb_frag_t *frag)
3803 {
3804 	return page_to_phys(skb_frag_page(frag)) + skb_frag_off(frag);
3805 }
3806 
3807 /**
3808  * skb_frag_page_copy() - sets the page in a fragment from another fragment
3809  * @fragto: skb fragment where page is set
3810  * @fragfrom: skb fragment page is copied from
3811  */
skb_frag_page_copy(skb_frag_t * fragto,const skb_frag_t * fragfrom)3812 static inline void skb_frag_page_copy(skb_frag_t *fragto,
3813 				      const skb_frag_t *fragfrom)
3814 {
3815 	fragto->netmem = fragfrom->netmem;
3816 }
3817 
3818 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
3819 
3820 /**
3821  * __skb_frag_dma_map - maps a paged fragment via the DMA API
3822  * @dev: the device to map the fragment to
3823  * @frag: the paged fragment to map
3824  * @offset: the offset within the fragment (starting at the
3825  *          fragment's own offset)
3826  * @size: the number of bytes to map
3827  * @dir: the direction of the mapping (``PCI_DMA_*``)
3828  *
3829  * Maps the page associated with @frag to @device.
3830  */
__skb_frag_dma_map(struct device * dev,const skb_frag_t * frag,size_t offset,size_t size,enum dma_data_direction dir)3831 static inline dma_addr_t __skb_frag_dma_map(struct device *dev,
3832 					    const skb_frag_t *frag,
3833 					    size_t offset, size_t size,
3834 					    enum dma_data_direction dir)
3835 {
3836 	if (skb_frag_is_net_iov(frag)) {
3837 		return netmem_to_net_iov(frag->netmem)->desc.dma_addr +
3838 		       offset + frag->offset;
3839 	}
3840 	return dma_map_page(dev, skb_frag_page(frag),
3841 			    skb_frag_off(frag) + offset, size, dir);
3842 }
3843 
3844 #define skb_frag_dma_map(dev, frag, ...)				\
3845 	CONCATENATE(_skb_frag_dma_map,					\
3846 		    COUNT_ARGS(__VA_ARGS__))(dev, frag, ##__VA_ARGS__)
3847 
3848 #define __skb_frag_dma_map1(dev, frag, offset, uf, uo) ({		\
3849 	const skb_frag_t *uf = (frag);					\
3850 	size_t uo = (offset);						\
3851 									\
3852 	__skb_frag_dma_map(dev, uf, uo, skb_frag_size(uf) - uo,		\
3853 			   DMA_TO_DEVICE);				\
3854 })
3855 #define _skb_frag_dma_map1(dev, frag, offset)				\
3856 	__skb_frag_dma_map1(dev, frag, offset, __UNIQUE_ID(frag_),	\
3857 			    __UNIQUE_ID(offset_))
3858 #define _skb_frag_dma_map0(dev, frag)					\
3859 	_skb_frag_dma_map1(dev, frag, 0)
3860 #define _skb_frag_dma_map2(dev, frag, offset, size)			\
3861 	__skb_frag_dma_map(dev, frag, offset, size, DMA_TO_DEVICE)
3862 #define _skb_frag_dma_map3(dev, frag, offset, size, dir)		\
3863 	__skb_frag_dma_map(dev, frag, offset, size, dir)
3864 
pskb_copy(struct sk_buff * skb,gfp_t gfp_mask)3865 static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
3866 					gfp_t gfp_mask)
3867 {
3868 	return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
3869 }
3870 
3871 
pskb_copy_for_clone(struct sk_buff * skb,gfp_t gfp_mask)3872 static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
3873 						  gfp_t gfp_mask)
3874 {
3875 	return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
3876 }
3877 
3878 
3879 /**
3880  *	skb_clone_writable - is the header of a clone writable
3881  *	@skb: buffer to check
3882  *	@len: length up to which to write
3883  *
3884  *	Returns true if modifying the header part of the cloned buffer
3885  *	does not requires the data to be copied.
3886  */
skb_clone_writable(const struct sk_buff * skb,unsigned int len)3887 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
3888 {
3889 	return !skb_header_cloned(skb) &&
3890 	       skb_headroom(skb) + len <= skb->hdr_len;
3891 }
3892 
skb_try_make_writable(struct sk_buff * skb,unsigned int write_len)3893 static inline int skb_try_make_writable(struct sk_buff *skb,
3894 					unsigned int write_len)
3895 {
3896 	return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
3897 	       pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
3898 }
3899 
__skb_cow(struct sk_buff * skb,unsigned int headroom,int cloned)3900 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
3901 			    int cloned)
3902 {
3903 	int delta = 0;
3904 
3905 	if (headroom > skb_headroom(skb))
3906 		delta = headroom - skb_headroom(skb);
3907 
3908 	if (delta || cloned)
3909 		return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
3910 					GFP_ATOMIC);
3911 	return 0;
3912 }
3913 
3914 /**
3915  *	skb_cow - copy header of skb when it is required
3916  *	@skb: buffer to cow
3917  *	@headroom: needed headroom
3918  *
3919  *	If the skb passed lacks sufficient headroom or its data part
3920  *	is shared, data is reallocated. If reallocation fails, an error
3921  *	is returned and original skb is not changed.
3922  *
3923  *	The result is skb with writable area skb->head...skb->tail
3924  *	and at least @headroom of space at head.
3925  */
skb_cow(struct sk_buff * skb,unsigned int headroom)3926 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
3927 {
3928 	return __skb_cow(skb, headroom, skb_cloned(skb));
3929 }
3930 
3931 /**
3932  *	skb_cow_head - skb_cow but only making the head writable
3933  *	@skb: buffer to cow
3934  *	@headroom: needed headroom
3935  *
3936  *	This function is identical to skb_cow except that we replace the
3937  *	skb_cloned check by skb_header_cloned.  It should be used when
3938  *	you only need to push on some header and do not need to modify
3939  *	the data.
3940  */
skb_cow_head(struct sk_buff * skb,unsigned int headroom)3941 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
3942 {
3943 	return __skb_cow(skb, headroom, skb_header_cloned(skb));
3944 }
3945 
3946 /**
3947  *	skb_padto	- pad an skbuff up to a minimal size
3948  *	@skb: buffer to pad
3949  *	@len: minimal length
3950  *
3951  *	Pads up a buffer to ensure the trailing bytes exist and are
3952  *	blanked. If the buffer already contains sufficient data it
3953  *	is untouched. Otherwise it is extended. Returns zero on
3954  *	success. The skb is freed on error.
3955  */
skb_padto(struct sk_buff * skb,unsigned int len)3956 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
3957 {
3958 	unsigned int size = skb->len;
3959 	if (likely(size >= len))
3960 		return 0;
3961 	return skb_pad(skb, len - size);
3962 }
3963 
3964 /**
3965  *	__skb_put_padto - increase size and pad an skbuff up to a minimal size
3966  *	@skb: buffer to pad
3967  *	@len: minimal length
3968  *	@free_on_error: free buffer on error
3969  *
3970  *	Pads up a buffer to ensure the trailing bytes exist and are
3971  *	blanked. If the buffer already contains sufficient data it
3972  *	is untouched. Otherwise it is extended. Returns zero on
3973  *	success. The skb is freed on error if @free_on_error is true.
3974  */
__skb_put_padto(struct sk_buff * skb,unsigned int len,bool free_on_error)3975 static inline int __must_check __skb_put_padto(struct sk_buff *skb,
3976 					       unsigned int len,
3977 					       bool free_on_error)
3978 {
3979 	unsigned int size = skb->len;
3980 
3981 	if (unlikely(size < len)) {
3982 		len -= size;
3983 		if (__skb_pad(skb, len, free_on_error))
3984 			return -ENOMEM;
3985 		__skb_put(skb, len);
3986 	}
3987 	return 0;
3988 }
3989 
3990 /**
3991  *	skb_put_padto - increase size and pad an skbuff up to a minimal size
3992  *	@skb: buffer to pad
3993  *	@len: minimal length
3994  *
3995  *	Pads up a buffer to ensure the trailing bytes exist and are
3996  *	blanked. If the buffer already contains sufficient data it
3997  *	is untouched. Otherwise it is extended. Returns zero on
3998  *	success. The skb is freed on error.
3999  */
skb_put_padto(struct sk_buff * skb,unsigned int len)4000 static inline int __must_check skb_put_padto(struct sk_buff *skb, unsigned int len)
4001 {
4002 	return __skb_put_padto(skb, len, true);
4003 }
4004 
4005 bool csum_and_copy_from_iter_full(void *addr, size_t bytes, __wsum *csum, struct iov_iter *i)
4006 	__must_check;
4007 
skb_can_coalesce_netmem(struct sk_buff * skb,int i,netmem_ref netmem,int off)4008 static inline bool skb_can_coalesce_netmem(struct sk_buff *skb, int i,
4009 					   netmem_ref netmem, int off)
4010 {
4011 	if (skb_zcopy(skb))
4012 		return false;
4013 	if (i) {
4014 		const skb_frag_t *frag = &skb_shinfo(skb)->frags[i - 1];
4015 
4016 		return netmem == skb_frag_netmem(frag) &&
4017 		       off == skb_frag_off(frag) + skb_frag_size(frag);
4018 	}
4019 	return false;
4020 }
4021 
skb_can_coalesce(struct sk_buff * skb,int i,const struct page * page,int off)4022 static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
4023 				    const struct page *page, int off)
4024 {
4025 	return skb_can_coalesce_netmem(skb, i, page_to_netmem(page), off);
4026 }
4027 
__skb_linearize(struct sk_buff * skb)4028 static inline int __skb_linearize(struct sk_buff *skb)
4029 {
4030 	return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
4031 }
4032 
4033 /**
4034  *	skb_linearize - convert paged skb to linear one
4035  *	@skb: buffer to linarize
4036  *
4037  *	If there is no free memory -ENOMEM is returned, otherwise zero
4038  *	is returned and the old skb data released.
4039  */
skb_linearize(struct sk_buff * skb)4040 static inline int skb_linearize(struct sk_buff *skb)
4041 {
4042 	return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
4043 }
4044 
4045 /**
4046  * skb_has_shared_frag - can any frag be overwritten
4047  * @skb: buffer to test
4048  *
4049  * Return: true if the skb has at least one frag that might be modified
4050  * by an external entity (as in vmsplice()/sendfile())
4051  */
skb_has_shared_frag(const struct sk_buff * skb)4052 static inline bool skb_has_shared_frag(const struct sk_buff *skb)
4053 {
4054 	return skb_is_nonlinear(skb) &&
4055 	       skb_shinfo(skb)->flags & SKBFL_SHARED_FRAG;
4056 }
4057 
4058 /**
4059  *	skb_linearize_cow - make sure skb is linear and writable
4060  *	@skb: buffer to process
4061  *
4062  *	If there is no free memory -ENOMEM is returned, otherwise zero
4063  *	is returned and the old skb data released.
4064  */
skb_linearize_cow(struct sk_buff * skb)4065 static inline int skb_linearize_cow(struct sk_buff *skb)
4066 {
4067 	return skb_is_nonlinear(skb) || skb_cloned(skb) ?
4068 	       __skb_linearize(skb) : 0;
4069 }
4070 
4071 static __always_inline void
__skb_postpull_rcsum(struct sk_buff * skb,const void * start,unsigned int len,unsigned int off)4072 __skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
4073 		     unsigned int off)
4074 {
4075 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4076 		skb->csum = csum_block_sub(skb->csum,
4077 					   csum_partial(start, len, 0), off);
4078 	else if (skb->ip_summed == CHECKSUM_PARTIAL &&
4079 		 skb_checksum_start_offset(skb) < 0)
4080 		skb->ip_summed = CHECKSUM_NONE;
4081 }
4082 
4083 /**
4084  *	skb_postpull_rcsum - update checksum for received skb after pull
4085  *	@skb: buffer to update
4086  *	@start: start of data before pull
4087  *	@len: length of data pulled
4088  *
4089  *	After doing a pull on a received packet, you need to call this to
4090  *	update the CHECKSUM_COMPLETE checksum, or set ip_summed to
4091  *	CHECKSUM_NONE so that it can be recomputed from scratch.
4092  */
4093 static __always_inline void
skb_postpull_rcsum(struct sk_buff * skb,const void * start,unsigned int len)4094 skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len)
4095 {
4096 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4097 		skb->csum = wsum_negate(csum_partial(start, len,
4098 						     wsum_negate(skb->csum)));
4099 	else if (skb->ip_summed == CHECKSUM_PARTIAL &&
4100 		 skb_checksum_start_offset(skb) < 0)
4101 		skb->ip_summed = CHECKSUM_NONE;
4102 }
4103 
4104 static __always_inline void
__skb_postpush_rcsum(struct sk_buff * skb,const void * start,unsigned int len,unsigned int off)4105 __skb_postpush_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
4106 		     unsigned int off)
4107 {
4108 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4109 		skb->csum = csum_block_add(skb->csum,
4110 					   csum_partial(start, len, 0), off);
4111 }
4112 
4113 /**
4114  *	skb_postpush_rcsum - update checksum for received skb after push
4115  *	@skb: buffer to update
4116  *	@start: start of data after push
4117  *	@len: length of data pushed
4118  *
4119  *	After doing a push on a received packet, you need to call this to
4120  *	update the CHECKSUM_COMPLETE checksum.
4121  */
skb_postpush_rcsum(struct sk_buff * skb,const void * start,unsigned int len)4122 static inline void skb_postpush_rcsum(struct sk_buff *skb,
4123 				      const void *start, unsigned int len)
4124 {
4125 	__skb_postpush_rcsum(skb, start, len, 0);
4126 }
4127 
4128 void *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
4129 
4130 /**
4131  *	skb_push_rcsum - push skb and update receive checksum
4132  *	@skb: buffer to update
4133  *	@len: length of data pulled
4134  *
4135  *	This function performs an skb_push on the packet and updates
4136  *	the CHECKSUM_COMPLETE checksum.  It should be used on
4137  *	receive path processing instead of skb_push unless you know
4138  *	that the checksum difference is zero (e.g., a valid IP header)
4139  *	or you are setting ip_summed to CHECKSUM_NONE.
4140  */
skb_push_rcsum(struct sk_buff * skb,unsigned int len)4141 static inline void *skb_push_rcsum(struct sk_buff *skb, unsigned int len)
4142 {
4143 	skb_push(skb, len);
4144 	skb_postpush_rcsum(skb, skb->data, len);
4145 	return skb->data;
4146 }
4147 
4148 int pskb_trim_rcsum_slow(struct sk_buff *skb, unsigned int len);
4149 /**
4150  *	pskb_trim_rcsum - trim received skb and update checksum
4151  *	@skb: buffer to trim
4152  *	@len: new length
4153  *
4154  *	This is exactly the same as pskb_trim except that it ensures the
4155  *	checksum of received packets are still valid after the operation.
4156  *	It can change skb pointers.
4157  */
4158 
pskb_trim_rcsum(struct sk_buff * skb,unsigned int len)4159 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
4160 {
4161 	skb_might_realloc(skb);
4162 	if (likely(len >= skb->len))
4163 		return 0;
4164 	return pskb_trim_rcsum_slow(skb, len);
4165 }
4166 
__skb_trim_rcsum(struct sk_buff * skb,unsigned int len)4167 static inline int __skb_trim_rcsum(struct sk_buff *skb, unsigned int len)
4168 {
4169 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4170 		skb->ip_summed = CHECKSUM_NONE;
4171 	__skb_trim(skb, len);
4172 	return 0;
4173 }
4174 
__skb_grow_rcsum(struct sk_buff * skb,unsigned int len)4175 static inline int __skb_grow_rcsum(struct sk_buff *skb, unsigned int len)
4176 {
4177 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4178 		skb->ip_summed = CHECKSUM_NONE;
4179 	return __skb_grow(skb, len);
4180 }
4181 
4182 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
4183 #define skb_rb_first(root) rb_to_skb(rb_first(root))
4184 #define skb_rb_last(root)  rb_to_skb(rb_last(root))
4185 #define skb_rb_next(skb)   rb_to_skb(rb_next(&(skb)->rbnode))
4186 #define skb_rb_prev(skb)   rb_to_skb(rb_prev(&(skb)->rbnode))
4187 
4188 #define skb_queue_walk(queue, skb) \
4189 		for (skb = (queue)->next;					\
4190 		     skb != (struct sk_buff *)(queue);				\
4191 		     skb = skb->next)
4192 
4193 #define skb_queue_walk_safe(queue, skb, tmp)					\
4194 		for (skb = (queue)->next, tmp = skb->next;			\
4195 		     skb != (struct sk_buff *)(queue);				\
4196 		     skb = tmp, tmp = skb->next)
4197 
4198 #define skb_queue_walk_from(queue, skb)						\
4199 		for (; skb != (struct sk_buff *)(queue);			\
4200 		     skb = skb->next)
4201 
4202 #define skb_rbtree_walk(skb, root)						\
4203 		for (skb = skb_rb_first(root); skb != NULL;			\
4204 		     skb = skb_rb_next(skb))
4205 
4206 #define skb_rbtree_walk_from(skb)						\
4207 		for (; skb != NULL;						\
4208 		     skb = skb_rb_next(skb))
4209 
4210 #define skb_rbtree_walk_from_safe(skb, tmp)					\
4211 		for (; tmp = skb ? skb_rb_next(skb) : NULL, (skb != NULL);	\
4212 		     skb = tmp)
4213 
4214 #define skb_queue_walk_from_safe(queue, skb, tmp)				\
4215 		for (tmp = skb->next;						\
4216 		     skb != (struct sk_buff *)(queue);				\
4217 		     skb = tmp, tmp = skb->next)
4218 
4219 #define skb_queue_reverse_walk(queue, skb) \
4220 		for (skb = (queue)->prev;					\
4221 		     skb != (struct sk_buff *)(queue);				\
4222 		     skb = skb->prev)
4223 
4224 #define skb_queue_reverse_walk_safe(queue, skb, tmp)				\
4225 		for (skb = (queue)->prev, tmp = skb->prev;			\
4226 		     skb != (struct sk_buff *)(queue);				\
4227 		     skb = tmp, tmp = skb->prev)
4228 
4229 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)			\
4230 		for (tmp = skb->prev;						\
4231 		     skb != (struct sk_buff *)(queue);				\
4232 		     skb = tmp, tmp = skb->prev)
4233 
skb_has_frag_list(const struct sk_buff * skb)4234 static inline bool skb_has_frag_list(const struct sk_buff *skb)
4235 {
4236 	return skb_shinfo(skb)->frag_list != NULL;
4237 }
4238 
skb_frag_list_init(struct sk_buff * skb)4239 static inline void skb_frag_list_init(struct sk_buff *skb)
4240 {
4241 	skb_shinfo(skb)->frag_list = NULL;
4242 }
4243 
4244 #define skb_walk_frags(skb, iter)	\
4245 	for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
4246 
4247 
4248 int __skb_wait_for_more_packets(struct sock *sk, struct sk_buff_head *queue,
4249 				int *err, long *timeo_p,
4250 				const struct sk_buff *skb);
4251 struct sk_buff *__skb_try_recv_from_queue(struct sk_buff_head *queue,
4252 					  unsigned int flags,
4253 					  int *off, int *err,
4254 					  struct sk_buff **last);
4255 struct sk_buff *__skb_try_recv_datagram(struct sock *sk,
4256 					struct sk_buff_head *queue,
4257 					unsigned int flags, int *off, int *err,
4258 					struct sk_buff **last);
4259 struct sk_buff *__skb_recv_datagram(struct sock *sk,
4260 				    struct sk_buff_head *sk_queue,
4261 				    unsigned int flags, int *off, int *err);
4262 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned int flags, int *err);
4263 __poll_t datagram_poll_queue(struct file *file, struct socket *sock,
4264 			     struct poll_table_struct *wait,
4265 			     struct sk_buff_head *rcv_queue);
4266 __poll_t datagram_poll(struct file *file, struct socket *sock,
4267 			   struct poll_table_struct *wait);
4268 int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
4269 			   struct iov_iter *to, int size);
skb_copy_datagram_msg(const struct sk_buff * from,int offset,struct msghdr * msg,int size)4270 static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
4271 					struct msghdr *msg, int size)
4272 {
4273 	return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
4274 }
4275 int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
4276 				   struct msghdr *msg);
4277 int skb_copy_and_crc32c_datagram_iter(const struct sk_buff *skb, int offset,
4278 				      struct iov_iter *to, int len, u32 *crcp);
4279 int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
4280 				 struct iov_iter *from, int len);
4281 int skb_copy_datagram_from_iter_full(struct sk_buff *skb, int offset,
4282 				     struct iov_iter *from, int len);
4283 int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
4284 void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
4285 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
4286 int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
4287 int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
4288 __wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
4289 			      int len);
4290 int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
4291 		    struct pipe_inode_info *pipe, unsigned int len,
4292 		    unsigned int flags);
4293 int skb_send_sock_locked(struct sock *sk, struct sk_buff *skb, int offset,
4294 			 int len);
4295 int skb_send_sock_locked_with_flags(struct sock *sk, struct sk_buff *skb,
4296 				    int offset, int len, int flags);
4297 int skb_send_sock(struct sock *sk, struct sk_buff *skb, int offset, int len);
4298 void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
4299 unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
4300 int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
4301 		 int len, int hlen);
4302 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
4303 int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
4304 void skb_scrub_packet(struct sk_buff *skb, bool xnet);
4305 struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
4306 struct sk_buff *skb_segment_list(struct sk_buff *skb, netdev_features_t features,
4307 				 unsigned int offset);
4308 struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
4309 int skb_ensure_writable(struct sk_buff *skb, unsigned int write_len);
4310 int skb_ensure_writable_head_tail(struct sk_buff *skb, struct net_device *dev);
4311 int __skb_vlan_pop(struct sk_buff *skb, u16 *vlan_tci);
4312 int skb_vlan_pop(struct sk_buff *skb);
4313 int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
4314 int skb_eth_pop(struct sk_buff *skb);
4315 int skb_eth_push(struct sk_buff *skb, const unsigned char *dst,
4316 		 const unsigned char *src);
4317 int skb_mpls_push(struct sk_buff *skb, __be32 mpls_lse, __be16 mpls_proto,
4318 		  int mac_len, bool ethernet);
4319 int skb_mpls_pop(struct sk_buff *skb, __be16 next_proto, int mac_len,
4320 		 bool ethernet);
4321 int skb_mpls_update_lse(struct sk_buff *skb, __be32 mpls_lse);
4322 int skb_mpls_dec_ttl(struct sk_buff *skb);
4323 struct sk_buff *pskb_extract(struct sk_buff *skb, int off, int to_copy,
4324 			     gfp_t gfp);
4325 
memcpy_from_msg(void * data,struct msghdr * msg,int len)4326 static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
4327 {
4328 	return copy_from_iter_full(data, len, &msg->msg_iter) ? 0 : -EFAULT;
4329 }
4330 
memcpy_to_msg(struct msghdr * msg,void * data,int len)4331 static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
4332 {
4333 	return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
4334 }
4335 
4336 __wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
4337 		    __wsum csum);
4338 u32 skb_crc32c(const struct sk_buff *skb, int offset, int len, u32 crc);
4339 
4340 static inline void * __must_check
__skb_header_pointer(const struct sk_buff * skb,int offset,int len,const void * data,int hlen,void * buffer)4341 __skb_header_pointer(const struct sk_buff *skb, int offset, int len,
4342 		     const void *data, int hlen, void *buffer)
4343 {
4344 	if (likely(hlen - offset >= len))
4345 		return (void *)data + offset;
4346 
4347 	if (!skb || unlikely(skb_copy_bits(skb, offset, buffer, len) < 0))
4348 		return NULL;
4349 
4350 	return buffer;
4351 }
4352 
4353 static __always_inline void * __must_check
skb_header_pointer(const struct sk_buff * skb,int offset,int len,void * buffer)4354 skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
4355 {
4356 	return __skb_header_pointer(skb, offset, len, skb->data,
4357 				    skb_headlen(skb), buffer);
4358 }
4359 
4360 /* Variant of skb_header_pointer() where @offset is user-controlled
4361  * and potentially negative.
4362  */
4363 static inline void * __must_check
skb_header_pointer_careful(const struct sk_buff * skb,int offset,int len,void * buffer)4364 skb_header_pointer_careful(const struct sk_buff *skb, int offset,
4365 			   int len, void *buffer)
4366 {
4367 	if (unlikely(offset < 0 && -offset > skb_headroom(skb)))
4368 		return NULL;
4369 	return skb_header_pointer(skb, offset, len, buffer);
4370 }
4371 
4372 static inline void * __must_check
skb_pointer_if_linear(const struct sk_buff * skb,int offset,int len)4373 skb_pointer_if_linear(const struct sk_buff *skb, int offset, int len)
4374 {
4375 	if (likely(skb_headlen(skb) - offset >= len))
4376 		return skb->data + offset;
4377 	return NULL;
4378 }
4379 
4380 /**
4381  *	skb_needs_linearize - check if we need to linearize a given skb
4382  *			      depending on the given device features.
4383  *	@skb: socket buffer to check
4384  *	@features: net device features
4385  *
4386  *	Returns true if either:
4387  *	1. skb has frag_list and the device doesn't support FRAGLIST, or
4388  *	2. skb is fragmented and the device does not support SG.
4389  */
skb_needs_linearize(struct sk_buff * skb,netdev_features_t features)4390 static inline bool skb_needs_linearize(struct sk_buff *skb,
4391 				       netdev_features_t features)
4392 {
4393 	return skb_is_nonlinear(skb) &&
4394 	       ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
4395 		(skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
4396 }
4397 
skb_copy_from_linear_data(const struct sk_buff * skb,void * to,const unsigned int len)4398 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
4399 					     void *to,
4400 					     const unsigned int len)
4401 {
4402 	memcpy(to, skb->data, len);
4403 }
4404 
skb_copy_from_linear_data_offset(const struct sk_buff * skb,const int offset,void * to,const unsigned int len)4405 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
4406 						    const int offset, void *to,
4407 						    const unsigned int len)
4408 {
4409 	memcpy(to, skb->data + offset, len);
4410 }
4411 
skb_copy_to_linear_data(struct sk_buff * skb,const void * from,const unsigned int len)4412 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
4413 					   const void *from,
4414 					   const unsigned int len)
4415 {
4416 	memcpy(skb->data, from, len);
4417 }
4418 
skb_copy_to_linear_data_offset(struct sk_buff * skb,const int offset,const void * from,const unsigned int len)4419 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
4420 						  const int offset,
4421 						  const void *from,
4422 						  const unsigned int len)
4423 {
4424 	memcpy(skb->data + offset, from, len);
4425 }
4426 
4427 void skb_init(void);
4428 
skb_get_ktime(const struct sk_buff * skb)4429 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
4430 {
4431 	return skb->tstamp;
4432 }
4433 
4434 /**
4435  *	skb_get_timestamp - get timestamp from a skb
4436  *	@skb: skb to get stamp from
4437  *	@stamp: pointer to struct __kernel_old_timeval to store stamp in
4438  *
4439  *	Timestamps are stored in the skb as offsets to a base timestamp.
4440  *	This function converts the offset back to a struct timeval and stores
4441  *	it in stamp.
4442  */
skb_get_timestamp(const struct sk_buff * skb,struct __kernel_old_timeval * stamp)4443 static inline void skb_get_timestamp(const struct sk_buff *skb,
4444 				     struct __kernel_old_timeval *stamp)
4445 {
4446 	*stamp = ns_to_kernel_old_timeval(skb->tstamp);
4447 }
4448 
skb_get_new_timestamp(const struct sk_buff * skb,struct __kernel_sock_timeval * stamp)4449 static inline void skb_get_new_timestamp(const struct sk_buff *skb,
4450 					 struct __kernel_sock_timeval *stamp)
4451 {
4452 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4453 
4454 	stamp->tv_sec = ts.tv_sec;
4455 	stamp->tv_usec = ts.tv_nsec / 1000;
4456 }
4457 
skb_get_timestampns(const struct sk_buff * skb,struct __kernel_old_timespec * stamp)4458 static inline void skb_get_timestampns(const struct sk_buff *skb,
4459 				       struct __kernel_old_timespec *stamp)
4460 {
4461 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4462 
4463 	stamp->tv_sec = ts.tv_sec;
4464 	stamp->tv_nsec = ts.tv_nsec;
4465 }
4466 
skb_get_new_timestampns(const struct sk_buff * skb,struct __kernel_timespec * stamp)4467 static inline void skb_get_new_timestampns(const struct sk_buff *skb,
4468 					   struct __kernel_timespec *stamp)
4469 {
4470 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4471 
4472 	stamp->tv_sec = ts.tv_sec;
4473 	stamp->tv_nsec = ts.tv_nsec;
4474 }
4475 
__net_timestamp(struct sk_buff * skb)4476 static inline void __net_timestamp(struct sk_buff *skb)
4477 {
4478 	skb->tstamp = ktime_get_real();
4479 	skb->tstamp_type = SKB_CLOCK_REALTIME;
4480 }
4481 
net_timedelta(ktime_t t)4482 static inline ktime_t net_timedelta(ktime_t t)
4483 {
4484 	return ktime_sub(ktime_get_real(), t);
4485 }
4486 
skb_set_delivery_time(struct sk_buff * skb,ktime_t kt,u8 tstamp_type)4487 static inline void skb_set_delivery_time(struct sk_buff *skb, ktime_t kt,
4488 					 u8 tstamp_type)
4489 {
4490 	skb->tstamp = kt;
4491 
4492 	if (kt)
4493 		skb->tstamp_type = tstamp_type;
4494 	else
4495 		skb->tstamp_type = SKB_CLOCK_REALTIME;
4496 }
4497 
skb_set_delivery_type_by_clockid(struct sk_buff * skb,ktime_t kt,clockid_t clockid)4498 static inline void skb_set_delivery_type_by_clockid(struct sk_buff *skb,
4499 						    ktime_t kt, clockid_t clockid)
4500 {
4501 	u8 tstamp_type = SKB_CLOCK_REALTIME;
4502 
4503 	switch (clockid) {
4504 	case CLOCK_REALTIME:
4505 		break;
4506 	case CLOCK_MONOTONIC:
4507 		tstamp_type = SKB_CLOCK_MONOTONIC;
4508 		break;
4509 	case CLOCK_TAI:
4510 		tstamp_type = SKB_CLOCK_TAI;
4511 		break;
4512 	default:
4513 		WARN_ON_ONCE(1);
4514 		kt = 0;
4515 	}
4516 
4517 	skb_set_delivery_time(skb, kt, tstamp_type);
4518 }
4519 
4520 DECLARE_STATIC_KEY_FALSE(netstamp_needed_key);
4521 
4522 /* It is used in the ingress path to clear the delivery_time.
4523  * If needed, set the skb->tstamp to the (rcv) timestamp.
4524  */
skb_clear_delivery_time(struct sk_buff * skb)4525 static __always_inline void skb_clear_delivery_time(struct sk_buff *skb)
4526 {
4527 	if (skb->tstamp_type) {
4528 		skb->tstamp_type = SKB_CLOCK_REALTIME;
4529 		if (static_branch_unlikely(&netstamp_needed_key))
4530 			skb->tstamp = ktime_get_real();
4531 		else
4532 			skb->tstamp = 0;
4533 	}
4534 }
4535 
skb_clear_tstamp(struct sk_buff * skb)4536 static inline void skb_clear_tstamp(struct sk_buff *skb)
4537 {
4538 	if (skb->tstamp_type)
4539 		return;
4540 
4541 	skb->tstamp = 0;
4542 }
4543 
skb_tstamp(const struct sk_buff * skb)4544 static inline ktime_t skb_tstamp(const struct sk_buff *skb)
4545 {
4546 	if (skb->tstamp_type)
4547 		return 0;
4548 
4549 	return skb->tstamp;
4550 }
4551 
4552 static __always_inline ktime_t
skb_tstamp_cond(const struct sk_buff * skb,bool cond)4553 skb_tstamp_cond(const struct sk_buff *skb, bool cond)
4554 {
4555 	if (skb->tstamp_type != SKB_CLOCK_MONOTONIC && skb->tstamp)
4556 		return skb->tstamp;
4557 
4558 	if (static_branch_unlikely(&netstamp_needed_key) || cond)
4559 		return ktime_get_real();
4560 
4561 	return 0;
4562 }
4563 
skb_metadata_len(const struct sk_buff * skb)4564 static inline u8 skb_metadata_len(const struct sk_buff *skb)
4565 {
4566 	return skb_shinfo(skb)->meta_len;
4567 }
4568 
skb_metadata_end(const struct sk_buff * skb)4569 static inline void *skb_metadata_end(const struct sk_buff *skb)
4570 {
4571 	return skb_mac_header(skb);
4572 }
4573 
__skb_metadata_differs(const struct sk_buff * skb_a,const struct sk_buff * skb_b,u8 meta_len)4574 static inline bool __skb_metadata_differs(const struct sk_buff *skb_a,
4575 					  const struct sk_buff *skb_b,
4576 					  u8 meta_len)
4577 {
4578 	const void *a = skb_metadata_end(skb_a);
4579 	const void *b = skb_metadata_end(skb_b);
4580 	u64 diffs = 0;
4581 
4582 	if (!IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) ||
4583 	    BITS_PER_LONG != 64)
4584 		goto slow;
4585 
4586 	/* Using more efficient variant than plain call to memcmp(). */
4587 	switch (meta_len) {
4588 #define __it(x, op) (x -= sizeof(u##op))
4589 #define __it_diff(a, b, op) (*(u##op *)__it(a, op)) ^ (*(u##op *)__it(b, op))
4590 	case 32: diffs |= __it_diff(a, b, 64);
4591 		fallthrough;
4592 	case 24: diffs |= __it_diff(a, b, 64);
4593 		fallthrough;
4594 	case 16: diffs |= __it_diff(a, b, 64);
4595 		fallthrough;
4596 	case  8: diffs |= __it_diff(a, b, 64);
4597 		break;
4598 	case 28: diffs |= __it_diff(a, b, 64);
4599 		fallthrough;
4600 	case 20: diffs |= __it_diff(a, b, 64);
4601 		fallthrough;
4602 	case 12: diffs |= __it_diff(a, b, 64);
4603 		fallthrough;
4604 	case  4: diffs |= __it_diff(a, b, 32);
4605 		break;
4606 	default:
4607 slow:
4608 		return memcmp(a - meta_len, b - meta_len, meta_len);
4609 	}
4610 	return diffs;
4611 }
4612 
skb_metadata_differs(const struct sk_buff * skb_a,const struct sk_buff * skb_b)4613 static inline bool skb_metadata_differs(const struct sk_buff *skb_a,
4614 					const struct sk_buff *skb_b)
4615 {
4616 	u8 len_a = skb_metadata_len(skb_a);
4617 	u8 len_b = skb_metadata_len(skb_b);
4618 
4619 	if (!(len_a | len_b))
4620 		return false;
4621 
4622 	return len_a != len_b ?
4623 	       true : __skb_metadata_differs(skb_a, skb_b, len_a);
4624 }
4625 
skb_metadata_set(struct sk_buff * skb,u8 meta_len)4626 static inline void skb_metadata_set(struct sk_buff *skb, u8 meta_len)
4627 {
4628 	skb_shinfo(skb)->meta_len = meta_len;
4629 }
4630 
skb_metadata_clear(struct sk_buff * skb)4631 static inline void skb_metadata_clear(struct sk_buff *skb)
4632 {
4633 	skb_metadata_set(skb, 0);
4634 }
4635 
4636 /**
4637  * skb_data_move - Move packet data and metadata after skb_push() or skb_pull().
4638  * @skb: packet to operate on
4639  * @len: number of bytes pushed or pulled from &sk_buff->data
4640  * @n: number of bytes to memmove() from pre-push/pull &sk_buff->data
4641  *
4642  * Moves @n bytes of packet data, can be zero, and all bytes of skb metadata.
4643  *
4644  * Assumes metadata is located immediately before &sk_buff->data prior to the
4645  * push/pull, and that sufficient headroom exists to hold it after an
4646  * skb_push(). Otherwise, metadata is cleared and a one-time warning is issued.
4647  *
4648  * Prefer skb_postpull_data_move() or skb_postpush_data_move() to calling this
4649  * helper directly.
4650  */
skb_data_move(struct sk_buff * skb,const int len,const unsigned int n)4651 static inline void skb_data_move(struct sk_buff *skb, const int len,
4652 				 const unsigned int n)
4653 {
4654 	const u8 meta_len = skb_metadata_len(skb);
4655 	u8 *meta, *meta_end;
4656 
4657 	if (!len || (!n && !meta_len))
4658 		return;
4659 
4660 	if (!meta_len)
4661 		goto no_metadata;
4662 
4663 	meta_end = skb_metadata_end(skb);
4664 	meta = meta_end - meta_len;
4665 
4666 	if (WARN_ON_ONCE(meta_end + len != skb->data ||
4667 			 meta_len > skb_headroom(skb))) {
4668 		skb_metadata_clear(skb);
4669 		goto no_metadata;
4670 	}
4671 
4672 	memmove(meta + len, meta, meta_len + n);
4673 	return;
4674 
4675 no_metadata:
4676 	memmove(skb->data, skb->data - len, n);
4677 }
4678 
4679 /**
4680  * skb_postpull_data_move - Move packet data and metadata after skb_pull().
4681  * @skb: packet to operate on
4682  * @len: number of bytes pulled from &sk_buff->data
4683  * @n: number of bytes to memmove() from pre-pull &sk_buff->data
4684  *
4685  * See skb_data_move() for details.
4686  */
skb_postpull_data_move(struct sk_buff * skb,const unsigned int len,const unsigned int n)4687 static inline void skb_postpull_data_move(struct sk_buff *skb,
4688 					  const unsigned int len,
4689 					  const unsigned int n)
4690 {
4691 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
4692 	skb_data_move(skb, len, n);
4693 }
4694 
4695 /**
4696  * skb_postpush_data_move - Move packet data and metadata after skb_push().
4697  * @skb: packet to operate on
4698  * @len: number of bytes pushed onto &sk_buff->data
4699  * @n: number of bytes to memmove() from pre-push &sk_buff->data
4700  *
4701  * See skb_data_move() for details.
4702  */
skb_postpush_data_move(struct sk_buff * skb,const unsigned int len,const unsigned int n)4703 static inline void skb_postpush_data_move(struct sk_buff *skb,
4704 					  const unsigned int len,
4705 					  const unsigned int n)
4706 {
4707 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
4708 	skb_data_move(skb, -len, n);
4709 }
4710 
4711 struct sk_buff *skb_clone_sk(struct sk_buff *skb);
4712 
4713 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
4714 
4715 void skb_clone_tx_timestamp(struct sk_buff *skb);
4716 bool skb_defer_rx_timestamp(struct sk_buff *skb);
4717 
4718 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
4719 
skb_clone_tx_timestamp(struct sk_buff * skb)4720 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
4721 {
4722 }
4723 
skb_defer_rx_timestamp(struct sk_buff * skb)4724 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
4725 {
4726 	return false;
4727 }
4728 
4729 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
4730 
4731 /**
4732  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
4733  *
4734  * PHY drivers may accept clones of transmitted packets for
4735  * timestamping via their phy_driver.txtstamp method. These drivers
4736  * must call this function to return the skb back to the stack with a
4737  * timestamp.
4738  *
4739  * @skb: clone of the original outgoing packet
4740  * @hwtstamps: hardware time stamps
4741  *
4742  */
4743 void skb_complete_tx_timestamp(struct sk_buff *skb,
4744 			       struct skb_shared_hwtstamps *hwtstamps);
4745 
4746 void __skb_tstamp_tx(struct sk_buff *orig_skb, const struct sk_buff *ack_skb,
4747 		     struct skb_shared_hwtstamps *hwtstamps,
4748 		     struct sock *sk, int tstype);
4749 
4750 /**
4751  * skb_tstamp_tx - queue clone of skb with send time stamps
4752  * @orig_skb:	the original outgoing packet
4753  * @hwtstamps:	hardware time stamps, may be NULL if not available
4754  *
4755  * If the skb has a socket associated, then this function clones the
4756  * skb (thus sharing the actual data and optional structures), stores
4757  * the optional hardware time stamping information (if non NULL) or
4758  * generates a software time stamp (otherwise), then queues the clone
4759  * to the error queue of the socket.  Errors are silently ignored.
4760  */
4761 void skb_tstamp_tx(struct sk_buff *orig_skb,
4762 		   struct skb_shared_hwtstamps *hwtstamps);
4763 
4764 /**
4765  * skb_tx_timestamp() - Driver hook for transmit timestamping
4766  *
4767  * Ethernet MAC Drivers should call this function in their hard_xmit()
4768  * function immediately before giving the sk_buff to the MAC hardware.
4769  *
4770  * Specifically, one should make absolutely sure that this function is
4771  * called before TX completion of this packet can trigger.  Otherwise
4772  * the packet could potentially already be freed.
4773  *
4774  * @skb: A socket buffer.
4775  */
skb_tx_timestamp(struct sk_buff * skb)4776 static inline void skb_tx_timestamp(struct sk_buff *skb)
4777 {
4778 	skb_clone_tx_timestamp(skb);
4779 	if (skb_shinfo(skb)->tx_flags & (SKBTX_SW_TSTAMP | SKBTX_BPF))
4780 		skb_tstamp_tx(skb, NULL);
4781 }
4782 
4783 /**
4784  * skb_complete_wifi_ack - deliver skb with wifi status
4785  *
4786  * @skb: the original outgoing packet
4787  * @acked: ack status
4788  *
4789  */
4790 void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
4791 
4792 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
4793 __sum16 __skb_checksum_complete(struct sk_buff *skb);
4794 
skb_csum_unnecessary(const struct sk_buff * skb)4795 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
4796 {
4797 	return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
4798 		skb->csum_valid ||
4799 		(skb->ip_summed == CHECKSUM_PARTIAL &&
4800 		 skb_checksum_start_offset(skb) >= 0));
4801 }
4802 
4803 /**
4804  *	skb_checksum_complete - Calculate checksum of an entire packet
4805  *	@skb: packet to process
4806  *
4807  *	This function calculates the checksum over the entire packet plus
4808  *	the value of skb->csum.  The latter can be used to supply the
4809  *	checksum of a pseudo header as used by TCP/UDP.  It returns the
4810  *	checksum.
4811  *
4812  *	For protocols that contain complete checksums such as ICMP/TCP/UDP,
4813  *	this function can be used to verify that checksum on received
4814  *	packets.  In that case the function should return zero if the
4815  *	checksum is correct.  In particular, this function will return zero
4816  *	if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
4817  *	hardware has already verified the correctness of the checksum.
4818  */
skb_checksum_complete(struct sk_buff * skb)4819 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
4820 {
4821 	return skb_csum_unnecessary(skb) ?
4822 	       0 : __skb_checksum_complete(skb);
4823 }
4824 
__skb_decr_checksum_unnecessary(struct sk_buff * skb)4825 static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
4826 {
4827 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4828 		if (skb->csum_level == 0)
4829 			skb->ip_summed = CHECKSUM_NONE;
4830 		else
4831 			skb->csum_level--;
4832 	}
4833 }
4834 
__skb_incr_checksum_unnecessary(struct sk_buff * skb)4835 static __always_inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
4836 {
4837 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4838 		if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
4839 			skb->csum_level++;
4840 	} else if (skb->ip_summed == CHECKSUM_NONE) {
4841 		skb->ip_summed = CHECKSUM_UNNECESSARY;
4842 		skb->csum_level = 0;
4843 	}
4844 }
4845 
__skb_reset_checksum_unnecessary(struct sk_buff * skb)4846 static inline void __skb_reset_checksum_unnecessary(struct sk_buff *skb)
4847 {
4848 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4849 		skb->ip_summed = CHECKSUM_NONE;
4850 		skb->csum_level = 0;
4851 	}
4852 }
4853 
4854 /* Check if we need to perform checksum complete validation.
4855  *
4856  * Returns: true if checksum complete is needed, false otherwise
4857  * (either checksum is unnecessary or zero checksum is allowed).
4858  */
__skb_checksum_validate_needed(struct sk_buff * skb,bool zero_okay,__sum16 check)4859 static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
4860 						  bool zero_okay,
4861 						  __sum16 check)
4862 {
4863 	if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
4864 		skb->csum_valid = 1;
4865 		__skb_decr_checksum_unnecessary(skb);
4866 		return false;
4867 	}
4868 
4869 	return true;
4870 }
4871 
4872 /* For small packets <= CHECKSUM_BREAK perform checksum complete directly
4873  * in checksum_init.
4874  */
4875 #define CHECKSUM_BREAK 76
4876 
4877 /* Unset checksum-complete
4878  *
4879  * Unset checksum complete can be done when packet is being modified
4880  * (uncompressed for instance) and checksum-complete value is
4881  * invalidated.
4882  */
skb_checksum_complete_unset(struct sk_buff * skb)4883 static inline void skb_checksum_complete_unset(struct sk_buff *skb)
4884 {
4885 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4886 		skb->ip_summed = CHECKSUM_NONE;
4887 }
4888 
4889 /* Validate (init) checksum based on checksum complete.
4890  *
4891  * Return values:
4892  *   0: checksum is validated or try to in skb_checksum_complete. In the latter
4893  *	case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
4894  *	checksum is stored in skb->csum for use in __skb_checksum_complete
4895  *   non-zero: value of invalid checksum
4896  *
4897  */
__skb_checksum_validate_complete(struct sk_buff * skb,bool complete,__wsum psum)4898 static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
4899 						       bool complete,
4900 						       __wsum psum)
4901 {
4902 	if (skb->ip_summed == CHECKSUM_COMPLETE) {
4903 		if (!csum_fold(csum_add(psum, skb->csum))) {
4904 			skb->csum_valid = 1;
4905 			return 0;
4906 		}
4907 	}
4908 
4909 	skb->csum = psum;
4910 
4911 	if (complete || skb->len <= CHECKSUM_BREAK) {
4912 		__sum16 csum;
4913 
4914 		csum = __skb_checksum_complete(skb);
4915 		skb->csum_valid = !csum;
4916 		return csum;
4917 	}
4918 
4919 	return 0;
4920 }
4921 
null_compute_pseudo(struct sk_buff * skb,int proto)4922 static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
4923 {
4924 	return 0;
4925 }
4926 
4927 /* Perform checksum validate (init). Note that this is a macro since we only
4928  * want to calculate the pseudo header which is an input function if necessary.
4929  * First we try to validate without any computation (checksum unnecessary) and
4930  * then calculate based on checksum complete calling the function to compute
4931  * pseudo header.
4932  *
4933  * Return values:
4934  *   0: checksum is validated or try to in skb_checksum_complete
4935  *   non-zero: value of invalid checksum
4936  */
4937 #define __skb_checksum_validate(skb, proto, complete,			\
4938 				zero_okay, check, compute_pseudo)	\
4939 ({									\
4940 	__sum16 __ret = 0;						\
4941 	skb->csum_valid = 0;						\
4942 	if (__skb_checksum_validate_needed(skb, zero_okay, check))	\
4943 		__ret = __skb_checksum_validate_complete(skb,		\
4944 				complete, compute_pseudo(skb, proto));	\
4945 	__ret;								\
4946 })
4947 
4948 #define skb_checksum_init(skb, proto, compute_pseudo)			\
4949 	__skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
4950 
4951 #define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo)	\
4952 	__skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
4953 
4954 #define skb_checksum_validate(skb, proto, compute_pseudo)		\
4955 	__skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
4956 
4957 #define skb_checksum_validate_zero_check(skb, proto, check,		\
4958 					 compute_pseudo)		\
4959 	__skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
4960 
4961 #define skb_checksum_simple_validate(skb)				\
4962 	__skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
4963 
__skb_checksum_convert_check(struct sk_buff * skb)4964 static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
4965 {
4966 	return (skb->ip_summed == CHECKSUM_NONE && skb->csum_valid);
4967 }
4968 
__skb_checksum_convert(struct sk_buff * skb,__wsum pseudo)4969 static inline void __skb_checksum_convert(struct sk_buff *skb, __wsum pseudo)
4970 {
4971 	skb->csum = ~pseudo;
4972 	skb->ip_summed = CHECKSUM_COMPLETE;
4973 }
4974 
4975 #define skb_checksum_try_convert(skb, proto, compute_pseudo)	\
4976 do {									\
4977 	if (__skb_checksum_convert_check(skb))				\
4978 		__skb_checksum_convert(skb, compute_pseudo(skb, proto)); \
4979 } while (0)
4980 
skb_remcsum_adjust_partial(struct sk_buff * skb,void * ptr,u16 start,u16 offset)4981 static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
4982 					      u16 start, u16 offset)
4983 {
4984 	skb->ip_summed = CHECKSUM_PARTIAL;
4985 	skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
4986 	skb->csum_offset = offset - start;
4987 }
4988 
4989 /* Update skbuf and packet to reflect the remote checksum offload operation.
4990  * When called, ptr indicates the starting point for skb->csum when
4991  * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
4992  * here, skb_postpull_rcsum is done so skb->csum start is ptr.
4993  */
skb_remcsum_process(struct sk_buff * skb,void * ptr,int start,int offset,bool nopartial)4994 static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
4995 				       int start, int offset, bool nopartial)
4996 {
4997 	__wsum delta;
4998 
4999 	if (!nopartial) {
5000 		skb_remcsum_adjust_partial(skb, ptr, start, offset);
5001 		return;
5002 	}
5003 
5004 	if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
5005 		__skb_checksum_complete(skb);
5006 		skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
5007 	}
5008 
5009 	delta = remcsum_adjust(ptr, skb->csum, start, offset);
5010 
5011 	/* Adjust skb->csum since we changed the packet */
5012 	skb->csum = csum_add(skb->csum, delta);
5013 }
5014 
skb_nfct(const struct sk_buff * skb)5015 static inline struct nf_conntrack *skb_nfct(const struct sk_buff *skb)
5016 {
5017 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
5018 	return (void *)(skb->_nfct & NFCT_PTRMASK);
5019 #else
5020 	return NULL;
5021 #endif
5022 }
5023 
skb_get_nfct(const struct sk_buff * skb)5024 static inline unsigned long skb_get_nfct(const struct sk_buff *skb)
5025 {
5026 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
5027 	return skb->_nfct;
5028 #else
5029 	return 0UL;
5030 #endif
5031 }
5032 
skb_set_nfct(struct sk_buff * skb,unsigned long nfct)5033 static inline void skb_set_nfct(struct sk_buff *skb, unsigned long nfct)
5034 {
5035 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
5036 	DEBUG_NET_WARN_ON_ONCE(skb->_nfct & NFCT_PTRMASK);
5037 	skb->slow_gro |= !!nfct;
5038 	skb->_nfct = nfct;
5039 #endif
5040 }
5041 
5042 #ifdef CONFIG_SKB_EXTENSIONS
5043 enum skb_ext_id {
5044 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
5045 	SKB_EXT_BRIDGE_NF,
5046 #endif
5047 #ifdef CONFIG_XFRM
5048 	SKB_EXT_SEC_PATH,
5049 #endif
5050 #if IS_ENABLED(CONFIG_NET_TC_SKB_EXT)
5051 	TC_SKB_EXT,
5052 #endif
5053 #if IS_ENABLED(CONFIG_MPTCP)
5054 	SKB_EXT_MPTCP,
5055 #endif
5056 #if IS_ENABLED(CONFIG_MCTP_FLOWS)
5057 	SKB_EXT_MCTP,
5058 #endif
5059 #if IS_ENABLED(CONFIG_INET_PSP)
5060 	SKB_EXT_PSP,
5061 #endif
5062 #if IS_ENABLED(CONFIG_CAN)
5063 	SKB_EXT_CAN,
5064 #endif
5065 	SKB_EXT_NUM, /* must be last */
5066 };
5067 
5068 /**
5069  *	struct skb_ext - sk_buff extensions
5070  *	@refcnt: 1 on allocation, deallocated on 0
5071  *	@offset: offset to add to @data to obtain extension address
5072  *	@chunks: size currently allocated, stored in SKB_EXT_ALIGN_SHIFT units
5073  *	@data: start of extension data, variable sized
5074  *
5075  *	Note: offsets/lengths are stored in chunks of 8 bytes, this allows
5076  *	to use 'u8' types while allowing up to 2kb worth of extension data.
5077  */
5078 struct skb_ext {
5079 	refcount_t refcnt;
5080 	u8 offset[SKB_EXT_NUM]; /* in chunks of 8 bytes */
5081 	u8 chunks;		/* same */
5082 	char data[] __aligned(8);
5083 };
5084 
5085 struct skb_ext *__skb_ext_alloc(gfp_t flags);
5086 void *__skb_ext_set(struct sk_buff *skb, enum skb_ext_id id,
5087 		    struct skb_ext *ext);
5088 void *skb_ext_add(struct sk_buff *skb, enum skb_ext_id id);
5089 void __skb_ext_del(struct sk_buff *skb, enum skb_ext_id id);
5090 void __skb_ext_put(struct skb_ext *ext);
5091 
skb_ext_put(struct sk_buff * skb)5092 static inline void skb_ext_put(struct sk_buff *skb)
5093 {
5094 	if (skb->active_extensions)
5095 		__skb_ext_put(skb->extensions);
5096 }
5097 
__skb_ext_copy(struct sk_buff * dst,const struct sk_buff * src)5098 static inline void __skb_ext_copy(struct sk_buff *dst,
5099 				  const struct sk_buff *src)
5100 {
5101 	dst->active_extensions = src->active_extensions;
5102 
5103 	if (src->active_extensions) {
5104 		struct skb_ext *ext = src->extensions;
5105 
5106 		refcount_inc(&ext->refcnt);
5107 		dst->extensions = ext;
5108 	}
5109 }
5110 
skb_ext_copy(struct sk_buff * dst,const struct sk_buff * src)5111 static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *src)
5112 {
5113 	skb_ext_put(dst);
5114 	__skb_ext_copy(dst, src);
5115 }
5116 
__skb_ext_exist(const struct skb_ext * ext,enum skb_ext_id i)5117 static inline bool __skb_ext_exist(const struct skb_ext *ext, enum skb_ext_id i)
5118 {
5119 	return !!ext->offset[i];
5120 }
5121 
skb_ext_exist(const struct sk_buff * skb,enum skb_ext_id id)5122 static inline bool skb_ext_exist(const struct sk_buff *skb, enum skb_ext_id id)
5123 {
5124 	return skb->active_extensions & (1 << id);
5125 }
5126 
skb_ext_del(struct sk_buff * skb,enum skb_ext_id id)5127 static inline void skb_ext_del(struct sk_buff *skb, enum skb_ext_id id)
5128 {
5129 	if (skb_ext_exist(skb, id))
5130 		__skb_ext_del(skb, id);
5131 }
5132 
skb_ext_find(const struct sk_buff * skb,enum skb_ext_id id)5133 static inline void *skb_ext_find(const struct sk_buff *skb, enum skb_ext_id id)
5134 {
5135 	if (skb_ext_exist(skb, id)) {
5136 		struct skb_ext *ext = skb->extensions;
5137 
5138 		return (void *)ext + (ext->offset[id] << 3);
5139 	}
5140 
5141 	return NULL;
5142 }
5143 
skb_ext_reset(struct sk_buff * skb)5144 static inline void skb_ext_reset(struct sk_buff *skb)
5145 {
5146 	if (unlikely(skb->active_extensions)) {
5147 		__skb_ext_put(skb->extensions);
5148 		skb->active_extensions = 0;
5149 	}
5150 }
5151 
skb_has_extensions(struct sk_buff * skb)5152 static inline bool skb_has_extensions(struct sk_buff *skb)
5153 {
5154 	return unlikely(skb->active_extensions);
5155 }
5156 #else
__skb_ext_put(struct skb_ext * ext)5157 static inline void __skb_ext_put(struct skb_ext *ext) {}
skb_ext_put(struct sk_buff * skb)5158 static inline void skb_ext_put(struct sk_buff *skb) {}
skb_ext_reset(struct sk_buff * skb)5159 static inline void skb_ext_reset(struct sk_buff *skb) {}
skb_ext_del(struct sk_buff * skb,int unused)5160 static inline void skb_ext_del(struct sk_buff *skb, int unused) {}
__skb_ext_copy(struct sk_buff * d,const struct sk_buff * s)5161 static inline void __skb_ext_copy(struct sk_buff *d, const struct sk_buff *s) {}
skb_ext_copy(struct sk_buff * dst,const struct sk_buff * s)5162 static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *s) {}
skb_has_extensions(struct sk_buff * skb)5163 static inline bool skb_has_extensions(struct sk_buff *skb) { return false; }
5164 #endif /* CONFIG_SKB_EXTENSIONS */
5165 
nf_reset_ct(struct sk_buff * skb)5166 static inline void nf_reset_ct(struct sk_buff *skb)
5167 {
5168 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5169 	nf_conntrack_put(skb_nfct(skb));
5170 	skb->_nfct = 0;
5171 #endif
5172 }
5173 
nf_reset_trace(struct sk_buff * skb)5174 static inline void nf_reset_trace(struct sk_buff *skb)
5175 {
5176 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || IS_ENABLED(CONFIG_NF_TABLES)
5177 	skb->nf_trace = 0;
5178 #endif
5179 }
5180 
ipvs_reset(struct sk_buff * skb)5181 static inline void ipvs_reset(struct sk_buff *skb)
5182 {
5183 #if IS_ENABLED(CONFIG_IP_VS)
5184 	skb->ipvs_property = 0;
5185 #endif
5186 }
5187 
5188 /* Note: This doesn't put any conntrack info in dst. */
__nf_copy(struct sk_buff * dst,const struct sk_buff * src,bool copy)5189 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
5190 			     bool copy)
5191 {
5192 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5193 	dst->_nfct = src->_nfct;
5194 	nf_conntrack_get(skb_nfct(src));
5195 #endif
5196 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || IS_ENABLED(CONFIG_NF_TABLES)
5197 	if (copy)
5198 		dst->nf_trace = src->nf_trace;
5199 #endif
5200 }
5201 
nf_copy(struct sk_buff * dst,const struct sk_buff * src)5202 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
5203 {
5204 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5205 	nf_conntrack_put(skb_nfct(dst));
5206 #endif
5207 	dst->slow_gro = src->slow_gro;
5208 	__nf_copy(dst, src, true);
5209 }
5210 
5211 #ifdef CONFIG_NETWORK_SECMARK
skb_copy_secmark(struct sk_buff * to,const struct sk_buff * from)5212 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
5213 {
5214 	to->secmark = from->secmark;
5215 }
5216 
skb_init_secmark(struct sk_buff * skb)5217 static inline void skb_init_secmark(struct sk_buff *skb)
5218 {
5219 	skb->secmark = 0;
5220 }
5221 #else
skb_copy_secmark(struct sk_buff * to,const struct sk_buff * from)5222 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
5223 { }
5224 
skb_init_secmark(struct sk_buff * skb)5225 static inline void skb_init_secmark(struct sk_buff *skb)
5226 { }
5227 #endif
5228 
secpath_exists(const struct sk_buff * skb)5229 static inline int secpath_exists(const struct sk_buff *skb)
5230 {
5231 #ifdef CONFIG_XFRM
5232 	return skb_ext_exist(skb, SKB_EXT_SEC_PATH);
5233 #else
5234 	return 0;
5235 #endif
5236 }
5237 
skb_irq_freeable(const struct sk_buff * skb)5238 static inline bool skb_irq_freeable(const struct sk_buff *skb)
5239 {
5240 	return !skb->destructor &&
5241 		!secpath_exists(skb) &&
5242 		!skb_nfct(skb) &&
5243 		!skb->_skb_refdst &&
5244 		!skb_has_frag_list(skb);
5245 }
5246 
skb_set_queue_mapping(struct sk_buff * skb,u16 queue_mapping)5247 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
5248 {
5249 	skb->queue_mapping = queue_mapping;
5250 }
5251 
skb_get_queue_mapping(const struct sk_buff * skb)5252 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
5253 {
5254 	return skb->queue_mapping;
5255 }
5256 
skb_copy_queue_mapping(struct sk_buff * to,const struct sk_buff * from)5257 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
5258 {
5259 	to->queue_mapping = from->queue_mapping;
5260 }
5261 
skb_record_rx_queue(struct sk_buff * skb,u16 rx_queue)5262 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
5263 {
5264 	skb->queue_mapping = rx_queue + 1;
5265 }
5266 
skb_get_rx_queue(const struct sk_buff * skb)5267 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
5268 {
5269 	return skb->queue_mapping - 1;
5270 }
5271 
skb_rx_queue_recorded(const struct sk_buff * skb)5272 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
5273 {
5274 	return skb->queue_mapping != 0;
5275 }
5276 
skb_set_dst_pending_confirm(struct sk_buff * skb,u32 val)5277 static inline void skb_set_dst_pending_confirm(struct sk_buff *skb, u32 val)
5278 {
5279 	skb->dst_pending_confirm = val;
5280 }
5281 
skb_get_dst_pending_confirm(const struct sk_buff * skb)5282 static inline bool skb_get_dst_pending_confirm(const struct sk_buff *skb)
5283 {
5284 	return skb->dst_pending_confirm != 0;
5285 }
5286 
skb_sec_path(const struct sk_buff * skb)5287 static inline struct sec_path *skb_sec_path(const struct sk_buff *skb)
5288 {
5289 #ifdef CONFIG_XFRM
5290 	return skb_ext_find(skb, SKB_EXT_SEC_PATH);
5291 #else
5292 	return NULL;
5293 #endif
5294 }
5295 
skb_is_gso(const struct sk_buff * skb)5296 static inline bool skb_is_gso(const struct sk_buff *skb)
5297 {
5298 	return skb_shinfo(skb)->gso_size;
5299 }
5300 
5301 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_v6(const struct sk_buff * skb)5302 static inline bool skb_is_gso_v6(const struct sk_buff *skb)
5303 {
5304 	return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
5305 }
5306 
5307 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_sctp(const struct sk_buff * skb)5308 static inline bool skb_is_gso_sctp(const struct sk_buff *skb)
5309 {
5310 	return skb_shinfo(skb)->gso_type & SKB_GSO_SCTP;
5311 }
5312 
5313 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_tcp(const struct sk_buff * skb)5314 static inline bool skb_is_gso_tcp(const struct sk_buff *skb)
5315 {
5316 	return skb_shinfo(skb)->gso_type & (SKB_GSO_TCPV4 | SKB_GSO_TCPV6);
5317 }
5318 
skb_gso_reset(struct sk_buff * skb)5319 static inline void skb_gso_reset(struct sk_buff *skb)
5320 {
5321 	skb_shinfo(skb)->gso_size = 0;
5322 	skb_shinfo(skb)->gso_segs = 0;
5323 	skb_shinfo(skb)->gso_type = 0;
5324 }
5325 
skb_increase_gso_size(struct skb_shared_info * shinfo,u16 increment)5326 static inline void skb_increase_gso_size(struct skb_shared_info *shinfo,
5327 					 u16 increment)
5328 {
5329 	if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
5330 		return;
5331 	shinfo->gso_size += increment;
5332 }
5333 
skb_decrease_gso_size(struct skb_shared_info * shinfo,u16 decrement)5334 static inline void skb_decrease_gso_size(struct skb_shared_info *shinfo,
5335 					 u16 decrement)
5336 {
5337 	if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
5338 		return;
5339 	shinfo->gso_size -= decrement;
5340 }
5341 
5342 void __skb_warn_lro_forwarding(const struct sk_buff *skb);
5343 
skb_warn_if_lro(const struct sk_buff * skb)5344 static __always_inline bool skb_warn_if_lro(const struct sk_buff *skb)
5345 {
5346 	/* LRO sets gso_size but not gso_type, whereas if GSO is really
5347 	 * wanted then gso_type will be set. */
5348 	const struct skb_shared_info *shinfo = skb_shinfo(skb);
5349 
5350 	if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
5351 	    unlikely(shinfo->gso_type == 0)) {
5352 		__skb_warn_lro_forwarding(skb);
5353 		return true;
5354 	}
5355 	return false;
5356 }
5357 
skb_forward_csum(struct sk_buff * skb)5358 static inline void skb_forward_csum(struct sk_buff *skb)
5359 {
5360 	/* Unfortunately we don't support this one.  Any brave souls? */
5361 	if (skb->ip_summed == CHECKSUM_COMPLETE)
5362 		skb->ip_summed = CHECKSUM_NONE;
5363 }
5364 
5365 /**
5366  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
5367  * @skb: skb to check
5368  *
5369  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
5370  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
5371  * use this helper, to document places where we make this assertion.
5372  */
skb_checksum_none_assert(const struct sk_buff * skb)5373 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
5374 {
5375 	DEBUG_NET_WARN_ON_ONCE(skb->ip_summed != CHECKSUM_NONE);
5376 }
5377 
5378 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
5379 
5380 int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
5381 struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
5382 				     unsigned int transport_len,
5383 				     __sum16(*skb_chkf)(struct sk_buff *skb));
5384 
5385 /**
5386  * skb_head_is_locked - Determine if the skb->head is locked down
5387  * @skb: skb to check
5388  *
5389  * The head on skbs build around a head frag can be removed if they are
5390  * not cloned.  This function returns true if the skb head is locked down
5391  * due to either being allocated via kmalloc, or by being a clone with
5392  * multiple references to the head.
5393  */
skb_head_is_locked(const struct sk_buff * skb)5394 static inline bool skb_head_is_locked(const struct sk_buff *skb)
5395 {
5396 	return !skb->head_frag || skb_cloned(skb);
5397 }
5398 
5399 /* Local Checksum Offload.
5400  * Compute outer checksum based on the assumption that the
5401  * inner checksum will be offloaded later.
5402  * See Documentation/networking/checksum-offloads.rst for
5403  * explanation of how this works.
5404  * Fill in outer checksum adjustment (e.g. with sum of outer
5405  * pseudo-header) before calling.
5406  * Also ensure that inner checksum is in linear data area.
5407  */
lco_csum(struct sk_buff * skb)5408 static inline __wsum lco_csum(struct sk_buff *skb)
5409 {
5410 	unsigned char *csum_start = skb_checksum_start(skb);
5411 	unsigned char *l4_hdr = skb_transport_header(skb);
5412 	__wsum partial;
5413 
5414 	/* Start with complement of inner checksum adjustment */
5415 	partial = ~csum_unfold(*(__force __sum16 *)(csum_start +
5416 						    skb->csum_offset));
5417 
5418 	/* Add in checksum of our headers (incl. outer checksum
5419 	 * adjustment filled in by caller) and return result.
5420 	 */
5421 	return csum_partial(l4_hdr, csum_start - l4_hdr, partial);
5422 }
5423 
skb_is_redirected(const struct sk_buff * skb)5424 static inline bool skb_is_redirected(const struct sk_buff *skb)
5425 {
5426 	return skb->redirected;
5427 }
5428 
skb_set_redirected(struct sk_buff * skb,bool from_ingress)5429 static inline void skb_set_redirected(struct sk_buff *skb, bool from_ingress)
5430 {
5431 	skb->redirected = 1;
5432 #ifdef CONFIG_NET_REDIRECT
5433 	skb->from_ingress = from_ingress;
5434 	if (skb->from_ingress)
5435 		skb_clear_tstamp(skb);
5436 #endif
5437 }
5438 
skb_reset_redirect(struct sk_buff * skb)5439 static inline void skb_reset_redirect(struct sk_buff *skb)
5440 {
5441 	skb->redirected = 0;
5442 }
5443 
skb_set_redirected_noclear(struct sk_buff * skb,bool from_ingress)5444 static inline void skb_set_redirected_noclear(struct sk_buff *skb,
5445 					      bool from_ingress)
5446 {
5447 	skb->redirected = 1;
5448 #ifdef CONFIG_NET_REDIRECT
5449 	skb->from_ingress = from_ingress;
5450 #endif
5451 }
5452 
skb_csum_is_sctp(struct sk_buff * skb)5453 static inline bool skb_csum_is_sctp(struct sk_buff *skb)
5454 {
5455 #if IS_ENABLED(CONFIG_IP_SCTP)
5456 	return skb->csum_not_inet;
5457 #else
5458 	return 0;
5459 #endif
5460 }
5461 
skb_reset_csum_not_inet(struct sk_buff * skb)5462 static inline void skb_reset_csum_not_inet(struct sk_buff *skb)
5463 {
5464 	skb->ip_summed = CHECKSUM_NONE;
5465 #if IS_ENABLED(CONFIG_IP_SCTP)
5466 	skb->csum_not_inet = 0;
5467 #endif
5468 }
5469 
skb_set_kcov_handle(struct sk_buff * skb,struct kcov_common_handle_id kcov_handle)5470 static inline void skb_set_kcov_handle(struct sk_buff *skb,
5471 				       struct kcov_common_handle_id kcov_handle)
5472 {
5473 	skb->kcov_handle = kcov_handle;
5474 }
5475 
skb_get_kcov_handle(struct sk_buff * skb)5476 static inline struct kcov_common_handle_id skb_get_kcov_handle(struct sk_buff *skb)
5477 {
5478 	return skb->kcov_handle;
5479 }
5480 
skb_mark_for_recycle(struct sk_buff * skb)5481 static inline void skb_mark_for_recycle(struct sk_buff *skb)
5482 {
5483 #ifdef CONFIG_PAGE_POOL
5484 	skb->pp_recycle = 1;
5485 #endif
5486 }
5487 
5488 ssize_t skb_splice_from_iter(struct sk_buff *skb, struct iov_iter *iter,
5489 			     ssize_t maxsize);
5490 
5491 #endif	/* __KERNEL__ */
5492 #endif	/* _LINUX_SKBUFF_H */
5493