REDROOM

Navigation

Breadcrumbs

Create

Preview: liveness-broker.h Size: 2.34 KB

/opt/cpanel/ea-nodejs20/include/node/cppgc/liveness-broker.h

// 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 INCLUDE_CPPGC_LIVENESS_BROKER_H_
#define INCLUDE_CPPGC_LIVENESS_BROKER_H_

#include "cppgc/heap.h"
#include "cppgc/member.h"
#include "cppgc/sentinel-pointer.h"
#include "cppgc/trace-trait.h"
#include "v8config.h"  // NOLINT(build/include_directory)

namespace cppgc {

namespace internal {
class LivenessBrokerFactory;
}  // namespace internal

/**
 * The broker is passed to weak callbacks to allow (temporarily) querying
 * the liveness state of an object. References to non-live objects must be
 * cleared when `IsHeapObjectAlive()` returns false.
 *
 * \code
 * class GCedWithCustomWeakCallback final
 *   : public GarbageCollected<GCedWithCustomWeakCallback> {
 *  public:
 *   UntracedMember<Bar> bar;
 *
 *   void CustomWeakCallbackMethod(const LivenessBroker& broker) {
 *     if (!broker.IsHeapObjectAlive(bar))
 *       bar = nullptr;
 *   }
 *
 *   void Trace(cppgc::Visitor* visitor) const {
 *     visitor->RegisterWeakCallbackMethod<
 *         GCedWithCustomWeakCallback,
 *         &GCedWithCustomWeakCallback::CustomWeakCallbackMethod>(this);
 *   }
 * };
 * \endcode
 */
class V8_EXPORT LivenessBroker final {
 public:
  template <typename T>
  bool IsHeapObjectAlive(const T* object) const {
    // - nullptr objects are considered alive to allow weakness to be used from
    // stack while running into a conservative GC. Treating nullptr as dead
    // would mean that e.g. custom collections could not be strongified on
    // stack.
    // - Sentinel pointers are also preserved in weakness and not cleared.
    return !object || object == kSentinelPointer ||
           IsHeapObjectAliveImpl(
               TraceTrait<T>::GetTraceDescriptor(object).base_object_payload);
  }

  template <typename T>
  bool IsHeapObjectAlive(const WeakMember<T>& weak_member) const {
    return IsHeapObjectAlive<T>(weak_member.Get());
  }

  template <typename T>
  bool IsHeapObjectAlive(const UntracedMember<T>& untraced_member) const {
    return IsHeapObjectAlive<T>(untraced_member.Get());
  }

 private:
  LivenessBroker() = default;

  bool IsHeapObjectAliveImpl(const void*) const;

  friend class internal::LivenessBrokerFactory;
};

}  // namespace cppgc

#endif  // INCLUDE_CPPGC_LIVENESS_BROKER_H_

Name	Size	Perms	Modified	Actions
internal DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
allocation.h	11.61 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
common.h	643 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
cross-thread-persistent.h	14.81 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
custom-space.h	2.40 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
default-platform.h	2.18 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
ephemeron-pair.h	804 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
explicit-management.h	3.29 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
garbage-collected.h	3.11 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-consistency.h	11.74 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-handle.h	1.26 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-state.h	2.57 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-statistics.h	3.89 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap.h	5.70 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
liveness-broker.h	2.34 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
macros.h	1.31 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
member.h	22.75 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
name-provider.h	1.99 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
object-size-trait.h	1.60 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
persistent.h	13.50 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
platform.h	5.56 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
prefinalizer.h	2.88 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
process-heap-statistics.h	1009 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
sentinel-pointer.h	935 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
source-location.h	2.57 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
testing.h	2.96 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
trace-trait.h	3.14 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
type-traits.h	7.78 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
visitor.h	14.84 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive

Directory Contents