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 <asm/ioctls.h>
31 #include <linux/sunrpc/types.h>
32 #include <linux/sunrpc/cache.h>
33 #include <linux/sunrpc/stats.h>
35 #define RPCDBG_FACILITY RPCDBG_CACHE
37 static int cache_defer_req(struct cache_req
*req
, struct cache_head
*item
);
38 static void cache_revisit_request(struct cache_head
*item
);
40 static void cache_init(struct cache_head
*h
)
42 time_t now
= get_seconds();
46 h
->expiry_time
= now
+ CACHE_NEW_EXPIRY
;
47 h
->last_refresh
= now
;
50 struct cache_head
*sunrpc_cache_lookup(struct cache_detail
*detail
,
51 struct cache_head
*key
, int hash
)
53 struct cache_head
**head
, **hp
;
54 struct cache_head
*new = NULL
;
56 head
= &detail
->hash_table
[hash
];
58 read_lock(&detail
->hash_lock
);
60 for (hp
=head
; *hp
!= NULL
; hp
= &(*hp
)->next
) {
61 struct cache_head
*tmp
= *hp
;
62 if (detail
->match(tmp
, key
)) {
64 read_unlock(&detail
->hash_lock
);
68 read_unlock(&detail
->hash_lock
);
69 /* Didn't find anything, insert an empty entry */
71 new = detail
->alloc();
74 /* must fully initialise 'new', else
75 * we might get lose if we need to
79 detail
->init(new, key
);
81 write_lock(&detail
->hash_lock
);
83 /* check if entry appeared while we slept */
84 for (hp
=head
; *hp
!= NULL
; hp
= &(*hp
)->next
) {
85 struct cache_head
*tmp
= *hp
;
86 if (detail
->match(tmp
, key
)) {
88 write_unlock(&detail
->hash_lock
);
89 cache_put(new, detail
);
97 write_unlock(&detail
->hash_lock
);
101 EXPORT_SYMBOL_GPL(sunrpc_cache_lookup
);
104 static void cache_dequeue(struct cache_detail
*detail
, struct cache_head
*ch
);
106 static int cache_fresh_locked(struct cache_head
*head
, time_t expiry
)
108 head
->expiry_time
= expiry
;
109 head
->last_refresh
= get_seconds();
110 return !test_and_set_bit(CACHE_VALID
, &head
->flags
);
113 static void cache_fresh_unlocked(struct cache_head
*head
,
114 struct cache_detail
*detail
, int new)
117 cache_revisit_request(head
);
118 if (test_and_clear_bit(CACHE_PENDING
, &head
->flags
)) {
119 cache_revisit_request(head
);
120 cache_dequeue(detail
, head
);
124 struct cache_head
*sunrpc_cache_update(struct cache_detail
*detail
,
125 struct cache_head
*new, struct cache_head
*old
, int hash
)
127 /* The 'old' entry is to be replaced by 'new'.
128 * If 'old' is not VALID, we update it directly,
129 * otherwise we need to replace it
131 struct cache_head
**head
;
132 struct cache_head
*tmp
;
135 if (!test_bit(CACHE_VALID
, &old
->flags
)) {
136 write_lock(&detail
->hash_lock
);
137 if (!test_bit(CACHE_VALID
, &old
->flags
)) {
138 if (test_bit(CACHE_NEGATIVE
, &new->flags
))
139 set_bit(CACHE_NEGATIVE
, &old
->flags
);
141 detail
->update(old
, new);
142 is_new
= cache_fresh_locked(old
, new->expiry_time
);
143 write_unlock(&detail
->hash_lock
);
144 cache_fresh_unlocked(old
, detail
, is_new
);
147 write_unlock(&detail
->hash_lock
);
149 /* We need to insert a new entry */
150 tmp
= detail
->alloc();
152 cache_put(old
, detail
);
156 detail
->init(tmp
, old
);
157 head
= &detail
->hash_table
[hash
];
159 write_lock(&detail
->hash_lock
);
160 if (test_bit(CACHE_NEGATIVE
, &new->flags
))
161 set_bit(CACHE_NEGATIVE
, &tmp
->flags
);
163 detail
->update(tmp
, new);
168 is_new
= cache_fresh_locked(tmp
, new->expiry_time
);
169 cache_fresh_locked(old
, 0);
170 write_unlock(&detail
->hash_lock
);
171 cache_fresh_unlocked(tmp
, detail
, is_new
);
172 cache_fresh_unlocked(old
, detail
, 0);
173 cache_put(old
, detail
);
176 EXPORT_SYMBOL_GPL(sunrpc_cache_update
);
178 static int cache_make_upcall(struct cache_detail
*detail
, struct cache_head
*h
);
180 * This is the generic cache management routine for all
181 * the authentication caches.
182 * It checks the currency of a cache item and will (later)
183 * initiate an upcall to fill it if needed.
186 * Returns 0 if the cache_head can be used, or cache_puts it and returns
187 * -EAGAIN if upcall is pending,
188 * -ETIMEDOUT if upcall failed and should be retried,
189 * -ENOENT if cache entry was negative
191 int cache_check(struct cache_detail
*detail
,
192 struct cache_head
*h
, struct cache_req
*rqstp
)
195 long refresh_age
, age
;
197 /* First decide return status as best we can */
198 if (!test_bit(CACHE_VALID
, &h
->flags
) ||
199 h
->expiry_time
< get_seconds())
201 else if (detail
->flush_time
> h
->last_refresh
)
205 if (test_bit(CACHE_NEGATIVE
, &h
->flags
))
210 /* now see if we want to start an upcall */
211 refresh_age
= (h
->expiry_time
- h
->last_refresh
);
212 age
= get_seconds() - h
->last_refresh
;
217 } else if (rv
== -EAGAIN
|| age
> refresh_age
/2) {
218 dprintk("RPC: Want update, refage=%ld, age=%ld\n",
220 if (!test_and_set_bit(CACHE_PENDING
, &h
->flags
)) {
221 switch (cache_make_upcall(detail
, h
)) {
223 clear_bit(CACHE_PENDING
, &h
->flags
);
224 cache_revisit_request(h
);
226 set_bit(CACHE_NEGATIVE
, &h
->flags
);
227 cache_fresh_unlocked(h
, detail
,
228 cache_fresh_locked(h
, get_seconds()+CACHE_NEW_EXPIRY
));
234 clear_bit(CACHE_PENDING
, &h
->flags
);
235 cache_revisit_request(h
);
242 if (cache_defer_req(rqstp
, h
) != 0)
246 cache_put(h
, detail
);
249 EXPORT_SYMBOL_GPL(cache_check
);
252 * caches need to be periodically cleaned.
253 * For this we maintain a list of cache_detail and
254 * a current pointer into that list and into the table
257 * Each time clean_cache is called it finds the next non-empty entry
258 * in the current table and walks the list in that entry
259 * looking for entries that can be removed.
261 * An entry gets removed if:
262 * - The expiry is before current time
263 * - The last_refresh time is before the flush_time for that cache
265 * later we might drop old entries with non-NEVER expiry if that table
266 * is getting 'full' for some definition of 'full'
268 * The question of "how often to scan a table" is an interesting one
269 * and is answered in part by the use of the "nextcheck" field in the
271 * When a scan of a table begins, the nextcheck field is set to a time
272 * that is well into the future.
273 * While scanning, if an expiry time is found that is earlier than the
274 * current nextcheck time, nextcheck is set to that expiry time.
275 * If the flush_time is ever set to a time earlier than the nextcheck
276 * time, the nextcheck time is then set to that flush_time.
278 * A table is then only scanned if the current time is at least
279 * the nextcheck time.
283 static LIST_HEAD(cache_list
);
284 static DEFINE_SPINLOCK(cache_list_lock
);
285 static struct cache_detail
*current_detail
;
286 static int current_index
;
288 static const struct file_operations cache_file_operations
;
289 static const struct file_operations content_file_operations
;
290 static const struct file_operations cache_flush_operations
;
292 static void do_cache_clean(struct work_struct
*work
);
293 static DECLARE_DELAYED_WORK(cache_cleaner
, do_cache_clean
);
295 static void remove_cache_proc_entries(struct cache_detail
*cd
)
297 if (cd
->proc_ent
== NULL
)
300 remove_proc_entry("flush", cd
->proc_ent
);
302 remove_proc_entry("channel", cd
->proc_ent
);
304 remove_proc_entry("content", cd
->proc_ent
);
306 remove_proc_entry(cd
->name
, proc_net_rpc
);
309 #ifdef CONFIG_PROC_FS
310 static int create_cache_proc_entries(struct cache_detail
*cd
)
312 struct proc_dir_entry
*p
;
314 cd
->proc_ent
= proc_mkdir(cd
->name
, proc_net_rpc
);
315 if (cd
->proc_ent
== NULL
)
317 cd
->channel_ent
= cd
->content_ent
= NULL
;
319 p
= proc_create_data("flush", S_IFREG
|S_IRUSR
|S_IWUSR
,
320 cd
->proc_ent
, &cache_flush_operations
, cd
);
325 if (cd
->cache_request
|| cd
->cache_parse
) {
326 p
= proc_create_data("channel", S_IFREG
|S_IRUSR
|S_IWUSR
,
327 cd
->proc_ent
, &cache_file_operations
, cd
);
332 if (cd
->cache_show
) {
333 p
= proc_create_data("content", S_IFREG
|S_IRUSR
|S_IWUSR
,
334 cd
->proc_ent
, &content_file_operations
, cd
);
341 remove_cache_proc_entries(cd
);
344 #else /* CONFIG_PROC_FS */
345 static int create_cache_proc_entries(struct cache_detail
*cd
)
351 int cache_register(struct cache_detail
*cd
)
355 ret
= create_cache_proc_entries(cd
);
358 rwlock_init(&cd
->hash_lock
);
359 INIT_LIST_HEAD(&cd
->queue
);
360 spin_lock(&cache_list_lock
);
363 atomic_set(&cd
->readers
, 0);
366 list_add(&cd
->others
, &cache_list
);
367 spin_unlock(&cache_list_lock
);
369 /* start the cleaning process */
370 schedule_delayed_work(&cache_cleaner
, 0);
373 EXPORT_SYMBOL_GPL(cache_register
);
375 void cache_unregister(struct cache_detail
*cd
)
378 spin_lock(&cache_list_lock
);
379 write_lock(&cd
->hash_lock
);
380 if (cd
->entries
|| atomic_read(&cd
->inuse
)) {
381 write_unlock(&cd
->hash_lock
);
382 spin_unlock(&cache_list_lock
);
385 if (current_detail
== cd
)
386 current_detail
= NULL
;
387 list_del_init(&cd
->others
);
388 write_unlock(&cd
->hash_lock
);
389 spin_unlock(&cache_list_lock
);
390 remove_cache_proc_entries(cd
);
391 if (list_empty(&cache_list
)) {
392 /* module must be being unloaded so its safe to kill the worker */
393 cancel_delayed_work_sync(&cache_cleaner
);
397 printk(KERN_ERR
"nfsd: failed to unregister %s cache\n", cd
->name
);
399 EXPORT_SYMBOL_GPL(cache_unregister
);
401 /* clean cache tries to find something to clean
403 * It returns 1 if it cleaned something,
404 * 0 if it didn't find anything this time
405 * -1 if it fell off the end of the list.
407 static int cache_clean(void)
410 struct list_head
*next
;
412 spin_lock(&cache_list_lock
);
414 /* find a suitable table if we don't already have one */
415 while (current_detail
== NULL
||
416 current_index
>= current_detail
->hash_size
) {
418 next
= current_detail
->others
.next
;
420 next
= cache_list
.next
;
421 if (next
== &cache_list
) {
422 current_detail
= NULL
;
423 spin_unlock(&cache_list_lock
);
426 current_detail
= list_entry(next
, struct cache_detail
, others
);
427 if (current_detail
->nextcheck
> get_seconds())
428 current_index
= current_detail
->hash_size
;
431 current_detail
->nextcheck
= get_seconds()+30*60;
435 /* find a non-empty bucket in the table */
436 while (current_detail
&&
437 current_index
< current_detail
->hash_size
&&
438 current_detail
->hash_table
[current_index
] == NULL
)
441 /* find a cleanable entry in the bucket and clean it, or set to next bucket */
443 if (current_detail
&& current_index
< current_detail
->hash_size
) {
444 struct cache_head
*ch
, **cp
;
445 struct cache_detail
*d
;
447 write_lock(¤t_detail
->hash_lock
);
449 /* Ok, now to clean this strand */
451 cp
= & current_detail
->hash_table
[current_index
];
453 for (; ch
; cp
= & ch
->next
, ch
= *cp
) {
454 if (current_detail
->nextcheck
> ch
->expiry_time
)
455 current_detail
->nextcheck
= ch
->expiry_time
+1;
456 if (ch
->expiry_time
>= get_seconds()
457 && ch
->last_refresh
>= current_detail
->flush_time
460 if (test_and_clear_bit(CACHE_PENDING
, &ch
->flags
))
461 cache_dequeue(current_detail
, ch
);
463 if (atomic_read(&ch
->ref
.refcount
) == 1)
469 current_detail
->entries
--;
472 write_unlock(¤t_detail
->hash_lock
);
476 spin_unlock(&cache_list_lock
);
478 cache_revisit_request(ch
);
482 spin_unlock(&cache_list_lock
);
488 * We want to regularly clean the cache, so we need to schedule some work ...
490 static void do_cache_clean(struct work_struct
*work
)
493 if (cache_clean() == -1)
494 delay
= round_jiffies_relative(30*HZ
);
496 if (list_empty(&cache_list
))
500 schedule_delayed_work(&cache_cleaner
, delay
);
505 * Clean all caches promptly. This just calls cache_clean
506 * repeatedly until we are sure that every cache has had a chance to
509 void cache_flush(void)
511 while (cache_clean() != -1)
513 while (cache_clean() != -1)
516 EXPORT_SYMBOL_GPL(cache_flush
);
518 void cache_purge(struct cache_detail
*detail
)
520 detail
->flush_time
= LONG_MAX
;
521 detail
->nextcheck
= get_seconds();
523 detail
->flush_time
= 1;
525 EXPORT_SYMBOL_GPL(cache_purge
);
529 * Deferral and Revisiting of Requests.
531 * If a cache lookup finds a pending entry, we
532 * need to defer the request and revisit it later.
533 * All deferred requests are stored in a hash table,
534 * indexed by "struct cache_head *".
535 * As it may be wasteful to store a whole request
536 * structure, we allow the request to provide a
537 * deferred form, which must contain a
538 * 'struct cache_deferred_req'
539 * This cache_deferred_req contains a method to allow
540 * it to be revisited when cache info is available
543 #define DFR_HASHSIZE (PAGE_SIZE/sizeof(struct list_head))
544 #define DFR_HASH(item) ((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE)
546 #define DFR_MAX 300 /* ??? */
548 static DEFINE_SPINLOCK(cache_defer_lock
);
549 static LIST_HEAD(cache_defer_list
);
550 static struct list_head cache_defer_hash
[DFR_HASHSIZE
];
551 static int cache_defer_cnt
;
553 static int cache_defer_req(struct cache_req
*req
, struct cache_head
*item
)
555 struct cache_deferred_req
*dreq
;
556 int hash
= DFR_HASH(item
);
558 if (cache_defer_cnt
>= DFR_MAX
) {
559 /* too much in the cache, randomly drop this one,
560 * or continue and drop the oldest below
565 dreq
= req
->defer(req
);
571 spin_lock(&cache_defer_lock
);
573 list_add(&dreq
->recent
, &cache_defer_list
);
575 if (cache_defer_hash
[hash
].next
== NULL
)
576 INIT_LIST_HEAD(&cache_defer_hash
[hash
]);
577 list_add(&dreq
->hash
, &cache_defer_hash
[hash
]);
579 /* it is in, now maybe clean up */
581 if (++cache_defer_cnt
> DFR_MAX
) {
582 dreq
= list_entry(cache_defer_list
.prev
,
583 struct cache_deferred_req
, recent
);
584 list_del(&dreq
->recent
);
585 list_del(&dreq
->hash
);
588 spin_unlock(&cache_defer_lock
);
591 /* there was one too many */
592 dreq
->revisit(dreq
, 1);
594 if (!test_bit(CACHE_PENDING
, &item
->flags
)) {
595 /* must have just been validated... */
596 cache_revisit_request(item
);
601 static void cache_revisit_request(struct cache_head
*item
)
603 struct cache_deferred_req
*dreq
;
604 struct list_head pending
;
606 struct list_head
*lp
;
607 int hash
= DFR_HASH(item
);
609 INIT_LIST_HEAD(&pending
);
610 spin_lock(&cache_defer_lock
);
612 lp
= cache_defer_hash
[hash
].next
;
614 while (lp
!= &cache_defer_hash
[hash
]) {
615 dreq
= list_entry(lp
, struct cache_deferred_req
, hash
);
617 if (dreq
->item
== item
) {
618 list_del(&dreq
->hash
);
619 list_move(&dreq
->recent
, &pending
);
624 spin_unlock(&cache_defer_lock
);
626 while (!list_empty(&pending
)) {
627 dreq
= list_entry(pending
.next
, struct cache_deferred_req
, recent
);
628 list_del_init(&dreq
->recent
);
629 dreq
->revisit(dreq
, 0);
633 void cache_clean_deferred(void *owner
)
635 struct cache_deferred_req
*dreq
, *tmp
;
636 struct list_head pending
;
639 INIT_LIST_HEAD(&pending
);
640 spin_lock(&cache_defer_lock
);
642 list_for_each_entry_safe(dreq
, tmp
, &cache_defer_list
, recent
) {
643 if (dreq
->owner
== owner
) {
644 list_del(&dreq
->hash
);
645 list_move(&dreq
->recent
, &pending
);
649 spin_unlock(&cache_defer_lock
);
651 while (!list_empty(&pending
)) {
652 dreq
= list_entry(pending
.next
, struct cache_deferred_req
, recent
);
653 list_del_init(&dreq
->recent
);
654 dreq
->revisit(dreq
, 1);
659 * communicate with user-space
661 * We have a magic /proc file - /proc/sunrpc/<cachename>/channel.
662 * On read, you get a full request, or block.
663 * On write, an update request is processed.
664 * Poll works if anything to read, and always allows write.
666 * Implemented by linked list of requests. Each open file has
667 * a ->private that also exists in this list. New requests are added
668 * to the end and may wakeup and preceding readers.
669 * New readers are added to the head. If, on read, an item is found with
670 * CACHE_UPCALLING clear, we free it from the list.
674 static DEFINE_SPINLOCK(queue_lock
);
675 static DEFINE_MUTEX(queue_io_mutex
);
678 struct list_head list
;
679 int reader
; /* if 0, then request */
681 struct cache_request
{
682 struct cache_queue q
;
683 struct cache_head
*item
;
688 struct cache_reader
{
689 struct cache_queue q
;
690 int offset
; /* if non-0, we have a refcnt on next request */
694 cache_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
*ppos
)
696 struct cache_reader
*rp
= filp
->private_data
;
697 struct cache_request
*rq
;
698 struct cache_detail
*cd
= PDE(filp
->f_path
.dentry
->d_inode
)->data
;
704 mutex_lock(&queue_io_mutex
); /* protect against multiple concurrent
705 * readers on this file */
707 spin_lock(&queue_lock
);
708 /* need to find next request */
709 while (rp
->q
.list
.next
!= &cd
->queue
&&
710 list_entry(rp
->q
.list
.next
, struct cache_queue
, list
)
712 struct list_head
*next
= rp
->q
.list
.next
;
713 list_move(&rp
->q
.list
, next
);
715 if (rp
->q
.list
.next
== &cd
->queue
) {
716 spin_unlock(&queue_lock
);
717 mutex_unlock(&queue_io_mutex
);
721 rq
= container_of(rp
->q
.list
.next
, struct cache_request
, q
.list
);
722 BUG_ON(rq
->q
.reader
);
725 spin_unlock(&queue_lock
);
727 if (rp
->offset
== 0 && !test_bit(CACHE_PENDING
, &rq
->item
->flags
)) {
729 spin_lock(&queue_lock
);
730 list_move(&rp
->q
.list
, &rq
->q
.list
);
731 spin_unlock(&queue_lock
);
733 if (rp
->offset
+ count
> rq
->len
)
734 count
= rq
->len
- rp
->offset
;
736 if (copy_to_user(buf
, rq
->buf
+ rp
->offset
, count
))
739 if (rp
->offset
>= rq
->len
) {
741 spin_lock(&queue_lock
);
742 list_move(&rp
->q
.list
, &rq
->q
.list
);
743 spin_unlock(&queue_lock
);
748 if (rp
->offset
== 0) {
749 /* need to release rq */
750 spin_lock(&queue_lock
);
752 if (rq
->readers
== 0 &&
753 !test_bit(CACHE_PENDING
, &rq
->item
->flags
)) {
754 list_del(&rq
->q
.list
);
755 spin_unlock(&queue_lock
);
756 cache_put(rq
->item
, cd
);
760 spin_unlock(&queue_lock
);
764 mutex_unlock(&queue_io_mutex
);
765 return err
? err
: count
;
768 static char write_buf
[8192]; /* protected by queue_io_mutex */
771 cache_write(struct file
*filp
, const char __user
*buf
, size_t count
,
775 struct cache_detail
*cd
= PDE(filp
->f_path
.dentry
->d_inode
)->data
;
779 if (count
>= sizeof(write_buf
))
782 mutex_lock(&queue_io_mutex
);
784 if (copy_from_user(write_buf
, buf
, count
)) {
785 mutex_unlock(&queue_io_mutex
);
788 write_buf
[count
] = '\0';
790 err
= cd
->cache_parse(cd
, write_buf
, count
);
794 mutex_unlock(&queue_io_mutex
);
795 return err
? err
: count
;
798 static DECLARE_WAIT_QUEUE_HEAD(queue_wait
);
801 cache_poll(struct file
*filp
, poll_table
*wait
)
804 struct cache_reader
*rp
= filp
->private_data
;
805 struct cache_queue
*cq
;
806 struct cache_detail
*cd
= PDE(filp
->f_path
.dentry
->d_inode
)->data
;
808 poll_wait(filp
, &queue_wait
, wait
);
810 /* alway allow write */
811 mask
= POLL_OUT
| POLLWRNORM
;
816 spin_lock(&queue_lock
);
818 for (cq
= &rp
->q
; &cq
->list
!= &cd
->queue
;
819 cq
= list_entry(cq
->list
.next
, struct cache_queue
, list
))
821 mask
|= POLLIN
| POLLRDNORM
;
824 spin_unlock(&queue_lock
);
829 cache_ioctl(struct inode
*ino
, struct file
*filp
,
830 unsigned int cmd
, unsigned long arg
)
833 struct cache_reader
*rp
= filp
->private_data
;
834 struct cache_queue
*cq
;
835 struct cache_detail
*cd
= PDE(ino
)->data
;
837 if (cmd
!= FIONREAD
|| !rp
)
840 spin_lock(&queue_lock
);
842 /* only find the length remaining in current request,
843 * or the length of the next request
845 for (cq
= &rp
->q
; &cq
->list
!= &cd
->queue
;
846 cq
= list_entry(cq
->list
.next
, struct cache_queue
, list
))
848 struct cache_request
*cr
=
849 container_of(cq
, struct cache_request
, q
);
850 len
= cr
->len
- rp
->offset
;
853 spin_unlock(&queue_lock
);
855 return put_user(len
, (int __user
*)arg
);
859 cache_open(struct inode
*inode
, struct file
*filp
)
861 struct cache_reader
*rp
= NULL
;
863 nonseekable_open(inode
, filp
);
864 if (filp
->f_mode
& FMODE_READ
) {
865 struct cache_detail
*cd
= PDE(inode
)->data
;
867 rp
= kmalloc(sizeof(*rp
), GFP_KERNEL
);
872 atomic_inc(&cd
->readers
);
873 spin_lock(&queue_lock
);
874 list_add(&rp
->q
.list
, &cd
->queue
);
875 spin_unlock(&queue_lock
);
877 filp
->private_data
= rp
;
882 cache_release(struct inode
*inode
, struct file
*filp
)
884 struct cache_reader
*rp
= filp
->private_data
;
885 struct cache_detail
*cd
= PDE(inode
)->data
;
888 spin_lock(&queue_lock
);
890 struct cache_queue
*cq
;
891 for (cq
= &rp
->q
; &cq
->list
!= &cd
->queue
;
892 cq
= list_entry(cq
->list
.next
, struct cache_queue
, list
))
894 container_of(cq
, struct cache_request
, q
)
900 list_del(&rp
->q
.list
);
901 spin_unlock(&queue_lock
);
903 filp
->private_data
= NULL
;
906 cd
->last_close
= get_seconds();
907 atomic_dec(&cd
->readers
);
914 static const struct file_operations cache_file_operations
= {
915 .owner
= THIS_MODULE
,
918 .write
= cache_write
,
920 .ioctl
= cache_ioctl
, /* for FIONREAD */
922 .release
= cache_release
,
926 static void cache_dequeue(struct cache_detail
*detail
, struct cache_head
*ch
)
928 struct cache_queue
*cq
;
929 spin_lock(&queue_lock
);
930 list_for_each_entry(cq
, &detail
->queue
, list
)
932 struct cache_request
*cr
= container_of(cq
, struct cache_request
, q
);
935 if (cr
->readers
!= 0)
937 list_del(&cr
->q
.list
);
938 spin_unlock(&queue_lock
);
939 cache_put(cr
->item
, detail
);
944 spin_unlock(&queue_lock
);
948 * Support routines for text-based upcalls.
949 * Fields are separated by spaces.
950 * Fields are either mangled to quote space tab newline slosh with slosh
951 * or a hexified with a leading \x
952 * Record is terminated with newline.
956 void qword_add(char **bpp
, int *lp
, char *str
)
964 while ((c
=*str
++) && len
)
972 *bp
++ = '0' + ((c
& 0300)>>6);
973 *bp
++ = '0' + ((c
& 0070)>>3);
974 *bp
++ = '0' + ((c
& 0007)>>0);
982 if (c
|| len
<1) len
= -1;
990 EXPORT_SYMBOL_GPL(qword_add
);
992 void qword_addhex(char **bpp
, int *lp
, char *buf
, int blen
)
1003 while (blen
&& len
>= 2) {
1004 unsigned char c
= *buf
++;
1005 *bp
++ = '0' + ((c
&0xf0)>>4) + (c
>=0xa0)*('a'-'9'-1);
1006 *bp
++ = '0' + (c
&0x0f) + ((c
&0x0f)>=0x0a)*('a'-'9'-1);
1011 if (blen
|| len
<1) len
= -1;
1019 EXPORT_SYMBOL_GPL(qword_addhex
);
1021 static void warn_no_listener(struct cache_detail
*detail
)
1023 if (detail
->last_warn
!= detail
->last_close
) {
1024 detail
->last_warn
= detail
->last_close
;
1025 if (detail
->warn_no_listener
)
1026 detail
->warn_no_listener(detail
);
1031 * register an upcall request to user-space.
1032 * Each request is at most one page long.
1034 static int cache_make_upcall(struct cache_detail
*detail
, struct cache_head
*h
)
1038 struct cache_request
*crq
;
1042 if (detail
->cache_request
== NULL
)
1045 if (atomic_read(&detail
->readers
) == 0 &&
1046 detail
->last_close
< get_seconds() - 30) {
1047 warn_no_listener(detail
);
1051 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
1055 crq
= kmalloc(sizeof (*crq
), GFP_KERNEL
);
1061 bp
= buf
; len
= PAGE_SIZE
;
1063 detail
->cache_request(detail
, h
, &bp
, &len
);
1071 crq
->item
= cache_get(h
);
1073 crq
->len
= PAGE_SIZE
- len
;
1075 spin_lock(&queue_lock
);
1076 list_add_tail(&crq
->q
.list
, &detail
->queue
);
1077 spin_unlock(&queue_lock
);
1078 wake_up(&queue_wait
);
1083 * parse a message from user-space and pass it
1084 * to an appropriate cache
1085 * Messages are, like requests, separated into fields by
1086 * spaces and dequotes as \xHEXSTRING or embedded \nnn octal
1089 * reply cachename expiry key ... content....
1091 * key and content are both parsed by cache
1094 #define isodigit(c) (isdigit(c) && c <= '7')
1095 int qword_get(char **bpp
, char *dest
, int bufsize
)
1097 /* return bytes copied, or -1 on error */
1101 while (*bp
== ' ') bp
++;
1103 if (bp
[0] == '\\' && bp
[1] == 'x') {
1106 while (isxdigit(bp
[0]) && isxdigit(bp
[1]) && len
< bufsize
) {
1107 int byte
= isdigit(*bp
) ? *bp
-'0' : toupper(*bp
)-'A'+10;
1110 byte
|= isdigit(*bp
) ? *bp
-'0' : toupper(*bp
)-'A'+10;
1116 /* text with \nnn octal quoting */
1117 while (*bp
!= ' ' && *bp
!= '\n' && *bp
&& len
< bufsize
-1) {
1119 isodigit(bp
[1]) && (bp
[1] <= '3') &&
1122 int byte
= (*++bp
-'0');
1124 byte
= (byte
<< 3) | (*bp
++ - '0');
1125 byte
= (byte
<< 3) | (*bp
++ - '0');
1135 if (*bp
!= ' ' && *bp
!= '\n' && *bp
!= '\0')
1137 while (*bp
== ' ') bp
++;
1142 EXPORT_SYMBOL_GPL(qword_get
);
1146 * support /proc/sunrpc/cache/$CACHENAME/content
1148 * We call ->cache_show passing NULL for the item to
1149 * get a header, then pass each real item in the cache
1153 struct cache_detail
*cd
;
1156 static void *c_start(struct seq_file
*m
, loff_t
*pos
)
1157 __acquires(cd
->hash_lock
)
1160 unsigned hash
, entry
;
1161 struct cache_head
*ch
;
1162 struct cache_detail
*cd
= ((struct handle
*)m
->private)->cd
;
1165 read_lock(&cd
->hash_lock
);
1167 return SEQ_START_TOKEN
;
1169 entry
= n
& ((1LL<<32) - 1);
1171 for (ch
=cd
->hash_table
[hash
]; ch
; ch
=ch
->next
)
1174 n
&= ~((1LL<<32) - 1);
1178 } while(hash
< cd
->hash_size
&&
1179 cd
->hash_table
[hash
]==NULL
);
1180 if (hash
>= cd
->hash_size
)
1183 return cd
->hash_table
[hash
];
1186 static void *c_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
1188 struct cache_head
*ch
= p
;
1189 int hash
= (*pos
>> 32);
1190 struct cache_detail
*cd
= ((struct handle
*)m
->private)->cd
;
1192 if (p
== SEQ_START_TOKEN
)
1194 else if (ch
->next
== NULL
) {
1201 *pos
&= ~((1LL<<32) - 1);
1202 while (hash
< cd
->hash_size
&&
1203 cd
->hash_table
[hash
] == NULL
) {
1207 if (hash
>= cd
->hash_size
)
1210 return cd
->hash_table
[hash
];
1213 static void c_stop(struct seq_file
*m
, void *p
)
1214 __releases(cd
->hash_lock
)
1216 struct cache_detail
*cd
= ((struct handle
*)m
->private)->cd
;
1217 read_unlock(&cd
->hash_lock
);
1220 static int c_show(struct seq_file
*m
, void *p
)
1222 struct cache_head
*cp
= p
;
1223 struct cache_detail
*cd
= ((struct handle
*)m
->private)->cd
;
1225 if (p
== SEQ_START_TOKEN
)
1226 return cd
->cache_show(m
, cd
, NULL
);
1229 seq_printf(m
, "# expiry=%ld refcnt=%d flags=%lx\n",
1230 cp
->expiry_time
, atomic_read(&cp
->ref
.refcount
), cp
->flags
);
1232 if (cache_check(cd
, cp
, NULL
))
1233 /* cache_check does a cache_put on failure */
1234 seq_printf(m
, "# ");
1238 return cd
->cache_show(m
, cd
, cp
);
1241 static const struct seq_operations cache_content_op
= {
1248 static int content_open(struct inode
*inode
, struct file
*file
)
1251 struct cache_detail
*cd
= PDE(inode
)->data
;
1253 han
= __seq_open_private(file
, &cache_content_op
, sizeof(*han
));
1261 static const struct file_operations content_file_operations
= {
1262 .open
= content_open
,
1264 .llseek
= seq_lseek
,
1265 .release
= seq_release_private
,
1268 static ssize_t
read_flush(struct file
*file
, char __user
*buf
,
1269 size_t count
, loff_t
*ppos
)
1271 struct cache_detail
*cd
= PDE(file
->f_path
.dentry
->d_inode
)->data
;
1273 unsigned long p
= *ppos
;
1276 sprintf(tbuf
, "%lu\n", cd
->flush_time
);
1283 if (copy_to_user(buf
, (void*)(tbuf
+p
), len
))
1289 static ssize_t
write_flush(struct file
* file
, const char __user
* buf
,
1290 size_t count
, loff_t
*ppos
)
1292 struct cache_detail
*cd
= PDE(file
->f_path
.dentry
->d_inode
)->data
;
1296 if (*ppos
|| count
> sizeof(tbuf
)-1)
1298 if (copy_from_user(tbuf
, buf
, count
))
1301 flushtime
= simple_strtoul(tbuf
, &ep
, 0);
1302 if (*ep
&& *ep
!= '\n')
1305 cd
->flush_time
= flushtime
;
1306 cd
->nextcheck
= get_seconds();
1313 static const struct file_operations cache_flush_operations
= {
1314 .open
= nonseekable_open
,
1316 .write
= write_flush
,