4 * Generic code for various authentication-related caches
5 * used by sunrpc clients and servers.
7 * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
9 * Released under terms in GPL version 2. See COPYING.
13 #include <linux/types.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>
29 #include <linux/mutex.h>
30 #include <linux/pagemap.h>
31 #include <linux/smp_lock.h>
32 #include <asm/ioctls.h>
33 #include <linux/sunrpc/types.h>
34 #include <linux/sunrpc/cache.h>
35 #include <linux/sunrpc/stats.h>
36 #include <linux/sunrpc/rpc_pipe_fs.h>
39 #define RPCDBG_FACILITY RPCDBG_CACHE
41 static void cache_defer_req(struct cache_req *req, struct cache_head *item);
42 static void cache_revisit_request(struct cache_head *item);
44 static void cache_init(struct cache_head *h)
46 time_t now = seconds_since_boot();
50 h->expiry_time = now + CACHE_NEW_EXPIRY;
51 h->last_refresh = now;
54 static inline int cache_is_expired(struct cache_detail *detail, struct cache_head *h)
56 return (h->expiry_time < seconds_since_boot()) ||
57 (detail->flush_time > h->last_refresh);
60 struct cache_head *sunrpc_cache_lookup(struct cache_detail *detail,
61 struct cache_head *key, int hash)
63 struct cache_head **head, **hp;
64 struct cache_head *new = NULL, *freeme = NULL;
66 head = &detail->hash_table[hash];
68 read_lock(&detail->hash_lock);
70 for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
71 struct cache_head *tmp = *hp;
72 if (detail->match(tmp, key)) {
73 if (cache_is_expired(detail, tmp))
74 /* This entry is expired, we will discard it. */
77 read_unlock(&detail->hash_lock);
81 read_unlock(&detail->hash_lock);
82 /* Didn't find anything, insert an empty entry */
84 new = detail->alloc();
87 /* must fully initialise 'new', else
88 * we might get lose if we need to
92 detail->init(new, key);
94 write_lock(&detail->hash_lock);
96 /* check if entry appeared while we slept */
97 for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
98 struct cache_head *tmp = *hp;
99 if (detail->match(tmp, key)) {
100 if (cache_is_expired(detail, tmp)) {
108 write_unlock(&detail->hash_lock);
109 cache_put(new, detail);
117 write_unlock(&detail->hash_lock);
120 cache_put(freeme, detail);
123 EXPORT_SYMBOL_GPL(sunrpc_cache_lookup);
126 static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch);
128 static void cache_fresh_locked(struct cache_head *head, time_t expiry)
130 head->expiry_time = expiry;
131 head->last_refresh = seconds_since_boot();
132 set_bit(CACHE_VALID, &head->flags);
135 static void cache_fresh_unlocked(struct cache_head *head,
136 struct cache_detail *detail)
138 if (test_and_clear_bit(CACHE_PENDING, &head->flags)) {
139 cache_revisit_request(head);
140 cache_dequeue(detail, head);
144 struct cache_head *sunrpc_cache_update(struct cache_detail *detail,
145 struct cache_head *new, struct cache_head *old, int hash)
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
151 struct cache_head **head;
152 struct cache_head *tmp;
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);
160 detail->update(old, new);
161 cache_fresh_locked(old, new->expiry_time);
162 write_unlock(&detail->hash_lock);
163 cache_fresh_unlocked(old, detail);
166 write_unlock(&detail->hash_lock);
168 /* We need to insert a new entry */
169 tmp = detail->alloc();
171 cache_put(old, detail);
175 detail->init(tmp, old);
176 head = &detail->hash_table[hash];
178 write_lock(&detail->hash_lock);
179 if (test_bit(CACHE_NEGATIVE, &new->flags))
180 set_bit(CACHE_NEGATIVE, &tmp->flags);
182 detail->update(tmp, new);
187 cache_fresh_locked(tmp, new->expiry_time);
188 cache_fresh_locked(old, 0);
189 write_unlock(&detail->hash_lock);
190 cache_fresh_unlocked(tmp, detail);
191 cache_fresh_unlocked(old, detail);
192 cache_put(old, detail);
195 EXPORT_SYMBOL_GPL(sunrpc_cache_update);
197 static int cache_make_upcall(struct cache_detail *cd, struct cache_head *h)
199 if (!cd->cache_upcall)
201 return cd->cache_upcall(cd, h);
204 static inline int cache_is_valid(struct cache_detail *detail, struct cache_head *h)
206 if (!test_bit(CACHE_VALID, &h->flags))
210 if (test_bit(CACHE_NEGATIVE, &h->flags))
218 * This is the generic cache management routine for all
219 * the authentication caches.
220 * It checks the currency of a cache item and will (later)
221 * initiate an upcall to fill it if needed.
224 * Returns 0 if the cache_head can be used, or cache_puts it and returns
225 * -EAGAIN if upcall is pending and request has been queued
226 * -ETIMEDOUT if upcall failed or request could not be queue or
227 * upcall completed but item is still invalid (implying that
228 * the cache item has been replaced with a newer one).
229 * -ENOENT if cache entry was negative
231 int cache_check(struct cache_detail *detail,
232 struct cache_head *h, struct cache_req *rqstp)
235 long refresh_age, age;
237 /* First decide return status as best we can */
238 rv = cache_is_valid(detail, h);
240 /* now see if we want to start an upcall */
241 refresh_age = (h->expiry_time - h->last_refresh);
242 age = seconds_since_boot() - h->last_refresh;
247 } else if (rv == -EAGAIN || age > refresh_age/2) {
248 dprintk("RPC: Want update, refage=%ld, age=%ld\n",
250 if (!test_and_set_bit(CACHE_PENDING, &h->flags)) {
251 switch (cache_make_upcall(detail, h)) {
253 clear_bit(CACHE_PENDING, &h->flags);
254 cache_revisit_request(h);
256 set_bit(CACHE_NEGATIVE, &h->flags);
257 cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY);
258 cache_fresh_unlocked(h, detail);
264 clear_bit(CACHE_PENDING, &h->flags);
265 cache_revisit_request(h);
272 cache_defer_req(rqstp, h);
273 if (!test_bit(CACHE_PENDING, &h->flags)) {
274 /* Request is not deferred */
275 rv = cache_is_valid(detail, h);
281 cache_put(h, detail);
284 EXPORT_SYMBOL_GPL(cache_check);
287 * caches need to be periodically cleaned.
288 * For this we maintain a list of cache_detail and
289 * a current pointer into that list and into the table
292 * Each time clean_cache is called it finds the next non-empty entry
293 * in the current table and walks the list in that entry
294 * looking for entries that can be removed.
296 * An entry gets removed if:
297 * - The expiry is before current time
298 * - The last_refresh time is before the flush_time for that cache
300 * later we might drop old entries with non-NEVER expiry if that table
301 * is getting 'full' for some definition of 'full'
303 * The question of "how often to scan a table" is an interesting one
304 * and is answered in part by the use of the "nextcheck" field in the
306 * When a scan of a table begins, the nextcheck field is set to a time
307 * that is well into the future.
308 * While scanning, if an expiry time is found that is earlier than the
309 * current nextcheck time, nextcheck is set to that expiry time.
310 * If the flush_time is ever set to a time earlier than the nextcheck
311 * time, the nextcheck time is then set to that flush_time.
313 * A table is then only scanned if the current time is at least
314 * the nextcheck time.
318 static LIST_HEAD(cache_list);
319 static DEFINE_SPINLOCK(cache_list_lock);
320 static struct cache_detail *current_detail;
321 static int current_index;
323 static void do_cache_clean(struct work_struct *work);
324 static struct delayed_work cache_cleaner;
326 static void sunrpc_init_cache_detail(struct cache_detail *cd)
328 rwlock_init(&cd->hash_lock);
329 INIT_LIST_HEAD(&cd->queue);
330 spin_lock(&cache_list_lock);
333 atomic_set(&cd->readers, 0);
336 list_add(&cd->others, &cache_list);
337 spin_unlock(&cache_list_lock);
339 /* start the cleaning process */
340 schedule_delayed_work(&cache_cleaner, 0);
343 static void sunrpc_destroy_cache_detail(struct cache_detail *cd)
346 spin_lock(&cache_list_lock);
347 write_lock(&cd->hash_lock);
348 if (cd->entries || atomic_read(&cd->inuse)) {
349 write_unlock(&cd->hash_lock);
350 spin_unlock(&cache_list_lock);
353 if (current_detail == cd)
354 current_detail = NULL;
355 list_del_init(&cd->others);
356 write_unlock(&cd->hash_lock);
357 spin_unlock(&cache_list_lock);
358 if (list_empty(&cache_list)) {
359 /* module must be being unloaded so its safe to kill the worker */
360 cancel_delayed_work_sync(&cache_cleaner);
364 printk(KERN_ERR "nfsd: failed to unregister %s cache\n", cd->name);
367 /* clean cache tries to find something to clean
369 * It returns 1 if it cleaned something,
370 * 0 if it didn't find anything this time
371 * -1 if it fell off the end of the list.
373 static int cache_clean(void)
376 struct list_head *next;
378 spin_lock(&cache_list_lock);
380 /* find a suitable table if we don't already have one */
381 while (current_detail == NULL ||
382 current_index >= current_detail->hash_size) {
384 next = current_detail->others.next;
386 next = cache_list.next;
387 if (next == &cache_list) {
388 current_detail = NULL;
389 spin_unlock(&cache_list_lock);
392 current_detail = list_entry(next, struct cache_detail, others);
393 if (current_detail->nextcheck > seconds_since_boot())
394 current_index = current_detail->hash_size;
397 current_detail->nextcheck = seconds_since_boot()+30*60;
401 /* find a non-empty bucket in the table */
402 while (current_detail &&
403 current_index < current_detail->hash_size &&
404 current_detail->hash_table[current_index] == NULL)
407 /* find a cleanable entry in the bucket and clean it, or set to next bucket */
409 if (current_detail && current_index < current_detail->hash_size) {
410 struct cache_head *ch, **cp;
411 struct cache_detail *d;
413 write_lock(¤t_detail->hash_lock);
415 /* Ok, now to clean this strand */
417 cp = & current_detail->hash_table[current_index];
418 for (ch = *cp ; ch ; cp = & ch->next, ch = *cp) {
419 if (current_detail->nextcheck > ch->expiry_time)
420 current_detail->nextcheck = ch->expiry_time+1;
421 if (!cache_is_expired(current_detail, ch))
426 current_detail->entries--;
431 write_unlock(¤t_detail->hash_lock);
435 spin_unlock(&cache_list_lock);
437 if (test_and_clear_bit(CACHE_PENDING, &ch->flags))
438 cache_dequeue(current_detail, ch);
439 cache_revisit_request(ch);
443 spin_unlock(&cache_list_lock);
449 * We want to regularly clean the cache, so we need to schedule some work ...
451 static void do_cache_clean(struct work_struct *work)
454 if (cache_clean() == -1)
455 delay = round_jiffies_relative(30*HZ);
457 if (list_empty(&cache_list))
461 schedule_delayed_work(&cache_cleaner, delay);
466 * Clean all caches promptly. This just calls cache_clean
467 * repeatedly until we are sure that every cache has had a chance to
470 void cache_flush(void)
472 while (cache_clean() != -1)
474 while (cache_clean() != -1)
477 EXPORT_SYMBOL_GPL(cache_flush);
479 void cache_purge(struct cache_detail *detail)
481 detail->flush_time = LONG_MAX;
482 detail->nextcheck = seconds_since_boot();
484 detail->flush_time = 1;
486 EXPORT_SYMBOL_GPL(cache_purge);
490 * Deferral and Revisiting of Requests.
492 * If a cache lookup finds a pending entry, we
493 * need to defer the request and revisit it later.
494 * All deferred requests are stored in a hash table,
495 * indexed by "struct cache_head *".
496 * As it may be wasteful to store a whole request
497 * structure, we allow the request to provide a
498 * deferred form, which must contain a
499 * 'struct cache_deferred_req'
500 * This cache_deferred_req contains a method to allow
501 * it to be revisited when cache info is available
504 #define DFR_HASHSIZE (PAGE_SIZE/sizeof(struct list_head))
505 #define DFR_HASH(item) ((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE)
507 #define DFR_MAX 300 /* ??? */
509 static DEFINE_SPINLOCK(cache_defer_lock);
510 static LIST_HEAD(cache_defer_list);
511 static struct hlist_head cache_defer_hash[DFR_HASHSIZE];
512 static int cache_defer_cnt;
514 static void __unhash_deferred_req(struct cache_deferred_req *dreq)
516 list_del_init(&dreq->recent);
517 hlist_del_init(&dreq->hash);
521 static void __hash_deferred_req(struct cache_deferred_req *dreq, struct cache_head *item)
523 int hash = DFR_HASH(item);
525 list_add(&dreq->recent, &cache_defer_list);
526 hlist_add_head(&dreq->hash, &cache_defer_hash[hash]);
529 static void setup_deferral(struct cache_deferred_req *dreq, struct cache_head *item)
531 struct cache_deferred_req *discard;
535 spin_lock(&cache_defer_lock);
537 __hash_deferred_req(dreq, item);
539 /* it is in, now maybe clean up */
541 if (++cache_defer_cnt > DFR_MAX) {
542 discard = list_entry(cache_defer_list.prev,
543 struct cache_deferred_req, recent);
544 __unhash_deferred_req(discard);
546 spin_unlock(&cache_defer_lock);
549 /* there was one too many */
550 discard->revisit(discard, 1);
553 struct thread_deferred_req {
554 struct cache_deferred_req handle;
555 struct completion completion;
558 static void cache_restart_thread(struct cache_deferred_req *dreq, int too_many)
560 struct thread_deferred_req *dr =
561 container_of(dreq, struct thread_deferred_req, handle);
562 complete(&dr->completion);
565 static void cache_wait_req(struct cache_req *req, struct cache_head *item)
567 struct thread_deferred_req sleeper;
568 struct cache_deferred_req *dreq = &sleeper.handle;
570 sleeper.completion = COMPLETION_INITIALIZER_ONSTACK(sleeper.completion);
571 dreq->revisit = cache_restart_thread;
573 setup_deferral(dreq, item);
575 if (!test_bit(CACHE_PENDING, &item->flags) ||
576 wait_for_completion_interruptible_timeout(
577 &sleeper.completion, req->thread_wait) <= 0) {
578 /* The completion wasn't completed, so we need
581 spin_lock(&cache_defer_lock);
582 if (!hlist_unhashed(&sleeper.handle.hash)) {
583 __unhash_deferred_req(&sleeper.handle);
584 spin_unlock(&cache_defer_lock);
586 /* cache_revisit_request already removed
587 * this from the hash table, but hasn't
588 * called ->revisit yet. It will very soon
589 * and we need to wait for it.
591 spin_unlock(&cache_defer_lock);
592 wait_for_completion(&sleeper.completion);
597 static void cache_defer_req(struct cache_req *req, struct cache_head *item)
599 struct cache_deferred_req *dreq;
601 if (cache_defer_cnt >= DFR_MAX)
602 /* too much in the cache, randomly drop this one,
603 * or continue and drop the oldest
609 if (req->thread_wait) {
610 cache_wait_req(req, item);
611 if (!test_bit(CACHE_PENDING, &item->flags))
614 dreq = req->defer(req);
617 setup_deferral(dreq, item);
618 if (!test_bit(CACHE_PENDING, &item->flags))
619 /* Bit could have been cleared before we managed to
620 * set up the deferral, so need to revisit just in case
622 cache_revisit_request(item);
625 static void cache_revisit_request(struct cache_head *item)
627 struct cache_deferred_req *dreq;
628 struct list_head pending;
629 struct hlist_node *lp, *tmp;
630 int hash = DFR_HASH(item);
632 INIT_LIST_HEAD(&pending);
633 spin_lock(&cache_defer_lock);
635 hlist_for_each_entry_safe(dreq, lp, tmp, &cache_defer_hash[hash], hash)
636 if (dreq->item == item) {
637 __unhash_deferred_req(dreq);
638 list_add(&dreq->recent, &pending);
641 spin_unlock(&cache_defer_lock);
643 while (!list_empty(&pending)) {
644 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
645 list_del_init(&dreq->recent);
646 dreq->revisit(dreq, 0);
650 void cache_clean_deferred(void *owner)
652 struct cache_deferred_req *dreq, *tmp;
653 struct list_head pending;
656 INIT_LIST_HEAD(&pending);
657 spin_lock(&cache_defer_lock);
659 list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) {
660 if (dreq->owner == owner) {
661 __unhash_deferred_req(dreq);
662 list_add(&dreq->recent, &pending);
665 spin_unlock(&cache_defer_lock);
667 while (!list_empty(&pending)) {
668 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
669 list_del_init(&dreq->recent);
670 dreq->revisit(dreq, 1);
675 * communicate with user-space
677 * We have a magic /proc file - /proc/sunrpc/<cachename>/channel.
678 * On read, you get a full request, or block.
679 * On write, an update request is processed.
680 * Poll works if anything to read, and always allows write.
682 * Implemented by linked list of requests. Each open file has
683 * a ->private that also exists in this list. New requests are added
684 * to the end and may wakeup and preceding readers.
685 * New readers are added to the head. If, on read, an item is found with
686 * CACHE_UPCALLING clear, we free it from the list.
690 static DEFINE_SPINLOCK(queue_lock);
691 static DEFINE_MUTEX(queue_io_mutex);
694 struct list_head list;
695 int reader; /* if 0, then request */
697 struct cache_request {
698 struct cache_queue q;
699 struct cache_head *item;
704 struct cache_reader {
705 struct cache_queue q;
706 int offset; /* if non-0, we have a refcnt on next request */
709 static ssize_t cache_read(struct file *filp, char __user *buf, size_t count,
710 loff_t *ppos, struct cache_detail *cd)
712 struct cache_reader *rp = filp->private_data;
713 struct cache_request *rq;
714 struct inode *inode = filp->f_path.dentry->d_inode;
720 mutex_lock(&inode->i_mutex); /* protect against multiple concurrent
721 * readers on this file */
723 spin_lock(&queue_lock);
724 /* need to find next request */
725 while (rp->q.list.next != &cd->queue &&
726 list_entry(rp->q.list.next, struct cache_queue, list)
728 struct list_head *next = rp->q.list.next;
729 list_move(&rp->q.list, next);
731 if (rp->q.list.next == &cd->queue) {
732 spin_unlock(&queue_lock);
733 mutex_unlock(&inode->i_mutex);
737 rq = container_of(rp->q.list.next, struct cache_request, q.list);
738 BUG_ON(rq->q.reader);
741 spin_unlock(&queue_lock);
743 if (rp->offset == 0 && !test_bit(CACHE_PENDING, &rq->item->flags)) {
745 spin_lock(&queue_lock);
746 list_move(&rp->q.list, &rq->q.list);
747 spin_unlock(&queue_lock);
749 if (rp->offset + count > rq->len)
750 count = rq->len - rp->offset;
752 if (copy_to_user(buf, rq->buf + rp->offset, count))
755 if (rp->offset >= rq->len) {
757 spin_lock(&queue_lock);
758 list_move(&rp->q.list, &rq->q.list);
759 spin_unlock(&queue_lock);
764 if (rp->offset == 0) {
765 /* need to release rq */
766 spin_lock(&queue_lock);
768 if (rq->readers == 0 &&
769 !test_bit(CACHE_PENDING, &rq->item->flags)) {
770 list_del(&rq->q.list);
771 spin_unlock(&queue_lock);
772 cache_put(rq->item, cd);
776 spin_unlock(&queue_lock);
780 mutex_unlock(&inode->i_mutex);
781 return err ? err : count;
784 static ssize_t cache_do_downcall(char *kaddr, const char __user *buf,
785 size_t count, struct cache_detail *cd)
789 if (copy_from_user(kaddr, buf, count))
792 ret = cd->cache_parse(cd, kaddr, count);
798 static ssize_t cache_slow_downcall(const char __user *buf,
799 size_t count, struct cache_detail *cd)
801 static char write_buf[8192]; /* protected by queue_io_mutex */
802 ssize_t ret = -EINVAL;
804 if (count >= sizeof(write_buf))
806 mutex_lock(&queue_io_mutex);
807 ret = cache_do_downcall(write_buf, buf, count, cd);
808 mutex_unlock(&queue_io_mutex);
813 static ssize_t cache_downcall(struct address_space *mapping,
814 const char __user *buf,
815 size_t count, struct cache_detail *cd)
819 ssize_t ret = -ENOMEM;
821 if (count >= PAGE_CACHE_SIZE)
824 page = find_or_create_page(mapping, 0, GFP_KERNEL);
829 ret = cache_do_downcall(kaddr, buf, count, cd);
832 page_cache_release(page);
835 return cache_slow_downcall(buf, count, cd);
838 static ssize_t cache_write(struct file *filp, const char __user *buf,
839 size_t count, loff_t *ppos,
840 struct cache_detail *cd)
842 struct address_space *mapping = filp->f_mapping;
843 struct inode *inode = filp->f_path.dentry->d_inode;
844 ssize_t ret = -EINVAL;
846 if (!cd->cache_parse)
849 mutex_lock(&inode->i_mutex);
850 ret = cache_downcall(mapping, buf, count, cd);
851 mutex_unlock(&inode->i_mutex);
856 static DECLARE_WAIT_QUEUE_HEAD(queue_wait);
858 static unsigned int cache_poll(struct file *filp, poll_table *wait,
859 struct cache_detail *cd)
862 struct cache_reader *rp = filp->private_data;
863 struct cache_queue *cq;
865 poll_wait(filp, &queue_wait, wait);
867 /* alway allow write */
868 mask = POLL_OUT | POLLWRNORM;
873 spin_lock(&queue_lock);
875 for (cq= &rp->q; &cq->list != &cd->queue;
876 cq = list_entry(cq->list.next, struct cache_queue, list))
878 mask |= POLLIN | POLLRDNORM;
881 spin_unlock(&queue_lock);
885 static int cache_ioctl(struct inode *ino, struct file *filp,
886 unsigned int cmd, unsigned long arg,
887 struct cache_detail *cd)
890 struct cache_reader *rp = filp->private_data;
891 struct cache_queue *cq;
893 if (cmd != FIONREAD || !rp)
896 spin_lock(&queue_lock);
898 /* only find the length remaining in current request,
899 * or the length of the next request
901 for (cq= &rp->q; &cq->list != &cd->queue;
902 cq = list_entry(cq->list.next, struct cache_queue, list))
904 struct cache_request *cr =
905 container_of(cq, struct cache_request, q);
906 len = cr->len - rp->offset;
909 spin_unlock(&queue_lock);
911 return put_user(len, (int __user *)arg);
914 static int cache_open(struct inode *inode, struct file *filp,
915 struct cache_detail *cd)
917 struct cache_reader *rp = NULL;
919 if (!cd || !try_module_get(cd->owner))
921 nonseekable_open(inode, filp);
922 if (filp->f_mode & FMODE_READ) {
923 rp = kmalloc(sizeof(*rp), GFP_KERNEL);
928 atomic_inc(&cd->readers);
929 spin_lock(&queue_lock);
930 list_add(&rp->q.list, &cd->queue);
931 spin_unlock(&queue_lock);
933 filp->private_data = rp;
937 static int cache_release(struct inode *inode, struct file *filp,
938 struct cache_detail *cd)
940 struct cache_reader *rp = filp->private_data;
943 spin_lock(&queue_lock);
945 struct cache_queue *cq;
946 for (cq= &rp->q; &cq->list != &cd->queue;
947 cq = list_entry(cq->list.next, struct cache_queue, list))
949 container_of(cq, struct cache_request, q)
955 list_del(&rp->q.list);
956 spin_unlock(&queue_lock);
958 filp->private_data = NULL;
961 cd->last_close = seconds_since_boot();
962 atomic_dec(&cd->readers);
964 module_put(cd->owner);
970 static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch)
972 struct cache_queue *cq;
973 spin_lock(&queue_lock);
974 list_for_each_entry(cq, &detail->queue, list)
976 struct cache_request *cr = container_of(cq, struct cache_request, q);
979 if (cr->readers != 0)
981 list_del(&cr->q.list);
982 spin_unlock(&queue_lock);
983 cache_put(cr->item, detail);
988 spin_unlock(&queue_lock);
992 * Support routines for text-based upcalls.
993 * Fields are separated by spaces.
994 * Fields are either mangled to quote space tab newline slosh with slosh
995 * or a hexified with a leading \x
996 * Record is terminated with newline.
1000 void qword_add(char **bpp, int *lp, char *str)
1006 if (len < 0) return;
1008 while ((c=*str++) && len)
1016 *bp++ = '0' + ((c & 0300)>>6);
1017 *bp++ = '0' + ((c & 0070)>>3);
1018 *bp++ = '0' + ((c & 0007)>>0);
1026 if (c || len <1) len = -1;
1034 EXPORT_SYMBOL_GPL(qword_add);
1036 void qword_addhex(char **bpp, int *lp, char *buf, int blen)
1041 if (len < 0) return;
1047 while (blen && len >= 2) {
1048 unsigned char c = *buf++;
1049 *bp++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
1050 *bp++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
1055 if (blen || len<1) len = -1;
1063 EXPORT_SYMBOL_GPL(qword_addhex);
1065 static void warn_no_listener(struct cache_detail *detail)
1067 if (detail->last_warn != detail->last_close) {
1068 detail->last_warn = detail->last_close;
1069 if (detail->warn_no_listener)
1070 detail->warn_no_listener(detail, detail->last_close != 0);
1074 static bool cache_listeners_exist(struct cache_detail *detail)
1076 if (atomic_read(&detail->readers))
1078 if (detail->last_close == 0)
1079 /* This cache was never opened */
1081 if (detail->last_close < seconds_since_boot() - 30)
1083 * We allow for the possibility that someone might
1084 * restart a userspace daemon without restarting the
1085 * server; but after 30 seconds, we give up.
1092 * register an upcall request to user-space and queue it up for read() by the
1095 * Each request is at most one page long.
1097 int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h,
1098 void (*cache_request)(struct cache_detail *,
1099 struct cache_head *,
1105 struct cache_request *crq;
1109 if (!cache_listeners_exist(detail)) {
1110 warn_no_listener(detail);
1114 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
1118 crq = kmalloc(sizeof (*crq), GFP_KERNEL);
1124 bp = buf; len = PAGE_SIZE;
1126 cache_request(detail, h, &bp, &len);
1134 crq->item = cache_get(h);
1136 crq->len = PAGE_SIZE - len;
1138 spin_lock(&queue_lock);
1139 list_add_tail(&crq->q.list, &detail->queue);
1140 spin_unlock(&queue_lock);
1141 wake_up(&queue_wait);
1144 EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall);
1147 * parse a message from user-space and pass it
1148 * to an appropriate cache
1149 * Messages are, like requests, separated into fields by
1150 * spaces and dequotes as \xHEXSTRING or embedded \nnn octal
1153 * reply cachename expiry key ... content....
1155 * key and content are both parsed by cache
1158 #define isodigit(c) (isdigit(c) && c <= '7')
1159 int qword_get(char **bpp, char *dest, int bufsize)
1161 /* return bytes copied, or -1 on error */
1165 while (*bp == ' ') bp++;
1167 if (bp[0] == '\\' && bp[1] == 'x') {
1170 while (len < bufsize) {
1173 h = hex_to_bin(bp[0]);
1177 l = hex_to_bin(bp[1]);
1181 *dest++ = (h << 4) | l;
1186 /* text with \nnn octal quoting */
1187 while (*bp != ' ' && *bp != '\n' && *bp && len < bufsize-1) {
1189 isodigit(bp[1]) && (bp[1] <= '3') &&
1192 int byte = (*++bp -'0');
1194 byte = (byte << 3) | (*bp++ - '0');
1195 byte = (byte << 3) | (*bp++ - '0');
1205 if (*bp != ' ' && *bp != '\n' && *bp != '\0')
1207 while (*bp == ' ') bp++;
1212 EXPORT_SYMBOL_GPL(qword_get);
1216 * support /proc/sunrpc/cache/$CACHENAME/content
1218 * We call ->cache_show passing NULL for the item to
1219 * get a header, then pass each real item in the cache
1223 struct cache_detail *cd;
1226 static void *c_start(struct seq_file *m, loff_t *pos)
1227 __acquires(cd->hash_lock)
1230 unsigned hash, entry;
1231 struct cache_head *ch;
1232 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1235 read_lock(&cd->hash_lock);
1237 return SEQ_START_TOKEN;
1239 entry = n & ((1LL<<32) - 1);
1241 for (ch=cd->hash_table[hash]; ch; ch=ch->next)
1244 n &= ~((1LL<<32) - 1);
1248 } while(hash < cd->hash_size &&
1249 cd->hash_table[hash]==NULL);
1250 if (hash >= cd->hash_size)
1253 return cd->hash_table[hash];
1256 static void *c_next(struct seq_file *m, void *p, loff_t *pos)
1258 struct cache_head *ch = p;
1259 int hash = (*pos >> 32);
1260 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1262 if (p == SEQ_START_TOKEN)
1264 else if (ch->next == NULL) {
1271 *pos &= ~((1LL<<32) - 1);
1272 while (hash < cd->hash_size &&
1273 cd->hash_table[hash] == NULL) {
1277 if (hash >= cd->hash_size)
1280 return cd->hash_table[hash];
1283 static void c_stop(struct seq_file *m, void *p)
1284 __releases(cd->hash_lock)
1286 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1287 read_unlock(&cd->hash_lock);
1290 static int c_show(struct seq_file *m, void *p)
1292 struct cache_head *cp = p;
1293 struct cache_detail *cd = ((struct handle*)m->private)->cd;
1295 if (p == SEQ_START_TOKEN)
1296 return cd->cache_show(m, cd, NULL);
1299 seq_printf(m, "# expiry=%ld refcnt=%d flags=%lx\n",
1300 convert_to_wallclock(cp->expiry_time),
1301 atomic_read(&cp->ref.refcount), cp->flags);
1303 if (cache_check(cd, cp, NULL))
1304 /* cache_check does a cache_put on failure */
1305 seq_printf(m, "# ");
1309 return cd->cache_show(m, cd, cp);
1312 static const struct seq_operations cache_content_op = {
1319 static int content_open(struct inode *inode, struct file *file,
1320 struct cache_detail *cd)
1324 if (!cd || !try_module_get(cd->owner))
1326 han = __seq_open_private(file, &cache_content_op, sizeof(*han));
1328 module_put(cd->owner);
1336 static int content_release(struct inode *inode, struct file *file,
1337 struct cache_detail *cd)
1339 int ret = seq_release_private(inode, file);
1340 module_put(cd->owner);
1344 static int open_flush(struct inode *inode, struct file *file,
1345 struct cache_detail *cd)
1347 if (!cd || !try_module_get(cd->owner))
1349 return nonseekable_open(inode, file);
1352 static int release_flush(struct inode *inode, struct file *file,
1353 struct cache_detail *cd)
1355 module_put(cd->owner);
1359 static ssize_t read_flush(struct file *file, char __user *buf,
1360 size_t count, loff_t *ppos,
1361 struct cache_detail *cd)
1364 unsigned long p = *ppos;
1367 sprintf(tbuf, "%lu\n", convert_to_wallclock(cd->flush_time));
1374 if (copy_to_user(buf, (void*)(tbuf+p), len))
1380 static ssize_t write_flush(struct file *file, const char __user *buf,
1381 size_t count, loff_t *ppos,
1382 struct cache_detail *cd)
1387 if (*ppos || count > sizeof(tbuf)-1)
1389 if (copy_from_user(tbuf, buf, count))
1392 simple_strtoul(tbuf, &ep, 0);
1393 if (*ep && *ep != '\n')
1397 cd->flush_time = get_expiry(&bp);
1398 cd->nextcheck = seconds_since_boot();
1405 static ssize_t cache_read_procfs(struct file *filp, char __user *buf,
1406 size_t count, loff_t *ppos)
1408 struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;
1410 return cache_read(filp, buf, count, ppos, cd);
1413 static ssize_t cache_write_procfs(struct file *filp, const char __user *buf,
1414 size_t count, loff_t *ppos)
1416 struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;
1418 return cache_write(filp, buf, count, ppos, cd);
1421 static unsigned int cache_poll_procfs(struct file *filp, poll_table *wait)
1423 struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;
1425 return cache_poll(filp, wait, cd);
1428 static long cache_ioctl_procfs(struct file *filp,
1429 unsigned int cmd, unsigned long arg)
1432 struct inode *inode = filp->f_path.dentry->d_inode;
1433 struct cache_detail *cd = PDE(inode)->data;
1436 ret = cache_ioctl(inode, filp, cmd, arg, cd);
1442 static int cache_open_procfs(struct inode *inode, struct file *filp)
1444 struct cache_detail *cd = PDE(inode)->data;
1446 return cache_open(inode, filp, cd);
1449 static int cache_release_procfs(struct inode *inode, struct file *filp)
1451 struct cache_detail *cd = PDE(inode)->data;
1453 return cache_release(inode, filp, cd);
1456 static const struct file_operations cache_file_operations_procfs = {
1457 .owner = THIS_MODULE,
1458 .llseek = no_llseek,
1459 .read = cache_read_procfs,
1460 .write = cache_write_procfs,
1461 .poll = cache_poll_procfs,
1462 .unlocked_ioctl = cache_ioctl_procfs, /* for FIONREAD */
1463 .open = cache_open_procfs,
1464 .release = cache_release_procfs,
1467 static int content_open_procfs(struct inode *inode, struct file *filp)
1469 struct cache_detail *cd = PDE(inode)->data;
1471 return content_open(inode, filp, cd);
1474 static int content_release_procfs(struct inode *inode, struct file *filp)
1476 struct cache_detail *cd = PDE(inode)->data;
1478 return content_release(inode, filp, cd);
1481 static const struct file_operations content_file_operations_procfs = {
1482 .open = content_open_procfs,
1484 .llseek = seq_lseek,
1485 .release = content_release_procfs,
1488 static int open_flush_procfs(struct inode *inode, struct file *filp)
1490 struct cache_detail *cd = PDE(inode)->data;
1492 return open_flush(inode, filp, cd);
1495 static int release_flush_procfs(struct inode *inode, struct file *filp)
1497 struct cache_detail *cd = PDE(inode)->data;
1499 return release_flush(inode, filp, cd);
1502 static ssize_t read_flush_procfs(struct file *filp, char __user *buf,
1503 size_t count, loff_t *ppos)
1505 struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;
1507 return read_flush(filp, buf, count, ppos, cd);
1510 static ssize_t write_flush_procfs(struct file *filp,
1511 const char __user *buf,
1512 size_t count, loff_t *ppos)
1514 struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;
1516 return write_flush(filp, buf, count, ppos, cd);
1519 static const struct file_operations cache_flush_operations_procfs = {
1520 .open = open_flush_procfs,
1521 .read = read_flush_procfs,
1522 .write = write_flush_procfs,
1523 .release = release_flush_procfs,
1526 static void remove_cache_proc_entries(struct cache_detail *cd, struct net *net)
1528 struct sunrpc_net *sn;
1530 if (cd->u.procfs.proc_ent == NULL)
1532 if (cd->u.procfs.flush_ent)
1533 remove_proc_entry("flush", cd->u.procfs.proc_ent);
1534 if (cd->u.procfs.channel_ent)
1535 remove_proc_entry("channel", cd->u.procfs.proc_ent);
1536 if (cd->u.procfs.content_ent)
1537 remove_proc_entry("content", cd->u.procfs.proc_ent);
1538 cd->u.procfs.proc_ent = NULL;
1539 sn = net_generic(net, sunrpc_net_id);
1540 remove_proc_entry(cd->name, sn->proc_net_rpc);
1543 #ifdef CONFIG_PROC_FS
1544 static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1546 struct proc_dir_entry *p;
1547 struct sunrpc_net *sn;
1549 sn = net_generic(net, sunrpc_net_id);
1550 cd->u.procfs.proc_ent = proc_mkdir(cd->name, sn->proc_net_rpc);
1551 if (cd->u.procfs.proc_ent == NULL)
1553 cd->u.procfs.channel_ent = NULL;
1554 cd->u.procfs.content_ent = NULL;
1556 p = proc_create_data("flush", S_IFREG|S_IRUSR|S_IWUSR,
1557 cd->u.procfs.proc_ent,
1558 &cache_flush_operations_procfs, cd);
1559 cd->u.procfs.flush_ent = p;
1563 if (cd->cache_upcall || cd->cache_parse) {
1564 p = proc_create_data("channel", S_IFREG|S_IRUSR|S_IWUSR,
1565 cd->u.procfs.proc_ent,
1566 &cache_file_operations_procfs, cd);
1567 cd->u.procfs.channel_ent = p;
1571 if (cd->cache_show) {
1572 p = proc_create_data("content", S_IFREG|S_IRUSR|S_IWUSR,
1573 cd->u.procfs.proc_ent,
1574 &content_file_operations_procfs, cd);
1575 cd->u.procfs.content_ent = p;
1581 remove_cache_proc_entries(cd, net);
1584 #else /* CONFIG_PROC_FS */
1585 static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1591 void __init cache_initialize(void)
1593 INIT_DELAYED_WORK_DEFERRABLE(&cache_cleaner, do_cache_clean);
1596 int cache_register_net(struct cache_detail *cd, struct net *net)
1600 sunrpc_init_cache_detail(cd);
1601 ret = create_cache_proc_entries(cd, net);
1603 sunrpc_destroy_cache_detail(cd);
1607 int cache_register(struct cache_detail *cd)
1609 return cache_register_net(cd, &init_net);
1611 EXPORT_SYMBOL_GPL(cache_register);
1613 void cache_unregister_net(struct cache_detail *cd, struct net *net)
1615 remove_cache_proc_entries(cd, net);
1616 sunrpc_destroy_cache_detail(cd);
1619 void cache_unregister(struct cache_detail *cd)
1621 cache_unregister_net(cd, &init_net);
1623 EXPORT_SYMBOL_GPL(cache_unregister);
1625 static ssize_t cache_read_pipefs(struct file *filp, char __user *buf,
1626 size_t count, loff_t *ppos)
1628 struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;
1630 return cache_read(filp, buf, count, ppos, cd);
1633 static ssize_t cache_write_pipefs(struct file *filp, const char __user *buf,
1634 size_t count, loff_t *ppos)
1636 struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;
1638 return cache_write(filp, buf, count, ppos, cd);
1641 static unsigned int cache_poll_pipefs(struct file *filp, poll_table *wait)
1643 struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;
1645 return cache_poll(filp, wait, cd);
1648 static long cache_ioctl_pipefs(struct file *filp,
1649 unsigned int cmd, unsigned long arg)
1651 struct inode *inode = filp->f_dentry->d_inode;
1652 struct cache_detail *cd = RPC_I(inode)->private;
1656 ret = cache_ioctl(inode, filp, cmd, arg, cd);
1662 static int cache_open_pipefs(struct inode *inode, struct file *filp)
1664 struct cache_detail *cd = RPC_I(inode)->private;
1666 return cache_open(inode, filp, cd);
1669 static int cache_release_pipefs(struct inode *inode, struct file *filp)
1671 struct cache_detail *cd = RPC_I(inode)->private;
1673 return cache_release(inode, filp, cd);
1676 const struct file_operations cache_file_operations_pipefs = {
1677 .owner = THIS_MODULE,
1678 .llseek = no_llseek,
1679 .read = cache_read_pipefs,
1680 .write = cache_write_pipefs,
1681 .poll = cache_poll_pipefs,
1682 .unlocked_ioctl = cache_ioctl_pipefs, /* for FIONREAD */
1683 .open = cache_open_pipefs,
1684 .release = cache_release_pipefs,
1687 static int content_open_pipefs(struct inode *inode, struct file *filp)
1689 struct cache_detail *cd = RPC_I(inode)->private;
1691 return content_open(inode, filp, cd);
1694 static int content_release_pipefs(struct inode *inode, struct file *filp)
1696 struct cache_detail *cd = RPC_I(inode)->private;
1698 return content_release(inode, filp, cd);
1701 const struct file_operations content_file_operations_pipefs = {
1702 .open = content_open_pipefs,
1704 .llseek = seq_lseek,
1705 .release = content_release_pipefs,
1708 static int open_flush_pipefs(struct inode *inode, struct file *filp)
1710 struct cache_detail *cd = RPC_I(inode)->private;
1712 return open_flush(inode, filp, cd);
1715 static int release_flush_pipefs(struct inode *inode, struct file *filp)
1717 struct cache_detail *cd = RPC_I(inode)->private;
1719 return release_flush(inode, filp, cd);
1722 static ssize_t read_flush_pipefs(struct file *filp, char __user *buf,
1723 size_t count, loff_t *ppos)
1725 struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;
1727 return read_flush(filp, buf, count, ppos, cd);
1730 static ssize_t write_flush_pipefs(struct file *filp,
1731 const char __user *buf,
1732 size_t count, loff_t *ppos)
1734 struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;
1736 return write_flush(filp, buf, count, ppos, cd);
1739 const struct file_operations cache_flush_operations_pipefs = {
1740 .open = open_flush_pipefs,
1741 .read = read_flush_pipefs,
1742 .write = write_flush_pipefs,
1743 .release = release_flush_pipefs,
1746 int sunrpc_cache_register_pipefs(struct dentry *parent,
1747 const char *name, mode_t umode,
1748 struct cache_detail *cd)
1754 sunrpc_init_cache_detail(cd);
1756 q.len = strlen(name);
1757 q.hash = full_name_hash(q.name, q.len);
1758 dir = rpc_create_cache_dir(parent, &q, umode, cd);
1760 cd->u.pipefs.dir = dir;
1762 sunrpc_destroy_cache_detail(cd);
1767 EXPORT_SYMBOL_GPL(sunrpc_cache_register_pipefs);
1769 void sunrpc_cache_unregister_pipefs(struct cache_detail *cd)
1771 rpc_remove_cache_dir(cd->u.pipefs.dir);
1772 cd->u.pipefs.dir = NULL;
1773 sunrpc_destroy_cache_detail(cd);
1775 EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs);