sock.h 64 KB

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