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 18 #include <linux/compiler.h> 19 #include <linux/string.h> 20 #include <linux/timer.h> 21 #include <linux/poll.h> 22 23 #include <net/inet_sock.h> 24 #include <net/request_sock.h> 25 26 #define INET_CSK_DEBUG 1 27 28 /* Cancel timers, when they are not required. */ 29 #undef INET_CSK_CLEAR_TIMERS 30 31 struct inet_bind_bucket; 32 struct tcp_congestion_ops; 33 34 /* 35 * Pointers to address related TCP functions 36 * (i.e. things that depend on the address family) 37 */ 38 struct inet_connection_sock_af_ops { 39 int (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl); 40 void (*send_check)(struct sock *sk, struct sk_buff *skb); 41 int (*rebuild_header)(struct sock *sk); 42 void (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb); 43 int (*conn_request)(struct sock *sk, struct sk_buff *skb); 44 struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb, 45 struct request_sock *req, 46 struct dst_entry *dst, 47 struct request_sock *req_unhash, 48 bool *own_req); 49 u16 net_header_len; 50 u16 net_frag_header_len; 51 u16 sockaddr_len; 52 int (*setsockopt)(struct sock *sk, int level, int optname, 53 char __user *optval, unsigned int optlen); 54 int (*getsockopt)(struct sock *sk, int level, int optname, 55 char __user *optval, int __user *optlen); 56 #ifdef CONFIG_COMPAT 57 int (*compat_setsockopt)(struct sock *sk, 58 int level, int optname, 59 char __user *optval, unsigned int optlen); 60 int (*compat_getsockopt)(struct sock *sk, 61 int level, int optname, 62 char __user *optval, int __user *optlen); 63 #endif 64 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *); 65 void (*mtu_reduced)(struct sock *sk); 66 }; 67 68 /** inet_connection_sock - INET connection oriented sock 69 * 70 * @icsk_accept_queue: FIFO of established children 71 * @icsk_bind_hash: Bind node 72 * @icsk_timeout: Timeout 73 * @icsk_retransmit_timer: Resend (no ack) 74 * @icsk_rto: Retransmit timeout 75 * @icsk_pmtu_cookie Last pmtu seen by socket 76 * @icsk_ca_ops Pluggable congestion control hook 77 * @icsk_af_ops Operations which are AF_INET{4,6} specific 78 * @icsk_ca_state: Congestion control state 79 * @icsk_retransmits: Number of unrecovered [RTO] timeouts 80 * @icsk_pending: Scheduled timer event 81 * @icsk_backoff: Backoff 82 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries 83 * @icsk_probes_out: unanswered 0 window probes 84 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options) 85 * @icsk_ack: Delayed ACK control data 86 * @icsk_mtup; MTU probing control data 87 */ 88 struct inet_connection_sock { 89 /* inet_sock has to be the first member! */ 90 struct inet_sock icsk_inet; 91 struct request_sock_queue icsk_accept_queue; 92 struct inet_bind_bucket *icsk_bind_hash; 93 unsigned long icsk_timeout; 94 struct timer_list icsk_retransmit_timer; 95 struct timer_list icsk_delack_timer; 96 __u32 icsk_rto; 97 __u32 icsk_pmtu_cookie; 98 const struct tcp_congestion_ops *icsk_ca_ops; 99 const struct inet_connection_sock_af_ops *icsk_af_ops; 100 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu); 101 __u8 icsk_ca_state:6, 102 icsk_ca_setsockopt:1, 103 icsk_ca_dst_locked:1; 104 __u8 icsk_retransmits; 105 __u8 icsk_pending; 106 __u8 icsk_backoff; 107 __u8 icsk_syn_retries; 108 __u8 icsk_probes_out; 109 __u16 icsk_ext_hdr_len; 110 struct { 111 __u8 pending; /* ACK is pending */ 112 __u8 quick; /* Scheduled number of quick acks */ 113 __u8 pingpong; /* The session is interactive */ 114 __u8 blocked; /* Delayed ACK was blocked by socket lock */ 115 __u32 ato; /* Predicted tick of soft clock */ 116 unsigned long timeout; /* Currently scheduled timeout */ 117 __u32 lrcvtime; /* timestamp of last received data packet */ 118 __u16 last_seg_size; /* Size of last incoming segment */ 119 __u16 rcv_mss; /* MSS used for delayed ACK decisions */ 120 } icsk_ack; 121 struct { 122 int enabled; 123 124 /* Range of MTUs to search */ 125 int search_high; 126 int search_low; 127 128 /* Information on the current probe. */ 129 int probe_size; 130 131 u32 probe_timestamp; 132 } icsk_mtup; 133 u32 icsk_user_timeout; 134 135 u64 icsk_ca_priv[88 / sizeof(u64)]; 136 #define ICSK_CA_PRIV_SIZE (11 * sizeof(u64)) 137 }; 138 139 #define ICSK_TIME_RETRANS 1 /* Retransmit timer */ 140 #define ICSK_TIME_DACK 2 /* Delayed ack timer */ 141 #define ICSK_TIME_PROBE0 3 /* Zero window probe timer */ 142 #define ICSK_TIME_EARLY_RETRANS 4 /* Early retransmit timer */ 143 #define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */ 144 #define ICSK_TIME_REO_TIMEOUT 6 /* Reordering timer */ 145 146 static inline struct inet_connection_sock *inet_csk(const struct sock *sk) 147 { 148 return (struct inet_connection_sock *)sk; 149 } 150 151 static inline void *inet_csk_ca(const struct sock *sk) 152 { 153 return (void *)inet_csk(sk)->icsk_ca_priv; 154 } 155 156 struct sock *inet_csk_clone_lock(const struct sock *sk, 157 const struct request_sock *req, 158 const gfp_t priority); 159 160 enum inet_csk_ack_state_t { 161 ICSK_ACK_SCHED = 1, 162 ICSK_ACK_TIMER = 2, 163 ICSK_ACK_PUSHED = 4, 164 ICSK_ACK_PUSHED2 = 8 165 }; 166 167 void inet_csk_init_xmit_timers(struct sock *sk, 168 void (*retransmit_handler)(unsigned long), 169 void (*delack_handler)(unsigned long), 170 void (*keepalive_handler)(unsigned long)); 171 void inet_csk_clear_xmit_timers(struct sock *sk); 172 173 static inline void inet_csk_schedule_ack(struct sock *sk) 174 { 175 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED; 176 } 177 178 static inline int inet_csk_ack_scheduled(const struct sock *sk) 179 { 180 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED; 181 } 182 183 static inline void inet_csk_delack_init(struct sock *sk) 184 { 185 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack)); 186 } 187 188 void inet_csk_delete_keepalive_timer(struct sock *sk); 189 void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout); 190 191 #ifdef INET_CSK_DEBUG 192 extern const char inet_csk_timer_bug_msg[]; 193 #endif 194 195 static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what) 196 { 197 struct inet_connection_sock *icsk = inet_csk(sk); 198 199 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) { 200 icsk->icsk_pending = 0; 201 #ifdef INET_CSK_CLEAR_TIMERS 202 sk_stop_timer(sk, &icsk->icsk_retransmit_timer); 203 #endif 204 } else if (what == ICSK_TIME_DACK) { 205 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0; 206 #ifdef INET_CSK_CLEAR_TIMERS 207 sk_stop_timer(sk, &icsk->icsk_delack_timer); 208 #endif 209 } 210 #ifdef INET_CSK_DEBUG 211 else { 212 pr_debug("%s", inet_csk_timer_bug_msg); 213 } 214 #endif 215 } 216 217 /* 218 * Reset the retransmission timer 219 */ 220 static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what, 221 unsigned long when, 222 const unsigned long max_when) 223 { 224 struct inet_connection_sock *icsk = inet_csk(sk); 225 226 if (when > max_when) { 227 #ifdef INET_CSK_DEBUG 228 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n", 229 sk, what, when, current_text_addr()); 230 #endif 231 when = max_when; 232 } 233 234 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 || 235 what == ICSK_TIME_EARLY_RETRANS || what == ICSK_TIME_LOSS_PROBE || 236 what == ICSK_TIME_REO_TIMEOUT) { 237 icsk->icsk_pending = what; 238 icsk->icsk_timeout = jiffies + when; 239 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout); 240 } else if (what == ICSK_TIME_DACK) { 241 icsk->icsk_ack.pending |= ICSK_ACK_TIMER; 242 icsk->icsk_ack.timeout = jiffies + when; 243 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout); 244 } 245 #ifdef INET_CSK_DEBUG 246 else { 247 pr_debug("%s", inet_csk_timer_bug_msg); 248 } 249 #endif 250 } 251 252 static inline unsigned long 253 inet_csk_rto_backoff(const struct inet_connection_sock *icsk, 254 unsigned long max_when) 255 { 256 u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff; 257 258 return (unsigned long)min_t(u64, when, max_when); 259 } 260 261 struct sock *inet_csk_accept(struct sock *sk, int flags, int *err, bool kern); 262 263 int inet_csk_get_port(struct sock *sk, unsigned short snum); 264 265 struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4, 266 const struct request_sock *req); 267 struct dst_entry *inet_csk_route_child_sock(const struct sock *sk, 268 struct sock *newsk, 269 const struct request_sock *req); 270 271 struct sock *inet_csk_reqsk_queue_add(struct sock *sk, 272 struct request_sock *req, 273 struct sock *child); 274 void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req, 275 unsigned long timeout); 276 struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child, 277 struct request_sock *req, 278 bool own_req); 279 280 static inline void inet_csk_reqsk_queue_added(struct sock *sk) 281 { 282 reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue); 283 } 284 285 static inline int inet_csk_reqsk_queue_len(const struct sock *sk) 286 { 287 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue); 288 } 289 290 static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk) 291 { 292 return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog; 293 } 294 295 void inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req); 296 void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req); 297 298 void inet_csk_destroy_sock(struct sock *sk); 299 void inet_csk_prepare_forced_close(struct sock *sk); 300 301 /* 302 * LISTEN is a special case for poll.. 303 */ 304 static inline unsigned int inet_csk_listen_poll(const struct sock *sk) 305 { 306 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ? 307 (POLLIN | POLLRDNORM) : 0; 308 } 309 310 int inet_csk_listen_start(struct sock *sk, int backlog); 311 void inet_csk_listen_stop(struct sock *sk); 312 313 void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr); 314 315 int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname, 316 char __user *optval, int __user *optlen); 317 int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname, 318 char __user *optval, unsigned int optlen); 319 320 struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu); 321 #endif /* _INET_CONNECTION_SOCK_H */ 322