tests/sys/fs/fusefs/utils.cc

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2019 The FreeBSD Foundation
   5  *
   6  * This software was developed by BFF Storage Systems, LLC under sponsorship
   7  * from the FreeBSD Foundation.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  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  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 extern "C" {
  32 #include <sys/param.h>
  33 #include <sys/mman.h>
  34 #include <sys/module.h>
  35 #include <sys/sysctl.h>
  36 #include <sys/wait.h>
  37
  38 #include <pwd.h>
  39 #include <semaphore.h>
  40 #include <unistd.h>
  41 }
  42
  43 #include <gtest/gtest.h>
  44
  45 #include "mockfs.hh"
  46 #include "utils.hh"
  47
  48 using namespace testing;
  49
  50 /* Check that fusefs(4) is accessible and the current user can mount(2) */
  51 void check_environment()
  52 {
  53         const char *devnode = "/dev/fuse";
  54         const char *usermount_node = "vfs.usermount";
  55         int usermount_val = 0;
  56         size_t usermount_size = sizeof(usermount_val);
  57         if (eaccess(devnode, R_OK | W_OK)) {
  58                 if (errno == ENOENT) {
  59                         GTEST_SKIP() << devnode << " does not exist";
  60                 } else if (errno == EACCES) {
  61                         GTEST_SKIP() << devnode <<
  62                             " is not accessible by the current user";
  63                 } else {
  64                         GTEST_SKIP() << strerror(errno);
  65                 }
  66         }
  67         sysctlbyname(usermount_node, &usermount_val, &usermount_size,
  68                      NULL, 0);
  69         if (geteuid() != 0 && !usermount_val)
  70                 GTEST_SKIP() << "current user is not allowed to mount";
  71 }
  72
  73 class FuseEnv: public Environment {
  74         virtual void SetUp() {
  75         }
  76 };
  77
  78 void FuseTest::SetUp() {
  79         const char *node = "vfs.maxbcachebuf";
  80         int val = 0;
  81         size_t size = sizeof(val);
  82
  83         /*
  84          * XXX check_environment should be called from FuseEnv::SetUp, but
  85          * can't due to https://github.com/google/googletest/issues/2189
  86          */
  87         check_environment();
  88         if (IsSkipped())
  89                 return;
  90
  91         ASSERT_EQ(0, sysctlbyname(node, &val, &size, NULL, 0))
  92                 << strerror(errno);
  93         m_maxbcachebuf = val;
  94
  95         try {
  96                 m_mock = new MockFS(m_maxreadahead, m_allow_other,
  97                         m_default_permissions, m_push_symlinks_in,
  98                         m_init_flags);
  99         } catch (std::system_error err) {
 100                 FAIL() << err.what();
 101         }
 102 }
 103
 104 void
 105 FuseTest::expect_access(uint64_t ino, mode_t access_mode, int error)
 106 {
 107         EXPECT_CALL(*m_mock, process(
 108                 ResultOf([=](auto in) {
 109                         return (in->header.opcode == FUSE_ACCESS &&
 110                                 in->header.nodeid == ino &&
 111                                 in->body.access.mask == access_mode);
 112                 }, Eq(true)),
 113                 _)
 114         ).WillOnce(Invoke(ReturnErrno(error)));
 115 }
 116
 117 void FuseTest::expect_getattr(uint64_t ino, uint64_t size)
 118 {
 119         /* Until the attr cache is working, we may send an additional GETATTR */
 120         EXPECT_CALL(*m_mock, process(
 121                 ResultOf([=](auto in) {
 122                         return (in->header.opcode == FUSE_GETATTR &&
 123                                 in->header.nodeid == ino);
 124                 }, Eq(true)),
 125                 _)
 126         ).WillRepeatedly(Invoke(ReturnImmediate([=](auto i __unused, auto out) {
 127                 SET_OUT_HEADER_LEN(out, attr);
 128                 out->body.attr.attr.ino = ino;  // Must match nodeid
 129                 out->body.attr.attr.mode = S_IFREG | 0644;
 130                 out->body.attr.attr.size = size;
 131                 out->body.attr.attr_valid = UINT64_MAX;
 132         })));
 133 }
 134
 135 void FuseTest::expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
 136         uint64_t size, int times)
 137 {
 138         EXPECT_LOOKUP(1, relpath)
 139         .Times(times)
 140         .WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
 141                 SET_OUT_HEADER_LEN(out, entry);
 142                 out->body.entry.attr.mode = mode;
 143                 out->body.entry.nodeid = ino;
 144                 out->body.entry.attr.nlink = 1;
 145                 out->body.entry.attr_valid = UINT64_MAX;
 146                 out->body.entry.attr.size = size;
 147         })));
 148 }
 149
 150 void FuseTest::expect_open(uint64_t ino, uint32_t flags, int times)
 151 {
 152         EXPECT_CALL(*m_mock, process(
 153                 ResultOf([=](auto in) {
 154                         return (in->header.opcode == FUSE_OPEN &&
 155                                 in->header.nodeid == ino);
 156                 }, Eq(true)),
 157                 _)
 158         ).Times(times)
 159         .WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
 160                 out->header.len = sizeof(out->header);
 161                 SET_OUT_HEADER_LEN(out, open);
 162                 out->body.open.fh = FH;
 163                 out->body.open.open_flags = flags;
 164         })));
 165 }
 166
 167 void FuseTest::expect_opendir(uint64_t ino)
 168 {
 169         /* opendir(3) calls fstatfs */
 170         EXPECT_CALL(*m_mock, process(
 171                 ResultOf([](auto in) {
 172                         return (in->header.opcode == FUSE_STATFS);
 173                 }, Eq(true)),
 174                 _)
 175         ).WillRepeatedly(Invoke(ReturnImmediate([=](auto i __unused, auto out) {
 176                 SET_OUT_HEADER_LEN(out, statfs);
 177         })));
 178
 179         EXPECT_CALL(*m_mock, process(
 180                 ResultOf([=](auto in) {
 181                         return (in->header.opcode == FUSE_OPENDIR &&
 182                                 in->header.nodeid == ino);
 183                 }, Eq(true)),
 184                 _)
 185         ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
 186                 out->header.len = sizeof(out->header);
 187                 SET_OUT_HEADER_LEN(out, open);
 188                 out->body.open.fh = FH;
 189         })));
 190 }
 191
 192 void FuseTest::expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
 193         uint64_t osize, const void *contents)
 194 {
 195         EXPECT_CALL(*m_mock, process(
 196                 ResultOf([=](auto in) {
 197                         return (in->header.opcode == FUSE_READ &&
 198                                 in->header.nodeid == ino &&
 199                                 in->body.read.fh == FH &&
 200                                 in->body.read.offset == offset &&
 201                                 in->body.read.size == isize);
 202                 }, Eq(true)),
 203                 _)
 204         ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
 205                 out->header.len = sizeof(struct fuse_out_header) + osize;
 206                 memmove(out->body.bytes, contents, osize);
 207         }))).RetiresOnSaturation();
 208 }
 209
 210 void FuseTest::expect_release(uint64_t ino, uint64_t fh)
 211 {
 212         EXPECT_CALL(*m_mock, process(
 213                 ResultOf([=](auto in) {
 214                         return (in->header.opcode == FUSE_RELEASE &&
 215                                 in->header.nodeid == ino &&
 216                                 in->body.release.fh == fh);
 217                 }, Eq(true)),
 218                 _)
 219         ).WillOnce(Invoke(ReturnErrno(0)));
 220 }
 221
 222 void FuseTest::expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
 223         uint64_t osize, uint32_t flags, const void *contents)
 224 {
 225         EXPECT_CALL(*m_mock, process(
 226                 ResultOf([=](auto in) {
 227                         const char *buf = (const char*)in->body.bytes +
 228                                 sizeof(struct fuse_write_in);
 229                         bool pid_ok;
 230
 231                         if (in->body.write.write_flags & FUSE_WRITE_CACHE)
 232                                 pid_ok = true;
 233                         else
 234                                 pid_ok = (pid_t)in->header.pid == getpid();
 235
 236                         return (in->header.opcode == FUSE_WRITE &&
 237                                 in->header.nodeid == ino &&
 238                                 in->body.write.fh == FH &&
 239                                 in->body.write.offset == offset  &&
 240                                 in->body.write.size == isize &&
 241                                 pid_ok &&
 242                                 in->body.write.write_flags == flags &&
 243                                 0 == bcmp(buf, contents, isize));
 244                 }, Eq(true)),
 245                 _)
 246         ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
 247                 SET_OUT_HEADER_LEN(out, write);
 248                 out->body.write.size = osize;
 249         })));
 250 }
 251
 252 static void
 253 get_unprivileged_uid(uid_t *uid)
 254 {
 255         struct passwd *pw;
 256
 257         /*
 258          * First try "tests", Kyua's default unprivileged user.  XXX after
 259          * GoogleTest gains a proper Kyua wrapper, get this with the Kyua API
 260          */
 261         pw = getpwnam("tests");
 262         if (pw == NULL) {
 263                 /* Fall back to "nobody" */
 264                 pw = getpwnam("nobody");
 265         }
 266         if (pw == NULL)
 267                 GTEST_SKIP() << "Test requires an unprivileged user";
 268         *uid = pw->pw_uid;
 269 }
 270
 271 void
 272 FuseTest::fork(bool drop_privs, std::function<void()> parent_func,
 273         std::function<int()> child_func)
 274 {
 275         sem_t *sem;
 276         int mprot = PROT_READ | PROT_WRITE;
 277         int mflags = MAP_ANON | MAP_SHARED;
 278         pid_t child;
 279         uid_t uid;
 280
 281         if (drop_privs) {
 282                 get_unprivileged_uid(&uid);
 283                 if (IsSkipped())
 284                         return;
 285         }
 286
 287         sem = (sem_t*)mmap(NULL, sizeof(*sem), mprot, mflags, -1, 0);
 288         ASSERT_NE(MAP_FAILED, sem) << strerror(errno);
 289         ASSERT_EQ(0, sem_init(sem, 1, 0)) << strerror(errno);
 290
 291         if ((child = ::fork()) == 0) {
 292                 /* In child */
 293                 int err = 0;
 294
 295                 if (sem_wait(sem)) {
 296                         perror("sem_wait");
 297                         err = 1;
 298                         goto out;
 299                 }
 300
 301                 if (drop_privs && 0 != setreuid(-1, uid)) {
 302                         perror("setreuid");
 303                         err = 1;
 304                         goto out;
 305                 }
 306                 err = child_func();
 307
 308 out:
 309                 sem_destroy(sem);
 310                 _exit(err);
 311         } else if (child > 0) {
 312                 int child_status;
 313
 314                 /*
 315                  * In parent.  Cleanup must happen here, because it's still
 316                  * privileged.
 317                  */
 318                 m_mock->m_child_pid = child;
 319                 ASSERT_NO_FATAL_FAILURE(parent_func());
 320
 321                 /* Signal the child process to go */
 322                 ASSERT_EQ(0, sem_post(sem)) << strerror(errno);
 323
 324                 ASSERT_LE(0, wait(&child_status)) << strerror(errno);
 325                 ASSERT_EQ(0, WEXITSTATUS(child_status));
 326         } else {
 327                 FAIL() << strerror(errno);
 328         }
 329         munmap(sem, sizeof(*sem));
 330 }
 331
 332 static void usage(char* progname) {
 333         fprintf(stderr, "Usage: %s [-v]\n\t-v increase verbosity\n", progname);
 334         exit(2);
 335 }
 336
 337 int main(int argc, char **argv) {
 338         int ch;
 339         FuseEnv *fuse_env = new FuseEnv;
 340
 341         InitGoogleTest(&argc, argv);
 342         AddGlobalTestEnvironment(fuse_env);
 343
 344         while ((ch = getopt(argc, argv, "v")) != -1) {
 345                 switch (ch) {
 346                         case 'v':
 347                                 verbosity++;
 348                                 break;
 349                         default:
 350                                 usage(argv[0]);
 351                                 break;
 352                 }
 353         }
 354
 355         return (RUN_ALL_TESTS());
 356 }