Home | History | Annotate | Line # | Download | only in common
h_fsmacros.h revision 1.35
      1 /*	$NetBSD: h_fsmacros.h,v 1.35 2011/08/11 10:52:12 uch 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(v7fs);
     65 
     66 #ifndef FSTEST_IMGNAME
     67 #define FSTEST_IMGNAME "image.fs"
     68 #endif
     69 #ifndef FSTEST_IMGSIZE
     70 #define FSTEST_IMGSIZE (10000 * 512)
     71 #endif
     72 #ifndef FSTEST_MNTNAME
     73 #define FSTEST_MNTNAME "/mnt"
     74 #endif
     75 
     76 #define FSTEST_CONSTRUCTOR(_tc_, _fs_, _args_)				\
     77 do {									\
     78 	if (_fs_##_fstest_newfs(_tc_, &_args_,				\
     79 	    FSTEST_IMGNAME, FSTEST_IMGSIZE, NULL) != 0)			\
     80 		atf_tc_fail_errno("newfs failed");			\
     81 	if (_fs_##_fstest_mount(_tc_, _args_, FSTEST_MNTNAME, 0) != 0)	\
     82 		atf_tc_fail_errno("mount failed");			\
     83 } while (/*CONSTCOND*/0);
     84 
     85 #define FSTEST_CONSTRUCTOR_FSPRIV(_tc_, _fs_, _args_, _privargs_)	\
     86 do {									\
     87 	if (_fs_##_fstest_newfs(_tc_, &_args_,				\
     88 	    FSTEST_IMGNAME, FSTEST_IMGSIZE, _privargs_) != 0)		\
     89 		atf_tc_fail_errno("newfs failed");			\
     90 	if (_fs_##_fstest_mount(_tc_, _args_, FSTEST_MNTNAME, 0) != 0)	\
     91 		atf_tc_fail_errno("mount failed");			\
     92 } while (/*CONSTCOND*/0);
     93 
     94 #define FSTEST_DESTRUCTOR(_tc_, _fs_, _args_)				\
     95 do {									\
     96 	if (_fs_##_fstest_unmount(_tc_, FSTEST_MNTNAME, 0) != 0) {	\
     97 		rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);		\
     98 		atf_tc_fail_errno("unmount failed");			\
     99 	}								\
    100 	if (_fs_##_fstest_delfs(_tc_, _args_) != 0)			\
    101 		atf_tc_fail_errno("delfs failed");			\
    102 } while (/*CONSTCOND*/0);
    103 
    104 #define ATF_TC_FSADD(fs,type,func,desc)					\
    105 	ATF_TC(fs##_##func);						\
    106 	ATF_TC_HEAD(fs##_##func,tc)					\
    107 	{								\
    108 		atf_tc_set_md_var(tc, "descr", type " test for " desc);	\
    109 		atf_tc_set_md_var(tc, "X-fs.type", #fs);		\
    110 		atf_tc_set_md_var(tc, "X-fs.mntname", type);		\
    111 	}								\
    112 	void *fs##func##tmp;						\
    113 									\
    114 	ATF_TC_BODY(fs##_##func,tc)					\
    115 	{								\
    116 		if (!atf_check_fstype(tc, #fs))				\
    117 			atf_tc_skip("filesystem not selected");		\
    118 		FSTEST_CONSTRUCTOR(tc,fs,fs##func##tmp);		\
    119 		func(tc,FSTEST_MNTNAME);				\
    120 		if (fs##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {	\
    121 			rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);	\
    122 			atf_tc_fail_errno("unmount failed");		\
    123 		}							\
    124 	}
    125 
    126 #define ATF_TC_FSADD_RO(_fs_,_type_,_func_,_desc_,_gen_)		\
    127 	ATF_TC(_fs_##_##_func_);					\
    128 	ATF_TC_HEAD(_fs_##_##_func_,tc)					\
    129 	{								\
    130 		atf_tc_set_md_var(tc, "descr",_type_" test for "_desc_);\
    131 		atf_tc_set_md_var(tc, "X-fs.type", #_fs_);		\
    132 		atf_tc_set_md_var(tc, "X-fs.mntname", _type_);		\
    133 	}								\
    134 	void *_fs_##_func_##tmp;					\
    135 									\
    136 	ATF_TC_BODY(_fs_##_##_func_,tc)					\
    137 	{								\
    138 		if (!atf_check_fstype(tc, #_fs_))			\
    139 			atf_tc_skip("filesystem not selected");		\
    140 		FSTEST_CONSTRUCTOR(tc,_fs_,_fs_##_func_##tmp);		\
    141 		_gen_(tc,FSTEST_MNTNAME);				\
    142 		if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0)	\
    143 			atf_tc_fail_errno("unmount r/w failed");	\
    144 		if (_fs_##_fstest_mount(tc, _fs_##_func_##tmp,		\
    145 		    FSTEST_MNTNAME, MNT_RDONLY) != 0)			\
    146 		atf_tc_fail_errno("mount ro failed");			\
    147 		_func_(tc,FSTEST_MNTNAME);				\
    148 		if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {\
    149 			rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);	\
    150 			atf_tc_fail_errno("unmount failed");		\
    151 		}							\
    152 	}
    153 
    154 #define ATF_TP_FSADD(fs,func)						\
    155   ATF_TP_ADD_TC(tp,fs##_##func)
    156 
    157 #define ATF_TC_FSAPPLY(func,desc)					\
    158   ATF_TC_FSADD(ext2fs,MOUNT_EXT2FS,func,desc)				\
    159   ATF_TC_FSADD(ffs,MOUNT_FFS,func,desc)					\
    160   ATF_TC_FSADD(ffslog,MOUNT_FFS,func,desc)				\
    161   ATF_TC_FSADD(lfs,MOUNT_LFS,func,desc)					\
    162   ATF_TC_FSADD(msdosfs,MOUNT_MSDOS,func,desc)				\
    163   ATF_TC_FSADD(nfs,MOUNT_NFS,func,desc)					\
    164   ATF_TC_FSADD(puffs,MOUNT_PUFFS,func,desc)				\
    165   ATF_TC_FSADD(p2k_ffs,MOUNT_PUFFS,func,desc)				\
    166   ATF_TC_FSADD(rumpfs,MOUNT_RUMPFS,func,desc)				\
    167   ATF_TC_FSADD(sysvbfs,MOUNT_SYSVBFS,func,desc)				\
    168   ATF_TC_FSADD(tmpfs,MOUNT_TMPFS,func,desc)				\
    169   ATF_TC_FSADD(v7fs,MOUNT_V7FS,func,desc)
    170 
    171 #define ATF_TP_FSAPPLY(func)						\
    172   ATF_TP_FSADD(ext2fs,func);						\
    173   ATF_TP_FSADD(ffs,func);						\
    174   ATF_TP_FSADD(ffslog,func);						\
    175   ATF_TP_FSADD(lfs,func);						\
    176   ATF_TP_FSADD(msdosfs,func);						\
    177   ATF_TP_FSADD(nfs,func);						\
    178   ATF_TP_FSADD(puffs,func);						\
    179   ATF_TP_FSADD(p2k_ffs,func);						\
    180   ATF_TP_FSADD(rumpfs,func);						\
    181   ATF_TP_FSADD(sysvbfs,func);						\
    182   ATF_TP_FSADD(tmpfs,func);						\
    183   ATF_TP_FSADD(v7fs,func);
    184 
    185 /*
    186  * Same as above, but generate a file system image first and perform
    187  * tests for a r/o mount.
    188  *
    189  * Missing the following file systems:
    190  *   + lfs (fstest_lfs routines cannot handle remount.  FIXME!)
    191  *   + tmpfs (memory backend)
    192  *   + rumpfs (memory backend)
    193  *   + puffs (memory backend, but could be run in theory)
    194  */
    195 
    196 #define ATF_TC_FSAPPLY_RO(func,desc,gen)				\
    197   ATF_TC_FSADD_RO(ext2fs,MOUNT_EXT2FS,func,desc,gen)			\
    198   ATF_TC_FSADD_RO(ffs,MOUNT_FFS,func,desc,gen)				\
    199   ATF_TC_FSADD_RO(ffslog,MOUNT_FFS,func,desc,gen)			\
    200   ATF_TC_FSADD_RO(msdosfs,MOUNT_MSDOS,func,desc,gen)			\
    201   ATF_TC_FSADD_RO(nfs,MOUNT_NFS,func,desc,gen)				\
    202   ATF_TC_FSADD_RO(nfsro,MOUNT_NFS,func,desc,gen)			\
    203   ATF_TC_FSADD_RO(sysvbfs,MOUNT_SYSVBFS,func,desc,gen)			\
    204   ATF_TC_FSADD_RO(v7fs,MOUNT_V7FS,func,desc,gen)
    205 
    206 #define ATF_TP_FSAPPLY_RO(func)						\
    207   ATF_TP_FSADD(ext2fs,func);						\
    208   ATF_TP_FSADD(ffs,func);						\
    209   ATF_TP_FSADD(ffslog,func);						\
    210   ATF_TP_FSADD(msdosfs,func);						\
    211   ATF_TP_FSADD(nfs,func);						\
    212   ATF_TP_FSADD(nfsro,func);						\
    213   ATF_TP_FSADD(sysvbfs,func);						\
    214   ATF_TP_FSADD(v7fs,func);
    215 
    216 #define ATF_FSAPPLY(func,desc)						\
    217 	ATF_TC_FSAPPLY(func,desc);					\
    218 	ATF_TP_ADD_TCS(tp)						\
    219 	{								\
    220 		ATF_TP_FSAPPLY(func);					\
    221 		return atf_no_error();					\
    222 	}
    223 
    224 static __inline bool
    225 atf_check_fstype(const atf_tc_t *tc, const char *fs)
    226 {
    227 	const char *fstype;
    228 
    229 	if (!atf_tc_has_config_var(tc, "fstype"))
    230 		return true;
    231 
    232 	fstype = atf_tc_get_config_var(tc, "fstype");
    233 	if (strcmp(fstype, fs) == 0)
    234 		return true;
    235 	return false;
    236 }
    237 
    238 #define FSTYPE_EXT2FS(tc)\
    239     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ext2fs") == 0)
    240 #define FSTYPE_FFS(tc)\
    241     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffs") == 0)
    242 #define FSTYPE_FFSLOG(tc)\
    243     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffslog") == 0)
    244 #define FSTYPE_LFS(tc)\
    245     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "lfs") == 0)
    246 #define FSTYPE_MSDOS(tc)\
    247     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "msdosfs") == 0)
    248 #define FSTYPE_NFS(tc)\
    249     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfs") == 0)
    250 #define FSTYPE_NFSRO(tc)\
    251     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfsro") == 0)
    252 #define FSTYPE_P2K_FFS(tc)\
    253     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "p2k_ffs") == 0)
    254 #define FSTYPE_PUFFS(tc)\
    255     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "puffs") == 0)
    256 #define FSTYPE_RUMPFS(tc)\
    257     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "rumpfs") == 0)
    258 #define FSTYPE_SYSVBFS(tc)\
    259     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "sysvbfs") == 0)
    260 #define FSTYPE_TMPFS(tc)\
    261     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "tmpfs") == 0)
    262 #define FSTYPE_V7FS(tc)\
    263     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "v7fs") == 0)
    264 
    265 #define FSTEST_ENTER()							\
    266 	if (rump_sys_chdir(FSTEST_MNTNAME) == -1)			\
    267 		atf_tc_fail_errno("failed to cd into test mount")
    268 
    269 #define FSTEST_EXIT()							\
    270 	if (rump_sys_chdir("/") == -1)					\
    271 		atf_tc_fail_errno("failed to cd out of test mount")
    272 
    273 /*
    274  * file system args structures
    275  */
    276 
    277 struct nfstestargs {
    278 	pid_t ta_childpid;
    279 	char ta_ethername[MAXPATHLEN];
    280 };
    281 
    282 struct puffstestargs {
    283 	uint8_t			*pta_pargs;
    284 	size_t			pta_pargslen;
    285 
    286 	int			pta_pflags;
    287 	pid_t			pta_childpid;
    288 
    289 	int			pta_rumpfd;
    290 	int			pta_servfd;
    291 
    292 	char			pta_dev[MAXPATHLEN];
    293 	char			pta_dir[MAXPATHLEN];
    294 
    295 	int			pta_mntflags;
    296 
    297 	int			pta_vfs_toserv_ops[PUFFS_VFS_MAX];
    298 	int			pta_vn_toserv_ops[PUFFS_VN_MAX];
    299 };
    300 
    301 #endif /* __H_FSMACROS_H_ */
    302