2 * linux/fs/nfsd/nfs4recover.c
4 * Copyright (c) 2004 The Regents of the University of Michigan.
7 * Andy Adamson <andros@citi.umich.edu>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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.
36 #include <linux/err.h>
37 #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>
42 #include <linux/param.h>
43 #include <linux/file.h>
44 #include <linux/namei.h>
45 #include <asm/uaccess.h>
46 #include <linux/scatterlist.h>
47 #include <linux/crypto.h>
48 #include <linux/sched.h>
50 #define NFSDDBG_FACILITY NFSDDBG_PROC
53 static struct nameidata rec_dir;
54 static int rec_dir_init = 0;
57 nfs4_save_user(uid_t *saveuid, gid_t *savegid)
59 *saveuid = current->fsuid;
60 *savegid = current->fsgid;
66 nfs4_reset_user(uid_t saveuid, gid_t savegid)
68 current->fsuid = saveuid;
69 current->fsgid = savegid;
73 md5_to_hex(char *out, char *md5)
77 for (i=0; i<16; i++) {
78 unsigned char c = md5[i];
80 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
81 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
87 nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
89 struct xdr_netobj cksum;
90 struct hash_desc desc;
91 struct scatterlist sg;
92 __be32 status = nfserr_resource;
94 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
95 clname->len, clname->data);
96 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
97 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
100 cksum.len = crypto_hash_digestsize(desc.tfm);
101 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
102 if (cksum.data == NULL)
105 sg_init_one(&sg, clname->data, clname->len);
107 if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
110 md5_to_hex(dname, cksum.data);
115 crypto_free_hash(desc.tfm);
121 nfsd4_sync_rec_dir(void)
123 mutex_lock(&rec_dir.path.dentry->d_inode->i_mutex);
124 nfsd_sync_dir(rec_dir.path.dentry);
125 mutex_unlock(&rec_dir.path.dentry->d_inode->i_mutex);
129 nfsd4_create_clid_dir(struct nfs4_client *clp)
131 char *dname = clp->cl_recdir;
132 struct dentry *dentry;
137 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
139 if (!rec_dir_init || clp->cl_firststate)
142 nfs4_save_user(&uid, &gid);
144 /* lock the parent */
145 mutex_lock(&rec_dir.path.dentry->d_inode->i_mutex);
147 dentry = lookup_one_len(dname, rec_dir.path.dentry, HEXDIR_LEN-1);
148 if (IS_ERR(dentry)) {
149 status = PTR_ERR(dentry);
153 if (dentry->d_inode) {
154 dprintk("NFSD: nfsd4_create_clid_dir: DIRECTORY EXISTS\n");
157 status = vfs_mkdir(rec_dir.path.dentry->d_inode, dentry, S_IRWXU);
161 mutex_unlock(&rec_dir.path.dentry->d_inode->i_mutex);
163 clp->cl_firststate = 1;
164 nfsd4_sync_rec_dir();
166 nfs4_reset_user(uid, gid);
167 dprintk("NFSD: nfsd4_create_clid_dir returns %d\n", status);
171 typedef int (recdir_func)(struct dentry *, struct dentry *);
174 struct dentry *dentry;
175 struct list_head list;
178 struct dentry_list_arg {
179 struct list_head dentries;
180 struct dentry *parent;
184 nfsd4_build_dentrylist(void *arg, const char *name, int namlen,
185 loff_t offset, u64 ino, unsigned int d_type)
187 struct dentry_list_arg *dla = arg;
188 struct list_head *dentries = &dla->dentries;
189 struct dentry *parent = dla->parent;
190 struct dentry *dentry;
191 struct dentry_list *child;
193 if (name && isdotent(name, namlen))
195 dentry = lookup_one_len(name, parent, namlen);
197 return PTR_ERR(dentry);
198 child = kmalloc(sizeof(*child), GFP_KERNEL);
201 child->dentry = dentry;
202 list_add(&child->list, dentries);
207 nfsd4_list_rec_dir(struct dentry *dir, recdir_func *f)
210 struct dentry_list_arg dla = {
213 struct list_head *dentries = &dla.dentries;
214 struct dentry_list *child;
222 nfs4_save_user(&uid, &gid);
224 filp = dentry_open(dget(dir), mntget(rec_dir.path.mnt), O_RDONLY);
225 status = PTR_ERR(filp);
228 INIT_LIST_HEAD(dentries);
229 status = vfs_readdir(filp, nfsd4_build_dentrylist, &dla);
231 while (!list_empty(dentries)) {
232 child = list_entry(dentries->next, struct dentry_list, list);
233 status = f(dir, child->dentry);
236 list_del(&child->list);
241 while (!list_empty(dentries)) {
242 child = list_entry(dentries->next, struct dentry_list, list);
243 list_del(&child->list);
247 nfs4_reset_user(uid, gid);
252 nfsd4_remove_clid_file(struct dentry *dir, struct dentry *dentry)
256 if (!S_ISREG(dir->d_inode->i_mode)) {
257 printk("nfsd4: non-file found in client recovery directory\n");
260 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
261 status = vfs_unlink(dir->d_inode, dentry);
262 mutex_unlock(&dir->d_inode->i_mutex);
267 nfsd4_clear_clid_dir(struct dentry *dir, struct dentry *dentry)
271 /* For now this directory should already be empty, but we empty it of
272 * any regular files anyway, just in case the directory was created by
273 * a kernel from the future.... */
274 nfsd4_list_rec_dir(dentry, nfsd4_remove_clid_file);
275 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
276 status = vfs_rmdir(dir->d_inode, dentry);
277 mutex_unlock(&dir->d_inode->i_mutex);
282 nfsd4_unlink_clid_dir(char *name, int namlen)
284 struct dentry *dentry;
287 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
289 mutex_lock(&rec_dir.path.dentry->d_inode->i_mutex);
290 dentry = lookup_one_len(name, rec_dir.path.dentry, namlen);
291 mutex_unlock(&rec_dir.path.dentry->d_inode->i_mutex);
292 if (IS_ERR(dentry)) {
293 status = PTR_ERR(dentry);
297 if (!dentry->d_inode)
300 status = nfsd4_clear_clid_dir(rec_dir.path.dentry, dentry);
307 nfsd4_remove_clid_dir(struct nfs4_client *clp)
313 if (!rec_dir_init || !clp->cl_firststate)
316 clp->cl_firststate = 0;
317 nfs4_save_user(&uid, &gid);
318 status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
319 nfs4_reset_user(uid, gid);
321 nfsd4_sync_rec_dir();
323 printk("NFSD: Failed to remove expired client state directory"
324 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
329 purge_old(struct dentry *parent, struct dentry *child)
333 if (nfs4_has_reclaimed_state(child->d_name.name))
336 status = nfsd4_clear_clid_dir(parent, child);
338 printk("failed to remove client recovery directory %s\n",
340 /* Keep trying, success or failure: */
345 nfsd4_recdir_purge_old(void) {
350 status = nfsd4_list_rec_dir(rec_dir.path.dentry, purge_old);
352 nfsd4_sync_rec_dir();
354 printk("nfsd4: failed to purge old clients from recovery"
355 " directory %s\n", rec_dir.path.dentry->d_name.name);
360 load_recdir(struct dentry *parent, struct dentry *child)
362 if (child->d_name.len != HEXDIR_LEN - 1) {
363 printk("nfsd4: illegal name %s in recovery directory\n",
365 /* Keep trying; maybe the others are OK: */
368 nfs4_client_to_reclaim(child->d_name.name);
373 nfsd4_recdir_load(void) {
376 status = nfsd4_list_rec_dir(rec_dir.path.dentry, load_recdir);
378 printk("nfsd4: failed loading clients from recovery"
379 " directory %s\n", rec_dir.path.dentry->d_name.name);
384 * Hold reference to the recovery directory.
388 nfsd4_init_recdir(char *rec_dirname)
394 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
397 BUG_ON(rec_dir_init);
399 nfs4_save_user(&uid, &gid);
401 status = path_lookup(rec_dirname, LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
404 printk("NFSD: unable to find recovery directory %s\n",
409 nfs4_reset_user(uid, gid);
413 nfsd4_shutdown_recdir(void)
418 path_put(&rec_dir.path);