sock.h 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288
  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/hardirq.h>
  43. #include <linux/kernel.h>
  44. #include <linux/list.h>
  45. #include <linux/list_nulls.h>
  46. #include <linux/timer.h>
  47. #include <linux/cache.h>
  48. #include <linux/bitops.h>
  49. #include <linux/lockdep.h>
  50. #include <linux/netdevice.h>
  51. #include <linux/skbuff.h> /* struct sk_buff */
  52. #include <linux/mm.h>
  53. #include <linux/security.h>
  54. #include <linux/slab.h>
  55. #include <linux/uaccess.h>
  56. #include <linux/memcontrol.h>
  57. #include <linux/res_counter.h>
  58. #include <linux/static_key.h>
  59. #include <linux/aio.h>
  60. #include <linux/sched.h>
  61. #include <linux/filter.h>
  62. #include <linux/rculist_nulls.h>
  63. #include <linux/poll.h>
  64. #include <linux/atomic.h>
  65. #include <net/dst.h>
  66. #include <net/checksum.h>
  67. struct cgroup;
  68. struct cgroup_subsys;
  69. #ifdef CONFIG_NET
  70. int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
  71. void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
  72. #else
  73. static inline
  74. int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
  75. {
  76. return 0;
  77. }
  78. static inline
  79. void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
  80. {
  81. }
  82. #endif
  83. /*
  84. * This structure really needs to be cleaned up.
  85. * Most of it is for TCP, and not used by any of
  86. * the other protocols.
  87. */
  88. /* Define this to get the SOCK_DBG debugging facility. */
  89. #define SOCK_DEBUGGING
  90. #ifdef SOCK_DEBUGGING
  91. #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
  92. printk(KERN_DEBUG msg); } while (0)
  93. #else
  94. /* Validate arguments and do nothing */
  95. static inline __printf(2, 3)
  96. void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
  97. {
  98. }
  99. #endif
  100. /* This is the per-socket lock. The spinlock provides a synchronization
  101. * between user contexts and software interrupt processing, whereas the
  102. * mini-semaphore synchronizes multiple users amongst themselves.
  103. */
  104. typedef struct {
  105. spinlock_t slock;
  106. int owned;
  107. wait_queue_head_t wq;
  108. /*
  109. * We express the mutex-alike socket_lock semantics
  110. * to the lock validator by explicitly managing
  111. * the slock as a lock variant (in addition to
  112. * the slock itself):
  113. */
  114. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  115. struct lockdep_map dep_map;
  116. #endif
  117. } socket_lock_t;
  118. struct sock;
  119. struct proto;
  120. struct net;
  121. typedef __u32 __bitwise __portpair;
  122. typedef __u64 __bitwise __addrpair;
  123. /**
  124. * struct sock_common - minimal network layer representation of sockets
  125. * @skc_daddr: Foreign IPv4 addr
  126. * @skc_rcv_saddr: Bound local IPv4 addr
  127. * @skc_hash: hash value used with various protocol lookup tables
  128. * @skc_u16hashes: two u16 hash values used by UDP lookup tables
  129. * @skc_dport: placeholder for inet_dport/tw_dport
  130. * @skc_num: placeholder for inet_num/tw_num
  131. * @skc_family: network address family
  132. * @skc_state: Connection state
  133. * @skc_reuse: %SO_REUSEADDR setting
  134. * @skc_reuseport: %SO_REUSEPORT setting
  135. * @skc_bound_dev_if: bound device index if != 0
  136. * @skc_bind_node: bind hash linkage for various protocol lookup tables
  137. * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
  138. * @skc_prot: protocol handlers inside a network family
  139. * @skc_net: reference to the network namespace of this socket
  140. * @skc_node: main hash linkage for various protocol lookup tables
  141. * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
  142. * @skc_tx_queue_mapping: tx queue number for this connection
  143. * @skc_refcnt: reference count
  144. *
  145. * This is the minimal network layer representation of sockets, the header
  146. * for struct sock and struct inet_timewait_sock.
  147. */
  148. struct sock_common {
  149. /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
  150. * address on 64bit arches : cf INET_MATCH() and INET_TW_MATCH()
  151. */
  152. union {
  153. __addrpair skc_addrpair;
  154. struct {
  155. __be32 skc_daddr;
  156. __be32 skc_rcv_saddr;
  157. };
  158. };
  159. union {
  160. unsigned int skc_hash;
  161. __u16 skc_u16hashes[2];
  162. };
  163. /* skc_dport && skc_num must be grouped as well */
  164. union {
  165. __portpair skc_portpair;
  166. struct {
  167. __be16 skc_dport;
  168. __u16 skc_num;
  169. };
  170. };
  171. unsigned short skc_family;
  172. volatile unsigned char skc_state;
  173. unsigned char skc_reuse:4;
  174. unsigned char skc_reuseport:4;
  175. int skc_bound_dev_if;
  176. union {
  177. struct hlist_node skc_bind_node;
  178. struct hlist_nulls_node skc_portaddr_node;
  179. };
  180. struct proto *skc_prot;
  181. #ifdef CONFIG_NET_NS
  182. struct net *skc_net;
  183. #endif
  184. /*
  185. * fields between dontcopy_begin/dontcopy_end
  186. * are not copied in sock_copy()
  187. */
  188. /* private: */
  189. int skc_dontcopy_begin[0];
  190. /* public: */
  191. union {
  192. struct hlist_node skc_node;
  193. struct hlist_nulls_node skc_nulls_node;
  194. };
  195. int skc_tx_queue_mapping;
  196. atomic_t skc_refcnt;
  197. /* private: */
  198. int skc_dontcopy_end[0];
  199. /* public: */
  200. };
  201. struct cg_proto;
  202. /**
  203. * struct sock - network layer representation of sockets
  204. * @__sk_common: shared layout with inet_timewait_sock
  205. * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
  206. * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
  207. * @sk_lock: synchronizer
  208. * @sk_rcvbuf: size of receive buffer in bytes
  209. * @sk_wq: sock wait queue and async head
  210. * @sk_rx_dst: receive input route used by early tcp demux
  211. * @sk_dst_cache: destination cache
  212. * @sk_dst_lock: destination cache lock
  213. * @sk_policy: flow policy
  214. * @sk_receive_queue: incoming packets
  215. * @sk_wmem_alloc: transmit queue bytes committed
  216. * @sk_write_queue: Packet sending queue
  217. * @sk_async_wait_queue: DMA copied packets
  218. * @sk_omem_alloc: "o" is "option" or "other"
  219. * @sk_wmem_queued: persistent queue size
  220. * @sk_forward_alloc: space allocated forward
  221. * @sk_napi_id: id of the last napi context to receive data for sk
  222. * @sk_ll_usec: usecs to busypoll when there is no data
  223. * @sk_allocation: allocation mode
  224. * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
  225. * @sk_sndbuf: size of send buffer in bytes
  226. * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
  227. * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
  228. * @sk_no_check: %SO_NO_CHECK setting, whether or not checkup packets
  229. * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
  230. * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
  231. * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
  232. * @sk_gso_max_size: Maximum GSO segment size to build
  233. * @sk_gso_max_segs: Maximum number of GSO segments
  234. * @sk_lingertime: %SO_LINGER l_linger setting
  235. * @sk_backlog: always used with the per-socket spinlock held
  236. * @sk_callback_lock: used with the callbacks in the end of this struct
  237. * @sk_error_queue: rarely used
  238. * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  239. * IPV6_ADDRFORM for instance)
  240. * @sk_err: last error
  241. * @sk_err_soft: errors that don't cause failure but are the cause of a
  242. * persistent failure not just 'timed out'
  243. * @sk_drops: raw/udp drops counter
  244. * @sk_ack_backlog: current listen backlog
  245. * @sk_max_ack_backlog: listen backlog set in listen()
  246. * @sk_priority: %SO_PRIORITY setting
  247. * @sk_cgrp_prioidx: socket group's priority map index
  248. * @sk_type: socket type (%SOCK_STREAM, etc)
  249. * @sk_protocol: which protocol this socket belongs in this network family
  250. * @sk_peer_pid: &struct pid for this socket's peer
  251. * @sk_peer_cred: %SO_PEERCRED setting
  252. * @sk_rcvlowat: %SO_RCVLOWAT setting
  253. * @sk_rcvtimeo: %SO_RCVTIMEO setting
  254. * @sk_sndtimeo: %SO_SNDTIMEO setting
  255. * @sk_rxhash: flow hash received from netif layer
  256. * @sk_filter: socket filtering instructions
  257. * @sk_protinfo: private area, net family specific, when not using slab
  258. * @sk_timer: sock cleanup timer
  259. * @sk_stamp: time stamp of last packet received
  260. * @sk_socket: Identd and reporting IO signals
  261. * @sk_user_data: RPC layer private data
  262. * @sk_frag: cached page frag
  263. * @sk_peek_off: current peek_offset value
  264. * @sk_send_head: front of stuff to transmit
  265. * @sk_security: used by security modules
  266. * @sk_mark: generic packet mark
  267. * @sk_classid: this socket's cgroup classid
  268. * @sk_cgrp: this socket's cgroup-specific proto data
  269. * @sk_write_pending: a write to stream socket waits to start
  270. * @sk_state_change: callback to indicate change in the state of the sock
  271. * @sk_data_ready: callback to indicate there is data to be processed
  272. * @sk_write_space: callback to indicate there is bf sending space available
  273. * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
  274. * @sk_backlog_rcv: callback to process the backlog
  275. * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
  276. */
  277. struct sock {
  278. /*
  279. * Now struct inet_timewait_sock also uses sock_common, so please just
  280. * don't add nothing before this first member (__sk_common) --acme
  281. */
  282. struct sock_common __sk_common;
  283. #define sk_node __sk_common.skc_node
  284. #define sk_nulls_node __sk_common.skc_nulls_node
  285. #define sk_refcnt __sk_common.skc_refcnt
  286. #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
  287. #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
  288. #define sk_dontcopy_end __sk_common.skc_dontcopy_end
  289. #define sk_hash __sk_common.skc_hash
  290. #define sk_family __sk_common.skc_family
  291. #define sk_state __sk_common.skc_state
  292. #define sk_reuse __sk_common.skc_reuse
  293. #define sk_reuseport __sk_common.skc_reuseport
  294. #define sk_bound_dev_if __sk_common.skc_bound_dev_if
  295. #define sk_bind_node __sk_common.skc_bind_node
  296. #define sk_prot __sk_common.skc_prot
  297. #define sk_net __sk_common.skc_net
  298. socket_lock_t sk_lock;
  299. struct sk_buff_head sk_receive_queue;
  300. /*
  301. * The backlog queue is special, it is always used with
  302. * the per-socket spinlock held and requires low latency
  303. * access. Therefore we special case it's implementation.
  304. * Note : rmem_alloc is in this structure to fill a hole
  305. * on 64bit arches, not because its logically part of
  306. * backlog.
  307. */
  308. struct {
  309. atomic_t rmem_alloc;
  310. int len;
  311. struct sk_buff *head;
  312. struct sk_buff *tail;
  313. } sk_backlog;
  314. #define sk_rmem_alloc sk_backlog.rmem_alloc
  315. int sk_forward_alloc;
  316. #ifdef CONFIG_RPS
  317. __u32 sk_rxhash;
  318. #endif
  319. #ifdef CONFIG_NET_RX_BUSY_POLL
  320. unsigned int sk_napi_id;
  321. unsigned int sk_ll_usec;
  322. #endif
  323. atomic_t sk_drops;
  324. int sk_rcvbuf;
  325. struct sk_filter __rcu *sk_filter;
  326. struct socket_wq __rcu *sk_wq;
  327. #ifdef CONFIG_NET_DMA
  328. struct sk_buff_head sk_async_wait_queue;
  329. #endif
  330. #ifdef CONFIG_XFRM
  331. struct xfrm_policy *sk_policy[2];
  332. #endif
  333. unsigned long sk_flags;
  334. struct dst_entry *sk_rx_dst;
  335. struct dst_entry __rcu *sk_dst_cache;
  336. spinlock_t sk_dst_lock;
  337. atomic_t sk_wmem_alloc;
  338. atomic_t sk_omem_alloc;
  339. int sk_sndbuf;
  340. struct sk_buff_head sk_write_queue;
  341. kmemcheck_bitfield_begin(flags);
  342. unsigned int sk_shutdown : 2,
  343. sk_no_check : 2,
  344. sk_userlocks : 4,
  345. sk_protocol : 8,
  346. sk_type : 16;
  347. kmemcheck_bitfield_end(flags);
  348. int sk_wmem_queued;
  349. gfp_t sk_allocation;
  350. u32 sk_pacing_rate; /* bytes per second */
  351. netdev_features_t sk_route_caps;
  352. netdev_features_t sk_route_nocaps;
  353. int sk_gso_type;
  354. unsigned int sk_gso_max_size;
  355. u16 sk_gso_max_segs;
  356. int sk_rcvlowat;
  357. unsigned long sk_lingertime;
  358. struct sk_buff_head sk_error_queue;
  359. struct proto *sk_prot_creator;
  360. rwlock_t sk_callback_lock;
  361. int sk_err,
  362. sk_err_soft;
  363. unsigned short sk_ack_backlog;
  364. unsigned short sk_max_ack_backlog;
  365. __u32 sk_priority;
  366. #if IS_ENABLED(CONFIG_NETPRIO_CGROUP)
  367. __u32 sk_cgrp_prioidx;
  368. #endif
  369. struct pid *sk_peer_pid;
  370. const struct cred *sk_peer_cred;
  371. long sk_rcvtimeo;
  372. long sk_sndtimeo;
  373. void *sk_protinfo;
  374. struct timer_list sk_timer;
  375. ktime_t sk_stamp;
  376. struct socket *sk_socket;
  377. void *sk_user_data;
  378. struct page_frag sk_frag;
  379. struct sk_buff *sk_send_head;
  380. __s32 sk_peek_off;
  381. int sk_write_pending;
  382. #ifdef CONFIG_SECURITY
  383. void *sk_security;
  384. #endif
  385. __u32 sk_mark;
  386. u32 sk_classid;
  387. struct cg_proto *sk_cgrp;
  388. void (*sk_state_change)(struct sock *sk);
  389. void (*sk_data_ready)(struct sock *sk, int bytes);
  390. void (*sk_write_space)(struct sock *sk);
  391. void (*sk_error_report)(struct sock *sk);
  392. int (*sk_backlog_rcv)(struct sock *sk,
  393. struct sk_buff *skb);
  394. void (*sk_destruct)(struct sock *sk);
  395. };
  396. /*
  397. * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
  398. * or not whether his port will be reused by someone else. SK_FORCE_REUSE
  399. * on a socket means that the socket will reuse everybody else's port
  400. * without looking at the other's sk_reuse value.
  401. */
  402. #define SK_NO_REUSE 0
  403. #define SK_CAN_REUSE 1
  404. #define SK_FORCE_REUSE 2
  405. static inline int sk_peek_offset(struct sock *sk, int flags)
  406. {
  407. if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
  408. return sk->sk_peek_off;
  409. else
  410. return 0;
  411. }
  412. static inline void sk_peek_offset_bwd(struct sock *sk, int val)
  413. {
  414. if (sk->sk_peek_off >= 0) {
  415. if (sk->sk_peek_off >= val)
  416. sk->sk_peek_off -= val;
  417. else
  418. sk->sk_peek_off = 0;
  419. }
  420. }
  421. static inline void sk_peek_offset_fwd(struct sock *sk, int val)
  422. {
  423. if (sk->sk_peek_off >= 0)
  424. sk->sk_peek_off += val;
  425. }
  426. /*
  427. * Hashed lists helper routines
  428. */
  429. static inline struct sock *sk_entry(const struct hlist_node *node)
  430. {
  431. return hlist_entry(node, struct sock, sk_node);
  432. }
  433. static inline struct sock *__sk_head(const struct hlist_head *head)
  434. {
  435. return hlist_entry(head->first, struct sock, sk_node);
  436. }
  437. static inline struct sock *sk_head(const struct hlist_head *head)
  438. {
  439. return hlist_empty(head) ? NULL : __sk_head(head);
  440. }
  441. static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
  442. {
  443. return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
  444. }
  445. static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
  446. {
  447. return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
  448. }
  449. static inline struct sock *sk_next(const struct sock *sk)
  450. {
  451. return sk->sk_node.next ?
  452. hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
  453. }
  454. static inline struct sock *sk_nulls_next(const struct sock *sk)
  455. {
  456. return (!is_a_nulls(sk->sk_nulls_node.next)) ?
  457. hlist_nulls_entry(sk->sk_nulls_node.next,
  458. struct sock, sk_nulls_node) :
  459. NULL;
  460. }
  461. static inline bool sk_unhashed(const struct sock *sk)
  462. {
  463. return hlist_unhashed(&sk->sk_node);
  464. }
  465. static inline bool sk_hashed(const struct sock *sk)
  466. {
  467. return !sk_unhashed(sk);
  468. }
  469. static inline void sk_node_init(struct hlist_node *node)
  470. {
  471. node->pprev = NULL;
  472. }
  473. static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
  474. {
  475. node->pprev = NULL;
  476. }
  477. static inline void __sk_del_node(struct sock *sk)
  478. {
  479. __hlist_del(&sk->sk_node);
  480. }
  481. /* NB: equivalent to hlist_del_init_rcu */
  482. static inline bool __sk_del_node_init(struct sock *sk)
  483. {
  484. if (sk_hashed(sk)) {
  485. __sk_del_node(sk);
  486. sk_node_init(&sk->sk_node);
  487. return true;
  488. }
  489. return false;
  490. }
  491. /* Grab socket reference count. This operation is valid only
  492. when sk is ALREADY grabbed f.e. it is found in hash table
  493. or a list and the lookup is made under lock preventing hash table
  494. modifications.
  495. */
  496. static inline void sock_hold(struct sock *sk)
  497. {
  498. atomic_inc(&sk->sk_refcnt);
  499. }
  500. /* Ungrab socket in the context, which assumes that socket refcnt
  501. cannot hit zero, f.e. it is true in context of any socketcall.
  502. */
  503. static inline void __sock_put(struct sock *sk)
  504. {
  505. atomic_dec(&sk->sk_refcnt);
  506. }
  507. static inline bool sk_del_node_init(struct sock *sk)
  508. {
  509. bool rc = __sk_del_node_init(sk);
  510. if (rc) {
  511. /* paranoid for a while -acme */
  512. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  513. __sock_put(sk);
  514. }
  515. return rc;
  516. }
  517. #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
  518. static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
  519. {
  520. if (sk_hashed(sk)) {
  521. hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
  522. return true;
  523. }
  524. return false;
  525. }
  526. static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
  527. {
  528. bool rc = __sk_nulls_del_node_init_rcu(sk);
  529. if (rc) {
  530. /* paranoid for a while -acme */
  531. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  532. __sock_put(sk);
  533. }
  534. return rc;
  535. }
  536. static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
  537. {
  538. hlist_add_head(&sk->sk_node, list);
  539. }
  540. static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
  541. {
  542. sock_hold(sk);
  543. __sk_add_node(sk, list);
  544. }
  545. static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
  546. {
  547. sock_hold(sk);
  548. hlist_add_head_rcu(&sk->sk_node, list);
  549. }
  550. static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  551. {
  552. hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
  553. }
  554. static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  555. {
  556. sock_hold(sk);
  557. __sk_nulls_add_node_rcu(sk, list);
  558. }
  559. static inline void __sk_del_bind_node(struct sock *sk)
  560. {
  561. __hlist_del(&sk->sk_bind_node);
  562. }
  563. static inline void sk_add_bind_node(struct sock *sk,
  564. struct hlist_head *list)
  565. {
  566. hlist_add_head(&sk->sk_bind_node, list);
  567. }
  568. #define sk_for_each(__sk, list) \
  569. hlist_for_each_entry(__sk, list, sk_node)
  570. #define sk_for_each_rcu(__sk, list) \
  571. hlist_for_each_entry_rcu(__sk, list, sk_node)
  572. #define sk_nulls_for_each(__sk, node, list) \
  573. hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
  574. #define sk_nulls_for_each_rcu(__sk, node, list) \
  575. hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
  576. #define sk_for_each_from(__sk) \
  577. hlist_for_each_entry_from(__sk, sk_node)
  578. #define sk_nulls_for_each_from(__sk, node) \
  579. if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
  580. hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
  581. #define sk_for_each_safe(__sk, tmp, list) \
  582. hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
  583. #define sk_for_each_bound(__sk, list) \
  584. hlist_for_each_entry(__sk, list, sk_bind_node)
  585. static inline struct user_namespace *sk_user_ns(struct sock *sk)
  586. {
  587. /* Careful only use this in a context where these parameters
  588. * can not change and must all be valid, such as recvmsg from
  589. * userspace.
  590. */
  591. return sk->sk_socket->file->f_cred->user_ns;
  592. }
  593. /* Sock flags */
  594. enum sock_flags {
  595. SOCK_DEAD,
  596. SOCK_DONE,
  597. SOCK_URGINLINE,
  598. SOCK_KEEPOPEN,
  599. SOCK_LINGER,
  600. SOCK_DESTROY,
  601. SOCK_BROADCAST,
  602. SOCK_TIMESTAMP,
  603. SOCK_ZAPPED,
  604. SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
  605. SOCK_DBG, /* %SO_DEBUG setting */
  606. SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
  607. SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
  608. SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
  609. SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
  610. SOCK_MEMALLOC, /* VM depends on this socket for swapping */
  611. SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
  612. SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
  613. SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
  614. SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
  615. SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
  616. SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
  617. SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
  618. SOCK_FASYNC, /* fasync() active */
  619. SOCK_RXQ_OVFL,
  620. SOCK_ZEROCOPY, /* buffers from userspace */
  621. SOCK_WIFI_STATUS, /* push wifi status to userspace */
  622. SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
  623. * Will use last 4 bytes of packet sent from
  624. * user-space instead.
  625. */
  626. SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
  627. SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
  628. };
  629. static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
  630. {
  631. nsk->sk_flags = osk->sk_flags;
  632. }
  633. static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
  634. {
  635. __set_bit(flag, &sk->sk_flags);
  636. }
  637. static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
  638. {
  639. __clear_bit(flag, &sk->sk_flags);
  640. }
  641. static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
  642. {
  643. return test_bit(flag, &sk->sk_flags);
  644. }
  645. #ifdef CONFIG_NET
  646. extern struct static_key memalloc_socks;
  647. static inline int sk_memalloc_socks(void)
  648. {
  649. return static_key_false(&memalloc_socks);
  650. }
  651. #else
  652. static inline int sk_memalloc_socks(void)
  653. {
  654. return 0;
  655. }
  656. #endif
  657. static inline gfp_t sk_gfp_atomic(struct sock *sk, gfp_t gfp_mask)
  658. {
  659. return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
  660. }
  661. static inline void sk_acceptq_removed(struct sock *sk)
  662. {
  663. sk->sk_ack_backlog--;
  664. }
  665. static inline void sk_acceptq_added(struct sock *sk)
  666. {
  667. sk->sk_ack_backlog++;
  668. }
  669. static inline bool sk_acceptq_is_full(const struct sock *sk)
  670. {
  671. return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
  672. }
  673. /*
  674. * Compute minimal free write space needed to queue new packets.
  675. */
  676. static inline int sk_stream_min_wspace(const struct sock *sk)
  677. {
  678. return sk->sk_wmem_queued >> 1;
  679. }
  680. static inline int sk_stream_wspace(const struct sock *sk)
  681. {
  682. return sk->sk_sndbuf - sk->sk_wmem_queued;
  683. }
  684. extern void sk_stream_write_space(struct sock *sk);
  685. /* OOB backlog add */
  686. static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
  687. {
  688. /* dont let skb dst not refcounted, we are going to leave rcu lock */
  689. skb_dst_force(skb);
  690. if (!sk->sk_backlog.tail)
  691. sk->sk_backlog.head = skb;
  692. else
  693. sk->sk_backlog.tail->next = skb;
  694. sk->sk_backlog.tail = skb;
  695. skb->next = NULL;
  696. }
  697. /*
  698. * Take into account size of receive queue and backlog queue
  699. * Do not take into account this skb truesize,
  700. * to allow even a single big packet to come.
  701. */
  702. static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb,
  703. unsigned int limit)
  704. {
  705. unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
  706. return qsize > limit;
  707. }
  708. /* The per-socket spinlock must be held here. */
  709. static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
  710. unsigned int limit)
  711. {
  712. if (sk_rcvqueues_full(sk, skb, limit))
  713. return -ENOBUFS;
  714. __sk_add_backlog(sk, skb);
  715. sk->sk_backlog.len += skb->truesize;
  716. return 0;
  717. }
  718. extern int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
  719. static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
  720. {
  721. if (sk_memalloc_socks() && skb_pfmemalloc(skb))
  722. return __sk_backlog_rcv(sk, skb);
  723. return sk->sk_backlog_rcv(sk, skb);
  724. }
  725. static inline void sock_rps_record_flow(const struct sock *sk)
  726. {
  727. #ifdef CONFIG_RPS
  728. struct rps_sock_flow_table *sock_flow_table;
  729. rcu_read_lock();
  730. sock_flow_table = rcu_dereference(rps_sock_flow_table);
  731. rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
  732. rcu_read_unlock();
  733. #endif
  734. }
  735. static inline void sock_rps_reset_flow(const struct sock *sk)
  736. {
  737. #ifdef CONFIG_RPS
  738. struct rps_sock_flow_table *sock_flow_table;
  739. rcu_read_lock();
  740. sock_flow_table = rcu_dereference(rps_sock_flow_table);
  741. rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
  742. rcu_read_unlock();
  743. #endif
  744. }
  745. static inline void sock_rps_save_rxhash(struct sock *sk,
  746. const struct sk_buff *skb)
  747. {
  748. #ifdef CONFIG_RPS
  749. if (unlikely(sk->sk_rxhash != skb->rxhash)) {
  750. sock_rps_reset_flow(sk);
  751. sk->sk_rxhash = skb->rxhash;
  752. }
  753. #endif
  754. }
  755. static inline void sock_rps_reset_rxhash(struct sock *sk)
  756. {
  757. #ifdef CONFIG_RPS
  758. sock_rps_reset_flow(sk);
  759. sk->sk_rxhash = 0;
  760. #endif
  761. }
  762. #define sk_wait_event(__sk, __timeo, __condition) \
  763. ({ int __rc; \
  764. release_sock(__sk); \
  765. __rc = __condition; \
  766. if (!__rc) { \
  767. *(__timeo) = schedule_timeout(*(__timeo)); \
  768. } \
  769. lock_sock(__sk); \
  770. __rc = __condition; \
  771. __rc; \
  772. })
  773. extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
  774. extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
  775. extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
  776. extern int sk_stream_error(struct sock *sk, int flags, int err);
  777. extern void sk_stream_kill_queues(struct sock *sk);
  778. extern void sk_set_memalloc(struct sock *sk);
  779. extern void sk_clear_memalloc(struct sock *sk);
  780. extern int sk_wait_data(struct sock *sk, long *timeo);
  781. struct request_sock_ops;
  782. struct timewait_sock_ops;
  783. struct inet_hashinfo;
  784. struct raw_hashinfo;
  785. struct module;
  786. /*
  787. * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
  788. * un-modified. Special care is taken when initializing object to zero.
  789. */
  790. static inline void sk_prot_clear_nulls(struct sock *sk, int size)
  791. {
  792. if (offsetof(struct sock, sk_node.next) != 0)
  793. memset(sk, 0, offsetof(struct sock, sk_node.next));
  794. memset(&sk->sk_node.pprev, 0,
  795. size - offsetof(struct sock, sk_node.pprev));
  796. }
  797. /* Networking protocol blocks we attach to sockets.
  798. * socket layer -> transport layer interface
  799. * transport -> network interface is defined by struct inet_proto
  800. */
  801. struct proto {
  802. void (*close)(struct sock *sk,
  803. long timeout);
  804. int (*connect)(struct sock *sk,
  805. struct sockaddr *uaddr,
  806. int addr_len);
  807. int (*disconnect)(struct sock *sk, int flags);
  808. struct sock * (*accept)(struct sock *sk, int flags, int *err);
  809. int (*ioctl)(struct sock *sk, int cmd,
  810. unsigned long arg);
  811. int (*init)(struct sock *sk);
  812. void (*destroy)(struct sock *sk);
  813. void (*shutdown)(struct sock *sk, int how);
  814. int (*setsockopt)(struct sock *sk, int level,
  815. int optname, char __user *optval,
  816. unsigned int optlen);
  817. int (*getsockopt)(struct sock *sk, int level,
  818. int optname, char __user *optval,
  819. int __user *option);
  820. #ifdef CONFIG_COMPAT
  821. int (*compat_setsockopt)(struct sock *sk,
  822. int level,
  823. int optname, char __user *optval,
  824. unsigned int optlen);
  825. int (*compat_getsockopt)(struct sock *sk,
  826. int level,
  827. int optname, char __user *optval,
  828. int __user *option);
  829. int (*compat_ioctl)(struct sock *sk,
  830. unsigned int cmd, unsigned long arg);
  831. #endif
  832. int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
  833. struct msghdr *msg, size_t len);
  834. int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
  835. struct msghdr *msg,
  836. size_t len, int noblock, int flags,
  837. int *addr_len);
  838. int (*sendpage)(struct sock *sk, struct page *page,
  839. int offset, size_t size, int flags);
  840. int (*bind)(struct sock *sk,
  841. struct sockaddr *uaddr, int addr_len);
  842. int (*backlog_rcv) (struct sock *sk,
  843. struct sk_buff *skb);
  844. void (*release_cb)(struct sock *sk);
  845. void (*mtu_reduced)(struct sock *sk);
  846. /* Keeping track of sk's, looking them up, and port selection methods. */
  847. void (*hash)(struct sock *sk);
  848. void (*unhash)(struct sock *sk);
  849. void (*rehash)(struct sock *sk);
  850. int (*get_port)(struct sock *sk, unsigned short snum);
  851. void (*clear_sk)(struct sock *sk, int size);
  852. /* Keeping track of sockets in use */
  853. #ifdef CONFIG_PROC_FS
  854. unsigned int inuse_idx;
  855. #endif
  856. bool (*stream_memory_free)(const struct sock *sk);
  857. /* Memory pressure */
  858. void (*enter_memory_pressure)(struct sock *sk);
  859. atomic_long_t *memory_allocated; /* Current allocated memory. */
  860. struct percpu_counter *sockets_allocated; /* Current number of sockets. */
  861. /*
  862. * Pressure flag: try to collapse.
  863. * Technical note: it is used by multiple contexts non atomically.
  864. * All the __sk_mem_schedule() is of this nature: accounting
  865. * is strict, actions are advisory and have some latency.
  866. */
  867. int *memory_pressure;
  868. long *sysctl_mem;
  869. int *sysctl_wmem;
  870. int *sysctl_rmem;
  871. int max_header;
  872. bool no_autobind;
  873. struct kmem_cache *slab;
  874. unsigned int obj_size;
  875. int slab_flags;
  876. struct percpu_counter *orphan_count;
  877. struct request_sock_ops *rsk_prot;
  878. struct timewait_sock_ops *twsk_prot;
  879. union {
  880. struct inet_hashinfo *hashinfo;
  881. struct udp_table *udp_table;
  882. struct raw_hashinfo *raw_hash;
  883. } h;
  884. struct module *owner;
  885. char name[32];
  886. struct list_head node;
  887. #ifdef SOCK_REFCNT_DEBUG
  888. atomic_t socks;
  889. #endif
  890. #ifdef CONFIG_MEMCG_KMEM
  891. /*
  892. * cgroup specific init/deinit functions. Called once for all
  893. * protocols that implement it, from cgroups populate function.
  894. * This function has to setup any files the protocol want to
  895. * appear in the kmem cgroup filesystem.
  896. */
  897. int (*init_cgroup)(struct mem_cgroup *memcg,
  898. struct cgroup_subsys *ss);
  899. void (*destroy_cgroup)(struct mem_cgroup *memcg);
  900. struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
  901. #endif
  902. };
  903. /*
  904. * Bits in struct cg_proto.flags
  905. */
  906. enum cg_proto_flags {
  907. /* Currently active and new sockets should be assigned to cgroups */
  908. MEMCG_SOCK_ACTIVE,
  909. /* It was ever activated; we must disarm static keys on destruction */
  910. MEMCG_SOCK_ACTIVATED,
  911. };
  912. struct cg_proto {
  913. void (*enter_memory_pressure)(struct sock *sk);
  914. struct res_counter *memory_allocated; /* Current allocated memory. */
  915. struct percpu_counter *sockets_allocated; /* Current number of sockets. */
  916. int *memory_pressure;
  917. long *sysctl_mem;
  918. unsigned long flags;
  919. /*
  920. * memcg field is used to find which memcg we belong directly
  921. * Each memcg struct can hold more than one cg_proto, so container_of
  922. * won't really cut.
  923. *
  924. * The elegant solution would be having an inverse function to
  925. * proto_cgroup in struct proto, but that means polluting the structure
  926. * for everybody, instead of just for memcg users.
  927. */
  928. struct mem_cgroup *memcg;
  929. };
  930. extern int proto_register(struct proto *prot, int alloc_slab);
  931. extern void proto_unregister(struct proto *prot);
  932. static inline bool memcg_proto_active(struct cg_proto *cg_proto)
  933. {
  934. return test_bit(MEMCG_SOCK_ACTIVE, &cg_proto->flags);
  935. }
  936. static inline bool memcg_proto_activated(struct cg_proto *cg_proto)
  937. {
  938. return test_bit(MEMCG_SOCK_ACTIVATED, &cg_proto->flags);
  939. }
  940. #ifdef SOCK_REFCNT_DEBUG
  941. static inline void sk_refcnt_debug_inc(struct sock *sk)
  942. {
  943. atomic_inc(&sk->sk_prot->socks);
  944. }
  945. static inline void sk_refcnt_debug_dec(struct sock *sk)
  946. {
  947. atomic_dec(&sk->sk_prot->socks);
  948. printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
  949. sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
  950. }
  951. static inline void sk_refcnt_debug_release(const struct sock *sk)
  952. {
  953. if (atomic_read(&sk->sk_refcnt) != 1)
  954. printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
  955. sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
  956. }
  957. #else /* SOCK_REFCNT_DEBUG */
  958. #define sk_refcnt_debug_inc(sk) do { } while (0)
  959. #define sk_refcnt_debug_dec(sk) do { } while (0)
  960. #define sk_refcnt_debug_release(sk) do { } while (0)
  961. #endif /* SOCK_REFCNT_DEBUG */
  962. #if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
  963. extern struct static_key memcg_socket_limit_enabled;
  964. static inline struct cg_proto *parent_cg_proto(struct proto *proto,
  965. struct cg_proto *cg_proto)
  966. {
  967. return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
  968. }
  969. #define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
  970. #else
  971. #define mem_cgroup_sockets_enabled 0
  972. static inline struct cg_proto *parent_cg_proto(struct proto *proto,
  973. struct cg_proto *cg_proto)
  974. {
  975. return NULL;
  976. }
  977. #endif
  978. static inline bool sk_stream_memory_free(const struct sock *sk)
  979. {
  980. if (sk->sk_wmem_queued >= sk->sk_sndbuf)
  981. return false;
  982. return sk->sk_prot->stream_memory_free ?
  983. sk->sk_prot->stream_memory_free(sk) : true;
  984. }
  985. static inline bool sk_stream_is_writeable(const struct sock *sk)
  986. {
  987. return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
  988. sk_stream_memory_free(sk);
  989. }
  990. static inline bool sk_has_memory_pressure(const struct sock *sk)
  991. {
  992. return sk->sk_prot->memory_pressure != NULL;
  993. }
  994. static inline bool sk_under_memory_pressure(const struct sock *sk)
  995. {
  996. if (!sk->sk_prot->memory_pressure)
  997. return false;
  998. if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
  999. return !!*sk->sk_cgrp->memory_pressure;
  1000. return !!*sk->sk_prot->memory_pressure;
  1001. }
  1002. static inline void sk_leave_memory_pressure(struct sock *sk)
  1003. {
  1004. int *memory_pressure = sk->sk_prot->memory_pressure;
  1005. if (!memory_pressure)
  1006. return;
  1007. if (*memory_pressure)
  1008. *memory_pressure = 0;
  1009. if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
  1010. struct cg_proto *cg_proto = sk->sk_cgrp;
  1011. struct proto *prot = sk->sk_prot;
  1012. for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
  1013. if (*cg_proto->memory_pressure)
  1014. *cg_proto->memory_pressure = 0;
  1015. }
  1016. }
  1017. static inline void sk_enter_memory_pressure(struct sock *sk)
  1018. {
  1019. if (!sk->sk_prot->enter_memory_pressure)
  1020. return;
  1021. if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
  1022. struct cg_proto *cg_proto = sk->sk_cgrp;
  1023. struct proto *prot = sk->sk_prot;
  1024. for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
  1025. cg_proto->enter_memory_pressure(sk);
  1026. }
  1027. sk->sk_prot->enter_memory_pressure(sk);
  1028. }
  1029. static inline long sk_prot_mem_limits(const struct sock *sk, int index)
  1030. {
  1031. long *prot = sk->sk_prot->sysctl_mem;
  1032. if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
  1033. prot = sk->sk_cgrp->sysctl_mem;
  1034. return prot[index];
  1035. }
  1036. static inline void memcg_memory_allocated_add(struct cg_proto *prot,
  1037. unsigned long amt,
  1038. int *parent_status)
  1039. {
  1040. struct res_counter *fail;
  1041. int ret;
  1042. ret = res_counter_charge_nofail(prot->memory_allocated,
  1043. amt << PAGE_SHIFT, &fail);
  1044. if (ret < 0)
  1045. *parent_status = OVER_LIMIT;
  1046. }
  1047. static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
  1048. unsigned long amt)
  1049. {
  1050. res_counter_uncharge(prot->memory_allocated, amt << PAGE_SHIFT);
  1051. }
  1052. static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
  1053. {
  1054. u64 ret;
  1055. ret = res_counter_read_u64(prot->memory_allocated, RES_USAGE);
  1056. return ret >> PAGE_SHIFT;
  1057. }
  1058. static inline long
  1059. sk_memory_allocated(const struct sock *sk)
  1060. {
  1061. struct proto *prot = sk->sk_prot;
  1062. if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
  1063. return memcg_memory_allocated_read(sk->sk_cgrp);
  1064. return atomic_long_read(prot->memory_allocated);
  1065. }
  1066. static inline long
  1067. sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
  1068. {
  1069. struct proto *prot = sk->sk_prot;
  1070. if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
  1071. memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
  1072. /* update the root cgroup regardless */
  1073. atomic_long_add_return(amt, prot->memory_allocated);
  1074. return memcg_memory_allocated_read(sk->sk_cgrp);
  1075. }
  1076. return atomic_long_add_return(amt, prot->memory_allocated);
  1077. }
  1078. static inline void
  1079. sk_memory_allocated_sub(struct sock *sk, int amt)
  1080. {
  1081. struct proto *prot = sk->sk_prot;
  1082. if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
  1083. memcg_memory_allocated_sub(sk->sk_cgrp, amt);
  1084. atomic_long_sub(amt, prot->memory_allocated);
  1085. }
  1086. static inline void sk_sockets_allocated_dec(struct sock *sk)
  1087. {
  1088. struct proto *prot = sk->sk_prot;
  1089. if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
  1090. struct cg_proto *cg_proto = sk->sk_cgrp;
  1091. for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
  1092. percpu_counter_dec(cg_proto->sockets_allocated);
  1093. }
  1094. percpu_counter_dec(prot->sockets_allocated);
  1095. }
  1096. static inline void sk_sockets_allocated_inc(struct sock *sk)
  1097. {
  1098. struct proto *prot = sk->sk_prot;
  1099. if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
  1100. struct cg_proto *cg_proto = sk->sk_cgrp;
  1101. for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
  1102. percpu_counter_inc(cg_proto->sockets_allocated);
  1103. }
  1104. percpu_counter_inc(prot->sockets_allocated);
  1105. }
  1106. static inline int
  1107. sk_sockets_allocated_read_positive(struct sock *sk)
  1108. {
  1109. struct proto *prot = sk->sk_prot;
  1110. if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
  1111. return percpu_counter_read_positive(sk->sk_cgrp->sockets_allocated);
  1112. return percpu_counter_read_positive(prot->sockets_allocated);
  1113. }
  1114. static inline int
  1115. proto_sockets_allocated_sum_positive(struct proto *prot)
  1116. {
  1117. return percpu_counter_sum_positive(prot->sockets_allocated);
  1118. }
  1119. static inline long
  1120. proto_memory_allocated(struct proto *prot)
  1121. {
  1122. return atomic_long_read(prot->memory_allocated);
  1123. }
  1124. static inline bool
  1125. proto_memory_pressure(struct proto *prot)
  1126. {
  1127. if (!prot->memory_pressure)
  1128. return false;
  1129. return !!*prot->memory_pressure;
  1130. }
  1131. #ifdef CONFIG_PROC_FS
  1132. /* Called with local bh disabled */
  1133. extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
  1134. extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
  1135. #else
  1136. static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
  1137. int inc)
  1138. {
  1139. }
  1140. #endif
  1141. /* With per-bucket locks this operation is not-atomic, so that
  1142. * this version is not worse.
  1143. */
  1144. static inline void __sk_prot_rehash(struct sock *sk)
  1145. {
  1146. sk->sk_prot->unhash(sk);
  1147. sk->sk_prot->hash(sk);
  1148. }
  1149. void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
  1150. /* About 10 seconds */
  1151. #define SOCK_DESTROY_TIME (10*HZ)
  1152. /* Sockets 0-1023 can't be bound to unless you are superuser */
  1153. #define PROT_SOCK 1024
  1154. #define SHUTDOWN_MASK 3
  1155. #define RCV_SHUTDOWN 1
  1156. #define SEND_SHUTDOWN 2
  1157. #define SOCK_SNDBUF_LOCK 1
  1158. #define SOCK_RCVBUF_LOCK 2
  1159. #define SOCK_BINDADDR_LOCK 4
  1160. #define SOCK_BINDPORT_LOCK 8
  1161. /* sock_iocb: used to kick off async processing of socket ios */
  1162. struct sock_iocb {
  1163. struct list_head list;
  1164. int flags;
  1165. int size;
  1166. struct socket *sock;
  1167. struct sock *sk;
  1168. struct scm_cookie *scm;
  1169. struct msghdr *msg, async_msg;
  1170. struct kiocb *kiocb;
  1171. };
  1172. static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
  1173. {
  1174. return (struct sock_iocb *)iocb->private;
  1175. }
  1176. static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
  1177. {
  1178. return si->kiocb;
  1179. }
  1180. struct socket_alloc {
  1181. struct socket socket;
  1182. struct inode vfs_inode;
  1183. };
  1184. static inline struct socket *SOCKET_I(struct inode *inode)
  1185. {
  1186. return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
  1187. }
  1188. static inline struct inode *SOCK_INODE(struct socket *socket)
  1189. {
  1190. return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
  1191. }
  1192. /*
  1193. * Functions for memory accounting
  1194. */
  1195. extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
  1196. extern void __sk_mem_reclaim(struct sock *sk);
  1197. #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
  1198. #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
  1199. #define SK_MEM_SEND 0
  1200. #define SK_MEM_RECV 1
  1201. static inline int sk_mem_pages(int amt)
  1202. {
  1203. return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
  1204. }
  1205. static inline bool sk_has_account(struct sock *sk)
  1206. {
  1207. /* return true if protocol supports memory accounting */
  1208. return !!sk->sk_prot->memory_allocated;
  1209. }
  1210. static inline bool sk_wmem_schedule(struct sock *sk, int size)
  1211. {
  1212. if (!sk_has_account(sk))
  1213. return true;
  1214. return size <= sk->sk_forward_alloc ||
  1215. __sk_mem_schedule(sk, size, SK_MEM_SEND);
  1216. }
  1217. static inline bool
  1218. sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
  1219. {
  1220. if (!sk_has_account(sk))
  1221. return true;
  1222. return size<= sk->sk_forward_alloc ||
  1223. __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
  1224. skb_pfmemalloc(skb);
  1225. }
  1226. static inline void sk_mem_reclaim(struct sock *sk)
  1227. {
  1228. if (!sk_has_account(sk))
  1229. return;
  1230. if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
  1231. __sk_mem_reclaim(sk);
  1232. }
  1233. static inline void sk_mem_reclaim_partial(struct sock *sk)
  1234. {
  1235. if (!sk_has_account(sk))
  1236. return;
  1237. if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
  1238. __sk_mem_reclaim(sk);
  1239. }
  1240. static inline void sk_mem_charge(struct sock *sk, int size)
  1241. {
  1242. if (!sk_has_account(sk))
  1243. return;
  1244. sk->sk_forward_alloc -= size;
  1245. }
  1246. static inline void sk_mem_uncharge(struct sock *sk, int size)
  1247. {
  1248. if (!sk_has_account(sk))
  1249. return;
  1250. sk->sk_forward_alloc += size;
  1251. }
  1252. static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
  1253. {
  1254. sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
  1255. sk->sk_wmem_queued -= skb->truesize;
  1256. sk_mem_uncharge(sk, skb->truesize);
  1257. __kfree_skb(skb);
  1258. }
  1259. /* Used by processes to "lock" a socket state, so that
  1260. * interrupts and bottom half handlers won't change it
  1261. * from under us. It essentially blocks any incoming
  1262. * packets, so that we won't get any new data or any
  1263. * packets that change the state of the socket.
  1264. *
  1265. * While locked, BH processing will add new packets to
  1266. * the backlog queue. This queue is processed by the
  1267. * owner of the socket lock right before it is released.
  1268. *
  1269. * Since ~2.3.5 it is also exclusive sleep lock serializing
  1270. * accesses from user process context.
  1271. */
  1272. #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
  1273. /*
  1274. * Macro so as to not evaluate some arguments when
  1275. * lockdep is not enabled.
  1276. *
  1277. * Mark both the sk_lock and the sk_lock.slock as a
  1278. * per-address-family lock class.
  1279. */
  1280. #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
  1281. do { \
  1282. sk->sk_lock.owned = 0; \
  1283. init_waitqueue_head(&sk->sk_lock.wq); \
  1284. spin_lock_init(&(sk)->sk_lock.slock); \
  1285. debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
  1286. sizeof((sk)->sk_lock)); \
  1287. lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
  1288. (skey), (sname)); \
  1289. lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
  1290. } while (0)
  1291. extern void lock_sock_nested(struct sock *sk, int subclass);
  1292. static inline void lock_sock(struct sock *sk)
  1293. {
  1294. lock_sock_nested(sk, 0);
  1295. }
  1296. extern void release_sock(struct sock *sk);
  1297. /* BH context may only use the following locking interface. */
  1298. #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
  1299. #define bh_lock_sock_nested(__sk) \
  1300. spin_lock_nested(&((__sk)->sk_lock.slock), \
  1301. SINGLE_DEPTH_NESTING)
  1302. #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
  1303. extern bool lock_sock_fast(struct sock *sk);
  1304. /**
  1305. * unlock_sock_fast - complement of lock_sock_fast
  1306. * @sk: socket
  1307. * @slow: slow mode
  1308. *
  1309. * fast unlock socket for user context.
  1310. * If slow mode is on, we call regular release_sock()
  1311. */
  1312. static inline void unlock_sock_fast(struct sock *sk, bool slow)
  1313. {
  1314. if (slow)
  1315. release_sock(sk);
  1316. else
  1317. spin_unlock_bh(&sk->sk_lock.slock);
  1318. }
  1319. extern struct sock *sk_alloc(struct net *net, int family,
  1320. gfp_t priority,
  1321. struct proto *prot);
  1322. extern void sk_free(struct sock *sk);
  1323. extern void sk_release_kernel(struct sock *sk);
  1324. extern struct sock *sk_clone_lock(const struct sock *sk,
  1325. const gfp_t priority);
  1326. extern struct sk_buff *sock_wmalloc(struct sock *sk,
  1327. unsigned long size, int force,
  1328. gfp_t priority);
  1329. extern struct sk_buff *sock_rmalloc(struct sock *sk,
  1330. unsigned long size, int force,
  1331. gfp_t priority);
  1332. extern void sock_wfree(struct sk_buff *skb);
  1333. extern void skb_orphan_partial(struct sk_buff *skb);
  1334. extern void sock_rfree(struct sk_buff *skb);
  1335. extern void sock_edemux(struct sk_buff *skb);
  1336. extern int sock_setsockopt(struct socket *sock, int level,
  1337. int op, char __user *optval,
  1338. unsigned int optlen);
  1339. extern int sock_getsockopt(struct socket *sock, int level,
  1340. int op, char __user *optval,
  1341. int __user *optlen);
  1342. extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
  1343. unsigned long size,
  1344. int noblock,
  1345. int *errcode);
  1346. extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
  1347. unsigned long header_len,
  1348. unsigned long data_len,
  1349. int noblock,
  1350. int *errcode,
  1351. int max_page_order);
  1352. extern void *sock_kmalloc(struct sock *sk, int size,
  1353. gfp_t priority);
  1354. extern void sock_kfree_s(struct sock *sk, void *mem, int size);
  1355. extern void sk_send_sigurg(struct sock *sk);
  1356. /*
  1357. * Functions to fill in entries in struct proto_ops when a protocol
  1358. * does not implement a particular function.
  1359. */
  1360. extern int sock_no_bind(struct socket *,
  1361. struct sockaddr *, int);
  1362. extern int sock_no_connect(struct socket *,
  1363. struct sockaddr *, int, int);
  1364. extern int sock_no_socketpair(struct socket *,
  1365. struct socket *);
  1366. extern int sock_no_accept(struct socket *,
  1367. struct socket *, int);
  1368. extern int sock_no_getname(struct socket *,
  1369. struct sockaddr *, int *, int);
  1370. extern unsigned int sock_no_poll(struct file *, struct socket *,
  1371. struct poll_table_struct *);
  1372. extern int sock_no_ioctl(struct socket *, unsigned int,
  1373. unsigned long);
  1374. extern int sock_no_listen(struct socket *, int);
  1375. extern int sock_no_shutdown(struct socket *, int);
  1376. extern int sock_no_getsockopt(struct socket *, int , int,
  1377. char __user *, int __user *);
  1378. extern int sock_no_setsockopt(struct socket *, int, int,
  1379. char __user *, unsigned int);
  1380. extern int sock_no_sendmsg(struct kiocb *, struct socket *,
  1381. struct msghdr *, size_t);
  1382. extern int sock_no_recvmsg(struct kiocb *, struct socket *,
  1383. struct msghdr *, size_t, int);
  1384. extern int sock_no_mmap(struct file *file,
  1385. struct socket *sock,
  1386. struct vm_area_struct *vma);
  1387. extern ssize_t sock_no_sendpage(struct socket *sock,
  1388. struct page *page,
  1389. int offset, size_t size,
  1390. int flags);
  1391. /*
  1392. * Functions to fill in entries in struct proto_ops when a protocol
  1393. * uses the inet style.
  1394. */
  1395. extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
  1396. char __user *optval, int __user *optlen);
  1397. extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
  1398. struct msghdr *msg, size_t size, int flags);
  1399. extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
  1400. char __user *optval, unsigned int optlen);
  1401. extern int compat_sock_common_getsockopt(struct socket *sock, int level,
  1402. int optname, char __user *optval, int __user *optlen);
  1403. extern int compat_sock_common_setsockopt(struct socket *sock, int level,
  1404. int optname, char __user *optval, unsigned int optlen);
  1405. extern void sk_common_release(struct sock *sk);
  1406. /*
  1407. * Default socket callbacks and setup code
  1408. */
  1409. /* Initialise core socket variables */
  1410. extern void sock_init_data(struct socket *sock, struct sock *sk);
  1411. extern void sk_filter_release_rcu(struct rcu_head *rcu);
  1412. /**
  1413. * sk_filter_release - release a socket filter
  1414. * @fp: filter to remove
  1415. *
  1416. * Remove a filter from a socket and release its resources.
  1417. */
  1418. static inline void sk_filter_release(struct sk_filter *fp)
  1419. {
  1420. if (atomic_dec_and_test(&fp->refcnt))
  1421. call_rcu(&fp->rcu, sk_filter_release_rcu);
  1422. }
  1423. static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
  1424. {
  1425. unsigned int size = sk_filter_len(fp);
  1426. atomic_sub(size, &sk->sk_omem_alloc);
  1427. sk_filter_release(fp);
  1428. }
  1429. static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
  1430. {
  1431. atomic_inc(&fp->refcnt);
  1432. atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
  1433. }
  1434. /*
  1435. * Socket reference counting postulates.
  1436. *
  1437. * * Each user of socket SHOULD hold a reference count.
  1438. * * Each access point to socket (an hash table bucket, reference from a list,
  1439. * running timer, skb in flight MUST hold a reference count.
  1440. * * When reference count hits 0, it means it will never increase back.
  1441. * * When reference count hits 0, it means that no references from
  1442. * outside exist to this socket and current process on current CPU
  1443. * is last user and may/should destroy this socket.
  1444. * * sk_free is called from any context: process, BH, IRQ. When
  1445. * it is called, socket has no references from outside -> sk_free
  1446. * may release descendant resources allocated by the socket, but
  1447. * to the time when it is called, socket is NOT referenced by any
  1448. * hash tables, lists etc.
  1449. * * Packets, delivered from outside (from network or from another process)
  1450. * and enqueued on receive/error queues SHOULD NOT grab reference count,
  1451. * when they sit in queue. Otherwise, packets will leak to hole, when
  1452. * socket is looked up by one cpu and unhasing is made by another CPU.
  1453. * It is true for udp/raw, netlink (leak to receive and error queues), tcp
  1454. * (leak to backlog). Packet socket does all the processing inside
  1455. * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
  1456. * use separate SMP lock, so that they are prone too.
  1457. */
  1458. /* Ungrab socket and destroy it, if it was the last reference. */
  1459. static inline void sock_put(struct sock *sk)
  1460. {
  1461. if (atomic_dec_and_test(&sk->sk_refcnt))
  1462. sk_free(sk);
  1463. }
  1464. extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
  1465. const int nested);
  1466. static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
  1467. {
  1468. sk->sk_tx_queue_mapping = tx_queue;
  1469. }
  1470. static inline void sk_tx_queue_clear(struct sock *sk)
  1471. {
  1472. sk->sk_tx_queue_mapping = -1;
  1473. }
  1474. static inline int sk_tx_queue_get(const struct sock *sk)
  1475. {
  1476. return sk ? sk->sk_tx_queue_mapping : -1;
  1477. }
  1478. static inline void sk_set_socket(struct sock *sk, struct socket *sock)
  1479. {
  1480. sk_tx_queue_clear(sk);
  1481. sk->sk_socket = sock;
  1482. }
  1483. static inline wait_queue_head_t *sk_sleep(struct sock *sk)
  1484. {
  1485. BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
  1486. return &rcu_dereference_raw(sk->sk_wq)->wait;
  1487. }
  1488. /* Detach socket from process context.
  1489. * Announce socket dead, detach it from wait queue and inode.
  1490. * Note that parent inode held reference count on this struct sock,
  1491. * we do not release it in this function, because protocol
  1492. * probably wants some additional cleanups or even continuing
  1493. * to work with this socket (TCP).
  1494. */
  1495. static inline void sock_orphan(struct sock *sk)
  1496. {
  1497. write_lock_bh(&sk->sk_callback_lock);
  1498. sock_set_flag(sk, SOCK_DEAD);
  1499. sk_set_socket(sk, NULL);
  1500. sk->sk_wq = NULL;
  1501. write_unlock_bh(&sk->sk_callback_lock);
  1502. }
  1503. static inline void sock_graft(struct sock *sk, struct socket *parent)
  1504. {
  1505. write_lock_bh(&sk->sk_callback_lock);
  1506. sk->sk_wq = parent->wq;
  1507. parent->sk = sk;
  1508. sk_set_socket(sk, parent);
  1509. security_sock_graft(sk, parent);
  1510. write_unlock_bh(&sk->sk_callback_lock);
  1511. }
  1512. extern kuid_t sock_i_uid(struct sock *sk);
  1513. extern unsigned long sock_i_ino(struct sock *sk);
  1514. static inline struct dst_entry *
  1515. __sk_dst_get(struct sock *sk)
  1516. {
  1517. return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
  1518. lockdep_is_held(&sk->sk_lock.slock));
  1519. }
  1520. static inline struct dst_entry *
  1521. sk_dst_get(struct sock *sk)
  1522. {
  1523. struct dst_entry *dst;
  1524. rcu_read_lock();
  1525. dst = rcu_dereference(sk->sk_dst_cache);
  1526. if (dst)
  1527. dst_hold(dst);
  1528. rcu_read_unlock();
  1529. return dst;
  1530. }
  1531. extern void sk_reset_txq(struct sock *sk);
  1532. static inline void dst_negative_advice(struct sock *sk)
  1533. {
  1534. struct dst_entry *ndst, *dst = __sk_dst_get(sk);
  1535. if (dst && dst->ops->negative_advice) {
  1536. ndst = dst->ops->negative_advice(dst);
  1537. if (ndst != dst) {
  1538. rcu_assign_pointer(sk->sk_dst_cache, ndst);
  1539. sk_reset_txq(sk);
  1540. }
  1541. }
  1542. }
  1543. static inline void
  1544. __sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1545. {
  1546. struct dst_entry *old_dst;
  1547. sk_tx_queue_clear(sk);
  1548. /*
  1549. * This can be called while sk is owned by the caller only,
  1550. * with no state that can be checked in a rcu_dereference_check() cond
  1551. */
  1552. old_dst = rcu_dereference_raw(sk->sk_dst_cache);
  1553. rcu_assign_pointer(sk->sk_dst_cache, dst);
  1554. dst_release(old_dst);
  1555. }
  1556. static inline void
  1557. sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1558. {
  1559. spin_lock(&sk->sk_dst_lock);
  1560. __sk_dst_set(sk, dst);
  1561. spin_unlock(&sk->sk_dst_lock);
  1562. }
  1563. static inline void
  1564. __sk_dst_reset(struct sock *sk)
  1565. {
  1566. __sk_dst_set(sk, NULL);
  1567. }
  1568. static inline void
  1569. sk_dst_reset(struct sock *sk)
  1570. {
  1571. spin_lock(&sk->sk_dst_lock);
  1572. __sk_dst_reset(sk);
  1573. spin_unlock(&sk->sk_dst_lock);
  1574. }
  1575. extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
  1576. extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
  1577. static inline bool sk_can_gso(const struct sock *sk)
  1578. {
  1579. return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
  1580. }
  1581. extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
  1582. static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
  1583. {
  1584. sk->sk_route_nocaps |= flags;
  1585. sk->sk_route_caps &= ~flags;
  1586. }
  1587. static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
  1588. char __user *from, char *to,
  1589. int copy, int offset)
  1590. {
  1591. if (skb->ip_summed == CHECKSUM_NONE) {
  1592. int err = 0;
  1593. __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
  1594. if (err)
  1595. return err;
  1596. skb->csum = csum_block_add(skb->csum, csum, offset);
  1597. } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
  1598. if (!access_ok(VERIFY_READ, from, copy) ||
  1599. __copy_from_user_nocache(to, from, copy))
  1600. return -EFAULT;
  1601. } else if (copy_from_user(to, from, copy))
  1602. return -EFAULT;
  1603. return 0;
  1604. }
  1605. static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
  1606. char __user *from, int copy)
  1607. {
  1608. int err, offset = skb->len;
  1609. err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
  1610. copy, offset);
  1611. if (err)
  1612. __skb_trim(skb, offset);
  1613. return err;
  1614. }
  1615. static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
  1616. struct sk_buff *skb,
  1617. struct page *page,
  1618. int off, int copy)
  1619. {
  1620. int err;
  1621. err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
  1622. copy, skb->len);
  1623. if (err)
  1624. return err;
  1625. skb->len += copy;
  1626. skb->data_len += copy;
  1627. skb->truesize += copy;
  1628. sk->sk_wmem_queued += copy;
  1629. sk_mem_charge(sk, copy);
  1630. return 0;
  1631. }
  1632. static inline int skb_copy_to_page(struct sock *sk, char __user *from,
  1633. struct sk_buff *skb, struct page *page,
  1634. int off, int copy)
  1635. {
  1636. if (skb->ip_summed == CHECKSUM_NONE) {
  1637. int err = 0;
  1638. __wsum csum = csum_and_copy_from_user(from,
  1639. page_address(page) + off,
  1640. copy, 0, &err);
  1641. if (err)
  1642. return err;
  1643. skb->csum = csum_block_add(skb->csum, csum, skb->len);
  1644. } else if (copy_from_user(page_address(page) + off, from, copy))
  1645. return -EFAULT;
  1646. skb->len += copy;
  1647. skb->data_len += copy;
  1648. skb->truesize += copy;
  1649. sk->sk_wmem_queued += copy;
  1650. sk_mem_charge(sk, copy);
  1651. return 0;
  1652. }
  1653. /**
  1654. * sk_wmem_alloc_get - returns write allocations
  1655. * @sk: socket
  1656. *
  1657. * Returns sk_wmem_alloc minus initial offset of one
  1658. */
  1659. static inline int sk_wmem_alloc_get(const struct sock *sk)
  1660. {
  1661. return atomic_read(&sk->sk_wmem_alloc) - 1;
  1662. }
  1663. /**
  1664. * sk_rmem_alloc_get - returns read allocations
  1665. * @sk: socket
  1666. *
  1667. * Returns sk_rmem_alloc
  1668. */
  1669. static inline int sk_rmem_alloc_get(const struct sock *sk)
  1670. {
  1671. return atomic_read(&sk->sk_rmem_alloc);
  1672. }
  1673. /**
  1674. * sk_has_allocations - check if allocations are outstanding
  1675. * @sk: socket
  1676. *
  1677. * Returns true if socket has write or read allocations
  1678. */
  1679. static inline bool sk_has_allocations(const struct sock *sk)
  1680. {
  1681. return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
  1682. }
  1683. /**
  1684. * wq_has_sleeper - check if there are any waiting processes
  1685. * @wq: struct socket_wq
  1686. *
  1687. * Returns true if socket_wq has waiting processes
  1688. *
  1689. * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
  1690. * barrier call. They were added due to the race found within the tcp code.
  1691. *
  1692. * Consider following tcp code paths:
  1693. *
  1694. * CPU1 CPU2
  1695. *
  1696. * sys_select receive packet
  1697. * ... ...
  1698. * __add_wait_queue update tp->rcv_nxt
  1699. * ... ...
  1700. * tp->rcv_nxt check sock_def_readable
  1701. * ... {
  1702. * schedule rcu_read_lock();
  1703. * wq = rcu_dereference(sk->sk_wq);
  1704. * if (wq && waitqueue_active(&wq->wait))
  1705. * wake_up_interruptible(&wq->wait)
  1706. * ...
  1707. * }
  1708. *
  1709. * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
  1710. * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
  1711. * could then endup calling schedule and sleep forever if there are no more
  1712. * data on the socket.
  1713. *
  1714. */
  1715. static inline bool wq_has_sleeper(struct socket_wq *wq)
  1716. {
  1717. /* We need to be sure we are in sync with the
  1718. * add_wait_queue modifications to the wait queue.
  1719. *
  1720. * This memory barrier is paired in the sock_poll_wait.
  1721. */
  1722. smp_mb();
  1723. return wq && waitqueue_active(&wq->wait);
  1724. }
  1725. /**
  1726. * sock_poll_wait - place memory barrier behind the poll_wait call.
  1727. * @filp: file
  1728. * @wait_address: socket wait queue
  1729. * @p: poll_table
  1730. *
  1731. * See the comments in the wq_has_sleeper function.
  1732. */
  1733. static inline void sock_poll_wait(struct file *filp,
  1734. wait_queue_head_t *wait_address, poll_table *p)
  1735. {
  1736. if (!poll_does_not_wait(p) && wait_address) {
  1737. poll_wait(filp, wait_address, p);
  1738. /* We need to be sure we are in sync with the
  1739. * socket flags modification.
  1740. *
  1741. * This memory barrier is paired in the wq_has_sleeper.
  1742. */
  1743. smp_mb();
  1744. }
  1745. }
  1746. /*
  1747. * Queue a received datagram if it will fit. Stream and sequenced
  1748. * protocols can't normally use this as they need to fit buffers in
  1749. * and play with them.
  1750. *
  1751. * Inlined as it's very short and called for pretty much every
  1752. * packet ever received.
  1753. */
  1754. static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
  1755. {
  1756. skb_orphan(skb);
  1757. skb->sk = sk;
  1758. skb->destructor = sock_wfree;
  1759. /*
  1760. * We used to take a refcount on sk, but following operation
  1761. * is enough to guarantee sk_free() wont free this sock until
  1762. * all in-flight packets are completed
  1763. */
  1764. atomic_add(skb->truesize, &sk->sk_wmem_alloc);
  1765. }
  1766. static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
  1767. {
  1768. skb_orphan(skb);
  1769. skb->sk = sk;
  1770. skb->destructor = sock_rfree;
  1771. atomic_add(skb->truesize, &sk->sk_rmem_alloc);
  1772. sk_mem_charge(sk, skb->truesize);
  1773. }
  1774. extern void sk_reset_timer(struct sock *sk, struct timer_list *timer,
  1775. unsigned long expires);
  1776. extern void sk_stop_timer(struct sock *sk, struct timer_list *timer);
  1777. extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
  1778. extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
  1779. /*
  1780. * Recover an error report and clear atomically
  1781. */
  1782. static inline int sock_error(struct sock *sk)
  1783. {
  1784. int err;
  1785. if (likely(!sk->sk_err))
  1786. return 0;
  1787. err = xchg(&sk->sk_err, 0);
  1788. return -err;
  1789. }
  1790. static inline unsigned long sock_wspace(struct sock *sk)
  1791. {
  1792. int amt = 0;
  1793. if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
  1794. amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
  1795. if (amt < 0)
  1796. amt = 0;
  1797. }
  1798. return amt;
  1799. }
  1800. static inline void sk_wake_async(struct sock *sk, int how, int band)
  1801. {
  1802. if (sock_flag(sk, SOCK_FASYNC))
  1803. sock_wake_async(sk->sk_socket, how, band);
  1804. }
  1805. /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
  1806. * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
  1807. * Note: for send buffers, TCP works better if we can build two skbs at
  1808. * minimum.
  1809. */
  1810. #define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
  1811. #define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
  1812. #define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
  1813. static inline void sk_stream_moderate_sndbuf(struct sock *sk)
  1814. {
  1815. if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
  1816. sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
  1817. sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
  1818. }
  1819. }
  1820. struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
  1821. /**
  1822. * sk_page_frag - return an appropriate page_frag
  1823. * @sk: socket
  1824. *
  1825. * If socket allocation mode allows current thread to sleep, it means its
  1826. * safe to use the per task page_frag instead of the per socket one.
  1827. */
  1828. static inline struct page_frag *sk_page_frag(struct sock *sk)
  1829. {
  1830. if (sk->sk_allocation & __GFP_WAIT)
  1831. return &current->task_frag;
  1832. return &sk->sk_frag;
  1833. }
  1834. extern bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
  1835. /*
  1836. * Default write policy as shown to user space via poll/select/SIGIO
  1837. */
  1838. static inline bool sock_writeable(const struct sock *sk)
  1839. {
  1840. return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
  1841. }
  1842. static inline gfp_t gfp_any(void)
  1843. {
  1844. return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
  1845. }
  1846. static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
  1847. {
  1848. return noblock ? 0 : sk->sk_rcvtimeo;
  1849. }
  1850. static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
  1851. {
  1852. return noblock ? 0 : sk->sk_sndtimeo;
  1853. }
  1854. static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
  1855. {
  1856. return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
  1857. }
  1858. /* Alas, with timeout socket operations are not restartable.
  1859. * Compare this to poll().
  1860. */
  1861. static inline int sock_intr_errno(long timeo)
  1862. {
  1863. return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
  1864. }
  1865. extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
  1866. struct sk_buff *skb);
  1867. extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
  1868. struct sk_buff *skb);
  1869. static inline void
  1870. sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
  1871. {
  1872. ktime_t kt = skb->tstamp;
  1873. struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
  1874. /*
  1875. * generate control messages if
  1876. * - receive time stamping in software requested (SOCK_RCVTSTAMP
  1877. * or SOCK_TIMESTAMPING_RX_SOFTWARE)
  1878. * - software time stamp available and wanted
  1879. * (SOCK_TIMESTAMPING_SOFTWARE)
  1880. * - hardware time stamps available and wanted
  1881. * (SOCK_TIMESTAMPING_SYS_HARDWARE or
  1882. * SOCK_TIMESTAMPING_RAW_HARDWARE)
  1883. */
  1884. if (sock_flag(sk, SOCK_RCVTSTAMP) ||
  1885. sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
  1886. (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
  1887. (hwtstamps->hwtstamp.tv64 &&
  1888. sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
  1889. (hwtstamps->syststamp.tv64 &&
  1890. sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
  1891. __sock_recv_timestamp(msg, sk, skb);
  1892. else
  1893. sk->sk_stamp = kt;
  1894. if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
  1895. __sock_recv_wifi_status(msg, sk, skb);
  1896. }
  1897. extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
  1898. struct sk_buff *skb);
  1899. static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
  1900. struct sk_buff *skb)
  1901. {
  1902. #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
  1903. (1UL << SOCK_RCVTSTAMP) | \
  1904. (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
  1905. (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
  1906. (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
  1907. (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
  1908. if (sk->sk_flags & FLAGS_TS_OR_DROPS)
  1909. __sock_recv_ts_and_drops(msg, sk, skb);
  1910. else
  1911. sk->sk_stamp = skb->tstamp;
  1912. }
  1913. /**
  1914. * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
  1915. * @sk: socket sending this packet
  1916. * @tx_flags: filled with instructions for time stamping
  1917. *
  1918. * Currently only depends on SOCK_TIMESTAMPING* flags.
  1919. */
  1920. extern void sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
  1921. /**
  1922. * sk_eat_skb - Release a skb if it is no longer needed
  1923. * @sk: socket to eat this skb from
  1924. * @skb: socket buffer to eat
  1925. * @copied_early: flag indicating whether DMA operations copied this data early
  1926. *
  1927. * This routine must be called with interrupts disabled or with the socket
  1928. * locked so that the sk_buff queue operation is ok.
  1929. */
  1930. #ifdef CONFIG_NET_DMA
  1931. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
  1932. {
  1933. __skb_unlink(skb, &sk->sk_receive_queue);
  1934. if (!copied_early)
  1935. __kfree_skb(skb);
  1936. else
  1937. __skb_queue_tail(&sk->sk_async_wait_queue, skb);
  1938. }
  1939. #else
  1940. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
  1941. {
  1942. __skb_unlink(skb, &sk->sk_receive_queue);
  1943. __kfree_skb(skb);
  1944. }
  1945. #endif
  1946. static inline
  1947. struct net *sock_net(const struct sock *sk)
  1948. {
  1949. return read_pnet(&sk->sk_net);
  1950. }
  1951. static inline
  1952. void sock_net_set(struct sock *sk, struct net *net)
  1953. {
  1954. write_pnet(&sk->sk_net, net);
  1955. }
  1956. /*
  1957. * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
  1958. * They should not hold a reference to a namespace in order to allow
  1959. * to stop it.
  1960. * Sockets after sk_change_net should be released using sk_release_kernel
  1961. */
  1962. static inline void sk_change_net(struct sock *sk, struct net *net)
  1963. {
  1964. put_net(sock_net(sk));
  1965. sock_net_set(sk, hold_net(net));
  1966. }
  1967. static inline struct sock *skb_steal_sock(struct sk_buff *skb)
  1968. {
  1969. if (skb->sk) {
  1970. struct sock *sk = skb->sk;
  1971. skb->destructor = NULL;
  1972. skb->sk = NULL;
  1973. return sk;
  1974. }
  1975. return NULL;
  1976. }
  1977. extern void sock_enable_timestamp(struct sock *sk, int flag);
  1978. extern int sock_get_timestamp(struct sock *, struct timeval __user *);
  1979. extern int sock_get_timestampns(struct sock *, struct timespec __user *);
  1980. extern int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len,
  1981. int level, int type);
  1982. /*
  1983. * Enable debug/info messages
  1984. */
  1985. extern int net_msg_warn;
  1986. #define NETDEBUG(fmt, args...) \
  1987. do { if (net_msg_warn) printk(fmt,##args); } while (0)
  1988. #define LIMIT_NETDEBUG(fmt, args...) \
  1989. do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
  1990. extern __u32 sysctl_wmem_max;
  1991. extern __u32 sysctl_rmem_max;
  1992. extern int sysctl_optmem_max;
  1993. extern __u32 sysctl_wmem_default;
  1994. extern __u32 sysctl_rmem_default;
  1995. #endif /* _SOCK_H */