Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 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 | package android.renderscript; |
| 18 | |
Mathew Inwood | f0c90b1 | 2018-08-01 10:05:11 +0100 | [diff] [blame] | 19 | import android.annotation.UnsupportedAppUsage; |
Yang Ni | eb4dd08 | 2016-03-24 09:40:32 -0700 | [diff] [blame] | 20 | import dalvik.system.CloseGuard; |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 21 | import java.util.concurrent.locks.ReentrantReadWriteLock; |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 22 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 23 | /** |
Tim Murray | c11e25c | 2013-04-09 11:01:01 -0700 | [diff] [blame] | 24 | * BaseObj is the base class for all RenderScript objects owned by a RS context. |
| 25 | * It is responsible for lifetime management and resource tracking. This class |
| 26 | * should not be used by a user application. |
Jason Sams | 06d69de | 2010-11-09 17:11:40 -0800 | [diff] [blame] | 27 | * |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 28 | **/ |
Stephen Hines | ef353dd | 2011-03-31 14:45:36 -0700 | [diff] [blame] | 29 | public class BaseObj { |
Tim Murray | 7a629fa | 2013-11-19 12:45:54 -0800 | [diff] [blame] | 30 | BaseObj(long id, RenderScript rs) { |
Jason Sams | 718cd1f | 2009-12-23 14:35:29 -0800 | [diff] [blame] | 31 | rs.validate(); |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 32 | mRS = rs; |
Alex Sakhartchouk | 0de9444 | 2010-08-11 14:41:28 -0700 | [diff] [blame] | 33 | mID = id; |
Jason Sams | 1bada8c | 2009-08-09 17:01:55 -0700 | [diff] [blame] | 34 | mDestroyed = false; |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 35 | } |
| 36 | |
Ashok Bhat | 0e0c088 | 2014-02-04 14:57:58 +0000 | [diff] [blame] | 37 | void setID(long id) { |
Jason Sams | 06d69de | 2010-11-09 17:11:40 -0800 | [diff] [blame] | 38 | if (mID != 0) { |
| 39 | throw new RSRuntimeException("Internal Error, reset of object ID."); |
| 40 | } |
| 41 | mID = id; |
| 42 | } |
| 43 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 44 | /** |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 45 | * Lookup the native object ID for this object. Primarily used by the |
| 46 | * generated reflected code. |
| 47 | * |
Jason Sams | e07694b | 2012-04-03 15:36:36 -0700 | [diff] [blame] | 48 | * @param rs Context to verify against internal context for |
| 49 | * match. |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 50 | * |
Tim Murray | 7a629fa | 2013-11-19 12:45:54 -0800 | [diff] [blame] | 51 | * @return long |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 52 | */ |
Tim Murray | 7a629fa | 2013-11-19 12:45:54 -0800 | [diff] [blame] | 53 | long getID(RenderScript rs) { |
Jason Sams | e07694b | 2012-04-03 15:36:36 -0700 | [diff] [blame] | 54 | mRS.validate(); |
Jason Sams | 7aa150c | 2010-09-21 14:47:22 -0700 | [diff] [blame] | 55 | if (mDestroyed) { |
Jason Sams | c1d6210 | 2010-11-04 14:32:19 -0700 | [diff] [blame] | 56 | throw new RSInvalidStateException("using a destroyed object."); |
Jason Sams | 7aa150c | 2010-09-21 14:47:22 -0700 | [diff] [blame] | 57 | } |
Jason Sams | 5476b45 | 2010-12-08 16:14:36 -0800 | [diff] [blame] | 58 | if (mID == 0) { |
| 59 | throw new RSRuntimeException("Internal error: Object id 0."); |
| 60 | } |
Jason Sams | e07694b | 2012-04-03 15:36:36 -0700 | [diff] [blame] | 61 | if ((rs != null) && (rs != mRS)) { |
| 62 | throw new RSInvalidStateException("using object with mismatched context."); |
| 63 | } |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 64 | return mID; |
| 65 | } |
| 66 | |
Jason Sams | bf6ef8d | 2010-12-06 15:59:59 -0800 | [diff] [blame] | 67 | void checkValid() { |
| 68 | if (mID == 0) { |
| 69 | throw new RSIllegalArgumentException("Invalid object."); |
| 70 | } |
| 71 | } |
| 72 | |
Tim Murray | 7a629fa | 2013-11-19 12:45:54 -0800 | [diff] [blame] | 73 | private long mID; |
Yang Ni | eb4dd08 | 2016-03-24 09:40:32 -0700 | [diff] [blame] | 74 | final CloseGuard guard = CloseGuard.get(); |
Jason Sams | 06d69de | 2010-11-09 17:11:40 -0800 | [diff] [blame] | 75 | private boolean mDestroyed; |
| 76 | private String mName; |
Mathew Inwood | f0c90b1 | 2018-08-01 10:05:11 +0100 | [diff] [blame] | 77 | @UnsupportedAppUsage |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 78 | RenderScript mRS; |
| 79 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 80 | /** |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 81 | * setName assigns a name to an object. This object can later be looked up |
Tim Murray | c11e25c | 2013-04-09 11:01:01 -0700 | [diff] [blame] | 82 | * by this name. |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 83 | * |
| 84 | * @param name The name to assign to the object. |
| 85 | */ |
| 86 | public void setName(String name) { |
Stephen Hines | 84a97ca | 2011-03-15 21:05:54 -0700 | [diff] [blame] | 87 | if (name == null) { |
| 88 | throw new RSIllegalArgumentException( |
| 89 | "setName requires a string of non-zero length."); |
| 90 | } |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 91 | if(name.length() < 1) { |
Stephen Hines | 84a97ca | 2011-03-15 21:05:54 -0700 | [diff] [blame] | 92 | throw new RSIllegalArgumentException( |
| 93 | "setName does not accept a zero length string."); |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 94 | } |
| 95 | if(mName != null) { |
Stephen Hines | 84a97ca | 2011-03-15 21:05:54 -0700 | [diff] [blame] | 96 | throw new RSIllegalArgumentException( |
| 97 | "setName object already has a name."); |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | try { |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 101 | byte[] bytes = name.getBytes("UTF-8"); |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 102 | mRS.nAssignName(mID, bytes); |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 103 | mName = name; |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 104 | } catch (java.io.UnsupportedEncodingException e) { |
| 105 | throw new RuntimeException(e); |
| 106 | } |
| 107 | } |
| 108 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 109 | /** |
Alex Sakhartchouk | 0400b07 | 2011-07-26 14:13:32 -0700 | [diff] [blame] | 110 | * @return name of the renderscript object |
| 111 | */ |
| 112 | public String getName() { |
| 113 | return mName; |
| 114 | } |
| 115 | |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 116 | private void helpDestroy() { |
| 117 | boolean shouldDestroy = false; |
| 118 | synchronized(this) { |
| 119 | if (!mDestroyed) { |
| 120 | shouldDestroy = true; |
| 121 | mDestroyed = true; |
| 122 | } |
| 123 | } |
| 124 | |
| 125 | if (shouldDestroy) { |
Yang Ni | eb4dd08 | 2016-03-24 09:40:32 -0700 | [diff] [blame] | 126 | guard.close(); |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 127 | // must include nObjDestroy in the critical section |
| 128 | ReentrantReadWriteLock.ReadLock rlock = mRS.mRWLock.readLock(); |
| 129 | rlock.lock(); |
Tim Murray | 6d63c84 | 2014-02-12 11:16:17 -0800 | [diff] [blame] | 130 | // AllocationAdapters are BaseObjs with an ID of 0 but should not be passed to nObjDestroy |
| 131 | if(mRS.isAlive() && mID != 0) { |
Jason Sams | d78be37 | 2010-08-17 19:28:29 -0700 | [diff] [blame] | 132 | mRS.nObjDestroy(mID); |
Jason Sams | 730ee65 | 2009-08-18 17:07:09 -0700 | [diff] [blame] | 133 | } |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 134 | rlock.unlock(); |
Jason Sams | a9e7a05 | 2009-09-25 14:51:22 -0700 | [diff] [blame] | 135 | mRS = null; |
Jason Sams | 730ee65 | 2009-08-18 17:07:09 -0700 | [diff] [blame] | 136 | mID = 0; |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 137 | } |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | protected void finalize() throws Throwable { |
Yang Ni | eb4dd08 | 2016-03-24 09:40:32 -0700 | [diff] [blame] | 141 | try { |
| 142 | if (guard != null) { |
| 143 | guard.warnIfOpen(); |
| 144 | } |
| 145 | helpDestroy(); |
| 146 | } finally { |
| 147 | super.finalize(); |
| 148 | } |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 149 | } |
Jason Sams | 7ce033d | 2009-08-18 14:14:24 -0700 | [diff] [blame] | 150 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 151 | /** |
Tim Murray | c11e25c | 2013-04-09 11:01:01 -0700 | [diff] [blame] | 152 | * Frees any native resources associated with this object. The |
| 153 | * primary use is to force immediate cleanup of resources when it is |
| 154 | * believed the GC will not respond quickly enough. |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 155 | */ |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 156 | public void destroy() { |
Jason Sams | 7ce033d | 2009-08-18 14:14:24 -0700 | [diff] [blame] | 157 | if(mDestroyed) { |
Jason Sams | c1d6210 | 2010-11-04 14:32:19 -0700 | [diff] [blame] | 158 | throw new RSInvalidStateException("Object already destroyed."); |
Jason Sams | 7ce033d | 2009-08-18 14:14:24 -0700 | [diff] [blame] | 159 | } |
Tim Murray | 504abb3 | 2014-01-07 11:13:56 -0800 | [diff] [blame] | 160 | helpDestroy(); |
Jason Sams | 7ce033d | 2009-08-18 14:14:24 -0700 | [diff] [blame] | 161 | } |
| 162 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 163 | /** |
Jason Sams | 27676fe | 2010-11-10 17:00:59 -0800 | [diff] [blame] | 164 | * If an object came from an a3d file, java fields need to be |
| 165 | * created with objects from the native layer |
| 166 | */ |
Alex Sakhartchouk | 80a4c2c | 2010-07-12 15:50:32 -0700 | [diff] [blame] | 167 | void updateFromNative() { |
Jason Sams | 06d69de | 2010-11-09 17:11:40 -0800 | [diff] [blame] | 168 | mRS.validate(); |
Jason Sams | e07694b | 2012-04-03 15:36:36 -0700 | [diff] [blame] | 169 | mName = mRS.nGetName(getID(mRS)); |
Alex Sakhartchouk | 80a4c2c | 2010-07-12 15:50:32 -0700 | [diff] [blame] | 170 | } |
| 171 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 172 | /** |
Stephen Hines | 705d2ea | 2011-06-09 10:11:54 -0700 | [diff] [blame] | 173 | * Calculates the hash code value for a BaseObj. |
| 174 | * |
| 175 | * @return int |
| 176 | */ |
| 177 | @Override |
| 178 | public int hashCode() { |
Tim Murray | 7a629fa | 2013-11-19 12:45:54 -0800 | [diff] [blame] | 179 | return (int)((mID & 0xfffffff) ^ (mID >> 32)); |
Stephen Hines | 705d2ea | 2011-06-09 10:11:54 -0700 | [diff] [blame] | 180 | } |
| 181 | |
Stephen Hines | 9c9ad3f8c2 | 2012-05-07 15:34:29 -0700 | [diff] [blame] | 182 | /** |
Stephen Hines | 705d2ea | 2011-06-09 10:11:54 -0700 | [diff] [blame] | 183 | * Compare the current BaseObj with another BaseObj for equality. |
| 184 | * |
| 185 | * @param obj The object to check equality with. |
| 186 | * |
| 187 | * @return boolean |
| 188 | */ |
| 189 | @Override |
| 190 | public boolean equals(Object obj) { |
| 191 | // Early-out check to see if both BaseObjs are actually the same |
| 192 | if (this == obj) |
| 193 | return true; |
| 194 | |
Tim Murray | 78214c95 | 2014-02-28 16:57:47 -0800 | [diff] [blame] | 195 | if (obj == null) { |
| 196 | return false; |
| 197 | } |
| 198 | |
Stephen Hines | 705d2ea | 2011-06-09 10:11:54 -0700 | [diff] [blame] | 199 | if (getClass() != obj.getClass()) { |
| 200 | return false; |
| 201 | } |
| 202 | |
| 203 | BaseObj b = (BaseObj) obj; |
| 204 | return mID == b.mID; |
| 205 | } |
Jason Sams | 36e612a | 2009-07-31 16:26:13 -0700 | [diff] [blame] | 206 | } |
| 207 | |