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