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 extern Mutex* tty_lock;
356
357 #define EXTRACHARLEN 32
358 #define CURRENTAPPX ".current"
359 #define FILENAMEBUFLEN 1024
360 // convert YYYY-MM-DD HH:MM:SS to YYYY-MM-DD_HH-MM-SS
361 char* get_datetime_string(char *buf, size_t len) {
362 os::local_time_string(buf, len);
363 int i = (int)strlen(buf);
364 while (i-- >= 0) {
365 if (buf[i] == ' ') buf[i] = '_';
366 else if (buf[i] == ':') buf[i] = '-';
367 }
368 return buf;
369 }
370
371 static const char* make_log_name_internal(const char* log_name, const char* force_directory,
372 int pid, const char* tms) {
373 const char* basename = log_name;
374 char file_sep = os::file_separator()[0];
375 const char* cp;
376 char pid_text[32];
377
378 for (cp = log_name; *cp != '\0'; cp++) {
379 if (*cp == '/' || *cp == file_sep) {
380 basename = cp + 1;
381 }
382 }
383 const char* nametail = log_name;
384 // Compute buffer length
385 size_t buffer_length;
386 if (force_directory != NULL) {
387 buffer_length = strlen(force_directory) + strlen(os::file_separator()) +
388 strlen(basename) + 1;
389 } else {
390 buffer_length = strlen(log_name) + 1;
391 }
392
393 // const char* star = strchr(basename, '*');
394 const char* pts = strstr(basename, "%p");
395 int pid_pos = (pts == NULL) ? -1 : (pts - nametail);
396
397 if (pid_pos >= 0) {
398 jio_snprintf(pid_text, sizeof(pid_text), "pid%u", pid);
399 buffer_length += strlen(pid_text);
400 }
401
402 pts = strstr(basename, "%t");
403 int tms_pos = (pts == NULL) ? -1 : (pts - nametail);
404 if (tms_pos >= 0) {
405 buffer_length += strlen(tms);
406 }
407
408 // Create big enough buffer.
409 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
410
411 strcpy(buf, "");
412 if (force_directory != NULL) {
413 strcat(buf, force_directory);
414 strcat(buf, os::file_separator());
415 nametail = basename; // completely skip directory prefix
416 }
417
418 // who is first, %p or %t?
419 int first = -1, second = -1;
420 const char *p1st = NULL;
421 const char *p2nd = NULL;
422
423 if (pid_pos >= 0 && tms_pos >= 0) {
424 // contains both %p and %t
425 if (pid_pos < tms_pos) {
426 // case foo%pbar%tmonkey.log
427 first = pid_pos;
428 p1st = pid_text;
429 second = tms_pos;
430 p2nd = tms;
431 } else {
432 // case foo%tbar%pmonkey.log
433 first = tms_pos;
434 p1st = tms;
435 second = pid_pos;
436 p2nd = pid_text;
437 }
438 } else if (pid_pos >= 0) {
439 // contains %p only
440 first = pid_pos;
441 p1st = pid_text;
442 } else if (tms_pos >= 0) {
443 // contains %t only
444 first = tms_pos;
445 p1st = tms;
446 }
447
448 int buf_pos = (int)strlen(buf);
449 const char* tail = nametail;
450
451 if (first >= 0) {
452 tail = nametail + first + 2;
453 strncpy(&buf[buf_pos], nametail, first);
454 strcpy(&buf[buf_pos + first], p1st);
455 buf_pos = (int)strlen(buf);
456 if (second >= 0) {
457 strncpy(&buf[buf_pos], tail, second - first - 2);
458 strcpy(&buf[buf_pos + second - first - 2], p2nd);
459 tail = nametail + second + 2;
460 }
461 }
462 strcat(buf, tail); // append rest of name, or all of name
463 return buf;
464 }
465
466 // log_name comes from -XX:LogFile=log_name or -Xloggc:log_name
467 // in log_name, %p => pid1234 and
468 // %t => YYYY-MM-DD_HH-MM-SS
469 static const char* make_log_name(const char* log_name, const char* force_directory) {
470 char timestr[32];
471 get_datetime_string(timestr, sizeof(timestr));
472 return make_log_name_internal(log_name, force_directory, os::current_process_id(),
473 timestr);
474 }
475
476 #ifndef PRODUCT
477 void test_loggc_filename() {
478 int pid;
479 char tms[32];
480 char i_result[FILENAMEBUFLEN];
481 const char* o_result;
482 get_datetime_string(tms, sizeof(tms));
483 pid = os::current_process_id();
484
485 // test.log
486 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test.log", tms);
487 o_result = make_log_name_internal("test.log", NULL, pid, tms);
488 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test.log\", NULL)");
489 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
490
491 // test-%t-%p.log
492 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%s-pid%u.log", tms, pid);
493 o_result = make_log_name_internal("test-%t-%p.log", NULL, pid, tms);
494 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t-%%p.log\", NULL)");
495 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
496
497 // test-%t%p.log
498 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "test-%spid%u.log", tms, pid);
499 o_result = make_log_name_internal("test-%t%p.log", NULL, pid, tms);
500 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"test-%%t%%p.log\", NULL)");
501 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
502
503 // %p%t.log
504 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u%s.log", pid, tms);
505 o_result = make_log_name_internal("%p%t.log", NULL, pid, tms);
506 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p%%t.log\", NULL)");
507 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
508
509 // %p-test.log
510 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "pid%u-test.log", pid);
511 o_result = make_log_name_internal("%p-test.log", NULL, pid, tms);
512 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%p-test.log\", NULL)");
513 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
514
515 // %t.log
516 jio_snprintf(i_result, sizeof(char)*FILENAMEBUFLEN, "%s.log", tms);
517 o_result = make_log_name_internal("%t.log", NULL, pid, tms);
518 assert(strcmp(i_result, o_result) == 0, "failed on testing make_log_name(\"%%t.log\", NULL)");
519 FREE_C_HEAP_ARRAY(char, o_result, mtInternal);
520 }
521 #endif // PRODUCT
522
523 fileStream::fileStream(const char* file_name) {
524 _file = fopen(file_name, "w");
525 if (_file != NULL) {
526 _need_close = true;
527 } else {
528 warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
529 _need_close = false;
530 }
531 }
532
533 fileStream::fileStream(const char* file_name, const char* opentype) {
534 _file = fopen(file_name, opentype);
535 if (_file != NULL) {
536 _need_close = true;
537 } else {
538 warning("Cannot open file %s due to %s\n", file_name, strerror(errno));
539 _need_close = false;
540 }
541 }
542
543 void fileStream::write(const char* s, size_t len) {
544 if (_file != NULL) {
545 // Make an unused local variable to avoid warning from gcc 4.x compiler.
546 size_t count = fwrite(s, 1, len, _file);
547 }
548 update_position(s, len);
549 }
550
551 long fileStream::fileSize() {
552 long size = -1;
553 if (_file != NULL) {
554 long pos = ::ftell(_file);
555 if (::fseek(_file, 0, SEEK_END) == 0) {
556 size = ::ftell(_file);
557 }
558 ::fseek(_file, pos, SEEK_SET);
559 }
560 return size;
561 }
562
563 char* fileStream::readln(char *data, int count ) {
564 char * ret = ::fgets(data, count, _file);
565 //Get rid of annoying \n char
566 data[::strlen(data)-1] = '\0';
567 return ret;
568 }
569
570 fileStream::~fileStream() {
571 if (_file != NULL) {
572 if (_need_close) fclose(_file);
573 _file = NULL;
574 }
575 }
576
577 void fileStream::flush() {
578 fflush(_file);
579 }
580
581 fdStream::fdStream(const char* file_name) {
582 _fd = open(file_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
583 _need_close = true;
584 }
585
586 fdStream::~fdStream() {
587 if (_fd != -1) {
588 if (_need_close) close(_fd);
589 _fd = -1;
590 }
591 }
592
593 void fdStream::write(const char* s, size_t len) {
594 if (_fd != -1) {
595 // Make an unused local variable to avoid warning from gcc 4.x compiler.
596 size_t count = ::write(_fd, s, (int)len);
597 }
598 update_position(s, len);
599 }
600
601 // dump vm version, os version, platform info, build id,
602 // memory usage and command line flags into header
603 void gcLogFileStream::dump_loggc_header() {
604 if (is_open()) {
605 print_cr("%s", Abstract_VM_Version::internal_vm_info_string());
606 os::print_memory_info(this);
607 print("CommandLine flags: ");
608 CommandLineFlags::printSetFlags(this);
609 }
610 }
611
612 gcLogFileStream::~gcLogFileStream() {
613 if (_file != NULL) {
614 if (_need_close) fclose(_file);
615 _file = NULL;
616 }
617 if (_file_name != NULL) {
618 FREE_C_HEAP_ARRAY(char, _file_name, mtInternal);
619 _file_name = NULL;
620 }
621 }
622
623 gcLogFileStream::gcLogFileStream(const char* file_name) {
624 _cur_file_num = 0;
625 _bytes_written = 0L;
626 _file_name = make_log_name(file_name, NULL);
627
628 // gc log file rotation
629 if (UseGCLogFileRotation && NumberOfGCLogFiles > 1) {
630 char tempbuf[FILENAMEBUFLEN];
631 jio_snprintf(tempbuf, sizeof(tempbuf), "%s.%d" CURRENTAPPX, _file_name, _cur_file_num);
632 _file = fopen(tempbuf, "w");
633 } else {
634 _file = fopen(_file_name, "w");
635 }
636 if (_file != NULL) {
637 _need_close = true;
638 dump_loggc_header();
639 } else {
640 warning("Cannot open file %s due to %s\n", _file_name, strerror(errno));
641 _need_close = false;
642 }
643 }
644
645 void gcLogFileStream::write(const char* s, size_t len) {
646 if (_file != NULL) {
647 size_t count = fwrite(s, 1, len, _file);
648 _bytes_written += count;
649 }
650 update_position(s, len);
651 }
652
653 // rotate_log must be called from VMThread at safepoint. In case need change parameters
654 // for gc log rotation from thread other than VMThread, a sub type of VM_Operation
655 // should be created and be submitted to VMThread's operation queue. DO NOT call this
656 // function directly. Currently, it is safe to rotate log at safepoint through VMThread.
657 // That is, no mutator threads and concurrent GC threads run parallel with VMThread to
658 // write to gc log file at safepoint. If in future, changes made for mutator threads or
659 // concurrent GC threads to run parallel with VMThread at safepoint, write and rotate_log
660 // must be synchronized.
661 void gcLogFileStream::rotate_log(bool force, outputStream* out) {
662 char time_msg[FILENAMEBUFLEN];
663 char time_str[EXTRACHARLEN];
664 char current_file_name[FILENAMEBUFLEN];
665 char renamed_file_name[FILENAMEBUFLEN];
666
667 if (!should_rotate(force)) {
668 return;
669 }
670
671 #ifdef ASSERT
672 Thread *thread = Thread::current();
673 assert(thread == NULL ||
674 (thread->is_VM_thread() && SafepointSynchronize::is_at_safepoint()),
675 "Must be VMThread at safepoint");
676 #endif
677 if (NumberOfGCLogFiles == 1) {
678 // rotate in same file
679 rewind();
680 _bytes_written = 0L;
681 jio_snprintf(time_msg, sizeof(time_msg), "File %s rotated at %s\n",
682 _file_name, os::local_time_string((char *)time_str, sizeof(time_str)));
683 write(time_msg, strlen(time_msg));
684
685 if (out != NULL) {
686 out->print("%s", time_msg);
687 }
688
689 dump_loggc_header();
690 return;
691 }
692
693 #if defined(_WINDOWS)
694 #ifndef F_OK
695 #define F_OK 0
696 #endif
697 #endif // _WINDOWS
698
699 // rotate file in names extended_filename.0, extended_filename.1, ...,
700 // extended_filename.<NumberOfGCLogFiles - 1>. Current rotation file name will
701 // have a form of extended_filename.<i>.current where i is the current rotation
702 // file number. After it reaches max file size, the file will be saved and renamed
703 // with .current removed from its tail.
704 size_t filename_len = strlen(_file_name);
705 if (_file != NULL) {
706 jio_snprintf(renamed_file_name, filename_len + EXTRACHARLEN, "%s.%d",
707 _file_name, _cur_file_num);
708 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
709 _file_name, _cur_file_num);
710
711 const char* msg = force ? "GC log rotation request has been received."
712 : "GC log file has reached the maximum size.";
713 jio_snprintf(time_msg, sizeof(time_msg), "%s %s Saved as %s\n",
714 os::local_time_string((char *)time_str, sizeof(time_str)),
715 msg, renamed_file_name);
716 write(time_msg, strlen(time_msg));
717
718 if (out != NULL) {
719 out->print("%s", time_msg);
720 }
721
722 fclose(_file);
723 _file = NULL;
724
725 bool can_rename = true;
726 if (access(current_file_name, F_OK) != 0) {
727 // current file does not exist?
728 warning("No source file exists, cannot rename\n");
729 can_rename = false;
730 }
731 if (can_rename) {
732 if (access(renamed_file_name, F_OK) == 0) {
733 if (remove(renamed_file_name) != 0) {
734 warning("Could not delete existing file %s\n", renamed_file_name);
735 can_rename = false;
736 }
737 } else {
738 // file does not exist, ok to rename
739 }
740 }
741 if (can_rename && rename(current_file_name, renamed_file_name) != 0) {
742 warning("Could not rename %s to %s\n", _file_name, renamed_file_name);
743 }
744 }
745
746 _cur_file_num++;
747 if (_cur_file_num > NumberOfGCLogFiles - 1) _cur_file_num = 0;
748 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN, "%s.%d" CURRENTAPPX,
749 _file_name, _cur_file_num);
750 _file = fopen(current_file_name, "w");
751
752 if (_file != NULL) {
753 _bytes_written = 0L;
754 _need_close = true;
755 // reuse current_file_name for time_msg
756 jio_snprintf(current_file_name, filename_len + EXTRACHARLEN,
757 "%s.%d", _file_name, _cur_file_num);
758 jio_snprintf(time_msg, sizeof(time_msg), "%s GC log file created %s\n",
759 os::local_time_string((char *)time_str, sizeof(time_str)),
760 current_file_name);
761 write(time_msg, strlen(time_msg));
762
763 if (out != NULL) {
764 out->print("%s", time_msg);
765 }
766
767 dump_loggc_header();
768 // remove the existing file
769 if (access(current_file_name, F_OK) == 0) {
770 if (remove(current_file_name) != 0) {
771 warning("Could not delete existing file %s\n", current_file_name);
772 }
773 }
774 } else {
775 warning("failed to open rotation log file %s due to %s\n"
776 "Turned off GC log file rotation\n",
777 _file_name, strerror(errno));
778 _need_close = false;
779 FLAG_SET_DEFAULT(UseGCLogFileRotation, false);
780 }
781 }
782
783 defaultStream* defaultStream::instance = NULL;
784 int defaultStream::_output_fd = 1;
785 int defaultStream::_error_fd = 2;
786 FILE* defaultStream::_output_stream = stdout;
787 FILE* defaultStream::_error_stream = stderr;
788
789 #define LOG_MAJOR_VERSION 160
790 #define LOG_MINOR_VERSION 1
791
792 void defaultStream::init() {
793 _inited = true;
794 if (LogVMOutput || LogCompilation) {
795 init_log();
796 }
797 }
798
799 bool defaultStream::has_log_file() {
800 // lazily create log file (at startup, LogVMOutput is false even
801 // if +LogVMOutput is used, because the flags haven't been parsed yet)
802 // For safer printing during fatal error handling, do not init logfile
803 // if a VM error has been reported.
804 if (!_inited && !is_error_reported()) init();
805 return _log_file != NULL;
806 }
807
808 void defaultStream::init_log() {
809 // %%% Need a MutexLocker?
810 const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log";
811 const char* try_name = make_log_name(log_name, NULL);
812 fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
813 if (!file->is_open()) {
814 // Try again to open the file.
815 char warnbuf[O_BUFLEN*2];
816 jio_snprintf(warnbuf, sizeof(warnbuf),
817 "Warning: Cannot open log file: %s\n", try_name);
818 // Note: This feature is for maintainer use only. No need for L10N.
819 jio_print(warnbuf);
820 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
821 try_name = make_log_name(log_name, os::get_temp_directory());
822 jio_snprintf(warnbuf, sizeof(warnbuf),
823 "Warning: Forcing option -XX:LogFile=%s\n", try_name);
824 jio_print(warnbuf);
825 delete file;
826 file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
827 }
828 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
829
830 if (file->is_open()) {
831 _log_file = file;
832 xmlStream* xs = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
833 _outer_xmlStream = xs;
834 if (this == tty) xtty = xs;
835 // Write XML header.
836 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
837 // (For now, don't bother to issue a DTD for this private format.)
838 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
839 // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
840 // we ever get round to introduce that method on the os class
841 xs->head("hotspot_log version='%d %d'"
842 " process='%d' time_ms='"INT64_FORMAT"'",
843 LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
844 os::current_process_id(), (int64_t)time_ms);
845 // Write VM version header immediately.
846 xs->head("vm_version");
847 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
848 xs->tail("name");
849 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
850 xs->tail("release");
851 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
852 xs->tail("info");
853 xs->tail("vm_version");
854 // Record information about the command-line invocation.
855 xs->head("vm_arguments"); // Cf. Arguments::print_on()
856 if (Arguments::num_jvm_flags() > 0) {
857 xs->head("flags");
858 Arguments::print_jvm_flags_on(xs->text());
859 xs->tail("flags");
860 }
861 if (Arguments::num_jvm_args() > 0) {
862 xs->head("args");
863 Arguments::print_jvm_args_on(xs->text());
864 xs->tail("args");
865 }
866 if (Arguments::java_command() != NULL) {
867 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
868 xs->tail("command");
869 }
870 if (Arguments::sun_java_launcher() != NULL) {
871 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
872 xs->tail("launcher");
873 }
874 if (Arguments::system_properties() != NULL) {
875 xs->head("properties");
876 // Print it as a java-style property list.
877 // System properties don't generally contain newlines, so don't bother with unparsing.
878 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
879 xs->text()->print_cr("%s=%s", p->key(), p->value());
880 }
881 xs->tail("properties");
882 }
883 xs->tail("vm_arguments");
884 // tty output per se is grouped under the <tty>...</tty> element.
885 xs->head("tty");
886 // All further non-markup text gets copied to the tty:
887 xs->_text = this; // requires friend declaration!
888 } else {
889 delete(file);
890 // and leave xtty as NULL
891 LogVMOutput = false;
892 DisplayVMOutput = true;
893 LogCompilation = false;
894 }
895 }
896
897 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
898 // called by ostream_abort() after a fatal error.
899 //
900 void defaultStream::finish_log() {
901 xmlStream* xs = _outer_xmlStream;
902 xs->done("tty");
903
904 // Other log forks are appended here, at the End of Time:
905 CompileLog::finish_log(xs->out()); // write compile logging, if any, now
906
907 xs->done("hotspot_log");
908 xs->flush();
909
910 fileStream* file = _log_file;
911 _log_file = NULL;
912
913 delete _outer_xmlStream;
914 _outer_xmlStream = NULL;
915
916 file->flush();
917 delete file;
918 }
919
920 void defaultStream::finish_log_on_error(char *buf, int buflen) {
921 xmlStream* xs = _outer_xmlStream;
922
923 if (xs && xs->out()) {
924
925 xs->done_raw("tty");
926
927 // Other log forks are appended here, at the End of Time:
928 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now
929
930 xs->done_raw("hotspot_log");
931 xs->flush();
932
933 fileStream* file = _log_file;
934 _log_file = NULL;
935 _outer_xmlStream = NULL;
936
937 if (file) {
938 file->flush();
939
940 // Can't delete or close the file because delete and fclose aren't
941 // async-safe. We are about to die, so leave it to the kernel.
942 // delete file;
943 }
944 }
945 }
946
947 intx defaultStream::hold(intx writer_id) {
948 bool has_log = has_log_file(); // check before locking
949 if (// impossible, but who knows?
950 writer_id == NO_WRITER ||
951
952 // bootstrap problem
953 tty_lock == NULL ||
954
955 // can't grab a lock or call Thread::current() if TLS isn't initialized
956 ThreadLocalStorage::thread() == NULL ||
957
958 // developer hook
959 !SerializeVMOutput ||
960
961 // VM already unhealthy
962 is_error_reported() ||
963
964 // safepoint == global lock (for VM only)
965 (SafepointSynchronize::is_synchronizing() &&
966 Thread::current()->is_VM_thread())
967 ) {
968 // do not attempt to lock unless we know the thread and the VM is healthy
969 return NO_WRITER;
970 }
971 if (_writer == writer_id) {
972 // already held, no need to re-grab the lock
973 return NO_WRITER;
974 }
975 tty_lock->lock_without_safepoint_check();
976 // got the lock
977 if (writer_id != _last_writer) {
978 if (has_log) {
979 _log_file->bol();
980 // output a hint where this output is coming from:
981 _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
982 }
983 _last_writer = writer_id;
984 }
985 _writer = writer_id;
986 return writer_id;
987 }
988
989 void defaultStream::release(intx holder) {
990 if (holder == NO_WRITER) {
991 // nothing to release: either a recursive lock, or we scribbled (too bad)
992 return;
993 }
994 if (_writer != holder) {
995 return; // already unlocked, perhaps via break_tty_lock_for_safepoint
996 }
997 _writer = NO_WRITER;
998 tty_lock->unlock();
999 }
1000
1001
1002 // Yuck: jio_print does not accept char*/len.
1003 static void call_jio_print(const char* s, size_t len) {
1004 char buffer[O_BUFLEN+100];
1005 if (len > sizeof(buffer)-1) {
1006 warning("increase O_BUFLEN in ostream.cpp -- output truncated");
1007 len = sizeof(buffer)-1;
1008 }
1009 strncpy(buffer, s, len);
1010 buffer[len] = '\0';
1011 jio_print(buffer);
1012 }
1013
1014
1015 void defaultStream::write(const char* s, size_t len) {
1016 intx thread_id = os::current_thread_id();
1017 intx holder = hold(thread_id);
1018
1019 if (DisplayVMOutput &&
1020 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
1021 // print to output stream. It can be redirected by a vfprintf hook
1022 if (s[len] == '\0') {
1023 jio_print(s);
1024 } else {
1025 call_jio_print(s, len);
1026 }
1027 }
1028
1029 // print to log file
1030 if (has_log_file()) {
1031 int nl0 = _newlines;
1032 xmlTextStream::write(s, len);
1033 // flush the log file too, if there were any newlines
1034 if (nl0 != _newlines){
1035 flush();
1036 }
1037 } else {
1038 update_position(s, len);
1039 }
1040
1041 release(holder);
1042 }
1043
1044 intx ttyLocker::hold_tty() {
1045 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER;
1046 intx thread_id = os::current_thread_id();
1047 return defaultStream::instance->hold(thread_id);
1048 }
1049
1050 void ttyLocker::release_tty(intx holder) {
1051 if (holder == defaultStream::NO_WRITER) return;
1052 defaultStream::instance->release(holder);
1053 }
1054
1055 bool ttyLocker::release_tty_if_locked() {
1056 intx thread_id = os::current_thread_id();
1057 if (defaultStream::instance->writer() == thread_id) {
1058 // release the lock and return true so callers know if was
1059 // previously held.
1060 release_tty(thread_id);
1061 return true;
1062 }
1063 return false;
1064 }
1065
1066 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
1067 if (defaultStream::instance != NULL &&
1068 defaultStream::instance->writer() == holder) {
1069 if (xtty != NULL) {
1070 xtty->print_cr("<!-- safepoint while printing -->");
1071 }
1072 defaultStream::instance->release(holder);
1073 }
1074 // (else there was no lock to break)
1075 }
1076
1077 void ostream_init() {
1078 if (defaultStream::instance == NULL) {
1079 defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
1080 tty = defaultStream::instance;
1081
1082 // We want to ensure that time stamps in GC logs consider time 0
1083 // the time when the JVM is initialized, not the first time we ask
1084 // for a time stamp. So, here, we explicitly update the time stamp
1085 // of tty.
1086 tty->time_stamp().update_to(1);
1087 }
1088 }
1089
1090 void ostream_init_log() {
1091 // For -Xloggc:<file> option - called in runtime/thread.cpp
1092 // Note : this must be called AFTER ostream_init()
1093
1094 gclog_or_tty = tty; // default to tty
1095 if (Arguments::gc_log_filename() != NULL) {
1096 fileStream * gclog = new(ResourceObj::C_HEAP, mtInternal)
1097 gcLogFileStream(Arguments::gc_log_filename());
1098 if (gclog->is_open()) {
1099 // now we update the time stamp of the GC log to be synced up
1100 // with tty.
1101 gclog->time_stamp().update_to(tty->time_stamp().ticks());
1102 }
1103 gclog_or_tty = gclog;
1104 }
1105
1106 // If we haven't lazily initialized the logfile yet, do it now,
1107 // to avoid the possibility of lazy initialization during a VM
1108 // crash, which can affect the stability of the fatal error handler.
1109 defaultStream::instance->has_log_file();
1110 }
1111
1112 // ostream_exit() is called during normal VM exit to finish log files, flush
1113 // output and free resource.
1114 void ostream_exit() {
1115 static bool ostream_exit_called = false;
1116 if (ostream_exit_called) return;
1117 ostream_exit_called = true;
1118 if (gclog_or_tty != tty) {
1119 delete gclog_or_tty;
1120 }
1121 {
1122 // we temporaly disable PrintMallocFree here
1123 // as otherwise it'll lead to using of almost deleted
1124 // tty or defaultStream::instance in logging facility
1125 // of HeapFree(), see 6391258
1126 DEBUG_ONLY(FlagSetting fs(PrintMallocFree, false);)
1127 if (tty != defaultStream::instance) {
1128 delete tty;
1129 }
1130 if (defaultStream::instance != NULL) {
1131 delete defaultStream::instance;
1132 }
1133 }
1134 tty = NULL;
1135 xtty = NULL;
1136 gclog_or_tty = NULL;
1137 defaultStream::instance = NULL;
1138 }
1139
1140 // ostream_abort() is called by os::abort() when VM is about to die.
1141 void ostream_abort() {
1142 // Here we can't delete gclog_or_tty and tty, just flush their output
1143 if (gclog_or_tty) gclog_or_tty->flush();
1144 if (tty) tty->flush();
1145
1146 if (defaultStream::instance != NULL) {
1147 static char buf[4096];
1148 defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
1149 }
1150 }
1151
1152 staticBufferStream::staticBufferStream(char* buffer, size_t buflen,
1153 outputStream *outer_stream) {
1154 _buffer = buffer;
1155 _buflen = buflen;
1156 _outer_stream = outer_stream;
1157 // compile task prints time stamp relative to VM start
1158 _stamp.update_to(1);
1159 }
1160
1161 void staticBufferStream::write(const char* c, size_t len) {
1162 _outer_stream->print_raw(c, (int)len);
1163 }
1164
1165 void staticBufferStream::flush() {
1166 _outer_stream->flush();
1167 }
1168
1169 void staticBufferStream::print(const char* format, ...) {
1170 va_list ap;
1171 va_start(ap, format);
1172 size_t len;
1173 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, false, len);
1174 write(str, len);
1175 va_end(ap);
1176 }
1177
1178 void staticBufferStream::print_cr(const char* format, ...) {
1179 va_list ap;
1180 va_start(ap, format);
1181 size_t len;
1182 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, true, len);
1183 write(str, len);
1184 va_end(ap);
1185 }
1186
1187 void staticBufferStream::vprint(const char *format, va_list argptr) {
1188 size_t len;
1189 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, false, len);
1190 write(str, len);
1191 }
1192
1193 void staticBufferStream::vprint_cr(const char* format, va_list argptr) {
1194 size_t len;
1195 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, true, len);
1196 write(str, len);
1197 }
1198
1199 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
1200 buffer_length = initial_size;
1201 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
1202 buffer_pos = 0;
1203 buffer_fixed = false;
1204 buffer_max = bufmax;
1205 }
1206
1207 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
1208 buffer_length = fixed_buffer_size;
1209 buffer = fixed_buffer;
1210 buffer_pos = 0;
1211 buffer_fixed = true;
1212 buffer_max = bufmax;
1213 }
1214
1215 void bufferedStream::write(const char* s, size_t len) {
1216
1217 if(buffer_pos + len > buffer_max) {
1218 flush();
1219 }
1220
1221 size_t end = buffer_pos + len;
1222 if (end >= buffer_length) {
1223 if (buffer_fixed) {
1224 // if buffer cannot resize, silently truncate
1225 len = buffer_length - buffer_pos - 1;
1226 } else {
1227 // For small overruns, double the buffer. For larger ones,
1228 // increase to the requested size.
1229 if (end < buffer_length * 2) {
1230 end = buffer_length * 2;
1231 }
1232 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
1233 buffer_length = end;
1234 }
1235 }
1236 memcpy(buffer + buffer_pos, s, len);
1237 buffer_pos += len;
1238 update_position(s, len);
1239 }
1240
1241 char* bufferedStream::as_string() {
1242 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
1243 strncpy(copy, buffer, buffer_pos);
1244 copy[buffer_pos] = 0; // terminating null
1245 return copy;
1246 }
1247
1248 bufferedStream::~bufferedStream() {
1249 if (!buffer_fixed) {
1250 FREE_C_HEAP_ARRAY(char, buffer, mtInternal);
1251 }
1252 }
1253
1254 #ifndef PRODUCT
1255
1256 #if defined(SOLARIS) || defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE)
1257 #include <sys/types.h>
1258 #include <sys/socket.h>
1259 #include <netinet/in.h>
1260 #include <arpa/inet.h>
1261 #endif
1262
1263 // Network access
1264 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
1265
1266 _socket = -1;
1267
1268 int result = os::socket(AF_INET, SOCK_STREAM, 0);
1269 if (result <= 0) {
1270 assert(false, "Socket could not be created!");
1271 } else {
1272 _socket = result;
1273 }
1274 }
1275
1276 int networkStream::read(char *buf, size_t len) {
1277 return os::recv(_socket, buf, (int)len, 0);
1278 }
1279
1280 void networkStream::flush() {
1281 if (size() != 0) {
1282 int result = os::raw_send(_socket, (char *)base(), size(), 0);
1283 assert(result != -1, "connection error");
1284 assert(result == (int)size(), "didn't send enough data");
1285 }
1286 reset();
1287 }
1288
1289 networkStream::~networkStream() {
1290 close();
1291 }
1292
1293 void networkStream::close() {
1294 if (_socket != -1) {
1295 flush();
1296 os::socket_close(_socket);
1297 _socket = -1;
1298 }
1299 }
1300
1301 bool networkStream::connect(const char *ip, short port) {
1302
1303 struct sockaddr_in server;
1304 server.sin_family = AF_INET;
1305 server.sin_port = htons(port);
1306
1307 server.sin_addr.s_addr = inet_addr(ip);
1308 if (server.sin_addr.s_addr == (uint32_t)-1) {
1309 struct hostent* host = os::get_host_by_name((char*)ip);
1310 if (host != NULL) {
1311 memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
1312 } else {
1313 return false;
1314 }
1315 }
1316
1317
1318 int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
1319 return (result >= 0);
1320 }
1321
1322 #endif