RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 00:27:45 +00:00
Code Issues Activity Actions

Kernel: Rename FileDescription => OpenFileDescription

Browse source 
Dr. POSIX really calls these "open file description", not just
"file description", so let's call them exactly that. :^)
This commit is contained in:
Andreas Kling 2021-09-07 13:39:11 +02:00
parent dbd639a2d8
commit 4a9c18afb9
135 changed files with 680 additions and 680 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Kernel/TTY/MasterPTY.cpp
View file

@ -62,14 +62,14 @@ String MasterPTY::pts_name() const
return m_pts_name;
}
KResultOr<size_t> MasterPTY::read(FileDescription&, u64, UserOrKernelBuffer& buffer, size_t size)
KResultOr<size_t> MasterPTY::read(OpenFileDescription&, u64, UserOrKernelBuffer& buffer, size_t size)
{
if (!m_slave && m_buffer->is_empty())
return 0;
return m_buffer->read(buffer, size);
}
KResultOr<size_t> MasterPTY::write(FileDescription&, u64, const UserOrKernelBuffer& buffer, size_t size)
KResultOr<size_t> MasterPTY::write(OpenFileDescription&, u64, const UserOrKernelBuffer& buffer, size_t size)
{
if (!m_slave)
return EIO;
@ -77,14 +77,14 @@ KResultOr<size_t> MasterPTY::write(FileDescription&, u64, const UserOrKernelBuff
return size;
}
bool MasterPTY::can_read(const FileDescription&, size_t) const
bool MasterPTY::can_read(const OpenFileDescription&, size_t) const
{
if (!m_slave)
return true;
return !m_buffer->is_empty();
}
bool MasterPTY::can_write(const FileDescription&, size_t) const
bool MasterPTY::can_write(const OpenFileDescription&, size_t) const
{
return true;
}
@ -93,7 +93,7 @@ void MasterPTY::notify_slave_closed(Badge<SlavePTY>)
{
dbgln_if(MASTERPTY_DEBUG, "MasterPTY({}): slave closed, my retains: {}, slave retains: {}", m_index, ref_count(), m_slave->ref_count());
// +1 ref for my MasterPTY::m_slave
// +1 ref for FileDescription::m_device
// +1 ref for OpenFileDescription::m_device
if (m_slave->ref_count() == 2)
m_slave = nullptr;
}
@ -115,7 +115,7 @@ bool MasterPTY::can_write_from_slave() const
KResult MasterPTY::close()
{
InterruptDisabler disabler;
// After the closing FileDescription dies, slave is the only thing keeping me alive.
// After the closing OpenFileDescription dies, slave is the only thing keeping me alive.
// From this point, let's consider ourselves closed.
m_closed = true;
@ -125,7 +125,7 @@ KResult MasterPTY::close()
return KSuccess;
}
KResult MasterPTY::ioctl(FileDescription& description, unsigned request, Userspace<void*> arg)
KResult MasterPTY::ioctl(OpenFileDescription& description, unsigned request, Userspace<void*> arg)
{
REQUIRE_PROMISE(tty);
if (!m_slave)
@ -135,7 +135,7 @@ KResult MasterPTY::ioctl(FileDescription& description, unsigned request, Userspa
return EINVAL;
}
String MasterPTY::absolute_path(const FileDescription&) const
String MasterPTY::absolute_path(const OpenFileDescription&) const
{
return String::formatted("ptm:{}", m_pts_name);
}

12
Kernel/TTY/MasterPTY.h
View file

@ -26,7 +26,7 @@ public:
void notify_slave_closed(Badge<SlavePTY>);
bool is_closed() const { return m_closed; }
virtual String absolute_path(const FileDescription&) const override;
virtual String absolute_path(const OpenFileDescription&) const override;
// ^Device
virtual mode_t required_mode() const override { return 0640; }
@ -35,13 +35,13 @@ public:
private:
explicit MasterPTY(unsigned index, NonnullOwnPtr<DoubleBuffer> buffer);
// ^CharacterDevice
virtual KResultOr<size_t> read(FileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual KResultOr<size_t> write(FileDescription&, u64, const UserOrKernelBuffer&, size_t) override;
virtual bool can_read(const FileDescription&, size_t) const override;
virtual bool can_write(const FileDescription&, size_t) const override;
virtual KResultOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual KResultOr<size_t> write(OpenFileDescription&, u64, const UserOrKernelBuffer&, size_t) override;
virtual bool can_read(const OpenFileDescription&, size_t) const override;
virtual bool can_write(const OpenFileDescription&, size_t) const override;
virtual KResult close() override;
virtual bool is_master_pty() const override { return true; }
virtual KResult ioctl(FileDescription&, unsigned request, Userspace<void*> arg) override;
virtual KResult ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg) override;
virtual StringView class_name() const override { return "MasterPTY"; }
RefPtr<SlavePTY> m_slave;

8
Kernel/TTY/PTYMultiplexer.cpp
View file

@ -6,7 +6,7 @@
#include <AK/Singleton.h>
#include <Kernel/Debug.h>
#include <Kernel/FileSystem/FileDescription.h>
#include <Kernel/FileSystem/OpenFileDescription.h>
#include <Kernel/Sections.h>
#include <Kernel/TTY/MasterPTY.h>
#include <Kernel/TTY/PTYMultiplexer.h>
@ -35,9 +35,9 @@ UNMAP_AFTER_INIT PTYMultiplexer::~PTYMultiplexer()
{
}
KResultOr<NonnullRefPtr<FileDescription>> PTYMultiplexer::open(int options)
KResultOr<NonnullRefPtr<OpenFileDescription>> PTYMultiplexer::open(int options)
{
return m_freelist.with_exclusive([&](auto& freelist) -> KResultOr<NonnullRefPtr<FileDescription>> {
return m_freelist.with_exclusive([&](auto& freelist) -> KResultOr<NonnullRefPtr<OpenFileDescription>> {
if (freelist.is_empty())
return EBUSY;
@ -46,7 +46,7 @@ KResultOr<NonnullRefPtr<FileDescription>> PTYMultiplexer::open(int options)
if (!master)
return ENOMEM;
dbgln_if(PTMX_DEBUG, "PTYMultiplexer::open: Vending master {}", master->index());
auto description = TRY(FileDescription::try_create(*master));
auto description = TRY(OpenFileDescription::try_create(*master));
description->set_rw_mode(options);
description->set_file_flags(options);
return description;

10
Kernel/TTY/PTYMultiplexer.h
View file

@ -27,11 +27,11 @@ public:
static PTYMultiplexer& the();
// ^CharacterDevice
virtual KResultOr<NonnullRefPtr<FileDescription>> open(int options) override;
virtual KResultOr<size_t> read(FileDescription&, u64, UserOrKernelBuffer&, size_t) override { return 0; }
virtual KResultOr<size_t> write(FileDescription&, u64, const UserOrKernelBuffer&, size_t) override { return 0; }
virtual bool can_read(const FileDescription&, size_t) const override { return true; }
virtual bool can_write(const FileDescription&, size_t) const override { return true; }
virtual KResultOr<NonnullRefPtr<OpenFileDescription>> open(int options) override;
virtual KResultOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override { return 0; }
virtual KResultOr<size_t> write(OpenFileDescription&, u64, const UserOrKernelBuffer&, size_t) override { return 0; }
virtual bool can_read(const OpenFileDescription&, size_t) const override { return true; }
virtual bool can_write(const OpenFileDescription&, size_t) const override { return true; }
void notify_master_destroyed(Badge<MasterPTY>, unsigned index);

6
Kernel/TTY/SlavePTY.cpp
View file

@ -82,19 +82,19 @@ KResultOr<size_t> SlavePTY::on_tty_write(const UserOrKernelBuffer& data, size_t
return m_master->on_slave_write(data, size);
}
bool SlavePTY::can_write(const FileDescription&, size_t) const
bool SlavePTY::can_write(const OpenFileDescription&, size_t) const
{
return m_master->can_write_from_slave();
}
bool SlavePTY::can_read(const FileDescription& description, size_t offset) const
bool SlavePTY::can_read(const OpenFileDescription& description, size_t offset) const
{
if (m_master->is_closed())
return true;
return TTY::can_read(description, offset);
}
KResultOr<size_t> SlavePTY::read(FileDescription& description, u64 offset, UserOrKernelBuffer& buffer, size_t size)
KResultOr<size_t> SlavePTY::read(OpenFileDescription& description, u64 offset, UserOrKernelBuffer& buffer, size_t size)
{
if (m_master->is_closed())
return 0;

6
Kernel/TTY/SlavePTY.h
View file

@ -32,9 +32,9 @@ private:
virtual void echo(u8) override;
// ^CharacterDevice
virtual bool can_read(const FileDescription&, size_t) const override;
virtual KResultOr<size_t> read(FileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual bool can_write(const FileDescription&, size_t) const override;
virtual bool can_read(const OpenFileDescription&, size_t) const override;
virtual KResultOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual bool can_write(const OpenFileDescription&, size_t) const override;
virtual StringView class_name() const override { return "SlavePTY"; }
virtual KResult close() override;

10
Kernel/TTY/TTY.cpp
View file

@ -41,7 +41,7 @@ void TTY::set_default_termios()
memcpy(m_termios.c_cc, ttydefchars, sizeof(ttydefchars));
}
KResultOr<size_t> TTY::read(FileDescription&, u64, UserOrKernelBuffer& buffer, size_t size)
KResultOr<size_t> TTY::read(OpenFileDescription&, u64, UserOrKernelBuffer& buffer, size_t size)
{
if (Process::current().pgid() != pgid()) {
// FIXME: Should we propagate this error path somehow?
@ -80,7 +80,7 @@ KResultOr<size_t> TTY::read(FileDescription&, u64, UserOrKernelBuffer& buffer, s
return result;
}
KResultOr<size_t> TTY::write(FileDescription&, u64, const UserOrKernelBuffer& buffer, size_t size)
KResultOr<size_t> TTY::write(OpenFileDescription&, u64, const UserOrKernelBuffer& buffer, size_t size)
{
if (m_termios.c_lflag & TOSTOP && Process::current().pgid() != pgid()) {
[[maybe_unused]] auto rc = Process::current().send_signal(SIGTTOU, nullptr);
@ -139,7 +139,7 @@ void TTY::process_output(u8 ch, Functor put_char)
}
}
bool TTY::can_read(const FileDescription&, size_t) const
bool TTY::can_read(const OpenFileDescription&, size_t) const
{
if (in_canonical_mode()) {
return m_available_lines > 0;
@ -147,7 +147,7 @@ bool TTY::can_read(const FileDescription&, size_t) const
return !m_input_buffer.is_empty();
}
bool TTY::can_write(const FileDescription&, size_t) const
bool TTY::can_write(const OpenFileDescription&, size_t) const
{
return true;
}
@ -454,7 +454,7 @@ KResult TTY::set_termios(const termios& t)
return rc;
}
KResult TTY::ioctl(FileDescription&, unsigned request, Userspace<void*> arg)
KResult TTY::ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg)
{
REQUIRE_PROMISE(tty);
auto& current_process = Process::current();

12
Kernel/TTY/TTY.h
View file

@ -21,12 +21,12 @@ class TTY : public CharacterDevice {
public:
virtual ~TTY() override;
virtual KResultOr<size_t> read(FileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual KResultOr<size_t> write(FileDescription&, u64, const UserOrKernelBuffer&, size_t) override;
virtual bool can_read(const FileDescription&, size_t) const override;
virtual bool can_write(const FileDescription&, size_t) const override;
virtual KResult ioctl(FileDescription&, unsigned request, Userspace<void*> arg) override final;
virtual String absolute_path(const FileDescription&) const override { return tty_name(); }
virtual KResultOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
virtual KResultOr<size_t> write(OpenFileDescription&, u64, const UserOrKernelBuffer&, size_t) override;
virtual bool can_read(const OpenFileDescription&, size_t) const override;
virtual bool can_write(const OpenFileDescription&, size_t) const override;
virtual KResult ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg) override final;
virtual String absolute_path(const OpenFileDescription&) const override { return tty_name(); }
virtual String const& tty_name() const = 0;