// Copyright 2016 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_PLATFORM_BINDINGS_TRACE_WRAPPER_V8_REFERENCE_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_BINDINGS_TRACE_WRAPPER_V8_REFERENCE_H_

#include <utility>

#include "base/compiler_specific.h"
#include "base/macros.h"
#include "third_party/blink/renderer/platform/heap/unified_heap_marking_visitor.h"
#include "third_party/blink/renderer/platform/heap/visitor.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/buildflags.h"
#include "third_party/blink/renderer/platform/wtf/hash_traits.h"
#include "third_party/blink/renderer/platform/wtf/vector_traits.h"
#include "v8/include/v8-cppgc.h"
#include "v8/include/v8.h"

#if BUILDFLAG(USE_V8_OILPAN)
#include "v8/include/cppgc/trace-trait.h"
#endif  // USE_V8_OILPAN

namespace blink {

template <typename T>
struct TraceTrait;

/**
 * TraceWrapperV8Reference is used to hold references from Blink to V8 that are
 * known to both garbage collectors. The reference is a regular traced reference
 * for unified heap garbage collections.
 */
template <typename T>
class TraceWrapperV8Reference {
 public:
  TraceWrapperV8Reference() = default;

  TraceWrapperV8Reference(v8::Isolate* isolate, v8::Local<T> handle) {
    InternalSet(isolate, handle);
  }

  bool operator==(const TraceWrapperV8Reference& other) const {
    return handle_ == other.handle_;
  }

  void Set(v8::Isolate* isolate, v8::Local<T> handle) {
    InternalSet(isolate, handle);
  }

  ALWAYS_INLINE v8::Local<T> NewLocal(v8::Isolate* isolate) const {
    return handle_.Get(isolate);
  }

  bool IsEmpty() const { return handle_.IsEmpty(); }
  bool IsEmptySafe() const { return handle_.IsEmptyThreadSafe(); }
  void Clear() { handle_.Reset(); }
  ALWAYS_INLINE const v8::TracedReference<T>& Get() const { return handle_; }
  ALWAYS_INLINE v8::TracedReference<T>& Get() { return handle_; }

  template <typename S>
  const TraceWrapperV8Reference<S>& Cast() const {
    static_assert(std::is_base_of<S, T>::value, "T must inherit from S");
    return reinterpret_cast<const TraceWrapperV8Reference<S>&>(
        const_cast<const TraceWrapperV8Reference<T>&>(*this));
  }

  template <typename S>
  const TraceWrapperV8Reference<S>& UnsafeCast() const {
    return reinterpret_cast<const TraceWrapperV8Reference<S>&>(
        const_cast<const TraceWrapperV8Reference<T>&>(*this));
  }

  // Move support.
  TraceWrapperV8Reference(TraceWrapperV8Reference&& other) noexcept {
    *this = std::move(other);
  }

  template <class S>
  TraceWrapperV8Reference(  // NOLINT
      TraceWrapperV8Reference<S>&& other) noexcept {
    *this = std::move(other);
  }

  TraceWrapperV8Reference& operator=(TraceWrapperV8Reference&& rhs) {
    handle_ = std::move(rhs.handle_);
    WriteBarrier();
    return *this;
  }

  template <class S>
  TraceWrapperV8Reference& operator=(TraceWrapperV8Reference<S>&& rhs) {
    handle_ = std::move(rhs.handle_);
    WriteBarrier();
    return *this;
  }

  // Copy support.
  TraceWrapperV8Reference(const TraceWrapperV8Reference& other) noexcept {
    *this = other;
  }

  template <class S>
  TraceWrapperV8Reference(const TraceWrapperV8Reference<S>& other) noexcept {
    *this = other;
  }

  TraceWrapperV8Reference& operator=(const TraceWrapperV8Reference& rhs) {
    DCHECK_EQ(0, rhs.handle_.WrapperClassId());
    handle_ = rhs.handle_;
    WriteBarrier();
    return *this;
  }

  template <class S>
  TraceWrapperV8Reference& operator=(const TraceWrapperV8Reference<S>& rhs) {
    DCHECK_EQ(0, rhs.handle_.WrapperClassId());
    handle_ = rhs.handle_;
    WriteBarrier();
    return *this;
  }

 protected:
  ALWAYS_INLINE void InternalSet(v8::Isolate* isolate, v8::Local<T> handle) {
    handle_.Reset(isolate, handle);
#if BUILDFLAG(USE_V8_OILPAN)
    UnifiedHeapMarkingVisitor::WriteBarrier(UnsafeCast<v8::Value>().Get());
#else   // !USE_V8_OILPAN
    UnifiedHeapMarkingVisitor::WriteBarrier(UnsafeCast<v8::Value>());
#endif  // !USE_V8_OILPAN
  }

  ALWAYS_INLINE void WriteBarrier() const {
#if BUILDFLAG(USE_V8_OILPAN)
    UnifiedHeapMarkingVisitor::WriteBarrier(UnsafeCast<v8::Value>().Get());
#else   // !USE_V8_OILPAN
    UnifiedHeapMarkingVisitor::WriteBarrier(UnsafeCast<v8::Value>());
#endif  // !USE_V8_OILPAN
  }

  v8::TracedReference<T> handle_;

  friend struct cppgc::TraceTrait<TraceWrapperV8Reference<T>>;
};
}  // namespace blink

#if BUILDFLAG(USE_V8_OILPAN)

namespace cppgc {
template <typename T>
struct TraceTrait<blink::TraceWrapperV8Reference<T>> {
  STATIC_ONLY(TraceTrait);

  static cppgc::TraceDescriptor GetTraceDescriptor(
      const blink::TraceWrapperV8Reference<T>* ref) {
    return {nullptr, Trace};
  }

  static void Trace(Visitor* visitor, const void* self) {
    visitor->Trace(
        static_cast<const blink::TraceWrapperV8Reference<T>*>(self)->handle_);
  }
};
}  // namespace cppgc

#else  // !USE_V8_OILPAN

namespace blink {
template <typename T>
struct TraceTrait<TraceWrapperV8Reference<T>> {
  STATIC_ONLY(TraceTrait);

  static TraceDescriptor GetTraceDescriptor(
      const TraceWrapperV8Reference<T>* ref) {
    return {ref, TraceTrait<TraceWrapperV8Reference<T>>::Trace};
  }

  static void Trace(Visitor* visitor, const void* ref) {
    visitor->Trace(*static_cast<const TraceWrapperV8Reference<T>*>(ref));
  }
};
}  // namespace blink

#endif  // !USE_V8_OILPAN

namespace WTF {

template <typename T>
struct IsTraceable<blink::TraceWrapperV8Reference<T>> {
  STATIC_ONLY(IsTraceable);
  static const bool value = true;
};

template <typename T>
struct VectorTraits<blink::TraceWrapperV8Reference<T>>
    : VectorTraitsBase<blink::TraceWrapperV8Reference<T>> {
  STATIC_ONLY(VectorTraits);
  static const bool kNeedsDestruction = false;
  static const bool kCanInitializeWithMemset = true;
  static const bool kCanClearUnusedSlotsWithMemset = true;
  static const bool kCanCopyWithMemcpy = false;
  static const bool kCanMoveWithMemcpy = false;
  static constexpr bool kCanTraceConcurrently = true;
};

template <typename T>
struct HashTraits<blink::TraceWrapperV8Reference<T>>
    : GenericHashTraits<blink::TraceWrapperV8Reference<T>> {
  STATIC_ONLY(HashTraits);
  static constexpr bool kCanTraceConcurrently = true;
};

}  // namespace WTF

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_BINDINGS_TRACE_WRAPPER_V8_REFERENCE_H_