heap-state.h

Go to the documentation of this file.

// 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 {
 
class V8_EXPORT HeapState final {
 public:
  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);
 
  static bool IsInAtomicPause(const HeapHandle& heap_handle);
 
  static bool PreviousGCWasConservative(const HeapHandle& heap_handle);
 
 private:
  HeapState() = delete;
};
 
}  // namespace subtle
}  // namespace cppgc
 
#endif  // INCLUDE_CPPGC_HEAP_STATE_H_