summaryrefslogtreecommitdiff
path: root/Kernel/FileSystem/FileBackedFileSystem.h
blob: 8bfb1a1b6f0ab986637197505ee08cc27c02563f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/*
 * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <Kernel/FileSystem/FileSystem.h>
#include <Kernel/FileSystem/OpenFileDescription.h>

namespace Kernel {

class FileBackedFileSystem : public FileSystem {
    friend class VirtualFileSystem;

public:
    virtual ~FileBackedFileSystem() override;

    File& file() { return m_file_description->file(); }
    OpenFileDescription& file_description() { return *m_file_description; }
    File const& file() const { return m_file_description->file(); }
    OpenFileDescription& file_description() const { return *m_file_description; }

protected:
    explicit FileBackedFileSystem(OpenFileDescription&);

    // Note: We require all FileBackedFileSystem to implement something that actually
    // takes into account the fact that we will clean the last mount of the filesystem,
    // therefore, removing the file system with it from the Kernel memory.
    virtual ErrorOr<void> prepare_to_clear_last_mount() override = 0;

    virtual ErrorOr<void> initialize_while_locked() = 0;
    virtual bool is_initialized_while_locked() = 0;

private:
    virtual ErrorOr<void> initialize() override final;
    virtual bool is_file_backed() const override { return true; }

    IntrusiveListNode<FileBackedFileSystem> m_file_backed_file_system_node;
    mutable NonnullLockRefPtr<OpenFileDescription> m_file_description;
};
}