sock.h 64 KB

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