contrib/netbsd-tests/fs/common/h_fsmacros.h

   1 /*      $NetBSD: h_fsmacros.h,v 1.41 2017/01/13 21:30:39 christos 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         }                                                               \
 114         void *fs##func##tmp;                                            \
 115                                                                         \
 116         ATF_TC_BODY(fs##_##func,tc)                                     \
 117         {                                                               \
 118                 if (!atf_check_fstype(tc, #fs))                         \
 119                         atf_tc_skip("filesystem not selected");         \
 120                 FSTEST_CONSTRUCTOR(tc,fs,fs##func##tmp);                \
 121                 func(tc,FSTEST_MNTNAME);                                \
 122                 if (fs##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {  \
 123                         rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);    \
 124                         atf_tc_fail_errno("unmount failed");            \
 125                 }                                                       \
 126         }
 127
 128 #define ATF_TC_FSADD_RO(_fs_,_type_,_func_,_desc_,_gen_)                \
 129         ATF_TC(_fs_##_##_func_);                                        \
 130         ATF_TC_HEAD(_fs_##_##_func_,tc)                                 \
 131         {                                                               \
 132                 atf_tc_set_md_var(tc, "descr",_type_" test for "_desc_);\
 133                 atf_tc_set_md_var(tc, "X-fs.type", #_fs_);              \
 134                 atf_tc_set_md_var(tc, "X-fs.mntname", _type_);          \
 135         }                                                               \
 136         void *_fs_##_func_##tmp;                                        \
 137                                                                         \
 138         ATF_TC_BODY(_fs_##_##_func_,tc)                                 \
 139         {                                                               \
 140                 if (!atf_check_fstype(tc, #_fs_))                       \
 141                         atf_tc_skip("filesystem not selected");         \
 142                 FSTEST_CONSTRUCTOR(tc,_fs_,_fs_##_func_##tmp);          \
 143                 _gen_(tc,FSTEST_MNTNAME);                               \
 144                 if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0)  \
 145                         atf_tc_fail_errno("unmount r/w failed");        \
 146                 if (_fs_##_fstest_mount(tc, _fs_##_func_##tmp,          \
 147                     FSTEST_MNTNAME, MNT_RDONLY) != 0)                   \
 148                         atf_tc_fail_errno("mount ro failed");           \
 149                 _func_(tc,FSTEST_MNTNAME);                              \
 150                 if (_fs_##_fstest_unmount(tc, FSTEST_MNTNAME, 0) != 0) {\
 151                         rump_pub_vfs_mount_print(FSTEST_MNTNAME, 1);    \
 152                         atf_tc_fail_errno("unmount failed");            \
 153                 }                                                       \
 154         }
 155
 156 #define ATF_TP_FSADD(fs,func)                                           \
 157   ATF_TP_ADD_TC(tp,fs##_##func)
 158
 159 #define ATF_TC_FSAPPLY_NOZFS(func,desc)                                 \
 160   ATF_TC_FSADD(ext2fs,MOUNT_EXT2FS,func,desc)                           \
 161   ATF_TC_FSADD(ffs,MOUNT_FFS,func,desc)                                 \
 162   ATF_TC_FSADD(ffslog,MOUNT_FFS,func,desc)                              \
 163   ATF_TC_FSADD(lfs,MOUNT_LFS,func,desc)                                 \
 164   ATF_TC_FSADD(msdosfs,MOUNT_MSDOS,func,desc)                           \
 165   ATF_TC_FSADD(nfs,MOUNT_NFS,func,desc)                                 \
 166   ATF_TC_FSADD(puffs,MOUNT_PUFFS,func,desc)                             \
 167   ATF_TC_FSADD(p2k_ffs,MOUNT_PUFFS,func,desc)                           \
 168   ATF_TC_FSADD(rumpfs,MOUNT_RUMPFS,func,desc)                           \
 169   ATF_TC_FSADD(sysvbfs,MOUNT_SYSVBFS,func,desc)                         \
 170   ATF_TC_FSADD(tmpfs,MOUNT_TMPFS,func,desc)                             \
 171   ATF_TC_FSADD(udf,MOUNT_UDF,func,desc)                         \
 172   ATF_TC_FSADD(v7fs,MOUNT_V7FS,func,desc)
 173
 174 #define ATF_TP_FSAPPLY_NOZFS(func)                                      \
 175   ATF_TP_FSADD(ext2fs,func);                                            \
 176   ATF_TP_FSADD(ffs,func);                                               \
 177   ATF_TP_FSADD(ffslog,func);                                            \
 178   ATF_TP_FSADD(lfs,func);                                               \
 179   ATF_TP_FSADD(msdosfs,func);                                           \
 180   ATF_TP_FSADD(nfs,func);                                               \
 181   ATF_TP_FSADD(puffs,func);                                             \
 182   ATF_TP_FSADD(p2k_ffs,func);                                           \
 183   ATF_TP_FSADD(rumpfs,func);                                            \
 184   ATF_TP_FSADD(sysvbfs,func);                                           \
 185   ATF_TP_FSADD(tmpfs,func);                                             \
 186   ATF_TP_FSADD(udf,func);                                               \
 187   ATF_TP_FSADD(v7fs,func);
 188
 189 /* XXX: this will not scale */
 190 #ifdef WANT_ZFS_TESTS
 191 #define ATF_TC_FSAPPLY(func,desc)                                       \
 192   ATF_TC_FSAPPLY_NOZFS(func,desc)                                       \
 193   ATF_TC_FSADD(zfs,MOUNT_ZFS,func,desc)
 194 #define ATF_TP_FSAPPLY(func)                                            \
 195   ATF_TP_FSAPPLY_NOZFS(func)                                            \
 196   ATF_TP_FSADD(zfs,func);
 197
 198 #else /* !WANT_ZFS_TESTS */
 199
 200 #define ATF_TC_FSAPPLY(func,desc)                                       \
 201   ATF_TC_FSAPPLY_NOZFS(func,desc)
 202 #define ATF_TP_FSAPPLY(func)                                            \
 203   ATF_TP_FSAPPLY_NOZFS(func)
 204
 205 #endif /* WANT_ZFS_TESTS */
 206
 207 /*
 208  * Same as above, but generate a file system image first and perform
 209  * tests for a r/o mount.
 210  *
 211  * Missing the following file systems:
 212  *   + lfs (fstest_lfs routines cannot handle remount.  FIXME!)
 213  *   + tmpfs (memory backend)
 214  *   + rumpfs (memory backend)
 215  *   + puffs (memory backend, but could be run in theory)
 216  */
 217
 218 #define ATF_TC_FSAPPLY_RO(func,desc,gen)                                \
 219   ATF_TC_FSADD_RO(ext2fs,MOUNT_EXT2FS,func,desc,gen)                    \
 220   ATF_TC_FSADD_RO(ffs,MOUNT_FFS,func,desc,gen)                          \
 221   ATF_TC_FSADD_RO(ffslog,MOUNT_FFS,func,desc,gen)                       \
 222   ATF_TC_FSADD_RO(msdosfs,MOUNT_MSDOS,func,desc,gen)                    \
 223   ATF_TC_FSADD_RO(nfs,MOUNT_NFS,func,desc,gen)                          \
 224   ATF_TC_FSADD_RO(nfsro,MOUNT_NFS,func,desc,gen)                        \
 225   ATF_TC_FSADD_RO(sysvbfs,MOUNT_SYSVBFS,func,desc,gen)                  \
 226   ATF_TC_FSADD_RO(udf,MOUNT_UDF,func,desc,gen)                  \
 227   ATF_TC_FSADD_RO(v7fs,MOUNT_V7FS,func,desc,gen)
 228
 229 #define ATF_TP_FSAPPLY_RO(func)                                         \
 230   ATF_TP_FSADD(ext2fs,func);                                            \
 231   ATF_TP_FSADD(ffs,func);                                               \
 232   ATF_TP_FSADD(ffslog,func);                                            \
 233   ATF_TP_FSADD(msdosfs,func);                                           \
 234   ATF_TP_FSADD(nfs,func);                                               \
 235   ATF_TP_FSADD(nfsro,func);                                             \
 236   ATF_TP_FSADD(sysvbfs,func);                                           \
 237   ATF_TP_FSADD(udf,func);                                               \
 238   ATF_TP_FSADD(v7fs,func);
 239
 240 #define ATF_FSAPPLY(func,desc)                                          \
 241         ATF_TC_FSAPPLY(func,desc);                                      \
 242         ATF_TP_ADD_TCS(tp)                                              \
 243         {                                                               \
 244                 ATF_TP_FSAPPLY(func);                                   \
 245                 return atf_no_error();                                  \
 246         }
 247
 248 static __inline bool
 249 atf_check_fstype(const atf_tc_t *tc, const char *fs)
 250 {
 251         const char *fstype;
 252
 253         if (!atf_tc_has_config_var(tc, "fstype"))
 254                 return true;
 255
 256         fstype = atf_tc_get_config_var(tc, "fstype");
 257         if (strcmp(fstype, fs) == 0)
 258                 return true;
 259         return false;
 260 }
 261
 262 #define FSTYPE_EXT2FS(tc)\
 263     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ext2fs") == 0)
 264 #define FSTYPE_FFS(tc)\
 265     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffs") == 0)
 266 #define FSTYPE_FFSLOG(tc)\
 267     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "ffslog") == 0)
 268 #define FSTYPE_LFS(tc)\
 269     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "lfs") == 0)
 270 #define FSTYPE_MSDOS(tc)\
 271     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "msdosfs") == 0)
 272 #define FSTYPE_NFS(tc)\
 273     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfs") == 0)
 274 #define FSTYPE_NFSRO(tc)\
 275     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "nfsro") == 0)
 276 #define FSTYPE_P2K_FFS(tc)\
 277     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "p2k_ffs") == 0)
 278 #define FSTYPE_PUFFS(tc)\
 279     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "puffs") == 0)
 280 #define FSTYPE_RUMPFS(tc)\
 281     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "rumpfs") == 0)
 282 #define FSTYPE_SYSVBFS(tc)\
 283     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "sysvbfs") == 0)
 284 #define FSTYPE_TMPFS(tc)\
 285     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "tmpfs") == 0)
 286 #define FSTYPE_UDF(tc)\
 287     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "udf") == 0)
 288 #define FSTYPE_V7FS(tc)\
 289     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "v7fs") == 0)
 290 #define FSTYPE_ZFS(tc)\
 291     (strcmp(atf_tc_get_md_var(tc, "X-fs.type"), "zfs") == 0)
 292
 293 #define FSTEST_ENTER()                                                  \
 294         if (rump_sys_chdir(FSTEST_MNTNAME) == -1)                       \
 295                 atf_tc_fail_errno("failed to cd into test mount")
 296
 297 #define FSTEST_EXIT()                                                   \
 298         if (rump_sys_chdir("/") == -1)                                  \
 299                 atf_tc_fail_errno("failed to cd out of test mount")
 300
 301 /*
 302  * file system args structures
 303  */
 304
 305 struct nfstestargs {
 306         pid_t ta_childpid;
 307         char ta_ethername[MAXPATHLEN];
 308 };
 309
 310 struct puffstestargs {
 311         uint8_t                 *pta_pargs;
 312         size_t                  pta_pargslen;
 313
 314         int                     pta_pflags;
 315         pid_t                   pta_childpid;
 316
 317         int                     pta_rumpfd;
 318         int                     pta_servfd;
 319
 320         char                    pta_dev[MAXPATHLEN];
 321         char                    pta_dir[MAXPATHLEN];
 322
 323         int                     pta_mntflags;
 324
 325         int                     pta_vfs_toserv_ops[PUFFS_VFS_MAX];
 326         int                     pta_vn_toserv_ops[PUFFS_VN_MAX];
 327 };
 328
 329 #endif /* __H_FSMACROS_H_ */