blob: 68ea47541b70dd8dbd4f2175ed1f2d3b6281eba2 [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
Elliott Hughes34023802011-08-30 12:06:17 -070022#include <string>
23#include <vector>
24
Elliott Hughese222ee02012-12-13 14:41:43 -080025#include "base/logging.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080026#include "globals.h"
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -070027#include "instruction_set.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080028#include "primitive.h"
29
Calin Juravlebb0b53f2014-05-23 17:33:29 +010030#ifdef HAVE_ANDROID_OS
31#include "cutils/properties.h"
32#endif
33
Carl Shapiro6b6b5f02011-06-21 15:05:09 -070034namespace art {
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070035
Ian Rogers0571d352011-11-03 19:51:38 -070036class DexFile;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080037
38namespace mirror {
Brian Carlstromea46f952013-07-30 01:26:50 -070039class ArtField;
40class ArtMethod;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041class Class;
Elliott Hughes11e45072011-08-16 17:40:46 -070042class Object;
Elliott Hughes5174fe62011-08-23 15:12:35 -070043class String;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080044} // namespace mirror
Elliott Hughes11e45072011-08-16 17:40:46 -070045
Mathieu Chartier0325e622012-09-05 14:22:51 -070046enum TimeUnit {
47 kTimeUnitNanosecond,
48 kTimeUnitMicrosecond,
49 kTimeUnitMillisecond,
50 kTimeUnitSecond,
51};
52
Carl Shapiroa2e18e12011-06-21 18:57:55 -070053template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +010054static constexpr bool IsPowerOfTwo(T x) {
Carl Shapiroa2e18e12011-06-21 18:57:55 -070055 return (x & (x - 1)) == 0;
56}
57
Elliott Hughes06b37d92011-10-16 11:51:29 -070058template<int n, typename T>
59static inline bool IsAligned(T x) {
60 COMPILE_ASSERT((n & (n - 1)) == 0, n_not_power_of_two);
Carl Shapiroa2e18e12011-06-21 18:57:55 -070061 return (x & (n - 1)) == 0;
62}
63
Elliott Hughes06b37d92011-10-16 11:51:29 -070064template<int n, typename T>
65static inline bool IsAligned(T* x) {
Brian Carlstrom89521892011-12-07 22:05:07 -080066 return IsAligned<n>(reinterpret_cast<const uintptr_t>(x));
Carl Shapiroa2e18e12011-06-21 18:57:55 -070067}
68
Andreas Gampeaf13ad92014-04-11 12:07:48 -070069template<typename T>
70static inline bool IsAlignedParam(T x, int n) {
71 return (x & (n - 1)) == 0;
72}
73
Elliott Hughes06b37d92011-10-16 11:51:29 -070074#define CHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -080075 CHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -070076
77#define DCHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -080078 DCHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -070079
Andreas Gampeaf13ad92014-04-11 12:07:48 -070080#define DCHECK_ALIGNED_PARAM(value, alignment) \
81 DCHECK(::art::IsAlignedParam(value, alignment)) << reinterpret_cast<const void*>(value)
82
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070083// Check whether an N-bit two's-complement representation can hold value.
84static 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 Shapiroa5d5cfd2011-06-21 12:46:59 -070091static 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 Shapiroa2e18e12011-06-21 18:57:55 -070098static 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
buzbee4ef3e452012-12-14 13:35:28 -0800105static inline uint16_t Low16Bits(uint32_t value) {
106 return static_cast<uint16_t>(value);
Ian Rogersb033c752011-07-20 12:22:35 -0700107}
108
buzbee4ef3e452012-12-14 13:35:28 -0800109static inline uint16_t High16Bits(uint32_t value) {
110 return static_cast<uint16_t>(value >> 16);
Ian Rogersb033c752011-07-20 12:22:35 -0700111}
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700112
buzbee4ef3e452012-12-14 13:35:28 -0800113static inline uint32_t Low32Bits(uint64_t value) {
114 return static_cast<uint32_t>(value);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700115}
116
buzbee4ef3e452012-12-14 13:35:28 -0800117static inline uint32_t High32Bits(uint64_t value) {
118 return static_cast<uint32_t>(value >> 32);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700119}
120
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700121// A static if which determines whether to return type A or B based on the condition boolean.
Vladimir Marko81949632014-05-02 11:53:22 +0100122template <bool condition, typename A, typename B>
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700123struct TypeStaticIf {
Vladimir Marko81949632014-05-02 11:53:22 +0100124 typedef A type;
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700125};
126
127// Specialization to handle the false case.
128template <typename A, typename B>
129struct TypeStaticIf<false, A, B> {
Vladimir Marko81949632014-05-02 11:53:22 +0100130 typedef B type;
131};
132
133// Type identity.
134template <typename T>
135struct TypeIdentity {
136 typedef T type;
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700137};
138
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800139// For rounding integers.
Carl Shapiro61e019d2011-07-14 16:53:09 -0700140template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100141static constexpr T RoundDown(T x, typename TypeIdentity<T>::type n) {
142 return
Vladimir Marko83642482014-06-11 12:12:07 +0100143 DCHECK_CONSTEXPR(IsPowerOfTwo(n), , T(0))
144 (x & -n);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700145}
146
147template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100148static constexpr T RoundUp(T x, typename TypeIdentity<T>::type n) {
Carl Shapiro61e019d2011-07-14 16:53:09 -0700149 return RoundDown(x + n - 1, n);
150}
151
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800152// For aligning pointers.
153template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100154static inline T* AlignDown(T* x, uintptr_t n) {
155 return reinterpret_cast<T*>(RoundDown(reinterpret_cast<uintptr_t>(x), n));
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800156}
157
158template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100159static inline T* AlignUp(T* x, uintptr_t n) {
160 return reinterpret_cast<T*>(RoundUp(reinterpret_cast<uintptr_t>(x), n));
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800161}
162
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700163// Implementation is from "Hacker's Delight" by Henry S. Warren, Jr.,
Carl Shapiro1fb86202011-06-27 17:43:13 -0700164// figure 3-3, page 48, where the function is called clp2.
165static 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 Marko81949632014-05-02 11:53:22 +0100175template<typename T>
176static constexpr int CLZ(T x) {
177 return (sizeof(T) == sizeof(uint32_t))
178 ? __builtin_clz(x)
179 : __builtin_clzll(x);
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700180}
181
Ian Rogersef7d42f2014-01-06 12:55:46 -0800182template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100183static constexpr int CTZ(T x) {
184 return (sizeof(T) == sizeof(uint32_t))
185 ? __builtin_ctz(x)
186 : __builtin_ctzll(x);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800187}
188
189template<typename T>
Vladimir Marko81949632014-05-02 11:53:22 +0100190static constexpr int POPCOUNT(T x) {
191 return (sizeof(T) == sizeof(uint32_t))
192 ? __builtin_popcount(x)
193 : __builtin_popcountll(x);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800194}
195
196static 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 Carlstromdb4d5402011-08-09 12:18:28 -0700201
Elliott Hughes46b92ba2011-08-12 17:57:34 -0700202static inline bool NeedsEscaping(uint16_t ch) {
203 return (ch < ' ' || ch > '~');
204}
205
Ian Rogers576ca0c2014-06-06 15:58:22 -0700206std::string PrintableChar(uint16_t ch);
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700207
Elliott Hughes82914b62012-04-09 15:56:29 -0700208// Returns an ASCII string corresponding to the given UTF-8 string.
209// Java escapes are used for non-ASCII characters.
210std::string PrintableString(const std::string& utf8);
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700211
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800212// Tests whether 's' starts with 'prefix'.
213bool StartsWith(const std::string& s, const char* prefix);
214
Brian Carlstrom7a967b32012-03-28 15:23:10 -0700215// Tests whether 's' starts with 'suffix'.
216bool EndsWith(const std::string& s, const char* suffix);
217
Elliott Hughes54e7df12011-09-16 11:47:04 -0700218// Used to implement PrettyClass, PrettyField, PrettyMethod, and PrettyTypeOf,
219// one of which is probably more useful to you.
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700220// 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 Rogersef7d42f2014-01-06 12:55:46 -0800223std::string PrettyDescriptor(mirror::String* descriptor)
224 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes6c8867d2011-10-03 16:34:05 -0700225std::string PrettyDescriptor(const std::string& descriptor);
Brian Carlstrom6b4ef022011-10-23 14:59:04 -0700226std::string PrettyDescriptor(Primitive::Type type);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800227std::string PrettyDescriptor(mirror::Class* klass)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700228 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700229
Elliott Hughes54e7df12011-09-16 11:47:04 -0700230// 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 Rogersef7d42f2014-01-06 12:55:46 -0800232std::string PrettyField(mirror::ArtField* f, bool with_type = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700233 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstrom6f29d0e2012-05-11 15:50:29 -0700234std::string PrettyField(uint32_t field_idx, const DexFile& dex_file, bool with_type = true);
Elliott Hughesa2501992011-08-26 19:39:54 -0700235
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700236// 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 Rogersef7d42f2014-01-06 12:55:46 -0800238std::string PrettyMethod(mirror::ArtMethod* m, bool with_signature = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700239 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers0571d352011-11-03 19:51:38 -0700240std::string PrettyMethod(uint32_t method_idx, const DexFile& dex_file, bool with_signature = true);
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700241
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 Hughes11e45072011-08-16 17:40:46 -0700244// 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 Rogersef7d42f2014-01-06 12:55:46 -0800246std::string PrettyTypeOf(mirror::Object* obj)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700247 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mathieu Chartier4c70d772012-09-10 14:08:32 -0700248
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 Chartier18c24b62012-09-10 08:54:25 -0700251std::string PrettyType(uint32_t type_idx, const DexFile& dex_file);
Elliott Hughes54e7df12011-09-16 11:47:04 -0700252
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 Rogersef7d42f2014-01-06 12:55:46 -0800255std::string PrettyClass(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700256 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700257
Ian Rogersd81871c2011-10-03 13:57:23 -0700258// Returns a human-readable form of the name of the given class with its class loader.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800259std::string PrettyClassAndClassLoader(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700260 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogersd81871c2011-10-03 13:57:23 -0700261
Elliott Hughesc967f782012-04-16 10:23:15 -0700262// Returns a human-readable size string such as "1MB".
Mathieu Chartiere6da9af2013-12-16 11:54:42 -0800263std::string PrettySize(int64_t size_in_bytes);
Ian Rogers3bb17a62012-01-27 23:56:44 -0800264
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"
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700268std::string PrettyDuration(uint64_t nano_duration, size_t max_fraction_digits = 3);
Ian Rogers3bb17a62012-01-27 23:56:44 -0800269
Mathieu Chartier0325e622012-09-05 14:22:51 -0700270// Format a nanosecond time to specified units.
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700271std::string FormatDuration(uint64_t nano_duration, TimeUnit time_unit,
272 size_t max_fraction_digits);
Mathieu Chartier0325e622012-09-05 14:22:51 -0700273
274// Get the appropriate unit for a nanosecond duration.
275TimeUnit GetAppropriateTimeUnit(uint64_t nano_duration);
276
Dave Allison70202782013-10-22 17:52:19 -0700277// Get the divisor to convert from a nanoseconds to a time unit.
Mathieu Chartier0325e622012-09-05 14:22:51 -0700278uint64_t GetNsToTimeUnitDivisor(TimeUnit time_unit);
279
Elliott Hughes79082e32011-08-25 12:07:32 -0700280// Performs JNI name mangling as described in section 11.3 "Linking Native Methods"
281// of the JNI spec.
282std::string MangleForJni(const std::string& s);
283
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700284// Turn "java.lang.String" into "Ljava/lang/String;".
285std::string DotToDescriptor(const char* class_name);
286
Brian Carlstromaded5f72011-10-07 17:15:04 -0700287// Turn "Ljava/lang/String;" into "java.lang.String".
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800288std::string DescriptorToDot(const char* descriptor);
Brian Carlstromaded5f72011-10-07 17:15:04 -0700289
Elliott Hughes91bf6cd2012-02-14 17:27:48 -0800290// Turn "Ljava/lang/String;" into "java/lang/String".
291std::string DescriptorToName(const char* descriptor);
292
Elliott Hughes906e6852011-10-28 14:52:10 -0700293// Tests for whether 's' is a valid class name in the three common forms:
294bool IsValidBinaryClassName(const char* s); // "java.lang.String"
295bool IsValidJniClassName(const char* s); // "java/lang/String"
296bool IsValidDescriptor(const char* s); // "Ljava/lang/String;"
Elliott Hughes64bf5a32011-09-20 14:43:12 -0700297
jeffhao10037c82012-01-23 15:06:23 -0800298// Returns whether the given string is a valid field or method name,
299// additionally allowing names that begin with '<' and end with '>'.
300bool IsValidMemberName(const char* s);
301
Elliott Hughes79082e32011-08-25 12:07:32 -0700302// Returns the JNI native function name for the non-overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800303std::string JniShortName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700304 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700305// Returns the JNI native function name for the overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800306std::string JniLongName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700307 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700308
Elliott Hughesd92bec42011-09-02 17:04:36 -0700309bool ReadFileToString(const std::string& file_name, std::string* result);
buzbeec143c552011-08-20 17:38:58 -0700310
Elliott Hughese27955c2011-08-26 15:21:24 -0700311// Returns the current date in ISO yyyy-mm-dd hh:mm:ss format.
312std::string GetIsoDate();
313
Elliott Hughes0512f022012-03-15 22:10:52 -0700314// Returns the monotonic time since some unspecified starting point in milliseconds.
Elliott Hughes7162ad92011-10-27 14:08:42 -0700315uint64_t MilliTime();
316
Elliott Hughes0512f022012-03-15 22:10:52 -0700317// Returns the monotonic time since some unspecified starting point in microseconds.
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800318uint64_t MicroTime();
319
Elliott Hughes0512f022012-03-15 22:10:52 -0700320// Returns the monotonic time since some unspecified starting point in nanoseconds.
Elliott Hughes83df2ac2011-10-11 16:37:54 -0700321uint64_t NanoTime();
322
Elliott Hughes0512f022012-03-15 22:10:52 -0700323// Returns the thread-specific CPU-time clock in nanoseconds or -1 if unavailable.
324uint64_t ThreadCpuNanoTime();
325
Elliott Hughesbb551fa2012-01-25 16:35:29 -0800326// Converts the given number of nanoseconds to milliseconds.
Mathieu Chartier720ef762013-08-17 14:46:54 -0700327static constexpr inline uint64_t NsToMs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800328 return ns / 1000 / 1000;
329}
330
331// Converts the given number of milliseconds to nanoseconds
Mathieu Chartier720ef762013-08-17 14:46:54 -0700332static constexpr inline uint64_t MsToNs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800333 return ns * 1000 * 1000;
334}
335
Brian Carlstrombcc29262012-11-02 11:36:03 -0700336#if defined(__APPLE__)
337// No clocks to specify on OS/X, fake value to pass to routines that require a clock.
338#define CLOCK_REALTIME 0xebadf00d
339#endif
340
Ian Rogers56edc432013-01-18 16:51:51 -0800341// Sleep for the given number of nanoseconds, a bad way to handle contention.
342void NanoSleep(uint64_t ns);
343
Brian Carlstrombcc29262012-11-02 11:36:03 -0700344// Initialize a timespec to either an absolute or relative time.
345void InitTimeSpec(bool absolute, int clock, int64_t ms, int32_t ns, timespec* ts);
346
Elliott Hughes48436bb2012-02-07 15:23:28 -0800347// Splits a string using the given separator character into a vector of
Elliott Hughes34023802011-08-30 12:06:17 -0700348// strings. Empty strings will be omitted.
Elliott Hughes48436bb2012-02-07 15:23:28 -0800349void Split(const std::string& s, char separator, std::vector<std::string>& result);
350
Dave Allison70202782013-10-22 17:52:19 -0700351// Trims whitespace off both ends of the given string.
352std::string Trim(std::string s);
353
Elliott Hughes48436bb2012-02-07 15:23:28 -0800354// Joins a vector of strings into a single string, using the given separator.
355template <typename StringT> std::string Join(std::vector<StringT>& strings, char separator);
Elliott Hughes34023802011-08-30 12:06:17 -0700356
Elliott Hughes42ee1422011-09-06 12:33:32 -0700357// Returns the calling thread's tid. (The C libraries don't expose this.)
358pid_t GetTid();
359
Elliott Hughes289be852012-06-12 13:57:20 -0700360// Returns the given thread's name.
361std::string GetThreadName(pid_t tid);
362
Ian Rogers120f1c72012-09-28 17:17:10 -0700363// Returns details of the given thread's stack.
Brian Carlstrom29212012013-09-12 22:18:30 -0700364void GetThreadStack(pthread_t thread, void** stack_base, size_t* stack_size);
Elliott Hughese1884192012-04-23 12:38:15 -0700365
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700366// Reads data from "/proc/self/task/${tid}/stat".
Brian Carlstrom29212012013-09-12 22:18:30 -0700367void GetTaskStats(pid_t tid, char* state, int* utime, int* stime, int* task_cpu);
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700368
Elliott Hughes1bac54f2012-03-16 12:48:31 -0700369// Returns the name of the scheduler group for the given thread the current process, or the empty string.
370std::string GetSchedulerGroupName(pid_t tid);
371
Elliott Hughesdcc24742011-09-07 14:02:44 -0700372// Sets the name of the current thread. The name may be truncated to an
373// implementation-defined limit.
Elliott Hughes22869a92012-03-27 14:08:24 -0700374void SetThreadName(const char* thread_name);
Elliott Hughesdcc24742011-09-07 14:02:44 -0700375
Elliott Hughes46e251b2012-05-22 15:10:45 -0700376// Dumps the native stack for thread 'tid' to 'os'.
Kenny Root067d20f2014-03-05 14:57:21 -0800377void DumpNativeStack(std::ostream& os, pid_t tid, const char* prefix = "",
Christopher Ferrisa2cee182014-04-16 19:13:59 -0700378 mirror::ArtMethod* current_method = nullptr)
Kenny Root067d20f2014-03-05 14:57:21 -0800379 NO_THREAD_SAFETY_ANALYSIS;
Elliott Hughes46e251b2012-05-22 15:10:45 -0700380
381// Dumps the kernel stack for thread 'tid' to 'os'. Note that this is only available on linux-x86.
382void DumpKernelStack(std::ostream& os, pid_t tid, const char* prefix = "", bool include_count = true);
383
Dave Allison70202782013-10-22 17:52:19 -0700384// Find $ANDROID_ROOT, /system, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800385const char* GetAndroidRoot();
386
Dave Allison70202782013-10-22 17:52:19 -0700387// Find $ANDROID_DATA, /data, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800388const char* GetAndroidData();
389
Narayan Kamath11d9f062014-04-23 20:24:57 +0100390// Returns the dalvik-cache location, or dies trying. subdir will be
391// appended to the cache location.
392std::string GetDalvikCacheOrDie(const char* subdir, bool create_if_absent = true);
Brian Carlstroma9f19782011-10-13 00:14:47 -0700393
Narayan Kamath11d9f062014-04-23 20:24:57 +0100394// Returns the absolute dalvik-cache path for a DexFile or OatFile, or
395// dies trying. The path returned will be rooted at cache_location.
396std::string GetDalvikCacheFilenameOrDie(const char* file_location,
397 const char* cache_location);
jeffhao262bf462011-10-20 18:36:32 -0700398
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700399// Returns the system location for an image
Brian Carlstrom2afe4942014-05-19 10:25:33 -0700400std::string GetSystemImageFilename(const char* location, InstructionSet isa);
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700401
402// Returns an .odex file name next adjacent to the dex location.
403// For example, for "/foo/bar/baz.jar", return "/foo/bar/<isa>/baz.odex".
Andreas Gampe833a4852014-05-21 18:46:59 -0700404// Note: does not support multidex location strings.
Brian Carlstrom2afe4942014-05-19 10:25:33 -0700405std::string DexFilenameToOdexFilename(const std::string& location, InstructionSet isa);
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700406
Brian Carlstrom7c3d13a2013-09-04 17:15:11 -0700407// Check whether the given magic matches a known file type.
408bool IsZipMagic(uint32_t magic);
409bool IsDexMagic(uint32_t magic);
410bool IsOatMagic(uint32_t magic);
Brian Carlstromb7bbba42011-10-13 14:58:47 -0700411
Brian Carlstrom6449c622014-02-10 23:48:36 -0800412// Wrapper on fork/execv to run a command in a subprocess.
413bool Exec(std::vector<std::string>& arg_vector, std::string* error_msg);
414
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800415class VoidFunctor {
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700416 public:
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800417 template <typename A>
Brian Carlstromdf629502013-07-17 22:39:56 -0700418 inline void operator() (A a) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800419 UNUSED(a);
420 }
421
422 template <typename A, typename B>
Brian Carlstromdf629502013-07-17 22:39:56 -0700423 inline void operator() (A a, B b) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800424 UNUSED(a);
425 UNUSED(b);
426 }
427
428 template <typename A, typename B, typename C>
Brian Carlstromdf629502013-07-17 22:39:56 -0700429 inline void operator() (A a, B b, C c) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800430 UNUSED(a);
431 UNUSED(b);
432 UNUSED(c);
433 }
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700434};
435
Carl Shapiro6b6b5f02011-06-21 15:05:09 -0700436} // namespace art
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700437
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700438#endif // ART_RUNTIME_UTILS_H_