serenity/Kernel/Devices/Generic/DeviceControlDevice.cpp
Liav A 5dcf03ad9a Kernel/Devices: Introduce the LoopDevice device
This device is a block device that allows a user to effectively treat an
Inode as a block device.

The static construction method is given an OpenFileDescription reference
but validates that:
- The description has a valid custody (so it's not some arbitrary file).
  Failing this requirement will yield EINVAL.
- The description custody points to an Inode which is a regular file, as
  we only support (seekable) regular files. Failing this requirement
  will yield ENOTSUP.

LoopDevice can be used to mount a regular file on the filesystem like
other supported types of (physical) block devices.
2024-03-13 15:33:47 -06:00

87 lines
2.8 KiB
C++

/*
* Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <Kernel/API/Ioctl.h>
#include <Kernel/Devices/DeviceManagement.h>
#include <Kernel/Devices/Generic/DeviceControlDevice.h>
#include <Kernel/Devices/Loop/LoopDevice.h>
#include <Kernel/Library/StdLib.h>
namespace Kernel {
UNMAP_AFTER_INIT NonnullLockRefPtr<DeviceControlDevice> DeviceControlDevice::must_create()
{
auto device_control_device_or_error = DeviceManagement::try_create_device<DeviceControlDevice>();
// FIXME: Find a way to propagate errors
VERIFY(!device_control_device_or_error.is_error());
return device_control_device_or_error.release_value();
}
bool DeviceControlDevice::can_read(OpenFileDescription const&, u64) const
{
return DeviceManagement::the().event_queue({}).with([](auto& queue) -> bool {
return !queue.is_empty();
});
}
UNMAP_AFTER_INIT DeviceControlDevice::DeviceControlDevice()
: CharacterDevice(2, 10)
{
}
UNMAP_AFTER_INIT DeviceControlDevice::~DeviceControlDevice() = default;
ErrorOr<size_t> DeviceControlDevice::read(OpenFileDescription&, u64 offset, UserOrKernelBuffer& buffer, size_t size)
{
if (offset != 0)
return Error::from_errno(EINVAL);
if ((size % sizeof(DeviceEvent)) != 0)
return Error::from_errno(EOVERFLOW);
return DeviceManagement::the().event_queue({}).with([&](auto& queue) -> ErrorOr<size_t> {
size_t nread = 0;
for (size_t event_index = 0; event_index < (size / sizeof(DeviceEvent)); event_index++) {
if (queue.is_empty())
break;
auto event = queue.dequeue();
TRY(buffer.write(&event, nread, sizeof(DeviceEvent)));
nread += sizeof(DeviceEvent);
}
return nread;
});
}
ErrorOr<void> DeviceControlDevice::ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg)
{
switch (request) {
case DEVCTL_CREATE_LOOP_DEVICE: {
unsigned fd { 0 };
TRY(copy_from_user(&fd, static_ptr_cast<unsigned*>(arg)));
auto file_description = TRY(Process::current().open_file_description(fd));
auto device = TRY(LoopDevice::create_with_file_description(file_description));
unsigned index = device->index();
return copy_to_user(static_ptr_cast<unsigned*>(arg), &index);
}
case DEVCTL_DESTROY_LOOP_DEVICE: {
unsigned index { 0 };
TRY(copy_from_user(&index, static_ptr_cast<unsigned*>(arg)));
return LoopDevice::all_instances().with([index](auto& list) -> ErrorOr<void> {
for (auto& device : list) {
if (device.index() == index) {
device.remove({});
return {};
}
}
return Error::from_errno(ENODEV);
});
}
default:
return Error::from_errno(EINVAL);
};
}
}