rsObjectBase.h revision f0c1df480304a72ce41e7d4b088319cbd7f0938a
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" 21326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 22225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#define RS_OBJECT_DEBUG 0 23225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 24f0c1df480304a72ce41e7d4b088319cbd7f0938aJason Sams#include <utils/CallStack.h> 25326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 26326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace android { 27326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace renderscript { 28326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 29e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Samsclass Context; 30fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchoukclass OStream; 31e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 32326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams// An element is a group of Components that occupies one cell in a structure. 33326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsclass ObjectBase 34326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams{ 35326e0ddf89e8df2837752fbfd7a014814b32082cJason Samspublic: 36e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams ObjectBase(Context *rsc); 37326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 389397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams void incSysRef() const; 39e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool decSysRef() const; 409397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams 419397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams void incUserRef() const; 42e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool decUserRef() const; 43e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams bool zeroUserRef() const; 44225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 45225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static bool checkDelete(const ObjectBase *); 46326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 47a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams const char * getName() const { 48fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk return mName.string(); 49a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 50a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams void setName(const char *); 51a4a54e42fc710a62b47cbcb9d64c34a190429d9eJason Sams void setName(const char *, uint32_t len); 52a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams 53e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams Context * getContext() const {return mRSC;} 54e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 55e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams static void zeroAllUserRef(Context *rsc); 56c21cf40f6ae69091bf24f87b5eeabc95e73dd271Jason Sams static void dumpAll(Context *rsc); 57e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 58e12c1c591b4219e80f29c6c0e0c62c9578b75450Jason Sams virtual void dumpLOGV(const char *prefix) const; 59fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk virtual void serialize(OStream *stream) const = 0; 60b825f67adb5d1e1751fe108e6dbf9c6f2555c283Alex Sakhartchouk virtual RsA3DClassID getClassId() const = 0; 61f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 62605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams static bool isValid(const Context *rsc, const ObjectBase *obj); 63605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams 64225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // The async lock is taken during object creation in non-rs threads 65225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // and object deletion in the rs thread. 66225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncLock(); 67225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncUnlock(); 682353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 69f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Samsprotected: 70225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // Called inside the async lock for any object list management that is 71225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // necessary in derived classes. 72225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual void preDestroy() const; 73225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 748154954868694e1f233d87d4933a474518b1cb81Jason Sams Context *mRSC; 75225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual ~ObjectBase(); 76f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 77326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprivate: 782353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams static pthread_mutex_t gObjectInitMutex; 792353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 80e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void add() const; 81e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void remove() const; 82e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 83fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk String8 mName; 849397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mSysRefCount; 859397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mUserRefCount; 86326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 87e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mPrev; 88e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mNext; 89225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 90225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#if RS_OBJECT_DEBUG 91225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams CallStack mStack; 92225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#endif 93225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 94326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 95326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 969397e30ce5fe3f6af9212a93b490836b04fdfffaJason Samstemplate<class T> 979397e30ce5fe3f6af9212a93b490836b04fdfffaJason Samsclass ObjectBaseRef 98326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams{ 99326e0ddf89e8df2837752fbfd7a014814b32082cJason Samspublic: 100326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ObjectBaseRef() { 101326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 102326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 103326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 1041030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(const ObjectBaseRef &ref) { 1051030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref.get(); 106a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1079397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->incSysRef(); 108a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1091030893d9b99b72468034da13df025bda479bb97Jason Sams } 1101030893d9b99b72468034da13df025bda479bb97Jason Sams 1111030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(T *ref) { 1121030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref; 113a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1149397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 115a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1161030893d9b99b72468034da13df025bda479bb97Jason Sams } 1171030893d9b99b72468034da13df025bda479bb97Jason Sams 118225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams ObjectBaseRef & operator= (const ObjectBaseRef &ref) { 119225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams return ObjectBaseRef(ref); 120225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams } 121225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 122326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ~ObjectBaseRef() { 123326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 124326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 125326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 126326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void set(T *ref) { 127326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef != ref) { 128326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 129326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = ref; 130a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1319397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 132a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 133326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 134326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 135326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 136a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams void set(const ObjectBaseRef &ref) { 137a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams set(ref.mRef); 138a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 139a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams 140326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void clear() { 141326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef) { 1429397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->decSysRef(); 143326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 144326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 145326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 146326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 147326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams inline T * get() const { 148326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams return mRef; 149326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 150326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 1519397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams inline T * operator-> () const { 1529397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams return mRef; 153326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 154326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 155326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprotected: 156326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams T * mRef; 157326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 158326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 159326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 160326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 161326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 162326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 163326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 164326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#endif //ANDROID_RS_OBJECT_BASE_H 165326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 166