Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | */ |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 16 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_UTILS_H_ |
| 18 | #define ART_RUNTIME_UTILS_H_ |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 19 | |
Elliott Hughes | 92b3b56 | 2011-09-08 16:32:26 -0700 | [diff] [blame] | 20 | #include <pthread.h> |
Elliott Hughes | e222ee0 | 2012-12-13 14:41:43 -0800 | [diff] [blame] | 21 | |
Elliott Hughes | 3402380 | 2011-08-30 12:06:17 -0700 | [diff] [blame] | 22 | #include <string> |
| 23 | #include <vector> |
| 24 | |
Elliott Hughes | e222ee0 | 2012-12-13 14:41:43 -0800 | [diff] [blame] | 25 | #include "base/logging.h" |
Elliott Hughes | e222ee0 | 2012-12-13 14:41:43 -0800 | [diff] [blame] | 26 | #include "base/stringprintf.h" |
| 27 | #include "globals.h" |
| 28 | #include "primitive.h" |
| 29 | |
Carl Shapiro | 6b6b5f0 | 2011-06-21 15:05:09 -0700 | [diff] [blame] | 30 | namespace art { |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 31 | |
Ian Rogers | 0571d35 | 2011-11-03 19:51:38 -0700 | [diff] [blame] | 32 | class DexFile; |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 33 | |
| 34 | namespace mirror { |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 35 | class ArtField; |
| 36 | class ArtMethod; |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 37 | class Class; |
Elliott Hughes | 11e4507 | 2011-08-16 17:40:46 -0700 | [diff] [blame] | 38 | class Object; |
Elliott Hughes | 5174fe6 | 2011-08-23 15:12:35 -0700 | [diff] [blame] | 39 | class String; |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 40 | } // namespace mirror |
Elliott Hughes | 11e4507 | 2011-08-16 17:40:46 -0700 | [diff] [blame] | 41 | |
Mathieu Chartier | 0325e62 | 2012-09-05 14:22:51 -0700 | [diff] [blame] | 42 | enum TimeUnit { |
| 43 | kTimeUnitNanosecond, |
| 44 | kTimeUnitMicrosecond, |
| 45 | kTimeUnitMillisecond, |
| 46 | kTimeUnitSecond, |
| 47 | }; |
| 48 | |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 49 | template<typename T> |
| 50 | static inline bool IsPowerOfTwo(T x) { |
| 51 | return (x & (x - 1)) == 0; |
| 52 | } |
| 53 | |
Elliott Hughes | 06b37d9 | 2011-10-16 11:51:29 -0700 | [diff] [blame] | 54 | template<int n, typename T> |
| 55 | static inline bool IsAligned(T x) { |
| 56 | COMPILE_ASSERT((n & (n - 1)) == 0, n_not_power_of_two); |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 57 | return (x & (n - 1)) == 0; |
| 58 | } |
| 59 | |
Elliott Hughes | 06b37d9 | 2011-10-16 11:51:29 -0700 | [diff] [blame] | 60 | template<int n, typename T> |
| 61 | static inline bool IsAligned(T* x) { |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 62 | return IsAligned<n>(reinterpret_cast<const uintptr_t>(x)); |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 63 | } |
| 64 | |
Andreas Gampe | af13ad9 | 2014-04-11 12:07:48 -0700 | [diff] [blame] | 65 | template<typename T> |
| 66 | static inline bool IsAlignedParam(T x, int n) { |
| 67 | return (x & (n - 1)) == 0; |
| 68 | } |
| 69 | |
Elliott Hughes | 06b37d9 | 2011-10-16 11:51:29 -0700 | [diff] [blame] | 70 | #define CHECK_ALIGNED(value, alignment) \ |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 71 | CHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value) |
Elliott Hughes | 06b37d9 | 2011-10-16 11:51:29 -0700 | [diff] [blame] | 72 | |
| 73 | #define DCHECK_ALIGNED(value, alignment) \ |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 74 | DCHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value) |
Elliott Hughes | 06b37d9 | 2011-10-16 11:51:29 -0700 | [diff] [blame] | 75 | |
Andreas Gampe | af13ad9 | 2014-04-11 12:07:48 -0700 | [diff] [blame] | 76 | #define DCHECK_ALIGNED_PARAM(value, alignment) \ |
| 77 | DCHECK(::art::IsAlignedParam(value, alignment)) << reinterpret_cast<const void*>(value) |
| 78 | |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 79 | // Check whether an N-bit two's-complement representation can hold value. |
| 80 | static inline bool IsInt(int N, word value) { |
| 81 | CHECK_LT(0, N); |
| 82 | CHECK_LT(N, kBitsPerWord); |
| 83 | word limit = static_cast<word>(1) << (N - 1); |
| 84 | return (-limit <= value) && (value < limit); |
| 85 | } |
| 86 | |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 87 | static inline bool IsUint(int N, word value) { |
| 88 | CHECK_LT(0, N); |
| 89 | CHECK_LT(N, kBitsPerWord); |
| 90 | word limit = static_cast<word>(1) << N; |
| 91 | return (0 <= value) && (value < limit); |
| 92 | } |
| 93 | |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 94 | static inline bool IsAbsoluteUint(int N, word value) { |
| 95 | CHECK_LT(0, N); |
| 96 | CHECK_LT(N, kBitsPerWord); |
| 97 | if (value < 0) value = -value; |
| 98 | return IsUint(N, value); |
| 99 | } |
| 100 | |
buzbee | 4ef3e45 | 2012-12-14 13:35:28 -0800 | [diff] [blame] | 101 | static inline uint16_t Low16Bits(uint32_t value) { |
| 102 | return static_cast<uint16_t>(value); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 103 | } |
| 104 | |
buzbee | 4ef3e45 | 2012-12-14 13:35:28 -0800 | [diff] [blame] | 105 | static inline uint16_t High16Bits(uint32_t value) { |
| 106 | return static_cast<uint16_t>(value >> 16); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 107 | } |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 108 | |
buzbee | 4ef3e45 | 2012-12-14 13:35:28 -0800 | [diff] [blame] | 109 | static inline uint32_t Low32Bits(uint64_t value) { |
| 110 | return static_cast<uint32_t>(value); |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 111 | } |
| 112 | |
buzbee | 4ef3e45 | 2012-12-14 13:35:28 -0800 | [diff] [blame] | 113 | static inline uint32_t High32Bits(uint64_t value) { |
| 114 | return static_cast<uint32_t>(value >> 32); |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 115 | } |
| 116 | |
Mathieu Chartier | 0a9dc05 | 2013-07-25 11:01:28 -0700 | [diff] [blame] | 117 | // A static if which determines whether to return type A or B based on the condition boolean. |
| 118 | template <const bool condition, typename A, typename B> |
| 119 | struct TypeStaticIf { |
| 120 | typedef A value; |
| 121 | }; |
| 122 | |
| 123 | // Specialization to handle the false case. |
| 124 | template <typename A, typename B> |
| 125 | struct TypeStaticIf<false, A, B> { |
| 126 | typedef B value; |
| 127 | }; |
| 128 | |
Hiroshi Yamauchi | 0941b04 | 2013-11-05 11:34:03 -0800 | [diff] [blame] | 129 | // For rounding integers. |
Carl Shapiro | 61e019d | 2011-07-14 16:53:09 -0700 | [diff] [blame] | 130 | template<typename T> |
| 131 | static inline T RoundDown(T x, int n) { |
Mathieu Chartier | 590fee9 | 2013-09-13 13:46:47 -0700 | [diff] [blame] | 132 | DCHECK(IsPowerOfTwo(n)); |
Carl Shapiro | 61e019d | 2011-07-14 16:53:09 -0700 | [diff] [blame] | 133 | return (x & -n); |
| 134 | } |
| 135 | |
| 136 | template<typename T> |
| 137 | static inline T RoundUp(T x, int n) { |
| 138 | return RoundDown(x + n - 1, n); |
| 139 | } |
| 140 | |
Hiroshi Yamauchi | 0941b04 | 2013-11-05 11:34:03 -0800 | [diff] [blame] | 141 | // For aligning pointers. |
| 142 | template<typename T> |
| 143 | static inline T* AlignDown(T* x, int n) { |
| 144 | CHECK(IsPowerOfTwo(n)); |
| 145 | return reinterpret_cast<T*>(reinterpret_cast<uintptr_t>(x) & -static_cast<uintptr_t>(n)); |
| 146 | } |
| 147 | |
| 148 | template<typename T> |
| 149 | static inline T* AlignUp(T* x, int n) { |
| 150 | return AlignDown(reinterpret_cast<T*>(reinterpret_cast<uintptr_t>(x) + static_cast<uintptr_t>(n - 1)), n); |
| 151 | } |
| 152 | |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 153 | // Implementation is from "Hacker's Delight" by Henry S. Warren, Jr., |
Carl Shapiro | 1fb8620 | 2011-06-27 17:43:13 -0700 | [diff] [blame] | 154 | // figure 3-3, page 48, where the function is called clp2. |
| 155 | static inline uint32_t RoundUpToPowerOfTwo(uint32_t x) { |
| 156 | x = x - 1; |
| 157 | x = x | (x >> 1); |
| 158 | x = x | (x >> 2); |
| 159 | x = x | (x >> 4); |
| 160 | x = x | (x >> 8); |
| 161 | x = x | (x >> 16); |
| 162 | return x + 1; |
| 163 | } |
| 164 | |
| 165 | // Implementation is from "Hacker's Delight" by Henry S. Warren, Jr., |
Carl Shapiro | a2e18e1 | 2011-06-21 18:57:55 -0700 | [diff] [blame] | 166 | // figure 5-2, page 66, where the function is called pop. |
| 167 | static inline int CountOneBits(uint32_t x) { |
| 168 | x = x - ((x >> 1) & 0x55555555); |
| 169 | x = (x & 0x33333333) + ((x >> 2) & 0x33333333); |
| 170 | x = (x + (x >> 4)) & 0x0F0F0F0F; |
| 171 | x = x + (x >> 8); |
| 172 | x = x + (x >> 16); |
| 173 | return static_cast<int>(x & 0x0000003F); |
| 174 | } |
| 175 | |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 176 | template<typename T> |
| 177 | static inline int CLZ(T x) { |
| 178 | if (sizeof(T) == sizeof(uint32_t)) { |
| 179 | return __builtin_clz(x); |
| 180 | } else { |
| 181 | return __builtin_clzll(x); |
| 182 | } |
| 183 | } |
| 184 | |
| 185 | template<typename T> |
| 186 | static inline int CTZ(T x) { |
| 187 | if (sizeof(T) == sizeof(uint32_t)) { |
| 188 | return __builtin_ctz(x); |
| 189 | } else { |
| 190 | return __builtin_ctzll(x); |
| 191 | } |
| 192 | } |
| 193 | |
| 194 | static inline uint32_t PointerToLowMemUInt32(const void* p) { |
| 195 | uintptr_t intp = reinterpret_cast<uintptr_t>(p); |
| 196 | DCHECK_LE(intp, 0xFFFFFFFFU); |
| 197 | return intp & 0xFFFFFFFFU; |
| 198 | } |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 199 | |
Elliott Hughes | 46b92ba | 2011-08-12 17:57:34 -0700 | [diff] [blame] | 200 | static inline bool NeedsEscaping(uint16_t ch) { |
| 201 | return (ch < ' ' || ch > '~'); |
| 202 | } |
| 203 | |
Elliott Hughes | c7ac37f | 2011-08-12 12:21:58 -0700 | [diff] [blame] | 204 | static inline std::string PrintableChar(uint16_t ch) { |
| 205 | std::string result; |
Elliott Hughes | 46b92ba | 2011-08-12 17:57:34 -0700 | [diff] [blame] | 206 | result += '\''; |
| 207 | if (NeedsEscaping(ch)) { |
| 208 | StringAppendF(&result, "\\u%04x", ch); |
| 209 | } else { |
Elliott Hughes | c7ac37f | 2011-08-12 12:21:58 -0700 | [diff] [blame] | 210 | result += ch; |
Elliott Hughes | c7ac37f | 2011-08-12 12:21:58 -0700 | [diff] [blame] | 211 | } |
Elliott Hughes | 46b92ba | 2011-08-12 17:57:34 -0700 | [diff] [blame] | 212 | result += '\''; |
Elliott Hughes | c7ac37f | 2011-08-12 12:21:58 -0700 | [diff] [blame] | 213 | return result; |
| 214 | } |
| 215 | |
Elliott Hughes | 82914b6 | 2012-04-09 15:56:29 -0700 | [diff] [blame] | 216 | // Returns an ASCII string corresponding to the given UTF-8 string. |
| 217 | // Java escapes are used for non-ASCII characters. |
| 218 | std::string PrintableString(const std::string& utf8); |
Elliott Hughes | c7ac37f | 2011-08-12 12:21:58 -0700 | [diff] [blame] | 219 | |
Elliott Hughes | f1a5adc | 2012-02-10 18:09:35 -0800 | [diff] [blame] | 220 | // Tests whether 's' starts with 'prefix'. |
| 221 | bool StartsWith(const std::string& s, const char* prefix); |
| 222 | |
Brian Carlstrom | 7a967b3 | 2012-03-28 15:23:10 -0700 | [diff] [blame] | 223 | // Tests whether 's' starts with 'suffix'. |
| 224 | bool EndsWith(const std::string& s, const char* suffix); |
| 225 | |
Elliott Hughes | 54e7df1 | 2011-09-16 11:47:04 -0700 | [diff] [blame] | 226 | // Used to implement PrettyClass, PrettyField, PrettyMethod, and PrettyTypeOf, |
| 227 | // one of which is probably more useful to you. |
Elliott Hughes | a0b8feb | 2011-08-20 09:50:55 -0700 | [diff] [blame] | 228 | // Returns a human-readable equivalent of 'descriptor'. So "I" would be "int", |
| 229 | // "[[I" would be "int[][]", "[Ljava/lang/String;" would be |
| 230 | // "java.lang.String[]", and so forth. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 231 | std::string PrettyDescriptor(mirror::String* descriptor) |
| 232 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 6c8867d | 2011-10-03 16:34:05 -0700 | [diff] [blame] | 233 | std::string PrettyDescriptor(const std::string& descriptor); |
Brian Carlstrom | 6b4ef02 | 2011-10-23 14:59:04 -0700 | [diff] [blame] | 234 | std::string PrettyDescriptor(Primitive::Type type); |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 235 | std::string PrettyDescriptor(mirror::Class* klass) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 236 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 11e4507 | 2011-08-16 17:40:46 -0700 | [diff] [blame] | 237 | |
Elliott Hughes | 54e7df1 | 2011-09-16 11:47:04 -0700 | [diff] [blame] | 238 | // Returns a human-readable signature for 'f'. Something like "a.b.C.f" or |
| 239 | // "int a.b.C.f" (depending on the value of 'with_type'). |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 240 | std::string PrettyField(mirror::ArtField* f, bool with_type = true) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 241 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | 6f29d0e | 2012-05-11 15:50:29 -0700 | [diff] [blame] | 242 | std::string PrettyField(uint32_t field_idx, const DexFile& dex_file, bool with_type = true); |
Elliott Hughes | a250199 | 2011-08-26 19:39:54 -0700 | [diff] [blame] | 243 | |
Elliott Hughes | a0b8feb | 2011-08-20 09:50:55 -0700 | [diff] [blame] | 244 | // Returns a human-readable signature for 'm'. Something like "a.b.C.m" or |
| 245 | // "a.b.C.m(II)V" (depending on the value of 'with_signature'). |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 246 | std::string PrettyMethod(mirror::ArtMethod* m, bool with_signature = true) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 247 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 0571d35 | 2011-11-03 19:51:38 -0700 | [diff] [blame] | 248 | std::string PrettyMethod(uint32_t method_idx, const DexFile& dex_file, bool with_signature = true); |
Elliott Hughes | a0b8feb | 2011-08-20 09:50:55 -0700 | [diff] [blame] | 249 | |
| 250 | // Returns a human-readable form of the name of the *class* of the given object. |
| 251 | // So given an instance of java.lang.String, the output would |
Elliott Hughes | 11e4507 | 2011-08-16 17:40:46 -0700 | [diff] [blame] | 252 | // be "java.lang.String". Given an array of int, the output would be "int[]". |
| 253 | // Given String.class, the output would be "java.lang.Class<java.lang.String>". |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 254 | std::string PrettyTypeOf(mirror::Object* obj) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 255 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 4c70d77 | 2012-09-10 14:08:32 -0700 | [diff] [blame] | 256 | |
| 257 | // Returns a human-readable form of the type at an index in the specified dex file. |
| 258 | // Example outputs: char[], java.lang.String. |
Mathieu Chartier | 18c24b6 | 2012-09-10 08:54:25 -0700 | [diff] [blame] | 259 | std::string PrettyType(uint32_t type_idx, const DexFile& dex_file); |
Elliott Hughes | 54e7df1 | 2011-09-16 11:47:04 -0700 | [diff] [blame] | 260 | |
| 261 | // Returns a human-readable form of the name of the given class. |
| 262 | // Given String.class, the output would be "java.lang.Class<java.lang.String>". |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 263 | std::string PrettyClass(mirror::Class* c) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 264 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 11e4507 | 2011-08-16 17:40:46 -0700 | [diff] [blame] | 265 | |
Ian Rogers | d81871c | 2011-10-03 13:57:23 -0700 | [diff] [blame] | 266 | // Returns a human-readable form of the name of the given class with its class loader. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 267 | std::string PrettyClassAndClassLoader(mirror::Class* c) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 268 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | d81871c | 2011-10-03 13:57:23 -0700 | [diff] [blame] | 269 | |
Elliott Hughes | c967f78 | 2012-04-16 10:23:15 -0700 | [diff] [blame] | 270 | // Returns a human-readable size string such as "1MB". |
Mathieu Chartier | e6da9af | 2013-12-16 11:54:42 -0800 | [diff] [blame] | 271 | std::string PrettySize(int64_t size_in_bytes); |
Ian Rogers | 3bb17a6 | 2012-01-27 23:56:44 -0800 | [diff] [blame] | 272 | |
| 273 | // Returns a human-readable time string which prints every nanosecond while trying to limit the |
| 274 | // number of trailing zeros. Prints using the largest human readable unit up to a second. |
| 275 | // e.g. "1ms", "1.000000001s", "1.001us" |
| 276 | std::string PrettyDuration(uint64_t nano_duration); |
| 277 | |
Mathieu Chartier | 0325e62 | 2012-09-05 14:22:51 -0700 | [diff] [blame] | 278 | // Format a nanosecond time to specified units. |
| 279 | std::string FormatDuration(uint64_t nano_duration, TimeUnit time_unit); |
| 280 | |
| 281 | // Get the appropriate unit for a nanosecond duration. |
| 282 | TimeUnit GetAppropriateTimeUnit(uint64_t nano_duration); |
| 283 | |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 284 | // Get the divisor to convert from a nanoseconds to a time unit. |
Mathieu Chartier | 0325e62 | 2012-09-05 14:22:51 -0700 | [diff] [blame] | 285 | uint64_t GetNsToTimeUnitDivisor(TimeUnit time_unit); |
| 286 | |
Elliott Hughes | 79082e3 | 2011-08-25 12:07:32 -0700 | [diff] [blame] | 287 | // Performs JNI name mangling as described in section 11.3 "Linking Native Methods" |
| 288 | // of the JNI spec. |
| 289 | std::string MangleForJni(const std::string& s); |
| 290 | |
Brian Carlstrom | f91c8c3 | 2011-09-21 17:30:34 -0700 | [diff] [blame] | 291 | // Turn "java.lang.String" into "Ljava/lang/String;". |
| 292 | std::string DotToDescriptor(const char* class_name); |
| 293 | |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 294 | // Turn "Ljava/lang/String;" into "java.lang.String". |
Elliott Hughes | f1a5adc | 2012-02-10 18:09:35 -0800 | [diff] [blame] | 295 | std::string DescriptorToDot(const char* descriptor); |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 296 | |
Elliott Hughes | 91bf6cd | 2012-02-14 17:27:48 -0800 | [diff] [blame] | 297 | // Turn "Ljava/lang/String;" into "java/lang/String". |
| 298 | std::string DescriptorToName(const char* descriptor); |
| 299 | |
Elliott Hughes | 906e685 | 2011-10-28 14:52:10 -0700 | [diff] [blame] | 300 | // Tests for whether 's' is a valid class name in the three common forms: |
| 301 | bool IsValidBinaryClassName(const char* s); // "java.lang.String" |
| 302 | bool IsValidJniClassName(const char* s); // "java/lang/String" |
| 303 | bool IsValidDescriptor(const char* s); // "Ljava/lang/String;" |
Elliott Hughes | 64bf5a3 | 2011-09-20 14:43:12 -0700 | [diff] [blame] | 304 | |
jeffhao | 10037c8 | 2012-01-23 15:06:23 -0800 | [diff] [blame] | 305 | // Returns whether the given string is a valid field or method name, |
| 306 | // additionally allowing names that begin with '<' and end with '>'. |
| 307 | bool IsValidMemberName(const char* s); |
| 308 | |
Elliott Hughes | 79082e3 | 2011-08-25 12:07:32 -0700 | [diff] [blame] | 309 | // Returns the JNI native function name for the non-overloaded method 'm'. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 310 | std::string JniShortName(mirror::ArtMethod* m) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 311 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 79082e3 | 2011-08-25 12:07:32 -0700 | [diff] [blame] | 312 | // Returns the JNI native function name for the overloaded method 'm'. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 313 | std::string JniLongName(mirror::ArtMethod* m) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 314 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 79082e3 | 2011-08-25 12:07:32 -0700 | [diff] [blame] | 315 | |
Elliott Hughes | d92bec4 | 2011-09-02 17:04:36 -0700 | [diff] [blame] | 316 | bool ReadFileToString(const std::string& file_name, std::string* result); |
buzbee | c143c55 | 2011-08-20 17:38:58 -0700 | [diff] [blame] | 317 | |
Elliott Hughes | e27955c | 2011-08-26 15:21:24 -0700 | [diff] [blame] | 318 | // Returns the current date in ISO yyyy-mm-dd hh:mm:ss format. |
| 319 | std::string GetIsoDate(); |
| 320 | |
Elliott Hughes | 0512f02 | 2012-03-15 22:10:52 -0700 | [diff] [blame] | 321 | // Returns the monotonic time since some unspecified starting point in milliseconds. |
Elliott Hughes | 7162ad9 | 2011-10-27 14:08:42 -0700 | [diff] [blame] | 322 | uint64_t MilliTime(); |
| 323 | |
Elliott Hughes | 0512f02 | 2012-03-15 22:10:52 -0700 | [diff] [blame] | 324 | // Returns the monotonic time since some unspecified starting point in microseconds. |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 325 | uint64_t MicroTime(); |
| 326 | |
Elliott Hughes | 0512f02 | 2012-03-15 22:10:52 -0700 | [diff] [blame] | 327 | // Returns the monotonic time since some unspecified starting point in nanoseconds. |
Elliott Hughes | 83df2ac | 2011-10-11 16:37:54 -0700 | [diff] [blame] | 328 | uint64_t NanoTime(); |
| 329 | |
Elliott Hughes | 0512f02 | 2012-03-15 22:10:52 -0700 | [diff] [blame] | 330 | // Returns the thread-specific CPU-time clock in nanoseconds or -1 if unavailable. |
| 331 | uint64_t ThreadCpuNanoTime(); |
| 332 | |
Elliott Hughes | bb551fa | 2012-01-25 16:35:29 -0800 | [diff] [blame] | 333 | // Converts the given number of nanoseconds to milliseconds. |
Mathieu Chartier | 720ef76 | 2013-08-17 14:46:54 -0700 | [diff] [blame] | 334 | static constexpr inline uint64_t NsToMs(uint64_t ns) { |
Ian Rogers | 3bb17a6 | 2012-01-27 23:56:44 -0800 | [diff] [blame] | 335 | return ns / 1000 / 1000; |
| 336 | } |
| 337 | |
| 338 | // Converts the given number of milliseconds to nanoseconds |
Mathieu Chartier | 720ef76 | 2013-08-17 14:46:54 -0700 | [diff] [blame] | 339 | static constexpr inline uint64_t MsToNs(uint64_t ns) { |
Ian Rogers | 3bb17a6 | 2012-01-27 23:56:44 -0800 | [diff] [blame] | 340 | return ns * 1000 * 1000; |
| 341 | } |
| 342 | |
Brian Carlstrom | bcc2926 | 2012-11-02 11:36:03 -0700 | [diff] [blame] | 343 | #if defined(__APPLE__) |
| 344 | // No clocks to specify on OS/X, fake value to pass to routines that require a clock. |
| 345 | #define CLOCK_REALTIME 0xebadf00d |
| 346 | #endif |
| 347 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 348 | // Sleep for the given number of nanoseconds, a bad way to handle contention. |
| 349 | void NanoSleep(uint64_t ns); |
| 350 | |
Brian Carlstrom | bcc2926 | 2012-11-02 11:36:03 -0700 | [diff] [blame] | 351 | // Initialize a timespec to either an absolute or relative time. |
| 352 | void InitTimeSpec(bool absolute, int clock, int64_t ms, int32_t ns, timespec* ts); |
| 353 | |
Elliott Hughes | 48436bb | 2012-02-07 15:23:28 -0800 | [diff] [blame] | 354 | // Splits a string using the given separator character into a vector of |
Elliott Hughes | 3402380 | 2011-08-30 12:06:17 -0700 | [diff] [blame] | 355 | // strings. Empty strings will be omitted. |
Elliott Hughes | 48436bb | 2012-02-07 15:23:28 -0800 | [diff] [blame] | 356 | void Split(const std::string& s, char separator, std::vector<std::string>& result); |
| 357 | |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 358 | // Trims whitespace off both ends of the given string. |
| 359 | std::string Trim(std::string s); |
| 360 | |
Elliott Hughes | 48436bb | 2012-02-07 15:23:28 -0800 | [diff] [blame] | 361 | // Joins a vector of strings into a single string, using the given separator. |
| 362 | template <typename StringT> std::string Join(std::vector<StringT>& strings, char separator); |
Elliott Hughes | 3402380 | 2011-08-30 12:06:17 -0700 | [diff] [blame] | 363 | |
Elliott Hughes | 42ee142 | 2011-09-06 12:33:32 -0700 | [diff] [blame] | 364 | // Returns the calling thread's tid. (The C libraries don't expose this.) |
| 365 | pid_t GetTid(); |
| 366 | |
Elliott Hughes | 289be85 | 2012-06-12 13:57:20 -0700 | [diff] [blame] | 367 | // Returns the given thread's name. |
| 368 | std::string GetThreadName(pid_t tid); |
| 369 | |
Ian Rogers | 120f1c7 | 2012-09-28 17:17:10 -0700 | [diff] [blame] | 370 | // Returns details of the given thread's stack. |
Brian Carlstrom | 2921201 | 2013-09-12 22:18:30 -0700 | [diff] [blame] | 371 | void GetThreadStack(pthread_t thread, void** stack_base, size_t* stack_size); |
Elliott Hughes | e188419 | 2012-04-23 12:38:15 -0700 | [diff] [blame] | 372 | |
Elliott Hughes | bfe487b | 2011-10-26 15:48:55 -0700 | [diff] [blame] | 373 | // Reads data from "/proc/self/task/${tid}/stat". |
Brian Carlstrom | 2921201 | 2013-09-12 22:18:30 -0700 | [diff] [blame] | 374 | void GetTaskStats(pid_t tid, char* state, int* utime, int* stime, int* task_cpu); |
Elliott Hughes | bfe487b | 2011-10-26 15:48:55 -0700 | [diff] [blame] | 375 | |
Elliott Hughes | 1bac54f | 2012-03-16 12:48:31 -0700 | [diff] [blame] | 376 | // Returns the name of the scheduler group for the given thread the current process, or the empty string. |
| 377 | std::string GetSchedulerGroupName(pid_t tid); |
| 378 | |
Elliott Hughes | dcc2474 | 2011-09-07 14:02:44 -0700 | [diff] [blame] | 379 | // Sets the name of the current thread. The name may be truncated to an |
| 380 | // implementation-defined limit. |
Elliott Hughes | 22869a9 | 2012-03-27 14:08:24 -0700 | [diff] [blame] | 381 | void SetThreadName(const char* thread_name); |
Elliott Hughes | dcc2474 | 2011-09-07 14:02:44 -0700 | [diff] [blame] | 382 | |
Elliott Hughes | 46e251b | 2012-05-22 15:10:45 -0700 | [diff] [blame] | 383 | // Dumps the native stack for thread 'tid' to 'os'. |
Kenny Root | 067d20f | 2014-03-05 14:57:21 -0800 | [diff] [blame] | 384 | void DumpNativeStack(std::ostream& os, pid_t tid, const char* prefix = "", |
Christopher Ferris | a2cee18 | 2014-04-16 19:13:59 -0700 | [diff] [blame^] | 385 | mirror::ArtMethod* current_method = nullptr) |
Kenny Root | 067d20f | 2014-03-05 14:57:21 -0800 | [diff] [blame] | 386 | NO_THREAD_SAFETY_ANALYSIS; |
Elliott Hughes | 46e251b | 2012-05-22 15:10:45 -0700 | [diff] [blame] | 387 | |
| 388 | // Dumps the kernel stack for thread 'tid' to 'os'. Note that this is only available on linux-x86. |
| 389 | void DumpKernelStack(std::ostream& os, pid_t tid, const char* prefix = "", bool include_count = true); |
| 390 | |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 391 | // Find $ANDROID_ROOT, /system, or abort. |
Brian Carlstrom | a56fcd6 | 2012-02-04 21:23:01 -0800 | [diff] [blame] | 392 | const char* GetAndroidRoot(); |
| 393 | |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 394 | // Find $ANDROID_DATA, /data, or abort. |
Brian Carlstrom | a56fcd6 | 2012-02-04 21:23:01 -0800 | [diff] [blame] | 395 | const char* GetAndroidData(); |
| 396 | |
Brian Carlstrom | 7675e16 | 2013-06-10 16:18:04 -0700 | [diff] [blame] | 397 | // Returns the dalvik-cache location, or dies trying. |
| 398 | std::string GetDalvikCacheOrDie(const char* android_data); |
Brian Carlstrom | a9f1978 | 2011-10-13 00:14:47 -0700 | [diff] [blame] | 399 | |
Brian Carlstrom | 7675e16 | 2013-06-10 16:18:04 -0700 | [diff] [blame] | 400 | // Returns the dalvik-cache location for a DexFile or OatFile, or dies trying. |
Ian Rogers | 8d31bbd | 2013-10-13 10:44:14 -0700 | [diff] [blame] | 401 | std::string GetDalvikCacheFilenameOrDie(const char* location); |
jeffhao | 262bf46 | 2011-10-20 18:36:32 -0700 | [diff] [blame] | 402 | |
Brian Carlstrom | 7c3d13a | 2013-09-04 17:15:11 -0700 | [diff] [blame] | 403 | // Check whether the given magic matches a known file type. |
| 404 | bool IsZipMagic(uint32_t magic); |
| 405 | bool IsDexMagic(uint32_t magic); |
| 406 | bool IsOatMagic(uint32_t magic); |
Brian Carlstrom | b7bbba4 | 2011-10-13 14:58:47 -0700 | [diff] [blame] | 407 | |
Brian Carlstrom | 6449c62 | 2014-02-10 23:48:36 -0800 | [diff] [blame] | 408 | // Wrapper on fork/execv to run a command in a subprocess. |
| 409 | bool Exec(std::vector<std::string>& arg_vector, std::string* error_msg); |
| 410 | |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 411 | class VoidFunctor { |
Mathieu Chartier | 357e9be | 2012-08-01 11:00:14 -0700 | [diff] [blame] | 412 | public: |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 413 | template <typename A> |
Brian Carlstrom | df62950 | 2013-07-17 22:39:56 -0700 | [diff] [blame] | 414 | inline void operator() (A a) const { |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 415 | UNUSED(a); |
| 416 | } |
| 417 | |
| 418 | template <typename A, typename B> |
Brian Carlstrom | df62950 | 2013-07-17 22:39:56 -0700 | [diff] [blame] | 419 | inline void operator() (A a, B b) const { |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 420 | UNUSED(a); |
| 421 | UNUSED(b); |
| 422 | } |
| 423 | |
| 424 | template <typename A, typename B, typename C> |
Brian Carlstrom | df62950 | 2013-07-17 22:39:56 -0700 | [diff] [blame] | 425 | inline void operator() (A a, B b, C c) const { |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 426 | UNUSED(a); |
| 427 | UNUSED(b); |
| 428 | UNUSED(c); |
| 429 | } |
Mathieu Chartier | 357e9be | 2012-08-01 11:00:14 -0700 | [diff] [blame] | 430 | }; |
| 431 | |
Carl Shapiro | 6b6b5f0 | 2011-06-21 15:05:09 -0700 | [diff] [blame] | 432 | } // namespace art |
Carl Shapiro | a5d5cfd | 2011-06-21 12:46:59 -0700 | [diff] [blame] | 433 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 434 | #endif // ART_RUNTIME_UTILS_H_ |