Skip to content

Commit

Permalink
Kernel: Rename FileDescriptor to FileDescription.
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
awesomekling committed Jun 7, 2019
1 parent 69a6ce9 commit 08cd75a
Show file tree
Hide file tree
Showing 70 changed files with 373 additions and 373 deletions.
6 changes: 3 additions & 3 deletions Kernel/Console.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ Console::~Console()
{
}

bool Console::can_read(FileDescriptor&) const
bool Console::can_read(FileDescription&) const
{
return false;
}

ssize_t Console::read(FileDescriptor&, byte*, ssize_t)
ssize_t Console::read(FileDescription&, byte*, ssize_t)
{
// FIXME: Implement reading from the console.
// Maybe we could use a ring buffer for this device?
return 0;
}

ssize_t Console::write(FileDescriptor&, const byte* data, ssize_t size)
ssize_t Console::write(FileDescription&, const byte* data, ssize_t size)
{
if (!size)
return 0;
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Console.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ class Console final : public CharacterDevice {
virtual ~Console() override;

// ^CharacterDevice
virtual bool can_read(FileDescriptor&) const override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual const char* class_name() const override { return "Console"; }

void set_implementation(ConsoleImplementation* implementation) { m_implementation = implementation; }
Expand Down
12 changes: 6 additions & 6 deletions Kernel/Devices/BXVGADevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ dword BXVGADevice::find_framebuffer_address()
return framebuffer_address;
}

KResultOr<Region*> BXVGADevice::mmap(Process& process, FileDescriptor&, LinearAddress preferred_laddr, size_t offset, size_t size, int prot)
KResultOr<Region*> BXVGADevice::mmap(Process& process, FileDescription&, LinearAddress preferred_laddr, size_t offset, size_t size, int prot)
{
ASSERT(offset == 0);
ASSERT(size == framebuffer_size_in_bytes());
Expand All @@ -104,7 +104,7 @@ KResultOr<Region*> BXVGADevice::mmap(Process& process, FileDescriptor&, LinearAd
return region;
}

int BXVGADevice::ioctl(FileDescriptor&, unsigned request, unsigned arg)
int BXVGADevice::ioctl(FileDescription&, unsigned request, unsigned arg)
{
switch (request) {
case BXVGA_DEV_IOCTL_SET_Y_OFFSET:
Expand All @@ -124,22 +124,22 @@ int BXVGADevice::ioctl(FileDescriptor&, unsigned request, unsigned arg)
};
}

bool BXVGADevice::can_read(FileDescriptor&) const
bool BXVGADevice::can_read(FileDescription&) const
{
ASSERT_NOT_REACHED();
}

bool BXVGADevice::can_write(FileDescriptor&) const
bool BXVGADevice::can_write(FileDescription&) const
{
ASSERT_NOT_REACHED();
}

ssize_t BXVGADevice::read(FileDescriptor&, byte*, ssize_t)
ssize_t BXVGADevice::read(FileDescription&, byte*, ssize_t)
{
ASSERT_NOT_REACHED();
}

ssize_t BXVGADevice::write(FileDescriptor&, const byte*, ssize_t)
ssize_t BXVGADevice::write(FileDescription&, const byte*, ssize_t)
{
ASSERT_NOT_REACHED();
}
12 changes: 6 additions & 6 deletions Kernel/Devices/BXVGADevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ class BXVGADevice final : public BlockDevice {
void set_resolution(int width, int height);
void set_y_offset(int);

virtual int ioctl(FileDescriptor&, unsigned request, unsigned arg) override;
virtual KResultOr<Region*> mmap(Process&, FileDescriptor&, LinearAddress preferred_laddr, size_t offset, size_t, int prot) override;
virtual int ioctl(FileDescription&, unsigned request, unsigned arg) override;
virtual KResultOr<Region*> mmap(Process&, FileDescription&, LinearAddress preferred_laddr, size_t offset, size_t, int prot) override;

size_t framebuffer_size_in_bytes() const { return m_framebuffer_size.area() * sizeof(dword) * 2; }
Size framebuffer_size() const { return m_framebuffer_size; }

private:
virtual const char* class_name() const override { return "BXVGA"; }
virtual bool can_read(FileDescriptor&) const override;
virtual bool can_write(FileDescriptor&) const override;
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual bool can_write(FileDescription&) const override;
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;

void set_register(word index, word value);
dword find_framebuffer_address();
Expand Down
2 changes: 1 addition & 1 deletion Kernel/Devices/DebugLogDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ DebugLogDevice::~DebugLogDevice()
{
}

ssize_t DebugLogDevice::write(FileDescriptor&, const byte* data, ssize_t data_size)
ssize_t DebugLogDevice::write(FileDescription&, const byte* data, ssize_t data_size)
{
for (int i = 0; i < data_size; ++i)
IO::out8(0xe9, data[i]);
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/DebugLogDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ class DebugLogDevice final : public CharacterDevice {

private:
// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override { return 0; }
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual bool can_read(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescription&, byte*, ssize_t) override { return 0; }
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual bool can_read(FileDescription&) const override { return true; }
virtual const char* class_name() const override { return "DebugLogDevice"; }
};
2 changes: 1 addition & 1 deletion Kernel/Devices/Device.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Device::~Device()
VFS::the().unregister_device({}, *this);
}

String Device::absolute_path(const FileDescriptor&) const
String Device::absolute_path(const FileDescription&) const
{
return String::format("device:%u,%u (%s)", m_major, m_minor, class_name());
}
2 changes: 1 addition & 1 deletion Kernel/Devices/Device.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Device : public File {
unsigned major() const { return m_major; }
unsigned minor() const { return m_minor; }

virtual String absolute_path(const FileDescriptor&) const override;
virtual String absolute_path(const FileDescription&) const override;

uid_t uid() const { return m_uid; }
uid_t gid() const { return m_gid; }
Expand Down
6 changes: 3 additions & 3 deletions Kernel/Devices/FullDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ FullDevice::~FullDevice()
{
}

bool FullDevice::can_read(FileDescriptor&) const
bool FullDevice::can_read(FileDescription&) const
{
return true;
}

ssize_t FullDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
ssize_t FullDevice::read(FileDescription&, byte* buffer, ssize_t size)
{
ssize_t count = min(PAGE_SIZE, size);
memset(buffer, 0, (size_t)count);
return count;
}

ssize_t FullDevice::write(FileDescriptor&, const byte*, ssize_t size)
ssize_t FullDevice::write(FileDescription&, const byte*, ssize_t size)
{
if (size == 0)
return 0;
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/FullDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ class FullDevice final : public CharacterDevice {

private:
// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_read(FileDescriptor&) const override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual const char* class_name() const override { return "FullDevice"; }
};
6 changes: 3 additions & 3 deletions Kernel/Devices/KeyboardDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -208,12 +208,12 @@ KeyboardDevice::~KeyboardDevice()
{
}

bool KeyboardDevice::can_read(FileDescriptor&) const
bool KeyboardDevice::can_read(FileDescription&) const
{
return !m_queue.is_empty();
}

ssize_t KeyboardDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
ssize_t KeyboardDevice::read(FileDescription&, byte* buffer, ssize_t size)
{
ssize_t nread = 0;
while (nread < size) {
Expand All @@ -229,7 +229,7 @@ ssize_t KeyboardDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
return nread;
}

ssize_t KeyboardDevice::write(FileDescriptor&, const byte*, ssize_t)
ssize_t KeyboardDevice::write(FileDescription&, const byte*, ssize_t)
{
return 0;
}
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/KeyboardDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class KeyboardDevice final : public IRQHandler
void set_client(KeyboardClient* client) { m_client = client; }

// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte* buffer, ssize_t) override;
virtual bool can_read(FileDescriptor&) const override;
virtual ssize_t write(FileDescriptor&, const byte* buffer, ssize_t) override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescription&, byte* buffer, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual ssize_t write(FileDescription&, const byte* buffer, ssize_t) override;
virtual bool can_write(FileDescription&) const override { return true; }

private:
// ^IRQHandler
Expand Down
6 changes: 3 additions & 3 deletions Kernel/Devices/NullDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ NullDevice::~NullDevice()
{
}

bool NullDevice::can_read(FileDescriptor&) const
bool NullDevice::can_read(FileDescription&) const
{
return true;
}

ssize_t NullDevice::read(FileDescriptor&, byte*, ssize_t)
ssize_t NullDevice::read(FileDescription&, byte*, ssize_t)
{
return 0;
}

ssize_t NullDevice::write(FileDescriptor&, const byte*, ssize_t buffer_size)
ssize_t NullDevice::write(FileDescription&, const byte*, ssize_t buffer_size)
{
return min(PAGE_SIZE, buffer_size);
}
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/NullDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ class NullDevice final : public CharacterDevice {

private:
// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual bool can_read(FileDescriptor&) const override;
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual bool can_read(FileDescription&) const override;
virtual const char* class_name() const override { return "NullDevice"; }
};
6 changes: 3 additions & 3 deletions Kernel/Devices/PS2MouseDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -218,12 +218,12 @@ byte PS2MouseDevice::mouse_read()
return IO::in8(0x60);
}

bool PS2MouseDevice::can_read(FileDescriptor&) const
bool PS2MouseDevice::can_read(FileDescription&) const
{
return !m_queue.is_empty();
}

ssize_t PS2MouseDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
ssize_t PS2MouseDevice::read(FileDescription&, byte* buffer, ssize_t size)
{
ssize_t nread = 0;
while (nread < size) {
Expand All @@ -239,7 +239,7 @@ ssize_t PS2MouseDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
return nread;
}

ssize_t PS2MouseDevice::write(FileDescriptor&, const byte*, ssize_t)
ssize_t PS2MouseDevice::write(FileDescription&, const byte*, ssize_t)
{
return 0;
}
8 changes: 4 additions & 4 deletions Kernel/Devices/PS2MouseDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ class PS2MouseDevice final : public IRQHandler
static PS2MouseDevice& the();

// ^CharacterDevice
virtual bool can_read(FileDescriptor&) const override;
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual bool can_read(FileDescription&) const override;
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_write(FileDescription&) const override { return true; }

private:
// ^IRQHandler
Expand Down
6 changes: 3 additions & 3 deletions Kernel/Devices/RandomDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ static void mysrand(unsigned seed)
}
#endif

bool RandomDevice::can_read(FileDescriptor&) const
bool RandomDevice::can_read(FileDescription&) const
{
return true;
}

ssize_t RandomDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
ssize_t RandomDevice::read(FileDescription&, byte* buffer, ssize_t size)
{
const int range = 'z' - 'a';
ssize_t nread = min(size, PAGE_SIZE);
Expand All @@ -42,7 +42,7 @@ ssize_t RandomDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
return nread;
}

ssize_t RandomDevice::write(FileDescriptor&, const byte*, ssize_t size)
ssize_t RandomDevice::write(FileDescription&, const byte*, ssize_t size)
{
// FIXME: Use input for entropy? I guess that could be a neat feature?
return min(PAGE_SIZE, size);
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/RandomDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ class RandomDevice final : public CharacterDevice {

private:
// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_read(FileDescriptor&) const override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual const char* class_name() const override { return "RandomDevice"; }
};
6 changes: 3 additions & 3 deletions Kernel/Devices/ZeroDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ ZeroDevice::~ZeroDevice()
{
}

bool ZeroDevice::can_read(FileDescriptor&) const
bool ZeroDevice::can_read(FileDescription&) const
{
return true;
}

ssize_t ZeroDevice::read(FileDescriptor&, byte* buffer, ssize_t size)
ssize_t ZeroDevice::read(FileDescription&, byte* buffer, ssize_t size)
{
ssize_t count = min(PAGE_SIZE, size);
memset(buffer, 0, (size_t)count);
return count;
}

ssize_t ZeroDevice::write(FileDescriptor&, const byte*, ssize_t size)
ssize_t ZeroDevice::write(FileDescription&, const byte*, ssize_t size)
{
return min(PAGE_SIZE, size);
}
Expand Down
8 changes: 4 additions & 4 deletions Kernel/Devices/ZeroDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ class ZeroDevice final : public CharacterDevice {

private:
// ^CharacterDevice
virtual ssize_t read(FileDescriptor&, byte*, ssize_t) override;
virtual ssize_t write(FileDescriptor&, const byte*, ssize_t) override;
virtual bool can_read(FileDescriptor&) const override;
virtual bool can_write(FileDescriptor&) const override { return true; }
virtual ssize_t read(FileDescription&, byte*, ssize_t) override;
virtual ssize_t write(FileDescription&, const byte*, ssize_t) override;
virtual bool can_read(FileDescription&) const override;
virtual bool can_write(FileDescription&) const override { return true; }
virtual const char* class_name() const override { return "ZeroDevice"; }
};
Loading

0 comments on commit 08cd75a

Please sign in to comment.