ea2446f4a3c8e36ec2c9380c4f11d6061fbb1cac
[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 #if CPU(ARM64) || PLATFORM(WATCHOS)
38 constexpr size_t PageSize = 16 * KB;
39 #else
40 constexpr size_t PageSize = 4 * KB;
41 #endif
42
43 constexpr size_t ConfigSizeToProtect = PageSize;
44
45 #if ENABLE(SEPARATED_WX_HEAP)
46 using JITWriteSeparateHeapsFunction = void (*)(off_t, const void*, size_t);
47 #endif
48
49 struct Config {
50     JS_EXPORT_PRIVATE static void disableFreezingForTesting();
51     JS_EXPORT_PRIVATE static void enableRestrictedOptions();
52     JS_EXPORT_PRIVATE static void permanentlyFreeze();
53
54     static void configureForTesting()
55     {
56         disableFreezingForTesting();
57         enableRestrictedOptions();
58     }
59
60     union {
61         struct {
62             // All the fields in this struct should be chosen such that their
63             // initial value is 0 / null / falsy because Config is instantiated
64             // as a global singleton.
65
66             bool isPermanentlyFrozen;
67             bool disabledFreezingForTesting;
68             bool restrictedOptionsEnabled;
69             bool jitDisabled;
70
71             // The following HasBeenCalled flags are for auditing call_once initialization functions.
72             bool initializeThreadingHasBeenCalled;
73
74             ExecutableAllocator* executableAllocator;
75             FixedVMPoolExecutableAllocator* fixedVMPoolExecutableAllocator;
76             void* startExecutableMemory;
77             void* endExecutableMemory;
78             uintptr_t startOfFixedWritableMemoryPool;
79
80 #if ENABLE(SEPARATED_WX_HEAP)
81             JITWriteSeparateHeapsFunction jitWriteSeparateHeaps;
82             bool useFastPermisionsJITCopy;
83 #endif
84
85             OptionsStorage options;
86
87             void (*shellTimeoutCheckCallback)(VM&);
88         };
89         char ensureSize[ConfigSizeToProtect];
90     };
91 };
92
93 extern "C" alignas(PageSize) JS_EXPORT_PRIVATE Config g_jscConfig;
94
95 static_assert(sizeof(Config) == ConfigSizeToProtect, "");
96 static_assert(roundUpToMultipleOf<PageSize>(ConfigSizeToProtect) == ConfigSizeToProtect, "");
97
98 } // namespace JSC