src/share/vm/utilities/ostream.cpp

Mon, 07 Oct 2013 14:10:29 +0400

author
vlivanov
date
Mon, 07 Oct 2013 14:10:29 +0400
changeset 5903
bf8a21c3ab3b
parent 5737
da051ce490eb
child 6472
2b8e28fdf503
permissions
-rw-r--r--

8025849: Redundant "pid" in VM log file name (e.g. hotspot_pidpid12345.log)
Reviewed-by: twisti, azeemj

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

mercurial