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 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, const struct xdr_netobj *clname)
109 struct xdr_netobj cksum;
110 struct hash_desc desc;
111 struct scatterlist sg;
114 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
115 clname->len, clname->data);
116 desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
117 desc.tfm = crypto_alloc_hash("md5", 0, CRYPTO_ALG_ASYNC);
118 if (IS_ERR(desc.tfm)) {
119 status = PTR_ERR(desc.tfm);
123 cksum.len = crypto_hash_digestsize(desc.tfm);
124 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
125 if (cksum.data == NULL) {
130 sg_init_one(&sg, clname->data, clname->len);
132 status = crypto_hash_digest(&desc, &sg, sg.length, cksum.data);
136 md5_to_hex(dname, cksum.data);
141 crypto_free_hash(desc.tfm);
147 * If we had an error generating the recdir name for the legacy tracker
148 * then warn the admin. If the error doesn't appear to be transient,
149 * then disable recovery tracking.
152 legacy_recdir_name_error(int error)
154 printk(KERN_ERR "NFSD: unable to generate recoverydir "
155 "name (%d).\n", error);
158 * if the algorithm just doesn't exist, then disable the recovery
159 * tracker altogether. The crypto libs will generally return this if
160 * FIPS is enabled as well.
162 if (error == -ENOENT) {
163 printk(KERN_ERR "NFSD: disabling legacy clientid tracking. "
164 "Reboot recovery will not function correctly!\n");
166 /* the argument is ignored by the legacy exit function */
167 nfsd4_client_tracking_exit(NULL);
172 nfsd4_create_clid_dir(struct nfs4_client *clp)
174 const struct cred *original_cred;
175 char dname[HEXDIR_LEN];
176 struct dentry *dir, *dentry;
177 struct nfs4_client_reclaim *crp;
179 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
181 dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
183 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
188 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
190 return legacy_recdir_name_error(status);
192 status = nfs4_save_creds(&original_cred);
196 status = mnt_want_write_file(rec_file);
200 dir = rec_file->f_path.dentry;
201 /* lock the parent */
202 mutex_lock(&dir->d_inode->i_mutex);
204 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
205 if (IS_ERR(dentry)) {
206 status = PTR_ERR(dentry);
211 * In the 4.1 case, where we're called from
212 * reclaim_complete(), records from the previous reboot
213 * may still be left, so this is OK.
215 * In the 4.0 case, we should never get here; but we may
216 * as well be forgiving and just succeed silently.
219 status = vfs_mkdir(dir->d_inode, dentry, S_IRWXU);
223 mutex_unlock(&dir->d_inode->i_mutex);
226 crp = nfs4_client_to_reclaim(dname, nn);
230 vfs_fsync(rec_file, 0);
232 printk(KERN_ERR "NFSD: failed to write recovery record"
233 " (err %d); please check that %s exists"
234 " and is writeable", status,
235 user_recovery_dirname);
237 mnt_drop_write_file(rec_file);
238 nfs4_reset_creds(original_cred);
241 typedef int (recdir_func)(struct dentry *, struct dentry *, struct nfsd_net *);
244 char name[HEXDIR_LEN];
245 struct list_head list;
249 nfsd4_build_namelist(void *arg, const char *name, int namlen,
250 loff_t offset, u64 ino, unsigned int d_type)
252 struct list_head *names = arg;
253 struct name_list *entry;
255 if (namlen != HEXDIR_LEN - 1)
257 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
260 memcpy(entry->name, name, HEXDIR_LEN - 1);
261 entry->name[HEXDIR_LEN - 1] = '\0';
262 list_add(&entry->list, names);
267 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
269 const struct cred *original_cred;
270 struct dentry *dir = rec_file->f_path.dentry;
274 status = nfs4_save_creds(&original_cred);
278 status = vfs_llseek(rec_file, 0, SEEK_SET);
280 nfs4_reset_creds(original_cred);
284 status = vfs_readdir(rec_file, nfsd4_build_namelist, &names);
285 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
286 while (!list_empty(&names)) {
287 struct name_list *entry;
288 entry = list_entry(names.next, struct name_list, list);
290 struct dentry *dentry;
291 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
292 if (IS_ERR(dentry)) {
293 status = PTR_ERR(dentry);
296 status = f(dir, dentry, nn);
299 list_del(&entry->list);
302 mutex_unlock(&dir->d_inode->i_mutex);
303 nfs4_reset_creds(original_cred);
308 nfsd4_unlink_clid_dir(char *name, int namlen)
310 struct dentry *dir, *dentry;
313 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
315 dir = rec_file->f_path.dentry;
316 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
317 dentry = lookup_one_len(name, dir, namlen);
318 if (IS_ERR(dentry)) {
319 status = PTR_ERR(dentry);
323 if (!dentry->d_inode)
325 status = vfs_rmdir(dir->d_inode, dentry);
329 mutex_unlock(&dir->d_inode->i_mutex);
334 nfsd4_remove_clid_dir(struct nfs4_client *clp)
336 const struct cred *original_cred;
337 struct nfs4_client_reclaim *crp;
338 char dname[HEXDIR_LEN];
340 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
342 if (!rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
345 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
347 return legacy_recdir_name_error(status);
349 status = mnt_want_write_file(rec_file);
352 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
354 status = nfs4_save_creds(&original_cred);
358 status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1);
359 nfs4_reset_creds(original_cred);
361 vfs_fsync(rec_file, 0);
363 /* remove reclaim record */
364 crp = nfsd4_find_reclaim_client(dname, nn);
366 nfs4_remove_reclaim_record(crp, nn);
370 mnt_drop_write_file(rec_file);
373 printk("NFSD: Failed to remove expired client state directory"
374 " %.*s\n", HEXDIR_LEN, dname);
378 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
382 if (nfs4_has_reclaimed_state(child->d_name.name, nn))
385 status = vfs_rmdir(parent->d_inode, child);
387 printk("failed to remove client recovery directory %s\n",
389 /* Keep trying, success or failure: */
394 nfsd4_recdir_purge_old(struct nfsd_net *nn, time_t boot_time)
401 status = mnt_want_write_file(rec_file);
404 status = nfsd4_list_rec_dir(purge_old, nn);
406 vfs_fsync(rec_file, 0);
407 mnt_drop_write_file(rec_file);
409 nfs4_release_reclaim(nn);
411 printk("nfsd4: failed to purge old clients from recovery"
412 " directory %s\n", rec_file->f_path.dentry->d_name.name);
416 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
418 if (child->d_name.len != HEXDIR_LEN - 1) {
419 printk("nfsd4: illegal name %s in recovery directory\n",
421 /* Keep trying; maybe the others are OK: */
424 nfs4_client_to_reclaim(child->d_name.name, nn);
429 nfsd4_recdir_load(struct net *net) {
431 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
436 status = nfsd4_list_rec_dir(load_recdir, nn);
438 printk("nfsd4: failed loading clients from recovery"
439 " directory %s\n", rec_file->f_path.dentry->d_name.name);
444 * Hold reference to the recovery directory.
448 nfsd4_init_recdir(void)
450 const struct cred *original_cred;
453 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
454 user_recovery_dirname);
458 status = nfs4_save_creds(&original_cred);
460 printk("NFSD: Unable to change credentials to find recovery"
461 " directory: error %d\n",
466 rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
467 if (IS_ERR(rec_file)) {
468 printk("NFSD: unable to find recovery directory %s\n",
469 user_recovery_dirname);
470 status = PTR_ERR(rec_file);
474 nfs4_reset_creds(original_cred);
482 nfs4_legacy_state_init(struct net *net)
484 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
487 nn->reclaim_str_hashtbl = kmalloc(sizeof(struct list_head) *
488 CLIENT_HASH_SIZE, GFP_KERNEL);
489 if (!nn->reclaim_str_hashtbl)
492 for (i = 0; i < CLIENT_HASH_SIZE; i++)
493 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
494 nn->reclaim_str_hashtbl_size = 0;
500 nfs4_legacy_state_shutdown(struct net *net)
502 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
504 kfree(nn->reclaim_str_hashtbl);
508 nfsd4_load_reboot_recovery_data(struct net *net)
513 status = nfsd4_init_recdir();
515 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(void)
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();
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(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 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)
1269 /* just run the init if it the method is already decided */
1270 if (client_tracking_ops)
1274 * First, try a UMH upcall. It should succeed or fail quickly, so
1275 * there's little harm in trying that first.
1277 client_tracking_ops = &nfsd4_umh_tracking_ops;
1278 status = client_tracking_ops->init(net);
1283 * See if the recoverydir exists and is a directory. If it is,
1284 * then use the legacy ops.
1286 client_tracking_ops = &nfsd4_legacy_tracking_ops;
1287 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1289 status = S_ISDIR(path.dentry->d_inode->i_mode);
1295 /* Finally, try to use nfsdcld */
1296 client_tracking_ops = &nfsd4_cld_tracking_ops;
1297 printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1298 "removed in 3.10. Please transition to using "
1301 status = client_tracking_ops->init(net);
1303 printk(KERN_WARNING "NFSD: Unable to initialize client "
1304 "recovery tracking! (%d)\n", status);
1305 client_tracking_ops = NULL;
1311 nfsd4_client_tracking_exit(struct net *net)
1313 if (client_tracking_ops) {
1314 if (client_tracking_ops->exit)
1315 client_tracking_ops->exit(net);
1316 client_tracking_ops = NULL;
1321 nfsd4_client_record_create(struct nfs4_client *clp)
1323 if (client_tracking_ops)
1324 client_tracking_ops->create(clp);
1328 nfsd4_client_record_remove(struct nfs4_client *clp)
1330 if (client_tracking_ops)
1331 client_tracking_ops->remove(clp);
1335 nfsd4_client_record_check(struct nfs4_client *clp)
1337 if (client_tracking_ops)
1338 return client_tracking_ops->check(clp);
1344 nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time)
1346 if (client_tracking_ops)
1347 client_tracking_ops->grace_done(nn, boot_time);
1351 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1353 struct super_block *sb = ptr;
1354 struct net *net = sb->s_fs_info;
1355 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1356 struct cld_net *cn = nn->cld_net;
1357 struct dentry *dentry;
1360 if (!try_module_get(THIS_MODULE))
1364 module_put(THIS_MODULE);
1369 case RPC_PIPEFS_MOUNT:
1370 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1371 if (IS_ERR(dentry)) {
1372 ret = PTR_ERR(dentry);
1375 cn->cn_pipe->dentry = dentry;
1377 case RPC_PIPEFS_UMOUNT:
1378 if (cn->cn_pipe->dentry)
1379 nfsd4_cld_unregister_sb(cn->cn_pipe);
1385 module_put(THIS_MODULE);
1389 static struct notifier_block nfsd4_cld_block = {
1390 .notifier_call = rpc_pipefs_event,
1394 register_cld_notifier(void)
1396 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1400 unregister_cld_notifier(void)
1402 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);