sock.h 62 KB

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