7831c196ab57b7877b7a7626208182fe0e20ca2b
[WebKit-https.git] / Source / JavaScriptCore / runtime / CacheableIdentifier.h
1 /*
2  * Copyright (C) 2020 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 "JSCJSValue.h"
29
30 namespace WTF {
31
32 class PrintStream;
33 class UniquedStringImpl;
34
35 } // namespace WTF
36
37 using WTF::PrintStream;
38 using WTF::UniquedStringImpl;
39
40 namespace JSC {
41
42 class Identifier;
43 class JSCell;
44 class SlotVisitor;
45
46 class CacheableIdentifier {
47 public:
48     CacheableIdentifier() = default;
49
50     static inline CacheableIdentifier createFromCell(JSCell* identifier);
51     static inline CacheableIdentifier createFromIdentifierOwnedByCodeBlock(const Identifier&);
52
53     CacheableIdentifier(const CacheableIdentifier&) = default;
54     CacheableIdentifier(CacheableIdentifier&&) = default;
55
56     CacheableIdentifier(std::nullptr_t)
57         : m_bits(0)
58     { }
59
60     bool isUid() const { return m_bits & s_uidTag; }
61     bool isCell() const { return !isUid(); }
62     inline bool isSymbolCell() const;
63     inline bool isStringCell() const;
64
65     bool isSymbol() const { return m_bits && uid()->isSymbol(); }
66
67     inline JSCell* cell() const;
68     UniquedStringImpl* uid() const;
69
70     explicit operator bool() const { return m_bits; }
71
72     CacheableIdentifier& operator=(const CacheableIdentifier&) = default;
73     CacheableIdentifier& operator=(CacheableIdentifier&&) = default;
74
75     bool operator==(const CacheableIdentifier& other) const;
76     bool operator!=(const CacheableIdentifier& other) const;
77     bool operator==(const Identifier& other) const;
78
79     static inline bool isCacheableIdentifierCell(JSCell*);
80     static inline bool isCacheableIdentifierCell(JSValue);
81
82     inline void visitAggregate(SlotVisitor&) const;
83
84     JS_EXPORT_PRIVATE void dump(PrintStream&) const;
85
86 private:
87     explicit inline CacheableIdentifier(const Identifier&);
88     explicit inline CacheableIdentifier(JSCell* identifier);
89
90     inline void setCellBits(JSCell*);
91     inline void setUidBits(UniquedStringImpl*);
92
93     // CacheableIdentifier can either hold a cell pointer or a uid. To discern which
94     // it is holding, we tag the low bit if we have a uid. We choose to tag the uid
95     // instead of the cell because this keeps the bits of the cell pointer form
96     // unpolluted, and therefore, it can be scanned by our conservative GC to keep the
97     // cell alive when the CacheableIdentifier is on the stack.
98     static constexpr uintptr_t s_uidTag = 1;
99     uintptr_t m_bits { 0 };
100 };
101
102 } // namespace JSC