sock.h 63 KB

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