zircon/system/ulib/minfs/include/minfs/minfs.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#pragma once

#include <inttypes.h>

#include <fbl/algorithm.h>
#include <fbl/function.h>
#include <fbl/intrusive_hash_table.h>
#include <fbl/intrusive_single_list.h>
#include <fbl/macros.h>
#include <fbl/ref_ptr.h>
#include <fbl/unique_ptr.h>

#ifdef __Fuchsia__
#include <lib/async/dispatcher.h>
#endif

#include <minfs/bcache.h>
#include <minfs/format.h>

#include <utility>

namespace minfs {

// Controls the validation-checking performed by minfs when loading
// structures from disk.
enum class IntegrityCheck {
    // Do not attempt to validate structures on load. This is useful
    // for inspection tools, which do not depend on the correctness
    // of on-disk structures.
    kNone,
    // Validate structures (locally) before usage. This is the
    // recommended option for mounted filesystems.
    kAll,
};

struct MountOptions {
    bool readonly;
    bool metrics;
    bool verbose;

    // Number of slices to preallocate for data when the filesystem is created.
    uint32_t fvm_data_slices = 1;
};

// Format the partition backed by |bc| as MinFS.
zx_status_t Mkfs(const MountOptions& options, fbl::unique_ptr<Bcache> bc);

// Format the partition backed by |bc| as MinFS.
inline zx_status_t Mkfs(fbl::unique_ptr<Bcache> bc) {
    return Mkfs({}, std::move(bc));
}

#ifdef __Fuchsia__

// Mount the filesystem backed by |bc| using the VFS layer |vfs|,
// and serve the root directory under the provided |mount_channel|.
//
// This function does not start the async_dispatcher_t object owned by |vfs|;
// requests will not be dispatched if that async_dispatcher_t object is not
// active.
zx_status_t MountAndServe(const MountOptions& options, async_dispatcher_t* dispatcher,
                          fbl::unique_ptr<Bcache> bc, zx::channel mount_channel,
                          fbl::Closure on_unmount);
#endif

} // namespace minfs