2 * linux/fs/nfs/delegation.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFS file delegation management
9 #include <linux/config.h>
10 #include <linux/completion.h>
11 #include <linux/kthread.h>
12 #include <linux/module.h>
13 #include <linux/sched.h>
14 #include <linux/spinlock.h>
16 #include <linux/nfs4.h>
17 #include <linux/nfs_fs.h>
18 #include <linux/nfs_xdr.h>
21 #include "delegation.h"
23 static struct nfs_delegation
*nfs_alloc_delegation(void)
25 return (struct nfs_delegation
*)kmalloc(sizeof(struct nfs_delegation
), GFP_KERNEL
);
28 static void nfs_free_delegation(struct nfs_delegation
*delegation
)
31 put_rpccred(delegation
->cred
);
35 static int nfs_delegation_claim_locks(struct nfs_open_context
*ctx
, struct nfs4_state
*state
)
37 struct inode
*inode
= state
->inode
;
41 for (fl
= inode
->i_flock
; fl
!= 0; fl
= fl
->fl_next
) {
42 if (!(fl
->fl_flags
& (FL_POSIX
|FL_FLOCK
)))
44 if ((struct nfs_open_context
*)fl
->fl_file
->private_data
!= ctx
)
46 status
= nfs4_lock_delegation_recall(state
, fl
);
51 printk(KERN_ERR
"%s: unhandled error %d.\n",
52 __FUNCTION__
, status
);
53 case -NFS4ERR_EXPIRED
:
54 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
55 case -NFS4ERR_STALE_CLIENTID
:
56 nfs4_schedule_state_recovery(NFS_SERVER(inode
)->nfs4_state
);
65 static void nfs_delegation_claim_opens(struct inode
*inode
)
67 struct nfs_inode
*nfsi
= NFS_I(inode
);
68 struct nfs_open_context
*ctx
;
69 struct nfs4_state
*state
;
73 spin_lock(&inode
->i_lock
);
74 list_for_each_entry(ctx
, &nfsi
->open_files
, list
) {
78 if (!test_bit(NFS_DELEGATED_STATE
, &state
->flags
))
80 get_nfs_open_context(ctx
);
81 spin_unlock(&inode
->i_lock
);
82 err
= nfs4_open_delegation_recall(ctx
->dentry
, state
);
84 err
= nfs_delegation_claim_locks(ctx
, state
);
85 put_nfs_open_context(ctx
);
90 spin_unlock(&inode
->i_lock
);
94 * Set up a delegation on an inode
96 void nfs_inode_reclaim_delegation(struct inode
*inode
, struct rpc_cred
*cred
, struct nfs_openres
*res
)
98 struct nfs_delegation
*delegation
= NFS_I(inode
)->delegation
;
100 if (delegation
== NULL
)
102 memcpy(delegation
->stateid
.data
, res
->delegation
.data
,
103 sizeof(delegation
->stateid
.data
));
104 delegation
->type
= res
->delegation_type
;
105 delegation
->maxsize
= res
->maxsize
;
107 delegation
->cred
= get_rpccred(cred
);
108 delegation
->flags
&= ~NFS_DELEGATION_NEED_RECLAIM
;
109 NFS_I(inode
)->delegation_state
= delegation
->type
;
114 * Set up a delegation on an inode
116 int nfs_inode_set_delegation(struct inode
*inode
, struct rpc_cred
*cred
, struct nfs_openres
*res
)
118 struct nfs4_client
*clp
= NFS_SERVER(inode
)->nfs4_state
;
119 struct nfs_inode
*nfsi
= NFS_I(inode
);
120 struct nfs_delegation
*delegation
;
123 /* Ensure we first revalidate the attributes and page cache! */
124 if ((nfsi
->cache_validity
& (NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_ATTR
)))
125 __nfs_revalidate_inode(NFS_SERVER(inode
), inode
);
127 delegation
= nfs_alloc_delegation();
128 if (delegation
== NULL
)
130 memcpy(delegation
->stateid
.data
, res
->delegation
.data
,
131 sizeof(delegation
->stateid
.data
));
132 delegation
->type
= res
->delegation_type
;
133 delegation
->maxsize
= res
->maxsize
;
134 delegation
->change_attr
= nfsi
->change_attr
;
135 delegation
->cred
= get_rpccred(cred
);
136 delegation
->inode
= inode
;
138 spin_lock(&clp
->cl_lock
);
139 if (nfsi
->delegation
== NULL
) {
140 list_add(&delegation
->super_list
, &clp
->cl_delegations
);
141 nfsi
->delegation
= delegation
;
142 nfsi
->delegation_state
= delegation
->type
;
145 if (memcmp(&delegation
->stateid
, &nfsi
->delegation
->stateid
,
146 sizeof(delegation
->stateid
)) != 0 ||
147 delegation
->type
!= nfsi
->delegation
->type
) {
148 printk("%s: server %u.%u.%u.%u, handed out a duplicate delegation!\n",
149 __FUNCTION__
, NIPQUAD(clp
->cl_addr
));
153 spin_unlock(&clp
->cl_lock
);
158 static int nfs_do_return_delegation(struct inode
*inode
, struct nfs_delegation
*delegation
)
162 __nfs_revalidate_inode(NFS_SERVER(inode
), inode
);
164 res
= nfs4_proc_delegreturn(inode
, delegation
->cred
, &delegation
->stateid
);
165 nfs_free_delegation(delegation
);
169 /* Sync all data to disk upon delegation return */
170 static void nfs_msync_inode(struct inode
*inode
)
172 filemap_fdatawrite(inode
->i_mapping
);
174 filemap_fdatawait(inode
->i_mapping
);
178 * Basic procedure for returning a delegation to the server
180 int __nfs_inode_return_delegation(struct inode
*inode
)
182 struct nfs4_client
*clp
= NFS_SERVER(inode
)->nfs4_state
;
183 struct nfs_inode
*nfsi
= NFS_I(inode
);
184 struct nfs_delegation
*delegation
;
187 nfs_msync_inode(inode
);
188 down_read(&clp
->cl_sem
);
189 /* Guard against new delegated open calls */
190 down_write(&nfsi
->rwsem
);
191 spin_lock(&clp
->cl_lock
);
192 delegation
= nfsi
->delegation
;
193 if (delegation
!= NULL
) {
194 list_del_init(&delegation
->super_list
);
195 nfsi
->delegation
= NULL
;
196 nfsi
->delegation_state
= 0;
198 spin_unlock(&clp
->cl_lock
);
199 nfs_delegation_claim_opens(inode
);
200 up_write(&nfsi
->rwsem
);
201 up_read(&clp
->cl_sem
);
202 nfs_msync_inode(inode
);
204 if (delegation
!= NULL
)
205 res
= nfs_do_return_delegation(inode
, delegation
);
210 * Return all delegations associated to a super block
212 void nfs_return_all_delegations(struct super_block
*sb
)
214 struct nfs4_client
*clp
= NFS_SB(sb
)->nfs4_state
;
215 struct nfs_delegation
*delegation
;
221 spin_lock(&clp
->cl_lock
);
222 list_for_each_entry(delegation
, &clp
->cl_delegations
, super_list
) {
223 if (delegation
->inode
->i_sb
!= sb
)
225 inode
= igrab(delegation
->inode
);
228 spin_unlock(&clp
->cl_lock
);
229 nfs_inode_return_delegation(inode
);
233 spin_unlock(&clp
->cl_lock
);
236 int nfs_do_expire_all_delegations(void *ptr
)
238 struct nfs4_client
*clp
= ptr
;
239 struct nfs_delegation
*delegation
;
243 allow_signal(SIGKILL
);
245 spin_lock(&clp
->cl_lock
);
246 if (test_bit(NFS4CLNT_STATE_RECOVER
, &clp
->cl_state
) != 0)
248 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
) == 0)
250 list_for_each_entry(delegation
, &clp
->cl_delegations
, super_list
) {
251 inode
= igrab(delegation
->inode
);
254 spin_unlock(&clp
->cl_lock
);
255 err
= nfs_inode_return_delegation(inode
);
261 spin_unlock(&clp
->cl_lock
);
262 nfs4_put_client(clp
);
263 module_put_and_exit(0);
266 void nfs_expire_all_delegations(struct nfs4_client
*clp
)
268 struct task_struct
*task
;
270 __module_get(THIS_MODULE
);
271 atomic_inc(&clp
->cl_count
);
272 task
= kthread_run(nfs_do_expire_all_delegations
, clp
,
273 "%u.%u.%u.%u-delegreturn",
274 NIPQUAD(clp
->cl_addr
));
277 nfs4_put_client(clp
);
278 module_put(THIS_MODULE
);
282 * Return all delegations following an NFS4ERR_CB_PATH_DOWN error.
284 void nfs_handle_cb_pathdown(struct nfs4_client
*clp
)
286 struct nfs_delegation
*delegation
;
292 spin_lock(&clp
->cl_lock
);
293 list_for_each_entry(delegation
, &clp
->cl_delegations
, super_list
) {
294 inode
= igrab(delegation
->inode
);
297 spin_unlock(&clp
->cl_lock
);
298 nfs_inode_return_delegation(inode
);
302 spin_unlock(&clp
->cl_lock
);
305 struct recall_threadargs
{
307 struct nfs4_client
*clp
;
308 const nfs4_stateid
*stateid
;
310 struct completion started
;
314 static int recall_thread(void *data
)
316 struct recall_threadargs
*args
= (struct recall_threadargs
*)data
;
317 struct inode
*inode
= igrab(args
->inode
);
318 struct nfs4_client
*clp
= NFS_SERVER(inode
)->nfs4_state
;
319 struct nfs_inode
*nfsi
= NFS_I(inode
);
320 struct nfs_delegation
*delegation
;
322 daemonize("nfsv4-delegreturn");
324 nfs_msync_inode(inode
);
325 down_read(&clp
->cl_sem
);
326 down_write(&nfsi
->rwsem
);
327 spin_lock(&clp
->cl_lock
);
328 delegation
= nfsi
->delegation
;
329 if (delegation
!= NULL
&& memcmp(delegation
->stateid
.data
,
331 sizeof(delegation
->stateid
.data
)) == 0) {
332 list_del_init(&delegation
->super_list
);
333 nfsi
->delegation
= NULL
;
334 nfsi
->delegation_state
= 0;
338 args
->result
= -ENOENT
;
340 spin_unlock(&clp
->cl_lock
);
341 complete(&args
->started
);
342 nfs_delegation_claim_opens(inode
);
343 up_write(&nfsi
->rwsem
);
344 up_read(&clp
->cl_sem
);
345 nfs_msync_inode(inode
);
347 if (delegation
!= NULL
)
348 nfs_do_return_delegation(inode
, delegation
);
350 module_put_and_exit(0);
354 * Asynchronous delegation recall!
356 int nfs_async_inode_return_delegation(struct inode
*inode
, const nfs4_stateid
*stateid
)
358 struct recall_threadargs data
= {
364 init_completion(&data
.started
);
365 __module_get(THIS_MODULE
);
366 status
= kernel_thread(recall_thread
, &data
, CLONE_KERNEL
);
369 wait_for_completion(&data
.started
);
372 module_put(THIS_MODULE
);
377 * Retrieve the inode associated with a delegation
379 struct inode
*nfs_delegation_find_inode(struct nfs4_client
*clp
, const struct nfs_fh
*fhandle
)
381 struct nfs_delegation
*delegation
;
382 struct inode
*res
= NULL
;
383 spin_lock(&clp
->cl_lock
);
384 list_for_each_entry(delegation
, &clp
->cl_delegations
, super_list
) {
385 if (nfs_compare_fh(fhandle
, &NFS_I(delegation
->inode
)->fh
) == 0) {
386 res
= igrab(delegation
->inode
);
390 spin_unlock(&clp
->cl_lock
);
395 * Mark all delegations as needing to be reclaimed
397 void nfs_delegation_mark_reclaim(struct nfs4_client
*clp
)
399 struct nfs_delegation
*delegation
;
400 spin_lock(&clp
->cl_lock
);
401 list_for_each_entry(delegation
, &clp
->cl_delegations
, super_list
)
402 delegation
->flags
|= NFS_DELEGATION_NEED_RECLAIM
;
403 spin_unlock(&clp
->cl_lock
);
407 * Reap all unclaimed delegations after reboot recovery is done
409 void nfs_delegation_reap_unclaimed(struct nfs4_client
*clp
)
411 struct nfs_delegation
*delegation
, *n
;
413 spin_lock(&clp
->cl_lock
);
414 list_for_each_entry_safe(delegation
, n
, &clp
->cl_delegations
, super_list
) {
415 if ((delegation
->flags
& NFS_DELEGATION_NEED_RECLAIM
) == 0)
417 list_move(&delegation
->super_list
, &head
);
418 NFS_I(delegation
->inode
)->delegation
= NULL
;
419 NFS_I(delegation
->inode
)->delegation_state
= 0;
421 spin_unlock(&clp
->cl_lock
);
422 while(!list_empty(&head
)) {
423 delegation
= list_entry(head
.next
, struct nfs_delegation
, super_list
);
424 list_del(&delegation
->super_list
);
425 nfs_free_delegation(delegation
);