sock.h 63 KB

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