/* * Copyright (c) 2021, Liav A. * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include namespace Kernel { namespace SegmentedProcFSIndex { enum class MainProcessProperty { Reserved = 0, Unveil = 1, Pledge = 2, FileDescriptions = 3, BinaryLink = 4, CurrentWorkDirectoryLink = 5, PerformanceEvents = 6, VirtualMemoryStats = 7, RootLink = 8, }; enum class ProcessSubDirectory { Reserved = 0, FileDescriptions = 1, Stacks = 2, }; void read_segments(u32& primary, ProcessSubDirectory& sub_directory, MainProcessProperty& property); InodeIndex build_segmented_index_for_pid_directory(ProcessID); InodeIndex build_segmented_index_for_sub_directory(ProcessID, ProcessSubDirectory sub_directory); InodeIndex build_segmented_index_for_main_property(ProcessID, ProcessSubDirectory sub_directory, MainProcessProperty property); InodeIndex build_segmented_index_for_main_property_in_pid_directory(ProcessID, MainProcessProperty property); InodeIndex build_segmented_index_for_thread_stack(ProcessID, ThreadID); InodeIndex build_segmented_index_for_file_description(ProcessID, unsigned); } class ProcFSComponentRegistry { public: static ProcFSComponentRegistry& the(); static void initialize(); ProcFSComponentRegistry(); ProcFSRootDirectory& root_directory() { return *m_root_directory; } Mutex& get_lock() { return m_lock; } private: Mutex m_lock; NonnullRefPtr m_root_directory; }; class ProcFSExposedComponent : public RefCounted { public: StringView name() const { return m_name->view(); } virtual KResultOr read_bytes(off_t, size_t, UserOrKernelBuffer&, FileDescription*) const { VERIFY_NOT_REACHED(); } virtual KResult traverse_as_directory(unsigned, Function) const { VERIFY_NOT_REACHED(); } virtual KResultOr> lookup(StringView) { VERIFY_NOT_REACHED(); }; virtual KResultOr write_bytes(off_t, size_t, const UserOrKernelBuffer&, FileDescription*) { return KResult(EROFS); } virtual size_t size() const { return 0; } virtual mode_t required_mode() const { return 0444; } virtual uid_t owner_user() const { return 0; } virtual gid_t owner_group() const { return 0; } time_t modified_time() const { return TimeManagement::now().to_timeval().tv_sec; } virtual void prepare_for_deletion() { } virtual KResult refresh_data(FileDescription&) const { return KSuccess; } virtual KResultOr> to_inode(const ProcFS& procfs_instance) const; virtual InodeIndex component_index() const { return m_component_index; } virtual ~ProcFSExposedComponent() = default; protected: ProcFSExposedComponent(); explicit ProcFSExposedComponent(StringView name); private: OwnPtr m_name; InodeIndex m_component_index {}; }; class ProcFSExposedDirectory : public ProcFSExposedComponent , public Weakable { friend class ProcFSComponentRegistry; public: virtual KResult traverse_as_directory(unsigned, Function) const override; virtual KResultOr> lookup(StringView name) override; void add_component(const ProcFSExposedComponent&); virtual void prepare_for_deletion() override { for (auto& component : m_components) { component.prepare_for_deletion(); } } virtual mode_t required_mode() const override { return 0555; } virtual KResultOr> to_inode(const ProcFS& procfs_instance) const override final; protected: explicit ProcFSExposedDirectory(StringView name); ProcFSExposedDirectory(StringView name, const ProcFSExposedDirectory& parent_directory); NonnullRefPtrVector m_components; WeakPtr m_parent_directory; }; class ProcFSExposedLink : public ProcFSExposedComponent { public: virtual KResultOr> to_inode(const ProcFS& procfs_instance) const override final; virtual KResultOr read_bytes(off_t offset, size_t count, UserOrKernelBuffer& buffer, FileDescription* description) const override; protected: virtual bool acquire_link(KBufferBuilder& builder) = 0; explicit ProcFSExposedLink(StringView name); mutable Mutex m_lock { "ProcFSLink" }; }; class ProcFSRootDirectory final : public ProcFSExposedDirectory { friend class ProcFSComponentRegistry; public: virtual KResultOr> lookup(StringView name) override; static NonnullRefPtr must_create(); virtual ~ProcFSRootDirectory(); private: virtual KResult traverse_as_directory(unsigned, Function) const override; ProcFSRootDirectory(); }; struct ProcFSInodeData : public FileDescriptionData { OwnPtr buffer; }; class ProcFSGlobalInformation : public ProcFSExposedComponent { public: virtual ~ProcFSGlobalInformation() override {}; virtual KResultOr read_bytes(off_t offset, size_t count, UserOrKernelBuffer& buffer, FileDescription* description) const override; virtual mode_t required_mode() const override { return 0444; } protected: explicit ProcFSGlobalInformation(StringView name) : ProcFSExposedComponent(name) { } virtual KResult refresh_data(FileDescription&) const override; virtual bool output(KBufferBuilder& builder) = 0; mutable Mutex m_refresh_lock; }; class ProcFSSystemBoolean : public ProcFSGlobalInformation { public: virtual bool value() const = 0; virtual void set_value(bool new_value) = 0; protected: explicit ProcFSSystemBoolean(StringView name) : ProcFSGlobalInformation(name) { } virtual bool output(KBufferBuilder& builder) override { builder.appendff("{}\n", value()); return true; } }; }