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/FixedArray.h>
30#include <AK/InlineLinkedList.h>
31#include <AK/RefCounted.h>
32#include <AK/RefPtr.h>
33#include <AK/Weakable.h>
34#include <Kernel/Lock.h>
35
36namespace Kernel {
37
38class Inode;
39class PhysicalPage;
40
41class VMObject : public RefCounted<VMObject>
42 , public Weakable<VMObject>
43 , public InlineLinkedListNode<VMObject> {
44 friend class MemoryManager;
45 friend class Region;
46
47public:
48 virtual ~VMObject();
49
50 virtual NonnullRefPtr<VMObject> clone() = 0;
51
52 virtual bool is_anonymous() const { return false; }
53 virtual bool is_purgeable() const { return false; }
54 virtual bool is_inode() const { return false; }
55 virtual bool is_shared_inode() const { return false; }
56 virtual bool is_private_inode() const { return false; }
57 virtual bool is_contiguous() const { return false; }
58
59 size_t page_count() const { return m_physical_pages.size(); }
60 const FixedArray<RefPtr<PhysicalPage>>& physical_pages() const { return m_physical_pages; }
61 FixedArray<RefPtr<PhysicalPage>>& physical_pages() { return m_physical_pages; }
62
63 size_t size() const { return m_physical_pages.size() * PAGE_SIZE; }
64
65 virtual const char* class_name() const = 0;
66
67 // For InlineLinkedListNode
68 VMObject* m_next { nullptr };
69 VMObject* m_prev { nullptr };
70
71protected:
72 explicit VMObject(size_t);
73 explicit VMObject(const VMObject&);
74
75 template<typename Callback>
76 void for_each_region(Callback);
77
78 FixedArray<RefPtr<PhysicalPage>> m_physical_pages;
79 Lock m_paging_lock { "VMObject" };
80
81private:
82 VMObject& operator=(const VMObject&) = delete;
83 VMObject& operator=(VMObject&&) = delete;
84 VMObject(VMObject&&) = delete;
85};
86
87}