Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 1 | /* |
2 | * Copyright (C) 2009 The Android Open Source Project | ||||
3 | * | ||||
4 | * Licensed under the Apache License, Version 2.0 (the "License"); | ||||
5 | * you may not use this file except in compliance with the License. | ||||
6 | * You may obtain a copy of the License at | ||||
7 | * | ||||
8 | * http://www.apache.org/licenses/LICENSE-2.0 | ||||
9 | * | ||||
10 | * Unless required by applicable law or agreed to in writing, software | ||||
11 | * distributed under the License is distributed on an "AS IS" BASIS, | ||||
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||
13 | * See the License for the specific language governing permissions and | ||||
14 | * limitations under the License. | ||||
15 | */ | ||||
16 | |||||
17 | #ifndef ANDROID_RS_OBJECT_BASE_H | ||||
18 | #define ANDROID_RS_OBJECT_BASE_H | ||||
19 | |||||
20 | #include "rsUtils.h" | ||||
Alex Sakhartchouk | e23d239 | 2012-03-09 09:24:39 -0800 | [diff] [blame] | 21 | #include "rsDefines.h" |
Stephen Hines | d216daf | 2013-04-02 16:32:34 -0700 | [diff] [blame] | 22 | #include "rsDebugHelper.h" |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 23 | |
24 | namespace android { | ||||
25 | namespace renderscript { | ||||
26 | |||||
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 27 | class Context; |
Alex Sakhartchouk | fb6b614 | 2010-05-21 12:53:13 -0700 | [diff] [blame] | 28 | class OStream; |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 29 | |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 30 | // An element is a group of Components that occupies one cell in a structure. |
Alex Sakhartchouk | afb743a | 2010-11-09 17:00:54 -0800 | [diff] [blame] | 31 | class ObjectBase { |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 32 | public: |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 33 | ObjectBase(Context *rsc); |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 34 | |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 35 | void incSysRef() const; |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 36 | bool decSysRef() const; |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 37 | |
38 | void incUserRef() const; | ||||
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 39 | bool decUserRef() const; |
40 | bool zeroUserRef() const; | ||||
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 41 | |
42 | static bool checkDelete(const ObjectBase *); | ||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 43 | |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 44 | const char * getName() const { |
Stephen Hines | b0934b6 | 2013-07-03 17:27:38 -0700 | [diff] [blame] | 45 | return mName; |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 46 | } |
Jason Sams | 48ecf6a | 2013-07-09 15:35:29 -0700 | [diff] [blame] | 47 | void assignName(const char *s) {mName = s;} |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 48 | void setName(const char *); |
Jason Sams | a4a54e4 | 2009-06-10 18:39:40 -0700 | [diff] [blame] | 49 | void setName(const char *, uint32_t len); |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 50 | |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 51 | Context * getContext() const {return mRSC;} |
Jason Sams | c7cec1e | 2011-08-18 18:01:33 -0700 | [diff] [blame] | 52 | virtual bool freeChildren(); |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 53 | |
54 | static void zeroAllUserRef(Context *rsc); | ||||
Jason Sams | c7cec1e | 2011-08-18 18:01:33 -0700 | [diff] [blame] | 55 | static void freeAllChildren(Context *rsc); |
Jason Sams | c21cf40 | 2009-11-17 17:26:46 -0800 | [diff] [blame] | 56 | static void dumpAll(Context *rsc); |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 57 | |
Jason Sams | e12c1c5 | 2009-09-27 17:50:38 -0700 | [diff] [blame] | 58 | virtual void dumpLOGV(const char *prefix) const; |
Jason Sams | e3150cf | 2012-07-24 18:10:20 -0700 | [diff] [blame] | 59 | virtual void serialize(Context *rsc, OStream *stream) const = 0; |
Alex Sakhartchouk | b825f67 | 2010-06-04 10:06:50 -0700 | [diff] [blame] | 60 | virtual RsA3DClassID getClassId() const = 0; |
Jason Sams | f2649a9 | 2009-09-25 16:37:33 -0700 | [diff] [blame] | 61 | |
Jason Sams | 605048a | 2010-09-30 18:15:52 -0700 | [diff] [blame] | 62 | static bool isValid(const Context *rsc, const ObjectBase *obj); |
63 | |||||
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 64 | // The async lock is taken during object creation in non-rs threads |
65 | // and object deletion in the rs thread. | ||||
66 | static void asyncLock(); | ||||
67 | static void asyncUnlock(); | ||||
Jason Sams | 2353ae3 | 2010-10-14 17:48:46 -0700 | [diff] [blame] | 68 | |
Jason Sams | f2649a9 | 2009-09-25 16:37:33 -0700 | [diff] [blame] | 69 | protected: |
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 70 | // Called inside the async lock for any object list management that is |
71 | // necessary in derived classes. | ||||
72 | virtual void preDestroy() const; | ||||
73 | |||||
Jason Sams | 8154954 | 2010-02-17 15:38:10 -0800 | [diff] [blame] | 74 | Context *mRSC; |
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 75 | virtual ~ObjectBase(); |
Jason Sams | f2649a9 | 2009-09-25 16:37:33 -0700 | [diff] [blame] | 76 | |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 77 | private: |
Jason Sams | 2353ae3 | 2010-10-14 17:48:46 -0700 | [diff] [blame] | 78 | static pthread_mutex_t gObjectInitMutex; |
79 | |||||
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 80 | void add() const; |
81 | void remove() const; | ||||
82 | |||||
Stephen Hines | b0934b6 | 2013-07-03 17:27:38 -0700 | [diff] [blame] | 83 | const char* mName; |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 84 | mutable int32_t mSysRefCount; |
85 | mutable int32_t mUserRefCount; | ||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 86 | |
Jason Sams | e514b45 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 87 | mutable const ObjectBase * mPrev; |
88 | mutable const ObjectBase * mNext; | ||||
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 89 | |
Stephen Hines | d216daf | 2013-04-02 16:32:34 -0700 | [diff] [blame] | 90 | DebugHelper *mDH; |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 91 | }; |
92 | |||||
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 93 | template<class T> |
Alex Sakhartchouk | afb743a | 2010-11-09 17:00:54 -0800 | [diff] [blame] | 94 | class ObjectBaseRef { |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 95 | public: |
96 | ObjectBaseRef() { | ||||
97 | mRef = NULL; | ||||
98 | } | ||||
99 | |||||
Jason Sams | 1030893 | 2009-06-09 12:15:30 -0700 | [diff] [blame] | 100 | ObjectBaseRef(const ObjectBaseRef &ref) { |
101 | mRef = ref.get(); | ||||
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 102 | if (mRef) { |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 103 | mRef->incSysRef(); |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 104 | } |
Jason Sams | 1030893 | 2009-06-09 12:15:30 -0700 | [diff] [blame] | 105 | } |
106 | |||||
107 | ObjectBaseRef(T *ref) { | ||||
108 | mRef = ref; | ||||
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 109 | if (mRef) { |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 110 | ref->incSysRef(); |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 111 | } |
Jason Sams | 1030893 | 2009-06-09 12:15:30 -0700 | [diff] [blame] | 112 | } |
113 | |||||
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 114 | ObjectBaseRef & operator= (const ObjectBaseRef &ref) { |
Alex Sakhartchouk | c700e64 | 2011-08-16 13:09:46 -0700 | [diff] [blame] | 115 | if (&ref != this) { |
116 | set(ref); | ||||
117 | } | ||||
118 | return *this; | ||||
Jason Sams | 225afd3 | 2010-10-21 14:06:55 -0700 | [diff] [blame] | 119 | } |
120 | |||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 121 | ~ObjectBaseRef() { |
122 | clear(); | ||||
123 | } | ||||
124 | |||||
125 | void set(T *ref) { | ||||
126 | if (mRef != ref) { | ||||
127 | clear(); | ||||
128 | mRef = ref; | ||||
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 129 | if (mRef) { |
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 130 | ref->incSysRef(); |
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 131 | } |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 132 | } |
133 | } | ||||
134 | |||||
Jason Sams | a0a1b6f | 2009-06-10 15:04:38 -0700 | [diff] [blame] | 135 | void set(const ObjectBaseRef &ref) { |
136 | set(ref.mRef); | ||||
137 | } | ||||
138 | |||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 139 | void clear() { |
140 | if (mRef) { | ||||
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 141 | mRef->decSysRef(); |
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 142 | } |
143 | mRef = NULL; | ||||
144 | } | ||||
145 | |||||
146 | inline T * get() const { | ||||
147 | return mRef; | ||||
148 | } | ||||
149 | |||||
Jason Sams | 9397e30 | 2009-08-27 20:23:34 -0700 | [diff] [blame] | 150 | inline T * operator-> () const { |
151 | return mRef; | ||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 152 | } |
153 | |||||
154 | protected: | ||||
155 | T * mRef; | ||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 156 | }; |
157 | |||||
Jason Sams | 326e0dd | 2009-05-22 14:03:28 -0700 | [diff] [blame] | 158 | } |
159 | } | ||||
160 | |||||
161 | #endif //ANDROID_RS_OBJECT_BASE_H | ||||
162 |