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