jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/LogStream.h>
30#include <AK/Types.h>
31
32class VirtualAddress {
33public:
34 VirtualAddress() {}
35 explicit VirtualAddress(FlatPtr address)
36 : m_address(address)
37 {
38 }
39
40 explicit VirtualAddress(const void* address)
41 : m_address((FlatPtr)address)
42 {
43 }
44
45 bool is_null() const { return m_address == 0; }
46 bool is_page_aligned() const { return (m_address & 0xfff) == 0; }
47
48 VirtualAddress offset(FlatPtr o) const { return VirtualAddress(m_address + o); }
49 FlatPtr get() const { return m_address; }
50 void set(FlatPtr address) { m_address = address; }
51 void mask(FlatPtr m) { m_address &= m; }
52
53 bool operator<=(const VirtualAddress& other) const { return m_address <= other.m_address; }
54 bool operator>=(const VirtualAddress& other) const { return m_address >= other.m_address; }
55 bool operator>(const VirtualAddress& other) const { return m_address > other.m_address; }
56 bool operator<(const VirtualAddress& other) const { return m_address < other.m_address; }
57 bool operator==(const VirtualAddress& other) const { return m_address == other.m_address; }
58 bool operator!=(const VirtualAddress& other) const { return m_address != other.m_address; }
59
60 u8* as_ptr() { return reinterpret_cast<u8*>(m_address); }
61 const u8* as_ptr() const { return reinterpret_cast<const u8*>(m_address); }
62
63 VirtualAddress page_base() const { return VirtualAddress(m_address & 0xfffff000); }
64
65private:
66 FlatPtr m_address { 0 };
67};
68
69inline VirtualAddress operator-(const VirtualAddress& a, const VirtualAddress& b)
70{
71 return VirtualAddress(a.get() - b.get());
72}
73
74inline const LogStream& operator<<(const LogStream& stream, VirtualAddress value)
75{
76 return stream << 'V' << value.as_ptr();
77}