jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2022, Undefine <undefine@undefine.pl>
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 */
6
7#pragma once
8
9#include <AK/OwnPtr.h>
10#include <AK/RefPtr.h>
11#include <Kernel/FileSystem/FATFS/Definitions.h>
12#include <Kernel/FileSystem/FATFS/FileSystem.h>
13#include <Kernel/FileSystem/Inode.h>
14#include <Kernel/KBuffer.h>
15#include <Kernel/KString.h>
16
17namespace Kernel {
18
19class FATInode final : public Inode {
20 friend FATFS;
21
22public:
23 virtual ~FATInode() override = default;
24
25 static ErrorOr<NonnullRefPtr<FATInode>> create(FATFS&, FATEntry, Vector<FATLongFileNameEntry> const& = {});
26
27 FATFS& fs() { return static_cast<FATFS&>(Inode::fs()); }
28 FATFS const& fs() const { return static_cast<FATFS const&>(Inode::fs()); }
29
30private:
31 FATInode(FATFS&, FATEntry, NonnullOwnPtr<KString> filename);
32
33 static constexpr u32 no_more_clusters = 0x0FFFFFF8;
34 static constexpr u32 cluster_number_mask = 0x0FFFFFFF;
35
36 static constexpr u8 end_entry_byte = 0x00;
37 static constexpr u8 unused_entry_byte = 0xE5;
38
39 static constexpr u8 lfn_entry_character_termination = 0x00;
40 static constexpr u8 lfn_entry_unused_byte = 0xFF;
41
42 static constexpr u8 normal_filename_length = 8;
43 static constexpr u8 normal_extension_length = 3;
44
45 static ErrorOr<NonnullOwnPtr<KString>> compute_filename(FATEntry&, Vector<FATLongFileNameEntry> const& = {});
46 static StringView byte_terminated_string(StringView, u8);
47
48 ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> compute_block_list();
49 ErrorOr<NonnullOwnPtr<KBuffer>> read_block_list();
50 ErrorOr<RefPtr<FATInode>> traverse(Function<ErrorOr<bool>(RefPtr<FATInode>)> callback);
51 u32 first_cluster() const;
52
53 // ^Inode
54 virtual ErrorOr<size_t> write_bytes_locked(off_t, size_t, UserOrKernelBuffer const& data, OpenFileDescription*) override;
55 virtual ErrorOr<size_t> read_bytes_locked(off_t, size_t, UserOrKernelBuffer& buffer, OpenFileDescription*) const override;
56
57 virtual InodeMetadata metadata() const override;
58 virtual ErrorOr<void> traverse_as_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)>) const override;
59 virtual ErrorOr<NonnullRefPtr<Inode>> lookup(StringView name) override;
60 virtual ErrorOr<NonnullRefPtr<Inode>> create_child(StringView name, mode_t, dev_t, UserID, GroupID) override;
61 virtual ErrorOr<void> add_child(Inode&, StringView name, mode_t) override;
62 virtual ErrorOr<void> remove_child(StringView name) override;
63 virtual ErrorOr<void> replace_child(StringView name, Inode& child) override;
64 virtual ErrorOr<void> chmod(mode_t) override;
65 virtual ErrorOr<void> chown(UserID, GroupID) override;
66 virtual ErrorOr<void> flush_metadata() override;
67
68 Vector<BlockBasedFileSystem::BlockIndex> m_block_list;
69 FATEntry m_entry;
70 NonnullOwnPtr<KString> m_filename;
71 InodeMetadata m_metadata;
72};
73
74}