rsObjectBase.h revision d216dafa216f3329577ab624cdc5a5d1860ec035
1326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams/* 2326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * Copyright (C) 2009 The Android Open Source Project 3326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * 4326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * Licensed under the Apache License, Version 2.0 (the "License"); 5326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * you may not use this file except in compliance with the License. 6326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * You may obtain a copy of the License at 7326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * 8326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * http://www.apache.org/licenses/LICENSE-2.0 9326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * 10326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * Unless required by applicable law or agreed to in writing, software 11326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * distributed under the License is distributed on an "AS IS" BASIS, 12326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * See the License for the specific language governing permissions and 14326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams * limitations under the License. 15326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams */ 16326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 17326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#ifndef ANDROID_RS_OBJECT_BASE_H 18326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#define ANDROID_RS_OBJECT_BASE_H 19326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 20326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#include "rsUtils.h" 21e23d239828a229eb7d4d33c9630070f0a87833e1Alex Sakhartchouk#include "rsDefines.h" 22d216dafa216f3329577ab624cdc5a5d1860ec035Stephen Hines#include "rsDebugHelper.h" 23326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 24326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace android { 25326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace renderscript { 26326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 27e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Samsclass Context; 28fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchoukclass OStream; 29e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 30326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams// An element is a group of Components that occupies one cell in a structure. 31afb743aca56c18beb7ab924e75cb6e070ef3e55aAlex Sakhartchoukclass ObjectBase { 32326e0ddf89e8df2837752fbfd7a014814b32082cJason Samspublic: 33e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams ObjectBase(Context *rsc); 34326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 359397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams void incSysRef() const; 36e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool decSysRef() const; 379397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams 389397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams void incUserRef() const; 39e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool decUserRef() const; 40e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool zeroUserRef() const; 41225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 42225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static bool checkDelete(const ObjectBase *); 43326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 44a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams const char * getName() const { 45fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk return mName.string(); 46a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 47a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams void setName(const char *); 48a4a54e42fc710a62b47cbcb9d64c34a190429d9eJason Sams void setName(const char *, uint32_t len); 49a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams 50e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams Context * getContext() const {return mRSC;} 51c7cec1e3577cc77a5a73d5bd5a82733b1b9936a1Jason Sams virtual bool freeChildren(); 52e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 53e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams static void zeroAllUserRef(Context *rsc); 54c7cec1e3577cc77a5a73d5bd5a82733b1b9936a1Jason Sams static void freeAllChildren(Context *rsc); 55c21cf40f6ae69091bf24f87b5eeabc95e73dd271Jason Sams static void dumpAll(Context *rsc); 56e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 57e12c1c591b4219e80f29c6c0e0c62c9578b75450Jason Sams virtual void dumpLOGV(const char *prefix) const; 58e3150cfb3edb028407669e4a65e087eae77e718cJason Sams virtual void serialize(Context *rsc, OStream *stream) const = 0; 59b825f67adb5d1e1751fe108e6dbf9c6f2555c283Alex Sakhartchouk virtual RsA3DClassID getClassId() const = 0; 60f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 61605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams static bool isValid(const Context *rsc, const ObjectBase *obj); 62605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams 63225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // The async lock is taken during object creation in non-rs threads 64225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // and object deletion in the rs thread. 65225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncLock(); 66225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncUnlock(); 672353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 68f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Samsprotected: 69225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // Called inside the async lock for any object list management that is 70225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // necessary in derived classes. 71225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual void preDestroy() const; 72225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 738154954868694e1f233d87d4933a474518b1cb81Jason Sams Context *mRSC; 74225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual ~ObjectBase(); 75f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 76326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprivate: 772353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams static pthread_mutex_t gObjectInitMutex; 782353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 79e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void add() const; 80e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void remove() const; 81e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 82fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk String8 mName; 839397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mSysRefCount; 849397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mUserRefCount; 85326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 86e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mPrev; 87e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mNext; 88225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 89d216dafa216f3329577ab624cdc5a5d1860ec035Stephen Hines DebugHelper *mDH; 90326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 91326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 929397e30ce5fe3f6af9212a93b490836b04fdfffaJason Samstemplate<class T> 93afb743aca56c18beb7ab924e75cb6e070ef3e55aAlex Sakhartchoukclass ObjectBaseRef { 94326e0ddf89e8df2837752fbfd7a014814b32082cJason Samspublic: 95326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ObjectBaseRef() { 96326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 97326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 98326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 991030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(const ObjectBaseRef &ref) { 1001030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref.get(); 101a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1029397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->incSysRef(); 103a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1041030893d9b99b72468034da13df025bda479bb97Jason Sams } 1051030893d9b99b72468034da13df025bda479bb97Jason Sams 1061030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(T *ref) { 1071030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref; 108a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1099397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 110a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1111030893d9b99b72468034da13df025bda479bb97Jason Sams } 1121030893d9b99b72468034da13df025bda479bb97Jason Sams 113225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams ObjectBaseRef & operator= (const ObjectBaseRef &ref) { 114c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk if (&ref != this) { 115c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk set(ref); 116c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk } 117c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk return *this; 118225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams } 119225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 120326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ~ObjectBaseRef() { 121326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 122326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 123326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 124326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void set(T *ref) { 125326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef != ref) { 126326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 127326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = ref; 128a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1299397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 130a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 131326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 132326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 133326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 134a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams void set(const ObjectBaseRef &ref) { 135a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams set(ref.mRef); 136a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 137a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams 138326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void clear() { 139326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef) { 1409397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->decSysRef(); 141326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 142326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 143326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 144326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 145326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams inline T * get() const { 146326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams return mRef; 147326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 148326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 1499397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams inline T * operator-> () const { 1509397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams return mRef; 151326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 152326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 153326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprotected: 154326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams T * mRef; 155326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 156326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 157326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 158326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 159326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 160326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#endif //ANDROID_RS_OBJECT_BASE_H 161326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 162