1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include "../private/libc_logging.h" // Relative path so we can #include this .cpp file for testing. 30 #include "../private/ScopedPthreadMutexLocker.h" 31 32 #include <android/set_abort_message.h> 33 #include <assert.h> 34 #include <ctype.h> 35 #include <errno.h> 36 #include <fcntl.h> 37 #include <pthread.h> 38 #include <stdarg.h> 39 #include <stddef.h> 40 #include <stdlib.h> 41 #include <string.h> 42 #include <sys/mman.h> 43 #include <sys/socket.h> 44 #include <sys/types.h> 45 #include <sys/uio.h> 46 #include <sys/un.h> 47 #include <time.h> 48 #include <unistd.h> 49 50 #define _REALLY_INCLUDE_SYS__SYSTEM_PROPERTIES_H_ 51 #include <sys/_system_properties.h> 52 53 static pthread_mutex_t g_abort_msg_lock = PTHREAD_MUTEX_INITIALIZER; 54 55 __LIBC_HIDDEN__ abort_msg_t** __abort_message_ptr; // Accessible to __libc_init_common. 56 57 // Must be kept in sync with frameworks/base/core/java/android/util/EventLog.java. 58 enum AndroidEventLogType { 59 EVENT_TYPE_INT = 0, 60 EVENT_TYPE_LONG = 1, 61 EVENT_TYPE_STRING = 2, 62 EVENT_TYPE_LIST = 3, 63 EVENT_TYPE_FLOAT = 4, 64 }; 65 66 struct BufferOutputStream { 67 public: 68 BufferOutputStream(char* buffer, size_t size) : total(0) { 69 buffer_ = buffer; 70 end_ = buffer + size - 1; 71 pos_ = buffer_; 72 pos_[0] = '\0'; 73 } 74 75 ~BufferOutputStream() { 76 } 77 78 void Send(const char* data, int len) { 79 if (len < 0) { 80 len = strlen(data); 81 } 82 83 total += len; 84 85 while (len > 0) { 86 int avail = end_ - pos_; 87 if (avail == 0) { 88 return; 89 } 90 if (avail > len) { 91 avail = len; 92 } 93 memcpy(pos_, data, avail); 94 pos_ += avail; 95 pos_[0] = '\0'; 96 len -= avail; 97 } 98 } 99 100 size_t total; 101 102 private: 103 char* buffer_; 104 char* pos_; 105 char* end_; 106 }; 107 108 struct FdOutputStream { 109 public: 110 FdOutputStream(int fd) : total(0), fd_(fd) { 111 } 112 113 void Send(const char* data, int len) { 114 if (len < 0) { 115 len = strlen(data); 116 } 117 118 total += len; 119 120 while (len > 0) { 121 int rc = TEMP_FAILURE_RETRY(write(fd_, data, len)); 122 if (rc == -1) { 123 return; 124 } 125 data += rc; 126 len -= rc; 127 } 128 } 129 130 size_t total; 131 132 private: 133 int fd_; 134 }; 135 136 /*** formatted output implementation 137 ***/ 138 139 /* Parse a decimal string from 'format + *ppos', 140 * return the value, and writes the new position past 141 * the decimal string in '*ppos' on exit. 142 * 143 * NOTE: Does *not* handle a sign prefix. 144 */ 145 static unsigned parse_decimal(const char *format, int *ppos) { 146 const char* p = format + *ppos; 147 unsigned result = 0; 148 149 for (;;) { 150 int ch = *p; 151 unsigned d = static_cast<unsigned>(ch - '0'); 152 153 if (d >= 10U) { 154 break; 155 } 156 157 result = result*10 + d; 158 p++; 159 } 160 *ppos = p - format; 161 return result; 162 } 163 164 // Writes number 'value' in base 'base' into buffer 'buf' of size 'buf_size' bytes. 165 // Assumes that buf_size > 0. 166 static void format_unsigned(char* buf, size_t buf_size, uint64_t value, int base, bool caps) { 167 char* p = buf; 168 char* end = buf + buf_size - 1; 169 170 // Generate digit string in reverse order. 171 while (value) { 172 unsigned d = value % base; 173 value /= base; 174 if (p != end) { 175 char ch; 176 if (d < 10) { 177 ch = '0' + d; 178 } else { 179 ch = (caps ? 'A' : 'a') + (d - 10); 180 } 181 *p++ = ch; 182 } 183 } 184 185 // Special case for 0. 186 if (p == buf) { 187 if (p != end) { 188 *p++ = '0'; 189 } 190 } 191 *p = '\0'; 192 193 // Reverse digit string in-place. 194 size_t length = p - buf; 195 for (size_t i = 0, j = length - 1; i < j; ++i, --j) { 196 char ch = buf[i]; 197 buf[i] = buf[j]; 198 buf[j] = ch; 199 } 200 } 201 202 static void format_integer(char* buf, size_t buf_size, uint64_t value, char conversion) { 203 // Decode the conversion specifier. 204 int is_signed = (conversion == 'd' || conversion == 'i' || conversion == 'o'); 205 int base = 10; 206 if (conversion == 'x' || conversion == 'X') { 207 base = 16; 208 } else if (conversion == 'o') { 209 base = 8; 210 } 211 bool caps = (conversion == 'X'); 212 213 if (is_signed && static_cast<int64_t>(value) < 0) { 214 buf[0] = '-'; 215 buf += 1; 216 buf_size -= 1; 217 value = static_cast<uint64_t>(-static_cast<int64_t>(value)); 218 } 219 format_unsigned(buf, buf_size, value, base, caps); 220 } 221 222 template <typename Out> 223 static void SendRepeat(Out& o, char ch, int count) { 224 char pad[8]; 225 memset(pad, ch, sizeof(pad)); 226 227 const int pad_size = static_cast<int>(sizeof(pad)); 228 while (count > 0) { 229 int avail = count; 230 if (avail > pad_size) { 231 avail = pad_size; 232 } 233 o.Send(pad, avail); 234 count -= avail; 235 } 236 } 237 238 /* Perform formatted output to an output target 'o' */ 239 template <typename Out> 240 static void out_vformat(Out& o, const char* format, va_list args) { 241 int nn = 0; 242 243 for (;;) { 244 int mm; 245 int padZero = 0; 246 int padLeft = 0; 247 char sign = '\0'; 248 int width = -1; 249 int prec = -1; 250 size_t bytelen = sizeof(int); 251 int slen; 252 char buffer[32]; /* temporary buffer used to format numbers */ 253 254 char c; 255 256 /* first, find all characters that are not 0 or '%' */ 257 /* then send them to the output directly */ 258 mm = nn; 259 do { 260 c = format[mm]; 261 if (c == '\0' || c == '%') 262 break; 263 mm++; 264 } while (1); 265 266 if (mm > nn) { 267 o.Send(format+nn, mm-nn); 268 nn = mm; 269 } 270 271 /* is this it ? then exit */ 272 if (c == '\0') 273 break; 274 275 /* nope, we are at a '%' modifier */ 276 nn++; // skip it 277 278 /* parse flags */ 279 for (;;) { 280 c = format[nn++]; 281 if (c == '\0') { /* single trailing '%' ? */ 282 c = '%'; 283 o.Send(&c, 1); 284 return; 285 } 286 else if (c == '0') { 287 padZero = 1; 288 continue; 289 } 290 else if (c == '-') { 291 padLeft = 1; 292 continue; 293 } 294 else if (c == ' ' || c == '+') { 295 sign = c; 296 continue; 297 } 298 break; 299 } 300 301 /* parse field width */ 302 if ((c >= '0' && c <= '9')) { 303 nn --; 304 width = static_cast<int>(parse_decimal(format, &nn)); 305 c = format[nn++]; 306 } 307 308 /* parse precision */ 309 if (c == '.') { 310 prec = static_cast<int>(parse_decimal(format, &nn)); 311 c = format[nn++]; 312 } 313 314 /* length modifier */ 315 switch (c) { 316 case 'h': 317 bytelen = sizeof(short); 318 if (format[nn] == 'h') { 319 bytelen = sizeof(char); 320 nn += 1; 321 } 322 c = format[nn++]; 323 break; 324 case 'l': 325 bytelen = sizeof(long); 326 if (format[nn] == 'l') { 327 bytelen = sizeof(long long); 328 nn += 1; 329 } 330 c = format[nn++]; 331 break; 332 case 'z': 333 bytelen = sizeof(size_t); 334 c = format[nn++]; 335 break; 336 case 't': 337 bytelen = sizeof(ptrdiff_t); 338 c = format[nn++]; 339 break; 340 default: 341 ; 342 } 343 344 /* conversion specifier */ 345 const char* str = buffer; 346 if (c == 's') { 347 /* string */ 348 str = va_arg(args, const char*); 349 if (str == NULL) { 350 str = "(null)"; 351 } 352 } else if (c == 'c') { 353 /* character */ 354 /* NOTE: char is promoted to int when passed through the stack */ 355 buffer[0] = static_cast<char>(va_arg(args, int)); 356 buffer[1] = '\0'; 357 } else if (c == 'p') { 358 uint64_t value = reinterpret_cast<uintptr_t>(va_arg(args, void*)); 359 buffer[0] = '0'; 360 buffer[1] = 'x'; 361 format_integer(buffer + 2, sizeof(buffer) - 2, value, 'x'); 362 } else if (c == 'd' || c == 'i' || c == 'o' || c == 'u' || c == 'x' || c == 'X') { 363 /* integers - first read value from stack */ 364 uint64_t value; 365 int is_signed = (c == 'd' || c == 'i' || c == 'o'); 366 367 /* NOTE: int8_t and int16_t are promoted to int when passed 368 * through the stack 369 */ 370 switch (bytelen) { 371 case 1: value = static_cast<uint8_t>(va_arg(args, int)); break; 372 case 2: value = static_cast<uint16_t>(va_arg(args, int)); break; 373 case 4: value = va_arg(args, uint32_t); break; 374 case 8: value = va_arg(args, uint64_t); break; 375 default: return; /* should not happen */ 376 } 377 378 /* sign extension, if needed */ 379 if (is_signed) { 380 int shift = 64 - 8*bytelen; 381 value = static_cast<uint64_t>((static_cast<int64_t>(value << shift)) >> shift); 382 } 383 384 /* format the number properly into our buffer */ 385 format_integer(buffer, sizeof(buffer), value, c); 386 } else if (c == '%') { 387 buffer[0] = '%'; 388 buffer[1] = '\0'; 389 } else { 390 __assert(__FILE__, __LINE__, "conversion specifier unsupported"); 391 } 392 393 /* if we are here, 'str' points to the content that must be 394 * outputted. handle padding and alignment now */ 395 396 slen = strlen(str); 397 398 if (sign != '\0' || prec != -1) { 399 __assert(__FILE__, __LINE__, "sign/precision unsupported"); 400 } 401 402 if (slen < width && !padLeft) { 403 char padChar = padZero ? '0' : ' '; 404 SendRepeat(o, padChar, width - slen); 405 } 406 407 o.Send(str, slen); 408 409 if (slen < width && padLeft) { 410 char padChar = padZero ? '0' : ' '; 411 SendRepeat(o, padChar, width - slen); 412 } 413 } 414 } 415 416 int __libc_format_buffer(char* buffer, size_t buffer_size, const char* format, ...) { 417 BufferOutputStream os(buffer, buffer_size); 418 va_list args; 419 va_start(args, format); 420 out_vformat(os, format, args); 421 va_end(args); 422 return os.total; 423 } 424 425 int __libc_format_fd(int fd, const char* format, ...) { 426 FdOutputStream os(fd); 427 va_list args; 428 va_start(args, format); 429 out_vformat(os, format, args); 430 va_end(args); 431 return os.total; 432 } 433 434 static int __libc_write_stderr(const char* tag, const char* msg) { 435 int fd = TEMP_FAILURE_RETRY(open("/dev/stderr", O_CLOEXEC | O_WRONLY | O_APPEND)); 436 if (fd == -1) { 437 return -1; 438 } 439 440 iovec vec[4]; 441 vec[0].iov_base = const_cast<char*>(tag); 442 vec[0].iov_len = strlen(tag); 443 vec[1].iov_base = const_cast<char*>(": "); 444 vec[1].iov_len = 2; 445 vec[2].iov_base = const_cast<char*>(msg); 446 vec[2].iov_len = strlen(msg); 447 vec[3].iov_base = const_cast<char*>("\n"); 448 vec[3].iov_len = 1; 449 450 int result = TEMP_FAILURE_RETRY(writev(fd, vec, 4)); 451 close(fd); 452 return result; 453 } 454 455 static int __libc_open_log_socket() { 456 // ToDo: Ideally we want this to fail if the gid of the current 457 // process is AID_LOGD, but will have to wait until we have 458 // registered this in private/android_filesystem_config.h. We have 459 // found that all logd crashes thus far have had no problem stuffing 460 // the UNIX domain socket and moving on so not critical *today*. 461 462 int log_fd = TEMP_FAILURE_RETRY(socket(PF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, 0)); 463 if (log_fd < 0) { 464 return -1; 465 } 466 467 if (fcntl(log_fd, F_SETFL, O_NONBLOCK) == -1) { 468 close(log_fd); 469 return -1; 470 } 471 472 union { 473 struct sockaddr addr; 474 struct sockaddr_un addrUn; 475 } u; 476 memset(&u, 0, sizeof(u)); 477 u.addrUn.sun_family = AF_UNIX; 478 strlcpy(u.addrUn.sun_path, "/dev/socket/logdw", sizeof(u.addrUn.sun_path)); 479 480 if (TEMP_FAILURE_RETRY(connect(log_fd, &u.addr, sizeof(u.addrUn))) != 0) { 481 close(log_fd); 482 return -1; 483 } 484 485 return log_fd; 486 } 487 488 struct cache { 489 const prop_info* pinfo; 490 uint32_t serial; 491 char c; 492 }; 493 494 static void refresh_cache(struct cache *cache, const char *key) 495 { 496 if (!cache->pinfo) { 497 cache->pinfo = __system_property_find(key); 498 if (!cache->pinfo) { 499 return; 500 } 501 } 502 uint32_t serial = __system_property_serial(cache->pinfo); 503 if (serial == cache->serial) { 504 return; 505 } 506 cache->serial = serial; 507 508 char buf[PROP_VALUE_MAX]; 509 __system_property_read(cache->pinfo, 0, buf); 510 cache->c = buf[0]; 511 } 512 513 // Timestamp state generally remains constant, since a change is 514 // rare, we can accept a trylock failure gracefully. 515 static pthread_mutex_t lock_clockid = PTHREAD_MUTEX_INITIALIZER; 516 517 static clockid_t __android_log_clockid() 518 { 519 static struct cache r_time_cache = { NULL, static_cast<uint32_t>(-1), 0 }; 520 static struct cache p_time_cache = { NULL, static_cast<uint32_t>(-1), 0 }; 521 char c; 522 523 if (pthread_mutex_trylock(&lock_clockid)) { 524 // We are willing to accept some race in this context 525 if (!(c = p_time_cache.c)) { 526 c = r_time_cache.c; 527 } 528 } else { 529 static uint32_t serial; 530 uint32_t current_serial = __system_property_area_serial(); 531 if (current_serial != serial) { 532 refresh_cache(&r_time_cache, "ro.logd.timestamp"); 533 refresh_cache(&p_time_cache, "persist.logd.timestamp"); 534 serial = current_serial; 535 } 536 if (!(c = p_time_cache.c)) { 537 c = r_time_cache.c; 538 } 539 540 pthread_mutex_unlock(&lock_clockid); 541 } 542 543 return (tolower(c) == 'm') ? CLOCK_MONOTONIC : CLOCK_REALTIME; 544 } 545 546 struct log_time { // Wire format 547 uint32_t tv_sec; 548 uint32_t tv_nsec; 549 }; 550 551 int __libc_write_log(int priority, const char* tag, const char* msg) { 552 int main_log_fd = __libc_open_log_socket(); 553 if (main_log_fd == -1) { 554 // Try stderr instead. 555 return __libc_write_stderr(tag, msg); 556 } 557 558 iovec vec[6]; 559 char log_id = (priority == ANDROID_LOG_FATAL) ? LOG_ID_CRASH : LOG_ID_MAIN; 560 vec[0].iov_base = &log_id; 561 vec[0].iov_len = sizeof(log_id); 562 uint16_t tid = gettid(); 563 vec[1].iov_base = &tid; 564 vec[1].iov_len = sizeof(tid); 565 timespec ts; 566 clock_gettime(__android_log_clockid(), &ts); 567 log_time realtime_ts; 568 realtime_ts.tv_sec = ts.tv_sec; 569 realtime_ts.tv_nsec = ts.tv_nsec; 570 vec[2].iov_base = &realtime_ts; 571 vec[2].iov_len = sizeof(realtime_ts); 572 573 vec[3].iov_base = &priority; 574 vec[3].iov_len = 1; 575 vec[4].iov_base = const_cast<char*>(tag); 576 vec[4].iov_len = strlen(tag) + 1; 577 vec[5].iov_base = const_cast<char*>(msg); 578 vec[5].iov_len = strlen(msg) + 1; 579 580 int result = TEMP_FAILURE_RETRY(writev(main_log_fd, vec, sizeof(vec) / sizeof(vec[0]))); 581 close(main_log_fd); 582 return result; 583 } 584 585 int __libc_format_log_va_list(int priority, const char* tag, const char* format, va_list args) { 586 char buffer[1024]; 587 BufferOutputStream os(buffer, sizeof(buffer)); 588 out_vformat(os, format, args); 589 return __libc_write_log(priority, tag, buffer); 590 } 591 592 int __libc_format_log(int priority, const char* tag, const char* format, ...) { 593 va_list args; 594 va_start(args, format); 595 int result = __libc_format_log_va_list(priority, tag, format, args); 596 va_end(args); 597 return result; 598 } 599 600 static int __libc_android_log_event(int32_t tag, char type, const void* payload, size_t len) { 601 iovec vec[6]; 602 char log_id = LOG_ID_EVENTS; 603 vec[0].iov_base = &log_id; 604 vec[0].iov_len = sizeof(log_id); 605 uint16_t tid = gettid(); 606 vec[1].iov_base = &tid; 607 vec[1].iov_len = sizeof(tid); 608 timespec ts; 609 clock_gettime(__android_log_clockid(), &ts); 610 log_time realtime_ts; 611 realtime_ts.tv_sec = ts.tv_sec; 612 realtime_ts.tv_nsec = ts.tv_nsec; 613 vec[2].iov_base = &realtime_ts; 614 vec[2].iov_len = sizeof(realtime_ts); 615 616 vec[3].iov_base = &tag; 617 vec[3].iov_len = sizeof(tag); 618 vec[4].iov_base = &type; 619 vec[4].iov_len = sizeof(type); 620 vec[5].iov_base = const_cast<void*>(payload); 621 vec[5].iov_len = len; 622 623 int event_log_fd = __libc_open_log_socket(); 624 625 if (event_log_fd == -1) { 626 return -1; 627 } 628 int result = TEMP_FAILURE_RETRY(writev(event_log_fd, vec, sizeof(vec) / sizeof(vec[0]))); 629 close(event_log_fd); 630 return result; 631 } 632 633 void __libc_android_log_event_int(int32_t tag, int value) { 634 __libc_android_log_event(tag, EVENT_TYPE_INT, &value, sizeof(value)); 635 } 636 637 void __libc_android_log_event_uid(int32_t tag) { 638 __libc_android_log_event_int(tag, getuid()); 639 } 640 641 void __fortify_chk_fail(const char* msg, uint32_t tag) { 642 if (tag != 0) { 643 __libc_android_log_event_uid(tag); 644 } 645 __libc_fatal("FORTIFY: %s", msg); 646 } 647 648 static void __libc_fatal(const char* format, va_list args) { 649 char msg[1024]; 650 BufferOutputStream os(msg, sizeof(msg)); 651 out_vformat(os, format, args); 652 653 // Log to stderr for the benefit of "adb shell" users. 654 struct iovec iov[2] = { 655 { msg, os.total }, 656 { const_cast<char*>("\n"), 1 }, 657 }; 658 TEMP_FAILURE_RETRY(writev(2, iov, 2)); 659 660 // Log to the log for the benefit of regular app developers (whose stdout and stderr are closed). 661 __libc_write_log(ANDROID_LOG_FATAL, "libc", msg); 662 663 android_set_abort_message(msg); 664 } 665 666 void __libc_fatal_no_abort(const char* format, ...) { 667 va_list args; 668 va_start(args, format); 669 __libc_fatal(format, args); 670 va_end(args); 671 } 672 673 void __libc_fatal(const char* format, ...) { 674 va_list args; 675 va_start(args, format); 676 __libc_fatal(format, args); 677 va_end(args); 678 abort(); 679 } 680 681 void android_set_abort_message(const char* msg) { 682 ScopedPthreadMutexLocker locker(&g_abort_msg_lock); 683 684 if (__abort_message_ptr == NULL) { 685 // We must have crashed _very_ early. 686 return; 687 } 688 689 if (*__abort_message_ptr != NULL) { 690 // We already have an abort message. 691 // Assume that the first crash is the one most worth reporting. 692 return; 693 } 694 695 size_t size = sizeof(abort_msg_t) + strlen(msg) + 1; 696 void* map = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE, -1, 0); 697 if (map == MAP_FAILED) { 698 return; 699 } 700 701 // TODO: if we stick to the current "one-shot" scheme, we can remove this code and 702 // stop storing the size. 703 if (*__abort_message_ptr != NULL) { 704 munmap(*__abort_message_ptr, (*__abort_message_ptr)->size); 705 } 706 abort_msg_t* new_abort_message = reinterpret_cast<abort_msg_t*>(map); 707 new_abort_message->size = size; 708 strcpy(new_abort_message->msg, msg); 709 *__abort_message_ptr = new_abort_message; 710 } 711