REDROOM

Navigation

Breadcrumbs

Create

Preview: testing.h Size: 2.96 KB

//opt/cpanel/ea-nodejs20/include/node/cppgc/testing.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_TESTING_H_
#define INCLUDE_CPPGC_TESTING_H_

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

namespace cppgc {

class HeapHandle;

/**
 * Namespace contains testing helpers.
 */
namespace testing {

/**
 * Overrides the state of the stack with the provided value. Parameters passed
 * to explicit garbage collection calls still take precedence. Must not be
 * nested.
 *
 * This scope is useful to make the garbage collector consider the stack when
 * tasks that invoke garbage collection (through the provided platform) contain
 * interesting pointers on its stack.
 */
class V8_EXPORT V8_NODISCARD OverrideEmbedderStackStateScope final {
  CPPGC_STACK_ALLOCATED();

 public:
  /**
   * Constructs a scoped object that automatically enters and leaves the scope.
   *
   * \param heap_handle The corresponding heap.
   */
  explicit OverrideEmbedderStackStateScope(HeapHandle& heap_handle,
                                           EmbedderStackState state);
  ~OverrideEmbedderStackStateScope();

  OverrideEmbedderStackStateScope(const OverrideEmbedderStackStateScope&) =
      delete;
  OverrideEmbedderStackStateScope& operator=(
      const OverrideEmbedderStackStateScope&) = delete;

 private:
  HeapHandle& heap_handle_;
};

/**
 * Testing interface for managed heaps that allows for controlling garbage
 * collection timings. Embedders should use this class when testing the
 * interaction of their code with incremental/concurrent garbage collection.
 */
class V8_EXPORT StandaloneTestingHeap final {
 public:
  explicit StandaloneTestingHeap(HeapHandle&);

  /**
   * Start an incremental garbage collection.
   */
  void StartGarbageCollection();

  /**
   * Perform an incremental step. This will also schedule concurrent steps if
   * needed.
   *
   * \param stack_state The state of the stack during the step.
   */
  bool PerformMarkingStep(EmbedderStackState stack_state);

  /**
   * Finalize the current garbage collection cycle atomically.
   * Assumes that garbage collection is in progress.
   *
   * \param stack_state The state of the stack for finalizing the garbage
   * collection cycle.
   */
  void FinalizeGarbageCollection(EmbedderStackState stack_state);

  /**
   * Toggle main thread marking on/off. Allows to stress concurrent marking
   * (e.g. to better detect data races).
   *
   * \param should_mark Denotes whether the main thread should contribute to
   * marking. Defaults to true.
   */
  void ToggleMainThreadMarking(bool should_mark);

  /**
   * Force enable compaction for the next garbage collection cycle.
   */
  void ForceCompactionForNextGarbageCollection();

 private:
  HeapHandle& heap_handle_;
};

V8_EXPORT bool IsHeapObjectOld(void*);

}  // namespace testing
}  // namespace cppgc

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