sock.h 47 KB

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