sock.h 69 KB

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