sock.h 63 KB

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