Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 1 | /* |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 2 | * Copyright (C) 2015 The Android Open Source Project |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 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 | |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 17 | // Don't edit this file! It is auto-generated by frameworks/rs/api/generate.sh. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 18 | |
| 19 | /* |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 20 | * rs_atomic.rsh: Atomic Update Functions |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 21 | * |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 22 | * To update values shared between multiple threads, use the functions below. |
| 23 | * They ensure that the values are atomically updated, i.e. that the memory |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 24 | * reads, the updates, and the memory writes are done in the right order. |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 25 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 26 | * These functions are slower than their non-atomic equivalents, so use |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 27 | * them only when synchronization is needed. |
| 28 | * |
| 29 | * Note that in RenderScript, your code is likely to be running in separate |
| 30 | * threads even though you did not explicitely create them. The RenderScript |
| 31 | * runtime will very often split the execution of one kernel across multiple |
| 32 | * threads. Updating globals should be done with atomic functions. If possible, |
| 33 | * modify your algorithm to avoid them altogether. |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 34 | */ |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 35 | |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 36 | #ifndef RENDERSCRIPT_RS_ATOMIC_RSH |
| 37 | #define RENDERSCRIPT_RS_ATOMIC_RSH |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 38 | |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 39 | /* |
| 40 | * rsAtomicAdd: Thread-safe addition |
| 41 | * |
| 42 | * Atomicly adds a value to the value at addr, i.e. *addr += value. |
| 43 | * |
| 44 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 45 | * addr: Address of the value to modify. |
| 46 | * value: Amount to add. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 47 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 48 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 49 | */ |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 50 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 51 | extern int32_t __attribute__((overloadable)) |
| 52 | rsAtomicAdd(volatile int32_t* addr, int32_t value); |
Ying Wang | b335bb0 | 2011-11-29 10:23:55 -0800 | [diff] [blame] | 53 | #endif |
| 54 | |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 55 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 56 | extern int32_t __attribute__((overloadable)) |
| 57 | rsAtomicAdd(volatile uint32_t* addr, uint32_t value); |
| 58 | #endif |
| 59 | |
| 60 | /* |
| 61 | * rsAtomicAnd: Thread-safe bitwise and |
| 62 | * |
| 63 | * Atomicly performs a bitwise and of two values, storing the result back at addr, |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 64 | * i.e. *addr &= value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 65 | * |
| 66 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 67 | * addr: Address of the value to modify. |
| 68 | * value: Value to and with. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 69 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 70 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 71 | */ |
| 72 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 73 | extern int32_t __attribute__((overloadable)) |
| 74 | rsAtomicAnd(volatile int32_t* addr, int32_t value); |
| 75 | #endif |
| 76 | |
| 77 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 78 | extern int32_t __attribute__((overloadable)) |
| 79 | rsAtomicAnd(volatile uint32_t* addr, uint32_t value); |
| 80 | #endif |
| 81 | |
| 82 | /* |
| 83 | * rsAtomicCas: Thread-safe compare and set |
| 84 | * |
| 85 | * If the value at addr matches compareValue then the newValue is written at addr, |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 86 | * i.e. if (*addr == compareValue) { *addr = newValue; }. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 87 | * |
| 88 | * You can check that the value was written by checking that the value returned |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 89 | * by rsAtomicCas() is compareValue. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 90 | * |
| 91 | * Parameters: |
Pirama Arumuga Nainar | db74586 | 2015-05-11 14:34:37 -0700 | [diff] [blame] | 92 | * addr: Address of the value to compare and replace if the test passes. |
| 93 | * compareValue: Value to test *addr against. |
| 94 | * newValue: Value to write if the test passes. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 95 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 96 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 97 | */ |
| 98 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 99 | extern int32_t __attribute__((overloadable)) |
| 100 | rsAtomicCas(volatile int32_t* addr, int32_t compareValue, int32_t newValue); |
| 101 | #endif |
| 102 | |
| 103 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 104 | extern uint32_t __attribute__((overloadable)) |
| 105 | rsAtomicCas(volatile uint32_t* addr, uint32_t compareValue, uint32_t newValue); |
| 106 | #endif |
| 107 | |
| 108 | /* |
| 109 | * rsAtomicDec: Thread-safe decrement |
| 110 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 111 | * Atomicly subtracts one from the value at addr. This is equivalent to rsAtomicSub(addr, 1). |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 112 | * |
| 113 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 114 | * addr: Address of the value to decrement. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 115 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 116 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 117 | */ |
| 118 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 119 | extern int32_t __attribute__((overloadable)) |
| 120 | rsAtomicDec(volatile int32_t* addr); |
| 121 | #endif |
| 122 | |
| 123 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 124 | extern int32_t __attribute__((overloadable)) |
| 125 | rsAtomicDec(volatile uint32_t* addr); |
| 126 | #endif |
| 127 | |
| 128 | /* |
| 129 | * rsAtomicInc: Thread-safe increment |
| 130 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 131 | * Atomicly adds one to the value at addr. This is equivalent to rsAtomicAdd(addr, 1). |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 132 | * |
| 133 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 134 | * addr: Address of the value to increment. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 135 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 136 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 137 | */ |
| 138 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 139 | extern int32_t __attribute__((overloadable)) |
| 140 | rsAtomicInc(volatile int32_t* addr); |
| 141 | #endif |
| 142 | |
| 143 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 144 | extern int32_t __attribute__((overloadable)) |
| 145 | rsAtomicInc(volatile uint32_t* addr); |
| 146 | #endif |
| 147 | |
| 148 | /* |
| 149 | * rsAtomicMax: Thread-safe maximum |
| 150 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 151 | * Atomicly sets the value at addr to the maximum of *addr and value, i.e. |
| 152 | * *addr = max(*addr, value). |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 153 | * |
| 154 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 155 | * addr: Address of the value to modify. |
| 156 | * value: Comparison value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 157 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 158 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 159 | */ |
| 160 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 161 | extern uint32_t __attribute__((overloadable)) |
| 162 | rsAtomicMax(volatile uint32_t* addr, uint32_t value); |
| 163 | #endif |
| 164 | |
| 165 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 166 | extern int32_t __attribute__((overloadable)) |
| 167 | rsAtomicMax(volatile int32_t* addr, int32_t value); |
| 168 | #endif |
| 169 | |
| 170 | /* |
| 171 | * rsAtomicMin: Thread-safe minimum |
| 172 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 173 | * Atomicly sets the value at addr to the minimum of *addr and value, i.e. |
| 174 | * *addr = min(*addr, value). |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 175 | * |
| 176 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 177 | * addr: Address of the value to modify. |
| 178 | * value: Comparison value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 179 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 180 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 181 | */ |
| 182 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 183 | extern uint32_t __attribute__((overloadable)) |
| 184 | rsAtomicMin(volatile uint32_t* addr, uint32_t value); |
| 185 | #endif |
| 186 | |
| 187 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 188 | extern int32_t __attribute__((overloadable)) |
| 189 | rsAtomicMin(volatile int32_t* addr, int32_t value); |
| 190 | #endif |
| 191 | |
| 192 | /* |
| 193 | * rsAtomicOr: Thread-safe bitwise or |
| 194 | * |
| 195 | * Atomicly perform a bitwise or two values, storing the result at addr, |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 196 | * i.e. *addr |= value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 197 | * |
| 198 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 199 | * addr: Address of the value to modify. |
| 200 | * value: Value to or with. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 201 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 202 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 203 | */ |
| 204 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 205 | extern int32_t __attribute__((overloadable)) |
| 206 | rsAtomicOr(volatile int32_t* addr, int32_t value); |
| 207 | #endif |
| 208 | |
| 209 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 210 | extern int32_t __attribute__((overloadable)) |
| 211 | rsAtomicOr(volatile uint32_t* addr, uint32_t value); |
| 212 | #endif |
| 213 | |
| 214 | /* |
| 215 | * rsAtomicSub: Thread-safe subtraction |
| 216 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 217 | * Atomicly subtracts a value from the value at addr, i.e. *addr -= value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 218 | * |
| 219 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 220 | * addr: Address of the value to modify. |
| 221 | * value: Amount to subtract. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 222 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 223 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 224 | */ |
| 225 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 226 | extern int32_t __attribute__((overloadable)) |
| 227 | rsAtomicSub(volatile int32_t* addr, int32_t value); |
| 228 | #endif |
| 229 | |
| 230 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 231 | extern int32_t __attribute__((overloadable)) |
| 232 | rsAtomicSub(volatile uint32_t* addr, uint32_t value); |
| 233 | #endif |
| 234 | |
| 235 | /* |
| 236 | * rsAtomicXor: Thread-safe bitwise exclusive or |
| 237 | * |
| 238 | * Atomicly performs a bitwise xor of two values, storing the result at addr, |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 239 | * i.e. *addr ^= value. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 240 | * |
| 241 | * Parameters: |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 242 | * addr: Address of the value to modify. |
| 243 | * value: Value to xor with. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 244 | * |
Stephen Hines | 3f86823 | 2015-04-10 09:22:19 -0700 | [diff] [blame] | 245 | * Returns: Value of *addr prior to the operation. |
Stephen Hines | b4d9c8b | 2015-03-30 16:04:04 -0700 | [diff] [blame] | 246 | */ |
| 247 | #if (defined(RS_VERSION) && (RS_VERSION >= 14)) |
| 248 | extern int32_t __attribute__((overloadable)) |
| 249 | rsAtomicXor(volatile int32_t* addr, int32_t value); |
| 250 | #endif |
| 251 | |
| 252 | #if (defined(RS_VERSION) && (RS_VERSION >= 20)) |
| 253 | extern int32_t __attribute__((overloadable)) |
| 254 | rsAtomicXor(volatile uint32_t* addr, uint32_t value); |
| 255 | #endif |
| 256 | |
| 257 | #endif // RENDERSCRIPT_RS_ATOMIC_RSH |