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.
6 * Support for INET connection oriented protocols.
8 * Authors: See the TCP sources
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.
16 #include <linux/module.h>
17 #include <linux/jhash.h>
19 #include <net/inet_connection_sock.h>
20 #include <net/inet_hashtables.h>
21 #include <net/inet_timewait_sock.h>
23 #include <net/route.h>
24 #include <net/tcp_states.h>
28 const char inet_csk_timer_bug_msg[] = "inet_csk BUG: unknown timer value\n";
29 EXPORT_SYMBOL(inet_csk_timer_bug_msg);
33 * This array holds the first and last local port number.
35 int sysctl_local_port_range[2] = { 32768, 61000 };
36 DEFINE_SEQLOCK(sysctl_port_range_lock);
38 void inet_get_local_port_range(int *low, int *high)
42 seq = read_seqbegin(&sysctl_port_range_lock);
44 *low = sysctl_local_port_range[0];
45 *high = sysctl_local_port_range[1];
46 } while (read_seqretry(&sysctl_port_range_lock, seq));
48 EXPORT_SYMBOL(inet_get_local_port_range);
50 int inet_csk_bind_conflict(const struct sock *sk,
51 const struct inet_bind_bucket *tb)
53 const __be32 sk_rcv_saddr = inet_rcv_saddr(sk);
55 struct hlist_node *node;
56 int reuse = sk->sk_reuse;
58 sk_for_each_bound(sk2, node, &tb->owners) {
60 !inet_v6_ipv6only(sk2) &&
61 (!sk->sk_bound_dev_if ||
62 !sk2->sk_bound_dev_if ||
63 sk->sk_bound_dev_if == sk2->sk_bound_dev_if)) {
64 if (!reuse || !sk2->sk_reuse ||
65 sk2->sk_state == TCP_LISTEN) {
66 const __be32 sk2_rcv_saddr = inet_rcv_saddr(sk2);
67 if (!sk2_rcv_saddr || !sk_rcv_saddr ||
68 sk2_rcv_saddr == sk_rcv_saddr)
76 EXPORT_SYMBOL_GPL(inet_csk_bind_conflict);
78 /* Obtain a reference to a local port for the given sock,
79 * if snum is zero it means select any available local port.
81 int inet_csk_get_port(struct inet_hashinfo *hashinfo,
82 struct sock *sk, unsigned short snum,
83 int (*bind_conflict)(const struct sock *sk,
84 const struct inet_bind_bucket *tb))
86 struct inet_bind_hashbucket *head;
87 struct hlist_node *node;
88 struct inet_bind_bucket *tb;
93 int remaining, rover, low, high;
95 inet_get_local_port_range(&low, &high);
96 remaining = (high - low) + 1;
97 rover = net_random() % remaining + low;
100 head = &hashinfo->bhash[inet_bhashfn(rover, hashinfo->bhash_size)];
101 spin_lock(&head->lock);
102 inet_bind_bucket_for_each(tb, node, &head->chain)
103 if (tb->port == rover)
107 spin_unlock(&head->lock);
110 } while (--remaining > 0);
112 /* Exhausted local port range during search? It is not
113 * possible for us to be holding one of the bind hash
114 * locks if this test triggers, because if 'remaining'
115 * drops to zero, we broke out of the do/while loop at
116 * the top level, not from the 'break;' statement.
122 /* OK, here is the one we will use. HEAD is
123 * non-NULL and we hold it's mutex.
127 head = &hashinfo->bhash[inet_bhashfn(snum, hashinfo->bhash_size)];
128 spin_lock(&head->lock);
129 inet_bind_bucket_for_each(tb, node, &head->chain)
130 if (tb->port == snum)
136 if (!hlist_empty(&tb->owners)) {
137 if (sk->sk_reuse > 1)
139 if (tb->fastreuse > 0 &&
140 sk->sk_reuse && sk->sk_state != TCP_LISTEN) {
144 if (bind_conflict(sk, tb))
150 if (!tb && (tb = inet_bind_bucket_create(hashinfo->bind_bucket_cachep, head, snum)) == NULL)
152 if (hlist_empty(&tb->owners)) {
153 if (sk->sk_reuse && sk->sk_state != TCP_LISTEN)
157 } else if (tb->fastreuse &&
158 (!sk->sk_reuse || sk->sk_state == TCP_LISTEN))
161 if (!inet_csk(sk)->icsk_bind_hash)
162 inet_bind_hash(sk, tb, snum);
163 BUG_TRAP(inet_csk(sk)->icsk_bind_hash == tb);
167 spin_unlock(&head->lock);
173 EXPORT_SYMBOL_GPL(inet_csk_get_port);
176 * Wait for an incoming connection, avoid race conditions. This must be called
177 * with the socket locked.
179 static int inet_csk_wait_for_connect(struct sock *sk, long timeo)
181 struct inet_connection_sock *icsk = inet_csk(sk);
186 * True wake-one mechanism for incoming connections: only
187 * one process gets woken up, not the 'whole herd'.
188 * Since we do not 'race & poll' for established sockets
189 * anymore, the common case will execute the loop only once.
191 * Subtle issue: "add_wait_queue_exclusive()" will be added
192 * after any current non-exclusive waiters, and we know that
193 * it will always _stay_ after any new non-exclusive waiters
194 * because all non-exclusive waiters are added at the
195 * beginning of the wait-queue. As such, it's ok to "drop"
196 * our exclusiveness temporarily when we get woken up without
197 * having to remove and re-insert us on the wait queue.
200 prepare_to_wait_exclusive(sk->sk_sleep, &wait,
203 if (reqsk_queue_empty(&icsk->icsk_accept_queue))
204 timeo = schedule_timeout(timeo);
207 if (!reqsk_queue_empty(&icsk->icsk_accept_queue))
210 if (sk->sk_state != TCP_LISTEN)
212 err = sock_intr_errno(timeo);
213 if (signal_pending(current))
219 finish_wait(sk->sk_sleep, &wait);
224 * This will accept the next outstanding connection.
226 struct sock *inet_csk_accept(struct sock *sk, int flags, int *err)
228 struct inet_connection_sock *icsk = inet_csk(sk);
234 /* We need to make sure that this socket is listening,
235 * and that it has something pending.
238 if (sk->sk_state != TCP_LISTEN)
241 /* Find already established connection */
242 if (reqsk_queue_empty(&icsk->icsk_accept_queue)) {
243 long timeo = sock_rcvtimeo(sk, flags & O_NONBLOCK);
245 /* If this is a non blocking socket don't sleep */
250 error = inet_csk_wait_for_connect(sk, timeo);
255 newsk = reqsk_queue_get_child(&icsk->icsk_accept_queue, sk);
256 BUG_TRAP(newsk->sk_state != TCP_SYN_RECV);
266 EXPORT_SYMBOL(inet_csk_accept);
269 * Using different timers for retransmit, delayed acks and probes
270 * We may wish use just one timer maintaining a list of expire jiffies
273 void inet_csk_init_xmit_timers(struct sock *sk,
274 void (*retransmit_handler)(unsigned long),
275 void (*delack_handler)(unsigned long),
276 void (*keepalive_handler)(unsigned long))
278 struct inet_connection_sock *icsk = inet_csk(sk);
280 setup_timer(&icsk->icsk_retransmit_timer, retransmit_handler,
282 setup_timer(&icsk->icsk_delack_timer, delack_handler,
284 setup_timer(&sk->sk_timer, keepalive_handler, (unsigned long)sk);
285 icsk->icsk_pending = icsk->icsk_ack.pending = 0;
288 EXPORT_SYMBOL(inet_csk_init_xmit_timers);
290 void inet_csk_clear_xmit_timers(struct sock *sk)
292 struct inet_connection_sock *icsk = inet_csk(sk);
294 icsk->icsk_pending = icsk->icsk_ack.pending = icsk->icsk_ack.blocked = 0;
296 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
297 sk_stop_timer(sk, &icsk->icsk_delack_timer);
298 sk_stop_timer(sk, &sk->sk_timer);
301 EXPORT_SYMBOL(inet_csk_clear_xmit_timers);
303 void inet_csk_delete_keepalive_timer(struct sock *sk)
305 sk_stop_timer(sk, &sk->sk_timer);
308 EXPORT_SYMBOL(inet_csk_delete_keepalive_timer);
310 void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long len)
312 sk_reset_timer(sk, &sk->sk_timer, jiffies + len);
315 EXPORT_SYMBOL(inet_csk_reset_keepalive_timer);
317 struct dst_entry* inet_csk_route_req(struct sock *sk,
318 const struct request_sock *req)
321 const struct inet_request_sock *ireq = inet_rsk(req);
322 struct ip_options *opt = inet_rsk(req)->opt;
323 struct flowi fl = { .oif = sk->sk_bound_dev_if,
325 { .daddr = ((opt && opt->srr) ?
328 .saddr = ireq->loc_addr,
329 .tos = RT_CONN_FLAGS(sk) } },
330 .proto = sk->sk_protocol,
332 { .sport = inet_sk(sk)->sport,
333 .dport = ireq->rmt_port } } };
335 security_req_classify_flow(req, &fl);
336 if (ip_route_output_flow(&init_net, &rt, &fl, sk, 0)) {
337 IP_INC_STATS_BH(IPSTATS_MIB_OUTNOROUTES);
340 if (opt && opt->is_strictroute && rt->rt_dst != rt->rt_gateway) {
342 IP_INC_STATS_BH(IPSTATS_MIB_OUTNOROUTES);
348 EXPORT_SYMBOL_GPL(inet_csk_route_req);
350 static inline u32 inet_synq_hash(const __be32 raddr, const __be16 rport,
351 const u32 rnd, const u32 synq_hsize)
353 return jhash_2words((__force u32)raddr, (__force u32)rport, rnd) & (synq_hsize - 1);
356 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
357 #define AF_INET_FAMILY(fam) ((fam) == AF_INET)
359 #define AF_INET_FAMILY(fam) 1
362 struct request_sock *inet_csk_search_req(const struct sock *sk,
363 struct request_sock ***prevp,
364 const __be16 rport, const __be32 raddr,
367 const struct inet_connection_sock *icsk = inet_csk(sk);
368 struct listen_sock *lopt = icsk->icsk_accept_queue.listen_opt;
369 struct request_sock *req, **prev;
371 for (prev = &lopt->syn_table[inet_synq_hash(raddr, rport, lopt->hash_rnd,
372 lopt->nr_table_entries)];
373 (req = *prev) != NULL;
374 prev = &req->dl_next) {
375 const struct inet_request_sock *ireq = inet_rsk(req);
377 if (ireq->rmt_port == rport &&
378 ireq->rmt_addr == raddr &&
379 ireq->loc_addr == laddr &&
380 AF_INET_FAMILY(req->rsk_ops->family)) {
390 EXPORT_SYMBOL_GPL(inet_csk_search_req);
392 void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
393 unsigned long timeout)
395 struct inet_connection_sock *icsk = inet_csk(sk);
396 struct listen_sock *lopt = icsk->icsk_accept_queue.listen_opt;
397 const u32 h = inet_synq_hash(inet_rsk(req)->rmt_addr, inet_rsk(req)->rmt_port,
398 lopt->hash_rnd, lopt->nr_table_entries);
400 reqsk_queue_hash_req(&icsk->icsk_accept_queue, h, req, timeout);
401 inet_csk_reqsk_queue_added(sk, timeout);
404 /* Only thing we need from tcp.h */
405 extern int sysctl_tcp_synack_retries;
407 EXPORT_SYMBOL_GPL(inet_csk_reqsk_queue_hash_add);
409 void inet_csk_reqsk_queue_prune(struct sock *parent,
410 const unsigned long interval,
411 const unsigned long timeout,
412 const unsigned long max_rto)
414 struct inet_connection_sock *icsk = inet_csk(parent);
415 struct request_sock_queue *queue = &icsk->icsk_accept_queue;
416 struct listen_sock *lopt = queue->listen_opt;
417 int max_retries = icsk->icsk_syn_retries ? : sysctl_tcp_synack_retries;
418 int thresh = max_retries;
419 unsigned long now = jiffies;
420 struct request_sock **reqp, *req;
423 if (lopt == NULL || lopt->qlen == 0)
426 /* Normally all the openreqs are young and become mature
427 * (i.e. converted to established socket) for first timeout.
428 * If synack was not acknowledged for 3 seconds, it means
429 * one of the following things: synack was lost, ack was lost,
430 * rtt is high or nobody planned to ack (i.e. synflood).
431 * When server is a bit loaded, queue is populated with old
432 * open requests, reducing effective size of queue.
433 * When server is well loaded, queue size reduces to zero
434 * after several minutes of work. It is not synflood,
435 * it is normal operation. The solution is pruning
436 * too old entries overriding normal timeout, when
437 * situation becomes dangerous.
439 * Essentially, we reserve half of room for young
440 * embrions; and abort old ones without pity, if old
441 * ones are about to clog our table.
443 if (lopt->qlen>>(lopt->max_qlen_log-1)) {
444 int young = (lopt->qlen_young<<1);
447 if (lopt->qlen < young)
454 if (queue->rskq_defer_accept)
455 max_retries = queue->rskq_defer_accept;
457 budget = 2 * (lopt->nr_table_entries / (timeout / interval));
458 i = lopt->clock_hand;
461 reqp=&lopt->syn_table[i];
462 while ((req = *reqp) != NULL) {
463 if (time_after_eq(now, req->expires)) {
464 if ((req->retrans < thresh ||
465 (inet_rsk(req)->acked && req->retrans < max_retries))
466 && !req->rsk_ops->rtx_syn_ack(parent, req, NULL)) {
469 if (req->retrans++ == 0)
471 timeo = min((timeout << req->retrans), max_rto);
472 req->expires = now + timeo;
473 reqp = &req->dl_next;
477 /* Drop this request */
478 inet_csk_reqsk_queue_unlink(parent, req, reqp);
479 reqsk_queue_removed(queue, req);
483 reqp = &req->dl_next;
486 i = (i + 1) & (lopt->nr_table_entries - 1);
488 } while (--budget > 0);
490 lopt->clock_hand = i;
493 inet_csk_reset_keepalive_timer(parent, interval);
496 EXPORT_SYMBOL_GPL(inet_csk_reqsk_queue_prune);
498 struct sock *inet_csk_clone(struct sock *sk, const struct request_sock *req,
499 const gfp_t priority)
501 struct sock *newsk = sk_clone(sk, priority);
504 struct inet_connection_sock *newicsk = inet_csk(newsk);
506 newsk->sk_state = TCP_SYN_RECV;
507 newicsk->icsk_bind_hash = NULL;
509 inet_sk(newsk)->dport = inet_rsk(req)->rmt_port;
510 newsk->sk_write_space = sk_stream_write_space;
512 newicsk->icsk_retransmits = 0;
513 newicsk->icsk_backoff = 0;
514 newicsk->icsk_probes_out = 0;
516 /* Deinitialize accept_queue to trap illegal accesses. */
517 memset(&newicsk->icsk_accept_queue, 0, sizeof(newicsk->icsk_accept_queue));
519 security_inet_csk_clone(newsk, req);
524 EXPORT_SYMBOL_GPL(inet_csk_clone);
527 * At this point, there should be no process reference to this
528 * socket, and thus no user references at all. Therefore we
529 * can assume the socket waitqueue is inactive and nobody will
530 * try to jump onto it.
532 void inet_csk_destroy_sock(struct sock *sk)
534 BUG_TRAP(sk->sk_state == TCP_CLOSE);
535 BUG_TRAP(sock_flag(sk, SOCK_DEAD));
537 /* It cannot be in hash table! */
538 BUG_TRAP(sk_unhashed(sk));
540 /* If it has not 0 inet_sk(sk)->num, it must be bound */
541 BUG_TRAP(!inet_sk(sk)->num || inet_csk(sk)->icsk_bind_hash);
543 sk->sk_prot->destroy(sk);
545 sk_stream_kill_queues(sk);
547 xfrm_sk_free_policy(sk);
549 sk_refcnt_debug_release(sk);
551 atomic_dec(sk->sk_prot->orphan_count);
555 EXPORT_SYMBOL(inet_csk_destroy_sock);
557 int inet_csk_listen_start(struct sock *sk, const int nr_table_entries)
559 struct inet_sock *inet = inet_sk(sk);
560 struct inet_connection_sock *icsk = inet_csk(sk);
561 int rc = reqsk_queue_alloc(&icsk->icsk_accept_queue, nr_table_entries);
566 sk->sk_max_ack_backlog = 0;
567 sk->sk_ack_backlog = 0;
568 inet_csk_delack_init(sk);
570 /* There is race window here: we announce ourselves listening,
571 * but this transition is still not validated by get_port().
572 * It is OK, because this socket enters to hash table only
573 * after validation is complete.
575 sk->sk_state = TCP_LISTEN;
576 if (!sk->sk_prot->get_port(sk, inet->num)) {
577 inet->sport = htons(inet->num);
580 sk->sk_prot->hash(sk);
585 sk->sk_state = TCP_CLOSE;
586 __reqsk_queue_destroy(&icsk->icsk_accept_queue);
590 EXPORT_SYMBOL_GPL(inet_csk_listen_start);
593 * This routine closes sockets which have been at least partially
594 * opened, but not yet accepted.
596 void inet_csk_listen_stop(struct sock *sk)
598 struct inet_connection_sock *icsk = inet_csk(sk);
599 struct request_sock *acc_req;
600 struct request_sock *req;
602 inet_csk_delete_keepalive_timer(sk);
604 /* make all the listen_opt local to us */
605 acc_req = reqsk_queue_yank_acceptq(&icsk->icsk_accept_queue);
607 /* Following specs, it would be better either to send FIN
608 * (and enter FIN-WAIT-1, it is normal close)
609 * or to send active reset (abort).
610 * Certainly, it is pretty dangerous while synflood, but it is
611 * bad justification for our negligence 8)
612 * To be honest, we are not able to make either
613 * of the variants now. --ANK
615 reqsk_queue_destroy(&icsk->icsk_accept_queue);
617 while ((req = acc_req) != NULL) {
618 struct sock *child = req->sk;
620 acc_req = req->dl_next;
624 BUG_TRAP(!sock_owned_by_user(child));
627 sk->sk_prot->disconnect(child, O_NONBLOCK);
631 atomic_inc(sk->sk_prot->orphan_count);
633 inet_csk_destroy_sock(child);
635 bh_unlock_sock(child);
639 sk_acceptq_removed(sk);
642 BUG_TRAP(!sk->sk_ack_backlog);
645 EXPORT_SYMBOL_GPL(inet_csk_listen_stop);
647 void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr)
649 struct sockaddr_in *sin = (struct sockaddr_in *)uaddr;
650 const struct inet_sock *inet = inet_sk(sk);
652 sin->sin_family = AF_INET;
653 sin->sin_addr.s_addr = inet->daddr;
654 sin->sin_port = inet->dport;
657 EXPORT_SYMBOL_GPL(inet_csk_addr2sockaddr);
659 int inet_csk_ctl_sock_create(struct socket **sock, unsigned short family,
660 unsigned short type, unsigned char protocol)
662 int rc = sock_create_kern(family, type, protocol, sock);
665 (*sock)->sk->sk_allocation = GFP_ATOMIC;
666 inet_sk((*sock)->sk)->uc_ttl = -1;
668 * Unhash it so that IP input processing does not even see it,
669 * we do not wish this socket to see incoming packets.
671 (*sock)->sk->sk_prot->unhash((*sock)->sk);
676 EXPORT_SYMBOL_GPL(inet_csk_ctl_sock_create);
679 int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
680 char __user *optval, int __user *optlen)
682 const struct inet_connection_sock *icsk = inet_csk(sk);
684 if (icsk->icsk_af_ops->compat_getsockopt != NULL)
685 return icsk->icsk_af_ops->compat_getsockopt(sk, level, optname,
687 return icsk->icsk_af_ops->getsockopt(sk, level, optname,
691 EXPORT_SYMBOL_GPL(inet_csk_compat_getsockopt);
693 int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
694 char __user *optval, int optlen)
696 const struct inet_connection_sock *icsk = inet_csk(sk);
698 if (icsk->icsk_af_ops->compat_setsockopt != NULL)
699 return icsk->icsk_af_ops->compat_setsockopt(sk, level, optname,
701 return icsk->icsk_af_ops->setsockopt(sk, level, optname,
705 EXPORT_SYMBOL_GPL(inet_csk_compat_setsockopt);