skbuff.h 50 KB

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