tests/sys/fs/fusefs/destroy.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 #include "mockfs.hh"
  32 #include "utils.hh"
  33
  34 using namespace testing;
  35
  36 class Destroy: public FuseTest {
  37 public:
  38 void expect_destroy(int error)
  39 {
  40         EXPECT_CALL(*m_mock, process(
  41                 ResultOf([=](auto in) {
  42                         return (in->header.opcode == FUSE_DESTROY);
  43                 }, Eq(true)),
  44                 _)
  45         ).WillOnce(Invoke(ReturnErrno(error)));
  46 }
  47
  48 void expect_forget(uint64_t ino, uint64_t nlookup)
  49 {
  50         EXPECT_CALL(*m_mock, process(
  51                 ResultOf([=](auto in) {
  52                         return (in->header.opcode == FUSE_FORGET &&
  53                                 in->header.nodeid == ino &&
  54                                 in->body.forget.nlookup == nlookup);
  55                 }, Eq(true)),
  56                 _)
  57         ).WillOnce(Invoke([](auto in __unused, auto &out __unused) {
  58                 /* FUSE_FORGET has no response! */
  59         }));
  60 }
  61 };
  62
  63 /*
  64  * On unmount the kernel should send a FUSE_DESTROY operation.  It should also
  65  * send FUSE_FORGET operations for all inodes with lookup_count > 0.  It's hard
  66  * to trigger FUSE_FORGET in way except by unmounting, so this is the only
  67  * testing that FUSE_FORGET gets.
  68  */
  69 TEST_F(Destroy, ok)
  70 {
  71         const char FULLPATH[] = "mountpoint/some_file.txt";
  72         const char RELPATH[] = "some_file.txt";
  73         uint64_t ino = 42;
  74
  75         expect_lookup(RELPATH, ino, S_IFREG | 0644, 0, 2);
  76         expect_forget(1, 1);
  77         expect_forget(ino, 2);
  78         expect_destroy(0);
  79
  80         /*
  81          * access(2) the file to force a lookup.  Access it twice to double its
  82          * lookup count.
  83          */
  84         ASSERT_EQ(0, access(FULLPATH, F_OK)) << strerror(errno);
  85         ASSERT_EQ(0, access(FULLPATH, F_OK)) << strerror(errno);
  86
  87         /*
  88          * Unmount, triggering a FUSE_DESTROY and also causing a VOP_RECLAIM
  89          * for every vnode on this mp, triggering FUSE_FORGET for each of them.
  90          */
  91         m_mock->unmount();
  92 }