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