Home | History | Annotate | Line # | Download | only in common
h_fsmacros.h revision 1.38
      1 /*	$NetBSD: h_fsmacros.h,v 1.38 2013/06/26 19:29:24 reinoud Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2010 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Nicolas Joly.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef __H_FSMACROS_H_
     33 #define __H_FSMACROS_H_
     34 
     35 #include <sys/mount.h>
     36 
     37 #include <atf-c.h>
     38 #include <puffsdump.h>
     39 #include <string.h>
     40 
     41 #include <rump/rump.h>
     42 
     43 #include "../../h_macros.h"
     44 
     45 #define FSPROTOS(_fs_)							\
     46 int _fs_##_fstest_newfs(const atf_tc_t *, void **, const char *,	\
     47 			off_t, void *);					\
     48 int _fs_##_fstest_delfs(const atf_tc_t *, void *);			\
     49 int _fs_##_fstest_mount(const atf_tc_t *, void *, const char *, int);	\
     50 int _fs_##_fstest_unmount(const atf_tc_t *, const char *, int);
     51 
     52 FSPROTOS(ext2fs);
     53 FSPROTOS(ffs);
     54 FSPROTOS(ffslog);
     55 FSPROTOS(lfs);
     56 FSPROTOS(msdosfs);
     57 FSPROTOS(nfs);
     58 FSPROTOS(nfsro);
     59 FSPROTOS(p2k_ffs);
     60 FSPROTOS(puffs);
     61 FSPROTOS(rumpfs);
     62 FSPROTOS(sysvbfs);
     63 FSPROTOS(tmpfs);
     64 FSPROTOS(udf);
     65 FSPROTOS(v7fs);
     66 FSPROTOS(zfs);
     67 
     68 #ifndef FSTEST_IMGNAME
     69 #define FSTEST_IMGNAME "image.fs"
     70 #endif
     71 #ifndef FSTEST_IMGSIZE
     72 #define FSTEST_IMGSIZE (10000 * 512)
     73 #endif
     74 #ifndef FSTEST_MNTNAME
     75 #define FSTEST_MNTNAME "/mnt"
     76 #endif
     77 
     78 #define FSTEST_CONSTRUCTOR(_tc_, _fs_, _args_)				\
     79 do {									\
     80 	if (_fs_##_fstest_newfs(_tc_, &_args_,				\
     81 	    FSTEST_IMGNAME, FSTEST_IMGSIZE, NULL) != 0)			\
     82 		atf_tc_fail_errno("newfs failed");			\
     83 	if (_fs_##_fstest_mount(_tc_, _args_, FSTEST_MNTNAME, 0) != 0)	\
     84 		atf_tc_fail_errno("mount failed");			\
     85 } while (/*CONSTCOND*/0);
     86 
     87 #define FSTEST_CONSTRUCTOR_FSPRIV(_tc_, _fs_, _args_, _privargs_)	\
     88 do {									\
     89 	if (_fs_##_fstest_newfs(_tc_, &_args_,				\
     90 	    FSTEST_IMGNAME, FSTEST_IMGSIZE, _privargs_) != 0)		\
     91 		atf_tc_fail_errno("newfs failed");			\
     92 	if (_fs_##_fstest_mount(_tc_, _args_, FSTEST_MNTNAME, 0) != 0)	\
     93 		atf_tc_fail_errno("mount failed");			\
     94 } while (/*CONSTCOND*/0);
     95 
     96 #define FSTEST_DESTRUCTOR(_tc_, _fs_, _args_)				\
     97 do {									\
     98 	if (_fs_##_fstest_unmount(_tc_, FSTEST_MNTNAME, 0) != 0) {	\
     99 		rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);		\
    100 		atf_tc_fail_errno("unmount failed");			\
    101 	}								\
    102 	if (_fs_##_fstest_delfs(_tc_, _args_) != 0)			\
    103 		atf_tc_fail_errno("delfs failed");			\
    104 } while (/*CONSTCOND*/0);
    105 
    106 #define ATF_TC_FSADD(fs,type,func,desc)					\
    107 	ATF_TC(fs##_##func);						\
    108 	ATF_TC_HEAD(fs##_##func,tc)					\
    109 	{								\
    110 		atf_tc_set_md_var(tc, "descr", type " test for " desc);	\
    111 		atf_tc_set_md_var(tc, "X-fs.type", #fs);		\
    112 		atf_tc_set_md_var(tc, "X-fs.mntname", type);		\
    113 		if (strcmp(#fs, "zfs") == 0) {				\
    114 			/* This should not be necessary. */		\
    115 			atf_tc_set_md_var(tc, "require.user", "root");	\
    116 		}							\
    117 	}								\
    118 	void *fs##func##tmp;						\
    119 									\
    120 	ATF_TC_BODY(fs##_##func,tc)					\
    121 	{								\
    122 		if (!atf_check_fstype(tc, #fs))				\
    123 			atf_tc_skip("filesystem not selected");		\
    124 		FSTEST_CONSTRUCTOR(tc,fs,fs##func##tmp);		\
    125 		func(tc,FSTEST_MNTNAME);				\
    126 		if (fs##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {	\
    127 			rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);	\
    128 			atf_tc_fail_errno("unmount failed");		\
    129 		}							\
    130 	}
    131 
    132 #define ATF_TC_FSADD_RO(_fs_,_type_,_func_,_desc_,_gen_)		\
    133 	ATF_TC(_fs_##_##_func_);					\
    134 	ATF_TC_HEAD(_fs_##_##_func_,tc)					\
    135 	{								\
    136 		atf_tc_set_md_var(tc, "descr",_type_" test for "_desc_);\
    137 		atf_tc_set_md_var(tc, "X-fs.type", #_fs_);		\
    138 		atf_tc_set_md_var(tc, "X-fs.mntname", _type_);		\
    139 		if (strcmp(#_fs_, "zfs") == 0) {			\
    140 			/* This should not be necessary. */		\
    141 			atf_tc_set_md_var(tc, "require.user", "root");	\
    142 		}							\
    143 	}								\
    144 	void *_fs_##_func_##tmp;					\
    145 									\
    146 	ATF_TC_BODY(_fs_##_##_func_,tc)					\
    147 	{								\
    148 		if (!atf_check_fstype(tc, #_fs_))			\
    149 			atf_tc_skip("filesystem not selected");		\
    150 		FSTEST_CONSTRUCTOR(tc,_fs_,_fs_##_func_##tmp);		\
    151 		_gen_(tc,FSTEST_MNTNAME);				\
    152 		if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0)	\
    153 			atf_tc_fail_errno("unmount r/w failed");	\
    154 		if (_fs_##_fstest_mount(tc, _fs_##_func_##tmp,		\
    155 		    FSTEST_MNTNAME, MNT_RDONLY) != 0)			\
    156 		atf_tc_fail_errno("mount ro failed");			\
    157 		_func_(tc,FSTEST_MNTNAME);				\
    158 		if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {\
    159 			rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);	\
    160 			atf_tc_fail_errno("unmount failed");		\
    161 		}							\
    162 	}
    163 
    164 #define ATF_TP_FSADD(fs,func)						\
    165   ATF_TP_ADD_TC(tp,fs##_##func)
    166 
    167 #define ATF_TC_FSAPPLY_NOZFS(func,desc)					\
    168   ATF_TC_FSADD(ext2fs,MOUNT_EXT2FS,func,desc)				\
    169   ATF_TC_FSADD(ffs,MOUNT_FFS,func,desc)					\
    170   ATF_TC_FSADD(ffslog,MOUNT_FFS,func,desc)				\
    171   ATF_TC_FSADD(lfs,MOUNT_LFS,func,desc)					\
    172   ATF_TC_FSADD(msdosfs,MOUNT_MSDOS,func,desc)				\
    173   ATF_TC_FSADD(nfs,MOUNT_NFS,func,desc)					\
    174   ATF_TC_FSADD(puffs,MOUNT_PUFFS,func,desc)				\
    175   ATF_TC_FSADD(p2k_ffs,MOUNT_PUFFS,func,desc)				\
    176   ATF_TC_FSADD(rumpfs,MOUNT_RUMPFS,func,desc)				\
    177   ATF_TC_FSADD(sysvbfs,MOUNT_SYSVBFS,func,desc)				\
    178   ATF_TC_FSADD(tmpfs,MOUNT_TMPFS,func,desc)				\
    179   ATF_TC_FSADD(udf,MOUNT_UDF,func,desc)				\
    180   ATF_TC_FSADD(v7fs,MOUNT_V7FS,func,desc)
    181 
    182 #define ATF_TP_FSAPPLY_NOZFS(func)					\
    183   ATF_TP_FSADD(ext2fs,func);						\
    184   ATF_TP_FSADD(ffs,func);						\
    185   ATF_TP_FSADD(ffslog,func);						\
    186   ATF_TP_FSADD(lfs,func);						\
    187   ATF_TP_FSADD(msdosfs,func);						\
    188   ATF_TP_FSADD(nfs,func);						\
    189   ATF_TP_FSADD(puffs,func);						\
    190   ATF_TP_FSADD(p2k_ffs,func);						\
    191   ATF_TP_FSADD(rumpfs,func);						\
    192   ATF_TP_FSADD(sysvbfs,func);						\
    193   ATF_TP_FSADD(tmpfs,func);						\
    194   ATF_TP_FSADD(udf,func);						\
    195   ATF_TP_FSADD(v7fs,func);
    196 
    197 /* XXX: this will not scale */
    198 #ifdef WANT_ZFS_TESTS
    199 #define ATF_TC_FSAPPLY(func,desc)					\
    200   ATF_TC_FSAPPLY_NOZFS(func,desc)					\
    201   ATF_TC_FSADD(zfs,MOUNT_ZFS,func,desc)
    202 #define ATF_TP_FSAPPLY(func)						\
    203   ATF_TP_FSAPPLY_NOZFS(func)						\
    204   ATF_TP_FSADD(zfs,func);
    205 
    206 #else /* !WANT_ZFS_TESTS */
    207 
    208 #define ATF_TC_FSAPPLY(func,desc)					\
    209   ATF_TC_FSAPPLY_NOZFS(func,desc)
    210 #define ATF_TP_FSAPPLY(func)						\
    211   ATF_TP_FSAPPLY_NOZFS(func)
    212 
    213 #endif /* WANT_ZFS_TESTS */
    214 
    215 /*
    216  * Same as above, but generate a file system image first and perform
    217  * tests for a r/o mount.
    218  *
    219  * Missing the following file systems:
    220  *   + lfs (fstest_lfs routines cannot handle remount.  FIXME!)
    221  *   + tmpfs (memory backend)
    222  *   + rumpfs (memory backend)
    223  *   + puffs (memory backend, but could be run in theory)
    224  */
    225 
    226 #define ATF_TC_FSAPPLY_RO(func,desc,gen)				\
    227   ATF_TC_FSADD_RO(ext2fs,MOUNT_EXT2FS,func,desc,gen)			\
    228   ATF_TC_FSADD_RO(ffs,MOUNT_FFS,func,desc,gen)				\
    229   ATF_TC_FSADD_RO(ffslog,MOUNT_FFS,func,desc,gen)			\
    230   ATF_TC_FSADD_RO(msdosfs,MOUNT_MSDOS,func,desc,gen)			\
    231   ATF_TC_FSADD_RO(nfs,MOUNT_NFS,func,desc,gen)				\
    232   ATF_TC_FSADD_RO(nfsro,MOUNT_NFS,func,desc,gen)			\
    233   ATF_TC_FSADD_RO(sysvbfs,MOUNT_SYSVBFS,func,desc,gen)			\
    234   ATF_TC_FSADD_RO(udf,MOUNT_UDF,func,desc,gen)			\
    235   ATF_TC_FSADD_RO(v7fs,MOUNT_V7FS,func,desc,gen)
    236 
    237 #define ATF_TP_FSAPPLY_RO(func)						\
    238   ATF_TP_FSADD(ext2fs,func);						\
    239   ATF_TP_FSADD(ffs,func);						\
    240   ATF_TP_FSADD(ffslog,func);						\
    241   ATF_TP_FSADD(msdosfs,func);						\
    242   ATF_TP_FSADD(nfs,func);						\
    243   ATF_TP_FSADD(nfsro,func);						\
    244   ATF_TP_FSADD(sysvbfs,func);						\
    245   ATF_TP_FSADD(udf,func);						\
    246   ATF_TP_FSADD(v7fs,func);
    247 
    248 #define ATF_FSAPPLY(func,desc)						\
    249 	ATF_TC_FSAPPLY(func,desc);					\
    250 	ATF_TP_ADD_TCS(tp)						\
    251 	{								\
    252 		ATF_TP_FSAPPLY(func);					\
    253 		return atf_no_error();					\
    254 	}
    255 
    256 static __inline bool
    257 atf_check_fstype(const atf_tc_t *tc, const char *fs)
    258 {
    259 	const char *fstype;
    260 
    261 	if (!atf_tc_has_config_var(tc, "fstype"))
    262 		return true;
    263 
    264 	fstype = atf_tc_get_config_var(tc, "fstype");
    265 	if (strcmp(fstype, fs) == 0)
    266 		return true;
    267 	return false;
    268 }
    269 
    270 #define FSTYPE_EXT2FS(tc)\
    271     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ext2fs") == 0)
    272 #define FSTYPE_FFS(tc)\
    273     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffs") == 0)
    274 #define FSTYPE_FFSLOG(tc)\
    275     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffslog") == 0)
    276 #define FSTYPE_LFS(tc)\
    277     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "lfs") == 0)
    278 #define FSTYPE_MSDOS(tc)\
    279     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "msdosfs") == 0)
    280 #define FSTYPE_NFS(tc)\
    281     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfs") == 0)
    282 #define FSTYPE_NFSRO(tc)\
    283     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfsro") == 0)
    284 #define FSTYPE_P2K_FFS(tc)\
    285     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "p2k_ffs") == 0)
    286 #define FSTYPE_PUFFS(tc)\
    287     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "puffs") == 0)
    288 #define FSTYPE_RUMPFS(tc)\
    289     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "rumpfs") == 0)
    290 #define FSTYPE_SYSVBFS(tc)\
    291     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "sysvbfs") == 0)
    292 #define FSTYPE_TMPFS(tc)\
    293     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "tmpfs") == 0)
    294 #define FSTYPE_UDF(tc)\
    295     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "udf") == 0)
    296 #define FSTYPE_V7FS(tc)\
    297     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "v7fs") == 0)
    298 #define FSTYPE_ZFS(tc)\
    299     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "zfs") == 0)
    300 
    301 #define FSTEST_ENTER()							\
    302 	if (rump_sys_chdir(FSTEST_MNTNAME) == -1)			\
    303 		atf_tc_fail_errno("failed to cd into test mount")
    304 
    305 #define FSTEST_EXIT()							\
    306 	if (rump_sys_chdir("/") == -1)					\
    307 		atf_tc_fail_errno("failed to cd out of test mount")
    308 
    309 /*
    310  * file system args structures
    311  */
    312 
    313 struct nfstestargs {
    314 	pid_t ta_childpid;
    315 	char ta_ethername[MAXPATHLEN];
    316 };
    317 
    318 struct puffstestargs {
    319 	uint8_t			*pta_pargs;
    320 	size_t			pta_pargslen;
    321 
    322 	int			pta_pflags;
    323 	pid_t			pta_childpid;
    324 
    325 	int			pta_rumpfd;
    326 	int			pta_servfd;
    327 
    328 	char			pta_dev[MAXPATHLEN];
    329 	char			pta_dir[MAXPATHLEN];
    330 
    331 	int			pta_mntflags;
    332 
    333 	int			pta_vfs_toserv_ops[PUFFS_VFS_MAX];
    334 	int			pta_vn_toserv_ops[PUFFS_VN_MAX];
    335 };
    336 
    337 #endif /* __H_FSMACROS_H_ */
    338