src/share/vm/utilities/ostream.cpp

Tue, 05 Nov 2013 17:38:04 -0800

author
kvn
date
Tue, 05 Nov 2013 17:38:04 -0800
changeset 6472
2b8e28fdf503
parent 6461
bdd155477289
parent 5903
bf8a21c3ab3b
child 6535
f42c10a3d4b1
permissions
-rw-r--r--

Merge

     1 /*
     2  * Copyright (c) 1997, 2013, 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  */
    25 #include "precompiled.hpp"
    26 #include "compiler/compileLog.hpp"
    27 #include "oops/oop.inline.hpp"
    28 #include "runtime/arguments.hpp"
    29 #include "utilities/defaultStream.hpp"
    30 #include "utilities/ostream.hpp"
    31 #include "utilities/top.hpp"
    32 #include "utilities/xmlstream.hpp"
    33 #ifdef TARGET_OS_FAMILY_linux
    34 # include "os_linux.inline.hpp"
    35 #endif
    36 #ifdef TARGET_OS_FAMILY_solaris
    37 # include "os_solaris.inline.hpp"
    38 #endif
    39 #ifdef TARGET_OS_FAMILY_windows
    40 # include "os_windows.inline.hpp"
    41 #endif
    42 #ifdef TARGET_OS_FAMILY_aix
    43 # include "os_aix.inline.hpp"
    44 #endif
    45 #ifdef TARGET_OS_FAMILY_bsd
    46 # include "os_bsd.inline.hpp"
    47 #endif
    49 extern "C" void jio_print(const char* s); // Declarationtion of jvm method
    51 outputStream::outputStream(int width) {
    52   _width       = width;
    53   _position    = 0;
    54   _newlines    = 0;
    55   _precount    = 0;
    56   _indentation = 0;
    57 }
    59 outputStream::outputStream(int width, bool has_time_stamps) {
    60   _width       = width;
    61   _position    = 0;
    62   _newlines    = 0;
    63   _precount    = 0;
    64   _indentation = 0;
    65   if (has_time_stamps)  _stamp.update();
    66 }
    68 void outputStream::update_position(const char* s, size_t len) {
    69   for (size_t i = 0; i < len; i++) {
    70     char ch = s[i];
    71     if (ch == '\n') {
    72       _newlines += 1;
    73       _precount += _position + 1;
    74       _position = 0;
    75     } else if (ch == '\t') {
    76       int tw = 8 - (_position & 7);
    77       _position += tw;
    78       _precount -= tw-1;  // invariant:  _precount + _position == total count
    79     } else {
    80       _position += 1;
    81     }
    82   }
    83 }
    85 // Execute a vsprintf, using the given buffer if necessary.
    86 // Return a pointer to the formatted string.
    87 const char* outputStream::do_vsnprintf(char* buffer, size_t buflen,
    88                                        const char* format, va_list ap,
    89                                        bool add_cr,
    90                                        size_t& result_len) {
    91   const char* result;
    92   if (add_cr)  buflen--;
    93   if (!strchr(format, '%')) {
    94     // constant format string
    95     result = format;
    96     result_len = strlen(result);
    97     if (add_cr && result_len >= buflen)  result_len = buflen-1;  // truncate
    98   } else if (format[0] == '%' && format[1] == 's' && format[2] == '\0') {
    99     // trivial copy-through format string
   100     result = va_arg(ap, const char*);
   101     result_len = strlen(result);
   102     if (add_cr && result_len >= buflen)  result_len = buflen-1;  // truncate
   103   } else if (vsnprintf(buffer, buflen, format, ap) >= 0) {
   104     result = buffer;
   105     result_len = strlen(result);
   106   } else {
   107     DEBUG_ONLY(warning("increase O_BUFLEN in ostream.hpp -- output truncated");)
   108     result = buffer;
   109     result_len = buflen - 1;
   110     buffer[result_len] = 0;
   111   }
   112   if (add_cr) {
   113     if (result != buffer) {
   114       strncpy(buffer, result, buflen);
   115       result = buffer;
   116     }
   117     buffer[result_len++] = '\n';
   118     buffer[result_len] = 0;
   119   }
   120   return result;
   121 }
   123 void outputStream::print(const char* format, ...) {
   124   char buffer[O_BUFLEN];
   125   va_list ap;
   126   va_start(ap, format);
   127   size_t len;
   128   const char* str = do_vsnprintf(buffer, O_BUFLEN, format, ap, false, len);
   129   write(str, len);
   130   va_end(ap);
   131 }
   133 void outputStream::print_cr(const char* format, ...) {
   134   char buffer[O_BUFLEN];
   135   va_list ap;
   136   va_start(ap, format);
   137   size_t len;
   138   const char* str = do_vsnprintf(buffer, O_BUFLEN, format, ap, true, len);
   139   write(str, len);
   140   va_end(ap);
   141 }
   143 void outputStream::vprint(const char *format, va_list argptr) {
   144   char buffer[O_BUFLEN];
   145   size_t len;
   146   const char* str = do_vsnprintf(buffer, O_BUFLEN, format, argptr, false, len);
   147   write(str, len);
   148 }
   150 void outputStream::vprint_cr(const char* format, va_list argptr) {
   151   char buffer[O_BUFLEN];
   152   size_t len;
   153   const char* str = do_vsnprintf(buffer, O_BUFLEN, format, argptr, true, len);
   154   write(str, len);
   155 }
   157 void outputStream::fill_to(int col) {
   158   int need_fill = col - position();
   159   sp(need_fill);
   160 }
   162 void outputStream::move_to(int col, int slop, int min_space) {
   163   if (position() >= col + slop)
   164     cr();
   165   int need_fill = col - position();
   166   if (need_fill < min_space)
   167     need_fill = min_space;
   168   sp(need_fill);
   169 }
   171 void outputStream::put(char ch) {
   172   assert(ch != 0, "please fix call site");
   173   char buf[] = { ch, '\0' };
   174   write(buf, 1);
   175 }
   177 #define SP_USE_TABS false
   179 void outputStream::sp(int count) {
   180   if (count < 0)  return;
   181   if (SP_USE_TABS && count >= 8) {
   182     int target = position() + count;
   183     while (count >= 8) {
   184       this->write("\t", 1);
   185       count -= 8;
   186     }
   187     count = target - position();
   188   }
   189   while (count > 0) {
   190     int nw = (count > 8) ? 8 : count;
   191     this->write("        ", nw);
   192     count -= nw;
   193   }
   194 }
   196 void outputStream::cr() {
   197   this->write("\n", 1);
   198 }
   200 void outputStream::stamp() {
   201   if (! _stamp.is_updated()) {
   202     _stamp.update(); // start at 0 on first call to stamp()
   203   }
   205   // outputStream::stamp() may get called by ostream_abort(), use snprintf
   206   // to avoid allocating large stack buffer in print().
   207   char buf[40];
   208   jio_snprintf(buf, sizeof(buf), "%.3f", _stamp.seconds());
   209   print_raw(buf);
   210 }
   212 void outputStream::stamp(bool guard,
   213                          const char* prefix,
   214                          const char* suffix) {
   215   if (!guard) {
   216     return;
   217   }
   218   print_raw(prefix);
   219   stamp();
   220   print_raw(suffix);
   221 }
   223 void outputStream::date_stamp(bool guard,
   224                               const char* prefix,
   225                               const char* suffix) {
   226   if (!guard) {
   227     return;
   228   }
   229   print_raw(prefix);
   230   static const char error_time[] = "yyyy-mm-ddThh:mm:ss.mmm+zzzz";
   231   static const int buffer_length = 32;
   232   char buffer[buffer_length];
   233   const char* iso8601_result = os::iso8601_time(buffer, buffer_length);
   234   if (iso8601_result != NULL) {
   235     print_raw(buffer);
   236   } else {
   237     print_raw(error_time);
   238   }
   239   print_raw(suffix);
   240   return;
   241 }
   243 outputStream& outputStream::indent() {
   244   while (_position < _indentation) sp();
   245   return *this;
   246 }
   248 void outputStream::print_jlong(jlong value) {
   249   print(JLONG_FORMAT, value);
   250 }
   252 void outputStream::print_julong(julong value) {
   253   print(JULONG_FORMAT, value);
   254 }
   256 /**
   257  * This prints out hex data in a 'windbg' or 'xxd' form, where each line is:
   258  *   <hex-address>: 8 * <hex-halfword> <ascii translation (optional)>
   259  * example:
   260  * 0000000: 7f44 4f46 0102 0102 0000 0000 0000 0000  .DOF............
   261  * 0000010: 0000 0000 0000 0040 0000 0020 0000 0005  .......@... ....
   262  * 0000020: 0000 0000 0000 0040 0000 0000 0000 015d  .......@.......]
   263  * ...
   264  *
   265  * indent is applied to each line.  Ends with a CR.
   266  */
   267 void outputStream::print_data(void* data, size_t len, bool with_ascii) {
   268   size_t limit = (len + 16) / 16 * 16;
   269   for (size_t i = 0; i < limit; ++i) {
   270     if (i % 16 == 0) {
   271       indent().print("%07x:", i);
   272     }
   273     if (i % 2 == 0) {
   274       print(" ");
   275     }
   276     if (i < len) {
   277       print("%02x", ((unsigned char*)data)[i]);
   278     } else {
   279       print("  ");
   280     }
   281     if ((i + 1) % 16 == 0) {
   282       if (with_ascii) {
   283         print("  ");
   284         for (size_t j = 0; j < 16; ++j) {
   285           size_t idx = i + j - 15;
   286           if (idx < len) {
   287             char c = ((char*)data)[idx];
   288             print("%c", c >= 32 && c <= 126 ? c : '.');
   289           }
   290         }
   291       }
   292       print_cr("");
   293     }
   294   }
   295 }
   297 stringStream::stringStream(size_t initial_size) : outputStream() {
   298   buffer_length = initial_size;
   299   buffer        = NEW_RESOURCE_ARRAY(char, buffer_length);
   300   buffer_pos    = 0;
   301   buffer_fixed  = false;
   302   DEBUG_ONLY(rm = Thread::current()->current_resource_mark();)
   303 }
   305 // useful for output to fixed chunks of memory, such as performance counters
   306 stringStream::stringStream(char* fixed_buffer, size_t fixed_buffer_size) : outputStream() {
   307   buffer_length = fixed_buffer_size;
   308   buffer        = fixed_buffer;
   309   buffer_pos    = 0;
   310   buffer_fixed  = true;
   311 }
   313 void stringStream::write(const char* s, size_t len) {
   314   size_t write_len = len;               // number of non-null bytes to write
   315   size_t end = buffer_pos + len + 1;    // position after write and final '\0'
   316   if (end > buffer_length) {
   317     if (buffer_fixed) {
   318       // if buffer cannot resize, silently truncate
   319       end = buffer_length;
   320       write_len = end - buffer_pos - 1; // leave room for the final '\0'
   321     } else {
   322       // For small overruns, double the buffer.  For larger ones,
   323       // increase to the requested size.
   324       if (end < buffer_length * 2) {
   325         end = buffer_length * 2;
   326       }
   327       char* oldbuf = buffer;
   328       assert(rm == NULL || Thread::current()->current_resource_mark() == rm,
   329              "stringStream is re-allocated with a different ResourceMark");
   330       buffer = NEW_RESOURCE_ARRAY(char, end);
   331       strncpy(buffer, oldbuf, buffer_pos);
   332       buffer_length = end;
   333     }
   334   }
   335   // invariant: buffer is always null-terminated
   336   guarantee(buffer_pos + write_len + 1 <= buffer_length, "stringStream oob");
   337   buffer[buffer_pos + write_len] = 0;
   338   strncpy(buffer + buffer_pos, s, write_len);
   339   buffer_pos += write_len;
   341   // Note that the following does not depend on write_len.
   342   // This means that position and count get updated
   343   // even when overflow occurs.
   344   update_position(s, len);
   345 }
   347 char* stringStream::as_string() {
   348   char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos + 1);
   349   strncpy(copy, buffer, buffer_pos);
   350   copy[buffer_pos] = 0;  // terminating null
   351   return copy;
   352 }
   354 stringStream::~stringStream() {}
   356 xmlStream*   xtty;
   357 outputStream* tty;
   358 outputStream* gclog_or_tty;
   359 extern Mutex* tty_lock;
   361 #define EXTRACHARLEN   32
   362 #define CURRENTAPPX    ".current"
   363 #define FILENAMEBUFLEN  1024
   364 // convert YYYY-MM-DD HH:MM:SS to YYYY-MM-DD_HH-MM-SS
   365 char* get_datetime_string(char *buf, size_t len) {
   366   os::local_time_string(buf, len);
   367   int i = (int)strlen(buf);
   368   while (i-- >= 0) {
   369     if (buf[i] == ' ') buf[i] = '_';
   370     else if (buf[i] == ':') buf[i] = '-';
   371   }
   372   return buf;
   373 }
   375 static const char* make_log_name_internal(const char* log_name, const char* force_directory,
   376                                                 int pid, const char* tms) {
   377   const char* basename = log_name;
   378   char file_sep = os::file_separator()[0];
   379   const char* cp;
   380   char  pid_text[32];
   382   for (cp = log_name; *cp != '\0'; cp++) {
   383     if (*cp == '/' || *cp == file_sep) {
   384       basename = cp + 1;
   385     }
   386   }
   387   const char* nametail = log_name;
   388   // Compute buffer length
   389   size_t buffer_length;
   390   if (force_directory != NULL) {
   391     buffer_length = strlen(force_directory) + strlen(os::file_separator()) +
   392                     strlen(basename) + 1;
   393   } else {
   394     buffer_length = strlen(log_name) + 1;
   395   }
   397   // const char* star = strchr(basename, '*');
   398   const char* pts = strstr(basename, "%p");
   399   int pid_pos = (pts == NULL) ? -1 : (pts - nametail);
   401   if (pid_pos >= 0) {
   402     jio_snprintf(pid_text, sizeof(pid_text), "pid%u", pid);
   403     buffer_length += strlen(pid_text);
   404   }
   406   pts = strstr(basename, "%t");
   407   int tms_pos = (pts == NULL) ? -1 : (pts - nametail);
   408   if (tms_pos >= 0) {
   409     buffer_length += strlen(tms);
   410   }
   412   // Create big enough buffer.
   413   char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
   415   strcpy(buf, "");
   416   if (force_directory != NULL) {
   417     strcat(buf, force_directory);
   418     strcat(buf, os::file_separator());
   419     nametail = basename;       // completely skip directory prefix
   420   }
   422   // who is first, %p or %t?
   423   int first = -1, second = -1;
   424   const char *p1st = NULL;
   425   const char *p2nd = NULL;
   427   if (pid_pos >= 0 && tms_pos >= 0) {
   428     // contains both %p and %t
   429     if (pid_pos < tms_pos) {
   430       // case foo%pbar%tmonkey.log
   431       first  = pid_pos;
   432       p1st   = pid_text;
   433       second = tms_pos;
   434       p2nd   = tms;
   435     } else {
   436       // case foo%tbar%pmonkey.log
   437       first  = tms_pos;
   438       p1st   = tms;
   439       second = pid_pos;
   440       p2nd   = pid_text;
   441     }
   442   } else if (pid_pos >= 0) {
   443     // contains %p only
   444     first  = pid_pos;
   445     p1st   = pid_text;
   446   } else if (tms_pos >= 0) {
   447     // contains %t only
   448     first  = tms_pos;
   449     p1st   = tms;
   450   }
   452   int buf_pos = (int)strlen(buf);
   453   const char* tail = nametail;
   455   if (first >= 0) {
   456     tail = nametail + first + 2;
   457     strncpy(&buf[buf_pos], nametail, first);
   458     strcpy(&buf[buf_pos + first], p1st);
   459     buf_pos = (int)strlen(buf);
   460     if (second >= 0) {
   461       strncpy(&buf[buf_pos], tail, second - first - 2);
   462       strcpy(&buf[buf_pos + second - first - 2], p2nd);
   463       tail = nametail + second + 2;
   464     }
   465   }
   466   strcat(buf, tail);      // append rest of name, or all of name
   467   return buf;
   468 }
   470 // log_name comes from -XX:LogFile=log_name or -Xloggc:log_name
   471 // in log_name, %p => pid1234 and
   472 //              %t => YYYY-MM-DD_HH-MM-SS
   473 static const char* make_log_name(const char* log_name, const char* force_directory) {
   474   char timestr[32];
   475   get_datetime_string(timestr, sizeof(timestr));
   476   return make_log_name_internal(log_name, force_directory, os::current_process_id(),
   477                                 timestr);
   478 }
   480 #ifndef PRODUCT
   481 void test_loggc_filename() {
   482   int pid;
   483   char  tms[32];
   484   char  i_result[FILENAMEBUFLEN];
   485   const char* o_result;
   486   get_datetime_string(tms, sizeof(tms));
   487   pid = os::current_process_id();
   489   // test.log
   490   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test.log", tms);
   491   o_result = make_log_name_internal("test.log", NULL, pid, tms);
   492   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test.log\", NULL)");
   493   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   495   // test-%t-%p.log
   496   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%s-pid%u.log", tms, pid);
   497   o_result = make_log_name_internal("test-%t-%p.log", NULL, pid, tms);
   498   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t-%%p.log\", NULL)");
   499   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   501   // test-%t%p.log
   502   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%spid%u.log", tms, pid);
   503   o_result = make_log_name_internal("test-%t%p.log", NULL, pid, tms);
   504   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t%%p.log\", NULL)");
   505   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   507   // %p%t.log
   508   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u%s.log", pid, tms);
   509   o_result = make_log_name_internal("%p%t.log", NULL, pid, tms);
   510   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p%%t.log\", NULL)");
   511   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   513   // %p-test.log
   514   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u-test.log", pid);
   515   o_result = make_log_name_internal("%p-test.log", NULL, pid, tms);
   516   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p-test.log\", NULL)");
   517   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   519   // %t.log
   520   jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "%s.log", tms);
   521   o_result = make_log_name_internal("%t.log", NULL, pid, tms);
   522   assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%t.log\", NULL)");
   523   FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
   524 }
   525 #endif // PRODUCT
   527 fileStream::fileStream(const char* file_name) {
   528   _file = fopen(file_name, "w");
   529   if (_file != NULL) {
   530     _need_close = true;
   531   } else {
   532     warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
   533     _need_close = false;
   534   }
   535 }
   537 fileStream::fileStream(const char* file_name, const char* opentype) {
   538   _file = fopen(file_name, opentype);
   539   if (_file != NULL) {
   540     _need_close = true;
   541   } else {
   542     warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
   543     _need_close = false;
   544   }
   545 }
   547 void fileStream::write(const char* s, size_t len) {
   548   if (_file != NULL)  {
   549     // Make an unused local variable to avoid warning from gcc 4.x compiler.
   550     size_t count = fwrite(s, 1, len, _file);
   551   }
   552   update_position(s, len);
   553 }
   555 long fileStream::fileSize() {
   556   long size = -1;
   557   if (_file != NULL) {
   558     long pos  = ::ftell(_file);
   559     if (::fseek(_file, 0, SEEK_END) == 0) {
   560       size = ::ftell(_file);
   561     }
   562     ::fseek(_file, pos, SEEK_SET);
   563   }
   564   return size;
   565 }
   567 char* fileStream::readln(char *data, int count ) {
   568   char * ret = ::fgets(data, count, _file);
   569   //Get rid of annoying \n char
   570   data[::strlen(data)-1] = '\0';
   571   return ret;
   572 }
   574 fileStream::~fileStream() {
   575   if (_file != NULL) {
   576     if (_need_close) fclose(_file);
   577     _file      = NULL;
   578   }
   579 }
   581 void fileStream::flush() {
   582   fflush(_file);
   583 }
   585 fdStream::fdStream(const char* file_name) {
   586   _fd = open(file_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
   587   _need_close = true;
   588 }
   590 fdStream::~fdStream() {
   591   if (_fd != -1) {
   592     if (_need_close) close(_fd);
   593     _fd = -1;
   594   }
   595 }
   597 void fdStream::write(const char* s, size_t len) {
   598   if (_fd != -1) {
   599     // Make an unused local variable to avoid warning from gcc 4.x compiler.
   600     size_t count = ::write(_fd, s, (int)len);
   601   }
   602   update_position(s, len);
   603 }
   605 // dump vm version, os version, platform info, build id,
   606 // memory usage and command line flags into header
   607 void gcLogFileStream::dump_loggc_header() {
   608   if (is_open()) {
   609     print_cr(Abstract_VM_Version::internal_vm_info_string());
   610     os::print_memory_info(this);
   611     print("CommandLine flags: ");
   612     CommandLineFlags::printSetFlags(this);
   613   }
   614 }
   616 gcLogFileStream::~gcLogFileStream() {
   617   if (_file != NULL) {
   618     if (_need_close) fclose(_file);
   619     _file = NULL;
   620   }
   621   if (_file_name != NULL) {
   622     FREE_C_HEAP_ARRAY(char, _file_name, mtInternal);
   623     _file_name = NULL;
   624   }
   625 }
   627 gcLogFileStream::gcLogFileStream(const char* file_name) {
   628   _cur_file_num = 0;
   629   _bytes_written = 0L;
   630   _file_name = make_log_name(file_name, NULL);
   632   // gc log file rotation
   633   if (UseGCLogFileRotation && NumberOfGCLogFiles > 1) {
   634     char tempbuf[FILENAMEBUFLEN];
   635     jio_snprintf(tempbuf, sizeof(tempbuf), "%s.%d" CURRENTAPPX, _file_name, _cur_file_num);
   636     _file = fopen(tempbuf, "w");
   637   } else {
   638     _file = fopen(_file_name, "w");
   639   }
   640   if (_file != NULL) {
   641     _need_close = true;
   642     dump_loggc_header();
   643   } else {
   644     warning("Cannot open file %s due to %s\n", _file_name, strerror(errno));
   645     _need_close = false;
   646   }
   647 }
   649 void gcLogFileStream::write(const char* s, size_t len) {
   650   if (_file != NULL) {
   651     size_t count = fwrite(s, 1, len, _file);
   652     _bytes_written += count;
   653   }
   654   update_position(s, len);
   655 }
   657 // rotate_log must be called from VMThread at safepoint. In case need change parameters
   658 // for gc log rotation from thread other than VMThread, a sub type of VM_Operation
   659 // should be created and be submitted to VMThread's operation queue. DO NOT call this
   660 // function directly. Currently, it is safe to rotate log at safepoint through VMThread.
   661 // That is, no mutator threads and concurrent GC threads run parallel with VMThread to
   662 // write to gc log file at safepoint. If in future, changes made for mutator threads or
   663 // concurrent GC threads to run parallel with VMThread at safepoint, write and rotate_log
   664 // must be synchronized.
   665 void gcLogFileStream::rotate_log() {
   666   char time_msg[FILENAMEBUFLEN];
   667   char time_str[EXTRACHARLEN];
   668   char current_file_name[FILENAMEBUFLEN];
   669   char renamed_file_name[FILENAMEBUFLEN];
   671   if (_bytes_written < (jlong)GCLogFileSize) {
   672     return;
   673   }
   675 #ifdef ASSERT
   676   Thread *thread = Thread::current();
   677   assert(thread == NULL ||
   678          (thread->is_VM_thread() && SafepointSynchronize::is_at_safepoint()),
   679          "Must be VMThread at safepoint");
   680 #endif
   681   if (NumberOfGCLogFiles == 1) {
   682     // rotate in same file
   683     rewind();
   684     _bytes_written = 0L;
   685     jio_snprintf(time_msg, sizeof(time_msg), "File  %s rotated at %s\n",
   686                  _file_name, os::local_time_string((char *)time_str, sizeof(time_str)));
   687     write(time_msg, strlen(time_msg));
   688     dump_loggc_header();
   689     return;
   690   }
   692 #if defined(_WINDOWS)
   693 #ifndef F_OK
   694 #define F_OK 0
   695 #endif
   696 #endif // _WINDOWS
   698   // rotate file in names extended_filename.0, extended_filename.1, ...,
   699   // extended_filename.<NumberOfGCLogFiles - 1>. Current rotation file name will
   700   // have a form of extended_filename.<i>.current where i is the current rotation
   701   // file number. After it reaches max file size, the file will be saved and renamed
   702   // with .current removed from its tail.
   703   size_t filename_len = strlen(_file_name);
   704   if (_file != NULL) {
   705     jio_snprintf(renamed_file_name, filename_len + EXTRACHARLEN, "%s.%d",
   706                  _file_name, _cur_file_num);
   707     jio_snprintf(current_file_name, filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
   708                  _file_name, _cur_file_num);
   709     jio_snprintf(time_msg, sizeof(time_msg), "%s GC log file has reached the"
   710                            " maximum size. Saved as %s\n",
   711                            os::local_time_string((char *)time_str, sizeof(time_str)),
   712                            renamed_file_name);
   713     write(time_msg, strlen(time_msg));
   715     fclose(_file);
   716     _file = NULL;
   718     bool can_rename = true;
   719     if (access(current_file_name, F_OK) != 0) {
   720       // current file does not exist?
   721       warning("No source file exists, cannot rename\n");
   722       can_rename = false;
   723     }
   724     if (can_rename) {
   725       if (access(renamed_file_name, F_OK) == 0) {
   726         if (remove(renamed_file_name) != 0) {
   727           warning("Could not delete existing file %s\n", renamed_file_name);
   728           can_rename = false;
   729         }
   730       } else {
   731         // file does not exist, ok to rename
   732       }
   733     }
   734     if (can_rename && rename(current_file_name, renamed_file_name) != 0) {
   735       warning("Could not rename %s to %s\n", _file_name, renamed_file_name);
   736     }
   737   }
   739   _cur_file_num++;
   740   if (_cur_file_num > NumberOfGCLogFiles - 1) _cur_file_num = 0;
   741   jio_snprintf(current_file_name,  filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
   742                _file_name, _cur_file_num);
   743   _file = fopen(current_file_name, "w");
   745   if (_file != NULL) {
   746     _bytes_written = 0L;
   747     _need_close = true;
   748     // reuse current_file_name for time_msg
   749     jio_snprintf(current_file_name, filename_len + EXTRACHARLEN,
   750                  "%s.%d", _file_name, _cur_file_num);
   751     jio_snprintf(time_msg, sizeof(time_msg), "%s GC log file created %s\n",
   752                            os::local_time_string((char *)time_str, sizeof(time_str)),
   753                            current_file_name);
   754     write(time_msg, strlen(time_msg));
   755     dump_loggc_header();
   756     // remove the existing file
   757     if (access(current_file_name, F_OK) == 0) {
   758       if (remove(current_file_name) != 0) {
   759         warning("Could not delete existing file %s\n", current_file_name);
   760       }
   761     }
   762   } else {
   763     warning("failed to open rotation log file %s due to %s\n"
   764             "Turned off GC log file rotation\n",
   765                   _file_name, strerror(errno));
   766     _need_close = false;
   767     FLAG_SET_DEFAULT(UseGCLogFileRotation, false);
   768   }
   769 }
   771 defaultStream* defaultStream::instance = NULL;
   772 int defaultStream::_output_fd = 1;
   773 int defaultStream::_error_fd  = 2;
   774 FILE* defaultStream::_output_stream = stdout;
   775 FILE* defaultStream::_error_stream  = stderr;
   777 #define LOG_MAJOR_VERSION 160
   778 #define LOG_MINOR_VERSION 1
   780 void defaultStream::init() {
   781   _inited = true;
   782   if (LogVMOutput || LogCompilation) {
   783     init_log();
   784   }
   785 }
   787 bool defaultStream::has_log_file() {
   788   // lazily create log file (at startup, LogVMOutput is false even
   789   // if +LogVMOutput is used, because the flags haven't been parsed yet)
   790   // For safer printing during fatal error handling, do not init logfile
   791   // if a VM error has been reported.
   792   if (!_inited && !is_error_reported())  init();
   793   return _log_file != NULL;
   794 }
   796 void defaultStream::init_log() {
   797   // %%% Need a MutexLocker?
   798   const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log";
   799   const char* try_name = make_log_name(log_name, NULL);
   800   fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
   801   if (!file->is_open()) {
   802     // Try again to open the file.
   803     char warnbuf[O_BUFLEN*2];
   804     jio_snprintf(warnbuf, sizeof(warnbuf),
   805                  "Warning:  Cannot open log file: %s\n", try_name);
   806     // Note:  This feature is for maintainer use only.  No need for L10N.
   807     jio_print(warnbuf);
   808     FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
   809     try_name = make_log_name(log_name, os::get_temp_directory());
   810     jio_snprintf(warnbuf, sizeof(warnbuf),
   811                  "Warning:  Forcing option -XX:LogFile=%s\n", try_name);
   812     jio_print(warnbuf);
   813     delete file;
   814     file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
   815   }
   816   FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
   818   if (file->is_open()) {
   819     _log_file = file;
   820     xmlStream* xs = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
   821     _outer_xmlStream = xs;
   822     if (this == tty)  xtty = xs;
   823     // Write XML header.
   824     xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
   825     // (For now, don't bother to issue a DTD for this private format.)
   826     jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
   827     // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
   828     // we ever get round to introduce that method on the os class
   829     xs->head("hotspot_log version='%d %d'"
   830              " process='%d' time_ms='"INT64_FORMAT"'",
   831              LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
   832              os::current_process_id(), time_ms);
   833     // Write VM version header immediately.
   834     xs->head("vm_version");
   835     xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
   836     xs->tail("name");
   837     xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
   838     xs->tail("release");
   839     xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
   840     xs->tail("info");
   841     xs->tail("vm_version");
   842     // Record information about the command-line invocation.
   843     xs->head("vm_arguments");  // Cf. Arguments::print_on()
   844     if (Arguments::num_jvm_flags() > 0) {
   845       xs->head("flags");
   846       Arguments::print_jvm_flags_on(xs->text());
   847       xs->tail("flags");
   848     }
   849     if (Arguments::num_jvm_args() > 0) {
   850       xs->head("args");
   851       Arguments::print_jvm_args_on(xs->text());
   852       xs->tail("args");
   853     }
   854     if (Arguments::java_command() != NULL) {
   855       xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
   856       xs->tail("command");
   857     }
   858     if (Arguments::sun_java_launcher() != NULL) {
   859       xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
   860       xs->tail("launcher");
   861     }
   862     if (Arguments::system_properties() !=  NULL) {
   863       xs->head("properties");
   864       // Print it as a java-style property list.
   865       // System properties don't generally contain newlines, so don't bother with unparsing.
   866       for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
   867         xs->text()->print_cr("%s=%s", p->key(), p->value());
   868       }
   869       xs->tail("properties");
   870     }
   871     xs->tail("vm_arguments");
   872     // tty output per se is grouped under the <tty>...</tty> element.
   873     xs->head("tty");
   874     // All further non-markup text gets copied to the tty:
   875     xs->_text = this;  // requires friend declaration!
   876   } else {
   877     delete(file);
   878     // and leave xtty as NULL
   879     LogVMOutput = false;
   880     DisplayVMOutput = true;
   881     LogCompilation = false;
   882   }
   883 }
   885 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
   886 // called by ostream_abort() after a fatal error.
   887 //
   888 void defaultStream::finish_log() {
   889   xmlStream* xs = _outer_xmlStream;
   890   xs->done("tty");
   892   // Other log forks are appended here, at the End of Time:
   893   CompileLog::finish_log(xs->out());  // write compile logging, if any, now
   895   xs->done("hotspot_log");
   896   xs->flush();
   898   fileStream* file = _log_file;
   899   _log_file = NULL;
   901   delete _outer_xmlStream;
   902   _outer_xmlStream = NULL;
   904   file->flush();
   905   delete file;
   906 }
   908 void defaultStream::finish_log_on_error(char *buf, int buflen) {
   909   xmlStream* xs = _outer_xmlStream;
   911   if (xs && xs->out()) {
   913     xs->done_raw("tty");
   915     // Other log forks are appended here, at the End of Time:
   916     CompileLog::finish_log_on_error(xs->out(), buf, buflen);  // write compile logging, if any, now
   918     xs->done_raw("hotspot_log");
   919     xs->flush();
   921     fileStream* file = _log_file;
   922     _log_file = NULL;
   923     _outer_xmlStream = NULL;
   925     if (file) {
   926       file->flush();
   928       // Can't delete or close the file because delete and fclose aren't
   929       // async-safe. We are about to die, so leave it to the kernel.
   930       // delete file;
   931     }
   932   }
   933 }
   935 intx defaultStream::hold(intx writer_id) {
   936   bool has_log = has_log_file();  // check before locking
   937   if (// impossible, but who knows?
   938       writer_id == NO_WRITER ||
   940       // bootstrap problem
   941       tty_lock == NULL ||
   943       // can't grab a lock or call Thread::current() if TLS isn't initialized
   944       ThreadLocalStorage::thread() == NULL ||
   946       // developer hook
   947       !SerializeVMOutput ||
   949       // VM already unhealthy
   950       is_error_reported() ||
   952       // safepoint == global lock (for VM only)
   953       (SafepointSynchronize::is_synchronizing() &&
   954        Thread::current()->is_VM_thread())
   955       ) {
   956     // do not attempt to lock unless we know the thread and the VM is healthy
   957     return NO_WRITER;
   958   }
   959   if (_writer == writer_id) {
   960     // already held, no need to re-grab the lock
   961     return NO_WRITER;
   962   }
   963   tty_lock->lock_without_safepoint_check();
   964   // got the lock
   965   if (writer_id != _last_writer) {
   966     if (has_log) {
   967       _log_file->bol();
   968       // output a hint where this output is coming from:
   969       _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
   970     }
   971     _last_writer = writer_id;
   972   }
   973   _writer = writer_id;
   974   return writer_id;
   975 }
   977 void defaultStream::release(intx holder) {
   978   if (holder == NO_WRITER) {
   979     // nothing to release:  either a recursive lock, or we scribbled (too bad)
   980     return;
   981   }
   982   if (_writer != holder) {
   983     return;  // already unlocked, perhaps via break_tty_lock_for_safepoint
   984   }
   985   _writer = NO_WRITER;
   986   tty_lock->unlock();
   987 }
   990 // Yuck:  jio_print does not accept char*/len.
   991 static void call_jio_print(const char* s, size_t len) {
   992   char buffer[O_BUFLEN+100];
   993   if (len > sizeof(buffer)-1) {
   994     warning("increase O_BUFLEN in ostream.cpp -- output truncated");
   995     len = sizeof(buffer)-1;
   996   }
   997   strncpy(buffer, s, len);
   998   buffer[len] = '\0';
   999   jio_print(buffer);
  1003 void defaultStream::write(const char* s, size_t len) {
  1004   intx thread_id = os::current_thread_id();
  1005   intx holder = hold(thread_id);
  1007   if (DisplayVMOutput &&
  1008       (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
  1009     // print to output stream. It can be redirected by a vfprintf hook
  1010     if (s[len] == '\0') {
  1011       jio_print(s);
  1012     } else {
  1013       call_jio_print(s, len);
  1017   // print to log file
  1018   if (has_log_file()) {
  1019     int nl0 = _newlines;
  1020     xmlTextStream::write(s, len);
  1021     // flush the log file too, if there were any newlines
  1022     if (nl0 != _newlines){
  1023       flush();
  1025   } else {
  1026     update_position(s, len);
  1029   release(holder);
  1032 intx ttyLocker::hold_tty() {
  1033   if (defaultStream::instance == NULL)  return defaultStream::NO_WRITER;
  1034   intx thread_id = os::current_thread_id();
  1035   return defaultStream::instance->hold(thread_id);
  1038 void ttyLocker::release_tty(intx holder) {
  1039   if (holder == defaultStream::NO_WRITER)  return;
  1040   defaultStream::instance->release(holder);
  1043 bool ttyLocker::release_tty_if_locked() {
  1044   intx thread_id = os::current_thread_id();
  1045   if (defaultStream::instance->writer() == thread_id) {
  1046     // release the lock and return true so callers know if was
  1047     // previously held.
  1048     release_tty(thread_id);
  1049     return true;
  1051   return false;
  1054 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
  1055   if (defaultStream::instance != NULL &&
  1056       defaultStream::instance->writer() == holder) {
  1057     if (xtty != NULL) {
  1058       xtty->print_cr("<!-- safepoint while printing -->");
  1060     defaultStream::instance->release(holder);
  1062   // (else there was no lock to break)
  1065 void ostream_init() {
  1066   if (defaultStream::instance == NULL) {
  1067     defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
  1068     tty = defaultStream::instance;
  1070     // We want to ensure that time stamps in GC logs consider time 0
  1071     // the time when the JVM is initialized, not the first time we ask
  1072     // for a time stamp. So, here, we explicitly update the time stamp
  1073     // of tty.
  1074     tty->time_stamp().update_to(1);
  1078 void ostream_init_log() {
  1079   // For -Xloggc:<file> option - called in runtime/thread.cpp
  1080   // Note : this must be called AFTER ostream_init()
  1082   gclog_or_tty = tty; // default to tty
  1083   if (Arguments::gc_log_filename() != NULL) {
  1084     fileStream * gclog  = new(ResourceObj::C_HEAP, mtInternal)
  1085                              gcLogFileStream(Arguments::gc_log_filename());
  1086     if (gclog->is_open()) {
  1087       // now we update the time stamp of the GC log to be synced up
  1088       // with tty.
  1089       gclog->time_stamp().update_to(tty->time_stamp().ticks());
  1091     gclog_or_tty = gclog;
  1094   // If we haven't lazily initialized the logfile yet, do it now,
  1095   // to avoid the possibility of lazy initialization during a VM
  1096   // crash, which can affect the stability of the fatal error handler.
  1097   defaultStream::instance->has_log_file();
  1100 // ostream_exit() is called during normal VM exit to finish log files, flush
  1101 // output and free resource.
  1102 void ostream_exit() {
  1103   static bool ostream_exit_called = false;
  1104   if (ostream_exit_called)  return;
  1105   ostream_exit_called = true;
  1106   if (gclog_or_tty != tty) {
  1107       delete gclog_or_tty;
  1110       // we temporaly disable PrintMallocFree here
  1111       // as otherwise it'll lead to using of almost deleted
  1112       // tty or defaultStream::instance in logging facility
  1113       // of HeapFree(), see 6391258
  1114       DEBUG_ONLY(FlagSetting fs(PrintMallocFree, false);)
  1115       if (tty != defaultStream::instance) {
  1116           delete tty;
  1118       if (defaultStream::instance != NULL) {
  1119           delete defaultStream::instance;
  1122   tty = NULL;
  1123   xtty = NULL;
  1124   gclog_or_tty = NULL;
  1125   defaultStream::instance = NULL;
  1128 // ostream_abort() is called by os::abort() when VM is about to die.
  1129 void ostream_abort() {
  1130   // Here we can't delete gclog_or_tty and tty, just flush their output
  1131   if (gclog_or_tty) gclog_or_tty->flush();
  1132   if (tty) tty->flush();
  1134   if (defaultStream::instance != NULL) {
  1135     static char buf[4096];
  1136     defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
  1140 staticBufferStream::staticBufferStream(char* buffer, size_t buflen,
  1141                                        outputStream *outer_stream) {
  1142   _buffer = buffer;
  1143   _buflen = buflen;
  1144   _outer_stream = outer_stream;
  1145   // compile task prints time stamp relative to VM start
  1146   _stamp.update_to(1);
  1149 void staticBufferStream::write(const char* c, size_t len) {
  1150   _outer_stream->print_raw(c, (int)len);
  1153 void staticBufferStream::flush() {
  1154   _outer_stream->flush();
  1157 void staticBufferStream::print(const char* format, ...) {
  1158   va_list ap;
  1159   va_start(ap, format);
  1160   size_t len;
  1161   const char* str = do_vsnprintf(_buffer, _buflen, format, ap, false, len);
  1162   write(str, len);
  1163   va_end(ap);
  1166 void staticBufferStream::print_cr(const char* format, ...) {
  1167   va_list ap;
  1168   va_start(ap, format);
  1169   size_t len;
  1170   const char* str = do_vsnprintf(_buffer, _buflen, format, ap, true, len);
  1171   write(str, len);
  1172   va_end(ap);
  1175 void staticBufferStream::vprint(const char *format, va_list argptr) {
  1176   size_t len;
  1177   const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, false, len);
  1178   write(str, len);
  1181 void staticBufferStream::vprint_cr(const char* format, va_list argptr) {
  1182   size_t len;
  1183   const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, true, len);
  1184   write(str, len);
  1187 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
  1188   buffer_length = initial_size;
  1189   buffer        = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
  1190   buffer_pos    = 0;
  1191   buffer_fixed  = false;
  1192   buffer_max    = bufmax;
  1195 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
  1196   buffer_length = fixed_buffer_size;
  1197   buffer        = fixed_buffer;
  1198   buffer_pos    = 0;
  1199   buffer_fixed  = true;
  1200   buffer_max    = bufmax;
  1203 void bufferedStream::write(const char* s, size_t len) {
  1205   if(buffer_pos + len > buffer_max) {
  1206     flush();
  1209   size_t end = buffer_pos + len;
  1210   if (end >= buffer_length) {
  1211     if (buffer_fixed) {
  1212       // if buffer cannot resize, silently truncate
  1213       len = buffer_length - buffer_pos - 1;
  1214     } else {
  1215       // For small overruns, double the buffer.  For larger ones,
  1216       // increase to the requested size.
  1217       if (end < buffer_length * 2) {
  1218         end = buffer_length * 2;
  1220       buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
  1221       buffer_length = end;
  1224   memcpy(buffer + buffer_pos, s, len);
  1225   buffer_pos += len;
  1226   update_position(s, len);
  1229 char* bufferedStream::as_string() {
  1230   char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
  1231   strncpy(copy, buffer, buffer_pos);
  1232   copy[buffer_pos] = 0;  // terminating null
  1233   return copy;
  1236 bufferedStream::~bufferedStream() {
  1237   if (!buffer_fixed) {
  1238     FREE_C_HEAP_ARRAY(char, buffer, mtInternal);
  1242 #ifndef PRODUCT
  1244 #if defined(SOLARIS) || defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE)
  1245 #include <sys/types.h>
  1246 #include <sys/socket.h>
  1247 #include <netinet/in.h>
  1248 #include <arpa/inet.h>
  1249 #endif
  1251 // Network access
  1252 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
  1254   _socket = -1;
  1256   int result = os::socket(AF_INET, SOCK_STREAM, 0);
  1257   if (result <= 0) {
  1258     assert(false, "Socket could not be created!");
  1259   } else {
  1260     _socket = result;
  1264 int networkStream::read(char *buf, size_t len) {
  1265   return os::recv(_socket, buf, (int)len, 0);
  1268 void networkStream::flush() {
  1269   if (size() != 0) {
  1270     int result = os::raw_send(_socket, (char *)base(), size(), 0);
  1271     assert(result != -1, "connection error");
  1272     assert(result == (int)size(), "didn't send enough data");
  1274   reset();
  1277 networkStream::~networkStream() {
  1278   close();
  1281 void networkStream::close() {
  1282   if (_socket != -1) {
  1283     flush();
  1284     os::socket_close(_socket);
  1285     _socket = -1;
  1289 bool networkStream::connect(const char *ip, short port) {
  1291   struct sockaddr_in server;
  1292   server.sin_family = AF_INET;
  1293   server.sin_port = htons(port);
  1295   server.sin_addr.s_addr = inet_addr(ip);
  1296   if (server.sin_addr.s_addr == (uint32_t)-1) {
  1297     struct hostent* host = os::get_host_by_name((char*)ip);
  1298     if (host != NULL) {
  1299       memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
  1300     } else {
  1301       return false;
  1306   int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
  1307   return (result >= 0);
  1310 #endif

mercurial