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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "JSCJSValue.h"
#include "Microtask.h"
#include "SlotVisitorMacros.h"
#include <wtf/Deque.h>
#include <wtf/SentinelLinkedList.h>
namespace JSC {
class JSGlobalObject;
class MarkedMicrotaskDeque;
class MicrotaskDispatcher;
class MicrotaskQueue;
class VM;
class QueuedTask {
WTF_MAKE_TZONE_ALLOCATED(QueuedTask);
friend class MicrotaskQueue;
friend class MarkedMicrotaskDeque;
public:
static constexpr unsigned maxArguments = 4;
enum class Result : uint8_t {
Executed,
Discard,
Suspended,
};
QueuedTask(RefPtr<MicrotaskDispatcher>&& dispatcher)
: m_dispatcher(WTFMove(dispatcher))
, m_identifier(MicrotaskIdentifier::generate())
{
}
QueuedTask(RefPtr<MicrotaskDispatcher>&& dispatcher, JSGlobalObject* globalObject, JSValue job, JSValue argument0, JSValue argument1, JSValue argument2, JSValue argument3)
: m_dispatcher(WTFMove(dispatcher))
, m_identifier(MicrotaskIdentifier::generate())
, m_globalObject(globalObject)
, m_job(job)
, m_arguments { argument0, argument1, argument2, argument3 }
{
}
void setDispatcher(RefPtr<MicrotaskDispatcher>&& dispatcher)
{
m_dispatcher = WTFMove(dispatcher);
}
bool isRunnable() const;
MicrotaskDispatcher* dispatcher() const { return m_dispatcher.get(); }
MicrotaskIdentifier identifier() const { return m_identifier; }
JSGlobalObject* globalObject() const { return m_globalObject; }
JSValue job() const { return m_job; }
std::span<const JSValue> arguments() const { return std::span { m_arguments }; }
private:
RefPtr<MicrotaskDispatcher> m_dispatcher;
MicrotaskIdentifier m_identifier;
JSGlobalObject* m_globalObject { nullptr };
JSValue m_job { };
JSValue m_arguments[maxArguments] { };
};
class MicrotaskDispatcher : public RefCounted<MicrotaskDispatcher> {
public:
enum class Type : uint8_t {
None,
// WebCoreMicrotaskDispatcher starts from here.
JavaScript,
UserGestureIndicator,
Function,
};
explicit MicrotaskDispatcher(Type type)
: m_type(type)
{ }
virtual ~MicrotaskDispatcher() = default;
virtual QueuedTask::Result run(QueuedTask&) = 0;
virtual bool isRunnable() const = 0;
Type type() const { return m_type; }
bool isWebCoreMicrotaskDispatcher() const { return static_cast<uint8_t>(m_type) >= static_cast<uint8_t>(Type::JavaScript); }
private:
Type m_type { Type::None };
};
class MarkedMicrotaskDeque {
public:
friend class MicrotaskQueue;
MarkedMicrotaskDeque() = default;
QueuedTask dequeue()
{
if (m_markedBefore)
--m_markedBefore;
return m_queue.takeFirst();
}
void enqueue(QueuedTask&& task)
{
m_queue.append(WTFMove(task));
}
bool isEmpty() const
{
return m_queue.isEmpty();
}
size_t size() const { return m_queue.size(); }
void clear()
{
m_queue.clear();
m_markedBefore = 0;
}
void beginMarking()
{
m_markedBefore = 0;
}
void swap(MarkedMicrotaskDeque& other)
{
m_queue.swap(other.m_queue);
std::swap(m_markedBefore, other.m_markedBefore);
}
JS_EXPORT_PRIVATE bool hasMicrotasksForFullyActiveDocument() const;
DECLARE_VISIT_AGGREGATE;
private:
Deque<QueuedTask> m_queue;
size_t m_markedBefore { 0 };
};
class MicrotaskQueue final : public BasicRawSentinelNode<MicrotaskQueue> {
WTF_MAKE_TZONE_ALLOCATED_EXPORT(MicrotaskQueue, JS_EXPORT_PRIVATE);
WTF_MAKE_NONCOPYABLE(MicrotaskQueue);
public:
JS_EXPORT_PRIVATE MicrotaskQueue(VM&);
JS_EXPORT_PRIVATE ~MicrotaskQueue();
JS_EXPORT_PRIVATE void enqueue(QueuedTask&&);
bool isEmpty() const
{
return m_queue.isEmpty();
}
size_t size() const { return m_queue.size(); }
void clear()
{
m_queue.clear();
m_toKeep.clear();
}
void beginMarking()
{
m_queue.beginMarking();
m_toKeep.beginMarking();
}
DECLARE_VISIT_AGGREGATE;
inline void performMicrotaskCheckpoint(VM&, NOESCAPE const Invocable<QueuedTask::Result(QueuedTask&)> auto& functor);
bool hasMicrotasksForFullyActiveDocument() const
{
return m_queue.hasMicrotasksForFullyActiveDocument();
}
private:
MarkedMicrotaskDeque m_queue;
MarkedMicrotaskDeque m_toKeep;
};
} // namespace JSC
|