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