dart::FfiCallbackMetadata Class Reference

#include <ffi_callback_metadata.h>

Classes
class	Metadata

Public Types
enum class	TrampolineType : uint8_t { kSync = 0 , kSyncStackDelta4 = 1 , kAsync = 2 }
enum	RuntimeFunctions { kGetFfiCallbackMetadata , kExitTemporaryIsolate , kNumRuntimeFunctions }
using	Trampoline = uword

Public Member Functions
Trampoline	CreateAsyncFfiCallback (Isolate *isolate, Zone *zone, const Function &function, Dart_Port send_port, Metadata **list_head)
Trampoline	CreateIsolateLocalFfiCallback (Isolate *isolate, Zone *zone, const Function &function, const Closure &closure, Metadata **list_head)
void	DeleteCallback (Trampoline trampoline, Metadata **list_head)
void	DeleteAllCallbacks (Metadata **list_head)
Metadata	LookupMetadataForTrampoline (Trampoline trampoline) const
Mutex *	lock ()
Metadata *	MetadataOfTrampoline (Trampoline trampoline) const
Trampoline	TrampolineOfMetadata (Metadata *metadata) const

Static Public Member Functions
static void	Init ()
static void	Cleanup ()
static FfiCallbackMetadata *	Instance ()
static constexpr intptr_t	NumCallbackTrampolinesPerPage ()
static constexpr intptr_t	RXMappingSize ()
static constexpr intptr_t	RWMappingSize ()
static constexpr intptr_t	MappingSize ()
static constexpr intptr_t	MappingAlignment ()
static constexpr intptr_t	MappingStart (uword address)
static constexpr uword	RuntimeFunctionOffset (uword function_index)
static constexpr intptr_t	MetadataOffset ()

Static Public Attributes
static constexpr intptr_t	kPageSize = 4 * KB
static constexpr intptr_t	kPageMask = ~(kPageSize - 1)

Detailed Description

Definition at line 33 of file ffi_callback_metadata.h.

Member Typedef Documentation

Trampoline

using dart::FfiCallbackMetadata::Trampoline = uword

Definition at line 38 of file ffi_callback_metadata.h.

Member Enumeration Documentation

RuntimeFunctions

enum dart::FfiCallbackMetadata::RuntimeFunctions

Enumerator
kGetFfiCallbackMetadata
kExitTemporaryIsolate
kNumRuntimeFunctions

Definition at line 46 of file ffi_callback_metadata.h.

                        {
    kGetFfiCallbackMetadata,
    kExitTemporaryIsolate,
    kNumRuntimeFunctions,
  };

TrampolineType

enum class dart::FfiCallbackMetadata::TrampolineType : uint8_t

strong

Enumerator
kSync
kSyncStackDelta4
kAsync

Definition at line 40 of file ffi_callback_metadata.h.

                            : uint8_t {
    kSync = 0,
    kSyncStackDelta4 = 1,  // Only used by TARGET_ARCH_IA32
    kAsync = 2,
  };

Member Function Documentation

Cleanup()

void dart::FfiCallbackMetadata::Cleanup ( )

static

Definition at line 75 of file ffi_callback_metadata.cc.

                                  {
  ASSERT(singleton_ != nullptr);
  delete singleton_;
  singleton_ = nullptr;
}

CreateAsyncFfiCallback()

FfiCallbackMetadata::Trampoline dart::FfiCallbackMetadata::CreateAsyncFfiCallback	(	Isolate *	isolate,
		Zone *	zone,
		const Function &	function,
		Dart_Port	send_port,
		Metadata **	list_head
	)

Definition at line 316 of file ffi_callback_metadata.cc.

                          {
  ASSERT(send_function.GetFfiCallbackKind() == FfiCallbackKind::kAsyncCallback);
  return CreateMetadataEntry(isolate, TrampolineType::kAsync,
                             GetEntryPoint(zone, send_function),
                             static_cast<uint64_t>(send_port), list_head);
}

CreateIsolateLocalFfiCallback()

FfiCallbackMetadata::Trampoline dart::FfiCallbackMetadata::CreateIsolateLocalFfiCallback	(	Isolate *	isolate,
		Zone *	zone,
		const Function &	function,
		const Closure &	closure,
		Metadata **	list_head
	)

Definition at line 270 of file ffi_callback_metadata.cc.

                                                                         {
  if (closure.IsNull()) {
    // If the closure is null, it means the target is a static function, so is
    // baked into the trampoline and is an ordinary sync callback.
    ASSERT(function.GetFfiCallbackKind() ==
           FfiCallbackKind::kIsolateLocalStaticCallback);
    return CreateSyncFfiCallbackImpl(isolate, zone, function, nullptr,
                                     list_head);
  } else {
    ASSERT(function.GetFfiCallbackKind() ==
           FfiCallbackKind::kIsolateLocalClosureCallback);
    return CreateSyncFfiCallbackImpl(isolate, zone, function,
                                     CreatePersistentHandle(isolate, closure),
                                     list_head);
  }
}

DeleteAllCallbacks()

void dart::FfiCallbackMetadata::DeleteAllCallbacks

(

Metadata **

list_head

)

Definition at line 222 of file ffi_callback_metadata.cc.

                                                                 {
  MutexLocker locker(&lock_);
  for (Metadata* entry = *list_head; entry != nullptr;) {
    Metadata* next = entry->list_next();
    DeleteCallbackLocked(entry);
    entry = next;
  }
  *list_head = nullptr;
}

DeleteCallback()

void dart::FfiCallbackMetadata::DeleteCallback	(	Trampoline	trampoline,
		Metadata **	list_head
	)

Definition at line 232 of file ffi_callback_metadata.cc.

                                                               {
  MutexLocker locker(&lock_);
  auto* entry = MetadataOfTrampoline(trampoline);
  ASSERT(entry->IsLive());
  auto* prev = entry->list_prev_;
  auto* next = entry->list_next_;
  if (prev != nullptr) {
    prev->list_next_ = next;
  } else {
    ASSERT(*list_head == entry);
    *list_head = next;
  }
  if (next != nullptr) {
    next->list_prev_ = prev;
  }
  DeleteCallbackLocked(entry);
}

Init()

void dart::FfiCallbackMetadata::Init ( )

static

Definition at line 70 of file ffi_callback_metadata.cc.

                               {
  ASSERT(singleton_ == nullptr);
  singleton_ = new FfiCallbackMetadata();
}

Instance()

FfiCallbackMetadata * dart::FfiCallbackMetadata::Instance ( )

static

Definition at line 81 of file ffi_callback_metadata.cc.

                                                   {
  ASSERT(singleton_ != nullptr);
  return singleton_;
}

lock()

Mutex * dart::FfiCallbackMetadata::lock ( )

inline

Definition at line 190 of file ffi_callback_metadata.h.

{ return &lock_; }

LookupMetadataForTrampoline()

FfiCallbackMetadata::Metadata dart::FfiCallbackMetadata::LookupMetadataForTrampoline

(

Trampoline

trampoline

)

const

Definition at line 367 of file ffi_callback_metadata.cc.

                                 {
  return *MetadataOfTrampoline(trampoline);
}

MappingAlignment()

static constexpr intptr_t dart::FfiCallbackMetadata::MappingAlignment ( )

inlinestaticconstexpr

Definition at line 235 of file ffi_callback_metadata.h.

                                               {
    return Utils::RoundUpToPowerOfTwo(MappingSize());
  }

MappingSize()

static constexpr intptr_t dart::FfiCallbackMetadata::MappingSize ( )

inlinestaticconstexpr

Definition at line 232 of file ffi_callback_metadata.h.

                                          {
    return RXMappingSize() + RWMappingSize();
  }

MappingStart()

static constexpr intptr_t dart::FfiCallbackMetadata::MappingStart ( uword  address )

inlinestaticconstexpr

Definition at line 238 of file ffi_callback_metadata.h.

                                                        {
    const uword mask = MappingAlignment() - 1;
    return address & ~mask;
  }

MetadataOffset()

static constexpr intptr_t dart::FfiCallbackMetadata::MetadataOffset ( )

inlinestaticconstexpr

Definition at line 245 of file ffi_callback_metadata.h.

                                             {
    return RuntimeFunctionOffset(kNumRuntimeFunctions);
  }

MetadataOfTrampoline()

FfiCallbackMetadata::Metadata * dart::FfiCallbackMetadata::MetadataOfTrampoline

(

Trampoline

trampoline

)

const

Definition at line 342 of file ffi_callback_metadata.cc.

                                 {
#if defined(DART_TARGET_OS_FUCHSIA)
  // On Fuchsia the metadata page is separate to the trampoline page.
  // TODO(https://dartbug.com/52579): Remove.
  const uword page_start =
      Utils::RoundDown(trampoline - offset_of_first_trampoline_in_page_,
                       VirtualMemory::PageSize());
  const uword index =
      (trampoline - offset_of_first_trampoline_in_page_ - page_start) /
      kNativeCallbackTrampolineSize;
  ASSERT(index < NumCallbackTrampolinesPerPage());
  Metadata* metadata_table = reinterpret_cast<Metadata*>(
      fuchsia_metadata_page_->start() + MetadataOffset());
  return metadata_table + index;
#else
  const uword start = MappingStart(trampoline);
  Metadata* metadatas = reinterpret_cast<Metadata*>(start + MetadataOffset());
  const uword index =
      (trampoline - start - offset_of_first_trampoline_in_page_) /
      kNativeCallbackTrampolineSize;
  return &metadatas[index];
#endif
}

NumCallbackTrampolinesPerPage()

static constexpr intptr_t dart::FfiCallbackMetadata::NumCallbackTrampolinesPerPage ( )

inlinestaticconstexpr

Definition at line 193 of file ffi_callback_metadata.h.

                                                            {
    return (kPageSize - kNativeCallbackSharedStubSize) /
           kNativeCallbackTrampolineSize;
  }

RuntimeFunctionOffset()

static constexpr uword dart::FfiCallbackMetadata::RuntimeFunctionOffset ( uword  function_index )

inlinestaticconstexpr

Definition at line 242 of file ffi_callback_metadata.h.

                                                                     {
    return RXMappingSize() + function_index * compiler::target::kWordSize;
  }

RWMappingSize()

static constexpr intptr_t dart::FfiCallbackMetadata::RWMappingSize ( )

inlinestaticconstexpr

Definition at line 226 of file ffi_callback_metadata.h.

                                            {
    return Utils::RoundUp(
        kNumRuntimeFunctions * compiler::target::kWordSize +
            sizeof(Metadata) * NumCallbackTrampolinesPerPage(),
        kPageSize);
  }

RXMappingSize()

static constexpr intptr_t dart::FfiCallbackMetadata::RXMappingSize ( )

inlinestaticconstexpr

Definition at line 225 of file ffi_callback_metadata.h.

{ return 2 * kPageSize; }

TrampolineOfMetadata()

FfiCallbackMetadata::Trampoline dart::FfiCallbackMetadata::TrampolineOfMetadata

(

Metadata *

metadata

)

const

Definition at line 328 of file ffi_callback_metadata.cc.

                              {
  const uword start = MappingStart(reinterpret_cast<uword>(metadata));
  Metadata* metadatas = reinterpret_cast<Metadata*>(start + MetadataOffset());
  const uword index = metadata - metadatas;
#if defined(DART_TARGET_OS_FUCHSIA)
  return StubCode::FfiCallbackTrampoline().EntryPoint() +
         index * kNativeCallbackTrampolineSize;
#else
  return start + offset_of_first_trampoline_in_page_ +
         index * kNativeCallbackTrampolineSize;
#endif
}

Member Data Documentation

kPageMask

constexpr intptr_t dart::FfiCallbackMetadata::kPageMask = ~(kPageSize - 1)

staticconstexpr

Definition at line 216 of file ffi_callback_metadata.h.

kPageSize

constexpr intptr_t dart::FfiCallbackMetadata::kPageSize = 4 * KB

staticconstexpr

Definition at line 214 of file ffi_callback_metadata.h.

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/vm/ffi_callback_metadata.h
• third_party/dart-lang/sdk/runtime/vm/ffi_callback_metadata.cc