2 * Copyright (c) 2004 The Regents of the University of Michigan.
3 * Copyright (c) 2012 Jeff Layton <jlayton@redhat.com>
6 * Andy Adamson <andros@citi.umich.edu>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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.
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>
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>
52 #define NFSDDBG_FACILITY NFSDDBG_PROC
55 struct nfsd4_client_tracking_ops {
56 int (*init)(struct net *);
57 void (*exit)(struct net *);
58 void (*create)(struct nfs4_client *);
59 void (*remove)(struct nfs4_client *);
60 int (*check)(struct nfs4_client *);
61 void (*grace_done)(struct nfsd_net *, time_t);
65 static char user_recovery_dirname[PATH_MAX] = "/var/lib/nfs/v4recovery";
68 nfs4_save_creds(const struct cred **original_creds)
72 new = prepare_creds();
76 new->fsuid = GLOBAL_ROOT_UID;
77 new->fsgid = GLOBAL_ROOT_GID;
78 *original_creds = override_creds(new);
84 nfs4_reset_creds(const struct cred *original)
86 revert_creds(original);
90 md5_to_hex(char *out, char *md5)
94 for (i=0; i<16; i++) {
95 unsigned char c = md5[i];
97 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
98 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
104 nfs4_make_rec_clidname(char *dname, const struct xdr_netobj *clname)
106 struct xdr_netobj cksum;
107 struct hash_desc desc;
108 struct scatterlist sg;
111 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
112 clname->len, clname->data);
113 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
114 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
115 if (IS_ERR(desc.tfm)) {
116 status = PTR_ERR(desc.tfm);
120 cksum.len = crypto_hash_digestsize(desc.tfm);
121 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
122 if (cksum.data == NULL) {
127 sg_init_one(&sg, clname->data, clname->len);
129 status = crypto_hash_digest(&desc, &sg, sg.length, cksum.data);
133 md5_to_hex(dname, cksum.data);
138 crypto_free_hash(desc.tfm);
144 * If we had an error generating the recdir name for the legacy tracker
145 * then warn the admin. If the error doesn't appear to be transient,
146 * then disable recovery tracking.
149 legacy_recdir_name_error(struct nfs4_client *clp, int error)
151 printk(KERN_ERR "NFSD: unable to generate recoverydir "
152 "name (%d).\n", error);
155 * if the algorithm just doesn't exist, then disable the recovery
156 * tracker altogether. The crypto libs will generally return this if
157 * FIPS is enabled as well.
159 if (error == -ENOENT) {
160 printk(KERN_ERR "NFSD: disabling legacy clientid tracking. "
161 "Reboot recovery will not function correctly!\n");
162 nfsd4_client_tracking_exit(clp->net);
167 nfsd4_create_clid_dir(struct nfs4_client *clp)
169 const struct cred *original_cred;
170 char dname[HEXDIR_LEN];
171 struct dentry *dir, *dentry;
172 struct nfs4_client_reclaim *crp;
174 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
176 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
181 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
183 return legacy_recdir_name_error(clp, status);
185 status = nfs4_save_creds(&original_cred);
189 status = mnt_want_write_file(nn->rec_file);
193 dir = nn->rec_file->f_path.dentry;
194 /* lock the parent */
195 mutex_lock(&dir->d_inode->i_mutex);
197 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
198 if (IS_ERR(dentry)) {
199 status = PTR_ERR(dentry);
204 * In the 4.1 case, where we're called from
205 * reclaim_complete(), records from the previous reboot
206 * may still be left, so this is OK.
208 * In the 4.0 case, we should never get here; but we may
209 * as well be forgiving and just succeed silently.
212 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
216 mutex_unlock(&dir->d_inode->i_mutex);
219 crp = nfs4_client_to_reclaim(dname, nn);
223 vfs_fsync(nn->rec_file, 0);
225 printk(KERN_ERR "NFSD: failed to write recovery record"
226 " (err %d); please check that %s exists"
227 " and is writeable", status,
228 user_recovery_dirname);
230 mnt_drop_write_file(nn->rec_file);
231 nfs4_reset_creds(original_cred);
234 typedef int (recdir_func)(struct dentry *, struct dentry *, struct nfsd_net *);
237 char name[HEXDIR_LEN];
238 struct list_head list;
241 struct nfs4_dir_ctx {
242 struct dir_context ctx;
243 struct list_head names;
247 nfsd4_build_namelist(void *arg, const char *name, int namlen,
248 loff_t offset, u64 ino, unsigned int d_type)
250 struct nfs4_dir_ctx *ctx = arg;
251 struct name_list *entry;
253 if (namlen != HEXDIR_LEN - 1)
255 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
258 memcpy(entry->name, name, HEXDIR_LEN - 1);
259 entry->name[HEXDIR_LEN - 1] = '\0';
260 list_add(&entry->list, &ctx->names);
265 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
267 const struct cred *original_cred;
268 struct dentry *dir = nn->rec_file->f_path.dentry;
269 struct nfs4_dir_ctx ctx = {
270 .ctx.actor = nfsd4_build_namelist,
271 .names = LIST_HEAD_INIT(ctx.names)
275 status = nfs4_save_creds(&original_cred);
279 status = vfs_llseek(nn->rec_file, 0, SEEK_SET);
281 nfs4_reset_creds(original_cred);
285 status = iterate_dir(nn->rec_file, &ctx.ctx);
286 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
287 while (!list_empty(&ctx.names)) {
288 struct name_list *entry;
289 entry = list_entry(ctx.names.next, struct name_list, list);
291 struct dentry *dentry;
292 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
293 if (IS_ERR(dentry)) {
294 status = PTR_ERR(dentry);
297 status = f(dir, dentry, nn);
300 list_del(&entry->list);
303 mutex_unlock(&dir->d_inode->i_mutex);
304 nfs4_reset_creds(original_cred);
309 nfsd4_unlink_clid_dir(char *name, int namlen, struct nfsd_net *nn)
311 struct dentry *dir, *dentry;
314 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
316 dir = nn->rec_file->f_path.dentry;
317 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
318 dentry = lookup_one_len(name, dir, namlen);
319 if (IS_ERR(dentry)) {
320 status = PTR_ERR(dentry);
324 if (!dentry->d_inode)
326 status = vfs_rmdir(dir->d_inode, dentry);
330 mutex_unlock(&dir->d_inode->i_mutex);
335 nfsd4_remove_clid_dir(struct nfs4_client *clp)
337 const struct cred *original_cred;
338 struct nfs4_client_reclaim *crp;
339 char dname[HEXDIR_LEN];
341 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
343 if (!nn->rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
346 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
348 return legacy_recdir_name_error(clp, status);
350 status = mnt_want_write_file(nn->rec_file);
353 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
355 status = nfs4_save_creds(&original_cred);
359 status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1, nn);
360 nfs4_reset_creds(original_cred);
362 vfs_fsync(nn->rec_file, 0);
364 /* remove reclaim record */
365 crp = nfsd4_find_reclaim_client(dname, nn);
367 nfs4_remove_reclaim_record(crp, nn);
371 mnt_drop_write_file(nn->rec_file);
374 printk("NFSD: Failed to remove expired client state directory"
375 " %.*s\n", HEXDIR_LEN, dname);
379 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
383 if (nfs4_has_reclaimed_state(child->d_name.name, nn))
386 status = vfs_rmdir(parent->d_inode, child);
388 printk("failed to remove client recovery directory %s\n",
390 /* Keep trying, success or failure: */
395 nfsd4_recdir_purge_old(struct nfsd_net *nn, time_t boot_time)
399 nn->in_grace = false;
402 status = mnt_want_write_file(nn->rec_file);
405 status = nfsd4_list_rec_dir(purge_old, nn);
407 vfs_fsync(nn->rec_file, 0);
408 mnt_drop_write_file(nn->rec_file);
410 nfs4_release_reclaim(nn);
412 printk("nfsd4: failed to purge old clients from recovery"
413 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
417 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
419 if (child->d_name.len != HEXDIR_LEN - 1) {
420 printk("nfsd4: illegal name %s in recovery directory\n",
422 /* Keep trying; maybe the others are OK: */
425 nfs4_client_to_reclaim(child->d_name.name, nn);
430 nfsd4_recdir_load(struct net *net) {
432 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
437 status = nfsd4_list_rec_dir(load_recdir, nn);
439 printk("nfsd4: failed loading clients from recovery"
440 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
445 * Hold reference to the recovery directory.
449 nfsd4_init_recdir(struct net *net)
451 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
452 const struct cred *original_cred;
455 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
456 user_recovery_dirname);
458 BUG_ON(nn->rec_file);
460 status = nfs4_save_creds(&original_cred);
462 printk("NFSD: Unable to change credentials to find recovery"
463 " directory: error %d\n",
468 nn->rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
469 if (IS_ERR(nn->rec_file)) {
470 printk("NFSD: unable to find recovery directory %s\n",
471 user_recovery_dirname);
472 status = PTR_ERR(nn->rec_file);
476 nfs4_reset_creds(original_cred);
484 nfs4_legacy_state_init(struct net *net)
486 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
489 nn->reclaim_str_hashtbl = kmalloc(sizeof(struct list_head) *
490 CLIENT_HASH_SIZE, GFP_KERNEL);
491 if (!nn->reclaim_str_hashtbl)
494 for (i = 0; i < CLIENT_HASH_SIZE; i++)
495 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
496 nn->reclaim_str_hashtbl_size = 0;
502 nfs4_legacy_state_shutdown(struct net *net)
504 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
506 kfree(nn->reclaim_str_hashtbl);
510 nfsd4_load_reboot_recovery_data(struct net *net)
514 status = nfsd4_init_recdir(net);
516 status = nfsd4_recdir_load(net);
518 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
523 nfsd4_legacy_tracking_init(struct net *net)
527 /* XXX: The legacy code won't work in a container */
528 if (net != &init_net) {
529 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
530 "tracking in a container!\n");
534 status = nfs4_legacy_state_init(net);
538 status = nfsd4_load_reboot_recovery_data(net);
544 nfs4_legacy_state_shutdown(net);
549 nfsd4_shutdown_recdir(struct nfsd_net *nn)
558 nfsd4_legacy_tracking_exit(struct net *net)
560 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
562 nfs4_release_reclaim(nn);
563 nfsd4_shutdown_recdir(nn);
564 nfs4_legacy_state_shutdown(net);
568 * Change the NFSv4 recovery directory to recdir.
571 nfs4_reset_recoverydir(char *recdir)
576 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
580 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
581 strcpy(user_recovery_dirname, recdir);
589 nfs4_recoverydir(void)
591 return user_recovery_dirname;
595 nfsd4_check_legacy_client(struct nfs4_client *clp)
598 char dname[HEXDIR_LEN];
599 struct nfs4_client_reclaim *crp;
600 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
602 /* did we already find that this client is stable? */
603 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
606 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
608 legacy_recdir_name_error(clp, status);
612 /* look for it in the reclaim hashtable otherwise */
613 crp = nfsd4_find_reclaim_client(dname, nn);
615 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
623 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
624 .init = nfsd4_legacy_tracking_init,
625 .exit = nfsd4_legacy_tracking_exit,
626 .create = nfsd4_create_clid_dir,
627 .remove = nfsd4_remove_clid_dir,
628 .check = nfsd4_check_legacy_client,
629 .grace_done = nfsd4_recdir_purge_old,
633 #define NFSD_PIPE_DIR "nfsd"
634 #define NFSD_CLD_PIPE "cld"
636 /* per-net-ns structure for holding cld upcall info */
638 struct rpc_pipe *cn_pipe;
640 struct list_head cn_list;
645 struct list_head cu_list;
646 struct cld_net *cu_net;
647 struct task_struct *cu_task;
648 struct cld_msg cu_msg;
652 __cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
655 struct rpc_pipe_msg msg;
657 memset(&msg, 0, sizeof(msg));
659 msg.len = sizeof(*cmsg);
662 * Set task state before we queue the upcall. That prevents
663 * wake_up_process in the downcall from racing with schedule.
665 set_current_state(TASK_UNINTERRUPTIBLE);
666 ret = rpc_queue_upcall(pipe, &msg);
668 set_current_state(TASK_RUNNING);
673 set_current_state(TASK_RUNNING);
682 cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
687 * -EAGAIN occurs when pipe is closed and reopened while there are
691 ret = __cld_pipe_upcall(pipe, cmsg);
692 } while (ret == -EAGAIN);
698 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
700 struct cld_upcall *tmp, *cup;
701 struct cld_msg __user *cmsg = (struct cld_msg __user *)src;
703 struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
705 struct cld_net *cn = nn->cld_net;
707 if (mlen != sizeof(*cmsg)) {
708 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
713 /* copy just the xid so we can try to find that */
714 if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
715 dprintk("%s: error when copying xid from userspace", __func__);
719 /* walk the list and find corresponding xid */
721 spin_lock(&cn->cn_lock);
722 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
723 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
725 list_del_init(&cup->cu_list);
729 spin_unlock(&cn->cn_lock);
731 /* couldn't find upcall? */
733 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
737 if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
740 wake_up_process(cup->cu_task);
745 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
747 struct cld_msg *cmsg = msg->data;
748 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
751 /* errno >= 0 means we got a downcall */
755 wake_up_process(cup->cu_task);
758 static const struct rpc_pipe_ops cld_upcall_ops = {
759 .upcall = rpc_pipe_generic_upcall,
760 .downcall = cld_pipe_downcall,
761 .destroy_msg = cld_pipe_destroy_msg,
764 static struct dentry *
765 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
767 struct dentry *dir, *dentry;
769 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
771 return ERR_PTR(-ENOENT);
772 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
778 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
781 rpc_unlink(pipe->dentry);
784 static struct dentry *
785 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
787 struct super_block *sb;
788 struct dentry *dentry;
790 sb = rpc_get_sb_net(net);
793 dentry = nfsd4_cld_register_sb(sb, pipe);
799 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
801 struct super_block *sb;
803 sb = rpc_get_sb_net(net);
805 nfsd4_cld_unregister_sb(pipe);
810 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
812 nfsd4_init_cld_pipe(struct net *net)
815 struct dentry *dentry;
816 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
822 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
828 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
829 if (IS_ERR(cn->cn_pipe)) {
830 ret = PTR_ERR(cn->cn_pipe);
833 spin_lock_init(&cn->cn_lock);
834 INIT_LIST_HEAD(&cn->cn_list);
836 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
837 if (IS_ERR(dentry)) {
838 ret = PTR_ERR(dentry);
839 goto err_destroy_data;
842 cn->cn_pipe->dentry = dentry;
847 rpc_destroy_pipe_data(cn->cn_pipe);
850 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
856 nfsd4_remove_cld_pipe(struct net *net)
858 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
859 struct cld_net *cn = nn->cld_net;
861 nfsd4_cld_unregister_net(net, cn->cn_pipe);
862 rpc_destroy_pipe_data(cn->cn_pipe);
867 static struct cld_upcall *
868 alloc_cld_upcall(struct cld_net *cn)
870 struct cld_upcall *new, *tmp;
872 new = kzalloc(sizeof(*new), GFP_KERNEL);
876 /* FIXME: hard cap on number in flight? */
878 spin_lock(&cn->cn_lock);
879 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
880 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
882 spin_unlock(&cn->cn_lock);
886 new->cu_task = current;
887 new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
888 put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
890 list_add(&new->cu_list, &cn->cn_list);
891 spin_unlock(&cn->cn_lock);
893 dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
899 free_cld_upcall(struct cld_upcall *victim)
901 struct cld_net *cn = victim->cu_net;
903 spin_lock(&cn->cn_lock);
904 list_del(&victim->cu_list);
905 spin_unlock(&cn->cn_lock);
909 /* Ask daemon to create a new record */
911 nfsd4_cld_create(struct nfs4_client *clp)
914 struct cld_upcall *cup;
915 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
916 struct cld_net *cn = nn->cld_net;
918 /* Don't upcall if it's already stored */
919 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
922 cup = alloc_cld_upcall(cn);
928 cup->cu_msg.cm_cmd = Cld_Create;
929 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
930 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
933 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
935 ret = cup->cu_msg.cm_status;
936 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
939 free_cld_upcall(cup);
942 printk(KERN_ERR "NFSD: Unable to create client "
943 "record on stable storage: %d\n", ret);
946 /* Ask daemon to create a new record */
948 nfsd4_cld_remove(struct nfs4_client *clp)
951 struct cld_upcall *cup;
952 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
953 struct cld_net *cn = nn->cld_net;
955 /* Don't upcall if it's already removed */
956 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
959 cup = alloc_cld_upcall(cn);
965 cup->cu_msg.cm_cmd = Cld_Remove;
966 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
967 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
970 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
972 ret = cup->cu_msg.cm_status;
973 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
976 free_cld_upcall(cup);
979 printk(KERN_ERR "NFSD: Unable to remove client "
980 "record from stable storage: %d\n", ret);
983 /* Check for presence of a record, and update its timestamp */
985 nfsd4_cld_check(struct nfs4_client *clp)
988 struct cld_upcall *cup;
989 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
990 struct cld_net *cn = nn->cld_net;
992 /* Don't upcall if one was already stored during this grace pd */
993 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
996 cup = alloc_cld_upcall(cn);
998 printk(KERN_ERR "NFSD: Unable to check client record on "
999 "stable storage: %d\n", -ENOMEM);
1003 cup->cu_msg.cm_cmd = Cld_Check;
1004 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1005 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1008 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1010 ret = cup->cu_msg.cm_status;
1011 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1014 free_cld_upcall(cup);
1019 nfsd4_cld_grace_done(struct nfsd_net *nn, time_t boot_time)
1022 struct cld_upcall *cup;
1023 struct cld_net *cn = nn->cld_net;
1025 cup = alloc_cld_upcall(cn);
1031 cup->cu_msg.cm_cmd = Cld_GraceDone;
1032 cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
1033 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1035 ret = cup->cu_msg.cm_status;
1037 free_cld_upcall(cup);
1040 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1043 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
1044 .init = nfsd4_init_cld_pipe,
1045 .exit = nfsd4_remove_cld_pipe,
1046 .create = nfsd4_cld_create,
1047 .remove = nfsd4_cld_remove,
1048 .check = nfsd4_cld_check,
1049 .grace_done = nfsd4_cld_grace_done,
1052 /* upcall via usermodehelper */
1053 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
1054 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
1056 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
1058 static bool cltrack_legacy_disable;
1059 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
1060 MODULE_PARM_DESC(cltrack_legacy_disable,
1061 "Disable legacy recoverydir conversion. Default: false");
1063 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1064 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1067 nfsd4_cltrack_legacy_topdir(void)
1073 if (cltrack_legacy_disable)
1076 len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
1077 strlen(nfs4_recoverydir()) + 1;
1079 result = kmalloc(len, GFP_KERNEL);
1083 copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
1084 nfs4_recoverydir());
1085 if (copied >= len) {
1086 /* just return nothing if output was truncated */
1095 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj *name)
1101 if (cltrack_legacy_disable)
1104 /* +1 is for '/' between "topdir" and "recdir" */
1105 len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1106 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1108 result = kmalloc(len, GFP_KERNEL);
1112 copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/",
1113 nfs4_recoverydir());
1114 if (copied > (len - HEXDIR_LEN)) {
1115 /* just return nothing if output will be truncated */
1120 copied = nfs4_make_rec_clidname(result + copied, name);
1130 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *legacy)
1136 if (unlikely(!cltrack_prog[0])) {
1137 dprintk("%s: cltrack_prog is disabled\n", __func__);
1141 dprintk("%s: cmd: %s\n", __func__, cmd);
1142 dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1143 dprintk("%s: legacy: %s\n", __func__, legacy ? legacy : "(null)");
1148 argv[0] = (char *)cltrack_prog;
1153 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1155 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1156 * error. The admin can re-enable it on the fly by using sysfs
1157 * once the problem has been fixed.
1159 if (ret == -ENOENT || ret == -EACCES) {
1160 dprintk("NFSD: %s was not found or isn't executable (%d). "
1161 "Setting cltrack_prog to blank string!",
1163 cltrack_prog[0] = '\0';
1165 dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1171 bin_to_hex_dup(const unsigned char *src, int srclen)
1176 /* +1 for terminating NULL */
1177 buf = kmalloc((srclen * 2) + 1, GFP_KERNEL);
1182 for (i = 0; i < srclen; i++) {
1183 sprintf(hex, "%2.2x", *src++);
1190 nfsd4_umh_cltrack_init(struct net __attribute__((unused)) *net)
1192 /* XXX: The usermode helper s not working in container yet. */
1193 if (net != &init_net) {
1194 WARN(1, KERN_ERR "NFSD: attempt to initialize umh client "
1195 "tracking in a container!\n");
1198 return nfsd4_umh_cltrack_upcall("init", NULL, NULL);
1202 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1206 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1208 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1211 nfsd4_umh_cltrack_upcall("create", hexid, NULL);
1216 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1220 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1222 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1225 nfsd4_umh_cltrack_upcall("remove", hexid, NULL);
1230 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1233 char *hexid, *legacy;
1235 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1237 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1240 legacy = nfsd4_cltrack_legacy_recdir(&clp->cl_name);
1241 ret = nfsd4_umh_cltrack_upcall("check", hexid, legacy);
1248 nfsd4_umh_cltrack_grace_done(struct nfsd_net __attribute__((unused)) *nn,
1252 char timestr[22]; /* FIXME: better way to determine max size? */
1254 sprintf(timestr, "%ld", boot_time);
1255 legacy = nfsd4_cltrack_legacy_topdir();
1256 nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy);
1260 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
1261 .init = nfsd4_umh_cltrack_init,
1263 .create = nfsd4_umh_cltrack_create,
1264 .remove = nfsd4_umh_cltrack_remove,
1265 .check = nfsd4_umh_cltrack_check,
1266 .grace_done = nfsd4_umh_cltrack_grace_done,
1270 nfsd4_client_tracking_init(struct net *net)
1274 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1276 /* just run the init if it the method is already decided */
1277 if (nn->client_tracking_ops)
1281 * First, try a UMH upcall. It should succeed or fail quickly, so
1282 * there's little harm in trying that first.
1284 nn->client_tracking_ops = &nfsd4_umh_tracking_ops;
1285 status = nn->client_tracking_ops->init(net);
1290 * See if the recoverydir exists and is a directory. If it is,
1291 * then use the legacy ops.
1293 nn->client_tracking_ops = &nfsd4_legacy_tracking_ops;
1294 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1296 status = S_ISDIR(path.dentry->d_inode->i_mode);
1302 /* Finally, try to use nfsdcld */
1303 nn->client_tracking_ops = &nfsd4_cld_tracking_ops;
1304 printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1305 "removed in 3.10. Please transition to using "
1308 status = nn->client_tracking_ops->init(net);
1310 printk(KERN_WARNING "NFSD: Unable to initialize client "
1311 "recovery tracking! (%d)\n", status);
1312 nn->client_tracking_ops = NULL;
1318 nfsd4_client_tracking_exit(struct net *net)
1320 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1322 if (nn->client_tracking_ops) {
1323 if (nn->client_tracking_ops->exit)
1324 nn->client_tracking_ops->exit(net);
1325 nn->client_tracking_ops = NULL;
1330 nfsd4_client_record_create(struct nfs4_client *clp)
1332 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1334 if (nn->client_tracking_ops)
1335 nn->client_tracking_ops->create(clp);
1339 nfsd4_client_record_remove(struct nfs4_client *clp)
1341 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1343 if (nn->client_tracking_ops)
1344 nn->client_tracking_ops->remove(clp);
1348 nfsd4_client_record_check(struct nfs4_client *clp)
1350 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1352 if (nn->client_tracking_ops)
1353 return nn->client_tracking_ops->check(clp);
1359 nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time)
1361 if (nn->client_tracking_ops)
1362 nn->client_tracking_ops->grace_done(nn, boot_time);
1366 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1368 struct super_block *sb = ptr;
1369 struct net *net = sb->s_fs_info;
1370 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1371 struct cld_net *cn = nn->cld_net;
1372 struct dentry *dentry;
1375 if (!try_module_get(THIS_MODULE))
1379 module_put(THIS_MODULE);
1384 case RPC_PIPEFS_MOUNT:
1385 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1386 if (IS_ERR(dentry)) {
1387 ret = PTR_ERR(dentry);
1390 cn->cn_pipe->dentry = dentry;
1392 case RPC_PIPEFS_UMOUNT:
1393 if (cn->cn_pipe->dentry)
1394 nfsd4_cld_unregister_sb(cn->cn_pipe);
1400 module_put(THIS_MODULE);
1404 static struct notifier_block nfsd4_cld_block = {
1405 .notifier_call = rpc_pipefs_event,
1409 register_cld_notifier(void)
1411 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1415 unregister_cld_notifier(void)
1417 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);