// Copyright (c) 2012, 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. #include "vm/raw_object.h" #include "vm/become.h" #include "vm/class_table.h" #include "vm/dart.h" #include "vm/freelist.h" #include "vm/isolate.h" #include "vm/object.h" #include "vm/visitor.h" namespace dart { void RawObject::Validate(Isolate* isolate) const { if (Object::void_class_ == reinterpret_cast(kHeapObjectTag)) { // Validation relies on properly initialized class classes. Skip if the // VM is still being initialized. return; } // All Smi values are valid. if (!IsHeapObject()) { return; } // Slightly more readable than a segfault. if (this == reinterpret_cast(kHeapObjectTag)) { FATAL("RAW_NULL encountered"); } // Validate that the tags_ field is sensible. uint32_t tags = ptr()->tags_; intptr_t reserved = ReservedBits::decode(tags); if (reserved != 0) { FATAL1("Invalid tags field encountered %x\n", tags); } intptr_t class_id = ClassIdTag::decode(tags); if (!isolate->class_table()->IsValidIndex(class_id)) { FATAL1("Invalid class id encountered %" Pd "\n", class_id); } if ((class_id == kNullCid) && (isolate->class_table()->At(class_id) == NULL)) { // Null class not yet initialized; skip. return; } intptr_t size = SizeTag::decode(tags); if (size != 0 && size != SizeFromClass()) { FATAL1("Inconsistent class size encountered %" Pd "\n", size); } } // Can't look at the class object because it can be called during // compaction when the class objects are moving. Can use the class // id in the header and the sizes in the Class Table. intptr_t RawObject::SizeFromClass() const { // Only reasonable to be called on heap objects. ASSERT(IsHeapObject()); intptr_t class_id = GetClassId(); intptr_t instance_size = 0; switch (class_id) { case kCodeCid: { const RawCode* raw_code = reinterpret_cast(this); intptr_t pointer_offsets_length = Code::PtrOffBits::decode(raw_code->ptr()->state_bits_); instance_size = Code::InstanceSize(pointer_offsets_length); break; } case kInstructionsCid: { const RawInstructions* raw_instructions = reinterpret_cast(this); intptr_t instructions_size = Instructions::Size(raw_instructions); instance_size = Instructions::InstanceSize(instructions_size); break; } case kContextCid: { const RawContext* raw_context = reinterpret_cast(this); intptr_t num_variables = raw_context->ptr()->num_variables_; instance_size = Context::InstanceSize(num_variables); break; } case kContextScopeCid: { const RawContextScope* raw_context_scope = reinterpret_cast(this); intptr_t num_variables = raw_context_scope->ptr()->num_variables_; instance_size = ContextScope::InstanceSize(num_variables); break; } case kOneByteStringCid: { const RawOneByteString* raw_string = reinterpret_cast(this); intptr_t string_length = Smi::Value(raw_string->ptr()->length_); instance_size = OneByteString::InstanceSize(string_length); break; } case kTwoByteStringCid: { const RawTwoByteString* raw_string = reinterpret_cast(this); intptr_t string_length = Smi::Value(raw_string->ptr()->length_); instance_size = TwoByteString::InstanceSize(string_length); break; } case kArrayCid: case kImmutableArrayCid: { const RawArray* raw_array = reinterpret_cast(this); intptr_t array_length = Smi::Value(raw_array->ptr()->length_); instance_size = Array::InstanceSize(array_length); break; } case kObjectPoolCid: { const RawObjectPool* raw_object_pool = reinterpret_cast(this); intptr_t len = raw_object_pool->ptr()->length_; instance_size = ObjectPool::InstanceSize(len); break; } #define SIZE_FROM_CLASS(clazz) case kTypedData##clazz##Cid: CLASS_LIST_TYPED_DATA(SIZE_FROM_CLASS) { const RawTypedData* raw_obj = reinterpret_cast(this); intptr_t cid = raw_obj->GetClassId(); intptr_t array_len = Smi::Value(raw_obj->ptr()->length_); intptr_t lengthInBytes = array_len * TypedData::ElementSizeInBytes(cid); instance_size = TypedData::InstanceSize(lengthInBytes); break; } #undef SIZE_FROM_CLASS case kTypeArgumentsCid: { const RawTypeArguments* raw_array = reinterpret_cast(this); intptr_t array_length = Smi::Value(raw_array->ptr()->length_); instance_size = TypeArguments::InstanceSize(array_length); break; } case kPcDescriptorsCid: { const RawPcDescriptors* raw_descriptors = reinterpret_cast(this); intptr_t length = raw_descriptors->ptr()->length_; instance_size = PcDescriptors::InstanceSize(length); break; } case kCodeSourceMapCid: { const RawCodeSourceMap* raw_code_source_map = reinterpret_cast(this); intptr_t length = raw_code_source_map->ptr()->length_; instance_size = CodeSourceMap::InstanceSize(length); break; } case kStackMapCid: { const RawStackMap* map = reinterpret_cast(this); intptr_t length = map->ptr()->length_; instance_size = StackMap::InstanceSize(length); break; } case kLocalVarDescriptorsCid: { const RawLocalVarDescriptors* raw_descriptors = reinterpret_cast(this); intptr_t num_descriptors = raw_descriptors->ptr()->num_entries_; instance_size = LocalVarDescriptors::InstanceSize(num_descriptors); break; } case kExceptionHandlersCid: { const RawExceptionHandlers* raw_handlers = reinterpret_cast(this); intptr_t num_handlers = raw_handlers->ptr()->num_entries_; instance_size = ExceptionHandlers::InstanceSize(num_handlers); break; } case kFreeListElement: { uword addr = RawObject::ToAddr(this); FreeListElement* element = reinterpret_cast(addr); instance_size = element->Size(); break; } case kForwardingCorpse: { uword addr = RawObject::ToAddr(this); ForwardingCorpse* element = reinterpret_cast(addr); instance_size = element->Size(); break; } default: { // Get the (constant) instance size out of the class object. // TODO(koda): Add Size(ClassTable*) interface to allow caching in loops. Isolate* isolate = Isolate::Current(); #if defined(DEBUG) ClassTable* class_table = isolate->class_table(); if (!class_table->IsValidIndex(class_id) || !class_table->HasValidClassAt(class_id)) { FATAL2("Invalid class id: %" Pd " from tags %x\n", class_id, ptr()->tags_); } #endif // DEBUG instance_size = isolate->GetClassSizeForHeapWalkAt(class_id); } } ASSERT(instance_size != 0); #if defined(DEBUG) uint32_t tags = ptr()->tags_; intptr_t tags_size = SizeTag::decode(tags); if ((class_id == kArrayCid) && (instance_size > tags_size && tags_size > 0)) { // TODO(22501): Array::MakeFixedLength could be in the process of shrinking // the array (see comment therein), having already updated the tags but not // yet set the new length. Wait a millisecond and try again. int retries_remaining = 1000; // ... but not forever. do { OS::Sleep(1); const RawArray* raw_array = reinterpret_cast(this); intptr_t array_length = Smi::Value(raw_array->ptr()->length_); instance_size = Array::InstanceSize(array_length); } while ((instance_size > tags_size) && (--retries_remaining > 0)); } if ((instance_size != tags_size) && (tags_size != 0)) { FATAL3("Size mismatch: %" Pd " from class vs %" Pd " from tags %x\n", instance_size, tags_size, tags); } #endif // DEBUG return instance_size; } intptr_t RawObject::VisitPointersPredefined(ObjectPointerVisitor* visitor, intptr_t class_id) { ASSERT(class_id < kNumPredefinedCids); intptr_t size = 0; // Only reasonable to be called on heap objects. ASSERT(IsHeapObject()); switch (class_id) { #define RAW_VISITPOINTERS(clazz) \ case k##clazz##Cid: { \ Raw##clazz* raw_obj = reinterpret_cast(this); \ size = Raw##clazz::Visit##clazz##Pointers(raw_obj, visitor); \ break; \ } CLASS_LIST_NO_OBJECT(RAW_VISITPOINTERS) #undef RAW_VISITPOINTERS #define RAW_VISITPOINTERS(clazz) case kTypedData##clazz##Cid: CLASS_LIST_TYPED_DATA(RAW_VISITPOINTERS) { RawTypedData* raw_obj = reinterpret_cast(this); size = RawTypedData::VisitTypedDataPointers(raw_obj, visitor); break; } #undef RAW_VISITPOINTERS #define RAW_VISITPOINTERS(clazz) case kExternalTypedData##clazz##Cid: CLASS_LIST_TYPED_DATA(RAW_VISITPOINTERS) { RawExternalTypedData* raw_obj = reinterpret_cast(this); size = RawExternalTypedData::VisitExternalTypedDataPointers(raw_obj, visitor); break; } #undef RAW_VISITPOINTERS #define RAW_VISITPOINTERS(clazz) case kTypedData##clazz##ViewCid: CLASS_LIST_TYPED_DATA(RAW_VISITPOINTERS) case kByteDataViewCid: case kByteBufferCid: { RawInstance* raw_obj = reinterpret_cast(this); size = RawInstance::VisitInstancePointers(raw_obj, visitor); break; } #undef RAW_VISITPOINTERS case kFreeListElement: { uword addr = RawObject::ToAddr(this); FreeListElement* element = reinterpret_cast(addr); size = element->Size(); break; } case kForwardingCorpse: { uword addr = RawObject::ToAddr(this); ForwardingCorpse* forwarder = reinterpret_cast(addr); size = forwarder->Size(); break; } case kNullCid: size = Size(); break; default: OS::Print("Class Id: %" Pd "\n", class_id); UNREACHABLE(); break; } ASSERT(size != 0); ASSERT(size == Size()); return size; } bool RawObject::FindObject(FindObjectVisitor* visitor) { ASSERT(visitor != NULL); return visitor->FindObject(this); } // Most objects are visited with this function. It calls the from() and to() // methods on the raw object to get the first and last cells that need // visiting. #define REGULAR_VISITOR(Type) \ intptr_t Raw##Type::Visit##Type##Pointers(Raw##Type* raw_obj, \ ObjectPointerVisitor* visitor) { \ /* Make sure that we got here with the tagged pointer as this. */ \ ASSERT(raw_obj->IsHeapObject()); \ ASSERT_UNCOMPRESSED(Type); \ visitor->VisitPointers(raw_obj->from(), raw_obj->to()); \ return Type::InstanceSize(); \ } // For variable length objects. get_length is a code snippet that gets the // length of the object, which is passed to InstanceSize and the to() method. #define VARIABLE_VISITOR(Type, get_length) \ intptr_t Raw##Type::Visit##Type##Pointers(Raw##Type* raw_obj, \ ObjectPointerVisitor* visitor) { \ /* Make sure that we got here with the tagged pointer as this. */ \ ASSERT(raw_obj->IsHeapObject()); \ intptr_t length = get_length; \ visitor->VisitPointers(raw_obj->from(), raw_obj->to(length)); \ return Type::InstanceSize(length); \ } // For now there are no compressed pointers: #define COMPRESSED_VISITOR(Type) REGULAR_VISITOR(Type) #define VARIABLE_COMPRESSED_VISITOR(Type, get_length) \ VARIABLE_VISITOR(Type, get_length) // For fixed-length objects that don't have any pointers that need visiting. #define NULL_VISITOR(Type) \ intptr_t Raw##Type::Visit##Type##Pointers(Raw##Type* raw_obj, \ ObjectPointerVisitor* visitor) { \ /* Make sure that we got here with the tagged pointer as this. */ \ ASSERT(raw_obj->IsHeapObject()); \ ASSERT_NOTHING_TO_VISIT(Type); \ return Type::InstanceSize(); \ } // For objects that don't have any pointers that need visiting, but have a // variable length. #define VARIABLE_NULL_VISITOR(Type, get_length) \ intptr_t Raw##Type::Visit##Type##Pointers(Raw##Type* raw_obj, \ ObjectPointerVisitor* visitor) { \ /* Make sure that we got here with the tagged pointer as this. */ \ ASSERT(raw_obj->IsHeapObject()); \ ASSERT_NOTHING_TO_VISIT(Type); \ intptr_t length = get_length; \ return Type::InstanceSize(length); \ } // For objects that are never instantiated on the heap. #define UNREACHABLE_VISITOR(Type) \ intptr_t Raw##Type::Visit##Type##Pointers(Raw##Type* raw_obj, \ ObjectPointerVisitor* visitor) { \ UNREACHABLE(); \ return 0; \ } REGULAR_VISITOR(Class) REGULAR_VISITOR(UnresolvedClass) REGULAR_VISITOR(Type) REGULAR_VISITOR(TypeRef) REGULAR_VISITOR(TypeParameter) REGULAR_VISITOR(BoundedType) REGULAR_VISITOR(MixinAppType) REGULAR_VISITOR(PatchClass) COMPRESSED_VISITOR(Closure) REGULAR_VISITOR(ClosureData) REGULAR_VISITOR(SignatureData) REGULAR_VISITOR(RedirectionData) REGULAR_VISITOR(Field) REGULAR_VISITOR(LiteralToken) REGULAR_VISITOR(TokenStream) REGULAR_VISITOR(Script) REGULAR_VISITOR(Library) REGULAR_VISITOR(LibraryPrefix) REGULAR_VISITOR(Namespace) REGULAR_VISITOR(SingleTargetCache) REGULAR_VISITOR(UnlinkedCall) REGULAR_VISITOR(ICData) REGULAR_VISITOR(MegamorphicCache) REGULAR_VISITOR(ApiError) REGULAR_VISITOR(LanguageError) REGULAR_VISITOR(UnhandledException) REGULAR_VISITOR(UnwindError) REGULAR_VISITOR(ExternalOneByteString) REGULAR_VISITOR(ExternalTwoByteString) COMPRESSED_VISITOR(GrowableObjectArray) COMPRESSED_VISITOR(LinkedHashMap) COMPRESSED_VISITOR(ExternalTypedData) REGULAR_VISITOR(ReceivePort) REGULAR_VISITOR(StackTrace) REGULAR_VISITOR(RegExp) REGULAR_VISITOR(WeakProperty) REGULAR_VISITOR(MirrorReference) REGULAR_VISITOR(UserTag) REGULAR_VISITOR(SubtypeTestCache) REGULAR_VISITOR(KernelProgramInfo) VARIABLE_VISITOR(TypeArguments, Smi::Value(raw_obj->ptr()->length_)) VARIABLE_VISITOR(LocalVarDescriptors, raw_obj->ptr()->num_entries_) VARIABLE_VISITOR(ExceptionHandlers, raw_obj->ptr()->num_entries_) VARIABLE_VISITOR(Context, raw_obj->ptr()->num_variables_) VARIABLE_COMPRESSED_VISITOR(Array, Smi::Value(raw_obj->ptr()->length_)) VARIABLE_COMPRESSED_VISITOR( TypedData, TypedData::ElementSizeInBytes(raw_obj->GetClassId()) * Smi::Value(raw_obj->ptr()->length_)) VARIABLE_VISITOR(ContextScope, raw_obj->ptr()->num_variables_) NULL_VISITOR(Mint) NULL_VISITOR(Double) NULL_VISITOR(Float32x4) NULL_VISITOR(Int32x4) NULL_VISITOR(Float64x2) NULL_VISITOR(Bool) NULL_VISITOR(Capability) NULL_VISITOR(SendPort) VARIABLE_NULL_VISITOR(Instructions, Instructions::Size(raw_obj)) VARIABLE_NULL_VISITOR(PcDescriptors, raw_obj->ptr()->length_) VARIABLE_NULL_VISITOR(CodeSourceMap, raw_obj->ptr()->length_) VARIABLE_NULL_VISITOR(StackMap, raw_obj->ptr()->length_) VARIABLE_NULL_VISITOR(OneByteString, Smi::Value(raw_obj->ptr()->length_)) VARIABLE_NULL_VISITOR(TwoByteString, Smi::Value(raw_obj->ptr()->length_)) // Abstract types don't have their visitor called. UNREACHABLE_VISITOR(AbstractType) UNREACHABLE_VISITOR(Error) UNREACHABLE_VISITOR(Number) UNREACHABLE_VISITOR(Integer) UNREACHABLE_VISITOR(String) // Smi has no heap representation. UNREACHABLE_VISITOR(Smi) bool RawFunction::CheckUsageCounter(RawFunction* raw_fun) { // NOTE: This code runs while GC is in progress and runs within // a NoHandleScope block. Hence it is not okay to use regular Zone or // Scope handles. We use direct stack handles, and so the raw pointers in // these handles are not traversed. The use of handles is mainly to // be able to reuse the handle based code and avoid having to add // helper functions to the raw object interface. Function fn; fn = raw_fun; // The function may not have code. if (!fn.HasCode()) return false; // These may not increment the usage counter. if (fn.is_intrinsic()) return false; if (fn.usage_counter() >= 0) { fn.SetUsageCounter(fn.usage_counter() / 2); } return FLAG_always_drop_code || (fn.usage_counter() == 0); } bool RawFunction::ShouldVisitCode(RawCode* raw_code) { // NOTE: This code runs while GC is in progress and runs within // a NoHandleScope block. Hence it is not okay to use regular Zone or // Scope handles. We use direct stack handles, and so the raw pointers in // these handles are not traversed. The use of handles is mainly to // be able to reuse the handle based code and avoid having to add // helper functions to the raw object interface. Code code; code = raw_code; if (code.IsNull()) return true; if (code.is_optimized()) return true; if (code.HasBreakpoint()) return true; return false; } intptr_t RawFunction::VisitFunctionPointers(RawFunction* raw_obj, ObjectPointerVisitor* visitor) { if (visitor->visit_function_code() || !CheckUsageCounter(raw_obj)) { visitor->VisitPointers(raw_obj->from(), raw_obj->to()); return Function::InstanceSize(); } #if defined(DART_PRECOMPILED_RUNTIME) UNREACHABLE(); #else visitor->VisitPointers(raw_obj->from(), raw_obj->to_no_code()); if (ShouldVisitCode(raw_obj->ptr()->code_)) { visitor->VisitPointer( reinterpret_cast(&raw_obj->ptr()->code_)); } else { visitor->add_skipped_code_function(raw_obj); } if (ShouldVisitCode(raw_obj->ptr()->unoptimized_code_)) { visitor->VisitPointer( reinterpret_cast(&raw_obj->ptr()->unoptimized_code_)); } else { visitor->add_skipped_code_function(raw_obj); } #endif return Function::InstanceSize(); } bool RawCode::ContainsPC(RawObject* raw_obj, uword pc) { uint32_t tags = raw_obj->ptr()->tags_; if (RawObject::ClassIdTag::decode(tags) == kCodeCid) { RawCode* raw_code = reinterpret_cast(raw_obj); return RawInstructions::ContainsPC(raw_code->ptr()->instructions_, pc); } return false; } intptr_t RawCode::VisitCodePointers(RawCode* raw_obj, ObjectPointerVisitor* visitor) { visitor->VisitPointers(raw_obj->from(), raw_obj->to()); RawCode* obj = raw_obj->ptr(); intptr_t length = Code::PtrOffBits::decode(obj->state_bits_); #if defined(TARGET_ARCH_IA32) // On IA32 only we embed pointers to objects directly in the generated // instructions. The variable portion of a Code object describes where to // find those pointers for tracing. if (Code::AliveBit::decode(obj->state_bits_)) { uword entry_point = reinterpret_cast(obj->instructions_->ptr()) + Instructions::HeaderSize(); for (intptr_t i = 0; i < length; i++) { int32_t offset = obj->data()[i]; visitor->VisitPointer( reinterpret_cast(entry_point + offset)); } } return Code::InstanceSize(length); #else // On all other architectures, objects are referenced indirectly through // either an ObjectPool or Thread. ASSERT(length == 0); return Code::InstanceSize(0); #endif } intptr_t RawObjectPool::VisitObjectPoolPointers(RawObjectPool* raw_obj, ObjectPointerVisitor* visitor) { const intptr_t length = raw_obj->ptr()->length_; RawObjectPool::Entry* entries = raw_obj->ptr()->data(); uint8_t* entry_types = raw_obj->ptr()->entry_types(); for (intptr_t i = 0; i < length; ++i) { ObjectPool::EntryType entry_type = static_cast(entry_types[i]); if (entry_type == ObjectPool::kTaggedObject) { visitor->VisitPointer(&entries[i].raw_obj_); } } return ObjectPool::InstanceSize(length); } bool RawInstructions::ContainsPC(RawInstructions* raw_instr, uword pc) { uword start_pc = reinterpret_cast(raw_instr->ptr()) + Instructions::HeaderSize(); uword end_pc = start_pc + Instructions::Size(raw_instr); ASSERT(end_pc > start_pc); return (pc >= start_pc) && (pc < end_pc); } intptr_t RawInstance::VisitInstancePointers(RawInstance* raw_obj, ObjectPointerVisitor* visitor) { // Make sure that we got here with the tagged pointer as this. ASSERT(raw_obj->IsHeapObject()); uint32_t tags = raw_obj->ptr()->tags_; intptr_t instance_size = SizeTag::decode(tags); if (instance_size == 0) { instance_size = visitor->isolate()->GetClassSizeForHeapWalkAt(raw_obj->GetClassId()); } // Calculate the first and last raw object pointer fields. uword obj_addr = RawObject::ToAddr(raw_obj); uword from = obj_addr + sizeof(RawObject); uword to = obj_addr + instance_size - kWordSize; visitor->VisitPointers(reinterpret_cast(from), reinterpret_cast(to)); return instance_size; } intptr_t RawImmutableArray::VisitImmutableArrayPointers( RawImmutableArray* raw_obj, ObjectPointerVisitor* visitor) { return RawArray::VisitArrayPointers(raw_obj, visitor); } } // namespace dart