blob: b5348405046b5e2831cdcc9cd32a7f0c3d2e6f8f [file] [log] [blame]
NeilBrowna55370a2005-06-23 22:03:52 -07001/*
2* linux/fs/nfsd/nfs4recover.c
3*
4* Copyright (c) 2004 The Regents of the University of Michigan.
5* All rights reserved.
6*
7* Andy Adamson <andros@citi.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*/
35
Herbert Xu35058682006-08-24 19:10:20 +100036#include <linux/err.h>
NeilBrowna55370a2005-06-23 22:03:52 -070037#include <linux/sunrpc/svc.h>
38#include <linux/nfsd/nfsd.h>
39#include <linux/nfs4.h>
40#include <linux/nfsd/state.h>
41#include <linux/nfsd/xdr4.h>
NeilBrown190e4fb2005-06-23 22:04:25 -070042#include <linux/param.h>
43#include <linux/file.h>
44#include <linux/namei.h>
NeilBrowna55370a2005-06-23 22:03:52 -070045#include <asm/uaccess.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010046#include <linux/scatterlist.h>
NeilBrowna55370a2005-06-23 22:03:52 -070047#include <linux/crypto.h>
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040048#include <linux/sched.h>
Dave Hansen06227532008-02-15 14:37:34 -080049#include <linux/mount.h>
NeilBrowna55370a2005-06-23 22:03:52 -070050
51#define NFSDDBG_FACILITY NFSDDBG_PROC
52
NeilBrown190e4fb2005-06-23 22:04:25 -070053/* Globals */
Al Viroa63bb992008-08-02 01:03:36 -040054static struct path rec_dir;
NeilBrown190e4fb2005-06-23 22:04:25 -070055static int rec_dir_init = 0;
56
David Howellsd84f4f92008-11-14 10:39:23 +110057static int
58nfs4_save_creds(const struct cred **original_creds)
NeilBrown190e4fb2005-06-23 22:04:25 -070059{
David Howellsd84f4f92008-11-14 10:39:23 +110060 struct cred *new;
61
62 new = prepare_creds();
63 if (!new)
64 return -ENOMEM;
65
66 new->fsuid = 0;
67 new->fsgid = 0;
68 *original_creds = override_creds(new);
69 put_cred(new);
70 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -070071}
72
73static void
David Howellsd84f4f92008-11-14 10:39:23 +110074nfs4_reset_creds(const struct cred *original)
NeilBrown190e4fb2005-06-23 22:04:25 -070075{
David Howellsd84f4f92008-11-14 10:39:23 +110076 revert_creds(original);
NeilBrown190e4fb2005-06-23 22:04:25 -070077}
78
NeilBrowna55370a2005-06-23 22:03:52 -070079static void
80md5_to_hex(char *out, char *md5)
81{
82 int i;
83
84 for (i=0; i<16; i++) {
85 unsigned char c = md5[i];
86
87 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
88 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
89 }
90 *out = '\0';
91}
92
Al Virob37ad282006-10-19 23:28:59 -070093__be32
NeilBrowna55370a2005-06-23 22:03:52 -070094nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
95{
96 struct xdr_netobj cksum;
Herbert Xu35058682006-08-24 19:10:20 +100097 struct hash_desc desc;
Jens Axboe60c74f82007-10-22 19:43:30 +020098 struct scatterlist sg;
Al Virob37ad282006-10-19 23:28:59 -070099 __be32 status = nfserr_resource;
NeilBrowna55370a2005-06-23 22:03:52 -0700100
101 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
102 clname->len, clname->data);
Herbert Xu35058682006-08-24 19:10:20 +1000103 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
104 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
105 if (IS_ERR(desc.tfm))
106 goto out_no_tfm;
107 cksum.len = crypto_hash_digestsize(desc.tfm);
NeilBrowna55370a2005-06-23 22:03:52 -0700108 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
109 if (cksum.data == NULL)
110 goto out;
NeilBrowna55370a2005-06-23 22:03:52 -0700111
Jens Axboe60c74f82007-10-22 19:43:30 +0200112 sg_init_one(&sg, clname->data, clname->len);
NeilBrowna55370a2005-06-23 22:03:52 -0700113
Jens Axboe60c74f82007-10-22 19:43:30 +0200114 if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
Herbert Xu35058682006-08-24 19:10:20 +1000115 goto out;
NeilBrowna55370a2005-06-23 22:03:52 -0700116
117 md5_to_hex(dname, cksum.data);
118
NeilBrowna55370a2005-06-23 22:03:52 -0700119 status = nfs_ok;
120out:
Krishna Kumar2bd9e7b2008-10-20 11:47:09 +0530121 kfree(cksum.data);
Herbert Xu35058682006-08-24 19:10:20 +1000122 crypto_free_hash(desc.tfm);
123out_no_tfm:
NeilBrowna55370a2005-06-23 22:03:52 -0700124 return status;
125}
NeilBrown190e4fb2005-06-23 22:04:25 -0700126
NeilBrowna6ccbbb2005-07-07 17:59:11 -0700127static void
128nfsd4_sync_rec_dir(void)
NeilBrownc7b9a452005-06-23 22:04:30 -0700129{
Al Viroa63bb992008-08-02 01:03:36 -0400130 mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
131 nfsd_sync_dir(rec_dir.dentry);
132 mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700133}
134
135int
136nfsd4_create_clid_dir(struct nfs4_client *clp)
137{
David Howellsd84f4f92008-11-14 10:39:23 +1100138 const struct cred *original_cred;
NeilBrownc7b9a452005-06-23 22:04:30 -0700139 char *dname = clp->cl_recdir;
140 struct dentry *dentry;
NeilBrownc7b9a452005-06-23 22:04:30 -0700141 int status;
142
143 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
144
145 if (!rec_dir_init || clp->cl_firststate)
146 return 0;
147
David Howellsd84f4f92008-11-14 10:39:23 +1100148 status = nfs4_save_creds(&original_cred);
149 if (status < 0)
150 return status;
NeilBrownc7b9a452005-06-23 22:04:30 -0700151
152 /* lock the parent */
Al Viroa63bb992008-08-02 01:03:36 -0400153 mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700154
Al Viroa63bb992008-08-02 01:03:36 -0400155 dentry = lookup_one_len(dname, rec_dir.dentry, HEXDIR_LEN-1);
NeilBrownc7b9a452005-06-23 22:04:30 -0700156 if (IS_ERR(dentry)) {
157 status = PTR_ERR(dentry);
158 goto out_unlock;
159 }
160 status = -EEXIST;
161 if (dentry->d_inode) {
162 dprintk("NFSD: nfsd4_create_clid_dir: DIRECTORY EXISTS\n");
163 goto out_put;
164 }
Al Viroa63bb992008-08-02 01:03:36 -0400165 status = mnt_want_write(rec_dir.mnt);
Dave Hansen463c3192008-02-15 14:37:57 -0800166 if (status)
167 goto out_put;
Al Viroa63bb992008-08-02 01:03:36 -0400168 status = vfs_mkdir(rec_dir.dentry->d_inode, dentry, S_IRWXU);
169 mnt_drop_write(rec_dir.mnt);
NeilBrownc7b9a452005-06-23 22:04:30 -0700170out_put:
171 dput(dentry);
172out_unlock:
Al Viroa63bb992008-08-02 01:03:36 -0400173 mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700174 if (status == 0) {
175 clp->cl_firststate = 1;
NeilBrowna6ccbbb2005-07-07 17:59:11 -0700176 nfsd4_sync_rec_dir();
NeilBrownc7b9a452005-06-23 22:04:30 -0700177 }
David Howellsd84f4f92008-11-14 10:39:23 +1100178 nfs4_reset_creds(original_cred);
NeilBrownc7b9a452005-06-23 22:04:30 -0700179 dprintk("NFSD: nfsd4_create_clid_dir returns %d\n", status);
180 return status;
181}
182
NeilBrown190e4fb2005-06-23 22:04:25 -0700183typedef int (recdir_func)(struct dentry *, struct dentry *);
184
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400185struct name_list {
186 char name[HEXDIR_LEN];
NeilBrown190e4fb2005-06-23 22:04:25 -0700187 struct list_head list;
188};
189
NeilBrown190e4fb2005-06-23 22:04:25 -0700190static int
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400191nfsd4_build_namelist(void *arg, const char *name, int namlen,
David Howellsafefdbb2006-10-03 01:13:46 -0700192 loff_t offset, u64 ino, unsigned int d_type)
NeilBrown190e4fb2005-06-23 22:04:25 -0700193{
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400194 struct list_head *names = arg;
195 struct name_list *entry;
NeilBrown190e4fb2005-06-23 22:04:25 -0700196
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400197 if (namlen != HEXDIR_LEN - 1)
Al Virob37ad282006-10-19 23:28:59 -0700198 return 0;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400199 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
200 if (entry == NULL)
NeilBrown190e4fb2005-06-23 22:04:25 -0700201 return -ENOMEM;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400202 memcpy(entry->name, name, HEXDIR_LEN - 1);
203 entry->name[HEXDIR_LEN - 1] = '\0';
204 list_add(&entry->list, names);
NeilBrown190e4fb2005-06-23 22:04:25 -0700205 return 0;
206}
207
208static int
209nfsd4_list_rec_dir(struct dentry *dir, recdir_func *f)
210{
David Howellsd84f4f92008-11-14 10:39:23 +1100211 const struct cred *original_cred;
NeilBrown190e4fb2005-06-23 22:04:25 -0700212 struct file *filp;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400213 LIST_HEAD(names);
214 struct name_list *entry;
215 struct dentry *dentry;
NeilBrown190e4fb2005-06-23 22:04:25 -0700216 int status;
217
218 if (!rec_dir_init)
219 return 0;
220
David Howellsd84f4f92008-11-14 10:39:23 +1100221 status = nfs4_save_creds(&original_cred);
222 if (status < 0)
223 return status;
NeilBrown190e4fb2005-06-23 22:04:25 -0700224
David Howells745ca242008-11-14 10:39:22 +1100225 filp = dentry_open(dget(dir), mntget(rec_dir.mnt), O_RDONLY,
226 current_cred());
NeilBrown190e4fb2005-06-23 22:04:25 -0700227 status = PTR_ERR(filp);
228 if (IS_ERR(filp))
229 goto out;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400230 status = vfs_readdir(filp, nfsd4_build_namelist, &names);
NeilBrown190e4fb2005-06-23 22:04:25 -0700231 fput(filp);
J. Bruce Fields8daed1e2009-05-11 16:10:19 -0400232 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400233 while (!list_empty(&names)) {
234 entry = list_entry(names.next, struct name_list, list);
235
236 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
237 if (IS_ERR(dentry)) {
238 status = PTR_ERR(dentry);
David Woodhouse2f9092e2009-04-20 23:18:37 +0100239 break;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400240 }
241 status = f(dir, dentry);
242 dput(dentry);
NeilBrown190e4fb2005-06-23 22:04:25 -0700243 if (status)
David Woodhouse2f9092e2009-04-20 23:18:37 +0100244 break;
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400245 list_del(&entry->list);
246 kfree(entry);
NeilBrown190e4fb2005-06-23 22:04:25 -0700247 }
David Woodhouse2f9092e2009-04-20 23:18:37 +0100248 mutex_unlock(&dir->d_inode->i_mutex);
NeilBrown190e4fb2005-06-23 22:04:25 -0700249out:
J. Bruce Fields05f4f672009-03-13 16:02:59 -0400250 while (!list_empty(&names)) {
251 entry = list_entry(names.next, struct name_list, list);
252 list_del(&entry->list);
253 kfree(entry);
NeilBrown190e4fb2005-06-23 22:04:25 -0700254 }
David Howellsd84f4f92008-11-14 10:39:23 +1100255 nfs4_reset_creds(original_cred);
NeilBrown190e4fb2005-06-23 22:04:25 -0700256 return status;
257}
258
259static int
NeilBrownc7b9a452005-06-23 22:04:30 -0700260nfsd4_unlink_clid_dir(char *name, int namlen)
261{
262 struct dentry *dentry;
263 int status;
264
265 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
266
J. Bruce Fields8daed1e2009-05-11 16:10:19 -0400267 mutex_lock_nested(&rec_dir.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
Al Viroa63bb992008-08-02 01:03:36 -0400268 dentry = lookup_one_len(name, rec_dir.dentry, namlen);
NeilBrownc7b9a452005-06-23 22:04:30 -0700269 if (IS_ERR(dentry)) {
270 status = PTR_ERR(dentry);
David Woodhouse2f9092e2009-04-20 23:18:37 +0100271 goto out_unlock;
NeilBrownc7b9a452005-06-23 22:04:30 -0700272 }
273 status = -ENOENT;
274 if (!dentry->d_inode)
275 goto out;
David Woodhouse2f9092e2009-04-20 23:18:37 +0100276 status = vfs_rmdir(rec_dir.dentry->d_inode, dentry);
NeilBrownc7b9a452005-06-23 22:04:30 -0700277out:
278 dput(dentry);
David Woodhouse2f9092e2009-04-20 23:18:37 +0100279out_unlock:
280 mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
NeilBrownc7b9a452005-06-23 22:04:30 -0700281 return status;
282}
283
284void
285nfsd4_remove_clid_dir(struct nfs4_client *clp)
286{
David Howellsd84f4f92008-11-14 10:39:23 +1100287 const struct cred *original_cred;
NeilBrownc7b9a452005-06-23 22:04:30 -0700288 int status;
289
290 if (!rec_dir_init || !clp->cl_firststate)
291 return;
292
Al Viroa63bb992008-08-02 01:03:36 -0400293 status = mnt_want_write(rec_dir.mnt);
Dave Hansen06227532008-02-15 14:37:34 -0800294 if (status)
295 goto out;
NeilBrown67be4312005-07-07 17:59:13 -0700296 clp->cl_firststate = 0;
David Howellsd84f4f92008-11-14 10:39:23 +1100297
298 status = nfs4_save_creds(&original_cred);
299 if (status < 0)
300 goto out;
301
NeilBrownc7b9a452005-06-23 22:04:30 -0700302 status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
David Howellsd84f4f92008-11-14 10:39:23 +1100303 nfs4_reset_creds(original_cred);
NeilBrownc7b9a452005-06-23 22:04:30 -0700304 if (status == 0)
NeilBrowna6ccbbb2005-07-07 17:59:11 -0700305 nfsd4_sync_rec_dir();
Al Viroa63bb992008-08-02 01:03:36 -0400306 mnt_drop_write(rec_dir.mnt);
Dave Hansen06227532008-02-15 14:37:34 -0800307out:
NeilBrownc7b9a452005-06-23 22:04:30 -0700308 if (status)
309 printk("NFSD: Failed to remove expired client state directory"
310 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
311 return;
312}
313
314static int
315purge_old(struct dentry *parent, struct dentry *child)
316{
317 int status;
318
Andy Adamsona1bcecd2009-04-03 08:28:05 +0300319 /* note: we currently use this path only for minorversion 0 */
320 if (nfs4_has_reclaimed_state(child->d_name.name, false))
Al Virob37ad282006-10-19 23:28:59 -0700321 return 0;
NeilBrownc7b9a452005-06-23 22:04:30 -0700322
David Woodhouse2f9092e2009-04-20 23:18:37 +0100323 status = vfs_rmdir(parent->d_inode, child);
NeilBrownc7b9a452005-06-23 22:04:30 -0700324 if (status)
325 printk("failed to remove client recovery directory %s\n",
326 child->d_name.name);
327 /* Keep trying, success or failure: */
Al Virob37ad282006-10-19 23:28:59 -0700328 return 0;
NeilBrownc7b9a452005-06-23 22:04:30 -0700329}
330
331void
332nfsd4_recdir_purge_old(void) {
333 int status;
334
335 if (!rec_dir_init)
336 return;
Al Viroa63bb992008-08-02 01:03:36 -0400337 status = mnt_want_write(rec_dir.mnt);
Dave Hansen06227532008-02-15 14:37:34 -0800338 if (status)
339 goto out;
Al Viroa63bb992008-08-02 01:03:36 -0400340 status = nfsd4_list_rec_dir(rec_dir.dentry, purge_old);
NeilBrownc7b9a452005-06-23 22:04:30 -0700341 if (status == 0)
NeilBrowna6ccbbb2005-07-07 17:59:11 -0700342 nfsd4_sync_rec_dir();
Al Viroa63bb992008-08-02 01:03:36 -0400343 mnt_drop_write(rec_dir.mnt);
Dave Hansen06227532008-02-15 14:37:34 -0800344out:
NeilBrownc7b9a452005-06-23 22:04:30 -0700345 if (status)
346 printk("nfsd4: failed to purge old clients from recovery"
Al Viroa63bb992008-08-02 01:03:36 -0400347 " directory %s\n", rec_dir.dentry->d_name.name);
NeilBrownc7b9a452005-06-23 22:04:30 -0700348}
349
350static int
NeilBrown190e4fb2005-06-23 22:04:25 -0700351load_recdir(struct dentry *parent, struct dentry *child)
352{
353 if (child->d_name.len != HEXDIR_LEN - 1) {
354 printk("nfsd4: illegal name %s in recovery directory\n",
355 child->d_name.name);
356 /* Keep trying; maybe the others are OK: */
Al Virob37ad282006-10-19 23:28:59 -0700357 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -0700358 }
359 nfs4_client_to_reclaim(child->d_name.name);
Al Virob37ad282006-10-19 23:28:59 -0700360 return 0;
NeilBrown190e4fb2005-06-23 22:04:25 -0700361}
362
363int
364nfsd4_recdir_load(void) {
365 int status;
366
Al Viroa63bb992008-08-02 01:03:36 -0400367 status = nfsd4_list_rec_dir(rec_dir.dentry, load_recdir);
NeilBrown190e4fb2005-06-23 22:04:25 -0700368 if (status)
369 printk("nfsd4: failed loading clients from recovery"
Al Viroa63bb992008-08-02 01:03:36 -0400370 " directory %s\n", rec_dir.dentry->d_name.name);
NeilBrown190e4fb2005-06-23 22:04:25 -0700371 return status;
372}
373
374/*
375 * Hold reference to the recovery directory.
376 */
377
378void
379nfsd4_init_recdir(char *rec_dirname)
380{
David Howellsd84f4f92008-11-14 10:39:23 +1100381 const struct cred *original_cred;
382 int status;
NeilBrown190e4fb2005-06-23 22:04:25 -0700383
384 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
385 rec_dirname);
386
387 BUG_ON(rec_dir_init);
388
David Howellsd84f4f92008-11-14 10:39:23 +1100389 status = nfs4_save_creds(&original_cred);
390 if (status < 0) {
391 printk("NFSD: Unable to change credentials to find recovery"
392 " directory: error %d\n",
393 status);
394 return;
395 }
NeilBrown190e4fb2005-06-23 22:04:25 -0700396
Al Viroa63bb992008-08-02 01:03:36 -0400397 status = kern_path(rec_dirname, LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
J. Bruce Fieldsc2642ab2006-01-18 17:43:29 -0800398 &rec_dir);
399 if (status)
400 printk("NFSD: unable to find recovery directory %s\n",
NeilBrown190e4fb2005-06-23 22:04:25 -0700401 rec_dirname);
402
403 if (!status)
404 rec_dir_init = 1;
David Howellsd84f4f92008-11-14 10:39:23 +1100405 nfs4_reset_creds(original_cred);
NeilBrown190e4fb2005-06-23 22:04:25 -0700406}
407
408void
409nfsd4_shutdown_recdir(void)
410{
411 if (!rec_dir_init)
412 return;
413 rec_dir_init = 0;
Al Viroa63bb992008-08-02 01:03:36 -0400414 path_put(&rec_dir);
NeilBrown190e4fb2005-06-23 22:04:25 -0700415}