Loading...
Searching...
No Matches
v8-metrics.h
Go to the documentation of this file.
1// Copyright 2020 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef V8_METRICS_H_
6#define V8_METRICS_H_
7
8#include <stddef.h>
9#include <stdint.h>
10
11#include <optional>
12#include <vector>
13
14#include "v8-internal.h" // NOLINT(build/include_directory)
15#include "v8-isolate.h" // NOLINT(build/include_directory)
16#include "v8-local-handle.h" // NOLINT(build/include_directory)
17#include "v8config.h" // NOLINT(build/include_directory)
18
19namespace v8 {
20
21class Context;
22class Isolate;
23
24namespace metrics {
25
32};
33
35 int64_t bytes_before = -1;
36 int64_t bytes_after = -1;
37 int64_t bytes_freed = -1;
38};
39
41 int64_t bytes_baseline = -1;
42 int64_t bytes_limit = -1;
43 int64_t bytes_current = -1;
44 int64_t bytes_max = -1;
45};
46
48 int reason = -1;
50 // The priority of the isolate during the GC cycle. A nullopt value denotes a
51 // mixed priority cycle, meaning the Isolate's priority was changed while the
52 // cycle was in progress.
53 std::optional<v8::Isolate::Priority> priority = std::nullopt;
54 bool reduce_memory = false;
55 bool is_loading = false;
83};
84
88};
89
93};
94
95template <typename EventType>
97 std::vector<EventType> events;
98};
99
106
108 int reason = -1;
109 // The priority of the isolate during the GC cycle. A nullopt value denotes a
110 // mixed priority cycle, meaning the Isolate's priority was changed while the
111 // cycle was in progress.
112 std::optional<v8::Isolate::Priority> priority = std::nullopt;
118#if defined(CPPGC_YOUNG_GENERATION)
119 GarbageCollectionPhases total_cpp;
120 GarbageCollectionSizes objects_cpp;
121 GarbageCollectionSizes memory_cpp;
122 double collection_rate_cpp_in_percent = -1.0;
123 double efficiency_cpp_in_bytes_per_us = -1.0;
124 double main_thread_efficiency_cpp_in_bytes_per_us = -1.0;
125#endif // defined(CPPGC_YOUNG_GENERATION)
126};
127
129 WasmModuleDecoded() = default;
133 : async(async),
139
140 bool async = false;
141 bool streamed = false;
142 bool success = false;
144 size_t function_count = 0;
146};
147
150
152 bool lazy, bool success, size_t code_size_in_bytes,
155 : async(async),
157 cached(cached),
159 lazy(lazy),
164
165 bool async = false;
166 bool streamed = false;
167 bool cached = false;
168 bool deserialized = false;
169 bool lazy = false;
170 bool success = false;
174};
175
177 bool async = false;
178 bool success = false;
181};
182
184 size_t count = 0;
185};
186
201 public:
202 // A unique identifier for a context in this Isolate.
203 // It is guaranteed to not be reused throughout the lifetime of the Isolate.
204 class ContextId {
205 public:
206 ContextId() : id_(kEmptyId) {}
207
208 bool IsEmpty() const { return id_ == kEmptyId; }
209 static const ContextId Empty() { return ContextId{kEmptyId}; }
210
211 bool operator==(const ContextId& other) const { return id_ == other.id_; }
212 bool operator!=(const ContextId& other) const { return id_ != other.id_; }
213
214 private:
215 friend class ::v8::Context;
216 friend class ::v8::internal::Isolate;
217
218 explicit ContextId(uintptr_t id) : id_(id) {}
219
220 static constexpr uintptr_t kEmptyId = 0;
221 uintptr_t id_;
222 };
223
224 virtual ~Recorder() = default;
225
226 // Main thread events. Those are only triggered on the main thread, and hence
227 // can access the context.
228#define ADD_MAIN_THREAD_EVENT(E) \
229 virtual void AddMainThreadEvent(const E&, ContextId) {}
239#undef ADD_MAIN_THREAD_EVENT
240
241 // Thread-safe events are not allowed to access the context and therefore do
242 // not carry a context ID with them. These IDs can be generated using
243 // Recorder::GetContextId() and the ID will be valid throughout the lifetime
244 // of the isolate. It is not guaranteed that the ID will still resolve to
245 // a valid context using Recorder::GetContext() at the time the metric is
246 // recorded. In this case, an empty handle will be returned.
247#define ADD_THREAD_SAFE_EVENT(E) \
248 virtual void AddThreadSafeEvent(const E&) {}
250#undef ADD_THREAD_SAFE_EVENT
251
252 virtual void NotifyIsolateDisposal() {}
253
254 // Return the context with the given id or an empty handle if the context
255 // was already garbage collected.
257 // Return the unique id corresponding to the given context.
259};
260
273 V8_INLINE static void Reset(Isolate* isolate) {
275 }
276
280 static LongTaskStats Get(Isolate* isolate);
281
282 int64_t gc_full_atomic_wall_clock_duration_us = 0;
283 int64_t gc_full_incremental_wall_clock_duration_us = 0;
284 int64_t gc_young_wall_clock_duration_us = 0;
285 // Only collected with --slow-histograms
286 int64_t v8_execute_us = 0;
287};
288
289} // namespace metrics
290} // namespace v8
291
292#endif // V8_METRICS_H_
Definition: v8-isolate.h:290
Definition: v8-local-handle.h:366
Definition: v8-local-handle.h:734
static void IncrementLongTasksStatsCounter(v8::Isolate *isolate)
Definition: v8-internal.h:1258
Definition: v8-metrics.h:204
ContextId()
Definition: v8-metrics.h:206
bool operator==(const ContextId &other) const
Definition: v8-metrics.h:211
static const ContextId Empty()
Definition: v8-metrics.h:209
bool operator!=(const ContextId &other) const
Definition: v8-metrics.h:212
bool IsEmpty() const
Definition: v8-metrics.h:208
Definition: v8-metrics.h:200
virtual ~Recorder()=default
static MaybeLocal< Context > GetContext(Isolate *isolate, ContextId id)
virtual void NotifyIsolateDisposal()
Definition: v8-metrics.h:252
static ContextId GetContextId(Local< Context > context)
Definition: libplatform.h:15
std::vector< EventType > events
Definition: v8-metrics.h:97
Definition: v8-metrics.h:47
GarbageCollectionPhases main_thread_incremental
Definition: v8-metrics.h:62
double collection_weight_in_percent
Definition: v8-metrics.h:77
double collection_weight_cpp_in_percent
Definition: v8-metrics.h:78
double main_thread_efficiency_cpp_in_bytes_per_us
Definition: v8-metrics.h:76
GarbageCollectionLimits global_consumed
Definition: v8-metrics.h:69
int64_t external_memory_bytes
Definition: v8-metrics.h:70
double collection_rate_cpp_in_percent
Definition: v8-metrics.h:72
GarbageCollectionSizes memory_cpp
Definition: v8-metrics.h:67
GarbageCollectionPhases main_thread_cpp
Definition: v8-metrics.h:59
GarbageCollectionLimits old_generation_consumed
Definition: v8-metrics.h:68
double efficiency_cpp_in_bytes_per_us
Definition: v8-metrics.h:74
GarbageCollectionSizes memory
Definition: v8-metrics.h:66
int64_t total_duration_since_last_mark_compact
Definition: v8-metrics.h:82
bool reduce_memory
Definition: v8-metrics.h:54
GarbageCollectionPhases main_thread_incremental_cpp
Definition: v8-metrics.h:63
double main_thread_efficiency_in_bytes_per_us
Definition: v8-metrics.h:75
GarbageCollectionSizes objects
Definition: v8-metrics.h:64
int64_t incremental_marking_start_stop_wall_clock_duration_in_us
Definition: v8-metrics.h:81
GarbageCollectionPhases main_thread_atomic_cpp
Definition: v8-metrics.h:61
double collection_rate_in_percent
Definition: v8-metrics.h:71
bool is_loading
Definition: v8-metrics.h:55
GarbageCollectionPhases main_thread
Definition: v8-metrics.h:58
int incremental_marking_reason
Definition: v8-metrics.h:49
std::optional< v8::Isolate::Priority > priority
Definition: v8-metrics.h:53
GarbageCollectionPhases total_cpp
Definition: v8-metrics.h:57
GarbageCollectionPhases total
Definition: v8-metrics.h:56
double main_thread_collection_weight_in_percent
Definition: v8-metrics.h:79
GarbageCollectionPhases main_thread_atomic
Definition: v8-metrics.h:60
int reason
Definition: v8-metrics.h:48
double efficiency_in_bytes_per_us
Definition: v8-metrics.h:73
GarbageCollectionSizes objects_cpp
Definition: v8-metrics.h:65
double main_thread_collection_weight_cpp_in_percent
Definition: v8-metrics.h:80
int64_t cpp_wall_clock_duration_in_us
Definition: v8-metrics.h:87
int64_t wall_clock_duration_in_us
Definition: v8-metrics.h:86
int64_t wall_clock_duration_in_us
Definition: v8-metrics.h:91
int64_t cpp_wall_clock_duration_in_us
Definition: v8-metrics.h:92
Definition: v8-metrics.h:40
int64_t bytes_limit
Definition: v8-metrics.h:42
int64_t bytes_max
Definition: v8-metrics.h:44
int64_t bytes_current
Definition: v8-metrics.h:43
int64_t bytes_baseline
Definition: v8-metrics.h:41
Definition: v8-metrics.h:26
int64_t sweep_wall_clock_duration_in_us
Definition: v8-metrics.h:30
int64_t weak_wall_clock_duration_in_us
Definition: v8-metrics.h:31
int64_t total_wall_clock_duration_in_us
Definition: v8-metrics.h:27
int64_t mark_wall_clock_duration_in_us
Definition: v8-metrics.h:29
int64_t compact_wall_clock_duration_in_us
Definition: v8-metrics.h:28
Definition: v8-metrics.h:34
int64_t bytes_freed
Definition: v8-metrics.h:37
int64_t bytes_after
Definition: v8-metrics.h:36
int64_t bytes_before
Definition: v8-metrics.h:35
Definition: v8-metrics.h:107
int64_t main_thread_wall_clock_duration_in_us
Definition: v8-metrics.h:114
double collection_rate_in_percent
Definition: v8-metrics.h:115
double efficiency_in_bytes_per_us
Definition: v8-metrics.h:116
double main_thread_efficiency_in_bytes_per_us
Definition: v8-metrics.h:117
int reason
Definition: v8-metrics.h:108
int64_t total_wall_clock_duration_in_us
Definition: v8-metrics.h:113
std::optional< v8::Isolate::Priority > priority
Definition: v8-metrics.h:112
Definition: v8-metrics.h:269
static void Reset(Isolate *isolate)
Definition: v8-metrics.h:273
static LongTaskStats Get(Isolate *isolate)
Definition: v8-metrics.h:148
WasmModuleCompiled(bool async, bool streamed, bool cached, bool deserialized, bool lazy, bool success, size_t code_size_in_bytes, size_t liftoff_bailout_count, int64_t wall_clock_duration_in_us)
Definition: v8-metrics.h:151
bool cached
Definition: v8-metrics.h:167
size_t liftoff_bailout_count
Definition: v8-metrics.h:172
bool lazy
Definition: v8-metrics.h:169
bool async
Definition: v8-metrics.h:165
bool deserialized
Definition: v8-metrics.h:168
int64_t wall_clock_duration_in_us
Definition: v8-metrics.h:173
bool success
Definition: v8-metrics.h:170
size_t code_size_in_bytes
Definition: v8-metrics.h:171
bool streamed
Definition: v8-metrics.h:166
Definition: v8-metrics.h:128
size_t module_size_in_bytes
Definition: v8-metrics.h:143
bool async
Definition: v8-metrics.h:140
size_t function_count
Definition: v8-metrics.h:144
bool success
Definition: v8-metrics.h:142
int64_t wall_clock_duration_in_us
Definition: v8-metrics.h:145
bool streamed
Definition: v8-metrics.h:141
WasmModuleDecoded(bool async, bool streamed, bool success, size_t module_size_in_bytes, size_t function_count, int64_t wall_clock_duration_in_us)
Definition: v8-metrics.h:130
Definition: v8-metrics.h:176
bool async
Definition: v8-metrics.h:177
int64_t wall_clock_duration_in_us
Definition: v8-metrics.h:180
bool success
Definition: v8-metrics.h:178
size_t imported_function_count
Definition: v8-metrics.h:179
Definition: v8-metrics.h:183
size_t count
Definition: v8-metrics.h:184
#define ADD_MAIN_THREAD_EVENT(E)
Definition: v8-metrics.h:228
#define ADD_THREAD_SAFE_EVENT(E)
Definition: v8-metrics.h:247
#define V8_EXPORT
Definition: v8config.h:860
#define V8_INLINE
Definition: v8config.h:513