diff options
Diffstat (limited to 'Kernel/Memory/PhysicalAddress.h')
-rw-r--r-- | Kernel/Memory/PhysicalAddress.h | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/Kernel/Memory/PhysicalAddress.h b/Kernel/Memory/PhysicalAddress.h new file mode 100644 index 0000000000..8610992ab5 --- /dev/null +++ b/Kernel/Memory/PhysicalAddress.h @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org> + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#pragma once + +#include <AK/Checked.h> +#include <AK/Format.h> +#include <AK/Types.h> + +typedef u64 PhysicalPtr; +typedef u64 PhysicalSize; + +class PhysicalAddress { +public: + ALWAYS_INLINE static PhysicalPtr physical_page_base(PhysicalPtr page_address) { return page_address & ~(PhysicalPtr)0xfff; } + ALWAYS_INLINE static size_t physical_page_index(PhysicalPtr page_address) + { + auto page_index = page_address >> 12; + if constexpr (sizeof(size_t) < sizeof(PhysicalPtr)) + VERIFY(!(page_index & ~(PhysicalPtr)((size_t)-1))); + return (size_t)(page_index); + } + + PhysicalAddress() = default; + explicit PhysicalAddress(PhysicalPtr address) + : m_address(address) + { + } + + [[nodiscard]] PhysicalAddress offset(PhysicalPtr o) const { return PhysicalAddress(m_address + o); } + [[nodiscard]] bool offset_addition_would_overflow(PhysicalPtr o) const { return Checked<PhysicalPtr>::addition_would_overflow(m_address, o); } + [[nodiscard]] PhysicalPtr get() const { return m_address; } + void set(PhysicalPtr address) { m_address = address; } + void mask(PhysicalPtr m) { m_address &= m; } + + [[nodiscard]] bool is_null() const { return m_address == 0; } + + // NOLINTNEXTLINE(readability-make-member-function-const) const PhysicalAddress shouldn't be allowed to modify the underlying memory + [[nodiscard]] u8* as_ptr() { return reinterpret_cast<u8*>(m_address); } + [[nodiscard]] u8 const* as_ptr() const { return reinterpret_cast<u8 const*>(m_address); } + + [[nodiscard]] PhysicalAddress page_base() const { return PhysicalAddress(physical_page_base(m_address)); } + [[nodiscard]] PhysicalPtr offset_in_page() const { return PhysicalAddress(m_address & 0xfff).get(); } + + bool operator==(PhysicalAddress const& other) const { return m_address == other.m_address; } + bool operator!=(PhysicalAddress const& other) const { return m_address != other.m_address; } + bool operator>(PhysicalAddress const& other) const { return m_address > other.m_address; } + bool operator>=(PhysicalAddress const& other) const { return m_address >= other.m_address; } + bool operator<(PhysicalAddress const& other) const { return m_address < other.m_address; } + bool operator<=(PhysicalAddress const& other) const { return m_address <= other.m_address; } + +private: + PhysicalPtr m_address { 0 }; +}; + +template<> +struct AK::Formatter<PhysicalAddress> : AK::Formatter<FormatString> { + ErrorOr<void> format(FormatBuilder& builder, PhysicalAddress value) + { + if constexpr (sizeof(PhysicalPtr) == sizeof(u64)) + return AK::Formatter<FormatString>::format(builder, "P{:016x}"sv, value.get()); + else + return AK::Formatter<FormatString>::format(builder, "P{}"sv, value.as_ptr()); + } +}; |