2 * Definitions for the 'struct sk_buff' memory handlers.
5 * Alan Cox, <gw4pts@gw4pts.ampr.org>
6 * Florian La Roche, <rzsfl@rz.uni-sb.de>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
14 #ifndef _LINUX_SKBUFF_H
15 #define _LINUX_SKBUFF_H
17 #include <linux/kernel.h>
18 #include <linux/kmemcheck.h>
19 #include <linux/compiler.h>
20 #include <linux/time.h>
21 #include <linux/bug.h>
22 #include <linux/cache.h>
23 #include <linux/rbtree.h>
24 #include <linux/socket.h>
26 #include <linux/atomic.h>
27 #include <asm/types.h>
28 #include <linux/spinlock.h>
29 #include <linux/net.h>
30 #include <linux/textsearch.h>
31 #include <net/checksum.h>
32 #include <linux/rcupdate.h>
33 #include <linux/hrtimer.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/netdev_features.h>
36 #include <linux/sched.h>
37 #include <net/flow_dissector.h>
38 #include <linux/splice.h>
39 #include <linux/in6.h>
42 /* A. Checksumming of received packets by device.
46 * Device failed to checksum this packet e.g. due to lack of capabilities.
47 * The packet contains full (though not verified) checksum in packet but
48 * not in skb->csum. Thus, skb->csum is undefined in this case.
50 * CHECKSUM_UNNECESSARY:
52 * The hardware you're dealing with doesn't calculate the full checksum
53 * (as in CHECKSUM_COMPLETE), but it does parse headers and verify checksums
54 * for specific protocols. For such packets it will set CHECKSUM_UNNECESSARY
55 * if their checksums are okay. skb->csum is still undefined in this case
56 * though. It is a bad option, but, unfortunately, nowadays most vendors do
57 * this. Apparently with the secret goal to sell you new devices, when you
58 * will add new protocol to your host, f.e. IPv6 8)
60 * CHECKSUM_UNNECESSARY is applicable to following protocols:
62 * UDP: IPv4 and IPv6. A device may apply CHECKSUM_UNNECESSARY to a
63 * zero UDP checksum for either IPv4 or IPv6, the networking stack
64 * may perform further validation in this case.
65 * GRE: only if the checksum is present in the header.
66 * SCTP: indicates the CRC in SCTP header has been validated.
68 * skb->csum_level indicates the number of consecutive checksums found in
69 * the packet minus one that have been verified as CHECKSUM_UNNECESSARY.
70 * For instance if a device receives an IPv6->UDP->GRE->IPv4->TCP packet
71 * and a device is able to verify the checksums for UDP (possibly zero),
72 * GRE (checksum flag is set), and TCP-- skb->csum_level would be set to
73 * two. If the device were only able to verify the UDP checksum and not
74 * GRE, either because it doesn't support GRE checksum of because GRE
75 * checksum is bad, skb->csum_level would be set to zero (TCP checksum is
76 * not considered in this case).
80 * This is the most generic way. The device supplied checksum of the _whole_
81 * packet as seen by netif_rx() and fills out in skb->csum. Meaning, the
82 * hardware doesn't need to parse L3/L4 headers to implement this.
84 * Note: Even if device supports only some protocols, but is able to produce
85 * skb->csum, it MUST use CHECKSUM_COMPLETE, not CHECKSUM_UNNECESSARY.
89 * A checksum is set up to be offloaded to a device as described in the
90 * output description for CHECKSUM_PARTIAL. This may occur on a packet
91 * received directly from another Linux OS, e.g., a virtualized Linux kernel
92 * on the same host, or it may be set in the input path in GRO or remote
93 * checksum offload. For the purposes of checksum verification, the checksum
94 * referred to by skb->csum_start + skb->csum_offset and any preceding
95 * checksums in the packet are considered verified. Any checksums in the
96 * packet that are after the checksum being offloaded are not considered to
99 * B. Checksumming on output.
103 * The skb was already checksummed by the protocol, or a checksum is not
108 * The device is required to checksum the packet as seen by hard_start_xmit()
109 * from skb->csum_start up to the end, and to record/write the checksum at
110 * offset skb->csum_start + skb->csum_offset.
112 * The device must show its capabilities in dev->features, set up at device
113 * setup time, e.g. netdev_features.h:
115 * NETIF_F_HW_CSUM - It's a clever device, it's able to checksum everything.
116 * NETIF_F_IP_CSUM - Device is dumb, it's able to checksum only TCP/UDP over
117 * IPv4. Sigh. Vendors like this way for an unknown reason.
118 * Though, see comment above about CHECKSUM_UNNECESSARY. 8)
119 * NETIF_F_IPV6_CSUM - About as dumb as the last one but does IPv6 instead.
120 * NETIF_F_... - Well, you get the picture.
122 * CHECKSUM_UNNECESSARY:
124 * Normally, the device will do per protocol specific checksumming. Protocol
125 * implementations that do not want the NIC to perform the checksum
126 * calculation should use this flag in their outgoing skbs.
128 * NETIF_F_FCOE_CRC - This indicates that the device can do FCoE FC CRC
129 * offload. Correspondingly, the FCoE protocol driver
130 * stack should use CHECKSUM_UNNECESSARY.
132 * Any questions? No questions, good. --ANK
135 /* Don't change this without changing skb_csum_unnecessary! */
136 #define CHECKSUM_NONE 0
137 #define CHECKSUM_UNNECESSARY 1
138 #define CHECKSUM_COMPLETE 2
139 #define CHECKSUM_PARTIAL 3
141 /* Maximum value in skb->csum_level */
142 #define SKB_MAX_CSUM_LEVEL 3
144 #define SKB_DATA_ALIGN(X) ALIGN(X, SMP_CACHE_BYTES)
145 #define SKB_WITH_OVERHEAD(X) \
146 ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
147 #define SKB_MAX_ORDER(X, ORDER) \
148 SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
149 #define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
150 #define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
152 /* return minimum truesize of one skb containing X bytes of data */
153 #define SKB_TRUESIZE(X) ((X) + \
154 SKB_DATA_ALIGN(sizeof(struct sk_buff)) + \
155 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
159 struct pipe_inode_info;
163 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
164 struct nf_conntrack {
169 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
170 struct nf_bridge_info {
173 BRNF_PROTO_UNCHANGED,
181 struct net_device *physindev;
183 /* always valid & non-NULL from FORWARD on, for physdev match */
184 struct net_device *physoutdev;
186 /* prerouting: detect dnat in orig/reply direction */
188 struct in6_addr ipv6_daddr;
190 /* after prerouting + nat detected: store original source
191 * mac since neigh resolution overwrites it, only used while
192 * skb is out in neigh layer.
194 char neigh_header[8];
199 struct sk_buff_head {
200 /* These two members must be first. */
201 struct sk_buff *next;
202 struct sk_buff *prev;
210 /* To allow 64K frame to be packed as single skb without frag_list we
211 * require 64K/PAGE_SIZE pages plus 1 additional page to allow for
212 * buffers which do not start on a page boundary.
214 * Since GRO uses frags we allocate at least 16 regardless of page
217 #if (65536/PAGE_SIZE + 1) < 16
218 #define MAX_SKB_FRAGS 16UL
220 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 1)
222 extern int sysctl_max_skb_frags;
224 typedef struct skb_frag_struct skb_frag_t;
226 struct skb_frag_struct {
230 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
239 static inline unsigned int skb_frag_size(const skb_frag_t *frag)
244 static inline void skb_frag_size_set(skb_frag_t *frag, unsigned int size)
249 static inline void skb_frag_size_add(skb_frag_t *frag, int delta)
254 static inline void skb_frag_size_sub(skb_frag_t *frag, int delta)
259 #define HAVE_HW_TIME_STAMP
262 * struct skb_shared_hwtstamps - hardware time stamps
263 * @hwtstamp: hardware time stamp transformed into duration
264 * since arbitrary point in time
266 * Software time stamps generated by ktime_get_real() are stored in
269 * hwtstamps can only be compared against other hwtstamps from
272 * This structure is attached to packets as part of the
273 * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
275 struct skb_shared_hwtstamps {
279 /* Definitions for tx_flags in struct skb_shared_info */
281 /* generate hardware time stamp */
282 SKBTX_HW_TSTAMP = 1 << 0,
284 /* generate software time stamp when queueing packet to NIC */
285 SKBTX_SW_TSTAMP = 1 << 1,
287 /* device driver is going to provide hardware time stamp */
288 SKBTX_IN_PROGRESS = 1 << 2,
290 /* device driver supports TX zero-copy buffers */
291 SKBTX_DEV_ZEROCOPY = 1 << 3,
293 /* generate wifi status information (where possible) */
294 SKBTX_WIFI_STATUS = 1 << 4,
296 /* This indicates at least one fragment might be overwritten
297 * (as in vmsplice(), sendfile() ...)
298 * If we need to compute a TX checksum, we'll need to copy
299 * all frags to avoid possible bad checksum
301 SKBTX_SHARED_FRAG = 1 << 5,
303 /* generate software time stamp when entering packet scheduling */
304 SKBTX_SCHED_TSTAMP = 1 << 6,
306 /* generate software timestamp on peer data acknowledgment */
307 SKBTX_ACK_TSTAMP = 1 << 7,
310 #define SKBTX_ANY_SW_TSTAMP (SKBTX_SW_TSTAMP | \
311 SKBTX_SCHED_TSTAMP | \
313 #define SKBTX_ANY_TSTAMP (SKBTX_HW_TSTAMP | SKBTX_ANY_SW_TSTAMP)
316 * The callback notifies userspace to release buffers when skb DMA is done in
317 * lower device, the skb last reference should be 0 when calling this.
318 * The zerocopy_success argument is true if zero copy transmit occurred,
319 * false on data copy or out of memory error caused by data copy attempt.
320 * The ctx field is used to track device context.
321 * The desc field is used to track userspace buffer index.
324 void (*callback)(struct ubuf_info *, bool zerocopy_success);
329 /* This data is invariant across clones and lives at
330 * the end of the header data, ie. at skb->end.
332 struct skb_shared_info {
333 unsigned char nr_frags;
335 unsigned short gso_size;
336 /* Warning: this field is not always filled in (UFO)! */
337 unsigned short gso_segs;
338 unsigned short gso_type;
339 struct sk_buff *frag_list;
340 struct skb_shared_hwtstamps hwtstamps;
345 * Warning : all fields before dataref are cleared in __alloc_skb()
349 /* Intermediate layers must ensure that destructor_arg
350 * remains valid until skb destructor */
351 void * destructor_arg;
353 /* must be last field, see pskb_expand_head() */
354 skb_frag_t frags[MAX_SKB_FRAGS];
357 /* We divide dataref into two halves. The higher 16 bits hold references
358 * to the payload part of skb->data. The lower 16 bits hold references to
359 * the entire skb->data. A clone of a headerless skb holds the length of
360 * the header in skb->hdr_len.
362 * All users must obey the rule that the skb->data reference count must be
363 * greater than or equal to the payload reference count.
365 * Holding a reference to the payload part means that the user does not
366 * care about modifications to the header part of skb->data.
368 #define SKB_DATAREF_SHIFT 16
369 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
373 SKB_FCLONE_UNAVAILABLE, /* skb has no fclone (from head_cache) */
374 SKB_FCLONE_ORIG, /* orig skb (from fclone_cache) */
375 SKB_FCLONE_CLONE, /* companion fclone skb (from fclone_cache) */
379 SKB_GSO_TCPV4 = 1 << 0,
380 SKB_GSO_UDP = 1 << 1,
382 /* This indicates the skb is from an untrusted source. */
383 SKB_GSO_DODGY = 1 << 2,
385 /* This indicates the tcp segment has CWR set. */
386 SKB_GSO_TCP_ECN = 1 << 3,
388 SKB_GSO_TCPV6 = 1 << 4,
390 SKB_GSO_FCOE = 1 << 5,
392 SKB_GSO_GRE = 1 << 6,
394 SKB_GSO_GRE_CSUM = 1 << 7,
396 SKB_GSO_IPIP = 1 << 8,
398 SKB_GSO_SIT = 1 << 9,
400 SKB_GSO_UDP_TUNNEL = 1 << 10,
402 SKB_GSO_UDP_TUNNEL_CSUM = 1 << 11,
404 SKB_GSO_TUNNEL_REMCSUM = 1 << 12,
407 #if BITS_PER_LONG > 32
408 #define NET_SKBUFF_DATA_USES_OFFSET 1
411 #ifdef NET_SKBUFF_DATA_USES_OFFSET
412 typedef unsigned int sk_buff_data_t;
414 typedef unsigned char *sk_buff_data_t;
418 * struct skb_mstamp - multi resolution time stamps
419 * @stamp_us: timestamp in us resolution
420 * @stamp_jiffies: timestamp in jiffies
433 * skb_mstamp_get - get current timestamp
434 * @cl: place to store timestamps
436 static inline void skb_mstamp_get(struct skb_mstamp *cl)
438 u64 val = local_clock();
440 do_div(val, NSEC_PER_USEC);
441 cl->stamp_us = (u32)val;
442 cl->stamp_jiffies = (u32)jiffies;
446 * skb_mstamp_delta - compute the difference in usec between two skb_mstamp
447 * @t1: pointer to newest sample
448 * @t0: pointer to oldest sample
450 static inline u32 skb_mstamp_us_delta(const struct skb_mstamp *t1,
451 const struct skb_mstamp *t0)
453 s32 delta_us = t1->stamp_us - t0->stamp_us;
454 u32 delta_jiffies = t1->stamp_jiffies - t0->stamp_jiffies;
456 /* If delta_us is negative, this might be because interval is too big,
457 * or local_clock() drift is too big : fallback using jiffies.
460 delta_jiffies >= (INT_MAX / (USEC_PER_SEC / HZ)))
462 delta_us = jiffies_to_usecs(delta_jiffies);
467 static inline bool skb_mstamp_after(const struct skb_mstamp *t1,
468 const struct skb_mstamp *t0)
470 s32 diff = t1->stamp_jiffies - t0->stamp_jiffies;
473 diff = t1->stamp_us - t0->stamp_us;
478 * struct sk_buff - socket buffer
479 * @next: Next buffer in list
480 * @prev: Previous buffer in list
481 * @tstamp: Time we arrived/left
482 * @rbnode: RB tree node, alternative to next/prev for netem/tcp
483 * @sk: Socket we are owned by
484 * @dev: Device we arrived on/are leaving by
485 * @cb: Control buffer. Free for use by every layer. Put private vars here
486 * @_skb_refdst: destination entry (with norefcount bit)
487 * @sp: the security path, used for xfrm
488 * @len: Length of actual data
489 * @data_len: Data length
490 * @mac_len: Length of link layer header
491 * @hdr_len: writable header length of cloned skb
492 * @csum: Checksum (must include start/offset pair)
493 * @csum_start: Offset from skb->head where checksumming should start
494 * @csum_offset: Offset from csum_start where checksum should be stored
495 * @priority: Packet queueing priority
496 * @ignore_df: allow local fragmentation
497 * @cloned: Head may be cloned (check refcnt to be sure)
498 * @ip_summed: Driver fed us an IP checksum
499 * @nohdr: Payload reference only, must not modify header
500 * @nfctinfo: Relationship of this skb to the connection
501 * @pkt_type: Packet class
502 * @fclone: skbuff clone status
503 * @ipvs_property: skbuff is owned by ipvs
504 * @peeked: this packet has been seen already, so stats have been
505 * done for it, don't do them again
506 * @nf_trace: netfilter packet trace flag
507 * @protocol: Packet protocol from driver
508 * @destructor: Destruct function
509 * @nfct: Associated connection, if any
510 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
511 * @skb_iif: ifindex of device we arrived on
512 * @tc_index: Traffic control index
513 * @tc_verd: traffic control verdict
514 * @hash: the packet hash
515 * @queue_mapping: Queue mapping for multiqueue devices
516 * @xmit_more: More SKBs are pending for this queue
517 * @ndisc_nodetype: router type (from link layer)
518 * @ooo_okay: allow the mapping of a socket to a queue to be changed
519 * @l4_hash: indicate hash is a canonical 4-tuple hash over transport
521 * @sw_hash: indicates hash was computed in software stack
522 * @wifi_acked_valid: wifi_acked was set
523 * @wifi_acked: whether frame was acked on wifi or not
524 * @no_fcs: Request NIC to treat last 4 bytes as Ethernet FCS
525 * @napi_id: id of the NAPI struct this skb came from
526 * @secmark: security marking
527 * @offload_fwd_mark: fwding offload mark
528 * @mark: Generic packet mark
529 * @vlan_proto: vlan encapsulation protocol
530 * @vlan_tci: vlan tag control information
531 * @inner_protocol: Protocol (encapsulation)
532 * @inner_transport_header: Inner transport layer header (encapsulation)
533 * @inner_network_header: Network layer header (encapsulation)
534 * @inner_mac_header: Link layer header (encapsulation)
535 * @transport_header: Transport layer header
536 * @network_header: Network layer header
537 * @mac_header: Link layer header
538 * @tail: Tail pointer
540 * @head: Head of buffer
541 * @data: Data head pointer
542 * @truesize: Buffer size
543 * @users: User count - see {datagram,tcp}.c
549 /* These two members must be first. */
550 struct sk_buff *next;
551 struct sk_buff *prev;
555 struct skb_mstamp skb_mstamp;
558 struct rb_node rbnode; /* used in netem & tcp stack */
561 struct net_device *dev;
564 * This is the control buffer. It is free to use for every
565 * layer. Please put your private variables there. If you
566 * want to keep them across layers you have to do a skb_clone()
567 * first. This is owned by whoever has the skb queued ATM.
569 char cb[48] __aligned(8);
571 unsigned long _skb_refdst;
572 void (*destructor)(struct sk_buff *skb);
576 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
577 struct nf_conntrack *nfct;
579 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
580 struct nf_bridge_info *nf_bridge;
587 /* Following fields are _not_ copied in __copy_skb_header()
588 * Note that queue_mapping is here mostly to fill a hole.
590 kmemcheck_bitfield_begin(flags1);
599 kmemcheck_bitfield_end(flags1);
601 /* fields enclosed in headers_start/headers_end are copied
602 * using a single memcpy() in __copy_skb_header()
605 __u32 headers_start[0];
608 /* if you move pkt_type around you also must adapt those constants */
609 #ifdef __BIG_ENDIAN_BITFIELD
610 #define PKT_TYPE_MAX (7 << 5)
612 #define PKT_TYPE_MAX 7
614 #define PKT_TYPE_OFFSET() offsetof(struct sk_buff, __pkt_type_offset)
616 __u8 __pkt_type_offset[0];
627 __u8 wifi_acked_valid:1;
631 /* Indicates the inner headers are valid in the skbuff. */
632 __u8 encapsulation:1;
633 __u8 encap_hdr_csum:1;
635 __u8 csum_complete_sw:1;
639 #ifdef CONFIG_IPV6_NDISC_NODETYPE
640 __u8 ndisc_nodetype:2;
642 __u8 ipvs_property:1;
643 __u8 inner_protocol_type:1;
644 __u8 remcsum_offload:1;
645 /* 3 or 5 bit hole */
647 #ifdef CONFIG_NET_SCHED
648 __u16 tc_index; /* traffic control index */
649 #ifdef CONFIG_NET_CLS_ACT
650 __u16 tc_verd; /* traffic control verdict */
666 #if defined(CONFIG_NET_RX_BUSY_POLL) || defined(CONFIG_XPS)
668 unsigned int napi_id;
669 unsigned int sender_cpu;
673 #ifdef CONFIG_NETWORK_SECMARK
676 #ifdef CONFIG_NET_SWITCHDEV
677 __u32 offload_fwd_mark;
683 __u32 reserved_tailroom;
687 __be16 inner_protocol;
691 __u16 inner_transport_header;
692 __u16 inner_network_header;
693 __u16 inner_mac_header;
696 __u16 transport_header;
697 __u16 network_header;
701 __u32 headers_end[0];
704 /* These elements must be at the end, see alloc_skb() for details. */
709 unsigned int truesize;
715 * Handling routines are only of interest to the kernel
717 #include <linux/slab.h>
720 #define SKB_ALLOC_FCLONE 0x01
721 #define SKB_ALLOC_RX 0x02
722 #define SKB_ALLOC_NAPI 0x04
724 /* Returns true if the skb was allocated from PFMEMALLOC reserves */
725 static inline bool skb_pfmemalloc(const struct sk_buff *skb)
727 return unlikely(skb->pfmemalloc);
731 * skb might have a dst pointer attached, refcounted or not.
732 * _skb_refdst low order bit is set if refcount was _not_ taken
734 #define SKB_DST_NOREF 1UL
735 #define SKB_DST_PTRMASK ~(SKB_DST_NOREF)
738 * skb_dst - returns skb dst_entry
741 * Returns skb dst_entry, regardless of reference taken or not.
743 static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
745 /* If refdst was not refcounted, check we still are in a
746 * rcu_read_lock section
748 WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
749 !rcu_read_lock_held() &&
750 !rcu_read_lock_bh_held());
751 return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
755 * skb_dst_set - sets skb dst
759 * Sets skb dst, assuming a reference was taken on dst and should
760 * be released by skb_dst_drop()
762 static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
764 skb->_skb_refdst = (unsigned long)dst;
768 * skb_dst_set_noref - sets skb dst, hopefully, without taking reference
772 * Sets skb dst, assuming a reference was not taken on dst.
773 * If dst entry is cached, we do not take reference and dst_release
774 * will be avoided by refdst_drop. If dst entry is not cached, we take
775 * reference, so that last dst_release can destroy the dst immediately.
777 static inline void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst)
779 WARN_ON(!rcu_read_lock_held() && !rcu_read_lock_bh_held());
780 skb->_skb_refdst = (unsigned long)dst | SKB_DST_NOREF;
784 * skb_dst_is_noref - Test if skb dst isn't refcounted
787 static inline bool skb_dst_is_noref(const struct sk_buff *skb)
789 return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
792 static inline struct rtable *skb_rtable(const struct sk_buff *skb)
794 return (struct rtable *)skb_dst(skb);
797 void kfree_skb(struct sk_buff *skb);
798 void kfree_skb_list(struct sk_buff *segs);
799 void skb_tx_error(struct sk_buff *skb);
800 void consume_skb(struct sk_buff *skb);
801 void __kfree_skb(struct sk_buff *skb);
802 extern struct kmem_cache *skbuff_head_cache;
804 void kfree_skb_partial(struct sk_buff *skb, bool head_stolen);
805 bool skb_try_coalesce(struct sk_buff *to, struct sk_buff *from,
806 bool *fragstolen, int *delta_truesize);
808 struct sk_buff *__alloc_skb(unsigned int size, gfp_t priority, int flags,
810 struct sk_buff *__build_skb(void *data, unsigned int frag_size);
811 struct sk_buff *build_skb(void *data, unsigned int frag_size);
812 static inline struct sk_buff *alloc_skb(unsigned int size,
815 return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
818 struct sk_buff *alloc_skb_with_frags(unsigned long header_len,
819 unsigned long data_len,
824 /* Layout of fast clones : [skb1][skb2][fclone_ref] */
825 struct sk_buff_fclones {
834 * skb_fclone_busy - check if fclone is busy
837 * Returns true is skb is a fast clone, and its clone is not freed.
838 * Some drivers call skb_orphan() in their ndo_start_xmit(),
839 * so we also check that this didnt happen.
841 static inline bool skb_fclone_busy(const struct sock *sk,
842 const struct sk_buff *skb)
844 const struct sk_buff_fclones *fclones;
846 fclones = container_of(skb, struct sk_buff_fclones, skb1);
848 return skb->fclone == SKB_FCLONE_ORIG &&
849 atomic_read(&fclones->fclone_ref) > 1 &&
850 fclones->skb2.sk == sk;
853 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
856 return __alloc_skb(size, priority, SKB_ALLOC_FCLONE, NUMA_NO_NODE);
859 struct sk_buff *__alloc_skb_head(gfp_t priority, int node);
860 static inline struct sk_buff *alloc_skb_head(gfp_t priority)
862 return __alloc_skb_head(priority, -1);
865 struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
866 int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
867 struct sk_buff *skb_clone(struct sk_buff *skb, gfp_t priority);
868 struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
869 struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
870 gfp_t gfp_mask, bool fclone);
871 static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
874 return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
877 int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
878 struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
879 unsigned int headroom);
880 struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
881 int newtailroom, gfp_t priority);
882 int skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
883 int offset, int len);
884 int skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg, int offset,
886 int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
887 int skb_pad(struct sk_buff *skb, int pad);
888 #define dev_kfree_skb(a) consume_skb(a)
890 int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
891 int getfrag(void *from, char *to, int offset,
892 int len, int odd, struct sk_buff *skb),
893 void *from, int length);
895 int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
896 int offset, size_t size);
898 struct skb_seq_state {
902 __u32 stepped_offset;
903 struct sk_buff *root_skb;
904 struct sk_buff *cur_skb;
908 void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
909 unsigned int to, struct skb_seq_state *st);
910 unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
911 struct skb_seq_state *st);
912 void skb_abort_seq_read(struct skb_seq_state *st);
914 unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
915 unsigned int to, struct ts_config *config);
918 * Packet hash types specify the type of hash in skb_set_hash.
920 * Hash types refer to the protocol layer addresses which are used to
921 * construct a packet's hash. The hashes are used to differentiate or identify
922 * flows of the protocol layer for the hash type. Hash types are either
923 * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
925 * Properties of hashes:
927 * 1) Two packets in different flows have different hash values
928 * 2) Two packets in the same flow should have the same hash value
930 * A hash at a higher layer is considered to be more specific. A driver should
931 * set the most specific hash possible.
933 * A driver cannot indicate a more specific hash than the layer at which a hash
934 * was computed. For instance an L3 hash cannot be set as an L4 hash.
936 * A driver may indicate a hash level which is less specific than the
937 * actual layer the hash was computed on. For instance, a hash computed
938 * at L4 may be considered an L3 hash. This should only be done if the
939 * driver can't unambiguously determine that the HW computed the hash at
940 * the higher layer. Note that the "should" in the second property above
943 enum pkt_hash_types {
944 PKT_HASH_TYPE_NONE, /* Undefined type */
945 PKT_HASH_TYPE_L2, /* Input: src_MAC, dest_MAC */
946 PKT_HASH_TYPE_L3, /* Input: src_IP, dst_IP */
947 PKT_HASH_TYPE_L4, /* Input: src_IP, dst_IP, src_port, dst_port */
950 static inline void skb_clear_hash(struct sk_buff *skb)
957 static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
964 __skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
966 skb->l4_hash = is_l4;
967 skb->sw_hash = is_sw;
972 skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
974 /* Used by drivers to set hash from HW */
975 __skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
979 __skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
981 __skb_set_hash(skb, hash, true, is_l4);
984 void __skb_get_hash(struct sk_buff *skb);
985 u32 __skb_get_hash_symmetric(struct sk_buff *skb);
986 u32 skb_get_poff(const struct sk_buff *skb);
987 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
988 const struct flow_keys *keys, int hlen);
989 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
990 void *data, int hlen_proto);
992 static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
993 int thoff, u8 ip_proto)
995 return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
998 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
999 const struct flow_dissector_key *key,
1000 unsigned int key_count);
1002 bool __skb_flow_dissect(const struct sk_buff *skb,
1003 struct flow_dissector *flow_dissector,
1004 void *target_container,
1005 void *data, __be16 proto, int nhoff, int hlen,
1006 unsigned int flags);
1008 static inline bool skb_flow_dissect(const struct sk_buff *skb,
1009 struct flow_dissector *flow_dissector,
1010 void *target_container, unsigned int flags)
1012 return __skb_flow_dissect(skb, flow_dissector, target_container,
1013 NULL, 0, 0, 0, flags);
1016 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
1017 struct flow_keys *flow,
1020 memset(flow, 0, sizeof(*flow));
1021 return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
1022 NULL, 0, 0, 0, flags);
1025 static inline bool skb_flow_dissect_flow_keys_buf(struct flow_keys *flow,
1026 void *data, __be16 proto,
1027 int nhoff, int hlen,
1030 memset(flow, 0, sizeof(*flow));
1031 return __skb_flow_dissect(NULL, &flow_keys_buf_dissector, flow,
1032 data, proto, nhoff, hlen, flags);
1035 static inline __u32 skb_get_hash(struct sk_buff *skb)
1037 if (!skb->l4_hash && !skb->sw_hash)
1038 __skb_get_hash(skb);
1043 __u32 __skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6);
1045 static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
1047 if (!skb->l4_hash && !skb->sw_hash) {
1048 struct flow_keys keys;
1049 __u32 hash = __get_hash_from_flowi6(fl6, &keys);
1051 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1057 __u32 __skb_get_hash_flowi4(struct sk_buff *skb, const struct flowi4 *fl);
1059 static inline __u32 skb_get_hash_flowi4(struct sk_buff *skb, const struct flowi4 *fl4)
1061 if (!skb->l4_hash && !skb->sw_hash) {
1062 struct flow_keys keys;
1063 __u32 hash = __get_hash_from_flowi4(fl4, &keys);
1065 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1071 __u32 skb_get_hash_perturb(const struct sk_buff *skb, u32 perturb);
1073 static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1078 static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1080 to->hash = from->hash;
1081 to->sw_hash = from->sw_hash;
1082 to->l4_hash = from->l4_hash;
1085 static inline void skb_sender_cpu_clear(struct sk_buff *skb)
1088 skb->sender_cpu = 0;
1092 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1093 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1095 return skb->head + skb->end;
1098 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1103 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1108 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1110 return skb->end - skb->head;
1115 #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
1117 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1119 return &skb_shinfo(skb)->hwtstamps;
1123 * skb_queue_empty - check if a queue is empty
1126 * Returns true if the queue is empty, false otherwise.
1128 static inline int skb_queue_empty(const struct sk_buff_head *list)
1130 return list->next == (const struct sk_buff *) list;
1134 * skb_queue_is_last - check if skb is the last entry in the queue
1138 * Returns true if @skb is the last buffer on the list.
1140 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1141 const struct sk_buff *skb)
1143 return skb->next == (const struct sk_buff *) list;
1147 * skb_queue_is_first - check if skb is the first entry in the queue
1151 * Returns true if @skb is the first buffer on the list.
1153 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1154 const struct sk_buff *skb)
1156 return skb->prev == (const struct sk_buff *) list;
1160 * skb_queue_next - return the next packet in the queue
1162 * @skb: current buffer
1164 * Return the next packet in @list after @skb. It is only valid to
1165 * call this if skb_queue_is_last() evaluates to false.
1167 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1168 const struct sk_buff *skb)
1170 /* This BUG_ON may seem severe, but if we just return then we
1171 * are going to dereference garbage.
1173 BUG_ON(skb_queue_is_last(list, skb));
1178 * skb_queue_prev - return the prev packet in the queue
1180 * @skb: current buffer
1182 * Return the prev packet in @list before @skb. It is only valid to
1183 * call this if skb_queue_is_first() evaluates to false.
1185 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1186 const struct sk_buff *skb)
1188 /* This BUG_ON may seem severe, but if we just return then we
1189 * are going to dereference garbage.
1191 BUG_ON(skb_queue_is_first(list, skb));
1196 * skb_get - reference buffer
1197 * @skb: buffer to reference
1199 * Makes another reference to a socket buffer and returns a pointer
1202 static inline struct sk_buff *skb_get(struct sk_buff *skb)
1204 atomic_inc(&skb->users);
1209 * If users == 1, we are the only owner and are can avoid redundant
1214 * skb_cloned - is the buffer a clone
1215 * @skb: buffer to check
1217 * Returns true if the buffer was generated with skb_clone() and is
1218 * one of multiple shared copies of the buffer. Cloned buffers are
1219 * shared data so must not be written to under normal circumstances.
1221 static inline int skb_cloned(const struct sk_buff *skb)
1223 return skb->cloned &&
1224 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
1227 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
1229 might_sleep_if(gfpflags_allow_blocking(pri));
1231 if (skb_cloned(skb))
1232 return pskb_expand_head(skb, 0, 0, pri);
1238 * skb_header_cloned - is the header a clone
1239 * @skb: buffer to check
1241 * Returns true if modifying the header part of the buffer requires
1242 * the data to be copied.
1244 static inline int skb_header_cloned(const struct sk_buff *skb)
1251 dataref = atomic_read(&skb_shinfo(skb)->dataref);
1252 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
1253 return dataref != 1;
1257 * skb_header_release - release reference to header
1258 * @skb: buffer to operate on
1260 * Drop a reference to the header part of the buffer. This is done
1261 * by acquiring a payload reference. You must not read from the header
1262 * part of skb->data after this.
1263 * Note : Check if you can use __skb_header_release() instead.
1265 static inline void skb_header_release(struct sk_buff *skb)
1269 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
1273 * __skb_header_release - release reference to header
1274 * @skb: buffer to operate on
1276 * Variant of skb_header_release() assuming skb is private to caller.
1277 * We can avoid one atomic operation.
1279 static inline void __skb_header_release(struct sk_buff *skb)
1282 atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
1287 * skb_shared - is the buffer shared
1288 * @skb: buffer to check
1290 * Returns true if more than one person has a reference to this
1293 static inline int skb_shared(const struct sk_buff *skb)
1295 return atomic_read(&skb->users) != 1;
1299 * skb_share_check - check if buffer is shared and if so clone it
1300 * @skb: buffer to check
1301 * @pri: priority for memory allocation
1303 * If the buffer is shared the buffer is cloned and the old copy
1304 * drops a reference. A new clone with a single reference is returned.
1305 * If the buffer is not shared the original buffer is returned. When
1306 * being called from interrupt status or with spinlocks held pri must
1309 * NULL is returned on a memory allocation failure.
1311 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
1313 might_sleep_if(gfpflags_allow_blocking(pri));
1314 if (skb_shared(skb)) {
1315 struct sk_buff *nskb = skb_clone(skb, pri);
1327 * Copy shared buffers into a new sk_buff. We effectively do COW on
1328 * packets to handle cases where we have a local reader and forward
1329 * and a couple of other messy ones. The normal one is tcpdumping
1330 * a packet thats being forwarded.
1334 * skb_unshare - make a copy of a shared buffer
1335 * @skb: buffer to check
1336 * @pri: priority for memory allocation
1338 * If the socket buffer is a clone then this function creates a new
1339 * copy of the data, drops a reference count on the old copy and returns
1340 * the new copy with the reference count at 1. If the buffer is not a clone
1341 * the original buffer is returned. When called with a spinlock held or
1342 * from interrupt state @pri must be %GFP_ATOMIC
1344 * %NULL is returned on a memory allocation failure.
1346 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
1349 might_sleep_if(gfpflags_allow_blocking(pri));
1350 if (skb_cloned(skb)) {
1351 struct sk_buff *nskb = skb_copy(skb, pri);
1353 /* Free our shared copy */
1364 * skb_peek - peek at the head of an &sk_buff_head
1365 * @list_: list to peek at
1367 * Peek an &sk_buff. Unlike most other operations you _MUST_
1368 * be careful with this one. A peek leaves the buffer on the
1369 * list and someone else may run off with it. You must hold
1370 * the appropriate locks or have a private queue to do this.
1372 * Returns %NULL for an empty list or a pointer to the head element.
1373 * The reference count is not incremented and the reference is therefore
1374 * volatile. Use with caution.
1376 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
1378 struct sk_buff *skb = list_->next;
1380 if (skb == (struct sk_buff *)list_)
1386 * skb_peek_next - peek skb following the given one from a queue
1387 * @skb: skb to start from
1388 * @list_: list to peek at
1390 * Returns %NULL when the end of the list is met or a pointer to the
1391 * next element. The reference count is not incremented and the
1392 * reference is therefore volatile. Use with caution.
1394 static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
1395 const struct sk_buff_head *list_)
1397 struct sk_buff *next = skb->next;
1399 if (next == (struct sk_buff *)list_)
1405 * skb_peek_tail - peek at the tail of an &sk_buff_head
1406 * @list_: list to peek at
1408 * Peek an &sk_buff. Unlike most other operations you _MUST_
1409 * be careful with this one. A peek leaves the buffer on the
1410 * list and someone else may run off with it. You must hold
1411 * the appropriate locks or have a private queue to do this.
1413 * Returns %NULL for an empty list or a pointer to the tail element.
1414 * The reference count is not incremented and the reference is therefore
1415 * volatile. Use with caution.
1417 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
1419 struct sk_buff *skb = list_->prev;
1421 if (skb == (struct sk_buff *)list_)
1428 * skb_queue_len - get queue length
1429 * @list_: list to measure
1431 * Return the length of an &sk_buff queue.
1433 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
1439 * __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
1440 * @list: queue to initialize
1442 * This initializes only the list and queue length aspects of
1443 * an sk_buff_head object. This allows to initialize the list
1444 * aspects of an sk_buff_head without reinitializing things like
1445 * the spinlock. It can also be used for on-stack sk_buff_head
1446 * objects where the spinlock is known to not be used.
1448 static inline void __skb_queue_head_init(struct sk_buff_head *list)
1450 list->prev = list->next = (struct sk_buff *)list;
1455 * This function creates a split out lock class for each invocation;
1456 * this is needed for now since a whole lot of users of the skb-queue
1457 * infrastructure in drivers have different locking usage (in hardirq)
1458 * than the networking core (in softirq only). In the long run either the
1459 * network layer or drivers should need annotation to consolidate the
1460 * main types of usage into 3 classes.
1462 static inline void skb_queue_head_init(struct sk_buff_head *list)
1464 spin_lock_init(&list->lock);
1465 __skb_queue_head_init(list);
1468 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
1469 struct lock_class_key *class)
1471 skb_queue_head_init(list);
1472 lockdep_set_class(&list->lock, class);
1476 * Insert an sk_buff on a list.
1478 * The "__skb_xxxx()" functions are the non-atomic ones that
1479 * can only be called with interrupts disabled.
1481 void skb_insert(struct sk_buff *old, struct sk_buff *newsk,
1482 struct sk_buff_head *list);
1483 static inline void __skb_insert(struct sk_buff *newsk,
1484 struct sk_buff *prev, struct sk_buff *next,
1485 struct sk_buff_head *list)
1489 next->prev = prev->next = newsk;
1493 static inline void __skb_queue_splice(const struct sk_buff_head *list,
1494 struct sk_buff *prev,
1495 struct sk_buff *next)
1497 struct sk_buff *first = list->next;
1498 struct sk_buff *last = list->prev;
1508 * skb_queue_splice - join two skb lists, this is designed for stacks
1509 * @list: the new list to add
1510 * @head: the place to add it in the first list
1512 static inline void skb_queue_splice(const struct sk_buff_head *list,
1513 struct sk_buff_head *head)
1515 if (!skb_queue_empty(list)) {
1516 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1517 head->qlen += list->qlen;
1522 * skb_queue_splice_init - join two skb lists and reinitialise the emptied list
1523 * @list: the new list to add
1524 * @head: the place to add it in the first list
1526 * The list at @list is reinitialised
1528 static inline void skb_queue_splice_init(struct sk_buff_head *list,
1529 struct sk_buff_head *head)
1531 if (!skb_queue_empty(list)) {
1532 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1533 head->qlen += list->qlen;
1534 __skb_queue_head_init(list);
1539 * skb_queue_splice_tail - join two skb lists, each list being a queue
1540 * @list: the new list to add
1541 * @head: the place to add it in the first list
1543 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1544 struct sk_buff_head *head)
1546 if (!skb_queue_empty(list)) {
1547 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1548 head->qlen += list->qlen;
1553 * skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
1554 * @list: the new list to add
1555 * @head: the place to add it in the first list
1557 * Each of the lists is a queue.
1558 * The list at @list is reinitialised
1560 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1561 struct sk_buff_head *head)
1563 if (!skb_queue_empty(list)) {
1564 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1565 head->qlen += list->qlen;
1566 __skb_queue_head_init(list);
1571 * __skb_queue_after - queue a buffer at the list head
1572 * @list: list to use
1573 * @prev: place after this buffer
1574 * @newsk: buffer to queue
1576 * Queue a buffer int the middle of a list. This function takes no locks
1577 * and you must therefore hold required locks before calling it.
1579 * A buffer cannot be placed on two lists at the same time.
1581 static inline void __skb_queue_after(struct sk_buff_head *list,
1582 struct sk_buff *prev,
1583 struct sk_buff *newsk)
1585 __skb_insert(newsk, prev, prev->next, list);
1588 void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1589 struct sk_buff_head *list);
1591 static inline void __skb_queue_before(struct sk_buff_head *list,
1592 struct sk_buff *next,
1593 struct sk_buff *newsk)
1595 __skb_insert(newsk, next->prev, next, list);
1599 * __skb_queue_head - queue a buffer at the list head
1600 * @list: list to use
1601 * @newsk: buffer to queue
1603 * Queue a buffer at the start of a list. This function takes no locks
1604 * and you must therefore hold required locks before calling it.
1606 * A buffer cannot be placed on two lists at the same time.
1608 void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
1609 static inline void __skb_queue_head(struct sk_buff_head *list,
1610 struct sk_buff *newsk)
1612 __skb_queue_after(list, (struct sk_buff *)list, newsk);
1616 * __skb_queue_tail - queue a buffer at the list tail
1617 * @list: list to use
1618 * @newsk: buffer to queue
1620 * Queue a buffer at the end of a list. This function takes no locks
1621 * and you must therefore hold required locks before calling it.
1623 * A buffer cannot be placed on two lists at the same time.
1625 void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
1626 static inline void __skb_queue_tail(struct sk_buff_head *list,
1627 struct sk_buff *newsk)
1629 __skb_queue_before(list, (struct sk_buff *)list, newsk);
1633 * remove sk_buff from list. _Must_ be called atomically, and with
1636 void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
1637 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1639 struct sk_buff *next, *prev;
1644 skb->next = skb->prev = NULL;
1650 * __skb_dequeue - remove from the head of the queue
1651 * @list: list to dequeue from
1653 * Remove the head of the list. This function does not take any locks
1654 * so must be used with appropriate locks held only. The head item is
1655 * returned or %NULL if the list is empty.
1657 struct sk_buff *skb_dequeue(struct sk_buff_head *list);
1658 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1660 struct sk_buff *skb = skb_peek(list);
1662 __skb_unlink(skb, list);
1667 * __skb_dequeue_tail - remove from the tail of the queue
1668 * @list: list to dequeue from
1670 * Remove the tail of the list. This function does not take any locks
1671 * so must be used with appropriate locks held only. The tail item is
1672 * returned or %NULL if the list is empty.
1674 struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
1675 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1677 struct sk_buff *skb = skb_peek_tail(list);
1679 __skb_unlink(skb, list);
1684 static inline bool skb_is_nonlinear(const struct sk_buff *skb)
1686 return skb->data_len;
1689 static inline unsigned int skb_headlen(const struct sk_buff *skb)
1691 return skb->len - skb->data_len;
1694 static inline int skb_pagelen(const struct sk_buff *skb)
1698 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
1699 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
1700 return len + skb_headlen(skb);
1704 * __skb_fill_page_desc - initialise a paged fragment in an skb
1705 * @skb: buffer containing fragment to be initialised
1706 * @i: paged fragment index to initialise
1707 * @page: the page to use for this fragment
1708 * @off: the offset to the data with @page
1709 * @size: the length of the data
1711 * Initialises the @i'th fragment of @skb to point to &size bytes at
1712 * offset @off within @page.
1714 * Does not take any additional reference on the fragment.
1716 static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
1717 struct page *page, int off, int size)
1719 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
1722 * Propagate page pfmemalloc to the skb if we can. The problem is
1723 * that not all callers have unique ownership of the page but rely
1724 * on page_is_pfmemalloc doing the right thing(tm).
1726 frag->page.p = page;
1727 frag->page_offset = off;
1728 skb_frag_size_set(frag, size);
1730 page = compound_head(page);
1731 if (page_is_pfmemalloc(page))
1732 skb->pfmemalloc = true;
1736 * skb_fill_page_desc - initialise a paged fragment in an skb
1737 * @skb: buffer containing fragment to be initialised
1738 * @i: paged fragment index to initialise
1739 * @page: the page to use for this fragment
1740 * @off: the offset to the data with @page
1741 * @size: the length of the data
1743 * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
1744 * @skb to point to @size bytes at offset @off within @page. In
1745 * addition updates @skb such that @i is the last fragment.
1747 * Does not take any additional reference on the fragment.
1749 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
1750 struct page *page, int off, int size)
1752 __skb_fill_page_desc(skb, i, page, off, size);
1753 skb_shinfo(skb)->nr_frags = i + 1;
1756 void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page, int off,
1757 int size, unsigned int truesize);
1759 void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
1760 unsigned int truesize);
1762 #define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
1763 #define SKB_FRAG_ASSERT(skb) BUG_ON(skb_has_frag_list(skb))
1764 #define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
1766 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1767 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1769 return skb->head + skb->tail;
1772 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1774 skb->tail = skb->data - skb->head;
1777 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1779 skb_reset_tail_pointer(skb);
1780 skb->tail += offset;
1783 #else /* NET_SKBUFF_DATA_USES_OFFSET */
1784 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1789 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1791 skb->tail = skb->data;
1794 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1796 skb->tail = skb->data + offset;
1799 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
1802 * Add data to an sk_buff
1804 unsigned char *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
1805 unsigned char *skb_put(struct sk_buff *skb, unsigned int len);
1806 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
1808 unsigned char *tmp = skb_tail_pointer(skb);
1809 SKB_LINEAR_ASSERT(skb);
1815 unsigned char *skb_push(struct sk_buff *skb, unsigned int len);
1816 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
1823 unsigned char *skb_pull(struct sk_buff *skb, unsigned int len);
1824 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
1827 BUG_ON(skb->len < skb->data_len);
1828 return skb->data += len;
1831 static inline unsigned char *skb_pull_inline(struct sk_buff *skb, unsigned int len)
1833 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
1836 unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
1838 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
1840 if (len > skb_headlen(skb) &&
1841 !__pskb_pull_tail(skb, len - skb_headlen(skb)))
1844 return skb->data += len;
1847 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
1849 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
1852 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
1854 if (likely(len <= skb_headlen(skb)))
1856 if (unlikely(len > skb->len))
1858 return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
1862 * skb_headroom - bytes at buffer head
1863 * @skb: buffer to check
1865 * Return the number of bytes of free space at the head of an &sk_buff.
1867 static inline unsigned int skb_headroom(const struct sk_buff *skb)
1869 return skb->data - skb->head;
1873 * skb_tailroom - bytes at buffer end
1874 * @skb: buffer to check
1876 * Return the number of bytes of free space at the tail of an sk_buff
1878 static inline int skb_tailroom(const struct sk_buff *skb)
1880 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
1884 * skb_availroom - bytes at buffer end
1885 * @skb: buffer to check
1887 * Return the number of bytes of free space at the tail of an sk_buff
1888 * allocated by sk_stream_alloc()
1890 static inline int skb_availroom(const struct sk_buff *skb)
1892 if (skb_is_nonlinear(skb))
1895 return skb->end - skb->tail - skb->reserved_tailroom;
1899 * skb_reserve - adjust headroom
1900 * @skb: buffer to alter
1901 * @len: bytes to move
1903 * Increase the headroom of an empty &sk_buff by reducing the tail
1904 * room. This is only allowed for an empty buffer.
1906 static inline void skb_reserve(struct sk_buff *skb, int len)
1913 * skb_tailroom_reserve - adjust reserved_tailroom
1914 * @skb: buffer to alter
1915 * @mtu: maximum amount of headlen permitted
1916 * @needed_tailroom: minimum amount of reserved_tailroom
1918 * Set reserved_tailroom so that headlen can be as large as possible but
1919 * not larger than mtu and tailroom cannot be smaller than
1921 * The required headroom should already have been reserved before using
1924 static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
1925 unsigned int needed_tailroom)
1927 SKB_LINEAR_ASSERT(skb);
1928 if (mtu < skb_tailroom(skb) - needed_tailroom)
1929 /* use at most mtu */
1930 skb->reserved_tailroom = skb_tailroom(skb) - mtu;
1932 /* use up to all available space */
1933 skb->reserved_tailroom = needed_tailroom;
1936 #define ENCAP_TYPE_ETHER 0
1937 #define ENCAP_TYPE_IPPROTO 1
1939 static inline void skb_set_inner_protocol(struct sk_buff *skb,
1942 skb->inner_protocol = protocol;
1943 skb->inner_protocol_type = ENCAP_TYPE_ETHER;
1946 static inline void skb_set_inner_ipproto(struct sk_buff *skb,
1949 skb->inner_ipproto = ipproto;
1950 skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
1953 static inline void skb_reset_inner_headers(struct sk_buff *skb)
1955 skb->inner_mac_header = skb->mac_header;
1956 skb->inner_network_header = skb->network_header;
1957 skb->inner_transport_header = skb->transport_header;
1960 static inline void skb_reset_mac_len(struct sk_buff *skb)
1962 skb->mac_len = skb->network_header - skb->mac_header;
1965 static inline unsigned char *skb_inner_transport_header(const struct sk_buff
1968 return skb->head + skb->inner_transport_header;
1971 static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
1973 skb->inner_transport_header = skb->data - skb->head;
1976 static inline void skb_set_inner_transport_header(struct sk_buff *skb,
1979 skb_reset_inner_transport_header(skb);
1980 skb->inner_transport_header += offset;
1983 static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
1985 return skb->head + skb->inner_network_header;
1988 static inline void skb_reset_inner_network_header(struct sk_buff *skb)
1990 skb->inner_network_header = skb->data - skb->head;
1993 static inline void skb_set_inner_network_header(struct sk_buff *skb,
1996 skb_reset_inner_network_header(skb);
1997 skb->inner_network_header += offset;
2000 static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
2002 return skb->head + skb->inner_mac_header;
2005 static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
2007 skb->inner_mac_header = skb->data - skb->head;
2010 static inline void skb_set_inner_mac_header(struct sk_buff *skb,
2013 skb_reset_inner_mac_header(skb);
2014 skb->inner_mac_header += offset;
2016 static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
2018 return skb->transport_header != (typeof(skb->transport_header))~0U;
2021 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
2023 return skb->head + skb->transport_header;
2026 static inline void skb_reset_transport_header(struct sk_buff *skb)
2028 skb->transport_header = skb->data - skb->head;
2031 static inline void skb_set_transport_header(struct sk_buff *skb,
2034 skb_reset_transport_header(skb);
2035 skb->transport_header += offset;
2038 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
2040 return skb->head + skb->network_header;
2043 static inline void skb_reset_network_header(struct sk_buff *skb)
2045 skb->network_header = skb->data - skb->head;
2048 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
2050 skb_reset_network_header(skb);
2051 skb->network_header += offset;
2054 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
2056 return skb->head + skb->mac_header;
2059 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2061 return skb->mac_header != (typeof(skb->mac_header))~0U;
2064 static inline void skb_reset_mac_header(struct sk_buff *skb)
2066 skb->mac_header = skb->data - skb->head;
2069 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
2071 skb_reset_mac_header(skb);
2072 skb->mac_header += offset;
2075 static inline void skb_pop_mac_header(struct sk_buff *skb)
2077 skb->mac_header = skb->network_header;
2080 static inline void skb_probe_transport_header(struct sk_buff *skb,
2081 const int offset_hint)
2083 struct flow_keys keys;
2085 if (skb_transport_header_was_set(skb))
2087 else if (skb_flow_dissect_flow_keys(skb, &keys, 0))
2088 skb_set_transport_header(skb, keys.control.thoff);
2090 skb_set_transport_header(skb, offset_hint);
2093 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
2095 if (skb_mac_header_was_set(skb)) {
2096 const unsigned char *old_mac = skb_mac_header(skb);
2098 skb_set_mac_header(skb, -skb->mac_len);
2099 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
2103 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
2105 return skb->csum_start - skb_headroom(skb);
2108 static inline int skb_transport_offset(const struct sk_buff *skb)
2110 return skb_transport_header(skb) - skb->data;
2113 static inline u32 skb_network_header_len(const struct sk_buff *skb)
2115 return skb->transport_header - skb->network_header;
2118 static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
2120 return skb->inner_transport_header - skb->inner_network_header;
2123 static inline int skb_network_offset(const struct sk_buff *skb)
2125 return skb_network_header(skb) - skb->data;
2128 static inline int skb_inner_network_offset(const struct sk_buff *skb)
2130 return skb_inner_network_header(skb) - skb->data;
2133 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
2135 return pskb_may_pull(skb, skb_network_offset(skb) + len);
2139 * CPUs often take a performance hit when accessing unaligned memory
2140 * locations. The actual performance hit varies, it can be small if the
2141 * hardware handles it or large if we have to take an exception and fix it
2144 * Since an ethernet header is 14 bytes network drivers often end up with
2145 * the IP header at an unaligned offset. The IP header can be aligned by
2146 * shifting the start of the packet by 2 bytes. Drivers should do this
2149 * skb_reserve(skb, NET_IP_ALIGN);
2151 * The downside to this alignment of the IP header is that the DMA is now
2152 * unaligned. On some architectures the cost of an unaligned DMA is high
2153 * and this cost outweighs the gains made by aligning the IP header.
2155 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
2158 #ifndef NET_IP_ALIGN
2159 #define NET_IP_ALIGN 2
2163 * The networking layer reserves some headroom in skb data (via
2164 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
2165 * the header has to grow. In the default case, if the header has to grow
2166 * 32 bytes or less we avoid the reallocation.
2168 * Unfortunately this headroom changes the DMA alignment of the resulting
2169 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
2170 * on some architectures. An architecture can override this value,
2171 * perhaps setting it to a cacheline in size (since that will maintain
2172 * cacheline alignment of the DMA). It must be a power of 2.
2174 * Various parts of the networking layer expect at least 32 bytes of
2175 * headroom, you should not reduce this.
2177 * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
2178 * to reduce average number of cache lines per packet.
2179 * get_rps_cpus() for example only access one 64 bytes aligned block :
2180 * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
2183 #define NET_SKB_PAD max(32, L1_CACHE_BYTES)
2186 int ___pskb_trim(struct sk_buff *skb, unsigned int len);
2188 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
2190 if (unlikely(skb_is_nonlinear(skb))) {
2195 skb_set_tail_pointer(skb, len);
2198 void skb_trim(struct sk_buff *skb, unsigned int len);
2200 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
2203 return ___pskb_trim(skb, len);
2204 __skb_trim(skb, len);
2208 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
2210 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
2214 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
2215 * @skb: buffer to alter
2218 * This is identical to pskb_trim except that the caller knows that
2219 * the skb is not cloned so we should never get an error due to out-
2222 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
2224 int err = pskb_trim(skb, len);
2229 * skb_orphan - orphan a buffer
2230 * @skb: buffer to orphan
2232 * If a buffer currently has an owner then we call the owner's
2233 * destructor function and make the @skb unowned. The buffer continues
2234 * to exist but is no longer charged to its former owner.
2236 static inline void skb_orphan(struct sk_buff *skb)
2238 if (skb->destructor) {
2239 skb->destructor(skb);
2240 skb->destructor = NULL;
2248 * skb_orphan_frags - orphan the frags contained in a buffer
2249 * @skb: buffer to orphan frags from
2250 * @gfp_mask: allocation mask for replacement pages
2252 * For each frag in the SKB which needs a destructor (i.e. has an
2253 * owner) create a copy of that frag and release the original
2254 * page by calling the destructor.
2256 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
2258 if (likely(!(skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY)))
2260 return skb_copy_ubufs(skb, gfp_mask);
2264 * __skb_queue_purge - empty a list
2265 * @list: list to empty
2267 * Delete all buffers on an &sk_buff list. Each buffer is removed from
2268 * the list and one reference dropped. This function does not take the
2269 * list lock and the caller must hold the relevant locks to use it.
2271 void skb_queue_purge(struct sk_buff_head *list);
2272 static inline void __skb_queue_purge(struct sk_buff_head *list)
2274 struct sk_buff *skb;
2275 while ((skb = __skb_dequeue(list)) != NULL)
2279 void *netdev_alloc_frag(unsigned int fragsz);
2281 struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
2285 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
2286 * @dev: network device to receive on
2287 * @length: length to allocate
2289 * Allocate a new &sk_buff and assign it a usage count of one. The
2290 * buffer has unspecified headroom built in. Users should allocate
2291 * the headroom they think they need without accounting for the
2292 * built in space. The built in space is used for optimisations.
2294 * %NULL is returned if there is no free memory. Although this function
2295 * allocates memory it can be called from an interrupt.
2297 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
2298 unsigned int length)
2300 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
2303 /* legacy helper around __netdev_alloc_skb() */
2304 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
2307 return __netdev_alloc_skb(NULL, length, gfp_mask);
2310 /* legacy helper around netdev_alloc_skb() */
2311 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
2313 return netdev_alloc_skb(NULL, length);
2317 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
2318 unsigned int length, gfp_t gfp)
2320 struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
2322 if (NET_IP_ALIGN && skb)
2323 skb_reserve(skb, NET_IP_ALIGN);
2327 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
2328 unsigned int length)
2330 return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
2333 static inline void skb_free_frag(void *addr)
2335 __free_page_frag(addr);
2338 void *napi_alloc_frag(unsigned int fragsz);
2339 struct sk_buff *__napi_alloc_skb(struct napi_struct *napi,
2340 unsigned int length, gfp_t gfp_mask);
2341 static inline struct sk_buff *napi_alloc_skb(struct napi_struct *napi,
2342 unsigned int length)
2344 return __napi_alloc_skb(napi, length, GFP_ATOMIC);
2348 * __dev_alloc_pages - allocate page for network Rx
2349 * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2350 * @order: size of the allocation
2352 * Allocate a new page.
2354 * %NULL is returned if there is no free memory.
2356 static inline struct page *__dev_alloc_pages(gfp_t gfp_mask,
2359 /* This piece of code contains several assumptions.
2360 * 1. This is for device Rx, therefor a cold page is preferred.
2361 * 2. The expectation is the user wants a compound page.
2362 * 3. If requesting a order 0 page it will not be compound
2363 * due to the check to see if order has a value in prep_new_page
2364 * 4. __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
2365 * code in gfp_to_alloc_flags that should be enforcing this.
2367 gfp_mask |= __GFP_COLD | __GFP_COMP | __GFP_MEMALLOC;
2369 return alloc_pages_node(NUMA_NO_NODE, gfp_mask, order);
2372 static inline struct page *dev_alloc_pages(unsigned int order)
2374 return __dev_alloc_pages(GFP_ATOMIC, order);
2378 * __dev_alloc_page - allocate a page for network Rx
2379 * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2381 * Allocate a new page.
2383 * %NULL is returned if there is no free memory.
2385 static inline struct page *__dev_alloc_page(gfp_t gfp_mask)
2387 return __dev_alloc_pages(gfp_mask, 0);
2390 static inline struct page *dev_alloc_page(void)
2392 return __dev_alloc_page(GFP_ATOMIC);
2396 * skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
2397 * @page: The page that was allocated from skb_alloc_page
2398 * @skb: The skb that may need pfmemalloc set
2400 static inline void skb_propagate_pfmemalloc(struct page *page,
2401 struct sk_buff *skb)
2403 if (page_is_pfmemalloc(page))
2404 skb->pfmemalloc = true;
2408 * skb_frag_page - retrieve the page referred to by a paged fragment
2409 * @frag: the paged fragment
2411 * Returns the &struct page associated with @frag.
2413 static inline struct page *skb_frag_page(const skb_frag_t *frag)
2415 return frag->page.p;
2419 * __skb_frag_ref - take an addition reference on a paged fragment.
2420 * @frag: the paged fragment
2422 * Takes an additional reference on the paged fragment @frag.
2424 static inline void __skb_frag_ref(skb_frag_t *frag)
2426 get_page(skb_frag_page(frag));
2430 * skb_frag_ref - take an addition reference on a paged fragment of an skb.
2432 * @f: the fragment offset.
2434 * Takes an additional reference on the @f'th paged fragment of @skb.
2436 static inline void skb_frag_ref(struct sk_buff *skb, int f)
2438 __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
2442 * __skb_frag_unref - release a reference on a paged fragment.
2443 * @frag: the paged fragment
2445 * Releases a reference on the paged fragment @frag.
2447 static inline void __skb_frag_unref(skb_frag_t *frag)
2449 put_page(skb_frag_page(frag));
2453 * skb_frag_unref - release a reference on a paged fragment of an skb.
2455 * @f: the fragment offset
2457 * Releases a reference on the @f'th paged fragment of @skb.
2459 static inline void skb_frag_unref(struct sk_buff *skb, int f)
2461 __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
2465 * skb_frag_address - gets the address of the data contained in a paged fragment
2466 * @frag: the paged fragment buffer
2468 * Returns the address of the data within @frag. The page must already
2471 static inline void *skb_frag_address(const skb_frag_t *frag)
2473 return page_address(skb_frag_page(frag)) + frag->page_offset;
2477 * skb_frag_address_safe - gets the address of the data contained in a paged fragment
2478 * @frag: the paged fragment buffer
2480 * Returns the address of the data within @frag. Checks that the page
2481 * is mapped and returns %NULL otherwise.
2483 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
2485 void *ptr = page_address(skb_frag_page(frag));
2489 return ptr + frag->page_offset;
2493 * __skb_frag_set_page - sets the page contained in a paged fragment
2494 * @frag: the paged fragment
2495 * @page: the page to set
2497 * Sets the fragment @frag to contain @page.
2499 static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
2501 frag->page.p = page;
2505 * skb_frag_set_page - sets the page contained in a paged fragment of an skb
2507 * @f: the fragment offset
2508 * @page: the page to set
2510 * Sets the @f'th fragment of @skb to contain @page.
2512 static inline void skb_frag_set_page(struct sk_buff *skb, int f,
2515 __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
2518 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
2521 * skb_frag_dma_map - maps a paged fragment via the DMA API
2522 * @dev: the device to map the fragment to
2523 * @frag: the paged fragment to map
2524 * @offset: the offset within the fragment (starting at the
2525 * fragment's own offset)
2526 * @size: the number of bytes to map
2527 * @dir: the direction of the mapping (%PCI_DMA_*)
2529 * Maps the page associated with @frag to @device.
2531 static inline dma_addr_t skb_frag_dma_map(struct device *dev,
2532 const skb_frag_t *frag,
2533 size_t offset, size_t size,
2534 enum dma_data_direction dir)
2536 return dma_map_page(dev, skb_frag_page(frag),
2537 frag->page_offset + offset, size, dir);
2540 static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
2543 return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
2547 static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
2550 return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
2555 * skb_clone_writable - is the header of a clone writable
2556 * @skb: buffer to check
2557 * @len: length up to which to write
2559 * Returns true if modifying the header part of the cloned buffer
2560 * does not requires the data to be copied.
2562 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
2564 return !skb_header_cloned(skb) &&
2565 skb_headroom(skb) + len <= skb->hdr_len;
2568 static inline int skb_try_make_writable(struct sk_buff *skb,
2569 unsigned int write_len)
2571 return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
2572 pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
2575 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
2580 if (headroom > skb_headroom(skb))
2581 delta = headroom - skb_headroom(skb);
2583 if (delta || cloned)
2584 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
2590 * skb_cow - copy header of skb when it is required
2591 * @skb: buffer to cow
2592 * @headroom: needed headroom
2594 * If the skb passed lacks sufficient headroom or its data part
2595 * is shared, data is reallocated. If reallocation fails, an error
2596 * is returned and original skb is not changed.
2598 * The result is skb with writable area skb->head...skb->tail
2599 * and at least @headroom of space at head.
2601 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
2603 return __skb_cow(skb, headroom, skb_cloned(skb));
2607 * skb_cow_head - skb_cow but only making the head writable
2608 * @skb: buffer to cow
2609 * @headroom: needed headroom
2611 * This function is identical to skb_cow except that we replace the
2612 * skb_cloned check by skb_header_cloned. It should be used when
2613 * you only need to push on some header and do not need to modify
2616 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
2618 return __skb_cow(skb, headroom, skb_header_cloned(skb));
2622 * skb_padto - pad an skbuff up to a minimal size
2623 * @skb: buffer to pad
2624 * @len: minimal length
2626 * Pads up a buffer to ensure the trailing bytes exist and are
2627 * blanked. If the buffer already contains sufficient data it
2628 * is untouched. Otherwise it is extended. Returns zero on
2629 * success. The skb is freed on error.
2631 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
2633 unsigned int size = skb->len;
2634 if (likely(size >= len))
2636 return skb_pad(skb, len - size);
2640 * skb_put_padto - increase size and pad an skbuff up to a minimal size
2641 * @skb: buffer to pad
2642 * @len: minimal length
2644 * Pads up a buffer to ensure the trailing bytes exist and are
2645 * blanked. If the buffer already contains sufficient data it
2646 * is untouched. Otherwise it is extended. Returns zero on
2647 * success. The skb is freed on error.
2649 static inline int skb_put_padto(struct sk_buff *skb, unsigned int len)
2651 unsigned int size = skb->len;
2653 if (unlikely(size < len)) {
2655 if (skb_pad(skb, len))
2657 __skb_put(skb, len);
2662 static inline int skb_add_data(struct sk_buff *skb,
2663 struct iov_iter *from, int copy)
2665 const int off = skb->len;
2667 if (skb->ip_summed == CHECKSUM_NONE) {
2669 if (csum_and_copy_from_iter(skb_put(skb, copy), copy,
2670 &csum, from) == copy) {
2671 skb->csum = csum_block_add(skb->csum, csum, off);
2674 } else if (copy_from_iter(skb_put(skb, copy), copy, from) == copy)
2677 __skb_trim(skb, off);
2681 static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
2682 const struct page *page, int off)
2685 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
2687 return page == skb_frag_page(frag) &&
2688 off == frag->page_offset + skb_frag_size(frag);
2693 static inline int __skb_linearize(struct sk_buff *skb)
2695 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
2699 * skb_linearize - convert paged skb to linear one
2700 * @skb: buffer to linarize
2702 * If there is no free memory -ENOMEM is returned, otherwise zero
2703 * is returned and the old skb data released.
2705 static inline int skb_linearize(struct sk_buff *skb)
2707 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
2711 * skb_has_shared_frag - can any frag be overwritten
2712 * @skb: buffer to test
2714 * Return true if the skb has at least one frag that might be modified
2715 * by an external entity (as in vmsplice()/sendfile())
2717 static inline bool skb_has_shared_frag(const struct sk_buff *skb)
2719 return skb_is_nonlinear(skb) &&
2720 skb_shinfo(skb)->tx_flags & SKBTX_SHARED_FRAG;
2724 * skb_linearize_cow - make sure skb is linear and writable
2725 * @skb: buffer to process
2727 * If there is no free memory -ENOMEM is returned, otherwise zero
2728 * is returned and the old skb data released.
2730 static inline int skb_linearize_cow(struct sk_buff *skb)
2732 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
2733 __skb_linearize(skb) : 0;
2737 * skb_postpull_rcsum - update checksum for received skb after pull
2738 * @skb: buffer to update
2739 * @start: start of data before pull
2740 * @len: length of data pulled
2742 * After doing a pull on a received packet, you need to call this to
2743 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
2744 * CHECKSUM_NONE so that it can be recomputed from scratch.
2747 static inline void skb_postpull_rcsum(struct sk_buff *skb,
2748 const void *start, unsigned int len)
2750 if (skb->ip_summed == CHECKSUM_COMPLETE)
2751 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
2752 else if (skb->ip_summed == CHECKSUM_PARTIAL &&
2753 skb_checksum_start_offset(skb) < 0)
2754 skb->ip_summed = CHECKSUM_NONE;
2757 unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
2759 static inline void skb_postpush_rcsum(struct sk_buff *skb,
2760 const void *start, unsigned int len)
2762 /* For performing the reverse operation to skb_postpull_rcsum(),
2763 * we can instead of ...
2765 * skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
2767 * ... just use this equivalent version here to save a few
2768 * instructions. Feeding csum of 0 in csum_partial() and later
2769 * on adding skb->csum is equivalent to feed skb->csum in the
2772 if (skb->ip_summed == CHECKSUM_COMPLETE)
2773 skb->csum = csum_partial(start, len, skb->csum);
2777 * skb_push_rcsum - push skb and update receive checksum
2778 * @skb: buffer to update
2779 * @len: length of data pulled
2781 * This function performs an skb_push on the packet and updates
2782 * the CHECKSUM_COMPLETE checksum. It should be used on
2783 * receive path processing instead of skb_push unless you know
2784 * that the checksum difference is zero (e.g., a valid IP header)
2785 * or you are setting ip_summed to CHECKSUM_NONE.
2787 static inline unsigned char *skb_push_rcsum(struct sk_buff *skb,
2791 skb_postpush_rcsum(skb, skb->data, len);
2796 * pskb_trim_rcsum - trim received skb and update checksum
2797 * @skb: buffer to trim
2800 * This is exactly the same as pskb_trim except that it ensures the
2801 * checksum of received packets are still valid after the operation.
2804 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
2806 if (likely(len >= skb->len))
2808 if (skb->ip_summed == CHECKSUM_COMPLETE)
2809 skb->ip_summed = CHECKSUM_NONE;
2810 return __pskb_trim(skb, len);
2813 #define skb_queue_walk(queue, skb) \
2814 for (skb = (queue)->next; \
2815 skb != (struct sk_buff *)(queue); \
2818 #define skb_queue_walk_safe(queue, skb, tmp) \
2819 for (skb = (queue)->next, tmp = skb->next; \
2820 skb != (struct sk_buff *)(queue); \
2821 skb = tmp, tmp = skb->next)
2823 #define skb_queue_walk_from(queue, skb) \
2824 for (; skb != (struct sk_buff *)(queue); \
2827 #define skb_queue_walk_from_safe(queue, skb, tmp) \
2828 for (tmp = skb->next; \
2829 skb != (struct sk_buff *)(queue); \
2830 skb = tmp, tmp = skb->next)
2832 #define skb_queue_reverse_walk(queue, skb) \
2833 for (skb = (queue)->prev; \
2834 skb != (struct sk_buff *)(queue); \
2837 #define skb_queue_reverse_walk_safe(queue, skb, tmp) \
2838 for (skb = (queue)->prev, tmp = skb->prev; \
2839 skb != (struct sk_buff *)(queue); \
2840 skb = tmp, tmp = skb->prev)
2842 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp) \
2843 for (tmp = skb->prev; \
2844 skb != (struct sk_buff *)(queue); \
2845 skb = tmp, tmp = skb->prev)
2847 static inline bool skb_has_frag_list(const struct sk_buff *skb)
2849 return skb_shinfo(skb)->frag_list != NULL;
2852 static inline void skb_frag_list_init(struct sk_buff *skb)
2854 skb_shinfo(skb)->frag_list = NULL;
2857 #define skb_walk_frags(skb, iter) \
2858 for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
2860 struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
2861 int *peeked, int *off, int *err);
2862 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags, int noblock,
2864 unsigned int datagram_poll(struct file *file, struct socket *sock,
2865 struct poll_table_struct *wait);
2866 int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
2867 struct iov_iter *to, int size);
2868 static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
2869 struct msghdr *msg, int size)
2871 return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
2873 int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
2874 struct msghdr *msg);
2875 int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
2876 struct iov_iter *from, int len);
2877 int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
2878 void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
2879 void skb_free_datagram_locked(struct sock *sk, struct sk_buff *skb);
2880 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
2881 int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
2882 int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
2883 __wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
2884 int len, __wsum csum);
2885 ssize_t skb_socket_splice(struct sock *sk,
2886 struct pipe_inode_info *pipe,
2887 struct splice_pipe_desc *spd);
2888 int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
2889 struct pipe_inode_info *pipe, unsigned int len,
2891 ssize_t (*splice_cb)(struct sock *,
2892 struct pipe_inode_info *,
2893 struct splice_pipe_desc *));
2894 void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
2895 unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
2896 int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
2898 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
2899 int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
2900 void skb_scrub_packet(struct sk_buff *skb, bool xnet);
2901 unsigned int skb_gso_transport_seglen(const struct sk_buff *skb);
2902 struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
2903 struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
2904 int skb_ensure_writable(struct sk_buff *skb, int write_len);
2905 int skb_vlan_pop(struct sk_buff *skb);
2906 int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
2908 static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
2910 return copy_from_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
2913 static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
2915 return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
2918 struct skb_checksum_ops {
2919 __wsum (*update)(const void *mem, int len, __wsum wsum);
2920 __wsum (*combine)(__wsum csum, __wsum csum2, int offset, int len);
2923 __wsum __skb_checksum(const struct sk_buff *skb, int offset, int len,
2924 __wsum csum, const struct skb_checksum_ops *ops);
2925 __wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
2928 static inline void * __must_check
2929 __skb_header_pointer(const struct sk_buff *skb, int offset,
2930 int len, void *data, int hlen, void *buffer)
2932 if (hlen - offset >= len)
2933 return data + offset;
2936 skb_copy_bits(skb, offset, buffer, len) < 0)
2942 static inline void * __must_check
2943 skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
2945 return __skb_header_pointer(skb, offset, len, skb->data,
2946 skb_headlen(skb), buffer);
2950 * skb_needs_linearize - check if we need to linearize a given skb
2951 * depending on the given device features.
2952 * @skb: socket buffer to check
2953 * @features: net device features
2955 * Returns true if either:
2956 * 1. skb has frag_list and the device doesn't support FRAGLIST, or
2957 * 2. skb is fragmented and the device does not support SG.
2959 static inline bool skb_needs_linearize(struct sk_buff *skb,
2960 netdev_features_t features)
2962 return skb_is_nonlinear(skb) &&
2963 ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
2964 (skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
2967 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
2969 const unsigned int len)
2971 memcpy(to, skb->data, len);
2974 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
2975 const int offset, void *to,
2976 const unsigned int len)
2978 memcpy(to, skb->data + offset, len);
2981 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
2983 const unsigned int len)
2985 memcpy(skb->data, from, len);
2988 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
2991 const unsigned int len)
2993 memcpy(skb->data + offset, from, len);
2996 void skb_init(void);
2998 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
3004 * skb_get_timestamp - get timestamp from a skb
3005 * @skb: skb to get stamp from
3006 * @stamp: pointer to struct timeval to store stamp in
3008 * Timestamps are stored in the skb as offsets to a base timestamp.
3009 * This function converts the offset back to a struct timeval and stores
3012 static inline void skb_get_timestamp(const struct sk_buff *skb,
3013 struct timeval *stamp)
3015 *stamp = ktime_to_timeval(skb->tstamp);
3018 static inline void skb_get_timestampns(const struct sk_buff *skb,
3019 struct timespec *stamp)
3021 *stamp = ktime_to_timespec(skb->tstamp);
3024 static inline void __net_timestamp(struct sk_buff *skb)
3026 skb->tstamp = ktime_get_real();
3029 static inline ktime_t net_timedelta(ktime_t t)
3031 return ktime_sub(ktime_get_real(), t);
3034 static inline ktime_t net_invalid_timestamp(void)
3036 return ktime_set(0, 0);
3039 struct sk_buff *skb_clone_sk(struct sk_buff *skb);
3041 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
3043 void skb_clone_tx_timestamp(struct sk_buff *skb);
3044 bool skb_defer_rx_timestamp(struct sk_buff *skb);
3046 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
3048 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
3052 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
3057 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
3060 * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
3062 * PHY drivers may accept clones of transmitted packets for
3063 * timestamping via their phy_driver.txtstamp method. These drivers
3064 * must call this function to return the skb back to the stack with a
3067 * @skb: clone of the the original outgoing packet
3068 * @hwtstamps: hardware time stamps
3071 void skb_complete_tx_timestamp(struct sk_buff *skb,
3072 struct skb_shared_hwtstamps *hwtstamps);
3074 void __skb_tstamp_tx(struct sk_buff *orig_skb,
3075 struct skb_shared_hwtstamps *hwtstamps,
3076 struct sock *sk, int tstype);
3079 * skb_tstamp_tx - queue clone of skb with send time stamps
3080 * @orig_skb: the original outgoing packet
3081 * @hwtstamps: hardware time stamps, may be NULL if not available
3083 * If the skb has a socket associated, then this function clones the
3084 * skb (thus sharing the actual data and optional structures), stores
3085 * the optional hardware time stamping information (if non NULL) or
3086 * generates a software time stamp (otherwise), then queues the clone
3087 * to the error queue of the socket. Errors are silently ignored.
3089 void skb_tstamp_tx(struct sk_buff *orig_skb,
3090 struct skb_shared_hwtstamps *hwtstamps);
3092 static inline void sw_tx_timestamp(struct sk_buff *skb)
3094 if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP &&
3095 !(skb_shinfo(skb)->tx_flags & SKBTX_IN_PROGRESS))
3096 skb_tstamp_tx(skb, NULL);
3100 * skb_tx_timestamp() - Driver hook for transmit timestamping
3102 * Ethernet MAC Drivers should call this function in their hard_xmit()
3103 * function immediately before giving the sk_buff to the MAC hardware.
3105 * Specifically, one should make absolutely sure that this function is
3106 * called before TX completion of this packet can trigger. Otherwise
3107 * the packet could potentially already be freed.
3109 * @skb: A socket buffer.
3111 static inline void skb_tx_timestamp(struct sk_buff *skb)
3113 skb_clone_tx_timestamp(skb);
3114 sw_tx_timestamp(skb);
3118 * skb_complete_wifi_ack - deliver skb with wifi status
3120 * @skb: the original outgoing packet
3121 * @acked: ack status
3124 void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
3126 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
3127 __sum16 __skb_checksum_complete(struct sk_buff *skb);
3129 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
3131 return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
3133 (skb->ip_summed == CHECKSUM_PARTIAL &&
3134 skb_checksum_start_offset(skb) >= 0));
3138 * skb_checksum_complete - Calculate checksum of an entire packet
3139 * @skb: packet to process
3141 * This function calculates the checksum over the entire packet plus
3142 * the value of skb->csum. The latter can be used to supply the
3143 * checksum of a pseudo header as used by TCP/UDP. It returns the
3146 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
3147 * this function can be used to verify that checksum on received
3148 * packets. In that case the function should return zero if the
3149 * checksum is correct. In particular, this function will return zero
3150 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
3151 * hardware has already verified the correctness of the checksum.
3153 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
3155 return skb_csum_unnecessary(skb) ?
3156 0 : __skb_checksum_complete(skb);
3159 static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
3161 if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3162 if (skb->csum_level == 0)
3163 skb->ip_summed = CHECKSUM_NONE;
3169 static inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
3171 if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3172 if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
3174 } else if (skb->ip_summed == CHECKSUM_NONE) {
3175 skb->ip_summed = CHECKSUM_UNNECESSARY;
3176 skb->csum_level = 0;
3180 static inline void __skb_mark_checksum_bad(struct sk_buff *skb)
3182 /* Mark current checksum as bad (typically called from GRO
3183 * path). In the case that ip_summed is CHECKSUM_NONE
3184 * this must be the first checksum encountered in the packet.
3185 * When ip_summed is CHECKSUM_UNNECESSARY, this is the first
3186 * checksum after the last one validated. For UDP, a zero
3187 * checksum can not be marked as bad.
3190 if (skb->ip_summed == CHECKSUM_NONE ||
3191 skb->ip_summed == CHECKSUM_UNNECESSARY)
3195 /* Check if we need to perform checksum complete validation.
3197 * Returns true if checksum complete is needed, false otherwise
3198 * (either checksum is unnecessary or zero checksum is allowed).
3200 static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
3204 if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
3205 skb->csum_valid = 1;
3206 __skb_decr_checksum_unnecessary(skb);
3213 /* For small packets <= CHECKSUM_BREAK peform checksum complete directly
3216 #define CHECKSUM_BREAK 76
3218 /* Unset checksum-complete
3220 * Unset checksum complete can be done when packet is being modified
3221 * (uncompressed for instance) and checksum-complete value is
3224 static inline void skb_checksum_complete_unset(struct sk_buff *skb)
3226 if (skb->ip_summed == CHECKSUM_COMPLETE)
3227 skb->ip_summed = CHECKSUM_NONE;
3230 /* Validate (init) checksum based on checksum complete.
3233 * 0: checksum is validated or try to in skb_checksum_complete. In the latter
3234 * case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
3235 * checksum is stored in skb->csum for use in __skb_checksum_complete
3236 * non-zero: value of invalid checksum
3239 static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
3243 if (skb->ip_summed == CHECKSUM_COMPLETE) {
3244 if (!csum_fold(csum_add(psum, skb->csum))) {
3245 skb->csum_valid = 1;
3248 } else if (skb->csum_bad) {
3249 /* ip_summed == CHECKSUM_NONE in this case */
3250 return (__force __sum16)1;
3255 if (complete || skb->len <= CHECKSUM_BREAK) {
3258 csum = __skb_checksum_complete(skb);
3259 skb->csum_valid = !csum;
3266 static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
3271 /* Perform checksum validate (init). Note that this is a macro since we only
3272 * want to calculate the pseudo header which is an input function if necessary.
3273 * First we try to validate without any computation (checksum unnecessary) and
3274 * then calculate based on checksum complete calling the function to compute
3278 * 0: checksum is validated or try to in skb_checksum_complete
3279 * non-zero: value of invalid checksum
3281 #define __skb_checksum_validate(skb, proto, complete, \
3282 zero_okay, check, compute_pseudo) \
3284 __sum16 __ret = 0; \
3285 skb->csum_valid = 0; \
3286 if (__skb_checksum_validate_needed(skb, zero_okay, check)) \
3287 __ret = __skb_checksum_validate_complete(skb, \
3288 complete, compute_pseudo(skb, proto)); \
3292 #define skb_checksum_init(skb, proto, compute_pseudo) \
3293 __skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
3295 #define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo) \
3296 __skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
3298 #define skb_checksum_validate(skb, proto, compute_pseudo) \
3299 __skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
3301 #define skb_checksum_validate_zero_check(skb, proto, check, \
3303 __skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
3305 #define skb_checksum_simple_validate(skb) \
3306 __skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
3308 static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
3310 return (skb->ip_summed == CHECKSUM_NONE &&
3311 skb->csum_valid && !skb->csum_bad);
3314 static inline void __skb_checksum_convert(struct sk_buff *skb,
3315 __sum16 check, __wsum pseudo)
3317 skb->csum = ~pseudo;
3318 skb->ip_summed = CHECKSUM_COMPLETE;
3321 #define skb_checksum_try_convert(skb, proto, check, compute_pseudo) \
3323 if (__skb_checksum_convert_check(skb)) \
3324 __skb_checksum_convert(skb, check, \
3325 compute_pseudo(skb, proto)); \
3328 static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
3329 u16 start, u16 offset)
3331 skb->ip_summed = CHECKSUM_PARTIAL;
3332 skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
3333 skb->csum_offset = offset - start;
3336 /* Update skbuf and packet to reflect the remote checksum offload operation.
3337 * When called, ptr indicates the starting point for skb->csum when
3338 * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
3339 * here, skb_postpull_rcsum is done so skb->csum start is ptr.
3341 static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
3342 int start, int offset, bool nopartial)
3347 skb_remcsum_adjust_partial(skb, ptr, start, offset);
3351 if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
3352 __skb_checksum_complete(skb);
3353 skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
3356 delta = remcsum_adjust(ptr, skb->csum, start, offset);
3358 /* Adjust skb->csum since we changed the packet */
3359 skb->csum = csum_add(skb->csum, delta);
3362 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3363 void nf_conntrack_destroy(struct nf_conntrack *nfct);
3364 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
3366 if (nfct && atomic_dec_and_test(&nfct->use))
3367 nf_conntrack_destroy(nfct);
3369 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
3372 atomic_inc(&nfct->use);
3375 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3376 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
3378 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
3381 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
3384 atomic_inc(&nf_bridge->use);
3386 #endif /* CONFIG_BRIDGE_NETFILTER */
3387 static inline void nf_reset(struct sk_buff *skb)
3389 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3390 nf_conntrack_put(skb->nfct);
3393 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3394 nf_bridge_put(skb->nf_bridge);
3395 skb->nf_bridge = NULL;
3399 static inline void nf_reset_trace(struct sk_buff *skb)
3401 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3406 /* Note: This doesn't put any conntrack and bridge info in dst. */
3407 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
3410 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3411 dst->nfct = src->nfct;
3412 nf_conntrack_get(src->nfct);
3414 dst->nfctinfo = src->nfctinfo;
3416 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3417 dst->nf_bridge = src->nf_bridge;
3418 nf_bridge_get(src->nf_bridge);
3420 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3422 dst->nf_trace = src->nf_trace;
3426 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
3428 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3429 nf_conntrack_put(dst->nfct);
3431 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3432 nf_bridge_put(dst->nf_bridge);
3434 __nf_copy(dst, src, true);
3437 #ifdef CONFIG_NETWORK_SECMARK
3438 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3440 to->secmark = from->secmark;
3443 static inline void skb_init_secmark(struct sk_buff *skb)
3448 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3451 static inline void skb_init_secmark(struct sk_buff *skb)
3455 static inline bool skb_irq_freeable(const struct sk_buff *skb)
3457 return !skb->destructor &&
3458 #if IS_ENABLED(CONFIG_XFRM)
3461 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
3464 !skb->_skb_refdst &&
3465 !skb_has_frag_list(skb);
3468 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
3470 skb->queue_mapping = queue_mapping;
3473 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
3475 return skb->queue_mapping;
3478 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
3480 to->queue_mapping = from->queue_mapping;
3483 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
3485 skb->queue_mapping = rx_queue + 1;
3488 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
3490 return skb->queue_mapping - 1;
3493 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
3495 return skb->queue_mapping != 0;
3498 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
3507 /* Keeps track of mac header offset relative to skb->head.
3508 * It is useful for TSO of Tunneling protocol. e.g. GRE.
3509 * For non-tunnel skb it points to skb_mac_header() and for
3510 * tunnel skb it points to outer mac header.
3511 * Keeps track of level of encapsulation of network headers.
3518 #define SKB_SGO_CB_OFFSET 32
3519 #define SKB_GSO_CB(skb) ((struct skb_gso_cb *)((skb)->cb + SKB_SGO_CB_OFFSET))
3521 static inline int skb_tnl_header_len(const struct sk_buff *inner_skb)
3523 return (skb_mac_header(inner_skb) - inner_skb->head) -
3524 SKB_GSO_CB(inner_skb)->mac_offset;
3527 static inline int gso_pskb_expand_head(struct sk_buff *skb, int extra)
3529 int new_headroom, headroom;
3532 headroom = skb_headroom(skb);
3533 ret = pskb_expand_head(skb, extra, 0, GFP_ATOMIC);
3537 new_headroom = skb_headroom(skb);
3538 SKB_GSO_CB(skb)->mac_offset += (new_headroom - headroom);
3542 /* Compute the checksum for a gso segment. First compute the checksum value
3543 * from the start of transport header to SKB_GSO_CB(skb)->csum_start, and
3544 * then add in skb->csum (checksum from csum_start to end of packet).
3545 * skb->csum and csum_start are then updated to reflect the checksum of the
3546 * resultant packet starting from the transport header-- the resultant checksum
3547 * is in the res argument (i.e. normally zero or ~ of checksum of a pseudo
3550 static inline __sum16 gso_make_checksum(struct sk_buff *skb, __wsum res)
3552 int plen = SKB_GSO_CB(skb)->csum_start - skb_headroom(skb) -
3553 skb_transport_offset(skb);
3556 partial = csum_partial(skb_transport_header(skb), plen, skb->csum);
3558 SKB_GSO_CB(skb)->csum_start -= plen;
3560 return csum_fold(partial);
3563 static inline bool skb_is_gso(const struct sk_buff *skb)
3565 return skb_shinfo(skb)->gso_size;
3568 /* Note: Should be called only if skb_is_gso(skb) is true */
3569 static inline bool skb_is_gso_v6(const struct sk_buff *skb)
3571 return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
3574 void __skb_warn_lro_forwarding(const struct sk_buff *skb);
3576 static inline bool skb_warn_if_lro(const struct sk_buff *skb)
3578 /* LRO sets gso_size but not gso_type, whereas if GSO is really
3579 * wanted then gso_type will be set. */
3580 const struct skb_shared_info *shinfo = skb_shinfo(skb);
3582 if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
3583 unlikely(shinfo->gso_type == 0)) {
3584 __skb_warn_lro_forwarding(skb);
3590 static inline void skb_forward_csum(struct sk_buff *skb)
3592 /* Unfortunately we don't support this one. Any brave souls? */
3593 if (skb->ip_summed == CHECKSUM_COMPLETE)
3594 skb->ip_summed = CHECKSUM_NONE;
3598 * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
3599 * @skb: skb to check
3601 * fresh skbs have their ip_summed set to CHECKSUM_NONE.
3602 * Instead of forcing ip_summed to CHECKSUM_NONE, we can
3603 * use this helper, to document places where we make this assertion.
3605 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
3608 BUG_ON(skb->ip_summed != CHECKSUM_NONE);
3612 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
3614 int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
3615 struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
3616 unsigned int transport_len,
3617 __sum16(*skb_chkf)(struct sk_buff *skb));
3620 * skb_head_is_locked - Determine if the skb->head is locked down
3621 * @skb: skb to check
3623 * The head on skbs build around a head frag can be removed if they are
3624 * not cloned. This function returns true if the skb head is locked down
3625 * due to either being allocated via kmalloc, or by being a clone with
3626 * multiple references to the head.
3628 static inline bool skb_head_is_locked(const struct sk_buff *skb)
3630 return !skb->head_frag || skb_cloned(skb);
3634 * skb_gso_network_seglen - Return length of individual segments of a gso packet
3638 * skb_gso_network_seglen is used to determine the real size of the
3639 * individual segments, including Layer3 (IP, IPv6) and L4 headers (TCP/UDP).
3641 * The MAC/L2 header is not accounted for.
3643 static inline unsigned int skb_gso_network_seglen(const struct sk_buff *skb)
3645 unsigned int hdr_len = skb_transport_header(skb) -
3646 skb_network_header(skb);
3647 return hdr_len + skb_gso_transport_seglen(skb);
3650 #endif /* __KERNEL__ */
3651 #endif /* _LINUX_SKBUFF_H */