File: RefCountedWithInlineWeakPtr.h

package info (click to toggle)
wpewebkit 2.52.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 488,880 kB
  • sloc: cpp: 3,911,108; javascript: 197,735; ansic: 163,103; python: 53,139; asm: 22,290; ruby: 18,114; perl: 17,149; xml: 4,631; yacc: 2,394; sh: 2,310; java: 2,032; lex: 1,358; pascal: 372; makefile: 88
file content (132 lines) | stat: -rw-r--r-- 3,847 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 * Copyright (C) 2025 Apple Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#pragma once

#include <wtf/RefCountDebugger.h>

namespace WTF {

// This base class holds the non-template methods and attributes.
// The RefCountedWithInlineWeakPtr class inherits from it reducing the template bloat
// generated by the compiler (technique called template hoisting).
class WTF_EMPTY_BASE_CLASS RefCountedWithInlineWeakPtrBase {
public:
    void ref() const
    {
        m_refCountDebugger.willRef(m_strongCount);
        ++m_strongCount;
    }

    bool hasOneRef() const { return m_strongCount == 1; }
    unsigned refCount() const { return m_strongCount; }

    void weakRef() const { ++m_weakCount; }

    RefCountDebugger& refCountDebugger() const { return const_cast<RefCountDebugger&>(m_refCountDebugger); }

protected:
    RefCountedWithInlineWeakPtrBase() = default;

    ~RefCountedWithInlineWeakPtrBase()
    {
        m_refCountDebugger.willDestroy(m_strongCount);
        RELEASE_ASSERT(m_strongCount == 1);
        // Use volatile to prevent compilers from eliminating this code. <https://webkit.org/b/304549>
        *static_cast<volatile unsigned*>(&m_strongCount) = 0;
    }

    // Returns true if the pointer should be destroyed.
    bool derefBase() const
    {
        m_refCountDebugger.willDeref(m_strongCount);

        if (m_strongCount != 1) {
            --m_strongCount;
            return false;
        }

        m_refCountDebugger.willDelete();
        return true;
    }

    // Returns true if the pointer should be freed.
    bool weakDerefBase() const
    {
        if (m_weakCount != 1) {
            --m_weakCount;
            return false;
        }

        return true;
    }

private:
    mutable unsigned m_strongCount { 1 };
    mutable unsigned m_weakCount { 1 }; // The strong counts collectively share one weak count.
    NO_UNIQUE_ADDRESS RefCountDebugger m_refCountDebugger;
};

template<typename T> class RefCountedWithInlineWeakPtr : public RefCountedWithInlineWeakPtrBase {
    WTF_MAKE_NONCOPYABLE(RefCountedWithInlineWeakPtr);
    WTF_DEPRECATED_MAKE_FAST_ALLOCATED(RefCountedWithInlineWeakPtr);
public:
    RefCountedWithInlineWeakPtr() = default;

    void deref() const
    {
        if (!derefBase()) [[likely]]
            return;
        derefSlowCase();
    }

    void weakDeref() const
    {
        if (!weakDerefBase()) [[likely]]
            return;
        weakDerefSlowCase();
    }

private:
    void derefSlowCase() const;
    void weakDerefSlowCase() const;
} SWIFT_RETURNED_AS_UNRETAINED_BY_DEFAULT;

template<typename T> void RefCountedWithInlineWeakPtr<T>::derefSlowCase() const
{
    const_cast<T*>(static_cast<const T*>(this))->~T();
    weakDeref();
}

template<typename T> void RefCountedWithInlineWeakPtr<T>::weakDerefSlowCase() const
{
    T::operator delete(const_cast<T*>(static_cast<const T*>(this)));
}

inline void adopted(RefCountedWithInlineWeakPtrBase* object)
{
    if (!object)
        return;
    object->refCountDebugger().adopted();
}

} // namespace WTF

using WTF::RefCountedWithInlineWeakPtr;