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/ip.h>
  20 #include <linux/ipv6.h>
  21 #include <linux/list.h>
  22 #include <linux/slab.h>
  23 #include <linux/socket.h>
  24 #include <linux/spinlock.h>
  25 #include <linux/types.h>
  26 #include <linux/wait.h>
  27 #include <linux/vmalloc.h>
  28
  29 #include <net/inet_connection_sock.h>
  30 #include <net/inet_sock.h>
  31 #include <net/sock.h>
  32 #include <net/route.h>
  33 #include <net/tcp_states.h>
  34 #include <net/netns/hash.h>
  35
  36 #include <linux/atomic.h>
  37 #include <asm/byteorder.h>
  38
  39 /* This is for all connections with a full identity, no wildcards.
  40  * The 'e' prefix stands for Establish, but we really put all sockets
  41  * but LISTEN ones.
  42  */
  43 struct inet_ehash_bucket {
  44         struct hlist_nulls_head chain;
  45 };
  46
  47 /* There are a few simple rules, which allow for local port reuse by
  48  * an application.  In essence:
  49  *
  50  *      1) Sockets bound to different interfaces may share a local port.
  51  *         Failing that, goto test 2.
  52  *      2) If all sockets have sk->sk_reuse set, and none of them are in
  53  *         TCP_LISTEN state, the port may be shared.
  54  *         Failing that, goto test 3.
  55  *      3) If all sockets are bound to a specific inet_sk(sk)->rcv_saddr local
  56  *         address, and none of them are the same, the port may be
  57  *         shared.
  58  *         Failing this, the port cannot be shared.
  59  *
  60  * The interesting point, is test #2.  This is what an FTP server does
  61  * all day.  To optimize this case we use a specific flag bit defined
  62  * below.  As we add sockets to a bind bucket list, we perform a
  63  * check of: (newsk->sk_reuse && (newsk->sk_state != TCP_LISTEN))
  64  * As long as all sockets added to a bind bucket pass this test,
  65  * the flag bit will be set.
  66  * The resulting situation is that tcp_v[46]_verify_bind() can just check
  67  * for this flag bit, if it is set and the socket trying to bind has
  68  * sk->sk_reuse set, we don't even have to walk the owners list at all,
  69  * we return that it is ok to bind this socket to the requested local port.
  70  *
  71  * Sounds like a lot of work, but it is worth it.  In a more naive
  72  * implementation (ie. current FreeBSD etc.) the entire list of ports
  73  * must be walked for each data port opened by an ftp server.  Needless
  74  * to say, this does not scale at all.  With a couple thousand FTP
  75  * users logged onto your box, isn't it nice to know that new data
  76  * ports are created in O(1) time?  I thought so. ;-)   -DaveM
  77  */
  78 struct inet_bind_bucket {
  79         possible_net_t          ib_net;
  80         unsigned short          port;
  81         signed char             fastreuse;
  82         signed char             fastreuseport;
  83         kuid_t                  fastuid;
  84         int                     num_owners;
  85         struct hlist_node       node;
  86         struct hlist_head       owners;
  87 };
  88
  89 static inline struct net *ib_net(struct inet_bind_bucket *ib)
  90 {
  91         return read_pnet(&ib->ib_net);
  92 }
  93
  94 #define inet_bind_bucket_for_each(tb, head) \
  95         hlist_for_each_entry(tb, head, node)
  96
  97 struct inet_bind_hashbucket {
  98         spinlock_t              lock;
  99         struct hlist_head       chain;
 100 };
 101
 102 /*
 103  * Sockets can be hashed in established or listening table
 104  * We must use different 'nulls' end-of-chain value for listening
 105  * hash table, or we might find a socket that was closed and
 106  * reallocated/inserted into established hash table
 107  */
 108 #define LISTENING_NULLS_BASE (1U << 29)
 109 struct inet_listen_hashbucket {
 110         spinlock_t              lock;
 111         struct hlist_nulls_head head;
 112 };
 113
 114 /* This is for listening sockets, thus all sockets which possess wildcards. */
 115 #define INET_LHTABLE_SIZE       32      /* Yes, really, this is all you need. */
 116
 117 struct inet_hashinfo {
 118         /* This is for sockets with full identity only.  Sockets here will
 119          * always be without wildcards and will have the following invariant:
 120          *
 121          *          TCP_ESTABLISHED <= sk->sk_state < TCP_CLOSE
 122          *
 123          */
 124         struct inet_ehash_bucket        *ehash;
 125         spinlock_t                      *ehash_locks;
 126         unsigned int                    ehash_mask;
 127         unsigned int                    ehash_locks_mask;
 128
 129         /* Ok, let's try this, I give up, we do need a local binding
 130          * TCP hash as well as the others for fast bind/connect.
 131          */
 132         struct inet_bind_hashbucket     *bhash;
 133
 134         unsigned int                    bhash_size;
 135         /* 4 bytes hole on 64 bit */
 136
 137         struct kmem_cache               *bind_bucket_cachep;
 138
 139         /* All the above members are written once at bootup and
 140          * never written again _or_ are predominantly read-access.
 141          *
 142          * Now align to a new cache line as all the following members
 143          * might be often dirty.
 144          */
 145         /* All sockets in TCP_LISTEN state will be in here.  This is the only
 146          * table where wildcard'd TCP sockets can exist.  Hash function here
 147          * is just local port number.
 148          */
 149         struct inet_listen_hashbucket   listening_hash[INET_LHTABLE_SIZE]
 150                                         ____cacheline_aligned_in_smp;
 151 };
 152
 153 static inline struct inet_ehash_bucket *inet_ehash_bucket(
 154         struct inet_hashinfo *hashinfo,
 155         unsigned int hash)
 156 {
 157         return &hashinfo->ehash[hash & hashinfo->ehash_mask];
 158 }
 159
 160 static inline spinlock_t *inet_ehash_lockp(
 161         struct inet_hashinfo *hashinfo,
 162         unsigned int hash)
 163 {
 164         return &hashinfo->ehash_locks[hash & hashinfo->ehash_locks_mask];
 165 }
 166
 167 static inline int inet_ehash_locks_alloc(struct inet_hashinfo *hashinfo)
 168 {
 169         unsigned int i, size = 256;
 170 #if defined(CONFIG_PROVE_LOCKING)
 171         unsigned int nr_pcpus = 2;
 172 #else
 173         unsigned int nr_pcpus = num_possible_cpus();
 174 #endif
 175         if (nr_pcpus >= 4)
 176                 size = 512;
 177         if (nr_pcpus >= 8)
 178                 size = 1024;
 179         if (nr_pcpus >= 16)
 180                 size = 2048;
 181         if (nr_pcpus >= 32)
 182                 size = 4096;
 183         if (sizeof(spinlock_t) != 0) {
 184 #ifdef CONFIG_NUMA
 185                 if (size * sizeof(spinlock_t) > PAGE_SIZE)
 186                         hashinfo->ehash_locks = vmalloc(size * sizeof(spinlock_t));
 187                 else
 188 #endif
 189                 hashinfo->ehash_locks = kmalloc(size * sizeof(spinlock_t),
 190                                                 GFP_KERNEL);
 191                 if (!hashinfo->ehash_locks)
 192                         return ENOMEM;
 193                 for (i = 0; i < size; i++)
 194                         spin_lock_init(&hashinfo->ehash_locks[i]);
 195         }
 196         hashinfo->ehash_locks_mask = size - 1;
 197         return 0;
 198 }
 199
 200 static inline void inet_ehash_locks_free(struct inet_hashinfo *hashinfo)
 201 {
 202         if (hashinfo->ehash_locks) {
 203 #ifdef CONFIG_NUMA
 204                 unsigned int size = (hashinfo->ehash_locks_mask + 1) *
 205                                                         sizeof(spinlock_t);
 206                 if (size > PAGE_SIZE)
 207                         vfree(hashinfo->ehash_locks);
 208                 else
 209 #endif
 210                 kfree(hashinfo->ehash_locks);
 211                 hashinfo->ehash_locks = NULL;
 212         }
 213 }
 214
 215 struct inet_bind_bucket *
 216 inet_bind_bucket_create(struct kmem_cache *cachep, struct net *net,
 217                         struct inet_bind_hashbucket *head,
 218                         const unsigned short snum);
 219 void inet_bind_bucket_destroy(struct kmem_cache *cachep,
 220                               struct inet_bind_bucket *tb);
 221
 222 static inline u32 inet_bhashfn(const struct net *net, const __u16 lport,
 223                                const u32 bhash_size)
 224 {
 225         return (lport + net_hash_mix(net)) & (bhash_size - 1);
 226 }
 227
 228 void inet_bind_hash(struct sock *sk, struct inet_bind_bucket *tb,
 229                     const unsigned short snum);
 230
 231 /* These can have wildcards, don't try too hard. */
 232 static inline u32 inet_lhashfn(const struct net *net, const unsigned short num)
 233 {
 234         return (num + net_hash_mix(net)) & (INET_LHTABLE_SIZE - 1);
 235 }
 236
 237 static inline int inet_sk_listen_hashfn(const struct sock *sk)
 238 {
 239         return inet_lhashfn(sock_net(sk), inet_sk(sk)->inet_num);
 240 }
 241
 242 /* Caller must disable local BH processing. */
 243 int __inet_inherit_port(struct sock *sk, struct sock *child);
 244
 245 void inet_put_port(struct sock *sk);
 246
 247 void inet_hashinfo_init(struct inet_hashinfo *h);
 248
 249 int __inet_hash_nolisten(struct sock *sk, struct inet_timewait_sock *tw);
 250 int __inet_hash(struct sock *sk, struct inet_timewait_sock *tw);
 251 void inet_hash(struct sock *sk);
 252 void inet_unhash(struct sock *sk);
 253
 254 struct sock *__inet_lookup_listener(struct net *net,
 255                                     struct inet_hashinfo *hashinfo,
 256                                     const __be32 saddr, const __be16 sport,
 257                                     const __be32 daddr,
 258                                     const unsigned short hnum,
 259                                     const int dif);
 260
 261 static inline struct sock *inet_lookup_listener(struct net *net,
 262                 struct inet_hashinfo *hashinfo,
 263                 __be32 saddr, __be16 sport,
 264                 __be32 daddr, __be16 dport, int dif)
 265 {
 266         return __inet_lookup_listener(net, hashinfo, saddr, sport,
 267                                       daddr, ntohs(dport), dif);
 268 }
 269
 270 /* Socket demux engine toys. */
 271 /* What happens here is ugly; there's a pair of adjacent fields in
 272    struct inet_sock; __be16 dport followed by __u16 num.  We want to
 273    search by pair, so we combine the keys into a single 32bit value
 274    and compare with 32bit value read from &...->dport.  Let's at least
 275    make sure that it's not mixed with anything else...
 276    On 64bit targets we combine comparisons with pair of adjacent __be32
 277    fields in the same way.
 278 */
 279 #ifdef __BIG_ENDIAN
 280 #define INET_COMBINED_PORTS(__sport, __dport) \
 281         ((__force __portpair)(((__force __u32)(__be16)(__sport) << 16) | (__u32)(__dport)))
 282 #else /* __LITTLE_ENDIAN */
 283 #define INET_COMBINED_PORTS(__sport, __dport) \
 284         ((__force __portpair)(((__u32)(__dport) << 16) | (__force __u32)(__be16)(__sport)))
 285 #endif
 286
 287 #if (BITS_PER_LONG == 64)
 288 #ifdef __BIG_ENDIAN
 289 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 290         const __addrpair __name = (__force __addrpair) ( \
 291                                    (((__force __u64)(__be32)(__saddr)) << 32) | \
 292                                    ((__force __u64)(__be32)(__daddr)))
 293 #else /* __LITTLE_ENDIAN */
 294 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 295         const __addrpair __name = (__force __addrpair) ( \
 296                                    (((__force __u64)(__be32)(__daddr)) << 32) | \
 297                                    ((__force __u64)(__be32)(__saddr)))
 298 #endif /* __BIG_ENDIAN */
 299 #define INET_MATCH(__sk, __net, __cookie, __saddr, __daddr, __ports, __dif)     \
 300         (((__sk)->sk_portpair == (__ports))                     &&      \
 301          ((__sk)->sk_addrpair == (__cookie))                    &&      \
 302          (!(__sk)->sk_bound_dev_if      ||                              \
 303            ((__sk)->sk_bound_dev_if == (__dif)))                &&      \
 304          net_eq(sock_net(__sk), (__net)))
 305 #else /* 32-bit arch */
 306 #define INET_ADDR_COOKIE(__name, __saddr, __daddr) \
 307         const int __name __deprecated __attribute__((unused))
 308
 309 #define INET_MATCH(__sk, __net, __cookie, __saddr, __daddr, __ports, __dif) \
 310         (((__sk)->sk_portpair == (__ports))             &&              \
 311          ((__sk)->sk_daddr      == (__saddr))           &&              \
 312          ((__sk)->sk_rcv_saddr  == (__daddr))           &&              \
 313          (!(__sk)->sk_bound_dev_if      ||                              \
 314            ((__sk)->sk_bound_dev_if == (__dif)))        &&              \
 315          net_eq(sock_net(__sk), (__net)))
 316 #endif /* 64-bit arch */
 317
 318 /*
 319  * Sockets in TCP_CLOSE state are _always_ taken out of the hash, so we need
 320  * not check it for lookups anymore, thanks Alexey. -DaveM
 321  *
 322  * Local BH must be disabled here.
 323  */
 324 struct sock *__inet_lookup_established(struct net *net,
 325                                        struct inet_hashinfo *hashinfo,
 326                                        const __be32 saddr, const __be16 sport,
 327                                        const __be32 daddr, const u16 hnum,
 328                                        const int dif);
 329
 330 static inline struct sock *
 331         inet_lookup_established(struct net *net, struct inet_hashinfo *hashinfo,
 332                                 const __be32 saddr, const __be16 sport,
 333                                 const __be32 daddr, const __be16 dport,
 334                                 const int dif)
 335 {
 336         return __inet_lookup_established(net, hashinfo, saddr, sport, daddr,
 337                                          ntohs(dport), dif);
 338 }
 339
 340 static inline struct sock *__inet_lookup(struct net *net,
 341                                          struct inet_hashinfo *hashinfo,
 342                                          const __be32 saddr, const __be16 sport,
 343                                          const __be32 daddr, const __be16 dport,
 344                                          const int dif)
 345 {
 346         u16 hnum = ntohs(dport);
 347         struct sock *sk = __inet_lookup_established(net, hashinfo,
 348                                 saddr, sport, daddr, hnum, dif);
 349
 350         return sk ? : __inet_lookup_listener(net, hashinfo, saddr, sport,
 351                                              daddr, hnum, dif);
 352 }
 353
 354 static inline struct sock *inet_lookup(struct net *net,
 355                                        struct inet_hashinfo *hashinfo,
 356                                        const __be32 saddr, const __be16 sport,
 357                                        const __be32 daddr, const __be16 dport,
 358                                        const int dif)
 359 {
 360         struct sock *sk;
 361
 362         local_bh_disable();
 363         sk = __inet_lookup(net, hashinfo, saddr, sport, daddr, dport, dif);
 364         local_bh_enable();
 365
 366         return sk;
 367 }
 368
 369 static inline struct sock *__inet_lookup_skb(struct inet_hashinfo *hashinfo,
 370                                              struct sk_buff *skb,
 371                                              const __be16 sport,
 372                                              const __be16 dport)
 373 {
 374         struct sock *sk = skb_steal_sock(skb);
 375         const struct iphdr *iph = ip_hdr(skb);
 376
 377         if (sk)
 378                 return sk;
 379         else
 380                 return __inet_lookup(dev_net(skb_dst(skb)->dev), hashinfo,
 381                                      iph->saddr, sport,
 382                                      iph->daddr, dport, inet_iif(skb));
 383 }
 384
 385 u32 sk_ehashfn(const struct sock *sk);
 386 u32 inet6_ehashfn(const struct net *net,
 387                   const struct in6_addr *laddr, const u16 lport,
 388                   const struct in6_addr *faddr, const __be16 fport);
 389
 390 static inline void sk_daddr_set(struct sock *sk, __be32 addr)
 391 {
 392         sk->sk_daddr = addr; /* alias of inet_daddr */
 393 #if IS_ENABLED(CONFIG_IPV6)
 394         ipv6_addr_set_v4mapped(addr, &sk->sk_v6_daddr);
 395 #endif
 396 }
 397
 398 static inline void sk_rcv_saddr_set(struct sock *sk, __be32 addr)
 399 {
 400         sk->sk_rcv_saddr = addr; /* alias of inet_rcv_saddr */
 401 #if IS_ENABLED(CONFIG_IPV6)
 402         ipv6_addr_set_v4mapped(addr, &sk->sk_v6_rcv_saddr);
 403 #endif
 404 }
 405
 406 int __inet_hash_connect(struct inet_timewait_death_row *death_row,
 407                         struct sock *sk, u32 port_offset,
 408                         int (*check_established)(struct inet_timewait_death_row *,
 409                                                  struct sock *, __u16,
 410                                                  struct inet_timewait_sock **));
 411
 412 int inet_hash_connect(struct inet_timewait_death_row *death_row,
 413                       struct sock *sk);
 414 #endif /* _INET_HASHTABLES_H */