1/*
2 * Copyright (C) 2004 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#ifndef RUNTIME_ROOT_H_
27#define RUNTIME_ROOT_H_
28
29#include <heap/Strong.h>
30#include <heap/Weak.h>
31#include <heap/WeakInlines.h>
32#include <wtf/Forward.h>
33#include <wtf/HashCountedSet.h>
34#include <wtf/HashSet.h>
35#include <wtf/Noncopyable.h>
36#include <wtf/PassRefPtr.h>
37#include <wtf/RefCounted.h>
38
39namespace JSC {
40
41class Interpreter;
42class JSGlobalObject;
43
44namespace Bindings {
45
46class RootObject;
47class RuntimeObject;
48
49typedef HashCountedSet<JSObject*> ProtectCountSet;
50
51extern RootObject* findProtectingRootObject(JSObject*);
52extern RootObject* findRootObject(JSGlobalObject*);
53
54class RootObject : public RefCounted<RootObject>, private JSC::WeakHandleOwner {
55    friend class JavaJSObject;
56
57public:
58    virtual ~RootObject();
59
60    static PassRefPtr<RootObject> create(const void* nativeHandle, JSGlobalObject*);
61
62    bool isValid() { return m_isValid; }
63    void invalidate();
64
65    void gcProtect(JSObject*);
66    void gcUnprotect(JSObject*);
67    bool gcIsProtected(JSObject*);
68
69    const void* nativeHandle() const;
70    JSGlobalObject* globalObject() const;
71    void updateGlobalObject(JSGlobalObject*);
72
73    void addRuntimeObject(VM&, RuntimeObject*);
74    void removeRuntimeObject(RuntimeObject*);
75
76    struct InvalidationCallback {
77        virtual void operator()(RootObject*) = 0;
78        virtual ~InvalidationCallback();
79    };
80    void addInvalidationCallback(InvalidationCallback* callback) { m_invalidationCallbacks.add(callback); }
81
82private:
83    RootObject(const void* nativeHandle, JSGlobalObject*);
84
85    // WeakHandleOwner
86    virtual void finalize(JSC::Handle<JSC::Unknown>, void* context) override;
87
88    bool m_isValid;
89
90    const void* m_nativeHandle;
91    Strong<JSGlobalObject> m_globalObject;
92
93    ProtectCountSet m_protectCountSet;
94    HashMap<RuntimeObject*, JSC::Weak<RuntimeObject>> m_runtimeObjects; // We use a map to implement a set.
95
96    HashSet<InvalidationCallback*> m_invalidationCallbacks;
97};
98
99} // namespace Bindings
100
101} // namespace JSC
102
103#endif // RUNTIME_ROOT_H_
104