It should be possible to flag a cell for unconditional finalization
[WebKit-https.git] / Source / JavaScriptCore / runtime / WeakMapBase.h
1 /*
2  * Copyright (C) 2013 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "HashMapImpl.h"
29 #include "JSDestructibleObject.h"
30 #include "Structure.h"
31 #include <wtf/HashMap.h>
32 #include <wtf/MathExtras.h>
33
34 namespace JSC {
35
36 class WeakMapBase : public JSDestructibleObject {
37 public:
38     using Base = JSDestructibleObject;
39
40     void set(VM&, JSObject*, JSValue);
41     JSValue get(JSObject*);
42     JSValue inlineGet(JSObject*);
43     JSValue inlineGet(JSObject*, int32_t hash);
44     bool remove(JSObject*);
45     bool contains(JSObject*);
46     void clear();
47
48     DECLARE_INFO;
49
50     using MapType = HashMap<JSObject*, WriteBarrier<Unknown>, WeakMapHash>;
51     MapType::const_iterator begin() const { return m_map.begin(); }
52     MapType::const_iterator end() const { return m_map.end(); }
53
54     unsigned size() const { return m_map.size(); }
55
56     static size_t estimatedSize(JSCell*);
57     static void visitChildren(JSCell*, SlotVisitor&);
58
59 protected:
60     WeakMapBase(VM&, Structure*);
61     static void destroy(JSCell*);
62
63     using KeyWithHash = std::pair<JSObject*, unsigned>;
64     struct HashTranslator {
65         static inline unsigned hash(const KeyWithHash& keyWithHash)
66         {
67             return keyWithHash.second;
68         }
69
70         static inline bool equal(JSObject* key, const KeyWithHash& keyWithHash)
71         {
72             return key == keyWithHash.first;
73         }
74     };
75
76     class DeadKeyCleaner : public UnconditionalFinalizer, public WeakReferenceHarvester {
77     public:
78         WeakMapBase* target();
79
80     private:
81         void visitWeakReferences(SlotVisitor&) override;
82         void finalizeUnconditionally() override;
83         unsigned m_liveKeyCount;
84     };
85     DeadKeyCleaner m_deadKeyCleaner;
86     MapType m_map;
87 };
88
89 ALWAYS_INLINE JSValue WeakMapBase::inlineGet(JSObject* key)
90 {
91     if (auto result = m_map.inlineGet(key))
92         return result.get();
93     return jsUndefined();
94 }
95
96 ALWAYS_INLINE JSValue WeakMapBase::inlineGet(JSObject* key, int32_t hash)
97 {
98     KeyWithHash keyWithHash { key, hash };
99     if (auto result = m_map.inlineGet<HashTranslator>(keyWithHash))
100         return result.get();
101     return jsUndefined();
102 }
103
104 } // namespace JSC