skbuff.h 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255
  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/config.h>
  16. #include <linux/kernel.h>
  17. #include <linux/compiler.h>
  18. #include <linux/time.h>
  19. #include <linux/cache.h>
  20. #include <asm/atomic.h>
  21. #include <asm/types.h>
  22. #include <linux/spinlock.h>
  23. #include <linux/mm.h>
  24. #include <linux/highmem.h>
  25. #include <linux/poll.h>
  26. #include <linux/net.h>
  27. #include <net/checksum.h>
  28. #define HAVE_ALLOC_SKB /* For the drivers to know */
  29. #define HAVE_ALIGNABLE_SKB /* Ditto 8) */
  30. #define SLAB_SKB /* Slabified skbuffs */
  31. #define CHECKSUM_NONE 0
  32. #define CHECKSUM_HW 1
  33. #define CHECKSUM_UNNECESSARY 2
  34. #define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
  35. ~(SMP_CACHE_BYTES - 1))
  36. #define SKB_MAX_ORDER(X, ORDER) (((PAGE_SIZE << (ORDER)) - (X) - \
  37. sizeof(struct skb_shared_info)) & \
  38. ~(SMP_CACHE_BYTES - 1))
  39. #define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
  40. #define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
  41. /* A. Checksumming of received packets by device.
  42. *
  43. * NONE: device failed to checksum this packet.
  44. * skb->csum is undefined.
  45. *
  46. * UNNECESSARY: device parsed packet and wouldbe verified checksum.
  47. * skb->csum is undefined.
  48. * It is bad option, but, unfortunately, many of vendors do this.
  49. * Apparently with secret goal to sell you new device, when you
  50. * will add new protocol to your host. F.e. IPv6. 8)
  51. *
  52. * HW: the most generic way. Device supplied checksum of _all_
  53. * the packet as seen by netif_rx in skb->csum.
  54. * NOTE: Even if device supports only some protocols, but
  55. * is able to produce some skb->csum, it MUST use HW,
  56. * not UNNECESSARY.
  57. *
  58. * B. Checksumming on output.
  59. *
  60. * NONE: skb is checksummed by protocol or csum is not required.
  61. *
  62. * HW: device is required to csum packet as seen by hard_start_xmit
  63. * from skb->h.raw to the end and to record the checksum
  64. * at skb->h.raw+skb->csum.
  65. *
  66. * Device must show its capabilities in dev->features, set
  67. * at device setup time.
  68. * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
  69. * everything.
  70. * NETIF_F_NO_CSUM - loopback or reliable single hop media.
  71. * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
  72. * TCP/UDP over IPv4. Sigh. Vendors like this
  73. * way by an unknown reason. Though, see comment above
  74. * about CHECKSUM_UNNECESSARY. 8)
  75. *
  76. * Any questions? No questions, good. --ANK
  77. */
  78. struct net_device;
  79. #ifdef CONFIG_NETFILTER
  80. struct nf_conntrack {
  81. atomic_t use;
  82. void (*destroy)(struct nf_conntrack *);
  83. };
  84. #ifdef CONFIG_BRIDGE_NETFILTER
  85. struct nf_bridge_info {
  86. atomic_t use;
  87. struct net_device *physindev;
  88. struct net_device *physoutdev;
  89. #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
  90. struct net_device *netoutdev;
  91. #endif
  92. unsigned int mask;
  93. unsigned long data[32 / sizeof(unsigned long)];
  94. };
  95. #endif
  96. #endif
  97. struct sk_buff_head {
  98. /* These two members must be first. */
  99. struct sk_buff *next;
  100. struct sk_buff *prev;
  101. __u32 qlen;
  102. spinlock_t lock;
  103. };
  104. struct sk_buff;
  105. /* To allow 64K frame to be packed as single skb without frag_list */
  106. #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
  107. typedef struct skb_frag_struct skb_frag_t;
  108. struct skb_frag_struct {
  109. struct page *page;
  110. __u16 page_offset;
  111. __u16 size;
  112. };
  113. /* This data is invariant across clones and lives at
  114. * the end of the header data, ie. at skb->end.
  115. */
  116. struct skb_shared_info {
  117. atomic_t dataref;
  118. unsigned int nr_frags;
  119. unsigned short tso_size;
  120. unsigned short tso_segs;
  121. struct sk_buff *frag_list;
  122. skb_frag_t frags[MAX_SKB_FRAGS];
  123. };
  124. /* We divide dataref into two halves. The higher 16 bits hold references
  125. * to the payload part of skb->data. The lower 16 bits hold references to
  126. * the entire skb->data. It is up to the users of the skb to agree on
  127. * where the payload starts.
  128. *
  129. * All users must obey the rule that the skb->data reference count must be
  130. * greater than or equal to the payload reference count.
  131. *
  132. * Holding a reference to the payload part means that the user does not
  133. * care about modifications to the header part of skb->data.
  134. */
  135. #define SKB_DATAREF_SHIFT 16
  136. #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
  137. /**
  138. * struct sk_buff - socket buffer
  139. * @next: Next buffer in list
  140. * @prev: Previous buffer in list
  141. * @list: List we are on
  142. * @sk: Socket we are owned by
  143. * @stamp: Time we arrived
  144. * @dev: Device we arrived on/are leaving by
  145. * @input_dev: Device we arrived on
  146. * @real_dev: The real device we are using
  147. * @h: Transport layer header
  148. * @nh: Network layer header
  149. * @mac: Link layer header
  150. * @dst: destination entry
  151. * @sp: the security path, used for xfrm
  152. * @cb: Control buffer. Free for use by every layer. Put private vars here
  153. * @len: Length of actual data
  154. * @data_len: Data length
  155. * @mac_len: Length of link layer header
  156. * @csum: Checksum
  157. * @local_df: allow local fragmentation
  158. * @cloned: Head may be cloned (check refcnt to be sure)
  159. * @nohdr: Payload reference only, must not modify header
  160. * @pkt_type: Packet class
  161. * @ip_summed: Driver fed us an IP checksum
  162. * @priority: Packet queueing priority
  163. * @users: User count - see {datagram,tcp}.c
  164. * @protocol: Packet protocol from driver
  165. * @security: Security level of packet
  166. * @truesize: Buffer size
  167. * @head: Head of buffer
  168. * @data: Data head pointer
  169. * @tail: Tail pointer
  170. * @end: End pointer
  171. * @destructor: Destruct function
  172. * @nfmark: Can be used for communication between hooks
  173. * @nfcache: Cache info
  174. * @nfct: Associated connection, if any
  175. * @nfctinfo: Relationship of this skb to the connection
  176. * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
  177. * @private: Data which is private to the HIPPI implementation
  178. * @tc_index: Traffic control index
  179. * @tc_verd: traffic control verdict
  180. * @tc_classid: traffic control classid
  181. */
  182. struct sk_buff {
  183. /* These two members must be first. */
  184. struct sk_buff *next;
  185. struct sk_buff *prev;
  186. struct sk_buff_head *list;
  187. struct sock *sk;
  188. struct timeval stamp;
  189. struct net_device *dev;
  190. struct net_device *input_dev;
  191. struct net_device *real_dev;
  192. union {
  193. struct tcphdr *th;
  194. struct udphdr *uh;
  195. struct icmphdr *icmph;
  196. struct igmphdr *igmph;
  197. struct iphdr *ipiph;
  198. struct ipv6hdr *ipv6h;
  199. unsigned char *raw;
  200. } h;
  201. union {
  202. struct iphdr *iph;
  203. struct ipv6hdr *ipv6h;
  204. struct arphdr *arph;
  205. unsigned char *raw;
  206. } nh;
  207. union {
  208. unsigned char *raw;
  209. } mac;
  210. struct dst_entry *dst;
  211. struct sec_path *sp;
  212. /*
  213. * This is the control buffer. It is free to use for every
  214. * layer. Please put your private variables there. If you
  215. * want to keep them across layers you have to do a skb_clone()
  216. * first. This is owned by whoever has the skb queued ATM.
  217. */
  218. char cb[40];
  219. unsigned int len,
  220. data_len,
  221. mac_len,
  222. csum;
  223. unsigned char local_df,
  224. cloned:1,
  225. nohdr:1,
  226. pkt_type,
  227. ip_summed;
  228. __u32 priority;
  229. unsigned short protocol,
  230. security;
  231. void (*destructor)(struct sk_buff *skb);
  232. #ifdef CONFIG_NETFILTER
  233. unsigned long nfmark;
  234. __u32 nfcache;
  235. __u32 nfctinfo;
  236. struct nf_conntrack *nfct;
  237. #ifdef CONFIG_BRIDGE_NETFILTER
  238. struct nf_bridge_info *nf_bridge;
  239. #endif
  240. #endif /* CONFIG_NETFILTER */
  241. #if defined(CONFIG_HIPPI)
  242. union {
  243. __u32 ifield;
  244. } private;
  245. #endif
  246. #ifdef CONFIG_NET_SCHED
  247. __u32 tc_index; /* traffic control index */
  248. #ifdef CONFIG_NET_CLS_ACT
  249. __u32 tc_verd; /* traffic control verdict */
  250. __u32 tc_classid; /* traffic control classid */
  251. #endif
  252. #endif
  253. /* These elements must be at the end, see alloc_skb() for details. */
  254. unsigned int truesize;
  255. atomic_t users;
  256. unsigned char *head,
  257. *data,
  258. *tail,
  259. *end;
  260. };
  261. #ifdef __KERNEL__
  262. /*
  263. * Handling routines are only of interest to the kernel
  264. */
  265. #include <linux/slab.h>
  266. #include <asm/system.h>
  267. extern void __kfree_skb(struct sk_buff *skb);
  268. extern struct sk_buff *alloc_skb(unsigned int size, int priority);
  269. extern struct sk_buff *alloc_skb_from_cache(kmem_cache_t *cp,
  270. unsigned int size, int priority);
  271. extern void kfree_skbmem(struct sk_buff *skb);
  272. extern struct sk_buff *skb_clone(struct sk_buff *skb, int priority);
  273. extern struct sk_buff *skb_copy(const struct sk_buff *skb, int priority);
  274. extern struct sk_buff *pskb_copy(struct sk_buff *skb, int gfp_mask);
  275. extern int pskb_expand_head(struct sk_buff *skb,
  276. int nhead, int ntail, int gfp_mask);
  277. extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
  278. unsigned int headroom);
  279. extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
  280. int newheadroom, int newtailroom,
  281. int priority);
  282. extern struct sk_buff * skb_pad(struct sk_buff *skb, int pad);
  283. #define dev_kfree_skb(a) kfree_skb(a)
  284. extern void skb_over_panic(struct sk_buff *skb, int len,
  285. void *here);
  286. extern void skb_under_panic(struct sk_buff *skb, int len,
  287. void *here);
  288. struct skb_seq_state
  289. {
  290. __u32 lower_offset;
  291. __u32 upper_offset;
  292. __u32 frag_idx;
  293. __u32 stepped_offset;
  294. struct sk_buff *root_skb;
  295. struct sk_buff *cur_skb;
  296. __u8 *frag_data;
  297. };
  298. extern void skb_prepare_seq_read(struct sk_buff *skb,
  299. unsigned int from, unsigned int to,
  300. struct skb_seq_state *st);
  301. extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
  302. struct skb_seq_state *st);
  303. extern void skb_abort_seq_read(struct skb_seq_state *st);
  304. /* Internal */
  305. #define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
  306. /**
  307. * skb_queue_empty - check if a queue is empty
  308. * @list: queue head
  309. *
  310. * Returns true if the queue is empty, false otherwise.
  311. */
  312. static inline int skb_queue_empty(const struct sk_buff_head *list)
  313. {
  314. return list->next == (struct sk_buff *)list;
  315. }
  316. /**
  317. * skb_get - reference buffer
  318. * @skb: buffer to reference
  319. *
  320. * Makes another reference to a socket buffer and returns a pointer
  321. * to the buffer.
  322. */
  323. static inline struct sk_buff *skb_get(struct sk_buff *skb)
  324. {
  325. atomic_inc(&skb->users);
  326. return skb;
  327. }
  328. /*
  329. * If users == 1, we are the only owner and are can avoid redundant
  330. * atomic change.
  331. */
  332. /**
  333. * kfree_skb - free an sk_buff
  334. * @skb: buffer to free
  335. *
  336. * Drop a reference to the buffer and free it if the usage count has
  337. * hit zero.
  338. */
  339. static inline void kfree_skb(struct sk_buff *skb)
  340. {
  341. if (likely(atomic_read(&skb->users) == 1))
  342. smp_rmb();
  343. else if (likely(!atomic_dec_and_test(&skb->users)))
  344. return;
  345. __kfree_skb(skb);
  346. }
  347. /**
  348. * skb_cloned - is the buffer a clone
  349. * @skb: buffer to check
  350. *
  351. * Returns true if the buffer was generated with skb_clone() and is
  352. * one of multiple shared copies of the buffer. Cloned buffers are
  353. * shared data so must not be written to under normal circumstances.
  354. */
  355. static inline int skb_cloned(const struct sk_buff *skb)
  356. {
  357. return skb->cloned &&
  358. (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
  359. }
  360. /**
  361. * skb_header_cloned - is the header a clone
  362. * @skb: buffer to check
  363. *
  364. * Returns true if modifying the header part of the buffer requires
  365. * the data to be copied.
  366. */
  367. static inline int skb_header_cloned(const struct sk_buff *skb)
  368. {
  369. int dataref;
  370. if (!skb->cloned)
  371. return 0;
  372. dataref = atomic_read(&skb_shinfo(skb)->dataref);
  373. dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
  374. return dataref != 1;
  375. }
  376. /**
  377. * skb_header_release - release reference to header
  378. * @skb: buffer to operate on
  379. *
  380. * Drop a reference to the header part of the buffer. This is done
  381. * by acquiring a payload reference. You must not read from the header
  382. * part of skb->data after this.
  383. */
  384. static inline void skb_header_release(struct sk_buff *skb)
  385. {
  386. BUG_ON(skb->nohdr);
  387. skb->nohdr = 1;
  388. atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
  389. }
  390. /**
  391. * skb_shared - is the buffer shared
  392. * @skb: buffer to check
  393. *
  394. * Returns true if more than one person has a reference to this
  395. * buffer.
  396. */
  397. static inline int skb_shared(const struct sk_buff *skb)
  398. {
  399. return atomic_read(&skb->users) != 1;
  400. }
  401. /**
  402. * skb_share_check - check if buffer is shared and if so clone it
  403. * @skb: buffer to check
  404. * @pri: priority for memory allocation
  405. *
  406. * If the buffer is shared the buffer is cloned and the old copy
  407. * drops a reference. A new clone with a single reference is returned.
  408. * If the buffer is not shared the original buffer is returned. When
  409. * being called from interrupt status or with spinlocks held pri must
  410. * be GFP_ATOMIC.
  411. *
  412. * NULL is returned on a memory allocation failure.
  413. */
  414. static inline struct sk_buff *skb_share_check(struct sk_buff *skb, int pri)
  415. {
  416. might_sleep_if(pri & __GFP_WAIT);
  417. if (skb_shared(skb)) {
  418. struct sk_buff *nskb = skb_clone(skb, pri);
  419. kfree_skb(skb);
  420. skb = nskb;
  421. }
  422. return skb;
  423. }
  424. /*
  425. * Copy shared buffers into a new sk_buff. We effectively do COW on
  426. * packets to handle cases where we have a local reader and forward
  427. * and a couple of other messy ones. The normal one is tcpdumping
  428. * a packet thats being forwarded.
  429. */
  430. /**
  431. * skb_unshare - make a copy of a shared buffer
  432. * @skb: buffer to check
  433. * @pri: priority for memory allocation
  434. *
  435. * If the socket buffer is a clone then this function creates a new
  436. * copy of the data, drops a reference count on the old copy and returns
  437. * the new copy with the reference count at 1. If the buffer is not a clone
  438. * the original buffer is returned. When called with a spinlock held or
  439. * from interrupt state @pri must be %GFP_ATOMIC
  440. *
  441. * %NULL is returned on a memory allocation failure.
  442. */
  443. static inline struct sk_buff *skb_unshare(struct sk_buff *skb, int pri)
  444. {
  445. might_sleep_if(pri & __GFP_WAIT);
  446. if (skb_cloned(skb)) {
  447. struct sk_buff *nskb = skb_copy(skb, pri);
  448. kfree_skb(skb); /* Free our shared copy */
  449. skb = nskb;
  450. }
  451. return skb;
  452. }
  453. /**
  454. * skb_peek
  455. * @list_: list to peek at
  456. *
  457. * Peek an &sk_buff. Unlike most other operations you _MUST_
  458. * be careful with this one. A peek leaves the buffer on the
  459. * list and someone else may run off with it. You must hold
  460. * the appropriate locks or have a private queue to do this.
  461. *
  462. * Returns %NULL for an empty list or a pointer to the head element.
  463. * The reference count is not incremented and the reference is therefore
  464. * volatile. Use with caution.
  465. */
  466. static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
  467. {
  468. struct sk_buff *list = ((struct sk_buff *)list_)->next;
  469. if (list == (struct sk_buff *)list_)
  470. list = NULL;
  471. return list;
  472. }
  473. /**
  474. * skb_peek_tail
  475. * @list_: list to peek at
  476. *
  477. * Peek an &sk_buff. Unlike most other operations you _MUST_
  478. * be careful with this one. A peek leaves the buffer on the
  479. * list and someone else may run off with it. You must hold
  480. * the appropriate locks or have a private queue to do this.
  481. *
  482. * Returns %NULL for an empty list or a pointer to the tail element.
  483. * The reference count is not incremented and the reference is therefore
  484. * volatile. Use with caution.
  485. */
  486. static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
  487. {
  488. struct sk_buff *list = ((struct sk_buff *)list_)->prev;
  489. if (list == (struct sk_buff *)list_)
  490. list = NULL;
  491. return list;
  492. }
  493. /**
  494. * skb_queue_len - get queue length
  495. * @list_: list to measure
  496. *
  497. * Return the length of an &sk_buff queue.
  498. */
  499. static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
  500. {
  501. return list_->qlen;
  502. }
  503. static inline void skb_queue_head_init(struct sk_buff_head *list)
  504. {
  505. spin_lock_init(&list->lock);
  506. list->prev = list->next = (struct sk_buff *)list;
  507. list->qlen = 0;
  508. }
  509. /*
  510. * Insert an sk_buff at the start of a list.
  511. *
  512. * The "__skb_xxxx()" functions are the non-atomic ones that
  513. * can only be called with interrupts disabled.
  514. */
  515. /**
  516. * __skb_queue_head - queue a buffer at the list head
  517. * @list: list to use
  518. * @newsk: buffer to queue
  519. *
  520. * Queue a buffer at the start of a list. This function takes no locks
  521. * and you must therefore hold required locks before calling it.
  522. *
  523. * A buffer cannot be placed on two lists at the same time.
  524. */
  525. extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
  526. static inline void __skb_queue_head(struct sk_buff_head *list,
  527. struct sk_buff *newsk)
  528. {
  529. struct sk_buff *prev, *next;
  530. newsk->list = list;
  531. list->qlen++;
  532. prev = (struct sk_buff *)list;
  533. next = prev->next;
  534. newsk->next = next;
  535. newsk->prev = prev;
  536. next->prev = prev->next = newsk;
  537. }
  538. /**
  539. * __skb_queue_tail - queue a buffer at the list tail
  540. * @list: list to use
  541. * @newsk: buffer to queue
  542. *
  543. * Queue a buffer at the end of a list. This function takes no locks
  544. * and you must therefore hold required locks before calling it.
  545. *
  546. * A buffer cannot be placed on two lists at the same time.
  547. */
  548. extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
  549. static inline void __skb_queue_tail(struct sk_buff_head *list,
  550. struct sk_buff *newsk)
  551. {
  552. struct sk_buff *prev, *next;
  553. newsk->list = list;
  554. list->qlen++;
  555. next = (struct sk_buff *)list;
  556. prev = next->prev;
  557. newsk->next = next;
  558. newsk->prev = prev;
  559. next->prev = prev->next = newsk;
  560. }
  561. /**
  562. * __skb_dequeue - remove from the head of the queue
  563. * @list: list to dequeue from
  564. *
  565. * Remove the head of the list. This function does not take any locks
  566. * so must be used with appropriate locks held only. The head item is
  567. * returned or %NULL if the list is empty.
  568. */
  569. extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
  570. static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
  571. {
  572. struct sk_buff *next, *prev, *result;
  573. prev = (struct sk_buff *) list;
  574. next = prev->next;
  575. result = NULL;
  576. if (next != prev) {
  577. result = next;
  578. next = next->next;
  579. list->qlen--;
  580. next->prev = prev;
  581. prev->next = next;
  582. result->next = result->prev = NULL;
  583. result->list = NULL;
  584. }
  585. return result;
  586. }
  587. /*
  588. * Insert a packet on a list.
  589. */
  590. extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk);
  591. static inline void __skb_insert(struct sk_buff *newsk,
  592. struct sk_buff *prev, struct sk_buff *next,
  593. struct sk_buff_head *list)
  594. {
  595. newsk->next = next;
  596. newsk->prev = prev;
  597. next->prev = prev->next = newsk;
  598. newsk->list = list;
  599. list->qlen++;
  600. }
  601. /*
  602. * Place a packet after a given packet in a list.
  603. */
  604. extern void skb_append(struct sk_buff *old, struct sk_buff *newsk);
  605. static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk)
  606. {
  607. __skb_insert(newsk, old, old->next, old->list);
  608. }
  609. /*
  610. * remove sk_buff from list. _Must_ be called atomically, and with
  611. * the list known..
  612. */
  613. extern void skb_unlink(struct sk_buff *skb);
  614. static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
  615. {
  616. struct sk_buff *next, *prev;
  617. list->qlen--;
  618. next = skb->next;
  619. prev = skb->prev;
  620. skb->next = skb->prev = NULL;
  621. skb->list = NULL;
  622. next->prev = prev;
  623. prev->next = next;
  624. }
  625. /* XXX: more streamlined implementation */
  626. /**
  627. * __skb_dequeue_tail - remove from the tail of the queue
  628. * @list: list to dequeue from
  629. *
  630. * Remove the tail of the list. This function does not take any locks
  631. * so must be used with appropriate locks held only. The tail item is
  632. * returned or %NULL if the list is empty.
  633. */
  634. extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
  635. static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
  636. {
  637. struct sk_buff *skb = skb_peek_tail(list);
  638. if (skb)
  639. __skb_unlink(skb, list);
  640. return skb;
  641. }
  642. static inline int skb_is_nonlinear(const struct sk_buff *skb)
  643. {
  644. return skb->data_len;
  645. }
  646. static inline unsigned int skb_headlen(const struct sk_buff *skb)
  647. {
  648. return skb->len - skb->data_len;
  649. }
  650. static inline int skb_pagelen(const struct sk_buff *skb)
  651. {
  652. int i, len = 0;
  653. for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
  654. len += skb_shinfo(skb)->frags[i].size;
  655. return len + skb_headlen(skb);
  656. }
  657. static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
  658. struct page *page, int off, int size)
  659. {
  660. skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
  661. frag->page = page;
  662. frag->page_offset = off;
  663. frag->size = size;
  664. skb_shinfo(skb)->nr_frags = i + 1;
  665. }
  666. #define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
  667. #define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
  668. #define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
  669. /*
  670. * Add data to an sk_buff
  671. */
  672. static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
  673. {
  674. unsigned char *tmp = skb->tail;
  675. SKB_LINEAR_ASSERT(skb);
  676. skb->tail += len;
  677. skb->len += len;
  678. return tmp;
  679. }
  680. /**
  681. * skb_put - add data to a buffer
  682. * @skb: buffer to use
  683. * @len: amount of data to add
  684. *
  685. * This function extends the used data area of the buffer. If this would
  686. * exceed the total buffer size the kernel will panic. A pointer to the
  687. * first byte of the extra data is returned.
  688. */
  689. static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
  690. {
  691. unsigned char *tmp = skb->tail;
  692. SKB_LINEAR_ASSERT(skb);
  693. skb->tail += len;
  694. skb->len += len;
  695. if (unlikely(skb->tail>skb->end))
  696. skb_over_panic(skb, len, current_text_addr());
  697. return tmp;
  698. }
  699. static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
  700. {
  701. skb->data -= len;
  702. skb->len += len;
  703. return skb->data;
  704. }
  705. /**
  706. * skb_push - add data to the start of a buffer
  707. * @skb: buffer to use
  708. * @len: amount of data to add
  709. *
  710. * This function extends the used data area of the buffer at the buffer
  711. * start. If this would exceed the total buffer headroom the kernel will
  712. * panic. A pointer to the first byte of the extra data is returned.
  713. */
  714. static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
  715. {
  716. skb->data -= len;
  717. skb->len += len;
  718. if (unlikely(skb->data<skb->head))
  719. skb_under_panic(skb, len, current_text_addr());
  720. return skb->data;
  721. }
  722. static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
  723. {
  724. skb->len -= len;
  725. BUG_ON(skb->len < skb->data_len);
  726. return skb->data += len;
  727. }
  728. /**
  729. * skb_pull - remove data from the start of a buffer
  730. * @skb: buffer to use
  731. * @len: amount of data to remove
  732. *
  733. * This function removes data from the start of a buffer, returning
  734. * the memory to the headroom. A pointer to the next data in the buffer
  735. * is returned. Once the data has been pulled future pushes will overwrite
  736. * the old data.
  737. */
  738. static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
  739. {
  740. return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
  741. }
  742. extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
  743. static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
  744. {
  745. if (len > skb_headlen(skb) &&
  746. !__pskb_pull_tail(skb, len-skb_headlen(skb)))
  747. return NULL;
  748. skb->len -= len;
  749. return skb->data += len;
  750. }
  751. static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
  752. {
  753. return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
  754. }
  755. static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
  756. {
  757. if (likely(len <= skb_headlen(skb)))
  758. return 1;
  759. if (unlikely(len > skb->len))
  760. return 0;
  761. return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
  762. }
  763. /**
  764. * skb_headroom - bytes at buffer head
  765. * @skb: buffer to check
  766. *
  767. * Return the number of bytes of free space at the head of an &sk_buff.
  768. */
  769. static inline int skb_headroom(const struct sk_buff *skb)
  770. {
  771. return skb->data - skb->head;
  772. }
  773. /**
  774. * skb_tailroom - bytes at buffer end
  775. * @skb: buffer to check
  776. *
  777. * Return the number of bytes of free space at the tail of an sk_buff
  778. */
  779. static inline int skb_tailroom(const struct sk_buff *skb)
  780. {
  781. return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
  782. }
  783. /**
  784. * skb_reserve - adjust headroom
  785. * @skb: buffer to alter
  786. * @len: bytes to move
  787. *
  788. * Increase the headroom of an empty &sk_buff by reducing the tail
  789. * room. This is only allowed for an empty buffer.
  790. */
  791. static inline void skb_reserve(struct sk_buff *skb, unsigned int len)
  792. {
  793. skb->data += len;
  794. skb->tail += len;
  795. }
  796. /*
  797. * CPUs often take a performance hit when accessing unaligned memory
  798. * locations. The actual performance hit varies, it can be small if the
  799. * hardware handles it or large if we have to take an exception and fix it
  800. * in software.
  801. *
  802. * Since an ethernet header is 14 bytes network drivers often end up with
  803. * the IP header at an unaligned offset. The IP header can be aligned by
  804. * shifting the start of the packet by 2 bytes. Drivers should do this
  805. * with:
  806. *
  807. * skb_reserve(NET_IP_ALIGN);
  808. *
  809. * The downside to this alignment of the IP header is that the DMA is now
  810. * unaligned. On some architectures the cost of an unaligned DMA is high
  811. * and this cost outweighs the gains made by aligning the IP header.
  812. *
  813. * Since this trade off varies between architectures, we allow NET_IP_ALIGN
  814. * to be overridden.
  815. */
  816. #ifndef NET_IP_ALIGN
  817. #define NET_IP_ALIGN 2
  818. #endif
  819. extern int ___pskb_trim(struct sk_buff *skb, unsigned int len, int realloc);
  820. static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
  821. {
  822. if (!skb->data_len) {
  823. skb->len = len;
  824. skb->tail = skb->data + len;
  825. } else
  826. ___pskb_trim(skb, len, 0);
  827. }
  828. /**
  829. * skb_trim - remove end from a buffer
  830. * @skb: buffer to alter
  831. * @len: new length
  832. *
  833. * Cut the length of a buffer down by removing data from the tail. If
  834. * the buffer is already under the length specified it is not modified.
  835. */
  836. static inline void skb_trim(struct sk_buff *skb, unsigned int len)
  837. {
  838. if (skb->len > len)
  839. __skb_trim(skb, len);
  840. }
  841. static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
  842. {
  843. if (!skb->data_len) {
  844. skb->len = len;
  845. skb->tail = skb->data+len;
  846. return 0;
  847. }
  848. return ___pskb_trim(skb, len, 1);
  849. }
  850. static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
  851. {
  852. return (len < skb->len) ? __pskb_trim(skb, len) : 0;
  853. }
  854. /**
  855. * skb_orphan - orphan a buffer
  856. * @skb: buffer to orphan
  857. *
  858. * If a buffer currently has an owner then we call the owner's
  859. * destructor function and make the @skb unowned. The buffer continues
  860. * to exist but is no longer charged to its former owner.
  861. */
  862. static inline void skb_orphan(struct sk_buff *skb)
  863. {
  864. if (skb->destructor)
  865. skb->destructor(skb);
  866. skb->destructor = NULL;
  867. skb->sk = NULL;
  868. }
  869. /**
  870. * __skb_queue_purge - empty a list
  871. * @list: list to empty
  872. *
  873. * Delete all buffers on an &sk_buff list. Each buffer is removed from
  874. * the list and one reference dropped. This function does not take the
  875. * list lock and the caller must hold the relevant locks to use it.
  876. */
  877. extern void skb_queue_purge(struct sk_buff_head *list);
  878. static inline void __skb_queue_purge(struct sk_buff_head *list)
  879. {
  880. struct sk_buff *skb;
  881. while ((skb = __skb_dequeue(list)) != NULL)
  882. kfree_skb(skb);
  883. }
  884. #ifndef CONFIG_HAVE_ARCH_DEV_ALLOC_SKB
  885. /**
  886. * __dev_alloc_skb - allocate an skbuff for sending
  887. * @length: length to allocate
  888. * @gfp_mask: get_free_pages mask, passed to alloc_skb
  889. *
  890. * Allocate a new &sk_buff and assign it a usage count of one. The
  891. * buffer has unspecified headroom built in. Users should allocate
  892. * the headroom they think they need without accounting for the
  893. * built in space. The built in space is used for optimisations.
  894. *
  895. * %NULL is returned in there is no free memory.
  896. */
  897. static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
  898. int gfp_mask)
  899. {
  900. struct sk_buff *skb = alloc_skb(length + 16, gfp_mask);
  901. if (likely(skb))
  902. skb_reserve(skb, 16);
  903. return skb;
  904. }
  905. #else
  906. extern struct sk_buff *__dev_alloc_skb(unsigned int length, int gfp_mask);
  907. #endif
  908. /**
  909. * dev_alloc_skb - allocate an skbuff for sending
  910. * @length: length to allocate
  911. *
  912. * Allocate a new &sk_buff and assign it a usage count of one. The
  913. * buffer has unspecified headroom built in. Users should allocate
  914. * the headroom they think they need without accounting for the
  915. * built in space. The built in space is used for optimisations.
  916. *
  917. * %NULL is returned in there is no free memory. Although this function
  918. * allocates memory it can be called from an interrupt.
  919. */
  920. static inline struct sk_buff *dev_alloc_skb(unsigned int length)
  921. {
  922. return __dev_alloc_skb(length, GFP_ATOMIC);
  923. }
  924. /**
  925. * skb_cow - copy header of skb when it is required
  926. * @skb: buffer to cow
  927. * @headroom: needed headroom
  928. *
  929. * If the skb passed lacks sufficient headroom or its data part
  930. * is shared, data is reallocated. If reallocation fails, an error
  931. * is returned and original skb is not changed.
  932. *
  933. * The result is skb with writable area skb->head...skb->tail
  934. * and at least @headroom of space at head.
  935. */
  936. static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
  937. {
  938. int delta = (headroom > 16 ? headroom : 16) - skb_headroom(skb);
  939. if (delta < 0)
  940. delta = 0;
  941. if (delta || skb_cloned(skb))
  942. return pskb_expand_head(skb, (delta + 15) & ~15, 0, GFP_ATOMIC);
  943. return 0;
  944. }
  945. /**
  946. * skb_padto - pad an skbuff up to a minimal size
  947. * @skb: buffer to pad
  948. * @len: minimal length
  949. *
  950. * Pads up a buffer to ensure the trailing bytes exist and are
  951. * blanked. If the buffer already contains sufficient data it
  952. * is untouched. Returns the buffer, which may be a replacement
  953. * for the original, or NULL for out of memory - in which case
  954. * the original buffer is still freed.
  955. */
  956. static inline struct sk_buff *skb_padto(struct sk_buff *skb, unsigned int len)
  957. {
  958. unsigned int size = skb->len;
  959. if (likely(size >= len))
  960. return skb;
  961. return skb_pad(skb, len-size);
  962. }
  963. static inline int skb_add_data(struct sk_buff *skb,
  964. char __user *from, int copy)
  965. {
  966. const int off = skb->len;
  967. if (skb->ip_summed == CHECKSUM_NONE) {
  968. int err = 0;
  969. unsigned int csum = csum_and_copy_from_user(from,
  970. skb_put(skb, copy),
  971. copy, 0, &err);
  972. if (!err) {
  973. skb->csum = csum_block_add(skb->csum, csum, off);
  974. return 0;
  975. }
  976. } else if (!copy_from_user(skb_put(skb, copy), from, copy))
  977. return 0;
  978. __skb_trim(skb, off);
  979. return -EFAULT;
  980. }
  981. static inline int skb_can_coalesce(struct sk_buff *skb, int i,
  982. struct page *page, int off)
  983. {
  984. if (i) {
  985. struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
  986. return page == frag->page &&
  987. off == frag->page_offset + frag->size;
  988. }
  989. return 0;
  990. }
  991. /**
  992. * skb_linearize - convert paged skb to linear one
  993. * @skb: buffer to linarize
  994. * @gfp: allocation mode
  995. *
  996. * If there is no free memory -ENOMEM is returned, otherwise zero
  997. * is returned and the old skb data released.
  998. */
  999. extern int __skb_linearize(struct sk_buff *skb, int gfp);
  1000. static inline int skb_linearize(struct sk_buff *skb, int gfp)
  1001. {
  1002. return __skb_linearize(skb, gfp);
  1003. }
  1004. /**
  1005. * skb_postpull_rcsum - update checksum for received skb after pull
  1006. * @skb: buffer to update
  1007. * @start: start of data before pull
  1008. * @len: length of data pulled
  1009. *
  1010. * After doing a pull on a received packet, you need to call this to
  1011. * update the CHECKSUM_HW checksum, or set ip_summed to CHECKSUM_NONE
  1012. * so that it can be recomputed from scratch.
  1013. */
  1014. static inline void skb_postpull_rcsum(struct sk_buff *skb,
  1015. const void *start, int len)
  1016. {
  1017. if (skb->ip_summed == CHECKSUM_HW)
  1018. skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
  1019. }
  1020. /**
  1021. * pskb_trim_rcsum - trim received skb and update checksum
  1022. * @skb: buffer to trim
  1023. * @len: new length
  1024. *
  1025. * This is exactly the same as pskb_trim except that it ensures the
  1026. * checksum of received packets are still valid after the operation.
  1027. */
  1028. static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
  1029. {
  1030. if (len >= skb->len)
  1031. return 0;
  1032. if (skb->ip_summed == CHECKSUM_HW)
  1033. skb->ip_summed = CHECKSUM_NONE;
  1034. return __pskb_trim(skb, len);
  1035. }
  1036. static inline void *kmap_skb_frag(const skb_frag_t *frag)
  1037. {
  1038. #ifdef CONFIG_HIGHMEM
  1039. BUG_ON(in_irq());
  1040. local_bh_disable();
  1041. #endif
  1042. return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
  1043. }
  1044. static inline void kunmap_skb_frag(void *vaddr)
  1045. {
  1046. kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
  1047. #ifdef CONFIG_HIGHMEM
  1048. local_bh_enable();
  1049. #endif
  1050. }
  1051. #define skb_queue_walk(queue, skb) \
  1052. for (skb = (queue)->next; \
  1053. prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
  1054. skb = skb->next)
  1055. extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
  1056. int noblock, int *err);
  1057. extern unsigned int datagram_poll(struct file *file, struct socket *sock,
  1058. struct poll_table_struct *wait);
  1059. extern int skb_copy_datagram_iovec(const struct sk_buff *from,
  1060. int offset, struct iovec *to,
  1061. int size);
  1062. extern int skb_copy_and_csum_datagram_iovec(const
  1063. struct sk_buff *skb,
  1064. int hlen,
  1065. struct iovec *iov);
  1066. extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
  1067. extern unsigned int skb_checksum(const struct sk_buff *skb, int offset,
  1068. int len, unsigned int csum);
  1069. extern int skb_copy_bits(const struct sk_buff *skb, int offset,
  1070. void *to, int len);
  1071. extern int skb_store_bits(const struct sk_buff *skb, int offset,
  1072. void *from, int len);
  1073. extern unsigned int skb_copy_and_csum_bits(const struct sk_buff *skb,
  1074. int offset, u8 *to, int len,
  1075. unsigned int csum);
  1076. extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
  1077. extern void skb_split(struct sk_buff *skb,
  1078. struct sk_buff *skb1, const u32 len);
  1079. static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
  1080. int len, void *buffer)
  1081. {
  1082. int hlen = skb_headlen(skb);
  1083. if (offset + len <= hlen)
  1084. return skb->data + offset;
  1085. if (skb_copy_bits(skb, offset, buffer, len) < 0)
  1086. return NULL;
  1087. return buffer;
  1088. }
  1089. extern void skb_init(void);
  1090. extern void skb_add_mtu(int mtu);
  1091. #ifdef CONFIG_NETFILTER
  1092. static inline void nf_conntrack_put(struct nf_conntrack *nfct)
  1093. {
  1094. if (nfct && atomic_dec_and_test(&nfct->use))
  1095. nfct->destroy(nfct);
  1096. }
  1097. static inline void nf_conntrack_get(struct nf_conntrack *nfct)
  1098. {
  1099. if (nfct)
  1100. atomic_inc(&nfct->use);
  1101. }
  1102. static inline void nf_reset(struct sk_buff *skb)
  1103. {
  1104. nf_conntrack_put(skb->nfct);
  1105. skb->nfct = NULL;
  1106. }
  1107. #ifdef CONFIG_BRIDGE_NETFILTER
  1108. static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
  1109. {
  1110. if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
  1111. kfree(nf_bridge);
  1112. }
  1113. static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
  1114. {
  1115. if (nf_bridge)
  1116. atomic_inc(&nf_bridge->use);
  1117. }
  1118. #endif /* CONFIG_BRIDGE_NETFILTER */
  1119. #else /* CONFIG_NETFILTER */
  1120. static inline void nf_reset(struct sk_buff *skb) {}
  1121. #endif /* CONFIG_NETFILTER */
  1122. #endif /* __KERNEL__ */
  1123. #endif /* _LINUX_SKBUFF_H */