blob: 949d7bba21605a9cb136e22f4fcfc2d4c960aada (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
#ifndef TEACHOS_KERNEL_FILESYSTEM_DEVICE_NUMBER_REGISTRY_HPP
#define TEACHOS_KERNEL_FILESYSTEM_DEVICE_NUMBER_REGISTRY_HPP
#include <kernel/filesystem/file_type.hpp>
#include <kapi/devices.hpp>
#include <kapi/filesystem.hpp>
#include <kstd/flat_map.hpp>
#include <kstd/memory.hpp>
#include <kstd/result.hpp>
#include <kstd/string.hpp>
#include <kstd/vector.hpp>
#include <cstdint>
namespace kernel::filesystem
{
struct device_number_registry_observer;
//! A registry to assign stable device numbers to published devices.
struct device_number_registry final : kapi::devices::interface_registry_observer
{
//! A single numbered device.
//!
//! Theses entries are used, for example, in devfs to provide access to devices.
struct entry
{
kapi::filesystem::device_number number;
file_type type;
kstd::string name;
kstd::weak_ptr<kapi::devices::device> device;
};
//! Construct a new device number registry, subscribing to the given interface registry.
//!
//! @param interface_registry The interface registry to back this device number registry.
explicit device_number_registry(kapi::devices::interface_registry & interface_registry);
//! Destroy this registry.
~device_number_registry() override;
device_number_registry(device_number_registry const &) = delete;
device_number_registry(device_number_registry &&) = delete;
auto operator=(device_number_registry const &) -> device_number_registry & = delete;
auto operator=(device_number_registry &&) -> device_number_registry & = delete;
//! Get the system global instance of the registry.
[[nodiscard]] auto static get() -> device_number_registry &;
//! Resolve a device number and file type to a device.
//!
//! @param number The device number.
//! @param type The expected file type of the device.
//! @return A device if a fitting entry is found, an error otherwise.
[[nodiscard]] auto resolve(kapi::filesystem::device_number number, file_type type) const
-> kstd::result<kstd::shared_ptr<kapi::devices::device>>;
//! Resolve a device to it's device number.
//!
//! @param device The device to find the number for.
//! @return The device number associated with the given device, or an error otherwise.
[[nodiscard]] auto number_of(kapi::devices::device const & device) const
-> kstd::result<kapi::filesystem::device_number>;
//! Get all currently registered devices.
//!
//! @return A range containing all currently registered devices numbers mappings.
[[nodiscard]] auto all() const -> kstd::vector<entry>;
//! Subscribe to device numbering events.
//!
//! Observers subscribed through this function are held through non-owning pointers. It is safe of an observer
//! subscribed through this function to be destroyed without being unsubscribed.
//!
//! @param observer The observer to notify.
auto subscribe(kstd::weak_ptr<device_number_registry_observer> observer) -> void;
private:
auto on_interface_published(kapi::devices::interface_id interface,
kapi::devices::interface_registry::entry const & entry) -> void override;
auto on_interface_withdrawn(kapi::devices::interface_id interface, kapi::devices::device & device) -> void override;
kstd::observer_ptr<kapi::devices::interface_registry> m_interface_registry;
mutable kstd::vector<entry> m_entries{};
kstd::flat_map<kapi::devices::driver const *, std::uint8_t> m_next_minor;
kstd::vector<kstd::weak_ptr<device_number_registry_observer>> m_observers{};
};
//! The interface for types interested in observing numbering transactions on a device number registry.
struct device_number_registry_observer
{
//! Enable correct destruction through base pointers.
virtual ~device_number_registry_observer() = default;
//! Called after a device has been assigned a device number.
//!
//! @param numbered The newly numbered entry.
virtual auto on_device_numbered(device_number_registry::entry const & numbered) -> void = 0;
//! Called after a device's number has been withdrawn.
//!
//! @param unnumbered The entry that is no longer numbered.
virtual auto on_device_unnumbered(device_number_registry::entry const & unnumbered) -> void = 0;
};
} // namespace kernel::filesystem
#endif
|
