blob: db3811af079691bf8524bd85783bb321edfc1fe7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 */
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/mm.h>
42#include <linux/pagemap.h>
43#include <linux/sunrpc/sched.h>
44#include <linux/sunrpc/clnt.h>
45
46#include <linux/nfs.h>
47#include <linux/nfs4.h>
48#include <linux/nfs_fs.h>
Trond Myklebust4ce79712005-06-22 17:16:21 +000049#include "nfs4_fs.h"
Trond Myklebust58d97142006-01-03 09:55:24 +010050#include "delegation.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Chuck Levere3c0fb72012-05-21 22:45:24 -040052#define NFSDBG_FACILITY NFSDBG_STATE
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54void
David Howells65f27f32006-11-22 14:55:48 +000055nfs4_renew_state(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
Trond Myklebustc48f4f32010-06-16 09:52:27 -040057 const struct nfs4_state_maintenance_ops *ops;
David Howells65f27f32006-11-22 14:55:48 +000058 struct nfs_client *clp =
59 container_of(work, struct nfs_client, cl_renewd.work);
NeilBrowna52458b2018-12-03 11:30:31 +110060 const struct cred *cred;
Alexandros Batsakisdc96aef2010-02-05 03:45:04 -080061 long lease;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 unsigned long last, now;
Trond Myklebust2f60ea62011-08-24 15:07:37 -040063 unsigned renew_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Trond Myklebustc48f4f32010-06-16 09:52:27 -040065 ops = clp->cl_mvops->state_renewal_ops;
Harvey Harrison3110ff82008-05-02 13:42:44 -070066 dprintk("%s: start\n", __func__);
Chuck Leverfca5238e2010-12-24 01:32:32 +000067
Andy Adamsond3b4c9d2011-03-01 01:34:10 +000068 if (test_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state))
Trond Myklebust58d97142006-01-03 09:55:24 +010069 goto out;
Chuck Leverfca5238e2010-12-24 01:32:32 +000070
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 lease = clp->cl_lease_time;
72 last = clp->cl_last_renewal;
73 now = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 /* Are we close to a lease timeout? */
Trond Myklebust2f60ea62011-08-24 15:07:37 -040075 if (time_after(now, last + lease/3))
76 renew_flags |= NFS4_RENEW_TIMEOUT;
77 if (nfs_delegations_present(clp))
78 renew_flags |= NFS4_RENEW_DELEGATION_CB;
79
80 if (renew_flags != 0) {
NeilBrownf15e1e82018-12-03 11:30:30 +110081 cred = ops->get_state_renewal_cred(clp);
Trond Myklebustb0d3ded2008-12-23 15:21:50 -050082 if (cred == NULL) {
Trond Myklebust2f60ea62011-08-24 15:07:37 -040083 if (!(renew_flags & NFS4_RENEW_DELEGATION_CB)) {
Trond Myklebustb0d3ded2008-12-23 15:21:50 -050084 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
85 goto out;
86 }
87 nfs_expire_all_delegations(clp);
88 } else {
Andy Adamsond1f456b2014-09-29 12:31:57 -040089 int ret;
90
Trond Myklebustb0d3ded2008-12-23 15:21:50 -050091 /* Queue an asynchronous RENEW. */
Andy Adamsond1f456b2014-09-29 12:31:57 -040092 ret = ops->sched_state_renewal(clp, cred, renew_flags);
NeilBrowna52458b2018-12-03 11:30:31 +110093 put_cred(cred);
Andy Adamsond1f456b2014-09-29 12:31:57 -040094 switch (ret) {
95 default:
96 goto out_exp;
97 case -EAGAIN:
98 case -ENOMEM:
99 break;
100 }
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500101 }
Alexandros Batsakisdc96aef2010-02-05 03:45:04 -0800102 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 dprintk("%s: failed to call renewd. Reason: lease not expired \n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700104 __func__);
Alexandros Batsakisdc96aef2010-02-05 03:45:04 -0800105 }
106 nfs4_schedule_state_renewal(clp);
107out_exp:
Trond Myklebustb7391f42008-12-23 15:21:52 -0500108 nfs_expire_unreferenced_delegations(clp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109out:
Harvey Harrison3110ff82008-05-02 13:42:44 -0700110 dprintk("%s: done\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111}
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113void
David Howellsadfa6f92006-08-22 20:06:08 -0400114nfs4_schedule_state_renewal(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
116 long timeout;
117
118 spin_lock(&clp->cl_lock);
119 timeout = (2 * clp->cl_lease_time) / 3 + (long)clp->cl_last_renewal
120 - (long)jiffies;
121 if (timeout < 5 * HZ)
122 timeout = 5 * HZ;
123 dprintk("%s: requeueing work. Lease period = %ld\n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700124 __func__, (timeout + HZ - 1) / HZ);
Tejun Heo41f63c52012-08-03 10:30:47 -0700125 mod_delayed_work(system_wq, &clp->cl_renewd, timeout);
Trond Myklebust5dd31772006-08-24 01:03:05 -0400126 set_bit(NFS_CS_RENEWD, &clp->cl_res_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 spin_unlock(&clp->cl_lock);
128}
129
130void
David Howellsadfa6f92006-08-22 20:06:08 -0400131nfs4_kill_renewd(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Trond Myklebust3d39c692007-08-07 15:28:33 -0400133 cancel_delayed_work_sync(&clp->cl_renewd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134}
135
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400136/**
137 * nfs4_set_lease_period - Sets the lease period on a nfs_client
138 *
139 * @clp: pointer to nfs_client
140 * @lease: new value for lease period
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400141 */
142void nfs4_set_lease_period(struct nfs_client *clp,
Robert Milkowski7dc29932020-01-30 09:43:25 +0000143 unsigned long lease)
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400144{
145 spin_lock(&clp->cl_lock);
146 clp->cl_lease_time = lease;
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400147 spin_unlock(&clp->cl_lock);
Trond Myklebust8d480322016-08-05 19:03:31 -0400148
149 /* Cap maximum reconnect timeout at 1/2 lease period */
Trond Myklebust26ae1022017-02-08 11:17:55 -0500150 rpc_set_connect_timeout(clp->cl_rpcclient, lease, lease >> 1);
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400151}