blob: 5def66b56c15fe9db6a97ed9533de341ffc44f3f [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 "base/stringprintf.h"
27#include "globals.h"
28#include "primitive.h"
29
Carl Shapiro6b6b5f02011-06-21 15:05:09 -070030namespace art {
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070031
Ian Rogers0571d352011-11-03 19:51:38 -070032class DexFile;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080033
34namespace mirror {
Brian Carlstromea46f952013-07-30 01:26:50 -070035class ArtField;
36class ArtMethod;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080037class Class;
Elliott Hughes11e45072011-08-16 17:40:46 -070038class Object;
Elliott Hughes5174fe62011-08-23 15:12:35 -070039class String;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040} // namespace mirror
Elliott Hughes11e45072011-08-16 17:40:46 -070041
Mathieu Chartier0325e622012-09-05 14:22:51 -070042enum TimeUnit {
43 kTimeUnitNanosecond,
44 kTimeUnitMicrosecond,
45 kTimeUnitMillisecond,
46 kTimeUnitSecond,
47};
48
Carl Shapiroa2e18e12011-06-21 18:57:55 -070049template<typename T>
50static inline bool IsPowerOfTwo(T x) {
51 return (x & (x - 1)) == 0;
52}
53
Elliott Hughes06b37d92011-10-16 11:51:29 -070054template<int n, typename T>
55static inline bool IsAligned(T x) {
56 COMPILE_ASSERT((n & (n - 1)) == 0, n_not_power_of_two);
Carl Shapiroa2e18e12011-06-21 18:57:55 -070057 return (x & (n - 1)) == 0;
58}
59
Elliott Hughes06b37d92011-10-16 11:51:29 -070060template<int n, typename T>
61static inline bool IsAligned(T* x) {
Brian Carlstrom89521892011-12-07 22:05:07 -080062 return IsAligned<n>(reinterpret_cast<const uintptr_t>(x));
Carl Shapiroa2e18e12011-06-21 18:57:55 -070063}
64
Andreas Gampeaf13ad92014-04-11 12:07:48 -070065template<typename T>
66static inline bool IsAlignedParam(T x, int n) {
67 return (x & (n - 1)) == 0;
68}
69
Elliott Hughes06b37d92011-10-16 11:51:29 -070070#define CHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -080071 CHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -070072
73#define DCHECK_ALIGNED(value, alignment) \
Brian Carlstrom89521892011-12-07 22:05:07 -080074 DCHECK(::art::IsAligned<alignment>(value)) << reinterpret_cast<const void*>(value)
Elliott Hughes06b37d92011-10-16 11:51:29 -070075
Andreas Gampeaf13ad92014-04-11 12:07:48 -070076#define DCHECK_ALIGNED_PARAM(value, alignment) \
77 DCHECK(::art::IsAlignedParam(value, alignment)) << reinterpret_cast<const void*>(value)
78
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -070079// Check whether an N-bit two's-complement representation can hold value.
80static 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 Shapiroa5d5cfd2011-06-21 12:46:59 -070087static 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 Shapiroa2e18e12011-06-21 18:57:55 -070094static 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
buzbee4ef3e452012-12-14 13:35:28 -0800101static inline uint16_t Low16Bits(uint32_t value) {
102 return static_cast<uint16_t>(value);
Ian Rogersb033c752011-07-20 12:22:35 -0700103}
104
buzbee4ef3e452012-12-14 13:35:28 -0800105static inline uint16_t High16Bits(uint32_t value) {
106 return static_cast<uint16_t>(value >> 16);
Ian Rogersb033c752011-07-20 12:22:35 -0700107}
Carl Shapiroa2e18e12011-06-21 18:57:55 -0700108
buzbee4ef3e452012-12-14 13:35:28 -0800109static inline uint32_t Low32Bits(uint64_t value) {
110 return static_cast<uint32_t>(value);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700111}
112
buzbee4ef3e452012-12-14 13:35:28 -0800113static inline uint32_t High32Bits(uint64_t value) {
114 return static_cast<uint32_t>(value >> 32);
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700115}
116
Mathieu Chartier0a9dc052013-07-25 11:01:28 -0700117// A static if which determines whether to return type A or B based on the condition boolean.
118template <const bool condition, typename A, typename B>
119struct TypeStaticIf {
120 typedef A value;
121};
122
123// Specialization to handle the false case.
124template <typename A, typename B>
125struct TypeStaticIf<false, A, B> {
126 typedef B value;
127};
128
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800129// For rounding integers.
Carl Shapiro61e019d2011-07-14 16:53:09 -0700130template<typename T>
131static inline T RoundDown(T x, int n) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700132 DCHECK(IsPowerOfTwo(n));
Carl Shapiro61e019d2011-07-14 16:53:09 -0700133 return (x & -n);
134}
135
136template<typename T>
137static inline T RoundUp(T x, int n) {
138 return RoundDown(x + n - 1, n);
139}
140
Hiroshi Yamauchi0941b042013-11-05 11:34:03 -0800141// For aligning pointers.
142template<typename T>
143static 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
148template<typename T>
149static 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 Shapiroa2e18e12011-06-21 18:57:55 -0700153// Implementation is from "Hacker's Delight" by Henry S. Warren, Jr.,
Carl Shapiro1fb86202011-06-27 17:43:13 -0700154// figure 3-3, page 48, where the function is called clp2.
155static 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 Shapiroa2e18e12011-06-21 18:57:55 -0700166// figure 5-2, page 66, where the function is called pop.
167static 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 Rogersef7d42f2014-01-06 12:55:46 -0800176template<typename T>
177static 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
185template<typename T>
186static 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
194static 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 Carlstromdb4d5402011-08-09 12:18:28 -0700199
Elliott Hughes46b92ba2011-08-12 17:57:34 -0700200static inline bool NeedsEscaping(uint16_t ch) {
201 return (ch < ' ' || ch > '~');
202}
203
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700204static inline std::string PrintableChar(uint16_t ch) {
205 std::string result;
Elliott Hughes46b92ba2011-08-12 17:57:34 -0700206 result += '\'';
207 if (NeedsEscaping(ch)) {
208 StringAppendF(&result, "\\u%04x", ch);
209 } else {
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700210 result += ch;
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700211 }
Elliott Hughes46b92ba2011-08-12 17:57:34 -0700212 result += '\'';
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700213 return result;
214}
215
Elliott Hughes82914b62012-04-09 15:56:29 -0700216// Returns an ASCII string corresponding to the given UTF-8 string.
217// Java escapes are used for non-ASCII characters.
218std::string PrintableString(const std::string& utf8);
Elliott Hughesc7ac37f2011-08-12 12:21:58 -0700219
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800220// Tests whether 's' starts with 'prefix'.
221bool StartsWith(const std::string& s, const char* prefix);
222
Brian Carlstrom7a967b32012-03-28 15:23:10 -0700223// Tests whether 's' starts with 'suffix'.
224bool EndsWith(const std::string& s, const char* suffix);
225
Elliott Hughes54e7df12011-09-16 11:47:04 -0700226// Used to implement PrettyClass, PrettyField, PrettyMethod, and PrettyTypeOf,
227// one of which is probably more useful to you.
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700228// 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 Rogersef7d42f2014-01-06 12:55:46 -0800231std::string PrettyDescriptor(mirror::String* descriptor)
232 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes6c8867d2011-10-03 16:34:05 -0700233std::string PrettyDescriptor(const std::string& descriptor);
Brian Carlstrom6b4ef022011-10-23 14:59:04 -0700234std::string PrettyDescriptor(Primitive::Type type);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800235std::string PrettyDescriptor(mirror::Class* klass)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700236 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700237
Elliott Hughes54e7df12011-09-16 11:47:04 -0700238// 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 Rogersef7d42f2014-01-06 12:55:46 -0800240std::string PrettyField(mirror::ArtField* f, bool with_type = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700241 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstrom6f29d0e2012-05-11 15:50:29 -0700242std::string PrettyField(uint32_t field_idx, const DexFile& dex_file, bool with_type = true);
Elliott Hughesa2501992011-08-26 19:39:54 -0700243
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700244// 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 Rogersef7d42f2014-01-06 12:55:46 -0800246std::string PrettyMethod(mirror::ArtMethod* m, bool with_signature = true)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700247 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers0571d352011-11-03 19:51:38 -0700248std::string PrettyMethod(uint32_t method_idx, const DexFile& dex_file, bool with_signature = true);
Elliott Hughesa0b8feb2011-08-20 09:50:55 -0700249
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 Hughes11e45072011-08-16 17:40:46 -0700252// 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 Rogersef7d42f2014-01-06 12:55:46 -0800254std::string PrettyTypeOf(mirror::Object* obj)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700255 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Mathieu Chartier4c70d772012-09-10 14:08:32 -0700256
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 Chartier18c24b62012-09-10 08:54:25 -0700259std::string PrettyType(uint32_t type_idx, const DexFile& dex_file);
Elliott Hughes54e7df12011-09-16 11:47:04 -0700260
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 Rogersef7d42f2014-01-06 12:55:46 -0800263std::string PrettyClass(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700264 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes11e45072011-08-16 17:40:46 -0700265
Ian Rogersd81871c2011-10-03 13:57:23 -0700266// Returns a human-readable form of the name of the given class with its class loader.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800267std::string PrettyClassAndClassLoader(mirror::Class* c)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700268 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogersd81871c2011-10-03 13:57:23 -0700269
Elliott Hughesc967f782012-04-16 10:23:15 -0700270// Returns a human-readable size string such as "1MB".
Mathieu Chartiere6da9af2013-12-16 11:54:42 -0800271std::string PrettySize(int64_t size_in_bytes);
Ian Rogers3bb17a62012-01-27 23:56:44 -0800272
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"
276std::string PrettyDuration(uint64_t nano_duration);
277
Mathieu Chartier0325e622012-09-05 14:22:51 -0700278// Format a nanosecond time to specified units.
279std::string FormatDuration(uint64_t nano_duration, TimeUnit time_unit);
280
281// Get the appropriate unit for a nanosecond duration.
282TimeUnit GetAppropriateTimeUnit(uint64_t nano_duration);
283
Dave Allison70202782013-10-22 17:52:19 -0700284// Get the divisor to convert from a nanoseconds to a time unit.
Mathieu Chartier0325e622012-09-05 14:22:51 -0700285uint64_t GetNsToTimeUnitDivisor(TimeUnit time_unit);
286
Elliott Hughes79082e32011-08-25 12:07:32 -0700287// Performs JNI name mangling as described in section 11.3 "Linking Native Methods"
288// of the JNI spec.
289std::string MangleForJni(const std::string& s);
290
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700291// Turn "java.lang.String" into "Ljava/lang/String;".
292std::string DotToDescriptor(const char* class_name);
293
Brian Carlstromaded5f72011-10-07 17:15:04 -0700294// Turn "Ljava/lang/String;" into "java.lang.String".
Elliott Hughesf1a5adc2012-02-10 18:09:35 -0800295std::string DescriptorToDot(const char* descriptor);
Brian Carlstromaded5f72011-10-07 17:15:04 -0700296
Elliott Hughes91bf6cd2012-02-14 17:27:48 -0800297// Turn "Ljava/lang/String;" into "java/lang/String".
298std::string DescriptorToName(const char* descriptor);
299
Elliott Hughes906e6852011-10-28 14:52:10 -0700300// Tests for whether 's' is a valid class name in the three common forms:
301bool IsValidBinaryClassName(const char* s); // "java.lang.String"
302bool IsValidJniClassName(const char* s); // "java/lang/String"
303bool IsValidDescriptor(const char* s); // "Ljava/lang/String;"
Elliott Hughes64bf5a32011-09-20 14:43:12 -0700304
jeffhao10037c82012-01-23 15:06:23 -0800305// Returns whether the given string is a valid field or method name,
306// additionally allowing names that begin with '<' and end with '>'.
307bool IsValidMemberName(const char* s);
308
Elliott Hughes79082e32011-08-25 12:07:32 -0700309// Returns the JNI native function name for the non-overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800310std::string JniShortName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700311 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700312// Returns the JNI native function name for the overloaded method 'm'.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800313std::string JniLongName(mirror::ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700314 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes79082e32011-08-25 12:07:32 -0700315
Elliott Hughesd92bec42011-09-02 17:04:36 -0700316bool ReadFileToString(const std::string& file_name, std::string* result);
buzbeec143c552011-08-20 17:38:58 -0700317
Elliott Hughese27955c2011-08-26 15:21:24 -0700318// Returns the current date in ISO yyyy-mm-dd hh:mm:ss format.
319std::string GetIsoDate();
320
Elliott Hughes0512f022012-03-15 22:10:52 -0700321// Returns the monotonic time since some unspecified starting point in milliseconds.
Elliott Hughes7162ad92011-10-27 14:08:42 -0700322uint64_t MilliTime();
323
Elliott Hughes0512f022012-03-15 22:10:52 -0700324// Returns the monotonic time since some unspecified starting point in microseconds.
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800325uint64_t MicroTime();
326
Elliott Hughes0512f022012-03-15 22:10:52 -0700327// Returns the monotonic time since some unspecified starting point in nanoseconds.
Elliott Hughes83df2ac2011-10-11 16:37:54 -0700328uint64_t NanoTime();
329
Elliott Hughes0512f022012-03-15 22:10:52 -0700330// Returns the thread-specific CPU-time clock in nanoseconds or -1 if unavailable.
331uint64_t ThreadCpuNanoTime();
332
Elliott Hughesbb551fa2012-01-25 16:35:29 -0800333// Converts the given number of nanoseconds to milliseconds.
Mathieu Chartier720ef762013-08-17 14:46:54 -0700334static constexpr inline uint64_t NsToMs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800335 return ns / 1000 / 1000;
336}
337
338// Converts the given number of milliseconds to nanoseconds
Mathieu Chartier720ef762013-08-17 14:46:54 -0700339static constexpr inline uint64_t MsToNs(uint64_t ns) {
Ian Rogers3bb17a62012-01-27 23:56:44 -0800340 return ns * 1000 * 1000;
341}
342
Brian Carlstrombcc29262012-11-02 11:36:03 -0700343#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 Rogers56edc432013-01-18 16:51:51 -0800348// Sleep for the given number of nanoseconds, a bad way to handle contention.
349void NanoSleep(uint64_t ns);
350
Brian Carlstrombcc29262012-11-02 11:36:03 -0700351// Initialize a timespec to either an absolute or relative time.
352void InitTimeSpec(bool absolute, int clock, int64_t ms, int32_t ns, timespec* ts);
353
Elliott Hughes48436bb2012-02-07 15:23:28 -0800354// Splits a string using the given separator character into a vector of
Elliott Hughes34023802011-08-30 12:06:17 -0700355// strings. Empty strings will be omitted.
Elliott Hughes48436bb2012-02-07 15:23:28 -0800356void Split(const std::string& s, char separator, std::vector<std::string>& result);
357
Dave Allison70202782013-10-22 17:52:19 -0700358// Trims whitespace off both ends of the given string.
359std::string Trim(std::string s);
360
Elliott Hughes48436bb2012-02-07 15:23:28 -0800361// Joins a vector of strings into a single string, using the given separator.
362template <typename StringT> std::string Join(std::vector<StringT>& strings, char separator);
Elliott Hughes34023802011-08-30 12:06:17 -0700363
Elliott Hughes42ee1422011-09-06 12:33:32 -0700364// Returns the calling thread's tid. (The C libraries don't expose this.)
365pid_t GetTid();
366
Elliott Hughes289be852012-06-12 13:57:20 -0700367// Returns the given thread's name.
368std::string GetThreadName(pid_t tid);
369
Ian Rogers120f1c72012-09-28 17:17:10 -0700370// Returns details of the given thread's stack.
Brian Carlstrom29212012013-09-12 22:18:30 -0700371void GetThreadStack(pthread_t thread, void** stack_base, size_t* stack_size);
Elliott Hughese1884192012-04-23 12:38:15 -0700372
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700373// Reads data from "/proc/self/task/${tid}/stat".
Brian Carlstrom29212012013-09-12 22:18:30 -0700374void GetTaskStats(pid_t tid, char* state, int* utime, int* stime, int* task_cpu);
Elliott Hughesbfe487b2011-10-26 15:48:55 -0700375
Elliott Hughes1bac54f2012-03-16 12:48:31 -0700376// Returns the name of the scheduler group for the given thread the current process, or the empty string.
377std::string GetSchedulerGroupName(pid_t tid);
378
Elliott Hughesdcc24742011-09-07 14:02:44 -0700379// Sets the name of the current thread. The name may be truncated to an
380// implementation-defined limit.
Elliott Hughes22869a92012-03-27 14:08:24 -0700381void SetThreadName(const char* thread_name);
Elliott Hughesdcc24742011-09-07 14:02:44 -0700382
Elliott Hughes46e251b2012-05-22 15:10:45 -0700383// Dumps the native stack for thread 'tid' to 'os'.
Kenny Root067d20f2014-03-05 14:57:21 -0800384void DumpNativeStack(std::ostream& os, pid_t tid, const char* prefix = "",
385 bool include_count = true, mirror::ArtMethod* current_method = nullptr)
386 NO_THREAD_SAFETY_ANALYSIS;
Elliott Hughes46e251b2012-05-22 15:10:45 -0700387
388// Dumps the kernel stack for thread 'tid' to 'os'. Note that this is only available on linux-x86.
389void DumpKernelStack(std::ostream& os, pid_t tid, const char* prefix = "", bool include_count = true);
390
Dave Allison70202782013-10-22 17:52:19 -0700391// Find $ANDROID_ROOT, /system, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800392const char* GetAndroidRoot();
393
Dave Allison70202782013-10-22 17:52:19 -0700394// Find $ANDROID_DATA, /data, or abort.
Brian Carlstroma56fcd62012-02-04 21:23:01 -0800395const char* GetAndroidData();
396
Brian Carlstrom7675e162013-06-10 16:18:04 -0700397// Returns the dalvik-cache location, or dies trying.
398std::string GetDalvikCacheOrDie(const char* android_data);
Brian Carlstroma9f19782011-10-13 00:14:47 -0700399
Brian Carlstrom7675e162013-06-10 16:18:04 -0700400// Returns the dalvik-cache location for a DexFile or OatFile, or dies trying.
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700401std::string GetDalvikCacheFilenameOrDie(const char* location);
jeffhao262bf462011-10-20 18:36:32 -0700402
Brian Carlstrom7c3d13a2013-09-04 17:15:11 -0700403// Check whether the given magic matches a known file type.
404bool IsZipMagic(uint32_t magic);
405bool IsDexMagic(uint32_t magic);
406bool IsOatMagic(uint32_t magic);
Brian Carlstromb7bbba42011-10-13 14:58:47 -0700407
Brian Carlstrom6449c622014-02-10 23:48:36 -0800408// Wrapper on fork/execv to run a command in a subprocess.
409bool Exec(std::vector<std::string>& arg_vector, std::string* error_msg);
410
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800411class VoidFunctor {
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700412 public:
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800413 template <typename A>
Brian Carlstromdf629502013-07-17 22:39:56 -0700414 inline void operator() (A a) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800415 UNUSED(a);
416 }
417
418 template <typename A, typename B>
Brian Carlstromdf629502013-07-17 22:39:56 -0700419 inline void operator() (A a, B b) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800420 UNUSED(a);
421 UNUSED(b);
422 }
423
424 template <typename A, typename B, typename C>
Brian Carlstromdf629502013-07-17 22:39:56 -0700425 inline void operator() (A a, B b, C c) const {
Mathieu Chartierd22d5482012-11-06 17:14:12 -0800426 UNUSED(a);
427 UNUSED(b);
428 UNUSED(c);
429 }
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700430};
431
Carl Shapiro6b6b5f02011-06-21 15:05:09 -0700432} // namespace art
Carl Shapiroa5d5cfd2011-06-21 12:46:59 -0700433
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700434#endif // ART_RUNTIME_UTILS_H_