configSizeToProtect should be 16KB
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSCConfig.h
1 /*
2  * Copyright (C) 2019 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "OptionsList.h"
29 #include <wtf/StdLibExtras.h>
30
31 namespace JSC {
32
33 class ExecutableAllocator;
34 class FixedVMPoolExecutableAllocator;
35 class VM;
36
37 constexpr size_t ConfigSizeToProtect = 16 * KB;
38
39 #if ENABLE(SEPARATED_WX_HEAP)
40 using JITWriteSeparateHeapsFunction = void (*)(off_t, const void*, size_t);
41 #endif
42
43 struct Config {
44     JS_EXPORT_PRIVATE static void disableFreezingForTesting();
45     JS_EXPORT_PRIVATE static void enableRestrictedOptions();
46     JS_EXPORT_PRIVATE static void permanentlyFreeze();
47
48     static void configureForTesting()
49     {
50         disableFreezingForTesting();
51         enableRestrictedOptions();
52     }
53
54     union {
55         struct {
56             // All the fields in this struct should be chosen such that their
57             // initial value is 0 / null / falsy because Config is instantiated
58             // as a global singleton.
59
60             bool isPermanentlyFrozen;
61             bool disabledFreezingForTesting;
62             bool restrictedOptionsEnabled;
63             bool jitDisabled;
64
65             // The following HasBeenCalled flags are for auditing call_once initialization functions.
66             bool initializeThreadingHasBeenCalled;
67
68             ExecutableAllocator* executableAllocator;
69             FixedVMPoolExecutableAllocator* fixedVMPoolExecutableAllocator;
70             void* startExecutableMemory;
71             void* endExecutableMemory;
72             uintptr_t startOfFixedWritableMemoryPool;
73
74 #if ENABLE(SEPARATED_WX_HEAP)
75             JITWriteSeparateHeapsFunction jitWriteSeparateHeaps;
76             bool useFastPermisionsJITCopy;
77 #endif
78
79             OptionsStorage options;
80
81             void (*shellTimeoutCheckCallback)(VM&);
82         };
83         char ensureSize[ConfigSizeToProtect];
84     };
85 };
86
87 extern "C" alignas(ConfigSizeToProtect) JS_EXPORT_PRIVATE Config g_jscConfig;
88
89 static_assert(sizeof(Config) == ConfigSizeToProtect, "");
90
91 } // namespace JSC