12dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers/* 22dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * Copyright (C) 2011 The Android Open Source Project 32dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * 42dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * Licensed under the Apache License, Version 2.0 (the "License"); 52dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * you may not use this file except in compliance with the License. 62dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * You may obtain a copy of the License at 72dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * 82dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * http://www.apache.org/licenses/LICENSE-2.0 92dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * 102dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * Unless required by applicable law or agreed to in writing, software 112dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * distributed under the License is distributed on an "AS IS" BASIS, 122dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 132dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * See the License for the specific language governing permissions and 142dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers * limitations under the License. 152dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers */ 162dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 17fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#ifndef ART_RUNTIME_MIRROR_ARRAY_H_ 18fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#define ART_RUNTIME_MIRROR_ARRAY_H_ 192dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 2094f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi#include "gc_root.h" 21b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers#include "gc/allocator_type.h" 222dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers#include "object.h" 2383c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier#include "object_callbacks.h" 242dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 252dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersnamespace art { 26b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers 27eb8167a4f4d27fce0530f6724ab8032610cd146bMathieu Chartiertemplate<class T> class Handle; 28b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers 292dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersnamespace mirror { 302dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 312dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersclass MANAGED Array : public Object { 322dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers public: 3398d1cc8033251c93786e2fa8c59a2e555a9493beMingyao Yang // The size of a java.lang.Class representing an array. 3498d1cc8033251c93786e2fa8c59a2e555a9493beMingyao Yang static uint32_t ClassSize(); 3598d1cc8033251c93786e2fa8c59a2e555a9493beMingyao Yang 366fac447555dc94a935b78198479cce645c837b89Ian Rogers // Allocates an array with the given properties, if fill_usable is true the array will be of at 376fac447555dc94a935b78198479cce645c837b89Ian Rogers // least component_count size, however, if there's usable space at the end of the allocation the 386fac447555dc94a935b78198479cce645c837b89Ian Rogers // array will fill it. 39cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier template <bool kIsInstrumented> 40cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier static Array* Alloc(Thread* self, Class* array_class, int32_t component_count, 416fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t component_size, gc::AllocatorType allocator_type, 426fac447555dc94a935b78198479cce645c837b89Ian Rogers bool fill_usable = false) 43cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 442dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 450cd81352a7c06e381951cea1b104fd73516f4341Mathieu Chartier static Array* CreateMultiArray(Thread* self, Handle<Class> element_class, 460cd81352a7c06e381951cea1b104fd73516f4341Mathieu Chartier Handle<IntArray> dimensions) 472dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 482dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 496e83c172f385cb45dd13bbcf41d2df8e410828c6Hiroshi Yamauchi template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags, 506e83c172f385cb45dd13bbcf41d2df8e410828c6Hiroshi Yamauchi ReadBarrierOption kReadBarrierOption = kWithReadBarrier> 51ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers size_t SizeOf() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 524e30541a92381fb280cd0be9a1763b713ee4d64cMathieu Chartier template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags> 531fb463e42cf1d67595cff66d19c0f99e3046f4c4Mathieu Chartier ALWAYS_INLINE int32_t GetLength() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 54b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers return GetField32<kVerifyFlags>(OFFSET_OF_OBJECT_MEMBER(Array, length_)); 552dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 562dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 57ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void SetLength(int32_t length) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 582dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers CHECK_GE(length, 0); 59d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // We use non transactional version since we can't undo this write. We also disable checking 60d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // since it would fail during a transaction. 61b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers SetField32<false, false, kVerifyNone>(OFFSET_OF_OBJECT_MEMBER(Array, length_), length); 622dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 632dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 642dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers static MemberOffset LengthOffset() { 652dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers return OFFSET_OF_OBJECT_MEMBER(Array, length_); 662dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 672dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 682dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers static MemberOffset DataOffset(size_t component_size) { 692dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers if (component_size != sizeof(int64_t)) { 702dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers return OFFSET_OF_OBJECT_MEMBER(Array, first_element_); 712dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } else { 722dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers // Align longs and doubles. 732dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers return MemberOffset(OFFSETOF_MEMBER(Array, first_element_) + 4); 742dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 752dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 762dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 77ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void* GetRawData(size_t component_size, int32_t index) 78ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 79ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers intptr_t data = reinterpret_cast<intptr_t>(this) + DataOffset(component_size).Int32Value() + 80ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers + (index * component_size); 812dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers return reinterpret_cast<void*>(data); 822dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 832dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 84ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers const void* GetRawData(size_t component_size, int32_t index) const { 85ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers intptr_t data = reinterpret_cast<intptr_t>(this) + DataOffset(component_size).Int32Value() + 86ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers + (index * component_size); 87ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers return reinterpret_cast<void*>(data); 882dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 892dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 90abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz // Returns true if the index is valid. If not, throws an ArrayIndexOutOfBoundsException and 91abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz // returns false. 924e30541a92381fb280cd0be9a1763b713ee4d64cMathieu Chartier template<VerifyObjectFlags kVerifyFlags = kDefaultVerifyFlags> 931fb463e42cf1d67595cff66d19c0f99e3046f4c4Mathieu Chartier ALWAYS_INLINE bool CheckIsValidIndex(int32_t index) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 942dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 952dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers protected: 96ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void ThrowArrayStoreException(Object* object) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 972dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 982dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers private: 99ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void ThrowArrayIndexOutOfBoundsException(int32_t index) 100abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 101abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz 1022dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers // The number of array elements. 1032dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers int32_t length_; 1042dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers // Marker for the data (used by generated code) 1052dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers uint32_t first_element_[0]; 1062dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 1072dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers DISALLOW_IMPLICIT_CONSTRUCTORS(Array); 1082dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers}; 1092dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 110b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogerstemplate<typename T> 1112dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersclass MANAGED PrimitiveArray : public Array { 1122dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers public: 1132dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers typedef T ElementType; 1142dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 1152dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers static PrimitiveArray<T>* Alloc(Thread* self, size_t length) 1162dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1172dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 118b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers const T* GetData() const ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 119ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers return reinterpret_cast<const T*>(GetRawData(sizeof(T), 0)); 1202dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 1212dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 122b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers T* GetData() ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 123ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers return reinterpret_cast<T*>(GetRawData(sizeof(T), 0)); 1242dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 1252dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 126b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers T Get(int32_t i) ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 127abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz 128b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers T GetWithoutChecks(int32_t i) ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 129abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz DCHECK(CheckIsValidIndex(i)); 1302dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers return GetData()[i]; 1312dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 1322dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 133b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers void Set(int32_t i, T value) ALWAYS_INLINE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 134d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz 135d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // TODO fix thread safety analysis broken by the use of template. This should be 136d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // SHARED_LOCKS_REQUIRED(Locks::mutator_lock_). 137d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz template<bool kTransactionActive, bool kCheckTransaction = true> 138b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers void Set(int32_t i, T value) ALWAYS_INLINE NO_THREAD_SAFETY_ANALYSIS; 1392dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 140d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // TODO fix thread safety analysis broken by the use of template. This should be 141d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz // SHARED_LOCKS_REQUIRED(Locks::mutator_lock_). 142d2fe10a3a34af171bf1631219cd2d6ff6b7778b5Sebastien Hertz template<bool kTransactionActive, bool kCheckTransaction = true> 143b0fa5dc7769c1e054032f39de0a3f6d6dd06f8cfIan Rogers void SetWithoutChecks(int32_t i, T value) ALWAYS_INLINE NO_THREAD_SAFETY_ANALYSIS; 144abff6439db28fbbed95490bfff7e24d1fdf5b771Sebastien Hertz 145ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers /* 146ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * Works like memmove(), except we guarantee not to allow tearing of array values (ie using 147ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * smaller than element size copies). Arguments are assumed to be within the bounds of the array 148ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * and the arrays non-null. 149ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers */ 150ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void Memmove(int32_t dst_pos, PrimitiveArray<T>* src, int32_t src_pos, int32_t count) 151ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 152ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers 153ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers /* 154ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * Works like memcpy(), except we guarantee not to allow tearing of array values (ie using 155ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * smaller than element size copies). Arguments are assumed to be within the bounds of the array 156ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers * and the arrays non-null. 157ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers */ 158ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers void Memcpy(int32_t dst_pos, PrimitiveArray<T>* src, int32_t src_pos, int32_t count) 159ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 160ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers 1612dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers static void SetArrayClass(Class* array_class) { 16294f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi CHECK(array_class_.IsNull()); 1632d10b206f9d0b97396b7dadb9a6415cd39efd341Ian Rogers CHECK(array_class != nullptr); 16494f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi array_class_ = GcRoot<Class>(array_class); 1652dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 1662dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 1674f1ebc2b86c8467d1ecb3ec655316e6d7ee8b8b5Hiroshi Yamauchi static Class* GetArrayClass() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 16894f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi DCHECK(!array_class_.IsNull()); 16994f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi return array_class_.Read(); 1702d10b206f9d0b97396b7dadb9a6415cd39efd341Ian Rogers } 1712d10b206f9d0b97396b7dadb9a6415cd39efd341Ian Rogers 1722dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers static void ResetArrayClass() { 17394f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi CHECK(!array_class_.IsNull()); 17494f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi array_class_ = GcRoot<Class>(nullptr); 1752dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers } 1762dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 17783c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier static void VisitRoots(RootCallback* callback, void* arg) 178c528dba35b5faece51ca658fc008b688f8b690adMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 179c528dba35b5faece51ca658fc008b688f8b690adMathieu Chartier 1802dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers private: 18194f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi static GcRoot<Class> array_class_; 1822dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 1832dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers DISALLOW_IMPLICIT_CONSTRUCTORS(PrimitiveArray); 1842dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers}; 1852dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 1862dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers} // namespace mirror 1872dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers} // namespace art 1882dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 189fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_MIRROR_ARRAY_H_ 190