fs/nfsd/nfscache.c

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