sock.h 64 KB

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