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 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
, &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
;
274 status
= nfs4_save_creds(&original_cred
);
278 status
= vfs_llseek(nn
->rec_file
, 0, SEEK_SET
);
280 nfs4_reset_creds(original_cred
);
284 INIT_LIST_HEAD(&ctx
.names
);
285 ctx
.ctx
.actor
= nfsd4_build_namelist
;
286 status
= iterate_dir(nn
->rec_file
, &ctx
.ctx
);
287 mutex_lock_nested(&dir
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
288 while (!list_empty(&ctx
.names
)) {
289 struct name_list
*entry
;
290 entry
= list_entry(ctx
.names
.next
, struct name_list
, list
);
292 struct dentry
*dentry
;
293 dentry
= lookup_one_len(entry
->name
, dir
, HEXDIR_LEN
-1);
294 if (IS_ERR(dentry
)) {
295 status
= PTR_ERR(dentry
);
298 status
= f(dir
, dentry
, nn
);
301 list_del(&entry
->list
);
304 mutex_unlock(&dir
->d_inode
->i_mutex
);
305 nfs4_reset_creds(original_cred
);
310 nfsd4_unlink_clid_dir(char *name
, int namlen
, struct nfsd_net
*nn
)
312 struct dentry
*dir
, *dentry
;
315 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen
, name
);
317 dir
= nn
->rec_file
->f_path
.dentry
;
318 mutex_lock_nested(&dir
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
319 dentry
= lookup_one_len(name
, dir
, namlen
);
320 if (IS_ERR(dentry
)) {
321 status
= PTR_ERR(dentry
);
325 if (!dentry
->d_inode
)
327 status
= vfs_rmdir(dir
->d_inode
, dentry
);
331 mutex_unlock(&dir
->d_inode
->i_mutex
);
336 nfsd4_remove_clid_dir(struct nfs4_client
*clp
)
338 const struct cred
*original_cred
;
339 struct nfs4_client_reclaim
*crp
;
340 char dname
[HEXDIR_LEN
];
342 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
344 if (!nn
->rec_file
|| !test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
347 status
= nfs4_make_rec_clidname(dname
, &clp
->cl_name
);
349 return legacy_recdir_name_error(clp
, status
);
351 status
= mnt_want_write_file(nn
->rec_file
);
354 clear_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
356 status
= nfs4_save_creds(&original_cred
);
360 status
= nfsd4_unlink_clid_dir(dname
, HEXDIR_LEN
-1, nn
);
361 nfs4_reset_creds(original_cred
);
363 vfs_fsync(nn
->rec_file
, 0);
365 /* remove reclaim record */
366 crp
= nfsd4_find_reclaim_client(dname
, nn
);
368 nfs4_remove_reclaim_record(crp
, nn
);
372 mnt_drop_write_file(nn
->rec_file
);
375 printk("NFSD: Failed to remove expired client state directory"
376 " %.*s\n", HEXDIR_LEN
, dname
);
380 purge_old(struct dentry
*parent
, struct dentry
*child
, struct nfsd_net
*nn
)
384 if (nfs4_has_reclaimed_state(child
->d_name
.name
, nn
))
387 status
= vfs_rmdir(parent
->d_inode
, child
);
389 printk("failed to remove client recovery directory %s\n",
391 /* Keep trying, success or failure: */
396 nfsd4_recdir_purge_old(struct nfsd_net
*nn
, time_t boot_time
)
400 nn
->in_grace
= false;
403 status
= mnt_want_write_file(nn
->rec_file
);
406 status
= nfsd4_list_rec_dir(purge_old
, nn
);
408 vfs_fsync(nn
->rec_file
, 0);
409 mnt_drop_write_file(nn
->rec_file
);
411 nfs4_release_reclaim(nn
);
413 printk("nfsd4: failed to purge old clients from recovery"
414 " directory %s\n", nn
->rec_file
->f_path
.dentry
->d_name
.name
);
418 load_recdir(struct dentry
*parent
, struct dentry
*child
, struct nfsd_net
*nn
)
420 if (child
->d_name
.len
!= HEXDIR_LEN
- 1) {
421 printk("nfsd4: illegal name %s in recovery directory\n",
423 /* Keep trying; maybe the others are OK: */
426 nfs4_client_to_reclaim(child
->d_name
.name
, nn
);
431 nfsd4_recdir_load(struct net
*net
) {
433 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
438 status
= nfsd4_list_rec_dir(load_recdir
, nn
);
440 printk("nfsd4: failed loading clients from recovery"
441 " directory %s\n", nn
->rec_file
->f_path
.dentry
->d_name
.name
);
446 * Hold reference to the recovery directory.
450 nfsd4_init_recdir(struct net
*net
)
452 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
453 const struct cred
*original_cred
;
456 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
457 user_recovery_dirname
);
459 BUG_ON(nn
->rec_file
);
461 status
= nfs4_save_creds(&original_cred
);
463 printk("NFSD: Unable to change credentials to find recovery"
464 " directory: error %d\n",
469 nn
->rec_file
= filp_open(user_recovery_dirname
, O_RDONLY
| O_DIRECTORY
, 0);
470 if (IS_ERR(nn
->rec_file
)) {
471 printk("NFSD: unable to find recovery directory %s\n",
472 user_recovery_dirname
);
473 status
= PTR_ERR(nn
->rec_file
);
477 nfs4_reset_creds(original_cred
);
485 nfs4_legacy_state_init(struct net
*net
)
487 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
490 nn
->reclaim_str_hashtbl
= kmalloc(sizeof(struct list_head
) *
491 CLIENT_HASH_SIZE
, GFP_KERNEL
);
492 if (!nn
->reclaim_str_hashtbl
)
495 for (i
= 0; i
< CLIENT_HASH_SIZE
; i
++)
496 INIT_LIST_HEAD(&nn
->reclaim_str_hashtbl
[i
]);
497 nn
->reclaim_str_hashtbl_size
= 0;
503 nfs4_legacy_state_shutdown(struct net
*net
)
505 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
507 kfree(nn
->reclaim_str_hashtbl
);
511 nfsd4_load_reboot_recovery_data(struct net
*net
)
515 status
= nfsd4_init_recdir(net
);
517 status
= nfsd4_recdir_load(net
);
519 printk(KERN_ERR
"NFSD: Failure reading reboot recovery data\n");
524 nfsd4_legacy_tracking_init(struct net
*net
)
528 /* XXX: The legacy code won't work in a container */
529 if (net
!= &init_net
) {
530 WARN(1, KERN_ERR
"NFSD: attempt to initialize legacy client "
531 "tracking in a container!\n");
535 status
= nfs4_legacy_state_init(net
);
539 status
= nfsd4_load_reboot_recovery_data(net
);
545 nfs4_legacy_state_shutdown(net
);
550 nfsd4_shutdown_recdir(struct nfsd_net
*nn
)
559 nfsd4_legacy_tracking_exit(struct net
*net
)
561 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
563 nfs4_release_reclaim(nn
);
564 nfsd4_shutdown_recdir(nn
);
565 nfs4_legacy_state_shutdown(net
);
569 * Change the NFSv4 recovery directory to recdir.
572 nfs4_reset_recoverydir(char *recdir
)
577 status
= kern_path(recdir
, LOOKUP_FOLLOW
, &path
);
581 if (S_ISDIR(path
.dentry
->d_inode
->i_mode
)) {
582 strcpy(user_recovery_dirname
, recdir
);
590 nfs4_recoverydir(void)
592 return user_recovery_dirname
;
596 nfsd4_check_legacy_client(struct nfs4_client
*clp
)
599 char dname
[HEXDIR_LEN
];
600 struct nfs4_client_reclaim
*crp
;
601 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
603 /* did we already find that this client is stable? */
604 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
607 status
= nfs4_make_rec_clidname(dname
, &clp
->cl_name
);
609 legacy_recdir_name_error(clp
, status
);
613 /* look for it in the reclaim hashtable otherwise */
614 crp
= nfsd4_find_reclaim_client(dname
, nn
);
616 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
624 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops
= {
625 .init
= nfsd4_legacy_tracking_init
,
626 .exit
= nfsd4_legacy_tracking_exit
,
627 .create
= nfsd4_create_clid_dir
,
628 .remove
= nfsd4_remove_clid_dir
,
629 .check
= nfsd4_check_legacy_client
,
630 .grace_done
= nfsd4_recdir_purge_old
,
634 #define NFSD_PIPE_DIR "nfsd"
635 #define NFSD_CLD_PIPE "cld"
637 /* per-net-ns structure for holding cld upcall info */
639 struct rpc_pipe
*cn_pipe
;
641 struct list_head cn_list
;
646 struct list_head cu_list
;
647 struct cld_net
*cu_net
;
648 struct task_struct
*cu_task
;
649 struct cld_msg cu_msg
;
653 __cld_pipe_upcall(struct rpc_pipe
*pipe
, struct cld_msg
*cmsg
)
656 struct rpc_pipe_msg msg
;
658 memset(&msg
, 0, sizeof(msg
));
660 msg
.len
= sizeof(*cmsg
);
663 * Set task state before we queue the upcall. That prevents
664 * wake_up_process in the downcall from racing with schedule.
666 set_current_state(TASK_UNINTERRUPTIBLE
);
667 ret
= rpc_queue_upcall(pipe
, &msg
);
669 set_current_state(TASK_RUNNING
);
674 set_current_state(TASK_RUNNING
);
683 cld_pipe_upcall(struct rpc_pipe
*pipe
, struct cld_msg
*cmsg
)
688 * -EAGAIN occurs when pipe is closed and reopened while there are
692 ret
= __cld_pipe_upcall(pipe
, cmsg
);
693 } while (ret
== -EAGAIN
);
699 cld_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
701 struct cld_upcall
*tmp
, *cup
;
702 struct cld_msg __user
*cmsg
= (struct cld_msg __user
*)src
;
704 struct nfsd_net
*nn
= net_generic(filp
->f_dentry
->d_sb
->s_fs_info
,
706 struct cld_net
*cn
= nn
->cld_net
;
708 if (mlen
!= sizeof(*cmsg
)) {
709 dprintk("%s: got %zu bytes, expected %zu\n", __func__
, mlen
,
714 /* copy just the xid so we can try to find that */
715 if (copy_from_user(&xid
, &cmsg
->cm_xid
, sizeof(xid
)) != 0) {
716 dprintk("%s: error when copying xid from userspace", __func__
);
720 /* walk the list and find corresponding xid */
722 spin_lock(&cn
->cn_lock
);
723 list_for_each_entry(tmp
, &cn
->cn_list
, cu_list
) {
724 if (get_unaligned(&tmp
->cu_msg
.cm_xid
) == xid
) {
726 list_del_init(&cup
->cu_list
);
730 spin_unlock(&cn
->cn_lock
);
732 /* couldn't find upcall? */
734 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__
, xid
);
738 if (copy_from_user(&cup
->cu_msg
, src
, mlen
) != 0)
741 wake_up_process(cup
->cu_task
);
746 cld_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
748 struct cld_msg
*cmsg
= msg
->data
;
749 struct cld_upcall
*cup
= container_of(cmsg
, struct cld_upcall
,
752 /* errno >= 0 means we got a downcall */
756 wake_up_process(cup
->cu_task
);
759 static const struct rpc_pipe_ops cld_upcall_ops
= {
760 .upcall
= rpc_pipe_generic_upcall
,
761 .downcall
= cld_pipe_downcall
,
762 .destroy_msg
= cld_pipe_destroy_msg
,
765 static struct dentry
*
766 nfsd4_cld_register_sb(struct super_block
*sb
, struct rpc_pipe
*pipe
)
768 struct dentry
*dir
, *dentry
;
770 dir
= rpc_d_lookup_sb(sb
, NFSD_PIPE_DIR
);
772 return ERR_PTR(-ENOENT
);
773 dentry
= rpc_mkpipe_dentry(dir
, NFSD_CLD_PIPE
, NULL
, pipe
);
779 nfsd4_cld_unregister_sb(struct rpc_pipe
*pipe
)
782 rpc_unlink(pipe
->dentry
);
785 static struct dentry
*
786 nfsd4_cld_register_net(struct net
*net
, struct rpc_pipe
*pipe
)
788 struct super_block
*sb
;
789 struct dentry
*dentry
;
791 sb
= rpc_get_sb_net(net
);
794 dentry
= nfsd4_cld_register_sb(sb
, pipe
);
800 nfsd4_cld_unregister_net(struct net
*net
, struct rpc_pipe
*pipe
)
802 struct super_block
*sb
;
804 sb
= rpc_get_sb_net(net
);
806 nfsd4_cld_unregister_sb(pipe
);
811 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
813 nfsd4_init_cld_pipe(struct net
*net
)
816 struct dentry
*dentry
;
817 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
823 cn
= kzalloc(sizeof(*cn
), GFP_KERNEL
);
829 cn
->cn_pipe
= rpc_mkpipe_data(&cld_upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
830 if (IS_ERR(cn
->cn_pipe
)) {
831 ret
= PTR_ERR(cn
->cn_pipe
);
834 spin_lock_init(&cn
->cn_lock
);
835 INIT_LIST_HEAD(&cn
->cn_list
);
837 dentry
= nfsd4_cld_register_net(net
, cn
->cn_pipe
);
838 if (IS_ERR(dentry
)) {
839 ret
= PTR_ERR(dentry
);
840 goto err_destroy_data
;
843 cn
->cn_pipe
->dentry
= dentry
;
848 rpc_destroy_pipe_data(cn
->cn_pipe
);
851 printk(KERN_ERR
"NFSD: unable to create nfsdcld upcall pipe (%d)\n",
857 nfsd4_remove_cld_pipe(struct net
*net
)
859 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
860 struct cld_net
*cn
= nn
->cld_net
;
862 nfsd4_cld_unregister_net(net
, cn
->cn_pipe
);
863 rpc_destroy_pipe_data(cn
->cn_pipe
);
868 static struct cld_upcall
*
869 alloc_cld_upcall(struct cld_net
*cn
)
871 struct cld_upcall
*new, *tmp
;
873 new = kzalloc(sizeof(*new), GFP_KERNEL
);
877 /* FIXME: hard cap on number in flight? */
879 spin_lock(&cn
->cn_lock
);
880 list_for_each_entry(tmp
, &cn
->cn_list
, cu_list
) {
881 if (tmp
->cu_msg
.cm_xid
== cn
->cn_xid
) {
883 spin_unlock(&cn
->cn_lock
);
887 new->cu_task
= current
;
888 new->cu_msg
.cm_vers
= CLD_UPCALL_VERSION
;
889 put_unaligned(cn
->cn_xid
++, &new->cu_msg
.cm_xid
);
891 list_add(&new->cu_list
, &cn
->cn_list
);
892 spin_unlock(&cn
->cn_lock
);
894 dprintk("%s: allocated xid %u\n", __func__
, new->cu_msg
.cm_xid
);
900 free_cld_upcall(struct cld_upcall
*victim
)
902 struct cld_net
*cn
= victim
->cu_net
;
904 spin_lock(&cn
->cn_lock
);
905 list_del(&victim
->cu_list
);
906 spin_unlock(&cn
->cn_lock
);
910 /* Ask daemon to create a new record */
912 nfsd4_cld_create(struct nfs4_client
*clp
)
915 struct cld_upcall
*cup
;
916 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
917 struct cld_net
*cn
= nn
->cld_net
;
919 /* Don't upcall if it's already stored */
920 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
923 cup
= alloc_cld_upcall(cn
);
929 cup
->cu_msg
.cm_cmd
= Cld_Create
;
930 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
931 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
934 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
936 ret
= cup
->cu_msg
.cm_status
;
937 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
940 free_cld_upcall(cup
);
943 printk(KERN_ERR
"NFSD: Unable to create client "
944 "record on stable storage: %d\n", ret
);
947 /* Ask daemon to create a new record */
949 nfsd4_cld_remove(struct nfs4_client
*clp
)
952 struct cld_upcall
*cup
;
953 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
954 struct cld_net
*cn
= nn
->cld_net
;
956 /* Don't upcall if it's already removed */
957 if (!test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
960 cup
= alloc_cld_upcall(cn
);
966 cup
->cu_msg
.cm_cmd
= Cld_Remove
;
967 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
968 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
971 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
973 ret
= cup
->cu_msg
.cm_status
;
974 clear_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
977 free_cld_upcall(cup
);
980 printk(KERN_ERR
"NFSD: Unable to remove client "
981 "record from stable storage: %d\n", ret
);
984 /* Check for presence of a record, and update its timestamp */
986 nfsd4_cld_check(struct nfs4_client
*clp
)
989 struct cld_upcall
*cup
;
990 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
991 struct cld_net
*cn
= nn
->cld_net
;
993 /* Don't upcall if one was already stored during this grace pd */
994 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
997 cup
= alloc_cld_upcall(cn
);
999 printk(KERN_ERR
"NFSD: Unable to check client record on "
1000 "stable storage: %d\n", -ENOMEM
);
1004 cup
->cu_msg
.cm_cmd
= Cld_Check
;
1005 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
1006 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
1009 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
1011 ret
= cup
->cu_msg
.cm_status
;
1012 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
1015 free_cld_upcall(cup
);
1020 nfsd4_cld_grace_done(struct nfsd_net
*nn
, time_t boot_time
)
1023 struct cld_upcall
*cup
;
1024 struct cld_net
*cn
= nn
->cld_net
;
1026 cup
= alloc_cld_upcall(cn
);
1032 cup
->cu_msg
.cm_cmd
= Cld_GraceDone
;
1033 cup
->cu_msg
.cm_u
.cm_gracetime
= (int64_t)boot_time
;
1034 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
1036 ret
= cup
->cu_msg
.cm_status
;
1038 free_cld_upcall(cup
);
1041 printk(KERN_ERR
"NFSD: Unable to end grace period: %d\n", ret
);
1044 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops
= {
1045 .init
= nfsd4_init_cld_pipe
,
1046 .exit
= nfsd4_remove_cld_pipe
,
1047 .create
= nfsd4_cld_create
,
1048 .remove
= nfsd4_cld_remove
,
1049 .check
= nfsd4_cld_check
,
1050 .grace_done
= nfsd4_cld_grace_done
,
1053 /* upcall via usermodehelper */
1054 static char cltrack_prog
[PATH_MAX
] = "/sbin/nfsdcltrack";
1055 module_param_string(cltrack_prog
, cltrack_prog
, sizeof(cltrack_prog
),
1057 MODULE_PARM_DESC(cltrack_prog
, "Path to the nfsdcltrack upcall program");
1059 static bool cltrack_legacy_disable
;
1060 module_param(cltrack_legacy_disable
, bool, S_IRUGO
|S_IWUSR
);
1061 MODULE_PARM_DESC(cltrack_legacy_disable
,
1062 "Disable legacy recoverydir conversion. Default: false");
1064 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1065 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1068 nfsd4_cltrack_legacy_topdir(void)
1074 if (cltrack_legacy_disable
)
1077 len
= strlen(LEGACY_TOPDIR_ENV_PREFIX
) +
1078 strlen(nfs4_recoverydir()) + 1;
1080 result
= kmalloc(len
, GFP_KERNEL
);
1084 copied
= snprintf(result
, len
, LEGACY_TOPDIR_ENV_PREFIX
"%s",
1085 nfs4_recoverydir());
1086 if (copied
>= len
) {
1087 /* just return nothing if output was truncated */
1096 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj
*name
)
1102 if (cltrack_legacy_disable
)
1105 /* +1 is for '/' between "topdir" and "recdir" */
1106 len
= strlen(LEGACY_RECDIR_ENV_PREFIX
) +
1107 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN
;
1109 result
= kmalloc(len
, GFP_KERNEL
);
1113 copied
= snprintf(result
, len
, LEGACY_RECDIR_ENV_PREFIX
"%s/",
1114 nfs4_recoverydir());
1115 if (copied
> (len
- HEXDIR_LEN
)) {
1116 /* just return nothing if output will be truncated */
1121 copied
= nfs4_make_rec_clidname(result
+ copied
, name
);
1131 nfsd4_umh_cltrack_upcall(char *cmd
, char *arg
, char *legacy
)
1137 if (unlikely(!cltrack_prog
[0])) {
1138 dprintk("%s: cltrack_prog is disabled\n", __func__
);
1142 dprintk("%s: cmd: %s\n", __func__
, cmd
);
1143 dprintk("%s: arg: %s\n", __func__
, arg
? arg
: "(null)");
1144 dprintk("%s: legacy: %s\n", __func__
, legacy
? legacy
: "(null)");
1149 argv
[0] = (char *)cltrack_prog
;
1154 ret
= call_usermodehelper(argv
[0], argv
, envp
, UMH_WAIT_PROC
);
1156 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1157 * error. The admin can re-enable it on the fly by using sysfs
1158 * once the problem has been fixed.
1160 if (ret
== -ENOENT
|| ret
== -EACCES
) {
1161 dprintk("NFSD: %s was not found or isn't executable (%d). "
1162 "Setting cltrack_prog to blank string!",
1164 cltrack_prog
[0] = '\0';
1166 dprintk("%s: %s return value: %d\n", __func__
, cltrack_prog
, ret
);
1172 bin_to_hex_dup(const unsigned char *src
, int srclen
)
1177 /* +1 for terminating NULL */
1178 buf
= kmalloc((srclen
* 2) + 1, GFP_KERNEL
);
1183 for (i
= 0; i
< srclen
; i
++) {
1184 sprintf(hex
, "%2.2x", *src
++);
1191 nfsd4_umh_cltrack_init(struct net
__attribute__((unused
)) *net
)
1193 /* XXX: The usermode helper s not working in container yet. */
1194 if (net
!= &init_net
) {
1195 WARN(1, KERN_ERR
"NFSD: attempt to initialize umh client "
1196 "tracking in a container!\n");
1199 return nfsd4_umh_cltrack_upcall("init", NULL
, NULL
);
1203 nfsd4_umh_cltrack_create(struct nfs4_client
*clp
)
1207 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1209 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1212 nfsd4_umh_cltrack_upcall("create", hexid
, NULL
);
1217 nfsd4_umh_cltrack_remove(struct nfs4_client
*clp
)
1221 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1223 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1226 nfsd4_umh_cltrack_upcall("remove", hexid
, NULL
);
1231 nfsd4_umh_cltrack_check(struct nfs4_client
*clp
)
1234 char *hexid
, *legacy
;
1236 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1238 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1241 legacy
= nfsd4_cltrack_legacy_recdir(&clp
->cl_name
);
1242 ret
= nfsd4_umh_cltrack_upcall("check", hexid
, legacy
);
1249 nfsd4_umh_cltrack_grace_done(struct nfsd_net
__attribute__((unused
)) *nn
,
1253 char timestr
[22]; /* FIXME: better way to determine max size? */
1255 sprintf(timestr
, "%ld", boot_time
);
1256 legacy
= nfsd4_cltrack_legacy_topdir();
1257 nfsd4_umh_cltrack_upcall("gracedone", timestr
, legacy
);
1261 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops
= {
1262 .init
= nfsd4_umh_cltrack_init
,
1264 .create
= nfsd4_umh_cltrack_create
,
1265 .remove
= nfsd4_umh_cltrack_remove
,
1266 .check
= nfsd4_umh_cltrack_check
,
1267 .grace_done
= nfsd4_umh_cltrack_grace_done
,
1271 nfsd4_client_tracking_init(struct net
*net
)
1275 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1277 /* just run the init if it the method is already decided */
1278 if (nn
->client_tracking_ops
)
1282 * First, try a UMH upcall. It should succeed or fail quickly, so
1283 * there's little harm in trying that first.
1285 nn
->client_tracking_ops
= &nfsd4_umh_tracking_ops
;
1286 status
= nn
->client_tracking_ops
->init(net
);
1291 * See if the recoverydir exists and is a directory. If it is,
1292 * then use the legacy ops.
1294 nn
->client_tracking_ops
= &nfsd4_legacy_tracking_ops
;
1295 status
= kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW
, &path
);
1297 status
= S_ISDIR(path
.dentry
->d_inode
->i_mode
);
1303 /* Finally, try to use nfsdcld */
1304 nn
->client_tracking_ops
= &nfsd4_cld_tracking_ops
;
1305 printk(KERN_WARNING
"NFSD: the nfsdcld client tracking upcall will be "
1306 "removed in 3.10. Please transition to using "
1309 status
= nn
->client_tracking_ops
->init(net
);
1311 printk(KERN_WARNING
"NFSD: Unable to initialize client "
1312 "recovery tracking! (%d)\n", status
);
1313 nn
->client_tracking_ops
= NULL
;
1319 nfsd4_client_tracking_exit(struct net
*net
)
1321 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1323 if (nn
->client_tracking_ops
) {
1324 if (nn
->client_tracking_ops
->exit
)
1325 nn
->client_tracking_ops
->exit(net
);
1326 nn
->client_tracking_ops
= NULL
;
1331 nfsd4_client_record_create(struct nfs4_client
*clp
)
1333 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1335 if (nn
->client_tracking_ops
)
1336 nn
->client_tracking_ops
->create(clp
);
1340 nfsd4_client_record_remove(struct nfs4_client
*clp
)
1342 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1344 if (nn
->client_tracking_ops
)
1345 nn
->client_tracking_ops
->remove(clp
);
1349 nfsd4_client_record_check(struct nfs4_client
*clp
)
1351 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1353 if (nn
->client_tracking_ops
)
1354 return nn
->client_tracking_ops
->check(clp
);
1360 nfsd4_record_grace_done(struct nfsd_net
*nn
, time_t boot_time
)
1362 if (nn
->client_tracking_ops
)
1363 nn
->client_tracking_ops
->grace_done(nn
, boot_time
);
1367 rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
, void *ptr
)
1369 struct super_block
*sb
= ptr
;
1370 struct net
*net
= sb
->s_fs_info
;
1371 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1372 struct cld_net
*cn
= nn
->cld_net
;
1373 struct dentry
*dentry
;
1376 if (!try_module_get(THIS_MODULE
))
1380 module_put(THIS_MODULE
);
1385 case RPC_PIPEFS_MOUNT
:
1386 dentry
= nfsd4_cld_register_sb(sb
, cn
->cn_pipe
);
1387 if (IS_ERR(dentry
)) {
1388 ret
= PTR_ERR(dentry
);
1391 cn
->cn_pipe
->dentry
= dentry
;
1393 case RPC_PIPEFS_UMOUNT
:
1394 if (cn
->cn_pipe
->dentry
)
1395 nfsd4_cld_unregister_sb(cn
->cn_pipe
);
1401 module_put(THIS_MODULE
);
1405 static struct notifier_block nfsd4_cld_block
= {
1406 .notifier_call
= rpc_pipefs_event
,
1410 register_cld_notifier(void)
1412 return rpc_pipefs_notifier_register(&nfsd4_cld_block
);
1416 unregister_cld_notifier(void)
1418 rpc_pipefs_notifier_unregister(&nfsd4_cld_block
);