REGRESSION(r249808): [GTK] Crash in JSC Config::permanentlyFreeze() on architecture...
[WebKit-https.git] / Source / WTF / wtf / PageBlock.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/StdLibExtras.h>
29
30 namespace WTF {
31
32 // We attempt to guess a value that is *AT LEAST* as large as the system's actual page size.
33 // This is impossible to do correctly at build time, but JSC really needs it at build time, so
34 // we have a RELEASE_ASSERT() inside WTF::pageSize to make sure it is set properly at runtime.
35 // All of these values are going to be incorrect on systems configured to use larger than normal
36 // page size, so on such systems it is expected that WebKit will crash until this value is changed
37 // and recompiled. Sorry.
38 //
39 // macOS x86_64 uses 4 KiB, but Apple's aarch64 systems use 16 KiB. Use 16 KiB on all Apple systems
40 // for consistency.
41 //
42 // Most Linux and Windows systems use a page size of 4 KiB.
43 //
44 // On Linux, Power systems normally use 64 KiB pages.
45 //
46 // aarch64 systems seem to be all over the place. Most Linux distros use 4 KiB, but RHEL uses
47 // 64 KiB. (Apple uses 16 KiB.)
48 //
49 // Use 64 KiB for any unknown CPUs to be conservative.
50 #if OS(DARWIN)
51 constexpr size_t CeilingOnPageSize = 16 * KB;
52 #elif OS(WINDOWS) || CPU(MIPS) || CPU(X86) || CPU(X86_64) || CPU(ARM)
53 constexpr size_t CeilingOnPageSize = 4 * KB;
54 #elif CPU(UNKNOWN) || CPU(PPC) || CPU(PPC64) || CPU(PPC64LE) || CPU(ARM64)
55 constexpr size_t CeilingOnPageSize = 64 * KB;
56 #else
57 #error Must set CeilingOnPageSize in PageBlock.h when adding a new CPU architecture!
58 #endif
59
60 WTF_EXPORT_PRIVATE size_t pageSize();
61 WTF_EXPORT_PRIVATE size_t pageMask();
62 inline bool isPageAligned(void* address) { return !(reinterpret_cast<intptr_t>(address) & (pageSize() - 1)); }
63 inline bool isPageAligned(size_t size) { return !(size & (pageSize() - 1)); }
64 inline bool isPowerOfTwo(size_t size) { return !(size & (size - 1)); }
65
66 class PageBlock {
67     WTF_MAKE_FAST_ALLOCATED;
68 public:
69     PageBlock();
70     PageBlock(const PageBlock&);
71     PageBlock(void*, size_t, bool hasGuardPages);
72     
73     void* base() const { return m_base; }
74     size_t size() const { return m_size; }
75
76     operator bool() const { return !!m_realBase; }
77
78     bool contains(void* containedBase, size_t containedSize)
79     {
80         return containedBase >= m_base
81             && (static_cast<char*>(containedBase) + containedSize) <= (static_cast<char*>(m_base) + m_size);
82     }
83
84 private:
85     void* m_realBase;
86     void* m_base;
87     size_t m_size;
88 };
89
90 inline PageBlock::PageBlock()
91     : m_realBase(0)
92     , m_base(0)
93     , m_size(0)
94 {
95 }
96
97 inline PageBlock::PageBlock(const PageBlock& other)
98     : m_realBase(other.m_realBase)
99     , m_base(other.m_base)
100     , m_size(other.m_size)
101 {
102 }
103
104 inline PageBlock::PageBlock(void* base, size_t size, bool hasGuardPages)
105     : m_realBase(base)
106     , m_base(static_cast<char*>(base) + ((base && hasGuardPages) ? pageSize() : 0))
107     , m_size(size)
108 {
109 }
110
111 } // namespace WTF
112
113 using WTF::CeilingOnPageSize;
114 using WTF::pageSize;
115 using WTF::isPageAligned;
116 using WTF::isPowerOfTwo;