custom-space.h 2.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// 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_CUSTOM_SPACE_H_
#define INCLUDE_CPPGC_CUSTOM_SPACE_H_

#include <stddef.h>

namespace cppgc {

12 13 14
/**
 * Index identifying a custom space.
 */
15
struct CustomSpaceIndex {
16
  constexpr CustomSpaceIndex(size_t value) : value(value) {}  // NOLINT
17 18
  size_t value;
};
19 20 21 22 23 24 25 26 27

/**
 * Top-level base class for custom spaces. Users must inherit from CustomSpace
 * below.
 */
class CustomSpaceBase {
 public:
  virtual ~CustomSpaceBase() = default;
  virtual CustomSpaceIndex GetCustomSpaceIndex() const = 0;
28
  virtual bool IsCompactable() const = 0;
29 30 31 32
};

/**
 * Base class custom spaces should directly inherit from. The class inheriting
33
 * from `CustomSpace` must define `kSpaceIndex` as unique space index. These
34 35 36 37 38 39 40 41 42 43
 * indices need for form a sequence starting at 0.
 *
 * Example:
 * \code
 * class CustomSpace1 : public CustomSpace<CustomSpace1> {
 *  public:
 *   static constexpr CustomSpaceIndex kSpaceIndex = 0;
 * };
 * class CustomSpace2 : public CustomSpace<CustomSpace2> {
 *  public:
44
 *   static constexpr CustomSpaceIndex kSpaceIndex = 1;
45 46 47 48 49 50
 * };
 * \endcode
 */
template <typename ConcreteCustomSpace>
class CustomSpace : public CustomSpaceBase {
 public:
51 52 53 54 55 56
  /**
   * Compaction is only supported on spaces that manually manage slots
   * recording.
   */
  static constexpr bool kSupportsCompaction = false;

57 58 59
  CustomSpaceIndex GetCustomSpaceIndex() const final {
    return ConcreteCustomSpace::kSpaceIndex;
  }
60 61 62
  bool IsCompactable() const final {
    return ConcreteCustomSpace::kSupportsCompaction;
  }
63 64 65 66 67 68 69 70 71 72
};

/**
 * User-overridable trait that allows pinning types to custom spaces.
 */
template <typename T, typename = void>
struct SpaceTrait {
  using Space = void;
};

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
namespace internal {

template <typename CustomSpace>
struct IsAllocatedOnCompactableSpaceImpl {
  static constexpr bool value = CustomSpace::kSupportsCompaction;
};

template <>
struct IsAllocatedOnCompactableSpaceImpl<void> {
  // Non-custom spaces are by default not compactable.
  static constexpr bool value = false;
};

template <typename T>
struct IsAllocatedOnCompactableSpace {
 public:
  static constexpr bool value =
      IsAllocatedOnCompactableSpaceImpl<typename SpaceTrait<T>::Space>::value;
};

}  // namespace internal

95 96 97
}  // namespace cppgc

#endif  // INCLUDE_CPPGC_CUSTOM_SPACE_H_