cache.c 43.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
 * net/sunrpc/cache.c
 *
 * Generic code for various authentication-related caches
 * used by sunrpc clients and servers.
 *
 * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
 *
 * Released under terms in GPL version 2.  See COPYING.
 *
 */

#include <linux/types.h>
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/slab.h>
#include <linux/signal.h>
#include <linux/sched.h>
#include <linux/kmod.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/ctype.h>
#include <asm/uaccess.h>
#include <linux/poll.h>
#include <linux/seq_file.h>
#include <linux/proc_fs.h>
#include <linux/net.h>
#include <linux/workqueue.h>
A
Arjan van de Ven 已提交
29
#include <linux/mutex.h>
30
#include <linux/pagemap.h>
L
Linus Torvalds 已提交
31 32 33 34
#include <asm/ioctls.h>
#include <linux/sunrpc/types.h>
#include <linux/sunrpc/cache.h>
#include <linux/sunrpc/stats.h>
35
#include <linux/sunrpc/rpc_pipe_fs.h>
36
#include "netns.h"
L
Linus Torvalds 已提交
37 38 39

#define	 RPCDBG_FACILITY RPCDBG_CACHE

40
static bool cache_defer_req(struct cache_req *req, struct cache_head *item);
L
Linus Torvalds 已提交
41 42
static void cache_revisit_request(struct cache_head *item);

43
static void cache_init(struct cache_head *h)
L
Linus Torvalds 已提交
44
{
45
	time_t now = seconds_since_boot();
L
Linus Torvalds 已提交
46 47
	h->next = NULL;
	h->flags = 0;
48
	kref_init(&h->ref);
L
Linus Torvalds 已提交
49 50 51 52
	h->expiry_time = now + CACHE_NEW_EXPIRY;
	h->last_refresh = now;
}

53 54
static inline int cache_is_expired(struct cache_detail *detail, struct cache_head *h)
{
55
	return  (h->expiry_time < seconds_since_boot()) ||
56 57 58
		(detail->flush_time > h->last_refresh);
}

59 60 61 62
struct cache_head *sunrpc_cache_lookup(struct cache_detail *detail,
				       struct cache_head *key, int hash)
{
	struct cache_head **head,  **hp;
63
	struct cache_head *new = NULL, *freeme = NULL;
64 65 66 67 68 69 70 71

	head = &detail->hash_table[hash];

	read_lock(&detail->hash_lock);

	for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
		struct cache_head *tmp = *hp;
		if (detail->match(tmp, key)) {
72 73 74
			if (cache_is_expired(detail, tmp))
				/* This entry is expired, we will discard it. */
				break;
75 76 77 78 79 80 81 82 83 84 85
			cache_get(tmp);
			read_unlock(&detail->hash_lock);
			return tmp;
		}
	}
	read_unlock(&detail->hash_lock);
	/* Didn't find anything, insert an empty entry */

	new = detail->alloc();
	if (!new)
		return NULL;
86 87 88 89
	/* must fully initialise 'new', else
	 * we might get lose if we need to
	 * cache_put it soon.
	 */
90
	cache_init(new);
91
	detail->init(new, key);
92 93 94 95 96 97 98

	write_lock(&detail->hash_lock);

	/* check if entry appeared while we slept */
	for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
		struct cache_head *tmp = *hp;
		if (detail->match(tmp, key)) {
99 100 101 102 103 104 105
			if (cache_is_expired(detail, tmp)) {
				*hp = tmp->next;
				tmp->next = NULL;
				detail->entries --;
				freeme = tmp;
				break;
			}
106 107
			cache_get(tmp);
			write_unlock(&detail->hash_lock);
108
			cache_put(new, detail);
109 110 111 112 113 114 115 116 117
			return tmp;
		}
	}
	new->next = *head;
	*head = new;
	detail->entries++;
	cache_get(new);
	write_unlock(&detail->hash_lock);

118 119
	if (freeme)
		cache_put(freeme, detail);
120 121
	return new;
}
122
EXPORT_SYMBOL_GPL(sunrpc_cache_lookup);
123

124

125
static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch);
126

127
static void cache_fresh_locked(struct cache_head *head, time_t expiry)
128 129
{
	head->expiry_time = expiry;
130
	head->last_refresh = seconds_since_boot();
131
	smp_wmb(); /* paired with smp_rmb() in cache_is_valid() */
132
	set_bit(CACHE_VALID, &head->flags);
133 134 135
}

static void cache_fresh_unlocked(struct cache_head *head,
136
				 struct cache_detail *detail)
137 138 139
{
	if (test_and_clear_bit(CACHE_PENDING, &head->flags)) {
		cache_revisit_request(head);
140
		cache_dequeue(detail, head);
141 142 143
	}
}

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
struct cache_head *sunrpc_cache_update(struct cache_detail *detail,
				       struct cache_head *new, struct cache_head *old, int hash)
{
	/* The 'old' entry is to be replaced by 'new'.
	 * If 'old' is not VALID, we update it directly,
	 * otherwise we need to replace it
	 */
	struct cache_head **head;
	struct cache_head *tmp;

	if (!test_bit(CACHE_VALID, &old->flags)) {
		write_lock(&detail->hash_lock);
		if (!test_bit(CACHE_VALID, &old->flags)) {
			if (test_bit(CACHE_NEGATIVE, &new->flags))
				set_bit(CACHE_NEGATIVE, &old->flags);
			else
				detail->update(old, new);
161
			cache_fresh_locked(old, new->expiry_time);
162
			write_unlock(&detail->hash_lock);
163
			cache_fresh_unlocked(old, detail);
164 165 166 167 168 169 170
			return old;
		}
		write_unlock(&detail->hash_lock);
	}
	/* We need to insert a new entry */
	tmp = detail->alloc();
	if (!tmp) {
171
		cache_put(old, detail);
172 173 174 175 176 177 178 179 180 181 182 183 184
		return NULL;
	}
	cache_init(tmp);
	detail->init(tmp, old);
	head = &detail->hash_table[hash];

	write_lock(&detail->hash_lock);
	if (test_bit(CACHE_NEGATIVE, &new->flags))
		set_bit(CACHE_NEGATIVE, &tmp->flags);
	else
		detail->update(tmp, new);
	tmp->next = *head;
	*head = tmp;
185
	detail->entries++;
186
	cache_get(tmp);
187
	cache_fresh_locked(tmp, new->expiry_time);
188
	cache_fresh_locked(old, 0);
189
	write_unlock(&detail->hash_lock);
190 191
	cache_fresh_unlocked(tmp, detail);
	cache_fresh_unlocked(old, detail);
192
	cache_put(old, detail);
193 194
	return tmp;
}
195
EXPORT_SYMBOL_GPL(sunrpc_cache_update);
L
Linus Torvalds 已提交
196

197 198 199 200 201 202
static int cache_make_upcall(struct cache_detail *cd, struct cache_head *h)
{
	if (!cd->cache_upcall)
		return -EINVAL;
	return cd->cache_upcall(cd, h);
}
203 204 205

static inline int cache_is_valid(struct cache_detail *detail, struct cache_head *h)
{
206
	if (!test_bit(CACHE_VALID, &h->flags))
207 208 209 210 211
		return -EAGAIN;
	else {
		/* entry is valid */
		if (test_bit(CACHE_NEGATIVE, &h->flags))
			return -ENOENT;
212 213 214 215 216 217 218 219
		else {
			/*
			 * In combination with write barrier in
			 * sunrpc_cache_update, ensures that anyone
			 * using the cache entry after this sees the
			 * updated contents:
			 */
			smp_rmb();
220
			return 0;
221
		}
222 223
	}
}
224

225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
static int try_to_negate_entry(struct cache_detail *detail, struct cache_head *h)
{
	int rv;

	write_lock(&detail->hash_lock);
	rv = cache_is_valid(detail, h);
	if (rv != -EAGAIN) {
		write_unlock(&detail->hash_lock);
		return rv;
	}
	set_bit(CACHE_NEGATIVE, &h->flags);
	cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY);
	write_unlock(&detail->hash_lock);
	cache_fresh_unlocked(h, detail);
	return -ENOENT;
}

L
Linus Torvalds 已提交
242 243 244 245 246 247 248 249
/*
 * This is the generic cache management routine for all
 * the authentication caches.
 * It checks the currency of a cache item and will (later)
 * initiate an upcall to fill it if needed.
 *
 *
 * Returns 0 if the cache_head can be used, or cache_puts it and returns
250 251 252 253
 * -EAGAIN if upcall is pending and request has been queued
 * -ETIMEDOUT if upcall failed or request could not be queue or
 *           upcall completed but item is still invalid (implying that
 *           the cache item has been replaced with a newer one).
L
Linus Torvalds 已提交
254 255 256 257 258 259 260 261 262
 * -ENOENT if cache entry was negative
 */
int cache_check(struct cache_detail *detail,
		    struct cache_head *h, struct cache_req *rqstp)
{
	int rv;
	long refresh_age, age;

	/* First decide return status as best we can */
263
	rv = cache_is_valid(detail, h);
L
Linus Torvalds 已提交
264 265 266

	/* now see if we want to start an upcall */
	refresh_age = (h->expiry_time - h->last_refresh);
267
	age = seconds_since_boot() - h->last_refresh;
L
Linus Torvalds 已提交
268 269 270 271 272

	if (rqstp == NULL) {
		if (rv == -EAGAIN)
			rv = -ENOENT;
	} else if (rv == -EAGAIN || age > refresh_age/2) {
273 274
		dprintk("RPC:       Want update, refage=%ld, age=%ld\n",
				refresh_age, age);
L
Linus Torvalds 已提交
275 276 277 278
		if (!test_and_set_bit(CACHE_PENDING, &h->flags)) {
			switch (cache_make_upcall(detail, h)) {
			case -EINVAL:
				clear_bit(CACHE_PENDING, &h->flags);
279
				cache_revisit_request(h);
280
				rv = try_to_negate_entry(detail, h);
L
Linus Torvalds 已提交
281 282 283 284 285 286 287 288 289
				break;
			case -EAGAIN:
				clear_bit(CACHE_PENDING, &h->flags);
				cache_revisit_request(h);
				break;
			}
		}
	}

290
	if (rv == -EAGAIN) {
291 292 293 294 295
		if (!cache_defer_req(rqstp, h)) {
			/*
			 * Request was not deferred; handle it as best
			 * we can ourselves:
			 */
296 297 298 299 300
			rv = cache_is_valid(detail, h);
			if (rv == -EAGAIN)
				rv = -ETIMEDOUT;
		}
	}
301
	if (rv)
302
		cache_put(h, detail);
L
Linus Torvalds 已提交
303 304
	return rv;
}
305
EXPORT_SYMBOL_GPL(cache_check);
L
Linus Torvalds 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335

/*
 * caches need to be periodically cleaned.
 * For this we maintain a list of cache_detail and
 * a current pointer into that list and into the table
 * for that entry.
 *
 * Each time clean_cache is called it finds the next non-empty entry
 * in the current table and walks the list in that entry
 * looking for entries that can be removed.
 *
 * An entry gets removed if:
 * - The expiry is before current time
 * - The last_refresh time is before the flush_time for that cache
 *
 * later we might drop old entries with non-NEVER expiry if that table
 * is getting 'full' for some definition of 'full'
 *
 * The question of "how often to scan a table" is an interesting one
 * and is answered in part by the use of the "nextcheck" field in the
 * cache_detail.
 * When a scan of a table begins, the nextcheck field is set to a time
 * that is well into the future.
 * While scanning, if an expiry time is found that is earlier than the
 * current nextcheck time, nextcheck is set to that expiry time.
 * If the flush_time is ever set to a time earlier than the nextcheck
 * time, the nextcheck time is then set to that flush_time.
 *
 * A table is then only scanned if the current time is at least
 * the nextcheck time.
336
 *
L
Linus Torvalds 已提交
337 338 339 340 341 342 343
 */

static LIST_HEAD(cache_list);
static DEFINE_SPINLOCK(cache_list_lock);
static struct cache_detail *current_detail;
static int current_index;

344
static void do_cache_clean(struct work_struct *work);
345
static struct delayed_work cache_cleaner;
L
Linus Torvalds 已提交
346

347
static void sunrpc_init_cache_detail(struct cache_detail *cd)
348
{
L
Linus Torvalds 已提交
349 350 351 352 353 354 355 356 357 358 359 360
	rwlock_init(&cd->hash_lock);
	INIT_LIST_HEAD(&cd->queue);
	spin_lock(&cache_list_lock);
	cd->nextcheck = 0;
	cd->entries = 0;
	atomic_set(&cd->readers, 0);
	cd->last_close = 0;
	cd->last_warn = -1;
	list_add(&cd->others, &cache_list);
	spin_unlock(&cache_list_lock);

	/* start the cleaning process */
361
	schedule_delayed_work(&cache_cleaner, 0);
L
Linus Torvalds 已提交
362 363
}

364
static void sunrpc_destroy_cache_detail(struct cache_detail *cd)
L
Linus Torvalds 已提交
365 366 367 368 369 370 371
{
	cache_purge(cd);
	spin_lock(&cache_list_lock);
	write_lock(&cd->hash_lock);
	if (cd->entries || atomic_read(&cd->inuse)) {
		write_unlock(&cd->hash_lock);
		spin_unlock(&cache_list_lock);
372
		goto out;
L
Linus Torvalds 已提交
373 374 375 376 377 378 379 380
	}
	if (current_detail == cd)
		current_detail = NULL;
	list_del_init(&cd->others);
	write_unlock(&cd->hash_lock);
	spin_unlock(&cache_list_lock);
	if (list_empty(&cache_list)) {
		/* module must be being unloaded so its safe to kill the worker */
381
		cancel_delayed_work_sync(&cache_cleaner);
L
Linus Torvalds 已提交
382
	}
383 384 385
	return;
out:
	printk(KERN_ERR "nfsd: failed to unregister %s cache\n", cd->name);
L
Linus Torvalds 已提交
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
}

/* clean cache tries to find something to clean
 * and cleans it.
 * It returns 1 if it cleaned something,
 *            0 if it didn't find anything this time
 *           -1 if it fell off the end of the list.
 */
static int cache_clean(void)
{
	int rv = 0;
	struct list_head *next;

	spin_lock(&cache_list_lock);

	/* find a suitable table if we don't already have one */
	while (current_detail == NULL ||
	    current_index >= current_detail->hash_size) {
		if (current_detail)
			next = current_detail->others.next;
		else
			next = cache_list.next;
		if (next == &cache_list) {
			current_detail = NULL;
			spin_unlock(&cache_list_lock);
			return -1;
		}
		current_detail = list_entry(next, struct cache_detail, others);
414
		if (current_detail->nextcheck > seconds_since_boot())
L
Linus Torvalds 已提交
415 416 417
			current_index = current_detail->hash_size;
		else {
			current_index = 0;
418
			current_detail->nextcheck = seconds_since_boot()+30*60;
L
Linus Torvalds 已提交
419 420 421 422 423 424 425 426 427 428
		}
	}

	/* find a non-empty bucket in the table */
	while (current_detail &&
	       current_index < current_detail->hash_size &&
	       current_detail->hash_table[current_index] == NULL)
		current_index++;

	/* find a cleanable entry in the bucket and clean it, or set to next bucket */
429

L
Linus Torvalds 已提交
430 431 432
	if (current_detail && current_index < current_detail->hash_size) {
		struct cache_head *ch, **cp;
		struct cache_detail *d;
433

L
Linus Torvalds 已提交
434 435 436
		write_lock(&current_detail->hash_lock);

		/* Ok, now to clean this strand */
437

L
Linus Torvalds 已提交
438
		cp = & current_detail->hash_table[current_index];
439
		for (ch = *cp ; ch ; cp = & ch->next, ch = *cp) {
L
Linus Torvalds 已提交
440 441
			if (current_detail->nextcheck > ch->expiry_time)
				current_detail->nextcheck = ch->expiry_time+1;
442
			if (!cache_is_expired(current_detail, ch))
L
Linus Torvalds 已提交
443 444 445 446 447 448
				continue;

			*cp = ch->next;
			ch->next = NULL;
			current_detail->entries--;
			rv = 1;
449
			break;
L
Linus Torvalds 已提交
450
		}
451

L
Linus Torvalds 已提交
452 453 454 455 456
		write_unlock(&current_detail->hash_lock);
		d = current_detail;
		if (!ch)
			current_index ++;
		spin_unlock(&cache_list_lock);
457
		if (ch) {
458 459
			if (test_and_clear_bit(CACHE_PENDING, &ch->flags))
				cache_dequeue(current_detail, ch);
460
			cache_revisit_request(ch);
461
			cache_put(ch, d);
462
		}
L
Linus Torvalds 已提交
463 464 465 466 467 468 469 470 471
	} else
		spin_unlock(&cache_list_lock);

	return rv;
}

/*
 * We want to regularly clean the cache, so we need to schedule some work ...
 */
472
static void do_cache_clean(struct work_struct *work)
L
Linus Torvalds 已提交
473 474 475
{
	int delay = 5;
	if (cache_clean() == -1)
476
		delay = round_jiffies_relative(30*HZ);
L
Linus Torvalds 已提交
477 478 479 480 481 482 483 484 485

	if (list_empty(&cache_list))
		delay = 0;

	if (delay)
		schedule_delayed_work(&cache_cleaner, delay);
}


486
/*
L
Linus Torvalds 已提交
487
 * Clean all caches promptly.  This just calls cache_clean
488
 * repeatedly until we are sure that every cache has had a chance to
L
Linus Torvalds 已提交
489 490 491 492 493 494 495 496 497
 * be fully cleaned
 */
void cache_flush(void)
{
	while (cache_clean() != -1)
		cond_resched();
	while (cache_clean() != -1)
		cond_resched();
}
498
EXPORT_SYMBOL_GPL(cache_flush);
L
Linus Torvalds 已提交
499 500 501 502

void cache_purge(struct cache_detail *detail)
{
	detail->flush_time = LONG_MAX;
503
	detail->nextcheck = seconds_since_boot();
L
Linus Torvalds 已提交
504 505 506
	cache_flush();
	detail->flush_time = 1;
}
507
EXPORT_SYMBOL_GPL(cache_purge);
L
Linus Torvalds 已提交
508 509 510 511 512 513 514 515 516 517


/*
 * Deferral and Revisiting of Requests.
 *
 * If a cache lookup finds a pending entry, we
 * need to defer the request and revisit it later.
 * All deferred requests are stored in a hash table,
 * indexed by "struct cache_head *".
 * As it may be wasteful to store a whole request
518
 * structure, we allow the request to provide a
L
Linus Torvalds 已提交
519 520 521 522 523 524 525 526 527 528 529 530 531
 * deferred form, which must contain a
 * 'struct cache_deferred_req'
 * This cache_deferred_req contains a method to allow
 * it to be revisited when cache info is available
 */

#define	DFR_HASHSIZE	(PAGE_SIZE/sizeof(struct list_head))
#define	DFR_HASH(item)	((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE)

#define	DFR_MAX	300	/* ??? */

static DEFINE_SPINLOCK(cache_defer_lock);
static LIST_HEAD(cache_defer_list);
532
static struct hlist_head cache_defer_hash[DFR_HASHSIZE];
L
Linus Torvalds 已提交
533 534
static int cache_defer_cnt;

J
J. Bruce Fields 已提交
535 536
static void __unhash_deferred_req(struct cache_deferred_req *dreq)
{
537
	hlist_del_init(&dreq->hash);
538 539 540 541
	if (!list_empty(&dreq->recent)) {
		list_del_init(&dreq->recent);
		cache_defer_cnt--;
	}
J
J. Bruce Fields 已提交
542 543 544
}

static void __hash_deferred_req(struct cache_deferred_req *dreq, struct cache_head *item)
L
Linus Torvalds 已提交
545 546 547
{
	int hash = DFR_HASH(item);

548
	INIT_LIST_HEAD(&dreq->recent);
549
	hlist_add_head(&dreq->hash, &cache_defer_hash[hash]);
J
J. Bruce Fields 已提交
550 551
}

552 553 554
static void setup_deferral(struct cache_deferred_req *dreq,
			   struct cache_head *item,
			   int count_me)
L
Linus Torvalds 已提交
555 556 557 558 559 560
{

	dreq->item = item;

	spin_lock(&cache_defer_lock);

J
J. Bruce Fields 已提交
561
	__hash_deferred_req(dreq, item);
L
Linus Torvalds 已提交
562

563 564 565
	if (count_me) {
		cache_defer_cnt++;
		list_add(&dreq->recent, &cache_defer_list);
L
Linus Torvalds 已提交
566
	}
567

L
Linus Torvalds 已提交
568 569
	spin_unlock(&cache_defer_lock);

J
J. Bruce Fields 已提交
570
}
571

J
J. Bruce Fields 已提交
572 573 574 575 576 577 578 579 580 581 582 583
struct thread_deferred_req {
	struct cache_deferred_req handle;
	struct completion completion;
};

static void cache_restart_thread(struct cache_deferred_req *dreq, int too_many)
{
	struct thread_deferred_req *dr =
		container_of(dreq, struct thread_deferred_req, handle);
	complete(&dr->completion);
}

584
static void cache_wait_req(struct cache_req *req, struct cache_head *item)
J
J. Bruce Fields 已提交
585 586 587 588 589 590 591
{
	struct thread_deferred_req sleeper;
	struct cache_deferred_req *dreq = &sleeper.handle;

	sleeper.completion = COMPLETION_INITIALIZER_ONSTACK(sleeper.completion);
	dreq->revisit = cache_restart_thread;

592
	setup_deferral(dreq, item, 0);
J
J. Bruce Fields 已提交
593

594
	if (!test_bit(CACHE_PENDING, &item->flags) ||
595
	    wait_for_completion_interruptible_timeout(
J
J. Bruce Fields 已提交
596 597 598 599 600
		    &sleeper.completion, req->thread_wait) <= 0) {
		/* The completion wasn't completed, so we need
		 * to clean up
		 */
		spin_lock(&cache_defer_lock);
601
		if (!hlist_unhashed(&sleeper.handle.hash)) {
J
J. Bruce Fields 已提交
602 603 604 605 606 607 608
			__unhash_deferred_req(&sleeper.handle);
			spin_unlock(&cache_defer_lock);
		} else {
			/* cache_revisit_request already removed
			 * this from the hash table, but hasn't
			 * called ->revisit yet.  It will very soon
			 * and we need to wait for it.
609
			 */
J
J. Bruce Fields 已提交
610 611
			spin_unlock(&cache_defer_lock);
			wait_for_completion(&sleeper.completion);
612
		}
J
J. Bruce Fields 已提交
613 614 615
	}
}

616
static void cache_limit_defers(void)
J
J. Bruce Fields 已提交
617
{
618 619 620 621
	/* Make sure we haven't exceed the limit of allowed deferred
	 * requests.
	 */
	struct cache_deferred_req *discard = NULL;
J
J. Bruce Fields 已提交
622

623 624
	if (cache_defer_cnt <= DFR_MAX)
		return;
625

626 627 628 629 630 631 632 633 634 635 636 637 638
	spin_lock(&cache_defer_lock);

	/* Consider removing either the first or the last */
	if (cache_defer_cnt > DFR_MAX) {
		if (net_random() & 1)
			discard = list_entry(cache_defer_list.next,
					     struct cache_deferred_req, recent);
		else
			discard = list_entry(cache_defer_list.prev,
					     struct cache_deferred_req, recent);
		__unhash_deferred_req(discard);
	}
	spin_unlock(&cache_defer_lock);
639 640
	if (discard)
		discard->revisit(discard, 1);
641
}
642

643 644
/* Return true if and only if a deferred request is queued. */
static bool cache_defer_req(struct cache_req *req, struct cache_head *item)
645 646
{
	struct cache_deferred_req *dreq;
647

J
J. Bruce Fields 已提交
648
	if (req->thread_wait) {
649 650
		cache_wait_req(req, item);
		if (!test_bit(CACHE_PENDING, &item->flags))
651
			return false;
L
Linus Torvalds 已提交
652
	}
J
J. Bruce Fields 已提交
653 654
	dreq = req->defer(req);
	if (dreq == NULL)
655
		return false;
656
	setup_deferral(dreq, item, 1);
657 658 659 660 661
	if (!test_bit(CACHE_PENDING, &item->flags))
		/* Bit could have been cleared before we managed to
		 * set up the deferral, so need to revisit just in case
		 */
		cache_revisit_request(item);
662 663

	cache_limit_defers();
664
	return true;
L
Linus Torvalds 已提交
665 666 667 668 669 670
}

static void cache_revisit_request(struct cache_head *item)
{
	struct cache_deferred_req *dreq;
	struct list_head pending;
671
	struct hlist_node *lp, *tmp;
L
Linus Torvalds 已提交
672 673 674 675
	int hash = DFR_HASH(item);

	INIT_LIST_HEAD(&pending);
	spin_lock(&cache_defer_lock);
676

677 678 679 680
	hlist_for_each_entry_safe(dreq, lp, tmp, &cache_defer_hash[hash], hash)
		if (dreq->item == item) {
			__unhash_deferred_req(dreq);
			list_add(&dreq->recent, &pending);
L
Linus Torvalds 已提交
681
		}
682

L
Linus Torvalds 已提交
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
	spin_unlock(&cache_defer_lock);

	while (!list_empty(&pending)) {
		dreq = list_entry(pending.next, struct cache_deferred_req, recent);
		list_del_init(&dreq->recent);
		dreq->revisit(dreq, 0);
	}
}

void cache_clean_deferred(void *owner)
{
	struct cache_deferred_req *dreq, *tmp;
	struct list_head pending;


	INIT_LIST_HEAD(&pending);
	spin_lock(&cache_defer_lock);
700

L
Linus Torvalds 已提交
701 702
	list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) {
		if (dreq->owner == owner) {
J
J. Bruce Fields 已提交
703
			__unhash_deferred_req(dreq);
704
			list_add(&dreq->recent, &pending);
L
Linus Torvalds 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718
		}
	}
	spin_unlock(&cache_defer_lock);

	while (!list_empty(&pending)) {
		dreq = list_entry(pending.next, struct cache_deferred_req, recent);
		list_del_init(&dreq->recent);
		dreq->revisit(dreq, 1);
	}
}

/*
 * communicate with user-space
 *
J
J. Bruce Fields 已提交
719 720 721 722
 * We have a magic /proc file - /proc/sunrpc/<cachename>/channel.
 * On read, you get a full request, or block.
 * On write, an update request is processed.
 * Poll works if anything to read, and always allows write.
L
Linus Torvalds 已提交
723
 *
724
 * Implemented by linked list of requests.  Each open file has
J
J. Bruce Fields 已提交
725
 * a ->private that also exists in this list.  New requests are added
L
Linus Torvalds 已提交
726 727 728 729 730 731 732
 * to the end and may wakeup and preceding readers.
 * New readers are added to the head.  If, on read, an item is found with
 * CACHE_UPCALLING clear, we free it from the list.
 *
 */

static DEFINE_SPINLOCK(queue_lock);
A
Arjan van de Ven 已提交
733
static DEFINE_MUTEX(queue_io_mutex);
L
Linus Torvalds 已提交
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750

struct cache_queue {
	struct list_head	list;
	int			reader;	/* if 0, then request */
};
struct cache_request {
	struct cache_queue	q;
	struct cache_head	*item;
	char			* buf;
	int			len;
	int			readers;
};
struct cache_reader {
	struct cache_queue	q;
	int			offset;	/* if non-0, we have a refcnt on next request */
};

751 752
static ssize_t cache_read(struct file *filp, char __user *buf, size_t count,
			  loff_t *ppos, struct cache_detail *cd)
L
Linus Torvalds 已提交
753 754 755
{
	struct cache_reader *rp = filp->private_data;
	struct cache_request *rq;
756
	struct inode *inode = filp->f_path.dentry->d_inode;
L
Linus Torvalds 已提交
757 758 759 760 761
	int err;

	if (count == 0)
		return 0;

762
	mutex_lock(&inode->i_mutex); /* protect against multiple concurrent
L
Linus Torvalds 已提交
763 764 765 766 767 768 769 770 771 772 773 774
			      * readers on this file */
 again:
	spin_lock(&queue_lock);
	/* need to find next request */
	while (rp->q.list.next != &cd->queue &&
	       list_entry(rp->q.list.next, struct cache_queue, list)
	       ->reader) {
		struct list_head *next = rp->q.list.next;
		list_move(&rp->q.list, next);
	}
	if (rp->q.list.next == &cd->queue) {
		spin_unlock(&queue_lock);
775
		mutex_unlock(&inode->i_mutex);
776
		BUG_ON(rp->offset);
L
Linus Torvalds 已提交
777 778 779
		return 0;
	}
	rq = container_of(rp->q.list.next, struct cache_request, q.list);
780
	BUG_ON(rq->q.reader);
L
Linus Torvalds 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
	if (rp->offset == 0)
		rq->readers++;
	spin_unlock(&queue_lock);

	if (rp->offset == 0 && !test_bit(CACHE_PENDING, &rq->item->flags)) {
		err = -EAGAIN;
		spin_lock(&queue_lock);
		list_move(&rp->q.list, &rq->q.list);
		spin_unlock(&queue_lock);
	} else {
		if (rp->offset + count > rq->len)
			count = rq->len - rp->offset;
		err = -EFAULT;
		if (copy_to_user(buf, rq->buf + rp->offset, count))
			goto out;
		rp->offset += count;
		if (rp->offset >= rq->len) {
			rp->offset = 0;
			spin_lock(&queue_lock);
			list_move(&rp->q.list, &rq->q.list);
			spin_unlock(&queue_lock);
		}
		err = 0;
	}
 out:
	if (rp->offset == 0) {
		/* need to release rq */
		spin_lock(&queue_lock);
		rq->readers--;
		if (rq->readers == 0 &&
		    !test_bit(CACHE_PENDING, &rq->item->flags)) {
			list_del(&rq->q.list);
			spin_unlock(&queue_lock);
814
			cache_put(rq->item, cd);
L
Linus Torvalds 已提交
815 816 817 818 819 820 821
			kfree(rq->buf);
			kfree(rq);
		} else
			spin_unlock(&queue_lock);
	}
	if (err == -EAGAIN)
		goto again;
822
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
823 824 825
	return err ? err :  count;
}

826 827 828 829
static ssize_t cache_do_downcall(char *kaddr, const char __user *buf,
				 size_t count, struct cache_detail *cd)
{
	ssize_t ret;
L
Linus Torvalds 已提交
830

831 832 833 834 835 836 837 838 839 840 841
	if (copy_from_user(kaddr, buf, count))
		return -EFAULT;
	kaddr[count] = '\0';
	ret = cd->cache_parse(cd, kaddr, count);
	if (!ret)
		ret = count;
	return ret;
}

static ssize_t cache_slow_downcall(const char __user *buf,
				   size_t count, struct cache_detail *cd)
L
Linus Torvalds 已提交
842
{
843 844
	static char write_buf[8192]; /* protected by queue_io_mutex */
	ssize_t ret = -EINVAL;
L
Linus Torvalds 已提交
845 846

	if (count >= sizeof(write_buf))
847
		goto out;
A
Arjan van de Ven 已提交
848
	mutex_lock(&queue_io_mutex);
849 850 851 852 853
	ret = cache_do_downcall(write_buf, buf, count, cd);
	mutex_unlock(&queue_io_mutex);
out:
	return ret;
}
L
Linus Torvalds 已提交
854

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
static ssize_t cache_downcall(struct address_space *mapping,
			      const char __user *buf,
			      size_t count, struct cache_detail *cd)
{
	struct page *page;
	char *kaddr;
	ssize_t ret = -ENOMEM;

	if (count >= PAGE_CACHE_SIZE)
		goto out_slow;

	page = find_or_create_page(mapping, 0, GFP_KERNEL);
	if (!page)
		goto out_slow;

	kaddr = kmap(page);
	ret = cache_do_downcall(kaddr, buf, count, cd);
	kunmap(page);
	unlock_page(page);
	page_cache_release(page);
	return ret;
out_slow:
	return cache_slow_downcall(buf, count, cd);
}
L
Linus Torvalds 已提交
879

880 881 882
static ssize_t cache_write(struct file *filp, const char __user *buf,
			   size_t count, loff_t *ppos,
			   struct cache_detail *cd)
883 884 885 886 887 888 889 890 891 892 893 894 895
{
	struct address_space *mapping = filp->f_mapping;
	struct inode *inode = filp->f_path.dentry->d_inode;
	ssize_t ret = -EINVAL;

	if (!cd->cache_parse)
		goto out;

	mutex_lock(&inode->i_mutex);
	ret = cache_downcall(mapping, buf, count, cd);
	mutex_unlock(&inode->i_mutex);
out:
	return ret;
L
Linus Torvalds 已提交
896 897 898 899
}

static DECLARE_WAIT_QUEUE_HEAD(queue_wait);

900 901
static unsigned int cache_poll(struct file *filp, poll_table *wait,
			       struct cache_detail *cd)
L
Linus Torvalds 已提交
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
{
	unsigned int mask;
	struct cache_reader *rp = filp->private_data;
	struct cache_queue *cq;

	poll_wait(filp, &queue_wait, wait);

	/* alway allow write */
	mask = POLL_OUT | POLLWRNORM;

	if (!rp)
		return mask;

	spin_lock(&queue_lock);

	for (cq= &rp->q; &cq->list != &cd->queue;
	     cq = list_entry(cq->list.next, struct cache_queue, list))
		if (!cq->reader) {
			mask |= POLLIN | POLLRDNORM;
			break;
		}
	spin_unlock(&queue_lock);
	return mask;
}

927 928 929
static int cache_ioctl(struct inode *ino, struct file *filp,
		       unsigned int cmd, unsigned long arg,
		       struct cache_detail *cd)
L
Linus Torvalds 已提交
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
{
	int len = 0;
	struct cache_reader *rp = filp->private_data;
	struct cache_queue *cq;

	if (cmd != FIONREAD || !rp)
		return -EINVAL;

	spin_lock(&queue_lock);

	/* only find the length remaining in current request,
	 * or the length of the next request
	 */
	for (cq= &rp->q; &cq->list != &cd->queue;
	     cq = list_entry(cq->list.next, struct cache_queue, list))
		if (!cq->reader) {
			struct cache_request *cr =
				container_of(cq, struct cache_request, q);
			len = cr->len - rp->offset;
			break;
		}
	spin_unlock(&queue_lock);

	return put_user(len, (int __user *)arg);
}

956 957
static int cache_open(struct inode *inode, struct file *filp,
		      struct cache_detail *cd)
L
Linus Torvalds 已提交
958 959 960
{
	struct cache_reader *rp = NULL;

961 962
	if (!cd || !try_module_get(cd->owner))
		return -EACCES;
L
Linus Torvalds 已提交
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
	nonseekable_open(inode, filp);
	if (filp->f_mode & FMODE_READ) {
		rp = kmalloc(sizeof(*rp), GFP_KERNEL);
		if (!rp)
			return -ENOMEM;
		rp->offset = 0;
		rp->q.reader = 1;
		atomic_inc(&cd->readers);
		spin_lock(&queue_lock);
		list_add(&rp->q.list, &cd->queue);
		spin_unlock(&queue_lock);
	}
	filp->private_data = rp;
	return 0;
}

979 980
static int cache_release(struct inode *inode, struct file *filp,
			 struct cache_detail *cd)
L
Linus Torvalds 已提交
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
{
	struct cache_reader *rp = filp->private_data;

	if (rp) {
		spin_lock(&queue_lock);
		if (rp->offset) {
			struct cache_queue *cq;
			for (cq= &rp->q; &cq->list != &cd->queue;
			     cq = list_entry(cq->list.next, struct cache_queue, list))
				if (!cq->reader) {
					container_of(cq, struct cache_request, q)
						->readers--;
					break;
				}
			rp->offset = 0;
		}
		list_del(&rp->q.list);
		spin_unlock(&queue_lock);

		filp->private_data = NULL;
		kfree(rp);

1003
		cd->last_close = seconds_since_boot();
L
Linus Torvalds 已提交
1004 1005
		atomic_dec(&cd->readers);
	}
1006
	module_put(cd->owner);
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011
	return 0;
}



1012
static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch)
L
Linus Torvalds 已提交
1013 1014 1015 1016 1017 1018 1019 1020 1021
{
	struct cache_queue *cq;
	spin_lock(&queue_lock);
	list_for_each_entry(cq, &detail->queue, list)
		if (!cq->reader) {
			struct cache_request *cr = container_of(cq, struct cache_request, q);
			if (cr->item != ch)
				continue;
			if (cr->readers != 0)
1022
				continue;
L
Linus Torvalds 已提交
1023 1024
			list_del(&cr->q.list);
			spin_unlock(&queue_lock);
1025
			cache_put(cr->item, detail);
L
Linus Torvalds 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
			kfree(cr->buf);
			kfree(cr);
			return;
		}
	spin_unlock(&queue_lock);
}

/*
 * Support routines for text-based upcalls.
 * Fields are separated by spaces.
 * Fields are either mangled to quote space tab newline slosh with slosh
 * or a hexified with a leading \x
 * Record is terminated with newline.
 *
 */

void qword_add(char **bpp, int *lp, char *str)
{
	char *bp = *bpp;
	int len = *lp;
	char c;

	if (len < 0) return;

	while ((c=*str++) && len)
		switch(c) {
		case ' ':
		case '\t':
		case '\n':
		case '\\':
			if (len >= 4) {
				*bp++ = '\\';
				*bp++ = '0' + ((c & 0300)>>6);
				*bp++ = '0' + ((c & 0070)>>3);
				*bp++ = '0' + ((c & 0007)>>0);
			}
			len -= 4;
			break;
		default:
			*bp++ = c;
			len--;
		}
	if (c || len <1) len = -1;
	else {
		*bp++ = ' ';
		len--;
	}
	*bpp = bp;
	*lp = len;
}
1076
EXPORT_SYMBOL_GPL(qword_add);
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104

void qword_addhex(char **bpp, int *lp, char *buf, int blen)
{
	char *bp = *bpp;
	int len = *lp;

	if (len < 0) return;

	if (len > 2) {
		*bp++ = '\\';
		*bp++ = 'x';
		len -= 2;
		while (blen && len >= 2) {
			unsigned char c = *buf++;
			*bp++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
			*bp++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
			len -= 2;
			blen--;
		}
	}
	if (blen || len<1) len = -1;
	else {
		*bp++ = ' ';
		len--;
	}
	*bpp = bp;
	*lp = len;
}
1105
EXPORT_SYMBOL_GPL(qword_addhex);
L
Linus Torvalds 已提交
1106 1107 1108 1109 1110 1111

static void warn_no_listener(struct cache_detail *detail)
{
	if (detail->last_warn != detail->last_close) {
		detail->last_warn = detail->last_close;
		if (detail->warn_no_listener)
1112
			detail->warn_no_listener(detail, detail->last_close != 0);
L
Linus Torvalds 已提交
1113 1114 1115
	}
}

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
static bool cache_listeners_exist(struct cache_detail *detail)
{
	if (atomic_read(&detail->readers))
		return true;
	if (detail->last_close == 0)
		/* This cache was never opened */
		return false;
	if (detail->last_close < seconds_since_boot() - 30)
		/*
		 * We allow for the possibility that someone might
		 * restart a userspace daemon without restarting the
		 * server; but after 30 seconds, we give up.
		 */
		 return false;
	return true;
}

L
Linus Torvalds 已提交
1133
/*
1134 1135 1136
 * register an upcall request to user-space and queue it up for read() by the
 * upcall daemon.
 *
L
Linus Torvalds 已提交
1137 1138
 * Each request is at most one page long.
 */
1139 1140 1141 1142 1143
int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h,
		void (*cache_request)(struct cache_detail *,
				      struct cache_head *,
				      char **,
				      int *))
L
Linus Torvalds 已提交
1144 1145 1146 1147 1148 1149 1150
{

	char *buf;
	struct cache_request *crq;
	char *bp;
	int len;

1151 1152 1153
	if (!cache_listeners_exist(detail)) {
		warn_no_listener(detail);
		return -EINVAL;
L
Linus Torvalds 已提交
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
	}

	buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
	if (!buf)
		return -EAGAIN;

	crq = kmalloc(sizeof (*crq), GFP_KERNEL);
	if (!crq) {
		kfree(buf);
		return -EAGAIN;
	}

	bp = buf; len = PAGE_SIZE;

1168
	cache_request(detail, h, &bp, &len);
L
Linus Torvalds 已提交
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185

	if (len < 0) {
		kfree(buf);
		kfree(crq);
		return -EAGAIN;
	}
	crq->q.reader = 0;
	crq->item = cache_get(h);
	crq->buf = buf;
	crq->len = PAGE_SIZE - len;
	crq->readers = 0;
	spin_lock(&queue_lock);
	list_add_tail(&crq->q.list, &detail->queue);
	spin_unlock(&queue_lock);
	wake_up(&queue_wait);
	return 0;
}
1186
EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall);
L
Linus Torvalds 已提交
1187 1188 1189 1190 1191 1192 1193

/*
 * parse a message from user-space and pass it
 * to an appropriate cache
 * Messages are, like requests, separated into fields by
 * spaces and dequotes as \xHEXSTRING or embedded \nnn octal
 *
1194
 * Message is
L
Linus Torvalds 已提交
1195 1196
 *   reply cachename expiry key ... content....
 *
1197
 * key and content are both parsed by cache
L
Linus Torvalds 已提交
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
 */

#define isodigit(c) (isdigit(c) && c <= '7')
int qword_get(char **bpp, char *dest, int bufsize)
{
	/* return bytes copied, or -1 on error */
	char *bp = *bpp;
	int len = 0;

	while (*bp == ' ') bp++;

	if (bp[0] == '\\' && bp[1] == 'x') {
		/* HEX STRING */
		bp += 2;
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
		while (len < bufsize) {
			int h, l;

			h = hex_to_bin(bp[0]);
			if (h < 0)
				break;

			l = hex_to_bin(bp[1]);
			if (l < 0)
				break;

			*dest++ = (h << 4) | l;
			bp += 2;
L
Linus Torvalds 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
			len++;
		}
	} else {
		/* text with \nnn octal quoting */
		while (*bp != ' ' && *bp != '\n' && *bp && len < bufsize-1) {
			if (*bp == '\\' &&
			    isodigit(bp[1]) && (bp[1] <= '3') &&
			    isodigit(bp[2]) &&
			    isodigit(bp[3])) {
				int byte = (*++bp -'0');
				bp++;
				byte = (byte << 3) | (*bp++ - '0');
				byte = (byte << 3) | (*bp++ - '0');
				*dest++ = byte;
				len++;
			} else {
				*dest++ = *bp++;
				len++;
			}
		}
	}

	if (*bp != ' ' && *bp != '\n' && *bp != '\0')
		return -1;
	while (*bp == ' ') bp++;
	*bpp = bp;
	*dest = '\0';
	return len;
}
1254
EXPORT_SYMBOL_GPL(qword_get);
L
Linus Torvalds 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268


/*
 * support /proc/sunrpc/cache/$CACHENAME/content
 * as a seqfile.
 * We call ->cache_show passing NULL for the item to
 * get a header, then pass each real item in the cache
 */

struct handle {
	struct cache_detail *cd;
};

static void *c_start(struct seq_file *m, loff_t *pos)
1269
	__acquires(cd->hash_lock)
L
Linus Torvalds 已提交
1270 1271 1272 1273 1274
{
	loff_t n = *pos;
	unsigned hash, entry;
	struct cache_head *ch;
	struct cache_detail *cd = ((struct handle*)m->private)->cd;
1275

L
Linus Torvalds 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289

	read_lock(&cd->hash_lock);
	if (!n--)
		return SEQ_START_TOKEN;
	hash = n >> 32;
	entry = n & ((1LL<<32) - 1);

	for (ch=cd->hash_table[hash]; ch; ch=ch->next)
		if (!entry--)
			return ch;
	n &= ~((1LL<<32) - 1);
	do {
		hash++;
		n += 1LL<<32;
1290
	} while(hash < cd->hash_size &&
L
Linus Torvalds 已提交
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
		cd->hash_table[hash]==NULL);
	if (hash >= cd->hash_size)
		return NULL;
	*pos = n+1;
	return cd->hash_table[hash];
}

static void *c_next(struct seq_file *m, void *p, loff_t *pos)
{
	struct cache_head *ch = p;
	int hash = (*pos >> 32);
	struct cache_detail *cd = ((struct handle*)m->private)->cd;

	if (p == SEQ_START_TOKEN)
		hash = 0;
	else if (ch->next == NULL) {
		hash++;
		*pos += 1LL<<32;
	} else {
		++*pos;
		return ch->next;
	}
	*pos &= ~((1LL<<32) - 1);
	while (hash < cd->hash_size &&
	       cd->hash_table[hash] == NULL) {
		hash++;
		*pos += 1LL<<32;
	}
	if (hash >= cd->hash_size)
		return NULL;
	++*pos;
	return cd->hash_table[hash];
}

static void c_stop(struct seq_file *m, void *p)
1326
	__releases(cd->hash_lock)
L
Linus Torvalds 已提交
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
{
	struct cache_detail *cd = ((struct handle*)m->private)->cd;
	read_unlock(&cd->hash_lock);
}

static int c_show(struct seq_file *m, void *p)
{
	struct cache_head *cp = p;
	struct cache_detail *cd = ((struct handle*)m->private)->cd;

	if (p == SEQ_START_TOKEN)
		return cd->cache_show(m, cd, NULL);

	ifdebug(CACHE)
1341
		seq_printf(m, "# expiry=%ld refcnt=%d flags=%lx\n",
1342 1343
			   convert_to_wallclock(cp->expiry_time),
			   atomic_read(&cp->ref.refcount), cp->flags);
L
Linus Torvalds 已提交
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
	cache_get(cp);
	if (cache_check(cd, cp, NULL))
		/* cache_check does a cache_put on failure */
		seq_printf(m, "# ");
	else
		cache_put(cp, cd);

	return cd->cache_show(m, cd, cp);
}

1354
static const struct seq_operations cache_content_op = {
L
Linus Torvalds 已提交
1355 1356 1357 1358 1359 1360
	.start	= c_start,
	.next	= c_next,
	.stop	= c_stop,
	.show	= c_show,
};

1361 1362
static int content_open(struct inode *inode, struct file *file,
			struct cache_detail *cd)
L
Linus Torvalds 已提交
1363 1364 1365
{
	struct handle *han;

1366 1367
	if (!cd || !try_module_get(cd->owner))
		return -EACCES;
1368
	han = __seq_open_private(file, &cache_content_op, sizeof(*han));
1369 1370
	if (han == NULL) {
		module_put(cd->owner);
L
Linus Torvalds 已提交
1371
		return -ENOMEM;
1372
	}
L
Linus Torvalds 已提交
1373 1374

	han->cd = cd;
1375
	return 0;
L
Linus Torvalds 已提交
1376 1377
}

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
static int content_release(struct inode *inode, struct file *file,
		struct cache_detail *cd)
{
	int ret = seq_release_private(inode, file);
	module_put(cd->owner);
	return ret;
}

static int open_flush(struct inode *inode, struct file *file,
			struct cache_detail *cd)
{
	if (!cd || !try_module_get(cd->owner))
		return -EACCES;
	return nonseekable_open(inode, file);
}

static int release_flush(struct inode *inode, struct file *file,
			struct cache_detail *cd)
{
	module_put(cd->owner);
	return 0;
}
L
Linus Torvalds 已提交
1400 1401

static ssize_t read_flush(struct file *file, char __user *buf,
1402 1403
			  size_t count, loff_t *ppos,
			  struct cache_detail *cd)
L
Linus Torvalds 已提交
1404 1405 1406
{
	char tbuf[20];
	unsigned long p = *ppos;
1407
	size_t len;
L
Linus Torvalds 已提交
1408

1409
	sprintf(tbuf, "%lu\n", convert_to_wallclock(cd->flush_time));
L
Linus Torvalds 已提交
1410 1411 1412 1413
	len = strlen(tbuf);
	if (p >= len)
		return 0;
	len -= p;
1414 1415
	if (len > count)
		len = count;
L
Linus Torvalds 已提交
1416
	if (copy_to_user(buf, (void*)(tbuf+p), len))
1417 1418
		return -EFAULT;
	*ppos += len;
L
Linus Torvalds 已提交
1419 1420 1421
	return len;
}

1422 1423 1424
static ssize_t write_flush(struct file *file, const char __user *buf,
			   size_t count, loff_t *ppos,
			   struct cache_detail *cd)
L
Linus Torvalds 已提交
1425 1426
{
	char tbuf[20];
1427 1428
	char *bp, *ep;

L
Linus Torvalds 已提交
1429 1430 1431 1432 1433
	if (*ppos || count > sizeof(tbuf)-1)
		return -EINVAL;
	if (copy_from_user(tbuf, buf, count))
		return -EFAULT;
	tbuf[count] = 0;
1434
	simple_strtoul(tbuf, &ep, 0);
L
Linus Torvalds 已提交
1435 1436 1437
	if (*ep && *ep != '\n')
		return -EINVAL;

1438 1439 1440
	bp = tbuf;
	cd->flush_time = get_expiry(&bp);
	cd->nextcheck = seconds_since_boot();
L
Linus Torvalds 已提交
1441 1442 1443 1444 1445 1446
	cache_flush();

	*ppos += count;
	return count;
}

1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
static ssize_t cache_read_procfs(struct file *filp, char __user *buf,
				 size_t count, loff_t *ppos)
{
	struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;

	return cache_read(filp, buf, count, ppos, cd);
}

static ssize_t cache_write_procfs(struct file *filp, const char __user *buf,
				  size_t count, loff_t *ppos)
{
	struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;

	return cache_write(filp, buf, count, ppos, cd);
}

static unsigned int cache_poll_procfs(struct file *filp, poll_table *wait)
{
	struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;

	return cache_poll(filp, wait, cd);
}

1470 1471
static long cache_ioctl_procfs(struct file *filp,
			       unsigned int cmd, unsigned long arg)
1472
{
1473
	struct inode *inode = filp->f_path.dentry->d_inode;
1474 1475
	struct cache_detail *cd = PDE(inode)->data;

A
Arnd Bergmann 已提交
1476
	return cache_ioctl(inode, filp, cmd, arg, cd);
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
}

static int cache_open_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return cache_open(inode, filp, cd);
}

static int cache_release_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return cache_release(inode, filp, cd);
}

static const struct file_operations cache_file_operations_procfs = {
	.owner		= THIS_MODULE,
	.llseek		= no_llseek,
	.read		= cache_read_procfs,
	.write		= cache_write_procfs,
	.poll		= cache_poll_procfs,
1499
	.unlocked_ioctl	= cache_ioctl_procfs, /* for FIONREAD */
1500 1501
	.open		= cache_open_procfs,
	.release	= cache_release_procfs,
L
Linus Torvalds 已提交
1502
};
1503 1504 1505 1506 1507 1508 1509 1510

static int content_open_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return content_open(inode, filp, cd);
}

1511 1512 1513 1514 1515 1516 1517
static int content_release_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return content_release(inode, filp, cd);
}

1518 1519 1520 1521
static const struct file_operations content_file_operations_procfs = {
	.open		= content_open_procfs,
	.read		= seq_read,
	.llseek		= seq_lseek,
1522
	.release	= content_release_procfs,
1523 1524
};

1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
static int open_flush_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return open_flush(inode, filp, cd);
}

static int release_flush_procfs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = PDE(inode)->data;

	return release_flush(inode, filp, cd);
}

1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
static ssize_t read_flush_procfs(struct file *filp, char __user *buf,
			    size_t count, loff_t *ppos)
{
	struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;

	return read_flush(filp, buf, count, ppos, cd);
}

static ssize_t write_flush_procfs(struct file *filp,
				  const char __user *buf,
				  size_t count, loff_t *ppos)
{
	struct cache_detail *cd = PDE(filp->f_path.dentry->d_inode)->data;

	return write_flush(filp, buf, count, ppos, cd);
}

static const struct file_operations cache_flush_operations_procfs = {
1557
	.open		= open_flush_procfs,
1558 1559
	.read		= read_flush_procfs,
	.write		= write_flush_procfs,
1560
	.release	= release_flush_procfs,
1561
	.llseek		= no_llseek,
L
Linus Torvalds 已提交
1562
};
1563

1564
static void remove_cache_proc_entries(struct cache_detail *cd, struct net *net)
1565
{
1566 1567
	struct sunrpc_net *sn;

1568 1569 1570 1571 1572 1573 1574 1575 1576
	if (cd->u.procfs.proc_ent == NULL)
		return;
	if (cd->u.procfs.flush_ent)
		remove_proc_entry("flush", cd->u.procfs.proc_ent);
	if (cd->u.procfs.channel_ent)
		remove_proc_entry("channel", cd->u.procfs.proc_ent);
	if (cd->u.procfs.content_ent)
		remove_proc_entry("content", cd->u.procfs.proc_ent);
	cd->u.procfs.proc_ent = NULL;
1577 1578
	sn = net_generic(net, sunrpc_net_id);
	remove_proc_entry(cd->name, sn->proc_net_rpc);
1579 1580 1581
}

#ifdef CONFIG_PROC_FS
1582
static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1583 1584
{
	struct proc_dir_entry *p;
1585
	struct sunrpc_net *sn;
1586

1587 1588
	sn = net_generic(net, sunrpc_net_id);
	cd->u.procfs.proc_ent = proc_mkdir(cd->name, sn->proc_net_rpc);
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
	if (cd->u.procfs.proc_ent == NULL)
		goto out_nomem;
	cd->u.procfs.channel_ent = NULL;
	cd->u.procfs.content_ent = NULL;

	p = proc_create_data("flush", S_IFREG|S_IRUSR|S_IWUSR,
			     cd->u.procfs.proc_ent,
			     &cache_flush_operations_procfs, cd);
	cd->u.procfs.flush_ent = p;
	if (p == NULL)
		goto out_nomem;

	if (cd->cache_upcall || cd->cache_parse) {
		p = proc_create_data("channel", S_IFREG|S_IRUSR|S_IWUSR,
				     cd->u.procfs.proc_ent,
				     &cache_file_operations_procfs, cd);
		cd->u.procfs.channel_ent = p;
		if (p == NULL)
			goto out_nomem;
	}
	if (cd->cache_show) {
		p = proc_create_data("content", S_IFREG|S_IRUSR|S_IWUSR,
				cd->u.procfs.proc_ent,
				&content_file_operations_procfs, cd);
		cd->u.procfs.content_ent = p;
		if (p == NULL)
			goto out_nomem;
	}
	return 0;
out_nomem:
1619
	remove_cache_proc_entries(cd, net);
1620 1621 1622
	return -ENOMEM;
}
#else /* CONFIG_PROC_FS */
1623
static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1624 1625 1626 1627 1628
{
	return 0;
}
#endif

1629 1630 1631 1632 1633
void __init cache_initialize(void)
{
	INIT_DELAYED_WORK_DEFERRABLE(&cache_cleaner, do_cache_clean);
}

1634
int cache_register_net(struct cache_detail *cd, struct net *net)
1635 1636 1637 1638
{
	int ret;

	sunrpc_init_cache_detail(cd);
1639
	ret = create_cache_proc_entries(cd, net);
1640 1641 1642 1643
	if (ret)
		sunrpc_destroy_cache_detail(cd);
	return ret;
}
1644
EXPORT_SYMBOL_GPL(cache_register_net);
1645 1646 1647 1648 1649

int cache_register(struct cache_detail *cd)
{
	return cache_register_net(cd, &init_net);
}
1650 1651
EXPORT_SYMBOL_GPL(cache_register);

1652
void cache_unregister_net(struct cache_detail *cd, struct net *net)
1653
{
1654
	remove_cache_proc_entries(cd, net);
1655 1656
	sunrpc_destroy_cache_detail(cd);
}
1657
EXPORT_SYMBOL_GPL(cache_unregister_net);
1658 1659 1660 1661 1662

void cache_unregister(struct cache_detail *cd)
{
	cache_unregister_net(cd, &init_net);
}
1663
EXPORT_SYMBOL_GPL(cache_unregister);
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687

static ssize_t cache_read_pipefs(struct file *filp, char __user *buf,
				 size_t count, loff_t *ppos)
{
	struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;

	return cache_read(filp, buf, count, ppos, cd);
}

static ssize_t cache_write_pipefs(struct file *filp, const char __user *buf,
				  size_t count, loff_t *ppos)
{
	struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;

	return cache_write(filp, buf, count, ppos, cd);
}

static unsigned int cache_poll_pipefs(struct file *filp, poll_table *wait)
{
	struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;

	return cache_poll(filp, wait, cd);
}

1688
static long cache_ioctl_pipefs(struct file *filp,
1689 1690
			      unsigned int cmd, unsigned long arg)
{
1691
	struct inode *inode = filp->f_dentry->d_inode;
1692 1693
	struct cache_detail *cd = RPC_I(inode)->private;

A
Arnd Bergmann 已提交
1694
	return cache_ioctl(inode, filp, cmd, arg, cd);
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
}

static int cache_open_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return cache_open(inode, filp, cd);
}

static int cache_release_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return cache_release(inode, filp, cd);
}

const struct file_operations cache_file_operations_pipefs = {
	.owner		= THIS_MODULE,
	.llseek		= no_llseek,
	.read		= cache_read_pipefs,
	.write		= cache_write_pipefs,
	.poll		= cache_poll_pipefs,
1717
	.unlocked_ioctl	= cache_ioctl_pipefs, /* for FIONREAD */
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
	.open		= cache_open_pipefs,
	.release	= cache_release_pipefs,
};

static int content_open_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return content_open(inode, filp, cd);
}

1729 1730 1731 1732 1733 1734 1735
static int content_release_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return content_release(inode, filp, cd);
}

1736 1737 1738 1739
const struct file_operations content_file_operations_pipefs = {
	.open		= content_open_pipefs,
	.read		= seq_read,
	.llseek		= seq_lseek,
1740
	.release	= content_release_pipefs,
1741 1742
};

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
static int open_flush_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return open_flush(inode, filp, cd);
}

static int release_flush_pipefs(struct inode *inode, struct file *filp)
{
	struct cache_detail *cd = RPC_I(inode)->private;

	return release_flush(inode, filp, cd);
}

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
static ssize_t read_flush_pipefs(struct file *filp, char __user *buf,
			    size_t count, loff_t *ppos)
{
	struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;

	return read_flush(filp, buf, count, ppos, cd);
}

static ssize_t write_flush_pipefs(struct file *filp,
				  const char __user *buf,
				  size_t count, loff_t *ppos)
{
	struct cache_detail *cd = RPC_I(filp->f_path.dentry->d_inode)->private;

	return write_flush(filp, buf, count, ppos, cd);
}

const struct file_operations cache_flush_operations_pipefs = {
1775
	.open		= open_flush_pipefs,
1776 1777
	.read		= read_flush_pipefs,
	.write		= write_flush_pipefs,
1778
	.release	= release_flush_pipefs,
1779
	.llseek		= no_llseek,
1780 1781 1782
};

int sunrpc_cache_register_pipefs(struct dentry *parent,
A
Al Viro 已提交
1783
				 const char *name, umode_t umode,
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
				 struct cache_detail *cd)
{
	struct qstr q;
	struct dentry *dir;
	int ret = 0;

	sunrpc_init_cache_detail(cd);
	q.name = name;
	q.len = strlen(name);
	q.hash = full_name_hash(q.name, q.len);
	dir = rpc_create_cache_dir(parent, &q, umode, cd);
	if (!IS_ERR(dir))
		cd->u.pipefs.dir = dir;
	else {
		sunrpc_destroy_cache_detail(cd);
		ret = PTR_ERR(dir);
	}
	return ret;
}
EXPORT_SYMBOL_GPL(sunrpc_cache_register_pipefs);

void sunrpc_cache_unregister_pipefs(struct cache_detail *cd)
{
	rpc_remove_cache_dir(cd->u.pipefs.dir);
	cd->u.pipefs.dir = NULL;
	sunrpc_destroy_cache_detail(cd);
}
EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs);