sock.h 62 KB

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