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