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