sock.h 63 KB

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