utils.cc revision bfd9a4378eacaf2dc2bbe05ad48c5164fc93c9fe
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 */ 16 17#include "utils.h" 18 19#include <inttypes.h> 20#include <pthread.h> 21#include <sys/stat.h> 22#include <sys/syscall.h> 23#include <sys/types.h> 24#include <sys/wait.h> 25#include <unistd.h> 26#include <memory> 27 28#include "base/stl_util.h" 29#include "base/unix_file/fd_file.h" 30#include "dex_file-inl.h" 31#include "mirror/art_field-inl.h" 32#include "mirror/art_method-inl.h" 33#include "mirror/class-inl.h" 34#include "mirror/class_loader.h" 35#include "mirror/object-inl.h" 36#include "mirror/object_array-inl.h" 37#include "mirror/string.h" 38#include "object_utils.h" 39#include "os.h" 40#include "scoped_thread_state_change.h" 41#include "utf-inl.h" 42 43#if !defined(HAVE_POSIX_CLOCKS) 44#include <sys/time.h> 45#endif 46 47#if defined(HAVE_PRCTL) 48#include <sys/prctl.h> 49#endif 50 51#if defined(__APPLE__) 52#include "AvailabilityMacros.h" // For MAC_OS_X_VERSION_MAX_ALLOWED 53#include <sys/syscall.h> 54#endif 55 56#include <backtrace/Backtrace.h> // For DumpNativeStack. 57 58#if defined(__linux__) 59#include <linux/unistd.h> 60#endif 61 62namespace art { 63 64pid_t GetTid() { 65#if defined(__APPLE__) 66 uint64_t owner; 67 CHECK_PTHREAD_CALL(pthread_threadid_np, (NULL, &owner), __FUNCTION__); // Requires Mac OS 10.6 68 return owner; 69#else 70 // Neither bionic nor glibc exposes gettid(2). 71 return syscall(__NR_gettid); 72#endif 73} 74 75std::string GetThreadName(pid_t tid) { 76 std::string result; 77 if (ReadFileToString(StringPrintf("/proc/self/task/%d/comm", tid), &result)) { 78 result.resize(result.size() - 1); // Lose the trailing '\n'. 79 } else { 80 result = "<unknown>"; 81 } 82 return result; 83} 84 85void GetThreadStack(pthread_t thread, void** stack_base, size_t* stack_size) { 86#if defined(__APPLE__) 87 *stack_size = pthread_get_stacksize_np(thread); 88 void* stack_addr = pthread_get_stackaddr_np(thread); 89 90 // Check whether stack_addr is the base or end of the stack. 91 // (On Mac OS 10.7, it's the end.) 92 int stack_variable; 93 if (stack_addr > &stack_variable) { 94 *stack_base = reinterpret_cast<byte*>(stack_addr) - *stack_size; 95 } else { 96 *stack_base = stack_addr; 97 } 98#else 99 pthread_attr_t attributes; 100 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__); 101 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__); 102 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__); 103#endif 104} 105 106bool ReadFileToString(const std::string& file_name, std::string* result) { 107 std::unique_ptr<File> file(new File); 108 if (!file->Open(file_name, O_RDONLY)) { 109 return false; 110 } 111 112 std::vector<char> buf(8 * KB); 113 while (true) { 114 int64_t n = TEMP_FAILURE_RETRY(read(file->Fd(), &buf[0], buf.size())); 115 if (n == -1) { 116 return false; 117 } 118 if (n == 0) { 119 return true; 120 } 121 result->append(&buf[0], n); 122 } 123} 124 125std::string GetIsoDate() { 126 time_t now = time(NULL); 127 tm tmbuf; 128 tm* ptm = localtime_r(&now, &tmbuf); 129 return StringPrintf("%04d-%02d-%02d %02d:%02d:%02d", 130 ptm->tm_year + 1900, ptm->tm_mon+1, ptm->tm_mday, 131 ptm->tm_hour, ptm->tm_min, ptm->tm_sec); 132} 133 134uint64_t MilliTime() { 135#if defined(HAVE_POSIX_CLOCKS) 136 timespec now; 137 clock_gettime(CLOCK_MONOTONIC, &now); 138 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000) + now.tv_nsec / UINT64_C(1000000); 139#else 140 timeval now; 141 gettimeofday(&now, NULL); 142 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000) + now.tv_usec / UINT64_C(1000); 143#endif 144} 145 146uint64_t MicroTime() { 147#if defined(HAVE_POSIX_CLOCKS) 148 timespec now; 149 clock_gettime(CLOCK_MONOTONIC, &now); 150 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000); 151#else 152 timeval now; 153 gettimeofday(&now, NULL); 154 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_usec; 155#endif 156} 157 158uint64_t NanoTime() { 159#if defined(HAVE_POSIX_CLOCKS) 160 timespec now; 161 clock_gettime(CLOCK_MONOTONIC, &now); 162 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000000) + now.tv_nsec; 163#else 164 timeval now; 165 gettimeofday(&now, NULL); 166 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000000) + now.tv_usec * UINT64_C(1000); 167#endif 168} 169 170uint64_t ThreadCpuNanoTime() { 171#if defined(HAVE_POSIX_CLOCKS) 172 timespec now; 173 clock_gettime(CLOCK_THREAD_CPUTIME_ID, &now); 174 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000000) + now.tv_nsec; 175#else 176 UNIMPLEMENTED(WARNING); 177 return -1; 178#endif 179} 180 181void NanoSleep(uint64_t ns) { 182 timespec tm; 183 tm.tv_sec = 0; 184 tm.tv_nsec = ns; 185 nanosleep(&tm, NULL); 186} 187 188void InitTimeSpec(bool absolute, int clock, int64_t ms, int32_t ns, timespec* ts) { 189 int64_t endSec; 190 191 if (absolute) { 192#if !defined(__APPLE__) 193 clock_gettime(clock, ts); 194#else 195 UNUSED(clock); 196 timeval tv; 197 gettimeofday(&tv, NULL); 198 ts->tv_sec = tv.tv_sec; 199 ts->tv_nsec = tv.tv_usec * 1000; 200#endif 201 } else { 202 ts->tv_sec = 0; 203 ts->tv_nsec = 0; 204 } 205 endSec = ts->tv_sec + ms / 1000; 206 if (UNLIKELY(endSec >= 0x7fffffff)) { 207 std::ostringstream ss; 208 LOG(INFO) << "Note: end time exceeds epoch: " << ss.str(); 209 endSec = 0x7ffffffe; 210 } 211 ts->tv_sec = endSec; 212 ts->tv_nsec = (ts->tv_nsec + (ms % 1000) * 1000000) + ns; 213 214 // Catch rollover. 215 if (ts->tv_nsec >= 1000000000L) { 216 ts->tv_sec++; 217 ts->tv_nsec -= 1000000000L; 218 } 219} 220 221std::string PrettyDescriptor(mirror::String* java_descriptor) { 222 if (java_descriptor == NULL) { 223 return "null"; 224 } 225 return PrettyDescriptor(java_descriptor->ToModifiedUtf8()); 226} 227 228std::string PrettyDescriptor(mirror::Class* klass) { 229 if (klass == NULL) { 230 return "null"; 231 } 232 return PrettyDescriptor(klass->GetDescriptor()); 233} 234 235std::string PrettyDescriptor(const std::string& descriptor) { 236 // Count the number of '['s to get the dimensionality. 237 const char* c = descriptor.c_str(); 238 size_t dim = 0; 239 while (*c == '[') { 240 dim++; 241 c++; 242 } 243 244 // Reference or primitive? 245 if (*c == 'L') { 246 // "[[La/b/C;" -> "a.b.C[][]". 247 c++; // Skip the 'L'. 248 } else { 249 // "[[B" -> "byte[][]". 250 // To make life easier, we make primitives look like unqualified 251 // reference types. 252 switch (*c) { 253 case 'B': c = "byte;"; break; 254 case 'C': c = "char;"; break; 255 case 'D': c = "double;"; break; 256 case 'F': c = "float;"; break; 257 case 'I': c = "int;"; break; 258 case 'J': c = "long;"; break; 259 case 'S': c = "short;"; break; 260 case 'Z': c = "boolean;"; break; 261 case 'V': c = "void;"; break; // Used when decoding return types. 262 default: return descriptor; 263 } 264 } 265 266 // At this point, 'c' is a string of the form "fully/qualified/Type;" 267 // or "primitive;". Rewrite the type with '.' instead of '/': 268 std::string result; 269 const char* p = c; 270 while (*p != ';') { 271 char ch = *p++; 272 if (ch == '/') { 273 ch = '.'; 274 } 275 result.push_back(ch); 276 } 277 // ...and replace the semicolon with 'dim' "[]" pairs: 278 while (dim--) { 279 result += "[]"; 280 } 281 return result; 282} 283 284std::string PrettyDescriptor(Primitive::Type type) { 285 std::string descriptor_string(Primitive::Descriptor(type)); 286 return PrettyDescriptor(descriptor_string); 287} 288 289std::string PrettyField(mirror::ArtField* f, bool with_type) { 290 if (f == NULL) { 291 return "null"; 292 } 293 std::string result; 294 if (with_type) { 295 result += PrettyDescriptor(f->GetTypeDescriptor()); 296 result += ' '; 297 } 298 StackHandleScope<1> hs(Thread::Current()); 299 result += PrettyDescriptor(FieldHelper(hs.NewHandle(f)).GetDeclaringClassDescriptor()); 300 result += '.'; 301 result += f->GetName(); 302 return result; 303} 304 305std::string PrettyField(uint32_t field_idx, const DexFile& dex_file, bool with_type) { 306 if (field_idx >= dex_file.NumFieldIds()) { 307 return StringPrintf("<<invalid-field-idx-%d>>", field_idx); 308 } 309 const DexFile::FieldId& field_id = dex_file.GetFieldId(field_idx); 310 std::string result; 311 if (with_type) { 312 result += dex_file.GetFieldTypeDescriptor(field_id); 313 result += ' '; 314 } 315 result += PrettyDescriptor(dex_file.GetFieldDeclaringClassDescriptor(field_id)); 316 result += '.'; 317 result += dex_file.GetFieldName(field_id); 318 return result; 319} 320 321std::string PrettyType(uint32_t type_idx, const DexFile& dex_file) { 322 if (type_idx >= dex_file.NumTypeIds()) { 323 return StringPrintf("<<invalid-type-idx-%d>>", type_idx); 324 } 325 const DexFile::TypeId& type_id = dex_file.GetTypeId(type_idx); 326 return PrettyDescriptor(dex_file.GetTypeDescriptor(type_id)); 327} 328 329std::string PrettyArguments(const char* signature) { 330 std::string result; 331 result += '('; 332 CHECK_EQ(*signature, '('); 333 ++signature; // Skip the '('. 334 while (*signature != ')') { 335 size_t argument_length = 0; 336 while (signature[argument_length] == '[') { 337 ++argument_length; 338 } 339 if (signature[argument_length] == 'L') { 340 argument_length = (strchr(signature, ';') - signature + 1); 341 } else { 342 ++argument_length; 343 } 344 std::string argument_descriptor(signature, argument_length); 345 result += PrettyDescriptor(argument_descriptor); 346 if (signature[argument_length] != ')') { 347 result += ", "; 348 } 349 signature += argument_length; 350 } 351 CHECK_EQ(*signature, ')'); 352 ++signature; // Skip the ')'. 353 result += ')'; 354 return result; 355} 356 357std::string PrettyReturnType(const char* signature) { 358 const char* return_type = strchr(signature, ')'); 359 CHECK(return_type != NULL); 360 ++return_type; // Skip ')'. 361 return PrettyDescriptor(return_type); 362} 363 364std::string PrettyMethod(mirror::ArtMethod* m, bool with_signature) { 365 if (m == nullptr) { 366 return "null"; 367 } 368 std::string result(PrettyDescriptor(m->GetDeclaringClassDescriptor())); 369 result += '.'; 370 result += m->GetName(); 371 if (UNLIKELY(m->IsFastNative())) { 372 result += "!"; 373 } 374 if (with_signature) { 375 const Signature signature = m->GetSignature(); 376 std::string sig_as_string(signature.ToString()); 377 if (signature == Signature::NoSignature()) { 378 return result + sig_as_string; 379 } 380 result = PrettyReturnType(sig_as_string.c_str()) + " " + result + 381 PrettyArguments(sig_as_string.c_str()); 382 } 383 return result; 384} 385 386std::string PrettyMethod(uint32_t method_idx, const DexFile& dex_file, bool with_signature) { 387 if (method_idx >= dex_file.NumMethodIds()) { 388 return StringPrintf("<<invalid-method-idx-%d>>", method_idx); 389 } 390 const DexFile::MethodId& method_id = dex_file.GetMethodId(method_idx); 391 std::string result(PrettyDescriptor(dex_file.GetMethodDeclaringClassDescriptor(method_id))); 392 result += '.'; 393 result += dex_file.GetMethodName(method_id); 394 if (with_signature) { 395 const Signature signature = dex_file.GetMethodSignature(method_id); 396 std::string sig_as_string(signature.ToString()); 397 if (signature == Signature::NoSignature()) { 398 return result + sig_as_string; 399 } 400 result = PrettyReturnType(sig_as_string.c_str()) + " " + result + 401 PrettyArguments(sig_as_string.c_str()); 402 } 403 return result; 404} 405 406std::string PrettyTypeOf(mirror::Object* obj) { 407 if (obj == NULL) { 408 return "null"; 409 } 410 if (obj->GetClass() == NULL) { 411 return "(raw)"; 412 } 413 std::string result(PrettyDescriptor(obj->GetClass()->GetDescriptor())); 414 if (obj->IsClass()) { 415 result += "<" + PrettyDescriptor(obj->AsClass()->GetDescriptor()) + ">"; 416 } 417 return result; 418} 419 420std::string PrettyClass(mirror::Class* c) { 421 if (c == NULL) { 422 return "null"; 423 } 424 std::string result; 425 result += "java.lang.Class<"; 426 result += PrettyDescriptor(c); 427 result += ">"; 428 return result; 429} 430 431std::string PrettyClassAndClassLoader(mirror::Class* c) { 432 if (c == NULL) { 433 return "null"; 434 } 435 std::string result; 436 result += "java.lang.Class<"; 437 result += PrettyDescriptor(c); 438 result += ","; 439 result += PrettyTypeOf(c->GetClassLoader()); 440 // TODO: add an identifying hash value for the loader 441 result += ">"; 442 return result; 443} 444 445std::string PrettySize(int64_t byte_count) { 446 // The byte thresholds at which we display amounts. A byte count is displayed 447 // in unit U when kUnitThresholds[U] <= bytes < kUnitThresholds[U+1]. 448 static const int64_t kUnitThresholds[] = { 449 0, // B up to... 450 3*1024, // KB up to... 451 2*1024*1024, // MB up to... 452 1024*1024*1024 // GB from here. 453 }; 454 static const int64_t kBytesPerUnit[] = { 1, KB, MB, GB }; 455 static const char* const kUnitStrings[] = { "B", "KB", "MB", "GB" }; 456 const char* negative_str = ""; 457 if (byte_count < 0) { 458 negative_str = "-"; 459 byte_count = -byte_count; 460 } 461 int i = arraysize(kUnitThresholds); 462 while (--i > 0) { 463 if (byte_count >= kUnitThresholds[i]) { 464 break; 465 } 466 } 467 return StringPrintf("%s%" PRId64 "%s", 468 negative_str, byte_count / kBytesPerUnit[i], kUnitStrings[i]); 469} 470 471std::string PrettyDuration(uint64_t nano_duration) { 472 if (nano_duration == 0) { 473 return "0"; 474 } else { 475 return FormatDuration(nano_duration, GetAppropriateTimeUnit(nano_duration)); 476 } 477} 478 479TimeUnit GetAppropriateTimeUnit(uint64_t nano_duration) { 480 const uint64_t one_sec = 1000 * 1000 * 1000; 481 const uint64_t one_ms = 1000 * 1000; 482 const uint64_t one_us = 1000; 483 if (nano_duration >= one_sec) { 484 return kTimeUnitSecond; 485 } else if (nano_duration >= one_ms) { 486 return kTimeUnitMillisecond; 487 } else if (nano_duration >= one_us) { 488 return kTimeUnitMicrosecond; 489 } else { 490 return kTimeUnitNanosecond; 491 } 492} 493 494uint64_t GetNsToTimeUnitDivisor(TimeUnit time_unit) { 495 const uint64_t one_sec = 1000 * 1000 * 1000; 496 const uint64_t one_ms = 1000 * 1000; 497 const uint64_t one_us = 1000; 498 499 switch (time_unit) { 500 case kTimeUnitSecond: 501 return one_sec; 502 case kTimeUnitMillisecond: 503 return one_ms; 504 case kTimeUnitMicrosecond: 505 return one_us; 506 case kTimeUnitNanosecond: 507 return 1; 508 } 509 return 0; 510} 511 512std::string FormatDuration(uint64_t nano_duration, TimeUnit time_unit) { 513 const char* unit = NULL; 514 uint64_t divisor = GetNsToTimeUnitDivisor(time_unit); 515 uint32_t zero_fill = 1; 516 switch (time_unit) { 517 case kTimeUnitSecond: 518 unit = "s"; 519 zero_fill = 9; 520 break; 521 case kTimeUnitMillisecond: 522 unit = "ms"; 523 zero_fill = 6; 524 break; 525 case kTimeUnitMicrosecond: 526 unit = "us"; 527 zero_fill = 3; 528 break; 529 case kTimeUnitNanosecond: 530 unit = "ns"; 531 zero_fill = 0; 532 break; 533 } 534 535 uint64_t whole_part = nano_duration / divisor; 536 uint64_t fractional_part = nano_duration % divisor; 537 if (fractional_part == 0) { 538 return StringPrintf("%" PRIu64 "%s", whole_part, unit); 539 } else { 540 while ((fractional_part % 1000) == 0) { 541 zero_fill -= 3; 542 fractional_part /= 1000; 543 } 544 if (zero_fill == 3) { 545 return StringPrintf("%" PRIu64 ".%03" PRIu64 "%s", whole_part, fractional_part, unit); 546 } else if (zero_fill == 6) { 547 return StringPrintf("%" PRIu64 ".%06" PRIu64 "%s", whole_part, fractional_part, unit); 548 } else { 549 return StringPrintf("%" PRIu64 ".%09" PRIu64 "%s", whole_part, fractional_part, unit); 550 } 551 } 552} 553 554std::string PrintableChar(uint16_t ch) { 555 std::string result; 556 result += '\''; 557 if (NeedsEscaping(ch)) { 558 StringAppendF(&result, "\\u%04x", ch); 559 } else { 560 result += ch; 561 } 562 result += '\''; 563 return result; 564} 565 566std::string PrintableString(const std::string& utf) { 567 std::string result; 568 result += '"'; 569 const char* p = utf.c_str(); 570 size_t char_count = CountModifiedUtf8Chars(p); 571 for (size_t i = 0; i < char_count; ++i) { 572 uint16_t ch = GetUtf16FromUtf8(&p); 573 if (ch == '\\') { 574 result += "\\\\"; 575 } else if (ch == '\n') { 576 result += "\\n"; 577 } else if (ch == '\r') { 578 result += "\\r"; 579 } else if (ch == '\t') { 580 result += "\\t"; 581 } else if (NeedsEscaping(ch)) { 582 StringAppendF(&result, "\\u%04x", ch); 583 } else { 584 result += ch; 585 } 586 } 587 result += '"'; 588 return result; 589} 590 591// See http://java.sun.com/j2se/1.5.0/docs/guide/jni/spec/design.html#wp615 for the full rules. 592std::string MangleForJni(const std::string& s) { 593 std::string result; 594 size_t char_count = CountModifiedUtf8Chars(s.c_str()); 595 const char* cp = &s[0]; 596 for (size_t i = 0; i < char_count; ++i) { 597 uint16_t ch = GetUtf16FromUtf8(&cp); 598 if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') || (ch >= '0' && ch <= '9')) { 599 result.push_back(ch); 600 } else if (ch == '.' || ch == '/') { 601 result += "_"; 602 } else if (ch == '_') { 603 result += "_1"; 604 } else if (ch == ';') { 605 result += "_2"; 606 } else if (ch == '[') { 607 result += "_3"; 608 } else { 609 StringAppendF(&result, "_0%04x", ch); 610 } 611 } 612 return result; 613} 614 615std::string DotToDescriptor(const char* class_name) { 616 std::string descriptor(class_name); 617 std::replace(descriptor.begin(), descriptor.end(), '.', '/'); 618 if (descriptor.length() > 0 && descriptor[0] != '[') { 619 descriptor = "L" + descriptor + ";"; 620 } 621 return descriptor; 622} 623 624std::string DescriptorToDot(const char* descriptor) { 625 size_t length = strlen(descriptor); 626 if (descriptor[0] == 'L' && descriptor[length - 1] == ';') { 627 std::string result(descriptor + 1, length - 2); 628 std::replace(result.begin(), result.end(), '/', '.'); 629 return result; 630 } 631 return descriptor; 632} 633 634std::string DescriptorToName(const char* descriptor) { 635 size_t length = strlen(descriptor); 636 if (descriptor[0] == 'L' && descriptor[length - 1] == ';') { 637 std::string result(descriptor + 1, length - 2); 638 return result; 639 } 640 return descriptor; 641} 642 643std::string JniShortName(mirror::ArtMethod* m) { 644 std::string class_name(m->GetDeclaringClassDescriptor()); 645 // Remove the leading 'L' and trailing ';'... 646 CHECK_EQ(class_name[0], 'L') << class_name; 647 CHECK_EQ(class_name[class_name.size() - 1], ';') << class_name; 648 class_name.erase(0, 1); 649 class_name.erase(class_name.size() - 1, 1); 650 651 std::string method_name(m->GetName()); 652 653 std::string short_name; 654 short_name += "Java_"; 655 short_name += MangleForJni(class_name); 656 short_name += "_"; 657 short_name += MangleForJni(method_name); 658 return short_name; 659} 660 661std::string JniLongName(mirror::ArtMethod* m) { 662 std::string long_name; 663 long_name += JniShortName(m); 664 long_name += "__"; 665 666 std::string signature(m->GetSignature().ToString()); 667 signature.erase(0, 1); 668 signature.erase(signature.begin() + signature.find(')'), signature.end()); 669 670 long_name += MangleForJni(signature); 671 672 return long_name; 673} 674 675// Helper for IsValidPartOfMemberNameUtf8(), a bit vector indicating valid low ascii. 676uint32_t DEX_MEMBER_VALID_LOW_ASCII[4] = { 677 0x00000000, // 00..1f low control characters; nothing valid 678 0x03ff2010, // 20..3f digits and symbols; valid: '0'..'9', '$', '-' 679 0x87fffffe, // 40..5f uppercase etc.; valid: 'A'..'Z', '_' 680 0x07fffffe // 60..7f lowercase etc.; valid: 'a'..'z' 681}; 682 683// Helper for IsValidPartOfMemberNameUtf8(); do not call directly. 684bool IsValidPartOfMemberNameUtf8Slow(const char** pUtf8Ptr) { 685 /* 686 * It's a multibyte encoded character. Decode it and analyze. We 687 * accept anything that isn't (a) an improperly encoded low value, 688 * (b) an improper surrogate pair, (c) an encoded '\0', (d) a high 689 * control character, or (e) a high space, layout, or special 690 * character (U+00a0, U+2000..U+200f, U+2028..U+202f, 691 * U+fff0..U+ffff). This is all specified in the dex format 692 * document. 693 */ 694 695 uint16_t utf16 = GetUtf16FromUtf8(pUtf8Ptr); 696 697 // Perform follow-up tests based on the high 8 bits. 698 switch (utf16 >> 8) { 699 case 0x00: 700 // It's only valid if it's above the ISO-8859-1 high space (0xa0). 701 return (utf16 > 0x00a0); 702 case 0xd8: 703 case 0xd9: 704 case 0xda: 705 case 0xdb: 706 // It's a leading surrogate. Check to see that a trailing 707 // surrogate follows. 708 utf16 = GetUtf16FromUtf8(pUtf8Ptr); 709 return (utf16 >= 0xdc00) && (utf16 <= 0xdfff); 710 case 0xdc: 711 case 0xdd: 712 case 0xde: 713 case 0xdf: 714 // It's a trailing surrogate, which is not valid at this point. 715 return false; 716 case 0x20: 717 case 0xff: 718 // It's in the range that has spaces, controls, and specials. 719 switch (utf16 & 0xfff8) { 720 case 0x2000: 721 case 0x2008: 722 case 0x2028: 723 case 0xfff0: 724 case 0xfff8: 725 return false; 726 } 727 break; 728 } 729 return true; 730} 731 732/* Return whether the pointed-at modified-UTF-8 encoded character is 733 * valid as part of a member name, updating the pointer to point past 734 * the consumed character. This will consume two encoded UTF-16 code 735 * points if the character is encoded as a surrogate pair. Also, if 736 * this function returns false, then the given pointer may only have 737 * been partially advanced. 738 */ 739static bool IsValidPartOfMemberNameUtf8(const char** pUtf8Ptr) { 740 uint8_t c = (uint8_t) **pUtf8Ptr; 741 if (LIKELY(c <= 0x7f)) { 742 // It's low-ascii, so check the table. 743 uint32_t wordIdx = c >> 5; 744 uint32_t bitIdx = c & 0x1f; 745 (*pUtf8Ptr)++; 746 return (DEX_MEMBER_VALID_LOW_ASCII[wordIdx] & (1 << bitIdx)) != 0; 747 } 748 749 // It's a multibyte encoded character. Call a non-inline function 750 // for the heavy lifting. 751 return IsValidPartOfMemberNameUtf8Slow(pUtf8Ptr); 752} 753 754bool IsValidMemberName(const char* s) { 755 bool angle_name = false; 756 757 switch (*s) { 758 case '\0': 759 // The empty string is not a valid name. 760 return false; 761 case '<': 762 angle_name = true; 763 s++; 764 break; 765 } 766 767 while (true) { 768 switch (*s) { 769 case '\0': 770 return !angle_name; 771 case '>': 772 return angle_name && s[1] == '\0'; 773 } 774 775 if (!IsValidPartOfMemberNameUtf8(&s)) { 776 return false; 777 } 778 } 779} 780 781enum ClassNameType { kName, kDescriptor }; 782static bool IsValidClassName(const char* s, ClassNameType type, char separator) { 783 int arrayCount = 0; 784 while (*s == '[') { 785 arrayCount++; 786 s++; 787 } 788 789 if (arrayCount > 255) { 790 // Arrays may have no more than 255 dimensions. 791 return false; 792 } 793 794 if (arrayCount != 0) { 795 /* 796 * If we're looking at an array of some sort, then it doesn't 797 * matter if what is being asked for is a class name; the 798 * format looks the same as a type descriptor in that case, so 799 * treat it as such. 800 */ 801 type = kDescriptor; 802 } 803 804 if (type == kDescriptor) { 805 /* 806 * We are looking for a descriptor. Either validate it as a 807 * single-character primitive type, or continue on to check the 808 * embedded class name (bracketed by "L" and ";"). 809 */ 810 switch (*(s++)) { 811 case 'B': 812 case 'C': 813 case 'D': 814 case 'F': 815 case 'I': 816 case 'J': 817 case 'S': 818 case 'Z': 819 // These are all single-character descriptors for primitive types. 820 return (*s == '\0'); 821 case 'V': 822 // Non-array void is valid, but you can't have an array of void. 823 return (arrayCount == 0) && (*s == '\0'); 824 case 'L': 825 // Class name: Break out and continue below. 826 break; 827 default: 828 // Oddball descriptor character. 829 return false; 830 } 831 } 832 833 /* 834 * We just consumed the 'L' that introduces a class name as part 835 * of a type descriptor, or we are looking for an unadorned class 836 * name. 837 */ 838 839 bool sepOrFirst = true; // first character or just encountered a separator. 840 for (;;) { 841 uint8_t c = (uint8_t) *s; 842 switch (c) { 843 case '\0': 844 /* 845 * Premature end for a type descriptor, but valid for 846 * a class name as long as we haven't encountered an 847 * empty component (including the degenerate case of 848 * the empty string ""). 849 */ 850 return (type == kName) && !sepOrFirst; 851 case ';': 852 /* 853 * Invalid character for a class name, but the 854 * legitimate end of a type descriptor. In the latter 855 * case, make sure that this is the end of the string 856 * and that it doesn't end with an empty component 857 * (including the degenerate case of "L;"). 858 */ 859 return (type == kDescriptor) && !sepOrFirst && (s[1] == '\0'); 860 case '/': 861 case '.': 862 if (c != separator) { 863 // The wrong separator character. 864 return false; 865 } 866 if (sepOrFirst) { 867 // Separator at start or two separators in a row. 868 return false; 869 } 870 sepOrFirst = true; 871 s++; 872 break; 873 default: 874 if (!IsValidPartOfMemberNameUtf8(&s)) { 875 return false; 876 } 877 sepOrFirst = false; 878 break; 879 } 880 } 881} 882 883bool IsValidBinaryClassName(const char* s) { 884 return IsValidClassName(s, kName, '.'); 885} 886 887bool IsValidJniClassName(const char* s) { 888 return IsValidClassName(s, kName, '/'); 889} 890 891bool IsValidDescriptor(const char* s) { 892 return IsValidClassName(s, kDescriptor, '/'); 893} 894 895void Split(const std::string& s, char separator, std::vector<std::string>& result) { 896 const char* p = s.data(); 897 const char* end = p + s.size(); 898 while (p != end) { 899 if (*p == separator) { 900 ++p; 901 } else { 902 const char* start = p; 903 while (++p != end && *p != separator) { 904 // Skip to the next occurrence of the separator. 905 } 906 result.push_back(std::string(start, p - start)); 907 } 908 } 909} 910 911std::string Trim(std::string s) { 912 std::string result; 913 unsigned int start_index = 0; 914 unsigned int end_index = s.size() - 1; 915 916 // Skip initial whitespace. 917 while (start_index < s.size()) { 918 if (!isspace(s[start_index])) { 919 break; 920 } 921 start_index++; 922 } 923 924 // Skip terminating whitespace. 925 while (end_index >= start_index) { 926 if (!isspace(s[end_index])) { 927 break; 928 } 929 end_index--; 930 } 931 932 // All spaces, no beef. 933 if (end_index < start_index) { 934 return ""; 935 } 936 // Start_index is the first non-space, end_index is the last one. 937 return s.substr(start_index, end_index - start_index + 1); 938} 939 940template <typename StringT> 941std::string Join(std::vector<StringT>& strings, char separator) { 942 if (strings.empty()) { 943 return ""; 944 } 945 946 std::string result(strings[0]); 947 for (size_t i = 1; i < strings.size(); ++i) { 948 result += separator; 949 result += strings[i]; 950 } 951 return result; 952} 953 954// Explicit instantiations. 955template std::string Join<std::string>(std::vector<std::string>& strings, char separator); 956template std::string Join<const char*>(std::vector<const char*>& strings, char separator); 957template std::string Join<char*>(std::vector<char*>& strings, char separator); 958 959bool StartsWith(const std::string& s, const char* prefix) { 960 return s.compare(0, strlen(prefix), prefix) == 0; 961} 962 963bool EndsWith(const std::string& s, const char* suffix) { 964 size_t suffix_length = strlen(suffix); 965 size_t string_length = s.size(); 966 if (suffix_length > string_length) { 967 return false; 968 } 969 size_t offset = string_length - suffix_length; 970 return s.compare(offset, suffix_length, suffix) == 0; 971} 972 973void SetThreadName(const char* thread_name) { 974 int hasAt = 0; 975 int hasDot = 0; 976 const char* s = thread_name; 977 while (*s) { 978 if (*s == '.') { 979 hasDot = 1; 980 } else if (*s == '@') { 981 hasAt = 1; 982 } 983 s++; 984 } 985 int len = s - thread_name; 986 if (len < 15 || hasAt || !hasDot) { 987 s = thread_name; 988 } else { 989 s = thread_name + len - 15; 990 } 991#if defined(HAVE_ANDROID_PTHREAD_SETNAME_NP) 992 // pthread_setname_np fails rather than truncating long strings. 993 char buf[16]; // MAX_TASK_COMM_LEN=16 is hard-coded into bionic 994 strncpy(buf, s, sizeof(buf)-1); 995 buf[sizeof(buf)-1] = '\0'; 996 errno = pthread_setname_np(pthread_self(), buf); 997 if (errno != 0) { 998 PLOG(WARNING) << "Unable to set the name of current thread to '" << buf << "'"; 999 } 1000#elif defined(__APPLE__) && MAC_OS_X_VERSION_MAX_ALLOWED >= 1060 1001 pthread_setname_np(thread_name); 1002#elif defined(HAVE_PRCTL) 1003 prctl(PR_SET_NAME, (unsigned long) s, 0, 0, 0); // NOLINT (unsigned long) 1004#else 1005 UNIMPLEMENTED(WARNING) << thread_name; 1006#endif 1007} 1008 1009void GetTaskStats(pid_t tid, char* state, int* utime, int* stime, int* task_cpu) { 1010 *utime = *stime = *task_cpu = 0; 1011 std::string stats; 1012 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/stat", tid), &stats)) { 1013 return; 1014 } 1015 // Skip the command, which may contain spaces. 1016 stats = stats.substr(stats.find(')') + 2); 1017 // Extract the three fields we care about. 1018 std::vector<std::string> fields; 1019 Split(stats, ' ', fields); 1020 *state = fields[0][0]; 1021 *utime = strtoull(fields[11].c_str(), NULL, 10); 1022 *stime = strtoull(fields[12].c_str(), NULL, 10); 1023 *task_cpu = strtoull(fields[36].c_str(), NULL, 10); 1024} 1025 1026std::string GetSchedulerGroupName(pid_t tid) { 1027 // /proc/<pid>/cgroup looks like this: 1028 // 2:devices:/ 1029 // 1:cpuacct,cpu:/ 1030 // We want the third field from the line whose second field contains the "cpu" token. 1031 std::string cgroup_file; 1032 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) { 1033 return ""; 1034 } 1035 std::vector<std::string> cgroup_lines; 1036 Split(cgroup_file, '\n', cgroup_lines); 1037 for (size_t i = 0; i < cgroup_lines.size(); ++i) { 1038 std::vector<std::string> cgroup_fields; 1039 Split(cgroup_lines[i], ':', cgroup_fields); 1040 std::vector<std::string> cgroups; 1041 Split(cgroup_fields[1], ',', cgroups); 1042 for (size_t i = 0; i < cgroups.size(); ++i) { 1043 if (cgroups[i] == "cpu") { 1044 return cgroup_fields[2].substr(1); // Skip the leading slash. 1045 } 1046 } 1047 } 1048 return ""; 1049} 1050 1051void DumpNativeStack(std::ostream& os, pid_t tid, const char* prefix, 1052 mirror::ArtMethod* current_method) { 1053 // We may be called from contexts where current_method is not null, so we must assert this. 1054 if (current_method != nullptr) { 1055 Locks::mutator_lock_->AssertSharedHeld(Thread::Current()); 1056 } 1057 std::unique_ptr<Backtrace> backtrace(Backtrace::Create(BACKTRACE_CURRENT_PROCESS, tid)); 1058 if (!backtrace->Unwind(0)) { 1059 os << prefix << "(backtrace::Unwind failed for thread " << tid << ")\n"; 1060 return; 1061 } else if (backtrace->NumFrames() == 0) { 1062 os << prefix << "(no native stack frames for thread " << tid << ")\n"; 1063 return; 1064 } 1065 1066 for (Backtrace::const_iterator it = backtrace->begin(); 1067 it != backtrace->end(); ++it) { 1068 // We produce output like this: 1069 // ] #00 pc 000075bb8 /system/lib/libc.so (unwind_backtrace_thread+536) 1070 // In order for parsing tools to continue to function, the stack dump 1071 // format must at least adhere to this format: 1072 // #XX pc <RELATIVE_ADDR> <FULL_PATH_TO_SHARED_LIBRARY> ... 1073 // The parsers require a single space before and after pc, and two spaces 1074 // after the <RELATIVE_ADDR>. There can be any prefix data before the 1075 // #XX. <RELATIVE_ADDR> has to be a hex number but with no 0x prefix. 1076 os << prefix << StringPrintf("#%02zu pc ", it->num); 1077 if (!it->map) { 1078 os << StringPrintf("%08" PRIxPTR " ???", it->pc); 1079 } else { 1080 os << StringPrintf("%08" PRIxPTR " ", it->pc - it->map->start) 1081 << it->map->name << " ("; 1082 if (!it->func_name.empty()) { 1083 os << it->func_name; 1084 if (it->func_offset != 0) { 1085 os << "+" << it->func_offset; 1086 } 1087 } else if (current_method != nullptr && current_method->IsWithinQuickCode(it->pc)) { 1088 const void* start_of_code = current_method->GetEntryPointFromQuickCompiledCode(); 1089 os << JniLongName(current_method) << "+" 1090 << (it->pc - reinterpret_cast<uintptr_t>(start_of_code)); 1091 } else { 1092 os << "???"; 1093 } 1094 os << ")"; 1095 } 1096 os << "\n"; 1097 } 1098} 1099 1100#if defined(__APPLE__) 1101 1102// TODO: is there any way to get the kernel stack on Mac OS? 1103void DumpKernelStack(std::ostream&, pid_t, const char*, bool) {} 1104 1105#else 1106 1107void DumpKernelStack(std::ostream& os, pid_t tid, const char* prefix, bool include_count) { 1108 if (tid == GetTid()) { 1109 // There's no point showing that we're reading our stack out of /proc! 1110 return; 1111 } 1112 1113 std::string kernel_stack_filename(StringPrintf("/proc/self/task/%d/stack", tid)); 1114 std::string kernel_stack; 1115 if (!ReadFileToString(kernel_stack_filename, &kernel_stack)) { 1116 os << prefix << "(couldn't read " << kernel_stack_filename << ")\n"; 1117 return; 1118 } 1119 1120 std::vector<std::string> kernel_stack_frames; 1121 Split(kernel_stack, '\n', kernel_stack_frames); 1122 // We skip the last stack frame because it's always equivalent to "[<ffffffff>] 0xffffffff", 1123 // which looking at the source appears to be the kernel's way of saying "that's all, folks!". 1124 kernel_stack_frames.pop_back(); 1125 for (size_t i = 0; i < kernel_stack_frames.size(); ++i) { 1126 // Turn "[<ffffffff8109156d>] futex_wait_queue_me+0xcd/0x110" 1127 // into "futex_wait_queue_me+0xcd/0x110". 1128 const char* text = kernel_stack_frames[i].c_str(); 1129 const char* close_bracket = strchr(text, ']'); 1130 if (close_bracket != NULL) { 1131 text = close_bracket + 2; 1132 } 1133 os << prefix; 1134 if (include_count) { 1135 os << StringPrintf("#%02zd ", i); 1136 } 1137 os << text << "\n"; 1138 } 1139} 1140 1141#endif 1142 1143const char* GetAndroidRoot() { 1144 const char* android_root = getenv("ANDROID_ROOT"); 1145 if (android_root == NULL) { 1146 if (OS::DirectoryExists("/system")) { 1147 android_root = "/system"; 1148 } else { 1149 LOG(FATAL) << "ANDROID_ROOT not set and /system does not exist"; 1150 return ""; 1151 } 1152 } 1153 if (!OS::DirectoryExists(android_root)) { 1154 LOG(FATAL) << "Failed to find ANDROID_ROOT directory " << android_root; 1155 return ""; 1156 } 1157 return android_root; 1158} 1159 1160const char* GetAndroidData() { 1161 const char* android_data = getenv("ANDROID_DATA"); 1162 if (android_data == NULL) { 1163 if (OS::DirectoryExists("/data")) { 1164 android_data = "/data"; 1165 } else { 1166 LOG(FATAL) << "ANDROID_DATA not set and /data does not exist"; 1167 return ""; 1168 } 1169 } 1170 if (!OS::DirectoryExists(android_data)) { 1171 LOG(FATAL) << "Failed to find ANDROID_DATA directory " << android_data; 1172 return ""; 1173 } 1174 return android_data; 1175} 1176 1177std::string GetDalvikCacheOrDie(const char* subdir, const bool create_if_absent) { 1178 CHECK(subdir != nullptr); 1179 const char* android_data = GetAndroidData(); 1180 const std::string dalvik_cache_root(StringPrintf("%s/dalvik-cache/", android_data)); 1181 const std::string dalvik_cache = dalvik_cache_root + subdir; 1182 if (create_if_absent && !OS::DirectoryExists(dalvik_cache.c_str())) { 1183 // Don't create the system's /data/dalvik-cache/... because it needs special permissions. 1184 if (strcmp(android_data, "/data") != 0) { 1185 int result = mkdir(dalvik_cache_root.c_str(), 0700); 1186 if (result != 0 && errno != EEXIST) { 1187 PLOG(FATAL) << "Failed to create dalvik-cache directory " << dalvik_cache_root; 1188 return ""; 1189 } 1190 result = mkdir(dalvik_cache.c_str(), 0700); 1191 if (result != 0) { 1192 PLOG(FATAL) << "Failed to create dalvik-cache directory " << dalvik_cache; 1193 return ""; 1194 } 1195 } else { 1196 LOG(FATAL) << "Failed to find dalvik-cache directory " << dalvik_cache; 1197 return ""; 1198 } 1199 } 1200 return dalvik_cache; 1201} 1202 1203std::string GetDalvikCacheFilenameOrDie(const char* location, const char* cache_location) { 1204 if (location[0] != '/') { 1205 LOG(FATAL) << "Expected path in location to be absolute: "<< location; 1206 } 1207 std::string cache_file(&location[1]); // skip leading slash 1208 if (!EndsWith(location, ".dex") && !EndsWith(location, ".art")) { 1209 cache_file += "/"; 1210 cache_file += DexFile::kClassesDex; 1211 } 1212 std::replace(cache_file.begin(), cache_file.end(), '/', '@'); 1213 return StringPrintf("%s/%s", cache_location, cache_file.c_str()); 1214} 1215 1216static void InsertIsaDirectory(const InstructionSet isa, std::string* filename) { 1217 // in = /foo/bar/baz 1218 // out = /foo/bar/<isa>/baz 1219 size_t pos = filename->rfind('/'); 1220 CHECK_NE(pos, std::string::npos) << *filename << " " << isa; 1221 filename->insert(pos, "/", 1); 1222 filename->insert(pos + 1, GetInstructionSetString(isa)); 1223} 1224 1225std::string GetSystemImageFilename(const char* location, const InstructionSet isa) { 1226 // location = /system/framework/boot.art 1227 // filename = /system/framework/<isa>/boot.art 1228 std::string filename(location); 1229 InsertIsaDirectory(isa, &filename); 1230 return filename; 1231} 1232 1233std::string DexFilenameToOdexFilename(const std::string& location, const InstructionSet isa) { 1234 // location = /foo/bar/baz.jar 1235 // odex_location = /foo/bar/<isa>/baz.odex 1236 CHECK_GE(location.size(), 4U) << location; // must be at least .123 1237 std::string odex_location(location); 1238 InsertIsaDirectory(isa, &odex_location); 1239 size_t dot_index = odex_location.size() - 3 - 1; // 3=dex or zip or apk 1240 CHECK_EQ('.', odex_location[dot_index]) << location; 1241 odex_location.resize(dot_index + 1); 1242 CHECK_EQ('.', odex_location[odex_location.size()-1]) << location << " " << odex_location; 1243 odex_location += "odex"; 1244 return odex_location; 1245} 1246 1247bool IsZipMagic(uint32_t magic) { 1248 return (('P' == ((magic >> 0) & 0xff)) && 1249 ('K' == ((magic >> 8) & 0xff))); 1250} 1251 1252bool IsDexMagic(uint32_t magic) { 1253 return DexFile::IsMagicValid(reinterpret_cast<const byte*>(&magic)); 1254} 1255 1256bool IsOatMagic(uint32_t magic) { 1257 return (memcmp(reinterpret_cast<const byte*>(magic), 1258 OatHeader::kOatMagic, 1259 sizeof(OatHeader::kOatMagic)) == 0); 1260} 1261 1262bool Exec(std::vector<std::string>& arg_vector, std::string* error_msg) { 1263 const std::string command_line(Join(arg_vector, ' ')); 1264 1265 CHECK_GE(arg_vector.size(), 1U) << command_line; 1266 1267 // Convert the args to char pointers. 1268 const char* program = arg_vector[0].c_str(); 1269 std::vector<char*> args; 1270 for (size_t i = 0; i < arg_vector.size(); ++i) { 1271 const std::string& arg = arg_vector[i]; 1272 char* arg_str = const_cast<char*>(arg.c_str()); 1273 CHECK(arg_str != nullptr) << i; 1274 args.push_back(arg_str); 1275 } 1276 args.push_back(NULL); 1277 1278 // fork and exec 1279 pid_t pid = fork(); 1280 if (pid == 0) { 1281 // no allocation allowed between fork and exec 1282 1283 // change process groups, so we don't get reaped by ProcessManager 1284 setpgid(0, 0); 1285 1286 execv(program, &args[0]); 1287 1288 PLOG(ERROR) << "Failed to execv(" << command_line << ")"; 1289 exit(1); 1290 } else { 1291 if (pid == -1) { 1292 *error_msg = StringPrintf("Failed to execv(%s) because fork failed: %s", 1293 command_line.c_str(), strerror(errno)); 1294 return false; 1295 } 1296 1297 // wait for subprocess to finish 1298 int status; 1299 pid_t got_pid = TEMP_FAILURE_RETRY(waitpid(pid, &status, 0)); 1300 if (got_pid != pid) { 1301 *error_msg = StringPrintf("Failed after fork for execv(%s) because waitpid failed: " 1302 "wanted %d, got %d: %s", 1303 command_line.c_str(), pid, got_pid, strerror(errno)); 1304 return false; 1305 } 1306 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) { 1307 *error_msg = StringPrintf("Failed execv(%s) because non-0 exit status", 1308 command_line.c_str()); 1309 return false; 1310 } 1311 } 1312 return true; 1313} 1314 1315} // namespace art 1316