sock.h 64 KB

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