SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 #endif
 190                 kfree(hashinfo->ehash_locks);
 191                 hashinfo->ehash_locks = NULL;
 192         }
 193 }
 194
 195 extern struct inet_bind_bucket *
 196                     inet_bind_bucket_create(struct kmem_cache *cachep,
 197                                             struct inet_bind_hashbucket *head,
 198                                             const unsigned short snum);
 199 extern void inet_bind_bucket_destroy(struct kmem_cache *cachep,
 200                                      struct inet_bind_bucket *tb);
 201
 202 static inline int inet_bhashfn(const __u16 lport, const int bhash_size)
 203 {
 204         return lport & (bhash_size - 1);
 205 }
 206
 207 extern void inet_bind_hash(struct sock *sk, struct inet_bind_bucket *tb,
 208                            const unsigned short snum);
 209
 210 /* These can have wildcards, don't try too hard. */
 211 static inline int inet_lhashfn(const unsigned short num)
 212 {
 213         return num & (INET_LHTABLE_SIZE - 1);
 214 }
 215
 216 static inline int inet_sk_listen_hashfn(const struct sock *sk)
 217 {
 218         return inet_lhashfn(inet_sk(sk)->num);
 219 }
 220
 221 /* Caller must disable local BH processing. */
 222 static inline void __inet_inherit_port(struct inet_hashinfo *table,
 223                                        struct sock *sk, struct sock *child)
 224 {
 225         const int bhash = inet_bhashfn(inet_sk(child)->num, table->bhash_size);
 226         struct inet_bind_hashbucket *head = &table->bhash[bhash];
 227         struct inet_bind_bucket *tb;
 228
 229         spin_lock(&head->lock);
 230         tb = inet_csk(sk)->icsk_bind_hash;
 231         sk_add_bind_node(child, &tb->owners);
 232         inet_csk(child)->icsk_bind_hash = tb;
 233         spin_unlock(&head->lock);
 234 }
 235
 236 static inline void inet_inherit_port(struct inet_hashinfo *table,
 237                                      struct sock *sk, struct sock *child)
 238 {
 239         local_bh_disable();
 240         __inet_inherit_port(table, sk, child);
 241         local_bh_enable();
 242 }
 243
 244 extern void inet_put_port(struct inet_hashinfo *table, struct sock *sk);
 245
 246 extern void inet_listen_wlock(struct inet_hashinfo *hashinfo);
 247
 248 /*
 249  * - We may sleep inside this lock.
 250  * - If sleeping is not required (or called from BH),
 251  *   use plain read_(un)lock(&inet_hashinfo.lhash_lock).
 252  */
 253 static inline void inet_listen_lock(struct inet_hashinfo *hashinfo)
 254 {
 255         /* read_lock synchronizes to candidates to writers */
 256         read_lock(&hashinfo->lhash_lock);
 257         atomic_inc(&hashinfo->lhash_users);
 258         read_unlock(&hashinfo->lhash_lock);
 259 }
 260
 261 static inline void inet_listen_unlock(struct inet_hashinfo *hashinfo)
 262 {
 263         if (atomic_dec_and_test(&hashinfo->lhash_users))
 264                 wake_up(&hashinfo->lhash_wait);
 265 }
 266
 267 extern void __inet_hash(struct inet_hashinfo *hashinfo, struct sock *sk);
 268 extern void __inet_hash_nolisten(struct inet_hashinfo *hinfo, struct sock *sk);
 269
 270 static inline void inet_hash(struct inet_hashinfo *hashinfo, struct sock *sk)
 271 {
 272         if (sk->sk_state != TCP_CLOSE) {
 273                 local_bh_disable();
 274                 __inet_hash(hashinfo, sk);
 275                 local_bh_enable();
 276         }
 277 }
 278
 279 static inline void inet_unhash(struct inet_hashinfo *hashinfo, struct sock *sk)
 280 {
 281         rwlock_t *lock;
 282
 283         if (sk_unhashed(sk))
 284                 goto out;
 285
 286         if (sk->sk_state == TCP_LISTEN) {
 287                 local_bh_disable();
 288                 inet_listen_wlock(hashinfo);
 289                 lock = &hashinfo->lhash_lock;
 290         } else {
 291                 lock = inet_ehash_lockp(hashinfo, sk->sk_hash);
 292                 write_lock_bh(lock);
 293         }
 294
 295         if (__sk_del_node_init(sk))
 296                 sock_prot_dec_use(sk->sk_prot);
 297         write_unlock_bh(lock);
 298 out:
 299         if (sk->sk_state == TCP_LISTEN)
 300                 wake_up(&hashinfo->lhash_wait);
 301 }
 302
 303 extern struct sock *__inet_lookup_listener(struct inet_hashinfo *hashinfo,
 304                                            const __be32 daddr,
 305                                            const unsigned short hnum,
 306                                            const int dif);
 307
 308 static inline struct sock *inet_lookup_listener(struct inet_hashinfo *hashinfo,
 309                                                 __be32 daddr, __be16 dport, int dif)
 310 {
 311         return __inet_lookup_listener(hashinfo, daddr, ntohs(dport), dif);
 312 }
 313
 314 /* Socket demux engine toys. */
 315 /* What happens here is ugly; there's a pair of adjacent fields in
 316    struct inet_sock; __be16 dport followed by __u16 num.  We want to
 317    search by pair, so we combine the keys into a single 32bit value
 318    and compare with 32bit value read from &...->dport.  Let's at least
 319    make sure that it's not mixed with anything else...
 320    On 64bit targets we combine comparisons with pair of adjacent __be32
 321    fields in the same way.
 322 */
 323 typedef __u32 __bitwise __portpair;
 324 #ifdef __BIG_ENDIAN
 325 #define INET_COMBINED_PORTS(__sport, __dport) \
 326         ((__force __portpair)(((__force __u32)(__be16)(__sport) << 16) | (__u32)(__dport)))
 327 #else /* __LITTLE_ENDIAN */
 328 #define INET_COMBINED_PORTS(__sport, __dport) \
 329         ((__force __portpair)(((__u32)(__dport) << 16) | (__force __u32)(__be16)(__sport)))
 330 #endif
 331
 332 #if (BITS_PER_LONG == 64)
 333 typedef __u64 __bitwise __addrpair;
 334 #ifdef __BIG_ENDIAN
 335 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 336         const __addrpair __name = (__force __addrpair) ( \
 337                                    (((__force __u64)(__be32)(__saddr)) << 32) | \
 338                                    ((__force __u64)(__be32)(__daddr)));
 339 #else /* __LITTLE_ENDIAN */
 340 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 341         const __addrpair __name = (__force __addrpair) ( \
 342                                    (((__force __u64)(__be32)(__daddr)) << 32) | \
 343                                    ((__force __u64)(__be32)(__saddr)));
 344 #endif /* __BIG_ENDIAN */
 345 #define INET_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)\
 346         (((__sk)->sk_hash == (__hash))                          &&      \
 347          ((*((__addrpair *)&(inet_sk(__sk)->daddr))) == (__cookie))     &&      \
 348          ((*((__portpair *)&(inet_sk(__sk)->dport))) == (__ports))      &&      \
 349          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 350 #define INET_TW_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)\
 351         (((__sk)->sk_hash == (__hash))                          &&      \
 352          ((*((__addrpair *)&(inet_twsk(__sk)->tw_daddr))) == (__cookie)) &&     \
 353          ((*((__portpair *)&(inet_twsk(__sk)->tw_dport))) == (__ports)) &&      \
 354          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 355 #else /* 32-bit arch */
 356 #define INET_ADDR_COOKIE(__name, __saddr, __daddr)
 357 #define INET_MATCH(__sk, __hash, __cookie, __saddr, __daddr, __ports, __dif)    \
 358         (((__sk)->sk_hash == (__hash))                          &&      \
 359          (inet_sk(__sk)->daddr          == (__saddr))           &&      \
 360          (inet_sk(__sk)->rcv_saddr      == (__daddr))           &&      \
 361          ((*((__portpair *)&(inet_sk(__sk)->dport))) == (__ports))      &&      \
 362          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 363 #define INET_TW_MATCH(__sk, __hash,__cookie, __saddr, __daddr, __ports, __dif)  \
 364         (((__sk)->sk_hash == (__hash))                          &&      \
 365          (inet_twsk(__sk)->tw_daddr     == (__saddr))           &&      \
 366          (inet_twsk(__sk)->tw_rcv_saddr == (__daddr))           &&      \
 367          ((*((__portpair *)&(inet_twsk(__sk)->tw_dport))) == (__ports)) &&      \
 368          (!((__sk)->sk_bound_dev_if) || ((__sk)->sk_bound_dev_if == (__dif))))
 369 #endif /* 64-bit arch */
 370
 371 /*
 372  * Sockets in TCP_CLOSE state are _always_ taken out of the hash, so we need
 373  * not check it for lookups anymore, thanks Alexey. -DaveM
 374  *
 375  * Local BH must be disabled here.
 376  */
 377 static inline struct sock *
 378         __inet_lookup_established(struct inet_hashinfo *hashinfo,
 379                                   const __be32 saddr, const __be16 sport,
 380                                   const __be32 daddr, const u16 hnum,
 381                                   const int dif)
 382 {
 383         INET_ADDR_COOKIE(acookie, saddr, daddr)
 384         const __portpair ports = INET_COMBINED_PORTS(sport, hnum);
 385         struct sock *sk;
 386         const struct hlist_node *node;
 387         /* Optimize here for direct hit, only listening connections can
 388          * have wildcards anyways.
 389          */
 390         unsigned int hash = inet_ehashfn(daddr, hnum, saddr, sport);
 391         struct inet_ehash_bucket *head = inet_ehash_bucket(hashinfo, hash);
 392         rwlock_t *lock = inet_ehash_lockp(hashinfo, hash);
 393
 394         prefetch(head->chain.first);
 395         read_lock(lock);
 396         sk_for_each(sk, node, &head->chain) {
 397                 if (INET_MATCH(sk, hash, acookie, saddr, daddr, ports, dif))
 398                         goto hit; /* You sunk my battleship! */
 399         }
 400
 401         /* Must check for a TIME_WAIT'er before going to listener hash. */
 402         sk_for_each(sk, node, &head->twchain) {
 403                 if (INET_TW_MATCH(sk, hash, acookie, saddr, daddr, ports, dif))
 404                         goto hit;
 405         }
 406         sk = NULL;
 407 out:
 408         read_unlock(lock);
 409         return sk;
 410 hit:
 411         sock_hold(sk);
 412         goto out;
 413 }
 414
 415 static inline struct sock *
 416         inet_lookup_established(struct inet_hashinfo *hashinfo,
 417                                 const __be32 saddr, const __be16 sport,
 418                                 const __be32 daddr, const __be16 dport,
 419                                 const int dif)
 420 {
 421         return __inet_lookup_established(hashinfo, saddr, sport, daddr,
 422                                          ntohs(dport), dif);
 423 }
 424
 425 static inline struct sock *__inet_lookup(struct inet_hashinfo *hashinfo,
 426                                          const __be32 saddr, const __be16 sport,
 427                                          const __be32 daddr, const __be16 dport,
 428                                          const int dif)
 429 {
 430         u16 hnum = ntohs(dport);
 431         struct sock *sk = __inet_lookup_established(hashinfo, saddr, sport, daddr,
 432                                                     hnum, dif);
 433         return sk ? : __inet_lookup_listener(hashinfo, daddr, hnum, dif);
 434 }
 435
 436 static inline struct sock *inet_lookup(struct inet_hashinfo *hashinfo,
 437                                        const __be32 saddr, const __be16 sport,
 438                                        const __be32 daddr, const __be16 dport,
 439                                        const int dif)
 440 {
 441         struct sock *sk;
 442
 443         local_bh_disable();
 444         sk = __inet_lookup(hashinfo, saddr, sport, daddr, dport, dif);
 445         local_bh_enable();
 446
 447         return sk;
 448 }
 449
 450 extern int inet_hash_connect(struct inet_timewait_death_row *death_row,
 451                              struct sock *sk);
 452 #endif /* _INET_HASHTABLES_H */