]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/nfsd/nfs4recover.c
nfsd: convert nfs4_client->cl_cb_flags to a generic flags field
[mirror_ubuntu-jammy-kernel.git] / fs / nfsd / nfs4recover.c
CommitLineData
a55370a3 1/*
a55370a3
N
2* Copyright (c) 2004 The Regents of the University of Michigan.
3* All rights reserved.
4*
5* Andy Adamson <andros@citi.umich.edu>
6*
7* Redistribution and use in source and binary forms, with or without
8* modification, are permitted provided that the following conditions
9* are met:
10*
11* 1. Redistributions of source code must retain the above copyright
12* notice, this list of conditions and the following disclaimer.
13* 2. Redistributions in binary form must reproduce the above copyright
14* notice, this list of conditions and the following disclaimer in the
15* documentation and/or other materials provided with the distribution.
16* 3. Neither the name of the University nor the names of its
17* contributors may be used to endorse or promote products derived
18* from this software without specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
21* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31*
32*/
33
190e4fbf 34#include <linux/file.h>
5a0e3ad6 35#include <linux/slab.h>
190e4fbf 36#include <linux/namei.h>
a55370a3 37#include <linux/crypto.h>
e8edc6e0 38#include <linux/sched.h>
9a74af21
BH
39
40#include "nfsd.h"
41#include "state.h"
0a3adade 42#include "vfs.h"
a55370a3
N
43
44#define NFSDDBG_FACILITY NFSDDBG_PROC
45
190e4fbf 46/* Globals */
e970a573 47static struct file *rec_file;
48483bf2 48static char user_recovery_dirname[PATH_MAX] = "/var/lib/nfs/v4recovery";
190e4fbf 49
d84f4f99
DH
50static int
51nfs4_save_creds(const struct cred **original_creds)
190e4fbf 52{
d84f4f99
DH
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;
190e4fbf
N
64}
65
66static void
d84f4f99 67nfs4_reset_creds(const struct cred *original)
190e4fbf 68{
d84f4f99 69 revert_creds(original);
190e4fbf
N
70}
71
a55370a3
N
72static void
73md5_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
b37ad28b 86__be32
a55370a3
N
87nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
88{
89 struct xdr_netobj cksum;
35058687 90 struct hash_desc desc;
60c74f81 91 struct scatterlist sg;
3e772463 92 __be32 status = nfserr_jukebox;
a55370a3
N
93
94 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
95 clname->len, clname->data);
35058687
HX
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);
a55370a3
N
101 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
102 if (cksum.data == NULL)
103 goto out;
a55370a3 104
60c74f81 105 sg_init_one(&sg, clname->data, clname->len);
a55370a3 106
60c74f81 107 if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
35058687 108 goto out;
a55370a3
N
109
110 md5_to_hex(dname, cksum.data);
111
a55370a3
N
112 status = nfs_ok;
113out:
2bd9e7b6 114 kfree(cksum.data);
35058687
HX
115 crypto_free_hash(desc.tfm);
116out_no_tfm:
a55370a3
N
117 return status;
118}
190e4fbf 119
7a6ef8c7 120void nfsd4_create_clid_dir(struct nfs4_client *clp)
c7b9a459 121{
d84f4f99 122 const struct cred *original_cred;
c7b9a459 123 char *dname = clp->cl_recdir;
e970a573 124 struct dentry *dir, *dentry;
c7b9a459
N
125 int status;
126
127 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
128
a52d726b 129 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
7a6ef8c7 130 return;
b8548894 131 if (!rec_file)
7a6ef8c7 132 return;
d84f4f99
DH
133 status = nfs4_save_creds(&original_cred);
134 if (status < 0)
7a6ef8c7 135 return;
c7b9a459 136
e970a573 137 dir = rec_file->f_path.dentry;
c7b9a459 138 /* lock the parent */
e970a573 139 mutex_lock(&dir->d_inode->i_mutex);
c7b9a459 140
e970a573 141 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
c7b9a459
N
142 if (IS_ERR(dentry)) {
143 status = PTR_ERR(dentry);
144 goto out_unlock;
145 }
6577aac0 146 if (dentry->d_inode)
aec39680
BF
147 /*
148 * In the 4.1 case, where we're called from
149 * reclaim_complete(), records from the previous reboot
150 * may still be left, so this is OK.
151 *
152 * In the 4.0 case, we should never get here; but we may
153 * as well be forgiving and just succeed silently.
154 */
c7b9a459 155 goto out_put;
a561be71 156 status = mnt_want_write_file(rec_file);
463c3197
DH
157 if (status)
158 goto out_put;
e970a573 159 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
2a79f17e 160 mnt_drop_write_file(rec_file);
c7b9a459
N
161out_put:
162 dput(dentry);
163out_unlock:
e970a573 164 mutex_unlock(&dir->d_inode->i_mutex);
6577aac0 165 if (status == 0)
8018ab05 166 vfs_fsync(rec_file, 0);
6577aac0
BH
167 else
168 printk(KERN_ERR "NFSD: failed to write recovery record"
169 " (err %d); please check that %s exists"
170 " and is writeable", status,
171 user_recovery_dirname);
d84f4f99 172 nfs4_reset_creds(original_cred);
c7b9a459
N
173}
174
190e4fbf
N
175typedef int (recdir_func)(struct dentry *, struct dentry *);
176
05f4f678
BF
177struct name_list {
178 char name[HEXDIR_LEN];
190e4fbf
N
179 struct list_head list;
180};
181
190e4fbf 182static int
05f4f678 183nfsd4_build_namelist(void *arg, const char *name, int namlen,
afefdbb2 184 loff_t offset, u64 ino, unsigned int d_type)
190e4fbf 185{
05f4f678
BF
186 struct list_head *names = arg;
187 struct name_list *entry;
190e4fbf 188
05f4f678 189 if (namlen != HEXDIR_LEN - 1)
b37ad28b 190 return 0;
05f4f678
BF
191 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
192 if (entry == NULL)
190e4fbf 193 return -ENOMEM;
05f4f678
BF
194 memcpy(entry->name, name, HEXDIR_LEN - 1);
195 entry->name[HEXDIR_LEN - 1] = '\0';
196 list_add(&entry->list, names);
190e4fbf
N
197 return 0;
198}
199
200static int
5b4b299c 201nfsd4_list_rec_dir(recdir_func *f)
190e4fbf 202{
d84f4f99 203 const struct cred *original_cred;
5b4b299c 204 struct dentry *dir = rec_file->f_path.dentry;
05f4f678 205 LIST_HEAD(names);
190e4fbf
N
206 int status;
207
d84f4f99
DH
208 status = nfs4_save_creds(&original_cred);
209 if (status < 0)
210 return status;
190e4fbf 211
5b4b299c
AV
212 status = vfs_llseek(rec_file, 0, SEEK_SET);
213 if (status < 0) {
214 nfs4_reset_creds(original_cred);
215 return status;
216 }
217
218 status = vfs_readdir(rec_file, nfsd4_build_namelist, &names);
8daed1e5 219 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
05f4f678 220 while (!list_empty(&names)) {
5b4b299c 221 struct name_list *entry;
05f4f678 222 entry = list_entry(names.next, struct name_list, list);
5b4b299c
AV
223 if (!status) {
224 struct dentry *dentry;
225 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
226 if (IS_ERR(dentry)) {
227 status = PTR_ERR(dentry);
228 break;
229 }
230 status = f(dir, dentry);
231 dput(dentry);
05f4f678 232 }
05f4f678
BF
233 list_del(&entry->list);
234 kfree(entry);
190e4fbf 235 }
2f9092e1 236 mutex_unlock(&dir->d_inode->i_mutex);
d84f4f99 237 nfs4_reset_creds(original_cred);
190e4fbf
N
238 return status;
239}
240
c7b9a459
N
241static int
242nfsd4_unlink_clid_dir(char *name, int namlen)
243{
e970a573 244 struct dentry *dir, *dentry;
c7b9a459
N
245 int status;
246
247 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
248
e970a573
CH
249 dir = rec_file->f_path.dentry;
250 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
251 dentry = lookup_one_len(name, dir, namlen);
c7b9a459
N
252 if (IS_ERR(dentry)) {
253 status = PTR_ERR(dentry);
2f9092e1 254 goto out_unlock;
c7b9a459
N
255 }
256 status = -ENOENT;
257 if (!dentry->d_inode)
258 goto out;
e970a573 259 status = vfs_rmdir(dir->d_inode, dentry);
c7b9a459
N
260out:
261 dput(dentry);
2f9092e1 262out_unlock:
e970a573 263 mutex_unlock(&dir->d_inode->i_mutex);
c7b9a459
N
264 return status;
265}
266
267void
268nfsd4_remove_clid_dir(struct nfs4_client *clp)
269{
d84f4f99 270 const struct cred *original_cred;
c7b9a459
N
271 int status;
272
a52d726b 273 if (!rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
c7b9a459
N
274 return;
275
a561be71 276 status = mnt_want_write_file(rec_file);
0622753b
DH
277 if (status)
278 goto out;
a52d726b 279 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
d84f4f99
DH
280
281 status = nfs4_save_creds(&original_cred);
282 if (status < 0)
283 goto out;
284
c7b9a459 285 status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
d84f4f99 286 nfs4_reset_creds(original_cred);
c7b9a459 287 if (status == 0)
8018ab05 288 vfs_fsync(rec_file, 0);
2a79f17e 289 mnt_drop_write_file(rec_file);
0622753b 290out:
c7b9a459
N
291 if (status)
292 printk("NFSD: Failed to remove expired client state directory"
293 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
294 return;
295}
296
297static int
298purge_old(struct dentry *parent, struct dentry *child)
299{
300 int status;
301
a1bcecd2 302 if (nfs4_has_reclaimed_state(child->d_name.name, false))
b37ad28b 303 return 0;
c7b9a459 304
2f9092e1 305 status = vfs_rmdir(parent->d_inode, child);
c7b9a459
N
306 if (status)
307 printk("failed to remove client recovery directory %s\n",
308 child->d_name.name);
309 /* Keep trying, success or failure: */
b37ad28b 310 return 0;
c7b9a459
N
311}
312
313void
314nfsd4_recdir_purge_old(void) {
315 int status;
316
e970a573 317 if (!rec_file)
c7b9a459 318 return;
a561be71 319 status = mnt_want_write_file(rec_file);
0622753b
DH
320 if (status)
321 goto out;
5b4b299c 322 status = nfsd4_list_rec_dir(purge_old);
c7b9a459 323 if (status == 0)
8018ab05 324 vfs_fsync(rec_file, 0);
2a79f17e 325 mnt_drop_write_file(rec_file);
0622753b 326out:
c7b9a459
N
327 if (status)
328 printk("nfsd4: failed to purge old clients from recovery"
e970a573 329 " directory %s\n", rec_file->f_path.dentry->d_name.name);
c7b9a459
N
330}
331
190e4fbf
N
332static int
333load_recdir(struct dentry *parent, struct dentry *child)
334{
335 if (child->d_name.len != HEXDIR_LEN - 1) {
336 printk("nfsd4: illegal name %s in recovery directory\n",
337 child->d_name.name);
338 /* Keep trying; maybe the others are OK: */
b37ad28b 339 return 0;
190e4fbf
N
340 }
341 nfs4_client_to_reclaim(child->d_name.name);
b37ad28b 342 return 0;
190e4fbf
N
343}
344
345int
346nfsd4_recdir_load(void) {
347 int status;
348
e970a573
CH
349 if (!rec_file)
350 return 0;
351
5b4b299c 352 status = nfsd4_list_rec_dir(load_recdir);
190e4fbf
N
353 if (status)
354 printk("nfsd4: failed loading clients from recovery"
e970a573 355 " directory %s\n", rec_file->f_path.dentry->d_name.name);
190e4fbf
N
356 return status;
357}
358
359/*
360 * Hold reference to the recovery directory.
361 */
362
363void
48483bf2 364nfsd4_init_recdir()
190e4fbf 365{
d84f4f99
DH
366 const struct cred *original_cred;
367 int status;
190e4fbf
N
368
369 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
48483bf2 370 user_recovery_dirname);
190e4fbf 371
e970a573 372 BUG_ON(rec_file);
190e4fbf 373
d84f4f99
DH
374 status = nfs4_save_creds(&original_cred);
375 if (status < 0) {
376 printk("NFSD: Unable to change credentials to find recovery"
377 " directory: error %d\n",
378 status);
379 return;
380 }
190e4fbf 381
48483bf2 382 rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
e970a573 383 if (IS_ERR(rec_file)) {
c2642ab0 384 printk("NFSD: unable to find recovery directory %s\n",
48483bf2 385 user_recovery_dirname);
e970a573
CH
386 rec_file = NULL;
387 }
190e4fbf 388
d84f4f99 389 nfs4_reset_creds(original_cred);
190e4fbf
N
390}
391
392void
393nfsd4_shutdown_recdir(void)
394{
e970a573 395 if (!rec_file)
190e4fbf 396 return;
e970a573
CH
397 fput(rec_file);
398 rec_file = NULL;
190e4fbf 399}
48483bf2
BF
400
401/*
402 * Change the NFSv4 recovery directory to recdir.
403 */
404int
405nfs4_reset_recoverydir(char *recdir)
406{
407 int status;
408 struct path path;
409
410 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
411 if (status)
412 return status;
413 status = -ENOTDIR;
414 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
415 strcpy(user_recovery_dirname, recdir);
416 status = 0;
417 }
418 path_put(&path);
419 return status;
420}
421
422char *
423nfs4_recoverydir(void)
424{
425 return user_recovery_dirname;
426}