sdk/runtime/vm/object_store.h

// Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

#ifndef VM_OBJECT_STORE_H_
#define VM_OBJECT_STORE_H_

#include "vm/object.h"

namespace dart {

// Forward declarations.
class Isolate;
class ObjectPointerVisitor;

// The object store is a per isolate instance which stores references to
// objects used by the VM.
// TODO(iposva): Move the actual store into the object heap for quick handling
// by snapshots eventually.
class ObjectStore {
 public:
  // Index for objects/types/classes stored in the object store,
  // this index is used in snapshots to refer to classes or objects directly.
  enum {
    kTrueValue = Object::kMaxId,
    kFalseValue,
    kObjectType,
    kNullType,
    kDynamicType,
    kVoidType,
    kFunctionInterface,
    kNumberInterface,
    kDoubleInterface,
    kIntInterface,
    kBoolInterface,
    kStringInterface,
    kListInterface,
    kByteArrayInterface,
    kObjectClass,
    kSmiClass,
    kMintClass,
    kBigintClass,
    kDoubleClass,
    kOneByteStringClass,
    kTwoByteStringClass,
    kFourByteStringClass,
    kExternalOneByteStringClass,
    kExternalTwoByteStringClass,
    kExternalFourByteStringClass,
    kBoolClass,
    kArrayClass,
    kImmutableArrayClass,
    kGrowableObjectArrayClass,
    kInternalByteArrayClass,
    kExternalByteArrayClass,
    kStacktraceClass,
    kJSRegExpClass,
    kMaxId,
    kInvalidIndex = -1,
  };

  ~ObjectStore();

  RawClass* object_class() const { return object_class_; }
  void set_object_class(const Class& value) { object_class_ = value.raw(); }
  static intptr_t object_class_offset() {
    return OFFSET_OF(ObjectStore, object_class_);
  }

  RawType* object_type() const { return object_type_; }
  void set_object_type(const Type& value) {
    object_type_ = value.raw();
  }

  RawType* null_type() const { return null_type_; }
  void set_null_type(const Type& value) {
    null_type_ = value.raw();
  }

  RawType* dynamic_type() const { return dynamic_type_; }
  void set_dynamic_type(const Type& value) {
    dynamic_type_ = value.raw();
  }

  RawType* void_type() const { return void_type_; }
  void set_void_type(const Type& value) {
    void_type_ = value.raw();
  }

  RawType* function_interface() const {
    return function_interface_;
  }
  void set_function_interface(const Type& value) {
    function_interface_ = value.raw();
  }

  RawType* number_interface() const { return number_interface_; }
  void set_number_interface(const Type& value) {
    number_interface_ = value.raw();
  }

  RawType* int_interface() const { return int_interface_; }
  void set_int_interface(const Type& value) {
    int_interface_ = value.raw();
  }

  RawClass* smi_class() const { return smi_class_; }
  void set_smi_class(const Class& value) { smi_class_ = value.raw(); }
  static intptr_t smi_class_offset() {
    return OFFSET_OF(ObjectStore, smi_class_);
  }

  RawType* double_interface() const { return double_interface_; }
  void set_double_interface(const Type& value) {
    double_interface_ = value.raw();
  }

  RawClass* double_class() const { return double_class_; }
  void set_double_class(const Class& value) { double_class_ = value.raw(); }

  RawClass* mint_class() const { return mint_class_; }
  void set_mint_class(const Class& value) { mint_class_ = value.raw(); }

  RawClass* bigint_class() const { return bigint_class_; }
  void set_bigint_class(const Class& value) { bigint_class_ = value.raw(); }

  RawType* string_interface() const { return string_interface_; }
  void set_string_interface(const Type& value) {
    string_interface_ = value.raw();
  }

  RawClass* one_byte_string_class() const { return one_byte_string_class_; }
  void set_one_byte_string_class(const Class& value) {
    one_byte_string_class_ = value.raw();
  }

  RawClass* two_byte_string_class() const { return two_byte_string_class_; }
  void set_two_byte_string_class(const Class& value) {
    two_byte_string_class_ = value.raw();
  }

  RawClass* four_byte_string_class() const { return four_byte_string_class_; }
  void set_four_byte_string_class(const Class& value) {
    four_byte_string_class_ = value.raw();
  }

  RawClass* external_one_byte_string_class() const {
    return external_one_byte_string_class_;
  }
  void set_external_one_byte_string_class(const Class& value) {
    external_one_byte_string_class_ = value.raw();
  }

  RawClass* external_two_byte_string_class() const {
    return external_two_byte_string_class_;
  }
  void set_external_two_byte_string_class(const Class& value) {
    external_two_byte_string_class_ = value.raw();
  }

  RawClass* external_four_byte_string_class() const {
    return external_four_byte_string_class_;
  }
  void set_external_four_byte_string_class(const Class& value) {
    external_four_byte_string_class_ = value.raw();
  }

  RawType* bool_interface() const { return bool_interface_; }
  void set_bool_interface(const Type& value) {
    bool_interface_ = value.raw();
  }

  RawClass* bool_class() const { return bool_class_; }
  void set_bool_class(const Class& value) { bool_class_ = value.raw(); }

  RawType* list_interface() const { return list_interface_; }
  void set_list_interface(const Type& value) {
    list_interface_ = value.raw();
  }

  RawClass* array_class() const { return array_class_; }
  void set_array_class(const Class& value) { array_class_ = value.raw(); }
  static intptr_t array_class_offset() {
    return OFFSET_OF(ObjectStore, array_class_);
  }

  RawType* byte_array_interface() const { return byte_array_interface_; }
  void set_byte_array_interface(const Type& value) {
    byte_array_interface_ = value.raw();
  }

  RawClass* immutable_array_class() const { return immutable_array_class_; }
  void set_immutable_array_class(const Class& value) {
    immutable_array_class_ = value.raw();
  }

  RawClass* growable_object_array_class() const {
    return growable_object_array_class_;
  }
  void set_growable_object_array_class(const Class& value) {
    growable_object_array_class_ = value.raw();
  }
  static intptr_t growable_object_array_class_offset() {
    return OFFSET_OF(ObjectStore, growable_object_array_class_);
  }

  RawClass* internal_byte_array_class() const {
    return internal_byte_array_class_;
  }
  void set_internal_byte_array_class(const Class& value) {
    internal_byte_array_class_ = value.raw();
  }

  RawClass* external_byte_array_class() const {
    return external_byte_array_class_;
  }
  void set_external_byte_array_class(const Class& value) {
    external_byte_array_class_ = value.raw();
  }

  RawClass* stacktrace_class() const {
    return stacktrace_class_;
  }
  void set_stacktrace_class(const Class& value) {
    stacktrace_class_ = value.raw();
  }
  static intptr_t stacktrace_class_offset() {
    return OFFSET_OF(ObjectStore, stacktrace_class_);
  }

  RawClass* jsregexp_class() const {
    return jsregexp_class_;
  }
  void set_jsregexp_class(const Class& value) {
    jsregexp_class_ = value.raw();
  }
  static intptr_t jsregexp_class_offset() {
    return OFFSET_OF(ObjectStore, jsregexp_class_);
  }

  RawArray* symbol_table() const { return symbol_table_; }
  void set_symbol_table(const Array& value) { symbol_table_ = value.raw(); }

  RawArray* canonical_type_arguments() const {
    return canonical_type_arguments_;
  }
  void set_canonical_type_arguments(const Array& value) {
    canonical_type_arguments_ = value.raw();
  }

  RawLibrary* core_library() const { return core_library_; }
  void set_core_library(const Library& value) {
    core_library_ = value.raw();
  }

  RawLibrary* core_impl_library() const { return core_impl_library_; }
  void set_core_impl_library(const Library& value) {
    core_impl_library_ = value.raw();
  }

  RawLibrary* isolate_library() const {
    return isolate_library_;
  }

  void set_isolate_library(const Library& value) {
    isolate_library_ = value.raw();
  }

  RawLibrary* native_wrappers_library() const {
    return native_wrappers_library_;
  }
  void set_native_wrappers_library(const Library& value) {
    native_wrappers_library_ = value.raw();
  }

  RawLibrary* mirrors_library() const { return mirrors_library_; }
  void set_mirrors_library(const Library& value) {
    mirrors_library_ = value.raw();
  }

  RawLibrary* builtin_library() const {
    return builtin_library_;
  }
  void set_builtin_library(const Library& value) {
    builtin_library_ = value.raw();
  }

  RawLibrary* root_library() const { return root_library_; }
  void set_root_library(const Library& value) {
    root_library_ = value.raw();
  }

  // Returns head of list of registered libraries.
  RawLibrary* registered_libraries() const { return registered_libraries_; }
  void set_registered_libraries(const Library& value) {
    registered_libraries_ = value.raw();
  }

  RawGrowableObjectArray* pending_classes() const { return pending_classes_; }
  void set_pending_classes(const GrowableObjectArray& value) {
    ASSERT(!value.IsNull());
    pending_classes_ = value.raw();
  }

  RawError* sticky_error() const { return sticky_error_; }
  void set_sticky_error(const Error& value) {
    ASSERT(!value.IsNull());
    sticky_error_ = value.raw();
  }
  void clear_sticky_error() { sticky_error_ = Error::null(); }

  RawBool* true_value() const { return true_value_; }
  void set_true_value(const Bool& value) { true_value_ = value.raw(); }

  RawBool* false_value() const { return false_value_; }
  void set_false_value(const Bool& value) { false_value_ = value.raw(); }

  RawArray* empty_array() const { return empty_array_; }
  void set_empty_array(const Array& value) { empty_array_ = value.raw(); }

  RawContext* empty_context() const { return empty_context_; }
  void set_empty_context(const Context& value) {
    empty_context_ = value.raw();
  }

  RawInstance* stack_overflow() const { return stack_overflow_; }
  void set_stack_overflow(const Instance& value) {
    stack_overflow_ = value.raw();
  }

  RawInstance* out_of_memory() const { return out_of_memory_; }
  void set_out_of_memory(const Instance& value) {
    out_of_memory_ = value.raw();
  }

  RawArray* keyword_symbols() const { return keyword_symbols_; }
  void set_keyword_symbols(const Array& value) {
    keyword_symbols_ = value.raw();
  }
  void InitKeywordTable();

  // Visit all object pointers.
  void VisitObjectPointers(ObjectPointerVisitor* visitor);

  RawClass* GetClass(int index);
  int GetClassIndex(const RawClass* raw_class);
  RawType* GetType(int index);
  int GetTypeIndex(const RawType* raw_type);

  // Called to initialize objects required by the vm but which invoke
  // dart code.  If an error occurs then false is returned and error
  // information is stored in sticky_error().
  bool PreallocateObjects();

  static void Init(Isolate* isolate);

 private:
  ObjectStore();

  RawObject** from() { return reinterpret_cast<RawObject**>(&object_class_); }
  RawClass* object_class_;
  RawType* object_type_;
  RawType* null_type_;
  RawType* dynamic_type_;
  RawType* void_type_;
  RawType* function_interface_;
  RawType* number_interface_;
  RawType* int_interface_;
  RawClass* smi_class_;
  RawClass* mint_class_;
  RawClass* bigint_class_;
  RawType* double_interface_;
  RawClass* double_class_;
  RawType* string_interface_;
  RawClass* one_byte_string_class_;
  RawClass* two_byte_string_class_;
  RawClass* four_byte_string_class_;
  RawClass* external_one_byte_string_class_;
  RawClass* external_two_byte_string_class_;
  RawClass* external_four_byte_string_class_;
  RawType* bool_interface_;
  RawClass* bool_class_;
  RawType* list_interface_;
  RawClass* array_class_;
  RawClass* immutable_array_class_;
  RawClass* growable_object_array_class_;
  RawType* byte_array_interface_;
  RawClass* internal_byte_array_class_;
  RawClass* external_byte_array_class_;
  RawClass* stacktrace_class_;
  RawClass* jsregexp_class_;
  RawBool* true_value_;
  RawBool* false_value_;
  RawArray* empty_array_;
  RawArray* symbol_table_;
  RawArray* canonical_type_arguments_;
  RawLibrary* core_library_;
  RawLibrary* core_impl_library_;
  RawLibrary* isolate_library_;
  RawLibrary* mirrors_library_;
  RawLibrary* native_wrappers_library_;
  RawLibrary* builtin_library_;
  RawLibrary* root_library_;
  RawLibrary* registered_libraries_;
  RawGrowableObjectArray* pending_classes_;
  RawError* sticky_error_;
  RawContext* empty_context_;
  RawInstance* stack_overflow_;
  RawInstance* out_of_memory_;
  RawArray* keyword_symbols_;
  RawObject** to() { return reinterpret_cast<RawObject**>(&keyword_symbols_); }

  friend class SnapshotReader;

  DISALLOW_COPY_AND_ASSIGN(ObjectStore);
};

}  // namespace dart

#endif  // VM_OBJECT_STORE_H_