mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-23 08:00:20 +00:00
4a9c18afb9
Dr. POSIX really calls these "open file description", not just "file description", so let's call them exactly that. :^)
82 lines
2.6 KiB
C++
82 lines
2.6 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* Copyright (c) 2021, sin-ack <sin-ack@protonmail.com>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Badge.h>
|
|
#include <AK/Checked.h>
|
|
#include <AK/CircularQueue.h>
|
|
#include <AK/HashMap.h>
|
|
#include <AK/NonnullOwnPtr.h>
|
|
#include <Kernel/API/InodeWatcherEvent.h>
|
|
#include <Kernel/FileSystem/File.h>
|
|
#include <Kernel/Forward.h>
|
|
|
|
namespace Kernel {
|
|
|
|
// A specific description of a watch.
|
|
struct WatchDescription {
|
|
int wd;
|
|
Inode& inode;
|
|
unsigned event_mask;
|
|
|
|
static KResultOr<NonnullOwnPtr<WatchDescription>> create(int wd, Inode& inode, unsigned event_mask)
|
|
{
|
|
return adopt_nonnull_own_or_enomem(new (nothrow) WatchDescription(wd, inode, event_mask));
|
|
}
|
|
|
|
private:
|
|
WatchDescription(int wd, Inode& inode, unsigned event_mask)
|
|
: wd(wd)
|
|
, inode(inode)
|
|
, event_mask(event_mask)
|
|
{
|
|
}
|
|
};
|
|
|
|
class InodeWatcher final : public File {
|
|
public:
|
|
static KResultOr<NonnullRefPtr<InodeWatcher>> try_create();
|
|
virtual ~InodeWatcher() override;
|
|
|
|
virtual bool can_read(const OpenFileDescription&, size_t) const override;
|
|
virtual KResultOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
|
|
// Can't write to an inode watcher.
|
|
virtual bool can_write(const OpenFileDescription&, size_t) const override { return true; }
|
|
virtual KResultOr<size_t> write(OpenFileDescription&, u64, const UserOrKernelBuffer&, size_t) override { return EIO; }
|
|
virtual KResult close() override;
|
|
|
|
virtual String absolute_path(const OpenFileDescription&) const override;
|
|
virtual StringView class_name() const override { return "InodeWatcher"; };
|
|
virtual bool is_inode_watcher() const override { return true; }
|
|
|
|
void notify_inode_event(Badge<Inode>, InodeIdentifier, InodeWatcherEvent::Type, String const& name = {});
|
|
|
|
KResultOr<int> register_inode(Inode&, unsigned event_mask);
|
|
KResult unregister_by_wd(int);
|
|
void unregister_by_inode(Badge<Inode>, InodeIdentifier);
|
|
|
|
private:
|
|
explicit InodeWatcher() { }
|
|
|
|
mutable Mutex m_lock;
|
|
|
|
struct Event {
|
|
int wd { 0 };
|
|
InodeWatcherEvent::Type type { InodeWatcherEvent::Type::Invalid };
|
|
String path;
|
|
};
|
|
CircularQueue<Event, 32> m_queue;
|
|
Checked<int> m_wd_counter { 1 };
|
|
|
|
// NOTE: These two hashmaps provide two different ways of reaching the same
|
|
// watch description, so they will overlap.
|
|
HashMap<int, NonnullOwnPtr<WatchDescription>> m_wd_to_watches;
|
|
HashMap<InodeIdentifier, WatchDescription*> m_inode_to_watches;
|
|
};
|
|
|
|
}
|