Harden how the compiler references GC objects
[WebKit.git] / Source / JavaScriptCore / dfg / DFGOpInfo.h
1 /*
2  * Copyright (C) 2016-2017 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 "DFGRegisteredStructure.h"
29 #include "HeapCell.h"
30 #include <wtf/StdLibExtras.h>
31
32 #if ENABLE(DFG_JIT)
33
34 namespace JSC { namespace DFG {
35
36 // This type used in passing an immediate argument to Node constructor;
37 // distinguishes an immediate value (typically an index into a CodeBlock data structure - 
38 // a constant index, argument, or identifier) from a Node*.
39 struct OpInfo {
40     OpInfo() : m_value(0) { }
41     explicit OpInfo(int32_t value) : m_value(static_cast<uint64_t>(value)) { }
42     explicit OpInfo(uint32_t value) : m_value(static_cast<uint64_t>(value)) { }
43     explicit OpInfo(uint64_t value) : m_value(static_cast<uint64_t>(value)) { }
44 #if OS(DARWIN)
45     explicit OpInfo(uintptr_t value) : m_value(static_cast<uint64_t>(value)) { }
46 #endif
47     explicit OpInfo(RegisteredStructure structure) : m_value(static_cast<uint64_t>(bitwise_cast<uintptr_t>(structure))) { }
48
49
50     template <typename T>
51     explicit OpInfo(T* ptr)
52     {
53         static_assert(!std::is_base_of<HeapCell, T>::value, "To make an OpInfo with a cell in it, the cell must be registered or frozen.");
54         static_assert(!std::is_base_of<StructureSet, T>::value, "To make an OpInfo with a structure set in, make sure to use RegisteredStructureSet.");
55         m_value = static_cast<uint64_t>(reinterpret_cast<uintptr_t>(ptr));
56     }
57
58     uint64_t m_value;
59 };
60
61 } } // namespace JSC::DFG
62
63 #endif // ENABLE(DFG_JIT)