sock.h 45 KB

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