mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
Joyee Cheung
7f2d61f82a
This is similar to the `queryObjects()` console API provided by the Chromium DevTools console. It can be used to search for objects that have the matching constructor on its prototype chain in the entire heap, which can be useful for memory leak regression tests. To avoid surprising results, users should avoid using this API on constructors whose implementation they don't control, or on constructors that can be invoked by other parties in the application. To avoid accidental leaks, this API does not return raw references to the objects found. By default, it returns the count of the objects found. If `options.format` is `'summary'`, it returns an array containing brief string representations for each object. The visibility provided in this API is similar to what the heap snapshot provides, while users can save the cost of serialization and parsing and directly filer the target objects during the search. We have been using this API internally for the test suite, which has been more stable than any other leak regression testing strategies in the CI. With a public implementation we can now use the public API instead. PR-URL: https://github.com/nodejs/node/pull/51927 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
197 lines
11 KiB
C++
197 lines
11 KiB
C++
#ifndef SRC_NODE_EXTERNAL_REFERENCE_H_
|
|
#define SRC_NODE_EXTERNAL_REFERENCE_H_
|
|
|
|
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
|
|
|
|
#include <cinttypes>
|
|
#include <vector>
|
|
#include "v8-fast-api-calls.h"
|
|
#include "v8.h"
|
|
|
|
namespace node {
|
|
|
|
using CFunctionCallbackWithOneByteString =
|
|
uint32_t (*)(v8::Local<v8::Value>, const v8::FastOneByteString&);
|
|
using CFunctionCallback = void (*)(v8::Local<v8::Value> receiver);
|
|
using CFunctionCallbackReturnDouble =
|
|
double (*)(v8::Local<v8::Object> receiver);
|
|
using CFunctionCallbackValueReturnDouble =
|
|
double (*)(v8::Local<v8::Value> receiver);
|
|
using CFunctionCallbackWithInt64 = void (*)(v8::Local<v8::Object> receiver,
|
|
int64_t);
|
|
using CFunctionCallbackWithBool = void (*)(v8::Local<v8::Object> receiver,
|
|
bool);
|
|
using CFunctionCallbackWithString =
|
|
bool (*)(v8::Local<v8::Value>, const v8::FastOneByteString& input);
|
|
using CFunctionCallbackWithStrings =
|
|
bool (*)(v8::Local<v8::Value>,
|
|
const v8::FastOneByteString& input,
|
|
const v8::FastOneByteString& base);
|
|
using CFunctionWithUint32 = uint32_t (*)(v8::Local<v8::Value>,
|
|
const uint32_t input);
|
|
using CFunctionWithDoubleReturnDouble = double (*)(v8::Local<v8::Value>,
|
|
const double);
|
|
using CFunctionWithInt64Fallback = void (*)(v8::Local<v8::Value>,
|
|
const int64_t,
|
|
v8::FastApiCallbackOptions&);
|
|
using CFunctionWithBool = void (*)(v8::Local<v8::Value>, bool);
|
|
|
|
// This class manages the external references from the V8 heap
|
|
// to the C++ addresses in Node.js.
|
|
class ExternalReferenceRegistry {
|
|
public:
|
|
ExternalReferenceRegistry();
|
|
|
|
#define ALLOWED_EXTERNAL_REFERENCE_TYPES(V) \
|
|
V(CFunctionCallback) \
|
|
V(CFunctionCallbackWithOneByteString) \
|
|
V(CFunctionCallbackReturnDouble) \
|
|
V(CFunctionCallbackValueReturnDouble) \
|
|
V(CFunctionCallbackWithInt64) \
|
|
V(CFunctionCallbackWithBool) \
|
|
V(CFunctionCallbackWithString) \
|
|
V(CFunctionCallbackWithStrings) \
|
|
V(CFunctionWithUint32) \
|
|
V(CFunctionWithDoubleReturnDouble) \
|
|
V(CFunctionWithInt64Fallback) \
|
|
V(CFunctionWithBool) \
|
|
V(const v8::CFunctionInfo*) \
|
|
V(v8::FunctionCallback) \
|
|
V(v8::AccessorGetterCallback) \
|
|
V(v8::AccessorSetterCallback) \
|
|
V(v8::AccessorNameGetterCallback) \
|
|
V(v8::AccessorNameSetterCallback) \
|
|
V(v8::GenericNamedPropertyDefinerCallback) \
|
|
V(v8::GenericNamedPropertyDeleterCallback) \
|
|
V(v8::GenericNamedPropertyEnumeratorCallback) \
|
|
V(v8::GenericNamedPropertyQueryCallback) \
|
|
V(v8::GenericNamedPropertySetterCallback) \
|
|
V(v8::IndexedPropertySetterCallback) \
|
|
V(v8::IndexedPropertyDefinerCallback) \
|
|
V(v8::IndexedPropertyDeleterCallback) \
|
|
V(v8::IndexedPropertyQueryCallback) \
|
|
V(v8::IndexedPropertyDescriptorCallback) \
|
|
V(const v8::String::ExternalStringResourceBase*)
|
|
|
|
#define V(ExternalReferenceType) \
|
|
void Register(ExternalReferenceType addr) { RegisterT(addr); }
|
|
ALLOWED_EXTERNAL_REFERENCE_TYPES(V)
|
|
#undef V
|
|
|
|
// This can be called only once.
|
|
const std::vector<intptr_t>& external_references();
|
|
|
|
bool is_empty() { return external_references_.empty(); }
|
|
|
|
private:
|
|
template <typename T>
|
|
void RegisterT(T* address) {
|
|
external_references_.push_back(reinterpret_cast<intptr_t>(address));
|
|
}
|
|
bool is_finalized_ = false;
|
|
std::vector<intptr_t> external_references_;
|
|
};
|
|
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_BASE(V) \
|
|
V(async_wrap) \
|
|
V(binding) \
|
|
V(blob) \
|
|
V(buffer) \
|
|
V(builtins) \
|
|
V(cares_wrap) \
|
|
V(contextify) \
|
|
V(credentials) \
|
|
V(encoding_binding) \
|
|
V(env_var) \
|
|
V(errors) \
|
|
V(fs) \
|
|
V(fs_dir) \
|
|
V(fs_event_wrap) \
|
|
V(handle_wrap) \
|
|
V(heap_utils) \
|
|
V(internal_only_v8) \
|
|
V(messaging) \
|
|
V(mksnapshot) \
|
|
V(module_wrap) \
|
|
V(modules) \
|
|
V(options) \
|
|
V(os) \
|
|
V(performance) \
|
|
V(permission) \
|
|
V(process_methods) \
|
|
V(process_object) \
|
|
V(process_wrap) \
|
|
V(report) \
|
|
V(task_queue) \
|
|
V(tcp_wrap) \
|
|
V(tty_wrap) \
|
|
V(udp_wrap) \
|
|
V(url) \
|
|
V(util) \
|
|
V(pipe_wrap) \
|
|
V(sea) \
|
|
V(serdes) \
|
|
V(string_decoder) \
|
|
V(stream_wrap) \
|
|
V(signal_wrap) \
|
|
V(spawn_sync) \
|
|
V(trace_events) \
|
|
V(timers) \
|
|
V(types) \
|
|
V(uv) \
|
|
V(v8) \
|
|
V(zlib) \
|
|
V(wasm_web_api) \
|
|
V(worker)
|
|
|
|
#if NODE_HAVE_I18N_SUPPORT
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_I18N(V) V(icu)
|
|
#else
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_I18N(V)
|
|
#endif // NODE_HAVE_I18N_SUPPORT
|
|
|
|
#if HAVE_INSPECTOR
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_INSPECTOR(V) \
|
|
V(inspector) \
|
|
V(profiler)
|
|
#else
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_INSPECTOR(V)
|
|
#endif // HAVE_INSPECTOR
|
|
|
|
#if HAVE_OPENSSL
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_CRYPTO(V) V(crypto) V(tls_wrap)
|
|
#else
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_CRYPTO(V)
|
|
#endif // HAVE_OPENSSL
|
|
|
|
#if HAVE_OPENSSL && NODE_OPENSSL_HAS_QUIC
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_QUIC(V) V(quic)
|
|
#else
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST_QUIC(V)
|
|
#endif
|
|
|
|
#define EXTERNAL_REFERENCE_BINDING_LIST(V) \
|
|
EXTERNAL_REFERENCE_BINDING_LIST_BASE(V) \
|
|
EXTERNAL_REFERENCE_BINDING_LIST_INSPECTOR(V) \
|
|
EXTERNAL_REFERENCE_BINDING_LIST_I18N(V) \
|
|
EXTERNAL_REFERENCE_BINDING_LIST_CRYPTO(V) \
|
|
EXTERNAL_REFERENCE_BINDING_LIST_QUIC(V)
|
|
|
|
} // namespace node
|
|
|
|
// Declare all the external reference registration functions here,
|
|
// and define them later with #NODE_BINDING_EXTERNAL_REFERENCE(modname, func);
|
|
#define V(modname) \
|
|
void _register_external_reference_##modname( \
|
|
node::ExternalReferenceRegistry* registry);
|
|
EXTERNAL_REFERENCE_BINDING_LIST(V)
|
|
#undef V
|
|
|
|
#define NODE_BINDING_EXTERNAL_REFERENCE(modname, func) \
|
|
void _register_external_reference_##modname( \
|
|
node::ExternalReferenceRegistry* registry) { \
|
|
func(registry); \
|
|
}
|
|
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
|
|
#endif // SRC_NODE_EXTERNAL_REFERENCE_H_
|