367da30543
Add a framework for collecting event-based metrics like UKMs in V8 that is independent of the actual implementation. Design doc: https://docs.google.com/document/d/1vCZQCh4B05isqwJOwTPv7WqcnVp4KJITMgsHSBg35ZI/ R=ulan@chromium.org Bug: chromium:1101749 Change-Id: If3a5b954d1f0bcee4e06a03467b651feae378a5f Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/2288231 Commit-Queue: Emanuel Ziegler <ecmziegler@chromium.org> Reviewed-by: Ross McIlroy <rmcilroy@chromium.org> Reviewed-by: Ulan Degenbaev <ulan@chromium.org> Cr-Commit-Position: refs/heads/master@{#69098}
106 lines
3.3 KiB
C++
106 lines
3.3 KiB
C++
// Copyright 2020 the V8 project 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 V8_METRICS_H_
|
|
#define V8_METRICS_H_
|
|
|
|
#include "v8.h" // NOLINT(build/include_directory)
|
|
|
|
namespace v8 {
|
|
namespace metrics {
|
|
|
|
struct WasmModuleDecoded {
|
|
bool async = false;
|
|
bool streamed = false;
|
|
bool success = false;
|
|
size_t module_size_in_bytes = 0;
|
|
size_t function_count = 0;
|
|
int64_t wall_clock_time_in_us = 0;
|
|
};
|
|
|
|
struct WasmModuleCompiled {
|
|
bool async = false;
|
|
bool streamed = false;
|
|
bool cached = false;
|
|
bool deserialized = false;
|
|
bool lazy = false;
|
|
bool success = false;
|
|
size_t code_size_in_bytes = 0;
|
|
size_t liftoff_bailout_count = 0;
|
|
int64_t wall_clock_time_in_us = 0;
|
|
};
|
|
|
|
struct WasmModuleInstantiated {
|
|
bool async = false;
|
|
bool success = false;
|
|
size_t imported_function_count = 0;
|
|
int64_t wall_clock_time_in_us = 0;
|
|
};
|
|
|
|
struct WasmModuleTieredUp {
|
|
bool lazy = false;
|
|
size_t code_size_in_bytes = 0;
|
|
int64_t wall_clock_time_in_us = 0;
|
|
};
|
|
|
|
struct WasmModulesPerIsolate {
|
|
size_t count = 0;
|
|
};
|
|
|
|
#define V8_MAIN_THREAD_METRICS_EVENTS(V) \
|
|
V(WasmModuleDecoded) \
|
|
V(WasmModuleCompiled) \
|
|
V(WasmModuleInstantiated) \
|
|
V(WasmModuleTieredUp)
|
|
|
|
#define V8_THREAD_SAFE_METRICS_EVENTS(V) V(WasmModulesPerIsolate)
|
|
|
|
/**
|
|
* This class serves as a base class for recording event-based metrics in V8.
|
|
* There a two kinds of metrics, those which are expected to be thread-safe and
|
|
* whose implementation is required to fulfill this requirement and those whose
|
|
* implementation does not have that requirement and only needs to be
|
|
* executable on the main thread. If such an event is triggered from a
|
|
* background thread, it will be delayed and executed by the foreground task
|
|
* runner.
|
|
*
|
|
* The thread-safe events are listed in the V8_THREAD_SAFE_METRICS_EVENTS
|
|
* macro above while the main thread event are listed in
|
|
* V8_MAIN_THREAD_METRICS_EVENTS above. For the former, a virtual method
|
|
* AddMainThreadEvent(const E& event, v8::Context::Token token) will be
|
|
* generated and for the latter AddThreadSafeEvent(const E& event).
|
|
*
|
|
* Thread-safe events are not allowed to access the context and therefore do
|
|
* not carry a context token with them. These tokens can be generated from
|
|
* contexts using GetToken() and the token will be valid as long as the isolate
|
|
* and the context live. It is not guaranteed that the token will still resolve
|
|
* to a valid context using v8::Context::GetByToken() at the time the metric is
|
|
* recorded. In this case, an empty handle will be returned.
|
|
*
|
|
* The embedder is expected to call v8::Isolate::SetMetricsRecorder()
|
|
* providing its implementation and have the virtual methods overwritten
|
|
* for the events it cares about.
|
|
*/
|
|
class Recorder {
|
|
public:
|
|
virtual ~Recorder() = default;
|
|
|
|
#define ADD_MAIN_THREAD_EVENT(E) \
|
|
virtual void AddMainThreadEvent(const E& event, v8::Context::Token token) {}
|
|
V8_MAIN_THREAD_METRICS_EVENTS(ADD_MAIN_THREAD_EVENT)
|
|
#undef ADD_MAIN_THREAD_EVENT
|
|
|
|
#define ADD_THREAD_SAFE_EVENT(E) \
|
|
virtual void AddThreadSafeEvent(const E& event) {}
|
|
V8_THREAD_SAFE_METRICS_EVENTS(ADD_THREAD_SAFE_EVENT)
|
|
#undef ADD_THREAD_SAFE_EVENT
|
|
|
|
virtual void NotifyIsolateDisposal() {}
|
|
};
|
|
|
|
} // namespace metrics
|
|
} // namespace v8
|
|
|
|
#endif // V8_METRICS_H_
|