48742f243c25c92ed01064fa2f3b9ba358ddadd8
[safe/jmp/linux-2.6] / fs / nfsd / nfs4recover.c
1 /*
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
36 #include <linux/nfsd/nfsd.h>
37 #include <linux/nfsd/state.h>
38 #include <linux/file.h>
39 #include <linux/namei.h>
40 #include <linux/crypto.h>
41 #include <linux/sched.h>
42 #include "vfs.h"
43
44 #define NFSDDBG_FACILITY                NFSDDBG_PROC
45
46 /* Globals */
47 static struct path rec_dir;
48 static int rec_dir_init = 0;
49
50 static int
51 nfs4_save_creds(const struct cred **original_creds)
52 {
53         struct cred *new;
54
55         new = prepare_creds();
56         if (!new)
57                 return -ENOMEM;
58
59         new->fsuid = 0;
60         new->fsgid = 0;
61         *original_creds = override_creds(new);
62         put_cred(new);
63         return 0;
64 }
65
66 static void
67 nfs4_reset_creds(const struct cred *original)
68 {
69         revert_creds(original);
70 }
71
72 static void
73 md5_to_hex(char *out, char *md5)
74 {
75         int i;
76
77         for (i=0; i<16; i++) {
78                 unsigned char c = md5[i];
79
80                 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
81                 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
82         }
83         *out = '\0';
84 }
85
86 __be32
87 nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
88 {
89         struct xdr_netobj cksum;
90         struct hash_desc desc;
91         struct scatterlist sg;
92         __be32 status = nfserr_resource;
93
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);
98         if (IS_ERR(desc.tfm))
99                 goto out_no_tfm;
100         cksum.len = crypto_hash_digestsize(desc.tfm);
101         cksum.data = kmalloc(cksum.len, GFP_KERNEL);
102         if (cksum.data == NULL)
103                 goto out;
104
105         sg_init_one(&sg, clname->data, clname->len);
106
107         if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
108                 goto out;
109
110         md5_to_hex(dname, cksum.data);
111
112         status = nfs_ok;
113 out:
114         kfree(cksum.data);
115         crypto_free_hash(desc.tfm);
116 out_no_tfm:
117         return status;
118 }
119
120 static void
121 nfsd4_sync_rec_dir(void)
122 {
123         mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
124         nfsd_sync_dir(rec_dir.dentry);
125         mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
126 }
127
128 int
129 nfsd4_create_clid_dir(struct nfs4_client *clp)
130 {
131         const struct cred *original_cred;
132         char *dname = clp->cl_recdir;
133         struct dentry *dentry;
134         int status;
135
136         dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
137
138         if (!rec_dir_init || clp->cl_firststate)
139                 return 0;
140
141         status = nfs4_save_creds(&original_cred);
142         if (status < 0)
143                 return status;
144
145         /* lock the parent */
146         mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
147
148         dentry = lookup_one_len(dname, rec_dir.dentry, HEXDIR_LEN-1);
149         if (IS_ERR(dentry)) {
150                 status = PTR_ERR(dentry);
151                 goto out_unlock;
152         }
153         status = -EEXIST;
154         if (dentry->d_inode) {
155                 dprintk("NFSD: nfsd4_create_clid_dir: DIRECTORY EXISTS\n");
156                 goto out_put;
157         }
158         status = mnt_want_write(rec_dir.mnt);
159         if (status)
160                 goto out_put;
161         status = vfs_mkdir(rec_dir.dentry->d_inode, dentry, S_IRWXU);
162         mnt_drop_write(rec_dir.mnt);
163 out_put:
164         dput(dentry);
165 out_unlock:
166         mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
167         if (status == 0) {
168                 clp->cl_firststate = 1;
169                 nfsd4_sync_rec_dir();
170         }
171         nfs4_reset_creds(original_cred);
172         dprintk("NFSD: nfsd4_create_clid_dir returns %d\n", status);
173         return status;
174 }
175
176 typedef int (recdir_func)(struct dentry *, struct dentry *);
177
178 struct name_list {
179         char name[HEXDIR_LEN];
180         struct list_head list;
181 };
182
183 static int
184 nfsd4_build_namelist(void *arg, const char *name, int namlen,
185                 loff_t offset, u64 ino, unsigned int d_type)
186 {
187         struct list_head *names = arg;
188         struct name_list *entry;
189
190         if (namlen != HEXDIR_LEN - 1)
191                 return 0;
192         entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
193         if (entry == NULL)
194                 return -ENOMEM;
195         memcpy(entry->name, name, HEXDIR_LEN - 1);
196         entry->name[HEXDIR_LEN - 1] = '\0';
197         list_add(&entry->list, names);
198         return 0;
199 }
200
201 static int
202 nfsd4_list_rec_dir(struct dentry *dir, recdir_func *f)
203 {
204         const struct cred *original_cred;
205         struct file *filp;
206         LIST_HEAD(names);
207         struct name_list *entry;
208         struct dentry *dentry;
209         int status;
210
211         if (!rec_dir_init)
212                 return 0;
213
214         status = nfs4_save_creds(&original_cred);
215         if (status < 0)
216                 return status;
217
218         filp = dentry_open(dget(dir), mntget(rec_dir.mnt), O_RDONLY,
219                            current_cred());
220         status = PTR_ERR(filp);
221         if (IS_ERR(filp))
222                 goto out;
223         status = vfs_readdir(filp, nfsd4_build_namelist, &names);
224         fput(filp);
225         mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
226         while (!list_empty(&names)) {
227                 entry = list_entry(names.next, struct name_list, list);
228
229                 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
230                 if (IS_ERR(dentry)) {
231                         status = PTR_ERR(dentry);
232                         break;
233                 }
234                 status = f(dir, dentry);
235                 dput(dentry);
236                 if (status)
237                         break;
238                 list_del(&entry->list);
239                 kfree(entry);
240         }
241         mutex_unlock(&dir->d_inode->i_mutex);
242 out:
243         while (!list_empty(&names)) {
244                 entry = list_entry(names.next, struct name_list, list);
245                 list_del(&entry->list);
246                 kfree(entry);
247         }
248         nfs4_reset_creds(original_cred);
249         return status;
250 }
251
252 static int
253 nfsd4_unlink_clid_dir(char *name, int namlen)
254 {
255         struct dentry *dentry;
256         int status;
257
258         dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
259
260         mutex_lock_nested(&rec_dir.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
261         dentry = lookup_one_len(name, rec_dir.dentry, namlen);
262         if (IS_ERR(dentry)) {
263                 status = PTR_ERR(dentry);
264                 goto out_unlock;
265         }
266         status = -ENOENT;
267         if (!dentry->d_inode)
268                 goto out;
269         status = vfs_rmdir(rec_dir.dentry->d_inode, dentry);
270 out:
271         dput(dentry);
272 out_unlock:
273         mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
274         return status;
275 }
276
277 void
278 nfsd4_remove_clid_dir(struct nfs4_client *clp)
279 {
280         const struct cred *original_cred;
281         int status;
282
283         if (!rec_dir_init || !clp->cl_firststate)
284                 return;
285
286         status = mnt_want_write(rec_dir.mnt);
287         if (status)
288                 goto out;
289         clp->cl_firststate = 0;
290
291         status = nfs4_save_creds(&original_cred);
292         if (status < 0)
293                 goto out;
294
295         status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
296         nfs4_reset_creds(original_cred);
297         if (status == 0)
298                 nfsd4_sync_rec_dir();
299         mnt_drop_write(rec_dir.mnt);
300 out:
301         if (status)
302                 printk("NFSD: Failed to remove expired client state directory"
303                                 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
304         return;
305 }
306
307 static int
308 purge_old(struct dentry *parent, struct dentry *child)
309 {
310         int status;
311
312         /* note: we currently use this path only for minorversion 0 */
313         if (nfs4_has_reclaimed_state(child->d_name.name, false))
314                 return 0;
315
316         status = vfs_rmdir(parent->d_inode, child);
317         if (status)
318                 printk("failed to remove client recovery directory %s\n",
319                                 child->d_name.name);
320         /* Keep trying, success or failure: */
321         return 0;
322 }
323
324 void
325 nfsd4_recdir_purge_old(void) {
326         int status;
327
328         if (!rec_dir_init)
329                 return;
330         status = mnt_want_write(rec_dir.mnt);
331         if (status)
332                 goto out;
333         status = nfsd4_list_rec_dir(rec_dir.dentry, purge_old);
334         if (status == 0)
335                 nfsd4_sync_rec_dir();
336         mnt_drop_write(rec_dir.mnt);
337 out:
338         if (status)
339                 printk("nfsd4: failed to purge old clients from recovery"
340                         " directory %s\n", rec_dir.dentry->d_name.name);
341 }
342
343 static int
344 load_recdir(struct dentry *parent, struct dentry *child)
345 {
346         if (child->d_name.len != HEXDIR_LEN - 1) {
347                 printk("nfsd4: illegal name %s in recovery directory\n",
348                                 child->d_name.name);
349                 /* Keep trying; maybe the others are OK: */
350                 return 0;
351         }
352         nfs4_client_to_reclaim(child->d_name.name);
353         return 0;
354 }
355
356 int
357 nfsd4_recdir_load(void) {
358         int status;
359
360         status = nfsd4_list_rec_dir(rec_dir.dentry, load_recdir);
361         if (status)
362                 printk("nfsd4: failed loading clients from recovery"
363                         " directory %s\n", rec_dir.dentry->d_name.name);
364         return status;
365 }
366
367 /*
368  * Hold reference to the recovery directory.
369  */
370
371 void
372 nfsd4_init_recdir(char *rec_dirname)
373 {
374         const struct cred *original_cred;
375         int status;
376
377         printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
378                         rec_dirname);
379
380         BUG_ON(rec_dir_init);
381
382         status = nfs4_save_creds(&original_cred);
383         if (status < 0) {
384                 printk("NFSD: Unable to change credentials to find recovery"
385                        " directory: error %d\n",
386                        status);
387                 return;
388         }
389
390         status = kern_path(rec_dirname, LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
391                         &rec_dir);
392         if (status)
393                 printk("NFSD: unable to find recovery directory %s\n",
394                                 rec_dirname);
395
396         if (!status)
397                 rec_dir_init = 1;
398         nfs4_reset_creds(original_cred);
399 }
400
401 void
402 nfsd4_shutdown_recdir(void)
403 {
404         if (!rec_dir_init)
405                 return;
406         rec_dir_init = 0;
407         path_put(&rec_dir);
408 }