skbuff.h 34 KB

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