xref: /linux/include/linux/skbuff.h (revision 3e20009988e2470063824c58b19d1c80816cc46d)
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 #ifdef CONFIG_KCOV
1088 	u64			kcov_handle;
1089 #endif
1090 
1091 	); /* end headers group */
1092 
1093 	/* These elements must be at the end, see alloc_skb() for details.  */
1094 	sk_buff_data_t		tail;
1095 	sk_buff_data_t		end;
1096 	unsigned char		*head,
1097 				*data;
1098 	unsigned int		truesize;
1099 	refcount_t		users;
1100 
1101 #ifdef CONFIG_SKB_EXTENSIONS
1102 	/* only usable after checking ->active_extensions != 0 */
1103 	struct skb_ext		*extensions;
1104 #endif
1105 };
1106 
1107 /* if you move pkt_type around you also must adapt those constants */
1108 #ifdef __BIG_ENDIAN_BITFIELD
1109 #define PKT_TYPE_MAX	(7 << 5)
1110 #else
1111 #define PKT_TYPE_MAX	7
1112 #endif
1113 #define PKT_TYPE_OFFSET		offsetof(struct sk_buff, __pkt_type_offset)
1114 
1115 /* if you move tc_at_ingress or tstamp_type
1116  * around, you also must adapt these constants.
1117  */
1118 #ifdef __BIG_ENDIAN_BITFIELD
1119 #define SKB_TSTAMP_TYPE_MASK		(3 << 6)
1120 #define SKB_TSTAMP_TYPE_RSHIFT		(6)
1121 #define TC_AT_INGRESS_MASK		(1 << 5)
1122 #else
1123 #define SKB_TSTAMP_TYPE_MASK		(3)
1124 #define TC_AT_INGRESS_MASK		(1 << 2)
1125 #endif
1126 #define SKB_BF_MONO_TC_OFFSET		offsetof(struct sk_buff, __mono_tc_offset)
1127 
1128 #ifdef __KERNEL__
1129 /*
1130  *	Handling routines are only of interest to the kernel
1131  */
1132 
1133 #define SKB_ALLOC_FCLONE	0x01
1134 #define SKB_ALLOC_RX		0x02
1135 #define SKB_ALLOC_NAPI		0x04
1136 
1137 /**
1138  * skb_pfmemalloc - Test if the skb was allocated from PFMEMALLOC reserves
1139  * @skb: buffer
1140  */
skb_pfmemalloc(const struct sk_buff * skb)1141 static inline bool skb_pfmemalloc(const struct sk_buff *skb)
1142 {
1143 	return unlikely(skb->pfmemalloc);
1144 }
1145 
1146 /*
1147  * skb might have a dst pointer attached, refcounted or not.
1148  * _skb_refdst low order bit is set if refcount was _not_ taken
1149  */
1150 #define SKB_DST_NOREF	1UL
1151 #define SKB_DST_PTRMASK	~(SKB_DST_NOREF)
1152 
1153 /**
1154  * skb_dst - returns skb dst_entry
1155  * @skb: buffer
1156  *
1157  * Returns: skb dst_entry, regardless of reference taken or not.
1158  */
skb_dst(const struct sk_buff * skb)1159 static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
1160 {
1161 	/* If refdst was not refcounted, check we still are in a
1162 	 * rcu_read_lock section
1163 	 */
1164 	WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
1165 		!rcu_read_lock_held() &&
1166 		!rcu_read_lock_bh_held());
1167 	return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
1168 }
1169 
skb_dst_check_unset(struct sk_buff * skb)1170 static inline void skb_dst_check_unset(struct sk_buff *skb)
1171 {
1172 	DEBUG_NET_WARN_ON_ONCE((skb->_skb_refdst & SKB_DST_PTRMASK) &&
1173 			       !(skb->_skb_refdst & SKB_DST_NOREF));
1174 }
1175 
1176 /**
1177  * skb_dstref_steal() - return current dst_entry value and clear it
1178  * @skb: buffer
1179  *
1180  * Resets skb dst_entry without adjusting its reference count. Useful in
1181  * cases where dst_entry needs to be temporarily reset and restored.
1182  * Note that the returned value cannot be used directly because it
1183  * might contain SKB_DST_NOREF bit.
1184  *
1185  * When in doubt, prefer skb_dst_drop() over skb_dstref_steal() to correctly
1186  * handle dst_entry reference counting.
1187  *
1188  * Returns: original skb dst_entry.
1189  */
skb_dstref_steal(struct sk_buff * skb)1190 static inline unsigned long skb_dstref_steal(struct sk_buff *skb)
1191 {
1192 	unsigned long refdst = skb->_skb_refdst;
1193 
1194 	skb->_skb_refdst = 0;
1195 	return refdst;
1196 }
1197 
1198 /**
1199  * skb_dstref_restore() - restore skb dst_entry removed via skb_dstref_steal()
1200  * @skb: buffer
1201  * @refdst: dst entry from a call to skb_dstref_steal()
1202  */
skb_dstref_restore(struct sk_buff * skb,unsigned long refdst)1203 static inline void skb_dstref_restore(struct sk_buff *skb, unsigned long refdst)
1204 {
1205 	skb_dst_check_unset(skb);
1206 	skb->_skb_refdst = refdst;
1207 }
1208 
1209 /**
1210  * skb_dst_set - sets skb dst
1211  * @skb: buffer
1212  * @dst: dst entry
1213  *
1214  * Sets skb dst, assuming a reference was taken on dst and should
1215  * be released by skb_dst_drop()
1216  */
skb_dst_set(struct sk_buff * skb,struct dst_entry * dst)1217 static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
1218 {
1219 	skb_dst_check_unset(skb);
1220 	skb->slow_gro |= !!dst;
1221 	skb->_skb_refdst = (unsigned long)dst;
1222 }
1223 
1224 /**
1225  * skb_dst_set_noref - sets skb dst, hopefully, without taking reference
1226  * @skb: buffer
1227  * @dst: dst entry
1228  *
1229  * Sets skb dst, assuming a reference was not taken on dst.
1230  * If dst entry is cached, we do not take reference and dst_release
1231  * will be avoided by refdst_drop. If dst entry is not cached, we take
1232  * reference, so that last dst_release can destroy the dst immediately.
1233  */
skb_dst_set_noref(struct sk_buff * skb,struct dst_entry * dst)1234 static inline void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst)
1235 {
1236 	skb_dst_check_unset(skb);
1237 	WARN_ON(!rcu_read_lock_held() && !rcu_read_lock_bh_held());
1238 	skb->slow_gro |= !!dst;
1239 	skb->_skb_refdst = (unsigned long)dst | SKB_DST_NOREF;
1240 }
1241 
1242 /**
1243  * skb_dst_is_noref - Test if skb dst isn't refcounted
1244  * @skb: buffer
1245  */
skb_dst_is_noref(const struct sk_buff * skb)1246 static inline bool skb_dst_is_noref(const struct sk_buff *skb)
1247 {
1248 	return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
1249 }
1250 
1251 /* For mangling skb->pkt_type from user space side from applications
1252  * such as nft, tc, etc, we only allow a conservative subset of
1253  * possible pkt_types to be set.
1254 */
skb_pkt_type_ok(u32 ptype)1255 static inline bool skb_pkt_type_ok(u32 ptype)
1256 {
1257 	return ptype <= PACKET_OTHERHOST;
1258 }
1259 
1260 /**
1261  * skb_napi_id - Returns the skb's NAPI id
1262  * @skb: buffer
1263  */
skb_napi_id(const struct sk_buff * skb)1264 static inline unsigned int skb_napi_id(const struct sk_buff *skb)
1265 {
1266 #ifdef CONFIG_NET_RX_BUSY_POLL
1267 	return skb->napi_id;
1268 #else
1269 	return 0;
1270 #endif
1271 }
1272 
skb_wifi_acked_valid(const struct sk_buff * skb)1273 static inline bool skb_wifi_acked_valid(const struct sk_buff *skb)
1274 {
1275 #ifdef CONFIG_WIRELESS
1276 	return skb->wifi_acked_valid;
1277 #else
1278 	return 0;
1279 #endif
1280 }
1281 
1282 /**
1283  * skb_unref - decrement the skb's reference count
1284  * @skb: buffer
1285  *
1286  * Returns: true if we can free the skb.
1287  */
skb_unref(struct sk_buff * skb)1288 static inline bool skb_unref(struct sk_buff *skb)
1289 {
1290 	if (unlikely(!skb))
1291 		return false;
1292 	if (!IS_ENABLED(CONFIG_DEBUG_NET) && likely(refcount_read(&skb->users) == 1))
1293 		smp_rmb();
1294 	else if (likely(!refcount_dec_and_test(&skb->users)))
1295 		return false;
1296 
1297 	return true;
1298 }
1299 
skb_data_unref(const struct sk_buff * skb,struct skb_shared_info * shinfo)1300 static inline bool skb_data_unref(const struct sk_buff *skb,
1301 				  struct skb_shared_info *shinfo)
1302 {
1303 	int bias;
1304 
1305 	if (!skb->cloned)
1306 		return true;
1307 
1308 	bias = skb->nohdr ? (1 << SKB_DATAREF_SHIFT) + 1 : 1;
1309 
1310 	if (atomic_read(&shinfo->dataref) == bias)
1311 		smp_rmb();
1312 	else if (atomic_sub_return(bias, &shinfo->dataref))
1313 		return false;
1314 
1315 	return true;
1316 }
1317 
1318 void __fix_address sk_skb_reason_drop(struct sock *sk, struct sk_buff *skb,
1319 				      enum skb_drop_reason reason);
1320 
1321 static inline void
kfree_skb_reason(struct sk_buff * skb,enum skb_drop_reason reason)1322 kfree_skb_reason(struct sk_buff *skb, enum skb_drop_reason reason)
1323 {
1324 	sk_skb_reason_drop(NULL, skb, reason);
1325 }
1326 
1327 /**
1328  *	kfree_skb - free an sk_buff with 'NOT_SPECIFIED' reason
1329  *	@skb: buffer to free
1330  */
kfree_skb(struct sk_buff * skb)1331 static inline void kfree_skb(struct sk_buff *skb)
1332 {
1333 	kfree_skb_reason(skb, SKB_DROP_REASON_NOT_SPECIFIED);
1334 }
1335 
1336 void skb_release_head_state(struct sk_buff *skb);
1337 void kfree_skb_list_reason(struct sk_buff *segs,
1338 			   enum skb_drop_reason reason);
1339 void skb_dump(const char *level, const struct sk_buff *skb, bool full_pkt);
1340 void skb_tx_error(struct sk_buff *skb);
1341 
kfree_skb_list(struct sk_buff * segs)1342 static inline void kfree_skb_list(struct sk_buff *segs)
1343 {
1344 	kfree_skb_list_reason(segs, SKB_DROP_REASON_NOT_SPECIFIED);
1345 }
1346 
1347 #ifdef CONFIG_TRACEPOINTS
1348 void consume_skb(struct sk_buff *skb);
1349 #else
consume_skb(struct sk_buff * skb)1350 static inline void consume_skb(struct sk_buff *skb)
1351 {
1352 	return kfree_skb(skb);
1353 }
1354 #endif
1355 
1356 void __consume_stateless_skb(struct sk_buff *skb);
1357 void  __kfree_skb(struct sk_buff *skb);
1358 
1359 void kfree_skb_partial(struct sk_buff *skb, bool head_stolen);
1360 bool skb_try_coalesce(struct sk_buff *to, struct sk_buff *from,
1361 		      bool *fragstolen, int *delta_truesize);
1362 
1363 struct sk_buff *__alloc_skb(unsigned int size, gfp_t priority, int flags,
1364 			    int node);
1365 struct sk_buff *__build_skb(void *data, unsigned int frag_size);
1366 struct sk_buff *build_skb(void *data, unsigned int frag_size);
1367 struct sk_buff *build_skb_around(struct sk_buff *skb,
1368 				 void *data, unsigned int frag_size);
1369 void skb_attempt_defer_free(struct sk_buff *skb);
1370 
1371 u32 napi_skb_cache_get_bulk(void **skbs, u32 n);
1372 struct sk_buff *napi_build_skb(void *data, unsigned int frag_size);
1373 struct sk_buff *slab_build_skb(void *data);
1374 
1375 /**
1376  * alloc_skb - allocate a network buffer
1377  * @size: size to allocate
1378  * @priority: allocation mask
1379  *
1380  * This function is a convenient wrapper around __alloc_skb().
1381  */
alloc_skb(unsigned int size,gfp_t priority)1382 static inline struct sk_buff *alloc_skb(unsigned int size,
1383 					gfp_t priority)
1384 {
1385 	return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
1386 }
1387 
1388 struct sk_buff *alloc_skb_with_frags(unsigned long header_len,
1389 				     unsigned long data_len,
1390 				     int max_page_order,
1391 				     int *errcode,
1392 				     gfp_t gfp_mask);
1393 struct sk_buff *alloc_skb_for_msg(struct sk_buff *first);
1394 
1395 /* Layout of fast clones : [skb1][skb2][fclone_ref] */
1396 struct sk_buff_fclones {
1397 	struct sk_buff	skb1;
1398 
1399 	struct sk_buff	skb2;
1400 
1401 	refcount_t	fclone_ref;
1402 };
1403 
1404 /**
1405  *	skb_fclone_busy - check if fclone is busy
1406  *	@sk: socket
1407  *	@skb: buffer
1408  *
1409  * Returns: true if skb is a fast clone, and its clone is not freed.
1410  * Some drivers call skb_orphan() in their ndo_start_xmit(),
1411  * so we also check that didn't happen.
1412  */
skb_fclone_busy(const struct sock * sk,const struct sk_buff * skb)1413 static inline bool skb_fclone_busy(const struct sock *sk,
1414 				   const struct sk_buff *skb)
1415 {
1416 	const struct sk_buff_fclones *fclones;
1417 
1418 	fclones = container_of(skb, struct sk_buff_fclones, skb1);
1419 
1420 	return skb->fclone == SKB_FCLONE_ORIG &&
1421 	       refcount_read(&fclones->fclone_ref) > 1 &&
1422 	       READ_ONCE(fclones->skb2.sk) == sk;
1423 }
1424 
1425 /**
1426  * alloc_skb_fclone - allocate a network buffer from fclone cache
1427  * @size: size to allocate
1428  * @priority: allocation mask
1429  *
1430  * This function is a convenient wrapper around __alloc_skb().
1431  */
alloc_skb_fclone(unsigned int size,gfp_t priority)1432 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
1433 					       gfp_t priority)
1434 {
1435 	return __alloc_skb(size, priority, SKB_ALLOC_FCLONE, NUMA_NO_NODE);
1436 }
1437 
1438 struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
1439 void skb_headers_offset_update(struct sk_buff *skb, int off);
1440 int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
1441 struct sk_buff *skb_clone(struct sk_buff *skb, gfp_t priority);
1442 void skb_copy_header(struct sk_buff *new, const struct sk_buff *old);
1443 struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
1444 struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
1445 				   gfp_t gfp_mask, bool fclone);
__pskb_copy(struct sk_buff * skb,int headroom,gfp_t gfp_mask)1446 static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
1447 					  gfp_t gfp_mask)
1448 {
1449 	return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
1450 }
1451 
1452 int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
1453 struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
1454 				     unsigned int headroom);
1455 struct sk_buff *skb_expand_head(struct sk_buff *skb, unsigned int headroom);
1456 struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
1457 				int newtailroom, gfp_t priority);
1458 int __must_check skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
1459 				     int offset, int len);
1460 int __must_check skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg,
1461 			      int offset, int len);
1462 int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
1463 int __skb_pad(struct sk_buff *skb, int pad, bool free_on_error);
1464 
1465 /**
1466  *	skb_pad			-	zero pad the tail of an skb
1467  *	@skb: buffer to pad
1468  *	@pad: space to pad
1469  *
1470  *	Ensure that a buffer is followed by a padding area that is zero
1471  *	filled. Used by network drivers which may DMA or transfer data
1472  *	beyond the buffer end onto the wire.
1473  *
1474  *	May return error in out of memory cases. The skb is freed on error.
1475  */
skb_pad(struct sk_buff * skb,int pad)1476 static inline int skb_pad(struct sk_buff *skb, int pad)
1477 {
1478 	return __skb_pad(skb, pad, true);
1479 }
1480 #define dev_kfree_skb(a)	consume_skb(a)
1481 
1482 int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
1483 			 int offset, size_t size, size_t max_frags);
1484 
1485 struct skb_seq_state {
1486 	__u32		lower_offset;
1487 	__u32		upper_offset;
1488 	__u32		frag_idx;
1489 	__u32		stepped_offset;
1490 	struct sk_buff	*root_skb;
1491 	struct sk_buff	*cur_skb;
1492 	__u8		*frag_data;
1493 	__u32		frag_off;
1494 };
1495 
1496 void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
1497 			  unsigned int to, struct skb_seq_state *st);
1498 unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
1499 			  struct skb_seq_state *st);
1500 void skb_abort_seq_read(struct skb_seq_state *st);
1501 int skb_copy_seq_read(struct skb_seq_state *st, int offset, void *to, int len);
1502 
1503 unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
1504 			   unsigned int to, struct ts_config *config);
1505 
1506 /*
1507  * Packet hash types specify the type of hash in skb_set_hash.
1508  *
1509  * Hash types refer to the protocol layer addresses which are used to
1510  * construct a packet's hash. The hashes are used to differentiate or identify
1511  * flows of the protocol layer for the hash type. Hash types are either
1512  * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
1513  *
1514  * Properties of hashes:
1515  *
1516  * 1) Two packets in different flows have different hash values
1517  * 2) Two packets in the same flow should have the same hash value
1518  *
1519  * A hash at a higher layer is considered to be more specific. A driver should
1520  * set the most specific hash possible.
1521  *
1522  * A driver cannot indicate a more specific hash than the layer at which a hash
1523  * was computed. For instance an L3 hash cannot be set as an L4 hash.
1524  *
1525  * A driver may indicate a hash level which is less specific than the
1526  * actual layer the hash was computed on. For instance, a hash computed
1527  * at L4 may be considered an L3 hash. This should only be done if the
1528  * driver can't unambiguously determine that the HW computed the hash at
1529  * the higher layer. Note that the "should" in the second property above
1530  * permits this.
1531  */
1532 enum pkt_hash_types {
1533 	PKT_HASH_TYPE_NONE,	/* Undefined type */
1534 	PKT_HASH_TYPE_L2,	/* Input: src_MAC, dest_MAC */
1535 	PKT_HASH_TYPE_L3,	/* Input: src_IP, dst_IP */
1536 	PKT_HASH_TYPE_L4,	/* Input: src_IP, dst_IP, src_port, dst_port */
1537 };
1538 
skb_clear_hash(struct sk_buff * skb)1539 static inline void skb_clear_hash(struct sk_buff *skb)
1540 {
1541 	skb->hash = 0;
1542 	skb->sw_hash = 0;
1543 	skb->l4_hash = 0;
1544 }
1545 
skb_clear_hash_if_not_l4(struct sk_buff * skb)1546 static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
1547 {
1548 	if (!skb->l4_hash)
1549 		skb_clear_hash(skb);
1550 }
1551 
1552 static inline void
__skb_set_hash(struct sk_buff * skb,__u32 hash,bool is_sw,bool is_l4)1553 __skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
1554 {
1555 	skb->l4_hash = is_l4;
1556 	skb->sw_hash = is_sw;
1557 	skb->hash = hash;
1558 }
1559 
1560 static inline void
skb_set_hash(struct sk_buff * skb,__u32 hash,enum pkt_hash_types type)1561 skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
1562 {
1563 	/* Used by drivers to set hash from HW */
1564 	__skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
1565 }
1566 
1567 static inline void
__skb_set_sw_hash(struct sk_buff * skb,__u32 hash,bool is_l4)1568 __skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
1569 {
1570 	__skb_set_hash(skb, hash, true, is_l4);
1571 }
1572 
1573 u32 __skb_get_hash_symmetric_net(const struct net *net, const struct sk_buff *skb);
1574 
__skb_get_hash_symmetric(const struct sk_buff * skb)1575 static inline u32 __skb_get_hash_symmetric(const struct sk_buff *skb)
1576 {
1577 	return __skb_get_hash_symmetric_net(NULL, skb);
1578 }
1579 
1580 void __skb_get_hash_net(const struct net *net, struct sk_buff *skb);
1581 u32 skb_get_poff(const struct sk_buff *skb);
1582 u32 __skb_get_poff(const struct sk_buff *skb, const void *data,
1583 		   const struct flow_keys_basic *keys, int hlen);
1584 __be32 skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
1585 			  const void *data, int hlen_proto);
1586 
1587 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
1588 			     const struct flow_dissector_key *key,
1589 			     unsigned int key_count);
1590 
1591 struct bpf_flow_dissector;
1592 u32 bpf_flow_dissect(struct bpf_prog *prog, struct bpf_flow_dissector *ctx,
1593 		     __be16 proto, int nhoff, int hlen, unsigned int flags);
1594 
1595 bool __skb_flow_dissect(const struct net *net,
1596 			const struct sk_buff *skb,
1597 			struct flow_dissector *flow_dissector,
1598 			void *target_container, const void *data,
1599 			__be16 proto, int nhoff, int hlen, unsigned int flags);
1600 
skb_flow_dissect(const struct sk_buff * skb,struct flow_dissector * flow_dissector,void * target_container,unsigned int flags)1601 static inline bool skb_flow_dissect(const struct sk_buff *skb,
1602 				    struct flow_dissector *flow_dissector,
1603 				    void *target_container, unsigned int flags)
1604 {
1605 	return __skb_flow_dissect(NULL, skb, flow_dissector,
1606 				  target_container, NULL, 0, 0, 0, flags);
1607 }
1608 
skb_flow_dissect_flow_keys(const struct sk_buff * skb,struct flow_keys * flow,unsigned int flags)1609 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
1610 					      struct flow_keys *flow,
1611 					      unsigned int flags)
1612 {
1613 	memset(flow, 0, sizeof(*flow));
1614 	return __skb_flow_dissect(NULL, skb, &flow_keys_dissector,
1615 				  flow, NULL, 0, 0, 0, flags);
1616 }
1617 
1618 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)1619 skb_flow_dissect_flow_keys_basic(const struct net *net,
1620 				 const struct sk_buff *skb,
1621 				 struct flow_keys_basic *flow,
1622 				 const void *data, __be16 proto,
1623 				 int nhoff, int hlen, unsigned int flags)
1624 {
1625 	memset(flow, 0, sizeof(*flow));
1626 	return __skb_flow_dissect(net, skb, &flow_keys_basic_dissector, flow,
1627 				  data, proto, nhoff, hlen, flags);
1628 }
1629 
1630 void skb_flow_dissect_meta(const struct sk_buff *skb,
1631 			   struct flow_dissector *flow_dissector,
1632 			   void *target_container);
1633 
1634 /* Gets a skb connection tracking info, ctinfo map should be a
1635  * map of mapsize to translate enum ip_conntrack_info states
1636  * to user states.
1637  */
1638 void
1639 skb_flow_dissect_ct(const struct sk_buff *skb,
1640 		    struct flow_dissector *flow_dissector,
1641 		    void *target_container,
1642 		    u16 *ctinfo_map, size_t mapsize,
1643 		    bool post_ct, u16 zone);
1644 void
1645 skb_flow_dissect_tunnel_info(const struct sk_buff *skb,
1646 			     struct flow_dissector *flow_dissector,
1647 			     void *target_container);
1648 
1649 void skb_flow_dissect_hash(const struct sk_buff *skb,
1650 			   struct flow_dissector *flow_dissector,
1651 			   void *target_container);
1652 
skb_get_hash_net(const struct net * net,struct sk_buff * skb)1653 static inline __u32 skb_get_hash_net(const struct net *net, struct sk_buff *skb)
1654 {
1655 	if (!skb->l4_hash && !skb->sw_hash)
1656 		__skb_get_hash_net(net, skb);
1657 
1658 	return skb->hash;
1659 }
1660 
skb_get_hash(struct sk_buff * skb)1661 static inline __u32 skb_get_hash(struct sk_buff *skb)
1662 {
1663 	if (!skb->l4_hash && !skb->sw_hash)
1664 		__skb_get_hash_net(NULL, skb);
1665 
1666 	return skb->hash;
1667 }
1668 
skb_get_hash_flowi6(struct sk_buff * skb,const struct flowi6 * fl6)1669 static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
1670 {
1671 	if (!skb->l4_hash && !skb->sw_hash) {
1672 		struct flow_keys keys;
1673 		__u32 hash = __get_hash_from_flowi6(fl6, &keys);
1674 
1675 		__skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1676 	}
1677 
1678 	return skb->hash;
1679 }
1680 
1681 __u32 skb_get_hash_perturb(const struct sk_buff *skb,
1682 			   const siphash_key_t *perturb);
1683 
skb_get_hash_raw(const struct sk_buff * skb)1684 static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1685 {
1686 	return skb->hash;
1687 }
1688 
skb_copy_hash(struct sk_buff * to,const struct sk_buff * from)1689 static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1690 {
1691 	to->hash = from->hash;
1692 	to->sw_hash = from->sw_hash;
1693 	to->l4_hash = from->l4_hash;
1694 };
1695 
skb_cmp_decrypted(const struct sk_buff * skb1,const struct sk_buff * skb2)1696 static inline int skb_cmp_decrypted(const struct sk_buff *skb1,
1697 				    const struct sk_buff *skb2)
1698 {
1699 #ifdef CONFIG_SKB_DECRYPTED
1700 	return skb2->decrypted - skb1->decrypted;
1701 #else
1702 	return 0;
1703 #endif
1704 }
1705 
skb_is_decrypted(const struct sk_buff * skb)1706 static inline bool skb_is_decrypted(const struct sk_buff *skb)
1707 {
1708 #ifdef CONFIG_SKB_DECRYPTED
1709 	return skb->decrypted;
1710 #else
1711 	return false;
1712 #endif
1713 }
1714 
skb_copy_decrypted(struct sk_buff * to,const struct sk_buff * from)1715 static inline void skb_copy_decrypted(struct sk_buff *to,
1716 				      const struct sk_buff *from)
1717 {
1718 #ifdef CONFIG_SKB_DECRYPTED
1719 	to->decrypted = from->decrypted;
1720 #endif
1721 }
1722 
1723 #ifdef NET_SKBUFF_DATA_USES_OFFSET
skb_end_pointer(const struct sk_buff * skb)1724 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1725 {
1726 	return skb->head + skb->end;
1727 }
1728 
skb_end_offset(const struct sk_buff * skb)1729 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1730 {
1731 	return skb->end;
1732 }
1733 
skb_set_end_offset(struct sk_buff * skb,unsigned int offset)1734 static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
1735 {
1736 	skb->end = offset;
1737 }
1738 #else
skb_end_pointer(const struct sk_buff * skb)1739 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1740 {
1741 	return skb->end;
1742 }
1743 
skb_end_offset(const struct sk_buff * skb)1744 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1745 {
1746 	return skb->end - skb->head;
1747 }
1748 
skb_set_end_offset(struct sk_buff * skb,unsigned int offset)1749 static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
1750 {
1751 	skb->end = skb->head + offset;
1752 }
1753 #endif
1754 
1755 extern const struct ubuf_info_ops msg_zerocopy_ubuf_ops;
1756 
1757 struct ubuf_info *msg_zerocopy_realloc(struct sock *sk, size_t size,
1758 				       struct ubuf_info *uarg, bool devmem);
1759 
1760 void msg_zerocopy_put_abort(struct ubuf_info *uarg, bool have_uref);
1761 
1762 struct net_devmem_dmabuf_binding;
1763 
1764 int __zerocopy_sg_from_iter(struct msghdr *msg, struct sock *sk,
1765 			    struct sk_buff *skb, struct iov_iter *from,
1766 			    size_t length,
1767 			    struct net_devmem_dmabuf_binding *binding);
1768 
1769 int zerocopy_fill_skb_from_iter(struct sk_buff *skb,
1770 				struct iov_iter *from, size_t length);
1771 
skb_zerocopy_iter_dgram(struct sk_buff * skb,struct msghdr * msg,int len)1772 static inline int skb_zerocopy_iter_dgram(struct sk_buff *skb,
1773 					  struct msghdr *msg, int len)
1774 {
1775 	return __zerocopy_sg_from_iter(msg, skb->sk, skb, &msg->msg_iter, len,
1776 				       NULL);
1777 }
1778 
1779 int skb_zerocopy_iter_stream(struct sock *sk, struct sk_buff *skb,
1780 			     struct msghdr *msg, int len,
1781 			     struct ubuf_info *uarg,
1782 			     struct net_devmem_dmabuf_binding *binding);
1783 
1784 /* Internal */
1785 #define skb_shinfo(SKB)	((struct skb_shared_info *)(skb_end_pointer(SKB)))
1786 
skb_hwtstamps(struct sk_buff * skb)1787 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1788 {
1789 	return &skb_shinfo(skb)->hwtstamps;
1790 }
1791 
skb_zcopy(struct sk_buff * skb)1792 static inline struct ubuf_info *skb_zcopy(struct sk_buff *skb)
1793 {
1794 	bool is_zcopy = skb && skb_shinfo(skb)->flags & SKBFL_ZEROCOPY_ENABLE;
1795 
1796 	return is_zcopy ? skb_uarg(skb) : NULL;
1797 }
1798 
skb_zcopy_pure(const struct sk_buff * skb)1799 static inline bool skb_zcopy_pure(const struct sk_buff *skb)
1800 {
1801 	return skb_shinfo(skb)->flags & SKBFL_PURE_ZEROCOPY;
1802 }
1803 
skb_zcopy_managed(const struct sk_buff * skb)1804 static inline bool skb_zcopy_managed(const struct sk_buff *skb)
1805 {
1806 	return skb_shinfo(skb)->flags & SKBFL_MANAGED_FRAG_REFS;
1807 }
1808 
skb_pure_zcopy_same(const struct sk_buff * skb1,const struct sk_buff * skb2)1809 static inline bool skb_pure_zcopy_same(const struct sk_buff *skb1,
1810 				       const struct sk_buff *skb2)
1811 {
1812 	return skb_zcopy_pure(skb1) == skb_zcopy_pure(skb2);
1813 }
1814 
net_zcopy_get(struct ubuf_info * uarg)1815 static inline void net_zcopy_get(struct ubuf_info *uarg)
1816 {
1817 	refcount_inc(&uarg->refcnt);
1818 }
1819 
skb_zcopy_init(struct sk_buff * skb,struct ubuf_info * uarg)1820 static inline void skb_zcopy_init(struct sk_buff *skb, struct ubuf_info *uarg)
1821 {
1822 	skb_shinfo(skb)->destructor_arg = uarg;
1823 	skb_shinfo(skb)->flags |= uarg->flags;
1824 }
1825 
skb_zcopy_set(struct sk_buff * skb,struct ubuf_info * uarg,bool * have_ref)1826 static inline void skb_zcopy_set(struct sk_buff *skb, struct ubuf_info *uarg,
1827 				 bool *have_ref)
1828 {
1829 	if (skb && uarg && !skb_zcopy(skb)) {
1830 		if (unlikely(have_ref && *have_ref))
1831 			*have_ref = false;
1832 		else
1833 			net_zcopy_get(uarg);
1834 		skb_zcopy_init(skb, uarg);
1835 	}
1836 }
1837 
skb_zcopy_set_nouarg(struct sk_buff * skb,void * val)1838 static inline void skb_zcopy_set_nouarg(struct sk_buff *skb, void *val)
1839 {
1840 	skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t) val | 0x1UL);
1841 	skb_shinfo(skb)->flags |= SKBFL_ZEROCOPY_FRAG;
1842 }
1843 
skb_zcopy_is_nouarg(struct sk_buff * skb)1844 static inline bool skb_zcopy_is_nouarg(struct sk_buff *skb)
1845 {
1846 	return (uintptr_t) skb_shinfo(skb)->destructor_arg & 0x1UL;
1847 }
1848 
skb_zcopy_get_nouarg(struct sk_buff * skb)1849 static inline void *skb_zcopy_get_nouarg(struct sk_buff *skb)
1850 {
1851 	return (void *)((uintptr_t) skb_shinfo(skb)->destructor_arg & ~0x1UL);
1852 }
1853 
net_zcopy_put(struct ubuf_info * uarg)1854 static inline void net_zcopy_put(struct ubuf_info *uarg)
1855 {
1856 	if (uarg)
1857 		uarg->ops->complete(NULL, uarg, true);
1858 }
1859 
net_zcopy_put_abort(struct ubuf_info * uarg,bool have_uref)1860 static inline void net_zcopy_put_abort(struct ubuf_info *uarg, bool have_uref)
1861 {
1862 	if (uarg) {
1863 		if (uarg->ops == &msg_zerocopy_ubuf_ops)
1864 			msg_zerocopy_put_abort(uarg, have_uref);
1865 		else if (have_uref)
1866 			net_zcopy_put(uarg);
1867 	}
1868 }
1869 
1870 /* Release a reference on a zerocopy structure */
skb_zcopy_clear(struct sk_buff * skb,bool zerocopy_success)1871 static inline void skb_zcopy_clear(struct sk_buff *skb, bool zerocopy_success)
1872 {
1873 	struct ubuf_info *uarg = skb_zcopy(skb);
1874 
1875 	if (uarg) {
1876 		if (!skb_zcopy_is_nouarg(skb))
1877 			uarg->ops->complete(skb, uarg, zerocopy_success);
1878 
1879 		skb_shinfo(skb)->flags &= ~SKBFL_ALL_ZEROCOPY;
1880 	}
1881 }
1882 
1883 void __skb_zcopy_downgrade_managed(struct sk_buff *skb);
1884 
skb_zcopy_downgrade_managed(struct sk_buff * skb)1885 static inline void skb_zcopy_downgrade_managed(struct sk_buff *skb)
1886 {
1887 	if (unlikely(skb_zcopy_managed(skb)))
1888 		__skb_zcopy_downgrade_managed(skb);
1889 }
1890 
1891 /* Return true if frags in this skb are readable by the host. */
skb_frags_readable(const struct sk_buff * skb)1892 static inline bool skb_frags_readable(const struct sk_buff *skb)
1893 {
1894 	return !skb->unreadable;
1895 }
1896 
skb_mark_not_on_list(struct sk_buff * skb)1897 static inline void skb_mark_not_on_list(struct sk_buff *skb)
1898 {
1899 	skb->next = NULL;
1900 }
1901 
skb_poison_list(struct sk_buff * skb)1902 static inline void skb_poison_list(struct sk_buff *skb)
1903 {
1904 #ifdef CONFIG_DEBUG_NET
1905 	skb->next = SKB_LIST_POISON_NEXT;
1906 #endif
1907 }
1908 
1909 /* Iterate through singly-linked GSO fragments of an skb. */
1910 #define skb_list_walk_safe(first, skb, next_skb)                               \
1911 	for ((skb) = (first), (next_skb) = (skb) ? (skb)->next : NULL; (skb);  \
1912 	     (skb) = (next_skb), (next_skb) = (skb) ? (skb)->next : NULL)
1913 
skb_list_del_init(struct sk_buff * skb)1914 static inline void skb_list_del_init(struct sk_buff *skb)
1915 {
1916 	__list_del_entry(&skb->list);
1917 	skb_mark_not_on_list(skb);
1918 }
1919 
1920 /**
1921  *	skb_queue_empty - check if a queue is empty
1922  *	@list: queue head
1923  *
1924  *	Returns true if the queue is empty, false otherwise.
1925  */
skb_queue_empty(const struct sk_buff_head * list)1926 static inline int skb_queue_empty(const struct sk_buff_head *list)
1927 {
1928 	return list->next == (const struct sk_buff *) list;
1929 }
1930 
1931 /**
1932  *	skb_queue_empty_lockless - check if a queue is empty
1933  *	@list: queue head
1934  *
1935  *	Returns true if the queue is empty, false otherwise.
1936  *	This variant can be used in lockless contexts.
1937  */
skb_queue_empty_lockless(const struct sk_buff_head * list)1938 static inline bool skb_queue_empty_lockless(const struct sk_buff_head *list)
1939 {
1940 	return READ_ONCE(list->next) == (const struct sk_buff *) list;
1941 }
1942 
1943 
1944 /**
1945  *	skb_queue_is_last - check if skb is the last entry in the queue
1946  *	@list: queue head
1947  *	@skb: buffer
1948  *
1949  *	Returns true if @skb is the last buffer on the list.
1950  */
skb_queue_is_last(const struct sk_buff_head * list,const struct sk_buff * skb)1951 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1952 				     const struct sk_buff *skb)
1953 {
1954 	return skb->next == (const struct sk_buff *) list;
1955 }
1956 
1957 /**
1958  *	skb_queue_is_first - check if skb is the first entry in the queue
1959  *	@list: queue head
1960  *	@skb: buffer
1961  *
1962  *	Returns true if @skb is the first buffer on the list.
1963  */
skb_queue_is_first(const struct sk_buff_head * list,const struct sk_buff * skb)1964 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1965 				      const struct sk_buff *skb)
1966 {
1967 	return skb->prev == (const struct sk_buff *) list;
1968 }
1969 
1970 /**
1971  *	skb_queue_next - return the next packet in the queue
1972  *	@list: queue head
1973  *	@skb: current buffer
1974  *
1975  *	Return the next packet in @list after @skb.  It is only valid to
1976  *	call this if skb_queue_is_last() evaluates to false.
1977  */
skb_queue_next(const struct sk_buff_head * list,const struct sk_buff * skb)1978 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1979 					     const struct sk_buff *skb)
1980 {
1981 	/* This BUG_ON may seem severe, but if we just return then we
1982 	 * are going to dereference garbage.
1983 	 */
1984 	BUG_ON(skb_queue_is_last(list, skb));
1985 	return skb->next;
1986 }
1987 
1988 /**
1989  *	skb_queue_prev - return the prev packet in the queue
1990  *	@list: queue head
1991  *	@skb: current buffer
1992  *
1993  *	Return the prev packet in @list before @skb.  It is only valid to
1994  *	call this if skb_queue_is_first() evaluates to false.
1995  */
skb_queue_prev(const struct sk_buff_head * list,const struct sk_buff * skb)1996 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1997 					     const struct sk_buff *skb)
1998 {
1999 	/* This BUG_ON may seem severe, but if we just return then we
2000 	 * are going to dereference garbage.
2001 	 */
2002 	BUG_ON(skb_queue_is_first(list, skb));
2003 	return skb->prev;
2004 }
2005 
2006 /**
2007  *	skb_get - reference buffer
2008  *	@skb: buffer to reference
2009  *
2010  *	Makes another reference to a socket buffer and returns a pointer
2011  *	to the buffer.
2012  */
skb_get(struct sk_buff * skb)2013 static inline struct sk_buff *skb_get(struct sk_buff *skb)
2014 {
2015 	refcount_inc(&skb->users);
2016 	return skb;
2017 }
2018 
2019 /*
2020  * If users == 1, we are the only owner and can avoid redundant atomic changes.
2021  */
2022 
2023 /**
2024  *	skb_cloned - is the buffer a clone
2025  *	@skb: buffer to check
2026  *
2027  *	Returns true if the buffer was generated with skb_clone() and is
2028  *	one of multiple shared copies of the buffer. Cloned buffers are
2029  *	shared data so must not be written to under normal circumstances.
2030  */
skb_cloned(const struct sk_buff * skb)2031 static inline int skb_cloned(const struct sk_buff *skb)
2032 {
2033 	return skb->cloned &&
2034 	       (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
2035 }
2036 
skb_unclone(struct sk_buff * skb,gfp_t pri)2037 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
2038 {
2039 	might_sleep_if(gfpflags_allow_blocking(pri));
2040 
2041 	if (skb_cloned(skb))
2042 		return pskb_expand_head(skb, 0, 0, pri);
2043 
2044 	return 0;
2045 }
2046 
2047 /* This variant of skb_unclone() makes sure skb->truesize
2048  * and skb_end_offset() are not changed, whenever a new skb->head is needed.
2049  *
2050  * Indeed there is no guarantee that ksize(kmalloc(X)) == ksize(kmalloc(X))
2051  * when various debugging features are in place.
2052  */
2053 int __skb_unclone_keeptruesize(struct sk_buff *skb, gfp_t pri);
skb_unclone_keeptruesize(struct sk_buff * skb,gfp_t pri)2054 static inline int skb_unclone_keeptruesize(struct sk_buff *skb, gfp_t pri)
2055 {
2056 	might_sleep_if(gfpflags_allow_blocking(pri));
2057 
2058 	if (skb_cloned(skb))
2059 		return __skb_unclone_keeptruesize(skb, pri);
2060 	return 0;
2061 }
2062 
2063 /**
2064  *	skb_header_cloned - is the header a clone
2065  *	@skb: buffer to check
2066  *
2067  *	Returns true if modifying the header part of the buffer requires
2068  *	the data to be copied.
2069  */
skb_header_cloned(const struct sk_buff * skb)2070 static inline int skb_header_cloned(const struct sk_buff *skb)
2071 {
2072 	int dataref;
2073 
2074 	if (!skb->cloned)
2075 		return 0;
2076 
2077 	dataref = atomic_read(&skb_shinfo(skb)->dataref);
2078 	dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
2079 	return dataref != 1;
2080 }
2081 
skb_header_unclone(struct sk_buff * skb,gfp_t pri)2082 static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri)
2083 {
2084 	might_sleep_if(gfpflags_allow_blocking(pri));
2085 
2086 	if (skb_header_cloned(skb))
2087 		return pskb_expand_head(skb, 0, 0, pri);
2088 
2089 	return 0;
2090 }
2091 
2092 /**
2093  * __skb_header_release() - allow clones to use the headroom
2094  * @skb: buffer to operate on
2095  *
2096  * See "DOC: dataref and headerless skbs".
2097  */
__skb_header_release(struct sk_buff * skb)2098 static inline void __skb_header_release(struct sk_buff *skb)
2099 {
2100 	skb->nohdr = 1;
2101 	atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
2102 }
2103 
2104 
2105 /**
2106  *	skb_shared - is the buffer shared
2107  *	@skb: buffer to check
2108  *
2109  *	Returns true if more than one person has a reference to this
2110  *	buffer.
2111  */
skb_shared(const struct sk_buff * skb)2112 static inline int skb_shared(const struct sk_buff *skb)
2113 {
2114 	return refcount_read(&skb->users) != 1;
2115 }
2116 
2117 /**
2118  *	skb_share_check - check if buffer is shared and if so clone it
2119  *	@skb: buffer to check
2120  *	@pri: priority for memory allocation
2121  *
2122  *	If the buffer is shared the buffer is cloned and the old copy
2123  *	drops a reference. A new clone with a single reference is returned.
2124  *	If the buffer is not shared the original buffer is returned. When
2125  *	being called from interrupt status or with spinlocks held pri must
2126  *	be GFP_ATOMIC.
2127  *
2128  *	NULL is returned on a memory allocation failure.
2129  */
skb_share_check(struct sk_buff * skb,gfp_t pri)2130 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
2131 {
2132 	might_sleep_if(gfpflags_allow_blocking(pri));
2133 	if (skb_shared(skb)) {
2134 		struct sk_buff *nskb = skb_clone(skb, pri);
2135 
2136 		if (likely(nskb))
2137 			consume_skb(skb);
2138 		else
2139 			kfree_skb(skb);
2140 		skb = nskb;
2141 	}
2142 	return skb;
2143 }
2144 
2145 /*
2146  *	Copy shared buffers into a new sk_buff. We effectively do COW on
2147  *	packets to handle cases where we have a local reader and forward
2148  *	and a couple of other messy ones. The normal one is tcpdumping
2149  *	a packet that's being forwarded.
2150  */
2151 
2152 /**
2153  *	skb_unshare - make a copy of a shared buffer
2154  *	@skb: buffer to check
2155  *	@pri: priority for memory allocation
2156  *
2157  *	If the socket buffer is a clone then this function creates a new
2158  *	copy of the data, drops a reference count on the old copy and returns
2159  *	the new copy with the reference count at 1. If the buffer is not a clone
2160  *	the original buffer is returned. When called with a spinlock held or
2161  *	from interrupt state @pri must be %GFP_ATOMIC
2162  *
2163  *	%NULL is returned on a memory allocation failure.
2164  */
skb_unshare(struct sk_buff * skb,gfp_t pri)2165 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
2166 					  gfp_t pri)
2167 {
2168 	might_sleep_if(gfpflags_allow_blocking(pri));
2169 	if (skb_cloned(skb)) {
2170 		struct sk_buff *nskb = skb_copy(skb, pri);
2171 
2172 		/* Free our shared copy */
2173 		if (likely(nskb))
2174 			consume_skb(skb);
2175 		else
2176 			kfree_skb(skb);
2177 		skb = nskb;
2178 	}
2179 	return skb;
2180 }
2181 
2182 /**
2183  *	skb_peek - peek at the head of an &sk_buff_head
2184  *	@list_: list to peek at
2185  *
2186  *	Peek an &sk_buff. Unlike most other operations you _MUST_
2187  *	be careful with this one. A peek leaves the buffer on the
2188  *	list and someone else may run off with it. You must hold
2189  *	the appropriate locks or have a private queue to do this.
2190  *
2191  *	Returns %NULL for an empty list or a pointer to the head element.
2192  *	The reference count is not incremented and the reference is therefore
2193  *	volatile. Use with caution.
2194  */
skb_peek(const struct sk_buff_head * list_)2195 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
2196 {
2197 	struct sk_buff *skb = list_->next;
2198 
2199 	if (skb == (struct sk_buff *)list_)
2200 		skb = NULL;
2201 	return skb;
2202 }
2203 
2204 /**
2205  *	__skb_peek - peek at the head of a non-empty &sk_buff_head
2206  *	@list_: list to peek at
2207  *
2208  *	Like skb_peek(), but the caller knows that the list is not empty.
2209  */
__skb_peek(const struct sk_buff_head * list_)2210 static inline struct sk_buff *__skb_peek(const struct sk_buff_head *list_)
2211 {
2212 	return list_->next;
2213 }
2214 
2215 /**
2216  *	skb_peek_next - peek skb following the given one from a queue
2217  *	@skb: skb to start from
2218  *	@list_: list to peek at
2219  *
2220  *	Returns %NULL when the end of the list is met or a pointer to the
2221  *	next element. The reference count is not incremented and the
2222  *	reference is therefore volatile. Use with caution.
2223  */
skb_peek_next(struct sk_buff * skb,const struct sk_buff_head * list_)2224 static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
2225 		const struct sk_buff_head *list_)
2226 {
2227 	struct sk_buff *next = skb->next;
2228 
2229 	if (next == (struct sk_buff *)list_)
2230 		next = NULL;
2231 	return next;
2232 }
2233 
2234 /**
2235  *	skb_peek_tail - peek at the tail of an &sk_buff_head
2236  *	@list_: list to peek at
2237  *
2238  *	Peek an &sk_buff. Unlike most other operations you _MUST_
2239  *	be careful with this one. A peek leaves the buffer on the
2240  *	list and someone else may run off with it. You must hold
2241  *	the appropriate locks or have a private queue to do this.
2242  *
2243  *	Returns %NULL for an empty list or a pointer to the tail element.
2244  *	The reference count is not incremented and the reference is therefore
2245  *	volatile. Use with caution.
2246  */
skb_peek_tail(const struct sk_buff_head * list_)2247 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
2248 {
2249 	struct sk_buff *skb = READ_ONCE(list_->prev);
2250 
2251 	if (skb == (struct sk_buff *)list_)
2252 		skb = NULL;
2253 	return skb;
2254 
2255 }
2256 
2257 /**
2258  *	skb_queue_len	- get queue length
2259  *	@list_: list to measure
2260  *
2261  *	Return the length of an &sk_buff queue.
2262  */
skb_queue_len(const struct sk_buff_head * list_)2263 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
2264 {
2265 	return list_->qlen;
2266 }
2267 
2268 /**
2269  *	skb_queue_len_lockless	- get queue length
2270  *	@list_: list to measure
2271  *
2272  *	Return the length of an &sk_buff queue.
2273  *	This variant can be used in lockless contexts.
2274  */
skb_queue_len_lockless(const struct sk_buff_head * list_)2275 static inline __u32 skb_queue_len_lockless(const struct sk_buff_head *list_)
2276 {
2277 	return READ_ONCE(list_->qlen);
2278 }
2279 
2280 /**
2281  *	__skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
2282  *	@list: queue to initialize
2283  *
2284  *	This initializes only the list and queue length aspects of
2285  *	an sk_buff_head object.  This allows to initialize the list
2286  *	aspects of an sk_buff_head without reinitializing things like
2287  *	the spinlock.  It can also be used for on-stack sk_buff_head
2288  *	objects where the spinlock is known to not be used.
2289  */
__skb_queue_head_init(struct sk_buff_head * list)2290 static inline void __skb_queue_head_init(struct sk_buff_head *list)
2291 {
2292 	list->prev = list->next = (struct sk_buff *)list;
2293 	list->qlen = 0;
2294 }
2295 
2296 /*
2297  * This function creates a split out lock class for each invocation;
2298  * this is needed for now since a whole lot of users of the skb-queue
2299  * infrastructure in drivers have different locking usage (in hardirq)
2300  * than the networking core (in softirq only). In the long run either the
2301  * network layer or drivers should need annotation to consolidate the
2302  * main types of usage into 3 classes.
2303  */
skb_queue_head_init(struct sk_buff_head * list)2304 static inline void skb_queue_head_init(struct sk_buff_head *list)
2305 {
2306 	spin_lock_init(&list->lock);
2307 	__skb_queue_head_init(list);
2308 }
2309 
skb_queue_head_init_class(struct sk_buff_head * list,struct lock_class_key * class)2310 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
2311 		struct lock_class_key *class)
2312 {
2313 	skb_queue_head_init(list);
2314 	lockdep_set_class(&list->lock, class);
2315 }
2316 
2317 /*
2318  *	Insert an sk_buff on a list.
2319  *
2320  *	The "__skb_xxxx()" functions are the non-atomic ones that
2321  *	can only be called with interrupts disabled.
2322  */
__skb_insert(struct sk_buff * newsk,struct sk_buff * prev,struct sk_buff * next,struct sk_buff_head * list)2323 static inline void __skb_insert(struct sk_buff *newsk,
2324 				struct sk_buff *prev, struct sk_buff *next,
2325 				struct sk_buff_head *list)
2326 {
2327 	/* See skb_queue_empty_lockless() and skb_peek_tail()
2328 	 * for the opposite READ_ONCE()
2329 	 */
2330 	WRITE_ONCE(newsk->next, next);
2331 	WRITE_ONCE(newsk->prev, prev);
2332 	WRITE_ONCE(((struct sk_buff_list *)next)->prev, newsk);
2333 	WRITE_ONCE(((struct sk_buff_list *)prev)->next, newsk);
2334 	WRITE_ONCE(list->qlen, list->qlen + 1);
2335 }
2336 
__skb_queue_splice(const struct sk_buff_head * list,struct sk_buff * prev,struct sk_buff * next)2337 static inline void __skb_queue_splice(const struct sk_buff_head *list,
2338 				      struct sk_buff *prev,
2339 				      struct sk_buff *next)
2340 {
2341 	struct sk_buff *first = list->next;
2342 	struct sk_buff *last = list->prev;
2343 
2344 	WRITE_ONCE(first->prev, prev);
2345 	WRITE_ONCE(prev->next, first);
2346 
2347 	WRITE_ONCE(last->next, next);
2348 	WRITE_ONCE(next->prev, last);
2349 }
2350 
2351 /**
2352  *	skb_queue_splice - join two skb lists, this is designed for stacks
2353  *	@list: the new list to add
2354  *	@head: the place to add it in the first list
2355  */
skb_queue_splice(const struct sk_buff_head * list,struct sk_buff_head * head)2356 static inline void skb_queue_splice(const struct sk_buff_head *list,
2357 				    struct sk_buff_head *head)
2358 {
2359 	if (!skb_queue_empty(list)) {
2360 		__skb_queue_splice(list, (struct sk_buff *) head, head->next);
2361 		head->qlen += list->qlen;
2362 	}
2363 }
2364 
2365 /**
2366  *	skb_queue_splice_init - join two skb lists and reinitialise the emptied list
2367  *	@list: the new list to add
2368  *	@head: the place to add it in the first list
2369  *
2370  *	The list at @list is reinitialised
2371  */
skb_queue_splice_init(struct sk_buff_head * list,struct sk_buff_head * head)2372 static inline void skb_queue_splice_init(struct sk_buff_head *list,
2373 					 struct sk_buff_head *head)
2374 {
2375 	if (!skb_queue_empty(list)) {
2376 		__skb_queue_splice(list, (struct sk_buff *) head, head->next);
2377 		head->qlen += list->qlen;
2378 		__skb_queue_head_init(list);
2379 	}
2380 }
2381 
2382 /**
2383  *	skb_queue_splice_tail - join two skb lists, each list being a queue
2384  *	@list: the new list to add
2385  *	@head: the place to add it in the first list
2386  */
skb_queue_splice_tail(const struct sk_buff_head * list,struct sk_buff_head * head)2387 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
2388 					 struct sk_buff_head *head)
2389 {
2390 	if (!skb_queue_empty(list)) {
2391 		__skb_queue_splice(list, head->prev, (struct sk_buff *) head);
2392 		head->qlen += list->qlen;
2393 	}
2394 }
2395 
2396 /**
2397  *	skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
2398  *	@list: the new list to add
2399  *	@head: the place to add it in the first list
2400  *
2401  *	Each of the lists is a queue.
2402  *	The list at @list is reinitialised
2403  */
skb_queue_splice_tail_init(struct sk_buff_head * list,struct sk_buff_head * head)2404 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
2405 					      struct sk_buff_head *head)
2406 {
2407 	if (!skb_queue_empty(list)) {
2408 		__skb_queue_splice(list, head->prev, (struct sk_buff *) head);
2409 		head->qlen += list->qlen;
2410 		__skb_queue_head_init(list);
2411 	}
2412 }
2413 
2414 /**
2415  *	__skb_queue_after - queue a buffer at the list head
2416  *	@list: list to use
2417  *	@prev: place after this buffer
2418  *	@newsk: buffer to queue
2419  *
2420  *	Queue a buffer int the middle of a list. This function takes no locks
2421  *	and you must therefore hold required locks before calling it.
2422  *
2423  *	A buffer cannot be placed on two lists at the same time.
2424  */
__skb_queue_after(struct sk_buff_head * list,struct sk_buff * prev,struct sk_buff * newsk)2425 static inline void __skb_queue_after(struct sk_buff_head *list,
2426 				     struct sk_buff *prev,
2427 				     struct sk_buff *newsk)
2428 {
2429 	__skb_insert(newsk, prev, ((struct sk_buff_list *)prev)->next, list);
2430 }
2431 
2432 void skb_append(struct sk_buff *old, struct sk_buff *newsk,
2433 		struct sk_buff_head *list);
2434 
__skb_queue_before(struct sk_buff_head * list,struct sk_buff * next,struct sk_buff * newsk)2435 static inline void __skb_queue_before(struct sk_buff_head *list,
2436 				      struct sk_buff *next,
2437 				      struct sk_buff *newsk)
2438 {
2439 	__skb_insert(newsk, ((struct sk_buff_list *)next)->prev, next, list);
2440 }
2441 
2442 /**
2443  *	__skb_queue_head - queue a buffer at the list head
2444  *	@list: list to use
2445  *	@newsk: buffer to queue
2446  *
2447  *	Queue a buffer at the start of a list. This function takes no locks
2448  *	and you must therefore hold required locks before calling it.
2449  *
2450  *	A buffer cannot be placed on two lists at the same time.
2451  */
__skb_queue_head(struct sk_buff_head * list,struct sk_buff * newsk)2452 static inline void __skb_queue_head(struct sk_buff_head *list,
2453 				    struct sk_buff *newsk)
2454 {
2455 	__skb_queue_after(list, (struct sk_buff *)list, newsk);
2456 }
2457 void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
2458 
2459 /**
2460  *	__skb_queue_tail - queue a buffer at the list tail
2461  *	@list: list to use
2462  *	@newsk: buffer to queue
2463  *
2464  *	Queue a buffer at the end of a list. This function takes no locks
2465  *	and you must therefore hold required locks before calling it.
2466  *
2467  *	A buffer cannot be placed on two lists at the same time.
2468  */
__skb_queue_tail(struct sk_buff_head * list,struct sk_buff * newsk)2469 static inline void __skb_queue_tail(struct sk_buff_head *list,
2470 				   struct sk_buff *newsk)
2471 {
2472 	__skb_queue_before(list, (struct sk_buff *)list, newsk);
2473 }
2474 void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
2475 
2476 /*
2477  * remove sk_buff from list. _Must_ be called atomically, and with
2478  * the list known..
2479  */
2480 void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
__skb_unlink(struct sk_buff * skb,struct sk_buff_head * list)2481 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
2482 {
2483 	struct sk_buff *next, *prev;
2484 
2485 	WRITE_ONCE(list->qlen, list->qlen - 1);
2486 	next	   = skb->next;
2487 	prev	   = skb->prev;
2488 	skb->next  = skb->prev = NULL;
2489 	WRITE_ONCE(next->prev, prev);
2490 	WRITE_ONCE(prev->next, next);
2491 }
2492 
2493 /**
2494  *	__skb_dequeue - remove from the head of the queue
2495  *	@list: list to dequeue from
2496  *
2497  *	Remove the head of the list. This function does not take any locks
2498  *	so must be used with appropriate locks held only. The head item is
2499  *	returned or %NULL if the list is empty.
2500  */
__skb_dequeue(struct sk_buff_head * list)2501 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
2502 {
2503 	struct sk_buff *skb = skb_peek(list);
2504 	if (skb)
2505 		__skb_unlink(skb, list);
2506 	return skb;
2507 }
2508 struct sk_buff *skb_dequeue(struct sk_buff_head *list);
2509 
2510 /**
2511  *	__skb_dequeue_tail - remove from the tail of the queue
2512  *	@list: list to dequeue from
2513  *
2514  *	Remove the tail of the list. This function does not take any locks
2515  *	so must be used with appropriate locks held only. The tail item is
2516  *	returned or %NULL if the list is empty.
2517  */
__skb_dequeue_tail(struct sk_buff_head * list)2518 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
2519 {
2520 	struct sk_buff *skb = skb_peek_tail(list);
2521 	if (skb)
2522 		__skb_unlink(skb, list);
2523 	return skb;
2524 }
2525 struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
2526 
2527 
skb_is_nonlinear(const struct sk_buff * skb)2528 static inline bool skb_is_nonlinear(const struct sk_buff *skb)
2529 {
2530 	return skb->data_len;
2531 }
2532 
skb_headlen(const struct sk_buff * skb)2533 static inline unsigned int skb_headlen(const struct sk_buff *skb)
2534 {
2535 	return skb->len - skb->data_len;
2536 }
2537 
__skb_pagelen(const struct sk_buff * skb)2538 static inline unsigned int __skb_pagelen(const struct sk_buff *skb)
2539 {
2540 	unsigned int i, len = 0;
2541 
2542 	for (i = skb_shinfo(skb)->nr_frags - 1; (int)i >= 0; i--)
2543 		len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
2544 	return len;
2545 }
2546 
skb_pagelen(const struct sk_buff * skb)2547 static inline unsigned int skb_pagelen(const struct sk_buff *skb)
2548 {
2549 	return skb_headlen(skb) + __skb_pagelen(skb);
2550 }
2551 
skb_frag_fill_netmem_desc(skb_frag_t * frag,netmem_ref netmem,int off,int size)2552 static inline void skb_frag_fill_netmem_desc(skb_frag_t *frag,
2553 					     netmem_ref netmem, int off,
2554 					     int size)
2555 {
2556 	frag->netmem = netmem;
2557 	frag->offset = off;
2558 	skb_frag_size_set(frag, size);
2559 }
2560 
skb_frag_fill_page_desc(skb_frag_t * frag,struct page * page,int off,int size)2561 static inline void skb_frag_fill_page_desc(skb_frag_t *frag,
2562 					   struct page *page,
2563 					   int off, int size)
2564 {
2565 	skb_frag_fill_netmem_desc(frag, page_to_netmem(page), off, size);
2566 }
2567 
__skb_fill_netmem_desc_noacc(struct skb_shared_info * shinfo,int i,netmem_ref netmem,int off,int size)2568 static inline void __skb_fill_netmem_desc_noacc(struct skb_shared_info *shinfo,
2569 						int i, netmem_ref netmem,
2570 						int off, int size)
2571 {
2572 	skb_frag_t *frag = &shinfo->frags[i];
2573 
2574 	skb_frag_fill_netmem_desc(frag, netmem, off, size);
2575 }
2576 
__skb_fill_page_desc_noacc(struct skb_shared_info * shinfo,int i,struct page * page,int off,int size)2577 static inline void __skb_fill_page_desc_noacc(struct skb_shared_info *shinfo,
2578 					      int i, struct page *page,
2579 					      int off, int size)
2580 {
2581 	__skb_fill_netmem_desc_noacc(shinfo, i, page_to_netmem(page), off,
2582 				     size);
2583 }
2584 
2585 /**
2586  * skb_len_add - adds a number to len fields of skb
2587  * @skb: buffer to add len to
2588  * @delta: number of bytes to add
2589  */
skb_len_add(struct sk_buff * skb,int delta)2590 static inline void skb_len_add(struct sk_buff *skb, int delta)
2591 {
2592 	skb->len += delta;
2593 	skb->data_len += delta;
2594 	skb->truesize += delta;
2595 }
2596 
2597 /**
2598  * __skb_fill_netmem_desc - initialise a fragment in an skb
2599  * @skb: buffer containing fragment to be initialised
2600  * @i: fragment index to initialise
2601  * @netmem: the netmem to use for this fragment
2602  * @off: the offset to the data with @page
2603  * @size: the length of the data
2604  *
2605  * Initialises the @i'th fragment of @skb to point to &size bytes at
2606  * offset @off within @page.
2607  *
2608  * Does not take any additional reference on the fragment.
2609  */
2610 static __always_inline void
__skb_fill_netmem_desc(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size)2611 __skb_fill_netmem_desc(struct sk_buff *skb, int i, netmem_ref netmem,
2612 		       int off, int size)
2613 {
2614 	struct page *page;
2615 
2616 	__skb_fill_netmem_desc_noacc(skb_shinfo(skb), i, netmem, off, size);
2617 
2618 	if (netmem_is_net_iov(netmem)) {
2619 		skb->unreadable = true;
2620 		return;
2621 	}
2622 
2623 	page = netmem_to_page(netmem);
2624 
2625 	/* Propagate page pfmemalloc to the skb if we can. The problem is
2626 	 * that not all callers have unique ownership of the page but rely
2627 	 * on page_is_pfmemalloc doing the right thing(tm).
2628 	 */
2629 	page = compound_head(page);
2630 	if (page_is_pfmemalloc(page))
2631 		skb->pfmemalloc = true;
2632 }
2633 
2634 static __always_inline void
__skb_fill_page_desc(struct sk_buff * skb,int i,struct page * page,int off,int size)2635 __skb_fill_page_desc(struct sk_buff *skb, int i, struct page *page,
2636 		     int off, int size)
2637 {
2638 	__skb_fill_netmem_desc(skb, i, page_to_netmem(page), off, size);
2639 }
2640 
2641 static __always_inline void
skb_fill_netmem_desc(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size)2642 skb_fill_netmem_desc(struct sk_buff *skb, int i, netmem_ref netmem,
2643 		     int off, int size)
2644 {
2645 	__skb_fill_netmem_desc(skb, i, netmem, off, size);
2646 	skb_shinfo(skb)->nr_frags = i + 1;
2647 }
2648 
2649 /**
2650  * skb_fill_page_desc - initialise a paged fragment in an skb
2651  * @skb: buffer containing fragment to be initialised
2652  * @i: paged fragment index to initialise
2653  * @page: the page to use for this fragment
2654  * @off: the offset to the data with @page
2655  * @size: the length of the data
2656  *
2657  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
2658  * @skb to point to @size bytes at offset @off within @page. In
2659  * addition updates @skb such that @i is the last fragment.
2660  *
2661  * Does not take any additional reference on the fragment.
2662  */
2663 static __always_inline void
skb_fill_page_desc(struct sk_buff * skb,int i,struct page * page,int off,int size)2664 skb_fill_page_desc(struct sk_buff *skb, int i, struct page *page,
2665 		   int off, int size)
2666 {
2667 	skb_fill_netmem_desc(skb, i, page_to_netmem(page), off, size);
2668 }
2669 
2670 /**
2671  * skb_fill_page_desc_noacc - initialise a paged fragment in an skb
2672  * @skb: buffer containing fragment to be initialised
2673  * @i: paged fragment index to initialise
2674  * @page: the page to use for this fragment
2675  * @off: the offset to the data with @page
2676  * @size: the length of the data
2677  *
2678  * Variant of skb_fill_page_desc() which does not deal with
2679  * pfmemalloc, if page is not owned by us.
2680  */
skb_fill_page_desc_noacc(struct sk_buff * skb,int i,struct page * page,int off,int size)2681 static inline void skb_fill_page_desc_noacc(struct sk_buff *skb, int i,
2682 					    struct page *page, int off,
2683 					    int size)
2684 {
2685 	struct skb_shared_info *shinfo = skb_shinfo(skb);
2686 
2687 	__skb_fill_page_desc_noacc(shinfo, i, page, off, size);
2688 	shinfo->nr_frags = i + 1;
2689 }
2690 
skb_add_rx_frag_netmem(struct sk_buff * skb,int i,netmem_ref netmem,int off,int size,unsigned int truesize)2691 static inline void skb_add_rx_frag_netmem(struct sk_buff *skb, int i,
2692 					  netmem_ref netmem, int off,
2693 					  int size, unsigned int truesize)
2694 {
2695 	DEBUG_NET_WARN_ON_ONCE(size > truesize);
2696 
2697 	skb_fill_netmem_desc(skb, i, netmem, off, size);
2698 	skb->len += size;
2699 	skb->data_len += size;
2700 	skb->truesize += truesize;
2701 }
2702 
skb_add_rx_frag(struct sk_buff * skb,int i,struct page * page,int off,int size,unsigned int truesize)2703 static inline void skb_add_rx_frag(struct sk_buff *skb, int i,
2704 				   struct page *page, int off, int size,
2705 				   unsigned int truesize)
2706 {
2707 	skb_add_rx_frag_netmem(skb, i, page_to_netmem(page), off, size,
2708 			       truesize);
2709 }
2710 
2711 void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
2712 			  unsigned int truesize);
2713 
2714 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
2715 
2716 #ifdef NET_SKBUFF_DATA_USES_OFFSET
skb_tail_pointer(const struct sk_buff * skb)2717 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2718 {
2719 	return skb->head + skb->tail;
2720 }
2721 
skb_reset_tail_pointer(struct sk_buff * skb)2722 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2723 {
2724 	skb->tail = skb->data - skb->head;
2725 }
2726 
skb_set_tail_pointer(struct sk_buff * skb,const int offset)2727 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2728 {
2729 	skb_reset_tail_pointer(skb);
2730 	skb->tail += offset;
2731 }
2732 
2733 #else /* NET_SKBUFF_DATA_USES_OFFSET */
skb_tail_pointer(const struct sk_buff * skb)2734 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2735 {
2736 	return skb->tail;
2737 }
2738 
skb_reset_tail_pointer(struct sk_buff * skb)2739 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2740 {
2741 	skb->tail = skb->data;
2742 }
2743 
skb_set_tail_pointer(struct sk_buff * skb,const int offset)2744 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2745 {
2746 	skb->tail = skb->data + offset;
2747 }
2748 
2749 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
2750 
skb_assert_len(struct sk_buff * skb)2751 static inline void skb_assert_len(struct sk_buff *skb)
2752 {
2753 #ifdef CONFIG_DEBUG_NET
2754 	if (WARN_ONCE(!skb->len, "%s\n", __func__))
2755 		DO_ONCE_LITE(skb_dump, KERN_ERR, skb, false);
2756 #endif /* CONFIG_DEBUG_NET */
2757 }
2758 
2759 #if defined(CONFIG_FAIL_SKB_REALLOC)
2760 void skb_might_realloc(struct sk_buff *skb);
2761 #else
skb_might_realloc(struct sk_buff * skb)2762 static inline void skb_might_realloc(struct sk_buff *skb) {}
2763 #endif
2764 
2765 /*
2766  *	Add data to an sk_buff
2767  */
2768 void *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
2769 void *skb_put(struct sk_buff *skb, unsigned int len);
__skb_put(struct sk_buff * skb,unsigned int len)2770 static inline void *__skb_put(struct sk_buff *skb, unsigned int len)
2771 {
2772 	void *tmp = skb_tail_pointer(skb);
2773 	SKB_LINEAR_ASSERT(skb);
2774 	skb->tail += len;
2775 	skb->len  += len;
2776 	return tmp;
2777 }
2778 
__skb_put_zero(struct sk_buff * skb,unsigned int len)2779 static inline void *__skb_put_zero(struct sk_buff *skb, unsigned int len)
2780 {
2781 	void *tmp = __skb_put(skb, len);
2782 
2783 	memset(tmp, 0, len);
2784 	return tmp;
2785 }
2786 
__skb_put_data(struct sk_buff * skb,const void * data,unsigned int len)2787 static inline void *__skb_put_data(struct sk_buff *skb, const void *data,
2788 				   unsigned int len)
2789 {
2790 	void *tmp = __skb_put(skb, len);
2791 
2792 	memcpy(tmp, data, len);
2793 	return tmp;
2794 }
2795 
__skb_put_u8(struct sk_buff * skb,u8 val)2796 static inline void __skb_put_u8(struct sk_buff *skb, u8 val)
2797 {
2798 	*(u8 *)__skb_put(skb, 1) = val;
2799 }
2800 
skb_put_zero(struct sk_buff * skb,unsigned int len)2801 static inline void *skb_put_zero(struct sk_buff *skb, unsigned int len)
2802 {
2803 	void *tmp = skb_put(skb, len);
2804 
2805 	memset(tmp, 0, len);
2806 
2807 	return tmp;
2808 }
2809 
skb_put_data(struct sk_buff * skb,const void * data,unsigned int len)2810 static inline void *skb_put_data(struct sk_buff *skb, const void *data,
2811 				 unsigned int len)
2812 {
2813 	void *tmp = skb_put(skb, len);
2814 
2815 	memcpy(tmp, data, len);
2816 
2817 	return tmp;
2818 }
2819 
skb_put_u8(struct sk_buff * skb,u8 val)2820 static inline void skb_put_u8(struct sk_buff *skb, u8 val)
2821 {
2822 	*(u8 *)skb_put(skb, 1) = val;
2823 }
2824 
2825 void *skb_push(struct sk_buff *skb, unsigned int len);
__skb_push(struct sk_buff * skb,unsigned int len)2826 static inline void *__skb_push(struct sk_buff *skb, unsigned int len)
2827 {
2828 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2829 
2830 	skb->data -= len;
2831 	DEBUG_NET_WARN_ON_ONCE(skb->data < skb->head);
2832 	skb->len  += len;
2833 	return skb->data;
2834 }
2835 
2836 void *skb_pull(struct sk_buff *skb, unsigned int len);
__skb_pull(struct sk_buff * skb,unsigned int len)2837 static __always_inline void *__skb_pull(struct sk_buff *skb, unsigned int len)
2838 {
2839 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2840 
2841 	skb->len -= len;
2842 	if (unlikely(skb->len < skb->data_len)) {
2843 #if defined(CONFIG_DEBUG_NET)
2844 		skb->len += len;
2845 		pr_err("__skb_pull(len=%u)\n", len);
2846 		skb_dump(KERN_ERR, skb, false);
2847 #endif
2848 		BUG();
2849 	}
2850 	return skb->data += len;
2851 }
2852 
skb_pull_inline(struct sk_buff * skb,unsigned int len)2853 static inline void *skb_pull_inline(struct sk_buff *skb, unsigned int len)
2854 {
2855 	return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
2856 }
2857 
2858 void *skb_pull_data(struct sk_buff *skb, size_t len);
2859 
2860 void *__pskb_pull_tail(struct sk_buff *skb, int delta);
2861 
2862 static __always_inline enum skb_drop_reason
pskb_may_pull_reason(struct sk_buff * skb,unsigned int len)2863 pskb_may_pull_reason(struct sk_buff *skb, unsigned int len)
2864 {
2865 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
2866 	skb_might_realloc(skb);
2867 
2868 	if (likely(len <= skb_headlen(skb)))
2869 		return SKB_NOT_DROPPED_YET;
2870 
2871 	if (unlikely(len > skb->len))
2872 		return SKB_DROP_REASON_PKT_TOO_SMALL;
2873 
2874 	if (unlikely(!__pskb_pull_tail(skb, len - skb_headlen(skb))))
2875 		return SKB_DROP_REASON_NOMEM;
2876 
2877 	return SKB_NOT_DROPPED_YET;
2878 }
2879 
2880 static __always_inline bool
pskb_may_pull(struct sk_buff * skb,unsigned int len)2881 pskb_may_pull(struct sk_buff *skb, unsigned int len)
2882 {
2883 	return pskb_may_pull_reason(skb, len) == SKB_NOT_DROPPED_YET;
2884 }
2885 
pskb_pull(struct sk_buff * skb,unsigned int len)2886 static __always_inline void *pskb_pull(struct sk_buff *skb, unsigned int len)
2887 {
2888 	if (!pskb_may_pull(skb, len))
2889 		return NULL;
2890 
2891 	skb->len -= len;
2892 	return skb->data += len;
2893 }
2894 
2895 void skb_condense(struct sk_buff *skb);
2896 
2897 /**
2898  *	skb_headroom - bytes at buffer head
2899  *	@skb: buffer to check
2900  *
2901  *	Return the number of bytes of free space at the head of an &sk_buff.
2902  */
skb_headroom(const struct sk_buff * skb)2903 static inline unsigned int skb_headroom(const struct sk_buff *skb)
2904 {
2905 	return skb->data - skb->head;
2906 }
2907 
2908 /**
2909  *	skb_tailroom - bytes at buffer end
2910  *	@skb: buffer to check
2911  *
2912  *	Return the number of bytes of free space at the tail of an sk_buff
2913  */
skb_tailroom(const struct sk_buff * skb)2914 static inline int skb_tailroom(const struct sk_buff *skb)
2915 {
2916 	return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
2917 }
2918 
2919 /**
2920  *	skb_availroom - bytes at buffer end
2921  *	@skb: buffer to check
2922  *
2923  *	Return the number of bytes of free space at the tail of an sk_buff
2924  *	allocated by sk_stream_alloc()
2925  */
skb_availroom(const struct sk_buff * skb)2926 static inline int skb_availroom(const struct sk_buff *skb)
2927 {
2928 	if (skb_is_nonlinear(skb))
2929 		return 0;
2930 
2931 	return skb->end - skb->tail - skb->reserved_tailroom;
2932 }
2933 
2934 /**
2935  *	skb_reserve - adjust headroom
2936  *	@skb: buffer to alter
2937  *	@len: bytes to move
2938  *
2939  *	Increase the headroom of an empty &sk_buff by reducing the tail
2940  *	room. This is only allowed for an empty buffer.
2941  */
skb_reserve(struct sk_buff * skb,int len)2942 static inline void skb_reserve(struct sk_buff *skb, int len)
2943 {
2944 	skb->data += len;
2945 	skb->tail += len;
2946 }
2947 
2948 /**
2949  *	skb_tailroom_reserve - adjust reserved_tailroom
2950  *	@skb: buffer to alter
2951  *	@mtu: maximum amount of headlen permitted
2952  *	@needed_tailroom: minimum amount of reserved_tailroom
2953  *
2954  *	Set reserved_tailroom so that headlen can be as large as possible but
2955  *	not larger than mtu and tailroom cannot be smaller than
2956  *	needed_tailroom.
2957  *	The required headroom should already have been reserved before using
2958  *	this function.
2959  */
skb_tailroom_reserve(struct sk_buff * skb,unsigned int mtu,unsigned int needed_tailroom)2960 static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
2961 					unsigned int needed_tailroom)
2962 {
2963 	SKB_LINEAR_ASSERT(skb);
2964 	if (mtu < skb_tailroom(skb) - needed_tailroom)
2965 		/* use at most mtu */
2966 		skb->reserved_tailroom = skb_tailroom(skb) - mtu;
2967 	else
2968 		/* use up to all available space */
2969 		skb->reserved_tailroom = needed_tailroom;
2970 }
2971 
2972 #define ENCAP_TYPE_ETHER	0
2973 #define ENCAP_TYPE_IPPROTO	1
2974 
skb_set_inner_protocol(struct sk_buff * skb,__be16 protocol)2975 static inline void skb_set_inner_protocol(struct sk_buff *skb,
2976 					  __be16 protocol)
2977 {
2978 	skb->inner_protocol = protocol;
2979 	skb->inner_protocol_type = ENCAP_TYPE_ETHER;
2980 }
2981 
skb_set_inner_ipproto(struct sk_buff * skb,__u8 ipproto)2982 static inline void skb_set_inner_ipproto(struct sk_buff *skb,
2983 					 __u8 ipproto)
2984 {
2985 	skb->inner_ipproto = ipproto;
2986 	skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
2987 }
2988 
skb_reset_inner_headers(struct sk_buff * skb)2989 static inline void skb_reset_inner_headers(struct sk_buff *skb)
2990 {
2991 	skb->inner_mac_header = skb->mac_header;
2992 	skb->inner_network_header = skb->network_header;
2993 	skb->inner_transport_header = skb->transport_header;
2994 }
2995 
skb_mac_header_was_set(const struct sk_buff * skb)2996 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2997 {
2998 	return skb->mac_header != (typeof(skb->mac_header))~0U;
2999 }
3000 
skb_reset_mac_len(struct sk_buff * skb)3001 static inline void skb_reset_mac_len(struct sk_buff *skb)
3002 {
3003 	if (!skb_mac_header_was_set(skb)) {
3004 		DEBUG_NET_WARN_ON_ONCE(1);
3005 		skb->mac_len = 0;
3006 	} else {
3007 		skb->mac_len = skb->network_header - skb->mac_header;
3008 	}
3009 }
3010 
skb_inner_transport_header(const struct sk_buff * skb)3011 static inline unsigned char *skb_inner_transport_header(const struct sk_buff
3012 							*skb)
3013 {
3014 	return skb->head + skb->inner_transport_header;
3015 }
3016 
skb_inner_transport_offset(const struct sk_buff * skb)3017 static inline int skb_inner_transport_offset(const struct sk_buff *skb)
3018 {
3019 	return skb_inner_transport_header(skb) - skb->data;
3020 }
3021 
skb_reset_inner_transport_header(struct sk_buff * skb)3022 static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
3023 {
3024 	long offset = skb->data - skb->head;
3025 
3026 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_transport_header))offset);
3027 	skb->inner_transport_header = offset;
3028 }
3029 
skb_set_inner_transport_header(struct sk_buff * skb,const int offset)3030 static inline void skb_set_inner_transport_header(struct sk_buff *skb,
3031 						   const int offset)
3032 {
3033 	skb_reset_inner_transport_header(skb);
3034 	skb->inner_transport_header += offset;
3035 }
3036 
skb_inner_network_header(const struct sk_buff * skb)3037 static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
3038 {
3039 	return skb->head + skb->inner_network_header;
3040 }
3041 
skb_reset_inner_network_header(struct sk_buff * skb)3042 static inline void skb_reset_inner_network_header(struct sk_buff *skb)
3043 {
3044 	long offset = skb->data - skb->head;
3045 
3046 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_network_header))offset);
3047 	skb->inner_network_header = offset;
3048 }
3049 
skb_set_inner_network_header(struct sk_buff * skb,const int offset)3050 static inline void skb_set_inner_network_header(struct sk_buff *skb,
3051 						const int offset)
3052 {
3053 	skb_reset_inner_network_header(skb);
3054 	skb->inner_network_header += offset;
3055 }
3056 
skb_inner_network_header_was_set(const struct sk_buff * skb)3057 static inline bool skb_inner_network_header_was_set(const struct sk_buff *skb)
3058 {
3059 	return skb->inner_network_header > 0;
3060 }
3061 
skb_inner_mac_header(const struct sk_buff * skb)3062 static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
3063 {
3064 	return skb->head + skb->inner_mac_header;
3065 }
3066 
skb_reset_inner_mac_header(struct sk_buff * skb)3067 static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
3068 {
3069 	long offset = skb->data - skb->head;
3070 
3071 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->inner_mac_header))offset);
3072 	skb->inner_mac_header = offset;
3073 }
3074 
skb_set_inner_mac_header(struct sk_buff * skb,const int offset)3075 static inline void skb_set_inner_mac_header(struct sk_buff *skb,
3076 					    const int offset)
3077 {
3078 	skb_reset_inner_mac_header(skb);
3079 	skb->inner_mac_header += offset;
3080 }
skb_transport_header_was_set(const struct sk_buff * skb)3081 static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
3082 {
3083 	return skb->transport_header != (typeof(skb->transport_header))~0U;
3084 }
3085 
skb_transport_header(const struct sk_buff * skb)3086 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
3087 {
3088 	DEBUG_NET_WARN_ON_ONCE(!skb_transport_header_was_set(skb));
3089 	return skb->head + skb->transport_header;
3090 }
3091 
skb_reset_transport_header(struct sk_buff * skb)3092 static inline void skb_reset_transport_header(struct sk_buff *skb)
3093 {
3094 	long offset = skb->data - skb->head;
3095 
3096 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->transport_header))offset);
3097 	skb->transport_header = offset;
3098 }
3099 
3100 /**
3101  * skb_reset_transport_header_careful - conditionally reset transport header
3102  * @skb: buffer to alter
3103  *
3104  * Hardened version of skb_reset_transport_header().
3105  *
3106  * Returns: true if the operation was a success.
3107  */
3108 static inline bool __must_check
skb_reset_transport_header_careful(struct sk_buff * skb)3109 skb_reset_transport_header_careful(struct sk_buff *skb)
3110 {
3111 	long offset = skb->data - skb->head;
3112 
3113 	if (unlikely(offset != (typeof(skb->transport_header))offset))
3114 		return false;
3115 
3116 	if (unlikely(offset == (typeof(skb->transport_header))~0U))
3117 		return false;
3118 
3119 	skb->transport_header = offset;
3120 	return true;
3121 }
3122 
skb_set_transport_header(struct sk_buff * skb,const int offset)3123 static inline void skb_set_transport_header(struct sk_buff *skb,
3124 					    const int offset)
3125 {
3126 	skb_reset_transport_header(skb);
3127 	skb->transport_header += offset;
3128 }
3129 
skb_network_header(const struct sk_buff * skb)3130 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
3131 {
3132 	return skb->head + skb->network_header;
3133 }
3134 
skb_reset_network_header(struct sk_buff * skb)3135 static inline void skb_reset_network_header(struct sk_buff *skb)
3136 {
3137 	long offset = skb->data - skb->head;
3138 
3139 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->network_header))offset);
3140 	skb->network_header = offset;
3141 }
3142 
skb_set_network_header(struct sk_buff * skb,const int offset)3143 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
3144 {
3145 	skb_reset_network_header(skb);
3146 	skb->network_header += offset;
3147 }
3148 
skb_mac_header(const struct sk_buff * skb)3149 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
3150 {
3151 	DEBUG_NET_WARN_ON_ONCE(!skb_mac_header_was_set(skb));
3152 	return skb->head + skb->mac_header;
3153 }
3154 
skb_mac_offset(const struct sk_buff * skb)3155 static inline int skb_mac_offset(const struct sk_buff *skb)
3156 {
3157 	return skb_mac_header(skb) - skb->data;
3158 }
3159 
skb_mac_header_len(const struct sk_buff * skb)3160 static inline u32 skb_mac_header_len(const struct sk_buff *skb)
3161 {
3162 	DEBUG_NET_WARN_ON_ONCE(!skb_mac_header_was_set(skb));
3163 	return skb->network_header - skb->mac_header;
3164 }
3165 
skb_unset_mac_header(struct sk_buff * skb)3166 static inline void skb_unset_mac_header(struct sk_buff *skb)
3167 {
3168 	skb->mac_header = (typeof(skb->mac_header))~0U;
3169 }
3170 
skb_reset_mac_header(struct sk_buff * skb)3171 static inline void skb_reset_mac_header(struct sk_buff *skb)
3172 {
3173 	long offset = skb->data - skb->head;
3174 
3175 	DEBUG_NET_WARN_ON_ONCE(offset != (typeof(skb->mac_header))offset);
3176 	skb->mac_header = offset;
3177 }
3178 
skb_set_mac_header(struct sk_buff * skb,const int offset)3179 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
3180 {
3181 	skb_reset_mac_header(skb);
3182 	skb->mac_header += offset;
3183 }
3184 
skb_pop_mac_header(struct sk_buff * skb)3185 static inline void skb_pop_mac_header(struct sk_buff *skb)
3186 {
3187 	skb->mac_header = skb->network_header;
3188 }
3189 
skb_probe_transport_header(struct sk_buff * skb)3190 static inline void skb_probe_transport_header(struct sk_buff *skb)
3191 {
3192 	struct flow_keys_basic keys;
3193 
3194 	if (skb_transport_header_was_set(skb))
3195 		return;
3196 
3197 	if (skb_flow_dissect_flow_keys_basic(NULL, skb, &keys,
3198 					     NULL, 0, 0, 0, 0))
3199 		skb_set_transport_header(skb, keys.control.thoff);
3200 }
3201 
skb_mac_header_rebuild(struct sk_buff * skb)3202 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
3203 {
3204 	if (skb_mac_header_was_set(skb)) {
3205 		const unsigned char *old_mac = skb_mac_header(skb);
3206 
3207 		skb_set_mac_header(skb, -skb->mac_len);
3208 		memmove(skb_mac_header(skb), old_mac, skb->mac_len);
3209 	}
3210 }
3211 
3212 /* Move the full mac header up to current network_header.
3213  * Leaves skb->data pointing at offset skb->mac_len into the mac_header.
3214  * Must be provided the complete mac header length.
3215  */
skb_mac_header_rebuild_full(struct sk_buff * skb,u32 full_mac_len)3216 static inline void skb_mac_header_rebuild_full(struct sk_buff *skb, u32 full_mac_len)
3217 {
3218 	if (skb_mac_header_was_set(skb)) {
3219 		const unsigned char *old_mac = skb_mac_header(skb);
3220 
3221 		skb_set_mac_header(skb, -full_mac_len);
3222 		memmove(skb_mac_header(skb), old_mac, full_mac_len);
3223 		__skb_push(skb, full_mac_len - skb->mac_len);
3224 	}
3225 }
3226 
skb_checksum_start_offset(const struct sk_buff * skb)3227 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
3228 {
3229 	return skb->csum_start - skb_headroom(skb);
3230 }
3231 
skb_checksum_start(const struct sk_buff * skb)3232 static inline unsigned char *skb_checksum_start(const struct sk_buff *skb)
3233 {
3234 	return skb->head + skb->csum_start;
3235 }
3236 
skb_transport_offset(const struct sk_buff * skb)3237 static inline int skb_transport_offset(const struct sk_buff *skb)
3238 {
3239 	return skb_transport_header(skb) - skb->data;
3240 }
3241 
skb_network_header_len(const struct sk_buff * skb)3242 static inline u32 skb_network_header_len(const struct sk_buff *skb)
3243 {
3244 	DEBUG_NET_WARN_ON_ONCE(!skb_transport_header_was_set(skb));
3245 	return skb->transport_header - skb->network_header;
3246 }
3247 
skb_inner_network_header_len(const struct sk_buff * skb)3248 static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
3249 {
3250 	return skb->inner_transport_header - skb->inner_network_header;
3251 }
3252 
skb_network_offset(const struct sk_buff * skb)3253 static inline int skb_network_offset(const struct sk_buff *skb)
3254 {
3255 	return skb_network_header(skb) - skb->data;
3256 }
3257 
skb_inner_network_offset(const struct sk_buff * skb)3258 static inline int skb_inner_network_offset(const struct sk_buff *skb)
3259 {
3260 	return skb_inner_network_header(skb) - skb->data;
3261 }
3262 
3263 static inline enum skb_drop_reason
pskb_network_may_pull_reason(struct sk_buff * skb,unsigned int len)3264 pskb_network_may_pull_reason(struct sk_buff *skb, unsigned int len)
3265 {
3266 	return pskb_may_pull_reason(skb, skb_network_offset(skb) + len);
3267 }
3268 
pskb_network_may_pull(struct sk_buff * skb,unsigned int len)3269 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
3270 {
3271 	return pskb_network_may_pull_reason(skb, len) == SKB_NOT_DROPPED_YET;
3272 }
3273 
3274 /*
3275  * CPUs often take a performance hit when accessing unaligned memory
3276  * locations. The actual performance hit varies, it can be small if the
3277  * hardware handles it or large if we have to take an exception and fix it
3278  * in software.
3279  *
3280  * Since an ethernet header is 14 bytes network drivers often end up with
3281  * the IP header at an unaligned offset. The IP header can be aligned by
3282  * shifting the start of the packet by 2 bytes. Drivers should do this
3283  * with:
3284  *
3285  * skb_reserve(skb, NET_IP_ALIGN);
3286  *
3287  * The downside to this alignment of the IP header is that the DMA is now
3288  * unaligned. On some architectures the cost of an unaligned DMA is high
3289  * and this cost outweighs the gains made by aligning the IP header.
3290  *
3291  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
3292  * to be overridden.
3293  */
3294 #ifndef NET_IP_ALIGN
3295 #define NET_IP_ALIGN	2
3296 #endif
3297 
3298 /*
3299  * The networking layer reserves some headroom in skb data (via
3300  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
3301  * the header has to grow. In the default case, if the header has to grow
3302  * 32 bytes or less we avoid the reallocation.
3303  *
3304  * Unfortunately this headroom changes the DMA alignment of the resulting
3305  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
3306  * on some architectures. An architecture can override this value,
3307  * perhaps setting it to a cacheline in size (since that will maintain
3308  * cacheline alignment of the DMA). It must be a power of 2.
3309  *
3310  * Various parts of the networking layer expect at least 32 bytes of
3311  * headroom, you should not reduce this.
3312  *
3313  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
3314  * to reduce average number of cache lines per packet.
3315  * get_rps_cpu() for example only access one 64 bytes aligned block :
3316  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
3317  */
3318 #ifndef NET_SKB_PAD
3319 #define NET_SKB_PAD	max(32, L1_CACHE_BYTES)
3320 #endif
3321 
3322 int ___pskb_trim(struct sk_buff *skb, unsigned int len);
3323 
__skb_set_length(struct sk_buff * skb,unsigned int len)3324 static inline void __skb_set_length(struct sk_buff *skb, unsigned int len)
3325 {
3326 	if (WARN_ON(skb_is_nonlinear(skb)))
3327 		return;
3328 	skb->len = len;
3329 	skb_set_tail_pointer(skb, len);
3330 }
3331 
__skb_trim(struct sk_buff * skb,unsigned int len)3332 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
3333 {
3334 	__skb_set_length(skb, len);
3335 }
3336 
3337 void skb_trim(struct sk_buff *skb, unsigned int len);
3338 
__pskb_trim(struct sk_buff * skb,unsigned int len)3339 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
3340 {
3341 	if (skb->data_len)
3342 		return ___pskb_trim(skb, len);
3343 	__skb_trim(skb, len);
3344 	return 0;
3345 }
3346 
pskb_trim(struct sk_buff * skb,unsigned int len)3347 static __always_inline int pskb_trim(struct sk_buff *skb, unsigned int len)
3348 {
3349 	skb_might_realloc(skb);
3350 	return (len < skb->len) ? __pskb_trim(skb, len) : 0;
3351 }
3352 
3353 /**
3354  *	pskb_trim_unique - remove end from a paged unique (not cloned) buffer
3355  *	@skb: buffer to alter
3356  *	@len: new length
3357  *
3358  *	This is identical to pskb_trim except that the caller knows that
3359  *	the skb is not cloned so we should never get an error due to out-
3360  *	of-memory.
3361  */
pskb_trim_unique(struct sk_buff * skb,unsigned int len)3362 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
3363 {
3364 	int err = pskb_trim(skb, len);
3365 	BUG_ON(err);
3366 }
3367 
__skb_grow(struct sk_buff * skb,unsigned int len)3368 static inline int __skb_grow(struct sk_buff *skb, unsigned int len)
3369 {
3370 	unsigned int diff = len - skb->len;
3371 
3372 	if (skb_tailroom(skb) < diff) {
3373 		int ret = pskb_expand_head(skb, 0, diff - skb_tailroom(skb),
3374 					   GFP_ATOMIC);
3375 		if (ret)
3376 			return ret;
3377 	}
3378 	__skb_set_length(skb, len);
3379 	return 0;
3380 }
3381 
3382 /**
3383  *	skb_orphan - orphan a buffer
3384  *	@skb: buffer to orphan
3385  *
3386  *	If a buffer currently has an owner then we call the owner's
3387  *	destructor function and make the @skb unowned. The buffer continues
3388  *	to exist but is no longer charged to its former owner.
3389  */
skb_orphan(struct sk_buff * skb)3390 static __always_inline void skb_orphan(struct sk_buff *skb)
3391 {
3392 	if (skb->destructor) {
3393 		skb->destructor(skb);
3394 		skb->destructor = NULL;
3395 		skb->sk		= NULL;
3396 	} else {
3397 		BUG_ON(skb->sk);
3398 	}
3399 }
3400 
3401 /**
3402  *	skb_orphan_frags - orphan the frags contained in a buffer
3403  *	@skb: buffer to orphan frags from
3404  *	@gfp_mask: allocation mask for replacement pages
3405  *
3406  *	For each frag in the SKB which needs a destructor (i.e. has an
3407  *	owner) create a copy of that frag and release the original
3408  *	page by calling the destructor.
3409  */
skb_orphan_frags(struct sk_buff * skb,gfp_t gfp_mask)3410 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
3411 {
3412 	if (likely(!skb_zcopy(skb)))
3413 		return 0;
3414 	if (skb_shinfo(skb)->flags & SKBFL_DONT_ORPHAN)
3415 		return 0;
3416 	return skb_copy_ubufs(skb, gfp_mask);
3417 }
3418 
3419 /* 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)3420 static inline int skb_orphan_frags_rx(struct sk_buff *skb, gfp_t gfp_mask)
3421 {
3422 	if (likely(!skb_zcopy(skb)))
3423 		return 0;
3424 	return skb_copy_ubufs(skb, gfp_mask);
3425 }
3426 
3427 /**
3428  *	__skb_queue_purge_reason - empty a list
3429  *	@list: list to empty
3430  *	@reason: drop reason
3431  *
3432  *	Delete all buffers on an &sk_buff list. Each buffer is removed from
3433  *	the list and one reference dropped. This function does not take the
3434  *	list lock and the caller must hold the relevant locks to use it.
3435  */
__skb_queue_purge_reason(struct sk_buff_head * list,enum skb_drop_reason reason)3436 static inline void __skb_queue_purge_reason(struct sk_buff_head *list,
3437 					    enum skb_drop_reason reason)
3438 {
3439 	struct sk_buff *skb;
3440 
3441 	while ((skb = __skb_dequeue(list)) != NULL)
3442 		kfree_skb_reason(skb, reason);
3443 }
3444 
__skb_queue_purge(struct sk_buff_head * list)3445 static inline void __skb_queue_purge(struct sk_buff_head *list)
3446 {
3447 	__skb_queue_purge_reason(list, SKB_DROP_REASON_QUEUE_PURGE);
3448 }
3449 
3450 void skb_queue_purge_reason(struct sk_buff_head *list,
3451 			    enum skb_drop_reason reason);
3452 
skb_queue_purge(struct sk_buff_head * list)3453 static inline void skb_queue_purge(struct sk_buff_head *list)
3454 {
3455 	skb_queue_purge_reason(list, SKB_DROP_REASON_QUEUE_PURGE);
3456 }
3457 
3458 unsigned int skb_rbtree_purge(struct rb_root *root);
3459 void skb_errqueue_purge(struct sk_buff_head *list);
3460 
3461 void *__netdev_alloc_frag_align(unsigned int fragsz, unsigned int align_mask);
3462 
3463 /**
3464  * netdev_alloc_frag - allocate a page fragment
3465  * @fragsz: fragment size
3466  *
3467  * Allocates a frag from a page for receive buffer.
3468  * Uses GFP_ATOMIC allocations.
3469  */
netdev_alloc_frag(unsigned int fragsz)3470 static inline void *netdev_alloc_frag(unsigned int fragsz)
3471 {
3472 	return __netdev_alloc_frag_align(fragsz, ~0u);
3473 }
3474 
netdev_alloc_frag_align(unsigned int fragsz,unsigned int align)3475 static inline void *netdev_alloc_frag_align(unsigned int fragsz,
3476 					    unsigned int align)
3477 {
3478 	WARN_ON_ONCE(!is_power_of_2(align));
3479 	return __netdev_alloc_frag_align(fragsz, -align);
3480 }
3481 
3482 struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
3483 				   gfp_t gfp_mask);
3484 
3485 /**
3486  *	netdev_alloc_skb - allocate an skbuff for rx on a specific device
3487  *	@dev: network device to receive on
3488  *	@length: length to allocate
3489  *
3490  *	Allocate a new &sk_buff and assign it a usage count of one. The
3491  *	buffer has unspecified headroom built in. Users should allocate
3492  *	the headroom they think they need without accounting for the
3493  *	built in space. The built in space is used for optimisations.
3494  *
3495  *	%NULL is returned if there is no free memory. Although this function
3496  *	allocates memory it can be called from an interrupt.
3497  */
netdev_alloc_skb(struct net_device * dev,unsigned int length)3498 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
3499 					       unsigned int length)
3500 {
3501 	return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
3502 }
3503 
3504 /* legacy helper around __netdev_alloc_skb() */
__dev_alloc_skb(unsigned int length,gfp_t gfp_mask)3505 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
3506 					      gfp_t gfp_mask)
3507 {
3508 	return __netdev_alloc_skb(NULL, length, gfp_mask);
3509 }
3510 
3511 /* legacy helper around netdev_alloc_skb() */
dev_alloc_skb(unsigned int length)3512 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
3513 {
3514 	return netdev_alloc_skb(NULL, length);
3515 }
3516 
3517 
__netdev_alloc_skb_ip_align(struct net_device * dev,unsigned int length,gfp_t gfp)3518 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
3519 		unsigned int length, gfp_t gfp)
3520 {
3521 	struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
3522 
3523 	if (NET_IP_ALIGN && skb)
3524 		skb_reserve(skb, NET_IP_ALIGN);
3525 	return skb;
3526 }
3527 
netdev_alloc_skb_ip_align(struct net_device * dev,unsigned int length)3528 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
3529 		unsigned int length)
3530 {
3531 	return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
3532 }
3533 
skb_free_frag(void * addr)3534 static inline void skb_free_frag(void *addr)
3535 {
3536 	page_frag_free(addr);
3537 }
3538 
3539 void *__napi_alloc_frag_align(unsigned int fragsz, unsigned int align_mask);
3540 
napi_alloc_frag(unsigned int fragsz)3541 static inline void *napi_alloc_frag(unsigned int fragsz)
3542 {
3543 	return __napi_alloc_frag_align(fragsz, ~0u);
3544 }
3545 
napi_alloc_frag_align(unsigned int fragsz,unsigned int align)3546 static inline void *napi_alloc_frag_align(unsigned int fragsz,
3547 					  unsigned int align)
3548 {
3549 	WARN_ON_ONCE(!is_power_of_2(align));
3550 	return __napi_alloc_frag_align(fragsz, -align);
3551 }
3552 
3553 struct sk_buff *napi_alloc_skb(struct napi_struct *napi, unsigned int length);
3554 void napi_consume_skb(struct sk_buff *skb, int budget);
3555 
3556 void napi_skb_free_stolen_head(struct sk_buff *skb);
3557 void __napi_kfree_skb(struct sk_buff *skb, enum skb_drop_reason reason);
3558 
3559 /**
3560  * __dev_alloc_pages - allocate page for network Rx
3561  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
3562  * @order: size of the allocation
3563  *
3564  * Allocate a new page.
3565  *
3566  * %NULL is returned if there is no free memory.
3567 */
__dev_alloc_pages_noprof(gfp_t gfp_mask,unsigned int order)3568 static inline struct page *__dev_alloc_pages_noprof(gfp_t gfp_mask,
3569 					     unsigned int order)
3570 {
3571 	/* This piece of code contains several assumptions.
3572 	 * 1.  This is for device Rx, therefore a cold page is preferred.
3573 	 * 2.  The expectation is the user wants a compound page.
3574 	 * 3.  If requesting a order 0 page it will not be compound
3575 	 *     due to the check to see if order has a value in prep_new_page
3576 	 * 4.  __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
3577 	 *     code in gfp_to_alloc_flags that should be enforcing this.
3578 	 */
3579 	gfp_mask |= __GFP_COMP | __GFP_MEMALLOC;
3580 
3581 	return alloc_pages_node_noprof(NUMA_NO_NODE, gfp_mask, order);
3582 }
3583 #define __dev_alloc_pages(...)	alloc_hooks(__dev_alloc_pages_noprof(__VA_ARGS__))
3584 
3585 /*
3586  * This specialized allocator has to be a macro for its allocations to be
3587  * accounted separately (to have a separate alloc_tag).
3588  */
3589 #define dev_alloc_pages(_order) __dev_alloc_pages(GFP_ATOMIC | __GFP_NOWARN, _order)
3590 
3591 /**
3592  * __dev_alloc_page - allocate a page for network Rx
3593  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
3594  *
3595  * Allocate a new page.
3596  *
3597  * %NULL is returned if there is no free memory.
3598  */
__dev_alloc_page_noprof(gfp_t gfp_mask)3599 static inline struct page *__dev_alloc_page_noprof(gfp_t gfp_mask)
3600 {
3601 	return __dev_alloc_pages_noprof(gfp_mask, 0);
3602 }
3603 #define __dev_alloc_page(...)	alloc_hooks(__dev_alloc_page_noprof(__VA_ARGS__))
3604 
3605 /*
3606  * This specialized allocator has to be a macro for its allocations to be
3607  * accounted separately (to have a separate alloc_tag).
3608  */
3609 #define dev_alloc_page()	dev_alloc_pages(0)
3610 
3611 /**
3612  * dev_page_is_reusable - check whether a page can be reused for network Rx
3613  * @page: the page to test
3614  *
3615  * A page shouldn't be considered for reusing/recycling if it was allocated
3616  * under memory pressure or at a distant memory node.
3617  *
3618  * Returns: false if this page should be returned to page allocator, true
3619  * otherwise.
3620  */
dev_page_is_reusable(const struct page * page)3621 static inline bool dev_page_is_reusable(const struct page *page)
3622 {
3623 	return likely(page_to_nid(page) == numa_mem_id() &&
3624 		      !page_is_pfmemalloc(page));
3625 }
3626 
3627 /**
3628  *	skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
3629  *	@page: The page that was allocated from skb_alloc_page
3630  *	@skb: The skb that may need pfmemalloc set
3631  */
skb_propagate_pfmemalloc(const struct page * page,struct sk_buff * skb)3632 static inline void skb_propagate_pfmemalloc(const struct page *page,
3633 					    struct sk_buff *skb)
3634 {
3635 	if (page_is_pfmemalloc(page))
3636 		skb->pfmemalloc = true;
3637 }
3638 
3639 /**
3640  * skb_frag_off() - Returns the offset of a skb fragment
3641  * @frag: the paged fragment
3642  */
skb_frag_off(const skb_frag_t * frag)3643 static inline unsigned int skb_frag_off(const skb_frag_t *frag)
3644 {
3645 	return frag->offset;
3646 }
3647 
3648 /**
3649  * skb_frag_off_add() - Increments the offset of a skb fragment by @delta
3650  * @frag: skb fragment
3651  * @delta: value to add
3652  */
skb_frag_off_add(skb_frag_t * frag,int delta)3653 static inline void skb_frag_off_add(skb_frag_t *frag, int delta)
3654 {
3655 	frag->offset += delta;
3656 }
3657 
3658 /**
3659  * skb_frag_off_set() - Sets the offset of a skb fragment
3660  * @frag: skb fragment
3661  * @offset: offset of fragment
3662  */
skb_frag_off_set(skb_frag_t * frag,unsigned int offset)3663 static inline void skb_frag_off_set(skb_frag_t *frag, unsigned int offset)
3664 {
3665 	frag->offset = offset;
3666 }
3667 
3668 /**
3669  * skb_frag_off_copy() - Sets the offset of a skb fragment from another fragment
3670  * @fragto: skb fragment where offset is set
3671  * @fragfrom: skb fragment offset is copied from
3672  */
skb_frag_off_copy(skb_frag_t * fragto,const skb_frag_t * fragfrom)3673 static inline void skb_frag_off_copy(skb_frag_t *fragto,
3674 				     const skb_frag_t *fragfrom)
3675 {
3676 	fragto->offset = fragfrom->offset;
3677 }
3678 
3679 /* Return: true if the skb_frag contains a net_iov. */
skb_frag_is_net_iov(const skb_frag_t * frag)3680 static inline bool skb_frag_is_net_iov(const skb_frag_t *frag)
3681 {
3682 	return netmem_is_net_iov(frag->netmem);
3683 }
3684 
3685 /**
3686  * skb_frag_net_iov - retrieve the net_iov referred to by fragment
3687  * @frag: the fragment
3688  *
3689  * Return: the &struct net_iov associated with @frag. Returns NULL if this
3690  * frag has no associated net_iov.
3691  */
skb_frag_net_iov(const skb_frag_t * frag)3692 static inline struct net_iov *skb_frag_net_iov(const skb_frag_t *frag)
3693 {
3694 	if (!skb_frag_is_net_iov(frag))
3695 		return NULL;
3696 
3697 	return netmem_to_net_iov(frag->netmem);
3698 }
3699 
3700 /**
3701  * skb_frag_page - retrieve the page referred to by a paged fragment
3702  * @frag: the paged fragment
3703  *
3704  * Return: the &struct page associated with @frag. Returns NULL if this frag
3705  * has no associated page.
3706  */
skb_frag_page(const skb_frag_t * frag)3707 static inline struct page *skb_frag_page(const skb_frag_t *frag)
3708 {
3709 	if (skb_frag_is_net_iov(frag))
3710 		return NULL;
3711 
3712 	return netmem_to_page(frag->netmem);
3713 }
3714 
3715 /**
3716  * skb_frag_netmem - retrieve the netmem referred to by a fragment
3717  * @frag: the fragment
3718  *
3719  * Return: the &netmem_ref associated with @frag.
3720  */
skb_frag_netmem(const skb_frag_t * frag)3721 static inline netmem_ref skb_frag_netmem(const skb_frag_t *frag)
3722 {
3723 	return frag->netmem;
3724 }
3725 
3726 int skb_pp_cow_data(struct page_pool *pool, struct sk_buff **pskb,
3727 		    unsigned int headroom);
3728 int skb_cow_data_for_xdp(struct page_pool *pool, struct sk_buff **pskb,
3729 			 const struct bpf_prog *prog);
3730 
3731 /**
3732  * skb_frag_address - gets the address of the data contained in a paged fragment
3733  * @frag: the paged fragment buffer
3734  *
3735  * Returns: the address of the data within @frag. The page must already
3736  * be mapped.
3737  */
skb_frag_address(const skb_frag_t * frag)3738 static inline void *skb_frag_address(const skb_frag_t *frag)
3739 {
3740 	if (!skb_frag_page(frag))
3741 		return NULL;
3742 
3743 	return page_address(skb_frag_page(frag)) + skb_frag_off(frag);
3744 }
3745 
3746 /**
3747  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
3748  * @frag: the paged fragment buffer
3749  *
3750  * Returns: the address of the data within @frag. Checks that the page
3751  * is mapped and returns %NULL otherwise.
3752  */
skb_frag_address_safe(const skb_frag_t * frag)3753 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
3754 {
3755 	struct page *page = skb_frag_page(frag);
3756 	void *ptr;
3757 
3758 	if (!page)
3759 		return NULL;
3760 
3761 	ptr = page_address(page);
3762 	if (unlikely(!ptr))
3763 		return NULL;
3764 
3765 	return ptr + skb_frag_off(frag);
3766 }
3767 
3768 /**
3769  * skb_frag_phys - gets the physical address of the data in a paged fragment
3770  * @frag: the paged fragment buffer
3771  *
3772  * Returns: the physical address of the data within @frag.
3773  */
skb_frag_phys(const skb_frag_t * frag)3774 static inline phys_addr_t skb_frag_phys(const skb_frag_t *frag)
3775 {
3776 	return page_to_phys(skb_frag_page(frag)) + skb_frag_off(frag);
3777 }
3778 
3779 /**
3780  * skb_frag_page_copy() - sets the page in a fragment from another fragment
3781  * @fragto: skb fragment where page is set
3782  * @fragfrom: skb fragment page is copied from
3783  */
skb_frag_page_copy(skb_frag_t * fragto,const skb_frag_t * fragfrom)3784 static inline void skb_frag_page_copy(skb_frag_t *fragto,
3785 				      const skb_frag_t *fragfrom)
3786 {
3787 	fragto->netmem = fragfrom->netmem;
3788 }
3789 
3790 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
3791 
3792 /**
3793  * __skb_frag_dma_map - maps a paged fragment via the DMA API
3794  * @dev: the device to map the fragment to
3795  * @frag: the paged fragment to map
3796  * @offset: the offset within the fragment (starting at the
3797  *          fragment's own offset)
3798  * @size: the number of bytes to map
3799  * @dir: the direction of the mapping (``PCI_DMA_*``)
3800  *
3801  * Maps the page associated with @frag to @device.
3802  */
__skb_frag_dma_map(struct device * dev,const skb_frag_t * frag,size_t offset,size_t size,enum dma_data_direction dir)3803 static inline dma_addr_t __skb_frag_dma_map(struct device *dev,
3804 					    const skb_frag_t *frag,
3805 					    size_t offset, size_t size,
3806 					    enum dma_data_direction dir)
3807 {
3808 	if (skb_frag_is_net_iov(frag)) {
3809 		return netmem_to_net_iov(frag->netmem)->desc.dma_addr +
3810 		       offset + frag->offset;
3811 	}
3812 	return dma_map_page(dev, skb_frag_page(frag),
3813 			    skb_frag_off(frag) + offset, size, dir);
3814 }
3815 
3816 #define skb_frag_dma_map(dev, frag, ...)				\
3817 	CONCATENATE(_skb_frag_dma_map,					\
3818 		    COUNT_ARGS(__VA_ARGS__))(dev, frag, ##__VA_ARGS__)
3819 
3820 #define __skb_frag_dma_map1(dev, frag, offset, uf, uo) ({		\
3821 	const skb_frag_t *uf = (frag);					\
3822 	size_t uo = (offset);						\
3823 									\
3824 	__skb_frag_dma_map(dev, uf, uo, skb_frag_size(uf) - uo,		\
3825 			   DMA_TO_DEVICE);				\
3826 })
3827 #define _skb_frag_dma_map1(dev, frag, offset)				\
3828 	__skb_frag_dma_map1(dev, frag, offset, __UNIQUE_ID(frag_),	\
3829 			    __UNIQUE_ID(offset_))
3830 #define _skb_frag_dma_map0(dev, frag)					\
3831 	_skb_frag_dma_map1(dev, frag, 0)
3832 #define _skb_frag_dma_map2(dev, frag, offset, size)			\
3833 	__skb_frag_dma_map(dev, frag, offset, size, DMA_TO_DEVICE)
3834 #define _skb_frag_dma_map3(dev, frag, offset, size, dir)		\
3835 	__skb_frag_dma_map(dev, frag, offset, size, dir)
3836 
pskb_copy(struct sk_buff * skb,gfp_t gfp_mask)3837 static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
3838 					gfp_t gfp_mask)
3839 {
3840 	return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
3841 }
3842 
3843 
pskb_copy_for_clone(struct sk_buff * skb,gfp_t gfp_mask)3844 static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
3845 						  gfp_t gfp_mask)
3846 {
3847 	return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
3848 }
3849 
3850 
3851 /**
3852  *	skb_clone_writable - is the header of a clone writable
3853  *	@skb: buffer to check
3854  *	@len: length up to which to write
3855  *
3856  *	Returns true if modifying the header part of the cloned buffer
3857  *	does not requires the data to be copied.
3858  */
skb_clone_writable(const struct sk_buff * skb,unsigned int len)3859 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
3860 {
3861 	return !skb_header_cloned(skb) &&
3862 	       skb_headroom(skb) + len <= skb->hdr_len;
3863 }
3864 
skb_try_make_writable(struct sk_buff * skb,unsigned int write_len)3865 static inline int skb_try_make_writable(struct sk_buff *skb,
3866 					unsigned int write_len)
3867 {
3868 	return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
3869 	       pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
3870 }
3871 
__skb_cow(struct sk_buff * skb,unsigned int headroom,int cloned)3872 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
3873 			    int cloned)
3874 {
3875 	int delta = 0;
3876 
3877 	if (headroom > skb_headroom(skb))
3878 		delta = headroom - skb_headroom(skb);
3879 
3880 	if (delta || cloned)
3881 		return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
3882 					GFP_ATOMIC);
3883 	return 0;
3884 }
3885 
3886 /**
3887  *	skb_cow - copy header of skb when it is required
3888  *	@skb: buffer to cow
3889  *	@headroom: needed headroom
3890  *
3891  *	If the skb passed lacks sufficient headroom or its data part
3892  *	is shared, data is reallocated. If reallocation fails, an error
3893  *	is returned and original skb is not changed.
3894  *
3895  *	The result is skb with writable area skb->head...skb->tail
3896  *	and at least @headroom of space at head.
3897  */
skb_cow(struct sk_buff * skb,unsigned int headroom)3898 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
3899 {
3900 	return __skb_cow(skb, headroom, skb_cloned(skb));
3901 }
3902 
3903 /**
3904  *	skb_cow_head - skb_cow but only making the head writable
3905  *	@skb: buffer to cow
3906  *	@headroom: needed headroom
3907  *
3908  *	This function is identical to skb_cow except that we replace the
3909  *	skb_cloned check by skb_header_cloned.  It should be used when
3910  *	you only need to push on some header and do not need to modify
3911  *	the data.
3912  */
skb_cow_head(struct sk_buff * skb,unsigned int headroom)3913 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
3914 {
3915 	return __skb_cow(skb, headroom, skb_header_cloned(skb));
3916 }
3917 
3918 /**
3919  *	skb_padto	- pad an skbuff up to a minimal size
3920  *	@skb: buffer to pad
3921  *	@len: minimal length
3922  *
3923  *	Pads up a buffer to ensure the trailing bytes exist and are
3924  *	blanked. If the buffer already contains sufficient data it
3925  *	is untouched. Otherwise it is extended. Returns zero on
3926  *	success. The skb is freed on error.
3927  */
skb_padto(struct sk_buff * skb,unsigned int len)3928 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
3929 {
3930 	unsigned int size = skb->len;
3931 	if (likely(size >= len))
3932 		return 0;
3933 	return skb_pad(skb, len - size);
3934 }
3935 
3936 /**
3937  *	__skb_put_padto - increase size and pad an skbuff up to a minimal size
3938  *	@skb: buffer to pad
3939  *	@len: minimal length
3940  *	@free_on_error: free buffer on error
3941  *
3942  *	Pads up a buffer to ensure the trailing bytes exist and are
3943  *	blanked. If the buffer already contains sufficient data it
3944  *	is untouched. Otherwise it is extended. Returns zero on
3945  *	success. The skb is freed on error if @free_on_error is true.
3946  */
__skb_put_padto(struct sk_buff * skb,unsigned int len,bool free_on_error)3947 static inline int __must_check __skb_put_padto(struct sk_buff *skb,
3948 					       unsigned int len,
3949 					       bool free_on_error)
3950 {
3951 	unsigned int size = skb->len;
3952 
3953 	if (unlikely(size < len)) {
3954 		len -= size;
3955 		if (__skb_pad(skb, len, free_on_error))
3956 			return -ENOMEM;
3957 		__skb_put(skb, len);
3958 	}
3959 	return 0;
3960 }
3961 
3962 /**
3963  *	skb_put_padto - increase size and pad an skbuff up to a minimal size
3964  *	@skb: buffer to pad
3965  *	@len: minimal length
3966  *
3967  *	Pads up a buffer to ensure the trailing bytes exist and are
3968  *	blanked. If the buffer already contains sufficient data it
3969  *	is untouched. Otherwise it is extended. Returns zero on
3970  *	success. The skb is freed on error.
3971  */
skb_put_padto(struct sk_buff * skb,unsigned int len)3972 static inline int __must_check skb_put_padto(struct sk_buff *skb, unsigned int len)
3973 {
3974 	return __skb_put_padto(skb, len, true);
3975 }
3976 
3977 bool csum_and_copy_from_iter_full(void *addr, size_t bytes, __wsum *csum, struct iov_iter *i)
3978 	__must_check;
3979 
skb_can_coalesce_netmem(struct sk_buff * skb,int i,netmem_ref netmem,int off)3980 static inline bool skb_can_coalesce_netmem(struct sk_buff *skb, int i,
3981 					   netmem_ref netmem, int off)
3982 {
3983 	if (skb_zcopy(skb))
3984 		return false;
3985 	if (i) {
3986 		const skb_frag_t *frag = &skb_shinfo(skb)->frags[i - 1];
3987 
3988 		return netmem == skb_frag_netmem(frag) &&
3989 		       off == skb_frag_off(frag) + skb_frag_size(frag);
3990 	}
3991 	return false;
3992 }
3993 
skb_can_coalesce(struct sk_buff * skb,int i,const struct page * page,int off)3994 static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
3995 				    const struct page *page, int off)
3996 {
3997 	return skb_can_coalesce_netmem(skb, i, page_to_netmem(page), off);
3998 }
3999 
__skb_linearize(struct sk_buff * skb)4000 static inline int __skb_linearize(struct sk_buff *skb)
4001 {
4002 	return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
4003 }
4004 
4005 /**
4006  *	skb_linearize - convert paged skb to linear one
4007  *	@skb: buffer to linarize
4008  *
4009  *	If there is no free memory -ENOMEM is returned, otherwise zero
4010  *	is returned and the old skb data released.
4011  */
skb_linearize(struct sk_buff * skb)4012 static inline int skb_linearize(struct sk_buff *skb)
4013 {
4014 	return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
4015 }
4016 
4017 /**
4018  * skb_has_shared_frag - can any frag be overwritten
4019  * @skb: buffer to test
4020  *
4021  * Return: true if the skb has at least one frag that might be modified
4022  * by an external entity (as in vmsplice()/sendfile())
4023  */
skb_has_shared_frag(const struct sk_buff * skb)4024 static inline bool skb_has_shared_frag(const struct sk_buff *skb)
4025 {
4026 	return skb_is_nonlinear(skb) &&
4027 	       skb_shinfo(skb)->flags & SKBFL_SHARED_FRAG;
4028 }
4029 
4030 /**
4031  *	skb_linearize_cow - make sure skb is linear and writable
4032  *	@skb: buffer to process
4033  *
4034  *	If there is no free memory -ENOMEM is returned, otherwise zero
4035  *	is returned and the old skb data released.
4036  */
skb_linearize_cow(struct sk_buff * skb)4037 static inline int skb_linearize_cow(struct sk_buff *skb)
4038 {
4039 	return skb_is_nonlinear(skb) || skb_cloned(skb) ?
4040 	       __skb_linearize(skb) : 0;
4041 }
4042 
4043 static __always_inline void
__skb_postpull_rcsum(struct sk_buff * skb,const void * start,unsigned int len,unsigned int off)4044 __skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
4045 		     unsigned int off)
4046 {
4047 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4048 		skb->csum = csum_block_sub(skb->csum,
4049 					   csum_partial(start, len, 0), off);
4050 	else if (skb->ip_summed == CHECKSUM_PARTIAL &&
4051 		 skb_checksum_start_offset(skb) < 0)
4052 		skb->ip_summed = CHECKSUM_NONE;
4053 }
4054 
4055 /**
4056  *	skb_postpull_rcsum - update checksum for received skb after pull
4057  *	@skb: buffer to update
4058  *	@start: start of data before pull
4059  *	@len: length of data pulled
4060  *
4061  *	After doing a pull on a received packet, you need to call this to
4062  *	update the CHECKSUM_COMPLETE checksum, or set ip_summed to
4063  *	CHECKSUM_NONE so that it can be recomputed from scratch.
4064  */
4065 static __always_inline void
skb_postpull_rcsum(struct sk_buff * skb,const void * start,unsigned int len)4066 skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len)
4067 {
4068 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4069 		skb->csum = wsum_negate(csum_partial(start, len,
4070 						     wsum_negate(skb->csum)));
4071 	else if (skb->ip_summed == CHECKSUM_PARTIAL &&
4072 		 skb_checksum_start_offset(skb) < 0)
4073 		skb->ip_summed = CHECKSUM_NONE;
4074 }
4075 
4076 static __always_inline void
__skb_postpush_rcsum(struct sk_buff * skb,const void * start,unsigned int len,unsigned int off)4077 __skb_postpush_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
4078 		     unsigned int off)
4079 {
4080 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4081 		skb->csum = csum_block_add(skb->csum,
4082 					   csum_partial(start, len, 0), off);
4083 }
4084 
4085 /**
4086  *	skb_postpush_rcsum - update checksum for received skb after push
4087  *	@skb: buffer to update
4088  *	@start: start of data after push
4089  *	@len: length of data pushed
4090  *
4091  *	After doing a push on a received packet, you need to call this to
4092  *	update the CHECKSUM_COMPLETE checksum.
4093  */
skb_postpush_rcsum(struct sk_buff * skb,const void * start,unsigned int len)4094 static inline void skb_postpush_rcsum(struct sk_buff *skb,
4095 				      const void *start, unsigned int len)
4096 {
4097 	__skb_postpush_rcsum(skb, start, len, 0);
4098 }
4099 
4100 void *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
4101 
4102 /**
4103  *	skb_push_rcsum - push skb and update receive checksum
4104  *	@skb: buffer to update
4105  *	@len: length of data pulled
4106  *
4107  *	This function performs an skb_push on the packet and updates
4108  *	the CHECKSUM_COMPLETE checksum.  It should be used on
4109  *	receive path processing instead of skb_push unless you know
4110  *	that the checksum difference is zero (e.g., a valid IP header)
4111  *	or you are setting ip_summed to CHECKSUM_NONE.
4112  */
skb_push_rcsum(struct sk_buff * skb,unsigned int len)4113 static inline void *skb_push_rcsum(struct sk_buff *skb, unsigned int len)
4114 {
4115 	skb_push(skb, len);
4116 	skb_postpush_rcsum(skb, skb->data, len);
4117 	return skb->data;
4118 }
4119 
4120 int pskb_trim_rcsum_slow(struct sk_buff *skb, unsigned int len);
4121 /**
4122  *	pskb_trim_rcsum - trim received skb and update checksum
4123  *	@skb: buffer to trim
4124  *	@len: new length
4125  *
4126  *	This is exactly the same as pskb_trim except that it ensures the
4127  *	checksum of received packets are still valid after the operation.
4128  *	It can change skb pointers.
4129  */
4130 
pskb_trim_rcsum(struct sk_buff * skb,unsigned int len)4131 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
4132 {
4133 	skb_might_realloc(skb);
4134 	if (likely(len >= skb->len))
4135 		return 0;
4136 	return pskb_trim_rcsum_slow(skb, len);
4137 }
4138 
__skb_trim_rcsum(struct sk_buff * skb,unsigned int len)4139 static inline int __skb_trim_rcsum(struct sk_buff *skb, unsigned int len)
4140 {
4141 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4142 		skb->ip_summed = CHECKSUM_NONE;
4143 	__skb_trim(skb, len);
4144 	return 0;
4145 }
4146 
__skb_grow_rcsum(struct sk_buff * skb,unsigned int len)4147 static inline int __skb_grow_rcsum(struct sk_buff *skb, unsigned int len)
4148 {
4149 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4150 		skb->ip_summed = CHECKSUM_NONE;
4151 	return __skb_grow(skb, len);
4152 }
4153 
4154 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
4155 #define skb_rb_first(root) rb_to_skb(rb_first(root))
4156 #define skb_rb_last(root)  rb_to_skb(rb_last(root))
4157 #define skb_rb_next(skb)   rb_to_skb(rb_next(&(skb)->rbnode))
4158 #define skb_rb_prev(skb)   rb_to_skb(rb_prev(&(skb)->rbnode))
4159 
4160 #define skb_queue_walk(queue, skb) \
4161 		for (skb = (queue)->next;					\
4162 		     skb != (struct sk_buff *)(queue);				\
4163 		     skb = skb->next)
4164 
4165 #define skb_queue_walk_safe(queue, skb, tmp)					\
4166 		for (skb = (queue)->next, tmp = skb->next;			\
4167 		     skb != (struct sk_buff *)(queue);				\
4168 		     skb = tmp, tmp = skb->next)
4169 
4170 #define skb_queue_walk_from(queue, skb)						\
4171 		for (; skb != (struct sk_buff *)(queue);			\
4172 		     skb = skb->next)
4173 
4174 #define skb_rbtree_walk(skb, root)						\
4175 		for (skb = skb_rb_first(root); skb != NULL;			\
4176 		     skb = skb_rb_next(skb))
4177 
4178 #define skb_rbtree_walk_from(skb)						\
4179 		for (; skb != NULL;						\
4180 		     skb = skb_rb_next(skb))
4181 
4182 #define skb_rbtree_walk_from_safe(skb, tmp)					\
4183 		for (; tmp = skb ? skb_rb_next(skb) : NULL, (skb != NULL);	\
4184 		     skb = tmp)
4185 
4186 #define skb_queue_walk_from_safe(queue, skb, tmp)				\
4187 		for (tmp = skb->next;						\
4188 		     skb != (struct sk_buff *)(queue);				\
4189 		     skb = tmp, tmp = skb->next)
4190 
4191 #define skb_queue_reverse_walk(queue, skb) \
4192 		for (skb = (queue)->prev;					\
4193 		     skb != (struct sk_buff *)(queue);				\
4194 		     skb = skb->prev)
4195 
4196 #define skb_queue_reverse_walk_safe(queue, skb, tmp)				\
4197 		for (skb = (queue)->prev, tmp = skb->prev;			\
4198 		     skb != (struct sk_buff *)(queue);				\
4199 		     skb = tmp, tmp = skb->prev)
4200 
4201 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)			\
4202 		for (tmp = skb->prev;						\
4203 		     skb != (struct sk_buff *)(queue);				\
4204 		     skb = tmp, tmp = skb->prev)
4205 
skb_has_frag_list(const struct sk_buff * skb)4206 static inline bool skb_has_frag_list(const struct sk_buff *skb)
4207 {
4208 	return skb_shinfo(skb)->frag_list != NULL;
4209 }
4210 
skb_frag_list_init(struct sk_buff * skb)4211 static inline void skb_frag_list_init(struct sk_buff *skb)
4212 {
4213 	skb_shinfo(skb)->frag_list = NULL;
4214 }
4215 
4216 #define skb_walk_frags(skb, iter)	\
4217 	for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
4218 
4219 
4220 int __skb_wait_for_more_packets(struct sock *sk, struct sk_buff_head *queue,
4221 				int *err, long *timeo_p,
4222 				const struct sk_buff *skb);
4223 struct sk_buff *__skb_try_recv_from_queue(struct sk_buff_head *queue,
4224 					  unsigned int flags,
4225 					  int *off, int *err,
4226 					  struct sk_buff **last);
4227 struct sk_buff *__skb_try_recv_datagram(struct sock *sk,
4228 					struct sk_buff_head *queue,
4229 					unsigned int flags, int *off, int *err,
4230 					struct sk_buff **last);
4231 struct sk_buff *__skb_recv_datagram(struct sock *sk,
4232 				    struct sk_buff_head *sk_queue,
4233 				    unsigned int flags, int *off, int *err);
4234 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned int flags, int *err);
4235 __poll_t datagram_poll_queue(struct file *file, struct socket *sock,
4236 			     struct poll_table_struct *wait,
4237 			     struct sk_buff_head *rcv_queue);
4238 __poll_t datagram_poll(struct file *file, struct socket *sock,
4239 			   struct poll_table_struct *wait);
4240 int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
4241 			   struct iov_iter *to, int size);
skb_copy_datagram_msg(const struct sk_buff * from,int offset,struct msghdr * msg,int size)4242 static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
4243 					struct msghdr *msg, int size)
4244 {
4245 	return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
4246 }
4247 int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
4248 				   struct msghdr *msg);
4249 int skb_copy_and_crc32c_datagram_iter(const struct sk_buff *skb, int offset,
4250 				      struct iov_iter *to, int len, u32 *crcp);
4251 int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
4252 				 struct iov_iter *from, int len);
4253 int skb_copy_datagram_from_iter_full(struct sk_buff *skb, int offset,
4254 				     struct iov_iter *from, int len);
4255 int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
4256 void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
4257 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
4258 int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
4259 int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
4260 __wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
4261 			      int len);
4262 int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
4263 		    struct pipe_inode_info *pipe, unsigned int len,
4264 		    unsigned int flags);
4265 int skb_send_sock_locked(struct sock *sk, struct sk_buff *skb, int offset,
4266 			 int len);
4267 int skb_send_sock_locked_with_flags(struct sock *sk, struct sk_buff *skb,
4268 				    int offset, int len, int flags);
4269 int skb_send_sock(struct sock *sk, struct sk_buff *skb, int offset, int len);
4270 void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
4271 unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
4272 int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
4273 		 int len, int hlen);
4274 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
4275 int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
4276 void skb_scrub_packet(struct sk_buff *skb, bool xnet);
4277 struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
4278 struct sk_buff *skb_segment_list(struct sk_buff *skb, netdev_features_t features,
4279 				 unsigned int offset);
4280 struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
4281 int skb_ensure_writable(struct sk_buff *skb, unsigned int write_len);
4282 int skb_ensure_writable_head_tail(struct sk_buff *skb, struct net_device *dev);
4283 int __skb_vlan_pop(struct sk_buff *skb, u16 *vlan_tci);
4284 int skb_vlan_pop(struct sk_buff *skb);
4285 int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
4286 int skb_eth_pop(struct sk_buff *skb);
4287 int skb_eth_push(struct sk_buff *skb, const unsigned char *dst,
4288 		 const unsigned char *src);
4289 int skb_mpls_push(struct sk_buff *skb, __be32 mpls_lse, __be16 mpls_proto,
4290 		  int mac_len, bool ethernet);
4291 int skb_mpls_pop(struct sk_buff *skb, __be16 next_proto, int mac_len,
4292 		 bool ethernet);
4293 int skb_mpls_update_lse(struct sk_buff *skb, __be32 mpls_lse);
4294 int skb_mpls_dec_ttl(struct sk_buff *skb);
4295 struct sk_buff *pskb_extract(struct sk_buff *skb, int off, int to_copy,
4296 			     gfp_t gfp);
4297 
memcpy_from_msg(void * data,struct msghdr * msg,int len)4298 static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
4299 {
4300 	return copy_from_iter_full(data, len, &msg->msg_iter) ? 0 : -EFAULT;
4301 }
4302 
memcpy_to_msg(struct msghdr * msg,void * data,int len)4303 static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
4304 {
4305 	return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
4306 }
4307 
4308 __wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
4309 		    __wsum csum);
4310 u32 skb_crc32c(const struct sk_buff *skb, int offset, int len, u32 crc);
4311 
4312 static inline void * __must_check
__skb_header_pointer(const struct sk_buff * skb,int offset,int len,const void * data,int hlen,void * buffer)4313 __skb_header_pointer(const struct sk_buff *skb, int offset, int len,
4314 		     const void *data, int hlen, void *buffer)
4315 {
4316 	if (likely(hlen - offset >= len))
4317 		return (void *)data + offset;
4318 
4319 	if (!skb || unlikely(skb_copy_bits(skb, offset, buffer, len) < 0))
4320 		return NULL;
4321 
4322 	return buffer;
4323 }
4324 
4325 static __always_inline void * __must_check
skb_header_pointer(const struct sk_buff * skb,int offset,int len,void * buffer)4326 skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
4327 {
4328 	return __skb_header_pointer(skb, offset, len, skb->data,
4329 				    skb_headlen(skb), buffer);
4330 }
4331 
4332 /* Variant of skb_header_pointer() where @offset is user-controlled
4333  * and potentially negative.
4334  */
4335 static inline void * __must_check
skb_header_pointer_careful(const struct sk_buff * skb,int offset,int len,void * buffer)4336 skb_header_pointer_careful(const struct sk_buff *skb, int offset,
4337 			   int len, void *buffer)
4338 {
4339 	if (unlikely(offset < 0 && -offset > skb_headroom(skb)))
4340 		return NULL;
4341 	return skb_header_pointer(skb, offset, len, buffer);
4342 }
4343 
4344 static inline void * __must_check
skb_pointer_if_linear(const struct sk_buff * skb,int offset,int len)4345 skb_pointer_if_linear(const struct sk_buff *skb, int offset, int len)
4346 {
4347 	if (likely(skb_headlen(skb) - offset >= len))
4348 		return skb->data + offset;
4349 	return NULL;
4350 }
4351 
4352 /**
4353  *	skb_needs_linearize - check if we need to linearize a given skb
4354  *			      depending on the given device features.
4355  *	@skb: socket buffer to check
4356  *	@features: net device features
4357  *
4358  *	Returns true if either:
4359  *	1. skb has frag_list and the device doesn't support FRAGLIST, or
4360  *	2. skb is fragmented and the device does not support SG.
4361  */
skb_needs_linearize(struct sk_buff * skb,netdev_features_t features)4362 static inline bool skb_needs_linearize(struct sk_buff *skb,
4363 				       netdev_features_t features)
4364 {
4365 	return skb_is_nonlinear(skb) &&
4366 	       ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
4367 		(skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
4368 }
4369 
skb_copy_from_linear_data(const struct sk_buff * skb,void * to,const unsigned int len)4370 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
4371 					     void *to,
4372 					     const unsigned int len)
4373 {
4374 	memcpy(to, skb->data, len);
4375 }
4376 
skb_copy_from_linear_data_offset(const struct sk_buff * skb,const int offset,void * to,const unsigned int len)4377 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
4378 						    const int offset, void *to,
4379 						    const unsigned int len)
4380 {
4381 	memcpy(to, skb->data + offset, len);
4382 }
4383 
skb_copy_to_linear_data(struct sk_buff * skb,const void * from,const unsigned int len)4384 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
4385 					   const void *from,
4386 					   const unsigned int len)
4387 {
4388 	memcpy(skb->data, from, len);
4389 }
4390 
skb_copy_to_linear_data_offset(struct sk_buff * skb,const int offset,const void * from,const unsigned int len)4391 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
4392 						  const int offset,
4393 						  const void *from,
4394 						  const unsigned int len)
4395 {
4396 	memcpy(skb->data + offset, from, len);
4397 }
4398 
4399 void skb_init(void);
4400 
skb_get_ktime(const struct sk_buff * skb)4401 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
4402 {
4403 	return skb->tstamp;
4404 }
4405 
4406 /**
4407  *	skb_get_timestamp - get timestamp from a skb
4408  *	@skb: skb to get stamp from
4409  *	@stamp: pointer to struct __kernel_old_timeval to store stamp in
4410  *
4411  *	Timestamps are stored in the skb as offsets to a base timestamp.
4412  *	This function converts the offset back to a struct timeval and stores
4413  *	it in stamp.
4414  */
skb_get_timestamp(const struct sk_buff * skb,struct __kernel_old_timeval * stamp)4415 static inline void skb_get_timestamp(const struct sk_buff *skb,
4416 				     struct __kernel_old_timeval *stamp)
4417 {
4418 	*stamp = ns_to_kernel_old_timeval(skb->tstamp);
4419 }
4420 
skb_get_new_timestamp(const struct sk_buff * skb,struct __kernel_sock_timeval * stamp)4421 static inline void skb_get_new_timestamp(const struct sk_buff *skb,
4422 					 struct __kernel_sock_timeval *stamp)
4423 {
4424 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4425 
4426 	stamp->tv_sec = ts.tv_sec;
4427 	stamp->tv_usec = ts.tv_nsec / 1000;
4428 }
4429 
skb_get_timestampns(const struct sk_buff * skb,struct __kernel_old_timespec * stamp)4430 static inline void skb_get_timestampns(const struct sk_buff *skb,
4431 				       struct __kernel_old_timespec *stamp)
4432 {
4433 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4434 
4435 	stamp->tv_sec = ts.tv_sec;
4436 	stamp->tv_nsec = ts.tv_nsec;
4437 }
4438 
skb_get_new_timestampns(const struct sk_buff * skb,struct __kernel_timespec * stamp)4439 static inline void skb_get_new_timestampns(const struct sk_buff *skb,
4440 					   struct __kernel_timespec *stamp)
4441 {
4442 	struct timespec64 ts = ktime_to_timespec64(skb->tstamp);
4443 
4444 	stamp->tv_sec = ts.tv_sec;
4445 	stamp->tv_nsec = ts.tv_nsec;
4446 }
4447 
__net_timestamp(struct sk_buff * skb)4448 static inline void __net_timestamp(struct sk_buff *skb)
4449 {
4450 	skb->tstamp = ktime_get_real();
4451 	skb->tstamp_type = SKB_CLOCK_REALTIME;
4452 }
4453 
net_timedelta(ktime_t t)4454 static inline ktime_t net_timedelta(ktime_t t)
4455 {
4456 	return ktime_sub(ktime_get_real(), t);
4457 }
4458 
skb_set_delivery_time(struct sk_buff * skb,ktime_t kt,u8 tstamp_type)4459 static inline void skb_set_delivery_time(struct sk_buff *skb, ktime_t kt,
4460 					 u8 tstamp_type)
4461 {
4462 	skb->tstamp = kt;
4463 
4464 	if (kt)
4465 		skb->tstamp_type = tstamp_type;
4466 	else
4467 		skb->tstamp_type = SKB_CLOCK_REALTIME;
4468 }
4469 
skb_set_delivery_type_by_clockid(struct sk_buff * skb,ktime_t kt,clockid_t clockid)4470 static inline void skb_set_delivery_type_by_clockid(struct sk_buff *skb,
4471 						    ktime_t kt, clockid_t clockid)
4472 {
4473 	u8 tstamp_type = SKB_CLOCK_REALTIME;
4474 
4475 	switch (clockid) {
4476 	case CLOCK_REALTIME:
4477 		break;
4478 	case CLOCK_MONOTONIC:
4479 		tstamp_type = SKB_CLOCK_MONOTONIC;
4480 		break;
4481 	case CLOCK_TAI:
4482 		tstamp_type = SKB_CLOCK_TAI;
4483 		break;
4484 	default:
4485 		WARN_ON_ONCE(1);
4486 		kt = 0;
4487 	}
4488 
4489 	skb_set_delivery_time(skb, kt, tstamp_type);
4490 }
4491 
4492 DECLARE_STATIC_KEY_FALSE(netstamp_needed_key);
4493 
4494 /* It is used in the ingress path to clear the delivery_time.
4495  * If needed, set the skb->tstamp to the (rcv) timestamp.
4496  */
skb_clear_delivery_time(struct sk_buff * skb)4497 static __always_inline void skb_clear_delivery_time(struct sk_buff *skb)
4498 {
4499 	if (skb->tstamp_type) {
4500 		skb->tstamp_type = SKB_CLOCK_REALTIME;
4501 		if (static_branch_unlikely(&netstamp_needed_key))
4502 			skb->tstamp = ktime_get_real();
4503 		else
4504 			skb->tstamp = 0;
4505 	}
4506 }
4507 
skb_clear_tstamp(struct sk_buff * skb)4508 static inline void skb_clear_tstamp(struct sk_buff *skb)
4509 {
4510 	if (skb->tstamp_type)
4511 		return;
4512 
4513 	skb->tstamp = 0;
4514 }
4515 
skb_tstamp(const struct sk_buff * skb)4516 static inline ktime_t skb_tstamp(const struct sk_buff *skb)
4517 {
4518 	if (skb->tstamp_type)
4519 		return 0;
4520 
4521 	return skb->tstamp;
4522 }
4523 
4524 static __always_inline ktime_t
skb_tstamp_cond(const struct sk_buff * skb,bool cond)4525 skb_tstamp_cond(const struct sk_buff *skb, bool cond)
4526 {
4527 	if (skb->tstamp_type != SKB_CLOCK_MONOTONIC && skb->tstamp)
4528 		return skb->tstamp;
4529 
4530 	if (static_branch_unlikely(&netstamp_needed_key) || cond)
4531 		return ktime_get_real();
4532 
4533 	return 0;
4534 }
4535 
skb_metadata_len(const struct sk_buff * skb)4536 static inline u8 skb_metadata_len(const struct sk_buff *skb)
4537 {
4538 	return skb_shinfo(skb)->meta_len;
4539 }
4540 
skb_metadata_end(const struct sk_buff * skb)4541 static inline void *skb_metadata_end(const struct sk_buff *skb)
4542 {
4543 	return skb_mac_header(skb);
4544 }
4545 
__skb_metadata_differs(const struct sk_buff * skb_a,const struct sk_buff * skb_b,u8 meta_len)4546 static inline bool __skb_metadata_differs(const struct sk_buff *skb_a,
4547 					  const struct sk_buff *skb_b,
4548 					  u8 meta_len)
4549 {
4550 	const void *a = skb_metadata_end(skb_a);
4551 	const void *b = skb_metadata_end(skb_b);
4552 	u64 diffs = 0;
4553 
4554 	if (!IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) ||
4555 	    BITS_PER_LONG != 64)
4556 		goto slow;
4557 
4558 	/* Using more efficient variant than plain call to memcmp(). */
4559 	switch (meta_len) {
4560 #define __it(x, op) (x -= sizeof(u##op))
4561 #define __it_diff(a, b, op) (*(u##op *)__it(a, op)) ^ (*(u##op *)__it(b, op))
4562 	case 32: diffs |= __it_diff(a, b, 64);
4563 		fallthrough;
4564 	case 24: diffs |= __it_diff(a, b, 64);
4565 		fallthrough;
4566 	case 16: diffs |= __it_diff(a, b, 64);
4567 		fallthrough;
4568 	case  8: diffs |= __it_diff(a, b, 64);
4569 		break;
4570 	case 28: diffs |= __it_diff(a, b, 64);
4571 		fallthrough;
4572 	case 20: diffs |= __it_diff(a, b, 64);
4573 		fallthrough;
4574 	case 12: diffs |= __it_diff(a, b, 64);
4575 		fallthrough;
4576 	case  4: diffs |= __it_diff(a, b, 32);
4577 		break;
4578 	default:
4579 slow:
4580 		return memcmp(a - meta_len, b - meta_len, meta_len);
4581 	}
4582 	return diffs;
4583 }
4584 
skb_metadata_differs(const struct sk_buff * skb_a,const struct sk_buff * skb_b)4585 static inline bool skb_metadata_differs(const struct sk_buff *skb_a,
4586 					const struct sk_buff *skb_b)
4587 {
4588 	u8 len_a = skb_metadata_len(skb_a);
4589 	u8 len_b = skb_metadata_len(skb_b);
4590 
4591 	if (!(len_a | len_b))
4592 		return false;
4593 
4594 	return len_a != len_b ?
4595 	       true : __skb_metadata_differs(skb_a, skb_b, len_a);
4596 }
4597 
skb_metadata_set(struct sk_buff * skb,u8 meta_len)4598 static inline void skb_metadata_set(struct sk_buff *skb, u8 meta_len)
4599 {
4600 	skb_shinfo(skb)->meta_len = meta_len;
4601 }
4602 
skb_metadata_clear(struct sk_buff * skb)4603 static inline void skb_metadata_clear(struct sk_buff *skb)
4604 {
4605 	skb_metadata_set(skb, 0);
4606 }
4607 
4608 /**
4609  * skb_data_move - Move packet data and metadata after skb_push() or skb_pull().
4610  * @skb: packet to operate on
4611  * @len: number of bytes pushed or pulled from &sk_buff->data
4612  * @n: number of bytes to memmove() from pre-push/pull &sk_buff->data
4613  *
4614  * Moves @n bytes of packet data, can be zero, and all bytes of skb metadata.
4615  *
4616  * Assumes metadata is located immediately before &sk_buff->data prior to the
4617  * push/pull, and that sufficient headroom exists to hold it after an
4618  * skb_push(). Otherwise, metadata is cleared and a one-time warning is issued.
4619  *
4620  * Prefer skb_postpull_data_move() or skb_postpush_data_move() to calling this
4621  * helper directly.
4622  */
skb_data_move(struct sk_buff * skb,const int len,const unsigned int n)4623 static inline void skb_data_move(struct sk_buff *skb, const int len,
4624 				 const unsigned int n)
4625 {
4626 	const u8 meta_len = skb_metadata_len(skb);
4627 	u8 *meta, *meta_end;
4628 
4629 	if (!len || (!n && !meta_len))
4630 		return;
4631 
4632 	if (!meta_len)
4633 		goto no_metadata;
4634 
4635 	meta_end = skb_metadata_end(skb);
4636 	meta = meta_end - meta_len;
4637 
4638 	if (WARN_ON_ONCE(meta_end + len != skb->data ||
4639 			 meta_len > skb_headroom(skb))) {
4640 		skb_metadata_clear(skb);
4641 		goto no_metadata;
4642 	}
4643 
4644 	memmove(meta + len, meta, meta_len + n);
4645 	return;
4646 
4647 no_metadata:
4648 	memmove(skb->data, skb->data - len, n);
4649 }
4650 
4651 /**
4652  * skb_postpull_data_move - Move packet data and metadata after skb_pull().
4653  * @skb: packet to operate on
4654  * @len: number of bytes pulled from &sk_buff->data
4655  * @n: number of bytes to memmove() from pre-pull &sk_buff->data
4656  *
4657  * See skb_data_move() for details.
4658  */
skb_postpull_data_move(struct sk_buff * skb,const unsigned int len,const unsigned int n)4659 static inline void skb_postpull_data_move(struct sk_buff *skb,
4660 					  const unsigned int len,
4661 					  const unsigned int n)
4662 {
4663 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
4664 	skb_data_move(skb, len, n);
4665 }
4666 
4667 /**
4668  * skb_postpush_data_move - Move packet data and metadata after skb_push().
4669  * @skb: packet to operate on
4670  * @len: number of bytes pushed onto &sk_buff->data
4671  * @n: number of bytes to memmove() from pre-push &sk_buff->data
4672  *
4673  * See skb_data_move() for details.
4674  */
skb_postpush_data_move(struct sk_buff * skb,const unsigned int len,const unsigned int n)4675 static inline void skb_postpush_data_move(struct sk_buff *skb,
4676 					  const unsigned int len,
4677 					  const unsigned int n)
4678 {
4679 	DEBUG_NET_WARN_ON_ONCE(len > INT_MAX);
4680 	skb_data_move(skb, -len, n);
4681 }
4682 
4683 struct sk_buff *skb_clone_sk(struct sk_buff *skb);
4684 
4685 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
4686 
4687 void skb_clone_tx_timestamp(struct sk_buff *skb);
4688 bool skb_defer_rx_timestamp(struct sk_buff *skb);
4689 
4690 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
4691 
skb_clone_tx_timestamp(struct sk_buff * skb)4692 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
4693 {
4694 }
4695 
skb_defer_rx_timestamp(struct sk_buff * skb)4696 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
4697 {
4698 	return false;
4699 }
4700 
4701 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
4702 
4703 /**
4704  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
4705  *
4706  * PHY drivers may accept clones of transmitted packets for
4707  * timestamping via their phy_driver.txtstamp method. These drivers
4708  * must call this function to return the skb back to the stack with a
4709  * timestamp.
4710  *
4711  * @skb: clone of the original outgoing packet
4712  * @hwtstamps: hardware time stamps
4713  *
4714  */
4715 void skb_complete_tx_timestamp(struct sk_buff *skb,
4716 			       struct skb_shared_hwtstamps *hwtstamps);
4717 
4718 void __skb_tstamp_tx(struct sk_buff *orig_skb, const struct sk_buff *ack_skb,
4719 		     struct skb_shared_hwtstamps *hwtstamps,
4720 		     struct sock *sk, int tstype);
4721 
4722 /**
4723  * skb_tstamp_tx - queue clone of skb with send time stamps
4724  * @orig_skb:	the original outgoing packet
4725  * @hwtstamps:	hardware time stamps, may be NULL if not available
4726  *
4727  * If the skb has a socket associated, then this function clones the
4728  * skb (thus sharing the actual data and optional structures), stores
4729  * the optional hardware time stamping information (if non NULL) or
4730  * generates a software time stamp (otherwise), then queues the clone
4731  * to the error queue of the socket.  Errors are silently ignored.
4732  */
4733 void skb_tstamp_tx(struct sk_buff *orig_skb,
4734 		   struct skb_shared_hwtstamps *hwtstamps);
4735 
4736 /**
4737  * skb_tx_timestamp() - Driver hook for transmit timestamping
4738  *
4739  * Ethernet MAC Drivers should call this function in their hard_xmit()
4740  * function immediately before giving the sk_buff to the MAC hardware.
4741  *
4742  * Specifically, one should make absolutely sure that this function is
4743  * called before TX completion of this packet can trigger.  Otherwise
4744  * the packet could potentially already be freed.
4745  *
4746  * @skb: A socket buffer.
4747  */
skb_tx_timestamp(struct sk_buff * skb)4748 static inline void skb_tx_timestamp(struct sk_buff *skb)
4749 {
4750 	skb_clone_tx_timestamp(skb);
4751 	if (skb_shinfo(skb)->tx_flags & (SKBTX_SW_TSTAMP | SKBTX_BPF))
4752 		skb_tstamp_tx(skb, NULL);
4753 }
4754 
4755 /**
4756  * skb_complete_wifi_ack - deliver skb with wifi status
4757  *
4758  * @skb: the original outgoing packet
4759  * @acked: ack status
4760  *
4761  */
4762 void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
4763 
4764 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
4765 __sum16 __skb_checksum_complete(struct sk_buff *skb);
4766 
skb_csum_unnecessary(const struct sk_buff * skb)4767 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
4768 {
4769 	return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
4770 		skb->csum_valid ||
4771 		(skb->ip_summed == CHECKSUM_PARTIAL &&
4772 		 skb_checksum_start_offset(skb) >= 0));
4773 }
4774 
4775 /**
4776  *	skb_checksum_complete - Calculate checksum of an entire packet
4777  *	@skb: packet to process
4778  *
4779  *	This function calculates the checksum over the entire packet plus
4780  *	the value of skb->csum.  The latter can be used to supply the
4781  *	checksum of a pseudo header as used by TCP/UDP.  It returns the
4782  *	checksum.
4783  *
4784  *	For protocols that contain complete checksums such as ICMP/TCP/UDP,
4785  *	this function can be used to verify that checksum on received
4786  *	packets.  In that case the function should return zero if the
4787  *	checksum is correct.  In particular, this function will return zero
4788  *	if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
4789  *	hardware has already verified the correctness of the checksum.
4790  */
skb_checksum_complete(struct sk_buff * skb)4791 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
4792 {
4793 	return skb_csum_unnecessary(skb) ?
4794 	       0 : __skb_checksum_complete(skb);
4795 }
4796 
__skb_decr_checksum_unnecessary(struct sk_buff * skb)4797 static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
4798 {
4799 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4800 		if (skb->csum_level == 0)
4801 			skb->ip_summed = CHECKSUM_NONE;
4802 		else
4803 			skb->csum_level--;
4804 	}
4805 }
4806 
__skb_incr_checksum_unnecessary(struct sk_buff * skb)4807 static __always_inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
4808 {
4809 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4810 		if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
4811 			skb->csum_level++;
4812 	} else if (skb->ip_summed == CHECKSUM_NONE) {
4813 		skb->ip_summed = CHECKSUM_UNNECESSARY;
4814 		skb->csum_level = 0;
4815 	}
4816 }
4817 
__skb_reset_checksum_unnecessary(struct sk_buff * skb)4818 static inline void __skb_reset_checksum_unnecessary(struct sk_buff *skb)
4819 {
4820 	if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
4821 		skb->ip_summed = CHECKSUM_NONE;
4822 		skb->csum_level = 0;
4823 	}
4824 }
4825 
4826 /* Check if we need to perform checksum complete validation.
4827  *
4828  * Returns: true if checksum complete is needed, false otherwise
4829  * (either checksum is unnecessary or zero checksum is allowed).
4830  */
__skb_checksum_validate_needed(struct sk_buff * skb,bool zero_okay,__sum16 check)4831 static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
4832 						  bool zero_okay,
4833 						  __sum16 check)
4834 {
4835 	if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
4836 		skb->csum_valid = 1;
4837 		__skb_decr_checksum_unnecessary(skb);
4838 		return false;
4839 	}
4840 
4841 	return true;
4842 }
4843 
4844 /* For small packets <= CHECKSUM_BREAK perform checksum complete directly
4845  * in checksum_init.
4846  */
4847 #define CHECKSUM_BREAK 76
4848 
4849 /* Unset checksum-complete
4850  *
4851  * Unset checksum complete can be done when packet is being modified
4852  * (uncompressed for instance) and checksum-complete value is
4853  * invalidated.
4854  */
skb_checksum_complete_unset(struct sk_buff * skb)4855 static inline void skb_checksum_complete_unset(struct sk_buff *skb)
4856 {
4857 	if (skb->ip_summed == CHECKSUM_COMPLETE)
4858 		skb->ip_summed = CHECKSUM_NONE;
4859 }
4860 
4861 /* Validate (init) checksum based on checksum complete.
4862  *
4863  * Return values:
4864  *   0: checksum is validated or try to in skb_checksum_complete. In the latter
4865  *	case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
4866  *	checksum is stored in skb->csum for use in __skb_checksum_complete
4867  *   non-zero: value of invalid checksum
4868  *
4869  */
__skb_checksum_validate_complete(struct sk_buff * skb,bool complete,__wsum psum)4870 static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
4871 						       bool complete,
4872 						       __wsum psum)
4873 {
4874 	if (skb->ip_summed == CHECKSUM_COMPLETE) {
4875 		if (!csum_fold(csum_add(psum, skb->csum))) {
4876 			skb->csum_valid = 1;
4877 			return 0;
4878 		}
4879 	}
4880 
4881 	skb->csum = psum;
4882 
4883 	if (complete || skb->len <= CHECKSUM_BREAK) {
4884 		__sum16 csum;
4885 
4886 		csum = __skb_checksum_complete(skb);
4887 		skb->csum_valid = !csum;
4888 		return csum;
4889 	}
4890 
4891 	return 0;
4892 }
4893 
null_compute_pseudo(struct sk_buff * skb,int proto)4894 static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
4895 {
4896 	return 0;
4897 }
4898 
4899 /* Perform checksum validate (init). Note that this is a macro since we only
4900  * want to calculate the pseudo header which is an input function if necessary.
4901  * First we try to validate without any computation (checksum unnecessary) and
4902  * then calculate based on checksum complete calling the function to compute
4903  * pseudo header.
4904  *
4905  * Return values:
4906  *   0: checksum is validated or try to in skb_checksum_complete
4907  *   non-zero: value of invalid checksum
4908  */
4909 #define __skb_checksum_validate(skb, proto, complete,			\
4910 				zero_okay, check, compute_pseudo)	\
4911 ({									\
4912 	__sum16 __ret = 0;						\
4913 	skb->csum_valid = 0;						\
4914 	if (__skb_checksum_validate_needed(skb, zero_okay, check))	\
4915 		__ret = __skb_checksum_validate_complete(skb,		\
4916 				complete, compute_pseudo(skb, proto));	\
4917 	__ret;								\
4918 })
4919 
4920 #define skb_checksum_init(skb, proto, compute_pseudo)			\
4921 	__skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
4922 
4923 #define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo)	\
4924 	__skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
4925 
4926 #define skb_checksum_validate(skb, proto, compute_pseudo)		\
4927 	__skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
4928 
4929 #define skb_checksum_validate_zero_check(skb, proto, check,		\
4930 					 compute_pseudo)		\
4931 	__skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
4932 
4933 #define skb_checksum_simple_validate(skb)				\
4934 	__skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
4935 
__skb_checksum_convert_check(struct sk_buff * skb)4936 static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
4937 {
4938 	return (skb->ip_summed == CHECKSUM_NONE && skb->csum_valid);
4939 }
4940 
__skb_checksum_convert(struct sk_buff * skb,__wsum pseudo)4941 static inline void __skb_checksum_convert(struct sk_buff *skb, __wsum pseudo)
4942 {
4943 	skb->csum = ~pseudo;
4944 	skb->ip_summed = CHECKSUM_COMPLETE;
4945 }
4946 
4947 #define skb_checksum_try_convert(skb, proto, compute_pseudo)	\
4948 do {									\
4949 	if (__skb_checksum_convert_check(skb))				\
4950 		__skb_checksum_convert(skb, compute_pseudo(skb, proto)); \
4951 } while (0)
4952 
skb_remcsum_adjust_partial(struct sk_buff * skb,void * ptr,u16 start,u16 offset)4953 static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
4954 					      u16 start, u16 offset)
4955 {
4956 	skb->ip_summed = CHECKSUM_PARTIAL;
4957 	skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
4958 	skb->csum_offset = offset - start;
4959 }
4960 
4961 /* Update skbuf and packet to reflect the remote checksum offload operation.
4962  * When called, ptr indicates the starting point for skb->csum when
4963  * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
4964  * here, skb_postpull_rcsum is done so skb->csum start is ptr.
4965  */
skb_remcsum_process(struct sk_buff * skb,void * ptr,int start,int offset,bool nopartial)4966 static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
4967 				       int start, int offset, bool nopartial)
4968 {
4969 	__wsum delta;
4970 
4971 	if (!nopartial) {
4972 		skb_remcsum_adjust_partial(skb, ptr, start, offset);
4973 		return;
4974 	}
4975 
4976 	if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
4977 		__skb_checksum_complete(skb);
4978 		skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
4979 	}
4980 
4981 	delta = remcsum_adjust(ptr, skb->csum, start, offset);
4982 
4983 	/* Adjust skb->csum since we changed the packet */
4984 	skb->csum = csum_add(skb->csum, delta);
4985 }
4986 
skb_nfct(const struct sk_buff * skb)4987 static inline struct nf_conntrack *skb_nfct(const struct sk_buff *skb)
4988 {
4989 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
4990 	return (void *)(skb->_nfct & NFCT_PTRMASK);
4991 #else
4992 	return NULL;
4993 #endif
4994 }
4995 
skb_get_nfct(const struct sk_buff * skb)4996 static inline unsigned long skb_get_nfct(const struct sk_buff *skb)
4997 {
4998 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
4999 	return skb->_nfct;
5000 #else
5001 	return 0UL;
5002 #endif
5003 }
5004 
skb_set_nfct(struct sk_buff * skb,unsigned long nfct)5005 static inline void skb_set_nfct(struct sk_buff *skb, unsigned long nfct)
5006 {
5007 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
5008 	skb->slow_gro |= !!nfct;
5009 	skb->_nfct = nfct;
5010 #endif
5011 }
5012 
5013 #ifdef CONFIG_SKB_EXTENSIONS
5014 enum skb_ext_id {
5015 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
5016 	SKB_EXT_BRIDGE_NF,
5017 #endif
5018 #ifdef CONFIG_XFRM
5019 	SKB_EXT_SEC_PATH,
5020 #endif
5021 #if IS_ENABLED(CONFIG_NET_TC_SKB_EXT)
5022 	TC_SKB_EXT,
5023 #endif
5024 #if IS_ENABLED(CONFIG_MPTCP)
5025 	SKB_EXT_MPTCP,
5026 #endif
5027 #if IS_ENABLED(CONFIG_MCTP_FLOWS)
5028 	SKB_EXT_MCTP,
5029 #endif
5030 #if IS_ENABLED(CONFIG_INET_PSP)
5031 	SKB_EXT_PSP,
5032 #endif
5033 #if IS_ENABLED(CONFIG_CAN)
5034 	SKB_EXT_CAN,
5035 #endif
5036 	SKB_EXT_NUM, /* must be last */
5037 };
5038 
5039 /**
5040  *	struct skb_ext - sk_buff extensions
5041  *	@refcnt: 1 on allocation, deallocated on 0
5042  *	@offset: offset to add to @data to obtain extension address
5043  *	@chunks: size currently allocated, stored in SKB_EXT_ALIGN_SHIFT units
5044  *	@data: start of extension data, variable sized
5045  *
5046  *	Note: offsets/lengths are stored in chunks of 8 bytes, this allows
5047  *	to use 'u8' types while allowing up to 2kb worth of extension data.
5048  */
5049 struct skb_ext {
5050 	refcount_t refcnt;
5051 	u8 offset[SKB_EXT_NUM]; /* in chunks of 8 bytes */
5052 	u8 chunks;		/* same */
5053 	char data[] __aligned(8);
5054 };
5055 
5056 struct skb_ext *__skb_ext_alloc(gfp_t flags);
5057 void *__skb_ext_set(struct sk_buff *skb, enum skb_ext_id id,
5058 		    struct skb_ext *ext);
5059 void *skb_ext_add(struct sk_buff *skb, enum skb_ext_id id);
5060 void __skb_ext_del(struct sk_buff *skb, enum skb_ext_id id);
5061 void __skb_ext_put(struct skb_ext *ext);
5062 
skb_ext_put(struct sk_buff * skb)5063 static inline void skb_ext_put(struct sk_buff *skb)
5064 {
5065 	if (skb->active_extensions)
5066 		__skb_ext_put(skb->extensions);
5067 }
5068 
__skb_ext_copy(struct sk_buff * dst,const struct sk_buff * src)5069 static inline void __skb_ext_copy(struct sk_buff *dst,
5070 				  const struct sk_buff *src)
5071 {
5072 	dst->active_extensions = src->active_extensions;
5073 
5074 	if (src->active_extensions) {
5075 		struct skb_ext *ext = src->extensions;
5076 
5077 		refcount_inc(&ext->refcnt);
5078 		dst->extensions = ext;
5079 	}
5080 }
5081 
skb_ext_copy(struct sk_buff * dst,const struct sk_buff * src)5082 static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *src)
5083 {
5084 	skb_ext_put(dst);
5085 	__skb_ext_copy(dst, src);
5086 }
5087 
__skb_ext_exist(const struct skb_ext * ext,enum skb_ext_id i)5088 static inline bool __skb_ext_exist(const struct skb_ext *ext, enum skb_ext_id i)
5089 {
5090 	return !!ext->offset[i];
5091 }
5092 
skb_ext_exist(const struct sk_buff * skb,enum skb_ext_id id)5093 static inline bool skb_ext_exist(const struct sk_buff *skb, enum skb_ext_id id)
5094 {
5095 	return skb->active_extensions & (1 << id);
5096 }
5097 
skb_ext_del(struct sk_buff * skb,enum skb_ext_id id)5098 static inline void skb_ext_del(struct sk_buff *skb, enum skb_ext_id id)
5099 {
5100 	if (skb_ext_exist(skb, id))
5101 		__skb_ext_del(skb, id);
5102 }
5103 
skb_ext_find(const struct sk_buff * skb,enum skb_ext_id id)5104 static inline void *skb_ext_find(const struct sk_buff *skb, enum skb_ext_id id)
5105 {
5106 	if (skb_ext_exist(skb, id)) {
5107 		struct skb_ext *ext = skb->extensions;
5108 
5109 		return (void *)ext + (ext->offset[id] << 3);
5110 	}
5111 
5112 	return NULL;
5113 }
5114 
skb_ext_reset(struct sk_buff * skb)5115 static inline void skb_ext_reset(struct sk_buff *skb)
5116 {
5117 	if (unlikely(skb->active_extensions)) {
5118 		__skb_ext_put(skb->extensions);
5119 		skb->active_extensions = 0;
5120 	}
5121 }
5122 
skb_has_extensions(struct sk_buff * skb)5123 static inline bool skb_has_extensions(struct sk_buff *skb)
5124 {
5125 	return unlikely(skb->active_extensions);
5126 }
5127 #else
__skb_ext_put(struct skb_ext * ext)5128 static inline void __skb_ext_put(struct skb_ext *ext) {}
skb_ext_put(struct sk_buff * skb)5129 static inline void skb_ext_put(struct sk_buff *skb) {}
skb_ext_reset(struct sk_buff * skb)5130 static inline void skb_ext_reset(struct sk_buff *skb) {}
skb_ext_del(struct sk_buff * skb,int unused)5131 static inline void skb_ext_del(struct sk_buff *skb, int unused) {}
__skb_ext_copy(struct sk_buff * d,const struct sk_buff * s)5132 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)5133 static inline void skb_ext_copy(struct sk_buff *dst, const struct sk_buff *s) {}
skb_has_extensions(struct sk_buff * skb)5134 static inline bool skb_has_extensions(struct sk_buff *skb) { return false; }
5135 #endif /* CONFIG_SKB_EXTENSIONS */
5136 
nf_reset_ct(struct sk_buff * skb)5137 static inline void nf_reset_ct(struct sk_buff *skb)
5138 {
5139 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5140 	nf_conntrack_put(skb_nfct(skb));
5141 	skb->_nfct = 0;
5142 #endif
5143 }
5144 
nf_reset_trace(struct sk_buff * skb)5145 static inline void nf_reset_trace(struct sk_buff *skb)
5146 {
5147 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || IS_ENABLED(CONFIG_NF_TABLES)
5148 	skb->nf_trace = 0;
5149 #endif
5150 }
5151 
ipvs_reset(struct sk_buff * skb)5152 static inline void ipvs_reset(struct sk_buff *skb)
5153 {
5154 #if IS_ENABLED(CONFIG_IP_VS)
5155 	skb->ipvs_property = 0;
5156 #endif
5157 }
5158 
5159 /* Note: This doesn't put any conntrack info in dst. */
__nf_copy(struct sk_buff * dst,const struct sk_buff * src,bool copy)5160 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
5161 			     bool copy)
5162 {
5163 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5164 	dst->_nfct = src->_nfct;
5165 	nf_conntrack_get(skb_nfct(src));
5166 #endif
5167 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || IS_ENABLED(CONFIG_NF_TABLES)
5168 	if (copy)
5169 		dst->nf_trace = src->nf_trace;
5170 #endif
5171 }
5172 
nf_copy(struct sk_buff * dst,const struct sk_buff * src)5173 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
5174 {
5175 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5176 	nf_conntrack_put(skb_nfct(dst));
5177 #endif
5178 	dst->slow_gro = src->slow_gro;
5179 	__nf_copy(dst, src, true);
5180 }
5181 
5182 #ifdef CONFIG_NETWORK_SECMARK
skb_copy_secmark(struct sk_buff * to,const struct sk_buff * from)5183 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
5184 {
5185 	to->secmark = from->secmark;
5186 }
5187 
skb_init_secmark(struct sk_buff * skb)5188 static inline void skb_init_secmark(struct sk_buff *skb)
5189 {
5190 	skb->secmark = 0;
5191 }
5192 #else
skb_copy_secmark(struct sk_buff * to,const struct sk_buff * from)5193 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
5194 { }
5195 
skb_init_secmark(struct sk_buff * skb)5196 static inline void skb_init_secmark(struct sk_buff *skb)
5197 { }
5198 #endif
5199 
secpath_exists(const struct sk_buff * skb)5200 static inline int secpath_exists(const struct sk_buff *skb)
5201 {
5202 #ifdef CONFIG_XFRM
5203 	return skb_ext_exist(skb, SKB_EXT_SEC_PATH);
5204 #else
5205 	return 0;
5206 #endif
5207 }
5208 
skb_irq_freeable(const struct sk_buff * skb)5209 static inline bool skb_irq_freeable(const struct sk_buff *skb)
5210 {
5211 	return !skb->destructor &&
5212 		!secpath_exists(skb) &&
5213 		!skb_nfct(skb) &&
5214 		!skb->_skb_refdst &&
5215 		!skb_has_frag_list(skb);
5216 }
5217 
skb_set_queue_mapping(struct sk_buff * skb,u16 queue_mapping)5218 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
5219 {
5220 	skb->queue_mapping = queue_mapping;
5221 }
5222 
skb_get_queue_mapping(const struct sk_buff * skb)5223 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
5224 {
5225 	return skb->queue_mapping;
5226 }
5227 
skb_copy_queue_mapping(struct sk_buff * to,const struct sk_buff * from)5228 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
5229 {
5230 	to->queue_mapping = from->queue_mapping;
5231 }
5232 
skb_record_rx_queue(struct sk_buff * skb,u16 rx_queue)5233 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
5234 {
5235 	skb->queue_mapping = rx_queue + 1;
5236 }
5237 
skb_get_rx_queue(const struct sk_buff * skb)5238 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
5239 {
5240 	return skb->queue_mapping - 1;
5241 }
5242 
skb_rx_queue_recorded(const struct sk_buff * skb)5243 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
5244 {
5245 	return skb->queue_mapping != 0;
5246 }
5247 
skb_set_dst_pending_confirm(struct sk_buff * skb,u32 val)5248 static inline void skb_set_dst_pending_confirm(struct sk_buff *skb, u32 val)
5249 {
5250 	skb->dst_pending_confirm = val;
5251 }
5252 
skb_get_dst_pending_confirm(const struct sk_buff * skb)5253 static inline bool skb_get_dst_pending_confirm(const struct sk_buff *skb)
5254 {
5255 	return skb->dst_pending_confirm != 0;
5256 }
5257 
skb_sec_path(const struct sk_buff * skb)5258 static inline struct sec_path *skb_sec_path(const struct sk_buff *skb)
5259 {
5260 #ifdef CONFIG_XFRM
5261 	return skb_ext_find(skb, SKB_EXT_SEC_PATH);
5262 #else
5263 	return NULL;
5264 #endif
5265 }
5266 
skb_is_gso(const struct sk_buff * skb)5267 static inline bool skb_is_gso(const struct sk_buff *skb)
5268 {
5269 	return skb_shinfo(skb)->gso_size;
5270 }
5271 
5272 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_v6(const struct sk_buff * skb)5273 static inline bool skb_is_gso_v6(const struct sk_buff *skb)
5274 {
5275 	return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
5276 }
5277 
5278 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_sctp(const struct sk_buff * skb)5279 static inline bool skb_is_gso_sctp(const struct sk_buff *skb)
5280 {
5281 	return skb_shinfo(skb)->gso_type & SKB_GSO_SCTP;
5282 }
5283 
5284 /* Note: Should be called only if skb_is_gso(skb) is true */
skb_is_gso_tcp(const struct sk_buff * skb)5285 static inline bool skb_is_gso_tcp(const struct sk_buff *skb)
5286 {
5287 	return skb_shinfo(skb)->gso_type & (SKB_GSO_TCPV4 | SKB_GSO_TCPV6);
5288 }
5289 
skb_gso_reset(struct sk_buff * skb)5290 static inline void skb_gso_reset(struct sk_buff *skb)
5291 {
5292 	skb_shinfo(skb)->gso_size = 0;
5293 	skb_shinfo(skb)->gso_segs = 0;
5294 	skb_shinfo(skb)->gso_type = 0;
5295 }
5296 
skb_increase_gso_size(struct skb_shared_info * shinfo,u16 increment)5297 static inline void skb_increase_gso_size(struct skb_shared_info *shinfo,
5298 					 u16 increment)
5299 {
5300 	if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
5301 		return;
5302 	shinfo->gso_size += increment;
5303 }
5304 
skb_decrease_gso_size(struct skb_shared_info * shinfo,u16 decrement)5305 static inline void skb_decrease_gso_size(struct skb_shared_info *shinfo,
5306 					 u16 decrement)
5307 {
5308 	if (WARN_ON_ONCE(shinfo->gso_size == GSO_BY_FRAGS))
5309 		return;
5310 	shinfo->gso_size -= decrement;
5311 }
5312 
5313 void __skb_warn_lro_forwarding(const struct sk_buff *skb);
5314 
skb_warn_if_lro(const struct sk_buff * skb)5315 static __always_inline bool skb_warn_if_lro(const struct sk_buff *skb)
5316 {
5317 	/* LRO sets gso_size but not gso_type, whereas if GSO is really
5318 	 * wanted then gso_type will be set. */
5319 	const struct skb_shared_info *shinfo = skb_shinfo(skb);
5320 
5321 	if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
5322 	    unlikely(shinfo->gso_type == 0)) {
5323 		__skb_warn_lro_forwarding(skb);
5324 		return true;
5325 	}
5326 	return false;
5327 }
5328 
skb_forward_csum(struct sk_buff * skb)5329 static inline void skb_forward_csum(struct sk_buff *skb)
5330 {
5331 	/* Unfortunately we don't support this one.  Any brave souls? */
5332 	if (skb->ip_summed == CHECKSUM_COMPLETE)
5333 		skb->ip_summed = CHECKSUM_NONE;
5334 }
5335 
5336 /**
5337  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
5338  * @skb: skb to check
5339  *
5340  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
5341  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
5342  * use this helper, to document places where we make this assertion.
5343  */
skb_checksum_none_assert(const struct sk_buff * skb)5344 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
5345 {
5346 	DEBUG_NET_WARN_ON_ONCE(skb->ip_summed != CHECKSUM_NONE);
5347 }
5348 
5349 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
5350 
5351 int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
5352 struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
5353 				     unsigned int transport_len,
5354 				     __sum16(*skb_chkf)(struct sk_buff *skb));
5355 
5356 /**
5357  * skb_head_is_locked - Determine if the skb->head is locked down
5358  * @skb: skb to check
5359  *
5360  * The head on skbs build around a head frag can be removed if they are
5361  * not cloned.  This function returns true if the skb head is locked down
5362  * due to either being allocated via kmalloc, or by being a clone with
5363  * multiple references to the head.
5364  */
skb_head_is_locked(const struct sk_buff * skb)5365 static inline bool skb_head_is_locked(const struct sk_buff *skb)
5366 {
5367 	return !skb->head_frag || skb_cloned(skb);
5368 }
5369 
5370 /* Local Checksum Offload.
5371  * Compute outer checksum based on the assumption that the
5372  * inner checksum will be offloaded later.
5373  * See Documentation/networking/checksum-offloads.rst for
5374  * explanation of how this works.
5375  * Fill in outer checksum adjustment (e.g. with sum of outer
5376  * pseudo-header) before calling.
5377  * Also ensure that inner checksum is in linear data area.
5378  */
lco_csum(struct sk_buff * skb)5379 static inline __wsum lco_csum(struct sk_buff *skb)
5380 {
5381 	unsigned char *csum_start = skb_checksum_start(skb);
5382 	unsigned char *l4_hdr = skb_transport_header(skb);
5383 	__wsum partial;
5384 
5385 	/* Start with complement of inner checksum adjustment */
5386 	partial = ~csum_unfold(*(__force __sum16 *)(csum_start +
5387 						    skb->csum_offset));
5388 
5389 	/* Add in checksum of our headers (incl. outer checksum
5390 	 * adjustment filled in by caller) and return result.
5391 	 */
5392 	return csum_partial(l4_hdr, csum_start - l4_hdr, partial);
5393 }
5394 
skb_is_redirected(const struct sk_buff * skb)5395 static inline bool skb_is_redirected(const struct sk_buff *skb)
5396 {
5397 	return skb->redirected;
5398 }
5399 
skb_set_redirected(struct sk_buff * skb,bool from_ingress)5400 static inline void skb_set_redirected(struct sk_buff *skb, bool from_ingress)
5401 {
5402 	skb->redirected = 1;
5403 #ifdef CONFIG_NET_REDIRECT
5404 	skb->from_ingress = from_ingress;
5405 	if (skb->from_ingress)
5406 		skb_clear_tstamp(skb);
5407 #endif
5408 }
5409 
skb_reset_redirect(struct sk_buff * skb)5410 static inline void skb_reset_redirect(struct sk_buff *skb)
5411 {
5412 	skb->redirected = 0;
5413 }
5414 
skb_set_redirected_noclear(struct sk_buff * skb,bool from_ingress)5415 static inline void skb_set_redirected_noclear(struct sk_buff *skb,
5416 					      bool from_ingress)
5417 {
5418 	skb->redirected = 1;
5419 #ifdef CONFIG_NET_REDIRECT
5420 	skb->from_ingress = from_ingress;
5421 #endif
5422 }
5423 
skb_csum_is_sctp(struct sk_buff * skb)5424 static inline bool skb_csum_is_sctp(struct sk_buff *skb)
5425 {
5426 #if IS_ENABLED(CONFIG_IP_SCTP)
5427 	return skb->csum_not_inet;
5428 #else
5429 	return 0;
5430 #endif
5431 }
5432 
skb_reset_csum_not_inet(struct sk_buff * skb)5433 static inline void skb_reset_csum_not_inet(struct sk_buff *skb)
5434 {
5435 	skb->ip_summed = CHECKSUM_NONE;
5436 #if IS_ENABLED(CONFIG_IP_SCTP)
5437 	skb->csum_not_inet = 0;
5438 #endif
5439 }
5440 
skb_set_kcov_handle(struct sk_buff * skb,const u64 kcov_handle)5441 static inline void skb_set_kcov_handle(struct sk_buff *skb,
5442 				       const u64 kcov_handle)
5443 {
5444 #ifdef CONFIG_KCOV
5445 	skb->kcov_handle = kcov_handle;
5446 #endif
5447 }
5448 
skb_get_kcov_handle(struct sk_buff * skb)5449 static inline u64 skb_get_kcov_handle(struct sk_buff *skb)
5450 {
5451 #ifdef CONFIG_KCOV
5452 	return skb->kcov_handle;
5453 #else
5454 	return 0;
5455 #endif
5456 }
5457 
skb_mark_for_recycle(struct sk_buff * skb)5458 static inline void skb_mark_for_recycle(struct sk_buff *skb)
5459 {
5460 #ifdef CONFIG_PAGE_POOL
5461 	skb->pp_recycle = 1;
5462 #endif
5463 }
5464 
5465 ssize_t skb_splice_from_iter(struct sk_buff *skb, struct iov_iter *iter,
5466 			     ssize_t maxsize);
5467 
5468 #endif	/* __KERNEL__ */
5469 #endif	/* _LINUX_SKBUFF_H */
5470