Repository navigation
Expand file tree
/
Copy pathSourceProvider.h
More file actions
342 lines (284 loc) · 12.7 KB
/
Copy pathSourceProvider.h
File metadata and controls
342 lines (284 loc) · 12.7 KB
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/*
* Copyright (C) 2008-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.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "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 OR ITS 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 <wtf/Compiler.h>
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
#include <JavaScriptCore/CachedBytecode.h>
#include <JavaScriptCore/CodeBlockHash.h>
#include <JavaScriptCore/CodeSpecializationKind.h>
#include <JavaScriptCore/LineColumn.h>
#include <JavaScriptCore/SourceCharacters.h>
#include <JavaScriptCore/SourceOrigin.h>
#include <JavaScriptCore/SourceTaintedness.h>
#include <optional>
#include <span>
#include <wtf/Lock.h>
#include <wtf/Noncopyable.h>
#include <wtf/ScopedLambda.h>
#include <wtf/Threading.h>
#include <wtf/Vector.h>
#include <wtf/text/TextPosition.h>
#include <wtf/text/WTFString.h>
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
namespace JSC {
class SourceCode;
class SourceProvider;
class UnlinkedFunctionExecutable;
class UnlinkedFunctionCodeBlock;
enum class SourceProviderSourceType : uint8_t {
Program,
Module,
WebAssembly,
JSON,
Text,
ImportMap,
CSS,
};
using BytecodeCacheGenerator = Function<RefPtr<CachedBytecode>()>;
class LineStartTable {
WTF_MAKE_NONCOPYABLE(LineStartTable);
public:
LineStartTable() = default;
// Positions within the provider's own text. An inline <script> starts partway into its
// document, and that offset is not applied here.
struct PositionInfo {
unsigned line0Based { 0 };
unsigned column0Based { 0 };
unsigned lineStart { 0 };
unsigned lineEnd { 0 }; // excludes the line terminator, so [lineStart, lineEnd) is the text
};
JS_EXPORT_PRIVATE PositionInfo positionInfoForOffset(StringView text, unsigned offset);
// Out-of-range input clamps rather than fails: a line past the end gives the end of the text,
// and a column past the end of its line gives that line's end.
JS_EXPORT_PRIVATE unsigned offsetForPosition(StringView text, unsigned line0Based, unsigned column0Based);
JS_EXPORT_PRIVATE LineColumn zeroBasedLineColumnForOffset(const SourceProvider&, unsigned offset);
bool isBuilt() const
{
Locker locker { m_lock };
return !!m_lineStarts;
}
private:
template<typename CharType> static Vector<unsigned> build(std::span<const CharType>);
const Vector<unsigned>& ensureBuilt(StringView) WTF_REQUIRES_LOCK(m_lock);
mutable Lock m_lock;
std::optional<Vector<unsigned>> m_lineStarts WTF_GUARDED_BY_LOCK(m_lock);
unsigned m_builtForLength WTF_GUARDED_BY_LOCK(m_lock) { 0 };
};
class SourceProvider : public ThreadSafeRefCounted<SourceProvider> {
public:
static const intptr_t nullID = 1;
JS_EXPORT_PRIVATE SourceProvider(const SourceOrigin&, String&& sourceURL, String&& preRedirectURL, SourceTaintedness, const TextPosition& startPosition, SourceProviderSourceType);
JS_EXPORT_PRIVATE virtual ~SourceProvider();
virtual unsigned hash() const = 0;
virtual StringView source() const = 0;
virtual RefPtr<CachedBytecode> cachedBytecode() const { return nullptr; }
virtual void cacheBytecode(const BytecodeCacheGenerator&) const { }
virtual void updateCache(const UnlinkedFunctionExecutable*, const SourceCode&, CodeSpecializationKind, const UnlinkedFunctionCodeBlock*) const { }
virtual void commitCachedBytecode() const { }
StringView getRange(int start, int end) const LIFETIME_BOUND
{
return source().substring(start, end - start);
}
const SourceOrigin& sourceOrigin() const LIFETIME_BOUND { return m_sourceOrigin; }
// This is NOT the path that should be used for computing relative paths from a script. Use SourceOrigin's URL for that, the values may or may not be the same...
const String& sourceURL() const LIFETIME_BOUND { return m_sourceURL; }
const String& sourceURLStripped();
const String& preRedirectURL() const LIFETIME_BOUND { return m_preRedirectURL; }
const String& sourceURLDirective() const LIFETIME_BOUND { return m_sourceURLDirective; }
const String& sourceMappingURLDirective() const LIFETIME_BOUND { return m_sourceMappingURLDirective; }
TextPosition startPosition() const { return m_startPosition; }
SourceProviderSourceType sourceType() const { return m_sourceType; }
bool isModuleType() const
{
switch (m_sourceType) {
case SourceProviderSourceType::Module:
case SourceProviderSourceType::JSON:
case SourceProviderSourceType::Text:
case SourceProviderSourceType::CSS:
return true;
default:
return false;
}
}
SourceID asID()
{
if (!m_id)
getID();
return m_id;
}
void setSourceURLDirective(const String& sourceURLDirective) { m_sourceURLDirective = sourceURLDirective; }
void setSourceMappingURLDirective(const String& sourceMappingURLDirective) { m_sourceMappingURLDirective = sourceMappingURLDirective; }
void setSourceTaintedOrigin(SourceTaintKind kind, SourceTaintedOrigin taintedness) { m_taintedness[kind] = taintedness; }
SourceTaintedness taintedness() const { return m_taintedness; }
SourceTaintedOrigin sourceTaintedOrigin(SourceTaintKind kind) const { return m_taintedness[kind]; }
bool LEGACY_NODELETE couldBeTainted() const { return m_taintedness.couldBeTainted(); }
JS_EXPORT_PRIVATE void lockUnderlyingBuffer();
JS_EXPORT_PRIVATE void unlockUnderlyingBuffer();
JS_EXPORT_PRIVATE CodeBlockHash codeBlockHashConcurrently(int startOffset, int endOffset, CodeSpecializationKind) const;
// Like source(), but safe on any thread. The text is valid only during the call.
JS_EXPORT_PRIVATE virtual void withSourceConcurrently(const ScopedLambda<void(StringView)>&) const;
virtual bool isScriptBufferSourceProvider() const { return false; }
JS_EXPORT_PRIVATE UTF8CString sourceCodeDumpFilePath(const UTF8CString& dumpDirectory);
LineStartTable::PositionInfo positionInfoForOffset(unsigned offset)
{
// Reads source(), which is unsafe on GC threads. documentLineColumnForOffset() is a thread-safe option.
ASSERT(Thread::currentSingleton().gcThreadType() == GCThreadType::None);
return m_lineStartTable.positionInfoForOffset(source(), offset);
}
unsigned offsetForPosition(unsigned line0Based, unsigned column0Based)
{
ASSERT(Thread::currentSingleton().gcThreadType() == GCThreadType::None);
return m_lineStartTable.offsetForPosition(source(), line0Based, column0Based);
}
// An inline <script> shifts every line of its document, but shifts the column only on its first
// line, since later lines begin where their own line begins.
LineColumn documentZeroBasedLineColumnForOffset(unsigned offset)
{
auto position = m_lineStartTable.zeroBasedLineColumnForOffset(*this, offset);
return {
m_startPosition.m_line.zeroBasedInt() + position.line,
position.line ? position.column : m_startPosition.m_column.zeroBasedInt() + position.column,
};
}
LineColumn documentLineColumnForOffset(unsigned offset)
{
auto position = documentZeroBasedLineColumnForOffset(offset);
return { position.line + 1, position.column + 1 };
}
bool lineStartTableIsBuilt() const { return m_lineStartTable.isBuilt(); }
private:
JS_EXPORT_PRIVATE virtual void lockUnderlyingBufferImpl();
JS_EXPORT_PRIVATE virtual void unlockUnderlyingBufferImpl();
JS_EXPORT_PRIVATE void LEGACY_NODELETE getID();
std::atomic<unsigned> m_lockingCount { 0 };
SourceProviderSourceType m_sourceType;
SourceOrigin m_sourceOrigin;
String m_sourceURL;
String m_sourceURLStripped;
String m_preRedirectURL;
String m_sourceURLDirective;
String m_sourceMappingURLDirective;
TextPosition m_startPosition;
SourceID m_id { 0 };
SourceTaintedness m_taintedness;
std::atomic<bool> m_sourceCodeDumped { false };
Lock m_sourceCodeDumpLock;
UTF8CString m_sourceCodeDumpFilePath WTF_GUARDED_BY_LOCK(m_sourceCodeDumpLock);
LineStartTable m_lineStartTable;
};
DECLARE_ALLOCATOR_WITH_HEAP_IDENTIFIER(StringSourceProvider);
class StringSourceProvider : public SourceProvider {
WTF_DEPRECATED_MAKE_FAST_ALLOCATED_WITH_HEAP_IDENTIFIER(StringSourceProvider, StringSourceProvider);
public:
static Ref<StringSourceProvider> create(const String& source, const SourceOrigin& sourceOrigin, String sourceURL, SourceTaintedness taintedness, const TextPosition& startPosition = TextPosition(), SourceProviderSourceType sourceType = SourceProviderSourceType::Program)
{
return adoptRef(*new StringSourceProvider(source, sourceOrigin, taintedness, WTF::move(sourceURL), startPosition, sourceType));
}
unsigned hash() const override
{
return m_source.get().hash();
}
StringView source() const override
{
return m_source.get();
}
protected:
StringSourceProvider(const String& source, const SourceOrigin& sourceOrigin, SourceTaintedness taintedness, String&& sourceURL, const TextPosition& startPosition, SourceProviderSourceType sourceType)
: SourceProvider(sourceOrigin, WTF::move(sourceURL), String(), taintedness, startPosition, sourceType)
, m_source(source.isNull() ? *StringImpl::empty() : *source.impl())
{
}
private:
const Ref<StringImpl> m_source;
};
#if ENABLE(WEBASSEMBLY)
class BaseWebAssemblySourceProvider : public SourceProvider {
public:
virtual const uint8_t* data() = 0;
virtual size_t size() const = 0;
protected:
JS_EXPORT_PRIVATE BaseWebAssemblySourceProvider(const SourceOrigin&, String&& sourceURL);
};
class WebAssemblySourceProvider final : public BaseWebAssemblySourceProvider {
public:
static Ref<WebAssemblySourceProvider> create(Vector<uint8_t>&& data, const SourceOrigin& sourceOrigin, String sourceURL)
{
return adoptRef(*new WebAssemblySourceProvider(WTF::move(data), sourceOrigin, WTF::move(sourceURL)));
}
unsigned hash() const final
{
return m_source.impl()->hash();
}
StringView source() const final
{
return m_source;
}
const uint8_t* data() final
{
return m_data.span().data();
}
size_t size() const final
{
return m_data.size();
}
const Vector<uint8_t>& dataVector() const
{
return m_data;
}
private:
WebAssemblySourceProvider(Vector<uint8_t>&& data, const SourceOrigin& sourceOrigin, String&& sourceURL)
: BaseWebAssemblySourceProvider(sourceOrigin, WTF::move(sourceURL))
, m_source("[WebAssembly source]"_s)
, m_data(WTF::move(data))
{
}
String m_source;
Vector<uint8_t> m_data;
};
#endif
// RAII class for managing a source provider's underlying buffer.
class SourceProviderBufferGuard {
public:
explicit SourceProviderBufferGuard(SourceProvider* sourceProvider)
: m_sourceProvider(sourceProvider)
{
if (m_sourceProvider)
m_sourceProvider->lockUnderlyingBuffer();
}
~SourceProviderBufferGuard()
{
if (m_sourceProvider)
m_sourceProvider->unlockUnderlyingBuffer();
}
SourceProvider* provider() { return m_sourceProvider; }
private:
// This must not be RefPtr. It is possible that this is used by the concurrent compiler and
// we are ensuring that this does not go away with different mechanism. But SourceProvider etc. can have main-thread-only affinity.
SourceProvider* m_sourceProvider { nullptr };
};
} // namespace JSC