skbuff.h 50 KB

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