2020-01-18 08:38:21 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2019-02-15 23:47:20 +00:00
|
|
|
#pragma once
|
|
|
|
|
2019-04-24 00:37:57 +00:00
|
|
|
// Device is the base class of everything that lives in the /dev directory.
|
|
|
|
//
|
|
|
|
// To expose a Device to the filesystem, simply pass two unique numbers to the constructor,
|
|
|
|
// and then mknod a file in /dev with those numbers.
|
|
|
|
//
|
|
|
|
// There are two main subclasses:
|
|
|
|
// - BlockDevice (random access)
|
|
|
|
// - CharacterDevice (sequential)
|
2020-11-02 18:16:01 +00:00
|
|
|
#include <AK/DoublyLinkedList.h>
|
2021-11-07 23:51:39 +00:00
|
|
|
#include <AK/Error.h>
|
2019-08-18 11:48:15 +00:00
|
|
|
#include <AK/Function.h>
|
|
|
|
#include <AK/HashMap.h>
|
2021-08-14 08:40:37 +00:00
|
|
|
#include <AK/RefPtr.h>
|
2020-11-02 18:16:01 +00:00
|
|
|
#include <Kernel/Devices/AsyncDeviceRequest.h>
|
2021-12-23 18:08:18 +00:00
|
|
|
#include <Kernel/FileSystem/DeviceFileTypes.h>
|
2019-07-09 12:46:23 +00:00
|
|
|
#include <Kernel/FileSystem/File.h>
|
2021-08-14 08:40:37 +00:00
|
|
|
#include <Kernel/FileSystem/SysFS.h>
|
2019-04-29 02:55:54 +00:00
|
|
|
#include <Kernel/UnixTypes.h>
|
2019-02-15 23:47:20 +00:00
|
|
|
|
2020-02-16 00:27:42 +00:00
|
|
|
namespace Kernel {
|
|
|
|
|
2019-04-28 13:02:55 +00:00
|
|
|
class Device : public File {
|
2021-08-14 08:40:37 +00:00
|
|
|
protected:
|
|
|
|
enum class State {
|
|
|
|
Normal,
|
|
|
|
BeingRemoved,
|
|
|
|
};
|
|
|
|
|
2019-02-15 23:47:20 +00:00
|
|
|
public:
|
2019-04-28 13:02:55 +00:00
|
|
|
virtual ~Device() override;
|
2019-02-15 23:47:20 +00:00
|
|
|
|
2021-12-23 18:08:18 +00:00
|
|
|
MajorNumber major() const { return m_major; }
|
|
|
|
MinorNumber minor() const { return m_minor; }
|
2019-02-15 23:47:20 +00:00
|
|
|
|
2022-04-01 17:58:27 +00:00
|
|
|
virtual ErrorOr<NonnullOwnPtr<KString>> pseudo_path(OpenFileDescription const&) const override;
|
2019-02-15 23:47:20 +00:00
|
|
|
|
2021-08-28 20:11:16 +00:00
|
|
|
UserID uid() const { return m_uid; }
|
|
|
|
GroupID gid() const { return m_gid; }
|
2019-02-15 23:47:20 +00:00
|
|
|
|
2019-04-28 13:02:55 +00:00
|
|
|
virtual bool is_device() const override { return true; }
|
2021-12-28 23:00:29 +00:00
|
|
|
virtual void will_be_destroyed() override;
|
2021-09-10 11:44:46 +00:00
|
|
|
virtual void after_inserting();
|
2022-04-01 17:58:27 +00:00
|
|
|
void process_next_queued_request(Badge<AsyncDeviceRequest>, AsyncDeviceRequest const&);
|
2020-11-02 18:16:01 +00:00
|
|
|
|
|
|
|
template<typename AsyncRequestType, typename... Args>
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<NonnullRefPtr<AsyncRequestType>> try_make_request(Args&&... args)
|
2020-11-02 18:16:01 +00:00
|
|
|
{
|
2021-09-07 14:40:54 +00:00
|
|
|
auto request = TRY(adopt_nonnull_ref_or_enomem(new (nothrow) AsyncRequestType(*this, forward<Args>(args)...)));
|
2021-08-21 23:49:22 +00:00
|
|
|
SpinlockLocker lock(m_requests_lock);
|
2021-02-06 23:59:32 +00:00
|
|
|
bool was_empty = m_requests.is_empty();
|
|
|
|
m_requests.append(request);
|
2020-11-02 18:16:01 +00:00
|
|
|
if (was_empty)
|
2021-02-06 23:59:32 +00:00
|
|
|
request->do_start(move(lock));
|
2020-11-02 18:16:01 +00:00
|
|
|
return request;
|
|
|
|
}
|
|
|
|
|
2019-02-15 23:47:20 +00:00
|
|
|
protected:
|
2021-12-23 18:08:18 +00:00
|
|
|
Device(MajorNumber major, MinorNumber minor);
|
2021-08-28 20:11:16 +00:00
|
|
|
void set_uid(UserID uid) { m_uid = uid; }
|
|
|
|
void set_gid(GroupID gid) { m_gid = gid; }
|
2019-02-15 23:47:20 +00:00
|
|
|
|
|
|
|
private:
|
2022-03-31 20:57:25 +00:00
|
|
|
MajorNumber const m_major { 0 };
|
|
|
|
MinorNumber const m_minor { 0 };
|
2021-08-28 20:11:16 +00:00
|
|
|
UserID m_uid { 0 };
|
|
|
|
GroupID m_gid { 0 };
|
2020-11-02 18:16:01 +00:00
|
|
|
|
2021-08-14 08:40:37 +00:00
|
|
|
State m_state { State::Normal };
|
|
|
|
|
2021-09-05 17:02:03 +00:00
|
|
|
Spinlock m_requests_lock;
|
2020-11-02 18:16:01 +00:00
|
|
|
DoublyLinkedList<RefPtr<AsyncDeviceRequest>> m_requests;
|
2021-09-10 11:44:46 +00:00
|
|
|
RefPtr<SysFSDeviceComponent> m_sysfs_component;
|
2019-02-15 23:47:20 +00:00
|
|
|
};
|
2020-02-16 00:27:42 +00:00
|
|
|
|
|
|
|
}
|