sock.h 62 KB

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