explicit-management.h 2.44 KB
Newer Older
1 2 3 4 5 6 7 8 9
// 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_EXPLICIT_MANAGEMENT_H_
#define INCLUDE_CPPGC_EXPLICIT_MANAGEMENT_H_

#include <cstddef>

10
#include "cppgc/allocation.h"
11 12 13 14 15 16 17
#include "cppgc/internal/logging.h"
#include "cppgc/type-traits.h"

namespace cppgc {
namespace internal {

V8_EXPORT void FreeUnreferencedObject(void*);
18
V8_EXPORT bool Resize(void*, size_t);
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

}  // namespace internal

namespace subtle {

/**
 * Informs the garbage collector that `object` can be immediately reclaimed. The
 * destructor may not be invoked immediately but only on next garbage
 * collection.
 *
 * It is up to the embedder to guarantee that no other object holds a reference
 * to `object` after calling `FreeUnreferencedObject()`. In case such a
 * reference exists, it's use results in a use-after-free.
 *
 * \param object Reference to an object that is of type `GarbageCollected` and
 *   should be immediately reclaimed.
 */
template <typename T>
void FreeUnreferencedObject(T* object) {
  static_assert(IsGarbageCollectedTypeV<T>,
                "Object must be of type GarbageCollected.");
  if (!object) return;
  internal::FreeUnreferencedObject(object);
}

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
/**
 * Tries to resize `object` of type `T` with additional bytes on top of
 * sizeof(T). Resizing is only useful with trailing inlined storage, see e.g.
 * `MakeGarbageCollected(AllocationHandle&, AdditionalBytes)`.
 *
 * `Resize()` performs growing or shrinking as needed and may skip the operation
 * for internal reasons, see return value.
 *
 * It is up to the embedder to guarantee that in case of shrinking a larger
 * object down, the reclaimed area is not used anymore. Any subsequent use
 * results in a use-after-free.
 *
 * \param object Reference to an object that is of type `GarbageCollected` and
 *   should be resized.
 * \param additional_bytes Bytes in addition to sizeof(T) that the object should
 *   provide.
 * \returns true when the operation was successful and the result can be relied
 *   on, and false otherwise.
 */
template <typename T>
64
bool Resize(T& object, AdditionalBytes additional_bytes) {
65 66
  static_assert(IsGarbageCollectedTypeV<T>,
                "Object must be of type GarbageCollected.");
67
  return internal::Resize(&object, sizeof(T) + additional_bytes.value);
68 69
}

70 71 72 73
}  // namespace subtle
}  // namespace cppgc

#endif  // INCLUDE_CPPGC_EXPLICIT_MANAGEMENT_H_