beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-22 23:50:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/Kernel/FileSystem/VirtualFileSystem.h

100 lines
3.6 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
/*
Kernel: Rename VFS => VirtualFileSystem
2021-07-10 22:25:24 +00:00
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 08:24:48 +00:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
*/
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
#pragma once
FileSystem: VFS should require Badge<Device> for device registration.
2019-05-31 13:36:49 +00:00
#include <AK/Badge.h>
Add clang-format file Also run it across the whole tree to get everything using the One True Style. We don't yet run this in an automated fashion as it's a little slow, but there is a snippet to do so in makeall.sh.
2019-05-28 09:53:16 +00:00
#include <AK/Function.h>
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
#include <AK/HashMap.h>
Kernel: Convert Vector<OwnPtr> to NonnullOwnPtrVector.
2019-07-24 07:15:33 +00:00
#include <AK/NonnullOwnPtrVector.h>
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
#include <AK/OwnPtr.h>
AK: Rename RetainPtr.h => RefPtr.h, Retained.h => NonnullRefPtr.h.
2019-06-21 16:45:35 +00:00
#include <AK/RefPtr.h>
Kernel+LibC: Add support for mount flags At the moment, the actual flags are ignored, but we correctly propagate them all the way from the original mount() syscall to each custody that resides on the mounted FS.
2020-01-11 15:25:26 +00:00
#include <AK/String.h>
FileSystem: VFS should require Badge<Device> for device registration.
2019-05-31 13:36:49 +00:00
#include <Kernel/FileSystem/FileSystem.h>
#include <Kernel/FileSystem/InodeIdentifier.h>
#include <Kernel/FileSystem/InodeMetadata.h>
Kernel: Make VirtualFileSystem::Mount a top-level class And move it to its own compilation unit.
2021-07-10 22:46:06 +00:00
#include <Kernel/FileSystem/Mount.h>
Kernel: Move UnveilNode.h into Kernel/FileSystem/
2021-08-06 12:11:45 +00:00
#include <Kernel/FileSystem/UnveilNode.h>
Kernel: Use Forward.h headers more
2021-07-11 09:49:16 +00:00
#include <Kernel/Forward.h>
Kernel: Add KResult and KResultOr<T> classes. The idea here is to combine a potential syscall error code with an arbitrary type in the case of success. I feel like this will end up much less error prone than returning some arbitrary type that kinda sorta has bool semantics (but sometimes not really) and passing the error through an out-param. This patch only converts a few syscalls to using it. More to come.
2019-02-25 19:47:56 +00:00
#include <Kernel/KResult.h>
Kernel: Rename ProtectedValue<T> => MutexProtected<T> Let's make it obvious what we're protecting it with.
2021-08-21 21:31:15 +00:00
#include <Kernel/Locking/MutexProtected.h>
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
Kernel: Move all code into the Kernel namespace
2020-02-16 00:27:42 +00:00
namespace Kernel {
Kernel+LibC: Clean up open() flag (O_*) definitions These were using a mix of decimal, octal and hexadecimal for no reason.
2020-01-21 12:34:39 +00:00
Kernel: Move VFS-internal O_FOO definitions to VirtualFileSystem.h
2021-08-14 17:46:18 +00:00
// Kernel internal options.
#define O_NOFOLLOW_NOERROR (1 << 29)
#define O_UNLINK_INTERNAL (1 << 30)
Kernel: Allow passing initial UID and GID when creating new inodes If we're creating something that should have a different owner than the current process's UID/GID, we need to plumb that all the way through VFS down to the FS functions.
2020-01-03 19:13:21 +00:00
struct UidAndGid {
uid_t uid;
gid_t gid;
};
Kernel: Rename VFS => VirtualFileSystem
2021-07-10 22:25:24 +00:00
class VirtualFileSystem {
Add a kmalloc_eternal() for things that will never be destroyed.
2018-10-31 22:19:15 +00:00
AK_MAKE_ETERNAL
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
public:
Kernel: Switch singletons to use new Singleton class MemoryManager cannot use the Singleton class because MemoryManager::initialize is called before the global constructors are run. That caused the Singleton to be re-initialized, causing it to create another MemoryManager instance. Fixes #3226
2020-08-25 01:35:19 +00:00
static void initialize();
Kernel: Rename VFS => VirtualFileSystem
2021-07-10 22:25:24 +00:00
static VirtualFileSystem& the();
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
Kernel: Rename VFS => VirtualFileSystem
2021-07-10 22:25:24 +00:00
VirtualFileSystem();
~VirtualFileSystem();
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
Kernel: Rename FS => FileSystem This matches our common naming style better.
2021-07-10 22:20:38 +00:00
bool mount_root(FileSystem&);
KResult mount(FileSystem&, Custody& mount_point, int flags);
Kernel: Properly propagate bind mount flags Previously, when performing a bind mount flags other than MS_BIND were ignored. Now, they're properly propagated the same way a for any other mount.
2020-01-12 16:22:24 +00:00
KResult bind_mount(Custody& source, Custody& mount_point, int flags);
Kernel+Userland: Support remounting filesystems :^) This makes it possible to change flags of a mount after the fact, with the caveats outlined in the man page.
2020-05-28 18:12:13 +00:00
KResult remount(Custody& mount_point, int new_flags);
Kernel: Port mounts to reference inodes directly ...instead of going through their identifiers. See the previous commit for reasoning.
2020-06-24 21:16:24 +00:00
KResult unmount(Inode& guest_inode);
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
Kernel: Allow passing initial UID and GID when creating new inodes If we're creating something that should have a different owner than the current process's UID/GID, we need to plumb that all the way through VFS down to the FS functions.
2020-01-03 19:13:21 +00:00
KResultOr<NonnullRefPtr<FileDescription>> open(StringView path, int options, mode_t mode, Custody& base, Optional<UidAndGid> = {});
KResultOr<NonnullRefPtr<FileDescription>> create(StringView path, int options, mode_t mode, Custody& parent_custody, Optional<UidAndGid> = {});
FileSystem: Port most of the code over to using custodies. The current working directory is now stored as a custody. Likewise for a process executable file. This unbreaks /proc/PID/fd which has not been working since we made the filesystem bigger. This still needs a bunch of work, for instance when renaming or removing a file somewhere, we have to update the relevant custody links.
2019-05-30 16:58:59 +00:00
KResult mkdir(StringView path, mode_t mode, Custody& base);
KResult link(StringView old_path, StringView new_path, Custody& base);
KResult unlink(StringView path, Custody& base);
KResult symlink(StringView target, StringView linkpath, Custody& base);
KResult rmdir(StringView path, Custody& base);
KResult chmod(StringView path, mode_t, Custody& base);
Kernel: Pass a Custody instead of Inode to VFS methods VFS no longer deals with inodes in public API, only with custodies and file descriptions. Talk directly to the file system if you need to operate on a inode. In most cases you actually want to go though VFS, to get proper permission check and other niceties. For this to work, you have to provide a custody, which describes *how* you have opened the inode, not just what the inode is.
2020-05-28 14:41:04 +00:00
KResult chmod(Custody&, mode_t);
FileSystem: Port most of the code over to using custodies. The current working directory is now stored as a custody. Likewise for a process executable file. This unbreaks /proc/PID/fd which has not been working since we made the filesystem bigger. This still needs a bunch of work, for instance when renaming or removing a file somewhere, we have to update the relevant custody links.
2019-05-30 16:58:59 +00:00
KResult chown(StringView path, uid_t, gid_t, Custody& base);
Kernel: Pass a Custody instead of Inode to VFS methods VFS no longer deals with inodes in public API, only with custodies and file descriptions. Talk directly to the file system if you need to operate on a inode. In most cases you actually want to go though VFS, to get proper permission check and other niceties. For this to work, you have to provide a custody, which describes *how* you have opened the inode, not just what the inode is.
2020-05-28 14:41:04 +00:00
KResult chown(Custody&, uid_t, gid_t);
FileSystem: Port most of the code over to using custodies. The current working directory is now stored as a custody. Likewise for a process executable file. This unbreaks /proc/PID/fd which has not been working since we made the filesystem bigger. This still needs a bunch of work, for instance when renaming or removing a file somewhere, we have to update the relevant custody links.
2019-05-30 16:58:59 +00:00
KResult access(StringView path, int mode, Custody& base);
Kernel: Generalize VFS metadata lookup and use it in mount() and stat() Refactored VFS::stat() into VFS::lookup_metadata(), which can now be used for general VFS metadata lookup by path.
2019-08-02 17:23:23 +00:00
KResultOr<InodeMetadata> lookup_metadata(StringView path, Custody& base, int options = 0);
FileSystem: Port most of the code over to using custodies. The current working directory is now stored as a custody. Likewise for a process executable file. This unbreaks /proc/PID/fd which has not been working since we made the filesystem bigger. This still needs a bunch of work, for instance when renaming or removing a file somewhere, we have to update the relevant custody links.
2019-05-30 16:58:59 +00:00
KResult utime(StringView path, Custody& base, time_t atime, time_t mtime);
KResult rename(StringView oldpath, StringView newpath, Custody& base);
KResult mknod(StringView path, mode_t, dev_t, Custody& base);
AK: Rename RetainPtr => RefPtr and Retained => NonnullRefPtr.
2019-06-21 16:37:47 +00:00
KResultOr<NonnullRefPtr<Custody>> open_directory(StringView path, Custody& base);
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
A pass of style/naming cleanup in VFS.
2018-11-15 14:10:12 +00:00
void for_each_mount(Function<void(const Mount&)>) const;
Add a simple /proc/mounts that enumerates the current VFS mounts.
2018-10-26 16:43:25 +00:00
Fix mkdir with relative paths.
2018-11-18 22:28:43 +00:00
InodeIdentifier root_inode_id() const;
Kernel: Make VirtualFileSystem::sync() static
2021-07-10 22:26:17 +00:00
static void sync();
Add sync() syscall and a /bin/sync. It walks all the live Inode objects and flushes pending metadata changes wherever needed. This could be optimized by keeping a separate list of dirty Inodes, but let's not get ahead of ourselves.
2018-12-19 23:39:29 +00:00
FileSystem: Add a Custody class that represents a parent/child guardianship. A custody is kind of a directory entry abstraction that represents a single entry in a parent directory that tells us the name of a child inode. The idea here is for path resolution to produce a chain of custody objects.
2019-05-30 15:46:08 +00:00
Custody& root_custody();
Kernel: Simplify VFS::resolve_path() further It turns out we don't even need to store the whole custody chain, as we only ever access its last element. So we can just store one custody. This also fixes a performance FIXME :^) Also, rename parent_custody to out_parent.
2020-01-15 07:52:33 +00:00
KResultOr<NonnullRefPtr<Custody>> resolve_path(StringView path, Custody& base, RefPtr<Custody>* out_parent = nullptr, int options = 0, int symlink_recursion_level = 0);
Kernel: Resolve relative paths when there is a veil (#1474)
2020-03-19 08:57:34 +00:00
KResultOr<NonnullRefPtr<Custody>> resolve_path_without_veil(StringView path, Custody& base, RefPtr<Custody>* out_parent = nullptr, int options = 0, int symlink_recursion_level = 0);
FileSystem: Add a Custody class that represents a parent/child guardianship. A custody is kind of a directory entry abstraction that represents a single entry in a parent directory that tells us the name of a child inode. The idea here is for path resolution to produce a chain of custody objects.
2019-05-30 15:46:08 +00:00
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
private:
Kernel: Rename FileDescriptor to FileDescription. After reading a bunch of POSIX specs, I've learned that a file descriptor is the number that refers to a file description, not the description itself. So this patch renames FileDescriptor to FileDescription, and Process now has FileDescription* file_description(int fd).
2019-06-07 07:36:51 +00:00
friend class FileDescription;
Lots of hacking to make a very simple "ls" utility. I added a dead-simple malloc that only allows allocations < 4096 bytes. It just forwards the request to mmap() every time. I also added simplified versions of opendir() and readdir().
2018-10-24 10:43:52 +00:00
Kernel: Don't assume there are no nodes if m_unveiled_paths.is_empty() If m_unveiled_paths.is_empty(), the root node (which is m_unveiled_paths itself) is the matching veil. This means we should not return nullptr in this case, but just use the code path for the general case. This fixes a bug where calling e.g. unveil("/", "r") would refuse you access to anything, because find_matching_unveiled_path would wrongly return nullptr. Since find_matching_unveiled_path can no longer return nullptr, we can now just return a reference instead.
2021-06-06 21:13:26 +00:00
UnveilNode const& find_matching_unveiled_path(StringView path);
Kernel: Don't allocate Strings unnecessarily in process veil validation Previously, Custody::absolute_path() was called for every call to validate_path_against_process_veil(). For processes that don't have a veil, the path is not used by the function. This means that it is unnecessarily generated. This introduces an overload to validate_path_against_process_veil(), which takes a Custody const& and only generates the absolute path if it there is actually a veil and it is thus needed. This patch results in a speed up of Assistant's file system cache building by around 16 percent.
2021-07-05 15:15:07 +00:00
KResult validate_path_against_process_veil(Custody const& path, int options);
Kernel: Add a basic implementation of unveil() This syscall is a complement to pledge() and adds the same sort of incremental relinquishing of capabilities for filesystem access. The first call to unveil() will "drop a veil" on the process, and from now on, only unveiled parts of the filesystem are visible to it. Each call to unveil() specifies a path to either a directory or a file along with permissions for that path. The permissions are a combination of the following: - r: Read access (like the "rpath" promise) - w: Write access (like the "wpath" promise) - x: Execute access - c: Create/remove access (like the "cpath" promise) Attempts to open a path that has not been unveiled with fail with ENOENT. If the unveiled path lacks sufficient permissions, it will fail with EACCES. Like pledge(), subsequent calls to unveil() with the same path can only remove permissions, not add them. Once you call unveil(nullptr, nullptr), the veil is locked, and it's no longer possible to unveil any more paths for the process, ever. This concept comes from OpenBSD, and their implementation does various things differently, I'm sure. This is just a first implementation for SerenityOS, and we'll keep improving on it as we go. :^)
2020-01-20 21:12:04 +00:00
KResult validate_path_against_process_veil(StringView path, int options);
Rename: VirtualFileSystem -> VFS VirtualFileSystem::Node -> Vnode
2018-11-15 13:43:10 +00:00
bool is_vfs_root(InodeIdentifier) const;
Kernel: Rename FS => FileSystem This matches our common naming style better.
2021-07-10 22:20:38 +00:00
KResult traverse_directory_inode(Inode&, Function<bool(FileSystem::DirectoryEntryView const&)>);
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
A pass of style/naming cleanup in VFS.
2018-11-15 14:10:12 +00:00
Mount* find_mount_for_host(InodeIdentifier);
Mount* find_mount_for_guest(InodeIdentifier);
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
AK: Rename RetainPtr => RefPtr and Retained => NonnullRefPtr.
2019-06-21 16:37:47 +00:00
RefPtr<Inode> m_root_inode;
RefPtr<Custody> m_root_custody;
Kernel: Use ProtectedValue for VirtualFileSystem::m_mounts This is what VirtualFileSystem::m_lock was actually guarding, and wrapping it in a ProtectedValue makes it so much more obvious how it all works. :^)
2021-08-15 23:40:19 +00:00
Kernel: Rename ProtectedValue<T> => MutexProtected<T> Let's make it obvious what we're protecting it with.
2021-08-21 21:31:15 +00:00
MutexProtected<Vector<Mount, 16>> m_mounts;
Import all this stuff into a single repo called Serenity.
2018-10-10 09:53:07 +00:00
};
Kernel: Move all code into the Kernel namespace
2020-02-16 00:27:42 +00:00
}
Reference in a new issue Copy permalink