mirror of
https://github.com/RGBCube/serenity
synced 2025-07-25 06:07:34 +00:00
Kernel: Introduce the new ProcFS design
The new ProcFS design consists of two main parts: 1. The representative ProcFS class, which is derived from the FS class. The ProcFS and its inodes are much more lean - merely 3 classes to represent the common type of inodes - regular files, symbolic links and directories. They're backed by a ProcFSExposedComponent object, which is responsible for the functional operation behind the scenes. 2. The backend of the ProcFS - the ProcFSComponentsRegistrar class and all derived classes from the ProcFSExposedComponent class. These together form the entire backend and handle all the functions you can expect from the ProcFS. The ProcFSExposedComponent derived classes split to 3 types in the manner of lifetime in the kernel: 1. Persistent objects - this category includes all basic objects, like the root folder, /proc/bus folder, main blob files in the root folders, etc. These objects are persistent and cannot die ever. 2. Semi-persistent objects - this category includes all PID folders, and subdirectories to the PID folders. It also includes exposed objects like the unveil JSON'ed blob. These object are persistent as long as the the responsible process they represent is still alive. 3. Dynamic objects - this category includes files in the subdirectories of a PID folder, like /proc/PID/fd/* or /proc/PID/stacks/*. Essentially, these objects are always created dynamically and when no longer in need after being used, they're deallocated. Nevertheless, the new allocated backend objects and inodes try to use the same InodeIndex if possible - this might change only when a thread dies and a new thread is born with a new thread stack, or when a file descriptor is closed and a new one within the same file descriptor number is opened. This is needed to actually be able to do something useful with these objects. The new design assures that many ProcFS instances can be used at once, with one backend for usage for all instances.
This commit is contained in:
Liav A
Andreas Kling
parent
1baa05d6b2
commit
12b6e69150
12 changed files with 2294 additions and 1774 deletions
|
|
@ -12,130 +12,91 @@
|
|||
#include <Kernel/FileSystem/Inode.h>
|
||||
#include <Kernel/KBufferBuilder.h>
|
||||
#include <Kernel/Lock.h>
|
||||
#include <Kernel/ProcessExposed.h>
|
||||
|
||||
namespace Kernel {
|
||||
|
||||
class Process;
|
||||
|
||||
class ProcFSInode;
|
||||
class ProcFSDirectoryInode;
|
||||
|
||||
class ProcFS final : public FS {
|
||||
friend class ProcFSInode;
|
||||
friend class ProcFSDirectoryInode;
|
||||
|
||||
public:
|
||||
virtual ~ProcFS() override;
|
||||
static RefPtr<ProcFS> create();
|
||||
|
||||
virtual bool initialize() override;
|
||||
virtual const char* class_name() const override;
|
||||
virtual const char* class_name() const override { return "ProcFS"; }
|
||||
|
||||
virtual NonnullRefPtr<Inode> root_inode() const override;
|
||||
|
||||
static void add_sys_bool(String&&, Lockable<bool>&, Function<void()>&& notify_callback = nullptr);
|
||||
|
||||
private:
|
||||
ProcFS();
|
||||
|
||||
struct ProcFSDirectoryEntry {
|
||||
ProcFSDirectoryEntry() = default;
|
||||
ProcFSDirectoryEntry(const char* a_name, unsigned a_proc_file_type, bool a_supervisor_only, bool (*read_callback)(InodeIdentifier, KBufferBuilder&) = nullptr, KResultOr<size_t> (*write_callback)(InodeIdentifier, const UserOrKernelBuffer&, size_t) = nullptr, RefPtr<ProcFSInode>&& a_inode = nullptr)
|
||||
: name(a_name)
|
||||
, proc_file_type(a_proc_file_type)
|
||||
, supervisor_only(a_supervisor_only)
|
||||
, read_callback(read_callback)
|
||||
, write_callback(write_callback)
|
||||
, inode(move(a_inode))
|
||||
{
|
||||
}
|
||||
|
||||
const char* name { nullptr };
|
||||
unsigned proc_file_type { 0 };
|
||||
bool supervisor_only { false };
|
||||
bool (*read_callback)(InodeIdentifier, KBufferBuilder&);
|
||||
KResultOr<size_t> (*write_callback)(InodeIdentifier, const UserOrKernelBuffer&, size_t);
|
||||
RefPtr<ProcFSInode> inode;
|
||||
InodeIdentifier identifier(unsigned fsid) const;
|
||||
};
|
||||
|
||||
RefPtr<Inode> get_inode(InodeIdentifier) const;
|
||||
ProcFSDirectoryEntry* get_directory_entry(InodeIdentifier) const;
|
||||
|
||||
Vector<ProcFSDirectoryEntry> m_entries;
|
||||
|
||||
mutable Lock m_inodes_lock;
|
||||
mutable HashMap<unsigned, ProcFSInode*> m_inodes;
|
||||
RefPtr<ProcFSInode> m_root_inode;
|
||||
NonnullRefPtr<ProcFSDirectoryInode> m_root_inode;
|
||||
};
|
||||
|
||||
class ProcFSInode final : public Inode {
|
||||
class ProcFSInode : public Inode {
|
||||
friend class ProcFS;
|
||||
|
||||
public:
|
||||
static NonnullRefPtr<ProcFSInode> create(const ProcFS&, const ProcFSExposedComponent&);
|
||||
virtual ~ProcFSInode() override;
|
||||
StringView name() const;
|
||||
|
||||
protected:
|
||||
ProcFSInode(const ProcFS&, const ProcFSExposedComponent&);
|
||||
|
||||
private:
|
||||
// ^Inode
|
||||
virtual KResult attach(FileDescription&) override;
|
||||
virtual void did_seek(FileDescription&, off_t) override;
|
||||
virtual KResult attach(FileDescription& description) override;
|
||||
virtual KResultOr<size_t> read_bytes(off_t, size_t, UserOrKernelBuffer& buffer, FileDescription*) const override;
|
||||
virtual InodeMetadata metadata() const override;
|
||||
virtual KResult traverse_as_directory(Function<bool(const FS::DirectoryEntryView&)>) const override;
|
||||
virtual RefPtr<Inode> lookup(StringView name) override;
|
||||
virtual void flush_metadata() override;
|
||||
virtual InodeMetadata metadata() const override;
|
||||
virtual KResultOr<size_t> write_bytes(off_t, size_t, const UserOrKernelBuffer& buffer, FileDescription*) override;
|
||||
virtual KResultOr<NonnullRefPtr<Inode>> create_child(const String& name, mode_t, dev_t, uid_t, gid_t) override;
|
||||
virtual KResult add_child(Inode&, const StringView& name, mode_t) override;
|
||||
virtual KResult remove_child(const StringView& name) override;
|
||||
virtual void did_seek(FileDescription&, off_t) override;
|
||||
virtual KResultOr<size_t> directory_entry_count() const override;
|
||||
virtual KResult chmod(mode_t) override;
|
||||
virtual KResult chown(uid_t, gid_t) override;
|
||||
virtual KResultOr<NonnullRefPtr<Custody>> resolve_as_link(Custody& base, RefPtr<Custody>* out_parent = nullptr, int options = 0, int symlink_recursion_level = 0) const override;
|
||||
virtual KResult set_mtime(time_t) override;
|
||||
virtual KResult truncate(u64) override;
|
||||
|
||||
KResult refresh_data(FileDescription&) const;
|
||||
|
||||
RefPtr<Process> process() const;
|
||||
|
||||
ProcFS& fs() { return static_cast<ProcFS&>(Inode::fs()); }
|
||||
const ProcFS& fs() const { return static_cast<const ProcFS&>(Inode::fs()); }
|
||||
ProcFSInode(ProcFS&, InodeIndex);
|
||||
NonnullRefPtr<ProcFSExposedComponent> m_associated_component;
|
||||
};
|
||||
|
||||
class ProcFSProxyInode final : public Inode {
|
||||
friend class ProcFSInode;
|
||||
class ProcFSLinkInode : public ProcFSInode {
|
||||
friend class ProcFS;
|
||||
|
||||
public:
|
||||
virtual ~ProcFSProxyInode() override;
|
||||
static NonnullRefPtr<ProcFSLinkInode> create(const ProcFS&, const ProcFSExposedComponent&);
|
||||
|
||||
private:
|
||||
// ^Inode
|
||||
virtual KResult attach(FileDescription&) override;
|
||||
virtual void did_seek(FileDescription&, off_t) override;
|
||||
virtual KResultOr<size_t> read_bytes(off_t, size_t, UserOrKernelBuffer&, FileDescription*) const override { VERIFY_NOT_REACHED(); }
|
||||
protected:
|
||||
ProcFSLinkInode(const ProcFS&, const ProcFSExposedComponent&);
|
||||
virtual InodeMetadata metadata() const override;
|
||||
virtual KResult traverse_as_directory(Function<bool(const FS::DirectoryEntryView&)>) const override { VERIFY_NOT_REACHED(); }
|
||||
virtual RefPtr<Inode> lookup(StringView name) override;
|
||||
virtual void flush_metadata() override {};
|
||||
virtual KResultOr<size_t> write_bytes(off_t, size_t, const UserOrKernelBuffer&, FileDescription*) override { VERIFY_NOT_REACHED(); }
|
||||
virtual KResultOr<NonnullRefPtr<Inode>> create_child(const String& name, mode_t, dev_t, uid_t, gid_t) override;
|
||||
virtual KResult add_child(Inode&, const StringView& name, mode_t) override;
|
||||
virtual KResult remove_child(const StringView& name) override;
|
||||
virtual KResultOr<size_t> directory_entry_count() const override;
|
||||
virtual KResult chmod(mode_t) override { return EINVAL; }
|
||||
virtual KResult chown(uid_t, gid_t) override { return EINVAL; }
|
||||
virtual KResultOr<NonnullRefPtr<Custody>> resolve_as_link(Custody&, RefPtr<Custody>*, int, int) const override { VERIFY_NOT_REACHED(); }
|
||||
virtual FileDescription* preopen_fd() override { return m_fd; }
|
||||
|
||||
ProcFS& fs() { return static_cast<ProcFS&>(Inode::fs()); }
|
||||
const ProcFS& fs() const { return static_cast<const ProcFS&>(Inode::fs()); }
|
||||
|
||||
ProcFSProxyInode(ProcFS&, FileDescription&);
|
||||
static NonnullRefPtr<ProcFSProxyInode> create(ProcFS& fs, FileDescription& fd)
|
||||
{
|
||||
return adopt_ref(*new ProcFSProxyInode(fs, fd));
|
||||
}
|
||||
|
||||
NonnullRefPtr<FileDescription> m_fd;
|
||||
};
|
||||
|
||||
class ProcFSDirectoryInode : public ProcFSInode {
|
||||
friend class ProcFS;
|
||||
|
||||
public:
|
||||
static NonnullRefPtr<ProcFSDirectoryInode> create(const ProcFS&, const ProcFSExposedComponent&);
|
||||
virtual ~ProcFSDirectoryInode() override;
|
||||
|
||||
protected:
|
||||
ProcFSDirectoryInode(const ProcFS&, const ProcFSExposedComponent&);
|
||||
// ^Inode
|
||||
virtual InodeMetadata metadata() const override;
|
||||
virtual KResult traverse_as_directory(Function<bool(const FS::DirectoryEntryView&)>) const override;
|
||||
virtual RefPtr<Inode> lookup(StringView name) override;
|
||||
virtual KResultOr<size_t> directory_entry_count() const override;
|
||||
|
||||
ProcFS& m_parent_fs;
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue