include/net/inet_hashtables.h

   1 /*
   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  * Authors:     Lotsa people, from code originally in tcp
   7  *
   8  *      This program is free software; you can redistribute it and/or
   9  *      modify it under the terms of the GNU General Public License
  10  *      as published by the Free Software Foundation; either version
  11  *      2 of the License, or (at your option) any later version.
  12  */
  13
  14 #ifndef _INET_HASHTABLES_H
  15 #define _INET_HASHTABLES_H
  16
  17
  18 #include <linux/interrupt.h>
  19 #include <linux/ipv6.h>
  20 #include <linux/list.h>
  21 #include <linux/slab.h>
  22 #include <linux/socket.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/types.h>
  25 #include <linux/wait.h>
  26 #include <linux/vmalloc.h>
  27
  28 #include <net/inet_connection_sock.h>
  29 #include <net/inet_sock.h>
  30 #include <net/sock.h>
  31 #include <net/tcp_states.h>
  32
  33 #include <asm/atomic.h>
  34 #include <asm/byteorder.h>
  35
  36 /* This is for all connections with a full identity, no wildcards.
  37  * One chain is dedicated to TIME_WAIT sockets.
  38  * I'll experiment with dynamic table growth later.
  39  */
  40 struct inet_ehash_bucket {
  41         struct hlist_head chain;
  42         struct hlist_head twchain;
  43 };
  44
  45 /* There are a few simple rules, which allow for local port reuse by
  46  * an application.  In essence:
  47  *
  48  *      1) Sockets bound to different interfaces may share a local port.
  49  *         Failing that, goto test 2.
  50  *      2) If all sockets have sk->sk_reuse set, and none of them are in
  51  *         TCP_LISTEN state, the port may be shared.
  52  *         Failing that, goto test 3.
  53  *      3) If all sockets are bound to a specific inet_sk(sk)->rcv_saddr local
  54  *         address, and none of them are the same, the port may be
  55  *         shared.
  56  *         Failing this, the port cannot be shared.
  57  *
  58  * The interesting point, is test #2.  This is what an FTP server does
  59  * all day.  To optimize this case we use a specific flag bit defined
  60  * below.  As we add sockets to a bind bucket list, we perform a
  61  * check of: (newsk->sk_reuse && (newsk->sk_state != TCP_LISTEN))
  62  * As long as all sockets added to a bind bucket pass this test,
  63  * the flag bit will be set.
  64  * The resulting situation is that tcp_v[46]_verify_bind() can just check
  65  * for this flag bit, if it is set and the socket trying to bind has
  66  * sk->sk_reuse set, we don't even have to walk the owners list at all,
  67  * we return that it is ok to bind this socket to the requested local port.
  68  *
  69  * Sounds like a lot of work, but it is worth it.  In a more naive
  70  * implementation (ie. current FreeBSD etc.) the entire list of ports
  71  * must be walked for each data port opened by an ftp server.  Needless
  72  * to say, this does not scale at all.  With a couple thousand FTP
  73  * users logged onto your box, isn't it nice to know that new data
  74  * ports are created in O(1) time?  I thought so. ;-)   -DaveM
  75  */
  76 struct inet_bind_bucket {
  77         unsigned short          port;
  78         signed short            fastreuse;
  79         struct hlist_node       node;
  80         struct hlist_head       owners;
  81 };
  82
  83 #define inet_bind_bucket_for_each(tb, node, head) \
  84         hlist_for_each_entry(tb, node, head, node)
  85
  86 struct inet_bind_hashbucket {
  87         spinlock_t              lock;
  88         struct hlist_head       chain;
  89 };
  90
  91 /* This is for listening sockets, thus all sockets which possess wildcards. */
  92 #define INET_LHTABLE_SIZE       32      /* Yes, really, this is all you need. */
  93
  94 struct inet_hashinfo {
  95         /* This is for sockets with full identity only.  Sockets here will
  96          * always be without wildcards and will have the following invariant:
  97          *
  98          *          TCP_ESTABLISHED <= sk->sk_state < TCP_CLOSE
  99          *
 100          * TIME_WAIT sockets use a separate chain (twchain).
 101          */
 102         struct inet_ehash_bucket        *ehash;
 103         rwlock_t                        *ehash_locks;
 104         unsigned int                    ehash_size;
 105         unsigned int                    ehash_locks_mask;
 106
 107         /* Ok, let's try this, I give up, we do need a local binding
 108          * TCP hash as well as the others for fast bind/connect.
 109          */
 110         struct inet_bind_hashbucket     *bhash;
 111
 112         unsigned int                    bhash_size;
 113         /* Note : 4 bytes padding on 64 bit arches */
 114
 115         /* All sockets in TCP_LISTEN state will be in here.  This is the only
 116          * table where wildcard'd TCP sockets can exist.  Hash function here
 117          * is just local port number.
 118          */
 119         struct hlist_head               listening_hash[INET_LHTABLE_SIZE];
 120
 121         /* All the above members are written once at bootup and
 122          * never written again _or_ are predominantly read-access.
 123          *
 124          * Now align to a new cache line as all the following members
 125          * are often dirty.
 126          */
 127         rwlock_t                        lhash_lock ____cacheline_aligned;
 128         atomic_t                        lhash_users;
 129         wait_queue_head_t               lhash_wait;
 130         struct kmem_cache                       *bind_bucket_cachep;
 131 };
 132
 133 static inline struct inet_ehash_bucket *inet_ehash_bucket(
 134         struct inet_hashinfo *hashinfo,
 135         unsigned int hash)
 136 {
 137         return &hashinfo->ehash[hash & (hashinfo->ehash_size - 1)];
 138 }
 139
 140 static inline rwlock_t *inet_ehash_lockp(
 141         struct inet_hashinfo *hashinfo,
 142         unsigned int hash)
 143 {
 144         return &hashinfo->ehash_locks[hash & hashinfo->ehash_locks_mask];
 145 }
 146
 147 static inline int inet_ehash_locks_alloc(struct inet_hashinfo *hashinfo)
 148 {
 149         unsigned int i, size = 256;
 150 #if defined(CONFIG_PROVE_LOCKING)
 151         unsigned int nr_pcpus = 2;
 152 #else
 153         unsigned int nr_pcpus = num_possible_cpus();
 154 #endif
 155         if (nr_pcpus >= 4)
 156                 size = 512;
 157         if (nr_pcpus >= 8)
 158                 size = 1024;
 159         if (nr_pcpus >= 16)
 160                 size = 2048;
 161         if (nr_pcpus >= 32)
 162                 size = 4096;
 163         if (sizeof(rwlock_t) != 0) {
 164 #ifdef CONFIG_NUMA
 165                 if (size * sizeof(rwlock_t) > PAGE_SIZE)
 166                         hashinfo->ehash_locks = vmalloc(size * sizeof(rwlock_t));
 167                 else
 168 #endif
 169                 hashinfo->ehash_locks = kmalloc(size * sizeof(rwlock_t),
 170                                                 GFP_KERNEL);
 171                 if (!hashinfo->ehash_locks)
 172                         return ENOMEM;
 173                 for (i = 0; i < size; i++)
 174                         rwlock_init(&hashinfo->ehash_locks[i]);
 175         }
 176         hashinfo->ehash_locks_mask = size - 1;
 177         return 0;
 178 }
 179
 180 static inline void inet_ehash_locks_free(struct inet_hashinfo *hashinfo)
 181 {
 182         if (hashinfo->ehash_locks) {
 183 #ifdef CONFIG_NUMA
 184                 unsigned int size = (hashinfo->ehash_locks_mask + 1) *
 185                                                         sizeof(rwlock_t);
 186                 if (size > PAGE_SIZE)
 187                         vfree(hashinfo->ehash_locks);
 188                 else
 189 #else
 190                 kfree(hashinfo->ehash_locks);
 191 #endif
 192                 hashinfo->ehash_locks = NULL;
 193         }
 194 }
 195
 196 extern struct inet_bind_bucket *
 197                     inet_bind_bucket_create(struct kmem_cache *cachep,
 198                                             struct inet_bind_hashbucket *head,
 199                                             const unsigned short snum);
 200 extern void inet_bind_bucket_destroy(struct kmem_cache *cachep,
 201                                      struct inet_bind_bucket *tb);
 202
 203 static inline int inet_bhashfn(const __u16 lport, const int bhash_size)
 204 {
 205         return lport & (bhash_size - 1);
 206 }
 207
 208 extern void inet_bind_hash(struct sock *sk, struct inet_bind_bucket *tb,
 209                            const unsigned short snum);
 210
 211 /* These can have wildcards, don't try too hard. */
 212 static inline int inet_lhashfn(const unsigned short num)
 213 {
 214         return num & (INET_LHTABLE_SIZE - 1);
 215 }
 216
 217 static inline int inet_sk_listen_hashfn(const struct sock *sk)
 218 {
 219         return inet_lhashfn(inet_sk(sk)->num);
 220 }
 221
 222 /* Caller must disable local BH processing. */
 223 static inline void __inet_inherit_port(struct inet_hashinfo *table,
 224                                        struct sock *sk, struct sock *child)
 225 {
 226         const int bhash = inet_bhashfn(inet_sk(child)->num, table->bhash_size);
 227         struct inet_bind_hashbucket *head = &table->bhash[bhash];
 228         struct inet_bind_bucket *tb;
 229
 230         spin_lock(&head->lock);
 231         tb = inet_csk(sk)->icsk_bind_hash;
 232         sk_add_bind_node(child, &tb->owners);
 233         inet_csk(child)->icsk_bind_hash = tb;
 234         spin_unlock(&head->lock);
 235 }
 236
 237 static inline void inet_inherit_port(struct inet_hashinfo *table,
 238                                      struct sock *sk, struct sock *child)
 239 {
 240         local_bh_disable();
 241         __inet_inherit_port(table, sk, child);
 242         local_bh_enable();
 243 }
 244
 245 extern void inet_put_port(struct inet_hashinfo *table, struct sock *sk);
 246
 247 extern void inet_listen_wlock(struct inet_hashinfo *hashinfo);
 248
 249 /*
 250  * - We may sleep inside this lock.
 251  * - If sleeping is not required (or called from BH),
 252  *   use plain read_(un)lock(&inet_hashinfo.lhash_lock).
 253  */
 254 static inline void inet_listen_lock(struct inet_hashinfo *hashinfo)
 255 {
 256         /* read_lock synchronizes to candidates to writers */
 257         read_lock(&hashinfo->lhash_lock);
 258         atomic_inc(&hashinfo->lhash_users);
 259         read_unlock(&hashinfo->lhash_lock);
 260 }
 261
 262 static inline void inet_listen_unlock(struct inet_hashinfo *hashinfo)
 263 {
 264         if (atomic_dec_and_test(&hashinfo->lhash_users))
 265                 wake_up(&hashinfo->lhash_wait);
 266 }
 267
 268 static inline void __inet_hash(struct inet_hashinfo *hashinfo,
 269                                struct sock *sk, const int listen_possible)
 270 {
 271         struct hlist_head *list;
 272         rwlock_t *lock;
 273
 274         BUG_TRAP(sk_unhashed(sk));
 275         if (listen_possible && sk->sk_state == TCP_LISTEN) {
 276                 list = &hashinfo->listening_hash[inet_sk_listen_hashfn(sk)];
 277                 lock = &hashinfo->lhash_lock;
 278                 inet_listen_wlock(hashinfo);
 279         } else {
 280                 struct inet_ehash_bucket *head;
 281                 sk->sk_hash = inet_sk_ehashfn(sk);
 282                 head = inet_ehash_bucket(hashinfo, sk->sk_hash);
 283                 list = &head->chain;
 284                 lock = inet_ehash_lockp(hashinfo, sk->sk_hash);
 285                 write_lock(lock);
 286         }
 287         __sk_add_node(sk, list);
 288         sock_prot_inc_use(sk->sk_prot);
 289         write_unlock(lock);
 290         if (listen_possible && sk->sk_state == TCP_LISTEN)
 291                 wake_up(&hashinfo->lhash_wait);
 292 }
 293
 294 static inline void inet_hash(struct inet_hashinfo *hashinfo, struct sock *sk)
 295 {
 296         if (sk->sk_state != TCP_CLOSE) {
 297                 local_bh_disable();
 298                 __inet_hash(hashinfo, sk, 1);
 299                 local_bh_enable();
 300         }
 301 }
 302
 303 static inline void inet_unhash(struct inet_hashinfo *hashinfo, struct sock *sk)
 304 {
 305         rwlock_t *lock;
 306
 307         if (sk_unhashed(sk))
 308                 goto out;
 309
 310         if (sk->sk_state == TCP_LISTEN) {
 311                 local_bh_disable();
 312                 inet_listen_wlock(hashinfo);
 313                 lock = &hashinfo->lhash_lock;
 314         } else {
 315                 lock = inet_ehash_lockp(hashinfo, sk->sk_hash);
 316                 write_lock_bh(lock);
 317         }
 318
 319         if (__sk_del_node_init(sk))
 320                 sock_prot_dec_use(sk->sk_prot);
 321         write_unlock_bh(lock);
 322 out:
 323         if (sk->sk_state == TCP_LISTEN)
 324                 wake_up(&hashinfo->lhash_wait);
 325 }
 326
 327 extern struct sock *__inet_lookup_listener(struct inet_hashinfo *hashinfo,
 328                                            const __be32 daddr,
 329                                            const unsigned short hnum,
 330                                            const int dif);
 331
 332 static inline struct sock *inet_lookup_listener(struct inet_hashinfo *hashinfo,
 333                                                 __be32 daddr, __be16 dport, int dif)
 334 {
 335         return __inet_lookup_listener(hashinfo, daddr, ntohs(dport), dif);
 336 }
 337
 338 /* Socket demux engine toys. */
 339 /* What happens here is ugly; there's a pair of adjacent fields in
 340    struct inet_sock; __be16 dport followed by __u16 num.  We want to
 341    search by pair, so we combine the keys into a single 32bit value
 342    and compare with 32bit value read from &...->dport.  Let's at least
 343    make sure that it's not mixed with anything else...
 344    On 64bit targets we combine comparisons with pair of adjacent __be32
 345    fields in the same way.
 346 */
 347 typedef __u32 __bitwise __portpair;
 348 #ifdef __BIG_ENDIAN
 349 #define INET_COMBINED_PORTS(__sport, __dport) \
 350         ((__force __portpair)(((__force __u32)(__be16)(__sport) << 16) | (__u32)(__dport)))
 351 #else /* __LITTLE_ENDIAN */
 352 #define INET_COMBINED_PORTS(__sport, __dport) \
 353         ((__force __portpair)(((__u32)(__dport) << 16) | (__force __u32)(__be16)(__sport)))
 354 #endif
 355
 356 #if (BITS_PER_LONG == 64)
 357 typedef __u64 __bitwise __addrpair;
 358 #ifdef __BIG_ENDIAN
 359 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 360         const __addrpair __name = (__force __addrpair) ( \
 361                                    (((__force __u64)(__be32)(__saddr)) << 32) | \
 362                                    ((__force __u64)(__be32)(__daddr)));
 363 #else /* __LITTLE_ENDIAN */
 364 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 365         const __addrpair __name = (__force __addrpair) ( \
 366                                    (((__force __u64)(__be32)(__daddr)) << 32) | \
 367                                    ((__force __u64)(__be32)(__saddr)));
 368 #endif /* __BIG_ENDIAN */
 369 #define INET_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)\
 370         (((__sk)->sk_hash == (__hash))                          &&      \
 371          ((*((__addrpair *)&(inet_sk(__sk)->daddr))) == (__cookie))     &&      \
 372          ((*((__portpair *)&(inet_sk(__sk)->dport))) == (__ports))      &&      \
 373          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 374 #define INET_TW_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)\
 375         (((__sk)->sk_hash == (__hash))                          &&      \
 376          ((*((__addrpair *)&(inet_twsk(__sk)->tw_daddr))) == (__cookie)) &&     \
 377          ((*((__portpair *)&(inet_twsk(__sk)->tw_dport))) == (__ports)) &&      \
 378          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 379 #else /* 32-bit arch */
 380 #define INET_ADDR_COOKIE(__name, __saddr, __daddr)
 381 #define INET_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)    \
 382         (((__sk)->sk_hash == (__hash))                          &&      \
 383          (inet_sk(__sk)->daddr          == (__saddr))           &&      \
 384          (inet_sk(__sk)->rcv_saddr      == (__daddr))           &&      \
 385          ((*((__portpair *)&(inet_sk(__sk)->dport))) == (__ports))      &&      \
 386          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 387 #define INET_TW_MATCH(__sk, __hash,__cookie, __saddr, __daddr, __ports, __dif)  \
 388         (((__sk)->sk_hash == (__hash))                          &&      \
 389          (inet_twsk(__sk)->tw_daddr     == (__saddr))           &&      \
 390          (inet_twsk(__sk)->tw_rcv_saddr == (__daddr))           &&      \
 391          ((*((__portpair *)&(inet_twsk(__sk)->tw_dport))) == (__ports)) &&      \
 392          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 393 #endif /* 64-bit arch */
 394
 395 /*
 396  * Sockets in TCP_CLOSE state are _always_ taken out of the hash, so we need
 397  * not check it for lookups anymore, thanks Alexey. -DaveM
 398  *
 399  * Local BH must be disabled here.
 400  */
 401 static inline struct sock *
 402         __inet_lookup_established(struct inet_hashinfo *hashinfo,
 403                                   const __be32 saddr, const __be16 sport,
 404                                   const __be32 daddr, const u16 hnum,
 405                                   const int dif)
 406 {
 407         INET_ADDR_COOKIE(acookie, saddr, daddr)
 408         const __portpair ports = INET_COMBINED_PORTS(sport, hnum);
 409         struct sock *sk;
 410         const struct hlist_node *node;
 411         /* Optimize here for direct hit, only listening connections can
 412          * have wildcards anyways.
 413          */
 414         unsigned int hash = inet_ehashfn(daddr, hnum, saddr, sport);
 415         struct inet_ehash_bucket *head = inet_ehash_bucket(hashinfo, hash);
 416         rwlock_t *lock = inet_ehash_lockp(hashinfo, hash);
 417
 418         prefetch(head->chain.first);
 419         read_lock(lock);
 420         sk_for_each(sk, node, &head->chain) {
 421                 if (INET_MATCH(sk, hash, acookie, saddr, daddr, ports, dif))
 422                         goto hit; /* You sunk my battleship! */
 423         }
 424
 425         /* Must check for a TIME_WAIT'er before going to listener hash. */
 426         sk_for_each(sk, node, &head->twchain) {
 427                 if (INET_TW_MATCH(sk, hash, acookie, saddr, daddr, ports, dif))
 428                         goto hit;
 429         }
 430         sk = NULL;
 431 out:
 432         read_unlock(lock);
 433         return sk;
 434 hit:
 435         sock_hold(sk);
 436         goto out;
 437 }
 438
 439 static inline struct sock *
 440         inet_lookup_established(struct inet_hashinfo *hashinfo,
 441                                 const __be32 saddr, const __be16 sport,
 442                                 const __be32 daddr, const __be16 dport,
 443                                 const int dif)
 444 {
 445         return __inet_lookup_established(hashinfo, saddr, sport, daddr,
 446                                          ntohs(dport), dif);
 447 }
 448
 449 static inline struct sock *__inet_lookup(struct inet_hashinfo *hashinfo,
 450                                          const __be32 saddr, const __be16 sport,
 451                                          const __be32 daddr, const __be16 dport,
 452                                          const int dif)
 453 {
 454         u16 hnum = ntohs(dport);
 455         struct sock *sk = __inet_lookup_established(hashinfo, saddr, sport, daddr,
 456                                                     hnum, dif);
 457         return sk ? : __inet_lookup_listener(hashinfo, daddr, hnum, dif);
 458 }
 459
 460 static inline struct sock *inet_lookup(struct inet_hashinfo *hashinfo,
 461                                        const __be32 saddr, const __be16 sport,
 462                                        const __be32 daddr, const __be16 dport,
 463                                        const int dif)
 464 {
 465         struct sock *sk;
 466
 467         local_bh_disable();
 468         sk = __inet_lookup(hashinfo, saddr, sport, daddr, dport, dif);
 469         local_bh_enable();
 470
 471         return sk;
 472 }
 473
 474 extern int inet_hash_connect(struct inet_timewait_death_row *death_row,
 475                              struct sock *sk);
 476 #endif /* _INET_HASHTABLES_H */