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" 22326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 23225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#define RS_OBJECT_DEBUG 0 24225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 25f0c1df480304a72ce41e7d4b088319cbd7f0938aJason Sams#include <utils/CallStack.h> 26326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 27326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace android { 28326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsnamespace renderscript { 29326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 30e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Samsclass Context; 31fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchoukclass OStream; 32e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 33326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams// An element is a group of Components that occupies one cell in a structure. 34afb743aca56c18beb7ab924e75cb6e070ef3e55aAlex Sakhartchoukclass ObjectBase { 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;} 54c7cec1e3577cc77a5a73d5bd5a82733b1b9936a1Jason Sams virtual bool freeChildren(); 55e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 56e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams static void zeroAllUserRef(Context *rsc); 57c7cec1e3577cc77a5a73d5bd5a82733b1b9936a1Jason Sams static void freeAllChildren(Context *rsc); 58c21cf40f6ae69091bf24f87b5eeabc95e73dd271Jason Sams static void dumpAll(Context *rsc); 59e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 60e12c1c591b4219e80f29c6c0e0c62c9578b75450Jason Sams virtual void dumpLOGV(const char *prefix) const; 61e3150cfb3edb028407669e4a65e087eae77e718cJason Sams virtual void serialize(Context *rsc, OStream *stream) const = 0; 62b825f67adb5d1e1751fe108e6dbf9c6f2555c283Alex Sakhartchouk virtual RsA3DClassID getClassId() const = 0; 63f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 64605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams static bool isValid(const Context *rsc, const ObjectBase *obj); 65605048a9f9af925782f6c90bc1cdc5af59e337d8Jason Sams 66225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // The async lock is taken during object creation in non-rs threads 67225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // and object deletion in the rs thread. 68225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncLock(); 69225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams static void asyncUnlock(); 702353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 71f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Samsprotected: 72225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // Called inside the async lock for any object list management that is 73225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams // necessary in derived classes. 74225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual void preDestroy() const; 75225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 768154954868694e1f233d87d4933a474518b1cb81Jason Sams Context *mRSC; 77225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams virtual ~ObjectBase(); 78f2649a961db2995e9e24a6c98f8a419f1496c1b7Jason Sams 79326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprivate: 802353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams static pthread_mutex_t gObjectInitMutex; 812353ae303868d04e3a26002b2f2dc456c15e8170Jason Sams 82e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void add() const; 83e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams void remove() const; 84e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams 85fb6b614bcea88a587a7ea4530be45ff0ffa0210eAlex Sakhartchouk String8 mName; 869397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mSysRefCount; 879397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mutable int32_t mUserRefCount; 88326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 89e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mPrev; 90e514b45de8561fbc6ef6770845102ca10b0a69d7Jason Sams mutable const ObjectBase * mNext; 91225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 92225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#if RS_OBJECT_DEBUG 93225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams CallStack mStack; 94225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams#endif 95225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 96326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 97326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 989397e30ce5fe3f6af9212a93b490836b04fdfffaJason Samstemplate<class T> 99afb743aca56c18beb7ab924e75cb6e070ef3e55aAlex Sakhartchoukclass ObjectBaseRef { 100326e0ddf89e8df2837752fbfd7a014814b32082cJason Samspublic: 101326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ObjectBaseRef() { 102326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 103326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 104326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 1051030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(const ObjectBaseRef &ref) { 1061030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref.get(); 107a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1089397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->incSysRef(); 109a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1101030893d9b99b72468034da13df025bda479bb97Jason Sams } 1111030893d9b99b72468034da13df025bda479bb97Jason Sams 1121030893d9b99b72468034da13df025bda479bb97Jason Sams ObjectBaseRef(T *ref) { 1131030893d9b99b72468034da13df025bda479bb97Jason Sams mRef = ref; 114a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1159397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 116a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 1171030893d9b99b72468034da13df025bda479bb97Jason Sams } 1181030893d9b99b72468034da13df025bda479bb97Jason Sams 119225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams ObjectBaseRef & operator= (const ObjectBaseRef &ref) { 120c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk if (&ref != this) { 121c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk set(ref); 122c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk } 123c700e649ca44d0dcff8b271e42d949ea72fe3c63Alex Sakhartchouk return *this; 124225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams } 125225afd317e101a7be5fe02c0a86361146ea89f05Jason Sams 126326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams ~ObjectBaseRef() { 127326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 128326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 129326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 130326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void set(T *ref) { 131326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef != ref) { 132326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams clear(); 133326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = ref; 134a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams if (mRef) { 1359397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams ref->incSysRef(); 136a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 137326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 138326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 139326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 140a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams void set(const ObjectBaseRef &ref) { 141a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams set(ref.mRef); 142a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams } 143a0a1b6fbece2eb8d72d788422ab3e5f58d5a9216Jason Sams 144326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams void clear() { 145326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams if (mRef) { 1469397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams mRef->decSysRef(); 147326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 148326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams mRef = NULL; 149326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 150326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 151326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams inline T * get() const { 152326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams return mRef; 153326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 154326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 1559397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams inline T * operator-> () const { 1569397e30ce5fe3f6af9212a93b490836b04fdfffaJason Sams return mRef; 157326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams } 158326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 159326e0ddf89e8df2837752fbfd7a014814b32082cJason Samsprotected: 160326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams T * mRef; 161326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams}; 162326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 163326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 164326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams} 165326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 166326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams#endif //ANDROID_RS_OBJECT_BASE_H 167326e0ddf89e8df2837752fbfd7a014814b32082cJason Sams 168