WorkStruct: Pass the work_struct pointer instead of context data
[linux-3.10.git] / fs / nfs / nfs4renewd.c
1 /*
2  *  fs/nfs/nfs4renewd.c
3  *
4  *  Copyright (c) 2002 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Kendrick Smith <kmsmith@umich.edu>
8  *
9  *  Redistribution and use in source and binary forms, with or without
10  *  modification, are permitted provided that the following conditions
11  *  are met:
12  *
13  *  1. Redistributions of source code must retain the above copyright
14  *     notice, this list of conditions and the following disclaimer.
15  *  2. Redistributions in binary form must reproduce the above copyright
16  *     notice, this list of conditions and the following disclaimer in the
17  *     documentation and/or other materials provided with the distribution.
18  *  3. Neither the name of the University nor the names of its
19  *     contributors may be used to endorse or promote products derived
20  *     from this software without specific prior written permission.
21  *
22  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
23  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
29  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Implementation of the NFSv4 "renew daemon", which wakes up periodically to
35  * send a RENEW, to keep state alive on the server.  The daemon is implemented
36  * as an rpc_task, not a real kernel thread, so it always runs in rpciod's
37  * context.  There is one renewd per nfs_server.
38  *
39  * TODO: If the send queue gets backlogged (e.g., if the server goes down),
40  * we will keep filling the queue with periodic RENEW requests.  We need a
41  * mechanism for ensuring that if renewd successfully sends off a request,
42  * then it only wakes up when the request is finished.  Maybe use the
43  * child task framework of the RPC layer?
44  */
45
46 #include <linux/sched.h>
47 #include <linux/smp_lock.h>
48 #include <linux/mm.h>
49 #include <linux/pagemap.h>
50 #include <linux/sunrpc/sched.h>
51 #include <linux/sunrpc/clnt.h>
52
53 #include <linux/nfs.h>
54 #include <linux/nfs4.h>
55 #include <linux/nfs_fs.h>
56 #include "nfs4_fs.h"
57 #include "delegation.h"
58
59 #define NFSDBG_FACILITY NFSDBG_PROC
60
61 void
62 nfs4_renew_state(struct work_struct *work)
63 {
64         struct nfs_client *clp =
65                 container_of(work, struct nfs_client, cl_renewd.work);
66         struct rpc_cred *cred;
67         long lease, timeout;
68         unsigned long last, now;
69
70         down_read(&clp->cl_sem);
71         dprintk("%s: start\n", __FUNCTION__);
72         /* Are there any active superblocks? */
73         if (list_empty(&clp->cl_superblocks))
74                 goto out;
75         spin_lock(&clp->cl_lock);
76         lease = clp->cl_lease_time;
77         last = clp->cl_last_renewal;
78         now = jiffies;
79         timeout = (2 * lease) / 3 + (long)last - (long)now;
80         /* Are we close to a lease timeout? */
81         if (time_after(now, last + lease/3)) {
82                 cred = nfs4_get_renew_cred(clp);
83                 if (cred == NULL) {
84                         set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
85                         spin_unlock(&clp->cl_lock);
86                         nfs_expire_all_delegations(clp);
87                         goto out;
88                 }
89                 spin_unlock(&clp->cl_lock);
90                 /* Queue an asynchronous RENEW. */
91                 nfs4_proc_async_renew(clp, cred);
92                 put_rpccred(cred);
93                 timeout = (2 * lease) / 3;
94                 spin_lock(&clp->cl_lock);
95         } else
96                 dprintk("%s: failed to call renewd. Reason: lease not expired \n",
97                                 __FUNCTION__);
98         if (timeout < 5 * HZ)    /* safeguard */
99                 timeout = 5 * HZ;
100         dprintk("%s: requeueing work. Lease period = %ld\n",
101                         __FUNCTION__, (timeout + HZ - 1) / HZ);
102         cancel_delayed_work(&clp->cl_renewd);
103         schedule_delayed_work(&clp->cl_renewd, timeout);
104         spin_unlock(&clp->cl_lock);
105 out:
106         up_read(&clp->cl_sem);
107         dprintk("%s: done\n", __FUNCTION__);
108 }
109
110 /* Must be called with clp->cl_sem locked for writes */
111 void
112 nfs4_schedule_state_renewal(struct nfs_client *clp)
113 {
114         long timeout;
115
116         spin_lock(&clp->cl_lock);
117         timeout = (2 * clp->cl_lease_time) / 3 + (long)clp->cl_last_renewal
118                 - (long)jiffies;
119         if (timeout < 5 * HZ)
120                 timeout = 5 * HZ;
121         dprintk("%s: requeueing work. Lease period = %ld\n",
122                         __FUNCTION__, (timeout + HZ - 1) / HZ);
123         cancel_delayed_work(&clp->cl_renewd);
124         schedule_delayed_work(&clp->cl_renewd, timeout);
125         set_bit(NFS_CS_RENEWD, &clp->cl_res_state);
126         spin_unlock(&clp->cl_lock);
127 }
128
129 void
130 nfs4_renewd_prepare_shutdown(struct nfs_server *server)
131 {
132         flush_scheduled_work();
133 }
134
135 void
136 nfs4_kill_renewd(struct nfs_client *clp)
137 {
138         down_read(&clp->cl_sem);
139         cancel_delayed_work(&clp->cl_renewd);
140         up_read(&clp->cl_sem);
141         flush_scheduled_work();
142 }
143
144 /*
145  * Local variables:
146  *   c-basic-offset: 8
147  * End:
148  */