sock.h 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667
  1. /*
  2. * INET An implementation of the TCP/IP protocol suite for the LINUX
  3. * operating system. INET is implemented using the BSD Socket
  4. * interface as the means of communication with the user level.
  5. *
  6. * Definitions for the AF_INET socket handler.
  7. *
  8. * Version: @(#)sock.h 1.0.4 05/13/93
  9. *
  10. * Authors: Ross Biro
  11. * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12. * Corey Minyard <wf-rch!minyard@relay.EU.net>
  13. * Florian La Roche <flla@stud.uni-sb.de>
  14. *
  15. * Fixes:
  16. * Alan Cox : Volatiles in skbuff pointers. See
  17. * skbuff comments. May be overdone,
  18. * better to prove they can be removed
  19. * than the reverse.
  20. * Alan Cox : Added a zapped field for tcp to note
  21. * a socket is reset and must stay shut up
  22. * Alan Cox : New fields for options
  23. * Pauline Middelink : identd support
  24. * Alan Cox : Eliminate low level recv/recvfrom
  25. * David S. Miller : New socket lookup architecture.
  26. * Steve Whitehouse: Default routines for sock_ops
  27. * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made
  28. * protinfo be just a void pointer, as the
  29. * protocol specific parts were moved to
  30. * respective headers and ipv4/v6, etc now
  31. * use private slabcaches for its socks
  32. * Pedro Hortas : New flags field for socket options
  33. *
  34. *
  35. * This program is free software; you can redistribute it and/or
  36. * modify it under the terms of the GNU General Public License
  37. * as published by the Free Software Foundation; either version
  38. * 2 of the License, or (at your option) any later version.
  39. */
  40. #ifndef _SOCK_H
  41. #define _SOCK_H
  42. #include <linux/kernel.h>
  43. #include <linux/list.h>
  44. #include <linux/list_nulls.h>
  45. #include <linux/timer.h>
  46. #include <linux/cache.h>
  47. #include <linux/module.h>
  48. #include <linux/lockdep.h>
  49. #include <linux/netdevice.h>
  50. #include <linux/skbuff.h> /* struct sk_buff */
  51. #include <linux/mm.h>
  52. #include <linux/security.h>
  53. #include <linux/filter.h>
  54. #include <linux/rculist_nulls.h>
  55. #include <linux/poll.h>
  56. #include <asm/atomic.h>
  57. #include <net/dst.h>
  58. #include <net/checksum.h>
  59. /*
  60. * This structure really needs to be cleaned up.
  61. * Most of it is for TCP, and not used by any of
  62. * the other protocols.
  63. */
  64. /* Define this to get the SOCK_DBG debugging facility. */
  65. #define SOCK_DEBUGGING
  66. #ifdef SOCK_DEBUGGING
  67. #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
  68. printk(KERN_DEBUG msg); } while (0)
  69. #else
  70. /* Validate arguments and do nothing */
  71. static void inline int __attribute__ ((format (printf, 2, 3)))
  72. SOCK_DEBUG(struct sock *sk, const char *msg, ...)
  73. {
  74. }
  75. #endif
  76. /* This is the per-socket lock. The spinlock provides a synchronization
  77. * between user contexts and software interrupt processing, whereas the
  78. * mini-semaphore synchronizes multiple users amongst themselves.
  79. */
  80. typedef struct {
  81. spinlock_t slock;
  82. int owned;
  83. wait_queue_head_t wq;
  84. /*
  85. * We express the mutex-alike socket_lock semantics
  86. * to the lock validator by explicitly managing
  87. * the slock as a lock variant (in addition to
  88. * the slock itself):
  89. */
  90. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  91. struct lockdep_map dep_map;
  92. #endif
  93. } socket_lock_t;
  94. struct sock;
  95. struct proto;
  96. struct net;
  97. /**
  98. * struct sock_common - minimal network layer representation of sockets
  99. * @skc_node: main hash linkage for various protocol lookup tables
  100. * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
  101. * @skc_refcnt: reference count
  102. * @skc_tx_queue_mapping: tx queue number for this connection
  103. * @skc_hash: hash value used with various protocol lookup tables
  104. * @skc_u16hashes: two u16 hash values used by UDP lookup tables
  105. * @skc_family: network address family
  106. * @skc_state: Connection state
  107. * @skc_reuse: %SO_REUSEADDR setting
  108. * @skc_bound_dev_if: bound device index if != 0
  109. * @skc_bind_node: bind hash linkage for various protocol lookup tables
  110. * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
  111. * @skc_prot: protocol handlers inside a network family
  112. * @skc_net: reference to the network namespace of this socket
  113. *
  114. * This is the minimal network layer representation of sockets, the header
  115. * for struct sock and struct inet_timewait_sock.
  116. */
  117. struct sock_common {
  118. /*
  119. * first fields are not copied in sock_copy()
  120. */
  121. union {
  122. struct hlist_node skc_node;
  123. struct hlist_nulls_node skc_nulls_node;
  124. };
  125. atomic_t skc_refcnt;
  126. int skc_tx_queue_mapping;
  127. union {
  128. unsigned int skc_hash;
  129. __u16 skc_u16hashes[2];
  130. };
  131. unsigned short skc_family;
  132. volatile unsigned char skc_state;
  133. unsigned char skc_reuse;
  134. int skc_bound_dev_if;
  135. union {
  136. struct hlist_node skc_bind_node;
  137. struct hlist_nulls_node skc_portaddr_node;
  138. };
  139. struct proto *skc_prot;
  140. #ifdef CONFIG_NET_NS
  141. struct net *skc_net;
  142. #endif
  143. };
  144. /**
  145. * struct sock - network layer representation of sockets
  146. * @__sk_common: shared layout with inet_timewait_sock
  147. * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
  148. * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
  149. * @sk_lock: synchronizer
  150. * @sk_rcvbuf: size of receive buffer in bytes
  151. * @sk_sleep: sock wait queue
  152. * @sk_dst_cache: destination cache
  153. * @sk_dst_lock: destination cache lock
  154. * @sk_policy: flow policy
  155. * @sk_rmem_alloc: receive queue bytes committed
  156. * @sk_receive_queue: incoming packets
  157. * @sk_wmem_alloc: transmit queue bytes committed
  158. * @sk_write_queue: Packet sending queue
  159. * @sk_async_wait_queue: DMA copied packets
  160. * @sk_omem_alloc: "o" is "option" or "other"
  161. * @sk_wmem_queued: persistent queue size
  162. * @sk_forward_alloc: space allocated forward
  163. * @sk_allocation: allocation mode
  164. * @sk_sndbuf: size of send buffer in bytes
  165. * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
  166. * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
  167. * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
  168. * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
  169. * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
  170. * @sk_gso_max_size: Maximum GSO segment size to build
  171. * @sk_lingertime: %SO_LINGER l_linger setting
  172. * @sk_backlog: always used with the per-socket spinlock held
  173. * @sk_callback_lock: used with the callbacks in the end of this struct
  174. * @sk_error_queue: rarely used
  175. * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  176. * IPV6_ADDRFORM for instance)
  177. * @sk_err: last error
  178. * @sk_err_soft: errors that don't cause failure but are the cause of a
  179. * persistent failure not just 'timed out'
  180. * @sk_drops: raw/udp drops counter
  181. * @sk_ack_backlog: current listen backlog
  182. * @sk_max_ack_backlog: listen backlog set in listen()
  183. * @sk_priority: %SO_PRIORITY setting
  184. * @sk_type: socket type (%SOCK_STREAM, etc)
  185. * @sk_protocol: which protocol this socket belongs in this network family
  186. * @sk_peercred: %SO_PEERCRED setting
  187. * @sk_rcvlowat: %SO_RCVLOWAT setting
  188. * @sk_rcvtimeo: %SO_RCVTIMEO setting
  189. * @sk_sndtimeo: %SO_SNDTIMEO setting
  190. * @sk_filter: socket filtering instructions
  191. * @sk_protinfo: private area, net family specific, when not using slab
  192. * @sk_timer: sock cleanup timer
  193. * @sk_stamp: time stamp of last packet received
  194. * @sk_socket: Identd and reporting IO signals
  195. * @sk_user_data: RPC layer private data
  196. * @sk_sndmsg_page: cached page for sendmsg
  197. * @sk_sndmsg_off: cached offset for sendmsg
  198. * @sk_send_head: front of stuff to transmit
  199. * @sk_security: used by security modules
  200. * @sk_mark: generic packet mark
  201. * @sk_write_pending: a write to stream socket waits to start
  202. * @sk_state_change: callback to indicate change in the state of the sock
  203. * @sk_data_ready: callback to indicate there is data to be processed
  204. * @sk_write_space: callback to indicate there is bf sending space available
  205. * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
  206. * @sk_backlog_rcv: callback to process the backlog
  207. * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
  208. */
  209. struct sock {
  210. /*
  211. * Now struct inet_timewait_sock also uses sock_common, so please just
  212. * don't add nothing before this first member (__sk_common) --acme
  213. */
  214. struct sock_common __sk_common;
  215. #define sk_node __sk_common.skc_node
  216. #define sk_nulls_node __sk_common.skc_nulls_node
  217. #define sk_refcnt __sk_common.skc_refcnt
  218. #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
  219. #define sk_copy_start __sk_common.skc_hash
  220. #define sk_hash __sk_common.skc_hash
  221. #define sk_family __sk_common.skc_family
  222. #define sk_state __sk_common.skc_state
  223. #define sk_reuse __sk_common.skc_reuse
  224. #define sk_bound_dev_if __sk_common.skc_bound_dev_if
  225. #define sk_bind_node __sk_common.skc_bind_node
  226. #define sk_prot __sk_common.skc_prot
  227. #define sk_net __sk_common.skc_net
  228. kmemcheck_bitfield_begin(flags);
  229. unsigned int sk_shutdown : 2,
  230. sk_no_check : 2,
  231. sk_userlocks : 4,
  232. sk_protocol : 8,
  233. sk_type : 16;
  234. kmemcheck_bitfield_end(flags);
  235. int sk_rcvbuf;
  236. socket_lock_t sk_lock;
  237. /*
  238. * The backlog queue is special, it is always used with
  239. * the per-socket spinlock held and requires low latency
  240. * access. Therefore we special case it's implementation.
  241. */
  242. struct {
  243. struct sk_buff *head;
  244. struct sk_buff *tail;
  245. int len;
  246. int limit;
  247. } sk_backlog;
  248. wait_queue_head_t *sk_sleep;
  249. struct dst_entry *sk_dst_cache;
  250. #ifdef CONFIG_XFRM
  251. struct xfrm_policy *sk_policy[2];
  252. #endif
  253. rwlock_t sk_dst_lock;
  254. atomic_t sk_rmem_alloc;
  255. atomic_t sk_wmem_alloc;
  256. atomic_t sk_omem_alloc;
  257. int sk_sndbuf;
  258. struct sk_buff_head sk_receive_queue;
  259. struct sk_buff_head sk_write_queue;
  260. #ifdef CONFIG_NET_DMA
  261. struct sk_buff_head sk_async_wait_queue;
  262. #endif
  263. int sk_wmem_queued;
  264. int sk_forward_alloc;
  265. gfp_t sk_allocation;
  266. int sk_route_caps;
  267. int sk_gso_type;
  268. unsigned int sk_gso_max_size;
  269. int sk_rcvlowat;
  270. unsigned long sk_flags;
  271. unsigned long sk_lingertime;
  272. struct sk_buff_head sk_error_queue;
  273. struct proto *sk_prot_creator;
  274. rwlock_t sk_callback_lock;
  275. int sk_err,
  276. sk_err_soft;
  277. atomic_t sk_drops;
  278. unsigned short sk_ack_backlog;
  279. unsigned short sk_max_ack_backlog;
  280. __u32 sk_priority;
  281. struct ucred sk_peercred;
  282. long sk_rcvtimeo;
  283. long sk_sndtimeo;
  284. struct sk_filter *sk_filter;
  285. void *sk_protinfo;
  286. struct timer_list sk_timer;
  287. ktime_t sk_stamp;
  288. struct socket *sk_socket;
  289. void *sk_user_data;
  290. struct page *sk_sndmsg_page;
  291. struct sk_buff *sk_send_head;
  292. __u32 sk_sndmsg_off;
  293. int sk_write_pending;
  294. #ifdef CONFIG_SECURITY
  295. void *sk_security;
  296. #endif
  297. __u32 sk_mark;
  298. /* XXX 4 bytes hole on 64 bit */
  299. void (*sk_state_change)(struct sock *sk);
  300. void (*sk_data_ready)(struct sock *sk, int bytes);
  301. void (*sk_write_space)(struct sock *sk);
  302. void (*sk_error_report)(struct sock *sk);
  303. int (*sk_backlog_rcv)(struct sock *sk,
  304. struct sk_buff *skb);
  305. void (*sk_destruct)(struct sock *sk);
  306. };
  307. /*
  308. * Hashed lists helper routines
  309. */
  310. static inline struct sock *sk_entry(const struct hlist_node *node)
  311. {
  312. return hlist_entry(node, struct sock, sk_node);
  313. }
  314. static inline struct sock *__sk_head(const struct hlist_head *head)
  315. {
  316. return hlist_entry(head->first, struct sock, sk_node);
  317. }
  318. static inline struct sock *sk_head(const struct hlist_head *head)
  319. {
  320. return hlist_empty(head) ? NULL : __sk_head(head);
  321. }
  322. static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
  323. {
  324. return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
  325. }
  326. static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
  327. {
  328. return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
  329. }
  330. static inline struct sock *sk_next(const struct sock *sk)
  331. {
  332. return sk->sk_node.next ?
  333. hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
  334. }
  335. static inline struct sock *sk_nulls_next(const struct sock *sk)
  336. {
  337. return (!is_a_nulls(sk->sk_nulls_node.next)) ?
  338. hlist_nulls_entry(sk->sk_nulls_node.next,
  339. struct sock, sk_nulls_node) :
  340. NULL;
  341. }
  342. static inline int sk_unhashed(const struct sock *sk)
  343. {
  344. return hlist_unhashed(&sk->sk_node);
  345. }
  346. static inline int sk_hashed(const struct sock *sk)
  347. {
  348. return !sk_unhashed(sk);
  349. }
  350. static __inline__ void sk_node_init(struct hlist_node *node)
  351. {
  352. node->pprev = NULL;
  353. }
  354. static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
  355. {
  356. node->pprev = NULL;
  357. }
  358. static __inline__ void __sk_del_node(struct sock *sk)
  359. {
  360. __hlist_del(&sk->sk_node);
  361. }
  362. /* NB: equivalent to hlist_del_init_rcu */
  363. static __inline__ int __sk_del_node_init(struct sock *sk)
  364. {
  365. if (sk_hashed(sk)) {
  366. __sk_del_node(sk);
  367. sk_node_init(&sk->sk_node);
  368. return 1;
  369. }
  370. return 0;
  371. }
  372. /* Grab socket reference count. This operation is valid only
  373. when sk is ALREADY grabbed f.e. it is found in hash table
  374. or a list and the lookup is made under lock preventing hash table
  375. modifications.
  376. */
  377. static inline void sock_hold(struct sock *sk)
  378. {
  379. atomic_inc(&sk->sk_refcnt);
  380. }
  381. /* Ungrab socket in the context, which assumes that socket refcnt
  382. cannot hit zero, f.e. it is true in context of any socketcall.
  383. */
  384. static inline void __sock_put(struct sock *sk)
  385. {
  386. atomic_dec(&sk->sk_refcnt);
  387. }
  388. static __inline__ int sk_del_node_init(struct sock *sk)
  389. {
  390. int rc = __sk_del_node_init(sk);
  391. if (rc) {
  392. /* paranoid for a while -acme */
  393. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  394. __sock_put(sk);
  395. }
  396. return rc;
  397. }
  398. #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
  399. static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
  400. {
  401. if (sk_hashed(sk)) {
  402. hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
  403. return 1;
  404. }
  405. return 0;
  406. }
  407. static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
  408. {
  409. int rc = __sk_nulls_del_node_init_rcu(sk);
  410. if (rc) {
  411. /* paranoid for a while -acme */
  412. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  413. __sock_put(sk);
  414. }
  415. return rc;
  416. }
  417. static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
  418. {
  419. hlist_add_head(&sk->sk_node, list);
  420. }
  421. static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
  422. {
  423. sock_hold(sk);
  424. __sk_add_node(sk, list);
  425. }
  426. static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
  427. {
  428. sock_hold(sk);
  429. hlist_add_head_rcu(&sk->sk_node, list);
  430. }
  431. static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  432. {
  433. hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
  434. }
  435. static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  436. {
  437. sock_hold(sk);
  438. __sk_nulls_add_node_rcu(sk, list);
  439. }
  440. static __inline__ void __sk_del_bind_node(struct sock *sk)
  441. {
  442. __hlist_del(&sk->sk_bind_node);
  443. }
  444. static __inline__ void sk_add_bind_node(struct sock *sk,
  445. struct hlist_head *list)
  446. {
  447. hlist_add_head(&sk->sk_bind_node, list);
  448. }
  449. #define sk_for_each(__sk, node, list) \
  450. hlist_for_each_entry(__sk, node, list, sk_node)
  451. #define sk_for_each_rcu(__sk, node, list) \
  452. hlist_for_each_entry_rcu(__sk, node, list, sk_node)
  453. #define sk_nulls_for_each(__sk, node, list) \
  454. hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
  455. #define sk_nulls_for_each_rcu(__sk, node, list) \
  456. hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
  457. #define sk_for_each_from(__sk, node) \
  458. if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
  459. hlist_for_each_entry_from(__sk, node, sk_node)
  460. #define sk_nulls_for_each_from(__sk, node) \
  461. if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
  462. hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
  463. #define sk_for_each_continue(__sk, node) \
  464. if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
  465. hlist_for_each_entry_continue(__sk, node, sk_node)
  466. #define sk_for_each_safe(__sk, node, tmp, list) \
  467. hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
  468. #define sk_for_each_bound(__sk, node, list) \
  469. hlist_for_each_entry(__sk, node, list, sk_bind_node)
  470. /* Sock flags */
  471. enum sock_flags {
  472. SOCK_DEAD,
  473. SOCK_DONE,
  474. SOCK_URGINLINE,
  475. SOCK_KEEPOPEN,
  476. SOCK_LINGER,
  477. SOCK_DESTROY,
  478. SOCK_BROADCAST,
  479. SOCK_TIMESTAMP,
  480. SOCK_ZAPPED,
  481. SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
  482. SOCK_DBG, /* %SO_DEBUG setting */
  483. SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
  484. SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
  485. SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
  486. SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
  487. SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
  488. SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
  489. SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
  490. SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
  491. SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
  492. SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
  493. SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
  494. SOCK_FASYNC, /* fasync() active */
  495. SOCK_RXQ_OVFL,
  496. };
  497. static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
  498. {
  499. nsk->sk_flags = osk->sk_flags;
  500. }
  501. static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
  502. {
  503. __set_bit(flag, &sk->sk_flags);
  504. }
  505. static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
  506. {
  507. __clear_bit(flag, &sk->sk_flags);
  508. }
  509. static inline int sock_flag(struct sock *sk, enum sock_flags flag)
  510. {
  511. return test_bit(flag, &sk->sk_flags);
  512. }
  513. static inline void sk_acceptq_removed(struct sock *sk)
  514. {
  515. sk->sk_ack_backlog--;
  516. }
  517. static inline void sk_acceptq_added(struct sock *sk)
  518. {
  519. sk->sk_ack_backlog++;
  520. }
  521. static inline int sk_acceptq_is_full(struct sock *sk)
  522. {
  523. return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
  524. }
  525. /*
  526. * Compute minimal free write space needed to queue new packets.
  527. */
  528. static inline int sk_stream_min_wspace(struct sock *sk)
  529. {
  530. return sk->sk_wmem_queued >> 1;
  531. }
  532. static inline int sk_stream_wspace(struct sock *sk)
  533. {
  534. return sk->sk_sndbuf - sk->sk_wmem_queued;
  535. }
  536. extern void sk_stream_write_space(struct sock *sk);
  537. static inline int sk_stream_memory_free(struct sock *sk)
  538. {
  539. return sk->sk_wmem_queued < sk->sk_sndbuf;
  540. }
  541. /* OOB backlog add */
  542. static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
  543. {
  544. if (!sk->sk_backlog.tail) {
  545. sk->sk_backlog.head = sk->sk_backlog.tail = skb;
  546. } else {
  547. sk->sk_backlog.tail->next = skb;
  548. sk->sk_backlog.tail = skb;
  549. }
  550. skb->next = NULL;
  551. }
  552. /* The per-socket spinlock must be held here. */
  553. static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
  554. {
  555. if (sk->sk_backlog.len >= max(sk->sk_backlog.limit, sk->sk_rcvbuf << 1))
  556. return -ENOBUFS;
  557. __sk_add_backlog(sk, skb);
  558. sk->sk_backlog.len += skb->truesize;
  559. return 0;
  560. }
  561. static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
  562. {
  563. return sk->sk_backlog_rcv(sk, skb);
  564. }
  565. #define sk_wait_event(__sk, __timeo, __condition) \
  566. ({ int __rc; \
  567. release_sock(__sk); \
  568. __rc = __condition; \
  569. if (!__rc) { \
  570. *(__timeo) = schedule_timeout(*(__timeo)); \
  571. } \
  572. lock_sock(__sk); \
  573. __rc = __condition; \
  574. __rc; \
  575. })
  576. extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
  577. extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
  578. extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
  579. extern int sk_stream_error(struct sock *sk, int flags, int err);
  580. extern void sk_stream_kill_queues(struct sock *sk);
  581. extern int sk_wait_data(struct sock *sk, long *timeo);
  582. struct request_sock_ops;
  583. struct timewait_sock_ops;
  584. struct inet_hashinfo;
  585. struct raw_hashinfo;
  586. /* Networking protocol blocks we attach to sockets.
  587. * socket layer -> transport layer interface
  588. * transport -> network interface is defined by struct inet_proto
  589. */
  590. struct proto {
  591. void (*close)(struct sock *sk,
  592. long timeout);
  593. int (*connect)(struct sock *sk,
  594. struct sockaddr *uaddr,
  595. int addr_len);
  596. int (*disconnect)(struct sock *sk, int flags);
  597. struct sock * (*accept) (struct sock *sk, int flags, int *err);
  598. int (*ioctl)(struct sock *sk, int cmd,
  599. unsigned long arg);
  600. int (*init)(struct sock *sk);
  601. void (*destroy)(struct sock *sk);
  602. void (*shutdown)(struct sock *sk, int how);
  603. int (*setsockopt)(struct sock *sk, int level,
  604. int optname, char __user *optval,
  605. unsigned int optlen);
  606. int (*getsockopt)(struct sock *sk, int level,
  607. int optname, char __user *optval,
  608. int __user *option);
  609. #ifdef CONFIG_COMPAT
  610. int (*compat_setsockopt)(struct sock *sk,
  611. int level,
  612. int optname, char __user *optval,
  613. unsigned int optlen);
  614. int (*compat_getsockopt)(struct sock *sk,
  615. int level,
  616. int optname, char __user *optval,
  617. int __user *option);
  618. #endif
  619. int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
  620. struct msghdr *msg, size_t len);
  621. int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
  622. struct msghdr *msg,
  623. size_t len, int noblock, int flags,
  624. int *addr_len);
  625. int (*sendpage)(struct sock *sk, struct page *page,
  626. int offset, size_t size, int flags);
  627. int (*bind)(struct sock *sk,
  628. struct sockaddr *uaddr, int addr_len);
  629. int (*backlog_rcv) (struct sock *sk,
  630. struct sk_buff *skb);
  631. /* Keeping track of sk's, looking them up, and port selection methods. */
  632. void (*hash)(struct sock *sk);
  633. void (*unhash)(struct sock *sk);
  634. int (*get_port)(struct sock *sk, unsigned short snum);
  635. /* Keeping track of sockets in use */
  636. #ifdef CONFIG_PROC_FS
  637. unsigned int inuse_idx;
  638. #endif
  639. /* Memory pressure */
  640. void (*enter_memory_pressure)(struct sock *sk);
  641. atomic_t *memory_allocated; /* Current allocated memory. */
  642. struct percpu_counter *sockets_allocated; /* Current number of sockets. */
  643. /*
  644. * Pressure flag: try to collapse.
  645. * Technical note: it is used by multiple contexts non atomically.
  646. * All the __sk_mem_schedule() is of this nature: accounting
  647. * is strict, actions are advisory and have some latency.
  648. */
  649. int *memory_pressure;
  650. int *sysctl_mem;
  651. int *sysctl_wmem;
  652. int *sysctl_rmem;
  653. int max_header;
  654. struct kmem_cache *slab;
  655. unsigned int obj_size;
  656. int slab_flags;
  657. struct percpu_counter *orphan_count;
  658. struct request_sock_ops *rsk_prot;
  659. struct timewait_sock_ops *twsk_prot;
  660. union {
  661. struct inet_hashinfo *hashinfo;
  662. struct udp_table *udp_table;
  663. struct raw_hashinfo *raw_hash;
  664. } h;
  665. struct module *owner;
  666. char name[32];
  667. struct list_head node;
  668. #ifdef SOCK_REFCNT_DEBUG
  669. atomic_t socks;
  670. #endif
  671. };
  672. extern int proto_register(struct proto *prot, int alloc_slab);
  673. extern void proto_unregister(struct proto *prot);
  674. #ifdef SOCK_REFCNT_DEBUG
  675. static inline void sk_refcnt_debug_inc(struct sock *sk)
  676. {
  677. atomic_inc(&sk->sk_prot->socks);
  678. }
  679. static inline void sk_refcnt_debug_dec(struct sock *sk)
  680. {
  681. atomic_dec(&sk->sk_prot->socks);
  682. printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
  683. sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
  684. }
  685. static inline void sk_refcnt_debug_release(const struct sock *sk)
  686. {
  687. if (atomic_read(&sk->sk_refcnt) != 1)
  688. printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
  689. sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
  690. }
  691. #else /* SOCK_REFCNT_DEBUG */
  692. #define sk_refcnt_debug_inc(sk) do { } while (0)
  693. #define sk_refcnt_debug_dec(sk) do { } while (0)
  694. #define sk_refcnt_debug_release(sk) do { } while (0)
  695. #endif /* SOCK_REFCNT_DEBUG */
  696. #ifdef CONFIG_PROC_FS
  697. /* Called with local bh disabled */
  698. extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
  699. extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
  700. #else
  701. static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
  702. int inc)
  703. {
  704. }
  705. #endif
  706. /* With per-bucket locks this operation is not-atomic, so that
  707. * this version is not worse.
  708. */
  709. static inline void __sk_prot_rehash(struct sock *sk)
  710. {
  711. sk->sk_prot->unhash(sk);
  712. sk->sk_prot->hash(sk);
  713. }
  714. /* About 10 seconds */
  715. #define SOCK_DESTROY_TIME (10*HZ)
  716. /* Sockets 0-1023 can't be bound to unless you are superuser */
  717. #define PROT_SOCK 1024
  718. #define SHUTDOWN_MASK 3
  719. #define RCV_SHUTDOWN 1
  720. #define SEND_SHUTDOWN 2
  721. #define SOCK_SNDBUF_LOCK 1
  722. #define SOCK_RCVBUF_LOCK 2
  723. #define SOCK_BINDADDR_LOCK 4
  724. #define SOCK_BINDPORT_LOCK 8
  725. /* sock_iocb: used to kick off async processing of socket ios */
  726. struct sock_iocb {
  727. struct list_head list;
  728. int flags;
  729. int size;
  730. struct socket *sock;
  731. struct sock *sk;
  732. struct scm_cookie *scm;
  733. struct msghdr *msg, async_msg;
  734. struct kiocb *kiocb;
  735. };
  736. static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
  737. {
  738. return (struct sock_iocb *)iocb->private;
  739. }
  740. static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
  741. {
  742. return si->kiocb;
  743. }
  744. struct socket_alloc {
  745. struct socket socket;
  746. struct inode vfs_inode;
  747. };
  748. static inline struct socket *SOCKET_I(struct inode *inode)
  749. {
  750. return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
  751. }
  752. static inline struct inode *SOCK_INODE(struct socket *socket)
  753. {
  754. return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
  755. }
  756. /*
  757. * Functions for memory accounting
  758. */
  759. extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
  760. extern void __sk_mem_reclaim(struct sock *sk);
  761. #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
  762. #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
  763. #define SK_MEM_SEND 0
  764. #define SK_MEM_RECV 1
  765. static inline int sk_mem_pages(int amt)
  766. {
  767. return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
  768. }
  769. static inline int sk_has_account(struct sock *sk)
  770. {
  771. /* return true if protocol supports memory accounting */
  772. return !!sk->sk_prot->memory_allocated;
  773. }
  774. static inline int sk_wmem_schedule(struct sock *sk, int size)
  775. {
  776. if (!sk_has_account(sk))
  777. return 1;
  778. return size <= sk->sk_forward_alloc ||
  779. __sk_mem_schedule(sk, size, SK_MEM_SEND);
  780. }
  781. static inline int sk_rmem_schedule(struct sock *sk, int size)
  782. {
  783. if (!sk_has_account(sk))
  784. return 1;
  785. return size <= sk->sk_forward_alloc ||
  786. __sk_mem_schedule(sk, size, SK_MEM_RECV);
  787. }
  788. static inline void sk_mem_reclaim(struct sock *sk)
  789. {
  790. if (!sk_has_account(sk))
  791. return;
  792. if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
  793. __sk_mem_reclaim(sk);
  794. }
  795. static inline void sk_mem_reclaim_partial(struct sock *sk)
  796. {
  797. if (!sk_has_account(sk))
  798. return;
  799. if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
  800. __sk_mem_reclaim(sk);
  801. }
  802. static inline void sk_mem_charge(struct sock *sk, int size)
  803. {
  804. if (!sk_has_account(sk))
  805. return;
  806. sk->sk_forward_alloc -= size;
  807. }
  808. static inline void sk_mem_uncharge(struct sock *sk, int size)
  809. {
  810. if (!sk_has_account(sk))
  811. return;
  812. sk->sk_forward_alloc += size;
  813. }
  814. static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
  815. {
  816. sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
  817. sk->sk_wmem_queued -= skb->truesize;
  818. sk_mem_uncharge(sk, skb->truesize);
  819. __kfree_skb(skb);
  820. }
  821. /* Used by processes to "lock" a socket state, so that
  822. * interrupts and bottom half handlers won't change it
  823. * from under us. It essentially blocks any incoming
  824. * packets, so that we won't get any new data or any
  825. * packets that change the state of the socket.
  826. *
  827. * While locked, BH processing will add new packets to
  828. * the backlog queue. This queue is processed by the
  829. * owner of the socket lock right before it is released.
  830. *
  831. * Since ~2.3.5 it is also exclusive sleep lock serializing
  832. * accesses from user process context.
  833. */
  834. #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
  835. /*
  836. * Macro so as to not evaluate some arguments when
  837. * lockdep is not enabled.
  838. *
  839. * Mark both the sk_lock and the sk_lock.slock as a
  840. * per-address-family lock class.
  841. */
  842. #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
  843. do { \
  844. sk->sk_lock.owned = 0; \
  845. init_waitqueue_head(&sk->sk_lock.wq); \
  846. spin_lock_init(&(sk)->sk_lock.slock); \
  847. debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
  848. sizeof((sk)->sk_lock)); \
  849. lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
  850. (skey), (sname)); \
  851. lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
  852. } while (0)
  853. extern void lock_sock_nested(struct sock *sk, int subclass);
  854. static inline void lock_sock(struct sock *sk)
  855. {
  856. lock_sock_nested(sk, 0);
  857. }
  858. extern void release_sock(struct sock *sk);
  859. /* BH context may only use the following locking interface. */
  860. #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
  861. #define bh_lock_sock_nested(__sk) \
  862. spin_lock_nested(&((__sk)->sk_lock.slock), \
  863. SINGLE_DEPTH_NESTING)
  864. #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
  865. extern struct sock *sk_alloc(struct net *net, int family,
  866. gfp_t priority,
  867. struct proto *prot);
  868. extern void sk_free(struct sock *sk);
  869. extern void sk_release_kernel(struct sock *sk);
  870. extern struct sock *sk_clone(const struct sock *sk,
  871. const gfp_t priority);
  872. extern struct sk_buff *sock_wmalloc(struct sock *sk,
  873. unsigned long size, int force,
  874. gfp_t priority);
  875. extern struct sk_buff *sock_rmalloc(struct sock *sk,
  876. unsigned long size, int force,
  877. gfp_t priority);
  878. extern void sock_wfree(struct sk_buff *skb);
  879. extern void sock_rfree(struct sk_buff *skb);
  880. extern int sock_setsockopt(struct socket *sock, int level,
  881. int op, char __user *optval,
  882. unsigned int optlen);
  883. extern int sock_getsockopt(struct socket *sock, int level,
  884. int op, char __user *optval,
  885. int __user *optlen);
  886. extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
  887. unsigned long size,
  888. int noblock,
  889. int *errcode);
  890. extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
  891. unsigned long header_len,
  892. unsigned long data_len,
  893. int noblock,
  894. int *errcode);
  895. extern void *sock_kmalloc(struct sock *sk, int size,
  896. gfp_t priority);
  897. extern void sock_kfree_s(struct sock *sk, void *mem, int size);
  898. extern void sk_send_sigurg(struct sock *sk);
  899. /*
  900. * Functions to fill in entries in struct proto_ops when a protocol
  901. * does not implement a particular function.
  902. */
  903. extern int sock_no_bind(struct socket *,
  904. struct sockaddr *, int);
  905. extern int sock_no_connect(struct socket *,
  906. struct sockaddr *, int, int);
  907. extern int sock_no_socketpair(struct socket *,
  908. struct socket *);
  909. extern int sock_no_accept(struct socket *,
  910. struct socket *, int);
  911. extern int sock_no_getname(struct socket *,
  912. struct sockaddr *, int *, int);
  913. extern unsigned int sock_no_poll(struct file *, struct socket *,
  914. struct poll_table_struct *);
  915. extern int sock_no_ioctl(struct socket *, unsigned int,
  916. unsigned long);
  917. extern int sock_no_listen(struct socket *, int);
  918. extern int sock_no_shutdown(struct socket *, int);
  919. extern int sock_no_getsockopt(struct socket *, int , int,
  920. char __user *, int __user *);
  921. extern int sock_no_setsockopt(struct socket *, int, int,
  922. char __user *, unsigned int);
  923. extern int sock_no_sendmsg(struct kiocb *, struct socket *,
  924. struct msghdr *, size_t);
  925. extern int sock_no_recvmsg(struct kiocb *, struct socket *,
  926. struct msghdr *, size_t, int);
  927. extern int sock_no_mmap(struct file *file,
  928. struct socket *sock,
  929. struct vm_area_struct *vma);
  930. extern ssize_t sock_no_sendpage(struct socket *sock,
  931. struct page *page,
  932. int offset, size_t size,
  933. int flags);
  934. /*
  935. * Functions to fill in entries in struct proto_ops when a protocol
  936. * uses the inet style.
  937. */
  938. extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
  939. char __user *optval, int __user *optlen);
  940. extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
  941. struct msghdr *msg, size_t size, int flags);
  942. extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
  943. char __user *optval, unsigned int optlen);
  944. extern int compat_sock_common_getsockopt(struct socket *sock, int level,
  945. int optname, char __user *optval, int __user *optlen);
  946. extern int compat_sock_common_setsockopt(struct socket *sock, int level,
  947. int optname, char __user *optval, unsigned int optlen);
  948. extern void sk_common_release(struct sock *sk);
  949. /*
  950. * Default socket callbacks and setup code
  951. */
  952. /* Initialise core socket variables */
  953. extern void sock_init_data(struct socket *sock, struct sock *sk);
  954. /**
  955. * sk_filter_release - release a socket filter
  956. * @fp: filter to remove
  957. *
  958. * Remove a filter from a socket and release its resources.
  959. */
  960. static inline void sk_filter_release(struct sk_filter *fp)
  961. {
  962. if (atomic_dec_and_test(&fp->refcnt))
  963. kfree(fp);
  964. }
  965. static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
  966. {
  967. unsigned int size = sk_filter_len(fp);
  968. atomic_sub(size, &sk->sk_omem_alloc);
  969. sk_filter_release(fp);
  970. }
  971. static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
  972. {
  973. atomic_inc(&fp->refcnt);
  974. atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
  975. }
  976. /*
  977. * Socket reference counting postulates.
  978. *
  979. * * Each user of socket SHOULD hold a reference count.
  980. * * Each access point to socket (an hash table bucket, reference from a list,
  981. * running timer, skb in flight MUST hold a reference count.
  982. * * When reference count hits 0, it means it will never increase back.
  983. * * When reference count hits 0, it means that no references from
  984. * outside exist to this socket and current process on current CPU
  985. * is last user and may/should destroy this socket.
  986. * * sk_free is called from any context: process, BH, IRQ. When
  987. * it is called, socket has no references from outside -> sk_free
  988. * may release descendant resources allocated by the socket, but
  989. * to the time when it is called, socket is NOT referenced by any
  990. * hash tables, lists etc.
  991. * * Packets, delivered from outside (from network or from another process)
  992. * and enqueued on receive/error queues SHOULD NOT grab reference count,
  993. * when they sit in queue. Otherwise, packets will leak to hole, when
  994. * socket is looked up by one cpu and unhasing is made by another CPU.
  995. * It is true for udp/raw, netlink (leak to receive and error queues), tcp
  996. * (leak to backlog). Packet socket does all the processing inside
  997. * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
  998. * use separate SMP lock, so that they are prone too.
  999. */
  1000. /* Ungrab socket and destroy it, if it was the last reference. */
  1001. static inline void sock_put(struct sock *sk)
  1002. {
  1003. if (atomic_dec_and_test(&sk->sk_refcnt))
  1004. sk_free(sk);
  1005. }
  1006. extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
  1007. const int nested);
  1008. static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
  1009. {
  1010. sk->sk_tx_queue_mapping = tx_queue;
  1011. }
  1012. static inline void sk_tx_queue_clear(struct sock *sk)
  1013. {
  1014. sk->sk_tx_queue_mapping = -1;
  1015. }
  1016. static inline int sk_tx_queue_get(const struct sock *sk)
  1017. {
  1018. return sk->sk_tx_queue_mapping;
  1019. }
  1020. static inline bool sk_tx_queue_recorded(const struct sock *sk)
  1021. {
  1022. return (sk && sk->sk_tx_queue_mapping >= 0);
  1023. }
  1024. static inline void sk_set_socket(struct sock *sk, struct socket *sock)
  1025. {
  1026. sk_tx_queue_clear(sk);
  1027. sk->sk_socket = sock;
  1028. }
  1029. /* Detach socket from process context.
  1030. * Announce socket dead, detach it from wait queue and inode.
  1031. * Note that parent inode held reference count on this struct sock,
  1032. * we do not release it in this function, because protocol
  1033. * probably wants some additional cleanups or even continuing
  1034. * to work with this socket (TCP).
  1035. */
  1036. static inline void sock_orphan(struct sock *sk)
  1037. {
  1038. write_lock_bh(&sk->sk_callback_lock);
  1039. sock_set_flag(sk, SOCK_DEAD);
  1040. sk_set_socket(sk, NULL);
  1041. sk->sk_sleep = NULL;
  1042. write_unlock_bh(&sk->sk_callback_lock);
  1043. }
  1044. static inline void sock_graft(struct sock *sk, struct socket *parent)
  1045. {
  1046. write_lock_bh(&sk->sk_callback_lock);
  1047. sk->sk_sleep = &parent->wait;
  1048. parent->sk = sk;
  1049. sk_set_socket(sk, parent);
  1050. security_sock_graft(sk, parent);
  1051. write_unlock_bh(&sk->sk_callback_lock);
  1052. }
  1053. extern int sock_i_uid(struct sock *sk);
  1054. extern unsigned long sock_i_ino(struct sock *sk);
  1055. static inline struct dst_entry *
  1056. __sk_dst_get(struct sock *sk)
  1057. {
  1058. return sk->sk_dst_cache;
  1059. }
  1060. static inline struct dst_entry *
  1061. sk_dst_get(struct sock *sk)
  1062. {
  1063. struct dst_entry *dst;
  1064. read_lock(&sk->sk_dst_lock);
  1065. dst = sk->sk_dst_cache;
  1066. if (dst)
  1067. dst_hold(dst);
  1068. read_unlock(&sk->sk_dst_lock);
  1069. return dst;
  1070. }
  1071. static inline void
  1072. __sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1073. {
  1074. struct dst_entry *old_dst;
  1075. sk_tx_queue_clear(sk);
  1076. old_dst = sk->sk_dst_cache;
  1077. sk->sk_dst_cache = dst;
  1078. dst_release(old_dst);
  1079. }
  1080. static inline void
  1081. sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1082. {
  1083. write_lock(&sk->sk_dst_lock);
  1084. __sk_dst_set(sk, dst);
  1085. write_unlock(&sk->sk_dst_lock);
  1086. }
  1087. static inline void
  1088. __sk_dst_reset(struct sock *sk)
  1089. {
  1090. struct dst_entry *old_dst;
  1091. sk_tx_queue_clear(sk);
  1092. old_dst = sk->sk_dst_cache;
  1093. sk->sk_dst_cache = NULL;
  1094. dst_release(old_dst);
  1095. }
  1096. static inline void
  1097. sk_dst_reset(struct sock *sk)
  1098. {
  1099. write_lock(&sk->sk_dst_lock);
  1100. __sk_dst_reset(sk);
  1101. write_unlock(&sk->sk_dst_lock);
  1102. }
  1103. extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
  1104. extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
  1105. static inline int sk_can_gso(const struct sock *sk)
  1106. {
  1107. return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
  1108. }
  1109. extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
  1110. static inline int skb_copy_to_page(struct sock *sk, char __user *from,
  1111. struct sk_buff *skb, struct page *page,
  1112. int off, int copy)
  1113. {
  1114. if (skb->ip_summed == CHECKSUM_NONE) {
  1115. int err = 0;
  1116. __wsum csum = csum_and_copy_from_user(from,
  1117. page_address(page) + off,
  1118. copy, 0, &err);
  1119. if (err)
  1120. return err;
  1121. skb->csum = csum_block_add(skb->csum, csum, skb->len);
  1122. } else if (copy_from_user(page_address(page) + off, from, copy))
  1123. return -EFAULT;
  1124. skb->len += copy;
  1125. skb->data_len += copy;
  1126. skb->truesize += copy;
  1127. sk->sk_wmem_queued += copy;
  1128. sk_mem_charge(sk, copy);
  1129. return 0;
  1130. }
  1131. /**
  1132. * sk_wmem_alloc_get - returns write allocations
  1133. * @sk: socket
  1134. *
  1135. * Returns sk_wmem_alloc minus initial offset of one
  1136. */
  1137. static inline int sk_wmem_alloc_get(const struct sock *sk)
  1138. {
  1139. return atomic_read(&sk->sk_wmem_alloc) - 1;
  1140. }
  1141. /**
  1142. * sk_rmem_alloc_get - returns read allocations
  1143. * @sk: socket
  1144. *
  1145. * Returns sk_rmem_alloc
  1146. */
  1147. static inline int sk_rmem_alloc_get(const struct sock *sk)
  1148. {
  1149. return atomic_read(&sk->sk_rmem_alloc);
  1150. }
  1151. /**
  1152. * sk_has_allocations - check if allocations are outstanding
  1153. * @sk: socket
  1154. *
  1155. * Returns true if socket has write or read allocations
  1156. */
  1157. static inline int sk_has_allocations(const struct sock *sk)
  1158. {
  1159. return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
  1160. }
  1161. /**
  1162. * sk_has_sleeper - check if there are any waiting processes
  1163. * @sk: socket
  1164. *
  1165. * Returns true if socket has waiting processes
  1166. *
  1167. * The purpose of the sk_has_sleeper and sock_poll_wait is to wrap the memory
  1168. * barrier call. They were added due to the race found within the tcp code.
  1169. *
  1170. * Consider following tcp code paths:
  1171. *
  1172. * CPU1 CPU2
  1173. *
  1174. * sys_select receive packet
  1175. * ... ...
  1176. * __add_wait_queue update tp->rcv_nxt
  1177. * ... ...
  1178. * tp->rcv_nxt check sock_def_readable
  1179. * ... {
  1180. * schedule ...
  1181. * if (sk->sk_sleep && waitqueue_active(sk->sk_sleep))
  1182. * wake_up_interruptible(sk->sk_sleep)
  1183. * ...
  1184. * }
  1185. *
  1186. * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
  1187. * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
  1188. * could then endup calling schedule and sleep forever if there are no more
  1189. * data on the socket.
  1190. *
  1191. * The sk_has_sleeper is always called right after a call to read_lock, so we
  1192. * can use smp_mb__after_lock barrier.
  1193. */
  1194. static inline int sk_has_sleeper(struct sock *sk)
  1195. {
  1196. /*
  1197. * We need to be sure we are in sync with the
  1198. * add_wait_queue modifications to the wait queue.
  1199. *
  1200. * This memory barrier is paired in the sock_poll_wait.
  1201. */
  1202. smp_mb__after_lock();
  1203. return sk->sk_sleep && waitqueue_active(sk->sk_sleep);
  1204. }
  1205. /**
  1206. * sock_poll_wait - place memory barrier behind the poll_wait call.
  1207. * @filp: file
  1208. * @wait_address: socket wait queue
  1209. * @p: poll_table
  1210. *
  1211. * See the comments in the sk_has_sleeper function.
  1212. */
  1213. static inline void sock_poll_wait(struct file *filp,
  1214. wait_queue_head_t *wait_address, poll_table *p)
  1215. {
  1216. if (p && wait_address) {
  1217. poll_wait(filp, wait_address, p);
  1218. /*
  1219. * We need to be sure we are in sync with the
  1220. * socket flags modification.
  1221. *
  1222. * This memory barrier is paired in the sk_has_sleeper.
  1223. */
  1224. smp_mb();
  1225. }
  1226. }
  1227. /*
  1228. * Queue a received datagram if it will fit. Stream and sequenced
  1229. * protocols can't normally use this as they need to fit buffers in
  1230. * and play with them.
  1231. *
  1232. * Inlined as it's very short and called for pretty much every
  1233. * packet ever received.
  1234. */
  1235. static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
  1236. {
  1237. skb_orphan(skb);
  1238. skb->sk = sk;
  1239. skb->destructor = sock_wfree;
  1240. /*
  1241. * We used to take a refcount on sk, but following operation
  1242. * is enough to guarantee sk_free() wont free this sock until
  1243. * all in-flight packets are completed
  1244. */
  1245. atomic_add(skb->truesize, &sk->sk_wmem_alloc);
  1246. }
  1247. static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
  1248. {
  1249. skb_orphan(skb);
  1250. skb->sk = sk;
  1251. skb->destructor = sock_rfree;
  1252. atomic_add(skb->truesize, &sk->sk_rmem_alloc);
  1253. sk_mem_charge(sk, skb->truesize);
  1254. }
  1255. extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
  1256. unsigned long expires);
  1257. extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
  1258. extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
  1259. static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb)
  1260. {
  1261. /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
  1262. number of warnings when compiling with -W --ANK
  1263. */
  1264. if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
  1265. (unsigned)sk->sk_rcvbuf)
  1266. return -ENOMEM;
  1267. skb_set_owner_r(skb, sk);
  1268. skb_queue_tail(&sk->sk_error_queue, skb);
  1269. if (!sock_flag(sk, SOCK_DEAD))
  1270. sk->sk_data_ready(sk, skb->len);
  1271. return 0;
  1272. }
  1273. /*
  1274. * Recover an error report and clear atomically
  1275. */
  1276. static inline int sock_error(struct sock *sk)
  1277. {
  1278. int err;
  1279. if (likely(!sk->sk_err))
  1280. return 0;
  1281. err = xchg(&sk->sk_err, 0);
  1282. return -err;
  1283. }
  1284. static inline unsigned long sock_wspace(struct sock *sk)
  1285. {
  1286. int amt = 0;
  1287. if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
  1288. amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
  1289. if (amt < 0)
  1290. amt = 0;
  1291. }
  1292. return amt;
  1293. }
  1294. static inline void sk_wake_async(struct sock *sk, int how, int band)
  1295. {
  1296. if (sock_flag(sk, SOCK_FASYNC))
  1297. sock_wake_async(sk->sk_socket, how, band);
  1298. }
  1299. #define SOCK_MIN_SNDBUF 2048
  1300. #define SOCK_MIN_RCVBUF 256
  1301. static inline void sk_stream_moderate_sndbuf(struct sock *sk)
  1302. {
  1303. if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
  1304. sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
  1305. sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
  1306. }
  1307. }
  1308. struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
  1309. static inline struct page *sk_stream_alloc_page(struct sock *sk)
  1310. {
  1311. struct page *page = NULL;
  1312. page = alloc_pages(sk->sk_allocation, 0);
  1313. if (!page) {
  1314. sk->sk_prot->enter_memory_pressure(sk);
  1315. sk_stream_moderate_sndbuf(sk);
  1316. }
  1317. return page;
  1318. }
  1319. /*
  1320. * Default write policy as shown to user space via poll/select/SIGIO
  1321. */
  1322. static inline int sock_writeable(const struct sock *sk)
  1323. {
  1324. return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
  1325. }
  1326. static inline gfp_t gfp_any(void)
  1327. {
  1328. return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
  1329. }
  1330. static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
  1331. {
  1332. return noblock ? 0 : sk->sk_rcvtimeo;
  1333. }
  1334. static inline long sock_sndtimeo(const struct sock *sk, int noblock)
  1335. {
  1336. return noblock ? 0 : sk->sk_sndtimeo;
  1337. }
  1338. static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
  1339. {
  1340. return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
  1341. }
  1342. /* Alas, with timeout socket operations are not restartable.
  1343. * Compare this to poll().
  1344. */
  1345. static inline int sock_intr_errno(long timeo)
  1346. {
  1347. return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
  1348. }
  1349. extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
  1350. struct sk_buff *skb);
  1351. static __inline__ void
  1352. sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
  1353. {
  1354. ktime_t kt = skb->tstamp;
  1355. struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
  1356. /*
  1357. * generate control messages if
  1358. * - receive time stamping in software requested (SOCK_RCVTSTAMP
  1359. * or SOCK_TIMESTAMPING_RX_SOFTWARE)
  1360. * - software time stamp available and wanted
  1361. * (SOCK_TIMESTAMPING_SOFTWARE)
  1362. * - hardware time stamps available and wanted
  1363. * (SOCK_TIMESTAMPING_SYS_HARDWARE or
  1364. * SOCK_TIMESTAMPING_RAW_HARDWARE)
  1365. */
  1366. if (sock_flag(sk, SOCK_RCVTSTAMP) ||
  1367. sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
  1368. (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
  1369. (hwtstamps->hwtstamp.tv64 &&
  1370. sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
  1371. (hwtstamps->syststamp.tv64 &&
  1372. sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
  1373. __sock_recv_timestamp(msg, sk, skb);
  1374. else
  1375. sk->sk_stamp = kt;
  1376. }
  1377. extern void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk, struct sk_buff *skb);
  1378. /**
  1379. * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
  1380. * @msg: outgoing packet
  1381. * @sk: socket sending this packet
  1382. * @shtx: filled with instructions for time stamping
  1383. *
  1384. * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
  1385. * parameters are invalid.
  1386. */
  1387. extern int sock_tx_timestamp(struct msghdr *msg,
  1388. struct sock *sk,
  1389. union skb_shared_tx *shtx);
  1390. /**
  1391. * sk_eat_skb - Release a skb if it is no longer needed
  1392. * @sk: socket to eat this skb from
  1393. * @skb: socket buffer to eat
  1394. * @copied_early: flag indicating whether DMA operations copied this data early
  1395. *
  1396. * This routine must be called with interrupts disabled or with the socket
  1397. * locked so that the sk_buff queue operation is ok.
  1398. */
  1399. #ifdef CONFIG_NET_DMA
  1400. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
  1401. {
  1402. __skb_unlink(skb, &sk->sk_receive_queue);
  1403. if (!copied_early)
  1404. __kfree_skb(skb);
  1405. else
  1406. __skb_queue_tail(&sk->sk_async_wait_queue, skb);
  1407. }
  1408. #else
  1409. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
  1410. {
  1411. __skb_unlink(skb, &sk->sk_receive_queue);
  1412. __kfree_skb(skb);
  1413. }
  1414. #endif
  1415. static inline
  1416. struct net *sock_net(const struct sock *sk)
  1417. {
  1418. #ifdef CONFIG_NET_NS
  1419. return sk->sk_net;
  1420. #else
  1421. return &init_net;
  1422. #endif
  1423. }
  1424. static inline
  1425. void sock_net_set(struct sock *sk, struct net *net)
  1426. {
  1427. #ifdef CONFIG_NET_NS
  1428. sk->sk_net = net;
  1429. #endif
  1430. }
  1431. /*
  1432. * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
  1433. * They should not hold a referrence to a namespace in order to allow
  1434. * to stop it.
  1435. * Sockets after sk_change_net should be released using sk_release_kernel
  1436. */
  1437. static inline void sk_change_net(struct sock *sk, struct net *net)
  1438. {
  1439. put_net(sock_net(sk));
  1440. sock_net_set(sk, hold_net(net));
  1441. }
  1442. static inline struct sock *skb_steal_sock(struct sk_buff *skb)
  1443. {
  1444. if (unlikely(skb->sk)) {
  1445. struct sock *sk = skb->sk;
  1446. skb->destructor = NULL;
  1447. skb->sk = NULL;
  1448. return sk;
  1449. }
  1450. return NULL;
  1451. }
  1452. extern void sock_enable_timestamp(struct sock *sk, int flag);
  1453. extern int sock_get_timestamp(struct sock *, struct timeval __user *);
  1454. extern int sock_get_timestampns(struct sock *, struct timespec __user *);
  1455. /*
  1456. * Enable debug/info messages
  1457. */
  1458. extern int net_msg_warn;
  1459. #define NETDEBUG(fmt, args...) \
  1460. do { if (net_msg_warn) printk(fmt,##args); } while (0)
  1461. #define LIMIT_NETDEBUG(fmt, args...) \
  1462. do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
  1463. extern __u32 sysctl_wmem_max;
  1464. extern __u32 sysctl_rmem_max;
  1465. extern void sk_init(void);
  1466. extern int sysctl_optmem_max;
  1467. extern __u32 sysctl_wmem_default;
  1468. extern __u32 sysctl_rmem_default;
  1469. #endif /* _SOCK_H */