fs/nfsd/nfscache.c

   1 /*
   2  * Request reply cache. This is currently a global cache, but this may
   3  * change in the future and be a per-client cache.
   4  *
   5  * This code is heavily inspired by the 44BSD implementation, although
   6  * it does things a bit differently.
   7  *
   8  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
   9  */
  10
  11 #include <linux/slab.h>
  12 #include <linux/sunrpc/addr.h>
  13 #include <linux/highmem.h>
  14 #include <linux/log2.h>
  15 #include <linux/hash.h>
  16 #include <net/checksum.h>
  17
  18 #include "nfsd.h"
  19 #include "cache.h"
  20
  21 #define NFSDDBG_FACILITY        NFSDDBG_REPCACHE
  22
  23 /*
  24  * We use this value to determine the number of hash buckets from the max
  25  * cache size, the idea being that when the cache is at its maximum number
  26  * of entries, then this should be the average number of entries per bucket.
  27  */
  28 #define TARGET_BUCKET_SIZE      64
  29
  30 struct nfsd_drc_bucket {
  31         struct list_head lru_head;
  32         spinlock_t cache_lock;
  33 };
  34
  35 static struct nfsd_drc_bucket   *drc_hashtbl;
  36 static struct kmem_cache        *drc_slab;
  37
  38 /* max number of entries allowed in the cache */
  39 static unsigned int             max_drc_entries;
  40
  41 /* number of significant bits in the hash value */
  42 static unsigned int             maskbits;
  43 static unsigned int             drc_hashsize;
  44
  45 /*
  46  * Stats and other tracking of on the duplicate reply cache. All of these and
  47  * the "rc" fields in nfsdstats are protected by the cache_lock
  48  */
  49
  50 /* total number of entries */
  51 static atomic_t                 num_drc_entries;
  52
  53 /* cache misses due only to checksum comparison failures */
  54 static unsigned int             payload_misses;
  55
  56 /* amount of memory (in bytes) currently consumed by the DRC */
  57 static unsigned int             drc_mem_usage;
  58
  59 /* longest hash chain seen */
  60 static unsigned int             longest_chain;
  61
  62 /* size of cache when we saw the longest hash chain */
  63 static unsigned int             longest_chain_cachesize;
  64
  65 static int      nfsd_cache_append(struct svc_rqst *rqstp, struct kvec *vec);
  66 static void     cache_cleaner_func(struct work_struct *unused);
  67 static unsigned long nfsd_reply_cache_count(struct shrinker *shrink,
  68                                             struct shrink_control *sc);
  69 static unsigned long nfsd_reply_cache_scan(struct shrinker *shrink,
  70                                            struct shrink_control *sc);
  71
  72 static struct shrinker nfsd_reply_cache_shrinker = {
  73         .scan_objects = nfsd_reply_cache_scan,
  74         .count_objects = nfsd_reply_cache_count,
  75         .seeks  = 1,
  76 };
  77
  78 /*
  79  * locking for the reply cache:
  80  * A cache entry is "single use" if c_state == RC_INPROG
  81  * Otherwise, it when accessing _prev or _next, the lock must be held.
  82  */
  83 static DECLARE_DELAYED_WORK(cache_cleaner, cache_cleaner_func);
  84
  85 /*
  86  * Put a cap on the size of the DRC based on the amount of available
  87  * low memory in the machine.
  88  *
  89  *  64MB:    8192
  90  * 128MB:   11585
  91  * 256MB:   16384
  92  * 512MB:   23170
  93  *   1GB:   32768
  94  *   2GB:   46340
  95  *   4GB:   65536
  96  *   8GB:   92681
  97  *  16GB:  131072
  98  *
  99  * ...with a hard cap of 256k entries. In the worst case, each entry will be
 100  * ~1k, so the above numbers should give a rough max of the amount of memory
 101  * used in k.
 102  */
 103 static unsigned int
 104 nfsd_cache_size_limit(void)
 105 {
 106         unsigned int limit;
 107         unsigned long low_pages = totalram_pages - totalhigh_pages;
 108
 109         limit = (16 * int_sqrt(low_pages)) << (PAGE_SHIFT-10);
 110         return min_t(unsigned int, limit, 256*1024);
 111 }
 112
 113 /*
 114  * Compute the number of hash buckets we need. Divide the max cachesize by
 115  * the "target" max bucket size, and round up to next power of two.
 116  */
 117 static unsigned int
 118 nfsd_hashsize(unsigned int limit)
 119 {
 120         return roundup_pow_of_two(limit / TARGET_BUCKET_SIZE);
 121 }
 122
 123 static u32
 124 nfsd_cache_hash(__be32 xid)
 125 {
 126         return hash_32(be32_to_cpu(xid), maskbits);
 127 }
 128
 129 static struct svc_cacherep *
 130 nfsd_reply_cache_alloc(void)
 131 {
 132         struct svc_cacherep     *rp;
 133
 134         rp = kmem_cache_alloc(drc_slab, GFP_KERNEL);
 135         if (rp) {
 136                 rp->c_state = RC_UNUSED;
 137                 rp->c_type = RC_NOCACHE;
 138                 INIT_LIST_HEAD(&rp->c_lru);
 139         }
 140         return rp;
 141 }
 142
 143 static void
 144 nfsd_reply_cache_free_locked(struct svc_cacherep *rp)
 145 {
 146         if (rp->c_type == RC_REPLBUFF && rp->c_replvec.iov_base) {
 147                 drc_mem_usage -= rp->c_replvec.iov_len;
 148                 kfree(rp->c_replvec.iov_base);
 149         }
 150         list_del(&rp->c_lru);
 151         atomic_dec(&num_drc_entries);
 152         drc_mem_usage -= sizeof(*rp);
 153         kmem_cache_free(drc_slab, rp);
 154 }
 155
 156 static void
 157 nfsd_reply_cache_free(struct nfsd_drc_bucket *b, struct svc_cacherep *rp)
 158 {
 159         spin_lock(&b->cache_lock);
 160         nfsd_reply_cache_free_locked(rp);
 161         spin_unlock(&b->cache_lock);
 162 }
 163
 164 int nfsd_reply_cache_init(void)
 165 {
 166         unsigned int hashsize;
 167         unsigned int i;
 168
 169         max_drc_entries = nfsd_cache_size_limit();
 170         atomic_set(&num_drc_entries, 0);
 171         hashsize = nfsd_hashsize(max_drc_entries);
 172         maskbits = ilog2(hashsize);
 173
 174         register_shrinker(&nfsd_reply_cache_shrinker);
 175         drc_slab = kmem_cache_create("nfsd_drc", sizeof(struct svc_cacherep),
 176                                         0, 0, NULL);
 177         if (!drc_slab)
 178                 goto out_nomem;
 179
 180         drc_hashtbl = kcalloc(hashsize, sizeof(*drc_hashtbl), GFP_KERNEL);
 181         if (!drc_hashtbl)
 182                 goto out_nomem;
 183         for (i = 0; i < hashsize; i++) {
 184                 INIT_LIST_HEAD(&drc_hashtbl[i].lru_head);
 185                 spin_lock_init(&drc_hashtbl[i].cache_lock);
 186         }
 187         drc_hashsize = hashsize;
 188
 189         return 0;
 190 out_nomem:
 191         printk(KERN_ERR "nfsd: failed to allocate reply cache\n");
 192         nfsd_reply_cache_shutdown();
 193         return -ENOMEM;
 194 }
 195
 196 void nfsd_reply_cache_shutdown(void)
 197 {
 198         struct svc_cacherep     *rp;
 199         unsigned int i;
 200
 201         unregister_shrinker(&nfsd_reply_cache_shrinker);
 202         cancel_delayed_work_sync(&cache_cleaner);
 203
 204         for (i = 0; i < drc_hashsize; i++) {
 205                 struct list_head *head = &drc_hashtbl[i].lru_head;
 206                 while (!list_empty(head)) {
 207                         rp = list_first_entry(head, struct svc_cacherep, c_lru);
 208                         nfsd_reply_cache_free_locked(rp);
 209                 }
 210         }
 211
 212         kfree (drc_hashtbl);
 213         drc_hashtbl = NULL;
 214         drc_hashsize = 0;
 215
 216         if (drc_slab) {
 217                 kmem_cache_destroy(drc_slab);
 218                 drc_slab = NULL;
 219         }
 220 }
 221
 222 /*
 223  * Move cache entry to end of LRU list, and queue the cleaner to run if it's
 224  * not already scheduled.
 225  */
 226 static void
 227 lru_put_end(struct nfsd_drc_bucket *b, struct svc_cacherep *rp)
 228 {
 229         rp->c_timestamp = jiffies;
 230         list_move_tail(&rp->c_lru, &b->lru_head);
 231         schedule_delayed_work(&cache_cleaner, RC_EXPIRE);
 232 }
 233
 234 static long
 235 prune_bucket(struct nfsd_drc_bucket *b)
 236 {
 237         struct svc_cacherep *rp, *tmp;
 238         long freed = 0;
 239
 240         list_for_each_entry_safe(rp, tmp, &b->lru_head, c_lru) {
 241                 /*
 242                  * Don't free entries attached to calls that are still
 243                  * in-progress, but do keep scanning the list.
 244                  */
 245                 if (rp->c_state == RC_INPROG)
 246                         continue;
 247                 if (atomic_read(&num_drc_entries) <= max_drc_entries &&
 248                     time_before(jiffies, rp->c_timestamp + RC_EXPIRE))
 249                         break;
 250                 nfsd_reply_cache_free_locked(rp);
 251                 freed++;
 252         }
 253         return freed;
 254 }
 255
 256 /*
 257  * Walk the LRU list and prune off entries that are older than RC_EXPIRE.
 258  * Also prune the oldest ones when the total exceeds the max number of entries.
 259  */
 260 static long
 261 prune_cache_entries(void)
 262 {
 263         unsigned int i;
 264         long freed = 0;
 265         bool cancel = true;
 266
 267         for (i = 0; i < drc_hashsize; i++) {
 268                 struct nfsd_drc_bucket *b = &drc_hashtbl[i];
 269
 270                 if (list_empty(&b->lru_head))
 271                         continue;
 272                 spin_lock(&b->cache_lock);
 273                 freed += prune_bucket(b);
 274                 if (!list_empty(&b->lru_head))
 275                         cancel = false;
 276                 spin_unlock(&b->cache_lock);
 277         }
 278
 279         /*
 280          * Conditionally rearm the job to run in RC_EXPIRE since we just
 281          * ran the pruner.
 282          */
 283         if (!cancel)
 284                 mod_delayed_work(system_wq, &cache_cleaner, RC_EXPIRE);
 285         return freed;
 286 }
 287
 288 static void
 289 cache_cleaner_func(struct work_struct *unused)
 290 {
 291         prune_cache_entries();
 292 }
 293
 294 static unsigned long
 295 nfsd_reply_cache_count(struct shrinker *shrink, struct shrink_control *sc)
 296 {
 297         return atomic_read(&num_drc_entries);
 298 }
 299
 300 static unsigned long
 301 nfsd_reply_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
 302 {
 303         return prune_cache_entries();
 304 }
 305 /*
 306  * Walk an xdr_buf and get a CRC for at most the first RC_CSUMLEN bytes
 307  */
 308 static __wsum
 309 nfsd_cache_csum(struct svc_rqst *rqstp)
 310 {
 311         int idx;
 312         unsigned int base;
 313         __wsum csum;
 314         struct xdr_buf *buf = &rqstp->rq_arg;
 315         const unsigned char *p = buf->head[0].iov_base;
 316         size_t csum_len = min_t(size_t, buf->head[0].iov_len + buf->page_len,
 317                                 RC_CSUMLEN);
 318         size_t len = min(buf->head[0].iov_len, csum_len);
 319
 320         /* rq_arg.head first */
 321         csum = csum_partial(p, len, 0);
 322         csum_len -= len;
 323
 324         /* Continue into page array */
 325         idx = buf->page_base / PAGE_SIZE;
 326         base = buf->page_base & ~PAGE_MASK;
 327         while (csum_len) {
 328                 p = page_address(buf->pages[idx]) + base;
 329                 len = min_t(size_t, PAGE_SIZE - base, csum_len);
 330                 csum = csum_partial(p, len, csum);
 331                 csum_len -= len;
 332                 base = 0;
 333                 ++idx;
 334         }
 335         return csum;
 336 }
 337
 338 static bool
 339 nfsd_cache_match(struct svc_rqst *rqstp, __wsum csum, struct svc_cacherep *rp)
 340 {
 341         /* Check RPC header info first */
 342         if (rqstp->rq_xid != rp->c_xid || rqstp->rq_proc != rp->c_proc ||
 343             rqstp->rq_prot != rp->c_prot || rqstp->rq_vers != rp->c_vers ||
 344             rqstp->rq_arg.len != rp->c_len ||
 345             !rpc_cmp_addr(svc_addr(rqstp), (struct sockaddr *)&rp->c_addr) ||
 346             rpc_get_port(svc_addr(rqstp)) != rpc_get_port((struct sockaddr *)&rp->c_addr))
 347                 return false;
 348
 349         /* compare checksum of NFS data */
 350         if (csum != rp->c_csum) {
 351                 ++payload_misses;
 352                 return false;
 353         }
 354
 355         return true;
 356 }
 357
 358 /*
 359  * Search the request hash for an entry that matches the given rqstp.
 360  * Must be called with cache_lock held. Returns the found entry or
 361  * NULL on failure.
 362  */
 363 static struct svc_cacherep *
 364 nfsd_cache_search(struct nfsd_drc_bucket *b, struct svc_rqst *rqstp,
 365                 __wsum csum)
 366 {
 367         struct svc_cacherep     *rp, *ret = NULL;
 368         struct list_head        *rh = &b->lru_head;
 369         unsigned int            entries = 0;
 370
 371         list_for_each_entry(rp, rh, c_lru) {
 372                 ++entries;
 373                 if (nfsd_cache_match(rqstp, csum, rp)) {
 374                         ret = rp;
 375                         break;
 376                 }
 377         }
 378
 379         /* tally hash chain length stats */
 380         if (entries > longest_chain) {
 381                 longest_chain = entries;
 382                 longest_chain_cachesize = atomic_read(&num_drc_entries);
 383         } else if (entries == longest_chain) {
 384                 /* prefer to keep the smallest cachesize possible here */
 385                 longest_chain_cachesize = min_t(unsigned int,
 386                                 longest_chain_cachesize,
 387                                 atomic_read(&num_drc_entries));
 388         }
 389
 390         return ret;
 391 }
 392
 393 /*
 394  * Try to find an entry matching the current call in the cache. When none
 395  * is found, we try to grab the oldest expired entry off the LRU list. If
 396  * a suitable one isn't there, then drop the cache_lock and allocate a
 397  * new one, then search again in case one got inserted while this thread
 398  * didn't hold the lock.
 399  */
 400 int
 401 nfsd_cache_lookup(struct svc_rqst *rqstp)
 402 {
 403         struct svc_cacherep     *rp, *found;
 404         __be32                  xid = rqstp->rq_xid;
 405         u32                     proto =  rqstp->rq_prot,
 406                                 vers = rqstp->rq_vers,
 407                                 proc = rqstp->rq_proc;
 408         __wsum                  csum;
 409         u32 hash = nfsd_cache_hash(xid);
 410         struct nfsd_drc_bucket *b = &drc_hashtbl[hash];
 411         unsigned long           age;
 412         int type = rqstp->rq_cachetype;
 413         int rtn = RC_DOIT;
 414
 415         rqstp->rq_cacherep = NULL;
 416         if (type == RC_NOCACHE) {
 417                 nfsdstats.rcnocache++;
 418                 return rtn;
 419         }
 420
 421         csum = nfsd_cache_csum(rqstp);
 422
 423         /*
 424          * Since the common case is a cache miss followed by an insert,
 425          * preallocate an entry.
 426          */
 427         rp = nfsd_reply_cache_alloc();
 428         spin_lock(&b->cache_lock);
 429         if (likely(rp)) {
 430                 atomic_inc(&num_drc_entries);
 431                 drc_mem_usage += sizeof(*rp);
 432         }
 433
 434         /* go ahead and prune the cache */
 435         prune_bucket(b);
 436
 437         found = nfsd_cache_search(b, rqstp, csum);
 438         if (found) {
 439                 if (likely(rp))
 440                         nfsd_reply_cache_free_locked(rp);
 441                 rp = found;
 442                 goto found_entry;
 443         }
 444
 445         if (!rp) {
 446                 dprintk("nfsd: unable to allocate DRC entry!\n");
 447                 goto out;
 448         }
 449
 450         nfsdstats.rcmisses++;
 451         rqstp->rq_cacherep = rp;
 452         rp->c_state = RC_INPROG;
 453         rp->c_xid = xid;
 454         rp->c_proc = proc;
 455         rpc_copy_addr((struct sockaddr *)&rp->c_addr, svc_addr(rqstp));
 456         rpc_set_port((struct sockaddr *)&rp->c_addr, rpc_get_port(svc_addr(rqstp)));
 457         rp->c_prot = proto;
 458         rp->c_vers = vers;
 459         rp->c_len = rqstp->rq_arg.len;
 460         rp->c_csum = csum;
 461
 462         lru_put_end(b, rp);
 463
 464         /* release any buffer */
 465         if (rp->c_type == RC_REPLBUFF) {
 466                 drc_mem_usage -= rp->c_replvec.iov_len;
 467                 kfree(rp->c_replvec.iov_base);
 468                 rp->c_replvec.iov_base = NULL;
 469         }
 470         rp->c_type = RC_NOCACHE;
 471  out:
 472         spin_unlock(&b->cache_lock);
 473         return rtn;
 474
 475 found_entry:
 476         nfsdstats.rchits++;
 477         /* We found a matching entry which is either in progress or done. */
 478         age = jiffies - rp->c_timestamp;
 479         lru_put_end(b, rp);
 480
 481         rtn = RC_DROPIT;
 482         /* Request being processed or excessive rexmits */
 483         if (rp->c_state == RC_INPROG || age < RC_DELAY)
 484                 goto out;
 485
 486         /* From the hall of fame of impractical attacks:
 487          * Is this a user who tries to snoop on the cache? */
 488         rtn = RC_DOIT;
 489         if (!rqstp->rq_secure && rp->c_secure)
 490                 goto out;
 491
 492         /* Compose RPC reply header */
 493         switch (rp->c_type) {
 494         case RC_NOCACHE:
 495                 break;
 496         case RC_REPLSTAT:
 497                 svc_putu32(&rqstp->rq_res.head[0], rp->c_replstat);
 498                 rtn = RC_REPLY;
 499                 break;
 500         case RC_REPLBUFF:
 501                 if (!nfsd_cache_append(rqstp, &rp->c_replvec))
 502                         goto out;       /* should not happen */
 503                 rtn = RC_REPLY;
 504                 break;
 505         default:
 506                 printk(KERN_WARNING "nfsd: bad repcache type %d\n", rp->c_type);
 507                 nfsd_reply_cache_free_locked(rp);
 508         }
 509
 510         goto out;
 511 }
 512
 513 /*
 514  * Update a cache entry. This is called from nfsd_dispatch when
 515  * the procedure has been executed and the complete reply is in
 516  * rqstp->rq_res.
 517  *
 518  * We're copying around data here rather than swapping buffers because
 519  * the toplevel loop requires max-sized buffers, which would be a waste
 520  * of memory for a cache with a max reply size of 100 bytes (diropokres).
 521  *
 522  * If we should start to use different types of cache entries tailored
 523  * specifically for attrstat and fh's, we may save even more space.
 524  *
 525  * Also note that a cachetype of RC_NOCACHE can legally be passed when
 526  * nfsd failed to encode a reply that otherwise would have been cached.
 527  * In this case, nfsd_cache_update is called with statp == NULL.
 528  */
 529 void
 530 nfsd_cache_update(struct svc_rqst *rqstp, int cachetype, __be32 *statp)
 531 {
 532         struct svc_cacherep *rp = rqstp->rq_cacherep;
 533         struct kvec     *resv = &rqstp->rq_res.head[0], *cachv;
 534         u32             hash;
 535         struct nfsd_drc_bucket *b;
 536         int             len;
 537         size_t          bufsize = 0;
 538
 539         if (!rp)
 540                 return;
 541
 542         hash = nfsd_cache_hash(rp->c_xid);
 543         b = &drc_hashtbl[hash];
 544
 545         len = resv->iov_len - ((char*)statp - (char*)resv->iov_base);
 546         len >>= 2;
 547
 548         /* Don't cache excessive amounts of data and XDR failures */
 549         if (!statp || len > (256 >> 2)) {
 550                 nfsd_reply_cache_free(b, rp);
 551                 return;
 552         }
 553
 554         switch (cachetype) {
 555         case RC_REPLSTAT:
 556                 if (len != 1)
 557                         printk("nfsd: RC_REPLSTAT/reply len %d!\n",len);
 558                 rp->c_replstat = *statp;
 559                 break;
 560         case RC_REPLBUFF:
 561                 cachv = &rp->c_replvec;
 562                 bufsize = len << 2;
 563                 cachv->iov_base = kmalloc(bufsize, GFP_KERNEL);
 564                 if (!cachv->iov_base) {
 565                         nfsd_reply_cache_free(b, rp);
 566                         return;
 567                 }
 568                 cachv->iov_len = bufsize;
 569                 memcpy(cachv->iov_base, statp, bufsize);
 570                 break;
 571         case RC_NOCACHE:
 572                 nfsd_reply_cache_free(b, rp);
 573                 return;
 574         }
 575         spin_lock(&b->cache_lock);
 576         drc_mem_usage += bufsize;
 577         lru_put_end(b, rp);
 578         rp->c_secure = rqstp->rq_secure;
 579         rp->c_type = cachetype;
 580         rp->c_state = RC_DONE;
 581         spin_unlock(&b->cache_lock);
 582         return;
 583 }
 584
 585 /*
 586  * Copy cached reply to current reply buffer. Should always fit.
 587  * FIXME as reply is in a page, we should just attach the page, and
 588  * keep a refcount....
 589  */
 590 static int
 591 nfsd_cache_append(struct svc_rqst *rqstp, struct kvec *data)
 592 {
 593         struct kvec     *vec = &rqstp->rq_res.head[0];
 594
 595         if (vec->iov_len + data->iov_len > PAGE_SIZE) {
 596                 printk(KERN_WARNING "nfsd: cached reply too large (%Zd).\n",
 597                                 data->iov_len);
 598                 return 0;
 599         }
 600         memcpy((char*)vec->iov_base + vec->iov_len, data->iov_base, data->iov_len);
 601         vec->iov_len += data->iov_len;
 602         return 1;
 603 }
 604
 605 /*
 606  * Note that fields may be added, removed or reordered in the future. Programs
 607  * scraping this file for info should test the labels to ensure they're
 608  * getting the correct field.
 609  */
 610 static int nfsd_reply_cache_stats_show(struct seq_file *m, void *v)
 611 {
 612         seq_printf(m, "max entries:           %u\n", max_drc_entries);
 613         seq_printf(m, "num entries:           %u\n",
 614                         atomic_read(&num_drc_entries));
 615         seq_printf(m, "hash buckets:          %u\n", 1 << maskbits);
 616         seq_printf(m, "mem usage:             %u\n", drc_mem_usage);
 617         seq_printf(m, "cache hits:            %u\n", nfsdstats.rchits);
 618         seq_printf(m, "cache misses:          %u\n", nfsdstats.rcmisses);
 619         seq_printf(m, "not cached:            %u\n", nfsdstats.rcnocache);
 620         seq_printf(m, "payload misses:        %u\n", payload_misses);
 621         seq_printf(m, "longest chain len:     %u\n", longest_chain);
 622         seq_printf(m, "cachesize at longest:  %u\n", longest_chain_cachesize);
 623         return 0;
 624 }
 625
 626 int nfsd_reply_cache_stats_open(struct inode *inode, struct file *file)
 627 {
 628         return single_open(file, nfsd_reply_cache_stats_show, NULL);
 629 }