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