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;
243 struct nfs4_dir_ctx {
244 struct dir_context ctx;
245 struct list_head names;
249 nfsd4_build_namelist(void *arg, const char *name, int namlen,
250 loff_t offset, u64 ino, unsigned int d_type)
252 struct nfs4_dir_ctx *ctx = 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, &ctx->names);
267 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
269 const struct cred *original_cred;
270 struct dentry *dir = nn->rec_file->f_path.dentry;
271 struct nfs4_dir_ctx ctx = {
272 .ctx.actor = nfsd4_build_namelist,
273 .names = LIST_HEAD_INIT(ctx.names)
277 status = nfs4_save_creds(&original_cred);
281 status = vfs_llseek(nn->rec_file, 0, SEEK_SET);
283 nfs4_reset_creds(original_cred);
287 status = iterate_dir(nn->rec_file, &ctx.ctx);
288 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
289 while (!list_empty(&ctx.names)) {
290 struct name_list *entry;
291 entry = list_entry(ctx.names.next, struct name_list, list);
293 struct dentry *dentry;
294 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
295 if (IS_ERR(dentry)) {
296 status = PTR_ERR(dentry);
299 status = f(dir, dentry, nn);
302 list_del(&entry->list);
305 mutex_unlock(&dir->d_inode->i_mutex);
306 nfs4_reset_creds(original_cred);
311 nfsd4_unlink_clid_dir(char *name, int namlen, struct nfsd_net *nn)
313 struct dentry *dir, *dentry;
316 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
318 dir = nn->rec_file->f_path.dentry;
319 mutex_lock_nested(&dir->d_inode->i_mutex, I_MUTEX_PARENT);
320 dentry = lookup_one_len(name, dir, namlen);
321 if (IS_ERR(dentry)) {
322 status = PTR_ERR(dentry);
326 if (!dentry->d_inode)
328 status = vfs_rmdir(dir->d_inode, dentry);
332 mutex_unlock(&dir->d_inode->i_mutex);
337 nfsd4_remove_clid_dir(struct nfs4_client *clp)
339 const struct cred *original_cred;
340 struct nfs4_client_reclaim *crp;
341 char dname[HEXDIR_LEN];
343 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
345 if (!nn->rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
348 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
350 return legacy_recdir_name_error(clp, status);
352 status = mnt_want_write_file(nn->rec_file);
355 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
357 status = nfs4_save_creds(&original_cred);
361 status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1, nn);
362 nfs4_reset_creds(original_cred);
364 vfs_fsync(nn->rec_file, 0);
366 /* remove reclaim record */
367 crp = nfsd4_find_reclaim_client(dname, nn);
369 nfs4_remove_reclaim_record(crp, nn);
373 mnt_drop_write_file(nn->rec_file);
376 printk("NFSD: Failed to remove expired client state directory"
377 " %.*s\n", HEXDIR_LEN, dname);
381 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
385 if (nfs4_has_reclaimed_state(child->d_name.name, nn))
388 status = vfs_rmdir(parent->d_inode, child);
390 printk("failed to remove client recovery directory %s\n",
392 /* Keep trying, success or failure: */
397 nfsd4_recdir_purge_old(struct nfsd_net *nn, time_t boot_time)
401 nn->in_grace = false;
404 status = mnt_want_write_file(nn->rec_file);
407 status = nfsd4_list_rec_dir(purge_old, nn);
409 vfs_fsync(nn->rec_file, 0);
410 mnt_drop_write_file(nn->rec_file);
412 nfs4_release_reclaim(nn);
414 printk("nfsd4: failed to purge old clients from recovery"
415 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
419 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
421 if (child->d_name.len != HEXDIR_LEN - 1) {
422 printk("nfsd4: illegal name %s in recovery directory\n",
424 /* Keep trying; maybe the others are OK: */
427 nfs4_client_to_reclaim(child->d_name.name, nn);
432 nfsd4_recdir_load(struct net *net) {
434 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
439 status = nfsd4_list_rec_dir(load_recdir, nn);
441 printk("nfsd4: failed loading clients from recovery"
442 " directory %s\n", nn->rec_file->f_path.dentry->d_name.name);
447 * Hold reference to the recovery directory.
451 nfsd4_init_recdir(struct net *net)
453 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
454 const struct cred *original_cred;
457 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
458 user_recovery_dirname);
460 BUG_ON(nn->rec_file);
462 status = nfs4_save_creds(&original_cred);
464 printk("NFSD: Unable to change credentials to find recovery"
465 " directory: error %d\n",
470 nn->rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
471 if (IS_ERR(nn->rec_file)) {
472 printk("NFSD: unable to find recovery directory %s\n",
473 user_recovery_dirname);
474 status = PTR_ERR(nn->rec_file);
478 nfs4_reset_creds(original_cred);
486 nfs4_legacy_state_init(struct net *net)
488 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
491 nn->reclaim_str_hashtbl = kmalloc(sizeof(struct list_head) *
492 CLIENT_HASH_SIZE, GFP_KERNEL);
493 if (!nn->reclaim_str_hashtbl)
496 for (i = 0; i < CLIENT_HASH_SIZE; i++)
497 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
498 nn->reclaim_str_hashtbl_size = 0;
504 nfs4_legacy_state_shutdown(struct net *net)
506 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
508 kfree(nn->reclaim_str_hashtbl);
512 nfsd4_load_reboot_recovery_data(struct net *net)
516 status = nfsd4_init_recdir(net);
518 status = nfsd4_recdir_load(net);
520 printk(KERN_ERR "NFSD: Failure reading reboot recovery data\n");
525 nfsd4_legacy_tracking_init(struct net *net)
529 /* XXX: The legacy code won't work in a container */
530 if (net != &init_net) {
531 WARN(1, KERN_ERR "NFSD: attempt to initialize legacy client "
532 "tracking in a container!\n");
536 status = nfs4_legacy_state_init(net);
540 status = nfsd4_load_reboot_recovery_data(net);
546 nfs4_legacy_state_shutdown(net);
551 nfsd4_shutdown_recdir(struct nfsd_net *nn)
560 nfsd4_legacy_tracking_exit(struct net *net)
562 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
564 nfs4_release_reclaim(nn);
565 nfsd4_shutdown_recdir(nn);
566 nfs4_legacy_state_shutdown(net);
570 * Change the NFSv4 recovery directory to recdir.
573 nfs4_reset_recoverydir(char *recdir)
578 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
582 if (S_ISDIR(path.dentry->d_inode->i_mode)) {
583 strcpy(user_recovery_dirname, recdir);
591 nfs4_recoverydir(void)
593 return user_recovery_dirname;
597 nfsd4_check_legacy_client(struct nfs4_client *clp)
600 char dname[HEXDIR_LEN];
601 struct nfs4_client_reclaim *crp;
602 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
604 /* did we already find that this client is stable? */
605 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
608 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
610 legacy_recdir_name_error(clp, status);
614 /* look for it in the reclaim hashtable otherwise */
615 crp = nfsd4_find_reclaim_client(dname, nn);
617 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
625 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
626 .init = nfsd4_legacy_tracking_init,
627 .exit = nfsd4_legacy_tracking_exit,
628 .create = nfsd4_create_clid_dir,
629 .remove = nfsd4_remove_clid_dir,
630 .check = nfsd4_check_legacy_client,
631 .grace_done = nfsd4_recdir_purge_old,
635 #define NFSD_PIPE_DIR "nfsd"
636 #define NFSD_CLD_PIPE "cld"
638 /* per-net-ns structure for holding cld upcall info */
640 struct rpc_pipe *cn_pipe;
642 struct list_head cn_list;
647 struct list_head cu_list;
648 struct cld_net *cu_net;
649 struct task_struct *cu_task;
650 struct cld_msg cu_msg;
654 __cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
657 struct rpc_pipe_msg msg;
659 memset(&msg, 0, sizeof(msg));
661 msg.len = sizeof(*cmsg);
664 * Set task state before we queue the upcall. That prevents
665 * wake_up_process in the downcall from racing with schedule.
667 set_current_state(TASK_UNINTERRUPTIBLE);
668 ret = rpc_queue_upcall(pipe, &msg);
670 set_current_state(TASK_RUNNING);
675 set_current_state(TASK_RUNNING);
684 cld_pipe_upcall(struct rpc_pipe *pipe, struct cld_msg *cmsg)
689 * -EAGAIN occurs when pipe is closed and reopened while there are
693 ret = __cld_pipe_upcall(pipe, cmsg);
694 } while (ret == -EAGAIN);
700 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
702 struct cld_upcall *tmp, *cup;
703 struct cld_msg __user *cmsg = (struct cld_msg __user *)src;
705 struct nfsd_net *nn = net_generic(filp->f_dentry->d_sb->s_fs_info,
707 struct cld_net *cn = nn->cld_net;
709 if (mlen != sizeof(*cmsg)) {
710 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
715 /* copy just the xid so we can try to find that */
716 if (copy_from_user(&xid, &cmsg->cm_xid, sizeof(xid)) != 0) {
717 dprintk("%s: error when copying xid from userspace", __func__);
721 /* walk the list and find corresponding xid */
723 spin_lock(&cn->cn_lock);
724 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
725 if (get_unaligned(&tmp->cu_msg.cm_xid) == xid) {
727 list_del_init(&cup->cu_list);
731 spin_unlock(&cn->cn_lock);
733 /* couldn't find upcall? */
735 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
739 if (copy_from_user(&cup->cu_msg, src, mlen) != 0)
742 wake_up_process(cup->cu_task);
747 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
749 struct cld_msg *cmsg = msg->data;
750 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
753 /* errno >= 0 means we got a downcall */
757 wake_up_process(cup->cu_task);
760 static const struct rpc_pipe_ops cld_upcall_ops = {
761 .upcall = rpc_pipe_generic_upcall,
762 .downcall = cld_pipe_downcall,
763 .destroy_msg = cld_pipe_destroy_msg,
766 static struct dentry *
767 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
769 struct dentry *dir, *dentry;
771 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
773 return ERR_PTR(-ENOENT);
774 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
780 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
783 rpc_unlink(pipe->dentry);
786 static struct dentry *
787 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
789 struct super_block *sb;
790 struct dentry *dentry;
792 sb = rpc_get_sb_net(net);
795 dentry = nfsd4_cld_register_sb(sb, pipe);
801 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
803 struct super_block *sb;
805 sb = rpc_get_sb_net(net);
807 nfsd4_cld_unregister_sb(pipe);
812 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
814 nfsd4_init_cld_pipe(struct net *net)
817 struct dentry *dentry;
818 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
824 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
830 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
831 if (IS_ERR(cn->cn_pipe)) {
832 ret = PTR_ERR(cn->cn_pipe);
835 spin_lock_init(&cn->cn_lock);
836 INIT_LIST_HEAD(&cn->cn_list);
838 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
839 if (IS_ERR(dentry)) {
840 ret = PTR_ERR(dentry);
841 goto err_destroy_data;
844 cn->cn_pipe->dentry = dentry;
849 rpc_destroy_pipe_data(cn->cn_pipe);
852 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
858 nfsd4_remove_cld_pipe(struct net *net)
860 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
861 struct cld_net *cn = nn->cld_net;
863 nfsd4_cld_unregister_net(net, cn->cn_pipe);
864 rpc_destroy_pipe_data(cn->cn_pipe);
869 static struct cld_upcall *
870 alloc_cld_upcall(struct cld_net *cn)
872 struct cld_upcall *new, *tmp;
874 new = kzalloc(sizeof(*new), GFP_KERNEL);
878 /* FIXME: hard cap on number in flight? */
880 spin_lock(&cn->cn_lock);
881 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
882 if (tmp->cu_msg.cm_xid == cn->cn_xid) {
884 spin_unlock(&cn->cn_lock);
888 new->cu_task = current;
889 new->cu_msg.cm_vers = CLD_UPCALL_VERSION;
890 put_unaligned(cn->cn_xid++, &new->cu_msg.cm_xid);
892 list_add(&new->cu_list, &cn->cn_list);
893 spin_unlock(&cn->cn_lock);
895 dprintk("%s: allocated xid %u\n", __func__, new->cu_msg.cm_xid);
901 free_cld_upcall(struct cld_upcall *victim)
903 struct cld_net *cn = victim->cu_net;
905 spin_lock(&cn->cn_lock);
906 list_del(&victim->cu_list);
907 spin_unlock(&cn->cn_lock);
911 /* Ask daemon to create a new record */
913 nfsd4_cld_create(struct nfs4_client *clp)
916 struct cld_upcall *cup;
917 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
918 struct cld_net *cn = nn->cld_net;
920 /* Don't upcall if it's already stored */
921 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
924 cup = alloc_cld_upcall(cn);
930 cup->cu_msg.cm_cmd = Cld_Create;
931 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
932 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
935 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
937 ret = cup->cu_msg.cm_status;
938 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
941 free_cld_upcall(cup);
944 printk(KERN_ERR "NFSD: Unable to create client "
945 "record on stable storage: %d\n", ret);
948 /* Ask daemon to create a new record */
950 nfsd4_cld_remove(struct nfs4_client *clp)
953 struct cld_upcall *cup;
954 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
955 struct cld_net *cn = nn->cld_net;
957 /* Don't upcall if it's already removed */
958 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
961 cup = alloc_cld_upcall(cn);
967 cup->cu_msg.cm_cmd = Cld_Remove;
968 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
969 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
972 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
974 ret = cup->cu_msg.cm_status;
975 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
978 free_cld_upcall(cup);
981 printk(KERN_ERR "NFSD: Unable to remove client "
982 "record from stable storage: %d\n", ret);
985 /* Check for presence of a record, and update its timestamp */
987 nfsd4_cld_check(struct nfs4_client *clp)
990 struct cld_upcall *cup;
991 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
992 struct cld_net *cn = nn->cld_net;
994 /* Don't upcall if one was already stored during this grace pd */
995 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
998 cup = alloc_cld_upcall(cn);
1000 printk(KERN_ERR "NFSD: Unable to check client record on "
1001 "stable storage: %d\n", -ENOMEM);
1005 cup->cu_msg.cm_cmd = Cld_Check;
1006 cup->cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1007 memcpy(cup->cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1010 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1012 ret = cup->cu_msg.cm_status;
1013 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1016 free_cld_upcall(cup);
1021 nfsd4_cld_grace_done(struct nfsd_net *nn, time_t boot_time)
1024 struct cld_upcall *cup;
1025 struct cld_net *cn = nn->cld_net;
1027 cup = alloc_cld_upcall(cn);
1033 cup->cu_msg.cm_cmd = Cld_GraceDone;
1034 cup->cu_msg.cm_u.cm_gracetime = (int64_t)boot_time;
1035 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_msg);
1037 ret = cup->cu_msg.cm_status;
1039 free_cld_upcall(cup);
1042 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1045 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
1046 .init = nfsd4_init_cld_pipe,
1047 .exit = nfsd4_remove_cld_pipe,
1048 .create = nfsd4_cld_create,
1049 .remove = nfsd4_cld_remove,
1050 .check = nfsd4_cld_check,
1051 .grace_done = nfsd4_cld_grace_done,
1054 /* upcall via usermodehelper */
1055 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
1056 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
1058 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
1060 static bool cltrack_legacy_disable;
1061 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
1062 MODULE_PARM_DESC(cltrack_legacy_disable,
1063 "Disable legacy recoverydir conversion. Default: false");
1065 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1066 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1069 nfsd4_cltrack_legacy_topdir(void)
1075 if (cltrack_legacy_disable)
1078 len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
1079 strlen(nfs4_recoverydir()) + 1;
1081 result = kmalloc(len, GFP_KERNEL);
1085 copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
1086 nfs4_recoverydir());
1087 if (copied >= len) {
1088 /* just return nothing if output was truncated */
1097 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj *name)
1103 if (cltrack_legacy_disable)
1106 /* +1 is for '/' between "topdir" and "recdir" */
1107 len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1108 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1110 result = kmalloc(len, GFP_KERNEL);
1114 copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/",
1115 nfs4_recoverydir());
1116 if (copied > (len - HEXDIR_LEN)) {
1117 /* just return nothing if output will be truncated */
1122 copied = nfs4_make_rec_clidname(result + copied, name);
1132 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *legacy)
1138 if (unlikely(!cltrack_prog[0])) {
1139 dprintk("%s: cltrack_prog is disabled\n", __func__);
1143 dprintk("%s: cmd: %s\n", __func__, cmd);
1144 dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1145 dprintk("%s: legacy: %s\n", __func__, legacy ? legacy : "(null)");
1150 argv[0] = (char *)cltrack_prog;
1155 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1157 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1158 * error. The admin can re-enable it on the fly by using sysfs
1159 * once the problem has been fixed.
1161 if (ret == -ENOENT || ret == -EACCES) {
1162 dprintk("NFSD: %s was not found or isn't executable (%d). "
1163 "Setting cltrack_prog to blank string!",
1165 cltrack_prog[0] = '\0';
1167 dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1173 bin_to_hex_dup(const unsigned char *src, int srclen)
1178 /* +1 for terminating NULL */
1179 buf = kmalloc((srclen * 2) + 1, GFP_KERNEL);
1184 for (i = 0; i < srclen; i++) {
1185 sprintf(hex, "%2.2x", *src++);
1192 nfsd4_umh_cltrack_init(struct net __attribute__((unused)) *net)
1194 /* XXX: The usermode helper s not working in container yet. */
1195 if (net != &init_net) {
1196 WARN(1, KERN_ERR "NFSD: attempt to initialize umh client "
1197 "tracking in a container!\n");
1200 return nfsd4_umh_cltrack_upcall("init", NULL, NULL);
1204 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1208 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1210 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1213 nfsd4_umh_cltrack_upcall("create", hexid, NULL);
1218 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1222 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1224 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1227 nfsd4_umh_cltrack_upcall("remove", hexid, NULL);
1232 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1235 char *hexid, *legacy;
1237 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1239 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1242 legacy = nfsd4_cltrack_legacy_recdir(&clp->cl_name);
1243 ret = nfsd4_umh_cltrack_upcall("check", hexid, legacy);
1250 nfsd4_umh_cltrack_grace_done(struct nfsd_net __attribute__((unused)) *nn,
1254 char timestr[22]; /* FIXME: better way to determine max size? */
1256 sprintf(timestr, "%ld", boot_time);
1257 legacy = nfsd4_cltrack_legacy_topdir();
1258 nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy);
1262 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
1263 .init = nfsd4_umh_cltrack_init,
1265 .create = nfsd4_umh_cltrack_create,
1266 .remove = nfsd4_umh_cltrack_remove,
1267 .check = nfsd4_umh_cltrack_check,
1268 .grace_done = nfsd4_umh_cltrack_grace_done,
1272 nfsd4_client_tracking_init(struct net *net)
1276 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1278 /* just run the init if it the method is already decided */
1279 if (nn->client_tracking_ops)
1283 * First, try a UMH upcall. It should succeed or fail quickly, so
1284 * there's little harm in trying that first.
1286 nn->client_tracking_ops = &nfsd4_umh_tracking_ops;
1287 status = nn->client_tracking_ops->init(net);
1292 * See if the recoverydir exists and is a directory. If it is,
1293 * then use the legacy ops.
1295 nn->client_tracking_ops = &nfsd4_legacy_tracking_ops;
1296 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
1298 status = S_ISDIR(path.dentry->d_inode->i_mode);
1304 /* Finally, try to use nfsdcld */
1305 nn->client_tracking_ops = &nfsd4_cld_tracking_ops;
1306 printk(KERN_WARNING "NFSD: the nfsdcld client tracking upcall will be "
1307 "removed in 3.10. Please transition to using "
1310 status = nn->client_tracking_ops->init(net);
1312 printk(KERN_WARNING "NFSD: Unable to initialize client "
1313 "recovery tracking! (%d)\n", status);
1314 nn->client_tracking_ops = NULL;
1320 nfsd4_client_tracking_exit(struct net *net)
1322 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1324 if (nn->client_tracking_ops) {
1325 if (nn->client_tracking_ops->exit)
1326 nn->client_tracking_ops->exit(net);
1327 nn->client_tracking_ops = NULL;
1332 nfsd4_client_record_create(struct nfs4_client *clp)
1334 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1336 if (nn->client_tracking_ops)
1337 nn->client_tracking_ops->create(clp);
1341 nfsd4_client_record_remove(struct nfs4_client *clp)
1343 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1345 if (nn->client_tracking_ops)
1346 nn->client_tracking_ops->remove(clp);
1350 nfsd4_client_record_check(struct nfs4_client *clp)
1352 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1354 if (nn->client_tracking_ops)
1355 return nn->client_tracking_ops->check(clp);
1361 nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time)
1363 if (nn->client_tracking_ops)
1364 nn->client_tracking_ops->grace_done(nn, boot_time);
1368 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
1370 struct super_block *sb = ptr;
1371 struct net *net = sb->s_fs_info;
1372 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1373 struct cld_net *cn = nn->cld_net;
1374 struct dentry *dentry;
1377 if (!try_module_get(THIS_MODULE))
1381 module_put(THIS_MODULE);
1386 case RPC_PIPEFS_MOUNT:
1387 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
1388 if (IS_ERR(dentry)) {
1389 ret = PTR_ERR(dentry);
1392 cn->cn_pipe->dentry = dentry;
1394 case RPC_PIPEFS_UMOUNT:
1395 if (cn->cn_pipe->dentry)
1396 nfsd4_cld_unregister_sb(cn->cn_pipe);
1402 module_put(THIS_MODULE);
1406 static struct notifier_block nfsd4_cld_block = {
1407 .notifier_call = rpc_pipefs_event,
1411 register_cld_notifier(void)
1413 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
1417 unregister_cld_notifier(void)
1419 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);