blob: ed3f9206a0ee87c914f133492f1f6011775bdef8 [file] [log] [blame]
NeilBrowna55370a2005-06-23 22:03:52 -07001/*
NeilBrowna55370a2005-06-23 22:03:52 -07002* Copyright (c) 2004 The Regents of the University of Michigan.
Jeff Laytonf3f80142012-03-21 09:52:07 -04003* Copyright (c) 2012 Jeff Layton <jlayton@redhat.com>
NeilBrowna55370a2005-06-23 22:03:52 -07004* All rights reserved.
5*
6* Andy Adamson <andros@citi.umich.edu>
7*
8* Redistribution and use in source and binary forms, with or without
9* modification, are permitted provided that the following conditions
10* are met:
11*
12* 1. Redistributions of source code must retain the above copyright
13* notice, this list of conditions and the following disclaimer.
14* 2. Redistributions in binary form must reproduce the above copyright
15* notice, this list of conditions and the following disclaimer in the
16* documentation and/or other materials provided with the distribution.
17* 3. Neither the name of the University nor the names of its
18* contributors may be used to endorse or promote products derived
19* from this software without specific prior written permission.
20*
21* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
22* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32*
33*/
34
NeilBrown190e4fb2005-06-23 22:04:25 -070035#include <linux/file.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090036#include <linux/slab.h>
NeilBrown190e4fb2005-06-23 22:04:25 -070037#include <linux/namei.h>
NeilBrowna55370a2005-06-23 22:03:52 -070038#include <linux/crypto.h>
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040039#include <linux/sched.h>
Jeff Laytonf3f80142012-03-21 09:52:07 -040040#include <linux/fs.h>
Jeff Layton813fd322012-03-21 09:52:08 -040041#include <linux/module.h>
Jeff Laytonf3f80142012-03-21 09:52:07 -040042#include <net/net_namespace.h>
43#include <linux/sunrpc/rpc_pipe_fs.h>
44#include <linux/sunrpc/clnt.h>
45#include <linux/nfsd/cld.h>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020046
47#include "nfsd.h"
48#include "state.h"
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050049#include "vfs.h"
Jeff Laytonf3f80142012-03-21 09:52:07 -040050#include "netns.h"
NeilBrowna55370a2005-06-23 22:03:52 -070051
52#define NFSDDBG_FACILITY NFSDDBG_PROC
53
Jeff Layton2a4317c2012-03-21 16:42:43 -040054/* Declarations */
55struct nfsd4_client_tracking_ops {
56 int (*init)(struct net *);
57 void (*exit)(struct net *);
58 void (*create)(struct nfs4_client *);
59 void (*remove)(struct nfs4_client *);
60 int (*check)(struct nfs4_client *);
61 void (*grace_done)(struct net *, time_t);
62};
63
NeilBrown190e4fb2005-06-23 22:04:25 -070064/* Globals */
Christoph Hellwige970a572010-03-22 17:32:14 +010065static struct file *rec_file;
J. Bruce Fields48483bf2011-08-26 20:40:28 -040066static char user_recovery_dirname[PATH_MAX] = "/var/lib/nfs/v4recovery";
Jeff Layton2a4317c2012-03-21 16:42:43 -040067static struct nfsd4_client_tracking_ops *client_tracking_ops;
NeilBrown190e4fb2005-06-23 22:04:25 -070068
David Howellsd84f4f92008-11-14 10:39:23 +110069static int
70nfs4_save_creds(const struct cred **original_creds)
NeilBrown190e4fb2005-06-23 22:04:25 -070071{
David Howellsd84f4f92008-11-14 10:39:23 +110072 struct cred *new;
73
74 new = prepare_creds();
75 if (!new)
76 return -ENOMEM;
77
78 new->fsuid = 0;
79 new->fsgid = 0;
80 *original_creds = override_creds(new);
81 put_cred(new);
82 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -070083}
84
85static void
David Howellsd84f4f92008-11-14 10:39:23 +110086nfs4_reset_creds(const struct cred *original)
NeilBrown190e4fb2005-06-23 22:04:25 -070087{
David Howellsd84f4f92008-11-14 10:39:23 +110088 revert_creds(original);
NeilBrown190e4fb2005-06-23 22:04:25 -070089}
90
NeilBrowna55370a2005-06-23 22:03:52 -070091static void
92md5_to_hex(char *out, char *md5)
93{
94 int i;
95
96 for (i=0; i<16; i++) {
97 unsigned char c = md5[i];
98
99 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
100 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
101 }
102 *out = '\0';
103}
104
Al Virob37ad282006-10-19 23:28:59 -0700105__be32
NeilBrowna55370a2005-06-23 22:03:52 -0700106nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
107{
108 struct xdr_netobj cksum;
Herbert Xu35058682006-08-24 19:10:20 +1000109 struct hash_desc desc;
Jens Axboe60c74f82007-10-22 19:43:30 +0200110 struct scatterlist sg;
J. Bruce Fields3e772462011-08-10 19:07:33 -0400111 __be32 status = nfserr_jukebox;
NeilBrowna55370a2005-06-23 22:03:52 -0700112
113 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
114 clname->len, clname->data);
Herbert Xu35058682006-08-24 19:10:20 +1000115 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
116 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
117 if (IS_ERR(desc.tfm))
118 goto out_no_tfm;
119 cksum.len = crypto_hash_digestsize(desc.tfm);
NeilBrowna55370a2005-06-23 22:03:52 -0700120 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
121 if (cksum.data == NULL)
122 goto out;
NeilBrowna55370a2005-06-23 22:03:52 -0700123
Jens Axboe60c74f82007-10-22 19:43:30 +0200124 sg_init_one(&sg, clname->data, clname->len);
NeilBrowna55370a2005-06-23 22:03:52 -0700125
Jens Axboe60c74f82007-10-22 19:43:30 +0200126 if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
Herbert Xu35058682006-08-24 19:10:20 +1000127 goto out;
NeilBrowna55370a2005-06-23 22:03:52 -0700128
129 md5_to_hex(dname, cksum.data);
130
NeilBrowna55370a2005-06-23 22:03:52 -0700131 status = nfs_ok;
132out:
Krishna Kumar2bd9e7b2008-10-20 11:47:09 +0530133 kfree(cksum.data);
Herbert Xu35058682006-08-24 19:10:20 +1000134 crypto_free_hash(desc.tfm);
135out_no_tfm:
NeilBrowna55370a2005-06-23 22:03:52 -0700136 return status;
137}
NeilBrown190e4fb2005-06-23 22:04:25 -0700138
Jeff Layton2a4317c2012-03-21 16:42:43 -0400139static void
140nfsd4_create_clid_dir(struct nfs4_client *clp)
NeilBrownc7b9a452005-06-23 22:04:30 -0700141{
David Howellsd84f4f92008-11-14 10:39:23 +1100142 const struct cred *original_cred;
NeilBrownc7b9a452005-06-23 22:04:30 -0700143 char *dname = clp->cl_recdir;
Christoph Hellwige970a572010-03-22 17:32:14 +0100144 struct dentry *dir, *dentry;
NeilBrownc7b9a452005-06-23 22:04:30 -0700145 int status;
146
147 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
148
Jeff Laytona52d7262012-03-21 09:52:02 -0400149 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
J. Bruce Fields7a6ef8c2012-01-05 15:38:41 -0500150 return;
J. Bruce Fieldsb8548892012-01-02 17:49:12 -0500151 if (!rec_file)
J. Bruce Fields7a6ef8c2012-01-05 15:38:41 -0500152 return;
David Howellsd84f4f92008-11-14 10:39:23 +1100153 status = nfs4_save_creds(&original_cred);
154 if (status < 0)
J. Bruce Fields7a6ef8c2012-01-05 15:38:41 -0500155 return;
NeilBrownc7b9a452005-06-23 22:04:30 -0700156
Christoph Hellwige970a572010-03-22 17:32:14 +0100157 dir = rec_file->f_path.dentry;
NeilBrownc7b9a452005-06-23 22:04:30 -0700158 /* lock the parent */
Christoph Hellwige970a572010-03-22 17:32:14 +0100159 mutex_lock(&dir->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700160
Christoph Hellwige970a572010-03-22 17:32:14 +0100161 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
NeilBrownc7b9a452005-06-23 22:04:30 -0700162 if (IS_ERR(dentry)) {
163 status = PTR_ERR(dentry);
164 goto out_unlock;
165 }
Boaz Harrosh6577aac2011-08-12 17:30:12 -0700166 if (dentry->d_inode)
J. Bruce Fieldsaec39682012-01-02 17:30:05 -0500167 /*
168 * In the 4.1 case, where we're called from
169 * reclaim_complete(), records from the previous reboot
170 * may still be left, so this is OK.
171 *
172 * In the 4.0 case, we should never get here; but we may
173 * as well be forgiving and just succeed silently.
174 */
NeilBrownc7b9a452005-06-23 22:04:30 -0700175 goto out_put;
Al Viroa561be72011-11-23 11:57:51 -0500176 status = mnt_want_write_file(rec_file);
Dave Hansen463c3192008-02-15 14:37:57 -0800177 if (status)
178 goto out_put;
Christoph Hellwige970a572010-03-22 17:32:14 +0100179 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
Al Viro2a79f172011-12-09 08:06:57 -0500180 mnt_drop_write_file(rec_file);
NeilBrownc7b9a452005-06-23 22:04:30 -0700181out_put:
182 dput(dentry);
183out_unlock:
Christoph Hellwige970a572010-03-22 17:32:14 +0100184 mutex_unlock(&dir->d_inode->i_mutex);
Boaz Harrosh6577aac2011-08-12 17:30:12 -0700185 if (status == 0)
Christoph Hellwig8018ab02010-03-22 17:32:25 +0100186 vfs_fsync(rec_file, 0);
Boaz Harrosh6577aac2011-08-12 17:30:12 -0700187 else
188 printk(KERN_ERR "NFSD: failed to write recovery record"
189 " (err %d); please check that %s exists"
190 " and is writeable", status,
191 user_recovery_dirname);
David Howellsd84f4f92008-11-14 10:39:23 +1100192 nfs4_reset_creds(original_cred);
NeilBrownc7b9a452005-06-23 22:04:30 -0700193}
194
NeilBrown190e4fb2005-06-23 22:04:25 -0700195typedef int (recdir_func)(struct dentry *, struct dentry *);
196
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400197struct name_list {
198 char name[HEXDIR_LEN];
NeilBrown190e4fb2005-06-23 22:04:25 -0700199 struct list_head list;
200};
201
NeilBrown190e4fb2005-06-23 22:04:25 -0700202static int
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400203nfsd4_build_namelist(void *arg, const char *name, int namlen,
David Howellsafefdbb2006-10-03 01:13:46 -0700204 loff_t offset, u64 ino, unsigned int d_type)
NeilBrown190e4fb2005-06-23 22:04:25 -0700205{
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400206 struct list_head *names = arg;
207 struct name_list *entry;
NeilBrown190e4fb2005-06-23 22:04:25 -0700208
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400209 if (namlen != HEXDIR_LEN - 1)
Al Virob37ad282006-10-19 23:28:59 -0700210 return 0;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400211 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
212 if (entry == NULL)
NeilBrown190e4fb2005-06-23 22:04:25 -0700213 return -ENOMEM;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400214 memcpy(entry->name, name, HEXDIR_LEN - 1);
215 entry->name[HEXDIR_LEN - 1] = '\0';
216 list_add(&entry->list, names);
NeilBrown190e4fb2005-06-23 22:04:25 -0700217 return 0;
218}
219
220static int
Al Viro5b4b2992011-07-07 18:43:21 -0400221nfsd4_list_rec_dir(recdir_func *f)
NeilBrown190e4fb2005-06-23 22:04:25 -0700222{
David Howellsd84f4f92008-11-14 10:39:23 +1100223 const struct cred *original_cred;
Al Viro5b4b2992011-07-07 18:43:21 -0400224 struct dentry *dir = rec_file->f_path.dentry;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400225 LIST_HEAD(names);
NeilBrown190e4fb2005-06-23 22:04:25 -0700226 int status;
227
David Howellsd84f4f92008-11-14 10:39:23 +1100228 status = nfs4_save_creds(&original_cred);
229 if (status < 0)
230 return status;
NeilBrown190e4fb2005-06-23 22:04:25 -0700231
Al Viro5b4b2992011-07-07 18:43:21 -0400232 status = vfs_llseek(rec_file, 0, SEEK_SET);
233 if (status < 0) {
234 nfs4_reset_creds(original_cred);
235 return status;
236 }
237
238 status = vfs_readdir(rec_file, nfsd4_build_namelist, &names);
J. Bruce Fields8daed1e2009-05-11 16:10:19 -0400239 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400240 while (!list_empty(&names)) {
Al Viro5b4b2992011-07-07 18:43:21 -0400241 struct name_list *entry;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400242 entry = list_entry(names.next, struct name_list, list);
Al Viro5b4b2992011-07-07 18:43:21 -0400243 if (!status) {
244 struct dentry *dentry;
245 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
246 if (IS_ERR(dentry)) {
247 status = PTR_ERR(dentry);
248 break;
249 }
250 status = f(dir, dentry);
251 dput(dentry);
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400252 }
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400253 list_del(&entry->list);
254 kfree(entry);
NeilBrown190e4fb2005-06-23 22:04:25 -0700255 }
David Woodhouse2f9092e2009-04-20 23:18:37 +0100256 mutex_unlock(&dir->d_inode->i_mutex);
David Howellsd84f4f92008-11-14 10:39:23 +1100257 nfs4_reset_creds(original_cred);
NeilBrown190e4fb2005-06-23 22:04:25 -0700258 return status;
259}
260
261static int
NeilBrownc7b9a452005-06-23 22:04:30 -0700262nfsd4_unlink_clid_dir(char *name, int namlen)
263{
Christoph Hellwige970a572010-03-22 17:32:14 +0100264 struct dentry *dir, *dentry;
NeilBrownc7b9a452005-06-23 22:04:30 -0700265 int status;
266
267 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
268
Christoph Hellwige970a572010-03-22 17:32:14 +0100269 dir = rec_file->f_path.dentry;
270 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
271 dentry = lookup_one_len(name, dir, namlen);
NeilBrownc7b9a452005-06-23 22:04:30 -0700272 if (IS_ERR(dentry)) {
273 status = PTR_ERR(dentry);
David Woodhouse2f9092e2009-04-20 23:18:37 +0100274 goto out_unlock;
NeilBrownc7b9a452005-06-23 22:04:30 -0700275 }
276 status = -ENOENT;
277 if (!dentry->d_inode)
278 goto out;
Christoph Hellwige970a572010-03-22 17:32:14 +0100279 status = vfs_rmdir(dir->d_inode, dentry);
NeilBrownc7b9a452005-06-23 22:04:30 -0700280out:
281 dput(dentry);
David Woodhouse2f9092e2009-04-20 23:18:37 +0100282out_unlock:
Christoph Hellwige970a572010-03-22 17:32:14 +0100283 mutex_unlock(&dir->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700284 return status;
285}
286
Jeff Layton2a4317c2012-03-21 16:42:43 -0400287static void
NeilBrownc7b9a452005-06-23 22:04:30 -0700288nfsd4_remove_clid_dir(struct nfs4_client *clp)
289{
David Howellsd84f4f92008-11-14 10:39:23 +1100290 const struct cred *original_cred;
NeilBrownc7b9a452005-06-23 22:04:30 -0700291 int status;
292
Jeff Laytona52d7262012-03-21 09:52:02 -0400293 if (!rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
NeilBrownc7b9a452005-06-23 22:04:30 -0700294 return;
295
Al Viroa561be72011-11-23 11:57:51 -0500296 status = mnt_want_write_file(rec_file);
Dave Hansen06227532008-02-15 14:37:34 -0800297 if (status)
298 goto out;
Jeff Laytona52d7262012-03-21 09:52:02 -0400299 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
David Howellsd84f4f92008-11-14 10:39:23 +1100300
301 status = nfs4_save_creds(&original_cred);
302 if (status < 0)
303 goto out;
304
NeilBrownc7b9a452005-06-23 22:04:30 -0700305 status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
David Howellsd84f4f92008-11-14 10:39:23 +1100306 nfs4_reset_creds(original_cred);
NeilBrownc7b9a452005-06-23 22:04:30 -0700307 if (status == 0)
Christoph Hellwig8018ab02010-03-22 17:32:25 +0100308 vfs_fsync(rec_file, 0);
Al Viro2a79f172011-12-09 08:06:57 -0500309 mnt_drop_write_file(rec_file);
Dave Hansen06227532008-02-15 14:37:34 -0800310out:
NeilBrownc7b9a452005-06-23 22:04:30 -0700311 if (status)
312 printk("NFSD: Failed to remove expired client state directory"
313 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
NeilBrownc7b9a452005-06-23 22:04:30 -0700314}
315
316static int
317purge_old(struct dentry *parent, struct dentry *child)
318{
319 int status;
320
Andy Adamsona1bcecd2009-04-03 08:28:05 +0300321 if (nfs4_has_reclaimed_state(child->d_name.name, false))
Al Virob37ad282006-10-19 23:28:59 -0700322 return 0;
NeilBrownc7b9a452005-06-23 22:04:30 -0700323
David Woodhouse2f9092e2009-04-20 23:18:37 +0100324 status = vfs_rmdir(parent->d_inode, child);
NeilBrownc7b9a452005-06-23 22:04:30 -0700325 if (status)
326 printk("failed to remove client recovery directory %s\n",
327 child->d_name.name);
328 /* Keep trying, success or failure: */
Al Virob37ad282006-10-19 23:28:59 -0700329 return 0;
NeilBrownc7b9a452005-06-23 22:04:30 -0700330}
331
Jeff Layton2a4317c2012-03-21 16:42:43 -0400332static void
333nfsd4_recdir_purge_old(struct net *net, time_t boot_time)
334{
NeilBrownc7b9a452005-06-23 22:04:30 -0700335 int status;
336
Christoph Hellwige970a572010-03-22 17:32:14 +0100337 if (!rec_file)
NeilBrownc7b9a452005-06-23 22:04:30 -0700338 return;
Al Viroa561be72011-11-23 11:57:51 -0500339 status = mnt_want_write_file(rec_file);
Dave Hansen06227532008-02-15 14:37:34 -0800340 if (status)
341 goto out;
Al Viro5b4b2992011-07-07 18:43:21 -0400342 status = nfsd4_list_rec_dir(purge_old);
NeilBrownc7b9a452005-06-23 22:04:30 -0700343 if (status == 0)
Christoph Hellwig8018ab02010-03-22 17:32:25 +0100344 vfs_fsync(rec_file, 0);
Al Viro2a79f172011-12-09 08:06:57 -0500345 mnt_drop_write_file(rec_file);
Dave Hansen06227532008-02-15 14:37:34 -0800346out:
NeilBrownc7b9a452005-06-23 22:04:30 -0700347 if (status)
348 printk("nfsd4: failed to purge old clients from recovery"
Christoph Hellwige970a572010-03-22 17:32:14 +0100349 " directory %s\n", rec_file->f_path.dentry->d_name.name);
NeilBrownc7b9a452005-06-23 22:04:30 -0700350}
351
352static int
NeilBrown190e4fb2005-06-23 22:04:25 -0700353load_recdir(struct dentry *parent, struct dentry *child)
354{
355 if (child->d_name.len != HEXDIR_LEN - 1) {
356 printk("nfsd4: illegal name %s in recovery directory\n",
357 child->d_name.name);
358 /* Keep trying; maybe the others are OK: */
Al Virob37ad282006-10-19 23:28:59 -0700359 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -0700360 }
361 nfs4_client_to_reclaim(child->d_name.name);
Al Virob37ad282006-10-19 23:28:59 -0700362 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -0700363}
364
Jeff Layton2a4317c2012-03-21 16:42:43 -0400365static int
NeilBrown190e4fb2005-06-23 22:04:25 -0700366nfsd4_recdir_load(void) {
367 int status;
368
Christoph Hellwige970a572010-03-22 17:32:14 +0100369 if (!rec_file)
370 return 0;
371
Al Viro5b4b2992011-07-07 18:43:21 -0400372 status = nfsd4_list_rec_dir(load_recdir);
NeilBrown190e4fb2005-06-23 22:04:25 -0700373 if (status)
374 printk("nfsd4: failed loading clients from recovery"
Christoph Hellwige970a572010-03-22 17:32:14 +0100375 " directory %s\n", rec_file->f_path.dentry->d_name.name);
NeilBrown190e4fb2005-06-23 22:04:25 -0700376 return status;
377}
378
379/*
380 * Hold reference to the recovery directory.
381 */
382
Jeff Layton2a4317c2012-03-21 16:42:43 -0400383static int
384nfsd4_init_recdir(void)
NeilBrown190e4fb2005-06-23 22:04:25 -0700385{
David Howellsd84f4f92008-11-14 10:39:23 +1100386 const struct cred *original_cred;
387 int status;
NeilBrown190e4fb2005-06-23 22:04:25 -0700388
389 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
J. Bruce Fields48483bf2011-08-26 20:40:28 -0400390 user_recovery_dirname);
NeilBrown190e4fb2005-06-23 22:04:25 -0700391
Christoph Hellwige970a572010-03-22 17:32:14 +0100392 BUG_ON(rec_file);
NeilBrown190e4fb2005-06-23 22:04:25 -0700393
David Howellsd84f4f92008-11-14 10:39:23 +1100394 status = nfs4_save_creds(&original_cred);
395 if (status < 0) {
396 printk("NFSD: Unable to change credentials to find recovery"
397 " directory: error %d\n",
398 status);
Jeff Layton2a4317c2012-03-21 16:42:43 -0400399 return status;
David Howellsd84f4f92008-11-14 10:39:23 +1100400 }
NeilBrown190e4fb2005-06-23 22:04:25 -0700401
J. Bruce Fields48483bf2011-08-26 20:40:28 -0400402 rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
Christoph Hellwige970a572010-03-22 17:32:14 +0100403 if (IS_ERR(rec_file)) {
J. Bruce Fieldsc2642ab2006-01-18 17:43:29 -0800404 printk("NFSD: unable to find recovery directory %s\n",
J. Bruce Fields48483bf2011-08-26 20:40:28 -0400405 user_recovery_dirname);
Jeff Layton2a4317c2012-03-21 16:42:43 -0400406 status = PTR_ERR(rec_file);
Christoph Hellwige970a572010-03-22 17:32:14 +0100407 rec_file = NULL;
408 }
NeilBrown190e4fb2005-06-23 22:04:25 -0700409
David Howellsd84f4f92008-11-14 10:39:23 +1100410 nfs4_reset_creds(original_cred);
Jeff Layton2a4317c2012-03-21 16:42:43 -0400411 return status;
NeilBrown190e4fb2005-06-23 22:04:25 -0700412}
413
Jeff Layton2a4317c2012-03-21 16:42:43 -0400414static int
415nfsd4_load_reboot_recovery_data(struct net *net)
416{
417 int status;
418
Jeff Laytoncc27e0d2012-03-21 09:52:09 -0400419 /* XXX: The legacy code won't work in a container */
420 if (net != &init_net) {
421 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
422 "tracking in a container!\n");
423 return -EINVAL;
424 }
425
Jeff Layton2a4317c2012-03-21 16:42:43 -0400426 nfs4_lock_state();
427 status = nfsd4_init_recdir();
428 if (!status)
429 status = nfsd4_recdir_load();
430 nfs4_unlock_state();
431 if (status)
432 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
433 return status;
434}
435
436static void
NeilBrown190e4fb2005-06-23 22:04:25 -0700437nfsd4_shutdown_recdir(void)
438{
Christoph Hellwige970a572010-03-22 17:32:14 +0100439 if (!rec_file)
NeilBrown190e4fb2005-06-23 22:04:25 -0700440 return;
Christoph Hellwige970a572010-03-22 17:32:14 +0100441 fput(rec_file);
442 rec_file = NULL;
NeilBrown190e4fb2005-06-23 22:04:25 -0700443}
J. Bruce Fields48483bf2011-08-26 20:40:28 -0400444
Jeff Layton2a4317c2012-03-21 16:42:43 -0400445static void
446nfsd4_legacy_tracking_exit(struct net *net)
447{
448 nfs4_release_reclaim();
449 nfsd4_shutdown_recdir();
450}
451
J. Bruce Fields48483bf2011-08-26 20:40:28 -0400452/*
453 * Change the NFSv4 recovery directory to recdir.
454 */
455int
456nfs4_reset_recoverydir(char *recdir)
457{
458 int status;
459 struct path path;
460
461 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
462 if (status)
463 return status;
464 status = -ENOTDIR;
465 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
466 strcpy(user_recovery_dirname, recdir);
467 status = 0;
468 }
469 path_put(&path);
470 return status;
471}
472
473char *
474nfs4_recoverydir(void)
475{
476 return user_recovery_dirname;
477}
Jeff Layton2a4317c2012-03-21 16:42:43 -0400478
479static int
480nfsd4_check_legacy_client(struct nfs4_client *clp)
481{
482 /* did we already find that this client is stable? */
483 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
484 return 0;
485
486 /* look for it in the reclaim hashtable otherwise */
487 if (nfsd4_find_reclaim_client(clp)) {
488 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
489 return 0;
490 }
491
492 return -ENOENT;
493}
494
495static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
496 .init = nfsd4_load_reboot_recovery_data,
497 .exit = nfsd4_legacy_tracking_exit,
498 .create = nfsd4_create_clid_dir,
499 .remove = nfsd4_remove_clid_dir,
500 .check = nfsd4_check_legacy_client,
501 .grace_done = nfsd4_recdir_purge_old,
502};
503
Jeff Laytonf3f80142012-03-21 09:52:07 -0400504/* Globals */
505#define NFSD_PIPE_DIR "nfsd"
506#define NFSD_CLD_PIPE "cld"
507
508/* per-net-ns structure for holding cld upcall info */
509struct cld_net {
510 struct rpc_pipe *cn_pipe;
511 spinlock_t cn_lock;
512 struct list_head cn_list;
513 unsigned int cn_xid;
514};
515
516struct cld_upcall {
517 struct list_head cu_list;
518 struct cld_net *cu_net;
519 struct task_struct *cu_task;
520 struct cld_msg cu_msg;
521};
522
523static int
524__cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
525{
526 int ret;
527 struct rpc_pipe_msg msg;
528
529 memset(&msg, 0, sizeof(msg));
530 msg.data = cmsg;
531 msg.len = sizeof(*cmsg);
532
533 /*
534 * Set task state before we queue the upcall. That prevents
535 * wake_up_process in the downcall from racing with schedule.
536 */
537 set_current_state(TASK_UNINTERRUPTIBLE);
538 ret = rpc_queue_upcall(pipe, &msg);
539 if (ret < 0) {
540 set_current_state(TASK_RUNNING);
541 goto out;
542 }
543
544 schedule();
545 set_current_state(TASK_RUNNING);
546
547 if (msg.errno < 0)
548 ret = msg.errno;
549out:
550 return ret;
551}
552
553static int
554cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
555{
556 int ret;
557
558 /*
559 * -EAGAIN occurs when pipe is closed and reopened while there are
560 * upcalls queued.
561 */
562 do {
563 ret = __cld_pipe_upcall(pipe, cmsg);
564 } while (ret == -EAGAIN);
565
566 return ret;
567}
568
569static ssize_t
570cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
571{
572 struct cld_upcall *tmp, *cup;
573 struct cld_msg *cmsg = (struct cld_msg *)src;
574 uint32_t xid;
575 struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
576 nfsd_net_id);
577 struct cld_net *cn = nn->cld_net;
578
579 if (mlen != sizeof(*cmsg)) {
Randy Dunlap8a7dc4b2012-04-30 12:25:31 -0700580 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
Jeff Laytonf3f80142012-03-21 09:52:07 -0400581 sizeof(*cmsg));
582 return -EINVAL;
583 }
584
585 /* copy just the xid so we can try to find that */
586 if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
587 dprintk("%s: error when copying xid from userspace", __func__);
588 return -EFAULT;
589 }
590
591 /* walk the list and find corresponding xid */
592 cup = NULL;
593 spin_lock(&cn->cn_lock);
594 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
595 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
596 cup = tmp;
597 list_del_init(&cup->cu_list);
598 break;
599 }
600 }
601 spin_unlock(&cn->cn_lock);
602
603 /* couldn't find upcall? */
604 if (!cup) {
Jeff Layton21f72c92012-03-28 07:36:01 -0400605 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
Jeff Laytonf3f80142012-03-21 09:52:07 -0400606 return -EINVAL;
607 }
608
609 if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
610 return -EFAULT;
611
612 wake_up_process(cup->cu_task);
613 return mlen;
614}
615
616static void
617cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
618{
619 struct cld_msg *cmsg = msg->data;
620 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
621 cu_msg);
622
623 /* errno >= 0 means we got a downcall */
624 if (msg->errno >= 0)
625 return;
626
627 wake_up_process(cup->cu_task);
628}
629
630static const struct rpc_pipe_ops cld_upcall_ops = {
631 .upcall = rpc_pipe_generic_upcall,
632 .downcall = cld_pipe_downcall,
633 .destroy_msg = cld_pipe_destroy_msg,
634};
635
636static struct dentry *
637nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
638{
639 struct dentry *dir, *dentry;
640
641 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
642 if (dir == NULL)
643 return ERR_PTR(-ENOENT);
644 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
645 dput(dir);
646 return dentry;
647}
648
649static void
650nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
651{
652 if (pipe->dentry)
653 rpc_unlink(pipe->dentry);
654}
655
656static struct dentry *
657nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
658{
659 struct super_block *sb;
660 struct dentry *dentry;
661
662 sb = rpc_get_sb_net(net);
663 if (!sb)
664 return NULL;
665 dentry = nfsd4_cld_register_sb(sb, pipe);
666 rpc_put_sb_net(net);
667 return dentry;
668}
669
670static void
671nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
672{
673 struct super_block *sb;
674
675 sb = rpc_get_sb_net(net);
676 if (sb) {
677 nfsd4_cld_unregister_sb(pipe);
678 rpc_put_sb_net(net);
679 }
680}
681
682/* Initialize rpc_pipefs pipe for communication with client tracking daemon */
683static int
684nfsd4_init_cld_pipe(struct net *net)
685{
686 int ret;
687 struct dentry *dentry;
688 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
689 struct cld_net *cn;
690
691 if (nn->cld_net)
692 return 0;
693
694 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
695 if (!cn) {
696 ret = -ENOMEM;
697 goto err;
698 }
699
700 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
701 if (IS_ERR(cn->cn_pipe)) {
702 ret = PTR_ERR(cn->cn_pipe);
703 goto err;
704 }
705 spin_lock_init(&cn->cn_lock);
706 INIT_LIST_HEAD(&cn->cn_list);
707
708 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
709 if (IS_ERR(dentry)) {
710 ret = PTR_ERR(dentry);
711 goto err_destroy_data;
712 }
713
714 cn->cn_pipe->dentry = dentry;
715 nn->cld_net = cn;
716 return 0;
717
718err_destroy_data:
719 rpc_destroy_pipe_data(cn->cn_pipe);
720err:
721 kfree(cn);
722 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
723 ret);
724 return ret;
725}
726
727static void
728nfsd4_remove_cld_pipe(struct net *net)
729{
730 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
731 struct cld_net *cn = nn->cld_net;
732
733 nfsd4_cld_unregister_net(net, cn->cn_pipe);
734 rpc_destroy_pipe_data(cn->cn_pipe);
735 kfree(nn->cld_net);
736 nn->cld_net = NULL;
737}
738
739static struct cld_upcall *
740alloc_cld_upcall(struct cld_net *cn)
741{
742 struct cld_upcall *new, *tmp;
743
744 new = kzalloc(sizeof(*new), GFP_KERNEL);
745 if (!new)
746 return new;
747
748 /* FIXME: hard cap on number in flight? */
749restart_search:
750 spin_lock(&cn->cn_lock);
751 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
752 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
753 cn->cn_xid++;
754 spin_unlock(&cn->cn_lock);
755 goto restart_search;
756 }
757 }
758 new->cu_task = current;
759 new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
760 put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
761 new->cu_net = cn;
762 list_add(&new->cu_list, &cn->cn_list);
763 spin_unlock(&cn->cn_lock);
764
765 dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
766
767 return new;
768}
769
770static void
771free_cld_upcall(struct cld_upcall *victim)
772{
773 struct cld_net *cn = victim->cu_net;
774
775 spin_lock(&cn->cn_lock);
776 list_del(&victim->cu_list);
777 spin_unlock(&cn->cn_lock);
778 kfree(victim);
779}
780
781/* Ask daemon to create a new record */
782static void
783nfsd4_cld_create(struct nfs4_client *clp)
784{
785 int ret;
786 struct cld_upcall *cup;
787 /* FIXME: determine net from clp */
788 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
789 struct cld_net *cn = nn->cld_net;
790
791 /* Don't upcall if it's already stored */
792 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
793 return;
794
795 cup = alloc_cld_upcall(cn);
796 if (!cup) {
797 ret = -ENOMEM;
798 goto out_err;
799 }
800
801 cup->cu_msg.cm_cmd = Cld_Create;
802 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
803 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
804 clp->cl_name.len);
805
806 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
807 if (!ret) {
808 ret = cup->cu_msg.cm_status;
809 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
810 }
811
812 free_cld_upcall(cup);
813out_err:
814 if (ret)
815 printk(KERN_ERR "NFSD: Unable to create client "
816 "record on stable storage: %d\n", ret);
817}
818
819/* Ask daemon to create a new record */
820static void
821nfsd4_cld_remove(struct nfs4_client *clp)
822{
823 int ret;
824 struct cld_upcall *cup;
825 /* FIXME: determine net from clp */
826 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
827 struct cld_net *cn = nn->cld_net;
828
829 /* Don't upcall if it's already removed */
830 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
831 return;
832
833 cup = alloc_cld_upcall(cn);
834 if (!cup) {
835 ret = -ENOMEM;
836 goto out_err;
837 }
838
839 cup->cu_msg.cm_cmd = Cld_Remove;
840 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
841 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
842 clp->cl_name.len);
843
844 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
845 if (!ret) {
846 ret = cup->cu_msg.cm_status;
847 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
848 }
849
850 free_cld_upcall(cup);
851out_err:
852 if (ret)
853 printk(KERN_ERR "NFSD: Unable to remove client "
854 "record from stable storage: %d\n", ret);
855}
856
857/* Check for presence of a record, and update its timestamp */
858static int
859nfsd4_cld_check(struct nfs4_client *clp)
860{
861 int ret;
862 struct cld_upcall *cup;
863 /* FIXME: determine net from clp */
864 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
865 struct cld_net *cn = nn->cld_net;
866
867 /* Don't upcall if one was already stored during this grace pd */
868 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
869 return 0;
870
871 cup = alloc_cld_upcall(cn);
872 if (!cup) {
873 printk(KERN_ERR "NFSD: Unable to check client record on "
874 "stable storage: %d\n", -ENOMEM);
875 return -ENOMEM;
876 }
877
878 cup->cu_msg.cm_cmd = Cld_Check;
879 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
880 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
881 clp->cl_name.len);
882
883 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
884 if (!ret) {
885 ret = cup->cu_msg.cm_status;
886 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
887 }
888
889 free_cld_upcall(cup);
890 return ret;
891}
892
893static void
894nfsd4_cld_grace_done(struct net *net, time_t boot_time)
895{
896 int ret;
897 struct cld_upcall *cup;
898 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
899 struct cld_net *cn = nn->cld_net;
900
901 cup = alloc_cld_upcall(cn);
902 if (!cup) {
903 ret = -ENOMEM;
904 goto out_err;
905 }
906
907 cup->cu_msg.cm_cmd = Cld_GraceDone;
908 cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
909 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
910 if (!ret)
911 ret = cup->cu_msg.cm_status;
912
913 free_cld_upcall(cup);
914out_err:
915 if (ret)
916 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
917}
918
919static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
920 .init = nfsd4_init_cld_pipe,
921 .exit = nfsd4_remove_cld_pipe,
922 .create = nfsd4_cld_create,
923 .remove = nfsd4_cld_remove,
924 .check = nfsd4_cld_check,
925 .grace_done = nfsd4_cld_grace_done,
926};
927
Jeff Layton2a4317c2012-03-21 16:42:43 -0400928int
929nfsd4_client_tracking_init(struct net *net)
930{
931 int status;
Jeff Laytonf3f80142012-03-21 09:52:07 -0400932 struct path path;
Jeff Layton2a4317c2012-03-21 16:42:43 -0400933
Jeff Laytonf3f80142012-03-21 09:52:07 -0400934 if (!client_tracking_ops) {
935 client_tracking_ops = &nfsd4_cld_tracking_ops;
936 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
937 if (!status) {
938 if (S_ISDIR(path.dentry->d_inode->i_mode))
939 client_tracking_ops =
940 &nfsd4_legacy_tracking_ops;
941 path_put(&path);
942 }
943 }
Jeff Layton2a4317c2012-03-21 16:42:43 -0400944
945 status = client_tracking_ops->init(net);
946 if (status) {
947 printk(KERN_WARNING "NFSD: Unable to initialize client "
948 "recovery tracking! (%d)\n", status);
949 client_tracking_ops = NULL;
950 }
951 return status;
952}
953
954void
955nfsd4_client_tracking_exit(struct net *net)
956{
957 if (client_tracking_ops) {
958 client_tracking_ops->exit(net);
959 client_tracking_ops = NULL;
960 }
961}
962
963void
964nfsd4_client_record_create(struct nfs4_client *clp)
965{
966 if (client_tracking_ops)
967 client_tracking_ops->create(clp);
968}
969
970void
971nfsd4_client_record_remove(struct nfs4_client *clp)
972{
973 if (client_tracking_ops)
974 client_tracking_ops->remove(clp);
975}
976
977int
978nfsd4_client_record_check(struct nfs4_client *clp)
979{
980 if (client_tracking_ops)
981 return client_tracking_ops->check(clp);
982
983 return -EOPNOTSUPP;
984}
985
986void
987nfsd4_record_grace_done(struct net *net, time_t boot_time)
988{
989 if (client_tracking_ops)
990 client_tracking_ops->grace_done(net, boot_time);
991}
Jeff Layton813fd322012-03-21 09:52:08 -0400992
993static int
994rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
995{
996 struct super_block *sb = ptr;
997 struct net *net = sb->s_fs_info;
998 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
999 struct cld_net *cn = nn->cld_net;
1000 struct dentry *dentry;
1001 int ret = 0;
1002
1003 if (!try_module_get(THIS_MODULE))
1004 return 0;
1005
1006 if (!cn) {
1007 module_put(THIS_MODULE);
1008 return 0;
1009 }
1010
1011 switch (event) {
1012 case RPC_PIPEFS_MOUNT:
1013 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1014 if (IS_ERR(dentry)) {
1015 ret = PTR_ERR(dentry);
1016 break;
1017 }
1018 cn->cn_pipe->dentry = dentry;
1019 break;
1020 case RPC_PIPEFS_UMOUNT:
1021 if (cn->cn_pipe->dentry)
1022 nfsd4_cld_unregister_sb(cn->cn_pipe);
1023 break;
1024 default:
1025 ret = -ENOTSUPP;
1026 break;
1027 }
1028 module_put(THIS_MODULE);
1029 return ret;
1030}
1031
1032struct notifier_block nfsd4_cld_block = {
1033 .notifier_call = rpc_pipefs_event,
1034};
Jeff Layton797a9d72012-03-29 07:52:49 -04001035
1036int
1037register_cld_notifier(void)
1038{
1039 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1040}
1041
1042void
1043unregister_cld_notifier(void)
1044{
1045 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);
1046}