sock.h 46 KB

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