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
;
244 nfsd4_build_namelist(void *arg
, const char *name
, int namlen
,
245 loff_t offset
, u64 ino
, unsigned int d_type
)
247 struct list_head
*names
= arg
;
248 struct name_list
*entry
;
250 if (namlen
!= HEXDIR_LEN
- 1)
252 entry
= kmalloc(sizeof(struct name_list
), GFP_KERNEL
);
255 memcpy(entry
->name
, name
, HEXDIR_LEN
- 1);
256 entry
->name
[HEXDIR_LEN
- 1] = '\0';
257 list_add(&entry
->list
, names
);
262 nfsd4_list_rec_dir(recdir_func
*f
, struct nfsd_net
*nn
)
264 const struct cred
*original_cred
;
265 struct dentry
*dir
= nn
->rec_file
->f_path
.dentry
;
267 struct dir_context ctx
;
268 struct list_head names
;
272 status
= nfs4_save_creds(&original_cred
);
276 status
= vfs_llseek(nn
->rec_file
, 0, SEEK_SET
);
278 nfs4_reset_creds(original_cred
);
282 INIT_LIST_HEAD(&ctx
.names
);
283 ctx
.ctx
.actor
= nfsd4_build_namelist
;
284 status
= iterate_dir(nn
->rec_file
, &ctx
.ctx
);
285 mutex_lock_nested(&dir
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
286 while (!list_empty(&ctx
.names
)) {
287 struct name_list
*entry
;
288 entry
= list_entry(ctx
.names
.next
, struct name_list
, list
);
290 struct dentry
*dentry
;
291 dentry
= lookup_one_len(entry
->name
, dir
, HEXDIR_LEN
-1);
292 if (IS_ERR(dentry
)) {
293 status
= PTR_ERR(dentry
);
296 status
= f(dir
, dentry
, nn
);
299 list_del(&entry
->list
);
302 mutex_unlock(&dir
->d_inode
->i_mutex
);
303 nfs4_reset_creds(original_cred
);
308 nfsd4_unlink_clid_dir(char *name
, int namlen
, struct nfsd_net
*nn
)
310 struct dentry
*dir
, *dentry
;
313 dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen
, name
);
315 dir
= nn
->rec_file
->f_path
.dentry
;
316 mutex_lock_nested(&dir
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
317 dentry
= lookup_one_len(name
, dir
, namlen
);
318 if (IS_ERR(dentry
)) {
319 status
= PTR_ERR(dentry
);
323 if (!dentry
->d_inode
)
325 status
= vfs_rmdir(dir
->d_inode
, dentry
);
329 mutex_unlock(&dir
->d_inode
->i_mutex
);
334 nfsd4_remove_clid_dir(struct nfs4_client
*clp
)
336 const struct cred
*original_cred
;
337 struct nfs4_client_reclaim
*crp
;
338 char dname
[HEXDIR_LEN
];
340 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
342 if (!nn
->rec_file
|| !test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
345 status
= nfs4_make_rec_clidname(dname
, &clp
->cl_name
);
347 return legacy_recdir_name_error(clp
, status
);
349 status
= mnt_want_write_file(nn
->rec_file
);
352 clear_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
354 status
= nfs4_save_creds(&original_cred
);
358 status
= nfsd4_unlink_clid_dir(dname
, HEXDIR_LEN
-1, nn
);
359 nfs4_reset_creds(original_cred
);
361 vfs_fsync(nn
->rec_file
, 0);
363 /* remove reclaim record */
364 crp
= nfsd4_find_reclaim_client(dname
, nn
);
366 nfs4_remove_reclaim_record(crp
, nn
);
370 mnt_drop_write_file(nn
->rec_file
);
373 printk("NFSD: Failed to remove expired client state directory"
374 " %.*s\n", HEXDIR_LEN
, dname
);
378 purge_old(struct dentry
*parent
, struct dentry
*child
, struct nfsd_net
*nn
)
382 if (nfs4_has_reclaimed_state(child
->d_name
.name
, nn
))
385 status
= vfs_rmdir(parent
->d_inode
, child
);
387 printk("failed to remove client recovery directory %s\n",
389 /* Keep trying, success or failure: */
394 nfsd4_recdir_purge_old(struct nfsd_net
*nn
, time_t boot_time
)
398 nn
->in_grace
= false;
401 status
= mnt_want_write_file(nn
->rec_file
);
404 status
= nfsd4_list_rec_dir(purge_old
, nn
);
406 vfs_fsync(nn
->rec_file
, 0);
407 mnt_drop_write_file(nn
->rec_file
);
409 nfs4_release_reclaim(nn
);
411 printk("nfsd4: failed to purge old clients from recovery"
412 " directory %s\n", nn
->rec_file
->f_path
.dentry
->d_name
.name
);
416 load_recdir(struct dentry
*parent
, struct dentry
*child
, struct nfsd_net
*nn
)
418 if (child
->d_name
.len
!= HEXDIR_LEN
- 1) {
419 printk("nfsd4: illegal name %s in recovery directory\n",
421 /* Keep trying; maybe the others are OK: */
424 nfs4_client_to_reclaim(child
->d_name
.name
, nn
);
429 nfsd4_recdir_load(struct net
*net
) {
431 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
436 status
= nfsd4_list_rec_dir(load_recdir
, nn
);
438 printk("nfsd4: failed loading clients from recovery"
439 " directory %s\n", nn
->rec_file
->f_path
.dentry
->d_name
.name
);
444 * Hold reference to the recovery directory.
448 nfsd4_init_recdir(struct net
*net
)
450 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
451 const struct cred
*original_cred
;
454 printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
455 user_recovery_dirname
);
457 BUG_ON(nn
->rec_file
);
459 status
= nfs4_save_creds(&original_cred
);
461 printk("NFSD: Unable to change credentials to find recovery"
462 " directory: error %d\n",
467 nn
->rec_file
= filp_open(user_recovery_dirname
, O_RDONLY
| O_DIRECTORY
, 0);
468 if (IS_ERR(nn
->rec_file
)) {
469 printk("NFSD: unable to find recovery directory %s\n",
470 user_recovery_dirname
);
471 status
= PTR_ERR(nn
->rec_file
);
475 nfs4_reset_creds(original_cred
);
483 nfs4_legacy_state_init(struct net
*net
)
485 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
488 nn
->reclaim_str_hashtbl
= kmalloc(sizeof(struct list_head
) *
489 CLIENT_HASH_SIZE
, GFP_KERNEL
);
490 if (!nn
->reclaim_str_hashtbl
)
493 for (i
= 0; i
< CLIENT_HASH_SIZE
; i
++)
494 INIT_LIST_HEAD(&nn
->reclaim_str_hashtbl
[i
]);
495 nn
->reclaim_str_hashtbl_size
= 0;
501 nfs4_legacy_state_shutdown(struct net
*net
)
503 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
505 kfree(nn
->reclaim_str_hashtbl
);
509 nfsd4_load_reboot_recovery_data(struct net
*net
)
513 status
= nfsd4_init_recdir(net
);
515 status
= nfsd4_recdir_load(net
);
517 printk(KERN_ERR
"NFSD: Failure reading reboot recovery data\n");
522 nfsd4_legacy_tracking_init(struct net
*net
)
526 /* XXX: The legacy code won't work in a container */
527 if (net
!= &init_net
) {
528 WARN(1, KERN_ERR
"NFSD: attempt to initialize legacy client "
529 "tracking in a container!\n");
533 status
= nfs4_legacy_state_init(net
);
537 status
= nfsd4_load_reboot_recovery_data(net
);
543 nfs4_legacy_state_shutdown(net
);
548 nfsd4_shutdown_recdir(struct nfsd_net
*nn
)
557 nfsd4_legacy_tracking_exit(struct net
*net
)
559 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
561 nfs4_release_reclaim(nn
);
562 nfsd4_shutdown_recdir(nn
);
563 nfs4_legacy_state_shutdown(net
);
567 * Change the NFSv4 recovery directory to recdir.
570 nfs4_reset_recoverydir(char *recdir
)
575 status
= kern_path(recdir
, LOOKUP_FOLLOW
, &path
);
579 if (S_ISDIR(path
.dentry
->d_inode
->i_mode
)) {
580 strcpy(user_recovery_dirname
, recdir
);
588 nfs4_recoverydir(void)
590 return user_recovery_dirname
;
594 nfsd4_check_legacy_client(struct nfs4_client
*clp
)
597 char dname
[HEXDIR_LEN
];
598 struct nfs4_client_reclaim
*crp
;
599 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
601 /* did we already find that this client is stable? */
602 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
605 status
= nfs4_make_rec_clidname(dname
, &clp
->cl_name
);
607 legacy_recdir_name_error(clp
, status
);
611 /* look for it in the reclaim hashtable otherwise */
612 crp
= nfsd4_find_reclaim_client(dname
, nn
);
614 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
622 static struct nfsd4_client_tracking_ops nfsd4_legacy_tracking_ops
= {
623 .init
= nfsd4_legacy_tracking_init
,
624 .exit
= nfsd4_legacy_tracking_exit
,
625 .create
= nfsd4_create_clid_dir
,
626 .remove
= nfsd4_remove_clid_dir
,
627 .check
= nfsd4_check_legacy_client
,
628 .grace_done
= nfsd4_recdir_purge_old
,
632 #define NFSD_PIPE_DIR "nfsd"
633 #define NFSD_CLD_PIPE "cld"
635 /* per-net-ns structure for holding cld upcall info */
637 struct rpc_pipe
*cn_pipe
;
639 struct list_head cn_list
;
644 struct list_head cu_list
;
645 struct cld_net
*cu_net
;
646 struct task_struct
*cu_task
;
647 struct cld_msg cu_msg
;
651 __cld_pipe_upcall(struct rpc_pipe
*pipe
, struct cld_msg
*cmsg
)
654 struct rpc_pipe_msg msg
;
656 memset(&msg
, 0, sizeof(msg
));
658 msg
.len
= sizeof(*cmsg
);
661 * Set task state before we queue the upcall. That prevents
662 * wake_up_process in the downcall from racing with schedule.
664 set_current_state(TASK_UNINTERRUPTIBLE
);
665 ret
= rpc_queue_upcall(pipe
, &msg
);
667 set_current_state(TASK_RUNNING
);
672 set_current_state(TASK_RUNNING
);
681 cld_pipe_upcall(struct rpc_pipe
*pipe
, struct cld_msg
*cmsg
)
686 * -EAGAIN occurs when pipe is closed and reopened while there are
690 ret
= __cld_pipe_upcall(pipe
, cmsg
);
691 } while (ret
== -EAGAIN
);
697 cld_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
699 struct cld_upcall
*tmp
, *cup
;
700 struct cld_msg __user
*cmsg
= (struct cld_msg __user
*)src
;
702 struct nfsd_net
*nn
= net_generic(filp
->f_dentry
->d_sb
->s_fs_info
,
704 struct cld_net
*cn
= nn
->cld_net
;
706 if (mlen
!= sizeof(*cmsg
)) {
707 dprintk("%s: got %zu bytes, expected %zu\n", __func__
, mlen
,
712 /* copy just the xid so we can try to find that */
713 if (copy_from_user(&xid
, &cmsg
->cm_xid
, sizeof(xid
)) != 0) {
714 dprintk("%s: error when copying xid from userspace", __func__
);
718 /* walk the list and find corresponding xid */
720 spin_lock(&cn
->cn_lock
);
721 list_for_each_entry(tmp
, &cn
->cn_list
, cu_list
) {
722 if (get_unaligned(&tmp
->cu_msg
.cm_xid
) == xid
) {
724 list_del_init(&cup
->cu_list
);
728 spin_unlock(&cn
->cn_lock
);
730 /* couldn't find upcall? */
732 dprintk("%s: couldn't find upcall -- xid=%u\n", __func__
, xid
);
736 if (copy_from_user(&cup
->cu_msg
, src
, mlen
) != 0)
739 wake_up_process(cup
->cu_task
);
744 cld_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
746 struct cld_msg
*cmsg
= msg
->data
;
747 struct cld_upcall
*cup
= container_of(cmsg
, struct cld_upcall
,
750 /* errno >= 0 means we got a downcall */
754 wake_up_process(cup
->cu_task
);
757 static const struct rpc_pipe_ops cld_upcall_ops
= {
758 .upcall
= rpc_pipe_generic_upcall
,
759 .downcall
= cld_pipe_downcall
,
760 .destroy_msg
= cld_pipe_destroy_msg
,
763 static struct dentry
*
764 nfsd4_cld_register_sb(struct super_block
*sb
, struct rpc_pipe
*pipe
)
766 struct dentry
*dir
, *dentry
;
768 dir
= rpc_d_lookup_sb(sb
, NFSD_PIPE_DIR
);
770 return ERR_PTR(-ENOENT
);
771 dentry
= rpc_mkpipe_dentry(dir
, NFSD_CLD_PIPE
, NULL
, pipe
);
777 nfsd4_cld_unregister_sb(struct rpc_pipe
*pipe
)
780 rpc_unlink(pipe
->dentry
);
783 static struct dentry
*
784 nfsd4_cld_register_net(struct net
*net
, struct rpc_pipe
*pipe
)
786 struct super_block
*sb
;
787 struct dentry
*dentry
;
789 sb
= rpc_get_sb_net(net
);
792 dentry
= nfsd4_cld_register_sb(sb
, pipe
);
798 nfsd4_cld_unregister_net(struct net
*net
, struct rpc_pipe
*pipe
)
800 struct super_block
*sb
;
802 sb
= rpc_get_sb_net(net
);
804 nfsd4_cld_unregister_sb(pipe
);
809 /* Initialize rpc_pipefs pipe for communication with client tracking daemon */
811 nfsd4_init_cld_pipe(struct net
*net
)
814 struct dentry
*dentry
;
815 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
821 cn
= kzalloc(sizeof(*cn
), GFP_KERNEL
);
827 cn
->cn_pipe
= rpc_mkpipe_data(&cld_upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
828 if (IS_ERR(cn
->cn_pipe
)) {
829 ret
= PTR_ERR(cn
->cn_pipe
);
832 spin_lock_init(&cn
->cn_lock
);
833 INIT_LIST_HEAD(&cn
->cn_list
);
835 dentry
= nfsd4_cld_register_net(net
, cn
->cn_pipe
);
836 if (IS_ERR(dentry
)) {
837 ret
= PTR_ERR(dentry
);
838 goto err_destroy_data
;
841 cn
->cn_pipe
->dentry
= dentry
;
846 rpc_destroy_pipe_data(cn
->cn_pipe
);
849 printk(KERN_ERR
"NFSD: unable to create nfsdcld upcall pipe (%d)\n",
855 nfsd4_remove_cld_pipe(struct net
*net
)
857 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
858 struct cld_net
*cn
= nn
->cld_net
;
860 nfsd4_cld_unregister_net(net
, cn
->cn_pipe
);
861 rpc_destroy_pipe_data(cn
->cn_pipe
);
866 static struct cld_upcall
*
867 alloc_cld_upcall(struct cld_net
*cn
)
869 struct cld_upcall
*new, *tmp
;
871 new = kzalloc(sizeof(*new), GFP_KERNEL
);
875 /* FIXME: hard cap on number in flight? */
877 spin_lock(&cn
->cn_lock
);
878 list_for_each_entry(tmp
, &cn
->cn_list
, cu_list
) {
879 if (tmp
->cu_msg
.cm_xid
== cn
->cn_xid
) {
881 spin_unlock(&cn
->cn_lock
);
885 new->cu_task
= current
;
886 new->cu_msg
.cm_vers
= CLD_UPCALL_VERSION
;
887 put_unaligned(cn
->cn_xid
++, &new->cu_msg
.cm_xid
);
889 list_add(&new->cu_list
, &cn
->cn_list
);
890 spin_unlock(&cn
->cn_lock
);
892 dprintk("%s: allocated xid %u\n", __func__
, new->cu_msg
.cm_xid
);
898 free_cld_upcall(struct cld_upcall
*victim
)
900 struct cld_net
*cn
= victim
->cu_net
;
902 spin_lock(&cn
->cn_lock
);
903 list_del(&victim
->cu_list
);
904 spin_unlock(&cn
->cn_lock
);
908 /* Ask daemon to create a new record */
910 nfsd4_cld_create(struct nfs4_client
*clp
)
913 struct cld_upcall
*cup
;
914 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
915 struct cld_net
*cn
= nn
->cld_net
;
917 /* Don't upcall if it's already stored */
918 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
921 cup
= alloc_cld_upcall(cn
);
927 cup
->cu_msg
.cm_cmd
= Cld_Create
;
928 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
929 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
932 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
934 ret
= cup
->cu_msg
.cm_status
;
935 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
938 free_cld_upcall(cup
);
941 printk(KERN_ERR
"NFSD: Unable to create client "
942 "record on stable storage: %d\n", ret
);
945 /* Ask daemon to create a new record */
947 nfsd4_cld_remove(struct nfs4_client
*clp
)
950 struct cld_upcall
*cup
;
951 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
952 struct cld_net
*cn
= nn
->cld_net
;
954 /* Don't upcall if it's already removed */
955 if (!test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
958 cup
= alloc_cld_upcall(cn
);
964 cup
->cu_msg
.cm_cmd
= Cld_Remove
;
965 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
966 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
969 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
971 ret
= cup
->cu_msg
.cm_status
;
972 clear_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
975 free_cld_upcall(cup
);
978 printk(KERN_ERR
"NFSD: Unable to remove client "
979 "record from stable storage: %d\n", ret
);
982 /* Check for presence of a record, and update its timestamp */
984 nfsd4_cld_check(struct nfs4_client
*clp
)
987 struct cld_upcall
*cup
;
988 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
989 struct cld_net
*cn
= nn
->cld_net
;
991 /* Don't upcall if one was already stored during this grace pd */
992 if (test_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
))
995 cup
= alloc_cld_upcall(cn
);
997 printk(KERN_ERR
"NFSD: Unable to check client record on "
998 "stable storage: %d\n", -ENOMEM
);
1002 cup
->cu_msg
.cm_cmd
= Cld_Check
;
1003 cup
->cu_msg
.cm_u
.cm_name
.cn_len
= clp
->cl_name
.len
;
1004 memcpy(cup
->cu_msg
.cm_u
.cm_name
.cn_id
, clp
->cl_name
.data
,
1007 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
1009 ret
= cup
->cu_msg
.cm_status
;
1010 set_bit(NFSD4_CLIENT_STABLE
, &clp
->cl_flags
);
1013 free_cld_upcall(cup
);
1018 nfsd4_cld_grace_done(struct nfsd_net
*nn
, time_t boot_time
)
1021 struct cld_upcall
*cup
;
1022 struct cld_net
*cn
= nn
->cld_net
;
1024 cup
= alloc_cld_upcall(cn
);
1030 cup
->cu_msg
.cm_cmd
= Cld_GraceDone
;
1031 cup
->cu_msg
.cm_u
.cm_gracetime
= (int64_t)boot_time
;
1032 ret
= cld_pipe_upcall(cn
->cn_pipe
, &cup
->cu_msg
);
1034 ret
= cup
->cu_msg
.cm_status
;
1036 free_cld_upcall(cup
);
1039 printk(KERN_ERR
"NFSD: Unable to end grace period: %d\n", ret
);
1042 static struct nfsd4_client_tracking_ops nfsd4_cld_tracking_ops
= {
1043 .init
= nfsd4_init_cld_pipe
,
1044 .exit
= nfsd4_remove_cld_pipe
,
1045 .create
= nfsd4_cld_create
,
1046 .remove
= nfsd4_cld_remove
,
1047 .check
= nfsd4_cld_check
,
1048 .grace_done
= nfsd4_cld_grace_done
,
1051 /* upcall via usermodehelper */
1052 static char cltrack_prog
[PATH_MAX
] = "/sbin/nfsdcltrack";
1053 module_param_string(cltrack_prog
, cltrack_prog
, sizeof(cltrack_prog
),
1055 MODULE_PARM_DESC(cltrack_prog
, "Path to the nfsdcltrack upcall program");
1057 static bool cltrack_legacy_disable
;
1058 module_param(cltrack_legacy_disable
, bool, S_IRUGO
|S_IWUSR
);
1059 MODULE_PARM_DESC(cltrack_legacy_disable
,
1060 "Disable legacy recoverydir conversion. Default: false");
1062 #define LEGACY_TOPDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_TOPDIR="
1063 #define LEGACY_RECDIR_ENV_PREFIX "NFSDCLTRACK_LEGACY_RECDIR="
1066 nfsd4_cltrack_legacy_topdir(void)
1072 if (cltrack_legacy_disable
)
1075 len
= strlen(LEGACY_TOPDIR_ENV_PREFIX
) +
1076 strlen(nfs4_recoverydir()) + 1;
1078 result
= kmalloc(len
, GFP_KERNEL
);
1082 copied
= snprintf(result
, len
, LEGACY_TOPDIR_ENV_PREFIX
"%s",
1083 nfs4_recoverydir());
1084 if (copied
>= len
) {
1085 /* just return nothing if output was truncated */
1094 nfsd4_cltrack_legacy_recdir(const struct xdr_netobj
*name
)
1100 if (cltrack_legacy_disable
)
1103 /* +1 is for '/' between "topdir" and "recdir" */
1104 len
= strlen(LEGACY_RECDIR_ENV_PREFIX
) +
1105 strlen(nfs4_recoverydir()) + 1 + HEXDIR_LEN
;
1107 result
= kmalloc(len
, GFP_KERNEL
);
1111 copied
= snprintf(result
, len
, LEGACY_RECDIR_ENV_PREFIX
"%s/",
1112 nfs4_recoverydir());
1113 if (copied
> (len
- HEXDIR_LEN
)) {
1114 /* just return nothing if output will be truncated */
1119 copied
= nfs4_make_rec_clidname(result
+ copied
, name
);
1129 nfsd4_umh_cltrack_upcall(char *cmd
, char *arg
, char *legacy
)
1135 if (unlikely(!cltrack_prog
[0])) {
1136 dprintk("%s: cltrack_prog is disabled\n", __func__
);
1140 dprintk("%s: cmd: %s\n", __func__
, cmd
);
1141 dprintk("%s: arg: %s\n", __func__
, arg
? arg
: "(null)");
1142 dprintk("%s: legacy: %s\n", __func__
, legacy
? legacy
: "(null)");
1147 argv
[0] = (char *)cltrack_prog
;
1152 ret
= call_usermodehelper(argv
[0], argv
, envp
, UMH_WAIT_PROC
);
1154 * Disable the upcall mechanism if we're getting an ENOENT or EACCES
1155 * error. The admin can re-enable it on the fly by using sysfs
1156 * once the problem has been fixed.
1158 if (ret
== -ENOENT
|| ret
== -EACCES
) {
1159 dprintk("NFSD: %s was not found or isn't executable (%d). "
1160 "Setting cltrack_prog to blank string!",
1162 cltrack_prog
[0] = '\0';
1164 dprintk("%s: %s return value: %d\n", __func__
, cltrack_prog
, ret
);
1170 bin_to_hex_dup(const unsigned char *src
, int srclen
)
1175 /* +1 for terminating NULL */
1176 buf
= kmalloc((srclen
* 2) + 1, GFP_KERNEL
);
1181 for (i
= 0; i
< srclen
; i
++) {
1182 sprintf(hex
, "%2.2x", *src
++);
1189 nfsd4_umh_cltrack_init(struct net
__attribute__((unused
)) *net
)
1191 /* XXX: The usermode helper s not working in container yet. */
1192 if (net
!= &init_net
) {
1193 WARN(1, KERN_ERR
"NFSD: attempt to initialize umh client "
1194 "tracking in a container!\n");
1197 return nfsd4_umh_cltrack_upcall("init", NULL
, NULL
);
1201 nfsd4_umh_cltrack_create(struct nfs4_client
*clp
)
1205 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1207 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1210 nfsd4_umh_cltrack_upcall("create", hexid
, NULL
);
1215 nfsd4_umh_cltrack_remove(struct nfs4_client
*clp
)
1219 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1221 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1224 nfsd4_umh_cltrack_upcall("remove", hexid
, NULL
);
1229 nfsd4_umh_cltrack_check(struct nfs4_client
*clp
)
1232 char *hexid
, *legacy
;
1234 hexid
= bin_to_hex_dup(clp
->cl_name
.data
, clp
->cl_name
.len
);
1236 dprintk("%s: can't allocate memory for upcall!\n", __func__
);
1239 legacy
= nfsd4_cltrack_legacy_recdir(&clp
->cl_name
);
1240 ret
= nfsd4_umh_cltrack_upcall("check", hexid
, legacy
);
1247 nfsd4_umh_cltrack_grace_done(struct nfsd_net
__attribute__((unused
)) *nn
,
1251 char timestr
[22]; /* FIXME: better way to determine max size? */
1253 sprintf(timestr
, "%ld", boot_time
);
1254 legacy
= nfsd4_cltrack_legacy_topdir();
1255 nfsd4_umh_cltrack_upcall("gracedone", timestr
, legacy
);
1259 static struct nfsd4_client_tracking_ops nfsd4_umh_tracking_ops
= {
1260 .init
= nfsd4_umh_cltrack_init
,
1262 .create
= nfsd4_umh_cltrack_create
,
1263 .remove
= nfsd4_umh_cltrack_remove
,
1264 .check
= nfsd4_umh_cltrack_check
,
1265 .grace_done
= nfsd4_umh_cltrack_grace_done
,
1269 nfsd4_client_tracking_init(struct net
*net
)
1273 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1275 /* just run the init if it the method is already decided */
1276 if (nn
->client_tracking_ops
)
1280 * First, try a UMH upcall. It should succeed or fail quickly, so
1281 * there's little harm in trying that first.
1283 nn
->client_tracking_ops
= &nfsd4_umh_tracking_ops
;
1284 status
= nn
->client_tracking_ops
->init(net
);
1289 * See if the recoverydir exists and is a directory. If it is,
1290 * then use the legacy ops.
1292 nn
->client_tracking_ops
= &nfsd4_legacy_tracking_ops
;
1293 status
= kern_path(nfs4_recoverydir(), LOOKUP_FOLLOW
, &path
);
1295 status
= S_ISDIR(path
.dentry
->d_inode
->i_mode
);
1301 /* Finally, try to use nfsdcld */
1302 nn
->client_tracking_ops
= &nfsd4_cld_tracking_ops
;
1303 printk(KERN_WARNING
"NFSD: the nfsdcld client tracking upcall will be "
1304 "removed in 3.10. Please transition to using "
1307 status
= nn
->client_tracking_ops
->init(net
);
1309 printk(KERN_WARNING
"NFSD: Unable to initialize client "
1310 "recovery tracking! (%d)\n", status
);
1311 nn
->client_tracking_ops
= NULL
;
1317 nfsd4_client_tracking_exit(struct net
*net
)
1319 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1321 if (nn
->client_tracking_ops
) {
1322 if (nn
->client_tracking_ops
->exit
)
1323 nn
->client_tracking_ops
->exit(net
);
1324 nn
->client_tracking_ops
= NULL
;
1329 nfsd4_client_record_create(struct nfs4_client
*clp
)
1331 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1333 if (nn
->client_tracking_ops
)
1334 nn
->client_tracking_ops
->create(clp
);
1338 nfsd4_client_record_remove(struct nfs4_client
*clp
)
1340 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1342 if (nn
->client_tracking_ops
)
1343 nn
->client_tracking_ops
->remove(clp
);
1347 nfsd4_client_record_check(struct nfs4_client
*clp
)
1349 struct nfsd_net
*nn
= net_generic(clp
->net
, nfsd_net_id
);
1351 if (nn
->client_tracking_ops
)
1352 return nn
->client_tracking_ops
->check(clp
);
1358 nfsd4_record_grace_done(struct nfsd_net
*nn
, time_t boot_time
)
1360 if (nn
->client_tracking_ops
)
1361 nn
->client_tracking_ops
->grace_done(nn
, boot_time
);
1365 rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
, void *ptr
)
1367 struct super_block
*sb
= ptr
;
1368 struct net
*net
= sb
->s_fs_info
;
1369 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1370 struct cld_net
*cn
= nn
->cld_net
;
1371 struct dentry
*dentry
;
1374 if (!try_module_get(THIS_MODULE
))
1378 module_put(THIS_MODULE
);
1383 case RPC_PIPEFS_MOUNT
:
1384 dentry
= nfsd4_cld_register_sb(sb
, cn
->cn_pipe
);
1385 if (IS_ERR(dentry
)) {
1386 ret
= PTR_ERR(dentry
);
1389 cn
->cn_pipe
->dentry
= dentry
;
1391 case RPC_PIPEFS_UMOUNT
:
1392 if (cn
->cn_pipe
->dentry
)
1393 nfsd4_cld_unregister_sb(cn
->cn_pipe
);
1399 module_put(THIS_MODULE
);
1403 static struct notifier_block nfsd4_cld_block
= {
1404 .notifier_call
= rpc_pipefs_event
,
1408 register_cld_notifier(void)
1410 return rpc_pipefs_notifier_register(&nfsd4_cld_block
);
1414 unregister_cld_notifier(void)
1416 rpc_pipefs_notifier_unregister(&nfsd4_cld_block
);