skbuff.h 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801
  1. /*
  2. * Definitions for the 'struct sk_buff' memory handlers.
  3. *
  4. * Authors:
  5. * Alan Cox, <gw4pts@gw4pts.ampr.org>
  6. * Florian La Roche, <rzsfl@rz.uni-sb.de>
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License
  10. * as published by the Free Software Foundation; either version
  11. * 2 of the License, or (at your option) any later version.
  12. */
  13. #ifndef _LINUX_SKBUFF_H
  14. #define _LINUX_SKBUFF_H
  15. #include <linux/kernel.h>
  16. #include <linux/compiler.h>
  17. #include <linux/time.h>
  18. #include <linux/cache.h>
  19. #include <asm/atomic.h>
  20. #include <asm/types.h>
  21. #include <linux/spinlock.h>
  22. #include <linux/net.h>
  23. #include <linux/textsearch.h>
  24. #include <net/checksum.h>
  25. #include <linux/rcupdate.h>
  26. #include <linux/dmaengine.h>
  27. #include <linux/hrtimer.h>
  28. #define HAVE_ALLOC_SKB /* For the drivers to know */
  29. #define HAVE_ALIGNABLE_SKB /* Ditto 8) */
  30. /* Don't change this without changing skb_csum_unnecessary! */
  31. #define CHECKSUM_NONE 0
  32. #define CHECKSUM_UNNECESSARY 1
  33. #define CHECKSUM_COMPLETE 2
  34. #define CHECKSUM_PARTIAL 3
  35. #define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
  36. ~(SMP_CACHE_BYTES - 1))
  37. #define SKB_WITH_OVERHEAD(X) \
  38. ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
  39. #define SKB_MAX_ORDER(X, ORDER) \
  40. SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
  41. #define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
  42. #define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
  43. /* A. Checksumming of received packets by device.
  44. *
  45. * NONE: device failed to checksum this packet.
  46. * skb->csum is undefined.
  47. *
  48. * UNNECESSARY: device parsed packet and wouldbe verified checksum.
  49. * skb->csum is undefined.
  50. * It is bad option, but, unfortunately, many of vendors do this.
  51. * Apparently with secret goal to sell you new device, when you
  52. * will add new protocol to your host. F.e. IPv6. 8)
  53. *
  54. * COMPLETE: the most generic way. Device supplied checksum of _all_
  55. * the packet as seen by netif_rx in skb->csum.
  56. * NOTE: Even if device supports only some protocols, but
  57. * is able to produce some skb->csum, it MUST use COMPLETE,
  58. * not UNNECESSARY.
  59. *
  60. * PARTIAL: identical to the case for output below. This may occur
  61. * on a packet received directly from another Linux OS, e.g.,
  62. * a virtualised Linux kernel on the same host. The packet can
  63. * be treated in the same way as UNNECESSARY except that on
  64. * output (i.e., forwarding) the checksum must be filled in
  65. * by the OS or the hardware.
  66. *
  67. * B. Checksumming on output.
  68. *
  69. * NONE: skb is checksummed by protocol or csum is not required.
  70. *
  71. * PARTIAL: device is required to csum packet as seen by hard_start_xmit
  72. * from skb->csum_start to the end and to record the checksum
  73. * at skb->csum_start + skb->csum_offset.
  74. *
  75. * Device must show its capabilities in dev->features, set
  76. * at device setup time.
  77. * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
  78. * everything.
  79. * NETIF_F_NO_CSUM - loopback or reliable single hop media.
  80. * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
  81. * TCP/UDP over IPv4. Sigh. Vendors like this
  82. * way by an unknown reason. Though, see comment above
  83. * about CHECKSUM_UNNECESSARY. 8)
  84. * NETIF_F_IPV6_CSUM about as dumb as the last one but does IPv6 instead.
  85. *
  86. * Any questions? No questions, good. --ANK
  87. */
  88. struct net_device;
  89. struct scatterlist;
  90. struct pipe_inode_info;
  91. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  92. struct nf_conntrack {
  93. atomic_t use;
  94. };
  95. #endif
  96. #ifdef CONFIG_BRIDGE_NETFILTER
  97. struct nf_bridge_info {
  98. atomic_t use;
  99. struct net_device *physindev;
  100. struct net_device *physoutdev;
  101. unsigned int mask;
  102. unsigned long data[32 / sizeof(unsigned long)];
  103. };
  104. #endif
  105. struct sk_buff_head {
  106. /* These two members must be first. */
  107. struct sk_buff *next;
  108. struct sk_buff *prev;
  109. __u32 qlen;
  110. spinlock_t lock;
  111. };
  112. struct sk_buff;
  113. /* To allow 64K frame to be packed as single skb without frag_list */
  114. #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
  115. typedef struct skb_frag_struct skb_frag_t;
  116. struct skb_frag_struct {
  117. struct page *page;
  118. __u32 page_offset;
  119. __u32 size;
  120. };
  121. /* This data is invariant across clones and lives at
  122. * the end of the header data, ie. at skb->end.
  123. */
  124. struct skb_shared_info {
  125. atomic_t dataref;
  126. unsigned short nr_frags;
  127. unsigned short gso_size;
  128. /* Warning: this field is not always filled in (UFO)! */
  129. unsigned short gso_segs;
  130. unsigned short gso_type;
  131. __be32 ip6_frag_id;
  132. struct sk_buff *frag_list;
  133. skb_frag_t frags[MAX_SKB_FRAGS];
  134. };
  135. /* We divide dataref into two halves. The higher 16 bits hold references
  136. * to the payload part of skb->data. The lower 16 bits hold references to
  137. * the entire skb->data. A clone of a headerless skb holds the length of
  138. * the header in skb->hdr_len.
  139. *
  140. * All users must obey the rule that the skb->data reference count must be
  141. * greater than or equal to the payload reference count.
  142. *
  143. * Holding a reference to the payload part means that the user does not
  144. * care about modifications to the header part of skb->data.
  145. */
  146. #define SKB_DATAREF_SHIFT 16
  147. #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
  148. enum {
  149. SKB_FCLONE_UNAVAILABLE,
  150. SKB_FCLONE_ORIG,
  151. SKB_FCLONE_CLONE,
  152. };
  153. enum {
  154. SKB_GSO_TCPV4 = 1 << 0,
  155. SKB_GSO_UDP = 1 << 1,
  156. /* This indicates the skb is from an untrusted source. */
  157. SKB_GSO_DODGY = 1 << 2,
  158. /* This indicates the tcp segment has CWR set. */
  159. SKB_GSO_TCP_ECN = 1 << 3,
  160. SKB_GSO_TCPV6 = 1 << 4,
  161. };
  162. #if BITS_PER_LONG > 32
  163. #define NET_SKBUFF_DATA_USES_OFFSET 1
  164. #endif
  165. #ifdef NET_SKBUFF_DATA_USES_OFFSET
  166. typedef unsigned int sk_buff_data_t;
  167. #else
  168. typedef unsigned char *sk_buff_data_t;
  169. #endif
  170. /**
  171. * struct sk_buff - socket buffer
  172. * @next: Next buffer in list
  173. * @prev: Previous buffer in list
  174. * @sk: Socket we are owned by
  175. * @tstamp: Time we arrived
  176. * @dev: Device we arrived on/are leaving by
  177. * @transport_header: Transport layer header
  178. * @network_header: Network layer header
  179. * @mac_header: Link layer header
  180. * @dst: destination entry
  181. * @sp: the security path, used for xfrm
  182. * @cb: Control buffer. Free for use by every layer. Put private vars here
  183. * @len: Length of actual data
  184. * @data_len: Data length
  185. * @mac_len: Length of link layer header
  186. * @hdr_len: writable header length of cloned skb
  187. * @csum: Checksum (must include start/offset pair)
  188. * @csum_start: Offset from skb->head where checksumming should start
  189. * @csum_offset: Offset from csum_start where checksum should be stored
  190. * @local_df: allow local fragmentation
  191. * @cloned: Head may be cloned (check refcnt to be sure)
  192. * @nohdr: Payload reference only, must not modify header
  193. * @pkt_type: Packet class
  194. * @fclone: skbuff clone status
  195. * @ip_summed: Driver fed us an IP checksum
  196. * @priority: Packet queueing priority
  197. * @users: User count - see {datagram,tcp}.c
  198. * @protocol: Packet protocol from driver
  199. * @truesize: Buffer size
  200. * @head: Head of buffer
  201. * @data: Data head pointer
  202. * @tail: Tail pointer
  203. * @end: End pointer
  204. * @destructor: Destruct function
  205. * @mark: Generic packet mark
  206. * @nfct: Associated connection, if any
  207. * @ipvs_property: skbuff is owned by ipvs
  208. * @peeked: this packet has been seen already, so stats have been
  209. * done for it, don't do them again
  210. * @nf_trace: netfilter packet trace flag
  211. * @nfctinfo: Relationship of this skb to the connection
  212. * @nfct_reasm: netfilter conntrack re-assembly pointer
  213. * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
  214. * @iif: ifindex of device we arrived on
  215. * @queue_mapping: Queue mapping for multiqueue devices
  216. * @tc_index: Traffic control index
  217. * @tc_verd: traffic control verdict
  218. * @dma_cookie: a cookie to one of several possible DMA operations
  219. * done by skb DMA functions
  220. * @secmark: security marking
  221. */
  222. struct sk_buff {
  223. /* These two members must be first. */
  224. struct sk_buff *next;
  225. struct sk_buff *prev;
  226. struct sock *sk;
  227. ktime_t tstamp;
  228. struct net_device *dev;
  229. union {
  230. struct dst_entry *dst;
  231. struct rtable *rtable;
  232. };
  233. struct sec_path *sp;
  234. /*
  235. * This is the control buffer. It is free to use for every
  236. * layer. Please put your private variables there. If you
  237. * want to keep them across layers you have to do a skb_clone()
  238. * first. This is owned by whoever has the skb queued ATM.
  239. */
  240. char cb[48];
  241. unsigned int len,
  242. data_len;
  243. __u16 mac_len,
  244. hdr_len;
  245. union {
  246. __wsum csum;
  247. struct {
  248. __u16 csum_start;
  249. __u16 csum_offset;
  250. };
  251. };
  252. __u32 priority;
  253. __u8 local_df:1,
  254. cloned:1,
  255. ip_summed:2,
  256. nohdr:1,
  257. nfctinfo:3;
  258. __u8 pkt_type:3,
  259. fclone:2,
  260. ipvs_property:1,
  261. peeked:1,
  262. nf_trace:1;
  263. __be16 protocol;
  264. void (*destructor)(struct sk_buff *skb);
  265. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  266. struct nf_conntrack *nfct;
  267. struct sk_buff *nfct_reasm;
  268. #endif
  269. #ifdef CONFIG_BRIDGE_NETFILTER
  270. struct nf_bridge_info *nf_bridge;
  271. #endif
  272. int iif;
  273. #ifdef CONFIG_NETDEVICES_MULTIQUEUE
  274. __u16 queue_mapping;
  275. #endif
  276. #ifdef CONFIG_NET_SCHED
  277. __u16 tc_index; /* traffic control index */
  278. #ifdef CONFIG_NET_CLS_ACT
  279. __u16 tc_verd; /* traffic control verdict */
  280. #endif
  281. #endif
  282. /* 2 byte hole */
  283. #ifdef CONFIG_NET_DMA
  284. dma_cookie_t dma_cookie;
  285. #endif
  286. #ifdef CONFIG_NETWORK_SECMARK
  287. __u32 secmark;
  288. #endif
  289. __u32 mark;
  290. sk_buff_data_t transport_header;
  291. sk_buff_data_t network_header;
  292. sk_buff_data_t mac_header;
  293. /* These elements must be at the end, see alloc_skb() for details. */
  294. sk_buff_data_t tail;
  295. sk_buff_data_t end;
  296. unsigned char *head,
  297. *data;
  298. unsigned int truesize;
  299. atomic_t users;
  300. };
  301. #ifdef __KERNEL__
  302. /*
  303. * Handling routines are only of interest to the kernel
  304. */
  305. #include <linux/slab.h>
  306. #include <asm/system.h>
  307. extern void kfree_skb(struct sk_buff *skb);
  308. extern void __kfree_skb(struct sk_buff *skb);
  309. extern struct sk_buff *__alloc_skb(unsigned int size,
  310. gfp_t priority, int fclone, int node);
  311. static inline struct sk_buff *alloc_skb(unsigned int size,
  312. gfp_t priority)
  313. {
  314. return __alloc_skb(size, priority, 0, -1);
  315. }
  316. static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
  317. gfp_t priority)
  318. {
  319. return __alloc_skb(size, priority, 1, -1);
  320. }
  321. extern struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
  322. extern struct sk_buff *skb_clone(struct sk_buff *skb,
  323. gfp_t priority);
  324. extern struct sk_buff *skb_copy(const struct sk_buff *skb,
  325. gfp_t priority);
  326. extern struct sk_buff *pskb_copy(struct sk_buff *skb,
  327. gfp_t gfp_mask);
  328. extern int pskb_expand_head(struct sk_buff *skb,
  329. int nhead, int ntail,
  330. gfp_t gfp_mask);
  331. extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
  332. unsigned int headroom);
  333. extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
  334. int newheadroom, int newtailroom,
  335. gfp_t priority);
  336. extern int skb_to_sgvec(struct sk_buff *skb,
  337. struct scatterlist *sg, int offset,
  338. int len);
  339. extern int skb_cow_data(struct sk_buff *skb, int tailbits,
  340. struct sk_buff **trailer);
  341. extern int skb_pad(struct sk_buff *skb, int pad);
  342. #define dev_kfree_skb(a) kfree_skb(a)
  343. extern void skb_over_panic(struct sk_buff *skb, int len,
  344. void *here);
  345. extern void skb_under_panic(struct sk_buff *skb, int len,
  346. void *here);
  347. extern void skb_truesize_bug(struct sk_buff *skb);
  348. static inline void skb_truesize_check(struct sk_buff *skb)
  349. {
  350. int len = sizeof(struct sk_buff) + skb->len;
  351. if (unlikely((int)skb->truesize < len))
  352. skb_truesize_bug(skb);
  353. }
  354. extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
  355. int getfrag(void *from, char *to, int offset,
  356. int len,int odd, struct sk_buff *skb),
  357. void *from, int length);
  358. struct skb_seq_state
  359. {
  360. __u32 lower_offset;
  361. __u32 upper_offset;
  362. __u32 frag_idx;
  363. __u32 stepped_offset;
  364. struct sk_buff *root_skb;
  365. struct sk_buff *cur_skb;
  366. __u8 *frag_data;
  367. };
  368. extern void skb_prepare_seq_read(struct sk_buff *skb,
  369. unsigned int from, unsigned int to,
  370. struct skb_seq_state *st);
  371. extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
  372. struct skb_seq_state *st);
  373. extern void skb_abort_seq_read(struct skb_seq_state *st);
  374. extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
  375. unsigned int to, struct ts_config *config,
  376. struct ts_state *state);
  377. #ifdef NET_SKBUFF_DATA_USES_OFFSET
  378. static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
  379. {
  380. return skb->head + skb->end;
  381. }
  382. #else
  383. static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
  384. {
  385. return skb->end;
  386. }
  387. #endif
  388. /* Internal */
  389. #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
  390. /**
  391. * skb_queue_empty - check if a queue is empty
  392. * @list: queue head
  393. *
  394. * Returns true if the queue is empty, false otherwise.
  395. */
  396. static inline int skb_queue_empty(const struct sk_buff_head *list)
  397. {
  398. return list->next == (struct sk_buff *)list;
  399. }
  400. /**
  401. * skb_get - reference buffer
  402. * @skb: buffer to reference
  403. *
  404. * Makes another reference to a socket buffer and returns a pointer
  405. * to the buffer.
  406. */
  407. static inline struct sk_buff *skb_get(struct sk_buff *skb)
  408. {
  409. atomic_inc(&skb->users);
  410. return skb;
  411. }
  412. /*
  413. * If users == 1, we are the only owner and are can avoid redundant
  414. * atomic change.
  415. */
  416. /**
  417. * skb_cloned - is the buffer a clone
  418. * @skb: buffer to check
  419. *
  420. * Returns true if the buffer was generated with skb_clone() and is
  421. * one of multiple shared copies of the buffer. Cloned buffers are
  422. * shared data so must not be written to under normal circumstances.
  423. */
  424. static inline int skb_cloned(const struct sk_buff *skb)
  425. {
  426. return skb->cloned &&
  427. (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
  428. }
  429. /**
  430. * skb_header_cloned - is the header a clone
  431. * @skb: buffer to check
  432. *
  433. * Returns true if modifying the header part of the buffer requires
  434. * the data to be copied.
  435. */
  436. static inline int skb_header_cloned(const struct sk_buff *skb)
  437. {
  438. int dataref;
  439. if (!skb->cloned)
  440. return 0;
  441. dataref = atomic_read(&skb_shinfo(skb)->dataref);
  442. dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
  443. return dataref != 1;
  444. }
  445. /**
  446. * skb_header_release - release reference to header
  447. * @skb: buffer to operate on
  448. *
  449. * Drop a reference to the header part of the buffer. This is done
  450. * by acquiring a payload reference. You must not read from the header
  451. * part of skb->data after this.
  452. */
  453. static inline void skb_header_release(struct sk_buff *skb)
  454. {
  455. BUG_ON(skb->nohdr);
  456. skb->nohdr = 1;
  457. atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
  458. }
  459. /**
  460. * skb_shared - is the buffer shared
  461. * @skb: buffer to check
  462. *
  463. * Returns true if more than one person has a reference to this
  464. * buffer.
  465. */
  466. static inline int skb_shared(const struct sk_buff *skb)
  467. {
  468. return atomic_read(&skb->users) != 1;
  469. }
  470. /**
  471. * skb_share_check - check if buffer is shared and if so clone it
  472. * @skb: buffer to check
  473. * @pri: priority for memory allocation
  474. *
  475. * If the buffer is shared the buffer is cloned and the old copy
  476. * drops a reference. A new clone with a single reference is returned.
  477. * If the buffer is not shared the original buffer is returned. When
  478. * being called from interrupt status or with spinlocks held pri must
  479. * be GFP_ATOMIC.
  480. *
  481. * NULL is returned on a memory allocation failure.
  482. */
  483. static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
  484. gfp_t pri)
  485. {
  486. might_sleep_if(pri & __GFP_WAIT);
  487. if (skb_shared(skb)) {
  488. struct sk_buff *nskb = skb_clone(skb, pri);
  489. kfree_skb(skb);
  490. skb = nskb;
  491. }
  492. return skb;
  493. }
  494. /*
  495. * Copy shared buffers into a new sk_buff. We effectively do COW on
  496. * packets to handle cases where we have a local reader and forward
  497. * and a couple of other messy ones. The normal one is tcpdumping
  498. * a packet thats being forwarded.
  499. */
  500. /**
  501. * skb_unshare - make a copy of a shared buffer
  502. * @skb: buffer to check
  503. * @pri: priority for memory allocation
  504. *
  505. * If the socket buffer is a clone then this function creates a new
  506. * copy of the data, drops a reference count on the old copy and returns
  507. * the new copy with the reference count at 1. If the buffer is not a clone
  508. * the original buffer is returned. When called with a spinlock held or
  509. * from interrupt state @pri must be %GFP_ATOMIC
  510. *
  511. * %NULL is returned on a memory allocation failure.
  512. */
  513. static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
  514. gfp_t pri)
  515. {
  516. might_sleep_if(pri & __GFP_WAIT);
  517. if (skb_cloned(skb)) {
  518. struct sk_buff *nskb = skb_copy(skb, pri);
  519. kfree_skb(skb); /* Free our shared copy */
  520. skb = nskb;
  521. }
  522. return skb;
  523. }
  524. /**
  525. * skb_peek
  526. * @list_: list to peek at
  527. *
  528. * Peek an &sk_buff. Unlike most other operations you _MUST_
  529. * be careful with this one. A peek leaves the buffer on the
  530. * list and someone else may run off with it. You must hold
  531. * the appropriate locks or have a private queue to do this.
  532. *
  533. * Returns %NULL for an empty list or a pointer to the head element.
  534. * The reference count is not incremented and the reference is therefore
  535. * volatile. Use with caution.
  536. */
  537. static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
  538. {
  539. struct sk_buff *list = ((struct sk_buff *)list_)->next;
  540. if (list == (struct sk_buff *)list_)
  541. list = NULL;
  542. return list;
  543. }
  544. /**
  545. * skb_peek_tail
  546. * @list_: list to peek at
  547. *
  548. * Peek an &sk_buff. Unlike most other operations you _MUST_
  549. * be careful with this one. A peek leaves the buffer on the
  550. * list and someone else may run off with it. You must hold
  551. * the appropriate locks or have a private queue to do this.
  552. *
  553. * Returns %NULL for an empty list or a pointer to the tail element.
  554. * The reference count is not incremented and the reference is therefore
  555. * volatile. Use with caution.
  556. */
  557. static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
  558. {
  559. struct sk_buff *list = ((struct sk_buff *)list_)->prev;
  560. if (list == (struct sk_buff *)list_)
  561. list = NULL;
  562. return list;
  563. }
  564. /**
  565. * skb_queue_len - get queue length
  566. * @list_: list to measure
  567. *
  568. * Return the length of an &sk_buff queue.
  569. */
  570. static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
  571. {
  572. return list_->qlen;
  573. }
  574. /*
  575. * This function creates a split out lock class for each invocation;
  576. * this is needed for now since a whole lot of users of the skb-queue
  577. * infrastructure in drivers have different locking usage (in hardirq)
  578. * than the networking core (in softirq only). In the long run either the
  579. * network layer or drivers should need annotation to consolidate the
  580. * main types of usage into 3 classes.
  581. */
  582. static inline void skb_queue_head_init(struct sk_buff_head *list)
  583. {
  584. spin_lock_init(&list->lock);
  585. list->prev = list->next = (struct sk_buff *)list;
  586. list->qlen = 0;
  587. }
  588. static inline void skb_queue_head_init_class(struct sk_buff_head *list,
  589. struct lock_class_key *class)
  590. {
  591. skb_queue_head_init(list);
  592. lockdep_set_class(&list->lock, class);
  593. }
  594. /*
  595. * Insert an sk_buff at the start of a list.
  596. *
  597. * The "__skb_xxxx()" functions are the non-atomic ones that
  598. * can only be called with interrupts disabled.
  599. */
  600. /**
  601. * __skb_queue_after - queue a buffer at the list head
  602. * @list: list to use
  603. * @prev: place after this buffer
  604. * @newsk: buffer to queue
  605. *
  606. * Queue a buffer int the middle of a list. This function takes no locks
  607. * and you must therefore hold required locks before calling it.
  608. *
  609. * A buffer cannot be placed on two lists at the same time.
  610. */
  611. static inline void __skb_queue_after(struct sk_buff_head *list,
  612. struct sk_buff *prev,
  613. struct sk_buff *newsk)
  614. {
  615. struct sk_buff *next;
  616. list->qlen++;
  617. next = prev->next;
  618. newsk->next = next;
  619. newsk->prev = prev;
  620. next->prev = prev->next = newsk;
  621. }
  622. /**
  623. * __skb_queue_head - queue a buffer at the list head
  624. * @list: list to use
  625. * @newsk: buffer to queue
  626. *
  627. * Queue a buffer at the start of a list. This function takes no locks
  628. * and you must therefore hold required locks before calling it.
  629. *
  630. * A buffer cannot be placed on two lists at the same time.
  631. */
  632. extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
  633. static inline void __skb_queue_head(struct sk_buff_head *list,
  634. struct sk_buff *newsk)
  635. {
  636. __skb_queue_after(list, (struct sk_buff *)list, newsk);
  637. }
  638. /**
  639. * __skb_queue_tail - queue a buffer at the list tail
  640. * @list: list to use
  641. * @newsk: buffer to queue
  642. *
  643. * Queue a buffer at the end of a list. This function takes no locks
  644. * and you must therefore hold required locks before calling it.
  645. *
  646. * A buffer cannot be placed on two lists at the same time.
  647. */
  648. extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
  649. static inline void __skb_queue_tail(struct sk_buff_head *list,
  650. struct sk_buff *newsk)
  651. {
  652. struct sk_buff *prev, *next;
  653. list->qlen++;
  654. next = (struct sk_buff *)list;
  655. prev = next->prev;
  656. newsk->next = next;
  657. newsk->prev = prev;
  658. next->prev = prev->next = newsk;
  659. }
  660. /**
  661. * __skb_dequeue - remove from the head of the queue
  662. * @list: list to dequeue from
  663. *
  664. * Remove the head of the list. This function does not take any locks
  665. * so must be used with appropriate locks held only. The head item is
  666. * returned or %NULL if the list is empty.
  667. */
  668. extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
  669. static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
  670. {
  671. struct sk_buff *next, *prev, *result;
  672. prev = (struct sk_buff *) list;
  673. next = prev->next;
  674. result = NULL;
  675. if (next != prev) {
  676. result = next;
  677. next = next->next;
  678. list->qlen--;
  679. next->prev = prev;
  680. prev->next = next;
  681. result->next = result->prev = NULL;
  682. }
  683. return result;
  684. }
  685. /*
  686. * Insert a packet on a list.
  687. */
  688. extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
  689. static inline void __skb_insert(struct sk_buff *newsk,
  690. struct sk_buff *prev, struct sk_buff *next,
  691. struct sk_buff_head *list)
  692. {
  693. newsk->next = next;
  694. newsk->prev = prev;
  695. next->prev = prev->next = newsk;
  696. list->qlen++;
  697. }
  698. /*
  699. * Place a packet after a given packet in a list.
  700. */
  701. extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
  702. static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
  703. {
  704. __skb_insert(newsk, old, old->next, list);
  705. }
  706. /*
  707. * remove sk_buff from list. _Must_ be called atomically, and with
  708. * the list known..
  709. */
  710. extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
  711. static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
  712. {
  713. struct sk_buff *next, *prev;
  714. list->qlen--;
  715. next = skb->next;
  716. prev = skb->prev;
  717. skb->next = skb->prev = NULL;
  718. next->prev = prev;
  719. prev->next = next;
  720. }
  721. /* XXX: more streamlined implementation */
  722. /**
  723. * __skb_dequeue_tail - remove from the tail of the queue
  724. * @list: list to dequeue from
  725. *
  726. * Remove the tail of the list. This function does not take any locks
  727. * so must be used with appropriate locks held only. The tail item is
  728. * returned or %NULL if the list is empty.
  729. */
  730. extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
  731. static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
  732. {
  733. struct sk_buff *skb = skb_peek_tail(list);
  734. if (skb)
  735. __skb_unlink(skb, list);
  736. return skb;
  737. }
  738. static inline int skb_is_nonlinear(const struct sk_buff *skb)
  739. {
  740. return skb->data_len;
  741. }
  742. static inline unsigned int skb_headlen(const struct sk_buff *skb)
  743. {
  744. return skb->len - skb->data_len;
  745. }
  746. static inline int skb_pagelen(const struct sk_buff *skb)
  747. {
  748. int i, len = 0;
  749. for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
  750. len += skb_shinfo(skb)->frags[i].size;
  751. return len + skb_headlen(skb);
  752. }
  753. static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
  754. struct page *page, int off, int size)
  755. {
  756. skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
  757. frag->page = page;
  758. frag->page_offset = off;
  759. frag->size = size;
  760. skb_shinfo(skb)->nr_frags = i + 1;
  761. }
  762. #define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
  763. #define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
  764. #define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
  765. #ifdef NET_SKBUFF_DATA_USES_OFFSET
  766. static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
  767. {
  768. return skb->head + skb->tail;
  769. }
  770. static inline void skb_reset_tail_pointer(struct sk_buff *skb)
  771. {
  772. skb->tail = skb->data - skb->head;
  773. }
  774. static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
  775. {
  776. skb_reset_tail_pointer(skb);
  777. skb->tail += offset;
  778. }
  779. #else /* NET_SKBUFF_DATA_USES_OFFSET */
  780. static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
  781. {
  782. return skb->tail;
  783. }
  784. static inline void skb_reset_tail_pointer(struct sk_buff *skb)
  785. {
  786. skb->tail = skb->data;
  787. }
  788. static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
  789. {
  790. skb->tail = skb->data + offset;
  791. }
  792. #endif /* NET_SKBUFF_DATA_USES_OFFSET */
  793. /*
  794. * Add data to an sk_buff
  795. */
  796. extern unsigned char *skb_put(struct sk_buff *skb, unsigned int len);
  797. static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
  798. {
  799. unsigned char *tmp = skb_tail_pointer(skb);
  800. SKB_LINEAR_ASSERT(skb);
  801. skb->tail += len;
  802. skb->len += len;
  803. return tmp;
  804. }
  805. static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
  806. {
  807. skb->data -= len;
  808. skb->len += len;
  809. return skb->data;
  810. }
  811. /**
  812. * skb_push - add data to the start of a buffer
  813. * @skb: buffer to use
  814. * @len: amount of data to add
  815. *
  816. * This function extends the used data area of the buffer at the buffer
  817. * start. If this would exceed the total buffer headroom the kernel will
  818. * panic. A pointer to the first byte of the extra data is returned.
  819. */
  820. static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
  821. {
  822. skb->data -= len;
  823. skb->len += len;
  824. if (unlikely(skb->data<skb->head))
  825. skb_under_panic(skb, len, current_text_addr());
  826. return skb->data;
  827. }
  828. static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
  829. {
  830. skb->len -= len;
  831. BUG_ON(skb->len < skb->data_len);
  832. return skb->data += len;
  833. }
  834. /**
  835. * skb_pull - remove data from the start of a buffer
  836. * @skb: buffer to use
  837. * @len: amount of data to remove
  838. *
  839. * This function removes data from the start of a buffer, returning
  840. * the memory to the headroom. A pointer to the next data in the buffer
  841. * is returned. Once the data has been pulled future pushes will overwrite
  842. * the old data.
  843. */
  844. static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
  845. {
  846. return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
  847. }
  848. extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
  849. static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
  850. {
  851. if (len > skb_headlen(skb) &&
  852. !__pskb_pull_tail(skb, len-skb_headlen(skb)))
  853. return NULL;
  854. skb->len -= len;
  855. return skb->data += len;
  856. }
  857. static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
  858. {
  859. return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
  860. }
  861. static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
  862. {
  863. if (likely(len <= skb_headlen(skb)))
  864. return 1;
  865. if (unlikely(len > skb->len))
  866. return 0;
  867. return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
  868. }
  869. /**
  870. * skb_headroom - bytes at buffer head
  871. * @skb: buffer to check
  872. *
  873. * Return the number of bytes of free space at the head of an &sk_buff.
  874. */
  875. static inline unsigned int skb_headroom(const struct sk_buff *skb)
  876. {
  877. return skb->data - skb->head;
  878. }
  879. /**
  880. * skb_tailroom - bytes at buffer end
  881. * @skb: buffer to check
  882. *
  883. * Return the number of bytes of free space at the tail of an sk_buff
  884. */
  885. static inline int skb_tailroom(const struct sk_buff *skb)
  886. {
  887. return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
  888. }
  889. /**
  890. * skb_reserve - adjust headroom
  891. * @skb: buffer to alter
  892. * @len: bytes to move
  893. *
  894. * Increase the headroom of an empty &sk_buff by reducing the tail
  895. * room. This is only allowed for an empty buffer.
  896. */
  897. static inline void skb_reserve(struct sk_buff *skb, int len)
  898. {
  899. skb->data += len;
  900. skb->tail += len;
  901. }
  902. #ifdef NET_SKBUFF_DATA_USES_OFFSET
  903. static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
  904. {
  905. return skb->head + skb->transport_header;
  906. }
  907. static inline void skb_reset_transport_header(struct sk_buff *skb)
  908. {
  909. skb->transport_header = skb->data - skb->head;
  910. }
  911. static inline void skb_set_transport_header(struct sk_buff *skb,
  912. const int offset)
  913. {
  914. skb_reset_transport_header(skb);
  915. skb->transport_header += offset;
  916. }
  917. static inline unsigned char *skb_network_header(const struct sk_buff *skb)
  918. {
  919. return skb->head + skb->network_header;
  920. }
  921. static inline void skb_reset_network_header(struct sk_buff *skb)
  922. {
  923. skb->network_header = skb->data - skb->head;
  924. }
  925. static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
  926. {
  927. skb_reset_network_header(skb);
  928. skb->network_header += offset;
  929. }
  930. static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
  931. {
  932. return skb->head + skb->mac_header;
  933. }
  934. static inline int skb_mac_header_was_set(const struct sk_buff *skb)
  935. {
  936. return skb->mac_header != ~0U;
  937. }
  938. static inline void skb_reset_mac_header(struct sk_buff *skb)
  939. {
  940. skb->mac_header = skb->data - skb->head;
  941. }
  942. static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
  943. {
  944. skb_reset_mac_header(skb);
  945. skb->mac_header += offset;
  946. }
  947. #else /* NET_SKBUFF_DATA_USES_OFFSET */
  948. static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
  949. {
  950. return skb->transport_header;
  951. }
  952. static inline void skb_reset_transport_header(struct sk_buff *skb)
  953. {
  954. skb->transport_header = skb->data;
  955. }
  956. static inline void skb_set_transport_header(struct sk_buff *skb,
  957. const int offset)
  958. {
  959. skb->transport_header = skb->data + offset;
  960. }
  961. static inline unsigned char *skb_network_header(const struct sk_buff *skb)
  962. {
  963. return skb->network_header;
  964. }
  965. static inline void skb_reset_network_header(struct sk_buff *skb)
  966. {
  967. skb->network_header = skb->data;
  968. }
  969. static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
  970. {
  971. skb->network_header = skb->data + offset;
  972. }
  973. static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
  974. {
  975. return skb->mac_header;
  976. }
  977. static inline int skb_mac_header_was_set(const struct sk_buff *skb)
  978. {
  979. return skb->mac_header != NULL;
  980. }
  981. static inline void skb_reset_mac_header(struct sk_buff *skb)
  982. {
  983. skb->mac_header = skb->data;
  984. }
  985. static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
  986. {
  987. skb->mac_header = skb->data + offset;
  988. }
  989. #endif /* NET_SKBUFF_DATA_USES_OFFSET */
  990. static inline int skb_transport_offset(const struct sk_buff *skb)
  991. {
  992. return skb_transport_header(skb) - skb->data;
  993. }
  994. static inline u32 skb_network_header_len(const struct sk_buff *skb)
  995. {
  996. return skb->transport_header - skb->network_header;
  997. }
  998. static inline int skb_network_offset(const struct sk_buff *skb)
  999. {
  1000. return skb_network_header(skb) - skb->data;
  1001. }
  1002. /*
  1003. * CPUs often take a performance hit when accessing unaligned memory
  1004. * locations. The actual performance hit varies, it can be small if the
  1005. * hardware handles it or large if we have to take an exception and fix it
  1006. * in software.
  1007. *
  1008. * Since an ethernet header is 14 bytes network drivers often end up with
  1009. * the IP header at an unaligned offset. The IP header can be aligned by
  1010. * shifting the start of the packet by 2 bytes. Drivers should do this
  1011. * with:
  1012. *
  1013. * skb_reserve(NET_IP_ALIGN);
  1014. *
  1015. * The downside to this alignment of the IP header is that the DMA is now
  1016. * unaligned. On some architectures the cost of an unaligned DMA is high
  1017. * and this cost outweighs the gains made by aligning the IP header.
  1018. *
  1019. * Since this trade off varies between architectures, we allow NET_IP_ALIGN
  1020. * to be overridden.
  1021. */
  1022. #ifndef NET_IP_ALIGN
  1023. #define NET_IP_ALIGN 2
  1024. #endif
  1025. /*
  1026. * The networking layer reserves some headroom in skb data (via
  1027. * dev_alloc_skb). This is used to avoid having to reallocate skb data when
  1028. * the header has to grow. In the default case, if the header has to grow
  1029. * 16 bytes or less we avoid the reallocation.
  1030. *
  1031. * Unfortunately this headroom changes the DMA alignment of the resulting
  1032. * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
  1033. * on some architectures. An architecture can override this value,
  1034. * perhaps setting it to a cacheline in size (since that will maintain
  1035. * cacheline alignment of the DMA). It must be a power of 2.
  1036. *
  1037. * Various parts of the networking layer expect at least 16 bytes of
  1038. * headroom, you should not reduce this.
  1039. */
  1040. #ifndef NET_SKB_PAD
  1041. #define NET_SKB_PAD 16
  1042. #endif
  1043. extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
  1044. static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
  1045. {
  1046. if (unlikely(skb->data_len)) {
  1047. WARN_ON(1);
  1048. return;
  1049. }
  1050. skb->len = len;
  1051. skb_set_tail_pointer(skb, len);
  1052. }
  1053. /**
  1054. * skb_trim - remove end from a buffer
  1055. * @skb: buffer to alter
  1056. * @len: new length
  1057. *
  1058. * Cut the length of a buffer down by removing data from the tail. If
  1059. * the buffer is already under the length specified it is not modified.
  1060. * The skb must be linear.
  1061. */
  1062. static inline void skb_trim(struct sk_buff *skb, unsigned int len)
  1063. {
  1064. if (skb->len > len)
  1065. __skb_trim(skb, len);
  1066. }
  1067. static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
  1068. {
  1069. if (skb->data_len)
  1070. return ___pskb_trim(skb, len);
  1071. __skb_trim(skb, len);
  1072. return 0;
  1073. }
  1074. static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
  1075. {
  1076. return (len < skb->len) ? __pskb_trim(skb, len) : 0;
  1077. }
  1078. /**
  1079. * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
  1080. * @skb: buffer to alter
  1081. * @len: new length
  1082. *
  1083. * This is identical to pskb_trim except that the caller knows that
  1084. * the skb is not cloned so we should never get an error due to out-
  1085. * of-memory.
  1086. */
  1087. static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
  1088. {
  1089. int err = pskb_trim(skb, len);
  1090. BUG_ON(err);
  1091. }
  1092. /**
  1093. * skb_orphan - orphan a buffer
  1094. * @skb: buffer to orphan
  1095. *
  1096. * If a buffer currently has an owner then we call the owner's
  1097. * destructor function and make the @skb unowned. The buffer continues
  1098. * to exist but is no longer charged to its former owner.
  1099. */
  1100. static inline void skb_orphan(struct sk_buff *skb)
  1101. {
  1102. if (skb->destructor)
  1103. skb->destructor(skb);
  1104. skb->destructor = NULL;
  1105. skb->sk = NULL;
  1106. }
  1107. /**
  1108. * __skb_queue_purge - empty a list
  1109. * @list: list to empty
  1110. *
  1111. * Delete all buffers on an &sk_buff list. Each buffer is removed from
  1112. * the list and one reference dropped. This function does not take the
  1113. * list lock and the caller must hold the relevant locks to use it.
  1114. */
  1115. extern void skb_queue_purge(struct sk_buff_head *list);
  1116. static inline void __skb_queue_purge(struct sk_buff_head *list)
  1117. {
  1118. struct sk_buff *skb;
  1119. while ((skb = __skb_dequeue(list)) != NULL)
  1120. kfree_skb(skb);
  1121. }
  1122. /**
  1123. * __dev_alloc_skb - allocate an skbuff for receiving
  1124. * @length: length to allocate
  1125. * @gfp_mask: get_free_pages mask, passed to alloc_skb
  1126. *
  1127. * Allocate a new &sk_buff and assign it a usage count of one. The
  1128. * buffer has unspecified headroom built in. Users should allocate
  1129. * the headroom they think they need without accounting for the
  1130. * built in space. The built in space is used for optimisations.
  1131. *
  1132. * %NULL is returned if there is no free memory.
  1133. */
  1134. static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
  1135. gfp_t gfp_mask)
  1136. {
  1137. struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
  1138. if (likely(skb))
  1139. skb_reserve(skb, NET_SKB_PAD);
  1140. return skb;
  1141. }
  1142. /**
  1143. * dev_alloc_skb - allocate an skbuff for receiving
  1144. * @length: length to allocate
  1145. *
  1146. * Allocate a new &sk_buff and assign it a usage count of one. The
  1147. * buffer has unspecified headroom built in. Users should allocate
  1148. * the headroom they think they need without accounting for the
  1149. * built in space. The built in space is used for optimisations.
  1150. *
  1151. * %NULL is returned if there is no free memory. Although this function
  1152. * allocates memory it can be called from an interrupt.
  1153. */
  1154. static inline struct sk_buff *dev_alloc_skb(unsigned int length)
  1155. {
  1156. return __dev_alloc_skb(length, GFP_ATOMIC);
  1157. }
  1158. extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
  1159. unsigned int length, gfp_t gfp_mask);
  1160. /**
  1161. * netdev_alloc_skb - allocate an skbuff for rx on a specific device
  1162. * @dev: network device to receive on
  1163. * @length: length to allocate
  1164. *
  1165. * Allocate a new &sk_buff and assign it a usage count of one. The
  1166. * buffer has unspecified headroom built in. Users should allocate
  1167. * the headroom they think they need without accounting for the
  1168. * built in space. The built in space is used for optimisations.
  1169. *
  1170. * %NULL is returned if there is no free memory. Although this function
  1171. * allocates memory it can be called from an interrupt.
  1172. */
  1173. static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
  1174. unsigned int length)
  1175. {
  1176. return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
  1177. }
  1178. /**
  1179. * skb_clone_writable - is the header of a clone writable
  1180. * @skb: buffer to check
  1181. * @len: length up to which to write
  1182. *
  1183. * Returns true if modifying the header part of the cloned buffer
  1184. * does not requires the data to be copied.
  1185. */
  1186. static inline int skb_clone_writable(struct sk_buff *skb, unsigned int len)
  1187. {
  1188. return !skb_header_cloned(skb) &&
  1189. skb_headroom(skb) + len <= skb->hdr_len;
  1190. }
  1191. static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
  1192. int cloned)
  1193. {
  1194. int delta = 0;
  1195. if (headroom < NET_SKB_PAD)
  1196. headroom = NET_SKB_PAD;
  1197. if (headroom > skb_headroom(skb))
  1198. delta = headroom - skb_headroom(skb);
  1199. if (delta || cloned)
  1200. return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
  1201. GFP_ATOMIC);
  1202. return 0;
  1203. }
  1204. /**
  1205. * skb_cow - copy header of skb when it is required
  1206. * @skb: buffer to cow
  1207. * @headroom: needed headroom
  1208. *
  1209. * If the skb passed lacks sufficient headroom or its data part
  1210. * is shared, data is reallocated. If reallocation fails, an error
  1211. * is returned and original skb is not changed.
  1212. *
  1213. * The result is skb with writable area skb->head...skb->tail
  1214. * and at least @headroom of space at head.
  1215. */
  1216. static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
  1217. {
  1218. return __skb_cow(skb, headroom, skb_cloned(skb));
  1219. }
  1220. /**
  1221. * skb_cow_head - skb_cow but only making the head writable
  1222. * @skb: buffer to cow
  1223. * @headroom: needed headroom
  1224. *
  1225. * This function is identical to skb_cow except that we replace the
  1226. * skb_cloned check by skb_header_cloned. It should be used when
  1227. * you only need to push on some header and do not need to modify
  1228. * the data.
  1229. */
  1230. static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
  1231. {
  1232. return __skb_cow(skb, headroom, skb_header_cloned(skb));
  1233. }
  1234. /**
  1235. * skb_padto - pad an skbuff up to a minimal size
  1236. * @skb: buffer to pad
  1237. * @len: minimal length
  1238. *
  1239. * Pads up a buffer to ensure the trailing bytes exist and are
  1240. * blanked. If the buffer already contains sufficient data it
  1241. * is untouched. Otherwise it is extended. Returns zero on
  1242. * success. The skb is freed on error.
  1243. */
  1244. static inline int skb_padto(struct sk_buff *skb, unsigned int len)
  1245. {
  1246. unsigned int size = skb->len;
  1247. if (likely(size >= len))
  1248. return 0;
  1249. return skb_pad(skb, len-size);
  1250. }
  1251. static inline int skb_add_data(struct sk_buff *skb,
  1252. char __user *from, int copy)
  1253. {
  1254. const int off = skb->len;
  1255. if (skb->ip_summed == CHECKSUM_NONE) {
  1256. int err = 0;
  1257. __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
  1258. copy, 0, &err);
  1259. if (!err) {
  1260. skb->csum = csum_block_add(skb->csum, csum, off);
  1261. return 0;
  1262. }
  1263. } else if (!copy_from_user(skb_put(skb, copy), from, copy))
  1264. return 0;
  1265. __skb_trim(skb, off);
  1266. return -EFAULT;
  1267. }
  1268. static inline int skb_can_coalesce(struct sk_buff *skb, int i,
  1269. struct page *page, int off)
  1270. {
  1271. if (i) {
  1272. struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
  1273. return page == frag->page &&
  1274. off == frag->page_offset + frag->size;
  1275. }
  1276. return 0;
  1277. }
  1278. static inline int __skb_linearize(struct sk_buff *skb)
  1279. {
  1280. return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
  1281. }
  1282. /**
  1283. * skb_linearize - convert paged skb to linear one
  1284. * @skb: buffer to linarize
  1285. *
  1286. * If there is no free memory -ENOMEM is returned, otherwise zero
  1287. * is returned and the old skb data released.
  1288. */
  1289. static inline int skb_linearize(struct sk_buff *skb)
  1290. {
  1291. return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
  1292. }
  1293. /**
  1294. * skb_linearize_cow - make sure skb is linear and writable
  1295. * @skb: buffer to process
  1296. *
  1297. * If there is no free memory -ENOMEM is returned, otherwise zero
  1298. * is returned and the old skb data released.
  1299. */
  1300. static inline int skb_linearize_cow(struct sk_buff *skb)
  1301. {
  1302. return skb_is_nonlinear(skb) || skb_cloned(skb) ?
  1303. __skb_linearize(skb) : 0;
  1304. }
  1305. /**
  1306. * skb_postpull_rcsum - update checksum for received skb after pull
  1307. * @skb: buffer to update
  1308. * @start: start of data before pull
  1309. * @len: length of data pulled
  1310. *
  1311. * After doing a pull on a received packet, you need to call this to
  1312. * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
  1313. * CHECKSUM_NONE so that it can be recomputed from scratch.
  1314. */
  1315. static inline void skb_postpull_rcsum(struct sk_buff *skb,
  1316. const void *start, unsigned int len)
  1317. {
  1318. if (skb->ip_summed == CHECKSUM_COMPLETE)
  1319. skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
  1320. }
  1321. unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
  1322. /**
  1323. * pskb_trim_rcsum - trim received skb and update checksum
  1324. * @skb: buffer to trim
  1325. * @len: new length
  1326. *
  1327. * This is exactly the same as pskb_trim except that it ensures the
  1328. * checksum of received packets are still valid after the operation.
  1329. */
  1330. static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
  1331. {
  1332. if (likely(len >= skb->len))
  1333. return 0;
  1334. if (skb->ip_summed == CHECKSUM_COMPLETE)
  1335. skb->ip_summed = CHECKSUM_NONE;
  1336. return __pskb_trim(skb, len);
  1337. }
  1338. #define skb_queue_walk(queue, skb) \
  1339. for (skb = (queue)->next; \
  1340. prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
  1341. skb = skb->next)
  1342. #define skb_queue_walk_safe(queue, skb, tmp) \
  1343. for (skb = (queue)->next, tmp = skb->next; \
  1344. skb != (struct sk_buff *)(queue); \
  1345. skb = tmp, tmp = skb->next)
  1346. #define skb_queue_reverse_walk(queue, skb) \
  1347. for (skb = (queue)->prev; \
  1348. prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
  1349. skb = skb->prev)
  1350. extern struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
  1351. int *peeked, int *err);
  1352. extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
  1353. int noblock, int *err);
  1354. extern unsigned int datagram_poll(struct file *file, struct socket *sock,
  1355. struct poll_table_struct *wait);
  1356. extern int skb_copy_datagram_iovec(const struct sk_buff *from,
  1357. int offset, struct iovec *to,
  1358. int size);
  1359. extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
  1360. int hlen,
  1361. struct iovec *iov);
  1362. extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
  1363. extern int skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
  1364. unsigned int flags);
  1365. extern __wsum skb_checksum(const struct sk_buff *skb, int offset,
  1366. int len, __wsum csum);
  1367. extern int skb_copy_bits(const struct sk_buff *skb, int offset,
  1368. void *to, int len);
  1369. extern int skb_store_bits(struct sk_buff *skb, int offset,
  1370. const void *from, int len);
  1371. extern __wsum skb_copy_and_csum_bits(const struct sk_buff *skb,
  1372. int offset, u8 *to, int len,
  1373. __wsum csum);
  1374. extern int skb_splice_bits(struct sk_buff *skb,
  1375. unsigned int offset,
  1376. struct pipe_inode_info *pipe,
  1377. unsigned int len,
  1378. unsigned int flags);
  1379. extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
  1380. extern void skb_split(struct sk_buff *skb,
  1381. struct sk_buff *skb1, const u32 len);
  1382. extern struct sk_buff *skb_segment(struct sk_buff *skb, int features);
  1383. static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
  1384. int len, void *buffer)
  1385. {
  1386. int hlen = skb_headlen(skb);
  1387. if (hlen - offset >= len)
  1388. return skb->data + offset;
  1389. if (skb_copy_bits(skb, offset, buffer, len) < 0)
  1390. return NULL;
  1391. return buffer;
  1392. }
  1393. static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
  1394. void *to,
  1395. const unsigned int len)
  1396. {
  1397. memcpy(to, skb->data, len);
  1398. }
  1399. static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
  1400. const int offset, void *to,
  1401. const unsigned int len)
  1402. {
  1403. memcpy(to, skb->data + offset, len);
  1404. }
  1405. static inline void skb_copy_to_linear_data(struct sk_buff *skb,
  1406. const void *from,
  1407. const unsigned int len)
  1408. {
  1409. memcpy(skb->data, from, len);
  1410. }
  1411. static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
  1412. const int offset,
  1413. const void *from,
  1414. const unsigned int len)
  1415. {
  1416. memcpy(skb->data + offset, from, len);
  1417. }
  1418. extern void skb_init(void);
  1419. /**
  1420. * skb_get_timestamp - get timestamp from a skb
  1421. * @skb: skb to get stamp from
  1422. * @stamp: pointer to struct timeval to store stamp in
  1423. *
  1424. * Timestamps are stored in the skb as offsets to a base timestamp.
  1425. * This function converts the offset back to a struct timeval and stores
  1426. * it in stamp.
  1427. */
  1428. static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
  1429. {
  1430. *stamp = ktime_to_timeval(skb->tstamp);
  1431. }
  1432. static inline void __net_timestamp(struct sk_buff *skb)
  1433. {
  1434. skb->tstamp = ktime_get_real();
  1435. }
  1436. static inline ktime_t net_timedelta(ktime_t t)
  1437. {
  1438. return ktime_sub(ktime_get_real(), t);
  1439. }
  1440. static inline ktime_t net_invalid_timestamp(void)
  1441. {
  1442. return ktime_set(0, 0);
  1443. }
  1444. extern __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
  1445. extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
  1446. static inline int skb_csum_unnecessary(const struct sk_buff *skb)
  1447. {
  1448. return skb->ip_summed & CHECKSUM_UNNECESSARY;
  1449. }
  1450. /**
  1451. * skb_checksum_complete - Calculate checksum of an entire packet
  1452. * @skb: packet to process
  1453. *
  1454. * This function calculates the checksum over the entire packet plus
  1455. * the value of skb->csum. The latter can be used to supply the
  1456. * checksum of a pseudo header as used by TCP/UDP. It returns the
  1457. * checksum.
  1458. *
  1459. * For protocols that contain complete checksums such as ICMP/TCP/UDP,
  1460. * this function can be used to verify that checksum on received
  1461. * packets. In that case the function should return zero if the
  1462. * checksum is correct. In particular, this function will return zero
  1463. * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
  1464. * hardware has already verified the correctness of the checksum.
  1465. */
  1466. static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
  1467. {
  1468. return skb_csum_unnecessary(skb) ?
  1469. 0 : __skb_checksum_complete(skb);
  1470. }
  1471. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  1472. extern void nf_conntrack_destroy(struct nf_conntrack *nfct);
  1473. static inline void nf_conntrack_put(struct nf_conntrack *nfct)
  1474. {
  1475. if (nfct && atomic_dec_and_test(&nfct->use))
  1476. nf_conntrack_destroy(nfct);
  1477. }
  1478. static inline void nf_conntrack_get(struct nf_conntrack *nfct)
  1479. {
  1480. if (nfct)
  1481. atomic_inc(&nfct->use);
  1482. }
  1483. static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
  1484. {
  1485. if (skb)
  1486. atomic_inc(&skb->users);
  1487. }
  1488. static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
  1489. {
  1490. if (skb)
  1491. kfree_skb(skb);
  1492. }
  1493. #endif
  1494. #ifdef CONFIG_BRIDGE_NETFILTER
  1495. static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
  1496. {
  1497. if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
  1498. kfree(nf_bridge);
  1499. }
  1500. static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
  1501. {
  1502. if (nf_bridge)
  1503. atomic_inc(&nf_bridge->use);
  1504. }
  1505. #endif /* CONFIG_BRIDGE_NETFILTER */
  1506. static inline void nf_reset(struct sk_buff *skb)
  1507. {
  1508. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  1509. nf_conntrack_put(skb->nfct);
  1510. skb->nfct = NULL;
  1511. nf_conntrack_put_reasm(skb->nfct_reasm);
  1512. skb->nfct_reasm = NULL;
  1513. #endif
  1514. #ifdef CONFIG_BRIDGE_NETFILTER
  1515. nf_bridge_put(skb->nf_bridge);
  1516. skb->nf_bridge = NULL;
  1517. #endif
  1518. }
  1519. /* Note: This doesn't put any conntrack and bridge info in dst. */
  1520. static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src)
  1521. {
  1522. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  1523. dst->nfct = src->nfct;
  1524. nf_conntrack_get(src->nfct);
  1525. dst->nfctinfo = src->nfctinfo;
  1526. dst->nfct_reasm = src->nfct_reasm;
  1527. nf_conntrack_get_reasm(src->nfct_reasm);
  1528. #endif
  1529. #ifdef CONFIG_BRIDGE_NETFILTER
  1530. dst->nf_bridge = src->nf_bridge;
  1531. nf_bridge_get(src->nf_bridge);
  1532. #endif
  1533. }
  1534. static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
  1535. {
  1536. #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  1537. nf_conntrack_put(dst->nfct);
  1538. nf_conntrack_put_reasm(dst->nfct_reasm);
  1539. #endif
  1540. #ifdef CONFIG_BRIDGE_NETFILTER
  1541. nf_bridge_put(dst->nf_bridge);
  1542. #endif
  1543. __nf_copy(dst, src);
  1544. }
  1545. #ifdef CONFIG_NETWORK_SECMARK
  1546. static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
  1547. {
  1548. to->secmark = from->secmark;
  1549. }
  1550. static inline void skb_init_secmark(struct sk_buff *skb)
  1551. {
  1552. skb->secmark = 0;
  1553. }
  1554. #else
  1555. static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
  1556. { }
  1557. static inline void skb_init_secmark(struct sk_buff *skb)
  1558. { }
  1559. #endif
  1560. static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
  1561. {
  1562. #ifdef CONFIG_NETDEVICES_MULTIQUEUE
  1563. skb->queue_mapping = queue_mapping;
  1564. #endif
  1565. }
  1566. static inline u16 skb_get_queue_mapping(struct sk_buff *skb)
  1567. {
  1568. #ifdef CONFIG_NETDEVICES_MULTIQUEUE
  1569. return skb->queue_mapping;
  1570. #else
  1571. return 0;
  1572. #endif
  1573. }
  1574. static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
  1575. {
  1576. #ifdef CONFIG_NETDEVICES_MULTIQUEUE
  1577. to->queue_mapping = from->queue_mapping;
  1578. #endif
  1579. }
  1580. static inline int skb_is_gso(const struct sk_buff *skb)
  1581. {
  1582. return skb_shinfo(skb)->gso_size;
  1583. }
  1584. static inline int skb_is_gso_v6(const struct sk_buff *skb)
  1585. {
  1586. return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
  1587. }
  1588. static inline void skb_forward_csum(struct sk_buff *skb)
  1589. {
  1590. /* Unfortunately we don't support this one. Any brave souls? */
  1591. if (skb->ip_summed == CHECKSUM_COMPLETE)
  1592. skb->ip_summed = CHECKSUM_NONE;
  1593. }
  1594. bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
  1595. #endif /* __KERNEL__ */
  1596. #endif /* _LINUX_SKBUFF_H */