sock.h 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180
  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. kmemcheck_bitfield_begin(flags);
  367. unsigned int sk_shutdown : 2,
  368. sk_no_check_tx : 1,
  369. sk_no_check_rx : 1,
  370. sk_userlocks : 4,
  371. sk_protocol : 8,
  372. sk_type : 16;
  373. #define SK_PROTOCOL_MAX U8_MAX
  374. kmemcheck_bitfield_end(flags);
  375. int sk_wmem_queued;
  376. gfp_t sk_allocation;
  377. u32 sk_pacing_rate; /* bytes per second */
  378. u32 sk_max_pacing_rate;
  379. netdev_features_t sk_route_caps;
  380. netdev_features_t sk_route_nocaps;
  381. int sk_gso_type;
  382. unsigned int sk_gso_max_size;
  383. u16 sk_gso_max_segs;
  384. int sk_rcvlowat;
  385. unsigned long sk_lingertime;
  386. struct sk_buff_head sk_error_queue;
  387. struct proto *sk_prot_creator;
  388. rwlock_t sk_callback_lock;
  389. int sk_err,
  390. sk_err_soft;
  391. u32 sk_ack_backlog;
  392. u32 sk_max_ack_backlog;
  393. __u32 sk_priority;
  394. __u32 sk_mark;
  395. struct pid *sk_peer_pid;
  396. const struct cred *sk_peer_cred;
  397. long sk_rcvtimeo;
  398. long sk_sndtimeo;
  399. struct timer_list sk_timer;
  400. ktime_t sk_stamp;
  401. u16 sk_tsflags;
  402. u32 sk_tskey;
  403. struct socket *sk_socket;
  404. void *sk_user_data;
  405. struct page_frag sk_frag;
  406. struct sk_buff *sk_send_head;
  407. __s32 sk_peek_off;
  408. int sk_write_pending;
  409. #ifdef CONFIG_SECURITY
  410. void *sk_security;
  411. #endif
  412. struct sock_cgroup_data sk_cgrp_data;
  413. struct mem_cgroup *sk_memcg;
  414. void (*sk_state_change)(struct sock *sk);
  415. void (*sk_data_ready)(struct sock *sk);
  416. void (*sk_write_space)(struct sock *sk);
  417. void (*sk_error_report)(struct sock *sk);
  418. int (*sk_backlog_rcv)(struct sock *sk,
  419. struct sk_buff *skb);
  420. void (*sk_destruct)(struct sock *sk);
  421. struct sock_reuseport __rcu *sk_reuseport_cb;
  422. struct rcu_head sk_rcu;
  423. };
  424. #define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
  425. #define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
  426. #define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
  427. /*
  428. * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
  429. * or not whether his port will be reused by someone else. SK_FORCE_REUSE
  430. * on a socket means that the socket will reuse everybody else's port
  431. * without looking at the other's sk_reuse value.
  432. */
  433. #define SK_NO_REUSE 0
  434. #define SK_CAN_REUSE 1
  435. #define SK_FORCE_REUSE 2
  436. static inline int sk_peek_offset(struct sock *sk, int flags)
  437. {
  438. if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
  439. return sk->sk_peek_off;
  440. else
  441. return 0;
  442. }
  443. static inline void sk_peek_offset_bwd(struct sock *sk, int val)
  444. {
  445. if (sk->sk_peek_off >= 0) {
  446. if (sk->sk_peek_off >= val)
  447. sk->sk_peek_off -= val;
  448. else
  449. sk->sk_peek_off = 0;
  450. }
  451. }
  452. static inline void sk_peek_offset_fwd(struct sock *sk, int val)
  453. {
  454. if (sk->sk_peek_off >= 0)
  455. sk->sk_peek_off += val;
  456. }
  457. /*
  458. * Hashed lists helper routines
  459. */
  460. static inline struct sock *sk_entry(const struct hlist_node *node)
  461. {
  462. return hlist_entry(node, struct sock, sk_node);
  463. }
  464. static inline struct sock *__sk_head(const struct hlist_head *head)
  465. {
  466. return hlist_entry(head->first, struct sock, sk_node);
  467. }
  468. static inline struct sock *sk_head(const struct hlist_head *head)
  469. {
  470. return hlist_empty(head) ? NULL : __sk_head(head);
  471. }
  472. static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
  473. {
  474. return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
  475. }
  476. static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
  477. {
  478. return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
  479. }
  480. static inline struct sock *sk_next(const struct sock *sk)
  481. {
  482. return sk->sk_node.next ?
  483. hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
  484. }
  485. static inline struct sock *sk_nulls_next(const struct sock *sk)
  486. {
  487. return (!is_a_nulls(sk->sk_nulls_node.next)) ?
  488. hlist_nulls_entry(sk->sk_nulls_node.next,
  489. struct sock, sk_nulls_node) :
  490. NULL;
  491. }
  492. static inline bool sk_unhashed(const struct sock *sk)
  493. {
  494. return hlist_unhashed(&sk->sk_node);
  495. }
  496. static inline bool sk_hashed(const struct sock *sk)
  497. {
  498. return !sk_unhashed(sk);
  499. }
  500. static inline void sk_node_init(struct hlist_node *node)
  501. {
  502. node->pprev = NULL;
  503. }
  504. static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
  505. {
  506. node->pprev = NULL;
  507. }
  508. static inline void __sk_del_node(struct sock *sk)
  509. {
  510. __hlist_del(&sk->sk_node);
  511. }
  512. /* NB: equivalent to hlist_del_init_rcu */
  513. static inline bool __sk_del_node_init(struct sock *sk)
  514. {
  515. if (sk_hashed(sk)) {
  516. __sk_del_node(sk);
  517. sk_node_init(&sk->sk_node);
  518. return true;
  519. }
  520. return false;
  521. }
  522. /* Grab socket reference count. This operation is valid only
  523. when sk is ALREADY grabbed f.e. it is found in hash table
  524. or a list and the lookup is made under lock preventing hash table
  525. modifications.
  526. */
  527. static inline void sock_hold(struct sock *sk)
  528. {
  529. atomic_inc(&sk->sk_refcnt);
  530. }
  531. /* Ungrab socket in the context, which assumes that socket refcnt
  532. cannot hit zero, f.e. it is true in context of any socketcall.
  533. */
  534. static inline void __sock_put(struct sock *sk)
  535. {
  536. atomic_dec(&sk->sk_refcnt);
  537. }
  538. static inline bool sk_del_node_init(struct sock *sk)
  539. {
  540. bool rc = __sk_del_node_init(sk);
  541. if (rc) {
  542. /* paranoid for a while -acme */
  543. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  544. __sock_put(sk);
  545. }
  546. return rc;
  547. }
  548. #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
  549. static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
  550. {
  551. if (sk_hashed(sk)) {
  552. hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
  553. return true;
  554. }
  555. return false;
  556. }
  557. static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
  558. {
  559. bool rc = __sk_nulls_del_node_init_rcu(sk);
  560. if (rc) {
  561. /* paranoid for a while -acme */
  562. WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
  563. __sock_put(sk);
  564. }
  565. return rc;
  566. }
  567. static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
  568. {
  569. hlist_add_head(&sk->sk_node, list);
  570. }
  571. static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
  572. {
  573. sock_hold(sk);
  574. __sk_add_node(sk, list);
  575. }
  576. static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
  577. {
  578. sock_hold(sk);
  579. hlist_add_head_rcu(&sk->sk_node, list);
  580. }
  581. static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  582. {
  583. hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
  584. }
  585. static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
  586. {
  587. sock_hold(sk);
  588. __sk_nulls_add_node_rcu(sk, list);
  589. }
  590. static inline void __sk_del_bind_node(struct sock *sk)
  591. {
  592. __hlist_del(&sk->sk_bind_node);
  593. }
  594. static inline void sk_add_bind_node(struct sock *sk,
  595. struct hlist_head *list)
  596. {
  597. hlist_add_head(&sk->sk_bind_node, list);
  598. }
  599. #define sk_for_each(__sk, list) \
  600. hlist_for_each_entry(__sk, list, sk_node)
  601. #define sk_for_each_rcu(__sk, list) \
  602. hlist_for_each_entry_rcu(__sk, list, sk_node)
  603. #define sk_nulls_for_each(__sk, node, list) \
  604. hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
  605. #define sk_nulls_for_each_rcu(__sk, node, list) \
  606. hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
  607. #define sk_for_each_from(__sk) \
  608. hlist_for_each_entry_from(__sk, sk_node)
  609. #define sk_nulls_for_each_from(__sk, node) \
  610. if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
  611. hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
  612. #define sk_for_each_safe(__sk, tmp, list) \
  613. hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
  614. #define sk_for_each_bound(__sk, list) \
  615. hlist_for_each_entry(__sk, list, sk_bind_node)
  616. /**
  617. * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
  618. * @tpos: the type * to use as a loop cursor.
  619. * @pos: the &struct hlist_node to use as a loop cursor.
  620. * @head: the head for your list.
  621. * @offset: offset of hlist_node within the struct.
  622. *
  623. */
  624. #define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
  625. for (pos = rcu_dereference((head)->first); \
  626. pos != NULL && \
  627. ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
  628. pos = rcu_dereference(pos->next))
  629. static inline struct user_namespace *sk_user_ns(struct sock *sk)
  630. {
  631. /* Careful only use this in a context where these parameters
  632. * can not change and must all be valid, such as recvmsg from
  633. * userspace.
  634. */
  635. return sk->sk_socket->file->f_cred->user_ns;
  636. }
  637. /* Sock flags */
  638. enum sock_flags {
  639. SOCK_DEAD,
  640. SOCK_DONE,
  641. SOCK_URGINLINE,
  642. SOCK_KEEPOPEN,
  643. SOCK_LINGER,
  644. SOCK_DESTROY,
  645. SOCK_BROADCAST,
  646. SOCK_TIMESTAMP,
  647. SOCK_ZAPPED,
  648. SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
  649. SOCK_DBG, /* %SO_DEBUG setting */
  650. SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
  651. SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
  652. SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
  653. SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
  654. SOCK_MEMALLOC, /* VM depends on this socket for swapping */
  655. SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
  656. SOCK_FASYNC, /* fasync() active */
  657. SOCK_RXQ_OVFL,
  658. SOCK_ZEROCOPY, /* buffers from userspace */
  659. SOCK_WIFI_STATUS, /* push wifi status to userspace */
  660. SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
  661. * Will use last 4 bytes of packet sent from
  662. * user-space instead.
  663. */
  664. SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
  665. SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
  666. SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
  667. };
  668. #define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
  669. static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
  670. {
  671. nsk->sk_flags = osk->sk_flags;
  672. }
  673. static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
  674. {
  675. __set_bit(flag, &sk->sk_flags);
  676. }
  677. static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
  678. {
  679. __clear_bit(flag, &sk->sk_flags);
  680. }
  681. static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
  682. {
  683. return test_bit(flag, &sk->sk_flags);
  684. }
  685. #ifdef CONFIG_NET
  686. extern struct static_key memalloc_socks;
  687. static inline int sk_memalloc_socks(void)
  688. {
  689. return static_key_false(&memalloc_socks);
  690. }
  691. #else
  692. static inline int sk_memalloc_socks(void)
  693. {
  694. return 0;
  695. }
  696. #endif
  697. static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
  698. {
  699. return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
  700. }
  701. static inline void sk_acceptq_removed(struct sock *sk)
  702. {
  703. sk->sk_ack_backlog--;
  704. }
  705. static inline void sk_acceptq_added(struct sock *sk)
  706. {
  707. sk->sk_ack_backlog++;
  708. }
  709. static inline bool sk_acceptq_is_full(const struct sock *sk)
  710. {
  711. return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
  712. }
  713. /*
  714. * Compute minimal free write space needed to queue new packets.
  715. */
  716. static inline int sk_stream_min_wspace(const struct sock *sk)
  717. {
  718. return sk->sk_wmem_queued >> 1;
  719. }
  720. static inline int sk_stream_wspace(const struct sock *sk)
  721. {
  722. return sk->sk_sndbuf - sk->sk_wmem_queued;
  723. }
  724. void sk_stream_write_space(struct sock *sk);
  725. /* OOB backlog add */
  726. static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
  727. {
  728. /* dont let skb dst not refcounted, we are going to leave rcu lock */
  729. skb_dst_force_safe(skb);
  730. if (!sk->sk_backlog.tail)
  731. sk->sk_backlog.head = skb;
  732. else
  733. sk->sk_backlog.tail->next = skb;
  734. sk->sk_backlog.tail = skb;
  735. skb->next = NULL;
  736. }
  737. /*
  738. * Take into account size of receive queue and backlog queue
  739. * Do not take into account this skb truesize,
  740. * to allow even a single big packet to come.
  741. */
  742. static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
  743. {
  744. unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
  745. return qsize > limit;
  746. }
  747. /* The per-socket spinlock must be held here. */
  748. static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
  749. unsigned int limit)
  750. {
  751. if (sk_rcvqueues_full(sk, limit))
  752. return -ENOBUFS;
  753. /*
  754. * If the skb was allocated from pfmemalloc reserves, only
  755. * allow SOCK_MEMALLOC sockets to use it as this socket is
  756. * helping free memory
  757. */
  758. if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
  759. return -ENOMEM;
  760. __sk_add_backlog(sk, skb);
  761. sk->sk_backlog.len += skb->truesize;
  762. return 0;
  763. }
  764. int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
  765. static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
  766. {
  767. if (sk_memalloc_socks() && skb_pfmemalloc(skb))
  768. return __sk_backlog_rcv(sk, skb);
  769. return sk->sk_backlog_rcv(sk, skb);
  770. }
  771. static inline void sk_incoming_cpu_update(struct sock *sk)
  772. {
  773. sk->sk_incoming_cpu = raw_smp_processor_id();
  774. }
  775. static inline void sock_rps_record_flow_hash(__u32 hash)
  776. {
  777. #ifdef CONFIG_RPS
  778. struct rps_sock_flow_table *sock_flow_table;
  779. rcu_read_lock();
  780. sock_flow_table = rcu_dereference(rps_sock_flow_table);
  781. rps_record_sock_flow(sock_flow_table, hash);
  782. rcu_read_unlock();
  783. #endif
  784. }
  785. static inline void sock_rps_record_flow(const struct sock *sk)
  786. {
  787. #ifdef CONFIG_RPS
  788. sock_rps_record_flow_hash(sk->sk_rxhash);
  789. #endif
  790. }
  791. static inline void sock_rps_save_rxhash(struct sock *sk,
  792. const struct sk_buff *skb)
  793. {
  794. #ifdef CONFIG_RPS
  795. if (unlikely(sk->sk_rxhash != skb->hash))
  796. sk->sk_rxhash = skb->hash;
  797. #endif
  798. }
  799. static inline void sock_rps_reset_rxhash(struct sock *sk)
  800. {
  801. #ifdef CONFIG_RPS
  802. sk->sk_rxhash = 0;
  803. #endif
  804. }
  805. #define sk_wait_event(__sk, __timeo, __condition) \
  806. ({ int __rc; \
  807. release_sock(__sk); \
  808. __rc = __condition; \
  809. if (!__rc) { \
  810. *(__timeo) = schedule_timeout(*(__timeo)); \
  811. } \
  812. sched_annotate_sleep(); \
  813. lock_sock(__sk); \
  814. __rc = __condition; \
  815. __rc; \
  816. })
  817. int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
  818. int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
  819. void sk_stream_wait_close(struct sock *sk, long timeo_p);
  820. int sk_stream_error(struct sock *sk, int flags, int err);
  821. void sk_stream_kill_queues(struct sock *sk);
  822. void sk_set_memalloc(struct sock *sk);
  823. void sk_clear_memalloc(struct sock *sk);
  824. int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
  825. struct request_sock_ops;
  826. struct timewait_sock_ops;
  827. struct inet_hashinfo;
  828. struct raw_hashinfo;
  829. struct module;
  830. /*
  831. * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
  832. * un-modified. Special care is taken when initializing object to zero.
  833. */
  834. static inline void sk_prot_clear_nulls(struct sock *sk, int size)
  835. {
  836. if (offsetof(struct sock, sk_node.next) != 0)
  837. memset(sk, 0, offsetof(struct sock, sk_node.next));
  838. memset(&sk->sk_node.pprev, 0,
  839. size - offsetof(struct sock, sk_node.pprev));
  840. }
  841. /* Networking protocol blocks we attach to sockets.
  842. * socket layer -> transport layer interface
  843. */
  844. struct proto {
  845. void (*close)(struct sock *sk,
  846. long timeout);
  847. int (*connect)(struct sock *sk,
  848. struct sockaddr *uaddr,
  849. int addr_len);
  850. int (*disconnect)(struct sock *sk, int flags);
  851. struct sock * (*accept)(struct sock *sk, int flags, int *err);
  852. int (*ioctl)(struct sock *sk, int cmd,
  853. unsigned long arg);
  854. int (*init)(struct sock *sk);
  855. void (*destroy)(struct sock *sk);
  856. void (*shutdown)(struct sock *sk, int how);
  857. int (*setsockopt)(struct sock *sk, int level,
  858. int optname, char __user *optval,
  859. unsigned int optlen);
  860. int (*getsockopt)(struct sock *sk, int level,
  861. int optname, char __user *optval,
  862. int __user *option);
  863. #ifdef CONFIG_COMPAT
  864. int (*compat_setsockopt)(struct sock *sk,
  865. int level,
  866. int optname, char __user *optval,
  867. unsigned int optlen);
  868. int (*compat_getsockopt)(struct sock *sk,
  869. int level,
  870. int optname, char __user *optval,
  871. int __user *option);
  872. int (*compat_ioctl)(struct sock *sk,
  873. unsigned int cmd, unsigned long arg);
  874. #endif
  875. int (*sendmsg)(struct sock *sk, struct msghdr *msg,
  876. size_t len);
  877. int (*recvmsg)(struct sock *sk, struct msghdr *msg,
  878. size_t len, int noblock, int flags,
  879. int *addr_len);
  880. int (*sendpage)(struct sock *sk, struct page *page,
  881. int offset, size_t size, int flags);
  882. int (*bind)(struct sock *sk,
  883. struct sockaddr *uaddr, int addr_len);
  884. int (*backlog_rcv) (struct sock *sk,
  885. struct sk_buff *skb);
  886. void (*release_cb)(struct sock *sk);
  887. /* Keeping track of sk's, looking them up, and port selection methods. */
  888. int (*hash)(struct sock *sk);
  889. void (*unhash)(struct sock *sk);
  890. void (*rehash)(struct sock *sk);
  891. int (*get_port)(struct sock *sk, unsigned short snum);
  892. void (*clear_sk)(struct sock *sk, int size);
  893. /* Keeping track of sockets in use */
  894. #ifdef CONFIG_PROC_FS
  895. unsigned int inuse_idx;
  896. #endif
  897. bool (*stream_memory_free)(const struct sock *sk);
  898. /* Memory pressure */
  899. void (*enter_memory_pressure)(struct sock *sk);
  900. atomic_long_t *memory_allocated; /* Current allocated memory. */
  901. struct percpu_counter *sockets_allocated; /* Current number of sockets. */
  902. /*
  903. * Pressure flag: try to collapse.
  904. * Technical note: it is used by multiple contexts non atomically.
  905. * All the __sk_mem_schedule() is of this nature: accounting
  906. * is strict, actions are advisory and have some latency.
  907. */
  908. int *memory_pressure;
  909. long *sysctl_mem;
  910. int *sysctl_wmem;
  911. int *sysctl_rmem;
  912. int max_header;
  913. bool no_autobind;
  914. struct kmem_cache *slab;
  915. unsigned int obj_size;
  916. int slab_flags;
  917. struct percpu_counter *orphan_count;
  918. struct request_sock_ops *rsk_prot;
  919. struct timewait_sock_ops *twsk_prot;
  920. union {
  921. struct inet_hashinfo *hashinfo;
  922. struct udp_table *udp_table;
  923. struct raw_hashinfo *raw_hash;
  924. } h;
  925. struct module *owner;
  926. char name[32];
  927. struct list_head node;
  928. #ifdef SOCK_REFCNT_DEBUG
  929. atomic_t socks;
  930. #endif
  931. int (*diag_destroy)(struct sock *sk, int err);
  932. };
  933. int proto_register(struct proto *prot, int alloc_slab);
  934. void proto_unregister(struct proto *prot);
  935. #ifdef SOCK_REFCNT_DEBUG
  936. static inline void sk_refcnt_debug_inc(struct sock *sk)
  937. {
  938. atomic_inc(&sk->sk_prot->socks);
  939. }
  940. static inline void sk_refcnt_debug_dec(struct sock *sk)
  941. {
  942. atomic_dec(&sk->sk_prot->socks);
  943. printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
  944. sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
  945. }
  946. static inline void sk_refcnt_debug_release(const struct sock *sk)
  947. {
  948. if (atomic_read(&sk->sk_refcnt) != 1)
  949. printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
  950. sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
  951. }
  952. #else /* SOCK_REFCNT_DEBUG */
  953. #define sk_refcnt_debug_inc(sk) do { } while (0)
  954. #define sk_refcnt_debug_dec(sk) do { } while (0)
  955. #define sk_refcnt_debug_release(sk) do { } while (0)
  956. #endif /* SOCK_REFCNT_DEBUG */
  957. static inline bool sk_stream_memory_free(const struct sock *sk)
  958. {
  959. if (sk->sk_wmem_queued >= sk->sk_sndbuf)
  960. return false;
  961. return sk->sk_prot->stream_memory_free ?
  962. sk->sk_prot->stream_memory_free(sk) : true;
  963. }
  964. static inline bool sk_stream_is_writeable(const struct sock *sk)
  965. {
  966. return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
  967. sk_stream_memory_free(sk);
  968. }
  969. static inline bool sk_has_memory_pressure(const struct sock *sk)
  970. {
  971. return sk->sk_prot->memory_pressure != NULL;
  972. }
  973. static inline bool sk_under_memory_pressure(const struct sock *sk)
  974. {
  975. if (!sk->sk_prot->memory_pressure)
  976. return false;
  977. if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
  978. mem_cgroup_under_socket_pressure(sk->sk_memcg))
  979. return true;
  980. return !!*sk->sk_prot->memory_pressure;
  981. }
  982. static inline void sk_leave_memory_pressure(struct sock *sk)
  983. {
  984. int *memory_pressure = sk->sk_prot->memory_pressure;
  985. if (!memory_pressure)
  986. return;
  987. if (*memory_pressure)
  988. *memory_pressure = 0;
  989. }
  990. static inline void sk_enter_memory_pressure(struct sock *sk)
  991. {
  992. if (!sk->sk_prot->enter_memory_pressure)
  993. return;
  994. sk->sk_prot->enter_memory_pressure(sk);
  995. }
  996. static inline long sk_prot_mem_limits(const struct sock *sk, int index)
  997. {
  998. return sk->sk_prot->sysctl_mem[index];
  999. }
  1000. static inline long
  1001. sk_memory_allocated(const struct sock *sk)
  1002. {
  1003. return atomic_long_read(sk->sk_prot->memory_allocated);
  1004. }
  1005. static inline long
  1006. sk_memory_allocated_add(struct sock *sk, int amt)
  1007. {
  1008. return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
  1009. }
  1010. static inline void
  1011. sk_memory_allocated_sub(struct sock *sk, int amt)
  1012. {
  1013. atomic_long_sub(amt, sk->sk_prot->memory_allocated);
  1014. }
  1015. static inline void sk_sockets_allocated_dec(struct sock *sk)
  1016. {
  1017. percpu_counter_dec(sk->sk_prot->sockets_allocated);
  1018. }
  1019. static inline void sk_sockets_allocated_inc(struct sock *sk)
  1020. {
  1021. percpu_counter_inc(sk->sk_prot->sockets_allocated);
  1022. }
  1023. static inline int
  1024. sk_sockets_allocated_read_positive(struct sock *sk)
  1025. {
  1026. return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
  1027. }
  1028. static inline int
  1029. proto_sockets_allocated_sum_positive(struct proto *prot)
  1030. {
  1031. return percpu_counter_sum_positive(prot->sockets_allocated);
  1032. }
  1033. static inline long
  1034. proto_memory_allocated(struct proto *prot)
  1035. {
  1036. return atomic_long_read(prot->memory_allocated);
  1037. }
  1038. static inline bool
  1039. proto_memory_pressure(struct proto *prot)
  1040. {
  1041. if (!prot->memory_pressure)
  1042. return false;
  1043. return !!*prot->memory_pressure;
  1044. }
  1045. #ifdef CONFIG_PROC_FS
  1046. /* Called with local bh disabled */
  1047. void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
  1048. int sock_prot_inuse_get(struct net *net, struct proto *proto);
  1049. #else
  1050. static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
  1051. int inc)
  1052. {
  1053. }
  1054. #endif
  1055. /* With per-bucket locks this operation is not-atomic, so that
  1056. * this version is not worse.
  1057. */
  1058. static inline int __sk_prot_rehash(struct sock *sk)
  1059. {
  1060. sk->sk_prot->unhash(sk);
  1061. return sk->sk_prot->hash(sk);
  1062. }
  1063. void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
  1064. /* About 10 seconds */
  1065. #define SOCK_DESTROY_TIME (10*HZ)
  1066. /* Sockets 0-1023 can't be bound to unless you are superuser */
  1067. #define PROT_SOCK 1024
  1068. #define SHUTDOWN_MASK 3
  1069. #define RCV_SHUTDOWN 1
  1070. #define SEND_SHUTDOWN 2
  1071. #define SOCK_SNDBUF_LOCK 1
  1072. #define SOCK_RCVBUF_LOCK 2
  1073. #define SOCK_BINDADDR_LOCK 4
  1074. #define SOCK_BINDPORT_LOCK 8
  1075. struct socket_alloc {
  1076. struct socket socket;
  1077. struct inode vfs_inode;
  1078. };
  1079. static inline struct socket *SOCKET_I(struct inode *inode)
  1080. {
  1081. return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
  1082. }
  1083. static inline struct inode *SOCK_INODE(struct socket *socket)
  1084. {
  1085. return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
  1086. }
  1087. /*
  1088. * Functions for memory accounting
  1089. */
  1090. int __sk_mem_schedule(struct sock *sk, int size, int kind);
  1091. void __sk_mem_reclaim(struct sock *sk, int amount);
  1092. #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
  1093. #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
  1094. #define SK_MEM_SEND 0
  1095. #define SK_MEM_RECV 1
  1096. static inline int sk_mem_pages(int amt)
  1097. {
  1098. return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
  1099. }
  1100. static inline bool sk_has_account(struct sock *sk)
  1101. {
  1102. /* return true if protocol supports memory accounting */
  1103. return !!sk->sk_prot->memory_allocated;
  1104. }
  1105. static inline bool sk_wmem_schedule(struct sock *sk, int size)
  1106. {
  1107. if (!sk_has_account(sk))
  1108. return true;
  1109. return size <= sk->sk_forward_alloc ||
  1110. __sk_mem_schedule(sk, size, SK_MEM_SEND);
  1111. }
  1112. static inline bool
  1113. sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
  1114. {
  1115. if (!sk_has_account(sk))
  1116. return true;
  1117. return size<= sk->sk_forward_alloc ||
  1118. __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
  1119. skb_pfmemalloc(skb);
  1120. }
  1121. static inline void sk_mem_reclaim(struct sock *sk)
  1122. {
  1123. if (!sk_has_account(sk))
  1124. return;
  1125. if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
  1126. __sk_mem_reclaim(sk, sk->sk_forward_alloc);
  1127. }
  1128. static inline void sk_mem_reclaim_partial(struct sock *sk)
  1129. {
  1130. if (!sk_has_account(sk))
  1131. return;
  1132. if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
  1133. __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
  1134. }
  1135. static inline void sk_mem_charge(struct sock *sk, int size)
  1136. {
  1137. if (!sk_has_account(sk))
  1138. return;
  1139. sk->sk_forward_alloc -= size;
  1140. }
  1141. static inline void sk_mem_uncharge(struct sock *sk, int size)
  1142. {
  1143. if (!sk_has_account(sk))
  1144. return;
  1145. sk->sk_forward_alloc += size;
  1146. }
  1147. static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
  1148. {
  1149. sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
  1150. sk->sk_wmem_queued -= skb->truesize;
  1151. sk_mem_uncharge(sk, skb->truesize);
  1152. __kfree_skb(skb);
  1153. }
  1154. /* Used by processes to "lock" a socket state, so that
  1155. * interrupts and bottom half handlers won't change it
  1156. * from under us. It essentially blocks any incoming
  1157. * packets, so that we won't get any new data or any
  1158. * packets that change the state of the socket.
  1159. *
  1160. * While locked, BH processing will add new packets to
  1161. * the backlog queue. This queue is processed by the
  1162. * owner of the socket lock right before it is released.
  1163. *
  1164. * Since ~2.3.5 it is also exclusive sleep lock serializing
  1165. * accesses from user process context.
  1166. */
  1167. #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
  1168. static inline void sock_release_ownership(struct sock *sk)
  1169. {
  1170. sk->sk_lock.owned = 0;
  1171. }
  1172. /*
  1173. * Macro so as to not evaluate some arguments when
  1174. * lockdep is not enabled.
  1175. *
  1176. * Mark both the sk_lock and the sk_lock.slock as a
  1177. * per-address-family lock class.
  1178. */
  1179. #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
  1180. do { \
  1181. sk->sk_lock.owned = 0; \
  1182. init_waitqueue_head(&sk->sk_lock.wq); \
  1183. spin_lock_init(&(sk)->sk_lock.slock); \
  1184. debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
  1185. sizeof((sk)->sk_lock)); \
  1186. lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
  1187. (skey), (sname)); \
  1188. lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
  1189. } while (0)
  1190. void lock_sock_nested(struct sock *sk, int subclass);
  1191. static inline void lock_sock(struct sock *sk)
  1192. {
  1193. lock_sock_nested(sk, 0);
  1194. }
  1195. void release_sock(struct sock *sk);
  1196. /* BH context may only use the following locking interface. */
  1197. #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
  1198. #define bh_lock_sock_nested(__sk) \
  1199. spin_lock_nested(&((__sk)->sk_lock.slock), \
  1200. SINGLE_DEPTH_NESTING)
  1201. #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
  1202. bool lock_sock_fast(struct sock *sk);
  1203. /**
  1204. * unlock_sock_fast - complement of lock_sock_fast
  1205. * @sk: socket
  1206. * @slow: slow mode
  1207. *
  1208. * fast unlock socket for user context.
  1209. * If slow mode is on, we call regular release_sock()
  1210. */
  1211. static inline void unlock_sock_fast(struct sock *sk, bool slow)
  1212. {
  1213. if (slow)
  1214. release_sock(sk);
  1215. else
  1216. spin_unlock_bh(&sk->sk_lock.slock);
  1217. }
  1218. struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
  1219. struct proto *prot, int kern);
  1220. void sk_free(struct sock *sk);
  1221. void sk_destruct(struct sock *sk);
  1222. struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
  1223. struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
  1224. gfp_t priority);
  1225. void sock_wfree(struct sk_buff *skb);
  1226. void skb_orphan_partial(struct sk_buff *skb);
  1227. void sock_rfree(struct sk_buff *skb);
  1228. void sock_efree(struct sk_buff *skb);
  1229. #ifdef CONFIG_INET
  1230. void sock_edemux(struct sk_buff *skb);
  1231. #else
  1232. #define sock_edemux(skb) sock_efree(skb)
  1233. #endif
  1234. int sock_setsockopt(struct socket *sock, int level, int op,
  1235. char __user *optval, unsigned int optlen);
  1236. int sock_getsockopt(struct socket *sock, int level, int op,
  1237. char __user *optval, int __user *optlen);
  1238. struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
  1239. int noblock, int *errcode);
  1240. struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
  1241. unsigned long data_len, int noblock,
  1242. int *errcode, int max_page_order);
  1243. void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
  1244. void sock_kfree_s(struct sock *sk, void *mem, int size);
  1245. void sock_kzfree_s(struct sock *sk, void *mem, int size);
  1246. void sk_send_sigurg(struct sock *sk);
  1247. struct sockcm_cookie {
  1248. u32 mark;
  1249. u16 tsflags;
  1250. };
  1251. int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
  1252. struct sockcm_cookie *sockc);
  1253. int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
  1254. struct sockcm_cookie *sockc);
  1255. /*
  1256. * Functions to fill in entries in struct proto_ops when a protocol
  1257. * does not implement a particular function.
  1258. */
  1259. int sock_no_bind(struct socket *, struct sockaddr *, int);
  1260. int sock_no_connect(struct socket *, struct sockaddr *, int, int);
  1261. int sock_no_socketpair(struct socket *, struct socket *);
  1262. int sock_no_accept(struct socket *, struct socket *, int);
  1263. int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
  1264. unsigned int sock_no_poll(struct file *, struct socket *,
  1265. struct poll_table_struct *);
  1266. int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
  1267. int sock_no_listen(struct socket *, int);
  1268. int sock_no_shutdown(struct socket *, int);
  1269. int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
  1270. int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
  1271. int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
  1272. int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
  1273. int sock_no_mmap(struct file *file, struct socket *sock,
  1274. struct vm_area_struct *vma);
  1275. ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
  1276. size_t size, int flags);
  1277. /*
  1278. * Functions to fill in entries in struct proto_ops when a protocol
  1279. * uses the inet style.
  1280. */
  1281. int sock_common_getsockopt(struct socket *sock, int level, int optname,
  1282. char __user *optval, int __user *optlen);
  1283. int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
  1284. int flags);
  1285. int sock_common_setsockopt(struct socket *sock, int level, int optname,
  1286. char __user *optval, unsigned int optlen);
  1287. int compat_sock_common_getsockopt(struct socket *sock, int level,
  1288. int optname, char __user *optval, int __user *optlen);
  1289. int compat_sock_common_setsockopt(struct socket *sock, int level,
  1290. int optname, char __user *optval, unsigned int optlen);
  1291. void sk_common_release(struct sock *sk);
  1292. /*
  1293. * Default socket callbacks and setup code
  1294. */
  1295. /* Initialise core socket variables */
  1296. void sock_init_data(struct socket *sock, struct sock *sk);
  1297. /*
  1298. * Socket reference counting postulates.
  1299. *
  1300. * * Each user of socket SHOULD hold a reference count.
  1301. * * Each access point to socket (an hash table bucket, reference from a list,
  1302. * running timer, skb in flight MUST hold a reference count.
  1303. * * When reference count hits 0, it means it will never increase back.
  1304. * * When reference count hits 0, it means that no references from
  1305. * outside exist to this socket and current process on current CPU
  1306. * is last user and may/should destroy this socket.
  1307. * * sk_free is called from any context: process, BH, IRQ. When
  1308. * it is called, socket has no references from outside -> sk_free
  1309. * may release descendant resources allocated by the socket, but
  1310. * to the time when it is called, socket is NOT referenced by any
  1311. * hash tables, lists etc.
  1312. * * Packets, delivered from outside (from network or from another process)
  1313. * and enqueued on receive/error queues SHOULD NOT grab reference count,
  1314. * when they sit in queue. Otherwise, packets will leak to hole, when
  1315. * socket is looked up by one cpu and unhasing is made by another CPU.
  1316. * It is true for udp/raw, netlink (leak to receive and error queues), tcp
  1317. * (leak to backlog). Packet socket does all the processing inside
  1318. * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
  1319. * use separate SMP lock, so that they are prone too.
  1320. */
  1321. /* Ungrab socket and destroy it, if it was the last reference. */
  1322. static inline void sock_put(struct sock *sk)
  1323. {
  1324. if (atomic_dec_and_test(&sk->sk_refcnt))
  1325. sk_free(sk);
  1326. }
  1327. /* Generic version of sock_put(), dealing with all sockets
  1328. * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
  1329. */
  1330. void sock_gen_put(struct sock *sk);
  1331. int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
  1332. static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
  1333. {
  1334. sk->sk_tx_queue_mapping = tx_queue;
  1335. }
  1336. static inline void sk_tx_queue_clear(struct sock *sk)
  1337. {
  1338. sk->sk_tx_queue_mapping = -1;
  1339. }
  1340. static inline int sk_tx_queue_get(const struct sock *sk)
  1341. {
  1342. return sk ? sk->sk_tx_queue_mapping : -1;
  1343. }
  1344. static inline void sk_set_socket(struct sock *sk, struct socket *sock)
  1345. {
  1346. sk_tx_queue_clear(sk);
  1347. sk->sk_socket = sock;
  1348. }
  1349. static inline wait_queue_head_t *sk_sleep(struct sock *sk)
  1350. {
  1351. BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
  1352. return &rcu_dereference_raw(sk->sk_wq)->wait;
  1353. }
  1354. /* Detach socket from process context.
  1355. * Announce socket dead, detach it from wait queue and inode.
  1356. * Note that parent inode held reference count on this struct sock,
  1357. * we do not release it in this function, because protocol
  1358. * probably wants some additional cleanups or even continuing
  1359. * to work with this socket (TCP).
  1360. */
  1361. static inline void sock_orphan(struct sock *sk)
  1362. {
  1363. write_lock_bh(&sk->sk_callback_lock);
  1364. sock_set_flag(sk, SOCK_DEAD);
  1365. sk_set_socket(sk, NULL);
  1366. sk->sk_wq = NULL;
  1367. write_unlock_bh(&sk->sk_callback_lock);
  1368. }
  1369. static inline void sock_graft(struct sock *sk, struct socket *parent)
  1370. {
  1371. write_lock_bh(&sk->sk_callback_lock);
  1372. sk->sk_wq = parent->wq;
  1373. parent->sk = sk;
  1374. sk_set_socket(sk, parent);
  1375. security_sock_graft(sk, parent);
  1376. write_unlock_bh(&sk->sk_callback_lock);
  1377. }
  1378. kuid_t sock_i_uid(struct sock *sk);
  1379. unsigned long sock_i_ino(struct sock *sk);
  1380. static inline u32 net_tx_rndhash(void)
  1381. {
  1382. u32 v = prandom_u32();
  1383. return v ?: 1;
  1384. }
  1385. static inline void sk_set_txhash(struct sock *sk)
  1386. {
  1387. sk->sk_txhash = net_tx_rndhash();
  1388. }
  1389. static inline void sk_rethink_txhash(struct sock *sk)
  1390. {
  1391. if (sk->sk_txhash)
  1392. sk_set_txhash(sk);
  1393. }
  1394. static inline struct dst_entry *
  1395. __sk_dst_get(struct sock *sk)
  1396. {
  1397. return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
  1398. lockdep_is_held(&sk->sk_lock.slock));
  1399. }
  1400. static inline struct dst_entry *
  1401. sk_dst_get(struct sock *sk)
  1402. {
  1403. struct dst_entry *dst;
  1404. rcu_read_lock();
  1405. dst = rcu_dereference(sk->sk_dst_cache);
  1406. if (dst && !atomic_inc_not_zero(&dst->__refcnt))
  1407. dst = NULL;
  1408. rcu_read_unlock();
  1409. return dst;
  1410. }
  1411. static inline void dst_negative_advice(struct sock *sk)
  1412. {
  1413. struct dst_entry *ndst, *dst = __sk_dst_get(sk);
  1414. sk_rethink_txhash(sk);
  1415. if (dst && dst->ops->negative_advice) {
  1416. ndst = dst->ops->negative_advice(dst);
  1417. if (ndst != dst) {
  1418. rcu_assign_pointer(sk->sk_dst_cache, ndst);
  1419. sk_tx_queue_clear(sk);
  1420. }
  1421. }
  1422. }
  1423. static inline void
  1424. __sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1425. {
  1426. struct dst_entry *old_dst;
  1427. sk_tx_queue_clear(sk);
  1428. /*
  1429. * This can be called while sk is owned by the caller only,
  1430. * with no state that can be checked in a rcu_dereference_check() cond
  1431. */
  1432. old_dst = rcu_dereference_raw(sk->sk_dst_cache);
  1433. rcu_assign_pointer(sk->sk_dst_cache, dst);
  1434. dst_release(old_dst);
  1435. }
  1436. static inline void
  1437. sk_dst_set(struct sock *sk, struct dst_entry *dst)
  1438. {
  1439. struct dst_entry *old_dst;
  1440. sk_tx_queue_clear(sk);
  1441. old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
  1442. dst_release(old_dst);
  1443. }
  1444. static inline void
  1445. __sk_dst_reset(struct sock *sk)
  1446. {
  1447. __sk_dst_set(sk, NULL);
  1448. }
  1449. static inline void
  1450. sk_dst_reset(struct sock *sk)
  1451. {
  1452. sk_dst_set(sk, NULL);
  1453. }
  1454. struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
  1455. struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
  1456. bool sk_mc_loop(struct sock *sk);
  1457. static inline bool sk_can_gso(const struct sock *sk)
  1458. {
  1459. return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
  1460. }
  1461. void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
  1462. static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
  1463. {
  1464. sk->sk_route_nocaps |= flags;
  1465. sk->sk_route_caps &= ~flags;
  1466. }
  1467. static inline bool sk_check_csum_caps(struct sock *sk)
  1468. {
  1469. return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
  1470. (sk->sk_family == PF_INET &&
  1471. (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
  1472. (sk->sk_family == PF_INET6 &&
  1473. (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
  1474. }
  1475. static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
  1476. struct iov_iter *from, char *to,
  1477. int copy, int offset)
  1478. {
  1479. if (skb->ip_summed == CHECKSUM_NONE) {
  1480. __wsum csum = 0;
  1481. if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
  1482. return -EFAULT;
  1483. skb->csum = csum_block_add(skb->csum, csum, offset);
  1484. } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
  1485. if (copy_from_iter_nocache(to, copy, from) != copy)
  1486. return -EFAULT;
  1487. } else if (copy_from_iter(to, copy, from) != copy)
  1488. return -EFAULT;
  1489. return 0;
  1490. }
  1491. static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
  1492. struct iov_iter *from, int copy)
  1493. {
  1494. int err, offset = skb->len;
  1495. err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
  1496. copy, offset);
  1497. if (err)
  1498. __skb_trim(skb, offset);
  1499. return err;
  1500. }
  1501. static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
  1502. struct sk_buff *skb,
  1503. struct page *page,
  1504. int off, int copy)
  1505. {
  1506. int err;
  1507. err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
  1508. copy, skb->len);
  1509. if (err)
  1510. return err;
  1511. skb->len += copy;
  1512. skb->data_len += copy;
  1513. skb->truesize += copy;
  1514. sk->sk_wmem_queued += copy;
  1515. sk_mem_charge(sk, copy);
  1516. return 0;
  1517. }
  1518. /**
  1519. * sk_wmem_alloc_get - returns write allocations
  1520. * @sk: socket
  1521. *
  1522. * Returns sk_wmem_alloc minus initial offset of one
  1523. */
  1524. static inline int sk_wmem_alloc_get(const struct sock *sk)
  1525. {
  1526. return atomic_read(&sk->sk_wmem_alloc) - 1;
  1527. }
  1528. /**
  1529. * sk_rmem_alloc_get - returns read allocations
  1530. * @sk: socket
  1531. *
  1532. * Returns sk_rmem_alloc
  1533. */
  1534. static inline int sk_rmem_alloc_get(const struct sock *sk)
  1535. {
  1536. return atomic_read(&sk->sk_rmem_alloc);
  1537. }
  1538. /**
  1539. * sk_has_allocations - check if allocations are outstanding
  1540. * @sk: socket
  1541. *
  1542. * Returns true if socket has write or read allocations
  1543. */
  1544. static inline bool sk_has_allocations(const struct sock *sk)
  1545. {
  1546. return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
  1547. }
  1548. /**
  1549. * skwq_has_sleeper - check if there are any waiting processes
  1550. * @wq: struct socket_wq
  1551. *
  1552. * Returns true if socket_wq has waiting processes
  1553. *
  1554. * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
  1555. * barrier call. They were added due to the race found within the tcp code.
  1556. *
  1557. * Consider following tcp code paths:
  1558. *
  1559. * CPU1 CPU2
  1560. *
  1561. * sys_select receive packet
  1562. * ... ...
  1563. * __add_wait_queue update tp->rcv_nxt
  1564. * ... ...
  1565. * tp->rcv_nxt check sock_def_readable
  1566. * ... {
  1567. * schedule rcu_read_lock();
  1568. * wq = rcu_dereference(sk->sk_wq);
  1569. * if (wq && waitqueue_active(&wq->wait))
  1570. * wake_up_interruptible(&wq->wait)
  1571. * ...
  1572. * }
  1573. *
  1574. * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
  1575. * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
  1576. * could then endup calling schedule and sleep forever if there are no more
  1577. * data on the socket.
  1578. *
  1579. */
  1580. static inline bool skwq_has_sleeper(struct socket_wq *wq)
  1581. {
  1582. return wq && wq_has_sleeper(&wq->wait);
  1583. }
  1584. /**
  1585. * sock_poll_wait - place memory barrier behind the poll_wait call.
  1586. * @filp: file
  1587. * @wait_address: socket wait queue
  1588. * @p: poll_table
  1589. *
  1590. * See the comments in the wq_has_sleeper function.
  1591. */
  1592. static inline void sock_poll_wait(struct file *filp,
  1593. wait_queue_head_t *wait_address, poll_table *p)
  1594. {
  1595. if (!poll_does_not_wait(p) && wait_address) {
  1596. poll_wait(filp, wait_address, p);
  1597. /* We need to be sure we are in sync with the
  1598. * socket flags modification.
  1599. *
  1600. * This memory barrier is paired in the wq_has_sleeper.
  1601. */
  1602. smp_mb();
  1603. }
  1604. }
  1605. static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
  1606. {
  1607. if (sk->sk_txhash) {
  1608. skb->l4_hash = 1;
  1609. skb->hash = sk->sk_txhash;
  1610. }
  1611. }
  1612. void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
  1613. /*
  1614. * Queue a received datagram if it will fit. Stream and sequenced
  1615. * protocols can't normally use this as they need to fit buffers in
  1616. * and play with them.
  1617. *
  1618. * Inlined as it's very short and called for pretty much every
  1619. * packet ever received.
  1620. */
  1621. static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
  1622. {
  1623. skb_orphan(skb);
  1624. skb->sk = sk;
  1625. skb->destructor = sock_rfree;
  1626. atomic_add(skb->truesize, &sk->sk_rmem_alloc);
  1627. sk_mem_charge(sk, skb->truesize);
  1628. }
  1629. void sk_reset_timer(struct sock *sk, struct timer_list *timer,
  1630. unsigned long expires);
  1631. void sk_stop_timer(struct sock *sk, struct timer_list *timer);
  1632. int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
  1633. int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
  1634. struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
  1635. /*
  1636. * Recover an error report and clear atomically
  1637. */
  1638. static inline int sock_error(struct sock *sk)
  1639. {
  1640. int err;
  1641. if (likely(!sk->sk_err))
  1642. return 0;
  1643. err = xchg(&sk->sk_err, 0);
  1644. return -err;
  1645. }
  1646. static inline unsigned long sock_wspace(struct sock *sk)
  1647. {
  1648. int amt = 0;
  1649. if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
  1650. amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
  1651. if (amt < 0)
  1652. amt = 0;
  1653. }
  1654. return amt;
  1655. }
  1656. /* Note:
  1657. * We use sk->sk_wq_raw, from contexts knowing this
  1658. * pointer is not NULL and cannot disappear/change.
  1659. */
  1660. static inline void sk_set_bit(int nr, struct sock *sk)
  1661. {
  1662. set_bit(nr, &sk->sk_wq_raw->flags);
  1663. }
  1664. static inline void sk_clear_bit(int nr, struct sock *sk)
  1665. {
  1666. clear_bit(nr, &sk->sk_wq_raw->flags);
  1667. }
  1668. static inline void sk_wake_async(const struct sock *sk, int how, int band)
  1669. {
  1670. if (sock_flag(sk, SOCK_FASYNC)) {
  1671. rcu_read_lock();
  1672. sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
  1673. rcu_read_unlock();
  1674. }
  1675. }
  1676. /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
  1677. * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
  1678. * Note: for send buffers, TCP works better if we can build two skbs at
  1679. * minimum.
  1680. */
  1681. #define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
  1682. #define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
  1683. #define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
  1684. static inline void sk_stream_moderate_sndbuf(struct sock *sk)
  1685. {
  1686. if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
  1687. sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
  1688. sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
  1689. }
  1690. }
  1691. struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
  1692. bool force_schedule);
  1693. /**
  1694. * sk_page_frag - return an appropriate page_frag
  1695. * @sk: socket
  1696. *
  1697. * If socket allocation mode allows current thread to sleep, it means its
  1698. * safe to use the per task page_frag instead of the per socket one.
  1699. */
  1700. static inline struct page_frag *sk_page_frag(struct sock *sk)
  1701. {
  1702. if (gfpflags_allow_blocking(sk->sk_allocation))
  1703. return &current->task_frag;
  1704. return &sk->sk_frag;
  1705. }
  1706. bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
  1707. /*
  1708. * Default write policy as shown to user space via poll/select/SIGIO
  1709. */
  1710. static inline bool sock_writeable(const struct sock *sk)
  1711. {
  1712. return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
  1713. }
  1714. static inline gfp_t gfp_any(void)
  1715. {
  1716. return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
  1717. }
  1718. static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
  1719. {
  1720. return noblock ? 0 : sk->sk_rcvtimeo;
  1721. }
  1722. static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
  1723. {
  1724. return noblock ? 0 : sk->sk_sndtimeo;
  1725. }
  1726. static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
  1727. {
  1728. return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
  1729. }
  1730. /* Alas, with timeout socket operations are not restartable.
  1731. * Compare this to poll().
  1732. */
  1733. static inline int sock_intr_errno(long timeo)
  1734. {
  1735. return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
  1736. }
  1737. struct sock_skb_cb {
  1738. u32 dropcount;
  1739. };
  1740. /* Store sock_skb_cb at the end of skb->cb[] so protocol families
  1741. * using skb->cb[] would keep using it directly and utilize its
  1742. * alignement guarantee.
  1743. */
  1744. #define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
  1745. sizeof(struct sock_skb_cb)))
  1746. #define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
  1747. SOCK_SKB_CB_OFFSET))
  1748. #define sock_skb_cb_check_size(size) \
  1749. BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
  1750. static inline void
  1751. sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
  1752. {
  1753. SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
  1754. }
  1755. void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
  1756. struct sk_buff *skb);
  1757. void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
  1758. struct sk_buff *skb);
  1759. static inline void
  1760. sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
  1761. {
  1762. ktime_t kt = skb->tstamp;
  1763. struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
  1764. /*
  1765. * generate control messages if
  1766. * - receive time stamping in software requested
  1767. * - software time stamp available and wanted
  1768. * - hardware time stamps available and wanted
  1769. */
  1770. if (sock_flag(sk, SOCK_RCVTSTAMP) ||
  1771. (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
  1772. (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
  1773. (hwtstamps->hwtstamp.tv64 &&
  1774. (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
  1775. __sock_recv_timestamp(msg, sk, skb);
  1776. else
  1777. sk->sk_stamp = kt;
  1778. if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
  1779. __sock_recv_wifi_status(msg, sk, skb);
  1780. }
  1781. void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
  1782. struct sk_buff *skb);
  1783. static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
  1784. struct sk_buff *skb)
  1785. {
  1786. #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
  1787. (1UL << SOCK_RCVTSTAMP))
  1788. #define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
  1789. SOF_TIMESTAMPING_RAW_HARDWARE)
  1790. if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
  1791. __sock_recv_ts_and_drops(msg, sk, skb);
  1792. else
  1793. sk->sk_stamp = skb->tstamp;
  1794. }
  1795. void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
  1796. /**
  1797. * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
  1798. * @sk: socket sending this packet
  1799. * @tsflags: timestamping flags to use
  1800. * @tx_flags: completed with instructions for time stamping
  1801. *
  1802. * Note : callers should take care of initial *tx_flags value (usually 0)
  1803. */
  1804. static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
  1805. __u8 *tx_flags)
  1806. {
  1807. if (unlikely(tsflags))
  1808. __sock_tx_timestamp(tsflags, tx_flags);
  1809. if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
  1810. *tx_flags |= SKBTX_WIFI_STATUS;
  1811. }
  1812. /**
  1813. * sk_eat_skb - Release a skb if it is no longer needed
  1814. * @sk: socket to eat this skb from
  1815. * @skb: socket buffer to eat
  1816. *
  1817. * This routine must be called with interrupts disabled or with the socket
  1818. * locked so that the sk_buff queue operation is ok.
  1819. */
  1820. static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
  1821. {
  1822. __skb_unlink(skb, &sk->sk_receive_queue);
  1823. __kfree_skb(skb);
  1824. }
  1825. static inline
  1826. struct net *sock_net(const struct sock *sk)
  1827. {
  1828. return read_pnet(&sk->sk_net);
  1829. }
  1830. static inline
  1831. void sock_net_set(struct sock *sk, struct net *net)
  1832. {
  1833. write_pnet(&sk->sk_net, net);
  1834. }
  1835. static inline struct sock *skb_steal_sock(struct sk_buff *skb)
  1836. {
  1837. if (skb->sk) {
  1838. struct sock *sk = skb->sk;
  1839. skb->destructor = NULL;
  1840. skb->sk = NULL;
  1841. return sk;
  1842. }
  1843. return NULL;
  1844. }
  1845. /* This helper checks if a socket is a full socket,
  1846. * ie _not_ a timewait or request socket.
  1847. */
  1848. static inline bool sk_fullsock(const struct sock *sk)
  1849. {
  1850. return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
  1851. }
  1852. /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
  1853. * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
  1854. */
  1855. static inline bool sk_listener(const struct sock *sk)
  1856. {
  1857. return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
  1858. }
  1859. /**
  1860. * sk_state_load - read sk->sk_state for lockless contexts
  1861. * @sk: socket pointer
  1862. *
  1863. * Paired with sk_state_store(). Used in places we do not hold socket lock :
  1864. * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
  1865. */
  1866. static inline int sk_state_load(const struct sock *sk)
  1867. {
  1868. return smp_load_acquire(&sk->sk_state);
  1869. }
  1870. /**
  1871. * sk_state_store - update sk->sk_state
  1872. * @sk: socket pointer
  1873. * @newstate: new state
  1874. *
  1875. * Paired with sk_state_load(). Should be used in contexts where
  1876. * state change might impact lockless readers.
  1877. */
  1878. static inline void sk_state_store(struct sock *sk, int newstate)
  1879. {
  1880. smp_store_release(&sk->sk_state, newstate);
  1881. }
  1882. void sock_enable_timestamp(struct sock *sk, int flag);
  1883. int sock_get_timestamp(struct sock *, struct timeval __user *);
  1884. int sock_get_timestampns(struct sock *, struct timespec __user *);
  1885. int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
  1886. int type);
  1887. bool sk_ns_capable(const struct sock *sk,
  1888. struct user_namespace *user_ns, int cap);
  1889. bool sk_capable(const struct sock *sk, int cap);
  1890. bool sk_net_capable(const struct sock *sk, int cap);
  1891. extern __u32 sysctl_wmem_max;
  1892. extern __u32 sysctl_rmem_max;
  1893. extern int sysctl_tstamp_allow_data;
  1894. extern int sysctl_optmem_max;
  1895. extern __u32 sysctl_wmem_default;
  1896. extern __u32 sysctl_rmem_default;
  1897. #endif /* _SOCK_H */