libv8-node 15.14.0.1-x86_64-darwin-21

data/vendor/v8/include/v8-fast-api-calls.h

@@ -0,0 +1,388 @@
+// 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.
+
+/**
+ * This file provides additional API on top of the default one for making
+ * API calls, which come from embedder C++ functions. The functions are being
+ * called directly from optimized code, doing all the necessary typechecks
+ * in the compiler itself, instead of on the embedder side. Hence the "fast"
+ * in the name. Example usage might look like:
+ *
+ * \code
+ *    void FastMethod(int param, bool another_param);
+ *
+ *    v8::FunctionTemplate::New(isolate, SlowCallback, data,
+ *                              signature, length, constructor_behavior
+ *                              side_effect_type,
+ *                              &v8::CFunction::Make(FastMethod));
+ * \endcode
+ *
+ * An example for custom embedder type support might employ a way to wrap/
+ * unwrap various C++ types in JSObject instances, e.g:
+ *
+ * \code
+ *
+ *    // Helper method with a check for field count.
+ *    template <typename T, int offset>
+ *    inline T* GetInternalField(v8::Local<v8::Object> wrapper) {
+ *      assert(offset < wrapper->InternalFieldCount());
+ *      return reinterpret_cast<T*>(
+ *          wrapper->GetAlignedPointerFromInternalField(offset));
+ *    }
+ *
+ *    class CustomEmbedderType {
+ *     public:
+ *      // Returns the raw C object from a wrapper JS object.
+ *      static CustomEmbedderType* Unwrap(v8::Local<v8::Object> wrapper) {
+ *        return GetInternalField<CustomEmbedderType,
+ *                                kV8EmbedderWrapperObjectIndex>(wrapper);
+ *      }
+ *      static void FastMethod(v8::ApiObject receiver_obj, int param) {
+ *        v8::Object* v8_object = reinterpret_cast<v8::Object*>(&api_object);
+ *        CustomEmbedderType* receiver = static_cast<CustomEmbedderType*>(
+ *          receiver_obj->GetAlignedPointerFromInternalField(
+ *            kV8EmbedderWrapperObjectIndex));
+ *
+ *        // Type checks are already done by the optimized code.
+ *        // Then call some performance-critical method like:
+ *        // receiver->Method(param);
+ *      }
+ *
+ *      static void SlowMethod(
+ *          const v8::FunctionCallbackInfo<v8::Value>& info) {
+ *        v8::Local<v8::Object> instance =
+ *          v8::Local<v8::Object>::Cast(info.Holder());
+ *        CustomEmbedderType* receiver = Unwrap(instance);
+ *        // TODO: Do type checks and extract {param}.
+ *        receiver->Method(param);
+ *      }
+ *    };
+ *
+ *    // TODO(mslekova): Clean-up these constants
+ *    // The constants kV8EmbedderWrapperTypeIndex and
+ *    // kV8EmbedderWrapperObjectIndex describe the offsets for the type info
+ *    // struct and the native object, when expressed as internal field indices
+ *    // within a JSObject. The existance of this helper function assumes that
+ *    // all embedder objects have their JSObject-side type info at the same
+ *    // offset, but this is not a limitation of the API itself. For a detailed
+ *    // use case, see the third example.
+ *    static constexpr int kV8EmbedderWrapperTypeIndex = 0;
+ *    static constexpr int kV8EmbedderWrapperObjectIndex = 1;
+ *
+ *    // The following setup function can be templatized based on
+ *    // the {embedder_object} argument.
+ *    void SetupCustomEmbedderObject(v8::Isolate* isolate,
+ *                                   v8::Local<v8::Context> context,
+ *                                   CustomEmbedderType* embedder_object) {
+ *      isolate->set_embedder_wrapper_type_index(
+ *        kV8EmbedderWrapperTypeIndex);
+ *      isolate->set_embedder_wrapper_object_index(
+ *        kV8EmbedderWrapperObjectIndex);
+ *
+ *      v8::CFunction c_func =
+ *        MakeV8CFunction(CustomEmbedderType::FastMethod);
+ *
+ *      Local<v8::FunctionTemplate> method_template =
+ *        v8::FunctionTemplate::New(
+ *          isolate, CustomEmbedderType::SlowMethod, v8::Local<v8::Value>(),
+ *          v8::Local<v8::Signature>(), 1, v8::ConstructorBehavior::kAllow,
+ *          v8::SideEffectType::kHasSideEffect, &c_func);
+ *
+ *      v8::Local<v8::ObjectTemplate> object_template =
+ *        v8::ObjectTemplate::New(isolate);
+ *      object_template->SetInternalFieldCount(
+ *        kV8EmbedderWrapperObjectIndex + 1);
+ *      object_template->Set(isolate, "method", method_template);
+ *
+ *      // Instantiate the wrapper JS object.
+ *      v8::Local<v8::Object> object =
+ *          object_template->NewInstance(context).ToLocalChecked();
+ *      object->SetAlignedPointerInInternalField(
+ *        kV8EmbedderWrapperObjectIndex,
+ *        reinterpret_cast<void*>(embedder_object));
+ *
+ *      // TODO: Expose {object} where it's necessary.
+ *    }
+ * \endcode
+ *
+ * For instance if {object} is exposed via a global "obj" variable,
+ * one could write in JS:
+ *   function hot_func() {
+ *     obj.method(42);
+ *   }
+ * and once {hot_func} gets optimized, CustomEmbedderType::FastMethod
+ * will be called instead of the slow version, with the following arguments:
+ *   receiver := the {embedder_object} from above
+ *   param := 42
+ *
+ * Currently only void return types are supported.
+ * Currently supported argument types:
+ *  - pointer to an embedder type
+ *  - bool
+ *  - int32_t
+ *  - uint32_t
+ *  - int64_t
+ *  - uint64_t
+ * The 64-bit integer types currently have the IDL (unsigned) long long
+ * semantics: https://heycam.github.io/webidl/#abstract-opdef-converttoint
+ * In the future we'll extend the API to also provide conversions from/to
+ * BigInt to preserve full precision.
+ * To be supported types:
+ *  - float32_t
+ *  - float64_t
+ *  - arrays of C types
+ *  - arrays of embedder types
+ */
+
+#ifndef INCLUDE_V8_FAST_API_CALLS_H_
+#define INCLUDE_V8_FAST_API_CALLS_H_
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "v8config.h"  // NOLINT(build/include_directory)
+
+namespace v8 {
+
+class CTypeInfo {
+ public:
+  enum class Type : char {
+    kVoid,
+    kBool,
+    kInt32,
+    kUint32,
+    kInt64,
+    kUint64,
+    kFloat32,
+    kFloat64,
+    kV8Value,
+  };
+
+  enum class ArgFlags : uint8_t {
+    kNone = 0,
+    kIsArrayBit = 1 << 0,  // This argument is first in an array of values.
+  };
+
+  static CTypeInfo FromWrapperType(ArgFlags flags = ArgFlags::kNone) {
+    return CTypeInfo(static_cast<int>(flags) | kIsWrapperTypeBit);
+  }
+
+  static constexpr CTypeInfo FromCType(Type ctype,
+                                       ArgFlags flags = ArgFlags::kNone) {
+    // TODO(mslekova): Refactor the manual bit manipulations to use
+    // PointerWithPayload instead.
+    // ctype cannot be Type::kV8Value.
+    return CTypeInfo(
+        ((static_cast<uintptr_t>(ctype) << kTypeOffset) & kTypeMask) |
+        static_cast<int>(flags));
+  }
+
+  const void* GetWrapperInfo() const;
+
+  constexpr Type GetType() const {
+    if (payload_ & kIsWrapperTypeBit) {
+      return Type::kV8Value;
+    }
+    return static_cast<Type>((payload_ & kTypeMask) >> kTypeOffset);
+  }
+
+  constexpr bool IsArray() const {
+    return payload_ & static_cast<int>(ArgFlags::kIsArrayBit);
+  }
+
+  static const CTypeInfo& Invalid() {
+    static CTypeInfo invalid = CTypeInfo(0);
+    return invalid;
+  }
+
+ private:
+  explicit constexpr CTypeInfo(uintptr_t payload) : payload_(payload) {}
+
+  // That must be the last bit after ArgFlags.
+  static constexpr uintptr_t kIsWrapperTypeBit = 1 << 1;
+  static constexpr uintptr_t kWrapperTypeInfoMask = static_cast<uintptr_t>(~0)
+                                                    << 2;
+
+  static constexpr unsigned int kTypeOffset = kIsWrapperTypeBit;
+  static constexpr unsigned int kTypeSize = 8 - kTypeOffset;
+  static constexpr uintptr_t kTypeMask =
+      (~(static_cast<uintptr_t>(~0) << kTypeSize)) << kTypeOffset;
+
+  const uintptr_t payload_;
+};
+
+class CFunctionInfo {
+ public:
+  virtual const CTypeInfo& ReturnInfo() const = 0;
+  virtual unsigned int ArgumentCount() const = 0;
+  virtual const CTypeInfo& ArgumentInfo(unsigned int index) const = 0;
+};
+
+struct ApiObject {
+  uintptr_t address;
+};
+
+namespace internal {
+
+template <typename T>
+struct GetCType {
+  static constexpr CTypeInfo Get() {
+    return CTypeInfo::FromCType(CTypeInfo::Type::kV8Value);
+  }
+};
+
+#define SPECIALIZE_GET_C_TYPE_FOR(ctype, ctypeinfo)            \
+  template <>                                                  \
+  struct GetCType<ctype> {                                     \
+    static constexpr CTypeInfo Get() {                         \
+      return CTypeInfo::FromCType(CTypeInfo::Type::ctypeinfo); \
+    }                                                          \
+  };
+
+#define SUPPORTED_C_TYPES(V) \
+  V(void, kVoid)             \
+  V(bool, kBool)             \
+  V(int32_t, kInt32)         \
+  V(uint32_t, kUint32)       \
+  V(int64_t, kInt64)         \
+  V(uint64_t, kUint64)       \
+  V(float, kFloat32)         \
+  V(double, kFloat64)        \
+  V(ApiObject, kV8Value)
+
+SUPPORTED_C_TYPES(SPECIALIZE_GET_C_TYPE_FOR)
+
+// T* where T is a primitive (array of primitives).
+template <typename T, typename = void>
+struct GetCTypePointerImpl {
+  static constexpr CTypeInfo Get() {
+    return CTypeInfo::FromCType(GetCType<T>::Get().GetType(),
+                                CTypeInfo::ArgFlags::kIsArrayBit);
+  }
+};
+
+// T* where T is an API object.
+template <typename T>
+struct GetCTypePointerImpl<T, void> {
+  static constexpr CTypeInfo Get() { return CTypeInfo::FromWrapperType(); }
+};
+
+// T** where T is a primitive. Not allowed.
+template <typename T, typename = void>
+struct GetCTypePointerPointerImpl {
+  static_assert(sizeof(T**) != sizeof(T**), "Unsupported type");
+};
+
+// T** where T is an API object (array of API objects).
+template <typename T>
+struct GetCTypePointerPointerImpl<T, void> {
+  static constexpr CTypeInfo Get() {
+    return CTypeInfo::FromWrapperType(CTypeInfo::ArgFlags::kIsArrayBit);
+  }
+};
+
+template <typename T>
+struct GetCType<T**> : public GetCTypePointerPointerImpl<T> {};
+
+template <typename T>
+struct GetCType<T*> : public GetCTypePointerImpl<T> {};
+
+template <typename R, bool RaisesException, typename... Args>
+class CFunctionInfoImpl : public CFunctionInfo {
+ public:
+  static constexpr int kHasErrorArgCount = (RaisesException ? 1 : 0);
+  static constexpr int kReceiverCount = 1;
+  CFunctionInfoImpl()
+      : return_info_(internal::GetCType<R>::Get()),
+        arg_count_(sizeof...(Args) - kHasErrorArgCount),
+        arg_info_{internal::GetCType<Args>::Get()...} {
+    static_assert(sizeof...(Args) >= kHasErrorArgCount + kReceiverCount,
+                  "The receiver or the has_error argument is missing.");
+    static_assert(
+        internal::GetCType<R>::Get().GetType() == CTypeInfo::Type::kVoid,
+        "Only void return types are currently supported.");
+  }
+
+  const CTypeInfo& ReturnInfo() const override { return return_info_; }
+  unsigned int ArgumentCount() const override { return arg_count_; }
+  const CTypeInfo& ArgumentInfo(unsigned int index) const override {
+    if (index >= ArgumentCount()) {
+      return CTypeInfo::Invalid();
+    }
+    return arg_info_[index];
+  }
+
+ private:
+  const CTypeInfo return_info_;
+  const unsigned int arg_count_;
+  const CTypeInfo arg_info_[sizeof...(Args)];
+};
+
+}  // namespace internal
+
+class V8_EXPORT CFunction {
+ public:
+  constexpr CFunction() : address_(nullptr), type_info_(nullptr) {}
+
+  const CTypeInfo& ReturnInfo() const { return type_info_->ReturnInfo(); }
+
+  const CTypeInfo& ArgumentInfo(unsigned int index) const {
+    return type_info_->ArgumentInfo(index);
+  }
+
+  unsigned int ArgumentCount() const { return type_info_->ArgumentCount(); }
+
+  const void* GetAddress() const { return address_; }
+  const CFunctionInfo* GetTypeInfo() const { return type_info_; }
+
+  template <typename F>
+  static CFunction Make(F* func) {
+    return ArgUnwrap<F*>::Make(func);
+  }
+
+  template <typename F>
+  static CFunction MakeWithErrorSupport(F* func) {
+    return ArgUnwrap<F*>::MakeWithErrorSupport(func);
+  }
+
+  template <typename F>
+  static CFunction Make(F* func, const CFunctionInfo* type_info) {
+    return CFunction(reinterpret_cast<const void*>(func), type_info);
+  }
+
+ private:
+  const void* address_;
+  const CFunctionInfo* type_info_;
+
+  CFunction(const void* address, const CFunctionInfo* type_info);
+
+  template <typename R, bool RaisesException, typename... Args>
+  static CFunctionInfo* GetCFunctionInfo() {
+    static internal::CFunctionInfoImpl<R, RaisesException, Args...> instance;
+    return &instance;
+  }
+
+  template <typename F>
+  class ArgUnwrap {
+    static_assert(sizeof(F) != sizeof(F),
+                  "CFunction must be created from a function pointer.");
+  };
+
+  template <typename R, typename... Args>
+  class ArgUnwrap<R (*)(Args...)> {
+   public:
+    static CFunction Make(R (*func)(Args...)) {
+      return CFunction(reinterpret_cast<const void*>(func),
+                       GetCFunctionInfo<R, false, Args...>());
+    }
+    static CFunction MakeWithErrorSupport(R (*func)(Args...)) {
+      return CFunction(reinterpret_cast<const void*>(func),
+                       GetCFunctionInfo<R, true, Args...>());
+    }
+  };
+};
+
+}  // namespace v8
+
+#endif  // INCLUDE_V8_FAST_API_CALLS_H_

data/vendor/v8/include/v8-inspector-protocol.h

@@ -0,0 +1,13 @@
+// Copyright 2016 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_V8_INSPECTOR_PROTOCOL_H_
+#define V8_V8_INSPECTOR_PROTOCOL_H_
+
+#include "inspector/Debugger.h"  // NOLINT(build/include_directory)
+#include "inspector/Runtime.h"   // NOLINT(build/include_directory)
+#include "inspector/Schema.h"    // NOLINT(build/include_directory)
+#include "v8-inspector.h"        // NOLINT(build/include_directory)
+
+#endif  // V8_V8_INSPECTOR_PROTOCOL_H_