2 * linux/fs/nfs/delegation.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFS file delegation management
9 #include <linux/completion.h>
10 #include <linux/kthread.h>
11 #include <linux/module.h>
12 #include <linux/sched.h>
13 #include <linux/spinlock.h>
15 #include <linux/nfs4.h>
16 #include <linux/nfs_fs.h>
17 #include <linux/nfs_xdr.h>
20 #include "delegation.h"
23 static void nfs_do_free_delegation(struct nfs_delegation *delegation)
28 static void nfs_free_delegation_callback(struct rcu_head *head)
30 struct nfs_delegation *delegation = container_of(head, struct nfs_delegation, rcu);
32 nfs_do_free_delegation(delegation);
35 static void nfs_free_delegation(struct nfs_delegation *delegation)
37 struct rpc_cred *cred;
39 cred = rcu_dereference(delegation->cred);
40 rcu_assign_pointer(delegation->cred, NULL);
41 call_rcu(&delegation->rcu, nfs_free_delegation_callback);
46 static int nfs_delegation_claim_locks(struct nfs_open_context *ctx, struct nfs4_state *state)
48 struct inode *inode = state->inode;
52 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
53 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
55 if (nfs_file_open_context(fl->fl_file) != ctx)
57 status = nfs4_lock_delegation_recall(state, fl);
62 printk(KERN_ERR "%s: unhandled error %d.\n",
64 case -NFS4ERR_EXPIRED:
65 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
66 case -NFS4ERR_STALE_CLIENTID:
67 nfs4_schedule_state_recovery(NFS_SERVER(inode)->nfs_client);
76 static void nfs_delegation_claim_opens(struct inode *inode, const nfs4_stateid *stateid)
78 struct nfs_inode *nfsi = NFS_I(inode);
79 struct nfs_open_context *ctx;
80 struct nfs4_state *state;
84 spin_lock(&inode->i_lock);
85 list_for_each_entry(ctx, &nfsi->open_files, list) {
89 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
91 if (memcmp(state->stateid.data, stateid->data, sizeof(state->stateid.data)) != 0)
93 get_nfs_open_context(ctx);
94 spin_unlock(&inode->i_lock);
95 err = nfs4_open_delegation_recall(ctx, state, stateid);
97 err = nfs_delegation_claim_locks(ctx, state);
98 put_nfs_open_context(ctx);
103 spin_unlock(&inode->i_lock);
107 * Set up a delegation on an inode
109 void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
111 struct nfs_delegation *delegation = NFS_I(inode)->delegation;
112 struct rpc_cred *oldcred;
114 if (delegation == NULL)
116 memcpy(delegation->stateid.data, res->delegation.data,
117 sizeof(delegation->stateid.data));
118 delegation->type = res->delegation_type;
119 delegation->maxsize = res->maxsize;
120 oldcred = delegation->cred;
121 delegation->cred = get_rpccred(cred);
122 clear_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
123 NFS_I(inode)->delegation_state = delegation->type;
125 put_rpccred(oldcred);
128 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
132 res = nfs4_proc_delegreturn(inode, delegation->cred, &delegation->stateid, issync);
133 nfs_free_delegation(delegation);
137 static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
139 struct inode *inode = NULL;
141 spin_lock(&delegation->lock);
142 if (delegation->inode != NULL)
143 inode = igrab(delegation->inode);
144 spin_unlock(&delegation->lock);
148 static struct nfs_delegation *nfs_detach_delegation_locked(struct nfs_inode *nfsi, const nfs4_stateid *stateid)
150 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
152 if (delegation == NULL)
154 spin_lock(&delegation->lock);
155 if (stateid != NULL && memcmp(delegation->stateid.data, stateid->data,
156 sizeof(delegation->stateid.data)) != 0)
158 list_del_rcu(&delegation->super_list);
159 delegation->inode = NULL;
160 nfsi->delegation_state = 0;
161 rcu_assign_pointer(nfsi->delegation, NULL);
162 spin_unlock(&delegation->lock);
165 spin_unlock(&delegation->lock);
171 * Set up a delegation on an inode
173 int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
175 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
176 struct nfs_inode *nfsi = NFS_I(inode);
177 struct nfs_delegation *delegation;
178 struct nfs_delegation *freeme = NULL;
181 delegation = kmalloc(sizeof(*delegation), GFP_KERNEL);
182 if (delegation == NULL)
184 memcpy(delegation->stateid.data, res->delegation.data,
185 sizeof(delegation->stateid.data));
186 delegation->type = res->delegation_type;
187 delegation->maxsize = res->maxsize;
188 delegation->change_attr = nfsi->change_attr;
189 delegation->cred = get_rpccred(cred);
190 delegation->inode = inode;
191 spin_lock_init(&delegation->lock);
193 spin_lock(&clp->cl_lock);
194 if (rcu_dereference(nfsi->delegation) != NULL) {
195 if (memcmp(&delegation->stateid, &nfsi->delegation->stateid,
196 sizeof(delegation->stateid)) == 0 &&
197 delegation->type == nfsi->delegation->type) {
201 * Deal with broken servers that hand out two
202 * delegations for the same file.
204 dfprintk(FILE, "%s: server %s handed out "
205 "a duplicate delegation!\n",
206 __func__, clp->cl_hostname);
207 if (delegation->type <= nfsi->delegation->type) {
212 freeme = nfs_detach_delegation_locked(nfsi, NULL);
214 list_add_rcu(&delegation->super_list, &clp->cl_delegations);
215 nfsi->delegation_state = delegation->type;
216 rcu_assign_pointer(nfsi->delegation, delegation);
219 /* Ensure we revalidate the attributes and page cache! */
220 spin_lock(&inode->i_lock);
221 nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
222 spin_unlock(&inode->i_lock);
225 spin_unlock(&clp->cl_lock);
226 if (delegation != NULL)
227 nfs_free_delegation(delegation);
229 nfs_do_return_delegation(inode, freeme, 0);
233 /* Sync all data to disk upon delegation return */
234 static void nfs_msync_inode(struct inode *inode)
236 filemap_fdatawrite(inode->i_mapping);
238 filemap_fdatawait(inode->i_mapping);
242 * Basic procedure for returning a delegation to the server
244 static int __nfs_inode_return_delegation(struct inode *inode, struct nfs_delegation *delegation)
246 struct nfs_inode *nfsi = NFS_I(inode);
248 nfs_msync_inode(inode);
249 /* Guard against new delegated open calls */
250 down_write(&nfsi->rwsem);
251 nfs_delegation_claim_opens(inode, &delegation->stateid);
252 up_write(&nfsi->rwsem);
253 nfs_msync_inode(inode);
255 return nfs_do_return_delegation(inode, delegation, 1);
259 * Return all delegations that have been marked for return
261 static void nfs_client_return_marked_delegations(struct nfs_client *clp)
263 struct nfs_delegation *delegation;
268 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
269 if (!test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
271 inode = nfs_delegation_grab_inode(delegation);
274 spin_lock(&clp->cl_lock);
275 delegation = nfs_detach_delegation_locked(NFS_I(inode), NULL);
276 spin_unlock(&clp->cl_lock);
278 if (delegation != NULL)
279 __nfs_inode_return_delegation(inode, delegation);
287 * This function returns the delegation without reclaiming opens
288 * or protecting against delegation reclaims.
289 * It is therefore really only safe to be called from
292 void nfs_inode_return_delegation_noreclaim(struct inode *inode)
294 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
295 struct nfs_inode *nfsi = NFS_I(inode);
296 struct nfs_delegation *delegation;
298 if (rcu_dereference(nfsi->delegation) != NULL) {
299 spin_lock(&clp->cl_lock);
300 delegation = nfs_detach_delegation_locked(nfsi, NULL);
301 spin_unlock(&clp->cl_lock);
302 if (delegation != NULL)
303 nfs_do_return_delegation(inode, delegation, 0);
307 int nfs_inode_return_delegation(struct inode *inode)
309 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
310 struct nfs_inode *nfsi = NFS_I(inode);
311 struct nfs_delegation *delegation;
314 if (rcu_dereference(nfsi->delegation) != NULL) {
315 spin_lock(&clp->cl_lock);
316 delegation = nfs_detach_delegation_locked(nfsi, NULL);
317 spin_unlock(&clp->cl_lock);
318 if (delegation != NULL)
319 err = __nfs_inode_return_delegation(inode, delegation);
325 * Return all delegations associated to a super block
327 void nfs_super_return_all_delegations(struct super_block *sb)
329 struct nfs_client *clp = NFS_SB(sb)->nfs_client;
330 struct nfs_delegation *delegation;
335 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
336 spin_lock(&delegation->lock);
337 if (delegation->inode != NULL && delegation->inode->i_sb == sb)
338 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
339 spin_unlock(&delegation->lock);
342 nfs_client_return_marked_delegations(clp);
345 static void nfs_client_return_all_delegations(struct nfs_client *clp)
347 struct nfs_delegation *delegation;
350 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list)
351 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
353 nfs_client_return_marked_delegations(clp);
356 static int nfs_do_expire_all_delegations(void *ptr)
358 struct nfs_client *clp = ptr;
360 allow_signal(SIGKILL);
362 if (test_bit(NFS4CLNT_STATE_RECOVER, &clp->cl_state) != 0)
364 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0)
366 nfs_client_return_all_delegations(clp);
369 module_put_and_exit(0);
372 void nfs_expire_all_delegations(struct nfs_client *clp)
374 struct task_struct *task;
376 __module_get(THIS_MODULE);
377 atomic_inc(&clp->cl_count);
378 task = kthread_run(nfs_do_expire_all_delegations, clp,
380 rpc_peeraddr2str(clp->cl_rpcclient,
385 module_put(THIS_MODULE);
389 * Return all delegations following an NFS4ERR_CB_PATH_DOWN error.
391 void nfs_handle_cb_pathdown(struct nfs_client *clp)
395 nfs_client_return_all_delegations(clp);
398 struct recall_threadargs {
400 struct nfs_client *clp;
401 const nfs4_stateid *stateid;
403 struct completion started;
407 static int recall_thread(void *data)
409 struct recall_threadargs *args = (struct recall_threadargs *)data;
410 struct inode *inode = igrab(args->inode);
411 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
412 struct nfs_inode *nfsi = NFS_I(inode);
413 struct nfs_delegation *delegation;
415 daemonize("nfsv4-delegreturn");
417 nfs_msync_inode(inode);
418 down_write(&nfsi->rwsem);
419 spin_lock(&clp->cl_lock);
420 delegation = nfs_detach_delegation_locked(nfsi, args->stateid);
421 if (delegation != NULL)
424 args->result = -ENOENT;
425 spin_unlock(&clp->cl_lock);
426 complete(&args->started);
427 nfs_delegation_claim_opens(inode, args->stateid);
428 up_write(&nfsi->rwsem);
429 nfs_msync_inode(inode);
431 if (delegation != NULL)
432 nfs_do_return_delegation(inode, delegation, 1);
434 module_put_and_exit(0);
438 * Asynchronous delegation recall!
440 int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid)
442 struct recall_threadargs data = {
448 init_completion(&data.started);
449 __module_get(THIS_MODULE);
450 status = kernel_thread(recall_thread, &data, CLONE_KERNEL);
453 wait_for_completion(&data.started);
456 module_put(THIS_MODULE);
461 * Retrieve the inode associated with a delegation
463 struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle)
465 struct nfs_delegation *delegation;
466 struct inode *res = NULL;
468 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
469 spin_lock(&delegation->lock);
470 if (delegation->inode != NULL &&
471 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
472 res = igrab(delegation->inode);
474 spin_unlock(&delegation->lock);
483 * Mark all delegations as needing to be reclaimed
485 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
487 struct nfs_delegation *delegation;
489 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list)
490 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
495 * Reap all unclaimed delegations after reboot recovery is done
497 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
499 struct nfs_delegation *delegation;
503 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
504 if (test_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags) == 0)
506 inode = nfs_delegation_grab_inode(delegation);
509 spin_lock(&clp->cl_lock);
510 delegation = nfs_detach_delegation_locked(NFS_I(inode), NULL);
511 spin_unlock(&clp->cl_lock);
513 if (delegation != NULL)
514 nfs_free_delegation(delegation);
521 int nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode)
523 struct nfs_inode *nfsi = NFS_I(inode);
524 struct nfs_delegation *delegation;
528 delegation = rcu_dereference(nfsi->delegation);
529 if (delegation != NULL) {
530 memcpy(dst->data, delegation->stateid.data, sizeof(dst->data));