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