blob: 0ca22b014de1a0a31e539a89e35fa5cc14875384 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * 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
Alexey Dobriyana6b7a402011-06-06 10:43:46 +000043#include <linux/hardirq.h>
Ilpo Järvinen172589c2007-08-28 15:50:33 -070044#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/list.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080046#include <linux/list_nulls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/timer.h>
48#include <linux/cache.h>
Glauber Costa3f134612012-05-29 15:07:11 -070049#include <linux/bitops.h>
Ingo Molnara5b5bb92006-07-03 00:25:35 -070050#include <linux/lockdep.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/netdevice.h>
52#include <linux/skbuff.h> /* struct sk_buff */
Al Virod7fe0f22006-12-03 23:15:30 -050053#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090055#include <linux/slab.h>
Tom Herbertc6e1a0d2011-04-04 22:30:30 -070056#include <linux/uaccess.h>
Johannes Weiner3e32cb22014-12-10 15:42:31 -080057#include <linux/page_counter.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000058#include <linux/memcontrol.h>
Ingo Molnarc5905af2012-02-24 08:31:31 +010059#include <linux/static_key.h>
Al Viro40401532012-02-13 03:58:52 +000060#include <linux/sched.h>
Herbert Xu1ce0bf52015-11-26 13:55:39 +080061#include <linux/wait.h>
Tejun Heo2a56a1f2015-12-07 17:38:52 -050062#include <linux/cgroup-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080065#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000066#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Eric Dumazetc31504d2010-11-15 19:58:26 +000068#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <net/dst.h>
70#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070071#include <net/tcp_states.h>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040072#include <linux/net_tstamp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Eric Dumazet9f048bf2011-12-13 03:59:08 +000074struct cgroup;
75struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000076#ifdef CONFIG_NET
Glauber Costa1d62e432012-04-09 19:36:33 -030077int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
78void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
Glauber Costac607b2e2011-12-16 00:52:00 +000079#else
80static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030081int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
Glauber Costac607b2e2011-12-16 00:52:00 +000082{
83 return 0;
84}
85static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030086void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
Glauber Costac607b2e2011-12-16 00:52:00 +000087{
88}
89#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/*
91 * This structure really needs to be cleaned up.
92 * Most of it is for TCP, and not used by any of
93 * the other protocols.
94 */
95
96/* Define this to get the SOCK_DBG debugging facility. */
97#define SOCK_DEBUGGING
98#ifdef SOCK_DEBUGGING
99#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
100 printk(KERN_DEBUG msg); } while (0)
101#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700102/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -0700103static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000104void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700105{
106}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#endif
108
109/* This is the per-socket lock. The spinlock provides a synchronization
110 * between user contexts and software interrupt processing, whereas the
111 * mini-semaphore synchronizes multiple users amongst themselves.
112 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113typedef struct {
114 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200115 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700117 /*
118 * We express the mutex-alike socket_lock semantics
119 * to the lock validator by explicitly managing
120 * the slock as a lock variant (in addition to
121 * the slock itself):
122 */
123#ifdef CONFIG_DEBUG_LOCK_ALLOC
124 struct lockdep_map dep_map;
125#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126} socket_lock_t;
127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700129struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800130struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Eric Dumazet077b3932012-12-02 07:33:10 +0000132typedef __u32 __bitwise __portpair;
133typedef __u64 __bitwise __addrpair;
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700136 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000137 * @skc_daddr: Foreign IPv4 addr
138 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000139 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000140 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000141 * @skc_dport: placeholder for inet_dport/tw_dport
142 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700143 * @skc_family: network address family
144 * @skc_state: Connection state
145 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000146 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700147 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700148 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000149 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700150 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200151 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000152 * @skc_node: main hash linkage for various protocol lookup tables
153 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
154 * @skc_tx_queue_mapping: tx queue number for this connection
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700155 * @skc_flags: place holder for sk_flags
156 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
157 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700158 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000159 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700160 *
161 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700162 * for struct sock and struct inet_timewait_sock.
163 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000165 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700166 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000167 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000168 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000169 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000170 struct {
171 __be32 skc_daddr;
172 __be32 skc_rcv_saddr;
173 };
174 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000175 union {
176 unsigned int skc_hash;
177 __u16 skc_u16hashes[2];
178 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000179 /* skc_dport && skc_num must be grouped as well */
180 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000181 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000182 struct {
183 __be16 skc_dport;
184 __u16 skc_num;
185 };
186 };
187
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000188 unsigned short skc_family;
189 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000190 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700191 unsigned char skc_reuseport:1;
192 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500193 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000194 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000195 union {
196 struct hlist_node skc_bind_node;
197 struct hlist_nulls_node skc_portaddr_node;
198 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700199 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500200 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700201
202#if IS_ENABLED(CONFIG_IPV6)
203 struct in6_addr skc_v6_daddr;
204 struct in6_addr skc_v6_rcv_saddr;
205#endif
206
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700207 atomic64_t skc_cookie;
208
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700209 /* following fields are padding to force
210 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
211 * assuming IPV6 is enabled. We use this padding differently
212 * for different kind of 'sockets'
213 */
214 union {
215 unsigned long skc_flags;
216 struct sock *skc_listener; /* request_sock */
217 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
218 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000219 /*
220 * fields between dontcopy_begin/dontcopy_end
221 * are not copied in sock_copy()
222 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000223 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000224 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000225 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000226 union {
227 struct hlist_node skc_node;
228 struct hlist_nulls_node skc_nulls_node;
229 };
230 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700231 union {
232 int skc_incoming_cpu;
233 u32 skc_rcv_wnd;
Eric Dumazetd475f092015-10-08 19:33:24 -0700234 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700235 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700236
Eric Dumazet68835ab2010-11-30 19:04:07 +0000237 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000238 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000239 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700240 union {
241 u32 skc_rxhash;
242 u32 skc_window_clamp;
Eric Dumazetd475f092015-10-08 19:33:24 -0700243 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700244 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000245 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246};
247
Glauber Costae1aab162011-12-11 21:47:03 +0000248struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249/**
250 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700251 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700252 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
253 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
254 * @sk_lock: synchronizer
255 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000256 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500257 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700258 * @sk_dst_cache: destination cache
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700259 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700260 * @sk_receive_queue: incoming packets
261 * @sk_wmem_alloc: transmit queue bytes committed
262 * @sk_write_queue: Packet sending queue
263 * @sk_omem_alloc: "o" is "option" or "other"
264 * @sk_wmem_queued: persistent queue size
265 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300266 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300267 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700268 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700269 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700270 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700271 * @sk_sndbuf: size of send buffer in bytes
Tom Herbert28448b82014-05-23 08:47:19 -0700272 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
273 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700274 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700275 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700276 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700277 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000278 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700279 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700280 * @sk_backlog: always used with the per-socket spinlock held
281 * @sk_callback_lock: used with the callbacks in the end of this struct
282 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800283 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
284 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700285 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800286 * @sk_err_soft: errors that don't cause failure but are the cause of a
287 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700288 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700289 * @sk_ack_backlog: current listen backlog
290 * @sk_max_ack_backlog: listen backlog set in listen()
291 * @sk_priority: %SO_PRIORITY setting
292 * @sk_type: socket type (%SOCK_STREAM, etc)
293 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000294 * @sk_peer_pid: &struct pid for this socket's peer
295 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700296 * @sk_rcvlowat: %SO_RCVLOWAT setting
297 * @sk_rcvtimeo: %SO_RCVTIMEO setting
298 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700299 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700300 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700301 * @sk_timer: sock cleanup timer
302 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400303 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400304 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700305 * @sk_socket: Identd and reporting IO signals
306 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000307 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000308 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700309 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700310 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800311 * @sk_mark: generic packet mark
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500312 * @sk_cgrp_data: cgroup data for this cgroup
Glauber Costae1aab162011-12-11 21:47:03 +0000313 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700314 * @sk_write_pending: a write to stream socket waits to start
315 * @sk_state_change: callback to indicate change in the state of the sock
316 * @sk_data_ready: callback to indicate there is data to be processed
317 * @sk_write_space: callback to indicate there is bf sending space available
318 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
319 * @sk_backlog_rcv: callback to process the backlog
320 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 */
322struct sock {
323 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700324 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 * don't add nothing before this first member (__sk_common) --acme
326 */
327 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000328#define sk_node __sk_common.skc_node
329#define sk_nulls_node __sk_common.skc_nulls_node
330#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000331#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000332
Eric Dumazet68835ab2010-11-30 19:04:07 +0000333#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
334#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000335#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700336#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700337#define sk_num __sk_common.skc_num
338#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700339#define sk_addrpair __sk_common.skc_addrpair
340#define sk_daddr __sk_common.skc_daddr
341#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342#define sk_family __sk_common.skc_family
343#define sk_state __sk_common.skc_state
344#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000345#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700346#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500347#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700350#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200351#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700352#define sk_v6_daddr __sk_common.skc_v6_daddr
353#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700354#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700355#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700356#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700357#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700358
Eric Dumazetb178bb32010-11-16 05:56:04 +0000359 socket_lock_t sk_lock;
360 struct sk_buff_head sk_receive_queue;
361 /*
362 * The backlog queue is special, it is always used with
363 * the per-socket spinlock held and requires low latency
364 * access. Therefore we special case it's implementation.
365 * Note : rmem_alloc is in this structure to fill a hole
366 * on 64bit arches, not because its logically part of
367 * backlog.
368 */
369 struct {
370 atomic_t rmem_alloc;
371 int len;
372 struct sk_buff *head;
373 struct sk_buff *tail;
374 } sk_backlog;
375#define sk_rmem_alloc sk_backlog.rmem_alloc
376 int sk_forward_alloc;
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800377
Tom Herbertb73c3d02014-07-01 21:32:17 -0700378 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800379#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300380 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300381 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300382#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000383 atomic_t sk_drops;
384 int sk_rcvbuf;
385
386 struct sk_filter __rcu *sk_filter;
Eric Dumazetceb5d582015-11-29 20:03:11 -0800387 union {
388 struct socket_wq __rcu *sk_wq;
389 struct socket_wq *sk_wq_raw;
390 };
Eric Dumazetb178bb32010-11-16 05:56:04 +0000391#ifdef CONFIG_XFRM
392 struct xfrm_policy *sk_policy[2];
393#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000394 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000395 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazet6bd4f352015-12-02 21:53:57 -0800396 /* Note: 32bit hole on 64bit arches */
Eric Dumazetb178bb32010-11-16 05:56:04 +0000397 atomic_t sk_wmem_alloc;
398 atomic_t sk_omem_alloc;
399 int sk_sndbuf;
400 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100401 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000402 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700403 sk_no_check_tx : 1,
404 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000405 sk_userlocks : 4,
406 sk_protocol : 8,
407 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100408 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400410 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700411 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700412 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000413 netdev_features_t sk_route_caps;
414 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700415 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700416 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000417 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800418 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700421 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 rwlock_t sk_callback_lock;
423 int sk_err,
424 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700425 u32 sk_ack_backlog;
426 u32 sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 __u32 sk_priority;
Tejun Heo297dbde2015-12-07 17:38:51 -0500428 __u32 sk_mark;
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000429 struct pid *sk_peer_pid;
430 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 long sk_rcvtimeo;
432 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700434 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400435 u16 sk_tsflags;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400436 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct socket *sk_socket;
438 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000439 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000441 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800443#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800445#endif
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500446 struct sock_cgroup_data sk_cgrp_data;
Glauber Costae1aab162011-12-11 21:47:03 +0000447 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400449 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 void (*sk_write_space)(struct sock *sk);
451 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000452 int (*sk_backlog_rcv)(struct sock *sk,
453 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 void (*sk_destruct)(struct sock *sk);
455};
456
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700457#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
458
459#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
460#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
461
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000462/*
463 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
464 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
465 * on a socket means that the socket will reuse everybody else's port
466 * without looking at the other's sk_reuse value.
467 */
468
469#define SK_NO_REUSE 0
470#define SK_CAN_REUSE 1
471#define SK_FORCE_REUSE 2
472
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000473static inline int sk_peek_offset(struct sock *sk, int flags)
474{
475 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
476 return sk->sk_peek_off;
477 else
478 return 0;
479}
480
481static inline void sk_peek_offset_bwd(struct sock *sk, int val)
482{
483 if (sk->sk_peek_off >= 0) {
484 if (sk->sk_peek_off >= val)
485 sk->sk_peek_off -= val;
486 else
487 sk->sk_peek_off = 0;
488 }
489}
490
491static inline void sk_peek_offset_fwd(struct sock *sk, int val)
492{
493 if (sk->sk_peek_off >= 0)
494 sk->sk_peek_off += val;
495}
496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497/*
498 * Hashed lists helper routines
499 */
Li Zefanc4146642010-02-08 23:18:45 +0000500static inline struct sock *sk_entry(const struct hlist_node *node)
501{
502 return hlist_entry(node, struct sock, sk_node);
503}
504
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700505static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
507 return hlist_entry(head->first, struct sock, sk_node);
508}
509
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700510static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
512 return hlist_empty(head) ? NULL : __sk_head(head);
513}
514
Eric Dumazet88ab1932008-11-16 19:39:21 -0800515static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
516{
517 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
518}
519
520static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
521{
522 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
523}
524
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700525static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 return sk->sk_node.next ?
528 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
529}
530
Eric Dumazet88ab1932008-11-16 19:39:21 -0800531static inline struct sock *sk_nulls_next(const struct sock *sk)
532{
533 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
534 hlist_nulls_entry(sk->sk_nulls_node.next,
535 struct sock, sk_nulls_node) :
536 NULL;
537}
538
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000539static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
541 return hlist_unhashed(&sk->sk_node);
542}
543
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000544static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
Akinobu Mitada753be2006-04-28 15:21:23 -0700546 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
548
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000549static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
551 node->pprev = NULL;
552}
553
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000554static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800555{
556 node->pprev = NULL;
557}
558
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000559static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
561 __hlist_del(&sk->sk_node);
562}
563
stephen hemminger808f5112010-02-22 07:57:18 +0000564/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000565static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
567 if (sk_hashed(sk)) {
568 __sk_del_node(sk);
569 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000570 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000572 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}
574
575/* Grab socket reference count. This operation is valid only
576 when sk is ALREADY grabbed f.e. it is found in hash table
577 or a list and the lookup is made under lock preventing hash table
578 modifications.
579 */
580
581static inline void sock_hold(struct sock *sk)
582{
583 atomic_inc(&sk->sk_refcnt);
584}
585
586/* Ungrab socket in the context, which assumes that socket refcnt
587 cannot hit zero, f.e. it is true in context of any socketcall.
588 */
589static inline void __sock_put(struct sock *sk)
590{
591 atomic_dec(&sk->sk_refcnt);
592}
593
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000594static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000596 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598 if (rc) {
599 /* paranoid for a while -acme */
600 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
601 __sock_put(sk);
602 }
603 return rc;
604}
stephen hemminger808f5112010-02-22 07:57:18 +0000605#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000607static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700608{
609 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800610 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000611 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700612 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000613 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700614}
615
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000616static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700617{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000618 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700619
620 if (rc) {
621 /* paranoid for a while -acme */
622 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
623 __sock_put(sk);
624 }
625 return rc;
626}
627
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000628static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
630 hlist_add_head(&sk->sk_node, list);
631}
632
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000633static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
635 sock_hold(sk);
636 __sk_add_node(sk, list);
637}
638
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000639static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000640{
641 sock_hold(sk);
642 hlist_add_head_rcu(&sk->sk_node, list);
643}
644
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000645static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700646{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800647 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700648}
649
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000650static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700651{
652 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800653 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700654}
655
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000656static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
658 __hlist_del(&sk->sk_bind_node);
659}
660
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000661static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 struct hlist_head *list)
663{
664 hlist_add_head(&sk->sk_bind_node, list);
665}
666
Sasha Levinb67bfe02013-02-27 17:06:00 -0800667#define sk_for_each(__sk, list) \
668 hlist_for_each_entry(__sk, list, sk_node)
669#define sk_for_each_rcu(__sk, list) \
670 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800671#define sk_nulls_for_each(__sk, node, list) \
672 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
673#define sk_nulls_for_each_rcu(__sk, node, list) \
674 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800675#define sk_for_each_from(__sk) \
676 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800677#define sk_nulls_for_each_from(__sk, node) \
678 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
679 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800680#define sk_for_each_safe(__sk, tmp, list) \
681 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
682#define sk_for_each_bound(__sk, list) \
683 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
David Held2dc41cf2014-07-15 23:28:32 -0400685/**
686 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
687 * @tpos: the type * to use as a loop cursor.
688 * @pos: the &struct hlist_node to use as a loop cursor.
689 * @head: the head for your list.
690 * @offset: offset of hlist_node within the struct.
691 *
692 */
693#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
694 for (pos = (head)->first; \
695 (!is_a_nulls(pos)) && \
696 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
697 pos = pos->next)
698
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600699static inline struct user_namespace *sk_user_ns(struct sock *sk)
700{
701 /* Careful only use this in a context where these parameters
702 * can not change and must all be valid, such as recvmsg from
703 * userspace.
704 */
705 return sk->sk_socket->file->f_cred->user_ns;
706}
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708/* Sock flags */
709enum sock_flags {
710 SOCK_DEAD,
711 SOCK_DONE,
712 SOCK_URGINLINE,
713 SOCK_KEEPOPEN,
714 SOCK_LINGER,
715 SOCK_DESTROY,
716 SOCK_BROADCAST,
717 SOCK_TIMESTAMP,
718 SOCK_ZAPPED,
719 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
720 SOCK_DBG, /* %SO_DEBUG setting */
721 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700722 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
724 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700725 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000726 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700727 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700728 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000729 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100730 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000731 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
732 * Will use last 4 bytes of packet sent from
733 * user-space instead.
734 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100735 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000736 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737};
738
Ralf Baechle53b924b2005-08-23 10:11:30 -0700739static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
740{
741 nsk->sk_flags = osk->sk_flags;
742}
743
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
745{
746 __set_bit(flag, &sk->sk_flags);
747}
748
749static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
750{
751 __clear_bit(flag, &sk->sk_flags);
752}
753
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000754static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
756 return test_bit(flag, &sk->sk_flags);
757}
758
Mel Gormanc93bdd02012-07-31 16:44:19 -0700759#ifdef CONFIG_NET
760extern struct static_key memalloc_socks;
761static inline int sk_memalloc_socks(void)
762{
763 return static_key_false(&memalloc_socks);
764}
765#else
766
767static inline int sk_memalloc_socks(void)
768{
769 return 0;
770}
771
772#endif
773
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800774static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700775{
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800776 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700777}
778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779static inline void sk_acceptq_removed(struct sock *sk)
780{
781 sk->sk_ack_backlog--;
782}
783
784static inline void sk_acceptq_added(struct sock *sk)
785{
786 sk->sk_ack_backlog++;
787}
788
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000789static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
David S. Miller64a14652007-03-06 11:21:05 -0800791 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792}
793
794/*
795 * Compute minimal free write space needed to queue new packets.
796 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000797static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800799 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000802static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
804 return sk->sk_sndbuf - sk->sk_wmem_queued;
805}
806
Joe Perches69336bd2013-09-22 10:32:26 -0700807void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Zhu Yi8eae9392010-03-04 18:01:40 +0000809/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000810static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800811{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000812 /* dont let skb dst not refcounted, we are going to leave rcu lock */
813 skb_dst_force(skb);
814
815 if (!sk->sk_backlog.tail)
816 sk->sk_backlog.head = skb;
817 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800818 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000819
820 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800821 skb->next = NULL;
822}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Eric Dumazetc3774112010-04-27 15:13:20 -0700824/*
825 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000826 * Do not take into account this skb truesize,
827 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700828 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300829static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700830{
831 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
832
Eric Dumazetf545a382012-04-22 23:34:26 +0000833 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700834}
835
Zhu Yi8eae9392010-03-04 18:01:40 +0000836/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000837static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
838 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000839{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300840 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000841 return -ENOBUFS;
842
Eric Dumazetc7c49b82015-09-29 18:52:25 -0700843 /*
844 * If the skb was allocated from pfmemalloc reserves, only
845 * allow SOCK_MEMALLOC sockets to use it as this socket is
846 * helping free memory
847 */
848 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
849 return -ENOMEM;
850
Zhu Yia3a858f2010-03-04 18:01:47 +0000851 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000852 sk->sk_backlog.len += skb->truesize;
853 return 0;
854}
855
Joe Perches69336bd2013-09-22 10:32:26 -0700856int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700857
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700858static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
859{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700860 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
861 return __sk_backlog_rcv(sk, skb);
862
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700863 return sk->sk_backlog_rcv(sk, skb);
864}
865
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800866static inline void sk_incoming_cpu_update(struct sock *sk)
867{
868 sk->sk_incoming_cpu = raw_smp_processor_id();
869}
870
Tom Herbertfe477552013-12-22 18:54:31 +0800871static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700872{
873#ifdef CONFIG_RPS
874 struct rps_sock_flow_table *sock_flow_table;
875
876 rcu_read_lock();
877 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800878 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700879 rcu_read_unlock();
880#endif
881}
882
Tom Herbertfe477552013-12-22 18:54:31 +0800883static inline void sock_rps_record_flow(const struct sock *sk)
884{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800885#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800886 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800887#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800888}
889
Tom Herbertbdeab992011-08-14 19:45:55 +0000890static inline void sock_rps_save_rxhash(struct sock *sk,
891 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700892{
893#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800894 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700895 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700896#endif
897}
898
Tom Herbertbdeab992011-08-14 19:45:55 +0000899static inline void sock_rps_reset_rxhash(struct sock *sk)
900{
901#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000902 sk->sk_rxhash = 0;
903#endif
904}
905
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700906#define sk_wait_event(__sk, __timeo, __condition) \
907 ({ int __rc; \
908 release_sock(__sk); \
909 __rc = __condition; \
910 if (!__rc) { \
911 *(__timeo) = schedule_timeout(*(__timeo)); \
912 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200913 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700914 lock_sock(__sk); \
915 __rc = __condition; \
916 __rc; \
917 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Joe Perches69336bd2013-09-22 10:32:26 -0700919int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
920int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
921void sk_stream_wait_close(struct sock *sk, long timeo_p);
922int sk_stream_error(struct sock *sk, int flags, int err);
923void sk_stream_kill_queues(struct sock *sk);
924void sk_set_memalloc(struct sock *sk);
925void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +0200927int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700929struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800930struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800931struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700932struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400933struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700934
Eric Dumazetf77d6022013-05-09 10:28:16 +0000935/*
936 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
937 * un-modified. Special care is taken when initializing object to zero.
938 */
939static inline void sk_prot_clear_nulls(struct sock *sk, int size)
940{
941 if (offsetof(struct sock, sk_node.next) != 0)
942 memset(sk, 0, offsetof(struct sock, sk_node.next));
943 memset(&sk->sk_node.pprev, 0,
944 size - offsetof(struct sock, sk_node.pprev));
945}
946
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947/* Networking protocol blocks we attach to sockets.
948 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 */
950struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000951 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 long timeout);
953 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000954 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 int addr_len);
956 int (*disconnect)(struct sock *sk, int flags);
957
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000958 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
960 int (*ioctl)(struct sock *sk, int cmd,
961 unsigned long arg);
962 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700963 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000965 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700967 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000968 int (*getsockopt)(struct sock *sk, int level,
969 int optname, char __user *optval,
970 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700971#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800972 int (*compat_setsockopt)(struct sock *sk,
973 int level,
974 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700975 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800976 int (*compat_getsockopt)(struct sock *sk,
977 int level,
978 int optname, char __user *optval,
979 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000980 int (*compat_ioctl)(struct sock *sk,
981 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700982#endif
Ying Xue1b784142015-03-02 15:37:48 +0800983 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
984 size_t len);
985 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000986 size_t len, int noblock, int flags,
987 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 int (*sendpage)(struct sock *sk, struct page *page,
989 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000990 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 struct sockaddr *uaddr, int addr_len);
992
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000993 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 struct sk_buff *skb);
995
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000996 void (*release_cb)(struct sock *sk);
997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 /* Keeping track of sk's, looking them up, and port selection methods. */
999 void (*hash)(struct sock *sk);
1000 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +00001001 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001003 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001005 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001006#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001007 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001008#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001009
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001010 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001012 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001013 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001014 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 /*
1016 * Pressure flag: try to collapse.
1017 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001018 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 * is strict, actions are advisory and have some latency.
1020 */
1021 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001022 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 int *sysctl_wmem;
1024 int *sysctl_rmem;
1025 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001026 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Eric Dumazet271b72c2008-10-29 02:11:14 -07001028 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001030 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Eric Dumazetdd24c002008-11-25 21:17:14 -08001032 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001033
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001034 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001035 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001036
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001037 union {
1038 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001039 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001040 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001041 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 struct module *owner;
1044
1045 char name[32];
1046
1047 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001048#ifdef SOCK_REFCNT_DEBUG
1049 atomic_t socks;
1050#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001051#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001052 /*
1053 * cgroup specific init/deinit functions. Called once for all
1054 * protocols that implement it, from cgroups populate function.
1055 * This function has to setup any files the protocol want to
1056 * appear in the kmem cgroup filesystem.
1057 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001058 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001059 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001060 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001061 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1062#endif
1063};
1064
Joe Perches69336bd2013-09-22 10:32:26 -07001065int proto_register(struct proto *prot, int alloc_slab);
1066void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001068#ifdef SOCK_REFCNT_DEBUG
1069static inline void sk_refcnt_debug_inc(struct sock *sk)
1070{
1071 atomic_inc(&sk->sk_prot->socks);
1072}
1073
1074static inline void sk_refcnt_debug_dec(struct sock *sk)
1075{
1076 atomic_dec(&sk->sk_prot->socks);
1077 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1078 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1079}
1080
Ying Xuedec34fb2013-02-15 22:28:25 +00001081static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001082{
1083 if (atomic_read(&sk->sk_refcnt) != 1)
1084 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1085 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1086}
1087#else /* SOCK_REFCNT_DEBUG */
1088#define sk_refcnt_debug_inc(sk) do { } while (0)
1089#define sk_refcnt_debug_dec(sk) do { } while (0)
1090#define sk_refcnt_debug_release(sk) do { } while (0)
1091#endif /* SOCK_REFCNT_DEBUG */
1092
Andrew Mortonc255a452012-07-31 16:43:02 -07001093#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001094extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001095static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1096 struct cg_proto *cg_proto)
1097{
1098 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1099}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001100#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001101#else
1102#define mem_cgroup_sockets_enabled 0
1103static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1104 struct cg_proto *cg_proto)
1105{
1106 return NULL;
1107}
1108#endif
1109
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001110static inline bool sk_stream_memory_free(const struct sock *sk)
1111{
1112 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1113 return false;
1114
1115 return sk->sk_prot->stream_memory_free ?
1116 sk->sk_prot->stream_memory_free(sk) : true;
1117}
1118
Eric Dumazet64dc6132013-07-22 20:26:31 -07001119static inline bool sk_stream_is_writeable(const struct sock *sk)
1120{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001121 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1122 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001123}
Glauber Costae1aab162011-12-11 21:47:03 +00001124
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001125
Glauber Costa180d8cd2011-12-11 21:47:02 +00001126static inline bool sk_has_memory_pressure(const struct sock *sk)
1127{
1128 return sk->sk_prot->memory_pressure != NULL;
1129}
1130
1131static inline bool sk_under_memory_pressure(const struct sock *sk)
1132{
1133 if (!sk->sk_prot->memory_pressure)
1134 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001135
1136 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001137 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001138
Christoph Paasch35b87f62013-10-23 12:49:21 -07001139 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001140}
1141
1142static inline void sk_leave_memory_pressure(struct sock *sk)
1143{
1144 int *memory_pressure = sk->sk_prot->memory_pressure;
1145
Glauber Costae1aab162011-12-11 21:47:03 +00001146 if (!memory_pressure)
1147 return;
1148
1149 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001150 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001151
1152 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1153 struct cg_proto *cg_proto = sk->sk_cgrp;
1154 struct proto *prot = sk->sk_prot;
1155
1156 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001157 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001158 }
1159
Glauber Costa180d8cd2011-12-11 21:47:02 +00001160}
1161
1162static inline void sk_enter_memory_pressure(struct sock *sk)
1163{
Glauber Costae1aab162011-12-11 21:47:03 +00001164 if (!sk->sk_prot->enter_memory_pressure)
1165 return;
1166
1167 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1168 struct cg_proto *cg_proto = sk->sk_cgrp;
1169 struct proto *prot = sk->sk_prot;
1170
1171 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001172 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001173 }
1174
1175 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001176}
1177
1178static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1179{
1180 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001181 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1182 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001183 return prot[index];
1184}
1185
Glauber Costae1aab162011-12-11 21:47:03 +00001186static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1187 unsigned long amt,
1188 int *parent_status)
1189{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001190 page_counter_charge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001191
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001192 if (page_counter_read(&prot->memory_allocated) >
1193 prot->memory_allocated.limit)
Glauber Costae1aab162011-12-11 21:47:03 +00001194 *parent_status = OVER_LIMIT;
1195}
1196
1197static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1198 unsigned long amt)
1199{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001200 page_counter_uncharge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001201}
1202
Glauber Costa180d8cd2011-12-11 21:47:02 +00001203static inline long
1204sk_memory_allocated(const struct sock *sk)
1205{
1206 struct proto *prot = sk->sk_prot;
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001207
Glauber Costae1aab162011-12-11 21:47:03 +00001208 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001209 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001210
Glauber Costa180d8cd2011-12-11 21:47:02 +00001211 return atomic_long_read(prot->memory_allocated);
1212}
1213
1214static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001215sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001216{
1217 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001218
1219 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1220 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1221 /* update the root cgroup regardless */
1222 atomic_long_add_return(amt, prot->memory_allocated);
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001223 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001224 }
1225
Glauber Costa180d8cd2011-12-11 21:47:02 +00001226 return atomic_long_add_return(amt, prot->memory_allocated);
1227}
1228
1229static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001230sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001231{
1232 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001233
Glauber Costa0e90b312012-01-20 04:57:16 +00001234 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001235 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1236
Glauber Costa180d8cd2011-12-11 21:47:02 +00001237 atomic_long_sub(amt, prot->memory_allocated);
1238}
1239
1240static inline void sk_sockets_allocated_dec(struct sock *sk)
1241{
1242 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001243
1244 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1245 struct cg_proto *cg_proto = sk->sk_cgrp;
1246
1247 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001248 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001249 }
1250
Glauber Costa180d8cd2011-12-11 21:47:02 +00001251 percpu_counter_dec(prot->sockets_allocated);
1252}
1253
1254static inline void sk_sockets_allocated_inc(struct sock *sk)
1255{
1256 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001257
1258 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1259 struct cg_proto *cg_proto = sk->sk_cgrp;
1260
1261 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001262 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001263 }
1264
Glauber Costa180d8cd2011-12-11 21:47:02 +00001265 percpu_counter_inc(prot->sockets_allocated);
1266}
1267
1268static inline int
1269sk_sockets_allocated_read_positive(struct sock *sk)
1270{
1271 struct proto *prot = sk->sk_prot;
1272
Glauber Costae1aab162011-12-11 21:47:03 +00001273 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001274 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001275
Eric Dumazet518fbf92012-04-28 23:21:56 +00001276 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001277}
1278
1279static inline int
1280proto_sockets_allocated_sum_positive(struct proto *prot)
1281{
1282 return percpu_counter_sum_positive(prot->sockets_allocated);
1283}
1284
1285static inline long
1286proto_memory_allocated(struct proto *prot)
1287{
1288 return atomic_long_read(prot->memory_allocated);
1289}
1290
1291static inline bool
1292proto_memory_pressure(struct proto *prot)
1293{
1294 if (!prot->memory_pressure)
1295 return false;
1296 return !!*prot->memory_pressure;
1297}
1298
Eric Dumazet65f76512008-01-03 20:46:48 -08001299
1300#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001302void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1303int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001304#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001305static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001306 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001307{
1308}
Eric Dumazet65f76512008-01-03 20:46:48 -08001309#endif
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001312/* With per-bucket locks this operation is not-atomic, so that
1313 * this version is not worse.
1314 */
1315static inline void __sk_prot_rehash(struct sock *sk)
1316{
1317 sk->sk_prot->unhash(sk);
1318 sk->sk_prot->hash(sk);
1319}
1320
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001321void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323/* About 10 seconds */
1324#define SOCK_DESTROY_TIME (10*HZ)
1325
1326/* Sockets 0-1023 can't be bound to unless you are superuser */
1327#define PROT_SOCK 1024
1328
1329#define SHUTDOWN_MASK 3
1330#define RCV_SHUTDOWN 1
1331#define SEND_SHUTDOWN 2
1332
1333#define SOCK_SNDBUF_LOCK 1
1334#define SOCK_RCVBUF_LOCK 2
1335#define SOCK_BINDADDR_LOCK 4
1336#define SOCK_BINDPORT_LOCK 8
1337
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338struct socket_alloc {
1339 struct socket socket;
1340 struct inode vfs_inode;
1341};
1342
1343static inline struct socket *SOCKET_I(struct inode *inode)
1344{
1345 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1346}
1347
1348static inline struct inode *SOCK_INODE(struct socket *socket)
1349{
1350 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1351}
1352
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001353/*
1354 * Functions for memory accounting
1355 */
Joe Perches69336bd2013-09-22 10:32:26 -07001356int __sk_mem_schedule(struct sock *sk, int size, int kind);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001357void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001359#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1360#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1361#define SK_MEM_SEND 0
1362#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001364static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001366 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
1368
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001369static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001371 /* return true if protocol supports memory accounting */
1372 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373}
1374
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001375static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001377 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001378 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001379 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001380 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1381}
1382
Mel Gormanc76562b2012-07-31 16:44:41 -07001383static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001384sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001385{
1386 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001387 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001388 return size<= sk->sk_forward_alloc ||
1389 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1390 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001391}
1392
1393static inline void sk_mem_reclaim(struct sock *sk)
1394{
1395 if (!sk_has_account(sk))
1396 return;
1397 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001398 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001399}
1400
David S. Miller9993e7d2008-01-10 21:56:38 -08001401static inline void sk_mem_reclaim_partial(struct sock *sk)
1402{
1403 if (!sk_has_account(sk))
1404 return;
1405 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001406 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001407}
1408
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001409static inline void sk_mem_charge(struct sock *sk, int size)
1410{
1411 if (!sk_has_account(sk))
1412 return;
1413 sk->sk_forward_alloc -= size;
1414}
1415
1416static inline void sk_mem_uncharge(struct sock *sk, int size)
1417{
1418 if (!sk_has_account(sk))
1419 return;
1420 sk->sk_forward_alloc += size;
1421}
1422
1423static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1424{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001425 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1426 sk->sk_wmem_queued -= skb->truesize;
1427 sk_mem_uncharge(sk, skb->truesize);
1428 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001429}
1430
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431/* Used by processes to "lock" a socket state, so that
1432 * interrupts and bottom half handlers won't change it
1433 * from under us. It essentially blocks any incoming
1434 * packets, so that we won't get any new data or any
1435 * packets that change the state of the socket.
1436 *
1437 * While locked, BH processing will add new packets to
1438 * the backlog queue. This queue is processed by the
1439 * owner of the socket lock right before it is released.
1440 *
1441 * Since ~2.3.5 it is also exclusive sleep lock serializing
1442 * accesses from user process context.
1443 */
John Heffnerd2e91172007-09-12 10:44:19 +02001444#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001446static inline void sock_release_ownership(struct sock *sk)
1447{
1448 sk->sk_lock.owned = 0;
1449}
1450
Peter Zijlstraed075362006-12-06 20:35:24 -08001451/*
1452 * Macro so as to not evaluate some arguments when
1453 * lockdep is not enabled.
1454 *
1455 * Mark both the sk_lock and the sk_lock.slock as a
1456 * per-address-family lock class.
1457 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001458#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001459do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001460 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001461 init_waitqueue_head(&sk->sk_lock.wq); \
1462 spin_lock_init(&(sk)->sk_lock.slock); \
1463 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1464 sizeof((sk)->sk_lock)); \
1465 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001466 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001467 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1468} while (0)
1469
Joe Perches69336bd2013-09-22 10:32:26 -07001470void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001471
1472static inline void lock_sock(struct sock *sk)
1473{
1474 lock_sock_nested(sk, 0);
1475}
1476
Joe Perches69336bd2013-09-22 10:32:26 -07001477void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
1479/* BH context may only use the following locking interface. */
1480#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001481#define bh_lock_sock_nested(__sk) \
1482 spin_lock_nested(&((__sk)->sk_lock.slock), \
1483 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1485
Joe Perches69336bd2013-09-22 10:32:26 -07001486bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001487/**
1488 * unlock_sock_fast - complement of lock_sock_fast
1489 * @sk: socket
1490 * @slow: slow mode
1491 *
1492 * fast unlock socket for user context.
1493 * If slow mode is on, we call regular release_sock()
1494 */
1495static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001496{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001497 if (slow)
1498 release_sock(sk);
1499 else
1500 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001501}
1502
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001503
Joe Perches69336bd2013-09-22 10:32:26 -07001504struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001505 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001506void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001507void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001508struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Joe Perches69336bd2013-09-22 10:32:26 -07001510struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1511 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001512void sock_wfree(struct sk_buff *skb);
1513void skb_orphan_partial(struct sk_buff *skb);
1514void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001515void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001516#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001517void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001518#else
1519#define sock_edemux(skb) sock_efree(skb)
1520#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Joe Perches69336bd2013-09-22 10:32:26 -07001522int sock_setsockopt(struct socket *sock, int level, int op,
1523 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Joe Perches69336bd2013-09-22 10:32:26 -07001525int sock_getsockopt(struct socket *sock, int level, int op,
1526 char __user *optval, int __user *optlen);
1527struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1528 int noblock, int *errcode);
1529struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1530 unsigned long data_len, int noblock,
1531 int *errcode, int max_page_order);
1532void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1533void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001534void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001535void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Edward Jeef28ea362015-10-08 14:56:48 -07001537struct sockcm_cookie {
1538 u32 mark;
1539};
1540
1541int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1542 struct sockcm_cookie *sockc);
1543
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544/*
1545 * Functions to fill in entries in struct proto_ops when a protocol
1546 * does not implement a particular function.
1547 */
Joe Perches69336bd2013-09-22 10:32:26 -07001548int sock_no_bind(struct socket *, struct sockaddr *, int);
1549int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1550int sock_no_socketpair(struct socket *, struct socket *);
1551int sock_no_accept(struct socket *, struct socket *, int);
1552int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1553unsigned int sock_no_poll(struct file *, struct socket *,
1554 struct poll_table_struct *);
1555int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1556int sock_no_listen(struct socket *, int);
1557int sock_no_shutdown(struct socket *, int);
1558int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1559int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001560int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1561int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001562int sock_no_mmap(struct file *file, struct socket *sock,
1563 struct vm_area_struct *vma);
1564ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1565 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567/*
1568 * Functions to fill in entries in struct proto_ops when a protocol
1569 * uses the inet style.
1570 */
Joe Perches69336bd2013-09-22 10:32:26 -07001571int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001573int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1574 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001575int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001576 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001577int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001578 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001579int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001580 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Joe Perches69336bd2013-09-22 10:32:26 -07001582void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
1584/*
1585 * Default socket callbacks and setup code
1586 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001589void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591/*
1592 * Socket reference counting postulates.
1593 *
1594 * * Each user of socket SHOULD hold a reference count.
1595 * * Each access point to socket (an hash table bucket, reference from a list,
1596 * running timer, skb in flight MUST hold a reference count.
1597 * * When reference count hits 0, it means it will never increase back.
1598 * * When reference count hits 0, it means that no references from
1599 * outside exist to this socket and current process on current CPU
1600 * is last user and may/should destroy this socket.
1601 * * sk_free is called from any context: process, BH, IRQ. When
1602 * it is called, socket has no references from outside -> sk_free
1603 * may release descendant resources allocated by the socket, but
1604 * to the time when it is called, socket is NOT referenced by any
1605 * hash tables, lists etc.
1606 * * Packets, delivered from outside (from network or from another process)
1607 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1608 * when they sit in queue. Otherwise, packets will leak to hole, when
1609 * socket is looked up by one cpu and unhasing is made by another CPU.
1610 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1611 * (leak to backlog). Packet socket does all the processing inside
1612 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1613 * use separate SMP lock, so that they are prone too.
1614 */
1615
1616/* Ungrab socket and destroy it, if it was the last reference. */
1617static inline void sock_put(struct sock *sk)
1618{
1619 if (atomic_dec_and_test(&sk->sk_refcnt))
1620 sk_free(sk);
1621}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001622/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001623 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001624 */
1625void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Joe Perches69336bd2013-09-22 10:32:26 -07001627int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001628
Krishna Kumare022f0b2009-10-19 23:46:20 +00001629static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1630{
1631 sk->sk_tx_queue_mapping = tx_queue;
1632}
1633
1634static inline void sk_tx_queue_clear(struct sock *sk)
1635{
1636 sk->sk_tx_queue_mapping = -1;
1637}
1638
1639static inline int sk_tx_queue_get(const struct sock *sk)
1640{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001641 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001642}
1643
David S. Miller972692e2008-06-17 22:41:38 -07001644static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1645{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001646 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001647 sk->sk_socket = sock;
1648}
1649
Eric Dumazetaa395142010-04-20 13:03:51 +00001650static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1651{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001652 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1653 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001654}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655/* Detach socket from process context.
1656 * Announce socket dead, detach it from wait queue and inode.
1657 * Note that parent inode held reference count on this struct sock,
1658 * we do not release it in this function, because protocol
1659 * probably wants some additional cleanups or even continuing
1660 * to work with this socket (TCP).
1661 */
1662static inline void sock_orphan(struct sock *sk)
1663{
1664 write_lock_bh(&sk->sk_callback_lock);
1665 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001666 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001667 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 write_unlock_bh(&sk->sk_callback_lock);
1669}
1670
1671static inline void sock_graft(struct sock *sk, struct socket *parent)
1672{
1673 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001674 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001676 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001677 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 write_unlock_bh(&sk->sk_callback_lock);
1679}
1680
Joe Perches69336bd2013-09-22 10:32:26 -07001681kuid_t sock_i_uid(struct sock *sk);
1682unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
Eric Dumazet58d607d2015-09-15 15:24:20 -07001684static inline u32 net_tx_rndhash(void)
1685{
1686 u32 v = prandom_u32();
1687
1688 return v ?: 1;
1689}
1690
Tom Herbert877d1f62015-07-28 16:02:05 -07001691static inline void sk_set_txhash(struct sock *sk)
1692{
Eric Dumazet58d607d2015-09-15 15:24:20 -07001693 sk->sk_txhash = net_tx_rndhash();
Tom Herbert877d1f62015-07-28 16:02:05 -07001694}
1695
Tom Herbert265f94f2015-07-28 16:02:06 -07001696static inline void sk_rethink_txhash(struct sock *sk)
1697{
1698 if (sk->sk_txhash)
1699 sk_set_txhash(sk);
1700}
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702static inline struct dst_entry *
1703__sk_dst_get(struct sock *sk)
1704{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001705 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001706 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
1708
1709static inline struct dst_entry *
1710sk_dst_get(struct sock *sk)
1711{
1712 struct dst_entry *dst;
1713
Eric Dumazetb6c67122010-04-08 23:03:29 +00001714 rcu_read_lock();
1715 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001716 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1717 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001718 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return dst;
1720}
1721
Eric Dumazetb6c67122010-04-08 23:03:29 +00001722static inline void dst_negative_advice(struct sock *sk)
1723{
1724 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1725
Tom Herbert265f94f2015-07-28 16:02:06 -07001726 sk_rethink_txhash(sk);
1727
Eric Dumazetb6c67122010-04-08 23:03:29 +00001728 if (dst && dst->ops->negative_advice) {
1729 ndst = dst->ops->negative_advice(dst);
1730
1731 if (ndst != dst) {
1732 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001733 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001734 }
1735 }
1736}
1737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738static inline void
1739__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1740{
1741 struct dst_entry *old_dst;
1742
Krishna Kumare022f0b2009-10-19 23:46:20 +00001743 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001744 /*
1745 * This can be called while sk is owned by the caller only,
1746 * with no state that can be checked in a rcu_dereference_check() cond
1747 */
1748 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001749 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 dst_release(old_dst);
1751}
1752
1753static inline void
1754sk_dst_set(struct sock *sk, struct dst_entry *dst)
1755{
Eric Dumazet7f502362014-06-30 01:26:23 -07001756 struct dst_entry *old_dst;
1757
1758 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001759 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001760 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761}
1762
1763static inline void
1764__sk_dst_reset(struct sock *sk)
1765{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001766 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767}
1768
1769static inline void
1770sk_dst_reset(struct sock *sk)
1771{
Eric Dumazet7f502362014-06-30 01:26:23 -07001772 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773}
1774
Joe Perches69336bd2013-09-22 10:32:26 -07001775struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Joe Perches69336bd2013-09-22 10:32:26 -07001777struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001779bool sk_mc_loop(struct sock *sk);
1780
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001781static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001782{
1783 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1784}
1785
Joe Perches69336bd2013-09-22 10:32:26 -07001786void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001787
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001788static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001789{
1790 sk->sk_route_nocaps |= flags;
1791 sk->sk_route_caps &= ~flags;
1792}
1793
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001794static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001795 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001796 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001797{
1798 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001799 __wsum csum = 0;
1800 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1801 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001802 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001803 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001804 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001805 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001806 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001807 return -EFAULT;
1808
1809 return 0;
1810}
1811
1812static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001813 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001814{
Wei Yongjun912d3982011-04-06 18:40:12 +00001815 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001816
Wei Yongjun912d3982011-04-06 18:40:12 +00001817 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1818 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001819 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001820 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001821
1822 return err;
1823}
1824
Al Viro57be5bd2014-11-28 13:40:20 -05001825static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001826 struct sk_buff *skb,
1827 struct page *page,
1828 int off, int copy)
1829{
1830 int err;
1831
Wei Yongjun912d3982011-04-06 18:40:12 +00001832 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1833 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001834 if (err)
1835 return err;
1836
1837 skb->len += copy;
1838 skb->data_len += copy;
1839 skb->truesize += copy;
1840 sk->sk_wmem_queued += copy;
1841 sk_mem_charge(sk, copy);
1842 return 0;
1843}
1844
Eric Dumazetc5640392009-06-16 10:12:03 +00001845/**
1846 * sk_wmem_alloc_get - returns write allocations
1847 * @sk: socket
1848 *
1849 * Returns sk_wmem_alloc minus initial offset of one
1850 */
1851static inline int sk_wmem_alloc_get(const struct sock *sk)
1852{
1853 return atomic_read(&sk->sk_wmem_alloc) - 1;
1854}
1855
1856/**
1857 * sk_rmem_alloc_get - returns read allocations
1858 * @sk: socket
1859 *
1860 * Returns sk_rmem_alloc
1861 */
1862static inline int sk_rmem_alloc_get(const struct sock *sk)
1863{
1864 return atomic_read(&sk->sk_rmem_alloc);
1865}
1866
1867/**
1868 * sk_has_allocations - check if allocations are outstanding
1869 * @sk: socket
1870 *
1871 * Returns true if socket has write or read allocations
1872 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001873static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001874{
1875 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1876}
1877
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001878/**
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001879 * skwq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001880 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001881 *
Eric Dumazet43815482010-04-29 11:01:49 +00001882 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001883 *
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001884 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001885 * barrier call. They were added due to the race found within the tcp code.
1886 *
1887 * Consider following tcp code paths:
1888 *
1889 * CPU1 CPU2
1890 *
1891 * sys_select receive packet
1892 * ... ...
1893 * __add_wait_queue update tp->rcv_nxt
1894 * ... ...
1895 * tp->rcv_nxt check sock_def_readable
1896 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001897 * schedule rcu_read_lock();
1898 * wq = rcu_dereference(sk->sk_wq);
1899 * if (wq && waitqueue_active(&wq->wait))
1900 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001901 * ...
1902 * }
1903 *
1904 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1905 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1906 * could then endup calling schedule and sleep forever if there are no more
1907 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001908 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001909 */
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001910static inline bool skwq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001911{
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001912 return wq && wq_has_sleeper(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001913}
1914
1915/**
1916 * sock_poll_wait - place memory barrier behind the poll_wait call.
1917 * @filp: file
1918 * @wait_address: socket wait queue
1919 * @p: poll_table
1920 *
Eric Dumazet43815482010-04-29 11:01:49 +00001921 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001922 */
1923static inline void sock_poll_wait(struct file *filp,
1924 wait_queue_head_t *wait_address, poll_table *p)
1925{
Hans Verkuil626cf232012-03-23 15:02:27 -07001926 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001927 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001928 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001929 * socket flags modification.
1930 *
Eric Dumazet43815482010-04-29 11:01:49 +00001931 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001932 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001933 smp_mb();
1934 }
1935}
1936
Tom Herbertb73c3d02014-07-01 21:32:17 -07001937static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1938{
1939 if (sk->sk_txhash) {
1940 skb->l4_hash = 1;
1941 skb->hash = sk->sk_txhash;
1942 }
1943}
1944
Eric Dumazet9e17f8a2015-11-01 15:36:55 -08001945void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001948 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 * protocols can't normally use this as they need to fit buffers in
1950 * and play with them.
1951 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001952 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 * packet ever received.
1954 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1956{
Herbert Xud55d87f2009-06-22 02:25:25 +00001957 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 skb->sk = sk;
1959 skb->destructor = sock_rfree;
1960 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001961 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962}
1963
Joe Perches69336bd2013-09-22 10:32:26 -07001964void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1965 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966
Joe Perches69336bd2013-09-22 10:32:26 -07001967void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
Joe Perches69336bd2013-09-22 10:32:26 -07001969int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Joe Perches69336bd2013-09-22 10:32:26 -07001971int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001972struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
1974/*
1975 * Recover an error report and clear atomically
1976 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978static inline int sock_error(struct sock *sk)
1979{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001980 int err;
1981 if (likely(!sk->sk_err))
1982 return 0;
1983 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 return -err;
1985}
1986
1987static inline unsigned long sock_wspace(struct sock *sk)
1988{
1989 int amt = 0;
1990
1991 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1992 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001993 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 amt = 0;
1995 }
1996 return amt;
1997}
1998
Eric Dumazetceb5d582015-11-29 20:03:11 -08001999/* Note:
2000 * We use sk->sk_wq_raw, from contexts knowing this
2001 * pointer is not NULL and cannot disappear/change.
2002 */
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002003static inline void sk_set_bit(int nr, struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002005 set_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002006}
2007
2008static inline void sk_clear_bit(int nr, struct sock *sk)
2009{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002010 clear_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002011}
2012
Eric Dumazetceb5d582015-11-29 20:03:11 -08002013static inline void sk_wake_async(const struct sock *sk, int how, int band)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002015 if (sock_flag(sk, SOCK_FASYNC)) {
2016 rcu_read_lock();
2017 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2018 rcu_read_unlock();
2019 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020}
2021
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002022/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2023 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2024 * Note: for send buffers, TCP works better if we can build two skbs at
2025 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002026 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002027#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002028
2029#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2030#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
2032static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2033{
2034 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002035 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002036 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 }
2038}
2039
Eric Dumazeteb934472015-05-19 13:26:55 -07002040struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2041 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Eric Dumazet5640f762012-09-23 23:04:42 +00002043/**
2044 * sk_page_frag - return an appropriate page_frag
2045 * @sk: socket
2046 *
2047 * If socket allocation mode allows current thread to sleep, it means its
2048 * safe to use the per task page_frag instead of the per socket one.
2049 */
2050static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051{
Mel Gormand0164ad2015-11-06 16:28:21 -08002052 if (gfpflags_allow_blocking(sk->sk_allocation))
Eric Dumazet5640f762012-09-23 23:04:42 +00002053 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Eric Dumazet5640f762012-09-23 23:04:42 +00002055 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056}
2057
Joe Perches69336bd2013-09-22 10:32:26 -07002058bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060/*
2061 * Default write policy as shown to user space via poll/select/SIGIO
2062 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002063static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002065 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066}
2067
Al Virodd0fc662005-10-07 07:46:04 +01002068static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069{
Andrew Morton99709372009-02-12 16:43:17 -08002070 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071}
2072
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002073static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074{
2075 return noblock ? 0 : sk->sk_rcvtimeo;
2076}
2077
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002078static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079{
2080 return noblock ? 0 : sk->sk_sndtimeo;
2081}
2082
2083static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2084{
2085 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2086}
2087
2088/* Alas, with timeout socket operations are not restartable.
2089 * Compare this to poll().
2090 */
2091static inline int sock_intr_errno(long timeo)
2092{
2093 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2094}
2095
Eyal Birger744d5a32015-03-01 14:58:31 +02002096struct sock_skb_cb {
2097 u32 dropcount;
2098};
2099
2100/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2101 * using skb->cb[] would keep using it directly and utilize its
2102 * alignement guarantee.
2103 */
2104#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2105 sizeof(struct sock_skb_cb)))
2106
2107#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2108 SOCK_SKB_CB_OFFSET))
2109
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002110#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002111 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002112
Eyal Birger3bc3b962015-03-01 14:58:30 +02002113static inline void
2114sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2115{
Eyal Birger744d5a32015-03-01 14:58:31 +02002116 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002117}
2118
Joe Perches69336bd2013-09-22 10:32:26 -07002119void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2120 struct sk_buff *skb);
2121void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2122 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002123
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002124static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2126{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002127 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002128 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002129
Patrick Ohly20d49472009-02-12 05:03:38 +00002130 /*
2131 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002132 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002133 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002134 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002135 */
2136 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002137 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002138 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002139 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002140 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002141 __sock_recv_timestamp(msg, sk, skb);
2142 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002143 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002144
2145 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2146 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147}
2148
Joe Perches69336bd2013-09-22 10:32:26 -07002149void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2150 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002151
2152static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2153 struct sk_buff *skb)
2154{
2155#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002156 (1UL << SOCK_RCVTSTAMP))
2157#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2158 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002159
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002160 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002161 __sock_recv_ts_and_drops(msg, sk, skb);
2162 else
2163 sk->sk_stamp = skb->tstamp;
2164}
Neil Horman3b885782009-10-12 13:26:31 -07002165
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002166void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);
2167
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002169 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002170 * @sk: socket sending this packet
Eric Dumazet140c55d2014-08-06 11:49:29 +02002171 * @tx_flags: completed with instructions for time stamping
2172 *
2173 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002174 */
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002175static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
2176{
2177 if (unlikely(sk->sk_tsflags))
2178 __sock_tx_timestamp(sk, tx_flags);
2179 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2180 *tx_flags |= SKBTX_WIFI_STATUS;
2181}
Patrick Ohly20d49472009-02-12 05:03:38 +00002182
2183/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002185 * @sk: socket to eat this skb from
2186 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 *
2188 * This routine must be called with interrupts disabled or with the socket
2189 * locked so that the sk_buff queue operation is ok.
2190*/
Dan Williams7bced392013-12-30 12:37:29 -08002191static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192{
2193 __skb_unlink(skb, &sk->sk_receive_queue);
2194 __kfree_skb(skb);
2195}
2196
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002197static inline
2198struct net *sock_net(const struct sock *sk)
2199{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002200 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002201}
2202
2203static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002204void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002205{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002206 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002207}
2208
KOVACS Krisztian23542612008-10-07 12:41:01 -07002209static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2210{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002211 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002212 struct sock *sk = skb->sk;
2213
2214 skb->destructor = NULL;
2215 skb->sk = NULL;
2216 return sk;
2217 }
2218 return NULL;
2219}
2220
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002221/* This helper checks if a socket is a full socket,
2222 * ie _not_ a timewait or request socket.
2223 */
2224static inline bool sk_fullsock(const struct sock *sk)
2225{
2226 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2227}
2228
Eric Dumazete446f9d2015-10-08 05:01:55 -07002229/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2230 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2231 */
2232static inline bool sk_listener(const struct sock *sk)
2233{
2234 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2235}
2236
Eric Dumazet00fd38d2015-11-12 08:43:18 -08002237/**
2238 * sk_state_load - read sk->sk_state for lockless contexts
2239 * @sk: socket pointer
2240 *
2241 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2242 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2243 */
2244static inline int sk_state_load(const struct sock *sk)
2245{
2246 return smp_load_acquire(&sk->sk_state);
2247}
2248
2249/**
2250 * sk_state_store - update sk->sk_state
2251 * @sk: socket pointer
2252 * @newstate: new state
2253 *
2254 * Paired with sk_state_load(). Should be used in contexts where
2255 * state change might impact lockless readers.
2256 */
2257static inline void sk_state_store(struct sock *sk, int newstate)
2258{
2259 smp_store_release(&sk->sk_state, newstate);
2260}
2261
Joe Perches69336bd2013-09-22 10:32:26 -07002262void sock_enable_timestamp(struct sock *sk, int flag);
2263int sock_get_timestamp(struct sock *, struct timeval __user *);
2264int sock_get_timestampns(struct sock *, struct timespec __user *);
2265int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2266 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002268bool sk_ns_capable(const struct sock *sk,
2269 struct user_namespace *user_ns, int cap);
2270bool sk_capable(const struct sock *sk, int cap);
2271bool sk_net_capable(const struct sock *sk, int cap);
2272
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273extern __u32 sysctl_wmem_max;
2274extern __u32 sysctl_rmem_max;
2275
Willem de Bruijnb245be12015-01-30 13:29:32 -05002276extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002277extern int sysctl_optmem_max;
2278
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002279extern __u32 sysctl_wmem_default;
2280extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002281
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282#endif /* _SOCK_H */