ladybird/Kernel/Devices/RandomDevice.h

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <Kernel/Devices/CharacterDevice.h>

namespace Kernel {

class RandomDevice final : public CharacterDevice {
    friend class DeviceManagement;

public:
    static NonnullLockRefPtr<RandomDevice> must_create();
    virtual ~RandomDevice() override;

private:
    RandomDevice();

    // ^CharacterDevice
    virtual ErrorOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
    virtual ErrorOr<size_t> write(OpenFileDescription&, u64, UserOrKernelBuffer const&, size_t) override;
    virtual bool can_read(OpenFileDescription const&, u64) const override;
    virtual bool can_write(OpenFileDescription const&, u64) const override { return true; }
    virtual StringView class_name() const override { return "RandomDevice"sv; }
};

}
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 05:38:21 -03:00			`/*`
			`* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 05:24:48 -03:00			`* SPDX-License-Identifier: BSD-2-Clause`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 05:38:21 -03:00			`*/`

Add a simple /dev/random. 2018-10-14 19:44:54 -03:00			`#pragma once`

Kernel: Standardize the header include style to 'include <Kernel/...>' This is the overwhelming standard in the project, but there were some cases in the kernel which were not following it, lets fix those cases! 2021-07-11 16:02:15 -03:00			`#include <Kernel/Devices/CharacterDevice.h>`
Add a simple /dev/random. 2018-10-14 19:44:54 -03:00
Kernel: Move all code into the Kernel namespace 2020-02-15 21:27:42 -03:00			`namespace Kernel {`

Add a simple /dev/random. 2018-10-14 19:44:54 -03:00			`class RandomDevice final : public CharacterDevice {`
Kernel: Introduce the DeviceManagement singleton This singleton simplifies many aspects that we struggled with before: 1. There's no need to make derived classes of Device expose the constructor as public anymore. The singleton is a friend of them, so he can call the constructor. This solves the issue with try_create_device helper neatly, hopefully for good. 2. Getting a reference of the NullDevice is now being done from this singleton, which means that NullDevice no longer needs to use its own singleton, and we can apply the try_create_device helper on it too :) 3. We can now defer registration completely after the Device constructor which means the Device constructor is merely assigning the major and minor numbers of the Device, and the try_create_device helper ensures it calls the after_inserting method immediately after construction. This creates a great opportunity to make registration more OOM-safe. 2021-09-11 03:19:20 -03:00			`friend class DeviceManagement;`

Add a simple /dev/random. 2018-10-14 19:44:54 -03:00			`public:`
Kernel: Make self-contained locking smart pointers their own classes Until now, our kernel has reimplemented a number of AK classes to provide automatic internal locking: - RefPtr - NonnullRefPtr - WeakPtr - Weakable This patch renames the Kernel classes so that they can coexist with the original AK classes: - RefPtr => LockRefPtr - NonnullRefPtr => NonnullLockRefPtr - WeakPtr => LockWeakPtr - Weakable => LockWeakable The goal here is to eventually get rid of the Lock* classes in favor of using external locking. 2022-08-19 15:53:40 -03:00			`static NonnullLockRefPtr<RandomDevice> must_create();`
Implement a basic way for read() to block. FileHandle gets a hasDataAvailableForRead() getter. If this returns true in sys$read(), the task will block(BlockedRead) + yield. The fd blocked on is stored in Task::m_fdBlockedOnRead. The scheduler then looks at the state of that fd during the unblock phase. This makes "sh" restful. :^) There's still some problem with the kernel not surviving the colonel task getting scheduled. I need to figure that out and fix it. 2018-10-25 08:07:59 -03:00			`virtual ~RandomDevice() override;`
Add a simple /dev/random. 2018-10-14 19:44:54 -03:00
Kernel: Introduce the DeviceManagement singleton This singleton simplifies many aspects that we struggled with before: 1. There's no need to make derived classes of Device expose the constructor as public anymore. The singleton is a friend of them, so he can call the constructor. This solves the issue with try_create_device helper neatly, hopefully for good. 2. Getting a reference of the NullDevice is now being done from this singleton, which means that NullDevice no longer needs to use its own singleton, and we can apply the try_create_device helper on it too :) 3. We can now defer registration completely after the Device constructor which means the Device constructor is merely assigning the major and minor numbers of the Device, and the try_create_device helper ensures it calls the after_inserting method immediately after construction. This creates a great opportunity to make registration more OOM-safe. 2021-09-11 03:19:20 -03:00			`private:`
Kernel: Don't use naked new statements in init process Instead, try to create the device objects in separate static methods, and if we fail for some odd reason to allocate memory for such devices, just panic with that reason. 2021-06-18 05:37:26 -03:00			`RandomDevice();`

Kernel: Make /proc/PID/fds display something useful for character devices. 2019-01-20 23:33:01 -02:00			`// ^CharacterDevice`
Kernel: Replace KResult and KResultOr<T> with Error and ErrorOr<T> We now use AK::Error and AK::ErrorOr<T> in both kernel and userspace! This was a slightly tedious refactoring that took a long time, so it's not unlikely that some bugs crept in. Nevertheless, it does pass basic functionality testing, and it's just real nice to finally see the same pattern in all contexts. :^) 2021-11-07 20:51:39 -03:00			`virtual ErrorOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;`
Everywhere: Run clang-format 2022-04-01 14:58:27 -03:00			`virtual ErrorOr<size_t> write(OpenFileDescription&, u64, UserOrKernelBuffer const&, size_t) override;`
			`virtual bool can_read(OpenFileDescription const&, u64) const override;`
			`virtual bool can_write(OpenFileDescription const&, u64) const override { return true; }`
Kernel: Use `operator ""sv` in all class_name() implementations Previously there was a mix of returning plain strings and returning explicit string views using `operator ""sv`. This change switches them all to standardized on `operator ""sv` as it avoids a call to strlen. 2021-10-02 19:24:00 -03:00			`virtual StringView class_name() const override { return "RandomDevice"sv; }`
Add a simple /dev/random. 2018-10-14 19:44:54 -03:00			`};`
Kernel: Move all code into the Kernel namespace 2020-02-15 21:27:42 -03:00
			`}`