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 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
178 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
183 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
185 return legacy_recdir_name_error(clp, status);
187 status = nfs4_save_creds(&original_cred);
191 status = mnt_want_write_file(nn->rec_file);
195 dir = nn->rec_file->f_path.dentry;
196 /* lock the parent */
197 mutex_lock(&dir->d_inode->i_mutex);
199 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
200 if (IS_ERR(dentry)) {
201 status = PTR_ERR(dentry);
206 * In the 4.1 case, where we're called from
207 * reclaim_complete(), records from the previous reboot
208 * may still be left, so this is OK.
210 * In the 4.0 case, we should never get here; but we may
211 * as well be forgiving and just succeed silently.
214 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
218 mutex_unlock(&dir->d_inode->i_mutex);
221 crp = nfs4_client_to_reclaim(dname, nn);
225 vfs_fsync(nn->rec_file, 0);
227 printk(KERN_ERR "NFSD: failed to write recovery record"
228 " (err %d); please check that %s exists"
229 " and is writeable", status,
230 user_recovery_dirname);
232 mnt_drop_write_file(nn->rec_file);
233 nfs4_reset_creds(original_cred);
236 typedef int (recdir_func)(struct dentry *, struct dentry *, struct nfsd_net *);
239 char name[HEXDIR_LEN];
240 struct list_head list;
244 nfsd4_build_namelist(void *arg, const char *name, int namlen,
245 loff_t offset, u64 ino, unsigned int d_type)
247 struct list_head *names = arg;
248 struct name_list *entry;
250 if (namlen != HEXDIR_LEN - 1)
252 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
255 memcpy(entry->name, name, HEXDIR_LEN - 1);
256 entry->name[HEXDIR_LEN - 1] = '\0';
257 list_add(&entry->list, names);
262 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
264 const struct cred *original_cred;
265 struct dentry *dir = nn->rec_file->f_path.dentry;
269 status = nfs4_save_creds(&original_cred);
273 status = vfs_llseek(nn->rec_file, 0, SEEK_SET);
275 nfs4_reset_creds(original_cred);
279 status = vfs_readdir(nn->rec_file, nfsd4_build_namelist, &names);
280 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
281 while (!list_empty(&names)) {
282 struct name_list *entry;
283 entry = list_entry(names.next, struct name_list, list);
285 struct dentry *dentry;
286 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
287 if (IS_ERR(dentry)) {
288 status = PTR_ERR(dentry);
291 status = f(dir, dentry, nn);
294 list_del(&entry->list);
297 mutex_unlock(&dir->d_inode->i_mutex);
298 nfs4_reset_creds(original_cred);
303 nfsd4_unlink_clid_dir(char *name, int namlen, struct nfsd_net *nn)
305 struct dentry *dir, *dentry;
308 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
310 dir = nn->rec_file->f_path.dentry;
311 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
312 dentry = lookup_one_len(name, dir, namlen);
313 if (IS_ERR(dentry)) {
314 status = PTR_ERR(dentry);
318 if (!dentry->d_inode)
320 status = vfs_rmdir(dir->d_inode, dentry);
324 mutex_unlock(&dir->d_inode->i_mutex);
329 nfsd4_remove_clid_dir(struct nfs4_client *clp)
331 const struct cred *original_cred;
332 struct nfs4_client_reclaim *crp;
333 char dname[HEXDIR_LEN];
335 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
337 if (!nn->rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
340 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
342 return legacy_recdir_name_error(clp, status);
344 status = mnt_want_write_file(nn->rec_file);
347 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
349 status = nfs4_save_creds(&original_cred);
353 status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1, nn);
354 nfs4_reset_creds(original_cred);
356 vfs_fsync(nn->rec_file, 0);
358 /* remove reclaim record */
359 crp = nfsd4_find_reclaim_client(dname, nn);
361 nfs4_remove_reclaim_record(crp, nn);
365 mnt_drop_write_file(nn->rec_file);
368 printk("NFSD: Failed to remove expired client state directory"
369 " %.*s\n", HEXDIR_LEN, dname);
373 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
377 if (nfs4_has_reclaimed_state(child->d_name.name, nn))
380 status = vfs_rmdir(parent->d_inode, child);
382 printk("failed to remove client recovery directory %s\n",
384 /* Keep trying, success or failure: */
389 nfsd4_recdir_purge_old(struct nfsd_net *nn, time_t boot_time)
393 nn->in_grace = false;
396 status = mnt_want_write_file(nn->rec_file);
399 status = nfsd4_list_rec_dir(purge_old, nn);
401 vfs_fsync(nn->rec_file, 0);
402 mnt_drop_write_file(nn->rec_file);
404 nfs4_release_reclaim(nn);
406 printk("nfsd4: failed to purge old clients from recovery"
407 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
411 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
413 if (child->d_name.len != HEXDIR_LEN - 1) {
414 printk("nfsd4: illegal name %s in recovery directory\n",
416 /* Keep trying; maybe the others are OK: */
419 nfs4_client_to_reclaim(child->d_name.name, nn);
424 nfsd4_recdir_load(struct net *net) {
426 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
431 status = nfsd4_list_rec_dir(load_recdir, nn);
433 printk("nfsd4: failed loading clients from recovery"
434 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
439 * Hold reference to the recovery directory.
443 nfsd4_init_recdir(struct net *net)
445 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
446 const struct cred *original_cred;
449 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
450 user_recovery_dirname);
452 BUG_ON(nn->rec_file);
454 status = nfs4_save_creds(&original_cred);
456 printk("NFSD: Unable to change credentials to find recovery"
457 " directory: error %d\n",
462 nn->rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
463 if (IS_ERR(nn->rec_file)) {
464 printk("NFSD: unable to find recovery directory %s\n",
465 user_recovery_dirname);
466 status = PTR_ERR(nn->rec_file);
470 nfs4_reset_creds(original_cred);
478 nfs4_legacy_state_init(struct net *net)
480 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
483 nn->reclaim_str_hashtbl = kmalloc(sizeof(struct list_head) *
484 CLIENT_HASH_SIZE, GFP_KERNEL);
485 if (!nn->reclaim_str_hashtbl)
488 for (i = 0; i < CLIENT_HASH_SIZE; i++)
489 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
490 nn->reclaim_str_hashtbl_size = 0;
496 nfs4_legacy_state_shutdown(struct net *net)
498 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
500 kfree(nn->reclaim_str_hashtbl);
504 nfsd4_load_reboot_recovery_data(struct net *net)
508 status = nfsd4_init_recdir(net);
510 status = nfsd4_recdir_load(net);
512 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
517 nfsd4_legacy_tracking_init(struct net *net)
521 /* XXX: The legacy code won't work in a container */
522 if (net != &init_net) {
523 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
524 "tracking in a container!\n");
528 status = nfs4_legacy_state_init(net);
532 status = nfsd4_load_reboot_recovery_data(net);
538 nfs4_legacy_state_shutdown(net);
543 nfsd4_shutdown_recdir(struct nfsd_net *nn)
552 nfsd4_legacy_tracking_exit(struct net *net)
554 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
556 nfs4_release_reclaim(nn);
557 nfsd4_shutdown_recdir(nn);
558 nfs4_legacy_state_shutdown(net);
562 * Change the NFSv4 recovery directory to recdir.
565 nfs4_reset_recoverydir(char *recdir)
570 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
574 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
575 strcpy(user_recovery_dirname, recdir);
583 nfs4_recoverydir(void)
585 return user_recovery_dirname;
589 nfsd4_check_legacy_client(struct nfs4_client *clp)
592 char dname[HEXDIR_LEN];
593 struct nfs4_client_reclaim *crp;
594 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
596 /* did we already find that this client is stable? */
597 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
600 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
602 legacy_recdir_name_error(clp, status);
606 /* look for it in the reclaim hashtable otherwise */
607 crp = nfsd4_find_reclaim_client(dname, nn);
609 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
617 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
618 .init = nfsd4_legacy_tracking_init,
619 .exit = nfsd4_legacy_tracking_exit,
620 .create = nfsd4_create_clid_dir,
621 .remove = nfsd4_remove_clid_dir,
622 .check = nfsd4_check_legacy_client,
623 .grace_done = nfsd4_recdir_purge_old,
627 #define NFSD_PIPE_DIR "nfsd"
628 #define NFSD_CLD_PIPE "cld"
630 /* per-net-ns structure for holding cld upcall info */
632 struct rpc_pipe *cn_pipe;
634 struct list_head cn_list;
639 struct list_head cu_list;
640 struct cld_net *cu_net;
641 struct task_struct *cu_task;
642 struct cld_msg cu_msg;
646 __cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
649 struct rpc_pipe_msg msg;
651 memset(&msg, 0, sizeof(msg));
653 msg.len = sizeof(*cmsg);
656 * Set task state before we queue the upcall. That prevents
657 * wake_up_process in the downcall from racing with schedule.
659 set_current_state(TASK_UNINTERRUPTIBLE);
660 ret = rpc_queue_upcall(pipe, &msg);
662 set_current_state(TASK_RUNNING);
667 set_current_state(TASK_RUNNING);
676 cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
681 * -EAGAIN occurs when pipe is closed and reopened while there are
685 ret = __cld_pipe_upcall(pipe, cmsg);
686 } while (ret == -EAGAIN);
692 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
694 struct cld_upcall *tmp, *cup;
695 struct cld_msg __user *cmsg = (struct cld_msg __user *)src;
697 struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
699 struct cld_net *cn = nn->cld_net;
701 if (mlen != sizeof(*cmsg)) {
702 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
707 /* copy just the xid so we can try to find that */
708 if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
709 dprintk("%s: error when copying xid from userspace", __func__);
713 /* walk the list and find corresponding xid */
715 spin_lock(&cn->cn_lock);
716 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
717 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
719 list_del_init(&cup->cu_list);
723 spin_unlock(&cn->cn_lock);
725 /* couldn't find upcall? */
727 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
731 if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
734 wake_up_process(cup->cu_task);
739 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
741 struct cld_msg *cmsg = msg->data;
742 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
745 /* errno >= 0 means we got a downcall */
749 wake_up_process(cup->cu_task);
752 static const struct rpc_pipe_ops cld_upcall_ops = {
753 .upcall = rpc_pipe_generic_upcall,
754 .downcall = cld_pipe_downcall,
755 .destroy_msg = cld_pipe_destroy_msg,
758 static struct dentry *
759 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
761 struct dentry *dir, *dentry;
763 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
765 return ERR_PTR(-ENOENT);
766 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
772 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
775 rpc_unlink(pipe->dentry);
778 static struct dentry *
779 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
781 struct super_block *sb;
782 struct dentry *dentry;
784 sb = rpc_get_sb_net(net);
787 dentry = nfsd4_cld_register_sb(sb, pipe);
793 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
795 struct super_block *sb;
797 sb = rpc_get_sb_net(net);
799 nfsd4_cld_unregister_sb(pipe);
804 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
806 nfsd4_init_cld_pipe(struct net *net)
809 struct dentry *dentry;
810 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
816 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
822 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
823 if (IS_ERR(cn->cn_pipe)) {
824 ret = PTR_ERR(cn->cn_pipe);
827 spin_lock_init(&cn->cn_lock);
828 INIT_LIST_HEAD(&cn->cn_list);
830 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
831 if (IS_ERR(dentry)) {
832 ret = PTR_ERR(dentry);
833 goto err_destroy_data;
836 cn->cn_pipe->dentry = dentry;
841 rpc_destroy_pipe_data(cn->cn_pipe);
844 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
850 nfsd4_remove_cld_pipe(struct net *net)
852 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
853 struct cld_net *cn = nn->cld_net;
855 nfsd4_cld_unregister_net(net, cn->cn_pipe);
856 rpc_destroy_pipe_data(cn->cn_pipe);
861 static struct cld_upcall *
862 alloc_cld_upcall(struct cld_net *cn)
864 struct cld_upcall *new, *tmp;
866 new = kzalloc(sizeof(*new), GFP_KERNEL);
870 /* FIXME: hard cap on number in flight? */
872 spin_lock(&cn->cn_lock);
873 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
874 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
876 spin_unlock(&cn->cn_lock);
880 new->cu_task = current;
881 new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
882 put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
884 list_add(&new->cu_list, &cn->cn_list);
885 spin_unlock(&cn->cn_lock);
887 dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
893 free_cld_upcall(struct cld_upcall *victim)
895 struct cld_net *cn = victim->cu_net;
897 spin_lock(&cn->cn_lock);
898 list_del(&victim->cu_list);
899 spin_unlock(&cn->cn_lock);
903 /* Ask daemon to create a new record */
905 nfsd4_cld_create(struct nfs4_client *clp)
908 struct cld_upcall *cup;
909 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
910 struct cld_net *cn = nn->cld_net;
912 /* Don't upcall if it's already stored */
913 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
916 cup = alloc_cld_upcall(cn);
922 cup->cu_msg.cm_cmd = Cld_Create;
923 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
924 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
927 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
929 ret = cup->cu_msg.cm_status;
930 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
933 free_cld_upcall(cup);
936 printk(KERN_ERR "NFSD: Unable to create client "
937 "record on stable storage: %d\n", ret);
940 /* Ask daemon to create a new record */
942 nfsd4_cld_remove(struct nfs4_client *clp)
945 struct cld_upcall *cup;
946 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
947 struct cld_net *cn = nn->cld_net;
949 /* Don't upcall if it's already removed */
950 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
953 cup = alloc_cld_upcall(cn);
959 cup->cu_msg.cm_cmd = Cld_Remove;
960 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
961 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
964 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
966 ret = cup->cu_msg.cm_status;
967 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
970 free_cld_upcall(cup);
973 printk(KERN_ERR "NFSD: Unable to remove client "
974 "record from stable storage: %d\n", ret);
977 /* Check for presence of a record, and update its timestamp */
979 nfsd4_cld_check(struct nfs4_client *clp)
982 struct cld_upcall *cup;
983 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
984 struct cld_net *cn = nn->cld_net;
986 /* Don't upcall if one was already stored during this grace pd */
987 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
990 cup = alloc_cld_upcall(cn);
992 printk(KERN_ERR "NFSD: Unable to check client record on "
993 "stable storage: %d\n", -ENOMEM);
997 cup->cu_msg.cm_cmd = Cld_Check;
998 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
999 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1002 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1004 ret = cup->cu_msg.cm_status;
1005 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1008 free_cld_upcall(cup);
1013 nfsd4_cld_grace_done(struct nfsd_net *nn, time_t boot_time)
1016 struct cld_upcall *cup;
1017 struct cld_net *cn = nn->cld_net;
1019 cup = alloc_cld_upcall(cn);
1025 cup->cu_msg.cm_cmd = Cld_GraceDone;
1026 cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
1027 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1029 ret = cup->cu_msg.cm_status;
1031 free_cld_upcall(cup);
1034 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1037 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
1038 .init = nfsd4_init_cld_pipe,
1039 .exit = nfsd4_remove_cld_pipe,
1040 .create = nfsd4_cld_create,
1041 .remove = nfsd4_cld_remove,
1042 .check = nfsd4_cld_check,
1043 .grace_done = nfsd4_cld_grace_done,
1046 /* upcall via usermodehelper */
1047 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
1048 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
1050 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
1052 static bool cltrack_legacy_disable;
1053 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
1054 MODULE_PARM_DESC(cltrack_legacy_disable,
1055 "Disable legacy recoverydir conversion. Default: false");
1057 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1058 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1061 nfsd4_cltrack_legacy_topdir(void)
1067 if (cltrack_legacy_disable)
1070 len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
1071 strlen(nfs4_recoverydir()) + 1;
1073 result = kmalloc(len, GFP_KERNEL);
1077 copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
1078 nfs4_recoverydir());
1079 if (copied >= len) {
1080 /* just return nothing if output was truncated */
1089 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj *name)
1095 if (cltrack_legacy_disable)
1098 /* +1 is for '/' between "topdir" and "recdir" */
1099 len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1100 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1102 result = kmalloc(len, GFP_KERNEL);
1106 copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/",
1107 nfs4_recoverydir());
1108 if (copied > (len - HEXDIR_LEN)) {
1109 /* just return nothing if output will be truncated */
1114 copied = nfs4_make_rec_clidname(result + copied, name);
1124 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *legacy)
1130 if (unlikely(!cltrack_prog[0])) {
1131 dprintk("%s: cltrack_prog is disabled\n", __func__);
1135 dprintk("%s: cmd: %s\n", __func__, cmd);
1136 dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1137 dprintk("%s: legacy: %s\n", __func__, legacy ? legacy : "(null)");
1142 argv[0] = (char *)cltrack_prog;
1147 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1149 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1150 * error. The admin can re-enable it on the fly by using sysfs
1151 * once the problem has been fixed.
1153 if (ret == -ENOENT || ret == -EACCES) {
1154 dprintk("NFSD: %s was not found or isn't executable (%d). "
1155 "Setting cltrack_prog to blank string!",
1157 cltrack_prog[0] = '\0';
1159 dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1165 bin_to_hex_dup(const unsigned char *src, int srclen)
1170 /* +1 for terminating NULL */
1171 buf = kmalloc((srclen * 2) + 1, GFP_KERNEL);
1176 for (i = 0; i < srclen; i++) {
1177 sprintf(hex, "%2.2x", *src++);
1184 nfsd4_umh_cltrack_init(struct net __attribute__((unused)) *net)
1186 /* XXX: The usermode helper s not working in container yet. */
1187 if (net != &init_net) {
1188 WARN(1, KERN_ERR "NFSD: attempt to initialize umh client "
1189 "tracking in a container!\n");
1192 return nfsd4_umh_cltrack_upcall("init", NULL, NULL);
1196 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1200 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1202 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1205 nfsd4_umh_cltrack_upcall("create", hexid, NULL);
1210 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1214 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1216 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1219 nfsd4_umh_cltrack_upcall("remove", hexid, NULL);
1224 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1227 char *hexid, *legacy;
1229 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1231 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1234 legacy = nfsd4_cltrack_legacy_recdir(&clp->cl_name);
1235 ret = nfsd4_umh_cltrack_upcall("check", hexid, legacy);
1242 nfsd4_umh_cltrack_grace_done(struct nfsd_net __attribute__((unused)) *nn,
1246 char timestr[22]; /* FIXME: better way to determine max size? */
1248 sprintf(timestr, "%ld", boot_time);
1249 legacy = nfsd4_cltrack_legacy_topdir();
1250 nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy);
1254 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
1255 .init = nfsd4_umh_cltrack_init,
1257 .create = nfsd4_umh_cltrack_create,
1258 .remove = nfsd4_umh_cltrack_remove,
1259 .check = nfsd4_umh_cltrack_check,
1260 .grace_done = nfsd4_umh_cltrack_grace_done,
1264 nfsd4_client_tracking_init(struct net *net)
1268 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1270 /* just run the init if it the method is already decided */
1271 if (nn->client_tracking_ops)
1275 * First, try a UMH upcall. It should succeed or fail quickly, so
1276 * there's little harm in trying that first.
1278 nn->client_tracking_ops = &nfsd4_umh_tracking_ops;
1279 status = nn->client_tracking_ops->init(net);
1284 * See if the recoverydir exists and is a directory. If it is,
1285 * then use the legacy ops.
1287 nn->client_tracking_ops = &nfsd4_legacy_tracking_ops;
1288 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1290 status = S_ISDIR(path.dentry->d_inode->i_mode);
1296 /* Finally, try to use nfsdcld */
1297 nn->client_tracking_ops = &nfsd4_cld_tracking_ops;
1298 printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1299 "removed in 3.10. Please transition to using "
1302 status = nn->client_tracking_ops->init(net);
1304 printk(KERN_WARNING "NFSD: Unable to initialize client "
1305 "recovery tracking! (%d)\n", status);
1306 nn->client_tracking_ops = NULL;
1312 nfsd4_client_tracking_exit(struct net *net)
1314 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1316 if (nn->client_tracking_ops) {
1317 if (nn->client_tracking_ops->exit)
1318 nn->client_tracking_ops->exit(net);
1319 nn->client_tracking_ops = NULL;
1324 nfsd4_client_record_create(struct nfs4_client *clp)
1326 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1328 if (nn->client_tracking_ops)
1329 nn->client_tracking_ops->create(clp);
1333 nfsd4_client_record_remove(struct nfs4_client *clp)
1335 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1337 if (nn->client_tracking_ops)
1338 nn->client_tracking_ops->remove(clp);
1342 nfsd4_client_record_check(struct nfs4_client *clp)
1344 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1346 if (nn->client_tracking_ops)
1347 return nn->client_tracking_ops->check(clp);
1353 nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time)
1355 if (nn->client_tracking_ops)
1356 nn->client_tracking_ops->grace_done(nn, boot_time);
1360 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1362 struct super_block *sb = ptr;
1363 struct net *net = sb->s_fs_info;
1364 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1365 struct cld_net *cn = nn->cld_net;
1366 struct dentry *dentry;
1369 if (!try_module_get(THIS_MODULE))
1373 module_put(THIS_MODULE);
1378 case RPC_PIPEFS_MOUNT:
1379 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1380 if (IS_ERR(dentry)) {
1381 ret = PTR_ERR(dentry);
1384 cn->cn_pipe->dentry = dentry;
1386 case RPC_PIPEFS_UMOUNT:
1387 if (cn->cn_pipe->dentry)
1388 nfsd4_cld_unregister_sb(cn->cn_pipe);
1394 module_put(THIS_MODULE);
1398 static struct notifier_block nfsd4_cld_block = {
1399 .notifier_call = rpc_pipefs_event,
1403 register_cld_notifier(void)
1405 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1409 unregister_cld_notifier(void)
1411 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);