dart::Snapshot Class Reference

#include <snapshot.h>

Public Types
enum	Kind {   kFull , kFullCore , kFullJIT , kFullAOT ,   kNone , kInvalid }

Public Member Functions
bool	check_magic () const
void	set_magic ()
int64_t	large_length () const
intptr_t	length () const
void	set_length (intptr_t value)
Kind	kind () const
void	set_kind (Kind value)
const uint8_t *	Addr () const
const uint8_t *	DataImage () const

Static Public Member Functions
static const char *	KindToCString (Kind kind)
static const Snapshot *	SetupFromBuffer (const void *raw_memory)
static bool	IsFull (Kind kind)
static bool	IncludesCode (Kind kind)
static bool	IncludesStringsInROData (Kind kind)

Static Public Attributes
static constexpr int32_t	kMagicValue = 0xdcdcf5f5
static constexpr intptr_t	kMagicOffset = 0
static constexpr intptr_t	kMagicSize = sizeof(int32_t)
static constexpr intptr_t	kLengthOffset = kMagicOffset + kMagicSize
static constexpr intptr_t	kLengthSize = sizeof(int64_t)
static constexpr intptr_t	kKindOffset = kLengthOffset + kLengthSize
static constexpr intptr_t	kKindSize = sizeof(int64_t)
static constexpr intptr_t	kHeaderSize = kKindOffset + kKindSize

Detailed Description

Definition at line 22 of file snapshot.h.

Member Enumeration Documentation

Kind

enum dart::Snapshot::Kind

Enumerator
kFull
kFullCore
kFullJIT
kFullAOT
kNone
kInvalid

Definition at line 24 of file snapshot.h.

            {
    kFull,      // Full snapshot of an application.
    kFullCore,  // Full snapshot of core libraries.
    kFullJIT,   // Full + JIT code
    kFullAOT,   // Full + AOT code
    kNone,      // gen_snapshot
    kInvalid
  };

Member Function Documentation

Addr()

const uint8_t * dart::Snapshot::Addr ( ) const

inline

Definition at line 79 of file snapshot.h.

{ return reinterpret_cast<const uint8_t*>(this); }

check_magic()

bool dart::Snapshot::check_magic ( ) const

inline

Definition at line 46 of file snapshot.h.

                           {
    return Read<int32_t>(kMagicOffset) == kMagicValue;
  }

DataImage()

const uint8_t * dart::Snapshot::DataImage ( ) const

inline

Definition at line 81 of file snapshot.h.

                                   {
    if (!IncludesCode(kind())) {
      return nullptr;
    }
    uword offset = Utils::RoundUp(length(), kObjectStartAlignment);
    return Addr() + offset;
  }

IncludesCode()

static bool dart::Snapshot::IncludesCode ( Kind  kind )

inlinestatic

Definition at line 67 of file snapshot.h.

                                      {
    return (kind == kFullJIT) || (kind == kFullAOT);
  }

IncludesStringsInROData()

static bool dart::Snapshot::IncludesStringsInROData ( Kind  kind )

inlinestatic

Definition at line 71 of file snapshot.h.

                                                 {
#if !defined(DART_COMPRESSED_POINTERS)
    return IncludesCode(kind);
#else
    return false;
#endif
  }

IsFull()

static bool dart::Snapshot::IsFull ( Kind  kind )

inlinestatic

Definition at line 63 of file snapshot.h.

                                {
    return (kind == kFull) || (kind == kFullCore) || (kind == kFullJIT) ||
           (kind == kFullAOT);
  }

kind()

Kind dart::Snapshot::kind ( ) const

inline

Definition at line 60 of file snapshot.h.

{ return static_cast<Kind>(Read<int64_t>(kKindOffset)); }

KindToCString()

const char * dart::Snapshot::KindToCString ( Kind  kind )

static

Definition at line 12 of file snapshot.cc.

                                             {
  switch (kind) {
    case kFull:
      return "full";
    case kFullCore:
      return "full-core";
    case kFullJIT:
      return "full-jit";
    case kFullAOT:
      return "full-aot";
    case kNone:
      return "none";
    case kInvalid:
    default:
      return "invalid";
  }
}

large_length()

int64_t dart::Snapshot::large_length ( ) const

inline

Definition at line 53 of file snapshot.h.

                               {
    return Read<int64_t>(kLengthOffset) + kMagicSize;
  }

length()

intptr_t dart::Snapshot::length ( ) const

inline

Definition at line 56 of file snapshot.h.

{ return static_cast<intptr_t>(large_length()); }

set_kind()

void dart::Snapshot::set_kind ( Kind  value )

inline

Definition at line 61 of file snapshot.h.

{ return Write<int64_t>(kKindOffset, value); }

set_length()

void dart::Snapshot::set_length ( intptr_t  value )

inline

Definition at line 57 of file snapshot.h.

                                  {
    return Write<int64_t>(kLengthOffset, value - kMagicSize);
  }

set_magic()

void dart::Snapshot::set_magic ( )

inline

Definition at line 49 of file snapshot.h.

{ return Write<int32_t>(kMagicOffset, kMagicValue); }

SetupFromBuffer()

const Snapshot * dart::Snapshot::SetupFromBuffer ( const void *  raw_memory )

static

Definition at line 30 of file snapshot.cc.

                                                                {
  ASSERT(raw_memory != nullptr);
  const Snapshot* snapshot = reinterpret_cast<const Snapshot*>(raw_memory);
  if (!snapshot->check_magic()) {
    return nullptr;
  }
  // If the raw length is negative or greater than what the local machine can
  // handle, then signal an error.
  int64_t length = snapshot->large_length();
  if ((length < 0) || (length > kIntptrMax)) {
    return nullptr;
  }
  return snapshot;
}

Member Data Documentation

kHeaderSize

constexpr intptr_t dart::Snapshot::kHeaderSize = kKindOffset + kKindSize

staticconstexpr

Definition at line 43 of file snapshot.h.

kKindOffset

constexpr intptr_t dart::Snapshot::kKindOffset = kLengthOffset + kLengthSize

staticconstexpr

Definition at line 41 of file snapshot.h.

kKindSize

constexpr intptr_t dart::Snapshot::kKindSize = sizeof(int64_t)

staticconstexpr

Definition at line 42 of file snapshot.h.

kLengthOffset

constexpr intptr_t dart::Snapshot::kLengthOffset = kMagicOffset + kMagicSize

staticconstexpr

Definition at line 39 of file snapshot.h.

kLengthSize

constexpr intptr_t dart::Snapshot::kLengthSize = sizeof(int64_t)

staticconstexpr

Definition at line 40 of file snapshot.h.

kMagicOffset

constexpr intptr_t dart::Snapshot::kMagicOffset = 0

staticconstexpr

Definition at line 37 of file snapshot.h.

kMagicSize

constexpr intptr_t dart::Snapshot::kMagicSize = sizeof(int32_t)

staticconstexpr

Definition at line 38 of file snapshot.h.

kMagicValue

constexpr int32_t dart::Snapshot::kMagicValue = 0xdcdcf5f5

staticconstexpr

Definition at line 36 of file snapshot.h.

---

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

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