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
|
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_THREAD_SAFE_SCRIPT_CONTAINER_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_THREAD_SAFE_SCRIPT_CONTAINER_H_
#include <memory>
#include <utility>
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/network/http_header_map.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/weborigin/kurl_hash.h"
#include "third_party/blink/renderer/platform/wtf/hash_map.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "third_party/blink/renderer/platform/wtf/thread_safe_ref_counted.h"
#include "third_party/blink/renderer/platform/wtf/threading_primitives.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
namespace blink {
// ThreadSafeScriptContainer stores the scripts of a service worker for
// startup. This container is created for each service worker. The IO thread
// adds scripts to the container, and the worker thread takes the scripts.
// Note: Due to the above explanations about multi-threads access on this
// container, all the non-thread-safe members like KURL and String need to be
// deep-copied.
//
// This class uses explicit synchronization because it needs to support
// synchronous importScripts() from the worker thread.
//
// This class is RefCounted because there is no ordering guarantee of lifetime
// of its owners, i.e. ServiceWorkerInstalledScriptsManager and its
// Internal class. ServiceWorkerInstalledScriptsManager is destroyed earlier
// than Internal if the worker is terminated before all scripts are streamed,
// and Internal is destroyed earlier if all of scripts are received before
// finishing script evaluation.
class MODULES_EXPORT ThreadSafeScriptContainer
: public WTF::ThreadSafeRefCounted<ThreadSafeScriptContainer> {
public:
using BytesChunk = Vector<char>;
// Container of a script. All the fields of this class need to be
// cross-thread-transfer-safe.
class MODULES_EXPORT RawScriptData {
USING_FAST_MALLOC(RawScriptData);
public:
RawScriptData(const String& encoding,
Vector<uint8_t> script_text,
Vector<uint8_t> meta_data);
~RawScriptData();
void AddHeader(const String& key, const String& value);
// The encoding of the script text.
const String& Encoding() const { return encoding_; }
// An array of raw bytes representing the script text.
Vector<uint8_t> TakeScriptText() { return std::move(script_text_); }
// An array of raw bytes representing the cached metadata.
Vector<uint8_t> TakeMetaData() { return std::move(meta_data_); }
// The HTTP headers of the script.
std::unique_ptr<CrossThreadHTTPHeaderMapData> TakeHeaders() {
return std::move(headers_);
}
private:
String encoding_;
Vector<uint8_t> script_text_;
Vector<uint8_t> meta_data_;
std::unique_ptr<CrossThreadHTTPHeaderMapData> headers_;
};
ThreadSafeScriptContainer();
enum class ScriptStatus {
// The script data has been received.
kReceived,
// The script data has been received but it has already been taken.
kTaken,
// Receiving the script has failed.
kFailed,
// The script data has not been received yet.
kPending
};
// Adds a script for the |url| to the container, and records status of the
// script as kReceived when |data| is non-null, or kFailed when |data| is
// nullptr. Called on the IO thread.
void AddOnIOThread(const KURL& url, std::unique_ptr<RawScriptData> data);
// Called on the worker thread.
ScriptStatus GetStatusOnWorkerThread(const KURL& url);
// Removes the script. After calling this, ScriptStatus for the
// script will be kPending.
// Called on the worker thread.
void ResetOnWorkerThread(const KURL& url);
// Waits until the script is added. The thread is blocked until the script is
// available or receiving the script fails. Returns false if an error happens
// and the waiting script won't be available forever.
// Called on the worker thread.
bool WaitOnWorkerThread(const KURL& url);
// Called on the worker thread.
std::unique_ptr<RawScriptData> TakeOnWorkerThread(const KURL& url);
// Called if no more data will be added.
// Called on the IO thread.
void OnAllDataAddedOnIOThread();
private:
friend class WTF::ThreadSafeRefCounted<ThreadSafeScriptContainer>;
~ThreadSafeScriptContainer();
// |mutex_| protects |waiting_cv_|, |script_data_|, |waiting_url_| and
// |are_all_data_added_|.
Mutex mutex_;
// |waiting_cv_| is signaled when a script whose url matches to |waiting_url|
// is added, or OnAllDataAdded is called. The worker thread waits on this, and
// the IO thread signals it.
ThreadCondition waiting_cv_;
HashMap<KURL, std::pair<ScriptStatus, std::unique_ptr<RawScriptData>>>
script_data_;
KURL waiting_url_;
bool are_all_data_added_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_THREAD_SAFE_SCRIPT_CONTAINER_H_
|
