nfsd: pass nfsd_net instead of net to grace enders
[platform/adaptation/renesas_rcar/renesas_kernel.git] / fs / nfsd / nfs4recover.c
1 /*
2 *  Copyright (c) 2004 The Regents of the University of Michigan.
3 *  Copyright (c) 2012 Jeff Layton <jlayton@redhat.com>
4 *  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
35 #include <linux/file.h>
36 #include <linux/slab.h>
37 #include <linux/namei.h>
38 #include <linux/crypto.h>
39 #include <linux/sched.h>
40 #include <linux/fs.h>
41 #include <linux/module.h>
42 #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>
46
47 #include "nfsd.h"
48 #include "state.h"
49 #include "vfs.h"
50 #include "netns.h"
51
52 #define NFSDDBG_FACILITY                NFSDDBG_PROC
53
54 /* Declarations */
55 struct 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 nfsd_net *, time_t);
62 };
63
64 /* Globals */
65 static struct file *rec_file;
66 static char user_recovery_dirname[PATH_MAX] = "/var/lib/nfs/v4recovery";
67 static struct nfsd4_client_tracking_ops *client_tracking_ops;
68 static bool in_grace;
69
70 static int
71 nfs4_save_creds(const struct cred **original_creds)
72 {
73         struct cred *new;
74
75         new = prepare_creds();
76         if (!new)
77                 return -ENOMEM;
78
79         new->fsuid = 0;
80         new->fsgid = 0;
81         *original_creds = override_creds(new);
82         put_cred(new);
83         return 0;
84 }
85
86 static void
87 nfs4_reset_creds(const struct cred *original)
88 {
89         revert_creds(original);
90 }
91
92 static void
93 md5_to_hex(char *out, char *md5)
94 {
95         int i;
96
97         for (i=0; i<16; i++) {
98                 unsigned char c = md5[i];
99
100                 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
101                 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
102         }
103         *out = '\0';
104 }
105
106 static int
107 nfs4_make_rec_clidname(char *dname, const struct xdr_netobj *clname)
108 {
109         struct xdr_netobj cksum;
110         struct hash_desc desc;
111         struct scatterlist sg;
112         int status;
113
114         dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
115                         clname->len, clname->data);
116         desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
117         desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
118         if (IS_ERR(desc.tfm)) {
119                 status = PTR_ERR(desc.tfm);
120                 goto out_no_tfm;
121         }
122
123         cksum.len = crypto_hash_digestsize(desc.tfm);
124         cksum.data = kmalloc(cksum.len, GFP_KERNEL);
125         if (cksum.data == NULL) {
126                 status = -ENOMEM;
127                 goto out;
128         }
129
130         sg_init_one(&sg, clname->data, clname->len);
131
132         status = crypto_hash_digest(&desc, &sg, sg.length, cksum.data);
133         if (status)
134                 goto out;
135
136         md5_to_hex(dname, cksum.data);
137
138         status = 0;
139 out:
140         kfree(cksum.data);
141         crypto_free_hash(desc.tfm);
142 out_no_tfm:
143         return status;
144 }
145
146 /*
147  * If we had an error generating the recdir name for the legacy tracker
148  * then warn the admin. If the error doesn't appear to be transient,
149  * then disable recovery tracking.
150  */
151 static void
152 legacy_recdir_name_error(int error)
153 {
154         printk(KERN_ERR "NFSD: unable to generate recoverydir "
155                         "name (%d).\n", error);
156
157         /*
158          * if the algorithm just doesn't exist, then disable the recovery
159          * tracker altogether. The crypto libs will generally return this if
160          * FIPS is enabled as well.
161          */
162         if (error == -ENOENT) {
163                 printk(KERN_ERR "NFSD: disabling legacy clientid tracking. "
164                         "Reboot recovery will not function correctly!\n");
165
166                 /* the argument is ignored by the legacy exit function */
167                 nfsd4_client_tracking_exit(NULL);
168         }
169 }
170
171 static void
172 nfsd4_create_clid_dir(struct nfs4_client *clp)
173 {
174         const struct cred *original_cred;
175         char dname[HEXDIR_LEN];
176         struct dentry *dir, *dentry;
177         struct nfs4_client_reclaim *crp;
178         int status;
179         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
180
181         dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
182
183         if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
184                 return;
185         if (!rec_file)
186                 return;
187
188         status = nfs4_make_rec_clidname(dname, &clp->cl_name);
189         if (status)
190                 return legacy_recdir_name_error(status);
191
192         status = nfs4_save_creds(&original_cred);
193         if (status < 0)
194                 return;
195
196         status = mnt_want_write_file(rec_file);
197         if (status)
198                 return;
199
200         dir = rec_file->f_path.dentry;
201         /* lock the parent */
202         mutex_lock(&dir->d_inode->i_mutex);
203
204         dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
205         if (IS_ERR(dentry)) {
206                 status = PTR_ERR(dentry);
207                 goto out_unlock;
208         }
209         if (dentry->d_inode)
210                 /*
211                  * In the 4.1 case, where we're called from
212                  * reclaim_complete(), records from the previous reboot
213                  * may still be left, so this is OK.
214                  *
215                  * In the 4.0 case, we should never get here; but we may
216                  * as well be forgiving and just succeed silently.
217                  */
218                 goto out_put;
219         status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
220 out_put:
221         dput(dentry);
222 out_unlock:
223         mutex_unlock(&dir->d_inode->i_mutex);
224         if (status == 0) {
225                 if (in_grace) {
226                         crp = nfs4_client_to_reclaim(dname, nn);
227                         if (crp)
228                                 crp->cr_clp = clp;
229                 }
230                 vfs_fsync(rec_file, 0);
231         } else {
232                 printk(KERN_ERR "NFSD: failed to write recovery record"
233                                 " (err %d); please check that %s exists"
234                                 " and is writeable", status,
235                                 user_recovery_dirname);
236         }
237         mnt_drop_write_file(rec_file);
238         nfs4_reset_creds(original_cred);
239 }
240
241 typedef int (recdir_func)(struct dentry *, struct dentry *, struct nfsd_net *);
242
243 struct name_list {
244         char name[HEXDIR_LEN];
245         struct list_head list;
246 };
247
248 static int
249 nfsd4_build_namelist(void *arg, const char *name, int namlen,
250                 loff_t offset, u64 ino, unsigned int d_type)
251 {
252         struct list_head *names = arg;
253         struct name_list *entry;
254
255         if (namlen != HEXDIR_LEN - 1)
256                 return 0;
257         entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
258         if (entry == NULL)
259                 return -ENOMEM;
260         memcpy(entry->name, name, HEXDIR_LEN - 1);
261         entry->name[HEXDIR_LEN - 1] = '\0';
262         list_add(&entry->list, names);
263         return 0;
264 }
265
266 static int
267 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
268 {
269         const struct cred *original_cred;
270         struct dentry *dir = rec_file->f_path.dentry;
271         LIST_HEAD(names);
272         int status;
273
274         status = nfs4_save_creds(&original_cred);
275         if (status < 0)
276                 return status;
277
278         status = vfs_llseek(rec_file, 0, SEEK_SET);
279         if (status < 0) {
280                 nfs4_reset_creds(original_cred);
281                 return status;
282         }
283
284         status = vfs_readdir(rec_file, nfsd4_build_namelist, &names);
285         mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
286         while (!list_empty(&names)) {
287                 struct name_list *entry;
288                 entry = list_entry(names.next, struct name_list, list);
289                 if (!status) {
290                         struct dentry *dentry;
291                         dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
292                         if (IS_ERR(dentry)) {
293                                 status = PTR_ERR(dentry);
294                                 break;
295                         }
296                         status = f(dir, dentry, nn);
297                         dput(dentry);
298                 }
299                 list_del(&entry->list);
300                 kfree(entry);
301         }
302         mutex_unlock(&dir->d_inode->i_mutex);
303         nfs4_reset_creds(original_cred);
304         return status;
305 }
306
307 static int
308 nfsd4_unlink_clid_dir(char *name, int namlen)
309 {
310         struct dentry *dir, *dentry;
311         int status;
312
313         dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
314
315         dir = rec_file->f_path.dentry;
316         mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
317         dentry = lookup_one_len(name, dir, namlen);
318         if (IS_ERR(dentry)) {
319                 status = PTR_ERR(dentry);
320                 goto out_unlock;
321         }
322         status = -ENOENT;
323         if (!dentry->d_inode)
324                 goto out;
325         status = vfs_rmdir(dir->d_inode, dentry);
326 out:
327         dput(dentry);
328 out_unlock:
329         mutex_unlock(&dir->d_inode->i_mutex);
330         return status;
331 }
332
333 static void
334 nfsd4_remove_clid_dir(struct nfs4_client *clp)
335 {
336         const struct cred *original_cred;
337         struct nfs4_client_reclaim *crp;
338         char dname[HEXDIR_LEN];
339         int status;
340         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
341
342         if (!rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
343                 return;
344
345         status = nfs4_make_rec_clidname(dname, &clp->cl_name);
346         if (status)
347                 return legacy_recdir_name_error(status);
348
349         status = mnt_want_write_file(rec_file);
350         if (status)
351                 goto out;
352         clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
353
354         status = nfs4_save_creds(&original_cred);
355         if (status < 0)
356                 goto out_drop_write;
357
358         status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1);
359         nfs4_reset_creds(original_cred);
360         if (status == 0) {
361                 vfs_fsync(rec_file, 0);
362                 if (in_grace) {
363                         /* remove reclaim record */
364                         crp = nfsd4_find_reclaim_client(dname, nn);
365                         if (crp)
366                                 nfs4_remove_reclaim_record(crp, nn);
367                 }
368         }
369 out_drop_write:
370         mnt_drop_write_file(rec_file);
371 out:
372         if (status)
373                 printk("NFSD: Failed to remove expired client state directory"
374                                 " %.*s\n", HEXDIR_LEN, dname);
375 }
376
377 static int
378 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
379 {
380         int status;
381
382         if (nfs4_has_reclaimed_state(child->d_name.name, nn))
383                 return 0;
384
385         status = vfs_rmdir(parent->d_inode, child);
386         if (status)
387                 printk("failed to remove client recovery directory %s\n",
388                                 child->d_name.name);
389         /* Keep trying, success or failure: */
390         return 0;
391 }
392
393 static void
394 nfsd4_recdir_purge_old(struct nfsd_net *nn, time_t boot_time)
395 {
396         int status;
397
398         in_grace = false;
399         if (!rec_file)
400                 return;
401         status = mnt_want_write_file(rec_file);
402         if (status)
403                 goto out;
404         status = nfsd4_list_rec_dir(purge_old, nn);
405         if (status == 0)
406                 vfs_fsync(rec_file, 0);
407         mnt_drop_write_file(rec_file);
408 out:
409         nfs4_release_reclaim(nn);
410         if (status)
411                 printk("nfsd4: failed to purge old clients from recovery"
412                         " directory %s\n", rec_file->f_path.dentry->d_name.name);
413 }
414
415 static int
416 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
417 {
418         if (child->d_name.len != HEXDIR_LEN - 1) {
419                 printk("nfsd4: illegal name %s in recovery directory\n",
420                                 child->d_name.name);
421                 /* Keep trying; maybe the others are OK: */
422                 return 0;
423         }
424         nfs4_client_to_reclaim(child->d_name.name, nn);
425         return 0;
426 }
427
428 static int
429 nfsd4_recdir_load(struct net *net) {
430         int status;
431         struct nfsd_net *nn =  net_generic(net, nfsd_net_id);
432
433         if (!rec_file)
434                 return 0;
435
436         status = nfsd4_list_rec_dir(load_recdir, nn);
437         if (status)
438                 printk("nfsd4: failed loading clients from recovery"
439                         " directory %s\n", rec_file->f_path.dentry->d_name.name);
440         return status;
441 }
442
443 /*
444  * Hold reference to the recovery directory.
445  */
446
447 static int
448 nfsd4_init_recdir(void)
449 {
450         const struct cred *original_cred;
451         int status;
452
453         printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
454                         user_recovery_dirname);
455
456         BUG_ON(rec_file);
457
458         status = nfs4_save_creds(&original_cred);
459         if (status < 0) {
460                 printk("NFSD: Unable to change credentials to find recovery"
461                        " directory: error %d\n",
462                        status);
463                 return status;
464         }
465
466         rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
467         if (IS_ERR(rec_file)) {
468                 printk("NFSD: unable to find recovery directory %s\n",
469                                 user_recovery_dirname);
470                 status = PTR_ERR(rec_file);
471                 rec_file = NULL;
472         }
473
474         nfs4_reset_creds(original_cred);
475         if (!status)
476                 in_grace = true;
477         return status;
478 }
479
480
481 static int
482 nfs4_legacy_state_init(struct net *net)
483 {
484         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
485         int i;
486
487         nn->reclaim_str_hashtbl = kmalloc(sizeof(struct list_head) *
488                                           CLIENT_HASH_SIZE, GFP_KERNEL);
489         if (!nn->reclaim_str_hashtbl)
490                 return -ENOMEM;
491
492         for (i = 0; i < CLIENT_HASH_SIZE; i++)
493                 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
494         nn->reclaim_str_hashtbl_size = 0;
495
496         return 0;
497 }
498
499 static void
500 nfs4_legacy_state_shutdown(struct net *net)
501 {
502         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
503
504         kfree(nn->reclaim_str_hashtbl);
505 }
506
507 static int
508 nfsd4_load_reboot_recovery_data(struct net *net)
509 {
510         int status;
511
512         nfs4_lock_state();
513         status = nfsd4_init_recdir();
514         if (!status)
515                 status = nfsd4_recdir_load(net);
516         nfs4_unlock_state();
517         if (status)
518                 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
519         return status;
520 }
521
522 static int
523 nfsd4_legacy_tracking_init(struct net *net)
524 {
525         int status;
526
527         /* XXX: The legacy code won't work in a container */
528         if (net != &init_net) {
529                 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
530                         "tracking in a container!\n");
531                 return -EINVAL;
532         }
533
534         status = nfs4_legacy_state_init(net);
535         if (status)
536                 return status;
537
538         status = nfsd4_load_reboot_recovery_data(net);
539         if (status)
540                 goto err;
541         return 0;
542
543 err:
544         nfs4_legacy_state_shutdown(net);
545         return status;
546 }
547
548 static void
549 nfsd4_shutdown_recdir(void)
550 {
551         if (!rec_file)
552                 return;
553         fput(rec_file);
554         rec_file = NULL;
555 }
556
557 static void
558 nfsd4_legacy_tracking_exit(struct net *net)
559 {
560         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
561
562         nfs4_release_reclaim(nn);
563         nfsd4_shutdown_recdir();
564         nfs4_legacy_state_shutdown(net);
565 }
566
567 /*
568  * Change the NFSv4 recovery directory to recdir.
569  */
570 int
571 nfs4_reset_recoverydir(char *recdir)
572 {
573         int status;
574         struct path path;
575
576         status = kern_path(recdir, LOOKUP_FOLLOW, &path);
577         if (status)
578                 return status;
579         status = -ENOTDIR;
580         if (S_ISDIR(path.dentry->d_inode->i_mode)) {
581                 strcpy(user_recovery_dirname, recdir);
582                 status = 0;
583         }
584         path_put(&path);
585         return status;
586 }
587
588 char *
589 nfs4_recoverydir(void)
590 {
591         return user_recovery_dirname;
592 }
593
594 static int
595 nfsd4_check_legacy_client(struct nfs4_client *clp)
596 {
597         int status;
598         char dname[HEXDIR_LEN];
599         struct nfs4_client_reclaim *crp;
600         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
601
602         /* did we already find that this client is stable? */
603         if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
604                 return 0;
605
606         status = nfs4_make_rec_clidname(dname, &clp->cl_name);
607         if (status) {
608                 legacy_recdir_name_error(status);
609                 return status;
610         }
611
612         /* look for it in the reclaim hashtable otherwise */
613         crp = nfsd4_find_reclaim_client(dname, nn);
614         if (crp) {
615                 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
616                 crp->cr_clp = clp;
617                 return 0;
618         }
619
620         return -ENOENT;
621 }
622
623 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
624         .init           = nfsd4_legacy_tracking_init,
625         .exit           = nfsd4_legacy_tracking_exit,
626         .create         = nfsd4_create_clid_dir,
627         .remove         = nfsd4_remove_clid_dir,
628         .check          = nfsd4_check_legacy_client,
629         .grace_done     = nfsd4_recdir_purge_old,
630 };
631
632 /* Globals */
633 #define NFSD_PIPE_DIR           "nfsd"
634 #define NFSD_CLD_PIPE           "cld"
635
636 /* per-net-ns structure for holding cld upcall info */
637 struct cld_net {
638         struct rpc_pipe         *cn_pipe;
639         spinlock_t               cn_lock;
640         struct list_head         cn_list;
641         unsigned int             cn_xid;
642 };
643
644 struct cld_upcall {
645         struct list_head         cu_list;
646         struct cld_net          *cu_net;
647         struct task_struct      *cu_task;
648         struct cld_msg           cu_msg;
649 };
650
651 static int
652 __cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
653 {
654         int ret;
655         struct rpc_pipe_msg msg;
656
657         memset(&msg, 0, sizeof(msg));
658         msg.data = cmsg;
659         msg.len = sizeof(*cmsg);
660
661         /*
662          * Set task state before we queue the upcall. That prevents
663          * wake_up_process in the downcall from racing with schedule.
664          */
665         set_current_state(TASK_UNINTERRUPTIBLE);
666         ret = rpc_queue_upcall(pipe, &msg);
667         if (ret < 0) {
668                 set_current_state(TASK_RUNNING);
669                 goto out;
670         }
671
672         schedule();
673         set_current_state(TASK_RUNNING);
674
675         if (msg.errno < 0)
676                 ret = msg.errno;
677 out:
678         return ret;
679 }
680
681 static int
682 cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
683 {
684         int ret;
685
686         /*
687          * -EAGAIN occurs when pipe is closed and reopened while there are
688          *  upcalls queued.
689          */
690         do {
691                 ret = __cld_pipe_upcall(pipe, cmsg);
692         } while (ret == -EAGAIN);
693
694         return ret;
695 }
696
697 static ssize_t
698 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
699 {
700         struct cld_upcall *tmp, *cup;
701         struct cld_msg __user *cmsg = (struct cld_msg __user *)src;
702         uint32_t xid;
703         struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
704                                                 nfsd_net_id);
705         struct cld_net *cn = nn->cld_net;
706
707         if (mlen != sizeof(*cmsg)) {
708                 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
709                         sizeof(*cmsg));
710                 return -EINVAL;
711         }
712
713         /* copy just the xid so we can try to find that */
714         if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
715                 dprintk("%s: error when copying xid from userspace", __func__);
716                 return -EFAULT;
717         }
718
719         /* walk the list and find corresponding xid */
720         cup = NULL;
721         spin_lock(&cn->cn_lock);
722         list_for_each_entry(tmp, &cn->cn_list, cu_list) {
723                 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
724                         cup = tmp;
725                         list_del_init(&cup->cu_list);
726                         break;
727                 }
728         }
729         spin_unlock(&cn->cn_lock);
730
731         /* couldn't find upcall? */
732         if (!cup) {
733                 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
734                 return -EINVAL;
735         }
736
737         if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
738                 return -EFAULT;
739
740         wake_up_process(cup->cu_task);
741         return mlen;
742 }
743
744 static void
745 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
746 {
747         struct cld_msg *cmsg = msg->data;
748         struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
749                                                  cu_msg);
750
751         /* errno >= 0 means we got a downcall */
752         if (msg->errno >= 0)
753                 return;
754
755         wake_up_process(cup->cu_task);
756 }
757
758 static const struct rpc_pipe_ops cld_upcall_ops = {
759         .upcall         = rpc_pipe_generic_upcall,
760         .downcall       = cld_pipe_downcall,
761         .destroy_msg    = cld_pipe_destroy_msg,
762 };
763
764 static struct dentry *
765 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
766 {
767         struct dentry *dir, *dentry;
768
769         dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
770         if (dir == NULL)
771                 return ERR_PTR(-ENOENT);
772         dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
773         dput(dir);
774         return dentry;
775 }
776
777 static void
778 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
779 {
780         if (pipe->dentry)
781                 rpc_unlink(pipe->dentry);
782 }
783
784 static struct dentry *
785 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
786 {
787         struct super_block *sb;
788         struct dentry *dentry;
789
790         sb = rpc_get_sb_net(net);
791         if (!sb)
792                 return NULL;
793         dentry = nfsd4_cld_register_sb(sb, pipe);
794         rpc_put_sb_net(net);
795         return dentry;
796 }
797
798 static void
799 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
800 {
801         struct super_block *sb;
802
803         sb = rpc_get_sb_net(net);
804         if (sb) {
805                 nfsd4_cld_unregister_sb(pipe);
806                 rpc_put_sb_net(net);
807         }
808 }
809
810 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
811 static int
812 nfsd4_init_cld_pipe(struct net *net)
813 {
814         int ret;
815         struct dentry *dentry;
816         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
817         struct cld_net *cn;
818
819         if (nn->cld_net)
820                 return 0;
821
822         cn = kzalloc(sizeof(*cn), GFP_KERNEL);
823         if (!cn) {
824                 ret = -ENOMEM;
825                 goto err;
826         }
827
828         cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
829         if (IS_ERR(cn->cn_pipe)) {
830                 ret = PTR_ERR(cn->cn_pipe);
831                 goto err;
832         }
833         spin_lock_init(&cn->cn_lock);
834         INIT_LIST_HEAD(&cn->cn_list);
835
836         dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
837         if (IS_ERR(dentry)) {
838                 ret = PTR_ERR(dentry);
839                 goto err_destroy_data;
840         }
841
842         cn->cn_pipe->dentry = dentry;
843         nn->cld_net = cn;
844         return 0;
845
846 err_destroy_data:
847         rpc_destroy_pipe_data(cn->cn_pipe);
848 err:
849         kfree(cn);
850         printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
851                         ret);
852         return ret;
853 }
854
855 static void
856 nfsd4_remove_cld_pipe(struct net *net)
857 {
858         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
859         struct cld_net *cn = nn->cld_net;
860
861         nfsd4_cld_unregister_net(net, cn->cn_pipe);
862         rpc_destroy_pipe_data(cn->cn_pipe);
863         kfree(nn->cld_net);
864         nn->cld_net = NULL;
865 }
866
867 static struct cld_upcall *
868 alloc_cld_upcall(struct cld_net *cn)
869 {
870         struct cld_upcall *new, *tmp;
871
872         new = kzalloc(sizeof(*new), GFP_KERNEL);
873         if (!new)
874                 return new;
875
876         /* FIXME: hard cap on number in flight? */
877 restart_search:
878         spin_lock(&cn->cn_lock);
879         list_for_each_entry(tmp, &cn->cn_list, cu_list) {
880                 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
881                         cn->cn_xid++;
882                         spin_unlock(&cn->cn_lock);
883                         goto restart_search;
884                 }
885         }
886         new->cu_task = current;
887         new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
888         put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
889         new->cu_net = cn;
890         list_add(&new->cu_list, &cn->cn_list);
891         spin_unlock(&cn->cn_lock);
892
893         dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
894
895         return new;
896 }
897
898 static void
899 free_cld_upcall(struct cld_upcall *victim)
900 {
901         struct cld_net *cn = victim->cu_net;
902
903         spin_lock(&cn->cn_lock);
904         list_del(&victim->cu_list);
905         spin_unlock(&cn->cn_lock);
906         kfree(victim);
907 }
908
909 /* Ask daemon to create a new record */
910 static void
911 nfsd4_cld_create(struct nfs4_client *clp)
912 {
913         int ret;
914         struct cld_upcall *cup;
915         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
916         struct cld_net *cn = nn->cld_net;
917
918         /* Don't upcall if it's already stored */
919         if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
920                 return;
921
922         cup = alloc_cld_upcall(cn);
923         if (!cup) {
924                 ret = -ENOMEM;
925                 goto out_err;
926         }
927
928         cup->cu_msg.cm_cmd = Cld_Create;
929         cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
930         memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
931                         clp->cl_name.len);
932
933         ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
934         if (!ret) {
935                 ret = cup->cu_msg.cm_status;
936                 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
937         }
938
939         free_cld_upcall(cup);
940 out_err:
941         if (ret)
942                 printk(KERN_ERR "NFSD: Unable to create client "
943                                 "record on stable storage: %d\n", ret);
944 }
945
946 /* Ask daemon to create a new record */
947 static void
948 nfsd4_cld_remove(struct nfs4_client *clp)
949 {
950         int ret;
951         struct cld_upcall *cup;
952         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
953         struct cld_net *cn = nn->cld_net;
954
955         /* Don't upcall if it's already removed */
956         if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
957                 return;
958
959         cup = alloc_cld_upcall(cn);
960         if (!cup) {
961                 ret = -ENOMEM;
962                 goto out_err;
963         }
964
965         cup->cu_msg.cm_cmd = Cld_Remove;
966         cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
967         memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
968                         clp->cl_name.len);
969
970         ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
971         if (!ret) {
972                 ret = cup->cu_msg.cm_status;
973                 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
974         }
975
976         free_cld_upcall(cup);
977 out_err:
978         if (ret)
979                 printk(KERN_ERR "NFSD: Unable to remove client "
980                                 "record from stable storage: %d\n", ret);
981 }
982
983 /* Check for presence of a record, and update its timestamp */
984 static int
985 nfsd4_cld_check(struct nfs4_client *clp)
986 {
987         int ret;
988         struct cld_upcall *cup;
989         struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
990         struct cld_net *cn = nn->cld_net;
991
992         /* Don't upcall if one was already stored during this grace pd */
993         if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
994                 return 0;
995
996         cup = alloc_cld_upcall(cn);
997         if (!cup) {
998                 printk(KERN_ERR "NFSD: Unable to check client record on "
999                                 "stable storage: %d\n", -ENOMEM);
1000                 return -ENOMEM;
1001         }
1002
1003         cup->cu_msg.cm_cmd = Cld_Check;
1004         cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1005         memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1006                         clp->cl_name.len);
1007
1008         ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1009         if (!ret) {
1010                 ret = cup->cu_msg.cm_status;
1011                 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1012         }
1013
1014         free_cld_upcall(cup);
1015         return ret;
1016 }
1017
1018 static void
1019 nfsd4_cld_grace_done(struct nfsd_net *nn, time_t boot_time)
1020 {
1021         int ret;
1022         struct cld_upcall *cup;
1023         struct cld_net *cn = nn->cld_net;
1024
1025         cup = alloc_cld_upcall(cn);
1026         if (!cup) {
1027                 ret = -ENOMEM;
1028                 goto out_err;
1029         }
1030
1031         cup->cu_msg.cm_cmd = Cld_GraceDone;
1032         cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
1033         ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1034         if (!ret)
1035                 ret = cup->cu_msg.cm_status;
1036
1037         free_cld_upcall(cup);
1038 out_err:
1039         if (ret)
1040                 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1041 }
1042
1043 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
1044         .init           = nfsd4_init_cld_pipe,
1045         .exit           = nfsd4_remove_cld_pipe,
1046         .create         = nfsd4_cld_create,
1047         .remove         = nfsd4_cld_remove,
1048         .check          = nfsd4_cld_check,
1049         .grace_done     = nfsd4_cld_grace_done,
1050 };
1051
1052 /* upcall via usermodehelper */
1053 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
1054 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
1055                         S_IRUGO|S_IWUSR);
1056 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
1057
1058 static bool cltrack_legacy_disable;
1059 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
1060 MODULE_PARM_DESC(cltrack_legacy_disable,
1061                 "Disable legacy recoverydir conversion. Default: false");
1062
1063 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1064 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1065
1066 static char *
1067 nfsd4_cltrack_legacy_topdir(void)
1068 {
1069         int copied;
1070         size_t len;
1071         char *result;
1072
1073         if (cltrack_legacy_disable)
1074                 return NULL;
1075
1076         len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
1077                 strlen(nfs4_recoverydir()) + 1;
1078
1079         result = kmalloc(len, GFP_KERNEL);
1080         if (!result)
1081                 return result;
1082
1083         copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
1084                                 nfs4_recoverydir());
1085         if (copied >= len) {
1086                 /* just return nothing if output was truncated */
1087                 kfree(result);
1088                 return NULL;
1089         }
1090
1091         return result;
1092 }
1093
1094 static char *
1095 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj *name)
1096 {
1097         int copied;
1098         size_t len;
1099         char *result;
1100
1101         if (cltrack_legacy_disable)
1102                 return NULL;
1103
1104         /* +1 is for '/' between "topdir" and "recdir" */
1105         len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1106                 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1107
1108         result = kmalloc(len, GFP_KERNEL);
1109         if (!result)
1110                 return result;
1111
1112         copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/",
1113                                 nfs4_recoverydir());
1114         if (copied > (len - HEXDIR_LEN)) {
1115                 /* just return nothing if output will be truncated */
1116                 kfree(result);
1117                 return NULL;
1118         }
1119
1120         copied = nfs4_make_rec_clidname(result + copied, name);
1121         if (copied) {
1122                 kfree(result);
1123                 return NULL;
1124         }
1125
1126         return result;
1127 }
1128
1129 static int
1130 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *legacy)
1131 {
1132         char *envp[2];
1133         char *argv[4];
1134         int ret;
1135
1136         if (unlikely(!cltrack_prog[0])) {
1137                 dprintk("%s: cltrack_prog is disabled\n", __func__);
1138                 return -EACCES;
1139         }
1140
1141         dprintk("%s: cmd: %s\n", __func__, cmd);
1142         dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1143         dprintk("%s: legacy: %s\n", __func__, legacy ? legacy : "(null)");
1144
1145         envp[0] = legacy;
1146         envp[1] = NULL;
1147
1148         argv[0] = (char *)cltrack_prog;
1149         argv[1] = cmd;
1150         argv[2] = arg;
1151         argv[3] = NULL;
1152
1153         ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1154         /*
1155          * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1156          * error. The admin can re-enable it on the fly by using sysfs
1157          * once the problem has been fixed.
1158          */
1159         if (ret == -ENOENT || ret == -EACCES) {
1160                 dprintk("NFSD: %s was not found or isn't executable (%d). "
1161                         "Setting cltrack_prog to blank string!",
1162                         cltrack_prog, ret);
1163                 cltrack_prog[0] = '\0';
1164         }
1165         dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1166
1167         return ret;
1168 }
1169
1170 static char *
1171 bin_to_hex_dup(const unsigned char *src, int srclen)
1172 {
1173         int i;
1174         char *buf, *hex;
1175
1176         /* +1 for terminating NULL */
1177         buf = kmalloc((srclen * 2) + 1, GFP_KERNEL);
1178         if (!buf)
1179                 return buf;
1180
1181         hex = buf;
1182         for (i = 0; i < srclen; i++) {
1183                 sprintf(hex, "%2.2x", *src++);
1184                 hex += 2;
1185         }
1186         return buf;
1187 }
1188
1189 static int
1190 nfsd4_umh_cltrack_init(struct net __attribute__((unused)) *net)
1191 {
1192         return nfsd4_umh_cltrack_upcall("init", NULL, NULL);
1193 }
1194
1195 static void
1196 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1197 {
1198         char *hexid;
1199
1200         hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1201         if (!hexid) {
1202                 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1203                 return;
1204         }
1205         nfsd4_umh_cltrack_upcall("create", hexid, NULL);
1206         kfree(hexid);
1207 }
1208
1209 static void
1210 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1211 {
1212         char *hexid;
1213
1214         hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1215         if (!hexid) {
1216                 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1217                 return;
1218         }
1219         nfsd4_umh_cltrack_upcall("remove", hexid, NULL);
1220         kfree(hexid);
1221 }
1222
1223 static int
1224 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1225 {
1226         int ret;
1227         char *hexid, *legacy;
1228
1229         hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1230         if (!hexid) {
1231                 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1232                 return -ENOMEM;
1233         }
1234         legacy = nfsd4_cltrack_legacy_recdir(&clp->cl_name);
1235         ret = nfsd4_umh_cltrack_upcall("check", hexid, legacy);
1236         kfree(legacy);
1237         kfree(hexid);
1238         return ret;
1239 }
1240
1241 static void
1242 nfsd4_umh_cltrack_grace_done(struct nfsd_net __attribute__((unused)) *nn,
1243                                 time_t boot_time)
1244 {
1245         char *legacy;
1246         char timestr[22]; /* FIXME: better way to determine max size? */
1247
1248         sprintf(timestr, "%ld", boot_time);
1249         legacy = nfsd4_cltrack_legacy_topdir();
1250         nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy);
1251         kfree(legacy);
1252 }
1253
1254 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
1255         .init           = nfsd4_umh_cltrack_init,
1256         .exit           = NULL,
1257         .create         = nfsd4_umh_cltrack_create,
1258         .remove         = nfsd4_umh_cltrack_remove,
1259         .check          = nfsd4_umh_cltrack_check,
1260         .grace_done     = nfsd4_umh_cltrack_grace_done,
1261 };
1262
1263 int
1264 nfsd4_client_tracking_init(struct net *net)
1265 {
1266         int status;
1267         struct path path;
1268
1269         /* just run the init if it the method is already decided */
1270         if (client_tracking_ops)
1271                 goto do_init;
1272
1273         /*
1274          * First, try a UMH upcall. It should succeed or fail quickly, so
1275          * there's little harm in trying that first.
1276          */
1277         client_tracking_ops = &nfsd4_umh_tracking_ops;
1278         status = client_tracking_ops->init(net);
1279         if (!status)
1280                 return status;
1281
1282         /*
1283          * See if the recoverydir exists and is a directory. If it is,
1284          * then use the legacy ops.
1285          */
1286         client_tracking_ops = &nfsd4_legacy_tracking_ops;
1287         status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1288         if (!status) {
1289                 status = S_ISDIR(path.dentry->d_inode->i_mode);
1290                 path_put(&path);
1291                 if (status)
1292                         goto do_init;
1293         }
1294
1295         /* Finally, try to use nfsdcld */
1296         client_tracking_ops = &nfsd4_cld_tracking_ops;
1297         printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1298                         "removed in 3.10. Please transition to using "
1299                         "nfsdcltrack.\n");
1300 do_init:
1301         status = client_tracking_ops->init(net);
1302         if (status) {
1303                 printk(KERN_WARNING "NFSD: Unable to initialize client "
1304                                     "recovery tracking! (%d)\n", status);
1305                 client_tracking_ops = NULL;
1306         }
1307         return status;
1308 }
1309
1310 void
1311 nfsd4_client_tracking_exit(struct net *net)
1312 {
1313         if (client_tracking_ops) {
1314                 if (client_tracking_ops->exit)
1315                         client_tracking_ops->exit(net);
1316                 client_tracking_ops = NULL;
1317         }
1318 }
1319
1320 void
1321 nfsd4_client_record_create(struct nfs4_client *clp)
1322 {
1323         if (client_tracking_ops)
1324                 client_tracking_ops->create(clp);
1325 }
1326
1327 void
1328 nfsd4_client_record_remove(struct nfs4_client *clp)
1329 {
1330         if (client_tracking_ops)
1331                 client_tracking_ops->remove(clp);
1332 }
1333
1334 int
1335 nfsd4_client_record_check(struct nfs4_client *clp)
1336 {
1337         if (client_tracking_ops)
1338                 return client_tracking_ops->check(clp);
1339
1340         return -EOPNOTSUPP;
1341 }
1342
1343 void
1344 nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time)
1345 {
1346         if (client_tracking_ops)
1347                 client_tracking_ops->grace_done(nn, boot_time);
1348 }
1349
1350 static int
1351 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1352 {
1353         struct super_block *sb = ptr;
1354         struct net *net = sb->s_fs_info;
1355         struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1356         struct cld_net *cn = nn->cld_net;
1357         struct dentry *dentry;
1358         int ret = 0;
1359
1360         if (!try_module_get(THIS_MODULE))
1361                 return 0;
1362
1363         if (!cn) {
1364                 module_put(THIS_MODULE);
1365                 return 0;
1366         }
1367
1368         switch (event) {
1369         case RPC_PIPEFS_MOUNT:
1370                 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1371                 if (IS_ERR(dentry)) {
1372                         ret = PTR_ERR(dentry);
1373                         break;
1374                 }
1375                 cn->cn_pipe->dentry = dentry;
1376                 break;
1377         case RPC_PIPEFS_UMOUNT:
1378                 if (cn->cn_pipe->dentry)
1379                         nfsd4_cld_unregister_sb(cn->cn_pipe);
1380                 break;
1381         default:
1382                 ret = -ENOTSUPP;
1383                 break;
1384         }
1385         module_put(THIS_MODULE);
1386         return ret;
1387 }
1388
1389 static struct notifier_block nfsd4_cld_block = {
1390         .notifier_call = rpc_pipefs_event,
1391 };
1392
1393 int
1394 register_cld_notifier(void)
1395 {
1396         return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1397 }
1398
1399 void
1400 unregister_cld_notifier(void)
1401 {
1402         rpc_pipefs_notifier_unregister(&nfsd4_cld_block);
1403 }