cache.c 43.7 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
static int cache_make_upcall(struct cache_detail *cd, struct cache_head *h)
{
199 200
	if (cd->cache_upcall)
		return cd->cache_upcall(cd, h);
201
	return sunrpc_cache_pipe_upcall(cd, h);
202
}
203

204
static inline int cache_is_valid(struct cache_head *h)
205
{
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
static int try_to_negate_entry(struct cache_detail *detail, struct cache_head *h)
{
	int rv;

	write_lock(&detail->hash_lock);
230
	rv = cache_is_valid(h);
231 232 233 234
	if (rv == -EAGAIN) {
		set_bit(CACHE_NEGATIVE, &h->flags);
		cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY);
		rv = -ENOENT;
235 236 237
	}
	write_unlock(&detail->hash_lock);
	cache_fresh_unlocked(h, detail);
238
	return rv;
239 240
}

L
Linus Torvalds 已提交
241 242 243 244 245 246 247 248
/*
 * 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
249 250 251 252
 * -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 已提交
253 254 255 256 257 258 259 260 261
 * -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 */
262
	rv = cache_is_valid(h);
L
Linus Torvalds 已提交
263 264 265

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

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

286
	if (rv == -EAGAIN) {
287 288 289 290 291
		if (!cache_defer_req(rqstp, h)) {
			/*
			 * Request was not deferred; handle it as best
			 * we can ourselves:
			 */
292
			rv = cache_is_valid(h);
293 294 295 296
			if (rv == -EAGAIN)
				rv = -ETIMEDOUT;
		}
	}
297
	if (rv)
298
		cache_put(h, detail);
L
Linus Torvalds 已提交
299 300
	return rv;
}
301
EXPORT_SYMBOL_GPL(cache_check);
L
Linus Torvalds 已提交
302 303 304 305 306 307 308

/*
 * 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.
 *
309
 * Each time cache_clean is called it finds the next non-empty entry
L
Linus Torvalds 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
 * 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.
332
 *
L
Linus Torvalds 已提交
333 334 335 336 337 338 339
 */

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

340
static void do_cache_clean(struct work_struct *work);
341
static struct delayed_work cache_cleaner;
L
Linus Torvalds 已提交
342

343
void sunrpc_init_cache_detail(struct cache_detail *cd)
344
{
L
Linus Torvalds 已提交
345 346 347 348 349 350 351 352 353 354 355 356
	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 */
357
	schedule_delayed_work(&cache_cleaner, 0);
L
Linus Torvalds 已提交
358
}
359
EXPORT_SYMBOL_GPL(sunrpc_init_cache_detail);
L
Linus Torvalds 已提交
360

361
void sunrpc_destroy_cache_detail(struct cache_detail *cd)
L
Linus Torvalds 已提交
362 363 364 365 366 367 368
{
	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);
369
		goto out;
L
Linus Torvalds 已提交
370 371 372 373 374 375 376 377
	}
	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 */
378
		cancel_delayed_work_sync(&cache_cleaner);
L
Linus Torvalds 已提交
379
	}
380 381 382
	return;
out:
	printk(KERN_ERR "nfsd: failed to unregister %s cache\n", cd->name);
L
Linus Torvalds 已提交
383
}
384
EXPORT_SYMBOL_GPL(sunrpc_destroy_cache_detail);
L
Linus Torvalds 已提交
385 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

/* 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);
412
		if (current_detail->nextcheck > seconds_since_boot())
L
Linus Torvalds 已提交
413 414 415
			current_index = current_detail->hash_size;
		else {
			current_index = 0;
416
			current_detail->nextcheck = seconds_since_boot()+30*60;
L
Linus Torvalds 已提交
417 418 419 420 421 422 423 424 425 426
		}
	}

	/* 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 */
427

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

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

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

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

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

L
Linus Torvalds 已提交
450 451 452 453 454
		write_unlock(&current_detail->hash_lock);
		d = current_detail;
		if (!ch)
			current_index ++;
		spin_unlock(&cache_list_lock);
455
		if (ch) {
456
			set_bit(CACHE_CLEANED, &ch->flags);
457
			cache_fresh_unlocked(ch, d);
458
			cache_put(ch, d);
459
		}
L
Linus Torvalds 已提交
460 461 462 463 464 465 466 467 468
	} else
		spin_unlock(&cache_list_lock);

	return rv;
}

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

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

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


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

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


/*
 * 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
515
 * structure, we allow the request to provide a
L
Linus Torvalds 已提交
516 517 518 519 520 521 522 523 524 525 526 527 528
 * 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);
529
static struct hlist_head cache_defer_hash[DFR_HASHSIZE];
L
Linus Torvalds 已提交
530 531
static int cache_defer_cnt;

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

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

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

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

	dreq->item = item;

	spin_lock(&cache_defer_lock);

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

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

L
Linus Torvalds 已提交
565 566
	spin_unlock(&cache_defer_lock);

J
J. Bruce Fields 已提交
567
}
568

J
J. Bruce Fields 已提交
569 570 571 572 573 574 575 576 577 578 579 580
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);
}

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

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

589
	setup_deferral(dreq, item, 0);
J
J. Bruce Fields 已提交
590

591
	if (!test_bit(CACHE_PENDING, &item->flags) ||
592
	    wait_for_completion_interruptible_timeout(
J
J. Bruce Fields 已提交
593 594 595 596 597
		    &sleeper.completion, req->thread_wait) <= 0) {
		/* The completion wasn't completed, so we need
		 * to clean up
		 */
		spin_lock(&cache_defer_lock);
598
		if (!hlist_unhashed(&sleeper.handle.hash)) {
J
J. Bruce Fields 已提交
599 600 601 602 603 604 605
			__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.
606
			 */
J
J. Bruce Fields 已提交
607 608
			spin_unlock(&cache_defer_lock);
			wait_for_completion(&sleeper.completion);
609
		}
J
J. Bruce Fields 已提交
610 611 612
	}
}

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

620 621
	if (cache_defer_cnt <= DFR_MAX)
		return;
622

623 624 625 626 627 628 629 630 631 632 633 634 635
	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);
636 637
	if (discard)
		discard->revisit(discard, 1);
638
}
639

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

J
J. Bruce Fields 已提交
645
	if (req->thread_wait) {
646 647
		cache_wait_req(req, item);
		if (!test_bit(CACHE_PENDING, &item->flags))
648
			return false;
L
Linus Torvalds 已提交
649
	}
J
J. Bruce Fields 已提交
650 651
	dreq = req->defer(req);
	if (dreq == NULL)
652
		return false;
653
	setup_deferral(dreq, item, 1);
654 655 656 657 658
	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);
659 660

	cache_limit_defers();
661
	return true;
L
Linus Torvalds 已提交
662 663 664 665 666 667
}

static void cache_revisit_request(struct cache_head *item)
{
	struct cache_deferred_req *dreq;
	struct list_head pending;
668
	struct hlist_node *tmp;
L
Linus Torvalds 已提交
669 670 671 672
	int hash = DFR_HASH(item);

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

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

L
Linus Torvalds 已提交
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
	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);
697

L
Linus Torvalds 已提交
698 699
	list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) {
		if (dreq->owner == owner) {
J
J. Bruce Fields 已提交
700
			__unhash_deferred_req(dreq);
701
			list_add(&dreq->recent, &pending);
L
Linus Torvalds 已提交
702 703 704 705 706 707 708 709 710 711 712 713 714 715
		}
	}
	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 已提交
716 717 718 719
 * 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 已提交
720
 *
721
 * Implemented by linked list of requests.  Each open file has
J
J. Bruce Fields 已提交
722
 * a ->private that also exists in this list.  New requests are added
L
Linus Torvalds 已提交
723 724 725 726 727 728 729
 * 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 已提交
730
static DEFINE_MUTEX(queue_io_mutex);
L
Linus Torvalds 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747

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 */
};

748 749 750 751 752 753 754 755 756 757 758 759
static int cache_request(struct cache_detail *detail,
			       struct cache_request *crq)
{
	char *bp = crq->buf;
	int len = PAGE_SIZE;

	detail->cache_request(detail, crq->item, &bp, &len);
	if (len < 0)
		return -EAGAIN;
	return PAGE_SIZE - len;
}

760 761
static ssize_t cache_read(struct file *filp, char __user *buf, size_t count,
			  loff_t *ppos, struct cache_detail *cd)
L
Linus Torvalds 已提交
762 763 764
{
	struct cache_reader *rp = filp->private_data;
	struct cache_request *rq;
A
Al Viro 已提交
765
	struct inode *inode = file_inode(filp);
L
Linus Torvalds 已提交
766 767 768 769 770
	int err;

	if (count == 0)
		return 0;

771
	mutex_lock(&inode->i_mutex); /* protect against multiple concurrent
L
Linus Torvalds 已提交
772 773 774 775 776 777 778 779 780 781 782 783
			      * 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);
784
		mutex_unlock(&inode->i_mutex);
785
		WARN_ON_ONCE(rp->offset);
L
Linus Torvalds 已提交
786 787 788
		return 0;
	}
	rq = container_of(rp->q.list.next, struct cache_request, q.list);
789
	WARN_ON_ONCE(rq->q.reader);
L
Linus Torvalds 已提交
790 791 792 793
	if (rp->offset == 0)
		rq->readers++;
	spin_unlock(&queue_lock);

794 795 796 797 798 799 800
	if (rq->len == 0) {
		err = cache_request(cd, rq);
		if (err < 0)
			goto out;
		rq->len = err;
	}

L
Linus Torvalds 已提交
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
	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);
830
			cache_put(rq->item, cd);
L
Linus Torvalds 已提交
831 832 833 834 835 836 837
			kfree(rq->buf);
			kfree(rq);
		} else
			spin_unlock(&queue_lock);
	}
	if (err == -EAGAIN)
		goto again;
838
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
839 840 841
	return err ? err :  count;
}

842 843 844 845
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 已提交
846

847 848
	if (count == 0)
		return -EINVAL;
849 850 851 852 853 854 855 856 857 858 859
	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 已提交
860
{
861 862
	static char write_buf[8192]; /* protected by queue_io_mutex */
	ssize_t ret = -EINVAL;
L
Linus Torvalds 已提交
863 864

	if (count >= sizeof(write_buf))
865
		goto out;
A
Arjan van de Ven 已提交
866
	mutex_lock(&queue_io_mutex);
867 868 869 870 871
	ret = cache_do_downcall(write_buf, buf, count, cd);
	mutex_unlock(&queue_io_mutex);
out:
	return ret;
}
L
Linus Torvalds 已提交
872

873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
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 已提交
897

898 899 900
static ssize_t cache_write(struct file *filp, const char __user *buf,
			   size_t count, loff_t *ppos,
			   struct cache_detail *cd)
901 902
{
	struct address_space *mapping = filp->f_mapping;
A
Al Viro 已提交
903
	struct inode *inode = file_inode(filp);
904 905 906 907 908 909 910 911 912 913
	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 已提交
914 915 916 917
}

static DECLARE_WAIT_QUEUE_HEAD(queue_wait);

918 919
static unsigned int cache_poll(struct file *filp, poll_table *wait,
			       struct cache_detail *cd)
L
Linus Torvalds 已提交
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
{
	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;
}

945 946 947
static int cache_ioctl(struct inode *ino, struct file *filp,
		       unsigned int cmd, unsigned long arg,
		       struct cache_detail *cd)
L
Linus Torvalds 已提交
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
{
	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);
}

974 975
static int cache_open(struct inode *inode, struct file *filp,
		      struct cache_detail *cd)
L
Linus Torvalds 已提交
976 977 978
{
	struct cache_reader *rp = NULL;

979 980
	if (!cd || !try_module_get(cd->owner))
		return -EACCES;
L
Linus Torvalds 已提交
981 982 983
	nonseekable_open(inode, filp);
	if (filp->f_mode & FMODE_READ) {
		rp = kmalloc(sizeof(*rp), GFP_KERNEL);
984 985
		if (!rp) {
			module_put(cd->owner);
L
Linus Torvalds 已提交
986
			return -ENOMEM;
987
		}
L
Linus Torvalds 已提交
988 989 990 991 992 993 994 995 996 997 998
		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;
}

999 1000
static int cache_release(struct inode *inode, struct file *filp,
			 struct cache_detail *cd)
L
Linus Torvalds 已提交
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
{
	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);

1023
		cd->last_close = seconds_since_boot();
L
Linus Torvalds 已提交
1024 1025
		atomic_dec(&cd->readers);
	}
1026
	module_put(cd->owner);
L
Linus Torvalds 已提交
1027 1028 1029 1030 1031
	return 0;
}



1032
static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch)
L
Linus Torvalds 已提交
1033
{
1034 1035 1036 1037 1038
	struct cache_queue *cq, *tmp;
	struct cache_request *cr;
	struct list_head dequeued;

	INIT_LIST_HEAD(&dequeued);
L
Linus Torvalds 已提交
1039
	spin_lock(&queue_lock);
1040
	list_for_each_entry_safe(cq, tmp, &detail->queue, list)
L
Linus Torvalds 已提交
1041
		if (!cq->reader) {
1042
			cr = container_of(cq, struct cache_request, q);
L
Linus Torvalds 已提交
1043 1044
			if (cr->item != ch)
				continue;
1045 1046 1047
			if (test_bit(CACHE_PENDING, &ch->flags))
				/* Lost a race and it is pending again */
				break;
L
Linus Torvalds 已提交
1048
			if (cr->readers != 0)
1049
				continue;
1050
			list_move(&cr->q.list, &dequeued);
L
Linus Torvalds 已提交
1051 1052
		}
	spin_unlock(&queue_lock);
1053 1054 1055 1056 1057 1058 1059
	while (!list_empty(&dequeued)) {
		cr = list_entry(dequeued.next, struct cache_request, q.list);
		list_del(&cr->q.list);
		cache_put(cr->item, detail);
		kfree(cr->buf);
		kfree(cr);
	}
L
Linus Torvalds 已提交
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 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
}

/*
 * 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;
}
1105
EXPORT_SYMBOL_GPL(qword_add);
L
Linus Torvalds 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

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;
}
1134
EXPORT_SYMBOL_GPL(qword_addhex);
L
Linus Torvalds 已提交
1135 1136 1137 1138 1139 1140

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)
1141
			detail->warn_no_listener(detail, detail->last_close != 0);
L
Linus Torvalds 已提交
1142 1143 1144
	}
}

1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
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 已提交
1162
/*
1163 1164 1165
 * register an upcall request to user-space and queue it up for read() by the
 * upcall daemon.
 *
L
Linus Torvalds 已提交
1166 1167
 * Each request is at most one page long.
 */
1168
int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h)
L
Linus Torvalds 已提交
1169 1170 1171 1172
{

	char *buf;
	struct cache_request *crq;
1173
	int ret = 0;
L
Linus Torvalds 已提交
1174

1175 1176
	if (!detail->cache_request)
		return -EINVAL;
L
Linus Torvalds 已提交
1177

1178 1179 1180
	if (!cache_listeners_exist(detail)) {
		warn_no_listener(detail);
		return -EINVAL;
L
Linus Torvalds 已提交
1181
	}
1182 1183 1184
	if (test_bit(CACHE_CLEANED, &h->flags))
		/* Too late to make an upcall */
		return -EAGAIN;
L
Linus Torvalds 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198

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

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

	crq->q.reader = 0;
	crq->item = cache_get(h);
	crq->buf = buf;
1199
	crq->len = 0;
L
Linus Torvalds 已提交
1200 1201
	crq->readers = 0;
	spin_lock(&queue_lock);
1202 1203 1204 1205 1206
	if (test_bit(CACHE_PENDING, &h->flags))
		list_add_tail(&crq->q.list, &detail->queue);
	else
		/* Lost a race, no longer PENDING, so don't enqueue */
		ret = -EAGAIN;
L
Linus Torvalds 已提交
1207 1208
	spin_unlock(&queue_lock);
	wake_up(&queue_wait);
1209 1210 1211 1212 1213
	if (ret == -EAGAIN) {
		kfree(buf);
		kfree(crq);
	}
	return ret;
L
Linus Torvalds 已提交
1214
}
1215
EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall);
L
Linus Torvalds 已提交
1216 1217 1218 1219 1220 1221 1222

/*
 * 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
 *
1223
 * Message is
L
Linus Torvalds 已提交
1224 1225
 *   reply cachename expiry key ... content....
 *
1226
 * key and content are both parsed by cache
L
Linus Torvalds 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
 */

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;
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
		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 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
			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;
}
1282
EXPORT_SYMBOL_GPL(qword_get);
L
Linus Torvalds 已提交
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296


/*
 * 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)
1297
	__acquires(cd->hash_lock)
L
Linus Torvalds 已提交
1298 1299
{
	loff_t n = *pos;
1300
	unsigned int hash, entry;
L
Linus Torvalds 已提交
1301 1302
	struct cache_head *ch;
	struct cache_detail *cd = ((struct handle*)m->private)->cd;
1303

L
Linus Torvalds 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317

	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;
1318
	} while(hash < cd->hash_size &&
L
Linus Torvalds 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
		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)
1354
	__releases(cd->hash_lock)
L
Linus Torvalds 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
{
	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)
1369
		seq_printf(m, "# expiry=%ld refcnt=%d flags=%lx\n",
1370 1371
			   convert_to_wallclock(cp->expiry_time),
			   atomic_read(&cp->ref.refcount), cp->flags);
L
Linus Torvalds 已提交
1372 1373 1374 1375
	cache_get(cp);
	if (cache_check(cd, cp, NULL))
		/* cache_check does a cache_put on failure */
		seq_printf(m, "# ");
1376 1377 1378
	else {
		if (cache_is_expired(cd, cp))
			seq_printf(m, "# ");
L
Linus Torvalds 已提交
1379
		cache_put(cp, cd);
1380
	}
L
Linus Torvalds 已提交
1381 1382 1383 1384

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

1385
static const struct seq_operations cache_content_op = {
L
Linus Torvalds 已提交
1386 1387 1388 1389 1390 1391
	.start	= c_start,
	.next	= c_next,
	.stop	= c_stop,
	.show	= c_show,
};

1392 1393
static int content_open(struct inode *inode, struct file *file,
			struct cache_detail *cd)
L
Linus Torvalds 已提交
1394 1395 1396
{
	struct handle *han;

1397 1398
	if (!cd || !try_module_get(cd->owner))
		return -EACCES;
1399
	han = __seq_open_private(file, &cache_content_op, sizeof(*han));
1400 1401
	if (han == NULL) {
		module_put(cd->owner);
L
Linus Torvalds 已提交
1402
		return -ENOMEM;
1403
	}
L
Linus Torvalds 已提交
1404 1405

	han->cd = cd;
1406
	return 0;
L
Linus Torvalds 已提交
1407 1408
}

1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
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 已提交
1431 1432

static ssize_t read_flush(struct file *file, char __user *buf,
1433 1434
			  size_t count, loff_t *ppos,
			  struct cache_detail *cd)
L
Linus Torvalds 已提交
1435
{
1436
	char tbuf[22];
L
Linus Torvalds 已提交
1437
	unsigned long p = *ppos;
1438
	size_t len;
L
Linus Torvalds 已提交
1439

1440
	snprintf(tbuf, sizeof(tbuf), "%lu\n", convert_to_wallclock(cd->flush_time));
L
Linus Torvalds 已提交
1441 1442 1443 1444
	len = strlen(tbuf);
	if (p >= len)
		return 0;
	len -= p;
1445 1446
	if (len > count)
		len = count;
L
Linus Torvalds 已提交
1447
	if (copy_to_user(buf, (void*)(tbuf+p), len))
1448 1449
		return -EFAULT;
	*ppos += len;
L
Linus Torvalds 已提交
1450 1451 1452
	return len;
}

1453 1454 1455
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 已提交
1456 1457
{
	char tbuf[20];
1458 1459
	char *bp, *ep;

L
Linus Torvalds 已提交
1460 1461 1462 1463 1464
	if (*ppos || count > sizeof(tbuf)-1)
		return -EINVAL;
	if (copy_from_user(tbuf, buf, count))
		return -EFAULT;
	tbuf[count] = 0;
1465
	simple_strtoul(tbuf, &ep, 0);
L
Linus Torvalds 已提交
1466 1467 1468
	if (*ep && *ep != '\n')
		return -EINVAL;

1469 1470 1471
	bp = tbuf;
	cd->flush_time = get_expiry(&bp);
	cd->nextcheck = seconds_since_boot();
L
Linus Torvalds 已提交
1472 1473 1474 1475 1476 1477
	cache_flush();

	*ppos += count;
	return count;
}

1478 1479 1480
static ssize_t cache_read_procfs(struct file *filp, char __user *buf,
				 size_t count, loff_t *ppos)
{
A
Al Viro 已提交
1481
	struct cache_detail *cd = PDE_DATA(file_inode(filp));
1482 1483 1484 1485 1486 1487 1488

	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)
{
A
Al Viro 已提交
1489
	struct cache_detail *cd = PDE_DATA(file_inode(filp));
1490 1491 1492 1493 1494 1495

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

static unsigned int cache_poll_procfs(struct file *filp, poll_table *wait)
{
A
Al Viro 已提交
1496
	struct cache_detail *cd = PDE_DATA(file_inode(filp));
1497 1498 1499 1500

	return cache_poll(filp, wait, cd);
}

1501 1502
static long cache_ioctl_procfs(struct file *filp,
			       unsigned int cmd, unsigned long arg)
1503
{
A
Al Viro 已提交
1504
	struct inode *inode = file_inode(filp);
A
Al Viro 已提交
1505
	struct cache_detail *cd = PDE_DATA(inode);
1506

A
Arnd Bergmann 已提交
1507
	return cache_ioctl(inode, filp, cmd, arg, cd);
1508 1509 1510 1511
}

static int cache_open_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1512
	struct cache_detail *cd = PDE_DATA(inode);
1513 1514 1515 1516 1517 1518

	return cache_open(inode, filp, cd);
}

static int cache_release_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1519
	struct cache_detail *cd = PDE_DATA(inode);
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529

	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,
1530
	.unlocked_ioctl	= cache_ioctl_procfs, /* for FIONREAD */
1531 1532
	.open		= cache_open_procfs,
	.release	= cache_release_procfs,
L
Linus Torvalds 已提交
1533
};
1534 1535 1536

static int content_open_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1537
	struct cache_detail *cd = PDE_DATA(inode);
1538 1539 1540 1541

	return content_open(inode, filp, cd);
}

1542 1543
static int content_release_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1544
	struct cache_detail *cd = PDE_DATA(inode);
1545 1546 1547 1548

	return content_release(inode, filp, cd);
}

1549 1550 1551 1552
static const struct file_operations content_file_operations_procfs = {
	.open		= content_open_procfs,
	.read		= seq_read,
	.llseek		= seq_lseek,
1553
	.release	= content_release_procfs,
1554 1555
};

1556 1557
static int open_flush_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1558
	struct cache_detail *cd = PDE_DATA(inode);
1559 1560 1561 1562 1563 1564

	return open_flush(inode, filp, cd);
}

static int release_flush_procfs(struct inode *inode, struct file *filp)
{
A
Al Viro 已提交
1565
	struct cache_detail *cd = PDE_DATA(inode);
1566 1567 1568 1569

	return release_flush(inode, filp, cd);
}

1570 1571 1572
static ssize_t read_flush_procfs(struct file *filp, char __user *buf,
			    size_t count, loff_t *ppos)
{
A
Al Viro 已提交
1573
	struct cache_detail *cd = PDE_DATA(file_inode(filp));
1574 1575 1576 1577 1578 1579 1580 1581

	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)
{
A
Al Viro 已提交
1582
	struct cache_detail *cd = PDE_DATA(file_inode(filp));
1583 1584 1585 1586 1587

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

static const struct file_operations cache_flush_operations_procfs = {
1588
	.open		= open_flush_procfs,
1589 1590
	.read		= read_flush_procfs,
	.write		= write_flush_procfs,
1591
	.release	= release_flush_procfs,
1592
	.llseek		= no_llseek,
L
Linus Torvalds 已提交
1593
};
1594

1595
static void remove_cache_proc_entries(struct cache_detail *cd, struct net *net)
1596
{
1597 1598
	struct sunrpc_net *sn;

1599 1600 1601 1602 1603 1604 1605 1606 1607
	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;
1608 1609
	sn = net_generic(net, sunrpc_net_id);
	remove_proc_entry(cd->name, sn->proc_net_rpc);
1610 1611 1612
}

#ifdef CONFIG_PROC_FS
1613
static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1614 1615
{
	struct proc_dir_entry *p;
1616
	struct sunrpc_net *sn;
1617

1618 1619
	sn = net_generic(net, sunrpc_net_id);
	cd->u.procfs.proc_ent = proc_mkdir(cd->name, sn->proc_net_rpc);
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
	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;

1632
	if (cd->cache_request || cd->cache_parse) {
1633 1634 1635 1636 1637 1638 1639 1640
		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) {
1641
		p = proc_create_data("content", S_IFREG|S_IRUSR,
1642 1643 1644 1645 1646 1647 1648 1649
				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:
1650
	remove_cache_proc_entries(cd, net);
1651 1652 1653
	return -ENOMEM;
}
#else /* CONFIG_PROC_FS */
1654
static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
1655 1656 1657 1658 1659
{
	return 0;
}
#endif

1660 1661
void __init cache_initialize(void)
{
1662
	INIT_DEFERRABLE_WORK(&cache_cleaner, do_cache_clean);
1663 1664
}

1665
int cache_register_net(struct cache_detail *cd, struct net *net)
1666 1667 1668 1669
{
	int ret;

	sunrpc_init_cache_detail(cd);
1670
	ret = create_cache_proc_entries(cd, net);
1671 1672 1673 1674
	if (ret)
		sunrpc_destroy_cache_detail(cd);
	return ret;
}
1675
EXPORT_SYMBOL_GPL(cache_register_net);
1676 1677

void cache_unregister_net(struct cache_detail *cd, struct net *net)
1678
{
1679
	remove_cache_proc_entries(cd, net);
1680 1681
	sunrpc_destroy_cache_detail(cd);
}
1682
EXPORT_SYMBOL_GPL(cache_unregister_net);
1683

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
struct cache_detail *cache_create_net(struct cache_detail *tmpl, struct net *net)
{
	struct cache_detail *cd;

	cd = kmemdup(tmpl, sizeof(struct cache_detail), GFP_KERNEL);
	if (cd == NULL)
		return ERR_PTR(-ENOMEM);

	cd->hash_table = kzalloc(cd->hash_size * sizeof(struct cache_head *),
				 GFP_KERNEL);
	if (cd->hash_table == NULL) {
		kfree(cd);
		return ERR_PTR(-ENOMEM);
	}
	cd->net = net;
	return cd;
}
EXPORT_SYMBOL_GPL(cache_create_net);

void cache_destroy_net(struct cache_detail *cd, struct net *net)
1704
{
1705 1706
	kfree(cd->hash_table);
	kfree(cd);
1707
}
1708
EXPORT_SYMBOL_GPL(cache_destroy_net);
1709 1710 1711 1712

static ssize_t cache_read_pipefs(struct file *filp, char __user *buf,
				 size_t count, loff_t *ppos)
{
A
Al Viro 已提交
1713
	struct cache_detail *cd = RPC_I(file_inode(filp))->private;
1714 1715 1716 1717 1718 1719 1720

	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)
{
A
Al Viro 已提交
1721
	struct cache_detail *cd = RPC_I(file_inode(filp))->private;
1722 1723 1724 1725 1726 1727

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

static unsigned int cache_poll_pipefs(struct file *filp, poll_table *wait)
{
A
Al Viro 已提交
1728
	struct cache_detail *cd = RPC_I(file_inode(filp))->private;
1729 1730 1731 1732

	return cache_poll(filp, wait, cd);
}

1733
static long cache_ioctl_pipefs(struct file *filp,
1734 1735
			      unsigned int cmd, unsigned long arg)
{
A
Al Viro 已提交
1736
	struct inode *inode = file_inode(filp);
1737 1738
	struct cache_detail *cd = RPC_I(inode)->private;

A
Arnd Bergmann 已提交
1739
	return cache_ioctl(inode, filp, cmd, arg, cd);
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
}

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,
1762
	.unlocked_ioctl	= cache_ioctl_pipefs, /* for FIONREAD */
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
	.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);
}

1774 1775 1776 1777 1778 1779 1780
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);
}

1781 1782 1783 1784
const struct file_operations content_file_operations_pipefs = {
	.open		= content_open_pipefs,
	.read		= seq_read,
	.llseek		= seq_lseek,
1785
	.release	= content_release_pipefs,
1786 1787
};

1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
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);
}

1802 1803 1804
static ssize_t read_flush_pipefs(struct file *filp, char __user *buf,
			    size_t count, loff_t *ppos)
{
A
Al Viro 已提交
1805
	struct cache_detail *cd = RPC_I(file_inode(filp))->private;
1806 1807 1808 1809 1810 1811 1812 1813

	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)
{
A
Al Viro 已提交
1814
	struct cache_detail *cd = RPC_I(file_inode(filp))->private;
1815 1816 1817 1818 1819

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

const struct file_operations cache_flush_operations_pipefs = {
1820
	.open		= open_flush_pipefs,
1821 1822
	.read		= read_flush_pipefs,
	.write		= write_flush_pipefs,
1823
	.release	= release_flush_pipefs,
1824
	.llseek		= no_llseek,
1825 1826 1827
};

int sunrpc_cache_register_pipefs(struct dentry *parent,
A
Al Viro 已提交
1828
				 const char *name, umode_t umode,
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
				 struct cache_detail *cd)
{
	struct qstr q;
	struct dentry *dir;
	int ret = 0;

	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;
1841
	else
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853
		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;
}
EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs);