blob: 73872d31d93e0b397c95dc39f7ff9d7d8623a525 [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
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 Shapiroa5d5cfd2011-06-21 12:46:59 -070016
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_UTILS_H_
18#define ART_RUNTIME_UTILS_H_
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070019
Elliott Hughes92b3b562011-09-08 16:32:26 -070020#include <pthread.h>
Elliott Hughese222ee02012-12-13 14:41:43 -080021
Alex Light53cb16b2014-06-12 11:26:29 -070022#include <limits>
Elliott Hughes34023802011-08-30 12:06:17 -070023#include <string>
24#include <vector>
25
Elliott Hughese222ee02012-12-13 14:41:43 -080026#include "base/logging.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080027#include "globals.h"
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -070028#include "instruction_set.h"
Ian Rogerse63db272014-07-15 15:36:11 -070029#include "base/mutex.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080030
Calin Juravlebb0b53f2014-05-23 17:33:29 +010031#ifdef HAVE_ANDROID_OS
32#include "cutils/properties.h"
33#endif
34
Carl Shapiro6b6b5f02011-06-21 15:05:09 -070035namespace art {
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070036
Ian Rogers0571d352011-11-03 19:51:38 -070037class DexFile;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080038
39namespace mirror {
Brian Carlstromea46f952013-07-30 01:26:50 -070040class ArtField;
41class ArtMethod;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080042class Class;
Elliott Hughes11e45072011-08-16 17:40:46 -070043class Object;
Elliott Hughes5174fe62011-08-23 15:12:35 -070044class String;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080045} // namespace mirror
Elliott Hughes11e45072011-08-16 17:40:46 -070046
Mathieu Chartier0325e622012-09-05 14:22:51 -070047enum TimeUnit {
48 kTimeUnitNanosecond,
49 kTimeUnitMicrosecond,
50 kTimeUnitMillisecond,
51 kTimeUnitSecond,
52};
53
Alex Light53cb16b2014-06-12 11:26:29 -070054template <typename T>
55bool ParseUint(const char *in, T* out) {
56 char* end;
57 unsigned long long int result = strtoull(in, &end, 0); // NOLINT(runtime/int)
58 if (in == end || *end != '\0') {
59 return false;
60 }
61 if (std::numeric_limits<T>::max() < result) {
62 return false;
63 }
64 *out = static_cast<T>(result);
65 return true;
66}
67
68template <typename T>
69bool ParseInt(const char* in, T* out) {
70 char* end;
71 long long int result = strtoll(in, &end, 0); // NOLINT(runtime/int)
72 if (in == end || *end != '\0') {
73 return false;
74 }
75 if (result < std::numeric_limits<T>::min() || std::numeric_limits<T>::max() < result) {
76 return false;
77 }
78 *out = static_cast<T>(result);
79 return true;
80}
81
Carl Shapiroa2e18e12011-06-21 18:57:55 -070082template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +010083static constexpr bool IsPowerOfTwo(T x) {
Carl Shapiroa2e18e12011-06-21 18:57:55 -070084 return (x & (x - 1)) == 0;
85}
86
Elliott Hughes06b37d92011-10-16 11:51:29 -070087template<int n, typename T>
88static inline bool IsAligned(T x) {
89 COMPILE_ASSERT((n & (n - 1)) == 0, n_not_power_of_two);
Carl Shapiroa2e18e12011-06-21 18:57:55 -070090 return (x & (n - 1)) == 0;
91}
92
Elliott Hughes06b37d92011-10-16 11:51:29 -070093template<int n, typename T>
94static inline bool IsAligned(T* x) {
Brian Carlstrom89521892011-12-07 22:05:07 -080095 return IsAligned<n>(reinterpret_cast<const uintptr_t>(x));
Carl Shapiroa2e18e12011-06-21 18:57:55 -070096}
97
Andreas Gampeaf13ad92014-04-11 12:07:48 -070098template<typename T>
99static inline bool IsAlignedParam(T x, int n) {
100 return (x & (n - 1)) == 0;
101}
102
Elliott Hughes06b37d92011-10-16 11:51:29 -0700103#define CHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -0800104 CHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -0700105
106#define DCHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -0800107 DCHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -0700108
Andreas Gampeaf13ad92014-04-11 12:07:48 -0700109#define DCHECK_ALIGNED_PARAM(value, alignment) \
110 DCHECK(::art::IsAlignedParam(value, alignment)) << reinterpret_cast<const void*>(value)
111
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700112// Check whether an N-bit two's-complement representation can hold value.
113static inline bool IsInt(int N, word value) {
114 CHECK_LT(0, N);
115 CHECK_LT(N, kBitsPerWord);
116 word limit = static_cast<word>(1) << (N - 1);
117 return (-limit <= value) && (value < limit);
118}
119
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700120static inline bool IsUint(int N, word value) {
121 CHECK_LT(0, N);
122 CHECK_LT(N, kBitsPerWord);
123 word limit = static_cast<word>(1) << N;
124 return (0 <= value) && (value < limit);
125}
126
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700127static inline bool IsAbsoluteUint(int N, word value) {
128 CHECK_LT(0, N);
129 CHECK_LT(N, kBitsPerWord);
130 if (value < 0) value = -value;
131 return IsUint(N, value);
132}
133
buzbee4ef3e452012-12-14 13:35:28 -0800134static inline uint16_t Low16Bits(uint32_t value) {
135 return static_cast<uint16_t>(value);
Ian Rogersb033c752011-07-20 12:22:35 -0700136}
137
buzbee4ef3e452012-12-14 13:35:28 -0800138static inline uint16_t High16Bits(uint32_t value) {
139 return static_cast<uint16_t>(value >> 16);
Ian Rogersb033c752011-07-20 12:22:35 -0700140}
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700141
buzbee4ef3e452012-12-14 13:35:28 -0800142static inline uint32_t Low32Bits(uint64_t value) {
143 return static_cast<uint32_t>(value);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700144}
145
buzbee4ef3e452012-12-14 13:35:28 -0800146static inline uint32_t High32Bits(uint64_t value) {
147 return static_cast<uint32_t>(value >> 32);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700148}
149
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700150// A static if which determines whether to return type A or B based on the condition boolean.
Vladimir Marko81949632014-05-02 11:53:22 +0100151template <bool condition, typename A, typename B>
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700152struct TypeStaticIf {
Vladimir Marko81949632014-05-02 11:53:22 +0100153 typedef A type;
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700154};
155
156// Specialization to handle the false case.
157template <typename A, typename B>
158struct TypeStaticIf<false, A, B> {
Vladimir Marko81949632014-05-02 11:53:22 +0100159 typedef B type;
160};
161
162// Type identity.
163template <typename T>
164struct TypeIdentity {
165 typedef T type;
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700166};
167
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800168// For rounding integers.
Carl Shapiro61e019d2011-07-14 16:53:09 -0700169template<typename T>
Mathieu Chartier4c13a3f2014-07-14 14:57:16 -0700170static constexpr T RoundDown(T x, typename TypeIdentity<T>::type n) WARN_UNUSED;
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700171
172template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100173static constexpr T RoundDown(T x, typename TypeIdentity<T>::type n) {
174 return
Vladimir Marko83642482014-06-11 12:12:07 +0100175 DCHECK_CONSTEXPR(IsPowerOfTwo(n), , T(0))
176 (x & -n);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700177}
178
179template<typename T>
Mathieu Chartier4c13a3f2014-07-14 14:57:16 -0700180static constexpr T RoundUp(T x, typename TypeIdentity<T>::type n) WARN_UNUSED;
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700181
182template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100183static constexpr T RoundUp(T x, typename TypeIdentity<T>::type n) {
Carl Shapiro61e019d2011-07-14 16:53:09 -0700184 return RoundDown(x + n - 1, n);
185}
186
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800187// For aligning pointers.
188template<typename T>
Mathieu Chartier4c13a3f2014-07-14 14:57:16 -0700189static inline T* AlignDown(T* x, uintptr_t n) WARN_UNUSED;
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700190
191template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100192static inline T* AlignDown(T* x, uintptr_t n) {
193 return reinterpret_cast<T*>(RoundDown(reinterpret_cast<uintptr_t>(x), n));
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800194}
195
196template<typename T>
Mathieu Chartier4c13a3f2014-07-14 14:57:16 -0700197static inline T* AlignUp(T* x, uintptr_t n) WARN_UNUSED;
Mingyao Yang98d1cc82014-05-15 17:02:16 -0700198
199template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100200static inline T* AlignUp(T* x, uintptr_t n) {
201 return reinterpret_cast<T*>(RoundUp(reinterpret_cast<uintptr_t>(x), n));
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800202}
203
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700204// Implementation is from "Hacker's Delight" by Henry S. Warren, Jr.,
Carl Shapiro1fb86202011-06-27 17:43:13 -0700205// figure 3-3, page 48, where the function is called clp2.
206static inline uint32_t RoundUpToPowerOfTwo(uint32_t x) {
207 x = x - 1;
208 x = x | (x >> 1);
209 x = x | (x >> 2);
210 x = x | (x >> 4);
211 x = x | (x >> 8);
212 x = x | (x >> 16);
213 return x + 1;
214}
215
Vladimir Marko81949632014-05-02 11:53:22 +0100216template<typename T>
217static constexpr int CLZ(T x) {
218 return (sizeof(T) == sizeof(uint32_t))
219 ? __builtin_clz(x)
220 : __builtin_clzll(x);
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700221}
222
Ian Rogersef7d42f2014-01-06 12:55:46 -0800223template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100224static constexpr int CTZ(T x) {
225 return (sizeof(T) == sizeof(uint32_t))
226 ? __builtin_ctz(x)
227 : __builtin_ctzll(x);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800228}
229
230template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100231static constexpr int POPCOUNT(T x) {
232 return (sizeof(T) == sizeof(uint32_t))
233 ? __builtin_popcount(x)
234 : __builtin_popcountll(x);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800235}
236
237static inline uint32_t PointerToLowMemUInt32(const void* p) {
238 uintptr_t intp = reinterpret_cast<uintptr_t>(p);
239 DCHECK_LE(intp, 0xFFFFFFFFU);
240 return intp & 0xFFFFFFFFU;
241}
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700242
Elliott Hughes46b92ba2011-08-12 17:57:34 -0700243static inline bool NeedsEscaping(uint16_t ch) {
244 return (ch < ' ' || ch > '~');
245}
246
Andreas Gampec200a4a2014-06-16 18:39:09 -0700247// Interpret the bit pattern of input (type U) as type V. Requires the size
248// of V >= size of U (compile-time checked).
249template<typename U, typename V>
250static inline V bit_cast(U in) {
251 COMPILE_ASSERT(sizeof(U) <= sizeof(V), size_of_u_not_le_size_of_v);
252 union {
253 U u;
254 V v;
255 } tmp;
256 tmp.u = in;
257 return tmp.v;
258}
259
Ian Rogers576ca0c2014-06-06 15:58:22 -0700260std::string PrintableChar(uint16_t ch);
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700261
Elliott Hughes82914b62012-04-09 15:56:29 -0700262// Returns an ASCII string corresponding to the given UTF-8 string.
263// Java escapes are used for non-ASCII characters.
264std::string PrintableString(const std::string& utf8);
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700265
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800266// Tests whether 's' starts with 'prefix'.
267bool StartsWith(const std::string& s, const char* prefix);
268
Brian Carlstrom7a967b32012-03-28 15:23:10 -0700269// Tests whether 's' starts with 'suffix'.
270bool EndsWith(const std::string& s, const char* suffix);
271
Elliott Hughes54e7df12011-09-16 11:47:04 -0700272// Used to implement PrettyClass, PrettyField, PrettyMethod, and PrettyTypeOf,
273// one of which is probably more useful to you.
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700274// Returns a human-readable equivalent of 'descriptor'. So "I" would be "int",
275// "[[I" would be "int[][]", "[Ljava/lang/String;" would be
276// "java.lang.String[]", and so forth.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800277std::string PrettyDescriptor(mirror::String* descriptor)
278 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes6c8867d2011-10-03 16:34:05 -0700279std::string PrettyDescriptor(const std::string& descriptor);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800280std::string PrettyDescriptor(mirror::Class* klass)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700281 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700282
Elliott Hughes54e7df12011-09-16 11:47:04 -0700283// Returns a human-readable signature for 'f'. Something like "a.b.C.f" or
284// "int a.b.C.f" (depending on the value of 'with_type').
Ian Rogersef7d42f2014-01-06 12:55:46 -0800285std::string PrettyField(mirror::ArtField* f, bool with_type = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700286 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstrom6f29d0e2012-05-11 15:50:29 -0700287std::string PrettyField(uint32_t field_idx, const DexFile& dex_file, bool with_type = true);
Elliott Hughesa2501992011-08-26 19:39:54 -0700288
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700289// Returns a human-readable signature for 'm'. Something like "a.b.C.m" or
290// "a.b.C.m(II)V" (depending on the value of 'with_signature').
Ian Rogersef7d42f2014-01-06 12:55:46 -0800291std::string PrettyMethod(mirror::ArtMethod* m, bool with_signature = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700292 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers0571d352011-11-03 19:51:38 -0700293std::string PrettyMethod(uint32_t method_idx, const DexFile& dex_file, bool with_signature = true);
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700294
295// Returns a human-readable form of the name of the *class* of the given object.
296// So given an instance of java.lang.String, the output would
Elliott Hughes11e45072011-08-16 17:40:46 -0700297// be "java.lang.String". Given an array of int, the output would be "int[]".
298// Given String.class, the output would be "java.lang.Class<java.lang.String>".
Ian Rogersef7d42f2014-01-06 12:55:46 -0800299std::string PrettyTypeOf(mirror::Object* obj)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700300 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mathieu Chartier4c70d772012-09-10 14:08:32 -0700301
302// Returns a human-readable form of the type at an index in the specified dex file.
303// Example outputs: char[], java.lang.String.
Mathieu Chartier18c24b62012-09-10 08:54:25 -0700304std::string PrettyType(uint32_t type_idx, const DexFile& dex_file);
Elliott Hughes54e7df12011-09-16 11:47:04 -0700305
306// Returns a human-readable form of the name of the given class.
307// Given String.class, the output would be "java.lang.Class<java.lang.String>".
Ian Rogersef7d42f2014-01-06 12:55:46 -0800308std::string PrettyClass(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700309 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700310
Ian Rogersd81871c2011-10-03 13:57:23 -0700311// Returns a human-readable form of the name of the given class with its class loader.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800312std::string PrettyClassAndClassLoader(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700313 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogersd81871c2011-10-03 13:57:23 -0700314
Elliott Hughesc967f782012-04-16 10:23:15 -0700315// Returns a human-readable size string such as "1MB".
Mathieu Chartiere6da9af2013-12-16 11:54:42 -0800316std::string PrettySize(int64_t size_in_bytes);
Ian Rogers3bb17a62012-01-27 23:56:44 -0800317
318// Returns a human-readable time string which prints every nanosecond while trying to limit the
319// number of trailing zeros. Prints using the largest human readable unit up to a second.
320// e.g. "1ms", "1.000000001s", "1.001us"
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700321std::string PrettyDuration(uint64_t nano_duration, size_t max_fraction_digits = 3);
Ian Rogers3bb17a62012-01-27 23:56:44 -0800322
Mathieu Chartier0325e622012-09-05 14:22:51 -0700323// Format a nanosecond time to specified units.
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700324std::string FormatDuration(uint64_t nano_duration, TimeUnit time_unit,
325 size_t max_fraction_digits);
Mathieu Chartier0325e622012-09-05 14:22:51 -0700326
327// Get the appropriate unit for a nanosecond duration.
328TimeUnit GetAppropriateTimeUnit(uint64_t nano_duration);
329
Dave Allison70202782013-10-22 17:52:19 -0700330// Get the divisor to convert from a nanoseconds to a time unit.
Mathieu Chartier0325e622012-09-05 14:22:51 -0700331uint64_t GetNsToTimeUnitDivisor(TimeUnit time_unit);
332
Elliott Hughes79082e32011-08-25 12:07:32 -0700333// Performs JNI name mangling as described in section 11.3 "Linking Native Methods"
334// of the JNI spec.
335std::string MangleForJni(const std::string& s);
336
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700337// Turn "java.lang.String" into "Ljava/lang/String;".
338std::string DotToDescriptor(const char* class_name);
339
Brian Carlstromaded5f72011-10-07 17:15:04 -0700340// Turn "Ljava/lang/String;" into "java.lang.String".
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800341std::string DescriptorToDot(const char* descriptor);
Brian Carlstromaded5f72011-10-07 17:15:04 -0700342
Elliott Hughes91bf6cd2012-02-14 17:27:48 -0800343// Turn "Ljava/lang/String;" into "java/lang/String".
344std::string DescriptorToName(const char* descriptor);
345
Elliott Hughes906e6852011-10-28 14:52:10 -0700346// Tests for whether 's' is a valid class name in the three common forms:
347bool IsValidBinaryClassName(const char* s); // "java.lang.String"
348bool IsValidJniClassName(const char* s); // "java/lang/String"
349bool IsValidDescriptor(const char* s); // "Ljava/lang/String;"
Elliott Hughes64bf5a32011-09-20 14:43:12 -0700350
jeffhao10037c82012-01-23 15:06:23 -0800351// Returns whether the given string is a valid field or method name,
352// additionally allowing names that begin with '<' and end with '>'.
353bool IsValidMemberName(const char* s);
354
Elliott Hughes79082e32011-08-25 12:07:32 -0700355// Returns the JNI native function name for the non-overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800356std::string JniShortName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700357 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700358// Returns the JNI native function name for the overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800359std::string JniLongName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700360 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700361
Elliott Hughesd92bec42011-09-02 17:04:36 -0700362bool ReadFileToString(const std::string& file_name, std::string* result);
buzbeec143c552011-08-20 17:38:58 -0700363
Elliott Hughese27955c2011-08-26 15:21:24 -0700364// Returns the current date in ISO yyyy-mm-dd hh:mm:ss format.
365std::string GetIsoDate();
366
Elliott Hughes0512f022012-03-15 22:10:52 -0700367// Returns the monotonic time since some unspecified starting point in milliseconds.
Elliott Hughes7162ad92011-10-27 14:08:42 -0700368uint64_t MilliTime();
369
Elliott Hughes0512f022012-03-15 22:10:52 -0700370// Returns the monotonic time since some unspecified starting point in microseconds.
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800371uint64_t MicroTime();
372
Elliott Hughes0512f022012-03-15 22:10:52 -0700373// Returns the monotonic time since some unspecified starting point in nanoseconds.
Elliott Hughes83df2ac2011-10-11 16:37:54 -0700374uint64_t NanoTime();
375
Elliott Hughes0512f022012-03-15 22:10:52 -0700376// Returns the thread-specific CPU-time clock in nanoseconds or -1 if unavailable.
377uint64_t ThreadCpuNanoTime();
378
Elliott Hughesbb551fa2012-01-25 16:35:29 -0800379// Converts the given number of nanoseconds to milliseconds.
Mathieu Chartier720ef762013-08-17 14:46:54 -0700380static constexpr inline uint64_t NsToMs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800381 return ns / 1000 / 1000;
382}
383
384// Converts the given number of milliseconds to nanoseconds
Mathieu Chartier720ef762013-08-17 14:46:54 -0700385static constexpr inline uint64_t MsToNs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800386 return ns * 1000 * 1000;
387}
388
Brian Carlstrombcc29262012-11-02 11:36:03 -0700389#if defined(__APPLE__)
390// No clocks to specify on OS/X, fake value to pass to routines that require a clock.
391#define CLOCK_REALTIME 0xebadf00d
392#endif
393
Ian Rogers56edc432013-01-18 16:51:51 -0800394// Sleep for the given number of nanoseconds, a bad way to handle contention.
395void NanoSleep(uint64_t ns);
396
Brian Carlstrombcc29262012-11-02 11:36:03 -0700397// Initialize a timespec to either an absolute or relative time.
398void InitTimeSpec(bool absolute, int clock, int64_t ms, int32_t ns, timespec* ts);
399
Elliott Hughes48436bb2012-02-07 15:23:28 -0800400// Splits a string using the given separator character into a vector of
Elliott Hughes34023802011-08-30 12:06:17 -0700401// strings. Empty strings will be omitted.
Elliott Hughes48436bb2012-02-07 15:23:28 -0800402void Split(const std::string& s, char separator, std::vector<std::string>& result);
403
Dave Allison70202782013-10-22 17:52:19 -0700404// Trims whitespace off both ends of the given string.
405std::string Trim(std::string s);
406
Elliott Hughes48436bb2012-02-07 15:23:28 -0800407// Joins a vector of strings into a single string, using the given separator.
408template <typename StringT> std::string Join(std::vector<StringT>& strings, char separator);
Elliott Hughes34023802011-08-30 12:06:17 -0700409
Elliott Hughes42ee1422011-09-06 12:33:32 -0700410// Returns the calling thread's tid. (The C libraries don't expose this.)
411pid_t GetTid();
412
Elliott Hughes289be852012-06-12 13:57:20 -0700413// Returns the given thread's name.
414std::string GetThreadName(pid_t tid);
415
Ian Rogers120f1c72012-09-28 17:17:10 -0700416// Returns details of the given thread's stack.
Brian Carlstrom29212012013-09-12 22:18:30 -0700417void GetThreadStack(pthread_t thread, void** stack_base, size_t* stack_size);
Elliott Hughese1884192012-04-23 12:38:15 -0700418
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700419// Reads data from "/proc/self/task/${tid}/stat".
Brian Carlstrom29212012013-09-12 22:18:30 -0700420void GetTaskStats(pid_t tid, char* state, int* utime, int* stime, int* task_cpu);
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700421
Elliott Hughes1bac54f2012-03-16 12:48:31 -0700422// Returns the name of the scheduler group for the given thread the current process, or the empty string.
423std::string GetSchedulerGroupName(pid_t tid);
424
Elliott Hughesdcc24742011-09-07 14:02:44 -0700425// Sets the name of the current thread. The name may be truncated to an
426// implementation-defined limit.
Elliott Hughes22869a92012-03-27 14:08:24 -0700427void SetThreadName(const char* thread_name);
Elliott Hughesdcc24742011-09-07 14:02:44 -0700428
Elliott Hughes46e251b2012-05-22 15:10:45 -0700429// Dumps the native stack for thread 'tid' to 'os'.
Kenny Root067d20f2014-03-05 14:57:21 -0800430void DumpNativeStack(std::ostream& os, pid_t tid, const char* prefix = "",
Christopher Ferrisa2cee182014-04-16 19:13:59 -0700431 mirror::ArtMethod* current_method = nullptr)
Kenny Root067d20f2014-03-05 14:57:21 -0800432 NO_THREAD_SAFETY_ANALYSIS;
Elliott Hughes46e251b2012-05-22 15:10:45 -0700433
434// Dumps the kernel stack for thread 'tid' to 'os'. Note that this is only available on linux-x86.
435void DumpKernelStack(std::ostream& os, pid_t tid, const char* prefix = "", bool include_count = true);
436
Dave Allison70202782013-10-22 17:52:19 -0700437// Find $ANDROID_ROOT, /system, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800438const char* GetAndroidRoot();
439
Dave Allison70202782013-10-22 17:52:19 -0700440// Find $ANDROID_DATA, /data, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800441const char* GetAndroidData();
Alex Lighta59dd802014-07-02 16:28:08 -0700442// Find $ANDROID_DATA, /data, or return nullptr.
443const char* GetAndroidDataSafe(std::string* error_msg);
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800444
Narayan Kamath11d9f062014-04-23 20:24:57 +0100445// Returns the dalvik-cache location, or dies trying. subdir will be
446// appended to the cache location.
447std::string GetDalvikCacheOrDie(const char* subdir, bool create_if_absent = true);
Alex Lighta59dd802014-07-02 16:28:08 -0700448// Return true if we found the dalvik cache and stored it in the dalvik_cache argument.
449// have_android_data will be set to true if we have an ANDROID_DATA that exists,
450// dalvik_cache_exists will be true if there is a dalvik-cache directory that is present.
451void GetDalvikCache(const char* subdir, bool create_if_absent, std::string* dalvik_cache,
452 bool* have_android_data, bool* dalvik_cache_exists);
Brian Carlstroma9f19782011-10-13 00:14:47 -0700453
Alex Lighta59dd802014-07-02 16:28:08 -0700454// Returns the absolute dalvik-cache path for a DexFile or OatFile. The path returned will be
455// rooted at cache_location.
456bool GetDalvikCacheFilename(const char* file_location, const char* cache_location,
457 std::string* filename, std::string* error_msg);
Narayan Kamath11d9f062014-04-23 20:24:57 +0100458// Returns the absolute dalvik-cache path for a DexFile or OatFile, or
459// dies trying. The path returned will be rooted at cache_location.
460std::string GetDalvikCacheFilenameOrDie(const char* file_location,
461 const char* cache_location);
jeffhao262bf462011-10-20 18:36:32 -0700462
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700463// Returns the system location for an image
Brian Carlstrom2afe4942014-05-19 10:25:33 -0700464std::string GetSystemImageFilename(const char* location, InstructionSet isa);
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700465
466// Returns an .odex file name next adjacent to the dex location.
467// For example, for "/foo/bar/baz.jar", return "/foo/bar/<isa>/baz.odex".
Andreas Gampe833a4852014-05-21 18:46:59 -0700468// Note: does not support multidex location strings.
Brian Carlstrom2afe4942014-05-19 10:25:33 -0700469std::string DexFilenameToOdexFilename(const std::string& location, InstructionSet isa);
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700470
Brian Carlstrom7c3d13a2013-09-04 17:15:11 -0700471// Check whether the given magic matches a known file type.
472bool IsZipMagic(uint32_t magic);
473bool IsDexMagic(uint32_t magic);
474bool IsOatMagic(uint32_t magic);
Brian Carlstromb7bbba42011-10-13 14:58:47 -0700475
Brian Carlstrom6449c622014-02-10 23:48:36 -0800476// Wrapper on fork/execv to run a command in a subprocess.
477bool Exec(std::vector<std::string>& arg_vector, std::string* error_msg);
478
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800479class VoidFunctor {
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700480 public:
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800481 template <typename A>
Brian Carlstromdf629502013-07-17 22:39:56 -0700482 inline void operator() (A a) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800483 UNUSED(a);
484 }
485
486 template <typename A, typename B>
Brian Carlstromdf629502013-07-17 22:39:56 -0700487 inline void operator() (A a, B b) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800488 UNUSED(a);
489 UNUSED(b);
490 }
491
492 template <typename A, typename B, typename C>
Brian Carlstromdf629502013-07-17 22:39:56 -0700493 inline void operator() (A a, B b, C c) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800494 UNUSED(a);
495 UNUSED(b);
496 UNUSED(c);
497 }
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700498};
499
Carl Shapiro6b6b5f02011-06-21 15:05:09 -0700500} // namespace art
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700501
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700502#endif // ART_RUNTIME_UTILS_H_