sock.h 45 KB

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