Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[linux-2.6/libata-dev.git] / fs / nfs / delegation.c
blob6390a4b5fee75823512f30de7f7452696a23093c
1 /*
2 * linux/fs/nfs/delegation.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFS file delegation management
8 */
9 #include <linux/completion.h>
10 #include <linux/kthread.h>
11 #include <linux/module.h>
12 #include <linux/sched.h>
13 #include <linux/slab.h>
14 #include <linux/spinlock.h>
16 #include <linux/nfs4.h>
17 #include <linux/nfs_fs.h>
18 #include <linux/nfs_xdr.h>
20 #include "nfs4_fs.h"
21 #include "delegation.h"
22 #include "internal.h"
24 static void nfs_free_delegation(struct nfs_delegation *delegation)
26 if (delegation->cred) {
27 put_rpccred(delegation->cred);
28 delegation->cred = NULL;
30 kfree_rcu(delegation, rcu);
33 /**
34 * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
35 * @delegation: delegation to process
38 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation)
40 set_bit(NFS_DELEGATION_REFERENCED, &delegation->flags);
43 /**
44 * nfs_have_delegation - check if inode has a delegation
45 * @inode: inode to check
46 * @flags: delegation types to check for
48 * Returns one if inode has the indicated delegation, otherwise zero.
50 int nfs4_have_delegation(struct inode *inode, fmode_t flags)
52 struct nfs_delegation *delegation;
53 int ret = 0;
55 flags &= FMODE_READ|FMODE_WRITE;
56 rcu_read_lock();
57 delegation = rcu_dereference(NFS_I(inode)->delegation);
58 if (delegation != NULL && (delegation->type & flags) == flags &&
59 !test_bit(NFS_DELEGATION_RETURNING, &delegation->flags)) {
60 nfs_mark_delegation_referenced(delegation);
61 ret = 1;
63 rcu_read_unlock();
64 return ret;
67 static int nfs_delegation_claim_locks(struct nfs_open_context *ctx, struct nfs4_state *state)
69 struct inode *inode = state->inode;
70 struct file_lock *fl;
71 int status = 0;
73 if (inode->i_flock == NULL)
74 return 0;
76 if (inode->i_flock == NULL)
77 goto out;
78 /* Protect inode->i_flock using the file locks lock */
79 lock_flocks();
80 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
81 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
82 continue;
83 if (nfs_file_open_context(fl->fl_file) != ctx)
84 continue;
85 unlock_flocks();
86 status = nfs4_lock_delegation_recall(state, fl);
87 if (status < 0)
88 goto out;
89 lock_flocks();
91 unlock_flocks();
92 out:
93 return status;
96 static int nfs_delegation_claim_opens(struct inode *inode, const nfs4_stateid *stateid)
98 struct nfs_inode *nfsi = NFS_I(inode);
99 struct nfs_open_context *ctx;
100 struct nfs4_state_owner *sp;
101 struct nfs4_state *state;
102 unsigned int seq;
103 int err;
105 again:
106 spin_lock(&inode->i_lock);
107 list_for_each_entry(ctx, &nfsi->open_files, list) {
108 state = ctx->state;
109 if (state == NULL)
110 continue;
111 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
112 continue;
113 if (!nfs4_stateid_match(&state->stateid, stateid))
114 continue;
115 get_nfs_open_context(ctx);
116 spin_unlock(&inode->i_lock);
117 sp = state->owner;
118 /* Block nfs4_proc_unlck */
119 mutex_lock(&sp->so_delegreturn_mutex);
120 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
121 err = nfs4_open_delegation_recall(ctx, state, stateid);
122 if (!err)
123 err = nfs_delegation_claim_locks(ctx, state);
124 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
125 err = -EAGAIN;
126 mutex_unlock(&sp->so_delegreturn_mutex);
127 put_nfs_open_context(ctx);
128 if (err != 0)
129 return err;
130 goto again;
132 spin_unlock(&inode->i_lock);
133 return 0;
137 * nfs_inode_reclaim_delegation - process a delegation reclaim request
138 * @inode: inode to process
139 * @cred: credential to use for request
140 * @res: new delegation state from server
143 void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred,
144 struct nfs_openres *res)
146 struct nfs_delegation *delegation;
147 struct rpc_cred *oldcred = NULL;
149 rcu_read_lock();
150 delegation = rcu_dereference(NFS_I(inode)->delegation);
151 if (delegation != NULL) {
152 spin_lock(&delegation->lock);
153 if (delegation->inode != NULL) {
154 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
155 delegation->type = res->delegation_type;
156 delegation->maxsize = res->maxsize;
157 oldcred = delegation->cred;
158 delegation->cred = get_rpccred(cred);
159 clear_bit(NFS_DELEGATION_NEED_RECLAIM,
160 &delegation->flags);
161 NFS_I(inode)->delegation_state = delegation->type;
162 spin_unlock(&delegation->lock);
163 put_rpccred(oldcred);
164 rcu_read_unlock();
165 } else {
166 /* We appear to have raced with a delegation return. */
167 spin_unlock(&delegation->lock);
168 rcu_read_unlock();
169 nfs_inode_set_delegation(inode, cred, res);
171 } else {
172 rcu_read_unlock();
176 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
178 int res = 0;
180 res = nfs4_proc_delegreturn(inode, delegation->cred, &delegation->stateid, issync);
181 nfs_free_delegation(delegation);
182 return res;
185 static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
187 struct inode *inode = NULL;
189 spin_lock(&delegation->lock);
190 if (delegation->inode != NULL)
191 inode = igrab(delegation->inode);
192 spin_unlock(&delegation->lock);
193 return inode;
196 static struct nfs_delegation *
197 nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
199 struct nfs_delegation *ret = NULL;
200 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
202 if (delegation == NULL)
203 goto out;
204 spin_lock(&delegation->lock);
205 if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
206 ret = delegation;
207 spin_unlock(&delegation->lock);
208 out:
209 return ret;
212 static struct nfs_delegation *
213 nfs_start_delegation_return(struct nfs_inode *nfsi)
215 struct nfs_delegation *delegation;
217 rcu_read_lock();
218 delegation = nfs_start_delegation_return_locked(nfsi);
219 rcu_read_unlock();
220 return delegation;
223 static void
224 nfs_abort_delegation_return(struct nfs_delegation *delegation,
225 struct nfs_client *clp)
228 spin_lock(&delegation->lock);
229 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
230 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
231 spin_unlock(&delegation->lock);
232 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
235 static struct nfs_delegation *
236 nfs_detach_delegation_locked(struct nfs_inode *nfsi,
237 struct nfs_delegation *delegation,
238 struct nfs_client *clp)
240 struct nfs_delegation *deleg_cur =
241 rcu_dereference_protected(nfsi->delegation,
242 lockdep_is_held(&clp->cl_lock));
244 if (deleg_cur == NULL || delegation != deleg_cur)
245 return NULL;
247 spin_lock(&delegation->lock);
248 set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
249 list_del_rcu(&delegation->super_list);
250 delegation->inode = NULL;
251 nfsi->delegation_state = 0;
252 rcu_assign_pointer(nfsi->delegation, NULL);
253 spin_unlock(&delegation->lock);
254 return delegation;
257 static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
258 struct nfs_delegation *delegation,
259 struct nfs_server *server)
261 struct nfs_client *clp = server->nfs_client;
263 spin_lock(&clp->cl_lock);
264 delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
265 spin_unlock(&clp->cl_lock);
266 return delegation;
269 static struct nfs_delegation *
270 nfs_inode_detach_delegation(struct inode *inode)
272 struct nfs_inode *nfsi = NFS_I(inode);
273 struct nfs_server *server = NFS_SERVER(inode);
274 struct nfs_delegation *delegation;
276 delegation = nfs_start_delegation_return(nfsi);
277 if (delegation == NULL)
278 return NULL;
279 return nfs_detach_delegation(nfsi, delegation, server);
283 * nfs_inode_set_delegation - set up a delegation on an inode
284 * @inode: inode to which delegation applies
285 * @cred: cred to use for subsequent delegation processing
286 * @res: new delegation state from server
288 * Returns zero on success, or a negative errno value.
290 int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
292 struct nfs_server *server = NFS_SERVER(inode);
293 struct nfs_client *clp = server->nfs_client;
294 struct nfs_inode *nfsi = NFS_I(inode);
295 struct nfs_delegation *delegation, *old_delegation;
296 struct nfs_delegation *freeme = NULL;
297 int status = 0;
299 delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
300 if (delegation == NULL)
301 return -ENOMEM;
302 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
303 delegation->type = res->delegation_type;
304 delegation->maxsize = res->maxsize;
305 delegation->change_attr = inode->i_version;
306 delegation->cred = get_rpccred(cred);
307 delegation->inode = inode;
308 delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
309 spin_lock_init(&delegation->lock);
311 spin_lock(&clp->cl_lock);
312 old_delegation = rcu_dereference_protected(nfsi->delegation,
313 lockdep_is_held(&clp->cl_lock));
314 if (old_delegation != NULL) {
315 if (nfs4_stateid_match(&delegation->stateid,
316 &old_delegation->stateid) &&
317 delegation->type == old_delegation->type) {
318 goto out;
321 * Deal with broken servers that hand out two
322 * delegations for the same file.
323 * Allow for upgrades to a WRITE delegation, but
324 * nothing else.
326 dfprintk(FILE, "%s: server %s handed out "
327 "a duplicate delegation!\n",
328 __func__, clp->cl_hostname);
329 if (delegation->type == old_delegation->type ||
330 !(delegation->type & FMODE_WRITE)) {
331 freeme = delegation;
332 delegation = NULL;
333 goto out;
335 freeme = nfs_detach_delegation_locked(nfsi,
336 old_delegation, clp);
337 if (freeme == NULL)
338 goto out;
340 list_add_rcu(&delegation->super_list, &server->delegations);
341 nfsi->delegation_state = delegation->type;
342 rcu_assign_pointer(nfsi->delegation, delegation);
343 delegation = NULL;
345 /* Ensure we revalidate the attributes and page cache! */
346 spin_lock(&inode->i_lock);
347 nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
348 spin_unlock(&inode->i_lock);
350 out:
351 spin_unlock(&clp->cl_lock);
352 if (delegation != NULL)
353 nfs_free_delegation(delegation);
354 if (freeme != NULL)
355 nfs_do_return_delegation(inode, freeme, 0);
356 return status;
360 * Basic procedure for returning a delegation to the server
362 static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
364 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
365 struct nfs_inode *nfsi = NFS_I(inode);
366 int err;
368 if (delegation == NULL)
369 return 0;
370 do {
371 err = nfs_delegation_claim_opens(inode, &delegation->stateid);
372 if (!issync || err != -EAGAIN)
373 break;
375 * Guard against state recovery
377 err = nfs4_wait_clnt_recover(clp);
378 } while (err == 0);
380 if (err) {
381 nfs_abort_delegation_return(delegation, clp);
382 goto out;
384 if (!nfs_detach_delegation(nfsi, delegation, NFS_SERVER(inode)))
385 goto out;
387 err = nfs_do_return_delegation(inode, delegation, issync);
388 out:
389 return err;
393 * nfs_client_return_marked_delegations - return previously marked delegations
394 * @clp: nfs_client to process
396 * Note that this function is designed to be called by the state
397 * manager thread. For this reason, it cannot flush the dirty data,
398 * since that could deadlock in case of a state recovery error.
400 * Returns zero on success, or a negative errno value.
402 int nfs_client_return_marked_delegations(struct nfs_client *clp)
404 struct nfs_delegation *delegation;
405 struct nfs_server *server;
406 struct inode *inode;
407 int err = 0;
409 restart:
410 rcu_read_lock();
411 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
412 list_for_each_entry_rcu(delegation, &server->delegations,
413 super_list) {
414 if (!test_and_clear_bit(NFS_DELEGATION_RETURN,
415 &delegation->flags))
416 continue;
417 inode = nfs_delegation_grab_inode(delegation);
418 if (inode == NULL)
419 continue;
420 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
421 rcu_read_unlock();
423 err = nfs_end_delegation_return(inode, delegation, 0);
424 iput(inode);
425 if (!err)
426 goto restart;
427 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
428 return err;
431 rcu_read_unlock();
432 return 0;
436 * nfs_inode_return_delegation_noreclaim - return delegation, don't reclaim opens
437 * @inode: inode to process
439 * Does not protect against delegation reclaims, therefore really only safe
440 * to be called from nfs4_clear_inode().
442 void nfs_inode_return_delegation_noreclaim(struct inode *inode)
444 struct nfs_delegation *delegation;
446 delegation = nfs_inode_detach_delegation(inode);
447 if (delegation != NULL)
448 nfs_do_return_delegation(inode, delegation, 0);
452 * nfs_inode_return_delegation - synchronously return a delegation
453 * @inode: inode to process
455 * This routine will always flush any dirty data to disk on the
456 * assumption that if we need to return the delegation, then
457 * we should stop caching.
459 * Returns zero on success, or a negative errno value.
461 int nfs4_inode_return_delegation(struct inode *inode)
463 struct nfs_inode *nfsi = NFS_I(inode);
464 struct nfs_delegation *delegation;
465 int err = 0;
467 nfs_wb_all(inode);
468 delegation = nfs_start_delegation_return(nfsi);
469 if (delegation != NULL)
470 err = nfs_end_delegation_return(inode, delegation, 1);
471 return err;
474 static void nfs_mark_return_delegation(struct nfs_server *server,
475 struct nfs_delegation *delegation)
477 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
478 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
482 * nfs_super_return_all_delegations - return delegations for one superblock
483 * @sb: sb to process
486 void nfs_server_return_all_delegations(struct nfs_server *server)
488 struct nfs_client *clp = server->nfs_client;
489 struct nfs_delegation *delegation;
491 if (clp == NULL)
492 return;
494 rcu_read_lock();
495 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
496 spin_lock(&delegation->lock);
497 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
498 spin_unlock(&delegation->lock);
500 rcu_read_unlock();
502 if (nfs_client_return_marked_delegations(clp) != 0)
503 nfs4_schedule_state_manager(clp);
506 static void nfs_mark_return_all_delegation_types(struct nfs_server *server,
507 fmode_t flags)
509 struct nfs_delegation *delegation;
511 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
512 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
513 continue;
514 if (delegation->type & flags)
515 nfs_mark_return_delegation(server, delegation);
519 static void nfs_client_mark_return_all_delegation_types(struct nfs_client *clp,
520 fmode_t flags)
522 struct nfs_server *server;
524 rcu_read_lock();
525 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
526 nfs_mark_return_all_delegation_types(server, flags);
527 rcu_read_unlock();
530 static void nfs_delegation_run_state_manager(struct nfs_client *clp)
532 if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
533 nfs4_schedule_state_manager(clp);
536 void nfs_remove_bad_delegation(struct inode *inode)
538 struct nfs_delegation *delegation;
540 delegation = nfs_inode_detach_delegation(inode);
541 if (delegation) {
542 nfs_inode_find_state_and_recover(inode, &delegation->stateid);
543 nfs_free_delegation(delegation);
546 EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
549 * nfs_expire_all_delegation_types
550 * @clp: client to process
551 * @flags: delegation types to expire
554 void nfs_expire_all_delegation_types(struct nfs_client *clp, fmode_t flags)
556 nfs_client_mark_return_all_delegation_types(clp, flags);
557 nfs_delegation_run_state_manager(clp);
561 * nfs_expire_all_delegations
562 * @clp: client to process
565 void nfs_expire_all_delegations(struct nfs_client *clp)
567 nfs_expire_all_delegation_types(clp, FMODE_READ|FMODE_WRITE);
570 static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
572 struct nfs_delegation *delegation;
574 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
575 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
576 continue;
577 nfs_mark_return_delegation(server, delegation);
582 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
583 * @clp: nfs_client to process
586 void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
588 struct nfs_server *server;
590 rcu_read_lock();
591 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
592 nfs_mark_return_unreferenced_delegations(server);
593 rcu_read_unlock();
595 nfs_delegation_run_state_manager(clp);
599 * nfs_async_inode_return_delegation - asynchronously return a delegation
600 * @inode: inode to process
601 * @stateid: state ID information
603 * Returns zero on success, or a negative errno value.
605 int nfs_async_inode_return_delegation(struct inode *inode,
606 const nfs4_stateid *stateid)
608 struct nfs_server *server = NFS_SERVER(inode);
609 struct nfs_client *clp = server->nfs_client;
610 struct nfs_delegation *delegation;
612 filemap_flush(inode->i_mapping);
614 rcu_read_lock();
615 delegation = rcu_dereference(NFS_I(inode)->delegation);
617 if (!clp->cl_mvops->match_stateid(&delegation->stateid, stateid)) {
618 rcu_read_unlock();
619 return -ENOENT;
621 nfs_mark_return_delegation(server, delegation);
622 rcu_read_unlock();
624 nfs_delegation_run_state_manager(clp);
625 return 0;
628 static struct inode *
629 nfs_delegation_find_inode_server(struct nfs_server *server,
630 const struct nfs_fh *fhandle)
632 struct nfs_delegation *delegation;
633 struct inode *res = NULL;
635 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
636 spin_lock(&delegation->lock);
637 if (delegation->inode != NULL &&
638 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
639 res = igrab(delegation->inode);
641 spin_unlock(&delegation->lock);
642 if (res != NULL)
643 break;
645 return res;
649 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
650 * @clp: client state handle
651 * @fhandle: filehandle from a delegation recall
653 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
654 * cannot be found.
656 struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
657 const struct nfs_fh *fhandle)
659 struct nfs_server *server;
660 struct inode *res = NULL;
662 rcu_read_lock();
663 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
664 res = nfs_delegation_find_inode_server(server, fhandle);
665 if (res != NULL)
666 break;
668 rcu_read_unlock();
669 return res;
672 static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
674 struct nfs_delegation *delegation;
676 list_for_each_entry_rcu(delegation, &server->delegations, super_list)
677 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
681 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
682 * @clp: nfs_client to process
685 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
687 struct nfs_server *server;
689 rcu_read_lock();
690 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
691 nfs_delegation_mark_reclaim_server(server);
692 rcu_read_unlock();
696 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
697 * @clp: nfs_client to process
700 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
702 struct nfs_delegation *delegation;
703 struct nfs_server *server;
704 struct inode *inode;
706 restart:
707 rcu_read_lock();
708 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
709 list_for_each_entry_rcu(delegation, &server->delegations,
710 super_list) {
711 if (test_bit(NFS_DELEGATION_NEED_RECLAIM,
712 &delegation->flags) == 0)
713 continue;
714 inode = nfs_delegation_grab_inode(delegation);
715 if (inode == NULL)
716 continue;
717 delegation = nfs_detach_delegation(NFS_I(inode),
718 delegation, server);
719 rcu_read_unlock();
721 if (delegation != NULL)
722 nfs_free_delegation(delegation);
723 iput(inode);
724 goto restart;
727 rcu_read_unlock();
731 * nfs_delegations_present - check for existence of delegations
732 * @clp: client state handle
734 * Returns one if there are any nfs_delegation structures attached
735 * to this nfs_client.
737 int nfs_delegations_present(struct nfs_client *clp)
739 struct nfs_server *server;
740 int ret = 0;
742 rcu_read_lock();
743 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
744 if (!list_empty(&server->delegations)) {
745 ret = 1;
746 break;
748 rcu_read_unlock();
749 return ret;
753 * nfs4_copy_delegation_stateid - Copy inode's state ID information
754 * @dst: stateid data structure to fill in
755 * @inode: inode to check
756 * @flags: delegation type requirement
758 * Returns "true" and fills in "dst->data" * if inode had a delegation,
759 * otherwise "false" is returned.
761 bool nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode,
762 fmode_t flags)
764 struct nfs_inode *nfsi = NFS_I(inode);
765 struct nfs_delegation *delegation;
766 bool ret;
768 flags &= FMODE_READ|FMODE_WRITE;
769 rcu_read_lock();
770 delegation = rcu_dereference(nfsi->delegation);
771 ret = (delegation != NULL && (delegation->type & flags) == flags);
772 if (ret) {
773 nfs4_stateid_copy(dst, &delegation->stateid);
774 nfs_mark_delegation_referenced(delegation);
776 rcu_read_unlock();
777 return ret;