jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 */
6
7#pragma once
8
9#include <AK/HashMap.h>
10#include <Kernel/FileSystem/Ext2FS/Definitions.h>
11#include <Kernel/FileSystem/Ext2FS/DirectoryEntry.h>
12#include <Kernel/FileSystem/Ext2FS/FileSystem.h>
13#include <Kernel/FileSystem/Inode.h>
14#include <Kernel/UnixTypes.h>
15
16namespace Kernel {
17
18class Ext2FSInode final : public Inode {
19 friend class Ext2FS;
20
21public:
22 virtual ~Ext2FSInode() override;
23
24 u64 size() const;
25 bool is_symlink() const { return Kernel::is_symlink(m_raw_inode.i_mode); }
26 bool is_directory() const { return Kernel::is_directory(m_raw_inode.i_mode); }
27
28private:
29 // ^Inode
30 virtual ErrorOr<size_t> read_bytes_locked(off_t, size_t, UserOrKernelBuffer& buffer, OpenFileDescription*) const override;
31 virtual InodeMetadata metadata() const override;
32 virtual ErrorOr<void> traverse_as_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)>) const override;
33 virtual ErrorOr<NonnullRefPtr<Inode>> lookup(StringView name) override;
34 virtual ErrorOr<void> flush_metadata() override;
35 virtual ErrorOr<size_t> write_bytes_locked(off_t, size_t, UserOrKernelBuffer const& data, OpenFileDescription*) override;
36 virtual ErrorOr<NonnullRefPtr<Inode>> create_child(StringView name, mode_t, dev_t, UserID, GroupID) override;
37 virtual ErrorOr<void> add_child(Inode& child, StringView name, mode_t) override;
38 virtual ErrorOr<void> remove_child(StringView name) override;
39 virtual ErrorOr<void> replace_child(StringView name, Inode& child) override;
40 virtual ErrorOr<void> update_timestamps(Optional<Time> atime, Optional<Time> ctime, Optional<Time> mtime) override;
41 virtual ErrorOr<void> increment_link_count() override;
42 virtual ErrorOr<void> decrement_link_count() override;
43 virtual ErrorOr<void> chmod(mode_t) override;
44 virtual ErrorOr<void> chown(UserID, GroupID) override;
45 virtual ErrorOr<void> truncate(u64) override;
46 virtual ErrorOr<int> get_block_address(int) override;
47
48 ErrorOr<void> write_directory(Vector<Ext2FSDirectoryEntry>&);
49 ErrorOr<void> populate_lookup_cache();
50 ErrorOr<void> resize(u64);
51 ErrorOr<void> write_indirect_block(BlockBasedFileSystem::BlockIndex, Span<BlockBasedFileSystem::BlockIndex>);
52 ErrorOr<void> grow_doubly_indirect_block(BlockBasedFileSystem::BlockIndex, size_t, Span<BlockBasedFileSystem::BlockIndex>, Vector<BlockBasedFileSystem::BlockIndex>&, unsigned&);
53 ErrorOr<void> shrink_doubly_indirect_block(BlockBasedFileSystem::BlockIndex, size_t, size_t, unsigned&);
54 ErrorOr<void> grow_triply_indirect_block(BlockBasedFileSystem::BlockIndex, size_t, Span<BlockBasedFileSystem::BlockIndex>, Vector<BlockBasedFileSystem::BlockIndex>&, unsigned&);
55 ErrorOr<void> shrink_triply_indirect_block(BlockBasedFileSystem::BlockIndex, size_t, size_t, unsigned&);
56 ErrorOr<void> flush_block_list();
57
58 ErrorOr<void> compute_block_list_with_exclusive_locking();
59 ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> compute_block_list() const;
60 ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> compute_block_list_with_meta_blocks() const;
61 ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> compute_block_list_impl(bool include_block_list_blocks) const;
62 ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> compute_block_list_impl_internal(ext2_inode const&, bool include_block_list_blocks) const;
63
64 Ext2FS& fs();
65 Ext2FS const& fs() const;
66 Ext2FSInode(Ext2FS&, InodeIndex);
67
68 Vector<BlockBasedFileSystem::BlockIndex> m_block_list;
69 HashMap<NonnullOwnPtr<KString>, InodeIndex> m_lookup_cache;
70 ext2_inode m_raw_inode {};
71
72 Mutex m_block_list_lock { "BlockList"sv };
73};
74
75inline Ext2FS& Ext2FSInode::fs()
76{
77 return static_cast<Ext2FS&>(Inode::fs());
78}
79
80inline Ext2FS const& Ext2FSInode::fs() const
81{
82 return static_cast<Ext2FS const&>(Inode::fs());
83}
84
85}