[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / JavaScriptCore / runtime / HasOwnPropertyCache.h
1 /*
2  * Copyright (C) 2016 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 "JSProxy.h"
29 #include "PropertySlot.h"
30 #include "Structure.h"
31
32 namespace JSC {
33
34 class HasOwnPropertyCache {
35     static const uint32_t size = 2 * 1024;
36     static_assert(!(size & (size - 1)), "size should be a power of two.");
37 public:
38     static const uint32_t mask = size - 1;
39
40     struct Entry {
41         static ptrdiff_t offsetOfStructureID() { return OBJECT_OFFSETOF(Entry, structureID); }
42         static ptrdiff_t offsetOfImpl() { return OBJECT_OFFSETOF(Entry, impl); }
43         static ptrdiff_t offsetOfResult() { return OBJECT_OFFSETOF(Entry, result); }
44
45         Entry() = default;
46
47         Entry(RefPtr<UniquedStringImpl>&& impl, StructureID structureID, bool result)
48             : impl(WTFMove(impl))
49             , structureID(structureID)
50             , result(result)
51         { }
52
53         Entry& operator=(Entry&& other)
54         {
55             impl = WTFMove(other.impl);
56             structureID = other.structureID;
57             result = other.result;
58             return *this;
59         }
60
61         RefPtr<UniquedStringImpl> impl { };
62         StructureID structureID { 0 };
63         bool result { false };
64     };
65
66     HasOwnPropertyCache() = delete;
67
68     void operator delete(void* cache)
69     {
70         static_cast<HasOwnPropertyCache*>(cache)->clear();
71         fastFree(cache);
72     }
73
74     static HasOwnPropertyCache* create()
75     {
76         size_t allocationSize = sizeof(Entry) * size;
77         HasOwnPropertyCache* result = static_cast<HasOwnPropertyCache*>(fastMalloc(allocationSize));
78         result->clearBuffer();
79         return result;
80     }
81
82     ALWAYS_INLINE static uint32_t hash(StructureID structureID, UniquedStringImpl* impl)
83     {
84         return bitwise_cast<uint32_t>(structureID) + impl->hash();
85     }
86
87     ALWAYS_INLINE std::optional<bool> get(Structure* structure, PropertyName propName)
88     {
89         UniquedStringImpl* impl = propName.uid();
90         StructureID id = structure->id();
91         uint32_t index = HasOwnPropertyCache::hash(id, impl) & mask;
92         Entry& entry = bitwise_cast<Entry*>(this)[index];
93         if (entry.structureID == id && entry.impl.get() == impl)
94             return entry.result;
95         return std::nullopt;
96     }
97
98     ALWAYS_INLINE void tryAdd(VM& vm, PropertySlot& slot, JSObject* object, PropertyName propName, bool result)
99     {
100         if (parseIndex(propName))
101             return;
102
103         if (!slot.isCacheable() && !slot.isUnset())
104             return;
105
106         if (object->type() == PureForwardingProxyType || object->type() == ImpureProxyType)
107             return;
108
109         Structure* structure = object->structure(vm);
110         if (!structure->typeInfo().prohibitsPropertyCaching()
111             && structure->propertyAccessesAreCacheable()
112             && (!slot.isUnset() || structure->propertyAccessesAreCacheableForAbsence())) {
113             if (structure->isDictionary()) {
114                 // FIXME: We should be able to flatten a dictionary object again.
115                 // https://bugs.webkit.org/show_bug.cgi?id=163092
116                 return;
117             }
118
119             ASSERT(!result == slot.isUnset());
120
121             UniquedStringImpl* impl = propName.uid();
122             StructureID id = structure->id();
123             uint32_t index = HasOwnPropertyCache::hash(id, impl) & mask;
124             bitwise_cast<Entry*>(this)[index] = Entry { RefPtr<UniquedStringImpl>(impl), id, result };
125         }
126     }
127
128     void clear()
129     {
130         Entry* buffer = bitwise_cast<Entry*>(this);
131         for (uint32_t i = 0; i < size; ++i)
132             buffer[i].Entry::~Entry();
133
134         clearBuffer();
135     }
136
137 private:
138     void clearBuffer()
139     {
140         Entry* buffer = bitwise_cast<Entry*>(this);
141         for (uint32_t i = 0; i < size; ++i)
142             new (&buffer[i]) Entry();
143     }
144 };
145
146 ALWAYS_INLINE HasOwnPropertyCache* VM::ensureHasOwnPropertyCache()
147 {
148     if (UNLIKELY(!m_hasOwnPropertyCache))
149         m_hasOwnPropertyCache = std::unique_ptr<HasOwnPropertyCache>(HasOwnPropertyCache::create());
150     return m_hasOwnPropertyCache.get();
151 }
152
153 } // namespace JSC