2020-01-18 08:38:21 +00:00
|
|
|
/*
|
2021-08-16 23:05:06 +00:00
|
|
|
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
|
2021-05-12 19:17:51 +00:00
|
|
|
* Copyright (c) 2021, sin-ack <sin-ack@protonmail.com>
|
2020-01-18 08:38:21 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2019-05-16 01:02:37 +00:00
|
|
|
#pragma once
|
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
#include <AK/Error.h>
|
2019-05-16 01:02:37 +00:00
|
|
|
#include <AK/Function.h>
|
2021-07-21 19:23:39 +00:00
|
|
|
#include <AK/HashTable.h>
|
2021-05-26 09:18:23 +00:00
|
|
|
#include <AK/IntrusiveList.h>
|
2019-05-16 01:02:37 +00:00
|
|
|
#include <AK/WeakPtr.h>
|
2020-07-16 21:23:03 +00:00
|
|
|
#include <Kernel/FileSystem/FIFO.h>
|
2019-05-28 09:53:16 +00:00
|
|
|
#include <Kernel/FileSystem/FileSystem.h>
|
2019-05-16 01:02:37 +00:00
|
|
|
#include <Kernel/FileSystem/InodeIdentifier.h>
|
|
|
|
#include <Kernel/FileSystem/InodeMetadata.h>
|
2020-02-16 00:50:16 +00:00
|
|
|
#include <Kernel/Forward.h>
|
2021-08-16 23:05:06 +00:00
|
|
|
#include <Kernel/Library/ListedRefCounted.h>
|
2021-07-18 07:10:27 +00:00
|
|
|
#include <Kernel/Locking/Mutex.h>
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2020-02-16 00:27:42 +00:00
|
|
|
namespace Kernel {
|
|
|
|
|
2021-12-28 22:22:14 +00:00
|
|
|
class Inode : public ListedRefCounted<Inode, LockType::Spinlock>
|
2021-09-16 00:10:03 +00:00
|
|
|
, public Weakable<Inode> {
|
2021-07-10 22:25:24 +00:00
|
|
|
friend class VirtualFileSystem;
|
2021-07-10 22:20:38 +00:00
|
|
|
friend class FileSystem;
|
2019-05-28 09:53:16 +00:00
|
|
|
|
2019-05-16 01:02:37 +00:00
|
|
|
public:
|
|
|
|
virtual ~Inode();
|
|
|
|
|
2022-01-10 23:51:05 +00:00
|
|
|
virtual void remove_from_secondary_lists() { }
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2021-07-10 22:20:38 +00:00
|
|
|
FileSystem& fs() { return m_file_system; }
|
|
|
|
FileSystem const& fs() const { return m_file_system; }
|
2021-11-18 14:11:31 +00:00
|
|
|
FileSystemID fsid() const { return m_file_system.fsid(); }
|
2021-02-12 08:18:47 +00:00
|
|
|
InodeIndex index() const { return m_index; }
|
2019-05-16 01:02:37 +00:00
|
|
|
|
|
|
|
size_t size() const { return metadata().size; }
|
|
|
|
bool is_symlink() const { return metadata().is_symlink(); }
|
|
|
|
bool is_directory() const { return metadata().is_directory(); }
|
|
|
|
bool is_character_device() const { return metadata().is_character_device(); }
|
|
|
|
mode_t mode() const { return metadata().mode; }
|
|
|
|
|
|
|
|
InodeIdentifier identifier() const { return { fsid(), index() }; }
|
|
|
|
virtual InodeMetadata metadata() const = 0;
|
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<NonnullOwnPtr<KBuffer>> read_entire(OpenFileDescription* = nullptr) const;
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<void> attach(OpenFileDescription&) { return {}; }
|
2021-09-07 11:39:11 +00:00
|
|
|
virtual void detach(OpenFileDescription&) { }
|
|
|
|
virtual void did_seek(OpenFileDescription&, off_t) { }
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<size_t> read_bytes(off_t, size_t, UserOrKernelBuffer& buffer, OpenFileDescription*) const = 0;
|
2021-11-10 14:42:39 +00:00
|
|
|
virtual ErrorOr<void> traverse_as_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)>) const = 0;
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<NonnullRefPtr<Inode>> lookup(StringView name) = 0;
|
2022-04-01 17:58:27 +00:00
|
|
|
virtual ErrorOr<size_t> write_bytes(off_t, size_t, UserOrKernelBuffer const& data, OpenFileDescription*) = 0;
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<NonnullRefPtr<Inode>> create_child(StringView name, mode_t, dev_t, UserID, GroupID) = 0;
|
2021-11-10 23:55:02 +00:00
|
|
|
virtual ErrorOr<void> add_child(Inode&, StringView name, mode_t) = 0;
|
|
|
|
virtual ErrorOr<void> remove_child(StringView name) = 0;
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<void> chmod(mode_t) = 0;
|
|
|
|
virtual ErrorOr<void> chown(UserID, GroupID) = 0;
|
|
|
|
virtual ErrorOr<void> truncate(u64) { return {}; }
|
|
|
|
virtual ErrorOr<NonnullRefPtr<Custody>> resolve_as_link(Custody& base, RefPtr<Custody>* out_parent, int options, int symlink_recursion_level) const;
|
|
|
|
|
|
|
|
virtual ErrorOr<int> get_block_address(int) { return ENOTSUP; }
|
2021-01-30 20:12:49 +00:00
|
|
|
|
2022-02-07 11:57:57 +00:00
|
|
|
RefPtr<LocalSocket> bound_socket() const;
|
2019-05-16 01:02:37 +00:00
|
|
|
bool bind_socket(LocalSocket&);
|
|
|
|
bool unbind_socket();
|
|
|
|
|
|
|
|
bool is_metadata_dirty() const { return m_metadata_dirty; }
|
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<void> set_atime(time_t);
|
|
|
|
virtual ErrorOr<void> set_ctime(time_t);
|
|
|
|
virtual ErrorOr<void> set_mtime(time_t);
|
|
|
|
virtual ErrorOr<void> increment_link_count();
|
|
|
|
virtual ErrorOr<void> decrement_link_count();
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<void> flush_metadata() = 0;
|
2019-05-16 01:02:37 +00:00
|
|
|
|
|
|
|
void will_be_destroyed();
|
|
|
|
|
2022-02-13 23:46:34 +00:00
|
|
|
ErrorOr<void> set_shared_vmobject(Memory::SharedInodeVMObject&);
|
2021-08-06 11:49:36 +00:00
|
|
|
RefPtr<Memory::SharedInodeVMObject> shared_vmobject() const;
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2021-09-12 03:28:59 +00:00
|
|
|
static void sync_all();
|
|
|
|
void sync();
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2022-02-03 00:39:49 +00:00
|
|
|
bool has_watchers() const;
|
2019-11-04 15:31:46 +00:00
|
|
|
|
2022-01-25 13:13:59 +00:00
|
|
|
ErrorOr<void> register_watcher(Badge<InodeWatcher>, InodeWatcher&);
|
2019-07-22 18:01:11 +00:00
|
|
|
void unregister_watcher(Badge<InodeWatcher>, InodeWatcher&);
|
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<NonnullRefPtr<FIFO>> fifo();
|
2020-07-16 21:23:03 +00:00
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<void> can_apply_flock(OpenFileDescription const&, flock const&) const;
|
|
|
|
ErrorOr<void> apply_flock(Process const&, OpenFileDescription const&, Userspace<flock const*>);
|
|
|
|
ErrorOr<void> get_flock(OpenFileDescription const&, Userspace<flock*>) const;
|
2021-09-07 11:39:11 +00:00
|
|
|
void remove_flocks_for_description(OpenFileDescription const&);
|
2021-07-19 05:29:56 +00:00
|
|
|
|
2019-05-16 01:02:37 +00:00
|
|
|
protected:
|
2021-07-10 22:20:38 +00:00
|
|
|
Inode(FileSystem&, InodeIndex);
|
2019-07-22 18:01:11 +00:00
|
|
|
void set_metadata_dirty(bool);
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<void> prepare_to_write_data();
|
2019-05-16 01:02:37 +00:00
|
|
|
|
2022-01-11 20:04:53 +00:00
|
|
|
void did_add_child(InodeIdentifier child_id, StringView);
|
|
|
|
void did_remove_child(InodeIdentifier child_id, StringView);
|
2021-05-12 19:17:51 +00:00
|
|
|
void did_modify_contents();
|
|
|
|
void did_delete_self();
|
2020-07-04 11:36:55 +00:00
|
|
|
|
2021-07-17 19:17:39 +00:00
|
|
|
mutable Mutex m_inode_lock { "Inode" };
|
2019-05-16 01:02:37 +00:00
|
|
|
|
|
|
|
private:
|
2021-07-10 22:20:38 +00:00
|
|
|
FileSystem& m_file_system;
|
2021-02-12 08:18:47 +00:00
|
|
|
InodeIndex m_index { 0 };
|
2021-08-06 11:49:36 +00:00
|
|
|
WeakPtr<Memory::SharedInodeVMObject> m_shared_vmobject;
|
2022-02-07 11:57:57 +00:00
|
|
|
RefPtr<LocalSocket> m_bound_socket;
|
2022-02-03 00:39:49 +00:00
|
|
|
SpinlockProtected<HashTable<InodeWatcher*>> m_watchers;
|
2019-05-16 01:02:37 +00:00
|
|
|
bool m_metadata_dirty { false };
|
2020-07-16 21:23:03 +00:00
|
|
|
RefPtr<FIFO> m_fifo;
|
2021-05-26 09:18:23 +00:00
|
|
|
IntrusiveListNode<Inode> m_inode_list_node;
|
|
|
|
|
2021-07-19 05:29:56 +00:00
|
|
|
struct Flock {
|
|
|
|
off_t start;
|
|
|
|
off_t len;
|
2021-09-07 11:39:11 +00:00
|
|
|
OpenFileDescription const* owner;
|
2021-07-19 05:29:56 +00:00
|
|
|
pid_t pid;
|
2021-09-16 06:46:45 +00:00
|
|
|
short type;
|
2021-07-19 05:29:56 +00:00
|
|
|
};
|
|
|
|
|
2022-02-03 16:28:45 +00:00
|
|
|
SpinlockProtected<Vector<Flock>> m_flocks;
|
2021-07-19 05:29:56 +00:00
|
|
|
|
2021-05-26 09:18:23 +00:00
|
|
|
public:
|
2021-09-09 12:00:59 +00:00
|
|
|
using AllInstancesList = IntrusiveList<&Inode::m_inode_list_node>;
|
2021-08-21 23:37:17 +00:00
|
|
|
static SpinlockProtected<Inode::AllInstancesList>& all_instances();
|
2019-05-16 01:02:37 +00:00
|
|
|
};
|
2020-02-16 00:27:42 +00:00
|
|
|
|
|
|
|
}
|