sock.h 63 KB

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