]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/inet_connection_sock.h
Merge back ACPI power management material for v5.14.
[mirror_ubuntu-jammy-kernel.git] / include / net / inet_connection_sock.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
463c84b9
ACM
2/*
3 * NET Generic infrastructure for INET connection oriented protocols.
4 *
5 * Definitions for inet_connection_sock
6 *
7 * Authors: Many people, see the TCP sources
8 *
9 * From code originally in TCP
463c84b9
ACM
10 */
11#ifndef _INET_CONNECTION_SOCK_H
12#define _INET_CONNECTION_SOCK_H
13
8292a17a 14#include <linux/compiler.h>
3f421baa 15#include <linux/string.h>
463c84b9 16#include <linux/timer.h>
bd01f843 17#include <linux/poll.h>
96d18d82 18#include <linux/kernel.h>
a7b75c5a 19#include <linux/sockptr.h>
14c85021
ACM
20
21#include <net/inet_sock.h>
463c84b9
ACM
22#include <net/request_sock.h>
23
3f421baa
ACM
24/* Cancel timers, when they are not required. */
25#undef INET_CSK_CLEAR_TIMERS
26
463c84b9 27struct inet_bind_bucket;
6687e988 28struct tcp_congestion_ops;
463c84b9 29
8292a17a
ACM
30/*
31 * Pointers to address related TCP functions
32 * (i.e. things that depend on the address family)
33 */
34struct inet_connection_sock_af_ops {
b0270e91 35 int (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl);
bb296246 36 void (*send_check)(struct sock *sk, struct sk_buff *skb);
8292a17a 37 int (*rebuild_header)(struct sock *sk);
5d299f3d 38 void (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb);
8292a17a 39 int (*conn_request)(struct sock *sk, struct sk_buff *skb);
0c27171e 40 struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb,
8292a17a 41 struct request_sock *req,
5e0724d0
ED
42 struct dst_entry *dst,
43 struct request_sock *req_unhash,
44 bool *own_req);
850db6b8 45 u16 net_header_len;
67469601 46 u16 net_frag_header_len;
850db6b8 47 u16 sockaddr_len;
82695b30 48 int (*setsockopt)(struct sock *sk, int level, int optname,
a7b75c5a 49 sockptr_t optval, unsigned int optlen);
82695b30 50 int (*getsockopt)(struct sock *sk, int level, int optname,
8292a17a
ACM
51 char __user *optval, int __user *optlen);
52 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
4fab9071 53 void (*mtu_reduced)(struct sock *sk);
8292a17a
ACM
54};
55
463c84b9
ACM
56/** inet_connection_sock - INET connection oriented sock
57 *
82695b30 58 * @icsk_accept_queue: FIFO of established children
463c84b9
ACM
59 * @icsk_bind_hash: Bind node
60 * @icsk_timeout: Timeout
61 * @icsk_retransmit_timer: Resend (no ack)
62 * @icsk_rto: Retransmit timeout
d83d8461 63 * @icsk_pmtu_cookie Last pmtu seen by socket
6687e988 64 * @icsk_ca_ops Pluggable congestion control hook
8292a17a 65 * @icsk_af_ops Operations which are AF_INET{4,6} specific
734942cc
DW
66 * @icsk_ulp_ops Pluggable ULP control hook
67 * @icsk_ulp_data ULP private data
6dac1523 68 * @icsk_clean_acked Clean acked data hook
61b7c691 69 * @icsk_listen_portaddr_node hash to the portaddr listener hashtable
6687e988 70 * @icsk_ca_state: Congestion control state
463c84b9
ACM
71 * @icsk_retransmits: Number of unrecovered [RTO] timeouts
72 * @icsk_pending: Scheduled timer event
73 * @icsk_backoff: Backoff
74 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
6687e988 75 * @icsk_probes_out: unanswered 0 window probes
d83d8461 76 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
463c84b9 77 * @icsk_ack: Delayed ACK control data
5d424d5a 78 * @icsk_mtup; MTU probing control data
9d9b1ee0
EC
79 * @icsk_probes_tstamp: Probe timestamp (cleared by non-zero window ack)
80 * @icsk_user_timeout: TCP_USER_TIMEOUT value
463c84b9
ACM
81 */
82struct inet_connection_sock {
83 /* inet_sock has to be the first member! */
84 struct inet_sock icsk_inet;
85 struct request_sock_queue icsk_accept_queue;
86 struct inet_bind_bucket *icsk_bind_hash;
87 unsigned long icsk_timeout;
88 struct timer_list icsk_retransmit_timer;
89 struct timer_list icsk_delack_timer;
90 __u32 icsk_rto;
ca584ba0 91 __u32 icsk_rto_min;
2b8ee4f0 92 __u32 icsk_delack_max;
d83d8461 93 __u32 icsk_pmtu_cookie;
770cfbcf
SH
94 const struct tcp_congestion_ops *icsk_ca_ops;
95 const struct inet_connection_sock_af_ops *icsk_af_ops;
734942cc 96 const struct tcp_ulp_ops *icsk_ulp_ops;
15a7dea7 97 void __rcu *icsk_ulp_data;
6dac1523 98 void (*icsk_clean_acked)(struct sock *sk, u32 acked_seq);
61b7c691 99 struct hlist_node icsk_listen_portaddr_node;
d83d8461 100 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
8919a9b3
NC
101 __u8 icsk_ca_state:5,
102 icsk_ca_initialized:1,
9f950415 103 icsk_ca_setsockopt:1,
c5c6a8ab 104 icsk_ca_dst_locked:1;
463c84b9
ACM
105 __u8 icsk_retransmits;
106 __u8 icsk_pending;
107 __u8 icsk_backoff;
108 __u8 icsk_syn_retries;
6687e988 109 __u8 icsk_probes_out;
d83d8461 110 __u16 icsk_ext_hdr_len;
463c84b9
ACM
111 struct {
112 __u8 pending; /* ACK is pending */
113 __u8 quick; /* Scheduled number of quick acks */
114 __u8 pingpong; /* The session is interactive */
a37c2134 115 __u8 retry; /* Number of attempts */
463c84b9
ACM
116 __u32 ato; /* Predicted tick of soft clock */
117 unsigned long timeout; /* Currently scheduled timeout */
118 __u32 lrcvtime; /* timestamp of last received data packet */
119 __u16 last_seg_size; /* Size of last incoming segment */
82695b30 120 __u16 rcv_mss; /* MSS used for delayed ACK decisions */
463c84b9 121 } icsk_ack;
5d424d5a 122 struct {
5d424d5a
JH
123 /* Range of MTUs to search */
124 int search_high;
125 int search_low;
126
127 /* Information on the current probe. */
14e8e0f6
NC
128 u32 probe_size:31,
129 /* Is the MTUP feature enabled for this connection? */
130 enabled:1;
05cbc0db
FD
131
132 u32 probe_timestamp;
5d424d5a 133 } icsk_mtup;
9d9b1ee0 134 u32 icsk_probes_tstamp;
dca43c75 135 u32 icsk_user_timeout;
b5d721d7 136
78dc70eb
PJ
137 u64 icsk_ca_priv[104 / sizeof(u64)];
138#define ICSK_CA_PRIV_SIZE (13 * sizeof(u64))
463c84b9
ACM
139};
140
3f421baa
ACM
141#define ICSK_TIME_RETRANS 1 /* Retransmit timer */
142#define ICSK_TIME_DACK 2 /* Delayed ack timer */
143#define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
6ba8a3b1 144#define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */
57dde7f7 145#define ICSK_TIME_REO_TIMEOUT 6 /* Reordering timer */
3f421baa 146
463c84b9
ACM
147static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
148{
149 return (struct inet_connection_sock *)sk;
150}
151
6687e988
ACM
152static inline void *inet_csk_ca(const struct sock *sk)
153{
154 return (void *)inet_csk(sk)->icsk_ca_priv;
155}
156
1fd51155
JP
157struct sock *inet_csk_clone_lock(const struct sock *sk,
158 const struct request_sock *req,
159 const gfp_t priority);
9f1d2604 160
3f421baa
ACM
161enum inet_csk_ack_state_t {
162 ICSK_ACK_SCHED = 1,
163 ICSK_ACK_TIMER = 2,
1ef9696c 164 ICSK_ACK_PUSHED = 4,
466466dc
YC
165 ICSK_ACK_PUSHED2 = 8,
166 ICSK_ACK_NOW = 16 /* Send the next ACK immediately (once) */
3f421baa
ACM
167};
168
1fd51155 169void inet_csk_init_xmit_timers(struct sock *sk,
59f379f9
KC
170 void (*retransmit_handler)(struct timer_list *),
171 void (*delack_handler)(struct timer_list *),
172 void (*keepalive_handler)(struct timer_list *));
1fd51155 173void inet_csk_clear_xmit_timers(struct sock *sk);
463c84b9 174
3f421baa
ACM
175static inline void inet_csk_schedule_ack(struct sock *sk)
176{
177 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
178}
179
180static inline int inet_csk_ack_scheduled(const struct sock *sk)
181{
182 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
183}
184
185static inline void inet_csk_delack_init(struct sock *sk)
186{
187 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
188}
189
1fd51155
JP
190void inet_csk_delete_keepalive_timer(struct sock *sk);
191void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
3f421baa 192
3f421baa
ACM
193static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
194{
195 struct inet_connection_sock *icsk = inet_csk(sk);
82695b30 196
3f421baa
ACM
197 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
198 icsk->icsk_pending = 0;
199#ifdef INET_CSK_CLEAR_TIMERS
200 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
201#endif
202 } else if (what == ICSK_TIME_DACK) {
b6b6d653 203 icsk->icsk_ack.pending = 0;
a37c2134 204 icsk->icsk_ack.retry = 0;
3f421baa
ACM
205#ifdef INET_CSK_CLEAR_TIMERS
206 sk_stop_timer(sk, &icsk->icsk_delack_timer);
207#endif
03bdfc00
JP
208 } else {
209 pr_debug("inet_csk BUG: unknown timer value\n");
3f421baa 210 }
3f421baa
ACM
211}
212
213/*
214 * Reset the retransmission timer
215 */
216static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
217 unsigned long when,
218 const unsigned long max_when)
219{
220 struct inet_connection_sock *icsk = inet_csk(sk);
221
222 if (when > max_when) {
3f421baa 223 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
96d18d82 224 sk, what, when, (void *)_THIS_IP_);
3f421baa
ACM
225 when = max_when;
226 }
227
6ba8a3b1 228 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 ||
a05a7280 229 what == ICSK_TIME_LOSS_PROBE || what == ICSK_TIME_REO_TIMEOUT) {
3f421baa
ACM
230 icsk->icsk_pending = what;
231 icsk->icsk_timeout = jiffies + when;
232 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
233 } else if (what == ICSK_TIME_DACK) {
234 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
235 icsk->icsk_ack.timeout = jiffies + when;
236 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
03bdfc00
JP
237 } else {
238 pr_debug("inet_csk BUG: unknown timer value\n");
3f421baa 239 }
3f421baa
ACM
240}
241
fcdd1cf4
ED
242static inline unsigned long
243inet_csk_rto_backoff(const struct inet_connection_sock *icsk,
244 unsigned long max_when)
245{
246 u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff;
247
248 return (unsigned long)min_t(u64, when, max_when);
249}
250
cdfbabfb 251struct sock *inet_csk_accept(struct sock *sk, int flags, int *err, bool kern);
3f421baa 252
1fd51155 253int inet_csk_get_port(struct sock *sk, unsigned short snum);
463c84b9 254
e5895bc6 255struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4,
1fd51155 256 const struct request_sock *req);
a2432c4f
ED
257struct dst_entry *inet_csk_route_child_sock(const struct sock *sk,
258 struct sock *newsk,
ba3f7f04 259 const struct request_sock *req);
463c84b9 260
7716682c
ED
261struct sock *inet_csk_reqsk_queue_add(struct sock *sk,
262 struct request_sock *req,
263 struct sock *child);
1fd51155
JP
264void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
265 unsigned long timeout);
5e0724d0
ED
266struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child,
267 struct request_sock *req,
268 bool own_req);
3f421baa 269
2feda341 270static inline void inet_csk_reqsk_queue_added(struct sock *sk)
3f421baa 271{
fa76ce73 272 reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue);
3f421baa
ACM
273}
274
275static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
276{
277 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
278}
279
3f421baa
ACM
280static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
281{
ef547f2a 282 return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog;
3f421baa
ACM
283}
284
7233da86 285bool inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req);
f03f2e15 286void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req);
3f421baa 287
2f8a397d
PA
288static inline void inet_csk_prepare_for_destroy_sock(struct sock *sk)
289{
290 /* The below has to be done to allow calling inet_csk_destroy_sock */
291 sock_set_flag(sk, SOCK_DEAD);
292 percpu_counter_inc(sk->sk_prot->orphan_count);
2f8a397d
PA
293}
294
1fd51155
JP
295void inet_csk_destroy_sock(struct sock *sk);
296void inet_csk_prepare_forced_close(struct sock *sk);
dc40c7bc
ACM
297
298/*
299 * LISTEN is a special case for poll..
300 */
ade994f4 301static inline __poll_t inet_csk_listen_poll(const struct sock *sk)
dc40c7bc
ACM
302{
303 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
a9a08845 304 (EPOLLIN | EPOLLRDNORM) : 0;
dc40c7bc
ACM
305}
306
f985c65c 307int inet_csk_listen_start(struct sock *sk, int backlog);
1fd51155 308void inet_csk_listen_stop(struct sock *sk);
295f7324 309
1fd51155 310void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
af05dc93 311
62ffc589
TF
312/* update the fast reuse flag when adding a socket */
313void inet_csk_update_fastreuse(struct inet_bind_bucket *tb,
314 struct sock *sk);
315
1fd51155 316struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu);
31954cd8 317
4a41f453 318#define TCP_PINGPONG_THRESH 3
31954cd8
WW
319
320static inline void inet_csk_enter_pingpong_mode(struct sock *sk)
321{
322 inet_csk(sk)->icsk_ack.pingpong = TCP_PINGPONG_THRESH;
323}
324
325static inline void inet_csk_exit_pingpong_mode(struct sock *sk)
326{
327 inet_csk(sk)->icsk_ack.pingpong = 0;
328}
329
330static inline bool inet_csk_in_pingpong_mode(struct sock *sk)
331{
332 return inet_csk(sk)->icsk_ack.pingpong >= TCP_PINGPONG_THRESH;
333}
4a41f453
WW
334
335static inline void inet_csk_inc_pingpong_cnt(struct sock *sk)
336{
337 struct inet_connection_sock *icsk = inet_csk(sk);
338
339 if (icsk->icsk_ack.pingpong < U8_MAX)
340 icsk->icsk_ack.pingpong++;
341}
7b70973d
LB
342
343static inline bool inet_csk_has_ulp(struct sock *sk)
344{
345 return inet_sk(sk)->is_icsk && !!inet_csk(sk)->icsk_ulp_ops;
346}
347
463c84b9 348#endif /* _INET_CONNECTION_SOCK_H */