embedder-data-slot.h 3.28 KB
Newer Older
1 2 3 4 5 6 7 8 9
// Copyright 2018 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 V8_OBJECTS_EMBEDDER_DATA_SLOT_H_
#define V8_OBJECTS_EMBEDDER_DATA_SLOT_H_

#include <utility>

10 11
#include "src/common/assert-scope.h"
#include "src/common/globals.h"
12
#include "src/objects/slots.h"
13 14 15 16 17 18 19 20

// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"

namespace v8 {
namespace internal {

class EmbedderDataArray;
21 22
class JSObject;
class Object;
23 24 25 26 27 28 29 30 31 32

// An EmbedderDataSlot instance describes a kEmbedderDataSlotSize field ("slot")
// holding an embedder data which may contain raw aligned pointer or a tagged
// pointer (smi or heap object).
// Its address() is the address of the slot.
// The slot's contents can be read and written using respective load_XX() and
// store_XX() methods.
// Storing heap object through this slot may require triggering write barriers
// so this operation must be done via static store_tagged() methods.
class EmbedderDataSlot
33
    : public SlotBase<EmbedderDataSlot, Address, kTaggedSize> {
34 35 36
 public:
  EmbedderDataSlot() : SlotBase(kNullAddress) {}
  V8_INLINE EmbedderDataSlot(EmbedderDataArray array, int entry_index);
37
  V8_INLINE EmbedderDataSlot(JSObject object, int embedder_field_index);
38

39
#if defined(V8_TARGET_BIG_ENDIAN) && defined(V8_COMPRESS_POINTERS)
40
  static constexpr int kTaggedPayloadOffset = kTaggedSize;
41 42
#else
  static constexpr int kTaggedPayloadOffset = 0;
43 44
#endif

45
#ifdef V8_COMPRESS_POINTERS
46 47
  // The raw payload is located in the other tagged part of the full pointer.
  static constexpr int kRawPayloadOffset = kTaggedSize - kTaggedPayloadOffset;
48 49 50 51
#endif
  static constexpr int kRequiredPtrAlignment = kSmiTagSize;

  // Opaque type used for storing raw embedder data.
52
  using RawData = Address;
53

54
  V8_INLINE Object load_tagged() const;
55 56 57 58
  V8_INLINE void store_smi(Smi value);

  // Setting an arbitrary tagged value requires triggering a write barrier
  // which requires separate object and offset values, therefore these static
59
  // functions also has the target object parameter.
60
  static V8_INLINE void store_tagged(EmbedderDataArray array, int entry_index,
61
                                     Object value);
62
  static V8_INLINE void store_tagged(JSObject object, int embedder_field_index,
63
                                     Object value);
64

65 66 67 68
  // Tries reinterpret the value as an aligned pointer and sets *out_result to
  // the pointer-like value. Note, that some Smis could still look like an
  // aligned pointers.
  // Returns true on success.
69 70 71 72 73 74 75
  V8_INLINE bool ToAlignedPointer(void** out_result) const;

  // Returns true if the pointer was successfully stored or false it the pointer
  // was improperly aligned.
  V8_INLINE V8_WARN_UNUSED_RESULT bool store_aligned_pointer(void* ptr);

  V8_INLINE RawData load_raw(const DisallowHeapAllocation& no_gc) const;
76 77 78 79 80 81
  V8_INLINE void store_raw(RawData data, const DisallowHeapAllocation& no_gc);

 private:
  // Stores given value to the embedder data slot in a concurrent-marker
  // friendly manner (tagged part of the slot is written atomically).
  V8_INLINE void gc_safe_store(Address value);
82 83 84 85 86 87 88 89
};

}  // namespace internal
}  // namespace v8

#include "src/objects/object-macros-undef.h"

#endif  // V8_OBJECTS_EMBEDDER_DATA_SLOT_H_