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 "runtime/os.hpp"
31 #include "runtime/vm_version.hpp"
32 #include "utilities/defaultStream.hpp"
33 #include "utilities/ostream.hpp"
34 #include "utilities/top.hpp"
35 #include "utilities/xmlstream.hpp"
36
37 extern "C" void jio_print(const char* s); // Declarationtion of jvm method
38
39 outputStream::outputStream(int width) {
40 _width = width;
41 _position = 0;
42 _newlines = 0;
43 _precount = 0;
44 _indentation = 0;
45 }
46
47 outputStream::outputStream(int width, bool has_time_stamps) {
48 _width = width;
49 _position = 0;
50 _newlines = 0;
51 _precount = 0;
52 _indentation = 0;
53 if (has_time_stamps) _stamp.update();
54 }
55
56 void outputStream::update_position(const char* s, size_t len) {
57 for (size_t i = 0; i < len; i++) {
58 char ch = s[i];
59 if (ch == '\n') {
60 _newlines += 1;
61 _precount += _position + 1;
62 _position = 0;
63 } else if (ch == '\t') {
64 int tw = 8 - (_position & 7);
65 _position += tw;
66 _precount -= tw-1; // invariant: _precount + _position == total count
67 } else {
68 _position += 1;
69 }
70 }
71 }
72
73 // Execute a vsprintf, using the given buffer if necessary.
74 // Return a pointer to the formatted string.
75 const char* outputStream::do_vsnprintf(char* buffer, size_t buflen,
76 const char* format, va_list ap,
77 bool add_cr,
78 size_t& result_len) {
79 const char* result;
80 if (add_cr) buflen--;
81 if (!strchr(format, '%')) {
82 // constant format string
83 result = format;
84 result_len = strlen(result);
85 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate
86 } else if (format[0] == '%' && format[1] == 's' && format[2] == '\0') {
87 // trivial copy-through format string
88 result = va_arg(ap, const char*);
89 result_len = strlen(result);
90 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate
91 } else if (vsnprintf(buffer, buflen, format, ap) >= 0) {
92 result = buffer;
93 result_len = strlen(result);
94 } else {
95 DEBUG_ONLY(warning("increase O_BUFLEN in ostream.hpp -- output truncated");)
96 result = buffer;
97 result_len = buflen - 1;
98 buffer[result_len] = 0;
99 }
100 if (add_cr) {
101 if (result != buffer) {
102 strncpy(buffer, result, buflen);
103 result = buffer;
104 }
105 buffer[result_len++] = '\n';
106 buffer[result_len] = 0;
107 }
108 return result;
109 }
110
111 void outputStream::print(const char* format, ...) {
112 char buffer[O_BUFLEN];
113 va_list ap;
114 va_start(ap, format);
115 size_t len;
116 const char* str = do_vsnprintf(buffer, O_BUFLEN, format, ap, false, len);
117 write(str, len);
118 va_end(ap);
119 }
120
121 void outputStream::print_cr(const char* format, ...) {
122 char buffer[O_BUFLEN];
123 va_list ap;
124 va_start(ap, format);
125 size_t len;
126 const char* str = do_vsnprintf(buffer, O_BUFLEN, format, ap, true, len);
127 write(str, len);
128 va_end(ap);
129 }
130
131 void outputStream::vprint(const char *format, va_list argptr) {
132 char buffer[O_BUFLEN];
133 size_t len;
134 const char* str = do_vsnprintf(buffer, O_BUFLEN, format, argptr, false, len);
135 write(str, len);
136 }
137
138 void outputStream::vprint_cr(const char* format, va_list argptr) {
139 char buffer[O_BUFLEN];
140 size_t len;
141 const char* str = do_vsnprintf(buffer, O_BUFLEN, format, argptr, true, len);
142 write(str, len);
143 }
144
145 void outputStream::fill_to(int col) {
146 int need_fill = col - position();
147 sp(need_fill);
148 }
149
150 void outputStream::move_to(int col, int slop, int min_space) {
151 if (position() >= col + slop)
152 cr();
153 int need_fill = col - position();
154 if (need_fill < min_space)
155 need_fill = min_space;
156 sp(need_fill);
157 }
158
159 void outputStream::put(char ch) {
160 assert(ch != 0, "please fix call site");
161 char buf[] = { ch, '\0' };
162 write(buf, 1);
163 }
164
165 #define SP_USE_TABS false
166
167 void outputStream::sp(int count) {
168 if (count < 0) return;
169 if (SP_USE_TABS && count >= 8) {
170 int target = position() + count;
171 while (count >= 8) {
172 this->write("\t", 1);
173 count -= 8;
174 }
175 count = target - position();
176 }
177 while (count > 0) {
178 int nw = (count > 8) ? 8 : count;
179 this->write(" ", nw);
180 count -= nw;
181 }
182 }
183
184 void outputStream::cr() {
185 this->write("\n", 1);
186 }
187
188 void outputStream::stamp() {
189 if (! _stamp.is_updated()) {
190 _stamp.update(); // start at 0 on first call to stamp()
191 }
192
193 // outputStream::stamp() may get called by ostream_abort(), use snprintf
194 // to avoid allocating large stack buffer in print().
195 char buf[40];
196 jio_snprintf(buf, sizeof(buf), "%.3f", _stamp.seconds());
197 print_raw(buf);
198 }
199
200 void outputStream::stamp(bool guard,
201 const char* prefix,
202 const char* suffix) {
203 if (!guard) {
204 return;
205 }
206 print_raw(prefix);
207 stamp();
208 print_raw(suffix);
209 }
210
211 void outputStream::date_stamp(bool guard,
212 const char* prefix,
213 const char* suffix) {
214 if (!guard) {
215 return;
216 }
217 print_raw(prefix);
218 static const char error_time[] = "yyyy-mm-ddThh:mm:ss.mmm+zzzz";
219 static const int buffer_length = 32;
220 char buffer[buffer_length];
221 const char* iso8601_result = os::iso8601_time(buffer, buffer_length);
222 if (iso8601_result != NULL) {
223 print_raw(buffer);
224 } else {
225 print_raw(error_time);
226 }
227 print_raw(suffix);
228 return;
229 }
230
231 void outputStream::gclog_stamp(const GCId& gc_id) {
232 date_stamp(PrintGCDateStamps);
233 stamp(PrintGCTimeStamps);
234 if (PrintGCID) {
235 print("#%u: ", gc_id.id());
236 }
237 }
238
239 outputStream& outputStream::indent() {
240 while (_position < _indentation) sp();
241 return *this;
242 }
243
244 void outputStream::print_jlong(jlong value) {
245 print(JLONG_FORMAT, value);
246 }
247
248 void outputStream::print_julong(julong value) {
249 print(JULONG_FORMAT, value);
250 }
251
252 /**
253 * This prints out hex data in a 'windbg' or 'xxd' form, where each line is:
254 * <hex-address>: 8 * <hex-halfword> <ascii translation (optional)>
255 * example:
256 * 0000000: 7f44 4f46 0102 0102 0000 0000 0000 0000 .DOF............
257 * 0000010: 0000 0000 0000 0040 0000 0020 0000 0005 .......@... ....
258 * 0000020: 0000 0000 0000 0040 0000 0000 0000 015d .......@.......]
259 * ...
260 *
261 * indent is applied to each line. Ends with a CR.
262 */
263 void outputStream::print_data(void* data, size_t len, bool with_ascii) {
264 size_t limit = (len + 16) / 16 * 16;
265 for (size_t i = 0; i < limit; ++i) {
266 if (i % 16 == 0) {
267 indent().print(INTPTR_FORMAT_W(07)":", i);
268 }
269 if (i % 2 == 0) {
270 print(" ");
271 }
272 if (i < len) {
273 print("%02x", ((unsigned char*)data)[i]);
274 } else {
275 print(" ");
276 }
277 if ((i + 1) % 16 == 0) {
278 if (with_ascii) {
279 print(" ");
280 for (size_t j = 0; j < 16; ++j) {
281 size_t idx = i + j - 15;
282 if (idx < len) {
283 char c = ((char*)data)[idx];
284 print("%c", c >= 32 && c <= 126 ? c : '.');
285 }
286 }
287 }
288 cr();
289 }
290 }
291 }
292
293 stringStream::stringStream(size_t initial_size) : outputStream() {
294 buffer_length = initial_size;
295 buffer = NEW_RESOURCE_ARRAY(char, buffer_length);
296 buffer_pos = 0;
297 buffer_fixed = false;
298 DEBUG_ONLY(rm = Thread::current()->current_resource_mark();)
299 }
300
301 // useful for output to fixed chunks of memory, such as performance counters
302 stringStream::stringStream(char* fixed_buffer, size_t fixed_buffer_size) : outputStream() {
303 buffer_length = fixed_buffer_size;
304 buffer = fixed_buffer;
305 buffer_pos = 0;
306 buffer_fixed = true;
307 }
308
309 void stringStream::write(const char* s, size_t len) {
310 size_t write_len = len; // number of non-null bytes to write
311 size_t end = buffer_pos + len + 1; // position after write and final '\0'
312 if (end > buffer_length) {
313 if (buffer_fixed) {
314 // if buffer cannot resize, silently truncate
315 end = buffer_length;
316 write_len = end - buffer_pos - 1; // leave room for the final '\0'
317 } else {
318 // For small overruns, double the buffer. For larger ones,
319 // increase to the requested size.
320 if (end < buffer_length * 2) {
321 end = buffer_length * 2;
322 }
323 char* oldbuf = buffer;
324 assert(rm == NULL || Thread::current()->current_resource_mark() == rm,
325 "stringStream is re-allocated with a different ResourceMark");
326 buffer = NEW_RESOURCE_ARRAY(char, end);
327 strncpy(buffer, oldbuf, buffer_pos);
328 buffer_length = end;
329 }
330 }
331 // invariant: buffer is always null-terminated
332 guarantee(buffer_pos + write_len + 1 <= buffer_length, "stringStream oob");
333 buffer[buffer_pos + write_len] = 0;
334 strncpy(buffer + buffer_pos, s, write_len);
335 buffer_pos += write_len;
336
337 // Note that the following does not depend on write_len.
338 // This means that position and count get updated
339 // even when overflow occurs.
340 update_position(s, len);
341 }
342
343 char* stringStream::as_string() {
344 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos + 1);
345 strncpy(copy, buffer, buffer_pos);
346 copy[buffer_pos] = 0; // terminating null
347 return copy;
348 }
349
350 stringStream::~stringStream() {}
351
352 xmlStream* xtty;
353 outputStream* tty;
354 outputStream* gclog_or_tty;
355 fileStream* classlist_file; // Only dump the classes that can be stored into the CDS archive
356 extern Mutex* tty_lock;
357
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 }
371
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];
378
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 }
393
394 // const char* star = strchr(basename, '*');
395 const char* pts = strstr(basename, "%p");
396 int pid_pos = (pts == NULL) ? -1 : (pts - nametail);
397
398 if (pid_pos >= 0) {
399 jio_snprintf(pid_text, sizeof(pid_text), "pid%u", pid);
400 buffer_length += strlen(pid_text);
401 }
402
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 }
408
409 // Create big enough buffer.
410 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
411
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 }
418
419 // who is first, %p or %t?
420 int first = -1, second = -1;
421 const char *p1st = NULL;
422 const char *p2nd = NULL;
423
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 }
448
449 int buf_pos = (int)strlen(buf);
450 const char* tail = nametail;
451
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 }
466
467 // log_name comes from -XX:LogFile=log_name, -Xloggc:log_name or
468 // -XX:DumpLoadedClassList=<file_name>
469 // in log_name, %p => pid1234 and
470 // %t => YYYY-MM-DD_HH-MM-SS
471 static const char* make_log_name(const char* log_name, const char* force_directory) {
472 char timestr[32];
473 get_datetime_string(timestr, sizeof(timestr));
474 return make_log_name_internal(log_name, force_directory, os::current_process_id(),
475 timestr);
476 }
477
478 #ifndef PRODUCT
479 void test_loggc_filename() {
480 int pid;
481 char tms[32];
482 char i_result[FILENAMEBUFLEN];
483 const char* o_result;
484 get_datetime_string(tms, sizeof(tms));
485 pid = os::current_process_id();
486
487 // test.log
488 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test.log", tms);
489 o_result = make_log_name_internal("test.log", NULL, pid, tms);
490 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test.log\", NULL)");
491 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
492
493 // test-%t-%p.log
494 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%s-pid%u.log", tms, pid);
495 o_result = make_log_name_internal("test-%t-%p.log", NULL, pid, tms);
496 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t-%%p.log\", NULL)");
497 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
498
499 // test-%t%p.log
500 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%spid%u.log", tms, pid);
501 o_result = make_log_name_internal("test-%t%p.log", NULL, pid, tms);
502 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t%%p.log\", NULL)");
503 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
504
505 // %p%t.log
506 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u%s.log", pid, tms);
507 o_result = make_log_name_internal("%p%t.log", NULL, pid, tms);
508 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p%%t.log\", NULL)");
509 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
510
511 // %p-test.log
512 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u-test.log", pid);
513 o_result = make_log_name_internal("%p-test.log", NULL, pid, tms);
514 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p-test.log\", NULL)");
515 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
516
517 // %t.log
518 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "%s.log", tms);
519 o_result = make_log_name_internal("%t.log", NULL, pid, tms);
520 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%t.log\", NULL)");
521 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
522 }
523 #endif // PRODUCT
524
525 fileStream::fileStream(const char* file_name) {
526 _file = fopen(file_name, "w");
527 if (_file != NULL) {
528 _need_close = true;
529 } else {
530 warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
531 _need_close = false;
532 }
533 }
534
535 fileStream::fileStream(const char* file_name, const char* opentype) {
536 _file = fopen(file_name, opentype);
537 if (_file != NULL) {
538 _need_close = true;
539 } else {
540 warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
541 _need_close = false;
542 }
543 }
544
545 void fileStream::write(const char* s, size_t len) {
546 if (_file != NULL) {
547 // Make an unused local variable to avoid warning from gcc 4.x compiler.
548 size_t count = fwrite(s, 1, len, _file);
549 }
550 update_position(s, len);
551 }
552
553 long fileStream::fileSize() {
554 long size = -1;
555 if (_file != NULL) {
556 long pos = ::ftell(_file);
557 if (::fseek(_file, 0, SEEK_END) == 0) {
558 size = ::ftell(_file);
559 }
560 ::fseek(_file, pos, SEEK_SET);
561 }
562 return size;
563 }
564
565 char* fileStream::readln(char *data, int count ) {
566 char * ret = ::fgets(data, count, _file);
567 //Get rid of annoying \n char
568 data[::strlen(data)-1] = '\0';
569 return ret;
570 }
571
572 fileStream::~fileStream() {
573 if (_file != NULL) {
574 if (_need_close) fclose(_file);
575 _file = NULL;
576 }
577 }
578
579 void fileStream::flush() {
580 fflush(_file);
581 }
582
583 fdStream::fdStream(const char* file_name) {
584 _fd = open(file_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
585 _need_close = true;
586 }
587
588 fdStream::~fdStream() {
589 if (_fd != -1) {
590 if (_need_close) close(_fd);
591 _fd = -1;
592 }
593 }
594
595 void fdStream::write(const char* s, size_t len) {
596 if (_fd != -1) {
597 // Make an unused local variable to avoid warning from gcc 4.x compiler.
598 size_t count = ::write(_fd, s, (int)len);
599 }
600 update_position(s, len);
601 }
602
603 // dump vm version, os version, platform info, build id,
604 // memory usage and command line flags into header
605 void gcLogFileStream::dump_loggc_header() {
606 if (is_open()) {
607 print_cr("%s", Abstract_VM_Version::internal_vm_info_string());
608 os::print_memory_info(this);
609 print("CommandLine flags: ");
610 CommandLineFlags::printSetFlags(this);
611 }
612 }
613
614 gcLogFileStream::~gcLogFileStream() {
615 if (_file != NULL) {
616 if (_need_close) fclose(_file);
617 _file = NULL;
618 }
619 if (_file_name != NULL) {
620 FREE_C_HEAP_ARRAY(char, _file_name, mtInternal);
621 _file_name = NULL;
622 }
623 }
624
625 gcLogFileStream::gcLogFileStream(const char* file_name) {
626 _cur_file_num = 0;
627 _bytes_written = 0L;
628 _file_name = make_log_name(file_name, NULL);
629
630 // gc log file rotation
631 if (UseGCLogFileRotation && NumberOfGCLogFiles > 1) {
632 char tempbuf[FILENAMEBUFLEN];
633 jio_snprintf(tempbuf, sizeof(tempbuf), "%s.%d" CURRENTAPPX, _file_name, _cur_file_num);
634 _file = fopen(tempbuf, "w");
635 } else {
636 _file = fopen(_file_name, "w");
637 }
638 if (_file != NULL) {
639 _need_close = true;
640 dump_loggc_header();
641 } else {
642 warning("Cannot open file %s due to %s\n", _file_name, strerror(errno));
643 _need_close = false;
644 }
645 }
646
647 void gcLogFileStream::write(const char* s, size_t len) {
648 if (_file != NULL) {
649 size_t count = fwrite(s, 1, len, _file);
650 _bytes_written += count;
651 }
652 update_position(s, len);
653 }
654
655 // rotate_log must be called from VMThread at safepoint. In case need change parameters
656 // for gc log rotation from thread other than VMThread, a sub type of VM_Operation
657 // should be created and be submitted to VMThread's operation queue. DO NOT call this
658 // function directly. Currently, it is safe to rotate log at safepoint through VMThread.
659 // That is, no mutator threads and concurrent GC threads run parallel with VMThread to
660 // write to gc log file at safepoint. If in future, changes made for mutator threads or
661 // concurrent GC threads to run parallel with VMThread at safepoint, write and rotate_log
662 // must be synchronized.
663 void gcLogFileStream::rotate_log(bool force, outputStream* out) {
664 char time_msg[FILENAMEBUFLEN];
665 char time_str[EXTRACHARLEN];
666 char current_file_name[FILENAMEBUFLEN];
667 char renamed_file_name[FILENAMEBUFLEN];
668
669 if (!should_rotate(force)) {
670 return;
671 }
672
673 #ifdef ASSERT
674 Thread *thread = Thread::current();
675 assert(thread == NULL ||
676 (thread->is_VM_thread() && SafepointSynchronize::is_at_safepoint()),
677 "Must be VMThread at safepoint");
678 #endif
679 if (NumberOfGCLogFiles == 1) {
680 // rotate in same file
681 rewind();
682 _bytes_written = 0L;
683 jio_snprintf(time_msg, sizeof(time_msg), "File %s rotated at %s\n",
684 _file_name, os::local_time_string((char *)time_str, sizeof(time_str)));
685 write(time_msg, strlen(time_msg));
686
687 if (out != NULL) {
688 out->print("%s", time_msg);
689 }
690
691 dump_loggc_header();
692 return;
693 }
694
695 #if defined(_WINDOWS)
696 #ifndef F_OK
697 #define F_OK 0
698 #endif
699 #endif // _WINDOWS
700
701 // rotate file in names extended_filename.0, extended_filename.1, ...,
702 // extended_filename.<NumberOfGCLogFiles - 1>. Current rotation file name will
703 // have a form of extended_filename.<i>.current where i is the current rotation
704 // file number. After it reaches max file size, the file will be saved and renamed
705 // with .current removed from its tail.
706 size_t filename_len = strlen(_file_name);
707 if (_file != NULL) {
708 jio_snprintf(renamed_file_name, filename_len + EXTRACHARLEN, "%s.%d",
709 _file_name, _cur_file_num);
710 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
711 _file_name, _cur_file_num);
712
713 const char* msg = force ? "GC log rotation request has been received."
714 : "GC log file has reached the maximum size.";
715 jio_snprintf(time_msg, sizeof(time_msg), "%s %s Saved as %s\n",
716 os::local_time_string((char *)time_str, sizeof(time_str)),
717 msg, renamed_file_name);
718 write(time_msg, strlen(time_msg));
719
720 if (out != NULL) {
721 out->print("%s", time_msg);
722 }
723
724 fclose(_file);
725 _file = NULL;
726
727 bool can_rename = true;
728 if (access(current_file_name, F_OK) != 0) {
729 // current file does not exist?
730 warning("No source file exists, cannot rename\n");
731 can_rename = false;
732 }
733 if (can_rename) {
734 if (access(renamed_file_name, F_OK) == 0) {
735 if (remove(renamed_file_name) != 0) {
736 warning("Could not delete existing file %s\n", renamed_file_name);
737 can_rename = false;
738 }
739 } else {
740 // file does not exist, ok to rename
741 }
742 }
743 if (can_rename && rename(current_file_name, renamed_file_name) != 0) {
744 warning("Could not rename %s to %s\n", _file_name, renamed_file_name);
745 }
746 }
747
748 _cur_file_num++;
749 if (_cur_file_num > NumberOfGCLogFiles - 1) _cur_file_num = 0;
750 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
751 _file_name, _cur_file_num);
752 _file = fopen(current_file_name, "w");
753
754 if (_file != NULL) {
755 _bytes_written = 0L;
756 _need_close = true;
757 // reuse current_file_name for time_msg
758 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN,
759 "%s.%d", _file_name, _cur_file_num);
760 jio_snprintf(time_msg, sizeof(time_msg), "%s GC log file created %s\n",
761 os::local_time_string((char *)time_str, sizeof(time_str)),
762 current_file_name);
763 write(time_msg, strlen(time_msg));
764
765 if (out != NULL) {
766 out->print("%s", time_msg);
767 }
768
769 dump_loggc_header();
770 // remove the existing file
771 if (access(current_file_name, F_OK) == 0) {
772 if (remove(current_file_name) != 0) {
773 warning("Could not delete existing file %s\n", current_file_name);
774 }
775 }
776 } else {
777 warning("failed to open rotation log file %s due to %s\n"
778 "Turned off GC log file rotation\n",
779 _file_name, strerror(errno));
780 _need_close = false;
781 FLAG_SET_DEFAULT(UseGCLogFileRotation, false);
782 }
783 }
784
785 defaultStream* defaultStream::instance = NULL;
786 int defaultStream::_output_fd = 1;
787 int defaultStream::_error_fd = 2;
788 FILE* defaultStream::_output_stream = stdout;
789 FILE* defaultStream::_error_stream = stderr;
790
791 #define LOG_MAJOR_VERSION 160
792 #define LOG_MINOR_VERSION 1
793
794 void defaultStream::init() {
795 _inited = true;
796 if (LogVMOutput || LogCompilation) {
797 init_log();
798 }
799 }
800
801 bool defaultStream::has_log_file() {
802 // lazily create log file (at startup, LogVMOutput is false even
803 // if +LogVMOutput is used, because the flags haven't been parsed yet)
804 // For safer printing during fatal error handling, do not init logfile
805 // if a VM error has been reported.
806 if (!_inited && !is_error_reported()) init();
807 return _log_file != NULL;
808 }
809
810 void defaultStream::init_log() {
811 // %%% Need a MutexLocker?
812 const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log";
813 const char* try_name = make_log_name(log_name, NULL);
814 fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
815 if (!file->is_open()) {
816 // Try again to open the file.
817 char warnbuf[O_BUFLEN*2];
818 jio_snprintf(warnbuf, sizeof(warnbuf),
819 "Warning: Cannot open log file: %s\n", try_name);
820 // Note: This feature is for maintainer use only. No need for L10N.
821 jio_print(warnbuf);
822 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
823 try_name = make_log_name(log_name, os::get_temp_directory());
824 jio_snprintf(warnbuf, sizeof(warnbuf),
825 "Warning: Forcing option -XX:LogFile=%s\n", try_name);
826 jio_print(warnbuf);
827 delete file;
828 file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
829 }
830 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
831
832 if (file->is_open()) {
833 _log_file = file;
834 xmlStream* xs = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
835 _outer_xmlStream = xs;
836 if (this == tty) xtty = xs;
837 // Write XML header.
838 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
839 // (For now, don't bother to issue a DTD for this private format.)
840 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
841 // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
842 // we ever get round to introduce that method on the os class
843 xs->head("hotspot_log version='%d %d'"
844 " process='%d' time_ms='"INT64_FORMAT"'",
845 LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
846 os::current_process_id(), (int64_t)time_ms);
847 // Write VM version header immediately.
848 xs->head("vm_version");
849 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
850 xs->tail("name");
851 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
852 xs->tail("release");
853 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
854 xs->tail("info");
855 xs->tail("vm_version");
856 // Record information about the command-line invocation.
857 xs->head("vm_arguments"); // Cf. Arguments::print_on()
858 if (Arguments::num_jvm_flags() > 0) {
859 xs->head("flags");
860 Arguments::print_jvm_flags_on(xs->text());
861 xs->tail("flags");
862 }
863 if (Arguments::num_jvm_args() > 0) {
864 xs->head("args");
865 Arguments::print_jvm_args_on(xs->text());
866 xs->tail("args");
867 }
868 if (Arguments::java_command() != NULL) {
869 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
870 xs->tail("command");
871 }
872 if (Arguments::sun_java_launcher() != NULL) {
873 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
874 xs->tail("launcher");
875 }
876 if (Arguments::system_properties() != NULL) {
877 xs->head("properties");
878 // Print it as a java-style property list.
879 // System properties don't generally contain newlines, so don't bother with unparsing.
880 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
881 xs->text()->print_cr("%s=%s", p->key(), p->value());
882 }
883 xs->tail("properties");
884 }
885 xs->tail("vm_arguments");
886 // tty output per se is grouped under the <tty>...</tty> element.
887 xs->head("tty");
888 // All further non-markup text gets copied to the tty:
889 xs->_text = this; // requires friend declaration!
890 } else {
891 delete(file);
892 // and leave xtty as NULL
893 LogVMOutput = false;
894 DisplayVMOutput = true;
895 LogCompilation = false;
896 }
897 }
898
899 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
900 // called by ostream_abort() after a fatal error.
901 //
902 void defaultStream::finish_log() {
903 xmlStream* xs = _outer_xmlStream;
904 xs->done("tty");
905
906 // Other log forks are appended here, at the End of Time:
907 CompileLog::finish_log(xs->out()); // write compile logging, if any, now
908
909 xs->done("hotspot_log");
910 xs->flush();
911
912 fileStream* file = _log_file;
913 _log_file = NULL;
914
915 delete _outer_xmlStream;
916 _outer_xmlStream = NULL;
917
918 file->flush();
919 delete file;
920 }
921
922 void defaultStream::finish_log_on_error(char *buf, int buflen) {
923 xmlStream* xs = _outer_xmlStream;
924
925 if (xs && xs->out()) {
926
927 xs->done_raw("tty");
928
929 // Other log forks are appended here, at the End of Time:
930 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now
931
932 xs->done_raw("hotspot_log");
933 xs->flush();
934
935 fileStream* file = _log_file;
936 _log_file = NULL;
937 _outer_xmlStream = NULL;
938
939 if (file) {
940 file->flush();
941
942 // Can't delete or close the file because delete and fclose aren't
943 // async-safe. We are about to die, so leave it to the kernel.
944 // delete file;
945 }
946 }
947 }
948
949 intx defaultStream::hold(intx writer_id) {
950 bool has_log = has_log_file(); // check before locking
951 if (// impossible, but who knows?
952 writer_id == NO_WRITER ||
953
954 // bootstrap problem
955 tty_lock == NULL ||
956
957 // can't grab a lock or call Thread::current() if TLS isn't initialized
958 ThreadLocalStorage::thread() == NULL ||
959
960 // developer hook
961 !SerializeVMOutput ||
962
963 // VM already unhealthy
964 is_error_reported() ||
965
966 // safepoint == global lock (for VM only)
967 (SafepointSynchronize::is_synchronizing() &&
968 Thread::current()->is_VM_thread())
969 ) {
970 // do not attempt to lock unless we know the thread and the VM is healthy
971 return NO_WRITER;
972 }
973 if (_writer == writer_id) {
974 // already held, no need to re-grab the lock
975 return NO_WRITER;
976 }
977 tty_lock->lock_without_safepoint_check();
978 // got the lock
979 if (writer_id != _last_writer) {
980 if (has_log) {
981 _log_file->bol();
982 // output a hint where this output is coming from:
983 _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
984 }
985 _last_writer = writer_id;
986 }
987 _writer = writer_id;
988 return writer_id;
989 }
990
991 void defaultStream::release(intx holder) {
992 if (holder == NO_WRITER) {
993 // nothing to release: either a recursive lock, or we scribbled (too bad)
994 return;
995 }
996 if (_writer != holder) {
997 return; // already unlocked, perhaps via break_tty_lock_for_safepoint
998 }
999 _writer = NO_WRITER;
1000 tty_lock->unlock();
1001 }
1002
1003
1004 // Yuck: jio_print does not accept char*/len.
1005 static void call_jio_print(const char* s, size_t len) {
1006 char buffer[O_BUFLEN+100];
1007 if (len > sizeof(buffer)-1) {
1008 warning("increase O_BUFLEN in ostream.cpp -- output truncated");
1009 len = sizeof(buffer)-1;
1010 }
1011 strncpy(buffer, s, len);
1012 buffer[len] = '\0';
1013 jio_print(buffer);
1014 }
1015
1016
1017 void defaultStream::write(const char* s, size_t len) {
1018 intx thread_id = os::current_thread_id();
1019 intx holder = hold(thread_id);
1020
1021 if (DisplayVMOutput &&
1022 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
1023 // print to output stream. It can be redirected by a vfprintf hook
1024 if (s[len] == '\0') {
1025 jio_print(s);
1026 } else {
1027 call_jio_print(s, len);
1028 }
1029 }
1030
1031 // print to log file
1032 if (has_log_file()) {
1033 int nl0 = _newlines;
1034 xmlTextStream::write(s, len);
1035 // flush the log file too, if there were any newlines
1036 if (nl0 != _newlines){
1037 flush();
1038 }
1039 } else {
1040 update_position(s, len);
1041 }
1042
1043 release(holder);
1044 }
1045
1046 intx ttyLocker::hold_tty() {
1047 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER;
1048 intx thread_id = os::current_thread_id();
1049 return defaultStream::instance->hold(thread_id);
1050 }
1051
1052 void ttyLocker::release_tty(intx holder) {
1053 if (holder == defaultStream::NO_WRITER) return;
1054 defaultStream::instance->release(holder);
1055 }
1056
1057 bool ttyLocker::release_tty_if_locked() {
1058 intx thread_id = os::current_thread_id();
1059 if (defaultStream::instance->writer() == thread_id) {
1060 // release the lock and return true so callers know if was
1061 // previously held.
1062 release_tty(thread_id);
1063 return true;
1064 }
1065 return false;
1066 }
1067
1068 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
1069 if (defaultStream::instance != NULL &&
1070 defaultStream::instance->writer() == holder) {
1071 if (xtty != NULL) {
1072 xtty->print_cr("<!-- safepoint while printing -->");
1073 }
1074 defaultStream::instance->release(holder);
1075 }
1076 // (else there was no lock to break)
1077 }
1078
1079 void ostream_init() {
1080 if (defaultStream::instance == NULL) {
1081 defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
1082 tty = defaultStream::instance;
1083
1084 // We want to ensure that time stamps in GC logs consider time 0
1085 // the time when the JVM is initialized, not the first time we ask
1086 // for a time stamp. So, here, we explicitly update the time stamp
1087 // of tty.
1088 tty->time_stamp().update_to(1);
1089 }
1090 }
1091
1092 void ostream_init_log() {
1093 // For -Xloggc:<file> option - called in runtime/thread.cpp
1094 // Note : this must be called AFTER ostream_init()
1095
1096 gclog_or_tty = tty; // default to tty
1097 if (Arguments::gc_log_filename() != NULL) {
1098 fileStream * gclog = new(ResourceObj::C_HEAP, mtInternal)
1099 gcLogFileStream(Arguments::gc_log_filename());
1100 if (gclog->is_open()) {
1101 // now we update the time stamp of the GC log to be synced up
1102 // with tty.
1103 gclog->time_stamp().update_to(tty->time_stamp().ticks());
1104 }
1105 gclog_or_tty = gclog;
1106 }
1107
1108 // For -XX:DumpLoadedClassList=<file> option
1109 if (DumpLoadedClassList != NULL) {
1110 const char* list_name = make_log_name(DumpLoadedClassList, NULL);
1111 classlist_file = new(ResourceObj::C_HEAP, mtInternal)
1112 fileStream(list_name);
1113 FREE_C_HEAP_ARRAY(char, list_name, mtInternal);
1114 }
1115
1116 // If we haven't lazily initialized the logfile yet, do it now,
1117 // to avoid the possibility of lazy initialization during a VM
1118 // crash, which can affect the stability of the fatal error handler.
1119 defaultStream::instance->has_log_file();
1120 }
1121
1122 // ostream_exit() is called during normal VM exit to finish log files, flush
1123 // output and free resource.
1124 void ostream_exit() {
1125 static bool ostream_exit_called = false;
1126 if (ostream_exit_called) return;
1127 ostream_exit_called = true;
1128 if (classlist_file != NULL) {
1129 delete classlist_file;
1130 }
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