jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * Copyright (c) 2022-2023, Liav A. <liavalb@hotmail.co.il>
4 *
5 * SPDX-License-Identifier: BSD-2-Clause
6 */
7
8#pragma once
9
10#include <Kernel/FileSystem/Inode.h>
11#include <Kernel/FileSystem/OpenFileDescription.h>
12#include <Kernel/FileSystem/ProcFS/Definitions.h>
13#include <Kernel/FileSystem/ProcFS/FileSystem.h>
14#include <Kernel/KBufferBuilder.h>
15#include <Kernel/UnixTypes.h>
16
17namespace Kernel {
18struct ProcFSInodeData : public OpenFileDescriptionData {
19 OwnPtr<KBuffer> buffer;
20};
21
22class ProcFSInode final : public Inode {
23 friend class ProcFS;
24
25public:
26 enum class Type {
27 RootDirectory,
28 SelfProcessLink,
29 ProcessProperty,
30 ProcessDirectory,
31 ProcessSubdirectory,
32 };
33
34 static InodeIndex create_index_from_global_directory_entry(segmented_global_inode_index entry);
35 static InodeIndex create_index_from_process_directory_entry(ProcessID pid, segmented_process_directory_entry entry);
36
37 virtual ~ProcFSInode() override;
38
39private:
40 ProcFSInode(ProcFS const&, InodeIndex);
41
42 ProcFS& procfs() { return static_cast<ProcFS&>(Inode::fs()); }
43 ProcFS const& procfs() const { return static_cast<ProcFS const&>(Inode::fs()); }
44
45 // ^Inode (EROFS handling)
46 virtual ErrorOr<NonnullRefPtr<Inode>> create_child(StringView, mode_t, dev_t, UserID, GroupID) override { return EROFS; }
47 virtual ErrorOr<void> add_child(Inode&, StringView, mode_t) override { return EROFS; }
48 virtual ErrorOr<void> remove_child(StringView) override { return EROFS; }
49 virtual ErrorOr<void> replace_child(StringView, Inode&) override { return EROFS; }
50 virtual ErrorOr<void> chmod(mode_t) override { return EROFS; }
51 virtual ErrorOr<void> chown(UserID, GroupID) override { return EROFS; }
52 virtual ErrorOr<size_t> write_bytes_locked(off_t, size_t, UserOrKernelBuffer const&, OpenFileDescription*) override { return EROFS; }
53 virtual ErrorOr<void> truncate(u64) override { return EROFS; }
54
55 // ^Inode (Silent ignore handling)
56 virtual ErrorOr<void> flush_metadata() override { return {}; }
57 virtual ErrorOr<void> update_timestamps(Optional<Time>, Optional<Time>, Optional<Time>) override { return {}; }
58
59 // ^Inode
60 virtual ErrorOr<void> attach(OpenFileDescription& description) override;
61 virtual void did_seek(OpenFileDescription&, off_t) override;
62 ErrorOr<void> traverse_as_root_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)>) const;
63 virtual ErrorOr<void> traverse_as_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)>) const override;
64
65 virtual InodeMetadata metadata() const override;
66 virtual ErrorOr<size_t> read_bytes_locked(off_t, size_t, UserOrKernelBuffer& buffer, OpenFileDescription*) const override;
67
68 ErrorOr<NonnullRefPtr<Inode>> lookup_as_root_directory(StringView name);
69 virtual ErrorOr<NonnullRefPtr<Inode>> lookup(StringView name) override final;
70
71 ErrorOr<void> refresh_process_property_data(OpenFileDescription& description);
72 ErrorOr<void> try_fetch_process_property_data(NonnullLockRefPtr<Process>, KBufferBuilder& builder) const;
73
74 Type m_type;
75 Optional<ProcessID> const m_associated_pid {};
76 u16 const m_subdirectory { 0 };
77 u32 const m_property { 0 };
78
79 mutable Mutex m_refresh_lock;
80};
81
82}