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   if (_file != NULL) {
 569     fflush(_file);
 570   }
 571 }
 572 
 573 void fdStream::write(const char* s, size_t len) {
 574   if (_fd != -1) {
 575     // Make an unused local variable to avoid warning from gcc compiler.
 576     size_t count = ::write(_fd, s, (int)len);
 577   }
 578   update_position(s, len);
 579 }
 580 
 581 defaultStream* defaultStream::instance = NULL;
 582 int defaultStream::_output_fd = 1;
 583 int defaultStream::_error_fd  = 2;
 584 FILE* defaultStream::_output_stream = stdout;
 585 FILE* defaultStream::_error_stream  = stderr;
 586 
 587 #define LOG_MAJOR_VERSION 160
 588 #define LOG_MINOR_VERSION 1
 589 
 590 void defaultStream::init() {
 591   _inited = true;
 592   if (LogVMOutput || LogCompilation) {
 593     init_log();
 594   }
 595 }
 596 
 597 bool defaultStream::has_log_file() {
 598   // lazily create log file (at startup, LogVMOutput is false even
 599   // if +LogVMOutput is used, because the flags haven't been parsed yet)
 600   // For safer printing during fatal error handling, do not init logfile
 601   // if a VM error has been reported.
 602   if (!_inited && !VMError::is_error_reported())  init();
 603   return _log_file != NULL;
 604 }
 605 
 606 fileStream* defaultStream::open_file(const char* log_name) {
 607   const char* try_name = make_log_name(log_name, NULL);
 608   if (try_name == NULL) {
 609     warning("Cannot open file %s: file name is too long.\n", log_name);
 610     return NULL;
 611   }
 612 
 613   fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
 614   FREE_C_HEAP_ARRAY(char, try_name);
 615   if (file->is_open()) {
 616     return file;
 617   }
 618 
 619   // Try again to open the file in the temp directory.
 620   delete file;
 621   // Note: This feature is for maintainer use only.  No need for L10N.
 622   jio_printf("Warning:  Cannot open log file: %s\n", log_name);
 623   try_name = make_log_name(log_name, os::get_temp_directory());
 624   if (try_name == NULL) {
 625     warning("Cannot open file %s: file name is too long for directory %s.\n", log_name, os::get_temp_directory());
 626     return NULL;
 627   }
 628 
 629   jio_printf("Warning:  Forcing option -XX:LogFile=%s\n", try_name);
 630 
 631   file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
 632   FREE_C_HEAP_ARRAY(char, try_name);
 633   if (file->is_open()) {
 634     return file;
 635   }
 636 
 637   delete file;
 638   return NULL;
 639 }
 640 
 641 void defaultStream::init_log() {
 642   // %%% Need a MutexLocker?
 643   const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log";
 644   fileStream* file = open_file(log_name);
 645 
 646   if (file != NULL) {
 647     _log_file = file;
 648     _outer_xmlStream = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
 649     start_log();
 650   } else {
 651     // and leave xtty as NULL
 652     LogVMOutput = false;
 653     DisplayVMOutput = true;
 654     LogCompilation = false;
 655   }
 656 }
 657 
 658 void defaultStream::start_log() {
 659   xmlStream*xs = _outer_xmlStream;
 660     if (this == tty)  xtty = xs;
 661     // Write XML header.
 662     xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
 663     // (For now, don't bother to issue a DTD for this private format.)
 664 
 665     // Calculate the start time of the log as ms since the epoch: this is
 666     // the current time in ms minus the uptime in ms.
 667     jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
 668     xs->head("hotspot_log version='%d %d'"
 669              " process='%d' time_ms='" INT64_FORMAT "'",
 670              LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
 671              os::current_process_id(), (int64_t)time_ms);
 672     // Write VM version header immediately.
 673     xs->head("vm_version");
 674     xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
 675     xs->tail("name");
 676     xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
 677     xs->tail("release");
 678     xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
 679     xs->tail("info");
 680     xs->tail("vm_version");
 681     // Record information about the command-line invocation.
 682     xs->head("vm_arguments");  // Cf. Arguments::print_on()
 683     if (Arguments::num_jvm_flags() > 0) {
 684       xs->head("flags");
 685       Arguments::print_jvm_flags_on(xs->text());
 686       xs->tail("flags");
 687     }
 688     if (Arguments::num_jvm_args() > 0) {
 689       xs->head("args");
 690       Arguments::print_jvm_args_on(xs->text());
 691       xs->tail("args");
 692     }
 693     if (Arguments::java_command() != NULL) {
 694       xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
 695       xs->tail("command");
 696     }
 697     if (Arguments::sun_java_launcher() != NULL) {
 698       xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
 699       xs->tail("launcher");
 700     }
 701     if (Arguments::system_properties() !=  NULL) {
 702       xs->head("properties");
 703       // Print it as a java-style property list.
 704       // System properties don't generally contain newlines, so don't bother with unparsing.
 705       outputStream *text = xs->text();
 706       for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
 707         assert(p->key() != NULL, "p->key() is NULL");
 708         if (p->is_readable()) {
 709           // Print in two stages to avoid problems with long
 710           // keys/values.
 711           text->print_raw(p->key());
 712           text->put('=');
 713           assert(p->value() != NULL, "p->value() is NULL");
 714           text->print_raw_cr(p->value());
 715         }
 716       }
 717       xs->tail("properties");
 718     }
 719     xs->tail("vm_arguments");
 720     // tty output per se is grouped under the <tty>...</tty> element.
 721     xs->head("tty");
 722     // All further non-markup text gets copied to the tty:
 723     xs->_text = this;  // requires friend declaration!
 724 }
 725 
 726 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
 727 // called by ostream_abort() after a fatal error.
 728 //
 729 void defaultStream::finish_log() {
 730   xmlStream* xs = _outer_xmlStream;
 731   xs->done("tty");
 732 
 733   // Other log forks are appended here, at the End of Time:
 734   CompileLog::finish_log(xs->out());  // write compile logging, if any, now
 735 
 736   xs->done("hotspot_log");
 737   xs->flush();
 738 
 739   fileStream* file = _log_file;
 740   _log_file = NULL;
 741 
 742   delete _outer_xmlStream;
 743   _outer_xmlStream = NULL;
 744 
 745   file->flush();
 746   delete file;
 747 }
 748 
 749 void defaultStream::finish_log_on_error(char *buf, int buflen) {
 750   xmlStream* xs = _outer_xmlStream;
 751 
 752   if (xs && xs->out()) {
 753 
 754     xs->done_raw("tty");
 755 
 756     // Other log forks are appended here, at the End of Time:
 757     CompileLog::finish_log_on_error(xs->out(), buf, buflen);  // write compile logging, if any, now
 758 
 759     xs->done_raw("hotspot_log");
 760     xs->flush();
 761 
 762     fileStream* file = _log_file;
 763     _log_file = NULL;
 764     _outer_xmlStream = NULL;
 765 
 766     if (file) {
 767       file->flush();
 768 
 769       // Can't delete or close the file because delete and fclose aren't
 770       // async-safe. We are about to die, so leave it to the kernel.
 771       // delete file;
 772     }
 773   }
 774 }
 775 
 776 intx defaultStream::hold(intx writer_id) {
 777   bool has_log = has_log_file();  // check before locking
 778   if (// impossible, but who knows?
 779       writer_id == NO_WRITER ||
 780 
 781       // bootstrap problem
 782       tty_lock == NULL ||
 783 
 784       // can't grab a lock if current Thread isn't set
 785       Thread::current_or_null() == NULL ||
 786 
 787       // developer hook
 788       !SerializeVMOutput ||
 789 
 790       // VM already unhealthy
 791       VMError::is_error_reported() ||
 792 
 793       // safepoint == global lock (for VM only)
 794       (SafepointSynchronize::is_synchronizing() &&
 795        Thread::current()->is_VM_thread())
 796       ) {
 797     // do not attempt to lock unless we know the thread and the VM is healthy
 798     return NO_WRITER;
 799   }
 800   if (_writer == writer_id) {
 801     // already held, no need to re-grab the lock
 802     return NO_WRITER;
 803   }
 804   tty_lock->lock_without_safepoint_check();
 805   // got the lock
 806   if (writer_id != _last_writer) {
 807     if (has_log) {
 808       _log_file->bol();
 809       // output a hint where this output is coming from:
 810       _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
 811     }
 812     _last_writer = writer_id;
 813   }
 814   _writer = writer_id;
 815   return writer_id;
 816 }
 817 
 818 void defaultStream::release(intx holder) {
 819   if (holder == NO_WRITER) {
 820     // nothing to release:  either a recursive lock, or we scribbled (too bad)
 821     return;
 822   }
 823   if (_writer != holder) {
 824     return;  // already unlocked, perhaps via break_tty_lock_for_safepoint
 825   }
 826   _writer = NO_WRITER;
 827   tty_lock->unlock();
 828 }
 829 
 830 void defaultStream::write(const char* s, size_t len) {
 831   intx thread_id = os::current_thread_id();
 832   intx holder = hold(thread_id);
 833 
 834   if (DisplayVMOutput &&
 835       (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
 836     // print to output stream. It can be redirected by a vfprintf hook
 837     jio_print(s, len);
 838   }
 839 
 840   // print to log file
 841   if (has_log_file()) {
 842     int nl0 = _newlines;
 843     xmlTextStream::write(s, len);
 844     // flush the log file too, if there were any newlines
 845     if (nl0 != _newlines){
 846       flush();
 847     }
 848   } else {
 849     update_position(s, len);
 850   }
 851 
 852   release(holder);
 853 }
 854 
 855 intx ttyLocker::hold_tty() {
 856   if (defaultStream::instance == NULL)  return defaultStream::NO_WRITER;
 857   intx thread_id = os::current_thread_id();
 858   return defaultStream::instance->hold(thread_id);
 859 }
 860 
 861 void ttyLocker::release_tty(intx holder) {
 862   if (holder == defaultStream::NO_WRITER)  return;
 863   defaultStream::instance->release(holder);
 864 }
 865 
 866 bool ttyLocker::release_tty_if_locked() {
 867   intx thread_id = os::current_thread_id();
 868   if (defaultStream::instance->writer() == thread_id) {
 869     // release the lock and return true so callers know if was
 870     // previously held.
 871     release_tty(thread_id);
 872     return true;
 873   }
 874   return false;
 875 }
 876 
 877 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
 878   if (defaultStream::instance != NULL &&
 879       defaultStream::instance->writer() == holder) {
 880     if (xtty != NULL) {
 881       xtty->print_cr("<!-- safepoint while printing -->");
 882     }
 883     defaultStream::instance->release(holder);
 884   }
 885   // (else there was no lock to break)
 886 }
 887 
 888 void ostream_init() {
 889   if (defaultStream::instance == NULL) {
 890     defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
 891     tty = defaultStream::instance;
 892 
 893     // We want to ensure that time stamps in GC logs consider time 0
 894     // the time when the JVM is initialized, not the first time we ask
 895     // for a time stamp. So, here, we explicitly update the time stamp
 896     // of tty.
 897     tty->time_stamp().update_to(1);
 898   }
 899 }
 900 
 901 void ostream_init_log() {
 902   // Note : this must be called AFTER ostream_init()
 903 
 904 #if INCLUDE_CDS
 905   // For -XX:DumpLoadedClassList=<file> option
 906   if (DumpLoadedClassList != NULL) {
 907     const char* list_name = make_log_name(DumpLoadedClassList, NULL);
 908     classlist_file = new(ResourceObj::C_HEAP, mtInternal)
 909                          fileStream(list_name);
 910     FREE_C_HEAP_ARRAY(char, list_name);
 911   }
 912 #endif
 913 
 914   // If we haven't lazily initialized the logfile yet, do it now,
 915   // to avoid the possibility of lazy initialization during a VM
 916   // crash, which can affect the stability of the fatal error handler.
 917   defaultStream::instance->has_log_file();
 918 }
 919 
 920 // ostream_exit() is called during normal VM exit to finish log files, flush
 921 // output and free resource.
 922 void ostream_exit() {
 923   static bool ostream_exit_called = false;
 924   if (ostream_exit_called)  return;
 925   ostream_exit_called = true;
 926 #if INCLUDE_CDS
 927   if (classlist_file != NULL) {
 928     delete classlist_file;
 929   }
 930 #endif
 931   if (tty != defaultStream::instance) {
 932     delete tty;
 933   }
 934   if (defaultStream::instance != NULL) {
 935     delete defaultStream::instance;
 936   }
 937   tty = NULL;
 938   xtty = NULL;
 939   defaultStream::instance = NULL;
 940 }
 941 
 942 // ostream_abort() is called by os::abort() when VM is about to die.
 943 void ostream_abort() {
 944   // Here we can't delete tty, just flush its output
 945   if (tty) tty->flush();
 946 
 947   if (defaultStream::instance != NULL) {
 948     static char buf[4096];
 949     defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
 950   }
 951 }
 952 
 953 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
 954   buffer_length = initial_size;
 955   buffer        = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
 956   buffer_pos    = 0;
 957   buffer_fixed  = false;
 958   buffer_max    = bufmax;
 959   truncated     = false;
 960 }
 961 
 962 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
 963   buffer_length = fixed_buffer_size;
 964   buffer        = fixed_buffer;
 965   buffer_pos    = 0;
 966   buffer_fixed  = true;
 967   buffer_max    = bufmax;
 968   truncated     = false;
 969 }
 970 
 971 void bufferedStream::write(const char* s, size_t len) {
 972 
 973   if (truncated) {
 974     return;
 975   }
 976 
 977   if(buffer_pos + len > buffer_max) {
 978     flush(); // Note: may be a noop.
 979   }
 980 
 981   size_t end = buffer_pos + len;
 982   if (end >= buffer_length) {
 983     if (buffer_fixed) {
 984       // if buffer cannot resize, silently truncate
 985       len = buffer_length - buffer_pos - 1;
 986       truncated = true;
 987     } else {
 988       // For small overruns, double the buffer.  For larger ones,
 989       // increase to the requested size.
 990       if (end < buffer_length * 2) {
 991         end = buffer_length * 2;
 992       }
 993       // Impose a cap beyond which the buffer cannot grow - a size which
 994       // in all probability indicates a real error, e.g. faulty printing
 995       // code looping, while not affecting cases of just-very-large-but-its-normal
 996       // output.
 997       const size_t reasonable_cap = MAX2(100 * M, buffer_max * 2);
 998       if (end > reasonable_cap) {
 999         // In debug VM, assert right away.
1000         assert(false, "Exceeded max buffer size for this string.");
1001         // Release VM: silently truncate. We do this since these kind of errors
1002         // are both difficult to predict with testing (depending on logging content)
1003         // and usually not serious enough to kill a production VM for it.
1004         end = reasonable_cap;
1005         size_t remaining = end - buffer_pos;
1006         if (len >= remaining) {
1007           len = remaining - 1;
1008           truncated = true;
1009         }
1010       }
1011       if (buffer_length < end) {
1012         buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
1013         buffer_length = end;
1014       }
1015     }
1016   }
1017   if (len > 0) {
1018     memcpy(buffer + buffer_pos, s, len);
1019     buffer_pos += len;
1020     update_position(s, len);
1021   }
1022 }
1023 
1024 char* bufferedStream::as_string() {
1025   char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
1026   strncpy(copy, buffer, buffer_pos);
1027   copy[buffer_pos] = 0;  // terminating null
1028   return copy;
1029 }
1030 
1031 bufferedStream::~bufferedStream() {
1032   if (!buffer_fixed) {
1033     FREE_C_HEAP_ARRAY(char, buffer);
1034   }
1035 }
1036 
1037 #ifndef PRODUCT
1038 
1039 #if defined(SOLARIS) || defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE)
1040 #include <sys/types.h>
1041 #include <sys/socket.h>
1042 #include <netinet/in.h>
1043 #include <arpa/inet.h>
1044 #elif defined(_WINDOWS)
1045 #include <winsock2.h>
1046 #endif
1047 
1048 // Network access
1049 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
1050 
1051   _socket = -1;
1052 
1053   int result = os::socket(AF_INET, SOCK_STREAM, 0);
1054   if (result <= 0) {
1055     assert(false, "Socket could not be created!");
1056   } else {
1057     _socket = result;
1058   }
1059 }
1060 
1061 int networkStream::read(char *buf, size_t len) {
1062   return os::recv(_socket, buf, (int)len, 0);
1063 }
1064 
1065 void networkStream::flush() {
1066   if (size() != 0) {
1067     int result = os::raw_send(_socket, (char *)base(), size(), 0);
1068     assert(result != -1, "connection error");
1069     assert(result == (int)size(), "didn't send enough data");
1070   }
1071   reset();
1072 }
1073 
1074 networkStream::~networkStream() {
1075   close();
1076 }
1077 
1078 void networkStream::close() {
1079   if (_socket != -1) {
1080     flush();
1081     os::socket_close(_socket);
1082     _socket = -1;
1083   }
1084 }
1085 
1086 bool networkStream::connect(const char *ip, short port) {
1087 
1088   struct sockaddr_in server;
1089   server.sin_family = AF_INET;
1090   server.sin_port = htons(port);
1091 
1092   server.sin_addr.s_addr = inet_addr(ip);
1093   if (server.sin_addr.s_addr == (uint32_t)-1) {
1094     struct hostent* host = os::get_host_by_name((char*)ip);
1095     if (host != NULL) {
1096       memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
1097     } else {
1098       return false;
1099     }
1100   }
1101 
1102 
1103   int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
1104   return (result >= 0);
1105 }
1106 
1107 #endif