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 net *, time_t);
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;
71 nfs4_save_creds(const struct cred **original_creds)
75 new = prepare_creds();
81 *original_creds = override_creds(new);
87 nfs4_reset_creds(const struct cred *original)
89 revert_creds(original);
93 md5_to_hex(char *out, char *md5)
97 for (i=0; i<16; i++) {
98 unsigned char c = md5[i];
100 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
101 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
107 nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
109 struct xdr_netobj cksum;
110 struct hash_desc desc;
111 struct scatterlist sg;
112 __be32 status = nfserr_jukebox;
114 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
115 clname->len, clname->data);
116 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
117 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
118 if (IS_ERR(desc.tfm))
120 cksum.len = crypto_hash_digestsize(desc.tfm);
121 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
122 if (cksum.data == NULL)
125 sg_init_one(&sg, clname->data, clname->len);
127 if (crypto_hash_digest(&desc, &sg, sg.length, cksum.data))
130 md5_to_hex(dname, cksum.data);
135 crypto_free_hash(desc.tfm);
141 nfsd4_create_clid_dir(struct nfs4_client *clp)
143 const struct cred *original_cred;
144 char *dname = clp->cl_recdir;
145 struct dentry *dir, *dentry;
146 struct nfs4_client_reclaim *crp;
149 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
151 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
155 status = nfs4_save_creds(&original_cred);
159 status = mnt_want_write_file(rec_file);
163 dir = rec_file->f_path.dentry;
164 /* lock the parent */
165 mutex_lock(&dir->d_inode->i_mutex);
167 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
168 if (IS_ERR(dentry)) {
169 status = PTR_ERR(dentry);
174 * In the 4.1 case, where we're called from
175 * reclaim_complete(), records from the previous reboot
176 * may still be left, so this is OK.
178 * In the 4.0 case, we should never get here; but we may
179 * as well be forgiving and just succeed silently.
182 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
186 mutex_unlock(&dir->d_inode->i_mutex);
189 crp = nfs4_client_to_reclaim(clp->cl_recdir);
193 vfs_fsync(rec_file, 0);
195 printk(KERN_ERR "NFSD: failed to write recovery record"
196 " (err %d); please check that %s exists"
197 " and is writeable", status,
198 user_recovery_dirname);
200 mnt_drop_write_file(rec_file);
201 nfs4_reset_creds(original_cred);
204 typedef int (recdir_func)(struct dentry *, struct dentry *);
207 char name[HEXDIR_LEN];
208 struct list_head list;
212 nfsd4_build_namelist(void *arg, const char *name, int namlen,
213 loff_t offset, u64 ino, unsigned int d_type)
215 struct list_head *names = arg;
216 struct name_list *entry;
218 if (namlen != HEXDIR_LEN - 1)
220 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
223 memcpy(entry->name, name, HEXDIR_LEN - 1);
224 entry->name[HEXDIR_LEN - 1] = '\0';
225 list_add(&entry->list, names);
230 nfsd4_list_rec_dir(recdir_func *f)
232 const struct cred *original_cred;
233 struct dentry *dir = rec_file->f_path.dentry;
237 status = nfs4_save_creds(&original_cred);
241 status = vfs_llseek(rec_file, 0, SEEK_SET);
243 nfs4_reset_creds(original_cred);
247 status = vfs_readdir(rec_file, nfsd4_build_namelist, &names);
248 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
249 while (!list_empty(&names)) {
250 struct name_list *entry;
251 entry = list_entry(names.next, struct name_list, list);
253 struct dentry *dentry;
254 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
255 if (IS_ERR(dentry)) {
256 status = PTR_ERR(dentry);
259 status = f(dir, dentry);
262 list_del(&entry->list);
265 mutex_unlock(&dir->d_inode->i_mutex);
266 nfs4_reset_creds(original_cred);
271 nfsd4_unlink_clid_dir(char *name, int namlen)
273 struct dentry *dir, *dentry;
276 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
278 dir = rec_file->f_path.dentry;
279 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
280 dentry = lookup_one_len(name, dir, namlen);
281 if (IS_ERR(dentry)) {
282 status = PTR_ERR(dentry);
286 if (!dentry->d_inode)
288 status = vfs_rmdir(dir->d_inode, dentry);
292 mutex_unlock(&dir->d_inode->i_mutex);
297 nfsd4_remove_clid_dir(struct nfs4_client *clp)
299 const struct cred *original_cred;
300 struct nfs4_client_reclaim *crp;
303 if (!rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
306 status = mnt_want_write_file(rec_file);
309 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
311 status = nfs4_save_creds(&original_cred);
315 status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
316 nfs4_reset_creds(original_cred);
318 vfs_fsync(rec_file, 0);
320 /* remove reclaim record */
321 crp = nfsd4_find_reclaim_client(clp->cl_recdir);
323 nfs4_remove_reclaim_record(crp);
327 mnt_drop_write_file(rec_file);
330 printk("NFSD: Failed to remove expired client state directory"
331 " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
335 purge_old(struct dentry *parent, struct dentry *child)
339 if (nfs4_has_reclaimed_state(child->d_name.name))
342 status = vfs_rmdir(parent->d_inode, child);
344 printk("failed to remove client recovery directory %s\n",
346 /* Keep trying, success or failure: */
351 nfsd4_recdir_purge_old(struct net *net, time_t boot_time)
358 status = mnt_want_write_file(rec_file);
361 status = nfsd4_list_rec_dir(purge_old);
363 vfs_fsync(rec_file, 0);
364 mnt_drop_write_file(rec_file);
367 printk("nfsd4: failed to purge old clients from recovery"
368 " directory %s\n", rec_file->f_path.dentry->d_name.name);
372 load_recdir(struct dentry *parent, struct dentry *child)
374 if (child->d_name.len != HEXDIR_LEN - 1) {
375 printk("nfsd4: illegal name %s in recovery directory\n",
377 /* Keep trying; maybe the others are OK: */
380 nfs4_client_to_reclaim(child->d_name.name);
385 nfsd4_recdir_load(void) {
391 status = nfsd4_list_rec_dir(load_recdir);
393 printk("nfsd4: failed loading clients from recovery"
394 " directory %s\n", rec_file->f_path.dentry->d_name.name);
399 * Hold reference to the recovery directory.
403 nfsd4_init_recdir(void)
405 const struct cred *original_cred;
408 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
409 user_recovery_dirname);
413 status = nfs4_save_creds(&original_cred);
415 printk("NFSD: Unable to change credentials to find recovery"
416 " directory: error %d\n",
421 rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
422 if (IS_ERR(rec_file)) {
423 printk("NFSD: unable to find recovery directory %s\n",
424 user_recovery_dirname);
425 status = PTR_ERR(rec_file);
429 nfs4_reset_creds(original_cred);
436 nfsd4_load_reboot_recovery_data(struct net *net)
440 /* XXX: The legacy code won't work in a container */
441 if (net != &init_net) {
442 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
443 "tracking in a container!\n");
448 status = nfsd4_init_recdir();
450 status = nfsd4_recdir_load();
453 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
458 nfsd4_shutdown_recdir(void)
467 nfsd4_legacy_tracking_exit(struct net *net)
469 nfs4_release_reclaim();
470 nfsd4_shutdown_recdir();
474 * Change the NFSv4 recovery directory to recdir.
477 nfs4_reset_recoverydir(char *recdir)
482 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
486 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
487 strcpy(user_recovery_dirname, recdir);
495 nfs4_recoverydir(void)
497 return user_recovery_dirname;
501 nfsd4_check_legacy_client(struct nfs4_client *clp)
503 struct nfs4_client_reclaim *crp;
505 /* did we already find that this client is stable? */
506 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
509 /* look for it in the reclaim hashtable otherwise */
510 crp = nfsd4_find_reclaim_client(clp->cl_recdir);
512 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
520 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
521 .init = nfsd4_load_reboot_recovery_data,
522 .exit = nfsd4_legacy_tracking_exit,
523 .create = nfsd4_create_clid_dir,
524 .remove = nfsd4_remove_clid_dir,
525 .check = nfsd4_check_legacy_client,
526 .grace_done = nfsd4_recdir_purge_old,
530 #define NFSD_PIPE_DIR "nfsd"
531 #define NFSD_CLD_PIPE "cld"
533 /* per-net-ns structure for holding cld upcall info */
535 struct rpc_pipe *cn_pipe;
537 struct list_head cn_list;
542 struct list_head cu_list;
543 struct cld_net *cu_net;
544 struct task_struct *cu_task;
545 struct cld_msg cu_msg;
549 __cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
552 struct rpc_pipe_msg msg;
554 memset(&msg, 0, sizeof(msg));
556 msg.len = sizeof(*cmsg);
559 * Set task state before we queue the upcall. That prevents
560 * wake_up_process in the downcall from racing with schedule.
562 set_current_state(TASK_UNINTERRUPTIBLE);
563 ret = rpc_queue_upcall(pipe, &msg);
565 set_current_state(TASK_RUNNING);
570 set_current_state(TASK_RUNNING);
579 cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
584 * -EAGAIN occurs when pipe is closed and reopened while there are
588 ret = __cld_pipe_upcall(pipe, cmsg);
589 } while (ret == -EAGAIN);
595 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
597 struct cld_upcall *tmp, *cup;
598 struct cld_msg __user *cmsg = (struct cld_msg __user *)src;
600 struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
602 struct cld_net *cn = nn->cld_net;
604 if (mlen != sizeof(*cmsg)) {
605 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
610 /* copy just the xid so we can try to find that */
611 if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
612 dprintk("%s: error when copying xid from userspace", __func__);
616 /* walk the list and find corresponding xid */
618 spin_lock(&cn->cn_lock);
619 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
620 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
622 list_del_init(&cup->cu_list);
626 spin_unlock(&cn->cn_lock);
628 /* couldn't find upcall? */
630 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
634 if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
637 wake_up_process(cup->cu_task);
642 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
644 struct cld_msg *cmsg = msg->data;
645 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
648 /* errno >= 0 means we got a downcall */
652 wake_up_process(cup->cu_task);
655 static const struct rpc_pipe_ops cld_upcall_ops = {
656 .upcall = rpc_pipe_generic_upcall,
657 .downcall = cld_pipe_downcall,
658 .destroy_msg = cld_pipe_destroy_msg,
661 static struct dentry *
662 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
664 struct dentry *dir, *dentry;
666 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
668 return ERR_PTR(-ENOENT);
669 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
675 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
678 rpc_unlink(pipe->dentry);
681 static struct dentry *
682 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
684 struct super_block *sb;
685 struct dentry *dentry;
687 sb = rpc_get_sb_net(net);
690 dentry = nfsd4_cld_register_sb(sb, pipe);
696 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
698 struct super_block *sb;
700 sb = rpc_get_sb_net(net);
702 nfsd4_cld_unregister_sb(pipe);
707 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
709 nfsd4_init_cld_pipe(struct net *net)
712 struct dentry *dentry;
713 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
719 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
725 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
726 if (IS_ERR(cn->cn_pipe)) {
727 ret = PTR_ERR(cn->cn_pipe);
730 spin_lock_init(&cn->cn_lock);
731 INIT_LIST_HEAD(&cn->cn_list);
733 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
734 if (IS_ERR(dentry)) {
735 ret = PTR_ERR(dentry);
736 goto err_destroy_data;
739 cn->cn_pipe->dentry = dentry;
744 rpc_destroy_pipe_data(cn->cn_pipe);
747 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
753 nfsd4_remove_cld_pipe(struct net *net)
755 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
756 struct cld_net *cn = nn->cld_net;
758 nfsd4_cld_unregister_net(net, cn->cn_pipe);
759 rpc_destroy_pipe_data(cn->cn_pipe);
764 static struct cld_upcall *
765 alloc_cld_upcall(struct cld_net *cn)
767 struct cld_upcall *new, *tmp;
769 new = kzalloc(sizeof(*new), GFP_KERNEL);
773 /* FIXME: hard cap on number in flight? */
775 spin_lock(&cn->cn_lock);
776 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
777 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
779 spin_unlock(&cn->cn_lock);
783 new->cu_task = current;
784 new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
785 put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
787 list_add(&new->cu_list, &cn->cn_list);
788 spin_unlock(&cn->cn_lock);
790 dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
796 free_cld_upcall(struct cld_upcall *victim)
798 struct cld_net *cn = victim->cu_net;
800 spin_lock(&cn->cn_lock);
801 list_del(&victim->cu_list);
802 spin_unlock(&cn->cn_lock);
806 /* Ask daemon to create a new record */
808 nfsd4_cld_create(struct nfs4_client *clp)
811 struct cld_upcall *cup;
812 /* FIXME: determine net from clp */
813 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
814 struct cld_net *cn = nn->cld_net;
816 /* Don't upcall if it's already stored */
817 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
820 cup = alloc_cld_upcall(cn);
826 cup->cu_msg.cm_cmd = Cld_Create;
827 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
828 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
831 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
833 ret = cup->cu_msg.cm_status;
834 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
837 free_cld_upcall(cup);
840 printk(KERN_ERR "NFSD: Unable to create client "
841 "record on stable storage: %d\n", ret);
844 /* Ask daemon to create a new record */
846 nfsd4_cld_remove(struct nfs4_client *clp)
849 struct cld_upcall *cup;
850 /* FIXME: determine net from clp */
851 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
852 struct cld_net *cn = nn->cld_net;
854 /* Don't upcall if it's already removed */
855 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
858 cup = alloc_cld_upcall(cn);
864 cup->cu_msg.cm_cmd = Cld_Remove;
865 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
866 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
869 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
871 ret = cup->cu_msg.cm_status;
872 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
875 free_cld_upcall(cup);
878 printk(KERN_ERR "NFSD: Unable to remove client "
879 "record from stable storage: %d\n", ret);
882 /* Check for presence of a record, and update its timestamp */
884 nfsd4_cld_check(struct nfs4_client *clp)
887 struct cld_upcall *cup;
888 /* FIXME: determine net from clp */
889 struct nfsd_net *nn = net_generic(&init_net, nfsd_net_id);
890 struct cld_net *cn = nn->cld_net;
892 /* Don't upcall if one was already stored during this grace pd */
893 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
896 cup = alloc_cld_upcall(cn);
898 printk(KERN_ERR "NFSD: Unable to check client record on "
899 "stable storage: %d\n", -ENOMEM);
903 cup->cu_msg.cm_cmd = Cld_Check;
904 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
905 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
908 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
910 ret = cup->cu_msg.cm_status;
911 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
914 free_cld_upcall(cup);
919 nfsd4_cld_grace_done(struct net *net, time_t boot_time)
922 struct cld_upcall *cup;
923 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
924 struct cld_net *cn = nn->cld_net;
926 cup = alloc_cld_upcall(cn);
932 cup->cu_msg.cm_cmd = Cld_GraceDone;
933 cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
934 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
936 ret = cup->cu_msg.cm_status;
938 free_cld_upcall(cup);
941 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
944 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
945 .init = nfsd4_init_cld_pipe,
946 .exit = nfsd4_remove_cld_pipe,
947 .create = nfsd4_cld_create,
948 .remove = nfsd4_cld_remove,
949 .check = nfsd4_cld_check,
950 .grace_done = nfsd4_cld_grace_done,
953 /* upcall via usermodehelper */
954 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
955 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
957 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
959 static bool cltrack_legacy_disable;
960 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
961 MODULE_PARM_DESC(cltrack_legacy_disable,
962 "Disable legacy recoverydir conversion. Default: false");
964 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
965 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
968 nfsd4_cltrack_legacy_topdir(void)
974 if (cltrack_legacy_disable)
977 len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
978 strlen(nfs4_recoverydir()) + 1;
980 result = kmalloc(len, GFP_KERNEL);
984 copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
987 /* just return nothing if output was truncated */
996 nfsd4_cltrack_legacy_recdir(const char *recdir)
1002 if (cltrack_legacy_disable)
1005 /* +1 is for '/' between "topdir" and "recdir" */
1006 len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1007 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1009 result = kmalloc(len, GFP_KERNEL);
1013 copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/%s",
1014 nfs4_recoverydir(), recdir);
1015 if (copied >= len) {
1016 /* just return nothing if output was truncated */
1025 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *legacy)
1031 if (unlikely(!cltrack_prog[0])) {
1032 dprintk("%s: cltrack_prog is disabled\n", __func__);
1036 dprintk("%s: cmd: %s\n", __func__, cmd);
1037 dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1038 dprintk("%s: legacy: %s\n", __func__, legacy ? legacy : "(null)");
1043 argv[0] = (char *)cltrack_prog;
1048 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1050 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1051 * error. The admin can re-enable it on the fly by using sysfs
1052 * once the problem has been fixed.
1054 if (ret == -ENOENT || ret == -EACCES) {
1055 dprintk("NFSD: %s was not found or isn't executable (%d). "
1056 "Setting cltrack_prog to blank string!",
1058 cltrack_prog[0] = '\0';
1060 dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1066 bin_to_hex_dup(const unsigned char *src, int srclen)
1071 /* +1 for terminating NULL */
1072 buf = kmalloc((srclen * 2) + 1, GFP_KERNEL);
1077 for (i = 0; i < srclen; i++) {
1078 sprintf(hex, "%2.2x", *src++);
1085 nfsd4_umh_cltrack_init(struct net __attribute__((unused)) *net)
1087 return nfsd4_umh_cltrack_upcall("init", NULL, NULL);
1091 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1095 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1097 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1100 nfsd4_umh_cltrack_upcall("create", hexid, NULL);
1105 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1109 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1111 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1114 nfsd4_umh_cltrack_upcall("remove", hexid, NULL);
1119 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1122 char *hexid, *legacy;
1124 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1126 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1129 legacy = nfsd4_cltrack_legacy_recdir(clp->cl_recdir);
1130 ret = nfsd4_umh_cltrack_upcall("check", hexid, legacy);
1137 nfsd4_umh_cltrack_grace_done(struct net __attribute__((unused)) *net,
1141 char timestr[22]; /* FIXME: better way to determine max size? */
1143 sprintf(timestr, "%ld", boot_time);
1144 legacy = nfsd4_cltrack_legacy_topdir();
1145 nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy);
1149 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
1150 .init = nfsd4_umh_cltrack_init,
1152 .create = nfsd4_umh_cltrack_create,
1153 .remove = nfsd4_umh_cltrack_remove,
1154 .check = nfsd4_umh_cltrack_check,
1155 .grace_done = nfsd4_umh_cltrack_grace_done,
1159 nfsd4_client_tracking_init(struct net *net)
1164 /* just run the init if it the method is already decided */
1165 if (client_tracking_ops)
1169 * First, try a UMH upcall. It should succeed or fail quickly, so
1170 * there's little harm in trying that first.
1172 client_tracking_ops = &nfsd4_umh_tracking_ops;
1173 status = client_tracking_ops->init(net);
1178 * See if the recoverydir exists and is a directory. If it is,
1179 * then use the legacy ops.
1181 client_tracking_ops = &nfsd4_legacy_tracking_ops;
1182 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1184 status = S_ISDIR(path.dentry->d_inode->i_mode);
1190 /* Finally, try to use nfsdcld */
1191 client_tracking_ops = &nfsd4_cld_tracking_ops;
1192 printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1193 "removed in 3.10. Please transition to using "
1196 status = client_tracking_ops->init(net);
1198 printk(KERN_WARNING "NFSD: Unable to initialize client "
1199 "recovery tracking! (%d)\n", status);
1200 client_tracking_ops = NULL;
1206 nfsd4_client_tracking_exit(struct net *net)
1208 if (client_tracking_ops) {
1209 if (client_tracking_ops->exit)
1210 client_tracking_ops->exit(net);
1211 client_tracking_ops = NULL;
1216 nfsd4_client_record_create(struct nfs4_client *clp)
1218 if (client_tracking_ops)
1219 client_tracking_ops->create(clp);
1223 nfsd4_client_record_remove(struct nfs4_client *clp)
1225 if (client_tracking_ops)
1226 client_tracking_ops->remove(clp);
1230 nfsd4_client_record_check(struct nfs4_client *clp)
1232 if (client_tracking_ops)
1233 return client_tracking_ops->check(clp);
1239 nfsd4_record_grace_done(struct net *net, time_t boot_time)
1241 if (client_tracking_ops)
1242 client_tracking_ops->grace_done(net, boot_time);
1246 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1248 struct super_block *sb = ptr;
1249 struct net *net = sb->s_fs_info;
1250 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1251 struct cld_net *cn = nn->cld_net;
1252 struct dentry *dentry;
1255 if (!try_module_get(THIS_MODULE))
1259 module_put(THIS_MODULE);
1264 case RPC_PIPEFS_MOUNT:
1265 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1266 if (IS_ERR(dentry)) {
1267 ret = PTR_ERR(dentry);
1270 cn->cn_pipe->dentry = dentry;
1272 case RPC_PIPEFS_UMOUNT:
1273 if (cn->cn_pipe->dentry)
1274 nfsd4_cld_unregister_sb(cn->cn_pipe);
1280 module_put(THIS_MODULE);
1284 static struct notifier_block nfsd4_cld_block = {
1285 .notifier_call = rpc_pipefs_event,
1289 register_cld_notifier(void)
1291 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1295 unregister_cld_notifier(void)
1297 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);