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