REDROOM

Navigation

Breadcrumbs

Create

Preview: heap-state.h Size: 2.57 KB

//opt/cpanel/ea-nodejs20/include/node/cppgc/heap-state.h

// Copyright 2021 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_HEAP_STATE_H_
#define INCLUDE_CPPGC_HEAP_STATE_H_

#include "v8config.h"  // NOLINT(build/include_directory)

namespace cppgc {

class HeapHandle;

namespace subtle {

/**
 * Helpers to peek into heap-internal state.
 */
class V8_EXPORT HeapState final {
 public:
  /**
   * Returns whether the garbage collector is marking. This API is experimental
   * and is expected to be removed in future.
   *
   * \param heap_handle The corresponding heap.
   * \returns true if the garbage collector is currently marking, and false
   *   otherwise.
   */
  static bool IsMarking(const HeapHandle& heap_handle);

  /*
   * Returns whether the garbage collector is sweeping. This API is experimental
   * and is expected to be removed in future.
   *
   * \param heap_handle The corresponding heap.
   * \returns true if the garbage collector is currently sweeping, and false
   *   otherwise.
   */
  static bool IsSweeping(const HeapHandle& heap_handle);

  /*
   * Returns whether the garbage collector is currently sweeping on the thread
   * owning this heap. This API allows the caller to determine whether it has
   * been called from a destructor of a managed object. This API is experimental
   * and may be removed in future.
   *
   * \param heap_handle The corresponding heap.
   * \returns true if the garbage collector is currently sweeping on this
   *   thread, and false otherwise.
   */
  static bool IsSweepingOnOwningThread(const HeapHandle& heap_handle);

  /**
   * Returns whether the garbage collector is in the atomic pause, i.e., the
   * mutator is stopped from running. This API is experimental and is expected
   * to be removed in future.
   *
   * \param heap_handle The corresponding heap.
   * \returns true if the garbage collector is currently in the atomic pause,
   *   and false otherwise.
   */
  static bool IsInAtomicPause(const HeapHandle& heap_handle);

  /**
   * Returns whether the last garbage collection was finalized conservatively
   * (i.e., with a non-empty stack). This API is experimental and is expected to
   * be removed in future.
   *
   * \param heap_handle The corresponding heap.
   * \returns true if the last garbage collection was finalized conservatively,
   * and false otherwise.
   */
  static bool PreviousGCWasConservative(const HeapHandle& heap_handle);

 private:
  HeapState() = delete;
};

}  // namespace subtle
}  // namespace cppgc

#endif  // INCLUDE_CPPGC_HEAP_STATE_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