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 != 0; 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",
63 __FUNCTION__, status);
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 delegation->flags &= ~NFS_DELEGATION_NEED_RECLAIM;
123 NFS_I(inode)->delegation_state = delegation->type;
125 put_rpccred(oldcred);
129 * Set up a delegation on an inode
131 int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
133 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
134 struct nfs_inode *nfsi = NFS_I(inode);
135 struct nfs_delegation *delegation;
138 delegation = kmalloc(sizeof(*delegation), GFP_KERNEL);
139 if (delegation == NULL)
141 memcpy(delegation->stateid.data, res->delegation.data,
142 sizeof(delegation->stateid.data));
143 delegation->type = res->delegation_type;
144 delegation->maxsize = res->maxsize;
145 delegation->change_attr = nfsi->change_attr;
146 delegation->cred = get_rpccred(cred);
147 delegation->inode = inode;
149 spin_lock(&clp->cl_lock);
150 if (rcu_dereference(nfsi->delegation) == NULL) {
151 list_add_rcu(&delegation->super_list, &clp->cl_delegations);
152 nfsi->delegation_state = delegation->type;
153 rcu_assign_pointer(nfsi->delegation, delegation);
156 if (memcmp(&delegation->stateid, &nfsi->delegation->stateid,
157 sizeof(delegation->stateid)) != 0 ||
158 delegation->type != nfsi->delegation->type) {
159 printk(KERN_WARNING "%s: server %s handed out "
160 "a duplicate delegation!\n",
161 __FUNCTION__, clp->cl_hostname);
166 /* Ensure we revalidate the attributes and page cache! */
167 spin_lock(&inode->i_lock);
168 nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
169 spin_unlock(&inode->i_lock);
171 spin_unlock(&clp->cl_lock);
172 if (delegation != NULL)
173 nfs_free_delegation(delegation);
177 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation)
181 res = nfs4_proc_delegreturn(inode, delegation->cred, &delegation->stateid);
182 nfs_free_delegation(delegation);
186 /* Sync all data to disk upon delegation return */
187 static void nfs_msync_inode(struct inode *inode)
189 filemap_fdatawrite(inode->i_mapping);
191 filemap_fdatawait(inode->i_mapping);
195 * Basic procedure for returning a delegation to the server
197 static int __nfs_inode_return_delegation(struct inode *inode, struct nfs_delegation *delegation)
199 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
200 struct nfs_inode *nfsi = NFS_I(inode);
202 nfs_msync_inode(inode);
203 down_read(&clp->cl_sem);
204 /* Guard against new delegated open calls */
205 down_write(&nfsi->rwsem);
206 nfs_delegation_claim_opens(inode, &delegation->stateid);
207 up_write(&nfsi->rwsem);
208 up_read(&clp->cl_sem);
209 nfs_msync_inode(inode);
211 return nfs_do_return_delegation(inode, delegation);
214 static struct nfs_delegation *nfs_detach_delegation_locked(struct nfs_inode *nfsi, const nfs4_stateid *stateid)
216 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
218 if (delegation == NULL)
220 if (stateid != NULL && memcmp(delegation->stateid.data, stateid->data,
221 sizeof(delegation->stateid.data)) != 0)
223 list_del_rcu(&delegation->super_list);
224 nfsi->delegation_state = 0;
225 rcu_assign_pointer(nfsi->delegation, NULL);
231 int nfs_inode_return_delegation(struct inode *inode)
233 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
234 struct nfs_inode *nfsi = NFS_I(inode);
235 struct nfs_delegation *delegation;
238 if (rcu_dereference(nfsi->delegation) != NULL) {
239 spin_lock(&clp->cl_lock);
240 delegation = nfs_detach_delegation_locked(nfsi, NULL);
241 spin_unlock(&clp->cl_lock);
242 if (delegation != NULL)
243 err = __nfs_inode_return_delegation(inode, delegation);
249 * Return all delegations associated to a super block
251 void nfs_return_all_delegations(struct super_block *sb)
253 struct nfs_client *clp = NFS_SB(sb)->nfs_client;
254 struct nfs_delegation *delegation;
261 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
262 if (delegation->inode->i_sb != sb)
264 inode = igrab(delegation->inode);
267 spin_lock(&clp->cl_lock);
268 delegation = nfs_detach_delegation_locked(NFS_I(inode), NULL);
269 spin_unlock(&clp->cl_lock);
271 if (delegation != NULL)
272 __nfs_inode_return_delegation(inode, delegation);
279 static int nfs_do_expire_all_delegations(void *ptr)
281 struct nfs_client *clp = ptr;
282 struct nfs_delegation *delegation;
285 allow_signal(SIGKILL);
287 if (test_bit(NFS4CLNT_STATE_RECOVER, &clp->cl_state) != 0)
289 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0)
292 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
293 inode = igrab(delegation->inode);
296 spin_lock(&clp->cl_lock);
297 delegation = nfs_detach_delegation_locked(NFS_I(inode), NULL);
298 spin_unlock(&clp->cl_lock);
301 __nfs_inode_return_delegation(inode, delegation);
308 module_put_and_exit(0);
311 void nfs_expire_all_delegations(struct nfs_client *clp)
313 struct task_struct *task;
315 __module_get(THIS_MODULE);
316 atomic_inc(&clp->cl_count);
317 task = kthread_run(nfs_do_expire_all_delegations, clp,
319 rpc_peeraddr2str(clp->cl_rpcclient,
324 module_put(THIS_MODULE);
328 * Return all delegations following an NFS4ERR_CB_PATH_DOWN error.
330 void nfs_handle_cb_pathdown(struct nfs_client *clp)
332 struct nfs_delegation *delegation;
339 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
340 inode = igrab(delegation->inode);
343 spin_lock(&clp->cl_lock);
344 delegation = nfs_detach_delegation_locked(NFS_I(inode), NULL);
345 spin_unlock(&clp->cl_lock);
347 if (delegation != NULL)
348 __nfs_inode_return_delegation(inode, delegation);
355 struct recall_threadargs {
357 struct nfs_client *clp;
358 const nfs4_stateid *stateid;
360 struct completion started;
364 static int recall_thread(void *data)
366 struct recall_threadargs *args = (struct recall_threadargs *)data;
367 struct inode *inode = igrab(args->inode);
368 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
369 struct nfs_inode *nfsi = NFS_I(inode);
370 struct nfs_delegation *delegation;
372 daemonize("nfsv4-delegreturn");
374 nfs_msync_inode(inode);
375 down_read(&clp->cl_sem);
376 down_write(&nfsi->rwsem);
377 spin_lock(&clp->cl_lock);
378 delegation = nfs_detach_delegation_locked(nfsi, args->stateid);
379 if (delegation != NULL)
382 args->result = -ENOENT;
383 spin_unlock(&clp->cl_lock);
384 complete(&args->started);
385 nfs_delegation_claim_opens(inode, args->stateid);
386 up_write(&nfsi->rwsem);
387 up_read(&clp->cl_sem);
388 nfs_msync_inode(inode);
390 if (delegation != NULL)
391 nfs_do_return_delegation(inode, delegation);
393 module_put_and_exit(0);
397 * Asynchronous delegation recall!
399 int nfs_async_inode_return_delegation(struct inode *inode, const nfs4_stateid *stateid)
401 struct recall_threadargs data = {
407 init_completion(&data.started);
408 __module_get(THIS_MODULE);
409 status = kernel_thread(recall_thread, &data, CLONE_KERNEL);
412 wait_for_completion(&data.started);
415 module_put(THIS_MODULE);
420 * Retrieve the inode associated with a delegation
422 struct inode *nfs_delegation_find_inode(struct nfs_client *clp, const struct nfs_fh *fhandle)
424 struct nfs_delegation *delegation;
425 struct inode *res = NULL;
427 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
428 if (nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
429 res = igrab(delegation->inode);
438 * Mark all delegations as needing to be reclaimed
440 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
442 struct nfs_delegation *delegation;
444 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list)
445 delegation->flags |= NFS_DELEGATION_NEED_RECLAIM;
450 * Reap all unclaimed delegations after reboot recovery is done
452 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
454 struct nfs_delegation *delegation;
457 list_for_each_entry_rcu(delegation, &clp->cl_delegations, super_list) {
458 if ((delegation->flags & NFS_DELEGATION_NEED_RECLAIM) == 0)
460 spin_lock(&clp->cl_lock);
461 delegation = nfs_detach_delegation_locked(NFS_I(delegation->inode), NULL);
462 spin_unlock(&clp->cl_lock);
464 if (delegation != NULL)
465 nfs_free_delegation(delegation);
471 int nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode)
473 struct nfs_inode *nfsi = NFS_I(inode);
474 struct nfs_delegation *delegation;
478 delegation = rcu_dereference(nfsi->delegation);
479 if (delegation != NULL) {
480 memcpy(dst->data, delegation->stateid.data, sizeof(dst->data));