sock.h 63 KB

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