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 <crypto/hash.h>
36 #include <linux/file.h>
37 #include <linux/slab.h>
38 #include <linux/namei.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 *);
66 static const struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops;
67 static const struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops_v2;
70 static char user_recovery_dirname[PATH_MAX] = "/var/lib/nfs/v4recovery";
73 nfs4_save_creds(const struct cred **original_creds)
77 new = prepare_creds();
81 new->fsuid = GLOBAL_ROOT_UID;
82 new->fsgid = GLOBAL_ROOT_GID;
83 *original_creds = override_creds(new);
89 nfs4_reset_creds(const struct cred *original)
91 revert_creds(original);
95 md5_to_hex(char *out, char *md5)
99 for (i=0; i<16; i++) {
100 unsigned char c = md5[i];
102 *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
103 *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
109 nfs4_make_rec_clidname(char *dname, const struct xdr_netobj *clname)
111 struct xdr_netobj cksum;
112 struct crypto_shash *tfm;
115 dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
116 clname->len, clname->data);
117 tfm = crypto_alloc_shash("md5", 0, 0);
119 status = PTR_ERR(tfm);
123 cksum.len = crypto_shash_digestsize(tfm);
124 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
125 if (cksum.data == NULL) {
130 status = crypto_shash_tfm_digest(tfm, clname->data, clname->len,
135 md5_to_hex(dname, cksum.data);
140 crypto_free_shash(tfm);
146 * If we had an error generating the recdir name for the legacy tracker
147 * then warn the admin. If the error doesn't appear to be transient,
148 * then disable recovery tracking.
151 legacy_recdir_name_error(struct nfs4_client *clp, int error)
153 printk(KERN_ERR "NFSD: unable to generate recoverydir "
154 "name (%d).\n", error);
157 * if the algorithm just doesn't exist, then disable the recovery
158 * tracker altogether. The crypto libs will generally return this if
159 * FIPS is enabled as well.
161 if (error == -ENOENT) {
162 printk(KERN_ERR "NFSD: disabling legacy clientid tracking. "
163 "Reboot recovery will not function correctly!\n");
164 nfsd4_client_tracking_exit(clp->net);
169 __nfsd4_create_reclaim_record_grace(struct nfs4_client *clp,
170 const char *dname, int len, struct nfsd_net *nn)
172 struct xdr_netobj name;
173 struct xdr_netobj princhash = { .len = 0, .data = NULL };
174 struct nfs4_client_reclaim *crp;
176 name.data = kmemdup(dname, len, GFP_KERNEL);
178 dprintk("%s: failed to allocate memory for name.data!\n",
183 crp = nfs4_client_to_reclaim(name, princhash, nn);
192 nfsd4_create_clid_dir(struct nfs4_client *clp)
194 const struct cred *original_cred;
195 char dname[HEXDIR_LEN];
196 struct dentry *dir, *dentry;
198 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
200 if (test_and_set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
205 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
207 return legacy_recdir_name_error(clp, status);
209 status = nfs4_save_creds(&original_cred);
213 status = mnt_want_write_file(nn->rec_file);
217 dir = nn->rec_file->f_path.dentry;
218 /* lock the parent */
219 inode_lock(d_inode(dir));
221 dentry = lookup_one_len(dname, dir, HEXDIR_LEN-1);
222 if (IS_ERR(dentry)) {
223 status = PTR_ERR(dentry);
226 if (d_really_is_positive(dentry))
228 * In the 4.1 case, where we're called from
229 * reclaim_complete(), records from the previous reboot
230 * may still be left, so this is OK.
232 * In the 4.0 case, we should never get here; but we may
233 * as well be forgiving and just succeed silently.
236 status = vfs_mkdir(&nop_mnt_idmap, d_inode(dir), dentry, S_IRWXU);
240 inode_unlock(d_inode(dir));
243 __nfsd4_create_reclaim_record_grace(clp, dname,
245 vfs_fsync(nn->rec_file, 0);
247 printk(KERN_ERR "NFSD: failed to write recovery record"
248 " (err %d); please check that %s exists"
249 " and is writeable", status,
250 user_recovery_dirname);
252 mnt_drop_write_file(nn->rec_file);
254 nfs4_reset_creds(original_cred);
257 typedef int (recdir_func)(struct dentry *, struct dentry *, struct nfsd_net *);
260 char name[HEXDIR_LEN];
261 struct list_head list;
264 struct nfs4_dir_ctx {
265 struct dir_context ctx;
266 struct list_head names;
270 nfsd4_build_namelist(struct dir_context *__ctx, const char *name, int namlen,
271 loff_t offset, u64 ino, unsigned int d_type)
273 struct nfs4_dir_ctx *ctx =
274 container_of(__ctx, struct nfs4_dir_ctx, ctx);
275 struct name_list *entry;
277 if (namlen != HEXDIR_LEN - 1)
279 entry = kmalloc(sizeof(struct name_list), GFP_KERNEL);
282 memcpy(entry->name, name, HEXDIR_LEN - 1);
283 entry->name[HEXDIR_LEN - 1] = '\0';
284 list_add(&entry->list, &ctx->names);
289 nfsd4_list_rec_dir(recdir_func *f, struct nfsd_net *nn)
291 const struct cred *original_cred;
292 struct dentry *dir = nn->rec_file->f_path.dentry;
293 struct nfs4_dir_ctx ctx = {
294 .ctx.actor = nfsd4_build_namelist,
295 .names = LIST_HEAD_INIT(ctx.names)
297 struct name_list *entry, *tmp;
300 status = nfs4_save_creds(&original_cred);
304 status = vfs_llseek(nn->rec_file, 0, SEEK_SET);
306 nfs4_reset_creds(original_cred);
310 status = iterate_dir(nn->rec_file, &ctx.ctx);
311 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
313 list_for_each_entry_safe(entry, tmp, &ctx.names, list) {
315 struct dentry *dentry;
316 dentry = lookup_one_len(entry->name, dir, HEXDIR_LEN-1);
317 if (IS_ERR(dentry)) {
318 status = PTR_ERR(dentry);
321 status = f(dir, dentry, nn);
324 list_del(&entry->list);
327 inode_unlock(d_inode(dir));
328 nfs4_reset_creds(original_cred);
330 list_for_each_entry_safe(entry, tmp, &ctx.names, list) {
331 dprintk("NFSD: %s. Left entry %s\n", __func__, entry->name);
332 list_del(&entry->list);
339 nfsd4_unlink_clid_dir(char *name, int namlen, struct nfsd_net *nn)
341 struct dentry *dir, *dentry;
344 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
346 dir = nn->rec_file->f_path.dentry;
347 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
348 dentry = lookup_one_len(name, dir, namlen);
349 if (IS_ERR(dentry)) {
350 status = PTR_ERR(dentry);
354 if (d_really_is_negative(dentry))
356 status = vfs_rmdir(&nop_mnt_idmap, d_inode(dir), dentry);
360 inode_unlock(d_inode(dir));
365 __nfsd4_remove_reclaim_record_grace(const char *dname, int len,
368 struct xdr_netobj name;
369 struct nfs4_client_reclaim *crp;
371 name.data = kmemdup(dname, len, GFP_KERNEL);
373 dprintk("%s: failed to allocate memory for name.data!\n",
378 crp = nfsd4_find_reclaim_client(name, nn);
381 nfs4_remove_reclaim_record(crp, nn);
385 nfsd4_remove_clid_dir(struct nfs4_client *clp)
387 const struct cred *original_cred;
388 char dname[HEXDIR_LEN];
390 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
392 if (!nn->rec_file || !test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
395 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
397 return legacy_recdir_name_error(clp, status);
399 status = mnt_want_write_file(nn->rec_file);
402 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
404 status = nfs4_save_creds(&original_cred);
408 status = nfsd4_unlink_clid_dir(dname, HEXDIR_LEN-1, nn);
409 nfs4_reset_creds(original_cred);
411 vfs_fsync(nn->rec_file, 0);
413 __nfsd4_remove_reclaim_record_grace(dname,
417 mnt_drop_write_file(nn->rec_file);
420 printk("NFSD: Failed to remove expired client state directory"
421 " %.*s\n", HEXDIR_LEN, dname);
425 purge_old(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
428 struct xdr_netobj name;
430 if (child->d_name.len != HEXDIR_LEN - 1) {
431 printk("%s: illegal name %pd in recovery directory\n",
433 /* Keep trying; maybe the others are OK: */
436 name.data = kmemdup_nul(child->d_name.name, child->d_name.len, GFP_KERNEL);
438 dprintk("%s: failed to allocate memory for name.data!\n",
442 name.len = HEXDIR_LEN;
443 if (nfs4_has_reclaimed_state(name, nn))
446 status = vfs_rmdir(&nop_mnt_idmap, d_inode(parent), child);
448 printk("failed to remove client recovery directory %pd\n",
453 /* Keep trying, success or failure: */
458 nfsd4_recdir_purge_old(struct nfsd_net *nn)
462 nn->in_grace = false;
465 status = mnt_want_write_file(nn->rec_file);
468 status = nfsd4_list_rec_dir(purge_old, nn);
470 vfs_fsync(nn->rec_file, 0);
471 mnt_drop_write_file(nn->rec_file);
473 nfs4_release_reclaim(nn);
475 printk("nfsd4: failed to purge old clients from recovery"
476 " directory %pD\n", nn->rec_file);
480 load_recdir(struct dentry *parent, struct dentry *child, struct nfsd_net *nn)
482 struct xdr_netobj name;
483 struct xdr_netobj princhash = { .len = 0, .data = NULL };
485 if (child->d_name.len != HEXDIR_LEN - 1) {
486 printk("%s: illegal name %pd in recovery directory\n",
488 /* Keep trying; maybe the others are OK: */
491 name.data = kmemdup_nul(child->d_name.name, child->d_name.len, GFP_KERNEL);
493 dprintk("%s: failed to allocate memory for name.data!\n",
497 name.len = HEXDIR_LEN;
498 if (!nfs4_client_to_reclaim(name, princhash, nn))
505 nfsd4_recdir_load(struct net *net) {
507 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
512 status = nfsd4_list_rec_dir(load_recdir, nn);
514 printk("nfsd4: failed loading clients from recovery"
515 " directory %pD\n", nn->rec_file);
520 * Hold reference to the recovery directory.
524 nfsd4_init_recdir(struct net *net)
526 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
527 const struct cred *original_cred;
530 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
531 user_recovery_dirname);
533 BUG_ON(nn->rec_file);
535 status = nfs4_save_creds(&original_cred);
537 printk("NFSD: Unable to change credentials to find recovery"
538 " directory: error %d\n",
543 nn->rec_file = filp_open(user_recovery_dirname, O_RDONLY | O_DIRECTORY, 0);
544 if (IS_ERR(nn->rec_file)) {
545 printk("NFSD: unable to find recovery directory %s\n",
546 user_recovery_dirname);
547 status = PTR_ERR(nn->rec_file);
551 nfs4_reset_creds(original_cred);
558 nfsd4_shutdown_recdir(struct net *net)
560 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
569 nfs4_legacy_state_init(struct net *net)
571 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
574 nn->reclaim_str_hashtbl = kmalloc_array(CLIENT_HASH_SIZE,
575 sizeof(struct list_head),
577 if (!nn->reclaim_str_hashtbl)
580 for (i = 0; i < CLIENT_HASH_SIZE; i++)
581 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
582 nn->reclaim_str_hashtbl_size = 0;
588 nfs4_legacy_state_shutdown(struct net *net)
590 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
592 kfree(nn->reclaim_str_hashtbl);
596 nfsd4_load_reboot_recovery_data(struct net *net)
600 status = nfsd4_init_recdir(net);
604 status = nfsd4_recdir_load(net);
606 nfsd4_shutdown_recdir(net);
612 nfsd4_legacy_tracking_init(struct net *net)
616 /* XXX: The legacy code won't work in a container */
617 if (net != &init_net) {
618 pr_warn("NFSD: attempt to initialize legacy client tracking in a container ignored.\n");
622 status = nfs4_legacy_state_init(net);
626 status = nfsd4_load_reboot_recovery_data(net);
629 pr_info("NFSD: Using legacy client tracking operations.\n");
633 nfs4_legacy_state_shutdown(net);
638 nfsd4_legacy_tracking_exit(struct net *net)
640 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
642 nfs4_release_reclaim(nn);
643 nfsd4_shutdown_recdir(net);
644 nfs4_legacy_state_shutdown(net);
648 * Change the NFSv4 recovery directory to recdir.
651 nfs4_reset_recoverydir(char *recdir)
656 status = kern_path(recdir, LOOKUP_FOLLOW, &path);
660 if (d_is_dir(path.dentry)) {
661 strcpy(user_recovery_dirname, recdir);
669 nfs4_recoverydir(void)
671 return user_recovery_dirname;
675 nfsd4_check_legacy_client(struct nfs4_client *clp)
678 char dname[HEXDIR_LEN];
679 struct nfs4_client_reclaim *crp;
680 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
681 struct xdr_netobj name;
683 /* did we already find that this client is stable? */
684 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
687 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
689 legacy_recdir_name_error(clp, status);
693 /* look for it in the reclaim hashtable otherwise */
694 name.data = kmemdup(dname, HEXDIR_LEN, GFP_KERNEL);
696 dprintk("%s: failed to allocate memory for name.data!\n",
700 name.len = HEXDIR_LEN;
701 crp = nfsd4_find_reclaim_client(name, nn);
704 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
713 static const struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops = {
714 .init = nfsd4_legacy_tracking_init,
715 .exit = nfsd4_legacy_tracking_exit,
716 .create = nfsd4_create_clid_dir,
717 .remove = nfsd4_remove_clid_dir,
718 .check = nfsd4_check_legacy_client,
719 .grace_done = nfsd4_recdir_purge_old,
725 #define NFSD_PIPE_DIR "nfsd"
726 #define NFSD_CLD_PIPE "cld"
728 /* per-net-ns structure for holding cld upcall info */
730 struct rpc_pipe *cn_pipe;
732 struct list_head cn_list;
735 struct crypto_shash *cn_tfm;
739 struct list_head cu_list;
740 struct cld_net *cu_net;
741 struct completion cu_done;
743 struct cld_msg_hdr cu_hdr;
744 struct cld_msg cu_msg;
745 struct cld_msg_v2 cu_msg_v2;
750 __cld_pipe_upcall(struct rpc_pipe *pipe, void *cmsg, struct nfsd_net *nn)
753 struct rpc_pipe_msg msg;
754 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall, cu_u);
756 memset(&msg, 0, sizeof(msg));
758 msg.len = nn->client_tracking_ops->msglen;
760 ret = rpc_queue_upcall(pipe, &msg);
765 wait_for_completion(&cup->cu_done);
774 cld_pipe_upcall(struct rpc_pipe *pipe, void *cmsg, struct nfsd_net *nn)
779 * -EAGAIN occurs when pipe is closed and reopened while there are
783 ret = __cld_pipe_upcall(pipe, cmsg, nn);
784 } while (ret == -EAGAIN);
790 __cld_pipe_inprogress_downcall(const struct cld_msg_v2 __user *cmsg,
793 uint8_t cmd, princhashlen;
794 struct xdr_netobj name, princhash = { .len = 0, .data = NULL };
796 struct cld_net *cn = nn->cld_net;
798 if (get_user(cmd, &cmsg->cm_cmd)) {
799 dprintk("%s: error when copying cmd from userspace", __func__);
802 if (cmd == Cld_GraceStart) {
803 if (nn->client_tracking_ops->version >= 2) {
804 const struct cld_clntinfo __user *ci;
806 ci = &cmsg->cm_u.cm_clntinfo;
807 if (get_user(namelen, &ci->cc_name.cn_len))
809 name.data = memdup_user(&ci->cc_name.cn_id, namelen);
810 if (IS_ERR(name.data))
811 return PTR_ERR(name.data);
813 get_user(princhashlen, &ci->cc_princhash.cp_len);
814 if (princhashlen > 0) {
815 princhash.data = memdup_user(
816 &ci->cc_princhash.cp_data,
818 if (IS_ERR(princhash.data)) {
820 return PTR_ERR(princhash.data);
822 princhash.len = princhashlen;
826 const struct cld_name __user *cnm;
828 cnm = &cmsg->cm_u.cm_name;
829 if (get_user(namelen, &cnm->cn_len))
831 name.data = memdup_user(&cnm->cn_id, namelen);
832 if (IS_ERR(name.data))
833 return PTR_ERR(name.data);
836 if (name.len > 5 && memcmp(name.data, "hash:", 5) == 0) {
837 name.len = name.len - 5;
838 memmove(name.data, name.data + 5, name.len);
839 cn->cn_has_legacy = true;
841 if (!nfs4_client_to_reclaim(name, princhash, nn)) {
843 kfree(princhash.data);
846 return nn->client_tracking_ops->msglen;
852 cld_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
854 struct cld_upcall *tmp, *cup;
855 struct cld_msg_hdr __user *hdr = (struct cld_msg_hdr __user *)src;
856 struct cld_msg_v2 __user *cmsg = (struct cld_msg_v2 __user *)src;
858 struct nfsd_net *nn = net_generic(file_inode(filp)->i_sb->s_fs_info,
860 struct cld_net *cn = nn->cld_net;
863 if (mlen != nn->client_tracking_ops->msglen) {
864 dprintk("%s: got %zu bytes, expected %zu\n", __func__, mlen,
865 nn->client_tracking_ops->msglen);
869 /* copy just the xid so we can try to find that */
870 if (copy_from_user(&xid, &hdr->cm_xid, sizeof(xid)) != 0) {
871 dprintk("%s: error when copying xid from userspace", __func__);
876 * copy the status so we know whether to remove the upcall from the
877 * list (for -EINPROGRESS, we just want to make sure the xid is
878 * valid, not remove the upcall from the list)
880 if (get_user(status, &hdr->cm_status)) {
881 dprintk("%s: error when copying status from userspace", __func__);
885 /* walk the list and find corresponding xid */
887 spin_lock(&cn->cn_lock);
888 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
889 if (get_unaligned(&tmp->cu_u.cu_hdr.cm_xid) == xid) {
891 if (status != -EINPROGRESS)
892 list_del_init(&cup->cu_list);
896 spin_unlock(&cn->cn_lock);
898 /* couldn't find upcall? */
900 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__, xid);
904 if (status == -EINPROGRESS)
905 return __cld_pipe_inprogress_downcall(cmsg, nn);
907 if (copy_from_user(&cup->cu_u.cu_msg_v2, src, mlen) != 0)
910 complete(&cup->cu_done);
915 cld_pipe_destroy_msg(struct rpc_pipe_msg *msg)
917 struct cld_msg *cmsg = msg->data;
918 struct cld_upcall *cup = container_of(cmsg, struct cld_upcall,
921 /* errno >= 0 means we got a downcall */
925 complete(&cup->cu_done);
928 static const struct rpc_pipe_ops cld_upcall_ops = {
929 .upcall = rpc_pipe_generic_upcall,
930 .downcall = cld_pipe_downcall,
931 .destroy_msg = cld_pipe_destroy_msg,
934 static struct dentry *
935 nfsd4_cld_register_sb(struct super_block *sb, struct rpc_pipe *pipe)
937 struct dentry *dir, *dentry;
939 dir = rpc_d_lookup_sb(sb, NFSD_PIPE_DIR);
941 return ERR_PTR(-ENOENT);
942 dentry = rpc_mkpipe_dentry(dir, NFSD_CLD_PIPE, NULL, pipe);
948 nfsd4_cld_unregister_sb(struct rpc_pipe *pipe)
951 rpc_unlink(pipe->dentry);
954 static struct dentry *
955 nfsd4_cld_register_net(struct net *net, struct rpc_pipe *pipe)
957 struct super_block *sb;
958 struct dentry *dentry;
960 sb = rpc_get_sb_net(net);
963 dentry = nfsd4_cld_register_sb(sb, pipe);
969 nfsd4_cld_unregister_net(struct net *net, struct rpc_pipe *pipe)
971 struct super_block *sb;
973 sb = rpc_get_sb_net(net);
975 nfsd4_cld_unregister_sb(pipe);
980 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
982 __nfsd4_init_cld_pipe(struct net *net)
985 struct dentry *dentry;
986 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
992 cn = kzalloc(sizeof(*cn), GFP_KERNEL);
998 cn->cn_pipe = rpc_mkpipe_data(&cld_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
999 if (IS_ERR(cn->cn_pipe)) {
1000 ret = PTR_ERR(cn->cn_pipe);
1003 spin_lock_init(&cn->cn_lock);
1004 INIT_LIST_HEAD(&cn->cn_list);
1006 dentry = nfsd4_cld_register_net(net, cn->cn_pipe);
1007 if (IS_ERR(dentry)) {
1008 ret = PTR_ERR(dentry);
1009 goto err_destroy_data;
1012 cn->cn_pipe->dentry = dentry;
1013 cn->cn_has_legacy = false;
1018 rpc_destroy_pipe_data(cn->cn_pipe);
1021 printk(KERN_ERR "NFSD: unable to create nfsdcld upcall pipe (%d)\n",
1027 nfsd4_init_cld_pipe(struct net *net)
1031 status = __nfsd4_init_cld_pipe(net);
1033 pr_info("NFSD: Using old nfsdcld client tracking operations.\n");
1038 nfsd4_remove_cld_pipe(struct net *net)
1040 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1041 struct cld_net *cn = nn->cld_net;
1043 nfsd4_cld_unregister_net(net, cn->cn_pipe);
1044 rpc_destroy_pipe_data(cn->cn_pipe);
1046 crypto_free_shash(cn->cn_tfm);
1051 static struct cld_upcall *
1052 alloc_cld_upcall(struct nfsd_net *nn)
1054 struct cld_upcall *new, *tmp;
1055 struct cld_net *cn = nn->cld_net;
1057 new = kzalloc(sizeof(*new), GFP_KERNEL);
1061 /* FIXME: hard cap on number in flight? */
1063 spin_lock(&cn->cn_lock);
1064 list_for_each_entry(tmp, &cn->cn_list, cu_list) {
1065 if (tmp->cu_u.cu_msg.cm_xid == cn->cn_xid) {
1067 spin_unlock(&cn->cn_lock);
1068 goto restart_search;
1071 init_completion(&new->cu_done);
1072 new->cu_u.cu_msg.cm_vers = nn->client_tracking_ops->version;
1073 put_unaligned(cn->cn_xid++, &new->cu_u.cu_msg.cm_xid);
1075 list_add(&new->cu_list, &cn->cn_list);
1076 spin_unlock(&cn->cn_lock);
1078 dprintk("%s: allocated xid %u\n", __func__, new->cu_u.cu_msg.cm_xid);
1084 free_cld_upcall(struct cld_upcall *victim)
1086 struct cld_net *cn = victim->cu_net;
1088 spin_lock(&cn->cn_lock);
1089 list_del(&victim->cu_list);
1090 spin_unlock(&cn->cn_lock);
1094 /* Ask daemon to create a new record */
1096 nfsd4_cld_create(struct nfs4_client *clp)
1099 struct cld_upcall *cup;
1100 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1101 struct cld_net *cn = nn->cld_net;
1103 /* Don't upcall if it's already stored */
1104 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1107 cup = alloc_cld_upcall(nn);
1113 cup->cu_u.cu_msg.cm_cmd = Cld_Create;
1114 cup->cu_u.cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1115 memcpy(cup->cu_u.cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1118 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1120 ret = cup->cu_u.cu_msg.cm_status;
1121 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1124 free_cld_upcall(cup);
1127 printk(KERN_ERR "NFSD: Unable to create client "
1128 "record on stable storage: %d\n", ret);
1131 /* Ask daemon to create a new record */
1133 nfsd4_cld_create_v2(struct nfs4_client *clp)
1136 struct cld_upcall *cup;
1137 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1138 struct cld_net *cn = nn->cld_net;
1139 struct cld_msg_v2 *cmsg;
1140 struct crypto_shash *tfm = cn->cn_tfm;
1141 struct xdr_netobj cksum;
1142 char *principal = NULL;
1144 /* Don't upcall if it's already stored */
1145 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1148 cup = alloc_cld_upcall(nn);
1154 cmsg = &cup->cu_u.cu_msg_v2;
1155 cmsg->cm_cmd = Cld_Create;
1156 cmsg->cm_u.cm_clntinfo.cc_name.cn_len = clp->cl_name.len;
1157 memcpy(cmsg->cm_u.cm_clntinfo.cc_name.cn_id, clp->cl_name.data,
1159 if (clp->cl_cred.cr_raw_principal)
1160 principal = clp->cl_cred.cr_raw_principal;
1161 else if (clp->cl_cred.cr_principal)
1162 principal = clp->cl_cred.cr_principal;
1164 cksum.len = crypto_shash_digestsize(tfm);
1165 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
1166 if (cksum.data == NULL) {
1170 ret = crypto_shash_tfm_digest(tfm, principal, strlen(principal),
1176 cmsg->cm_u.cm_clntinfo.cc_princhash.cp_len = cksum.len;
1177 memcpy(cmsg->cm_u.cm_clntinfo.cc_princhash.cp_data,
1178 cksum.data, cksum.len);
1181 cmsg->cm_u.cm_clntinfo.cc_princhash.cp_len = 0;
1183 ret = cld_pipe_upcall(cn->cn_pipe, cmsg, nn);
1185 ret = cmsg->cm_status;
1186 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1190 free_cld_upcall(cup);
1193 pr_err("NFSD: Unable to create client record on stable storage: %d\n",
1197 /* Ask daemon to create a new record */
1199 nfsd4_cld_remove(struct nfs4_client *clp)
1202 struct cld_upcall *cup;
1203 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1204 struct cld_net *cn = nn->cld_net;
1206 /* Don't upcall if it's already removed */
1207 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1210 cup = alloc_cld_upcall(nn);
1216 cup->cu_u.cu_msg.cm_cmd = Cld_Remove;
1217 cup->cu_u.cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1218 memcpy(cup->cu_u.cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1221 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1223 ret = cup->cu_u.cu_msg.cm_status;
1224 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1227 free_cld_upcall(cup);
1230 printk(KERN_ERR "NFSD: Unable to remove client "
1231 "record from stable storage: %d\n", ret);
1235 * For older nfsdcld's that do not allow us to "slurp" the clients
1236 * from the tracking database during startup.
1238 * Check for presence of a record, and update its timestamp
1241 nfsd4_cld_check_v0(struct nfs4_client *clp)
1244 struct cld_upcall *cup;
1245 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1246 struct cld_net *cn = nn->cld_net;
1248 /* Don't upcall if one was already stored during this grace pd */
1249 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1252 cup = alloc_cld_upcall(nn);
1254 printk(KERN_ERR "NFSD: Unable to check client record on "
1255 "stable storage: %d\n", -ENOMEM);
1259 cup->cu_u.cu_msg.cm_cmd = Cld_Check;
1260 cup->cu_u.cu_msg.cm_u.cm_name.cn_len = clp->cl_name.len;
1261 memcpy(cup->cu_u.cu_msg.cm_u.cm_name.cn_id, clp->cl_name.data,
1264 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1266 ret = cup->cu_u.cu_msg.cm_status;
1267 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1270 free_cld_upcall(cup);
1275 * For newer nfsdcld's that allow us to "slurp" the clients
1276 * from the tracking database during startup.
1278 * Check for presence of a record in the reclaim_str_hashtbl
1281 nfsd4_cld_check(struct nfs4_client *clp)
1283 struct nfs4_client_reclaim *crp;
1284 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1285 struct cld_net *cn = nn->cld_net;
1287 char dname[HEXDIR_LEN];
1288 struct xdr_netobj name;
1290 /* did we already find that this client is stable? */
1291 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1294 /* look for it in the reclaim hashtable otherwise */
1295 crp = nfsd4_find_reclaim_client(clp->cl_name, nn);
1299 if (cn->cn_has_legacy) {
1300 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
1304 name.data = kmemdup(dname, HEXDIR_LEN, GFP_KERNEL);
1306 dprintk("%s: failed to allocate memory for name.data!\n",
1310 name.len = HEXDIR_LEN;
1311 crp = nfsd4_find_reclaim_client(name, nn);
1324 nfsd4_cld_check_v2(struct nfs4_client *clp)
1326 struct nfs4_client_reclaim *crp;
1327 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1328 struct cld_net *cn = nn->cld_net;
1330 char dname[HEXDIR_LEN];
1331 struct xdr_netobj name;
1332 struct crypto_shash *tfm = cn->cn_tfm;
1333 struct xdr_netobj cksum;
1334 char *principal = NULL;
1336 /* did we already find that this client is stable? */
1337 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1340 /* look for it in the reclaim hashtable otherwise */
1341 crp = nfsd4_find_reclaim_client(clp->cl_name, nn);
1345 if (cn->cn_has_legacy) {
1346 status = nfs4_make_rec_clidname(dname, &clp->cl_name);
1350 name.data = kmemdup(dname, HEXDIR_LEN, GFP_KERNEL);
1352 dprintk("%s: failed to allocate memory for name.data\n",
1356 name.len = HEXDIR_LEN;
1357 crp = nfsd4_find_reclaim_client(name, nn);
1365 if (crp->cr_princhash.len) {
1366 if (clp->cl_cred.cr_raw_principal)
1367 principal = clp->cl_cred.cr_raw_principal;
1368 else if (clp->cl_cred.cr_principal)
1369 principal = clp->cl_cred.cr_principal;
1370 if (principal == NULL)
1372 cksum.len = crypto_shash_digestsize(tfm);
1373 cksum.data = kmalloc(cksum.len, GFP_KERNEL);
1374 if (cksum.data == NULL)
1376 status = crypto_shash_tfm_digest(tfm, principal,
1377 strlen(principal), cksum.data);
1382 if (memcmp(crp->cr_princhash.data, cksum.data,
1383 crp->cr_princhash.len)) {
1394 nfsd4_cld_grace_start(struct nfsd_net *nn)
1397 struct cld_upcall *cup;
1398 struct cld_net *cn = nn->cld_net;
1400 cup = alloc_cld_upcall(nn);
1406 cup->cu_u.cu_msg.cm_cmd = Cld_GraceStart;
1407 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1409 ret = cup->cu_u.cu_msg.cm_status;
1411 free_cld_upcall(cup);
1414 dprintk("%s: Unable to get clients from userspace: %d\n",
1419 /* For older nfsdcld's that need cm_gracetime */
1421 nfsd4_cld_grace_done_v0(struct nfsd_net *nn)
1424 struct cld_upcall *cup;
1425 struct cld_net *cn = nn->cld_net;
1427 cup = alloc_cld_upcall(nn);
1433 cup->cu_u.cu_msg.cm_cmd = Cld_GraceDone;
1434 cup->cu_u.cu_msg.cm_u.cm_gracetime = nn->boot_time;
1435 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1437 ret = cup->cu_u.cu_msg.cm_status;
1439 free_cld_upcall(cup);
1442 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1446 * For newer nfsdcld's that do not need cm_gracetime. We also need to call
1447 * nfs4_release_reclaim() to clear out the reclaim_str_hashtbl.
1450 nfsd4_cld_grace_done(struct nfsd_net *nn)
1453 struct cld_upcall *cup;
1454 struct cld_net *cn = nn->cld_net;
1456 cup = alloc_cld_upcall(nn);
1462 cup->cu_u.cu_msg.cm_cmd = Cld_GraceDone;
1463 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1465 ret = cup->cu_u.cu_msg.cm_status;
1467 free_cld_upcall(cup);
1469 nfs4_release_reclaim(nn);
1471 printk(KERN_ERR "NFSD: Unable to end grace period: %d\n", ret);
1475 nfs4_cld_state_init(struct net *net)
1477 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1480 nn->reclaim_str_hashtbl = kmalloc_array(CLIENT_HASH_SIZE,
1481 sizeof(struct list_head),
1483 if (!nn->reclaim_str_hashtbl)
1486 for (i = 0; i < CLIENT_HASH_SIZE; i++)
1487 INIT_LIST_HEAD(&nn->reclaim_str_hashtbl[i]);
1488 nn->reclaim_str_hashtbl_size = 0;
1489 nn->track_reclaim_completes = true;
1490 atomic_set(&nn->nr_reclaim_complete, 0);
1496 nfs4_cld_state_shutdown(struct net *net)
1498 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1500 nn->track_reclaim_completes = false;
1501 kfree(nn->reclaim_str_hashtbl);
1505 cld_running(struct nfsd_net *nn)
1507 struct cld_net *cn = nn->cld_net;
1508 struct rpc_pipe *pipe = cn->cn_pipe;
1510 return pipe->nreaders || pipe->nwriters;
1514 nfsd4_cld_get_version(struct nfsd_net *nn)
1517 struct cld_upcall *cup;
1518 struct cld_net *cn = nn->cld_net;
1521 cup = alloc_cld_upcall(nn);
1526 cup->cu_u.cu_msg.cm_cmd = Cld_GetVersion;
1527 ret = cld_pipe_upcall(cn->cn_pipe, &cup->cu_u.cu_msg, nn);
1529 ret = cup->cu_u.cu_msg.cm_status;
1532 version = cup->cu_u.cu_msg.cm_u.cm_version;
1533 dprintk("%s: userspace returned version %u\n",
1537 else if (version > CLD_UPCALL_VERSION)
1538 version = CLD_UPCALL_VERSION;
1542 nn->client_tracking_ops = &nfsd4_cld_tracking_ops;
1545 nn->client_tracking_ops = &nfsd4_cld_tracking_ops_v2;
1552 free_cld_upcall(cup);
1555 dprintk("%s: Unable to get version from userspace: %d\n",
1561 nfsd4_cld_tracking_init(struct net *net)
1564 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1567 struct crypto_shash *tfm;
1569 status = nfs4_cld_state_init(net);
1573 status = __nfsd4_init_cld_pipe(net);
1578 * rpc pipe upcalls take 30 seconds to time out, so we don't want to
1579 * queue an upcall unless we know that nfsdcld is running (because we
1580 * want this to fail fast so that nfsd4_client_tracking_init() can try
1581 * the next client tracking method). nfsdcld should already be running
1582 * before nfsd is started, so the wait here is for nfsdcld to open the
1583 * pipefs file we just created.
1585 while (!(running = cld_running(nn)) && retries--)
1589 status = -ETIMEDOUT;
1592 tfm = crypto_alloc_shash("sha256", 0, 0);
1594 status = PTR_ERR(tfm);
1597 nn->cld_net->cn_tfm = tfm;
1599 status = nfsd4_cld_get_version(nn);
1600 if (status == -EOPNOTSUPP)
1601 pr_warn("NFSD: nfsdcld GetVersion upcall failed. Please upgrade nfsdcld.\n");
1603 status = nfsd4_cld_grace_start(nn);
1605 if (status == -EOPNOTSUPP)
1606 pr_warn("NFSD: nfsdcld GraceStart upcall failed. Please upgrade nfsdcld.\n");
1607 nfs4_release_reclaim(nn);
1610 pr_info("NFSD: Using nfsdcld client tracking operations.\n");
1614 nfsd4_remove_cld_pipe(net);
1616 nfs4_cld_state_shutdown(net);
1621 nfsd4_cld_tracking_exit(struct net *net)
1623 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1625 nfs4_release_reclaim(nn);
1626 nfsd4_remove_cld_pipe(net);
1627 nfs4_cld_state_shutdown(net);
1630 /* For older nfsdcld's */
1631 static const struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops_v0 = {
1632 .init = nfsd4_init_cld_pipe,
1633 .exit = nfsd4_remove_cld_pipe,
1634 .create = nfsd4_cld_create,
1635 .remove = nfsd4_cld_remove,
1636 .check = nfsd4_cld_check_v0,
1637 .grace_done = nfsd4_cld_grace_done_v0,
1639 .msglen = sizeof(struct cld_msg),
1642 /* For newer nfsdcld's */
1643 static const struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops = {
1644 .init = nfsd4_cld_tracking_init,
1645 .exit = nfsd4_cld_tracking_exit,
1646 .create = nfsd4_cld_create,
1647 .remove = nfsd4_cld_remove,
1648 .check = nfsd4_cld_check,
1649 .grace_done = nfsd4_cld_grace_done,
1651 .msglen = sizeof(struct cld_msg),
1654 /* v2 create/check ops include the principal, if available */
1655 static const struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops_v2 = {
1656 .init = nfsd4_cld_tracking_init,
1657 .exit = nfsd4_cld_tracking_exit,
1658 .create = nfsd4_cld_create_v2,
1659 .remove = nfsd4_cld_remove,
1660 .check = nfsd4_cld_check_v2,
1661 .grace_done = nfsd4_cld_grace_done,
1663 .msglen = sizeof(struct cld_msg_v2),
1666 /* upcall via usermodehelper */
1667 static char cltrack_prog[PATH_MAX] = "/sbin/nfsdcltrack";
1668 module_param_string(cltrack_prog, cltrack_prog, sizeof(cltrack_prog),
1670 MODULE_PARM_DESC(cltrack_prog, "Path to the nfsdcltrack upcall program");
1672 static bool cltrack_legacy_disable;
1673 module_param(cltrack_legacy_disable, bool, S_IRUGO|S_IWUSR);
1674 MODULE_PARM_DESC(cltrack_legacy_disable,
1675 "Disable legacy recoverydir conversion. Default: false");
1677 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1678 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1679 #define HAS_SESSION_ENV_PREFIX "NFSDCLTRACK_CLIENT_HAS_SESSION="
1680 #define GRACE_START_ENV_PREFIX "NFSDCLTRACK_GRACE_START="
1683 nfsd4_cltrack_legacy_topdir(void)
1689 if (cltrack_legacy_disable)
1692 len = strlen(LEGACY_TOPDIR_ENV_PREFIX) +
1693 strlen(nfs4_recoverydir()) + 1;
1695 result = kmalloc(len, GFP_KERNEL);
1699 copied = snprintf(result, len, LEGACY_TOPDIR_ENV_PREFIX "%s",
1700 nfs4_recoverydir());
1701 if (copied >= len) {
1702 /* just return nothing if output was truncated */
1711 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj *name)
1717 if (cltrack_legacy_disable)
1720 /* +1 is for '/' between "topdir" and "recdir" */
1721 len = strlen(LEGACY_RECDIR_ENV_PREFIX) +
1722 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN;
1724 result = kmalloc(len, GFP_KERNEL);
1728 copied = snprintf(result, len, LEGACY_RECDIR_ENV_PREFIX "%s/",
1729 nfs4_recoverydir());
1730 if (copied > (len - HEXDIR_LEN)) {
1731 /* just return nothing if output will be truncated */
1736 copied = nfs4_make_rec_clidname(result + copied, name);
1746 nfsd4_cltrack_client_has_session(struct nfs4_client *clp)
1752 /* prefix + Y/N character + terminating NULL */
1753 len = strlen(HAS_SESSION_ENV_PREFIX) + 1 + 1;
1755 result = kmalloc(len, GFP_KERNEL);
1759 copied = snprintf(result, len, HAS_SESSION_ENV_PREFIX "%c",
1760 clp->cl_minorversion ? 'Y' : 'N');
1761 if (copied >= len) {
1762 /* just return nothing if output was truncated */
1771 nfsd4_cltrack_grace_start(time64_t grace_start)
1777 /* prefix + max width of int64_t string + terminating NULL */
1778 len = strlen(GRACE_START_ENV_PREFIX) + 22 + 1;
1780 result = kmalloc(len, GFP_KERNEL);
1784 copied = snprintf(result, len, GRACE_START_ENV_PREFIX "%lld",
1786 if (copied >= len) {
1787 /* just return nothing if output was truncated */
1796 nfsd4_umh_cltrack_upcall(char *cmd, char *arg, char *env0, char *env1)
1802 if (unlikely(!cltrack_prog[0])) {
1803 dprintk("%s: cltrack_prog is disabled\n", __func__);
1807 dprintk("%s: cmd: %s\n", __func__, cmd);
1808 dprintk("%s: arg: %s\n", __func__, arg ? arg : "(null)");
1809 dprintk("%s: env0: %s\n", __func__, env0 ? env0 : "(null)");
1810 dprintk("%s: env1: %s\n", __func__, env1 ? env1 : "(null)");
1816 argv[0] = (char *)cltrack_prog;
1821 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_PROC);
1823 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1824 * error. The admin can re-enable it on the fly by using sysfs
1825 * once the problem has been fixed.
1827 if (ret == -ENOENT || ret == -EACCES) {
1828 dprintk("NFSD: %s was not found or isn't executable (%d). "
1829 "Setting cltrack_prog to blank string!",
1831 cltrack_prog[0] = '\0';
1833 dprintk("%s: %s return value: %d\n", __func__, cltrack_prog, ret);
1839 bin_to_hex_dup(const unsigned char *src, int srclen)
1843 /* +1 for terminating NULL */
1844 buf = kzalloc((srclen * 2) + 1, GFP_KERNEL);
1848 bin2hex(buf, src, srclen);
1853 nfsd4_umh_cltrack_init(struct net *net)
1856 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1857 char *grace_start = nfsd4_cltrack_grace_start(nn->boot_time);
1859 /* XXX: The usermode helper s not working in container yet. */
1860 if (net != &init_net) {
1861 pr_warn("NFSD: attempt to initialize umh client tracking in a container ignored.\n");
1866 ret = nfsd4_umh_cltrack_upcall("init", NULL, grace_start, NULL);
1869 pr_info("NFSD: Using UMH upcall client tracking operations.\n");
1874 nfsd4_cltrack_upcall_lock(struct nfs4_client *clp)
1876 wait_on_bit_lock(&clp->cl_flags, NFSD4_CLIENT_UPCALL_LOCK,
1877 TASK_UNINTERRUPTIBLE);
1881 nfsd4_cltrack_upcall_unlock(struct nfs4_client *clp)
1883 smp_mb__before_atomic();
1884 clear_bit(NFSD4_CLIENT_UPCALL_LOCK, &clp->cl_flags);
1885 smp_mb__after_atomic();
1886 wake_up_bit(&clp->cl_flags, NFSD4_CLIENT_UPCALL_LOCK);
1890 nfsd4_umh_cltrack_create(struct nfs4_client *clp)
1892 char *hexid, *has_session, *grace_start;
1893 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
1896 * With v4.0 clients, there's little difference in outcome between a
1897 * create and check operation, and we can end up calling into this
1898 * function multiple times per client (once for each openowner). So,
1899 * for v4.0 clients skip upcalling once the client has been recorded
1900 * on stable storage.
1902 * For v4.1+ clients, the outcome of the two operations is different,
1903 * so we must ensure that we upcall for the create operation. v4.1+
1904 * clients call this on RECLAIM_COMPLETE though, so we should only end
1905 * up doing a single create upcall per client.
1907 if (clp->cl_minorversion == 0 &&
1908 test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1911 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1913 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1917 has_session = nfsd4_cltrack_client_has_session(clp);
1918 grace_start = nfsd4_cltrack_grace_start(nn->boot_time);
1920 nfsd4_cltrack_upcall_lock(clp);
1921 if (!nfsd4_umh_cltrack_upcall("create", hexid, has_session, grace_start))
1922 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1923 nfsd4_cltrack_upcall_unlock(clp);
1931 nfsd4_umh_cltrack_remove(struct nfs4_client *clp)
1935 if (!test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1938 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1940 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1944 nfsd4_cltrack_upcall_lock(clp);
1945 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags) &&
1946 nfsd4_umh_cltrack_upcall("remove", hexid, NULL, NULL) == 0)
1947 clear_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1948 nfsd4_cltrack_upcall_unlock(clp);
1954 nfsd4_umh_cltrack_check(struct nfs4_client *clp)
1957 char *hexid, *has_session, *legacy;
1959 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags))
1962 hexid = bin_to_hex_dup(clp->cl_name.data, clp->cl_name.len);
1964 dprintk("%s: can't allocate memory for upcall!\n", __func__);
1968 has_session = nfsd4_cltrack_client_has_session(clp);
1969 legacy = nfsd4_cltrack_legacy_recdir(&clp->cl_name);
1971 nfsd4_cltrack_upcall_lock(clp);
1972 if (test_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags)) {
1975 ret = nfsd4_umh_cltrack_upcall("check", hexid, has_session, legacy);
1977 set_bit(NFSD4_CLIENT_STABLE, &clp->cl_flags);
1979 nfsd4_cltrack_upcall_unlock(clp);
1988 nfsd4_umh_cltrack_grace_done(struct nfsd_net *nn)
1991 char timestr[22]; /* FIXME: better way to determine max size? */
1993 sprintf(timestr, "%lld", nn->boot_time);
1994 legacy = nfsd4_cltrack_legacy_topdir();
1995 nfsd4_umh_cltrack_upcall("gracedone", timestr, legacy, NULL);
1999 static const struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops = {
2000 .init = nfsd4_umh_cltrack_init,
2002 .create = nfsd4_umh_cltrack_create,
2003 .remove = nfsd4_umh_cltrack_remove,
2004 .check = nfsd4_umh_cltrack_check,
2005 .grace_done = nfsd4_umh_cltrack_grace_done,
2011 nfsd4_client_tracking_init(struct net *net)
2015 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
2017 /* just run the init if it the method is already decided */
2018 if (nn->client_tracking_ops)
2021 /* First, try to use nfsdcld */
2022 nn->client_tracking_ops = &nfsd4_cld_tracking_ops;
2023 status = nn->client_tracking_ops->init(net);
2026 if (status != -ETIMEDOUT) {
2027 nn->client_tracking_ops = &nfsd4_cld_tracking_ops_v0;
2028 status = nn->client_tracking_ops->init(net);
2034 * Next, try the UMH upcall.
2036 nn->client_tracking_ops = &nfsd4_umh_tracking_ops;
2037 status = nn->client_tracking_ops->init(net);
2042 * Finally, See if the recoverydir exists and is a directory.
2043 * If it is, then use the legacy ops.
2045 nn->client_tracking_ops = &nfsd4_legacy_tracking_ops;
2046 status = kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW, &path);
2048 status = d_is_dir(path.dentry);
2057 status = nn->client_tracking_ops->init(net);
2060 printk(KERN_WARNING "NFSD: Unable to initialize client "
2061 "recovery tracking! (%d)\n", status);
2062 nn->client_tracking_ops = NULL;
2068 nfsd4_client_tracking_exit(struct net *net)
2070 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
2072 if (nn->client_tracking_ops) {
2073 if (nn->client_tracking_ops->exit)
2074 nn->client_tracking_ops->exit(net);
2075 nn->client_tracking_ops = NULL;
2080 nfsd4_client_record_create(struct nfs4_client *clp)
2082 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
2084 if (nn->client_tracking_ops)
2085 nn->client_tracking_ops->create(clp);
2089 nfsd4_client_record_remove(struct nfs4_client *clp)
2091 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
2093 if (nn->client_tracking_ops)
2094 nn->client_tracking_ops->remove(clp);
2098 nfsd4_client_record_check(struct nfs4_client *clp)
2100 struct nfsd_net *nn = net_generic(clp->net, nfsd_net_id);
2102 if (nn->client_tracking_ops)
2103 return nn->client_tracking_ops->check(clp);
2109 nfsd4_record_grace_done(struct nfsd_net *nn)
2111 if (nn->client_tracking_ops)
2112 nn->client_tracking_ops->grace_done(nn);
2116 rpc_pipefs_event(struct notifier_block *nb, unsigned long event, void *ptr)
2118 struct super_block *sb = ptr;
2119 struct net *net = sb->s_fs_info;
2120 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
2121 struct cld_net *cn = nn->cld_net;
2122 struct dentry *dentry;
2125 if (!try_module_get(THIS_MODULE))
2129 module_put(THIS_MODULE);
2134 case RPC_PIPEFS_MOUNT:
2135 dentry = nfsd4_cld_register_sb(sb, cn->cn_pipe);
2136 if (IS_ERR(dentry)) {
2137 ret = PTR_ERR(dentry);
2140 cn->cn_pipe->dentry = dentry;
2142 case RPC_PIPEFS_UMOUNT:
2143 if (cn->cn_pipe->dentry)
2144 nfsd4_cld_unregister_sb(cn->cn_pipe);
2150 module_put(THIS_MODULE);
2154 static struct notifier_block nfsd4_cld_block = {
2155 .notifier_call = rpc_pipefs_event,
2159 register_cld_notifier(void)
2161 WARN_ON(!nfsd_net_id);
2162 return rpc_pipefs_notifier_register(&nfsd4_cld_block);
2166 unregister_cld_notifier(void)
2168 rpc_pipefs_notifier_unregister(&nfsd4_cld_block);