object_registry.h revision 0920163b0ee4ce3fbf57db5506659de14b77be75
164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes/* 264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * Copyright (C) 2013 The Android Open Source Project 364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * 464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * Licensed under the Apache License, Version 2.0 (the "License"); 564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * you may not use this file except in compliance with the License. 664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * You may obtain a copy of the License at 764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * 864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * http://www.apache.org/licenses/LICENSE-2.0 964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * 1064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * Unless required by applicable law or agreed to in writing, software 1164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * distributed under the License is distributed on an "AS IS" BASIS, 1264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * See the License for the specific language governing permissions and 1464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes * limitations under the License. 1564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes */ 1664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 1764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include <stdint.h> 1864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 1964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include <map> 2064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 2164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "jdwp/jdwp.h" 2264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "mirror/class.h" 2364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "mirror/class-inl.h" 2464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "mirror/field-inl.h" 2564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "mirror/object-inl.h" 2664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes#include "safe_map.h" 2764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 2864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughesnamespace art { 2964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 3064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughesstruct ObjectRegistryEntry { 3164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes // Is jni_reference a weak global or a regular global reference? 3264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes jobjectRefType jni_reference_type; 3364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 3464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes // The reference itself. 3564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes jobject jni_reference; 3664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 3764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes // A reference count, so we can implement DisposeObject. 3864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes int32_t reference_count; 3964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 4064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes // The corresponding id, so we only need one map lookup in Add. 4164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes JDWP::ObjectId id; 4264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes}; 4364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughesstd::ostream& operator<<(std::ostream& os, const ObjectRegistryEntry& rhs); 4464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 4564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes// Tracks those objects currently known to the debugger, so we can use consistent ids when 4664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes// referring to them. Normally we keep JNI weak global references to objects, so they can 4764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes// still be garbage collected. The debugger can ask us to retain objects, though, so we can 4864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes// also promote references to regular JNI global references (and demote them back again if 4964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes// the debugger tells us that's okay). 5064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughesclass ObjectRegistry { 5164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes public: 5264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes ObjectRegistry(); 5364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 5464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes JDWP::ObjectId Add(mirror::Object* o) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 5564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes JDWP::RefTypeId AddRefType(mirror::Class* c) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 5664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 5764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes template<typename T> T Get(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 5864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes if (id == 0) { 5964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes return NULL; 6064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes } 6164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes return reinterpret_cast<T>(InternalGet(id)); 6264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes } 6364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 6464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes bool Contains(mirror::Object* o) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 6564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 660f827169742aad6209d830db773a101849c32a83Elliott Hughes void Clear() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 6764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 680f827169742aad6209d830db773a101849c32a83Elliott Hughes void DisableCollection(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 690f827169742aad6209d830db773a101849c32a83Elliott Hughes void EnableCollection(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 7064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 710f827169742aad6209d830db773a101849c32a83Elliott Hughes bool IsCollected(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 7264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 7364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes void DisposeObject(JDWP::ObjectId id, uint32_t reference_count) 7464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 7564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 7664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes // Returned by Get when passed an invalid object id. 7764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes static mirror::Object* const kInvalidObject; 7864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 790920163b0ee4ce3fbf57db5506659de14b77be75Elliott Hughes // This is needed to get the jobject instead of the Object*. 80449db33fafa29578df60e8a323f78d5eb6247e76Jeff Hao // Avoid using this and use standard Get when possible. 81449db33fafa29578df60e8a323f78d5eb6247e76Jeff Hao jobject GetJObject(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 82449db33fafa29578df60e8a323f78d5eb6247e76Jeff Hao 8364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes private: 8464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes JDWP::ObjectId InternalAdd(mirror::Object* o) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 8564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes mirror::Object* InternalGet(JDWP::ObjectId id) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 860f827169742aad6209d830db773a101849c32a83Elliott Hughes void Demote(ObjectRegistryEntry& entry) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, lock_); 870f827169742aad6209d830db773a101849c32a83Elliott Hughes void Promote(ObjectRegistryEntry& entry) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, lock_); 8864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 8964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes Mutex lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 9064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 9164f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes typedef std::map<mirror::Object*, ObjectRegistryEntry>::iterator object_iterator; 9264f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes std::map<mirror::Object*, ObjectRegistryEntry> object_to_entry_ GUARDED_BY(lock_); 9364f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 9464f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes typedef SafeMap<JDWP::ObjectId, ObjectRegistryEntry*>::iterator id_iterator; 9564f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes SafeMap<JDWP::ObjectId, ObjectRegistryEntry*> id_to_entry_ GUARDED_BY(lock_); 9664f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 9764f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes size_t next_id_ GUARDED_BY(lock_); 9864f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes}; 9964f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes 10064f574f474aa77c72778640ab21f8cfa72546812Elliott Hughes} // namespace art 101