]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/sunrpc/cache.c
procfs: new helper - PDE_DATA(inode)
[mirror_ubuntu-bionic-kernel.git] / net / sunrpc / cache.c
CommitLineData
1da177e4
LT
1/*
2 * net/sunrpc/cache.c
3 *
4 * Generic code for various authentication-related caches
5 * used by sunrpc clients and servers.
6 *
7 * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
8 *
9 * Released under terms in GPL version 2. See COPYING.
10 *
11 */
12
13#include <linux/types.h>
14#include <linux/fs.h>
15#include <linux/file.h>
16#include <linux/slab.h>
17#include <linux/signal.h>
18#include <linux/sched.h>
19#include <linux/kmod.h>
20#include <linux/list.h>
21#include <linux/module.h>
22#include <linux/ctype.h>
23#include <asm/uaccess.h>
24#include <linux/poll.h>
25#include <linux/seq_file.h>
26#include <linux/proc_fs.h>
27#include <linux/net.h>
28#include <linux/workqueue.h>
4a3e2f71 29#include <linux/mutex.h>
da77005f 30#include <linux/pagemap.h>
1da177e4
LT
31#include <asm/ioctls.h>
32#include <linux/sunrpc/types.h>
33#include <linux/sunrpc/cache.h>
34#include <linux/sunrpc/stats.h>
8854e82d 35#include <linux/sunrpc/rpc_pipe_fs.h>
4f42d0d5 36#include "netns.h"
1da177e4
LT
37
38#define RPCDBG_FACILITY RPCDBG_CACHE
39
d76d1815 40static bool cache_defer_req(struct cache_req *req, struct cache_head *item);
1da177e4
LT
41static void cache_revisit_request(struct cache_head *item);
42
74cae61a 43static void cache_init(struct cache_head *h)
1da177e4 44{
c5b29f88 45 time_t now = seconds_since_boot();
1da177e4
LT
46 h->next = NULL;
47 h->flags = 0;
baab935f 48 kref_init(&h->ref);
1da177e4
LT
49 h->expiry_time = now + CACHE_NEW_EXPIRY;
50 h->last_refresh = now;
51}
52
2f50d8b6
N
53static inline int cache_is_expired(struct cache_detail *detail, struct cache_head *h)
54{
c5b29f88 55 return (h->expiry_time < seconds_since_boot()) ||
2f50d8b6
N
56 (detail->flush_time > h->last_refresh);
57}
58
15a5f6bd
N
59struct cache_head *sunrpc_cache_lookup(struct cache_detail *detail,
60 struct cache_head *key, int hash)
61{
62 struct cache_head **head, **hp;
d202cce8 63 struct cache_head *new = NULL, *freeme = NULL;
15a5f6bd
N
64
65 head = &detail->hash_table[hash];
66
67 read_lock(&detail->hash_lock);
68
69 for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
70 struct cache_head *tmp = *hp;
71 if (detail->match(tmp, key)) {
d202cce8
N
72 if (cache_is_expired(detail, tmp))
73 /* This entry is expired, we will discard it. */
74 break;
15a5f6bd
N
75 cache_get(tmp);
76 read_unlock(&detail->hash_lock);
77 return tmp;
78 }
79 }
80 read_unlock(&detail->hash_lock);
81 /* Didn't find anything, insert an empty entry */
82
83 new = detail->alloc();
84 if (!new)
85 return NULL;
2f34931f
NB
86 /* must fully initialise 'new', else
87 * we might get lose if we need to
88 * cache_put it soon.
89 */
15a5f6bd 90 cache_init(new);
2f34931f 91 detail->init(new, key);
15a5f6bd
N
92
93 write_lock(&detail->hash_lock);
94
95 /* check if entry appeared while we slept */
96 for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
97 struct cache_head *tmp = *hp;
98 if (detail->match(tmp, key)) {
d202cce8
N
99 if (cache_is_expired(detail, tmp)) {
100 *hp = tmp->next;
101 tmp->next = NULL;
102 detail->entries --;
103 freeme = tmp;
104 break;
105 }
15a5f6bd
N
106 cache_get(tmp);
107 write_unlock(&detail->hash_lock);
baab935f 108 cache_put(new, detail);
15a5f6bd
N
109 return tmp;
110 }
111 }
15a5f6bd
N
112 new->next = *head;
113 *head = new;
114 detail->entries++;
115 cache_get(new);
116 write_unlock(&detail->hash_lock);
117
d202cce8
N
118 if (freeme)
119 cache_put(freeme, detail);
15a5f6bd
N
120 return new;
121}
24c3767e 122EXPORT_SYMBOL_GPL(sunrpc_cache_lookup);
15a5f6bd 123
ebd0cb1a 124
f866a819 125static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch);
ebd0cb1a 126
908329f2 127static void cache_fresh_locked(struct cache_head *head, time_t expiry)
ebd0cb1a
N
128{
129 head->expiry_time = expiry;
c5b29f88 130 head->last_refresh = seconds_since_boot();
fdef7aa5 131 smp_wmb(); /* paired with smp_rmb() in cache_is_valid() */
908329f2 132 set_bit(CACHE_VALID, &head->flags);
ebd0cb1a
N
133}
134
135static void cache_fresh_unlocked(struct cache_head *head,
908329f2 136 struct cache_detail *detail)
ebd0cb1a 137{
ebd0cb1a
N
138 if (test_and_clear_bit(CACHE_PENDING, &head->flags)) {
139 cache_revisit_request(head);
f866a819 140 cache_dequeue(detail, head);
ebd0cb1a
N
141 }
142}
143
15a5f6bd
N
144struct cache_head *sunrpc_cache_update(struct cache_detail *detail,
145 struct cache_head *new, struct cache_head *old, int hash)
146{
147 /* The 'old' entry is to be replaced by 'new'.
148 * If 'old' is not VALID, we update it directly,
149 * otherwise we need to replace it
150 */
151 struct cache_head **head;
152 struct cache_head *tmp;
153
154 if (!test_bit(CACHE_VALID, &old->flags)) {
155 write_lock(&detail->hash_lock);
156 if (!test_bit(CACHE_VALID, &old->flags)) {
157 if (test_bit(CACHE_NEGATIVE, &new->flags))
158 set_bit(CACHE_NEGATIVE, &old->flags);
159 else
160 detail->update(old, new);
908329f2 161 cache_fresh_locked(old, new->expiry_time);
15a5f6bd 162 write_unlock(&detail->hash_lock);
908329f2 163 cache_fresh_unlocked(old, detail);
15a5f6bd
N
164 return old;
165 }
166 write_unlock(&detail->hash_lock);
167 }
168 /* We need to insert a new entry */
169 tmp = detail->alloc();
170 if (!tmp) {
baab935f 171 cache_put(old, detail);
15a5f6bd
N
172 return NULL;
173 }
174 cache_init(tmp);
175 detail->init(tmp, old);
176 head = &detail->hash_table[hash];
177
178 write_lock(&detail->hash_lock);
179 if (test_bit(CACHE_NEGATIVE, &new->flags))
180 set_bit(CACHE_NEGATIVE, &tmp->flags);
181 else
182 detail->update(tmp, new);
183 tmp->next = *head;
184 *head = tmp;
f2d39586 185 detail->entries++;
15a5f6bd 186 cache_get(tmp);
908329f2 187 cache_fresh_locked(tmp, new->expiry_time);
ebd0cb1a 188 cache_fresh_locked(old, 0);
15a5f6bd 189 write_unlock(&detail->hash_lock);
908329f2
N
190 cache_fresh_unlocked(tmp, detail);
191 cache_fresh_unlocked(old, detail);
baab935f 192 cache_put(old, detail);
15a5f6bd
N
193 return tmp;
194}
24c3767e 195EXPORT_SYMBOL_GPL(sunrpc_cache_update);
1da177e4 196
bc74b4f5
TM
197static int cache_make_upcall(struct cache_detail *cd, struct cache_head *h)
198{
2d438338
SK
199 if (cd->cache_upcall)
200 return cd->cache_upcall(cd, h);
21cd1254 201 return sunrpc_cache_pipe_upcall(cd, h);
bc74b4f5 202}
989a19b9
N
203
204static inline int cache_is_valid(struct cache_detail *detail, struct cache_head *h)
205{
d202cce8 206 if (!test_bit(CACHE_VALID, &h->flags))
989a19b9
N
207 return -EAGAIN;
208 else {
209 /* entry is valid */
210 if (test_bit(CACHE_NEGATIVE, &h->flags))
211 return -ENOENT;
fdef7aa5
BF
212 else {
213 /*
214 * In combination with write barrier in
215 * sunrpc_cache_update, ensures that anyone
216 * using the cache entry after this sees the
217 * updated contents:
218 */
219 smp_rmb();
989a19b9 220 return 0;
fdef7aa5 221 }
989a19b9
N
222 }
223}
e9dc1221 224
6bab93f8
BF
225static int try_to_negate_entry(struct cache_detail *detail, struct cache_head *h)
226{
227 int rv;
228
229 write_lock(&detail->hash_lock);
230 rv = cache_is_valid(detail, h);
231 if (rv != -EAGAIN) {
232 write_unlock(&detail->hash_lock);
233 return rv;
234 }
235 set_bit(CACHE_NEGATIVE, &h->flags);
236 cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY);
237 write_unlock(&detail->hash_lock);
238 cache_fresh_unlocked(h, detail);
239 return -ENOENT;
240}
241
1da177e4
LT
242/*
243 * This is the generic cache management routine for all
244 * the authentication caches.
245 * It checks the currency of a cache item and will (later)
246 * initiate an upcall to fill it if needed.
247 *
248 *
249 * Returns 0 if the cache_head can be used, or cache_puts it and returns
989a19b9
N
250 * -EAGAIN if upcall is pending and request has been queued
251 * -ETIMEDOUT if upcall failed or request could not be queue or
252 * upcall completed but item is still invalid (implying that
253 * the cache item has been replaced with a newer one).
1da177e4
LT
254 * -ENOENT if cache entry was negative
255 */
256int cache_check(struct cache_detail *detail,
257 struct cache_head *h, struct cache_req *rqstp)
258{
259 int rv;
260 long refresh_age, age;
261
262 /* First decide return status as best we can */
989a19b9 263 rv = cache_is_valid(detail, h);
1da177e4
LT
264
265 /* now see if we want to start an upcall */
266 refresh_age = (h->expiry_time - h->last_refresh);
c5b29f88 267 age = seconds_since_boot() - h->last_refresh;
1da177e4
LT
268
269 if (rqstp == NULL) {
270 if (rv == -EAGAIN)
271 rv = -ENOENT;
272 } else if (rv == -EAGAIN || age > refresh_age/2) {
46121cf7
CL
273 dprintk("RPC: Want update, refage=%ld, age=%ld\n",
274 refresh_age, age);
1da177e4
LT
275 if (!test_and_set_bit(CACHE_PENDING, &h->flags)) {
276 switch (cache_make_upcall(detail, h)) {
277 case -EINVAL:
278 clear_bit(CACHE_PENDING, &h->flags);
5c4d2639 279 cache_revisit_request(h);
6bab93f8 280 rv = try_to_negate_entry(detail, h);
1da177e4 281 break;
1da177e4
LT
282 case -EAGAIN:
283 clear_bit(CACHE_PENDING, &h->flags);
284 cache_revisit_request(h);
285 break;
286 }
287 }
288 }
289
989a19b9 290 if (rv == -EAGAIN) {
d76d1815
BF
291 if (!cache_defer_req(rqstp, h)) {
292 /*
293 * Request was not deferred; handle it as best
294 * we can ourselves:
295 */
989a19b9
N
296 rv = cache_is_valid(detail, h);
297 if (rv == -EAGAIN)
298 rv = -ETIMEDOUT;
299 }
300 }
4013edea 301 if (rv)
baab935f 302 cache_put(h, detail);
1da177e4
LT
303 return rv;
304}
24c3767e 305EXPORT_SYMBOL_GPL(cache_check);
1da177e4 306
1da177e4
LT
307/*
308 * caches need to be periodically cleaned.
309 * For this we maintain a list of cache_detail and
310 * a current pointer into that list and into the table
311 * for that entry.
312 *
313 * Each time clean_cache is called it finds the next non-empty entry
314 * in the current table and walks the list in that entry
315 * looking for entries that can be removed.
316 *
317 * An entry gets removed if:
318 * - The expiry is before current time
319 * - The last_refresh time is before the flush_time for that cache
320 *
321 * later we might drop old entries with non-NEVER expiry if that table
322 * is getting 'full' for some definition of 'full'
323 *
324 * The question of "how often to scan a table" is an interesting one
325 * and is answered in part by the use of the "nextcheck" field in the
326 * cache_detail.
327 * When a scan of a table begins, the nextcheck field is set to a time
328 * that is well into the future.
329 * While scanning, if an expiry time is found that is earlier than the
330 * current nextcheck time, nextcheck is set to that expiry time.
331 * If the flush_time is ever set to a time earlier than the nextcheck
332 * time, the nextcheck time is then set to that flush_time.
333 *
334 * A table is then only scanned if the current time is at least
335 * the nextcheck time.
cca5172a 336 *
1da177e4
LT
337 */
338
339static LIST_HEAD(cache_list);
340static DEFINE_SPINLOCK(cache_list_lock);
341static struct cache_detail *current_detail;
342static int current_index;
343
65f27f38 344static void do_cache_clean(struct work_struct *work);
8eab945c 345static struct delayed_work cache_cleaner;
1da177e4 346
820f9442 347void sunrpc_init_cache_detail(struct cache_detail *cd)
ffe9386b 348{
1da177e4
LT
349 rwlock_init(&cd->hash_lock);
350 INIT_LIST_HEAD(&cd->queue);
351 spin_lock(&cache_list_lock);
352 cd->nextcheck = 0;
353 cd->entries = 0;
354 atomic_set(&cd->readers, 0);
355 cd->last_close = 0;
356 cd->last_warn = -1;
357 list_add(&cd->others, &cache_list);
358 spin_unlock(&cache_list_lock);
359
360 /* start the cleaning process */
52bad64d 361 schedule_delayed_work(&cache_cleaner, 0);
1da177e4 362}
820f9442 363EXPORT_SYMBOL_GPL(sunrpc_init_cache_detail);
1da177e4 364
820f9442 365void sunrpc_destroy_cache_detail(struct cache_detail *cd)
1da177e4
LT
366{
367 cache_purge(cd);
368 spin_lock(&cache_list_lock);
369 write_lock(&cd->hash_lock);
370 if (cd->entries || atomic_read(&cd->inuse)) {
371 write_unlock(&cd->hash_lock);
372 spin_unlock(&cache_list_lock);
df95a9d4 373 goto out;
1da177e4
LT
374 }
375 if (current_detail == cd)
376 current_detail = NULL;
377 list_del_init(&cd->others);
378 write_unlock(&cd->hash_lock);
379 spin_unlock(&cache_list_lock);
1da177e4
LT
380 if (list_empty(&cache_list)) {
381 /* module must be being unloaded so its safe to kill the worker */
4011cd97 382 cancel_delayed_work_sync(&cache_cleaner);
1da177e4 383 }
df95a9d4
BF
384 return;
385out:
386 printk(KERN_ERR "nfsd: failed to unregister %s cache\n", cd->name);
1da177e4 387}
820f9442 388EXPORT_SYMBOL_GPL(sunrpc_destroy_cache_detail);
1da177e4
LT
389
390/* clean cache tries to find something to clean
391 * and cleans it.
392 * It returns 1 if it cleaned something,
393 * 0 if it didn't find anything this time
394 * -1 if it fell off the end of the list.
395 */
396static int cache_clean(void)
397{
398 int rv = 0;
399 struct list_head *next;
400
401 spin_lock(&cache_list_lock);
402
403 /* find a suitable table if we don't already have one */
404 while (current_detail == NULL ||
405 current_index >= current_detail->hash_size) {
406 if (current_detail)
407 next = current_detail->others.next;
408 else
409 next = cache_list.next;
410 if (next == &cache_list) {
411 current_detail = NULL;
412 spin_unlock(&cache_list_lock);
413 return -1;
414 }
415 current_detail = list_entry(next, struct cache_detail, others);
c5b29f88 416 if (current_detail->nextcheck > seconds_since_boot())
1da177e4
LT
417 current_index = current_detail->hash_size;
418 else {
419 current_index = 0;
c5b29f88 420 current_detail->nextcheck = seconds_since_boot()+30*60;
1da177e4
LT
421 }
422 }
423
424 /* find a non-empty bucket in the table */
425 while (current_detail &&
426 current_index < current_detail->hash_size &&
427 current_detail->hash_table[current_index] == NULL)
428 current_index++;
429
430 /* find a cleanable entry in the bucket and clean it, or set to next bucket */
cca5172a 431
1da177e4
LT
432 if (current_detail && current_index < current_detail->hash_size) {
433 struct cache_head *ch, **cp;
434 struct cache_detail *d;
cca5172a 435
1da177e4
LT
436 write_lock(&current_detail->hash_lock);
437
438 /* Ok, now to clean this strand */
cca5172a 439
1da177e4 440 cp = & current_detail->hash_table[current_index];
3af4974e 441 for (ch = *cp ; ch ; cp = & ch->next, ch = *cp) {
1da177e4
LT
442 if (current_detail->nextcheck > ch->expiry_time)
443 current_detail->nextcheck = ch->expiry_time+1;
2f50d8b6 444 if (!cache_is_expired(current_detail, ch))
1da177e4 445 continue;
1da177e4 446
1da177e4
LT
447 *cp = ch->next;
448 ch->next = NULL;
449 current_detail->entries--;
450 rv = 1;
3af4974e 451 break;
1da177e4 452 }
3af4974e 453
1da177e4
LT
454 write_unlock(&current_detail->hash_lock);
455 d = current_detail;
456 if (!ch)
457 current_index ++;
458 spin_unlock(&cache_list_lock);
5c4d2639 459 if (ch) {
3af4974e
N
460 if (test_and_clear_bit(CACHE_PENDING, &ch->flags))
461 cache_dequeue(current_detail, ch);
5c4d2639 462 cache_revisit_request(ch);
baab935f 463 cache_put(ch, d);
5c4d2639 464 }
1da177e4
LT
465 } else
466 spin_unlock(&cache_list_lock);
467
468 return rv;
469}
470
471/*
472 * We want to regularly clean the cache, so we need to schedule some work ...
473 */
65f27f38 474static void do_cache_clean(struct work_struct *work)
1da177e4
LT
475{
476 int delay = 5;
477 if (cache_clean() == -1)
6aad89c8 478 delay = round_jiffies_relative(30*HZ);
1da177e4
LT
479
480 if (list_empty(&cache_list))
481 delay = 0;
482
483 if (delay)
484 schedule_delayed_work(&cache_cleaner, delay);
485}
486
487
cca5172a 488/*
1da177e4 489 * Clean all caches promptly. This just calls cache_clean
cca5172a 490 * repeatedly until we are sure that every cache has had a chance to
1da177e4
LT
491 * be fully cleaned
492 */
493void cache_flush(void)
494{
495 while (cache_clean() != -1)
496 cond_resched();
497 while (cache_clean() != -1)
498 cond_resched();
499}
24c3767e 500EXPORT_SYMBOL_GPL(cache_flush);
1da177e4
LT
501
502void cache_purge(struct cache_detail *detail)
503{
504 detail->flush_time = LONG_MAX;
c5b29f88 505 detail->nextcheck = seconds_since_boot();
1da177e4
LT
506 cache_flush();
507 detail->flush_time = 1;
508}
24c3767e 509EXPORT_SYMBOL_GPL(cache_purge);
1da177e4
LT
510
511
512/*
513 * Deferral and Revisiting of Requests.
514 *
515 * If a cache lookup finds a pending entry, we
516 * need to defer the request and revisit it later.
517 * All deferred requests are stored in a hash table,
518 * indexed by "struct cache_head *".
519 * As it may be wasteful to store a whole request
cca5172a 520 * structure, we allow the request to provide a
1da177e4
LT
521 * deferred form, which must contain a
522 * 'struct cache_deferred_req'
523 * This cache_deferred_req contains a method to allow
524 * it to be revisited when cache info is available
525 */
526
527#define DFR_HASHSIZE (PAGE_SIZE/sizeof(struct list_head))
528#define DFR_HASH(item) ((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE)
529
530#define DFR_MAX 300 /* ??? */
531
532static DEFINE_SPINLOCK(cache_defer_lock);
533static LIST_HEAD(cache_defer_list);
11174492 534static struct hlist_head cache_defer_hash[DFR_HASHSIZE];
1da177e4
LT
535static int cache_defer_cnt;
536
6610f720
BF
537static void __unhash_deferred_req(struct cache_deferred_req *dreq)
538{
11174492 539 hlist_del_init(&dreq->hash);
e33534d5
N
540 if (!list_empty(&dreq->recent)) {
541 list_del_init(&dreq->recent);
542 cache_defer_cnt--;
543 }
6610f720
BF
544}
545
546static void __hash_deferred_req(struct cache_deferred_req *dreq, struct cache_head *item)
1da177e4 547{
1da177e4
LT
548 int hash = DFR_HASH(item);
549
e33534d5 550 INIT_LIST_HEAD(&dreq->recent);
11174492 551 hlist_add_head(&dreq->hash, &cache_defer_hash[hash]);
6610f720
BF
552}
553
e33534d5
N
554static void setup_deferral(struct cache_deferred_req *dreq,
555 struct cache_head *item,
556 int count_me)
1da177e4 557{
1da177e4
LT
558
559 dreq->item = item;
1da177e4
LT
560
561 spin_lock(&cache_defer_lock);
562
6610f720 563 __hash_deferred_req(dreq, item);
1da177e4 564
e33534d5
N
565 if (count_me) {
566 cache_defer_cnt++;
567 list_add(&dreq->recent, &cache_defer_list);
1da177e4 568 }
e33534d5 569
1da177e4
LT
570 spin_unlock(&cache_defer_lock);
571
3211af11 572}
f16b6e8d 573
3211af11
BF
574struct thread_deferred_req {
575 struct cache_deferred_req handle;
576 struct completion completion;
577};
578
579static void cache_restart_thread(struct cache_deferred_req *dreq, int too_many)
580{
581 struct thread_deferred_req *dr =
582 container_of(dreq, struct thread_deferred_req, handle);
583 complete(&dr->completion);
584}
585
d29068c4 586static void cache_wait_req(struct cache_req *req, struct cache_head *item)
3211af11
BF
587{
588 struct thread_deferred_req sleeper;
589 struct cache_deferred_req *dreq = &sleeper.handle;
3211af11
BF
590
591 sleeper.completion = COMPLETION_INITIALIZER_ONSTACK(sleeper.completion);
592 dreq->revisit = cache_restart_thread;
593
e33534d5 594 setup_deferral(dreq, item, 0);
3211af11 595
d29068c4 596 if (!test_bit(CACHE_PENDING, &item->flags) ||
277f68db 597 wait_for_completion_interruptible_timeout(
3211af11
BF
598 &sleeper.completion, req->thread_wait) <= 0) {
599 /* The completion wasn't completed, so we need
600 * to clean up
601 */
602 spin_lock(&cache_defer_lock);
11174492 603 if (!hlist_unhashed(&sleeper.handle.hash)) {
3211af11
BF
604 __unhash_deferred_req(&sleeper.handle);
605 spin_unlock(&cache_defer_lock);
606 } else {
607 /* cache_revisit_request already removed
608 * this from the hash table, but hasn't
609 * called ->revisit yet. It will very soon
610 * and we need to wait for it.
f16b6e8d 611 */
3211af11
BF
612 spin_unlock(&cache_defer_lock);
613 wait_for_completion(&sleeper.completion);
f16b6e8d 614 }
3211af11 615 }
3211af11
BF
616}
617
e33534d5 618static void cache_limit_defers(void)
3211af11 619{
e33534d5
N
620 /* Make sure we haven't exceed the limit of allowed deferred
621 * requests.
622 */
623 struct cache_deferred_req *discard = NULL;
3211af11 624
e33534d5
N
625 if (cache_defer_cnt <= DFR_MAX)
626 return;
d29068c4 627
e33534d5
N
628 spin_lock(&cache_defer_lock);
629
630 /* Consider removing either the first or the last */
631 if (cache_defer_cnt > DFR_MAX) {
632 if (net_random() & 1)
633 discard = list_entry(cache_defer_list.next,
634 struct cache_deferred_req, recent);
635 else
636 discard = list_entry(cache_defer_list.prev,
637 struct cache_deferred_req, recent);
638 __unhash_deferred_req(discard);
639 }
640 spin_unlock(&cache_defer_lock);
cd68c374 641 if (discard)
cd68c374 642 discard->revisit(discard, 1);
e33534d5 643}
cd68c374 644
d76d1815
BF
645/* Return true if and only if a deferred request is queued. */
646static bool cache_defer_req(struct cache_req *req, struct cache_head *item)
e33534d5
N
647{
648 struct cache_deferred_req *dreq;
d29068c4 649
3211af11 650 if (req->thread_wait) {
d29068c4
N
651 cache_wait_req(req, item);
652 if (!test_bit(CACHE_PENDING, &item->flags))
d76d1815 653 return false;
1da177e4 654 }
3211af11
BF
655 dreq = req->defer(req);
656 if (dreq == NULL)
d76d1815 657 return false;
e33534d5 658 setup_deferral(dreq, item, 1);
d29068c4
N
659 if (!test_bit(CACHE_PENDING, &item->flags))
660 /* Bit could have been cleared before we managed to
661 * set up the deferral, so need to revisit just in case
662 */
663 cache_revisit_request(item);
e33534d5
N
664
665 cache_limit_defers();
d76d1815 666 return true;
1da177e4
LT
667}
668
669static void cache_revisit_request(struct cache_head *item)
670{
671 struct cache_deferred_req *dreq;
672 struct list_head pending;
b67bfe0d 673 struct hlist_node *tmp;
1da177e4
LT
674 int hash = DFR_HASH(item);
675
676 INIT_LIST_HEAD(&pending);
677 spin_lock(&cache_defer_lock);
cca5172a 678
b67bfe0d 679 hlist_for_each_entry_safe(dreq, tmp, &cache_defer_hash[hash], hash)
11174492
N
680 if (dreq->item == item) {
681 __unhash_deferred_req(dreq);
682 list_add(&dreq->recent, &pending);
1da177e4 683 }
11174492 684
1da177e4
LT
685 spin_unlock(&cache_defer_lock);
686
687 while (!list_empty(&pending)) {
688 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
689 list_del_init(&dreq->recent);
690 dreq->revisit(dreq, 0);
691 }
692}
693
694void cache_clean_deferred(void *owner)
695{
696 struct cache_deferred_req *dreq, *tmp;
697 struct list_head pending;
698
699
700 INIT_LIST_HEAD(&pending);
701 spin_lock(&cache_defer_lock);
cca5172a 702
1da177e4
LT
703 list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) {
704 if (dreq->owner == owner) {
6610f720 705 __unhash_deferred_req(dreq);
e95dffa4 706 list_add(&dreq->recent, &pending);
1da177e4
LT
707 }
708 }
709 spin_unlock(&cache_defer_lock);
710
711 while (!list_empty(&pending)) {
712 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
713 list_del_init(&dreq->recent);
714 dreq->revisit(dreq, 1);
715 }
716}
717
718/*
719 * communicate with user-space
720 *
a490c681
BF
721 * We have a magic /proc file - /proc/sunrpc/<cachename>/channel.
722 * On read, you get a full request, or block.
723 * On write, an update request is processed.
724 * Poll works if anything to read, and always allows write.
1da177e4 725 *
cca5172a 726 * Implemented by linked list of requests. Each open file has
a490c681 727 * a ->private that also exists in this list. New requests are added
1da177e4
LT
728 * to the end and may wakeup and preceding readers.
729 * New readers are added to the head. If, on read, an item is found with
730 * CACHE_UPCALLING clear, we free it from the list.
731 *
732 */
733
734static DEFINE_SPINLOCK(queue_lock);
4a3e2f71 735static DEFINE_MUTEX(queue_io_mutex);
1da177e4
LT
736
737struct cache_queue {
738 struct list_head list;
739 int reader; /* if 0, then request */
740};
741struct cache_request {
742 struct cache_queue q;
743 struct cache_head *item;
744 char * buf;
745 int len;
746 int readers;
747};
748struct cache_reader {
749 struct cache_queue q;
750 int offset; /* if non-0, we have a refcnt on next request */
751};
752
d94af6de
SK
753static int cache_request(struct cache_detail *detail,
754 struct cache_request *crq)
755{
756 char *bp = crq->buf;
757 int len = PAGE_SIZE;
758
759 detail->cache_request(detail, crq->item, &bp, &len);
760 if (len < 0)
761 return -EAGAIN;
762 return PAGE_SIZE - len;
763}
764
173912a6
TM
765static ssize_t cache_read(struct file *filp, char __user *buf, size_t count,
766 loff_t *ppos, struct cache_detail *cd)
1da177e4
LT
767{
768 struct cache_reader *rp = filp->private_data;
769 struct cache_request *rq;
496ad9aa 770 struct inode *inode = file_inode(filp);
1da177e4
LT
771 int err;
772
773 if (count == 0)
774 return 0;
775
da77005f 776 mutex_lock(&inode->i_mutex); /* protect against multiple concurrent
1da177e4
LT
777 * readers on this file */
778 again:
779 spin_lock(&queue_lock);
780 /* need to find next request */
781 while (rp->q.list.next != &cd->queue &&
782 list_entry(rp->q.list.next, struct cache_queue, list)
783 ->reader) {
784 struct list_head *next = rp->q.list.next;
785 list_move(&rp->q.list, next);
786 }
787 if (rp->q.list.next == &cd->queue) {
788 spin_unlock(&queue_lock);
da77005f 789 mutex_unlock(&inode->i_mutex);
0db74d9a 790 WARN_ON_ONCE(rp->offset);
1da177e4
LT
791 return 0;
792 }
793 rq = container_of(rp->q.list.next, struct cache_request, q.list);
0db74d9a 794 WARN_ON_ONCE(rq->q.reader);
1da177e4
LT
795 if (rp->offset == 0)
796 rq->readers++;
797 spin_unlock(&queue_lock);
798
d94af6de
SK
799 if (rq->len == 0) {
800 err = cache_request(cd, rq);
801 if (err < 0)
802 goto out;
803 rq->len = err;
804 }
805
1da177e4
LT
806 if (rp->offset == 0 && !test_bit(CACHE_PENDING, &rq->item->flags)) {
807 err = -EAGAIN;
808 spin_lock(&queue_lock);
809 list_move(&rp->q.list, &rq->q.list);
810 spin_unlock(&queue_lock);
811 } else {
812 if (rp->offset + count > rq->len)
813 count = rq->len - rp->offset;
814 err = -EFAULT;
815 if (copy_to_user(buf, rq->buf + rp->offset, count))
816 goto out;
817 rp->offset += count;
818 if (rp->offset >= rq->len) {
819 rp->offset = 0;
820 spin_lock(&queue_lock);
821 list_move(&rp->q.list, &rq->q.list);
822 spin_unlock(&queue_lock);
823 }
824 err = 0;
825 }
826 out:
827 if (rp->offset == 0) {
828 /* need to release rq */
829 spin_lock(&queue_lock);
830 rq->readers--;
831 if (rq->readers == 0 &&
832 !test_bit(CACHE_PENDING, &rq->item->flags)) {
833 list_del(&rq->q.list);
834 spin_unlock(&queue_lock);
baab935f 835 cache_put(rq->item, cd);
1da177e4
LT
836 kfree(rq->buf);
837 kfree(rq);
838 } else
839 spin_unlock(&queue_lock);
840 }
841 if (err == -EAGAIN)
842 goto again;
da77005f 843 mutex_unlock(&inode->i_mutex);
1da177e4
LT
844 return err ? err : count;
845}
846
da77005f
TM
847static ssize_t cache_do_downcall(char *kaddr, const char __user *buf,
848 size_t count, struct cache_detail *cd)
849{
850 ssize_t ret;
1da177e4 851
6d8d1749
DC
852 if (count == 0)
853 return -EINVAL;
da77005f
TM
854 if (copy_from_user(kaddr, buf, count))
855 return -EFAULT;
856 kaddr[count] = '\0';
857 ret = cd->cache_parse(cd, kaddr, count);
858 if (!ret)
859 ret = count;
860 return ret;
861}
862
863static ssize_t cache_slow_downcall(const char __user *buf,
864 size_t count, struct cache_detail *cd)
1da177e4 865{
da77005f
TM
866 static char write_buf[8192]; /* protected by queue_io_mutex */
867 ssize_t ret = -EINVAL;
1da177e4 868
1da177e4 869 if (count >= sizeof(write_buf))
da77005f 870 goto out;
4a3e2f71 871 mutex_lock(&queue_io_mutex);
da77005f
TM
872 ret = cache_do_downcall(write_buf, buf, count, cd);
873 mutex_unlock(&queue_io_mutex);
874out:
875 return ret;
876}
1da177e4 877
da77005f
TM
878static ssize_t cache_downcall(struct address_space *mapping,
879 const char __user *buf,
880 size_t count, struct cache_detail *cd)
881{
882 struct page *page;
883 char *kaddr;
884 ssize_t ret = -ENOMEM;
885
886 if (count >= PAGE_CACHE_SIZE)
887 goto out_slow;
888
889 page = find_or_create_page(mapping, 0, GFP_KERNEL);
890 if (!page)
891 goto out_slow;
892
893 kaddr = kmap(page);
894 ret = cache_do_downcall(kaddr, buf, count, cd);
895 kunmap(page);
896 unlock_page(page);
897 page_cache_release(page);
898 return ret;
899out_slow:
900 return cache_slow_downcall(buf, count, cd);
901}
1da177e4 902
173912a6
TM
903static ssize_t cache_write(struct file *filp, const char __user *buf,
904 size_t count, loff_t *ppos,
905 struct cache_detail *cd)
da77005f
TM
906{
907 struct address_space *mapping = filp->f_mapping;
496ad9aa 908 struct inode *inode = file_inode(filp);
da77005f
TM
909 ssize_t ret = -EINVAL;
910
911 if (!cd->cache_parse)
912 goto out;
913
914 mutex_lock(&inode->i_mutex);
915 ret = cache_downcall(mapping, buf, count, cd);
916 mutex_unlock(&inode->i_mutex);
917out:
918 return ret;
1da177e4
LT
919}
920
921static DECLARE_WAIT_QUEUE_HEAD(queue_wait);
922
173912a6
TM
923static unsigned int cache_poll(struct file *filp, poll_table *wait,
924 struct cache_detail *cd)
1da177e4
LT
925{
926 unsigned int mask;
927 struct cache_reader *rp = filp->private_data;
928 struct cache_queue *cq;
1da177e4
LT
929
930 poll_wait(filp, &queue_wait, wait);
931
932 /* alway allow write */
933 mask = POLL_OUT | POLLWRNORM;
934
935 if (!rp)
936 return mask;
937
938 spin_lock(&queue_lock);
939
940 for (cq= &rp->q; &cq->list != &cd->queue;
941 cq = list_entry(cq->list.next, struct cache_queue, list))
942 if (!cq->reader) {
943 mask |= POLLIN | POLLRDNORM;
944 break;
945 }
946 spin_unlock(&queue_lock);
947 return mask;
948}
949
173912a6
TM
950static int cache_ioctl(struct inode *ino, struct file *filp,
951 unsigned int cmd, unsigned long arg,
952 struct cache_detail *cd)
1da177e4
LT
953{
954 int len = 0;
955 struct cache_reader *rp = filp->private_data;
956 struct cache_queue *cq;
1da177e4
LT
957
958 if (cmd != FIONREAD || !rp)
959 return -EINVAL;
960
961 spin_lock(&queue_lock);
962
963 /* only find the length remaining in current request,
964 * or the length of the next request
965 */
966 for (cq= &rp->q; &cq->list != &cd->queue;
967 cq = list_entry(cq->list.next, struct cache_queue, list))
968 if (!cq->reader) {
969 struct cache_request *cr =
970 container_of(cq, struct cache_request, q);
971 len = cr->len - rp->offset;
972 break;
973 }
974 spin_unlock(&queue_lock);
975
976 return put_user(len, (int __user *)arg);
977}
978
173912a6
TM
979static int cache_open(struct inode *inode, struct file *filp,
980 struct cache_detail *cd)
1da177e4
LT
981{
982 struct cache_reader *rp = NULL;
983
f7e86ab9
TM
984 if (!cd || !try_module_get(cd->owner))
985 return -EACCES;
1da177e4
LT
986 nonseekable_open(inode, filp);
987 if (filp->f_mode & FMODE_READ) {
1da177e4
LT
988 rp = kmalloc(sizeof(*rp), GFP_KERNEL);
989 if (!rp)
990 return -ENOMEM;
991 rp->offset = 0;
992 rp->q.reader = 1;
993 atomic_inc(&cd->readers);
994 spin_lock(&queue_lock);
995 list_add(&rp->q.list, &cd->queue);
996 spin_unlock(&queue_lock);
997 }
998 filp->private_data = rp;
999 return 0;
1000}
1001
173912a6
TM
1002static int cache_release(struct inode *inode, struct file *filp,
1003 struct cache_detail *cd)
1da177e4
LT
1004{
1005 struct cache_reader *rp = filp->private_data;
1da177e4
LT
1006
1007 if (rp) {
1008 spin_lock(&queue_lock);
1009 if (rp->offset) {
1010 struct cache_queue *cq;
1011 for (cq= &rp->q; &cq->list != &cd->queue;
1012 cq = list_entry(cq->list.next, struct cache_queue, list))
1013 if (!cq->reader) {
1014 container_of(cq, struct cache_request, q)
1015 ->readers--;
1016 break;
1017 }
1018 rp->offset = 0;
1019 }
1020 list_del(&rp->q.list);
1021 spin_unlock(&queue_lock);
1022
1023 filp->private_data = NULL;
1024 kfree(rp);
1025
c5b29f88 1026 cd->last_close = seconds_since_boot();
1da177e4
LT
1027 atomic_dec(&cd->readers);
1028 }
f7e86ab9 1029 module_put(cd->owner);
1da177e4
LT
1030 return 0;
1031}
1032
1033
1034
f866a819 1035static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch)
1da177e4
LT
1036{
1037 struct cache_queue *cq;
1038 spin_lock(&queue_lock);
1039 list_for_each_entry(cq, &detail->queue, list)
1040 if (!cq->reader) {
1041 struct cache_request *cr = container_of(cq, struct cache_request, q);
1042 if (cr->item != ch)
1043 continue;
1044 if (cr->readers != 0)
4013edea 1045 continue;
1da177e4
LT
1046 list_del(&cr->q.list);
1047 spin_unlock(&queue_lock);
baab935f 1048 cache_put(cr->item, detail);
1da177e4
LT
1049 kfree(cr->buf);
1050 kfree(cr);
1051 return;
1052 }
1053 spin_unlock(&queue_lock);
1054}
1055
1056/*
1057 * Support routines for text-based upcalls.
1058 * Fields are separated by spaces.
1059 * Fields are either mangled to quote space tab newline slosh with slosh
1060 * or a hexified with a leading \x
1061 * Record is terminated with newline.
1062 *
1063 */
1064
1065void qword_add(char **bpp, int *lp, char *str)
1066{
1067 char *bp = *bpp;
1068 int len = *lp;
1069 char c;
1070
1071 if (len < 0) return;
1072
1073 while ((c=*str++) && len)
1074 switch(c) {
1075 case ' ':
1076 case '\t':
1077 case '\n':
1078 case '\\':
1079 if (len >= 4) {
1080 *bp++ = '\\';
1081 *bp++ = '0' + ((c & 0300)>>6);
1082 *bp++ = '0' + ((c & 0070)>>3);
1083 *bp++ = '0' + ((c & 0007)>>0);
1084 }
1085 len -= 4;
1086 break;
1087 default:
1088 *bp++ = c;
1089 len--;
1090 }
1091 if (c || len <1) len = -1;
1092 else {
1093 *bp++ = ' ';
1094 len--;
1095 }
1096 *bpp = bp;
1097 *lp = len;
1098}
24c3767e 1099EXPORT_SYMBOL_GPL(qword_add);
1da177e4
LT
1100
1101void qword_addhex(char **bpp, int *lp, char *buf, int blen)
1102{
1103 char *bp = *bpp;
1104 int len = *lp;
1105
1106 if (len < 0) return;
1107
1108 if (len > 2) {
1109 *bp++ = '\\';
1110 *bp++ = 'x';
1111 len -= 2;
1112 while (blen && len >= 2) {
1113 unsigned char c = *buf++;
1114 *bp++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
1115 *bp++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
1116 len -= 2;
1117 blen--;
1118 }
1119 }
1120 if (blen || len<1) len = -1;
1121 else {
1122 *bp++ = ' ';
1123 len--;
1124 }
1125 *bpp = bp;
1126 *lp = len;
1127}
24c3767e 1128EXPORT_SYMBOL_GPL(qword_addhex);
1da177e4
LT
1129
1130static void warn_no_listener(struct cache_detail *detail)
1131{
1132 if (detail->last_warn != detail->last_close) {
1133 detail->last_warn = detail->last_close;
1134 if (detail->warn_no_listener)
2da8ca26 1135 detail->warn_no_listener(detail, detail->last_close != 0);
1da177e4
LT
1136 }
1137}
1138
06497524
BF
1139static bool cache_listeners_exist(struct cache_detail *detail)
1140{
1141 if (atomic_read(&detail->readers))
1142 return true;
1143 if (detail->last_close == 0)
1144 /* This cache was never opened */
1145 return false;
1146 if (detail->last_close < seconds_since_boot() - 30)
1147 /*
1148 * We allow for the possibility that someone might
1149 * restart a userspace daemon without restarting the
1150 * server; but after 30 seconds, we give up.
1151 */
1152 return false;
1153 return true;
1154}
1155
1da177e4 1156/*
bc74b4f5
TM
1157 * register an upcall request to user-space and queue it up for read() by the
1158 * upcall daemon.
1159 *
1da177e4
LT
1160 * Each request is at most one page long.
1161 */
21cd1254 1162int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h)
1da177e4
LT
1163{
1164
1165 char *buf;
1166 struct cache_request *crq;
1da177e4 1167
2d438338
SK
1168 if (!detail->cache_request)
1169 return -EINVAL;
1da177e4 1170
06497524
BF
1171 if (!cache_listeners_exist(detail)) {
1172 warn_no_listener(detail);
1173 return -EINVAL;
1da177e4
LT
1174 }
1175
1176 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
1177 if (!buf)
1178 return -EAGAIN;
1179
1180 crq = kmalloc(sizeof (*crq), GFP_KERNEL);
1181 if (!crq) {
1182 kfree(buf);
1183 return -EAGAIN;
1184 }
1185
1da177e4
LT
1186 crq->q.reader = 0;
1187 crq->item = cache_get(h);
1188 crq->buf = buf;
d94af6de 1189 crq->len = 0;
1da177e4
LT
1190 crq->readers = 0;
1191 spin_lock(&queue_lock);
1192 list_add_tail(&crq->q.list, &detail->queue);
1193 spin_unlock(&queue_lock);
1194 wake_up(&queue_wait);
1195 return 0;
1196}
bc74b4f5 1197EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall);
1da177e4
LT
1198
1199/*
1200 * parse a message from user-space and pass it
1201 * to an appropriate cache
1202 * Messages are, like requests, separated into fields by
1203 * spaces and dequotes as \xHEXSTRING or embedded \nnn octal
1204 *
cca5172a 1205 * Message is
1da177e4
LT
1206 * reply cachename expiry key ... content....
1207 *
cca5172a 1208 * key and content are both parsed by cache
1da177e4
LT
1209 */
1210
1211#define isodigit(c) (isdigit(c) && c <= '7')
1212int qword_get(char **bpp, char *dest, int bufsize)
1213{
1214 /* return bytes copied, or -1 on error */
1215 char *bp = *bpp;
1216 int len = 0;
1217
1218 while (*bp == ' ') bp++;
1219
1220 if (bp[0] == '\\' && bp[1] == 'x') {
1221 /* HEX STRING */
1222 bp += 2;
e7f483ea
AS
1223 while (len < bufsize) {
1224 int h, l;
1225
1226 h = hex_to_bin(bp[0]);
1227 if (h < 0)
1228 break;
1229
1230 l = hex_to_bin(bp[1]);
1231 if (l < 0)
1232 break;
1233
1234 *dest++ = (h << 4) | l;
1235 bp += 2;
1da177e4
LT
1236 len++;
1237 }
1238 } else {
1239 /* text with \nnn octal quoting */
1240 while (*bp != ' ' && *bp != '\n' && *bp && len < bufsize-1) {
1241 if (*bp == '\\' &&
1242 isodigit(bp[1]) && (bp[1] <= '3') &&
1243 isodigit(bp[2]) &&
1244 isodigit(bp[3])) {
1245 int byte = (*++bp -'0');
1246 bp++;
1247 byte = (byte << 3) | (*bp++ - '0');
1248 byte = (byte << 3) | (*bp++ - '0');
1249 *dest++ = byte;
1250 len++;
1251 } else {
1252 *dest++ = *bp++;
1253 len++;
1254 }
1255 }
1256 }
1257
1258 if (*bp != ' ' && *bp != '\n' && *bp != '\0')
1259 return -1;
1260 while (*bp == ' ') bp++;
1261 *bpp = bp;
1262 *dest = '\0';
1263 return len;
1264}
24c3767e 1265EXPORT_SYMBOL_GPL(qword_get);
1da177e4
LT
1266
1267
1268/*
1269 * support /proc/sunrpc/cache/$CACHENAME/content
1270 * as a seqfile.
1271 * We call ->cache_show passing NULL for the item to
1272 * get a header, then pass each real item in the cache
1273 */
1274
1275struct handle {
1276 struct cache_detail *cd;
1277};
1278
1279static void *c_start(struct seq_file *m, loff_t *pos)
9a429c49 1280 __acquires(cd->hash_lock)
1da177e4
LT
1281{
1282 loff_t n = *pos;
95c96174 1283 unsigned int hash, entry;
1da177e4
LT
1284 struct cache_head *ch;
1285 struct cache_detail *cd = ((struct handle*)m->private)->cd;
cca5172a 1286
1da177e4
LT
1287
1288 read_lock(&cd->hash_lock);
1289 if (!n--)
1290 return SEQ_START_TOKEN;
1291 hash = n >> 32;
1292 entry = n & ((1LL<<32) - 1);
1293
1294 for (ch=cd->hash_table[hash]; ch; ch=ch->next)
1295 if (!entry--)
1296 return ch;
1297 n &= ~((1LL<<32) - 1);
1298 do {
1299 hash++;
1300 n += 1LL<<32;
cca5172a 1301 } while(hash < cd->hash_size &&
1da177e4
LT
1302 cd->hash_table[hash]==NULL);
1303 if (hash >= cd->hash_size)
1304 return NULL;
1305 *pos = n+1;
1306 return cd->hash_table[hash];
1307}
1308
1309static void *c_next(struct seq_file *m, void *p, loff_t *pos)
1310{
1311 struct cache_head *ch = p;
1312 int hash = (*pos >> 32);
1313 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1314
1315 if (p == SEQ_START_TOKEN)
1316 hash = 0;
1317 else if (ch->next == NULL) {
1318 hash++;
1319 *pos += 1LL<<32;
1320 } else {
1321 ++*pos;
1322 return ch->next;
1323 }
1324 *pos &= ~((1LL<<32) - 1);
1325 while (hash < cd->hash_size &&
1326 cd->hash_table[hash] == NULL) {
1327 hash++;
1328 *pos += 1LL<<32;
1329 }
1330 if (hash >= cd->hash_size)
1331 return NULL;
1332 ++*pos;
1333 return cd->hash_table[hash];
1334}
1335
1336static void c_stop(struct seq_file *m, void *p)
9a429c49 1337 __releases(cd->hash_lock)
1da177e4
LT
1338{
1339 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1340 read_unlock(&cd->hash_lock);
1341}
1342
1343static int c_show(struct seq_file *m, void *p)
1344{
1345 struct cache_head *cp = p;
1346 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1347
1348 if (p == SEQ_START_TOKEN)
1349 return cd->cache_show(m, cd, NULL);
1350
1351 ifdebug(CACHE)
4013edea 1352 seq_printf(m, "# expiry=%ld refcnt=%d flags=%lx\n",
c5b29f88
N
1353 convert_to_wallclock(cp->expiry_time),
1354 atomic_read(&cp->ref.refcount), cp->flags);
1da177e4
LT
1355 cache_get(cp);
1356 if (cache_check(cd, cp, NULL))
1357 /* cache_check does a cache_put on failure */
1358 seq_printf(m, "# ");
200724a7
N
1359 else {
1360 if (cache_is_expired(cd, cp))
1361 seq_printf(m, "# ");
1da177e4 1362 cache_put(cp, cd);
200724a7 1363 }
1da177e4
LT
1364
1365 return cd->cache_show(m, cd, cp);
1366}
1367
56b3d975 1368static const struct seq_operations cache_content_op = {
1da177e4
LT
1369 .start = c_start,
1370 .next = c_next,
1371 .stop = c_stop,
1372 .show = c_show,
1373};
1374
173912a6
TM
1375static int content_open(struct inode *inode, struct file *file,
1376 struct cache_detail *cd)
1da177e4 1377{
1da177e4 1378 struct handle *han;
1da177e4 1379
f7e86ab9
TM
1380 if (!cd || !try_module_get(cd->owner))
1381 return -EACCES;
ec931035 1382 han = __seq_open_private(file, &cache_content_op, sizeof(*han));
a5990ea1
LZ
1383 if (han == NULL) {
1384 module_put(cd->owner);
1da177e4 1385 return -ENOMEM;
a5990ea1 1386 }
1da177e4
LT
1387
1388 han->cd = cd;
ec931035 1389 return 0;
1da177e4 1390}
1da177e4 1391
f7e86ab9
TM
1392static int content_release(struct inode *inode, struct file *file,
1393 struct cache_detail *cd)
1394{
1395 int ret = seq_release_private(inode, file);
1396 module_put(cd->owner);
1397 return ret;
1398}
1399
1400static int open_flush(struct inode *inode, struct file *file,
1401 struct cache_detail *cd)
1402{
1403 if (!cd || !try_module_get(cd->owner))
1404 return -EACCES;
1405 return nonseekable_open(inode, file);
1406}
1407
1408static int release_flush(struct inode *inode, struct file *file,
1409 struct cache_detail *cd)
1410{
1411 module_put(cd->owner);
1412 return 0;
1413}
1da177e4
LT
1414
1415static ssize_t read_flush(struct file *file, char __user *buf,
173912a6
TM
1416 size_t count, loff_t *ppos,
1417 struct cache_detail *cd)
1da177e4 1418{
212ba906 1419 char tbuf[22];
1da177e4 1420 unsigned long p = *ppos;
01b2969a 1421 size_t len;
1da177e4 1422
212ba906 1423 snprintf(tbuf, sizeof(tbuf), "%lu\n", convert_to_wallclock(cd->flush_time));
1da177e4
LT
1424 len = strlen(tbuf);
1425 if (p >= len)
1426 return 0;
1427 len -= p;
01b2969a
CL
1428 if (len > count)
1429 len = count;
1da177e4 1430 if (copy_to_user(buf, (void*)(tbuf+p), len))
01b2969a
CL
1431 return -EFAULT;
1432 *ppos += len;
1da177e4
LT
1433 return len;
1434}
1435
173912a6
TM
1436static ssize_t write_flush(struct file *file, const char __user *buf,
1437 size_t count, loff_t *ppos,
1438 struct cache_detail *cd)
1da177e4 1439{
1da177e4 1440 char tbuf[20];
c5b29f88
N
1441 char *bp, *ep;
1442
1da177e4
LT
1443 if (*ppos || count > sizeof(tbuf)-1)
1444 return -EINVAL;
1445 if (copy_from_user(tbuf, buf, count))
1446 return -EFAULT;
1447 tbuf[count] = 0;
c5b29f88 1448 simple_strtoul(tbuf, &ep, 0);
1da177e4
LT
1449 if (*ep && *ep != '\n')
1450 return -EINVAL;
1451
c5b29f88
N
1452 bp = tbuf;
1453 cd->flush_time = get_expiry(&bp);
1454 cd->nextcheck = seconds_since_boot();
1da177e4
LT
1455 cache_flush();
1456
1457 *ppos += count;
1458 return count;
1459}
1460
173912a6
TM
1461static ssize_t cache_read_procfs(struct file *filp, char __user *buf,
1462 size_t count, loff_t *ppos)
1463{
d9dda78b 1464 struct cache_detail *cd = PDE_DATA(file_inode(filp));
173912a6
TM
1465
1466 return cache_read(filp, buf, count, ppos, cd);
1467}
1468
1469static ssize_t cache_write_procfs(struct file *filp, const char __user *buf,
1470 size_t count, loff_t *ppos)
1471{
d9dda78b 1472 struct cache_detail *cd = PDE_DATA(file_inode(filp));
173912a6
TM
1473
1474 return cache_write(filp, buf, count, ppos, cd);
1475}
1476
1477static unsigned int cache_poll_procfs(struct file *filp, poll_table *wait)
1478{
d9dda78b 1479 struct cache_detail *cd = PDE_DATA(file_inode(filp));
173912a6
TM
1480
1481 return cache_poll(filp, wait, cd);
1482}
1483
d79b6f4d
FW
1484static long cache_ioctl_procfs(struct file *filp,
1485 unsigned int cmd, unsigned long arg)
173912a6 1486{
496ad9aa 1487 struct inode *inode = file_inode(filp);
d9dda78b 1488 struct cache_detail *cd = PDE_DATA(inode);
173912a6 1489
a6f8dbc6 1490 return cache_ioctl(inode, filp, cmd, arg, cd);
173912a6
TM
1491}
1492
1493static int cache_open_procfs(struct inode *inode, struct file *filp)
1494{
d9dda78b 1495 struct cache_detail *cd = PDE_DATA(inode);
173912a6
TM
1496
1497 return cache_open(inode, filp, cd);
1498}
1499
1500static int cache_release_procfs(struct inode *inode, struct file *filp)
1501{
d9dda78b 1502 struct cache_detail *cd = PDE_DATA(inode);
173912a6
TM
1503
1504 return cache_release(inode, filp, cd);
1505}
1506
1507static const struct file_operations cache_file_operations_procfs = {
1508 .owner = THIS_MODULE,
1509 .llseek = no_llseek,
1510 .read = cache_read_procfs,
1511 .write = cache_write_procfs,
1512 .poll = cache_poll_procfs,
d79b6f4d 1513 .unlocked_ioctl = cache_ioctl_procfs, /* for FIONREAD */
173912a6
TM
1514 .open = cache_open_procfs,
1515 .release = cache_release_procfs,
1da177e4 1516};
173912a6
TM
1517
1518static int content_open_procfs(struct inode *inode, struct file *filp)
1519{
d9dda78b 1520 struct cache_detail *cd = PDE_DATA(inode);
173912a6
TM
1521
1522 return content_open(inode, filp, cd);
1523}
1524
f7e86ab9
TM
1525static int content_release_procfs(struct inode *inode, struct file *filp)
1526{
d9dda78b 1527 struct cache_detail *cd = PDE_DATA(inode);
f7e86ab9
TM
1528
1529 return content_release(inode, filp, cd);
1530}
1531
173912a6
TM
1532static const struct file_operations content_file_operations_procfs = {
1533 .open = content_open_procfs,
1534 .read = seq_read,
1535 .llseek = seq_lseek,
f7e86ab9 1536 .release = content_release_procfs,
173912a6
TM
1537};
1538
f7e86ab9
TM
1539static int open_flush_procfs(struct inode *inode, struct file *filp)
1540{
d9dda78b 1541 struct cache_detail *cd = PDE_DATA(inode);
f7e86ab9
TM
1542
1543 return open_flush(inode, filp, cd);
1544}
1545
1546static int release_flush_procfs(struct inode *inode, struct file *filp)
1547{
d9dda78b 1548 struct cache_detail *cd = PDE_DATA(inode);
f7e86ab9
TM
1549
1550 return release_flush(inode, filp, cd);
1551}
1552
173912a6
TM
1553static ssize_t read_flush_procfs(struct file *filp, char __user *buf,
1554 size_t count, loff_t *ppos)
1555{
d9dda78b 1556 struct cache_detail *cd = PDE_DATA(file_inode(filp));
173912a6
TM
1557
1558 return read_flush(filp, buf, count, ppos, cd);
1559}
1560
1561static ssize_t write_flush_procfs(struct file *filp,
1562 const char __user *buf,
1563 size_t count, loff_t *ppos)
1564{
d9dda78b 1565 struct cache_detail *cd = PDE_DATA(file_inode(filp));
173912a6
TM
1566
1567 return write_flush(filp, buf, count, ppos, cd);
1568}
1569
1570static const struct file_operations cache_flush_operations_procfs = {
f7e86ab9 1571 .open = open_flush_procfs,
173912a6
TM
1572 .read = read_flush_procfs,
1573 .write = write_flush_procfs,
f7e86ab9 1574 .release = release_flush_procfs,
6038f373 1575 .llseek = no_llseek,
1da177e4 1576};
173912a6 1577
593ce16b 1578static void remove_cache_proc_entries(struct cache_detail *cd, struct net *net)
173912a6 1579{
4f42d0d5
PE
1580 struct sunrpc_net *sn;
1581
173912a6
TM
1582 if (cd->u.procfs.proc_ent == NULL)
1583 return;
1584 if (cd->u.procfs.flush_ent)
1585 remove_proc_entry("flush", cd->u.procfs.proc_ent);
1586 if (cd->u.procfs.channel_ent)
1587 remove_proc_entry("channel", cd->u.procfs.proc_ent);
1588 if (cd->u.procfs.content_ent)
1589 remove_proc_entry("content", cd->u.procfs.proc_ent);
1590 cd->u.procfs.proc_ent = NULL;
4f42d0d5
PE
1591 sn = net_generic(net, sunrpc_net_id);
1592 remove_proc_entry(cd->name, sn->proc_net_rpc);
173912a6
TM
1593}
1594
1595#ifdef CONFIG_PROC_FS
593ce16b 1596static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
173912a6
TM
1597{
1598 struct proc_dir_entry *p;
4f42d0d5 1599 struct sunrpc_net *sn;
173912a6 1600
4f42d0d5
PE
1601 sn = net_generic(net, sunrpc_net_id);
1602 cd->u.procfs.proc_ent = proc_mkdir(cd->name, sn->proc_net_rpc);
173912a6
TM
1603 if (cd->u.procfs.proc_ent == NULL)
1604 goto out_nomem;
1605 cd->u.procfs.channel_ent = NULL;
1606 cd->u.procfs.content_ent = NULL;
1607
1608 p = proc_create_data("flush", S_IFREG|S_IRUSR|S_IWUSR,
1609 cd->u.procfs.proc_ent,
1610 &cache_flush_operations_procfs, cd);
1611 cd->u.procfs.flush_ent = p;
1612 if (p == NULL)
1613 goto out_nomem;
1614
2d438338 1615 if (cd->cache_request || cd->cache_parse) {
173912a6
TM
1616 p = proc_create_data("channel", S_IFREG|S_IRUSR|S_IWUSR,
1617 cd->u.procfs.proc_ent,
1618 &cache_file_operations_procfs, cd);
1619 cd->u.procfs.channel_ent = p;
1620 if (p == NULL)
1621 goto out_nomem;
1622 }
1623 if (cd->cache_show) {
ec168676 1624 p = proc_create_data("content", S_IFREG|S_IRUSR,
173912a6
TM
1625 cd->u.procfs.proc_ent,
1626 &content_file_operations_procfs, cd);
1627 cd->u.procfs.content_ent = p;
1628 if (p == NULL)
1629 goto out_nomem;
1630 }
1631 return 0;
1632out_nomem:
593ce16b 1633 remove_cache_proc_entries(cd, net);
173912a6
TM
1634 return -ENOMEM;
1635}
1636#else /* CONFIG_PROC_FS */
593ce16b 1637static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
173912a6
TM
1638{
1639 return 0;
1640}
1641#endif
1642
8eab945c
AB
1643void __init cache_initialize(void)
1644{
203b42f7 1645 INIT_DEFERRABLE_WORK(&cache_cleaner, do_cache_clean);
8eab945c
AB
1646}
1647
593ce16b 1648int cache_register_net(struct cache_detail *cd, struct net *net)
173912a6
TM
1649{
1650 int ret;
1651
1652 sunrpc_init_cache_detail(cd);
593ce16b 1653 ret = create_cache_proc_entries(cd, net);
173912a6
TM
1654 if (ret)
1655 sunrpc_destroy_cache_detail(cd);
1656 return ret;
1657}
f5c8593b 1658EXPORT_SYMBOL_GPL(cache_register_net);
593ce16b 1659
593ce16b 1660void cache_unregister_net(struct cache_detail *cd, struct net *net)
173912a6 1661{
593ce16b 1662 remove_cache_proc_entries(cd, net);
173912a6
TM
1663 sunrpc_destroy_cache_detail(cd);
1664}
f5c8593b 1665EXPORT_SYMBOL_GPL(cache_unregister_net);
593ce16b 1666
0a402d5a
SK
1667struct cache_detail *cache_create_net(struct cache_detail *tmpl, struct net *net)
1668{
1669 struct cache_detail *cd;
1670
1671 cd = kmemdup(tmpl, sizeof(struct cache_detail), GFP_KERNEL);
1672 if (cd == NULL)
1673 return ERR_PTR(-ENOMEM);
1674
1675 cd->hash_table = kzalloc(cd->hash_size * sizeof(struct cache_head *),
1676 GFP_KERNEL);
1677 if (cd->hash_table == NULL) {
1678 kfree(cd);
1679 return ERR_PTR(-ENOMEM);
1680 }
1681 cd->net = net;
1682 return cd;
1683}
1684EXPORT_SYMBOL_GPL(cache_create_net);
1685
1686void cache_destroy_net(struct cache_detail *cd, struct net *net)
593ce16b 1687{
0a402d5a
SK
1688 kfree(cd->hash_table);
1689 kfree(cd);
593ce16b 1690}
0a402d5a 1691EXPORT_SYMBOL_GPL(cache_destroy_net);
8854e82d
TM
1692
1693static ssize_t cache_read_pipefs(struct file *filp, char __user *buf,
1694 size_t count, loff_t *ppos)
1695{
496ad9aa 1696 struct cache_detail *cd = RPC_I(file_inode(filp))->private;
8854e82d
TM
1697
1698 return cache_read(filp, buf, count, ppos, cd);
1699}
1700
1701static ssize_t cache_write_pipefs(struct file *filp, const char __user *buf,
1702 size_t count, loff_t *ppos)
1703{
496ad9aa 1704 struct cache_detail *cd = RPC_I(file_inode(filp))->private;
8854e82d
TM
1705
1706 return cache_write(filp, buf, count, ppos, cd);
1707}
1708
1709static unsigned int cache_poll_pipefs(struct file *filp, poll_table *wait)
1710{
496ad9aa 1711 struct cache_detail *cd = RPC_I(file_inode(filp))->private;
8854e82d
TM
1712
1713 return cache_poll(filp, wait, cd);
1714}
1715
9918ff26 1716static long cache_ioctl_pipefs(struct file *filp,
8854e82d
TM
1717 unsigned int cmd, unsigned long arg)
1718{
496ad9aa 1719 struct inode *inode = file_inode(filp);
8854e82d
TM
1720 struct cache_detail *cd = RPC_I(inode)->private;
1721
a6f8dbc6 1722 return cache_ioctl(inode, filp, cmd, arg, cd);
8854e82d
TM
1723}
1724
1725static int cache_open_pipefs(struct inode *inode, struct file *filp)
1726{
1727 struct cache_detail *cd = RPC_I(inode)->private;
1728
1729 return cache_open(inode, filp, cd);
1730}
1731
1732static int cache_release_pipefs(struct inode *inode, struct file *filp)
1733{
1734 struct cache_detail *cd = RPC_I(inode)->private;
1735
1736 return cache_release(inode, filp, cd);
1737}
1738
1739const struct file_operations cache_file_operations_pipefs = {
1740 .owner = THIS_MODULE,
1741 .llseek = no_llseek,
1742 .read = cache_read_pipefs,
1743 .write = cache_write_pipefs,
1744 .poll = cache_poll_pipefs,
9918ff26 1745 .unlocked_ioctl = cache_ioctl_pipefs, /* for FIONREAD */
8854e82d
TM
1746 .open = cache_open_pipefs,
1747 .release = cache_release_pipefs,
1748};
1749
1750static int content_open_pipefs(struct inode *inode, struct file *filp)
1751{
1752 struct cache_detail *cd = RPC_I(inode)->private;
1753
1754 return content_open(inode, filp, cd);
1755}
1756
f7e86ab9
TM
1757static int content_release_pipefs(struct inode *inode, struct file *filp)
1758{
1759 struct cache_detail *cd = RPC_I(inode)->private;
1760
1761 return content_release(inode, filp, cd);
1762}
1763
8854e82d
TM
1764const struct file_operations content_file_operations_pipefs = {
1765 .open = content_open_pipefs,
1766 .read = seq_read,
1767 .llseek = seq_lseek,
f7e86ab9 1768 .release = content_release_pipefs,
8854e82d
TM
1769};
1770
f7e86ab9
TM
1771static int open_flush_pipefs(struct inode *inode, struct file *filp)
1772{
1773 struct cache_detail *cd = RPC_I(inode)->private;
1774
1775 return open_flush(inode, filp, cd);
1776}
1777
1778static int release_flush_pipefs(struct inode *inode, struct file *filp)
1779{
1780 struct cache_detail *cd = RPC_I(inode)->private;
1781
1782 return release_flush(inode, filp, cd);
1783}
1784
8854e82d
TM
1785static ssize_t read_flush_pipefs(struct file *filp, char __user *buf,
1786 size_t count, loff_t *ppos)
1787{
496ad9aa 1788 struct cache_detail *cd = RPC_I(file_inode(filp))->private;
8854e82d
TM
1789
1790 return read_flush(filp, buf, count, ppos, cd);
1791}
1792
1793static ssize_t write_flush_pipefs(struct file *filp,
1794 const char __user *buf,
1795 size_t count, loff_t *ppos)
1796{
496ad9aa 1797 struct cache_detail *cd = RPC_I(file_inode(filp))->private;
8854e82d
TM
1798
1799 return write_flush(filp, buf, count, ppos, cd);
1800}
1801
1802const struct file_operations cache_flush_operations_pipefs = {
f7e86ab9 1803 .open = open_flush_pipefs,
8854e82d
TM
1804 .read = read_flush_pipefs,
1805 .write = write_flush_pipefs,
f7e86ab9 1806 .release = release_flush_pipefs,
6038f373 1807 .llseek = no_llseek,
8854e82d
TM
1808};
1809
1810int sunrpc_cache_register_pipefs(struct dentry *parent,
64f1426f 1811 const char *name, umode_t umode,
8854e82d
TM
1812 struct cache_detail *cd)
1813{
1814 struct qstr q;
1815 struct dentry *dir;
1816 int ret = 0;
1817
8854e82d
TM
1818 q.name = name;
1819 q.len = strlen(name);
1820 q.hash = full_name_hash(q.name, q.len);
1821 dir = rpc_create_cache_dir(parent, &q, umode, cd);
1822 if (!IS_ERR(dir))
1823 cd->u.pipefs.dir = dir;
820f9442 1824 else
8854e82d 1825 ret = PTR_ERR(dir);
8854e82d
TM
1826 return ret;
1827}
1828EXPORT_SYMBOL_GPL(sunrpc_cache_register_pipefs);
1829
1830void sunrpc_cache_unregister_pipefs(struct cache_detail *cd)
1831{
1832 rpc_remove_cache_dir(cd->u.pipefs.dir);
1833 cd->u.pipefs.dir = NULL;
8854e82d
TM
1834}
1835EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs);
1836