Serenity Operating System
1/*
2 * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 */
6
7#pragma once
8
9#include <Kernel/FileSystem/File.h>
10
11namespace Kernel {
12
13class Inode;
14
15class InodeFile final : public File {
16public:
17 static ErrorOr<NonnullRefPtr<InodeFile>> create(NonnullRefPtr<Inode> inode)
18 {
19 auto file = adopt_ref_if_nonnull(new (nothrow) InodeFile(move(inode)));
20 if (!file)
21 return ENOMEM;
22 return file.release_nonnull();
23 }
24
25 virtual ~InodeFile() override;
26
27 Inode const& inode() const { return *m_inode; }
28 Inode& inode() { return *m_inode; }
29
30 virtual bool can_read(OpenFileDescription const&, u64) const override { return true; }
31 virtual bool can_write(OpenFileDescription const&, u64) const override { return true; }
32
33 virtual ErrorOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
34 virtual ErrorOr<size_t> write(OpenFileDescription&, u64, UserOrKernelBuffer const&, size_t) override;
35 virtual ErrorOr<void> ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg) override;
36 virtual ErrorOr<NonnullLockRefPtr<Memory::VMObject>> vmobject_for_mmap(Process&, Memory::VirtualRange const&, u64& offset, bool shared) override;
37 virtual ErrorOr<struct stat> stat() const override { return inode().metadata().stat(); }
38
39 virtual ErrorOr<NonnullOwnPtr<KString>> pseudo_path(OpenFileDescription const&) const override;
40
41 virtual ErrorOr<void> truncate(u64) override;
42 virtual ErrorOr<void> sync() override;
43 virtual ErrorOr<void> chown(Credentials const&, OpenFileDescription&, UserID, GroupID) override;
44 virtual ErrorOr<void> chmod(Credentials const&, OpenFileDescription&, mode_t) override;
45
46 virtual StringView class_name() const override { return "InodeFile"sv; }
47
48 virtual bool is_seekable() const override { return true; }
49 virtual bool is_inode() const override { return true; }
50
51private:
52 virtual bool is_regular_file() const override;
53
54 explicit InodeFile(NonnullRefPtr<Inode>);
55 NonnullRefPtr<Inode> m_inode;
56};
57
58}