sock.h 88 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * INET An implementation of the TCP/IP protocol suite for the LINUX
  4. * operating system. INET is implemented using the BSD Socket
  5. * interface as the means of communication with the user level.
  6. *
  7. * Definitions for the AF_INET socket handler.
  8. *
  9. * Version: @(#)sock.h 1.0.4 05/13/93
  10. *
  11. * Authors: Ross Biro
  12. * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  13. * Corey Minyard <wf-rch!minyard@relay.EU.net>
  14. * Florian La Roche <flla@stud.uni-sb.de>
  15. *
  16. * Fixes:
  17. * Alan Cox : Volatiles in skbuff pointers. See
  18. * skbuff comments. May be overdone,
  19. * better to prove they can be removed
  20. * than the reverse.
  21. * Alan Cox : Added a zapped field for tcp to note
  22. * a socket is reset and must stay shut up
  23. * Alan Cox : New fields for options
  24. * Pauline Middelink : identd support
  25. * Alan Cox : Eliminate low level recv/recvfrom
  26. * David S. Miller : New socket lookup architecture.
  27. * Steve Whitehouse: Default routines for sock_ops
  28. * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made
  29. * protinfo be just a void pointer, as the
  30. * protocol specific parts were moved to
  31. * respective headers and ipv4/v6, etc now
  32. * use private slabcaches for its socks
  33. * Pedro Hortas : New flags field for socket options
  34. */
  35. #ifndef _SOCK_H
  36. #define _SOCK_H
  37. #include <linux/hardirq.h>
  38. #include <linux/kernel.h>
  39. #include <linux/list.h>
  40. #include <linux/list_nulls.h>
  41. #include <linux/timer.h>
  42. #include <linux/cache.h>
  43. #include <linux/bitops.h>
  44. #include <linux/lockdep.h>
  45. #include <linux/netdevice.h>
  46. #include <linux/skbuff.h> /* struct sk_buff */
  47. #include <linux/mm.h>
  48. #include <linux/security.h>
  49. #include <linux/slab.h>
  50. #include <linux/uaccess.h>
  51. #include <linux/page_counter.h>
  52. #include <linux/memcontrol.h>
  53. #include <linux/static_key.h>
  54. #include <linux/sched.h>
  55. #include <linux/wait.h>
  56. #include <linux/cgroup-defs.h>
  57. #include <linux/rbtree.h>
  58. #include <linux/rculist_nulls.h>
  59. #include <linux/poll.h>
  60. #include <linux/sockptr.h>
  61. #include <linux/indirect_call_wrapper.h>
  62. #include <linux/atomic.h>
  63. #include <linux/refcount.h>
  64. #include <linux/llist.h>
  65. #include <net/dst.h>
  66. #include <net/checksum.h>
  67. #include <net/tcp_states.h>
  68. #include <linux/net_tstamp.h>
  69. #include <net/l3mdev.h>
  70. #include <uapi/linux/socket.h>
  71. /*
  72. * This structure really needs to be cleaned up.
  73. * Most of it is for TCP, and not used by any of
  74. * the other protocols.
  75. */
  76. /* This is the per-socket lock. The spinlock provides a synchronization
  77. * between user contexts and software interrupt processing, whereas the
  78. * mini-semaphore synchronizes multiple users amongst themselves.
  79. */
  80. typedef struct {
  81. spinlock_t slock;
  82. int owned;
  83. wait_queue_head_t wq;
  84. /*
  85. * We express the mutex-alike socket_lock semantics
  86. * to the lock validator by explicitly managing
  87. * the slock as a lock variant (in addition to
  88. * the slock itself):
  89. */
  90. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  91. struct lockdep_map dep_map;
  92. #endif
  93. } socket_lock_t;
  94. struct sock;
  95. struct proto;
  96. struct net;
  97. typedef __u32 __bitwise __portpair;
  98. typedef __u64 __bitwise __addrpair;
  99. /**
  100. * struct sock_common - minimal network layer representation of sockets
  101. * @skc_daddr: Foreign IPv4 addr
  102. * @skc_rcv_saddr: Bound local IPv4 addr
  103. * @skc_addrpair: 8-byte-aligned __u64 union of @skc_daddr & @skc_rcv_saddr
  104. * @skc_hash: hash value used with various protocol lookup tables
  105. * @skc_u16hashes: two u16 hash values used by UDP lookup tables
  106. * @skc_dport: placeholder for inet_dport/tw_dport
  107. * @skc_num: placeholder for inet_num/tw_num
  108. * @skc_portpair: __u32 union of @skc_dport & @skc_num
  109. * @skc_family: network address family
  110. * @skc_state: Connection state
  111. * @skc_reuse: %SO_REUSEADDR setting
  112. * @skc_reuseport: %SO_REUSEPORT setting
  113. * @skc_ipv6only: socket is IPV6 only
  114. * @skc_net_refcnt: socket is using net ref counting
  115. * @skc_bypass_prot_mem: bypass the per-protocol memory accounting for skb
  116. * @skc_bound_dev_if: bound device index if != 0
  117. * @skc_bind_node: bind hash linkage for various protocol lookup tables
  118. * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
  119. * @skc_prot: protocol handlers inside a network family
  120. * @skc_net: reference to the network namespace of this socket
  121. * @skc_v6_daddr: IPV6 destination address
  122. * @skc_v6_rcv_saddr: IPV6 source address
  123. * @skc_cookie: socket's cookie value
  124. * @skc_node: main hash linkage for various protocol lookup tables
  125. * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
  126. * @skc_tx_queue_mapping: tx queue number for this connection
  127. * @skc_rx_queue_mapping: rx queue number for this connection
  128. * @skc_flags: place holder for sk_flags
  129. * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
  130. * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
  131. * @skc_listener: connection request listener socket (aka rsk_listener)
  132. * [union with @skc_flags]
  133. * @skc_tw_dr: (aka tw_dr) ptr to &struct inet_timewait_death_row
  134. * [union with @skc_flags]
  135. * @skc_incoming_cpu: record/match cpu processing incoming packets
  136. * @skc_rcv_wnd: (aka rsk_rcv_wnd) TCP receive window size (possibly scaled)
  137. * [union with @skc_incoming_cpu]
  138. * @skc_tw_rcv_nxt: (aka tw_rcv_nxt) TCP window next expected seq number
  139. * [union with @skc_incoming_cpu]
  140. * @skc_refcnt: reference count
  141. *
  142. * This is the minimal network layer representation of sockets, the header
  143. * for struct sock and struct inet_timewait_sock.
  144. */
  145. struct sock_common {
  146. union {
  147. __addrpair skc_addrpair;
  148. struct {
  149. __be32 skc_daddr;
  150. __be32 skc_rcv_saddr;
  151. };
  152. };
  153. union {
  154. unsigned int skc_hash;
  155. __u16 skc_u16hashes[2];
  156. };
  157. /* skc_dport && skc_num must be grouped as well */
  158. union {
  159. __portpair skc_portpair;
  160. struct {
  161. __be16 skc_dport;
  162. __u16 skc_num;
  163. };
  164. };
  165. unsigned short skc_family;
  166. volatile unsigned char skc_state;
  167. unsigned char skc_reuse:4;
  168. unsigned char skc_reuseport:1;
  169. unsigned char skc_ipv6only:1;
  170. unsigned char skc_net_refcnt:1;
  171. unsigned char skc_bypass_prot_mem:1;
  172. int skc_bound_dev_if;
  173. union {
  174. struct hlist_node skc_bind_node;
  175. struct hlist_node skc_portaddr_node;
  176. };
  177. struct proto *skc_prot;
  178. possible_net_t skc_net;
  179. #if IS_ENABLED(CONFIG_IPV6)
  180. struct in6_addr skc_v6_daddr;
  181. struct in6_addr skc_v6_rcv_saddr;
  182. #endif
  183. atomic64_t skc_cookie;
  184. /* following fields are padding to force
  185. * offset(struct sock, sk_refcnt) == 128 on 64bit arches
  186. * assuming IPV6 is enabled. We use this padding differently
  187. * for different kind of 'sockets'
  188. */
  189. union {
  190. unsigned long skc_flags;
  191. struct sock *skc_listener; /* request_sock */
  192. struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
  193. };
  194. /*
  195. * fields between dontcopy_begin/dontcopy_end
  196. * are not copied in sock_copy()
  197. */
  198. /* private: */
  199. int skc_dontcopy_begin[0];
  200. /* public: */
  201. union {
  202. struct hlist_node skc_node;
  203. struct hlist_nulls_node skc_nulls_node;
  204. };
  205. unsigned short skc_tx_queue_mapping;
  206. #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
  207. unsigned short skc_rx_queue_mapping;
  208. #endif
  209. union {
  210. int skc_incoming_cpu;
  211. u32 skc_rcv_wnd;
  212. u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
  213. };
  214. refcount_t skc_refcnt;
  215. /* private: */
  216. int skc_dontcopy_end[0];
  217. union {
  218. u32 skc_rxhash;
  219. u32 skc_window_clamp;
  220. u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
  221. };
  222. /* public: */
  223. };
  224. struct bpf_local_storage;
  225. struct sk_filter;
  226. /**
  227. * struct sock - network layer representation of sockets
  228. * @__sk_common: shared layout with inet_timewait_sock
  229. * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
  230. * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
  231. * @sk_lock: synchronizer
  232. * @sk_kern_sock: True if sock is using kernel lock classes
  233. * @sk_rcvbuf: size of receive buffer in bytes
  234. * @sk_wq: sock wait queue and async head
  235. * @sk_rx_dst: receive input route used by early demux
  236. * @sk_rx_dst_ifindex: ifindex for @sk_rx_dst
  237. * @sk_rx_dst_cookie: cookie for @sk_rx_dst
  238. * @sk_dst_cache: destination cache
  239. * @sk_dst_pending_confirm: need to confirm neighbour
  240. * @sk_policy: flow policy
  241. * @psp_assoc: PSP association, if socket is PSP-secured
  242. * @sk_receive_queue: incoming packets
  243. * @sk_wmem_alloc: transmit queue bytes committed
  244. * @sk_tsq_flags: TCP Small Queues flags
  245. * @sk_write_queue: Packet sending queue
  246. * @sk_omem_alloc: "o" is "option" or "other"
  247. * @sk_wmem_queued: persistent queue size
  248. * @sk_forward_alloc: space allocated forward
  249. * @sk_reserved_mem: space reserved and non-reclaimable for the socket
  250. * @sk_napi_id: id of the last napi context to receive data for sk
  251. * @sk_ll_usec: usecs to busypoll when there is no data
  252. * @sk_allocation: allocation mode
  253. * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
  254. * @sk_pacing_status: Pacing status (requested, handled by sch_fq)
  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_gso_disabled: if set, NETIF_F_GSO_MASK is forbidden.
  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_pacing_shift: scaling factor for TCP Small Queues
  265. * @sk_lingertime: %SO_LINGER l_linger setting
  266. * @sk_backlog: always used with the per-socket spinlock held
  267. * @sk_callback_lock: used with the callbacks in the end of this struct
  268. * @sk_error_queue: rarely used
  269. * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  270. * IPV6_ADDRFORM for instance)
  271. * @sk_err: last error
  272. * @sk_err_soft: errors that don't cause failure but are the cause of a
  273. * persistent failure not just 'timed out'
  274. * @sk_drops: raw/udp drops counter
  275. * @sk_drop_counters: optional pointer to numa_drop_counters
  276. * @sk_ack_backlog: current listen backlog
  277. * @sk_max_ack_backlog: listen backlog set in listen()
  278. * @sk_uid: user id of owner
  279. * @sk_ino: inode number (zero if orphaned)
  280. * @sk_prefer_busy_poll: prefer busypolling over softirq processing
  281. * @sk_busy_poll_budget: napi processing budget when busypolling
  282. * @sk_priority: %SO_PRIORITY setting
  283. * @sk_type: socket type (%SOCK_STREAM, etc)
  284. * @sk_protocol: which protocol this socket belongs in this network family
  285. * @sk_peer_lock: lock protecting @sk_peer_pid and @sk_peer_cred
  286. * @sk_peer_pid: &struct pid for this socket's peer
  287. * @sk_peer_cred: %SO_PEERCRED setting
  288. * @sk_rcvlowat: %SO_RCVLOWAT setting
  289. * @sk_rcvtimeo: %SO_RCVTIMEO setting
  290. * @sk_sndtimeo: %SO_SNDTIMEO setting
  291. * @sk_txhash: computed flow hash for use on transmit
  292. * @sk_txrehash: enable TX hash rethink
  293. * @sk_filter: socket filtering instructions
  294. * @sk_timer: sock cleanup timer
  295. * @tcp_retransmit_timer: tcp retransmit timer
  296. * @mptcp_retransmit_timer: mptcp retransmit timer
  297. * @sk_stamp: time stamp of last packet received
  298. * @sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
  299. * @sk_tsflags: SO_TIMESTAMPING flags
  300. * @sk_bpf_cb_flags: used in bpf_setsockopt()
  301. * @sk_use_task_frag: allow sk_page_frag() to use current->task_frag.
  302. * Sockets that can be used under memory reclaim should
  303. * set this to false.
  304. * @sk_bind_phc: SO_TIMESTAMPING bind PHC index of PTP virtual clock
  305. * for timestamping
  306. * @sk_tskey: counter to disambiguate concurrent tstamp requests
  307. * @sk_tx_queue_mapping_jiffies: time in jiffies of last @sk_tx_queue_mapping refresh.
  308. * @sk_zckey: counter to order MSG_ZEROCOPY notifications
  309. * @sk_socket: Identd and reporting IO signals
  310. * @sk_user_data: RPC layer private data. Write-protected by @sk_callback_lock.
  311. * @sk_frag: cached page frag
  312. * @sk_peek_off: current peek_offset value
  313. * @sk_send_head: front of stuff to transmit
  314. * @tcp_rtx_queue: TCP re-transmit queue [union with @sk_send_head]
  315. * @sk_security: used by security modules
  316. * @sk_mark: generic packet mark
  317. * @sk_cgrp_data: cgroup data for this cgroup
  318. * @sk_memcg: this socket's memory cgroup association
  319. * @sk_write_pending: a write to stream socket waits to start
  320. * @sk_disconnects: number of disconnect operations performed on this sock
  321. * @sk_state_change: callback to indicate change in the state of the sock
  322. * @sk_data_ready: callback to indicate there is data to be processed
  323. * @sk_write_space: callback to indicate there is bf sending space available
  324. * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
  325. * @sk_backlog_rcv: callback to process the backlog
  326. * @sk_validate_xmit_skb: ptr to an optional validate function
  327. * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
  328. * @sk_reuseport_cb: reuseport group container
  329. * @sk_bpf_storage: ptr to cache and control for bpf_sk_storage
  330. * @sk_rcu: used during RCU grace period
  331. * @sk_freeptr: used for SLAB_TYPESAFE_BY_RCU managed sockets
  332. * @sk_clockid: clockid used by time-based scheduling (SO_TXTIME)
  333. * @sk_txtime_deadline_mode: set deadline mode for SO_TXTIME
  334. * @sk_txtime_report_errors: set report errors mode for SO_TXTIME
  335. * @sk_txtime_unused: unused txtime flags
  336. * @sk_scm_recv_flags: all flags used by scm_recv()
  337. * @sk_scm_credentials: flagged by SO_PASSCRED to recv SCM_CREDENTIALS
  338. * @sk_scm_security: flagged by SO_PASSSEC to recv SCM_SECURITY
  339. * @sk_scm_pidfd: flagged by SO_PASSPIDFD to recv SCM_PIDFD
  340. * @sk_scm_rights: flagged by SO_PASSRIGHTS to recv SCM_RIGHTS
  341. * @sk_scm_unused: unused flags for scm_recv()
  342. * @ns_tracker: tracker for netns reference
  343. * @sk_user_frags: xarray of pages the user is holding a reference on.
  344. * @sk_owner: reference to the real owner of the socket that calls
  345. * sock_lock_init_class_and_name().
  346. */
  347. struct sock {
  348. /*
  349. * Now struct inet_timewait_sock also uses sock_common, so please just
  350. * don't add nothing before this first member (__sk_common) --acme
  351. */
  352. struct sock_common __sk_common;
  353. #define sk_node __sk_common.skc_node
  354. #define sk_nulls_node __sk_common.skc_nulls_node
  355. #define sk_refcnt __sk_common.skc_refcnt
  356. #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
  357. #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
  358. #define sk_rx_queue_mapping __sk_common.skc_rx_queue_mapping
  359. #endif
  360. #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
  361. #define sk_dontcopy_end __sk_common.skc_dontcopy_end
  362. #define sk_hash __sk_common.skc_hash
  363. #define sk_portpair __sk_common.skc_portpair
  364. #define sk_num __sk_common.skc_num
  365. #define sk_dport __sk_common.skc_dport
  366. #define sk_addrpair __sk_common.skc_addrpair
  367. #define sk_daddr __sk_common.skc_daddr
  368. #define sk_rcv_saddr __sk_common.skc_rcv_saddr
  369. #define sk_family __sk_common.skc_family
  370. #define sk_state __sk_common.skc_state
  371. #define sk_reuse __sk_common.skc_reuse
  372. #define sk_reuseport __sk_common.skc_reuseport
  373. #define sk_ipv6only __sk_common.skc_ipv6only
  374. #define sk_net_refcnt __sk_common.skc_net_refcnt
  375. #define sk_bypass_prot_mem __sk_common.skc_bypass_prot_mem
  376. #define sk_bound_dev_if __sk_common.skc_bound_dev_if
  377. #define sk_bind_node __sk_common.skc_bind_node
  378. #define sk_prot __sk_common.skc_prot
  379. #define sk_net __sk_common.skc_net
  380. #define sk_v6_daddr __sk_common.skc_v6_daddr
  381. #define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
  382. #define sk_cookie __sk_common.skc_cookie
  383. #define sk_incoming_cpu __sk_common.skc_incoming_cpu
  384. #define sk_flags __sk_common.skc_flags
  385. #define sk_rxhash __sk_common.skc_rxhash
  386. __cacheline_group_begin(sock_write_rx);
  387. atomic_t sk_drops;
  388. __s32 sk_peek_off;
  389. struct sk_buff_head sk_error_queue;
  390. struct sk_buff_head sk_receive_queue;
  391. /*
  392. * The backlog queue is special, it is always used with
  393. * the per-socket spinlock held and requires low latency
  394. * access. Therefore we special case it's implementation.
  395. * Note : rmem_alloc is in this structure to fill a hole
  396. * on 64bit arches, not because its logically part of
  397. * backlog.
  398. */
  399. struct {
  400. atomic_t rmem_alloc;
  401. int len;
  402. struct sk_buff *head;
  403. struct sk_buff *tail;
  404. } sk_backlog;
  405. #define sk_rmem_alloc sk_backlog.rmem_alloc
  406. __cacheline_group_end(sock_write_rx);
  407. __cacheline_group_begin(sock_read_rx);
  408. /* early demux fields */
  409. struct dst_entry __rcu *sk_rx_dst;
  410. int sk_rx_dst_ifindex;
  411. u32 sk_rx_dst_cookie;
  412. #ifdef CONFIG_NET_RX_BUSY_POLL
  413. unsigned int sk_ll_usec;
  414. unsigned int sk_napi_id;
  415. u16 sk_busy_poll_budget;
  416. u8 sk_prefer_busy_poll;
  417. #endif
  418. u8 sk_userlocks;
  419. int sk_rcvbuf;
  420. struct sk_filter __rcu *sk_filter;
  421. union {
  422. struct socket_wq __rcu *sk_wq;
  423. /* private: */
  424. struct socket_wq *sk_wq_raw;
  425. /* public: */
  426. };
  427. void (*sk_data_ready)(struct sock *sk);
  428. long sk_rcvtimeo;
  429. int sk_rcvlowat;
  430. __cacheline_group_end(sock_read_rx);
  431. __cacheline_group_begin(sock_read_rxtx);
  432. int sk_err;
  433. struct socket *sk_socket;
  434. #ifdef CONFIG_MEMCG
  435. struct mem_cgroup *sk_memcg;
  436. #endif
  437. #ifdef CONFIG_XFRM
  438. struct xfrm_policy __rcu *sk_policy[2];
  439. #endif
  440. #if IS_ENABLED(CONFIG_INET_PSP)
  441. struct psp_assoc __rcu *psp_assoc;
  442. #endif
  443. __cacheline_group_end(sock_read_rxtx);
  444. __cacheline_group_begin(sock_write_rxtx);
  445. socket_lock_t sk_lock;
  446. u32 sk_reserved_mem;
  447. int sk_forward_alloc;
  448. u32 sk_tsflags;
  449. __cacheline_group_end(sock_write_rxtx);
  450. __cacheline_group_begin(sock_write_tx);
  451. int sk_write_pending;
  452. atomic_t sk_omem_alloc;
  453. int sk_err_soft;
  454. int sk_wmem_queued;
  455. refcount_t sk_wmem_alloc;
  456. unsigned long sk_tsq_flags;
  457. union {
  458. struct sk_buff *sk_send_head;
  459. struct rb_root tcp_rtx_queue;
  460. };
  461. struct sk_buff_head sk_write_queue;
  462. struct page_frag sk_frag;
  463. union {
  464. struct timer_list sk_timer;
  465. struct timer_list tcp_retransmit_timer;
  466. struct timer_list mptcp_retransmit_timer;
  467. };
  468. unsigned long sk_pacing_rate; /* bytes per second */
  469. atomic_t sk_zckey;
  470. atomic_t sk_tskey;
  471. unsigned long sk_tx_queue_mapping_jiffies;
  472. __cacheline_group_end(sock_write_tx);
  473. __cacheline_group_begin(sock_read_tx);
  474. u32 sk_dst_pending_confirm;
  475. u32 sk_pacing_status; /* see enum sk_pacing */
  476. unsigned long sk_max_pacing_rate;
  477. long sk_sndtimeo;
  478. u32 sk_priority;
  479. u32 sk_mark;
  480. kuid_t sk_uid;
  481. u16 sk_protocol;
  482. u16 sk_type;
  483. struct dst_entry __rcu *sk_dst_cache;
  484. netdev_features_t sk_route_caps;
  485. #ifdef CONFIG_SOCK_VALIDATE_XMIT
  486. struct sk_buff* (*sk_validate_xmit_skb)(struct sock *sk,
  487. struct net_device *dev,
  488. struct sk_buff *skb);
  489. #endif
  490. u16 sk_gso_type;
  491. u16 sk_gso_max_segs;
  492. unsigned int sk_gso_max_size;
  493. gfp_t sk_allocation;
  494. u32 sk_txhash;
  495. int sk_sndbuf;
  496. u8 sk_pacing_shift;
  497. bool sk_use_task_frag;
  498. __cacheline_group_end(sock_read_tx);
  499. /*
  500. * Because of non atomicity rules, all
  501. * changes are protected by socket lock.
  502. */
  503. u8 sk_gso_disabled : 1,
  504. sk_kern_sock : 1,
  505. sk_no_check_tx : 1,
  506. sk_no_check_rx : 1;
  507. u8 sk_shutdown;
  508. unsigned long sk_lingertime;
  509. struct proto *sk_prot_creator;
  510. rwlock_t sk_callback_lock;
  511. u32 sk_ack_backlog;
  512. u32 sk_max_ack_backlog;
  513. unsigned long sk_ino;
  514. spinlock_t sk_peer_lock;
  515. int sk_bind_phc;
  516. struct pid *sk_peer_pid;
  517. const struct cred *sk_peer_cred;
  518. ktime_t sk_stamp;
  519. #if BITS_PER_LONG==32
  520. seqlock_t sk_stamp_seq;
  521. #endif
  522. int sk_disconnects;
  523. union {
  524. u8 sk_txrehash;
  525. u8 sk_scm_recv_flags;
  526. struct {
  527. u8 sk_scm_credentials : 1,
  528. sk_scm_security : 1,
  529. sk_scm_pidfd : 1,
  530. sk_scm_rights : 1,
  531. sk_scm_unused : 4;
  532. };
  533. };
  534. u8 sk_clockid;
  535. u8 sk_txtime_deadline_mode : 1,
  536. sk_txtime_report_errors : 1,
  537. sk_txtime_unused : 6;
  538. #define SK_BPF_CB_FLAG_TEST(SK, FLAG) ((SK)->sk_bpf_cb_flags & (FLAG))
  539. u8 sk_bpf_cb_flags;
  540. void *sk_user_data;
  541. #ifdef CONFIG_SECURITY
  542. void *sk_security;
  543. #endif
  544. struct sock_cgroup_data sk_cgrp_data;
  545. void (*sk_state_change)(struct sock *sk);
  546. void (*sk_write_space)(struct sock *sk);
  547. void (*sk_error_report)(struct sock *sk);
  548. int (*sk_backlog_rcv)(struct sock *sk,
  549. struct sk_buff *skb);
  550. void (*sk_destruct)(struct sock *sk);
  551. struct sock_reuseport __rcu *sk_reuseport_cb;
  552. #ifdef CONFIG_BPF_SYSCALL
  553. struct bpf_local_storage __rcu *sk_bpf_storage;
  554. #endif
  555. struct numa_drop_counters *sk_drop_counters;
  556. /* sockets using SLAB_TYPESAFE_BY_RCU can use sk_freeptr.
  557. * By the time kfree() is called, sk_rcu can not be in
  558. * use and can be mangled.
  559. */
  560. union {
  561. struct rcu_head sk_rcu;
  562. freeptr_t sk_freeptr;
  563. };
  564. netns_tracker ns_tracker;
  565. struct xarray sk_user_frags;
  566. #if IS_ENABLED(CONFIG_PROVE_LOCKING) && IS_ENABLED(CONFIG_MODULES)
  567. struct module *sk_owner;
  568. #endif
  569. };
  570. struct sock_bh_locked {
  571. struct sock *sock;
  572. local_lock_t bh_lock;
  573. };
  574. enum sk_pacing {
  575. SK_PACING_NONE = 0,
  576. SK_PACING_NEEDED = 1,
  577. SK_PACING_FQ = 2,
  578. };
  579. /* flag bits in sk_user_data
  580. *
  581. * - SK_USER_DATA_NOCOPY: Pointer stored in sk_user_data might
  582. * not be suitable for copying when cloning the socket. For instance,
  583. * it can point to a reference counted object. sk_user_data bottom
  584. * bit is set if pointer must not be copied.
  585. *
  586. * - SK_USER_DATA_BPF: Mark whether sk_user_data field is
  587. * managed/owned by a BPF reuseport array. This bit should be set
  588. * when sk_user_data's sk is added to the bpf's reuseport_array.
  589. *
  590. * - SK_USER_DATA_PSOCK: Mark whether pointer stored in
  591. * sk_user_data points to psock type. This bit should be set
  592. * when sk_user_data is assigned to a psock object.
  593. */
  594. #define SK_USER_DATA_NOCOPY 1UL
  595. #define SK_USER_DATA_BPF 2UL
  596. #define SK_USER_DATA_PSOCK 4UL
  597. #define SK_USER_DATA_PTRMASK ~(SK_USER_DATA_NOCOPY | SK_USER_DATA_BPF |\
  598. SK_USER_DATA_PSOCK)
  599. /**
  600. * sk_user_data_is_nocopy - Test if sk_user_data pointer must not be copied
  601. * @sk: socket
  602. */
  603. static inline bool sk_user_data_is_nocopy(const struct sock *sk)
  604. {
  605. return ((uintptr_t)sk->sk_user_data & SK_USER_DATA_NOCOPY);
  606. }
  607. #define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
  608. /**
  609. * __locked_read_sk_user_data_with_flags - return the pointer
  610. * only if argument flags all has been set in sk_user_data. Otherwise
  611. * return NULL
  612. *
  613. * @sk: socket
  614. * @flags: flag bits
  615. *
  616. * The caller must be holding sk->sk_callback_lock.
  617. */
  618. static inline void *
  619. __locked_read_sk_user_data_with_flags(const struct sock *sk,
  620. uintptr_t flags)
  621. {
  622. uintptr_t sk_user_data =
  623. (uintptr_t)rcu_dereference_check(__sk_user_data(sk),
  624. lockdep_is_held(&sk->sk_callback_lock));
  625. WARN_ON_ONCE(flags & SK_USER_DATA_PTRMASK);
  626. if ((sk_user_data & flags) == flags)
  627. return (void *)(sk_user_data & SK_USER_DATA_PTRMASK);
  628. return NULL;
  629. }
  630. /**
  631. * __rcu_dereference_sk_user_data_with_flags - return the pointer
  632. * only if argument flags all has been set in sk_user_data. Otherwise
  633. * return NULL
  634. *
  635. * @sk: socket
  636. * @flags: flag bits
  637. */
  638. static inline void *
  639. __rcu_dereference_sk_user_data_with_flags(const struct sock *sk,
  640. uintptr_t flags)
  641. {
  642. uintptr_t sk_user_data = (uintptr_t)rcu_dereference(__sk_user_data(sk));
  643. WARN_ON_ONCE(flags & SK_USER_DATA_PTRMASK);
  644. if ((sk_user_data & flags) == flags)
  645. return (void *)(sk_user_data & SK_USER_DATA_PTRMASK);
  646. return NULL;
  647. }
  648. #define rcu_dereference_sk_user_data(sk) \
  649. __rcu_dereference_sk_user_data_with_flags(sk, 0)
  650. #define __rcu_assign_sk_user_data_with_flags(sk, ptr, flags) \
  651. ({ \
  652. uintptr_t __tmp1 = (uintptr_t)(ptr), \
  653. __tmp2 = (uintptr_t)(flags); \
  654. WARN_ON_ONCE(__tmp1 & ~SK_USER_DATA_PTRMASK); \
  655. WARN_ON_ONCE(__tmp2 & SK_USER_DATA_PTRMASK); \
  656. rcu_assign_pointer(__sk_user_data((sk)), \
  657. __tmp1 | __tmp2); \
  658. })
  659. #define rcu_assign_sk_user_data(sk, ptr) \
  660. __rcu_assign_sk_user_data_with_flags(sk, ptr, 0)
  661. static inline
  662. struct net *sock_net(const struct sock *sk)
  663. {
  664. return read_pnet(&sk->sk_net);
  665. }
  666. static inline
  667. void sock_net_set(struct sock *sk, struct net *net)
  668. {
  669. write_pnet(&sk->sk_net, net);
  670. }
  671. /*
  672. * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
  673. * or not whether his port will be reused by someone else. SK_FORCE_REUSE
  674. * on a socket means that the socket will reuse everybody else's port
  675. * without looking at the other's sk_reuse value.
  676. */
  677. #define SK_NO_REUSE 0
  678. #define SK_CAN_REUSE 1
  679. #define SK_FORCE_REUSE 2
  680. int sk_set_peek_off(struct sock *sk, int val);
  681. static inline int sk_peek_offset(const struct sock *sk, int flags)
  682. {
  683. if (unlikely(flags & MSG_PEEK)) {
  684. return READ_ONCE(sk->sk_peek_off);
  685. }
  686. return 0;
  687. }
  688. static inline void sk_peek_offset_bwd(struct sock *sk, int val)
  689. {
  690. s32 off = READ_ONCE(sk->sk_peek_off);
  691. if (unlikely(off >= 0)) {
  692. off = max_t(s32, off - val, 0);
  693. WRITE_ONCE(sk->sk_peek_off, off);
  694. }
  695. }
  696. static inline void sk_peek_offset_fwd(struct sock *sk, int val)
  697. {
  698. sk_peek_offset_bwd(sk, -val);
  699. }
  700. /*
  701. * Hashed lists helper routines
  702. */
  703. static inline struct sock *sk_entry(const struct hlist_node *node)
  704. {
  705. return hlist_entry(node, struct sock, sk_node);
  706. }
  707. static inline struct sock *__sk_head(const struct hlist_head *head)
  708. {
  709. return hlist_entry(head->first, struct sock, sk_node);
  710. }
  711. static inline struct sock *sk_head(const struct hlist_head *head)
  712. {
  713. return hlist_empty(head) ? NULL : __sk_head(head);
  714. }
  715. static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
  716. {
  717. return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
  718. }
  719. static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
  720. {
  721. return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
  722. }
  723. static inline struct sock *sk_next(const struct sock *sk)
  724. {
  725. return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
  726. }
  727. static inline struct sock *sk_nulls_next(const struct sock *sk)
  728. {
  729. return (!is_a_nulls(sk->sk_nulls_node.next)) ?
  730. hlist_nulls_entry(sk->sk_nulls_node.next,
  731. struct sock, sk_nulls_node) :
  732. NULL;
  733. }
  734. static inline bool sk_unhashed(const struct sock *sk)
  735. {
  736. return hlist_unhashed(&sk->sk_node);
  737. }
  738. static inline bool sk_hashed(const struct sock *sk)
  739. {
  740. return !sk_unhashed(sk);
  741. }
  742. static inline void sk_node_init(struct hlist_node *node)
  743. {
  744. node->pprev = NULL;
  745. }
  746. static inline void __sk_del_node(struct sock *sk)
  747. {
  748. __hlist_del(&sk->sk_node);
  749. }
  750. /* NB: equivalent to hlist_del_init_rcu */
  751. static inline bool __sk_del_node_init(struct sock *sk)
  752. {
  753. if (sk_hashed(sk)) {
  754. __sk_del_node(sk);
  755. sk_node_init(&sk->sk_node);
  756. return true;
  757. }
  758. return false;
  759. }
  760. /* Grab socket reference count. This operation is valid only
  761. when sk is ALREADY grabbed f.e. it is found in hash table
  762. or a list and the lookup is made under lock preventing hash table
  763. modifications.
  764. */
  765. static __always_inline void sock_hold(struct sock *sk)
  766. {
  767. refcount_inc(&sk->sk_refcnt);
  768. }
  769. /* Ungrab socket in the context, which assumes that socket refcnt
  770. cannot hit zero, f.e. it is true in context of any socketcall.
  771. */
  772. static __always_inline void __sock_put(struct sock *sk)
  773. {
  774. refcount_dec(&sk->sk_refcnt);
  775. }
  776. static inline bool sk_del_node_init(struct sock *sk)
  777. {
  778. bool rc = __sk_del_node_init(sk);
  779. if (rc)
  780. __sock_put(sk);
  781. return rc;
  782. }
  783. #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
  784. static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
  785. {
  786. if (sk_hashed(sk)) {
  787. hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
  788. return true;
  789. }
  790. return false;
  791. }
  792. static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
  793. {
  794. bool rc = __sk_nulls_del_node_init_rcu(sk);
  795. if (rc)
  796. __sock_put(sk);
  797. return rc;
  798. }
  799. static inline bool sk_nulls_replace_node_init_rcu(struct sock *old,
  800. struct sock *new)
  801. {
  802. if (sk_hashed(old)) {
  803. hlist_nulls_replace_init_rcu(&old->sk_nulls_node,
  804. &new->sk_nulls_node);
  805. __sock_put(old);
  806. return true;
  807. }
  808. return false;
  809. }
  810. static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
  811. {
  812. hlist_add_head(&sk->sk_node, list);
  813. }
  814. static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
  815. {
  816. sock_hold(sk);
  817. __sk_add_node(sk, list);
  818. }
  819. static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
  820. {
  821. sock_hold(sk);
  822. if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
  823. sk->sk_family == AF_INET6)
  824. hlist_add_tail_rcu(&sk->sk_node, list);
  825. else
  826. hlist_add_head_rcu(&sk->sk_node, list);
  827. }
  828. static inline void sk_add_node_tail_rcu(struct sock *sk, struct hlist_head *list)
  829. {
  830. sock_hold(sk);
  831. hlist_add_tail_rcu(&sk->sk_node, list);
  832. }
  833. static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  834. {
  835. hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
  836. }
  837. static inline void __sk_nulls_add_node_tail_rcu(struct sock *sk, struct hlist_nulls_head *list)
  838. {
  839. hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
  840. }
  841. static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  842. {
  843. sock_hold(sk);
  844. __sk_nulls_add_node_rcu(sk, list);
  845. }
  846. static inline void __sk_del_bind_node(struct sock *sk)
  847. {
  848. __hlist_del(&sk->sk_bind_node);
  849. }
  850. static inline void sk_add_bind_node(struct sock *sk,
  851. struct hlist_head *list)
  852. {
  853. hlist_add_head(&sk->sk_bind_node, list);
  854. }
  855. #define sk_for_each(__sk, list) \
  856. hlist_for_each_entry(__sk, list, sk_node)
  857. #define sk_for_each_rcu(__sk, list) \
  858. hlist_for_each_entry_rcu(__sk, list, sk_node)
  859. #define sk_nulls_for_each(__sk, node, list) \
  860. hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
  861. #define sk_nulls_for_each_rcu(__sk, node, list) \
  862. hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
  863. #define sk_for_each_from(__sk) \
  864. hlist_for_each_entry_from(__sk, sk_node)
  865. #define sk_nulls_for_each_from(__sk, node) \
  866. if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
  867. hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
  868. #define sk_for_each_safe(__sk, tmp, list) \
  869. hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
  870. #define sk_for_each_bound(__sk, list) \
  871. hlist_for_each_entry(__sk, list, sk_bind_node)
  872. #define sk_for_each_bound_safe(__sk, tmp, list) \
  873. hlist_for_each_entry_safe(__sk, tmp, list, sk_bind_node)
  874. /**
  875. * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
  876. * @tpos: the type * to use as a loop cursor.
  877. * @pos: the &struct hlist_node to use as a loop cursor.
  878. * @head: the head for your list.
  879. * @offset: offset of hlist_node within the struct.
  880. *
  881. */
  882. #define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
  883. for (pos = rcu_dereference(hlist_first_rcu(head)); \
  884. pos != NULL && \
  885. ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
  886. pos = rcu_dereference(hlist_next_rcu(pos)))
  887. static inline struct user_namespace *sk_user_ns(const struct sock *sk)
  888. {
  889. /* Careful only use this in a context where these parameters
  890. * can not change and must all be valid, such as recvmsg from
  891. * userspace.
  892. */
  893. return sk->sk_socket->file->f_cred->user_ns;
  894. }
  895. /* Sock flags */
  896. enum sock_flags {
  897. SOCK_DEAD,
  898. SOCK_DONE,
  899. SOCK_URGINLINE,
  900. SOCK_KEEPOPEN,
  901. SOCK_LINGER,
  902. SOCK_DESTROY,
  903. SOCK_BROADCAST,
  904. SOCK_TIMESTAMP,
  905. SOCK_ZAPPED,
  906. SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
  907. SOCK_DBG, /* %SO_DEBUG setting */
  908. SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
  909. SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
  910. SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
  911. SOCK_MEMALLOC, /* VM depends on this socket for swapping */
  912. SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
  913. SOCK_FASYNC, /* fasync() active */
  914. SOCK_RXQ_OVFL,
  915. SOCK_ZEROCOPY, /* buffers from userspace */
  916. SOCK_WIFI_STATUS, /* push wifi status to userspace */
  917. SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
  918. * Will use last 4 bytes of packet sent from
  919. * user-space instead.
  920. */
  921. SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
  922. SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
  923. SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
  924. SOCK_TXTIME,
  925. SOCK_XDP, /* XDP is attached */
  926. SOCK_TSTAMP_NEW, /* Indicates 64 bit timestamps always */
  927. SOCK_RCVMARK, /* Receive SO_MARK ancillary data with packet */
  928. SOCK_RCVPRIORITY, /* Receive SO_PRIORITY ancillary data with packet */
  929. SOCK_TIMESTAMPING_ANY, /* Copy of sk_tsflags & TSFLAGS_ANY */
  930. };
  931. #define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
  932. /*
  933. * The highest bit of sk_tsflags is reserved for kernel-internal
  934. * SOCKCM_FLAG_TS_OPT_ID. There is a check in core/sock.c to control that
  935. * SOF_TIMESTAMPING* values do not reach this reserved area
  936. */
  937. #define SOCKCM_FLAG_TS_OPT_ID BIT(31)
  938. static inline void sock_copy_flags(struct sock *nsk, const struct sock *osk)
  939. {
  940. nsk->sk_flags = osk->sk_flags;
  941. }
  942. static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
  943. {
  944. __set_bit(flag, &sk->sk_flags);
  945. }
  946. static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
  947. {
  948. __clear_bit(flag, &sk->sk_flags);
  949. }
  950. static inline void sock_valbool_flag(struct sock *sk, enum sock_flags bit,
  951. int valbool)
  952. {
  953. if (valbool)
  954. sock_set_flag(sk, bit);
  955. else
  956. sock_reset_flag(sk, bit);
  957. }
  958. static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
  959. {
  960. return test_bit(flag, &sk->sk_flags);
  961. }
  962. #ifdef CONFIG_NET
  963. DECLARE_STATIC_KEY_FALSE(memalloc_socks_key);
  964. static inline int sk_memalloc_socks(void)
  965. {
  966. return static_branch_unlikely(&memalloc_socks_key);
  967. }
  968. void __receive_sock(struct file *file);
  969. #else
  970. static inline int sk_memalloc_socks(void)
  971. {
  972. return 0;
  973. }
  974. static inline void __receive_sock(struct file *file)
  975. { }
  976. #endif
  977. static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
  978. {
  979. return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
  980. }
  981. static inline void sk_acceptq_removed(struct sock *sk)
  982. {
  983. WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog - 1);
  984. }
  985. static inline void sk_acceptq_added(struct sock *sk)
  986. {
  987. WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog + 1);
  988. }
  989. /* Note: If you think the test should be:
  990. * return READ_ONCE(sk->sk_ack_backlog) >= READ_ONCE(sk->sk_max_ack_backlog);
  991. * Then please take a look at commit 64a146513f8f ("[NET]: Revert incorrect accept queue backlog changes.")
  992. */
  993. static inline bool sk_acceptq_is_full(const struct sock *sk)
  994. {
  995. return READ_ONCE(sk->sk_ack_backlog) > READ_ONCE(sk->sk_max_ack_backlog);
  996. }
  997. /*
  998. * Compute minimal free write space needed to queue new packets.
  999. */
  1000. static inline int sk_stream_min_wspace(const struct sock *sk)
  1001. {
  1002. return READ_ONCE(sk->sk_wmem_queued) >> 1;
  1003. }
  1004. static inline int sk_stream_wspace(const struct sock *sk)
  1005. {
  1006. return READ_ONCE(sk->sk_sndbuf) - READ_ONCE(sk->sk_wmem_queued);
  1007. }
  1008. static inline void sk_wmem_queued_add(struct sock *sk, int val)
  1009. {
  1010. WRITE_ONCE(sk->sk_wmem_queued, sk->sk_wmem_queued + val);
  1011. }
  1012. static inline void sk_forward_alloc_add(struct sock *sk, int val)
  1013. {
  1014. /* Paired with lockless reads of sk->sk_forward_alloc */
  1015. WRITE_ONCE(sk->sk_forward_alloc, sk->sk_forward_alloc + val);
  1016. }
  1017. void sk_stream_write_space(struct sock *sk);
  1018. /* OOB backlog add */
  1019. static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
  1020. {
  1021. /* dont let skb dst not refcounted, we are going to leave rcu lock */
  1022. skb_dst_force(skb);
  1023. if (!sk->sk_backlog.tail)
  1024. WRITE_ONCE(sk->sk_backlog.head, skb);
  1025. else
  1026. sk->sk_backlog.tail->next = skb;
  1027. WRITE_ONCE(sk->sk_backlog.tail, skb);
  1028. skb->next = NULL;
  1029. }
  1030. /*
  1031. * Take into account size of receive queue and backlog queue
  1032. * Do not take into account this skb truesize,
  1033. * to allow even a single big packet to come.
  1034. */
  1035. static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
  1036. {
  1037. unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
  1038. return qsize > limit;
  1039. }
  1040. /* The per-socket spinlock must be held here. */
  1041. static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
  1042. unsigned int limit)
  1043. {
  1044. if (sk_rcvqueues_full(sk, limit))
  1045. return -ENOBUFS;
  1046. /*
  1047. * If the skb was allocated from pfmemalloc reserves, only
  1048. * allow SOCK_MEMALLOC sockets to use it as this socket is
  1049. * helping free memory
  1050. */
  1051. if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
  1052. return -ENOMEM;
  1053. __sk_add_backlog(sk, skb);
  1054. sk->sk_backlog.len += skb->truesize;
  1055. return 0;
  1056. }
  1057. int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
  1058. INDIRECT_CALLABLE_DECLARE(int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb));
  1059. INDIRECT_CALLABLE_DECLARE(int tcp_v6_do_rcv(struct sock *sk, struct sk_buff *skb));
  1060. static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
  1061. {
  1062. if (sk_memalloc_socks() && skb_pfmemalloc(skb))
  1063. return __sk_backlog_rcv(sk, skb);
  1064. return INDIRECT_CALL_INET(sk->sk_backlog_rcv,
  1065. tcp_v6_do_rcv,
  1066. tcp_v4_do_rcv,
  1067. sk, skb);
  1068. }
  1069. static inline void sk_incoming_cpu_update(struct sock *sk)
  1070. {
  1071. int cpu = raw_smp_processor_id();
  1072. if (unlikely(READ_ONCE(sk->sk_incoming_cpu) != cpu))
  1073. WRITE_ONCE(sk->sk_incoming_cpu, cpu);
  1074. }
  1075. static inline void sock_rps_save_rxhash(struct sock *sk,
  1076. const struct sk_buff *skb)
  1077. {
  1078. #ifdef CONFIG_RPS
  1079. /* The following WRITE_ONCE() is paired with the READ_ONCE()
  1080. * here, and another one in sock_rps_record_flow().
  1081. */
  1082. if (unlikely(READ_ONCE(sk->sk_rxhash) != skb->hash))
  1083. WRITE_ONCE(sk->sk_rxhash, skb->hash);
  1084. #endif
  1085. }
  1086. static inline void sock_rps_reset_rxhash(struct sock *sk)
  1087. {
  1088. #ifdef CONFIG_RPS
  1089. /* Paired with READ_ONCE() in sock_rps_record_flow() */
  1090. WRITE_ONCE(sk->sk_rxhash, 0);
  1091. #endif
  1092. }
  1093. #define sk_wait_event(__sk, __timeo, __condition, __wait) \
  1094. ({ int __rc, __dis = __sk->sk_disconnects; \
  1095. release_sock(__sk); \
  1096. __rc = __condition; \
  1097. if (!__rc) { \
  1098. *(__timeo) = wait_woken(__wait, \
  1099. TASK_INTERRUPTIBLE, \
  1100. *(__timeo)); \
  1101. } \
  1102. sched_annotate_sleep(); \
  1103. lock_sock(__sk); \
  1104. __rc = __dis == __sk->sk_disconnects ? __condition : -EPIPE; \
  1105. __rc; \
  1106. })
  1107. int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
  1108. int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
  1109. void sk_stream_wait_close(struct sock *sk, long timeo_p);
  1110. int sk_stream_error(struct sock *sk, int flags, int err);
  1111. void sk_stream_kill_queues(struct sock *sk);
  1112. void sk_set_memalloc(struct sock *sk);
  1113. void sk_clear_memalloc(struct sock *sk);
  1114. void __sk_flush_backlog(struct sock *sk);
  1115. static inline bool sk_flush_backlog(struct sock *sk)
  1116. {
  1117. if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
  1118. __sk_flush_backlog(sk);
  1119. return true;
  1120. }
  1121. return false;
  1122. }
  1123. int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
  1124. struct request_sock_ops;
  1125. struct timewait_sock_ops;
  1126. struct inet_hashinfo;
  1127. struct raw_hashinfo;
  1128. struct smc_hashinfo;
  1129. struct module;
  1130. struct sk_psock;
  1131. /*
  1132. * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
  1133. * un-modified. Special care is taken when initializing object to zero.
  1134. */
  1135. static inline void sk_prot_clear_nulls(struct sock *sk, int size)
  1136. {
  1137. if (offsetof(struct sock, sk_node.next) != 0)
  1138. memset(sk, 0, offsetof(struct sock, sk_node.next));
  1139. memset(&sk->sk_node.pprev, 0,
  1140. size - offsetof(struct sock, sk_node.pprev));
  1141. }
  1142. struct proto_accept_arg {
  1143. int flags;
  1144. int err;
  1145. int is_empty;
  1146. bool kern;
  1147. };
  1148. /* Networking protocol blocks we attach to sockets.
  1149. * socket layer -> transport layer interface
  1150. */
  1151. struct proto {
  1152. void (*close)(struct sock *sk,
  1153. long timeout);
  1154. int (*pre_connect)(struct sock *sk,
  1155. struct sockaddr_unsized *uaddr,
  1156. int addr_len);
  1157. int (*connect)(struct sock *sk,
  1158. struct sockaddr_unsized *uaddr,
  1159. int addr_len);
  1160. int (*disconnect)(struct sock *sk, int flags);
  1161. struct sock * (*accept)(struct sock *sk,
  1162. struct proto_accept_arg *arg);
  1163. int (*ioctl)(struct sock *sk, int cmd,
  1164. int *karg);
  1165. int (*init)(struct sock *sk);
  1166. void (*destroy)(struct sock *sk);
  1167. void (*shutdown)(struct sock *sk, int how);
  1168. int (*setsockopt)(struct sock *sk, int level,
  1169. int optname, sockptr_t optval,
  1170. unsigned int optlen);
  1171. int (*getsockopt)(struct sock *sk, int level,
  1172. int optname, char __user *optval,
  1173. int __user *option);
  1174. void (*keepalive)(struct sock *sk, int valbool);
  1175. #ifdef CONFIG_COMPAT
  1176. int (*compat_ioctl)(struct sock *sk,
  1177. unsigned int cmd, unsigned long arg);
  1178. #endif
  1179. int (*sendmsg)(struct sock *sk, struct msghdr *msg,
  1180. size_t len);
  1181. int (*recvmsg)(struct sock *sk, struct msghdr *msg,
  1182. size_t len, int flags, int *addr_len);
  1183. void (*splice_eof)(struct socket *sock);
  1184. int (*bind)(struct sock *sk,
  1185. struct sockaddr_unsized *addr, int addr_len);
  1186. int (*bind_add)(struct sock *sk,
  1187. struct sockaddr_unsized *addr, int addr_len);
  1188. int (*backlog_rcv) (struct sock *sk,
  1189. struct sk_buff *skb);
  1190. bool (*bpf_bypass_getsockopt)(int level,
  1191. int optname);
  1192. void (*release_cb)(struct sock *sk);
  1193. /* Keeping track of sk's, looking them up, and port selection methods. */
  1194. int (*hash)(struct sock *sk);
  1195. void (*unhash)(struct sock *sk);
  1196. void (*rehash)(struct sock *sk);
  1197. int (*get_port)(struct sock *sk, unsigned short snum);
  1198. void (*put_port)(struct sock *sk);
  1199. #ifdef CONFIG_BPF_SYSCALL
  1200. int (*psock_update_sk_prot)(struct sock *sk,
  1201. struct sk_psock *psock,
  1202. bool restore);
  1203. #endif
  1204. /* Keeping track of sockets in use */
  1205. #ifdef CONFIG_PROC_FS
  1206. unsigned int inuse_idx;
  1207. #endif
  1208. bool (*stream_memory_free)(const struct sock *sk, int wake);
  1209. bool (*sock_is_readable)(struct sock *sk);
  1210. /* Memory pressure */
  1211. void (*enter_memory_pressure)(struct sock *sk);
  1212. void (*leave_memory_pressure)(struct sock *sk);
  1213. atomic_long_t *memory_allocated; /* Current allocated memory. */
  1214. int __percpu *per_cpu_fw_alloc;
  1215. struct percpu_counter *sockets_allocated; /* Current number of sockets. */
  1216. /*
  1217. * Pressure flag: try to collapse.
  1218. * Technical note: it is used by multiple contexts non atomically.
  1219. * Make sure to use READ_ONCE()/WRITE_ONCE() for all reads/writes.
  1220. * All the __sk_mem_schedule() is of this nature: accounting
  1221. * is strict, actions are advisory and have some latency.
  1222. */
  1223. unsigned long *memory_pressure;
  1224. long *sysctl_mem;
  1225. int *sysctl_wmem;
  1226. int *sysctl_rmem;
  1227. u32 sysctl_wmem_offset;
  1228. u32 sysctl_rmem_offset;
  1229. int max_header;
  1230. bool no_autobind;
  1231. struct kmem_cache *slab;
  1232. unsigned int obj_size;
  1233. unsigned int freeptr_offset;
  1234. unsigned int ipv6_pinfo_offset;
  1235. slab_flags_t slab_flags;
  1236. unsigned int useroffset; /* Usercopy region offset */
  1237. unsigned int usersize; /* Usercopy region size */
  1238. struct request_sock_ops *rsk_prot;
  1239. struct timewait_sock_ops *twsk_prot;
  1240. union {
  1241. struct inet_hashinfo *hashinfo;
  1242. struct udp_table *udp_table;
  1243. struct raw_hashinfo *raw_hash;
  1244. struct smc_hashinfo *smc_hash;
  1245. } h;
  1246. struct module *owner;
  1247. char name[32];
  1248. struct list_head node;
  1249. int (*diag_destroy)(struct sock *sk, int err);
  1250. } __randomize_layout;
  1251. int proto_register(struct proto *prot, int alloc_slab);
  1252. void proto_unregister(struct proto *prot);
  1253. int sock_load_diag_module(int family, int protocol);
  1254. INDIRECT_CALLABLE_DECLARE(bool tcp_stream_memory_free(const struct sock *sk, int wake));
  1255. static inline bool __sk_stream_memory_free(const struct sock *sk, int wake)
  1256. {
  1257. if (READ_ONCE(sk->sk_wmem_queued) >= READ_ONCE(sk->sk_sndbuf))
  1258. return false;
  1259. return sk->sk_prot->stream_memory_free ?
  1260. INDIRECT_CALL_INET_1(sk->sk_prot->stream_memory_free,
  1261. tcp_stream_memory_free, sk, wake) : true;
  1262. }
  1263. static inline bool sk_stream_memory_free(const struct sock *sk)
  1264. {
  1265. return __sk_stream_memory_free(sk, 0);
  1266. }
  1267. static inline bool __sk_stream_is_writeable(const struct sock *sk, int wake)
  1268. {
  1269. return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
  1270. __sk_stream_memory_free(sk, wake);
  1271. }
  1272. static inline bool sk_stream_is_writeable(const struct sock *sk)
  1273. {
  1274. return __sk_stream_is_writeable(sk, 0);
  1275. }
  1276. static inline int sk_under_cgroup_hierarchy(struct sock *sk,
  1277. struct cgroup *ancestor)
  1278. {
  1279. #ifdef CONFIG_SOCK_CGROUP_DATA
  1280. return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
  1281. ancestor);
  1282. #else
  1283. return -ENOTSUPP;
  1284. #endif
  1285. }
  1286. #define SK_ALLOC_PERCPU_COUNTER_BATCH 16
  1287. static inline void sk_sockets_allocated_dec(struct sock *sk)
  1288. {
  1289. percpu_counter_add_batch(sk->sk_prot->sockets_allocated, -1,
  1290. SK_ALLOC_PERCPU_COUNTER_BATCH);
  1291. }
  1292. static inline void sk_sockets_allocated_inc(struct sock *sk)
  1293. {
  1294. percpu_counter_add_batch(sk->sk_prot->sockets_allocated, 1,
  1295. SK_ALLOC_PERCPU_COUNTER_BATCH);
  1296. }
  1297. static inline u64
  1298. sk_sockets_allocated_read_positive(struct sock *sk)
  1299. {
  1300. return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
  1301. }
  1302. static inline int
  1303. proto_sockets_allocated_sum_positive(struct proto *prot)
  1304. {
  1305. return percpu_counter_sum_positive(prot->sockets_allocated);
  1306. }
  1307. #ifdef CONFIG_PROC_FS
  1308. #define PROTO_INUSE_NR 64 /* should be enough for the first time */
  1309. struct prot_inuse {
  1310. int all;
  1311. int val[PROTO_INUSE_NR];
  1312. };
  1313. static inline void sock_prot_inuse_add(const struct net *net,
  1314. const struct proto *prot, int val)
  1315. {
  1316. this_cpu_add(net->core.prot_inuse->val[prot->inuse_idx], val);
  1317. }
  1318. static inline void sock_inuse_add(const struct net *net, int val)
  1319. {
  1320. this_cpu_add(net->core.prot_inuse->all, val);
  1321. }
  1322. int sock_prot_inuse_get(struct net *net, struct proto *proto);
  1323. int sock_inuse_get(struct net *net);
  1324. #else
  1325. static inline void sock_prot_inuse_add(const struct net *net,
  1326. const struct proto *prot, int val)
  1327. {
  1328. }
  1329. static inline void sock_inuse_add(const struct net *net, int val)
  1330. {
  1331. }
  1332. #endif
  1333. /* With per-bucket locks this operation is not-atomic, so that
  1334. * this version is not worse.
  1335. */
  1336. static inline int __sk_prot_rehash(struct sock *sk)
  1337. {
  1338. sk->sk_prot->unhash(sk);
  1339. return sk->sk_prot->hash(sk);
  1340. }
  1341. /* About 10 seconds */
  1342. #define SOCK_DESTROY_TIME (10*HZ)
  1343. /* Sockets 0-1023 can't be bound to unless you are superuser */
  1344. #define PROT_SOCK 1024
  1345. #define SHUTDOWN_MASK 3
  1346. #define RCV_SHUTDOWN 1
  1347. #define SEND_SHUTDOWN 2
  1348. #define SOCK_BINDADDR_LOCK 4
  1349. #define SOCK_BINDPORT_LOCK 8
  1350. /**
  1351. * define SOCK_CONNECT_BIND - &sock->sk_userlocks flag for auto-bind at connect() time
  1352. */
  1353. #define SOCK_CONNECT_BIND 16
  1354. struct socket_alloc {
  1355. struct socket socket;
  1356. struct inode vfs_inode;
  1357. };
  1358. static inline struct socket *SOCKET_I(struct inode *inode)
  1359. {
  1360. return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
  1361. }
  1362. static inline struct inode *SOCK_INODE(struct socket *socket)
  1363. {
  1364. return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
  1365. }
  1366. /*
  1367. * Functions for memory accounting
  1368. */
  1369. int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
  1370. int __sk_mem_schedule(struct sock *sk, int size, int kind);
  1371. void __sk_mem_reduce_allocated(struct sock *sk, int amount);
  1372. void __sk_mem_reclaim(struct sock *sk, int amount);
  1373. #define SK_MEM_SEND 0
  1374. #define SK_MEM_RECV 1
  1375. /* sysctl_mem values are in pages */
  1376. static inline long sk_prot_mem_limits(const struct sock *sk, int index)
  1377. {
  1378. return READ_ONCE(sk->sk_prot->sysctl_mem[index]);
  1379. }
  1380. static inline int sk_mem_pages(int amt)
  1381. {
  1382. return (amt + PAGE_SIZE - 1) >> PAGE_SHIFT;
  1383. }
  1384. static inline bool sk_has_account(struct sock *sk)
  1385. {
  1386. /* return true if protocol supports memory accounting */
  1387. return !!sk->sk_prot->memory_allocated;
  1388. }
  1389. static inline bool sk_wmem_schedule(struct sock *sk, int size)
  1390. {
  1391. int delta;
  1392. if (!sk_has_account(sk))
  1393. return true;
  1394. delta = size - sk->sk_forward_alloc;
  1395. return delta <= 0 || __sk_mem_schedule(sk, delta, SK_MEM_SEND);
  1396. }
  1397. static inline bool
  1398. __sk_rmem_schedule(struct sock *sk, int size, bool pfmemalloc)
  1399. {
  1400. int delta;
  1401. if (!sk_has_account(sk))
  1402. return true;
  1403. delta = size - sk->sk_forward_alloc;
  1404. return delta <= 0 || __sk_mem_schedule(sk, delta, SK_MEM_RECV) ||
  1405. pfmemalloc;
  1406. }
  1407. static inline bool
  1408. sk_rmem_schedule(struct sock *sk, const struct sk_buff *skb, int size)
  1409. {
  1410. return __sk_rmem_schedule(sk, size, skb_pfmemalloc(skb));
  1411. }
  1412. static inline int sk_unused_reserved_mem(const struct sock *sk)
  1413. {
  1414. int unused_mem;
  1415. if (likely(!sk->sk_reserved_mem))
  1416. return 0;
  1417. unused_mem = sk->sk_reserved_mem - sk->sk_wmem_queued -
  1418. atomic_read(&sk->sk_rmem_alloc);
  1419. return unused_mem > 0 ? unused_mem : 0;
  1420. }
  1421. static inline void sk_mem_reclaim(struct sock *sk)
  1422. {
  1423. int reclaimable;
  1424. if (!sk_has_account(sk))
  1425. return;
  1426. reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
  1427. if (reclaimable >= (int)PAGE_SIZE)
  1428. __sk_mem_reclaim(sk, reclaimable);
  1429. }
  1430. static inline void sk_mem_reclaim_final(struct sock *sk)
  1431. {
  1432. sk->sk_reserved_mem = 0;
  1433. sk_mem_reclaim(sk);
  1434. }
  1435. static inline void sk_mem_charge(struct sock *sk, int size)
  1436. {
  1437. if (!sk_has_account(sk))
  1438. return;
  1439. sk_forward_alloc_add(sk, -size);
  1440. }
  1441. static inline void sk_mem_uncharge(struct sock *sk, int size)
  1442. {
  1443. if (!sk_has_account(sk))
  1444. return;
  1445. sk_forward_alloc_add(sk, size);
  1446. sk_mem_reclaim(sk);
  1447. }
  1448. void __sk_charge(struct sock *sk, gfp_t gfp);
  1449. #if IS_ENABLED(CONFIG_PROVE_LOCKING) && IS_ENABLED(CONFIG_MODULES)
  1450. static inline void sk_owner_set(struct sock *sk, struct module *owner)
  1451. {
  1452. __module_get(owner);
  1453. sk->sk_owner = owner;
  1454. }
  1455. static inline void sk_owner_clear(struct sock *sk)
  1456. {
  1457. sk->sk_owner = NULL;
  1458. }
  1459. static inline void sk_owner_put(struct sock *sk)
  1460. {
  1461. module_put(sk->sk_owner);
  1462. }
  1463. #else
  1464. static inline void sk_owner_set(struct sock *sk, struct module *owner)
  1465. {
  1466. }
  1467. static inline void sk_owner_clear(struct sock *sk)
  1468. {
  1469. }
  1470. static inline void sk_owner_put(struct sock *sk)
  1471. {
  1472. }
  1473. #endif
  1474. /*
  1475. * Macro so as to not evaluate some arguments when
  1476. * lockdep is not enabled.
  1477. *
  1478. * Mark both the sk_lock and the sk_lock.slock as a
  1479. * per-address-family lock class.
  1480. */
  1481. #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
  1482. do { \
  1483. sk_owner_set(sk, THIS_MODULE); \
  1484. sk->sk_lock.owned = 0; \
  1485. init_waitqueue_head(&sk->sk_lock.wq); \
  1486. spin_lock_init(&(sk)->sk_lock.slock); \
  1487. debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
  1488. sizeof((sk)->sk_lock)); \
  1489. lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
  1490. (skey), (sname)); \
  1491. lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
  1492. } while (0)
  1493. static inline bool lockdep_sock_is_held(const struct sock *sk)
  1494. {
  1495. return lockdep_is_held(&sk->sk_lock) ||
  1496. lockdep_is_held(&sk->sk_lock.slock);
  1497. }
  1498. void lock_sock_nested(struct sock *sk, int subclass);
  1499. static inline void lock_sock(struct sock *sk)
  1500. {
  1501. lock_sock_nested(sk, 0);
  1502. }
  1503. void __lock_sock(struct sock *sk);
  1504. void __release_sock(struct sock *sk);
  1505. void release_sock(struct sock *sk);
  1506. /* BH context may only use the following locking interface. */
  1507. #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
  1508. #define bh_lock_sock_nested(__sk) \
  1509. spin_lock_nested(&((__sk)->sk_lock.slock), \
  1510. SINGLE_DEPTH_NESTING)
  1511. #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
  1512. bool __lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock);
  1513. /**
  1514. * lock_sock_fast - fast version of lock_sock
  1515. * @sk: socket
  1516. *
  1517. * This version should be used for very small section, where process won't block
  1518. * return false if fast path is taken:
  1519. *
  1520. * sk_lock.slock locked, owned = 0, BH disabled
  1521. *
  1522. * return true if slow path is taken:
  1523. *
  1524. * sk_lock.slock unlocked, owned = 1, BH enabled
  1525. */
  1526. static inline bool lock_sock_fast(struct sock *sk)
  1527. {
  1528. /* The sk_lock has mutex_lock() semantics here. */
  1529. mutex_acquire(&sk->sk_lock.dep_map, 0, 0, _RET_IP_);
  1530. return __lock_sock_fast(sk);
  1531. }
  1532. /* fast socket lock variant for caller already holding a [different] socket lock */
  1533. static inline bool lock_sock_fast_nested(struct sock *sk)
  1534. {
  1535. mutex_acquire(&sk->sk_lock.dep_map, SINGLE_DEPTH_NESTING, 0, _RET_IP_);
  1536. return __lock_sock_fast(sk);
  1537. }
  1538. /**
  1539. * unlock_sock_fast - complement of lock_sock_fast
  1540. * @sk: socket
  1541. * @slow: slow mode
  1542. *
  1543. * fast unlock socket for user context.
  1544. * If slow mode is on, we call regular release_sock()
  1545. */
  1546. static inline void unlock_sock_fast(struct sock *sk, bool slow)
  1547. __releases(&sk->sk_lock.slock)
  1548. {
  1549. if (slow) {
  1550. release_sock(sk);
  1551. __release(&sk->sk_lock.slock);
  1552. } else {
  1553. mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
  1554. spin_unlock_bh(&sk->sk_lock.slock);
  1555. }
  1556. }
  1557. void sockopt_lock_sock(struct sock *sk);
  1558. void sockopt_release_sock(struct sock *sk);
  1559. bool sockopt_ns_capable(struct user_namespace *ns, int cap);
  1560. bool sockopt_capable(int cap);
  1561. /* Used by processes to "lock" a socket state, so that
  1562. * interrupts and bottom half handlers won't change it
  1563. * from under us. It essentially blocks any incoming
  1564. * packets, so that we won't get any new data or any
  1565. * packets that change the state of the socket.
  1566. *
  1567. * While locked, BH processing will add new packets to
  1568. * the backlog queue. This queue is processed by the
  1569. * owner of the socket lock right before it is released.
  1570. *
  1571. * Since ~2.3.5 it is also exclusive sleep lock serializing
  1572. * accesses from user process context.
  1573. */
  1574. static inline void sock_owned_by_me(const struct sock *sk)
  1575. {
  1576. #ifdef CONFIG_LOCKDEP
  1577. WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
  1578. #endif
  1579. }
  1580. static inline void sock_not_owned_by_me(const struct sock *sk)
  1581. {
  1582. #ifdef CONFIG_LOCKDEP
  1583. WARN_ON_ONCE(lockdep_sock_is_held(sk) && debug_locks);
  1584. #endif
  1585. }
  1586. static inline bool sock_owned_by_user(const struct sock *sk)
  1587. {
  1588. sock_owned_by_me(sk);
  1589. return sk->sk_lock.owned;
  1590. }
  1591. static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
  1592. {
  1593. return sk->sk_lock.owned;
  1594. }
  1595. static inline void sock_release_ownership(struct sock *sk)
  1596. {
  1597. DEBUG_NET_WARN_ON_ONCE(!sock_owned_by_user_nocheck(sk));
  1598. sk->sk_lock.owned = 0;
  1599. /* The sk_lock has mutex_unlock() semantics: */
  1600. mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
  1601. }
  1602. /* no reclassification while locks are held */
  1603. static inline bool sock_allow_reclassification(const struct sock *csk)
  1604. {
  1605. struct sock *sk = (struct sock *)csk;
  1606. return !sock_owned_by_user_nocheck(sk) &&
  1607. !spin_is_locked(&sk->sk_lock.slock);
  1608. }
  1609. struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
  1610. struct proto *prot, int kern);
  1611. void sk_free(struct sock *sk);
  1612. void sk_net_refcnt_upgrade(struct sock *sk);
  1613. void sk_destruct(struct sock *sk);
  1614. struct sock *sk_clone(const struct sock *sk, const gfp_t priority, bool lock);
  1615. static inline struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority)
  1616. {
  1617. return sk_clone(sk, priority, true);
  1618. }
  1619. struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
  1620. gfp_t priority);
  1621. void __sock_wfree(struct sk_buff *skb);
  1622. void sock_wfree(struct sk_buff *skb);
  1623. struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
  1624. gfp_t priority);
  1625. void skb_orphan_partial(struct sk_buff *skb);
  1626. void sock_rfree(struct sk_buff *skb);
  1627. void sock_efree(struct sk_buff *skb);
  1628. #ifdef CONFIG_INET
  1629. void sock_edemux(struct sk_buff *skb);
  1630. void sock_pfree(struct sk_buff *skb);
  1631. static inline void skb_set_owner_edemux(struct sk_buff *skb, struct sock *sk)
  1632. {
  1633. skb_orphan(skb);
  1634. if (refcount_inc_not_zero(&sk->sk_refcnt)) {
  1635. skb->sk = sk;
  1636. skb->destructor = sock_edemux;
  1637. }
  1638. }
  1639. #else
  1640. #define sock_edemux sock_efree
  1641. #endif
  1642. int sk_setsockopt(struct sock *sk, int level, int optname,
  1643. sockptr_t optval, unsigned int optlen);
  1644. int sock_setsockopt(struct socket *sock, int level, int op,
  1645. sockptr_t optval, unsigned int optlen);
  1646. int do_sock_setsockopt(struct socket *sock, bool compat, int level,
  1647. int optname, sockptr_t optval, int optlen);
  1648. int do_sock_getsockopt(struct socket *sock, bool compat, int level,
  1649. int optname, sockptr_t optval, sockptr_t optlen);
  1650. int sk_getsockopt(struct sock *sk, int level, int optname,
  1651. sockptr_t optval, sockptr_t optlen);
  1652. int sock_gettstamp(struct socket *sock, void __user *userstamp,
  1653. bool timeval, bool time32);
  1654. struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
  1655. unsigned long data_len, int noblock,
  1656. int *errcode, int max_page_order);
  1657. static inline struct sk_buff *sock_alloc_send_skb(struct sock *sk,
  1658. unsigned long size,
  1659. int noblock, int *errcode)
  1660. {
  1661. return sock_alloc_send_pskb(sk, size, 0, noblock, errcode, 0);
  1662. }
  1663. void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
  1664. void *sock_kmemdup(struct sock *sk, const void *src,
  1665. int size, gfp_t priority);
  1666. void sock_kfree_s(struct sock *sk, void *mem, int size);
  1667. void sock_kzfree_s(struct sock *sk, void *mem, int size);
  1668. void sk_send_sigurg(struct sock *sk);
  1669. static inline void sock_replace_proto(struct sock *sk, struct proto *proto)
  1670. {
  1671. if (sk->sk_socket)
  1672. clear_bit(SOCK_SUPPORT_ZC, &sk->sk_socket->flags);
  1673. WRITE_ONCE(sk->sk_prot, proto);
  1674. }
  1675. struct sockcm_cookie {
  1676. u64 transmit_time;
  1677. u32 mark;
  1678. u32 tsflags;
  1679. u32 ts_opt_id;
  1680. u32 priority;
  1681. u32 dmabuf_id;
  1682. };
  1683. static inline void sockcm_init(struct sockcm_cookie *sockc,
  1684. const struct sock *sk)
  1685. {
  1686. *sockc = (struct sockcm_cookie) {
  1687. .mark = READ_ONCE(sk->sk_mark),
  1688. .tsflags = READ_ONCE(sk->sk_tsflags),
  1689. .priority = READ_ONCE(sk->sk_priority),
  1690. };
  1691. }
  1692. int __sock_cmsg_send(struct sock *sk, struct cmsghdr *cmsg,
  1693. struct sockcm_cookie *sockc);
  1694. int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
  1695. struct sockcm_cookie *sockc);
  1696. /*
  1697. * Functions to fill in entries in struct proto_ops when a protocol
  1698. * does not implement a particular function.
  1699. */
  1700. int sock_no_bind(struct socket *sock, struct sockaddr_unsized *saddr, int len);
  1701. int sock_no_connect(struct socket *sock, struct sockaddr_unsized *saddr, int len, int flags);
  1702. int sock_no_socketpair(struct socket *, struct socket *);
  1703. int sock_no_accept(struct socket *, struct socket *, struct proto_accept_arg *);
  1704. int sock_no_getname(struct socket *, struct sockaddr *, int);
  1705. int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
  1706. int sock_no_listen(struct socket *, int);
  1707. int sock_no_shutdown(struct socket *, int);
  1708. int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
  1709. int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
  1710. int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
  1711. int sock_no_mmap(struct file *file, struct socket *sock,
  1712. struct vm_area_struct *vma);
  1713. /*
  1714. * Functions to fill in entries in struct proto_ops when a protocol
  1715. * uses the inet style.
  1716. */
  1717. int sock_common_getsockopt(struct socket *sock, int level, int optname,
  1718. char __user *optval, int __user *optlen);
  1719. int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
  1720. int flags);
  1721. int sock_common_setsockopt(struct socket *sock, int level, int optname,
  1722. sockptr_t optval, unsigned int optlen);
  1723. void sk_common_release(struct sock *sk);
  1724. /*
  1725. * Default socket callbacks and setup code
  1726. */
  1727. /* Initialise core socket variables using an explicit uid. */
  1728. void sock_init_data_uid(struct socket *sock, struct sock *sk, kuid_t uid);
  1729. /* Initialise core socket variables.
  1730. * Assumes struct socket *sock is embedded in a struct socket_alloc.
  1731. */
  1732. void sock_init_data(struct socket *sock, struct sock *sk);
  1733. /*
  1734. * Socket reference counting postulates.
  1735. *
  1736. * * Each user of socket SHOULD hold a reference count.
  1737. * * Each access point to socket (an hash table bucket, reference from a list,
  1738. * running timer, skb in flight MUST hold a reference count.
  1739. * * When reference count hits 0, it means it will never increase back.
  1740. * * When reference count hits 0, it means that no references from
  1741. * outside exist to this socket and current process on current CPU
  1742. * is last user and may/should destroy this socket.
  1743. * * sk_free is called from any context: process, BH, IRQ. When
  1744. * it is called, socket has no references from outside -> sk_free
  1745. * may release descendant resources allocated by the socket, but
  1746. * to the time when it is called, socket is NOT referenced by any
  1747. * hash tables, lists etc.
  1748. * * Packets, delivered from outside (from network or from another process)
  1749. * and enqueued on receive/error queues SHOULD NOT grab reference count,
  1750. * when they sit in queue. Otherwise, packets will leak to hole, when
  1751. * socket is looked up by one cpu and unhasing is made by another CPU.
  1752. * It is true for udp/raw, netlink (leak to receive and error queues), tcp
  1753. * (leak to backlog). Packet socket does all the processing inside
  1754. * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
  1755. * use separate SMP lock, so that they are prone too.
  1756. */
  1757. /* Ungrab socket and destroy it, if it was the last reference. */
  1758. static inline void sock_put(struct sock *sk)
  1759. {
  1760. if (refcount_dec_and_test(&sk->sk_refcnt))
  1761. sk_free(sk);
  1762. }
  1763. /* Generic version of sock_put(), dealing with all sockets
  1764. * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
  1765. */
  1766. void sock_gen_put(struct sock *sk);
  1767. int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
  1768. unsigned int trim_cap, bool refcounted);
  1769. static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
  1770. const int nested)
  1771. {
  1772. return __sk_receive_skb(sk, skb, nested, 1, true);
  1773. }
  1774. static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
  1775. {
  1776. /* sk_tx_queue_mapping accept only upto a 16-bit value */
  1777. if (WARN_ON_ONCE((unsigned short)tx_queue >= USHRT_MAX))
  1778. return;
  1779. /* Paired with READ_ONCE() in sk_tx_queue_get() and
  1780. * other WRITE_ONCE() because socket lock might be not held.
  1781. */
  1782. if (READ_ONCE(sk->sk_tx_queue_mapping) != tx_queue) {
  1783. WRITE_ONCE(sk->sk_tx_queue_mapping, tx_queue);
  1784. WRITE_ONCE(sk->sk_tx_queue_mapping_jiffies, jiffies);
  1785. return;
  1786. }
  1787. /* Refresh sk_tx_queue_mapping_jiffies if too old. */
  1788. if (time_is_before_jiffies(READ_ONCE(sk->sk_tx_queue_mapping_jiffies) + HZ))
  1789. WRITE_ONCE(sk->sk_tx_queue_mapping_jiffies, jiffies);
  1790. }
  1791. #define NO_QUEUE_MAPPING USHRT_MAX
  1792. static inline void sk_tx_queue_clear(struct sock *sk)
  1793. {
  1794. /* Paired with READ_ONCE() in sk_tx_queue_get() and
  1795. * other WRITE_ONCE() because socket lock might be not held.
  1796. */
  1797. WRITE_ONCE(sk->sk_tx_queue_mapping, NO_QUEUE_MAPPING);
  1798. }
  1799. int sk_tx_queue_get(const struct sock *sk);
  1800. static inline void __sk_rx_queue_set(struct sock *sk,
  1801. const struct sk_buff *skb,
  1802. bool force_set)
  1803. {
  1804. #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
  1805. if (skb_rx_queue_recorded(skb)) {
  1806. u16 rx_queue = skb_get_rx_queue(skb);
  1807. if (force_set ||
  1808. unlikely(READ_ONCE(sk->sk_rx_queue_mapping) != rx_queue))
  1809. WRITE_ONCE(sk->sk_rx_queue_mapping, rx_queue);
  1810. }
  1811. #endif
  1812. }
  1813. static inline void sk_rx_queue_set(struct sock *sk, const struct sk_buff *skb)
  1814. {
  1815. __sk_rx_queue_set(sk, skb, true);
  1816. }
  1817. static inline void sk_rx_queue_update(struct sock *sk, const struct sk_buff *skb)
  1818. {
  1819. __sk_rx_queue_set(sk, skb, false);
  1820. }
  1821. static inline void sk_rx_queue_clear(struct sock *sk)
  1822. {
  1823. #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
  1824. WRITE_ONCE(sk->sk_rx_queue_mapping, NO_QUEUE_MAPPING);
  1825. #endif
  1826. }
  1827. static inline int sk_rx_queue_get(const struct sock *sk)
  1828. {
  1829. #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
  1830. if (sk) {
  1831. int res = READ_ONCE(sk->sk_rx_queue_mapping);
  1832. if (res != NO_QUEUE_MAPPING)
  1833. return res;
  1834. }
  1835. #endif
  1836. return -1;
  1837. }
  1838. static inline void sk_set_socket(struct sock *sk, struct socket *sock)
  1839. {
  1840. WRITE_ONCE(sk->sk_socket, sock);
  1841. if (sock) {
  1842. WRITE_ONCE(sk->sk_uid, SOCK_INODE(sock)->i_uid);
  1843. WRITE_ONCE(sk->sk_ino, SOCK_INODE(sock)->i_ino);
  1844. } else {
  1845. /* Note: sk_uid is unchanged. */
  1846. WRITE_ONCE(sk->sk_ino, 0);
  1847. }
  1848. }
  1849. static inline wait_queue_head_t *sk_sleep(struct sock *sk)
  1850. {
  1851. BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
  1852. return &rcu_dereference_raw(sk->sk_wq)->wait;
  1853. }
  1854. /* Detach socket from process context.
  1855. * Announce socket dead, detach it from wait queue and inode.
  1856. * Note that parent inode held reference count on this struct sock,
  1857. * we do not release it in this function, because protocol
  1858. * probably wants some additional cleanups or even continuing
  1859. * to work with this socket (TCP).
  1860. */
  1861. static inline void sock_orphan(struct sock *sk)
  1862. {
  1863. write_lock_bh(&sk->sk_callback_lock);
  1864. sock_set_flag(sk, SOCK_DEAD);
  1865. sk_set_socket(sk, NULL);
  1866. sk->sk_wq = NULL;
  1867. write_unlock_bh(&sk->sk_callback_lock);
  1868. }
  1869. static inline void sock_graft(struct sock *sk, struct socket *parent)
  1870. {
  1871. WARN_ON(parent->sk);
  1872. write_lock_bh(&sk->sk_callback_lock);
  1873. rcu_assign_pointer(sk->sk_wq, &parent->wq);
  1874. parent->sk = sk;
  1875. sk_set_socket(sk, parent);
  1876. security_sock_graft(sk, parent);
  1877. write_unlock_bh(&sk->sk_callback_lock);
  1878. }
  1879. static inline unsigned long sock_i_ino(const struct sock *sk)
  1880. {
  1881. /* Paired with WRITE_ONCE() in sock_graft() and sock_orphan() */
  1882. return READ_ONCE(sk->sk_ino);
  1883. }
  1884. static inline kuid_t sk_uid(const struct sock *sk)
  1885. {
  1886. /* Paired with WRITE_ONCE() in sockfs_setattr() */
  1887. return READ_ONCE(sk->sk_uid);
  1888. }
  1889. static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
  1890. {
  1891. return sk ? sk_uid(sk) : make_kuid(net->user_ns, 0);
  1892. }
  1893. static inline u32 net_tx_rndhash(void)
  1894. {
  1895. u32 v = get_random_u32();
  1896. return v ?: 1;
  1897. }
  1898. static inline void sk_set_txhash(struct sock *sk)
  1899. {
  1900. /* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
  1901. WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
  1902. }
  1903. static inline bool sk_rethink_txhash(struct sock *sk)
  1904. {
  1905. if (sk->sk_txhash && sk->sk_txrehash == SOCK_TXREHASH_ENABLED) {
  1906. sk_set_txhash(sk);
  1907. return true;
  1908. }
  1909. return false;
  1910. }
  1911. static inline struct dst_entry *
  1912. __sk_dst_get(const struct sock *sk)
  1913. {
  1914. return rcu_dereference_check(sk->sk_dst_cache,
  1915. lockdep_sock_is_held(sk));
  1916. }
  1917. static inline struct dst_entry *
  1918. sk_dst_get(const struct sock *sk)
  1919. {
  1920. struct dst_entry *dst;
  1921. rcu_read_lock();
  1922. dst = rcu_dereference(sk->sk_dst_cache);
  1923. if (dst && !rcuref_get(&dst->__rcuref))
  1924. dst = NULL;
  1925. rcu_read_unlock();
  1926. return dst;
  1927. }
  1928. static inline void __dst_negative_advice(struct sock *sk)
  1929. {
  1930. struct dst_entry *dst = __sk_dst_get(sk);
  1931. if (dst && dst->ops->negative_advice)
  1932. dst->ops->negative_advice(sk, dst);
  1933. }
  1934. static inline void dst_negative_advice(struct sock *sk)
  1935. {
  1936. sk_rethink_txhash(sk);
  1937. __dst_negative_advice(sk);
  1938. }
  1939. static inline void
  1940. __sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1941. {
  1942. struct dst_entry *old_dst;
  1943. sk_tx_queue_clear(sk);
  1944. WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
  1945. old_dst = rcu_dereference_protected(sk->sk_dst_cache,
  1946. lockdep_sock_is_held(sk));
  1947. rcu_assign_pointer(sk->sk_dst_cache, dst);
  1948. dst_release(old_dst);
  1949. }
  1950. static inline void
  1951. sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1952. {
  1953. struct dst_entry *old_dst;
  1954. sk_tx_queue_clear(sk);
  1955. WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
  1956. old_dst = unrcu_pointer(xchg(&sk->sk_dst_cache, RCU_INITIALIZER(dst)));
  1957. dst_release(old_dst);
  1958. }
  1959. static inline void
  1960. __sk_dst_reset(struct sock *sk)
  1961. {
  1962. __sk_dst_set(sk, NULL);
  1963. }
  1964. static inline void
  1965. sk_dst_reset(struct sock *sk)
  1966. {
  1967. sk_dst_set(sk, NULL);
  1968. }
  1969. struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
  1970. struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
  1971. static inline void sk_dst_confirm(struct sock *sk)
  1972. {
  1973. if (!READ_ONCE(sk->sk_dst_pending_confirm))
  1974. WRITE_ONCE(sk->sk_dst_pending_confirm, 1);
  1975. }
  1976. static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
  1977. {
  1978. if (skb_get_dst_pending_confirm(skb)) {
  1979. struct sock *sk = skb->sk;
  1980. if (sk && READ_ONCE(sk->sk_dst_pending_confirm))
  1981. WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
  1982. neigh_confirm(n);
  1983. }
  1984. }
  1985. bool sk_mc_loop(const struct sock *sk);
  1986. static inline bool sk_can_gso(const struct sock *sk)
  1987. {
  1988. return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
  1989. }
  1990. void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
  1991. static inline void sk_gso_disable(struct sock *sk)
  1992. {
  1993. sk->sk_gso_disabled = 1;
  1994. sk->sk_route_caps &= ~NETIF_F_GSO_MASK;
  1995. }
  1996. static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
  1997. struct iov_iter *from, char *to,
  1998. int copy, int offset)
  1999. {
  2000. if (skb->ip_summed == CHECKSUM_NONE) {
  2001. __wsum csum = 0;
  2002. if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
  2003. return -EFAULT;
  2004. skb->csum = csum_block_add(skb->csum, csum, offset);
  2005. } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
  2006. if (!copy_from_iter_full_nocache(to, copy, from))
  2007. return -EFAULT;
  2008. } else if (!copy_from_iter_full(to, copy, from))
  2009. return -EFAULT;
  2010. return 0;
  2011. }
  2012. static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
  2013. struct iov_iter *from, int copy)
  2014. {
  2015. int err, offset = skb->len;
  2016. err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
  2017. copy, offset);
  2018. if (err)
  2019. __skb_trim(skb, offset);
  2020. return err;
  2021. }
  2022. static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
  2023. struct sk_buff *skb,
  2024. struct page *page,
  2025. int off, int copy)
  2026. {
  2027. int err;
  2028. err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
  2029. copy, skb->len);
  2030. if (err)
  2031. return err;
  2032. skb_len_add(skb, copy);
  2033. sk_wmem_queued_add(sk, copy);
  2034. sk_mem_charge(sk, copy);
  2035. return 0;
  2036. }
  2037. #define SK_WMEM_ALLOC_BIAS 1
  2038. /**
  2039. * sk_wmem_alloc_get - returns write allocations
  2040. * @sk: socket
  2041. *
  2042. * Return: sk_wmem_alloc minus initial offset of one
  2043. */
  2044. static inline int sk_wmem_alloc_get(const struct sock *sk)
  2045. {
  2046. return refcount_read(&sk->sk_wmem_alloc) - SK_WMEM_ALLOC_BIAS;
  2047. }
  2048. /**
  2049. * sk_rmem_alloc_get - returns read allocations
  2050. * @sk: socket
  2051. *
  2052. * Return: sk_rmem_alloc
  2053. */
  2054. static inline int sk_rmem_alloc_get(const struct sock *sk)
  2055. {
  2056. return atomic_read(&sk->sk_rmem_alloc);
  2057. }
  2058. /**
  2059. * sk_has_allocations - check if allocations are outstanding
  2060. * @sk: socket
  2061. *
  2062. * Return: true if socket has write or read allocations
  2063. */
  2064. static inline bool sk_has_allocations(const struct sock *sk)
  2065. {
  2066. return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
  2067. }
  2068. /**
  2069. * skwq_has_sleeper - check if there are any waiting processes
  2070. * @wq: struct socket_wq
  2071. *
  2072. * Return: true if socket_wq has waiting processes
  2073. *
  2074. * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
  2075. * barrier call. They were added due to the race found within the tcp code.
  2076. *
  2077. * Consider following tcp code paths::
  2078. *
  2079. * CPU1 CPU2
  2080. * sys_select receive packet
  2081. * ... ...
  2082. * __add_wait_queue update tp->rcv_nxt
  2083. * ... ...
  2084. * tp->rcv_nxt check sock_def_readable
  2085. * ... {
  2086. * schedule rcu_read_lock();
  2087. * wq = rcu_dereference(sk->sk_wq);
  2088. * if (wq && waitqueue_active(&wq->wait))
  2089. * wake_up_interruptible(&wq->wait)
  2090. * ...
  2091. * }
  2092. *
  2093. * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
  2094. * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
  2095. * could then endup calling schedule and sleep forever if there are no more
  2096. * data on the socket.
  2097. *
  2098. */
  2099. static inline bool skwq_has_sleeper(struct socket_wq *wq)
  2100. {
  2101. return wq && wq_has_sleeper(&wq->wait);
  2102. }
  2103. /**
  2104. * sock_poll_wait - wrapper for the poll_wait call.
  2105. * @filp: file
  2106. * @sock: socket to wait on
  2107. * @p: poll_table
  2108. *
  2109. * See the comments in the wq_has_sleeper function.
  2110. */
  2111. static inline void sock_poll_wait(struct file *filp, struct socket *sock,
  2112. poll_table *p)
  2113. {
  2114. /* Provides a barrier we need to be sure we are in sync
  2115. * with the socket flags modification.
  2116. *
  2117. * This memory barrier is paired in the wq_has_sleeper.
  2118. */
  2119. poll_wait(filp, &sock->wq.wait, p);
  2120. }
  2121. static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
  2122. {
  2123. /* This pairs with WRITE_ONCE() in sk_set_txhash() */
  2124. u32 txhash = READ_ONCE(sk->sk_txhash);
  2125. if (txhash) {
  2126. skb->l4_hash = 1;
  2127. skb->hash = txhash;
  2128. }
  2129. }
  2130. void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
  2131. /*
  2132. * Queue a received datagram if it will fit. Stream and sequenced
  2133. * protocols can't normally use this as they need to fit buffers in
  2134. * and play with them.
  2135. *
  2136. * Inlined as it's very short and called for pretty much every
  2137. * packet ever received.
  2138. */
  2139. static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
  2140. {
  2141. skb_orphan(skb);
  2142. skb->sk = sk;
  2143. skb->destructor = sock_rfree;
  2144. atomic_add(skb->truesize, &sk->sk_rmem_alloc);
  2145. sk_mem_charge(sk, skb->truesize);
  2146. }
  2147. static inline __must_check bool skb_set_owner_sk_safe(struct sk_buff *skb, struct sock *sk)
  2148. {
  2149. if (sk && refcount_inc_not_zero(&sk->sk_refcnt)) {
  2150. skb_orphan(skb);
  2151. skb->destructor = sock_efree;
  2152. skb->sk = sk;
  2153. return true;
  2154. }
  2155. return false;
  2156. }
  2157. static inline struct sk_buff *skb_clone_and_charge_r(struct sk_buff *skb, struct sock *sk)
  2158. {
  2159. skb = skb_clone(skb, sk_gfp_mask(sk, GFP_ATOMIC));
  2160. if (skb) {
  2161. if (sk_rmem_schedule(sk, skb, skb->truesize)) {
  2162. skb_set_owner_r(skb, sk);
  2163. return skb;
  2164. }
  2165. __kfree_skb(skb);
  2166. }
  2167. return NULL;
  2168. }
  2169. static inline void skb_prepare_for_gro(struct sk_buff *skb)
  2170. {
  2171. if (skb->destructor != sock_wfree) {
  2172. skb_orphan(skb);
  2173. return;
  2174. }
  2175. skb->slow_gro = 1;
  2176. }
  2177. void sk_reset_timer(struct sock *sk, struct timer_list *timer,
  2178. unsigned long expires);
  2179. void sk_stop_timer(struct sock *sk, struct timer_list *timer);
  2180. void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer);
  2181. int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
  2182. struct sk_buff *skb, unsigned int flags,
  2183. void (*destructor)(struct sock *sk,
  2184. struct sk_buff *skb));
  2185. int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
  2186. int sock_queue_rcv_skb_reason(struct sock *sk, struct sk_buff *skb,
  2187. enum skb_drop_reason *reason);
  2188. static inline int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
  2189. {
  2190. return sock_queue_rcv_skb_reason(sk, skb, NULL);
  2191. }
  2192. int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
  2193. struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
  2194. /*
  2195. * Recover an error report and clear atomically
  2196. */
  2197. static inline int sock_error(struct sock *sk)
  2198. {
  2199. int err;
  2200. /* Avoid an atomic operation for the common case.
  2201. * This is racy since another cpu/thread can change sk_err under us.
  2202. */
  2203. if (likely(data_race(!sk->sk_err)))
  2204. return 0;
  2205. err = xchg(&sk->sk_err, 0);
  2206. return -err;
  2207. }
  2208. void sk_error_report(struct sock *sk);
  2209. static inline unsigned long sock_wspace(struct sock *sk)
  2210. {
  2211. int amt = 0;
  2212. if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
  2213. amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
  2214. if (amt < 0)
  2215. amt = 0;
  2216. }
  2217. return amt;
  2218. }
  2219. /* Note:
  2220. * We use sk->sk_wq_raw, from contexts knowing this
  2221. * pointer is not NULL and cannot disappear/change.
  2222. */
  2223. static inline void sk_set_bit(int nr, struct sock *sk)
  2224. {
  2225. if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
  2226. !sock_flag(sk, SOCK_FASYNC))
  2227. return;
  2228. set_bit(nr, &sk->sk_wq_raw->flags);
  2229. }
  2230. static inline void sk_clear_bit(int nr, struct sock *sk)
  2231. {
  2232. if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
  2233. !sock_flag(sk, SOCK_FASYNC))
  2234. return;
  2235. clear_bit(nr, &sk->sk_wq_raw->flags);
  2236. }
  2237. static inline void sk_wake_async(const struct sock *sk, int how, int band)
  2238. {
  2239. if (sock_flag(sk, SOCK_FASYNC)) {
  2240. rcu_read_lock();
  2241. sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
  2242. rcu_read_unlock();
  2243. }
  2244. }
  2245. static inline void sk_wake_async_rcu(const struct sock *sk, int how, int band)
  2246. {
  2247. if (unlikely(sock_flag(sk, SOCK_FASYNC)))
  2248. sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
  2249. }
  2250. /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
  2251. * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
  2252. * Note: for send buffers, TCP works better if we can build two skbs at
  2253. * minimum.
  2254. */
  2255. #define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
  2256. #define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
  2257. #define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
  2258. static inline void sk_stream_moderate_sndbuf(struct sock *sk)
  2259. {
  2260. u32 val;
  2261. if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
  2262. return;
  2263. val = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
  2264. val = max_t(u32, val, sk_unused_reserved_mem(sk));
  2265. WRITE_ONCE(sk->sk_sndbuf, max_t(u32, val, SOCK_MIN_SNDBUF));
  2266. }
  2267. /**
  2268. * sk_page_frag - return an appropriate page_frag
  2269. * @sk: socket
  2270. *
  2271. * Use the per task page_frag instead of the per socket one for
  2272. * optimization when we know that we're in process context and own
  2273. * everything that's associated with %current.
  2274. *
  2275. * Both direct reclaim and page faults can nest inside other
  2276. * socket operations and end up recursing into sk_page_frag()
  2277. * while it's already in use: explicitly avoid task page_frag
  2278. * when users disable sk_use_task_frag.
  2279. *
  2280. * Return: a per task page_frag if context allows that,
  2281. * otherwise a per socket one.
  2282. */
  2283. static inline struct page_frag *sk_page_frag(struct sock *sk)
  2284. {
  2285. if (sk->sk_use_task_frag)
  2286. return &current->task_frag;
  2287. return &sk->sk_frag;
  2288. }
  2289. bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
  2290. static inline bool __sock_writeable(const struct sock *sk, int wmem_alloc)
  2291. {
  2292. return wmem_alloc < (READ_ONCE(sk->sk_sndbuf) >> 1);
  2293. }
  2294. /*
  2295. * Default write policy as shown to user space via poll/select/SIGIO
  2296. */
  2297. static inline bool sock_writeable(const struct sock *sk)
  2298. {
  2299. return __sock_writeable(sk, refcount_read(&sk->sk_wmem_alloc));
  2300. }
  2301. static inline gfp_t gfp_any(void)
  2302. {
  2303. return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
  2304. }
  2305. static inline gfp_t gfp_memcg_charge(void)
  2306. {
  2307. return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
  2308. }
  2309. #ifdef CONFIG_MEMCG
  2310. static inline struct mem_cgroup *mem_cgroup_from_sk(const struct sock *sk)
  2311. {
  2312. return sk->sk_memcg;
  2313. }
  2314. static inline bool mem_cgroup_sk_enabled(const struct sock *sk)
  2315. {
  2316. return mem_cgroup_sockets_enabled && mem_cgroup_from_sk(sk);
  2317. }
  2318. static inline bool mem_cgroup_sk_under_memory_pressure(const struct sock *sk)
  2319. {
  2320. struct mem_cgroup *memcg = mem_cgroup_from_sk(sk);
  2321. #ifdef CONFIG_MEMCG_V1
  2322. if (!cgroup_subsys_on_dfl(memory_cgrp_subsys))
  2323. return !!memcg->tcpmem_pressure;
  2324. #endif /* CONFIG_MEMCG_V1 */
  2325. do {
  2326. if (time_before64(get_jiffies_64(),
  2327. mem_cgroup_get_socket_pressure(memcg))) {
  2328. memcg_memory_event(mem_cgroup_from_sk(sk),
  2329. MEMCG_SOCK_THROTTLED);
  2330. return true;
  2331. }
  2332. } while ((memcg = parent_mem_cgroup(memcg)));
  2333. return false;
  2334. }
  2335. #else
  2336. static inline struct mem_cgroup *mem_cgroup_from_sk(const struct sock *sk)
  2337. {
  2338. return NULL;
  2339. }
  2340. static inline bool mem_cgroup_sk_enabled(const struct sock *sk)
  2341. {
  2342. return false;
  2343. }
  2344. static inline bool mem_cgroup_sk_under_memory_pressure(const struct sock *sk)
  2345. {
  2346. return false;
  2347. }
  2348. #endif
  2349. static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
  2350. {
  2351. return noblock ? 0 : READ_ONCE(sk->sk_rcvtimeo);
  2352. }
  2353. static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
  2354. {
  2355. return noblock ? 0 : READ_ONCE(sk->sk_sndtimeo);
  2356. }
  2357. static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
  2358. {
  2359. int v = waitall ? len : min_t(int, READ_ONCE(sk->sk_rcvlowat), len);
  2360. return v ?: 1;
  2361. }
  2362. /* Alas, with timeout socket operations are not restartable.
  2363. * Compare this to poll().
  2364. */
  2365. static inline int sock_intr_errno(long timeo)
  2366. {
  2367. return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
  2368. }
  2369. struct sock_skb_cb {
  2370. u32 dropcount;
  2371. };
  2372. /* Store sock_skb_cb at the end of skb->cb[] so protocol families
  2373. * using skb->cb[] would keep using it directly and utilize its
  2374. * alignment guarantee.
  2375. */
  2376. #define SOCK_SKB_CB_OFFSET (sizeof_field(struct sk_buff, cb) - \
  2377. sizeof(struct sock_skb_cb))
  2378. #define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
  2379. SOCK_SKB_CB_OFFSET))
  2380. #define sock_skb_cb_check_size(size) \
  2381. BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
  2382. static inline void sk_drops_add(struct sock *sk, int segs)
  2383. {
  2384. struct numa_drop_counters *ndc = sk->sk_drop_counters;
  2385. if (ndc)
  2386. numa_drop_add(ndc, segs);
  2387. else
  2388. atomic_add(segs, &sk->sk_drops);
  2389. }
  2390. static inline void sk_drops_inc(struct sock *sk)
  2391. {
  2392. sk_drops_add(sk, 1);
  2393. }
  2394. static inline int sk_drops_read(const struct sock *sk)
  2395. {
  2396. const struct numa_drop_counters *ndc = sk->sk_drop_counters;
  2397. if (ndc) {
  2398. DEBUG_NET_WARN_ON_ONCE(atomic_read(&sk->sk_drops));
  2399. return numa_drop_read(ndc);
  2400. }
  2401. return atomic_read(&sk->sk_drops);
  2402. }
  2403. static inline void sk_drops_reset(struct sock *sk)
  2404. {
  2405. struct numa_drop_counters *ndc = sk->sk_drop_counters;
  2406. if (ndc)
  2407. numa_drop_reset(ndc);
  2408. atomic_set(&sk->sk_drops, 0);
  2409. }
  2410. static inline void
  2411. sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
  2412. {
  2413. SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
  2414. sk_drops_read(sk) : 0;
  2415. }
  2416. static inline void sk_drops_skbadd(struct sock *sk, const struct sk_buff *skb)
  2417. {
  2418. int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
  2419. sk_drops_add(sk, segs);
  2420. }
  2421. static inline ktime_t sock_read_timestamp(struct sock *sk)
  2422. {
  2423. #if BITS_PER_LONG==32
  2424. unsigned int seq;
  2425. ktime_t kt;
  2426. do {
  2427. seq = read_seqbegin(&sk->sk_stamp_seq);
  2428. kt = sk->sk_stamp;
  2429. } while (read_seqretry(&sk->sk_stamp_seq, seq));
  2430. return kt;
  2431. #else
  2432. return READ_ONCE(sk->sk_stamp);
  2433. #endif
  2434. }
  2435. static inline void sock_write_timestamp(struct sock *sk, ktime_t kt)
  2436. {
  2437. #if BITS_PER_LONG==32
  2438. write_seqlock(&sk->sk_stamp_seq);
  2439. sk->sk_stamp = kt;
  2440. write_sequnlock(&sk->sk_stamp_seq);
  2441. #else
  2442. WRITE_ONCE(sk->sk_stamp, kt);
  2443. #endif
  2444. }
  2445. void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
  2446. struct sk_buff *skb);
  2447. void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
  2448. struct sk_buff *skb);
  2449. bool skb_has_tx_timestamp(struct sk_buff *skb, const struct sock *sk);
  2450. int skb_get_tx_timestamp(struct sk_buff *skb, struct sock *sk,
  2451. struct timespec64 *ts);
  2452. static inline void
  2453. sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
  2454. {
  2455. struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
  2456. u32 tsflags = READ_ONCE(sk->sk_tsflags);
  2457. ktime_t kt = skb->tstamp;
  2458. /*
  2459. * generate control messages if
  2460. * - receive time stamping in software requested
  2461. * - software time stamp available and wanted
  2462. * - hardware time stamps available and wanted
  2463. */
  2464. if (sock_flag(sk, SOCK_RCVTSTAMP) ||
  2465. (tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
  2466. (kt && tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
  2467. (hwtstamps->hwtstamp &&
  2468. (tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
  2469. __sock_recv_timestamp(msg, sk, skb);
  2470. else
  2471. sock_write_timestamp(sk, kt);
  2472. if (sock_flag(sk, SOCK_WIFI_STATUS) && skb_wifi_acked_valid(skb))
  2473. __sock_recv_wifi_status(msg, sk, skb);
  2474. }
  2475. void __sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
  2476. struct sk_buff *skb);
  2477. #define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
  2478. static inline void sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
  2479. struct sk_buff *skb)
  2480. {
  2481. #define FLAGS_RECV_CMSGS ((1UL << SOCK_RXQ_OVFL) | \
  2482. (1UL << SOCK_RCVTSTAMP) | \
  2483. (1UL << SOCK_RCVMARK) | \
  2484. (1UL << SOCK_RCVPRIORITY) | \
  2485. (1UL << SOCK_TIMESTAMPING_ANY))
  2486. #define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
  2487. SOF_TIMESTAMPING_RAW_HARDWARE)
  2488. if (READ_ONCE(sk->sk_flags) & FLAGS_RECV_CMSGS)
  2489. __sock_recv_cmsgs(msg, sk, skb);
  2490. else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
  2491. sock_write_timestamp(sk, skb->tstamp);
  2492. else if (unlikely(sock_read_timestamp(sk) == SK_DEFAULT_STAMP))
  2493. sock_write_timestamp(sk, 0);
  2494. }
  2495. void __sock_tx_timestamp(__u32 tsflags, __u8 *tx_flags);
  2496. /**
  2497. * _sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
  2498. * @sk: socket sending this packet
  2499. * @sockc: pointer to socket cmsg cookie to get timestamping info
  2500. * @tx_flags: completed with instructions for time stamping
  2501. * @tskey: filled in with next sk_tskey (not for TCP, which uses seqno)
  2502. *
  2503. * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
  2504. */
  2505. static inline void _sock_tx_timestamp(struct sock *sk,
  2506. const struct sockcm_cookie *sockc,
  2507. __u8 *tx_flags, __u32 *tskey)
  2508. {
  2509. __u32 tsflags = sockc->tsflags;
  2510. if (unlikely(tsflags)) {
  2511. __sock_tx_timestamp(tsflags, tx_flags);
  2512. if (tsflags & SOF_TIMESTAMPING_OPT_ID && tskey &&
  2513. tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK) {
  2514. if (tsflags & SOCKCM_FLAG_TS_OPT_ID)
  2515. *tskey = sockc->ts_opt_id;
  2516. else
  2517. *tskey = atomic_inc_return(&sk->sk_tskey) - 1;
  2518. }
  2519. }
  2520. }
  2521. static inline void sock_tx_timestamp(struct sock *sk,
  2522. const struct sockcm_cookie *sockc,
  2523. __u8 *tx_flags)
  2524. {
  2525. _sock_tx_timestamp(sk, sockc, tx_flags, NULL);
  2526. }
  2527. static inline void skb_setup_tx_timestamp(struct sk_buff *skb,
  2528. const struct sockcm_cookie *sockc)
  2529. {
  2530. _sock_tx_timestamp(skb->sk, sockc, &skb_shinfo(skb)->tx_flags,
  2531. &skb_shinfo(skb)->tskey);
  2532. }
  2533. static inline bool sk_is_inet(const struct sock *sk)
  2534. {
  2535. int family = READ_ONCE(sk->sk_family);
  2536. return family == AF_INET || family == AF_INET6;
  2537. }
  2538. static inline bool sk_is_tcp(const struct sock *sk)
  2539. {
  2540. return sk_is_inet(sk) &&
  2541. sk->sk_type == SOCK_STREAM &&
  2542. sk->sk_protocol == IPPROTO_TCP;
  2543. }
  2544. static inline bool sk_is_udp(const struct sock *sk)
  2545. {
  2546. return sk_is_inet(sk) &&
  2547. sk->sk_type == SOCK_DGRAM &&
  2548. sk->sk_protocol == IPPROTO_UDP;
  2549. }
  2550. static inline bool sk_is_unix(const struct sock *sk)
  2551. {
  2552. return sk->sk_family == AF_UNIX;
  2553. }
  2554. static inline bool sk_is_stream_unix(const struct sock *sk)
  2555. {
  2556. return sk_is_unix(sk) && sk->sk_type == SOCK_STREAM;
  2557. }
  2558. static inline bool sk_is_vsock(const struct sock *sk)
  2559. {
  2560. return sk->sk_family == AF_VSOCK;
  2561. }
  2562. static inline bool sk_may_scm_recv(const struct sock *sk)
  2563. {
  2564. return (IS_ENABLED(CONFIG_UNIX) && sk->sk_family == AF_UNIX) ||
  2565. sk->sk_family == AF_NETLINK ||
  2566. (IS_ENABLED(CONFIG_BT) && sk->sk_family == AF_BLUETOOTH);
  2567. }
  2568. /**
  2569. * sk_eat_skb - Release a skb if it is no longer needed
  2570. * @sk: socket to eat this skb from
  2571. * @skb: socket buffer to eat
  2572. *
  2573. * This routine must be called with interrupts disabled or with the socket
  2574. * locked so that the sk_buff queue operation is ok.
  2575. */
  2576. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
  2577. {
  2578. __skb_unlink(skb, &sk->sk_receive_queue);
  2579. __kfree_skb(skb);
  2580. }
  2581. static inline bool
  2582. skb_sk_is_prefetched(struct sk_buff *skb)
  2583. {
  2584. #ifdef CONFIG_INET
  2585. return skb->destructor == sock_pfree;
  2586. #else
  2587. return false;
  2588. #endif /* CONFIG_INET */
  2589. }
  2590. /* This helper checks if a socket is a full socket,
  2591. * ie _not_ a timewait or request socket.
  2592. */
  2593. static inline bool sk_fullsock(const struct sock *sk)
  2594. {
  2595. return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
  2596. }
  2597. static inline bool
  2598. sk_is_refcounted(struct sock *sk)
  2599. {
  2600. /* Only full sockets have sk->sk_flags. */
  2601. return !sk_fullsock(sk) || !sock_flag(sk, SOCK_RCU_FREE);
  2602. }
  2603. static inline bool
  2604. sk_requests_wifi_status(struct sock *sk)
  2605. {
  2606. return sk && sk_fullsock(sk) && sock_flag(sk, SOCK_WIFI_STATUS);
  2607. }
  2608. /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
  2609. * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
  2610. */
  2611. static inline bool sk_listener(const struct sock *sk)
  2612. {
  2613. return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
  2614. }
  2615. /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV or TIME_WAIT
  2616. * TCP SYNACK messages can be attached to LISTEN or NEW_SYN_RECV (depending on SYNCOOKIE)
  2617. * TCP RST and ACK can be attached to TIME_WAIT.
  2618. */
  2619. static inline bool sk_listener_or_tw(const struct sock *sk)
  2620. {
  2621. return (1 << READ_ONCE(sk->sk_state)) &
  2622. (TCPF_LISTEN | TCPF_NEW_SYN_RECV | TCPF_TIME_WAIT);
  2623. }
  2624. void sock_enable_timestamp(struct sock *sk, enum sock_flags flag);
  2625. int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
  2626. int type);
  2627. bool sk_ns_capable(const struct sock *sk,
  2628. struct user_namespace *user_ns, int cap);
  2629. bool sk_capable(const struct sock *sk, int cap);
  2630. bool sk_net_capable(const struct sock *sk, int cap);
  2631. void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
  2632. /* Take into consideration the size of the struct sk_buff overhead in the
  2633. * determination of these values, since that is non-constant across
  2634. * platforms. This makes socket queueing behavior and performance
  2635. * not depend upon such differences.
  2636. */
  2637. #define _SK_MEM_PACKETS 256
  2638. #define _SK_MEM_OVERHEAD SKB_TRUESIZE(256)
  2639. #define SK_WMEM_DEFAULT (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
  2640. #define SK_RMEM_DEFAULT (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
  2641. extern __u32 sysctl_wmem_max;
  2642. extern __u32 sysctl_rmem_max;
  2643. extern __u32 sysctl_wmem_default;
  2644. extern __u32 sysctl_rmem_default;
  2645. #define SKB_FRAG_PAGE_ORDER get_order(32768)
  2646. DECLARE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);
  2647. static inline int sk_get_wmem0(const struct sock *sk, const struct proto *proto)
  2648. {
  2649. /* Does this proto have per netns sysctl_wmem ? */
  2650. if (proto->sysctl_wmem_offset)
  2651. return READ_ONCE(*(int *)((void *)sock_net(sk) + proto->sysctl_wmem_offset));
  2652. return READ_ONCE(*proto->sysctl_wmem);
  2653. }
  2654. static inline int sk_get_rmem0(const struct sock *sk, const struct proto *proto)
  2655. {
  2656. /* Does this proto have per netns sysctl_rmem ? */
  2657. if (proto->sysctl_rmem_offset)
  2658. return READ_ONCE(*(int *)((void *)sock_net(sk) + proto->sysctl_rmem_offset));
  2659. return READ_ONCE(*proto->sysctl_rmem);
  2660. }
  2661. /* Default TCP Small queue budget is ~1 ms of data (1sec >> 10)
  2662. * Some wifi drivers need to tweak it to get more chunks.
  2663. * They can use this helper from their ndo_start_xmit()
  2664. */
  2665. static inline void sk_pacing_shift_update(struct sock *sk, int val)
  2666. {
  2667. if (!sk || !sk_fullsock(sk) || READ_ONCE(sk->sk_pacing_shift) == val)
  2668. return;
  2669. WRITE_ONCE(sk->sk_pacing_shift, val);
  2670. }
  2671. /* if a socket is bound to a device, check that the given device
  2672. * index is either the same or that the socket is bound to an L3
  2673. * master device and the given device index is also enslaved to
  2674. * that L3 master
  2675. */
  2676. static inline bool sk_dev_equal_l3scope(struct sock *sk, int dif)
  2677. {
  2678. int bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
  2679. int mdif;
  2680. if (!bound_dev_if || bound_dev_if == dif)
  2681. return true;
  2682. mdif = l3mdev_master_ifindex_by_index(sock_net(sk), dif);
  2683. if (mdif && mdif == bound_dev_if)
  2684. return true;
  2685. return false;
  2686. }
  2687. void sock_def_readable(struct sock *sk);
  2688. int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk);
  2689. void sock_set_timestamp(struct sock *sk, int optname, bool valbool);
  2690. int sock_set_timestamping(struct sock *sk, int optname,
  2691. struct so_timestamping timestamping);
  2692. #if defined(CONFIG_CGROUP_BPF)
  2693. void bpf_skops_tx_timestamping(struct sock *sk, struct sk_buff *skb, int op);
  2694. #else
  2695. static inline void bpf_skops_tx_timestamping(struct sock *sk, struct sk_buff *skb, int op)
  2696. {
  2697. }
  2698. #endif
  2699. void sock_no_linger(struct sock *sk);
  2700. void sock_set_keepalive(struct sock *sk);
  2701. void sock_set_priority(struct sock *sk, u32 priority);
  2702. void sock_set_rcvbuf(struct sock *sk, int val);
  2703. void sock_set_mark(struct sock *sk, u32 val);
  2704. void sock_set_reuseaddr(struct sock *sk);
  2705. void sock_set_reuseport(struct sock *sk);
  2706. void sock_set_sndtimeo(struct sock *sk, s64 secs);
  2707. int sock_bind_add(struct sock *sk, struct sockaddr_unsized *addr, int addr_len);
  2708. int sock_get_timeout(long timeo, void *optval, bool old_timeval);
  2709. int sock_copy_user_timeval(struct __kernel_sock_timeval *tv,
  2710. sockptr_t optval, int optlen, bool old_timeval);
  2711. int sock_ioctl_inout(struct sock *sk, unsigned int cmd,
  2712. void __user *arg, void *karg, size_t size);
  2713. int sk_ioctl(struct sock *sk, unsigned int cmd, void __user *arg);
  2714. static inline bool sk_is_readable(struct sock *sk)
  2715. {
  2716. const struct proto *prot = READ_ONCE(sk->sk_prot);
  2717. if (prot->sock_is_readable)
  2718. return prot->sock_is_readable(sk);
  2719. return false;
  2720. }
  2721. #endif /* _SOCK_H */