sock.h 63 KB

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