1 /* 2 * Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #include "precompiled.hpp" 26 #include "jvm.h" 27 #include "compiler/compileLog.hpp" 28 #include "memory/allocation.inline.hpp" 29 #include "oops/oop.inline.hpp" 30 #include "runtime/arguments.hpp" 31 #include "runtime/os.inline.hpp" 32 #include "runtime/vm_version.hpp" 33 #include "utilities/defaultStream.hpp" 34 #include "utilities/macros.hpp" 35 #include "utilities/ostream.hpp" 36 #include "utilities/vmError.hpp" 37 #include "utilities/xmlstream.hpp" 38 39 // Declarations of jvm methods 40 extern "C" void jio_print(const char* s, size_t len); 41 extern "C" int jio_printf(const char *fmt, ...); 42 43 outputStream::outputStream(int width) { 44 _width = width; 45 _position = 0; 46 _newlines = 0; 47 _precount = 0; 48 _indentation = 0; 49 _scratch = NULL; 50 _scratch_len = 0; 51 } 52 53 outputStream::outputStream(int width, bool has_time_stamps) { 54 _width = width; 55 _position = 0; 56 _newlines = 0; 57 _precount = 0; 58 _indentation = 0; 59 _scratch = NULL; 60 _scratch_len = 0; 61 if (has_time_stamps) _stamp.update(); 62 } 63 64 void outputStream::update_position(const char* s, size_t len) { 65 for (size_t i = 0; i < len; i++) { 66 char ch = s[i]; 67 if (ch == '\n') { 68 _newlines += 1; 69 _precount += _position + 1; 70 _position = 0; 71 } else if (ch == '\t') { 72 int tw = 8 - (_position & 7); 73 _position += tw; 74 _precount -= tw-1; // invariant: _precount + _position == total count 75 } else { 76 _position += 1; 77 } 78 } 79 } 80 81 // Execute a vsprintf, using the given buffer if necessary. 82 // Return a pointer to the formatted string. 83 const char* outputStream::do_vsnprintf(char* buffer, size_t buflen, 84 const char* format, va_list ap, 85 bool add_cr, 86 size_t& result_len) { 87 assert(buflen >= 2, "buffer too small"); 88 89 const char* result; 90 if (add_cr) buflen--; 91 if (!strchr(format, '%')) { 92 // constant format string 93 result = format; 94 result_len = strlen(result); 95 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate 96 } else if (format[0] == '%' && format[1] == 's' && format[2] == '\0') { 97 // trivial copy-through format string 98 result = va_arg(ap, const char*); 99 result_len = strlen(result); 100 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate 101 } else { 102 int required_len = os::vsnprintf(buffer, buflen, format, ap); 103 assert(required_len >= 0, "vsnprintf encoding error"); 104 result = buffer; 105 if ((size_t)required_len < buflen) { 106 result_len = required_len; 107 } else { 108 DEBUG_ONLY(warning("outputStream::do_vsnprintf output truncated -- buffer length is %d bytes but %d bytes are needed.", 109 add_cr ? (int)buflen + 1 : (int)buflen, add_cr ? required_len + 2 : required_len + 1);) 110 result_len = buflen - 1; 111 } 112 } 113 if (add_cr) { 114 if (result != buffer) { 115 memcpy(buffer, result, result_len); 116 result = buffer; 117 } 118 buffer[result_len++] = '\n'; 119 buffer[result_len] = 0; 120 } 121 return result; 122 } 123 124 void outputStream::do_vsnprintf_and_write_with_automatic_buffer(const char* format, va_list ap, bool add_cr) { 125 char buffer[O_BUFLEN]; 126 size_t len; 127 const char* str = do_vsnprintf(buffer, sizeof(buffer), format, ap, add_cr, len); 128 write(str, len); 129 } 130 131 void outputStream::do_vsnprintf_and_write_with_scratch_buffer(const char* format, va_list ap, bool add_cr) { 132 size_t len; 133 const char* str = do_vsnprintf(_scratch, _scratch_len, format, ap, add_cr, len); 134 write(str, len); 135 } 136 137 void outputStream::do_vsnprintf_and_write(const char* format, va_list ap, bool add_cr) { 138 if (_scratch) { 139 do_vsnprintf_and_write_with_scratch_buffer(format, ap, add_cr); 140 } else { 141 do_vsnprintf_and_write_with_automatic_buffer(format, ap, add_cr); 142 } 143 } 144 145 void outputStream::print(const char* format, ...) { 146 va_list ap; 147 va_start(ap, format); 148 do_vsnprintf_and_write(format, ap, false); 149 va_end(ap); 150 } 151 152 void outputStream::print_cr(const char* format, ...) { 153 va_list ap; 154 va_start(ap, format); 155 do_vsnprintf_and_write(format, ap, true); 156 va_end(ap); 157 } 158 159 void outputStream::vprint(const char *format, va_list argptr) { 160 do_vsnprintf_and_write(format, argptr, false); 161 } 162 163 void outputStream::vprint_cr(const char* format, va_list argptr) { 164 do_vsnprintf_and_write(format, argptr, true); 165 } 166 167 void outputStream::fill_to(int col) { 168 int need_fill = col - position(); 169 sp(need_fill); 170 } 171 172 void outputStream::move_to(int col, int slop, int min_space) { 173 if (position() >= col + slop) 174 cr(); 175 int need_fill = col - position(); 176 if (need_fill < min_space) 177 need_fill = min_space; 178 sp(need_fill); 179 } 180 181 void outputStream::put(char ch) { 182 assert(ch != 0, "please fix call site"); 183 char buf[] = { ch, '\0' }; 184 write(buf, 1); 185 } 186 187 #define SP_USE_TABS false 188 189 void outputStream::sp(int count) { 190 if (count < 0) return; 191 if (SP_USE_TABS && count >= 8) { 192 int target = position() + count; 193 while (count >= 8) { 194 this->write("\t", 1); 195 count -= 8; 196 } 197 count = target - position(); 198 } 199 while (count > 0) { 200 int nw = (count > 8) ? 8 : count; 201 this->write(" ", nw); 202 count -= nw; 203 } 204 } 205 206 void outputStream::cr() { 207 this->write("\n", 1); 208 } 209 210 void outputStream::cr_indent() { 211 cr(); indent(); 212 } 213 214 void outputStream::stamp() { 215 if (! _stamp.is_updated()) { 216 _stamp.update(); // start at 0 on first call to stamp() 217 } 218 219 // outputStream::stamp() may get called by ostream_abort(), use snprintf 220 // to avoid allocating large stack buffer in print(). 221 char buf[40]; 222 jio_snprintf(buf, sizeof(buf), "%.3f", _stamp.seconds()); 223 print_raw(buf); 224 } 225 226 void outputStream::stamp(bool guard, 227 const char* prefix, 228 const char* suffix) { 229 if (!guard) { 230 return; 231 } 232 print_raw(prefix); 233 stamp(); 234 print_raw(suffix); 235 } 236 237 void outputStream::date_stamp(bool guard, 238 const char* prefix, 239 const char* suffix) { 240 if (!guard) { 241 return; 242 } 243 print_raw(prefix); 244 static const char error_time[] = "yyyy-mm-ddThh:mm:ss.mmm+zzzz"; 245 static const int buffer_length = 32; 246 char buffer[buffer_length]; 247 const char* iso8601_result = os::iso8601_time(buffer, buffer_length); 248 if (iso8601_result != NULL) { 249 print_raw(buffer); 250 } else { 251 print_raw(error_time); 252 } 253 print_raw(suffix); 254 return; 255 } 256 257 outputStream& outputStream::indent() { 258 while (_position < _indentation) sp(); 259 return *this; 260 } 261 262 void outputStream::print_jlong(jlong value) { 263 print(JLONG_FORMAT, value); 264 } 265 266 void outputStream::print_julong(julong value) { 267 print(JULONG_FORMAT, value); 268 } 269 270 /** 271 * This prints out hex data in a 'windbg' or 'xxd' form, where each line is: 272 * <hex-address>: 8 * <hex-halfword> <ascii translation (optional)> 273 * example: 274 * 0000000: 7f44 4f46 0102 0102 0000 0000 0000 0000 .DOF............ 275 * 0000010: 0000 0000 0000 0040 0000 0020 0000 0005 .......@... .... 276 * 0000020: 0000 0000 0000 0040 0000 0000 0000 015d .......@.......] 277 * ... 278 * 279 * indent is applied to each line. Ends with a CR. 280 */ 281 void outputStream::print_data(void* data, size_t len, bool with_ascii) { 282 size_t limit = (len + 16) / 16 * 16; 283 for (size_t i = 0; i < limit; ++i) { 284 if (i % 16 == 0) { 285 indent().print(INTPTR_FORMAT_W(07) ":", i); 286 } 287 if (i % 2 == 0) { 288 print(" "); 289 } 290 if (i < len) { 291 print("%02x", ((unsigned char*)data)[i]); 292 } else { 293 print(" "); 294 } 295 if ((i + 1) % 16 == 0) { 296 if (with_ascii) { 297 print(" "); 298 for (size_t j = 0; j < 16; ++j) { 299 size_t idx = i + j - 15; 300 if (idx < len) { 301 char c = ((char*)data)[idx]; 302 print("%c", c >= 32 && c <= 126 ? c : '.'); 303 } 304 } 305 } 306 cr(); 307 } 308 } 309 } 310 311 stringStream::stringStream(size_t initial_size) : outputStream() { 312 buffer_length = initial_size; 313 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal); 314 buffer_pos = 0; 315 buffer_fixed = false; 316 zero_terminate(); 317 } 318 319 // useful for output to fixed chunks of memory, such as performance counters 320 stringStream::stringStream(char* fixed_buffer, size_t fixed_buffer_size) : outputStream() { 321 buffer_length = fixed_buffer_size; 322 buffer = fixed_buffer; 323 buffer_pos = 0; 324 buffer_fixed = true; 325 zero_terminate(); 326 } 327 328 void stringStream::write(const char* s, size_t len) { 329 size_t write_len = len; // number of non-null bytes to write 330 size_t end = buffer_pos + len + 1; // position after write and final '\0' 331 if (end > buffer_length) { 332 if (buffer_fixed) { 333 // if buffer cannot resize, silently truncate 334 end = buffer_length; 335 write_len = end - buffer_pos - 1; // leave room for the final '\0' 336 } else { 337 // For small overruns, double the buffer. For larger ones, 338 // increase to the requested size. 339 if (end < buffer_length * 2) { 340 end = buffer_length * 2; 341 } 342 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal); 343 buffer_length = end; 344 } 345 } 346 // invariant: buffer is always null-terminated 347 guarantee(buffer_pos + write_len + 1 <= buffer_length, "stringStream oob"); 348 if (write_len > 0) { 349 memcpy(buffer + buffer_pos, s, write_len); 350 buffer_pos += write_len; 351 zero_terminate(); 352 } 353 354 // Note that the following does not depend on write_len. 355 // This means that position and count get updated 356 // even when overflow occurs. 357 update_position(s, len); 358 } 359 360 void stringStream::zero_terminate() { 361 assert(buffer != NULL && 362 buffer_pos < buffer_length, "sanity"); 363 buffer[buffer_pos] = '\0'; 364 } 365 366 void stringStream::reset() { 367 buffer_pos = 0; _precount = 0; _position = 0; 368 zero_terminate(); 369 } 370 371 char* stringStream::as_string() const { 372 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos + 1); 373 strncpy(copy, buffer, buffer_pos); 374 copy[buffer_pos] = 0; // terminating null 375 return copy; 376 } 377 378 stringStream::~stringStream() { 379 if (buffer_fixed == false && buffer != NULL) { 380 FREE_C_HEAP_ARRAY(char, buffer); 381 } 382 } 383 384 xmlStream* xtty; 385 outputStream* tty; 386 CDS_ONLY(fileStream* classlist_file;) // Only dump the classes that can be stored into the CDS archive 387 extern Mutex* tty_lock; 388 389 #define EXTRACHARLEN 32 390 #define CURRENTAPPX ".current" 391 // convert YYYY-MM-DD HH:MM:SS to YYYY-MM-DD_HH-MM-SS 392 char* get_datetime_string(char *buf, size_t len) { 393 os::local_time_string(buf, len); 394 int i = (int)strlen(buf); 395 while (--i >= 0) { 396 if (buf[i] == ' ') buf[i] = '_'; 397 else if (buf[i] == ':') buf[i] = '-'; 398 } 399 return buf; 400 } 401 402 static const char* make_log_name_internal(const char* log_name, const char* force_directory, 403 int pid, const char* tms) { 404 const char* basename = log_name; 405 char file_sep = os::file_separator()[0]; 406 const char* cp; 407 char pid_text[32]; 408 409 for (cp = log_name; *cp != '\0'; cp++) { 410 if (*cp == '/' || *cp == file_sep) { 411 basename = cp + 1; 412 } 413 } 414 const char* nametail = log_name; 415 // Compute buffer length 416 size_t buffer_length; 417 if (force_directory != NULL) { 418 buffer_length = strlen(force_directory) + strlen(os::file_separator()) + 419 strlen(basename) + 1; 420 } else { 421 buffer_length = strlen(log_name) + 1; 422 } 423 424 const char* pts = strstr(basename, "%p"); 425 int pid_pos = (pts == NULL) ? -1 : (pts - nametail); 426 427 if (pid_pos >= 0) { 428 jio_snprintf(pid_text, sizeof(pid_text), "pid%u", pid); 429 buffer_length += strlen(pid_text); 430 } 431 432 pts = strstr(basename, "%t"); 433 int tms_pos = (pts == NULL) ? -1 : (pts - nametail); 434 if (tms_pos >= 0) { 435 buffer_length += strlen(tms); 436 } 437 438 // File name is too long. 439 if (buffer_length > JVM_MAXPATHLEN) { 440 return NULL; 441 } 442 443 // Create big enough buffer. 444 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal); 445 446 strcpy(buf, ""); 447 if (force_directory != NULL) { 448 strcat(buf, force_directory); 449 strcat(buf, os::file_separator()); 450 nametail = basename; // completely skip directory prefix 451 } 452 453 // who is first, %p or %t? 454 int first = -1, second = -1; 455 const char *p1st = NULL; 456 const char *p2nd = NULL; 457 458 if (pid_pos >= 0 && tms_pos >= 0) { 459 // contains both %p and %t 460 if (pid_pos < tms_pos) { 461 // case foo%pbar%tmonkey.log 462 first = pid_pos; 463 p1st = pid_text; 464 second = tms_pos; 465 p2nd = tms; 466 } else { 467 // case foo%tbar%pmonkey.log 468 first = tms_pos; 469 p1st = tms; 470 second = pid_pos; 471 p2nd = pid_text; 472 } 473 } else if (pid_pos >= 0) { 474 // contains %p only 475 first = pid_pos; 476 p1st = pid_text; 477 } else if (tms_pos >= 0) { 478 // contains %t only 479 first = tms_pos; 480 p1st = tms; 481 } 482 483 int buf_pos = (int)strlen(buf); 484 const char* tail = nametail; 485 486 if (first >= 0) { 487 tail = nametail + first + 2; 488 strncpy(&buf[buf_pos], nametail, first); 489 strcpy(&buf[buf_pos + first], p1st); 490 buf_pos = (int)strlen(buf); 491 if (second >= 0) { 492 strncpy(&buf[buf_pos], tail, second - first - 2); 493 strcpy(&buf[buf_pos + second - first - 2], p2nd); 494 tail = nametail + second + 2; 495 } 496 } 497 strcat(buf, tail); // append rest of name, or all of name 498 return buf; 499 } 500 501 // log_name comes from -XX:LogFile=log_name or 502 // -XX:DumpLoadedClassList=<file_name> 503 // in log_name, %p => pid1234 and 504 // %t => YYYY-MM-DD_HH-MM-SS 505 static const char* make_log_name(const char* log_name, const char* force_directory) { 506 char timestr[32]; 507 get_datetime_string(timestr, sizeof(timestr)); 508 return make_log_name_internal(log_name, force_directory, os::current_process_id(), 509 timestr); 510 } 511 512 fileStream::fileStream(const char* file_name) { 513 _file = fopen(file_name, "w"); 514 if (_file != NULL) { 515 _need_close = true; 516 } else { 517 warning("Cannot open file %s due to %s\n", file_name, os::strerror(errno)); 518 _need_close = false; 519 } 520 } 521 522 fileStream::fileStream(const char* file_name, const char* opentype) { 523 _file = fopen(file_name, opentype); 524 if (_file != NULL) { 525 _need_close = true; 526 } else { 527 warning("Cannot open file %s due to %s\n", file_name, os::strerror(errno)); 528 _need_close = false; 529 } 530 } 531 532 void fileStream::write(const char* s, size_t len) { 533 if (_file != NULL) { 534 // Make an unused local variable to avoid warning from gcc compiler. 535 size_t count = fwrite(s, 1, len, _file); 536 } 537 update_position(s, len); 538 } 539 540 long fileStream::fileSize() { 541 long size = -1; 542 if (_file != NULL) { 543 long pos = ::ftell(_file); 544 if (pos < 0) return pos; 545 if (::fseek(_file, 0, SEEK_END) == 0) { 546 size = ::ftell(_file); 547 } 548 ::fseek(_file, pos, SEEK_SET); 549 } 550 return size; 551 } 552 553 char* fileStream::readln(char *data, int count ) { 554 char * ret = ::fgets(data, count, _file); 555 //Get rid of annoying \n char 556 data[::strlen(data)-1] = '\0'; 557 return ret; 558 } 559 560 fileStream::~fileStream() { 561 if (_file != NULL) { 562 if (_need_close) fclose(_file); 563 _file = NULL; 564 } 565 } 566 567 void fileStream::flush() { 568 fflush(_file); 569 } 570 571 void fdStream::write(const char* s, size_t len) { 572 if (_fd != -1) { 573 // Make an unused local variable to avoid warning from gcc compiler. 574 size_t count = ::write(_fd, s, (int)len); 575 } 576 update_position(s, len); 577 } 578 579 defaultStream* defaultStream::instance = NULL; 580 int defaultStream::_output_fd = 1; 581 int defaultStream::_error_fd = 2; 582 FILE* defaultStream::_output_stream = stdout; 583 FILE* defaultStream::_error_stream = stderr; 584 585 #define LOG_MAJOR_VERSION 160 586 #define LOG_MINOR_VERSION 1 587 588 void defaultStream::init() { 589 _inited = true; 590 if (LogVMOutput || LogCompilation) { 591 init_log(); 592 } 593 } 594 595 bool defaultStream::has_log_file() { 596 // lazily create log file (at startup, LogVMOutput is false even 597 // if +LogVMOutput is used, because the flags haven't been parsed yet) 598 // For safer printing during fatal error handling, do not init logfile 599 // if a VM error has been reported. 600 if (!_inited && !VMError::is_error_reported()) init(); 601 return _log_file != NULL; 602 } 603 604 fileStream* defaultStream::open_file(const char* log_name) { 605 const char* try_name = make_log_name(log_name, NULL); 606 if (try_name == NULL) { 607 warning("Cannot open file %s: file name is too long.\n", log_name); 608 return NULL; 609 } 610 611 fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name); 612 FREE_C_HEAP_ARRAY(char, try_name); 613 if (file->is_open()) { 614 return file; 615 } 616 617 // Try again to open the file in the temp directory. 618 delete file; 619 // Note: This feature is for maintainer use only. No need for L10N. 620 jio_printf("Warning: Cannot open log file: %s\n", log_name); 621 try_name = make_log_name(log_name, os::get_temp_directory()); 622 if (try_name == NULL) { 623 warning("Cannot open file %s: file name is too long for directory %s.\n", log_name, os::get_temp_directory()); 624 return NULL; 625 } 626 627 jio_printf("Warning: Forcing option -XX:LogFile=%s\n", try_name); 628 629 file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name); 630 FREE_C_HEAP_ARRAY(char, try_name); 631 if (file->is_open()) { 632 return file; 633 } 634 635 delete file; 636 return NULL; 637 } 638 639 void defaultStream::init_log() { 640 // %%% Need a MutexLocker? 641 const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log"; 642 fileStream* file = open_file(log_name); 643 644 if (file != NULL) { 645 _log_file = file; 646 _outer_xmlStream = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file); 647 start_log(); 648 } else { 649 // and leave xtty as NULL 650 LogVMOutput = false; 651 DisplayVMOutput = true; 652 LogCompilation = false; 653 } 654 } 655 656 void defaultStream::start_log() { 657 xmlStream*xs = _outer_xmlStream; 658 if (this == tty) xtty = xs; 659 // Write XML header. 660 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>"); 661 // (For now, don't bother to issue a DTD for this private format.) 662 663 // Calculate the start time of the log as ms since the epoch: this is 664 // the current time in ms minus the uptime in ms. 665 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds(); 666 xs->head("hotspot_log version='%d %d'" 667 " process='%d' time_ms='" INT64_FORMAT "'", 668 LOG_MAJOR_VERSION, LOG_MINOR_VERSION, 669 os::current_process_id(), (int64_t)time_ms); 670 // Write VM version header immediately. 671 xs->head("vm_version"); 672 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr(); 673 xs->tail("name"); 674 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr(); 675 xs->tail("release"); 676 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr(); 677 xs->tail("info"); 678 xs->tail("vm_version"); 679 // Record information about the command-line invocation. 680 xs->head("vm_arguments"); // Cf. Arguments::print_on() 681 if (Arguments::num_jvm_flags() > 0) { 682 xs->head("flags"); 683 Arguments::print_jvm_flags_on(xs->text()); 684 xs->tail("flags"); 685 } 686 if (Arguments::num_jvm_args() > 0) { 687 xs->head("args"); 688 Arguments::print_jvm_args_on(xs->text()); 689 xs->tail("args"); 690 } 691 if (Arguments::java_command() != NULL) { 692 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command()); 693 xs->tail("command"); 694 } 695 if (Arguments::sun_java_launcher() != NULL) { 696 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher()); 697 xs->tail("launcher"); 698 } 699 if (Arguments::system_properties() != NULL) { 700 xs->head("properties"); 701 // Print it as a java-style property list. 702 // System properties don't generally contain newlines, so don't bother with unparsing. 703 outputStream *text = xs->text(); 704 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) { 705 assert(p->key() != NULL, "p->key() is NULL"); 706 if (p->is_readable()) { 707 // Print in two stages to avoid problems with long 708 // keys/values. 709 text->print_raw(p->key()); 710 text->put('='); 711 assert(p->value() != NULL, "p->value() is NULL"); 712 text->print_raw_cr(p->value()); 713 } 714 } 715 xs->tail("properties"); 716 } 717 xs->tail("vm_arguments"); 718 // tty output per se is grouped under the <tty>...</tty> element. 719 xs->head("tty"); 720 // All further non-markup text gets copied to the tty: 721 xs->_text = this; // requires friend declaration! 722 } 723 724 // finish_log() is called during normal VM shutdown. finish_log_on_error() is 725 // called by ostream_abort() after a fatal error. 726 // 727 void defaultStream::finish_log() { 728 xmlStream* xs = _outer_xmlStream; 729 xs->done("tty"); 730 731 // Other log forks are appended here, at the End of Time: 732 CompileLog::finish_log(xs->out()); // write compile logging, if any, now 733 734 xs->done("hotspot_log"); 735 xs->flush(); 736 737 fileStream* file = _log_file; 738 _log_file = NULL; 739 740 delete _outer_xmlStream; 741 _outer_xmlStream = NULL; 742 743 file->flush(); 744 delete file; 745 } 746 747 void defaultStream::finish_log_on_error(char *buf, int buflen) { 748 xmlStream* xs = _outer_xmlStream; 749 750 if (xs && xs->out()) { 751 752 xs->done_raw("tty"); 753 754 // Other log forks are appended here, at the End of Time: 755 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now 756 757 xs->done_raw("hotspot_log"); 758 xs->flush(); 759 760 fileStream* file = _log_file; 761 _log_file = NULL; 762 _outer_xmlStream = NULL; 763 764 if (file) { 765 file->flush(); 766 767 // Can't delete or close the file because delete and fclose aren't 768 // async-safe. We are about to die, so leave it to the kernel. 769 // delete file; 770 } 771 } 772 } 773 774 intx defaultStream::hold(intx writer_id) { 775 bool has_log = has_log_file(); // check before locking 776 if (// impossible, but who knows? 777 writer_id == NO_WRITER || 778 779 // bootstrap problem 780 tty_lock == NULL || 781 782 // can't grab a lock if current Thread isn't set 783 Thread::current_or_null() == NULL || 784 785 // developer hook 786 !SerializeVMOutput || 787 788 // VM already unhealthy 789 VMError::is_error_reported() || 790 791 // safepoint == global lock (for VM only) 792 (SafepointSynchronize::is_synchronizing() && 793 Thread::current()->is_VM_thread()) 794 ) { 795 // do not attempt to lock unless we know the thread and the VM is healthy 796 return NO_WRITER; 797 } 798 if (_writer == writer_id) { 799 // already held, no need to re-grab the lock 800 return NO_WRITER; 801 } 802 tty_lock->lock_without_safepoint_check(); 803 // got the lock 804 if (writer_id != _last_writer) { 805 if (has_log) { 806 _log_file->bol(); 807 // output a hint where this output is coming from: 808 _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id); 809 } 810 _last_writer = writer_id; 811 } 812 _writer = writer_id; 813 return writer_id; 814 } 815 816 void defaultStream::release(intx holder) { 817 if (holder == NO_WRITER) { 818 // nothing to release: either a recursive lock, or we scribbled (too bad) 819 return; 820 } 821 if (_writer != holder) { 822 return; // already unlocked, perhaps via break_tty_lock_for_safepoint 823 } 824 _writer = NO_WRITER; 825 tty_lock->unlock(); 826 } 827 828 void defaultStream::write(const char* s, size_t len) { 829 intx thread_id = os::current_thread_id(); 830 intx holder = hold(thread_id); 831 832 if (DisplayVMOutput && 833 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) { 834 // print to output stream. It can be redirected by a vfprintf hook 835 jio_print(s, len); 836 } 837 838 // print to log file 839 if (has_log_file()) { 840 int nl0 = _newlines; 841 xmlTextStream::write(s, len); 842 // flush the log file too, if there were any newlines 843 if (nl0 != _newlines){ 844 flush(); 845 } 846 } else { 847 update_position(s, len); 848 } 849 850 release(holder); 851 } 852 853 intx ttyLocker::hold_tty() { 854 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER; 855 intx thread_id = os::current_thread_id(); 856 return defaultStream::instance->hold(thread_id); 857 } 858 859 void ttyLocker::release_tty(intx holder) { 860 if (holder == defaultStream::NO_WRITER) return; 861 defaultStream::instance->release(holder); 862 } 863 864 bool ttyLocker::release_tty_if_locked() { 865 intx thread_id = os::current_thread_id(); 866 if (defaultStream::instance->writer() == thread_id) { 867 // release the lock and return true so callers know if was 868 // previously held. 869 release_tty(thread_id); 870 return true; 871 } 872 return false; 873 } 874 875 void ttyLocker::break_tty_lock_for_safepoint(intx holder) { 876 if (defaultStream::instance != NULL && 877 defaultStream::instance->writer() == holder) { 878 if (xtty != NULL) { 879 xtty->print_cr("<!-- safepoint while printing -->"); 880 } 881 defaultStream::instance->release(holder); 882 } 883 // (else there was no lock to break) 884 } 885 886 void ostream_init() { 887 if (defaultStream::instance == NULL) { 888 defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream(); 889 tty = defaultStream::instance; 890 891 // We want to ensure that time stamps in GC logs consider time 0 892 // the time when the JVM is initialized, not the first time we ask 893 // for a time stamp. So, here, we explicitly update the time stamp 894 // of tty. 895 tty->time_stamp().update_to(1); 896 } 897 } 898 899 void ostream_init_log() { 900 // Note : this must be called AFTER ostream_init() 901 902 #if INCLUDE_CDS 903 // For -XX:DumpLoadedClassList=<file> option 904 if (DumpLoadedClassList != NULL) { 905 const char* list_name = make_log_name(DumpLoadedClassList, NULL); 906 classlist_file = new(ResourceObj::C_HEAP, mtInternal) 907 fileStream(list_name); 908 FREE_C_HEAP_ARRAY(char, list_name); 909 } 910 #endif 911 912 // If we haven't lazily initialized the logfile yet, do it now, 913 // to avoid the possibility of lazy initialization during a VM 914 // crash, which can affect the stability of the fatal error handler. 915 defaultStream::instance->has_log_file(); 916 } 917 918 // ostream_exit() is called during normal VM exit to finish log files, flush 919 // output and free resource. 920 void ostream_exit() { 921 static bool ostream_exit_called = false; 922 if (ostream_exit_called) return; 923 ostream_exit_called = true; 924 #if INCLUDE_CDS 925 if (classlist_file != NULL) { 926 delete classlist_file; 927 } 928 #endif 929 if (tty != defaultStream::instance) { 930 delete tty; 931 } 932 if (defaultStream::instance != NULL) { 933 delete defaultStream::instance; 934 } 935 tty = NULL; 936 xtty = NULL; 937 defaultStream::instance = NULL; 938 } 939 940 // ostream_abort() is called by os::abort() when VM is about to die. 941 void ostream_abort() { 942 // Here we can't delete tty, just flush its output 943 if (tty) tty->flush(); 944 945 if (defaultStream::instance != NULL) { 946 static char buf[4096]; 947 defaultStream::instance->finish_log_on_error(buf, sizeof(buf)); 948 } 949 } 950 951 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() { 952 buffer_length = initial_size; 953 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal); 954 buffer_pos = 0; 955 buffer_fixed = false; 956 buffer_max = bufmax; 957 truncated = false; 958 } 959 960 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() { 961 buffer_length = fixed_buffer_size; 962 buffer = fixed_buffer; 963 buffer_pos = 0; 964 buffer_fixed = true; 965 buffer_max = bufmax; 966 truncated = false; 967 } 968 969 void bufferedStream::write(const char* s, size_t len) { 970 971 if (truncated) { 972 return; 973 } 974 975 if(buffer_pos + len > buffer_max) { 976 flush(); // Note: may be a noop. 977 } 978 979 size_t end = buffer_pos + len; 980 if (end >= buffer_length) { 981 if (buffer_fixed) { 982 // if buffer cannot resize, silently truncate 983 len = buffer_length - buffer_pos - 1; 984 truncated = true; 985 } else { 986 // For small overruns, double the buffer. For larger ones, 987 // increase to the requested size. 988 if (end < buffer_length * 2) { 989 end = buffer_length * 2; 990 } 991 // Impose a cap beyond which the buffer cannot grow - a size which 992 // in all probability indicates a real error, e.g. faulty printing 993 // code looping, while not affecting cases of just-very-large-but-its-normal 994 // output. 995 const size_t reasonable_cap = MAX2(100 * M, buffer_max * 2); 996 if (end > reasonable_cap) { 997 // In debug VM, assert right away. 998 assert(false, "Exceeded max buffer size for this string."); 999 // Release VM: silently truncate. We do this since these kind of errors 1000 // are both difficult to predict with testing (depending on logging content) 1001 // and usually not serious enough to kill a production VM for it. 1002 end = reasonable_cap; 1003 size_t remaining = end - buffer_pos; 1004 if (len >= remaining) { 1005 len = remaining - 1; 1006 truncated = true; 1007 } 1008 } 1009 if (buffer_length < end) { 1010 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal); 1011 buffer_length = end; 1012 } 1013 } 1014 } 1015 if (len > 0) { 1016 memcpy(buffer + buffer_pos, s, len); 1017 buffer_pos += len; 1018 update_position(s, len); 1019 } 1020 } 1021 1022 char* bufferedStream::as_string() { 1023 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1); 1024 strncpy(copy, buffer, buffer_pos); 1025 copy[buffer_pos] = 0; // terminating null 1026 return copy; 1027 } 1028 1029 bufferedStream::~bufferedStream() { 1030 if (!buffer_fixed) { 1031 FREE_C_HEAP_ARRAY(char, buffer); 1032 } 1033 } 1034 1035 #ifndef PRODUCT 1036 1037 #if defined(SOLARIS) || defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE) 1038 #include <sys/types.h> 1039 #include <sys/socket.h> 1040 #include <netinet/in.h> 1041 #include <arpa/inet.h> 1042 #elif defined(_WINDOWS) 1043 #include <winsock2.h> 1044 #endif 1045 1046 // Network access 1047 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) { 1048 1049 _socket = -1; 1050 1051 int result = os::socket(AF_INET, SOCK_STREAM, 0); 1052 if (result <= 0) { 1053 assert(false, "Socket could not be created!"); 1054 } else { 1055 _socket = result; 1056 } 1057 } 1058 1059 int networkStream::read(char *buf, size_t len) { 1060 return os::recv(_socket, buf, (int)len, 0); 1061 } 1062 1063 void networkStream::flush() { 1064 if (size() != 0) { 1065 int result = os::raw_send(_socket, (char *)base(), size(), 0); 1066 assert(result != -1, "connection error"); 1067 assert(result == (int)size(), "didn't send enough data"); 1068 } 1069 reset(); 1070 } 1071 1072 networkStream::~networkStream() { 1073 close(); 1074 } 1075 1076 void networkStream::close() { 1077 if (_socket != -1) { 1078 flush(); 1079 os::socket_close(_socket); 1080 _socket = -1; 1081 } 1082 } 1083 1084 bool networkStream::connect(const char *ip, short port) { 1085 1086 struct sockaddr_in server; 1087 server.sin_family = AF_INET; 1088 server.sin_port = htons(port); 1089 1090 server.sin_addr.s_addr = inet_addr(ip); 1091 if (server.sin_addr.s_addr == (uint32_t)-1) { 1092 struct hostent* host = os::get_host_by_name((char*)ip); 1093 if (host != NULL) { 1094 memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length); 1095 } else { 1096 return false; 1097 } 1098 } 1099 1100 1101 int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in)); 1102 return (result >= 0); 1103 } 1104 1105 #endif