1 /*
2 * Copyright (c) 1997, 2012, 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 // N.B. Same as INT64_FORMAT
247 print(os::jlong_format_specifier(), value);
248 }
249
250 void outputStream::print_julong(julong value) {
251 // N.B. Same as UINT64_FORMAT
252 print(os::julong_format_specifier(), value);
253 }
254
255 /**
256 * This prints out hex data in a 'windbg' or 'xxd' form, where each line is:
257 * <hex-address>: 8 * <hex-halfword> <ascii translation (optional)>
258 * example:
259 * 0000000: 7f44 4f46 0102 0102 0000 0000 0000 0000 .DOF............
260 * 0000010: 0000 0000 0000 0040 0000 0020 0000 0005 .......@... ....
261 * 0000020: 0000 0000 0000 0040 0000 0000 0000 015d .......@.......]
262 * ...
263 *
264 * indent is applied to each line. Ends with a CR.
265 */
266 void outputStream::print_data(void* data, size_t len, bool with_ascii) {
267 size_t limit = (len + 16) / 16 * 16;
268 for (size_t i = 0; i < limit; ++i) {
269 if (i % 16 == 0) {
270 indent().print("%07x:", i);
271 }
272 if (i % 2 == 0) {
273 print(" ");
274 }
275 if (i < len) {
276 print("%02x", ((unsigned char*)data)[i]);
277 } else {
278 print(" ");
279 }
280 if ((i + 1) % 16 == 0) {
281 if (with_ascii) {
282 print(" ");
283 for (size_t j = 0; j < 16; ++j) {
284 size_t idx = i + j - 15;
285 if (idx < len) {
286 char c = ((char*)data)[idx];
287 print("%c", c >= 32 && c <= 126 ? c : '.');
288 }
289 }
290 }
291 print_cr("");
292 }
293 }
294 }
295
296 stringStream::stringStream(size_t initial_size) : outputStream() {
297 buffer_length = initial_size;
298 buffer = NEW_RESOURCE_ARRAY(char, buffer_length);
299 buffer_pos = 0;
300 buffer_fixed = false;
301 }
302
303 // useful for output to fixed chunks of memory, such as performance counters
304 stringStream::stringStream(char* fixed_buffer, size_t fixed_buffer_size) : outputStream() {
305 buffer_length = fixed_buffer_size;
306 buffer = fixed_buffer;
307 buffer_pos = 0;
308 buffer_fixed = true;
309 }
310
311 void stringStream::write(const char* s, size_t len) {
312 size_t write_len = len; // number of non-null bytes to write
313 size_t end = buffer_pos + len + 1; // position after write and final '\0'
314 if (end > buffer_length) {
315 if (buffer_fixed) {
316 // if buffer cannot resize, silently truncate
317 end = buffer_length;
318 write_len = end - buffer_pos - 1; // leave room for the final '\0'
319 } else {
320 // For small overruns, double the buffer. For larger ones,
321 // increase to the requested size.
322 if (end < buffer_length * 2) {
323 end = buffer_length * 2;
324 }
325 char* oldbuf = buffer;
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 fileStream::fileStream(const char* file_name) {
358 _file = fopen(file_name, "w");
359 _need_close = true;
360 }
361
362 fileStream::fileStream(const char* file_name, const char* opentype) {
363 _file = fopen(file_name, opentype);
364 _need_close = true;
365 }
366
367 void fileStream::write(const char* s, size_t len) {
368 if (_file != NULL) {
369 // Make an unused local variable to avoid warning from gcc 4.x compiler.
370 size_t count = fwrite(s, 1, len, _file);
371 }
372 update_position(s, len);
373 }
374
375 long fileStream::fileSize() {
376 long size = -1;
377 if (_file != NULL) {
378 long pos = ::ftell(_file);
379 if (::fseek(_file, 0, SEEK_END) == 0) {
380 size = ::ftell(_file);
381 }
382 ::fseek(_file, pos, SEEK_SET);
383 }
384 return size;
385 }
386
387 char* fileStream::readln(char *data, int count ) {
388 char * ret = ::fgets(data, count, _file);
389 //Get rid of annoying \n char
390 data[::strlen(data)-1] = '\0';
391 return ret;
392 }
393
394 fileStream::~fileStream() {
395 if (_file != NULL) {
396 if (_need_close) fclose(_file);
397 _file = NULL;
398 }
399 }
400
401 void fileStream::flush() {
402 fflush(_file);
403 }
404
405 fdStream::fdStream(const char* file_name) {
406 _fd = open(file_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
407 _need_close = true;
408 }
409
410 fdStream::~fdStream() {
411 if (_fd != -1) {
412 if (_need_close) close(_fd);
413 _fd = -1;
414 }
415 }
416
417 void fdStream::write(const char* s, size_t len) {
418 if (_fd != -1) {
419 // Make an unused local variable to avoid warning from gcc 4.x compiler.
420 size_t count = ::write(_fd, s, (int)len);
421 }
422 update_position(s, len);
423 }
424
425 rotatingFileStream::~rotatingFileStream() {
426 if (_file != NULL) {
427 if (_need_close) fclose(_file);
428 _file = NULL;
429 FREE_C_HEAP_ARRAY(char, _file_name);
430 _file_name = NULL;
431 }
432 }
433
434 rotatingFileStream::rotatingFileStream(const char* file_name) {
435 _cur_file_num = 0;
436 _bytes_writen = 0L;
437 _file_name = NEW_C_HEAP_ARRAY(char, strlen(file_name)+10);
438 jio_snprintf(_file_name, strlen(file_name)+10, "%s.%d", file_name, _cur_file_num);
439 _file = fopen(_file_name, "w");
440 _need_close = true;
441 }
442
443 rotatingFileStream::rotatingFileStream(const char* file_name, const char* opentype) {
444 _cur_file_num = 0;
445 _bytes_writen = 0L;
446 _file_name = NEW_C_HEAP_ARRAY(char, strlen(file_name)+10);
447 jio_snprintf(_file_name, strlen(file_name)+10, "%s.%d", file_name, _cur_file_num);
448 _file = fopen(_file_name, opentype);
449 _need_close = true;
450 }
451
452 void rotatingFileStream::write(const char* s, size_t len) {
453 if (_file != NULL) {
454 // Make an unused local variable to avoid warning from gcc 4.x compiler.
455 size_t count = fwrite(s, 1, len, _file);
456 Atomic::add((jlong)count, &_bytes_writen);
457 }
458 update_position(s, len);
459 }
460
461 // rotate_log must be called from VMThread at safepoint. In case need change parameters
462 // for gc log rotation from thread other than VMThread, a sub type of VM_Operation
463 // should be created and be submitted to VMThread's operation queue. DO NOT call this
464 // function directly. Currently, it is safe to rotate log at safepoint through VMThread.
465 // That is, no mutator threads and concurrent GC threads run parallel with VMThread to
466 // write to gc log file at safepoint. If in future, changes made for mutator threads or
467 // concurrent GC threads to run parallel with VMThread at safepoint, write and rotate_log
468 // must be synchronized.
469 void rotatingFileStream::rotate_log() {
470 if (_bytes_writen < (jlong)GCLogFileSize) return;
471 #ifdef ASSERT
472 Thread *thread = Thread::current();
473 assert(thread == NULL ||
474 (thread->is_VM_thread() && SafepointSynchronize::is_at_safepoint()),
475 "Must be VMThread at safepoint");
476 #endif
477 if (NumberOfGCLogFiles == 1) {
478 // rotate in same file
479 rewind();
480 _bytes_writen = 0L;
481 return;
482 }
483
484 // rotate file in names file.0, file.1, file.2, ..., file.<MaxGCLogFileNumbers-1>
485 // close current file, rotate to next file
486 if (_file != NULL) {
487 _cur_file_num ++;
488 if (_cur_file_num >= NumberOfGCLogFiles) _cur_file_num = 0;
489 jio_snprintf(_file_name, strlen(Arguments::gc_log_filename()) + 10, "%s.%d",
490 Arguments::gc_log_filename(), _cur_file_num);
491 fclose(_file);
492 _file = NULL;
493 }
494 _file = fopen(_file_name, "w");
495 if (_file != NULL) {
496 _bytes_writen = 0L;
497 _need_close = true;
498 } else {
499 tty->print_cr("failed to open rotation log file %s due to %s\n",
500 _file_name, strerror(errno));
501 _need_close = false;
502 }
503 }
504
505 defaultStream* defaultStream::instance = NULL;
506 int defaultStream::_output_fd = 1;
507 int defaultStream::_error_fd = 2;
508 FILE* defaultStream::_output_stream = stdout;
509 FILE* defaultStream::_error_stream = stderr;
510
511 #define LOG_MAJOR_VERSION 160
512 #define LOG_MINOR_VERSION 1
513
514 void defaultStream::init() {
515 _inited = true;
516 if (LogVMOutput || LogCompilation) {
517 init_log();
518 }
519 }
520
521 bool defaultStream::has_log_file() {
522 // lazily create log file (at startup, LogVMOutput is false even
523 // if +LogVMOutput is used, because the flags haven't been parsed yet)
524 // For safer printing during fatal error handling, do not init logfile
525 // if a VM error has been reported.
526 if (!_inited && !is_error_reported()) init();
527 return _log_file != NULL;
528 }
529
530 static const char* make_log_name(const char* log_name, const char* force_directory) {
531 const char* basename = log_name;
532 char file_sep = os::file_separator()[0];
533 const char* cp;
534 for (cp = log_name; *cp != '\0'; cp++) {
535 if (*cp == '/' || *cp == file_sep) {
536 basename = cp+1;
537 }
538 }
539 const char* nametail = log_name;
540
541 // Compute buffer length
542 size_t buffer_length;
543 if (force_directory != NULL) {
544 buffer_length = strlen(force_directory) + strlen(os::file_separator()) +
545 strlen(basename) + 1;
546 } else {
547 buffer_length = strlen(log_name) + 1;
548 }
549
550 const char* star = strchr(basename, '*');
551 int star_pos = (star == NULL) ? -1 : (star - nametail);
552 int skip = 1;
553 if (star == NULL) {
554 // Try %p
555 star = strstr(basename, "%p");
556 if (star != NULL) {
557 skip = 2;
558 }
559 }
560 star_pos = (star == NULL) ? -1 : (star - nametail);
561
562 char pid[32];
563 if (star_pos >= 0) {
564 jio_snprintf(pid, sizeof(pid), "%u", os::current_process_id());
565 buffer_length += strlen(pid);
566 }
567
568 // File name is too long.
569 if (buffer_length > JVM_MAXPATHLEN) {
570 return NULL;
571 }
572
573 // Create big enough buffer.
574 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length);
575
576 strcpy(buf, "");
577 if (force_directory != NULL) {
578 strcat(buf, force_directory);
579 strcat(buf, os::file_separator());
580 nametail = basename; // completely skip directory prefix
581 }
582
583 if (star_pos >= 0) {
584 // convert foo*bar.log or foo%pbar.log to foo123bar.log
585 int buf_pos = (int) strlen(buf);
586 strncpy(&buf[buf_pos], nametail, star_pos);
587 strcpy(&buf[buf_pos + star_pos], pid);
588 nametail += star_pos + skip; // skip prefix and pid format
589 }
590
591 strcat(buf, nametail); // append rest of name, or all of name
592 return buf;
593 }
594
595 fileStream* defaultStream::open_file(const char* log_name){
596 const char* try_name = make_log_name(log_name, NULL);
597 if (try_name == NULL) {
598 warning("Cannot open file %s: file name is too long.\n", log_name);
599 return NULL;
600 }
601
602 fileStream* file = new(ResourceObj::C_HEAP) fileStream(try_name);
603 FREE_C_HEAP_ARRAY(char, try_name);
604 if (file->is_open()) {
605 return file;
606 }
607
608 // Try again to open the file.
609 delete file;
610 char warnbuf[O_BUFLEN*2];
611 jio_snprintf(warnbuf, sizeof(warnbuf), "Warning: Cannot open log file: %s\n", try_name);
612 // Note: This feature is for maintainer use only. No need for L10N.
613 jio_print(warnbuf);
614 try_name = make_log_name("hs_pid%p.log", os::get_temp_directory());
615 if (try_name == NULL) {
616 warning("Cannot open file %s: file name is too long for directory %s.\n", "hs_pid", os::get_temp_directory());
617 return NULL;
618 }
619
620 jio_snprintf(warnbuf, sizeof(warnbuf), "Warning: Forcing option -XX:LogFile=%s\n", try_name);
621 jio_print(warnbuf);
622
623 file = new(ResourceObj::C_HEAP) fileStream(try_name);
624 FREE_C_HEAP_ARRAY(char, try_name);
625 if (file->is_open()) {
626 return file;
627 }
628
629 delete file;
630 return NULL;
631 }
632
633 void defaultStream::init_log() {
634 // %%% Need a MutexLocker?
635 const char* log_name = LogFile != NULL ? LogFile : "hotspot.log";
636 fileStream* file = open_file(log_name);
637
638 if (file != NULL) {
639 _log_file = file;
640 _outer_xmlStream = new(ResourceObj::C_HEAP) xmlStream(file);
641 start_log();
642 } else {
643 // and leave xtty as NULL
644 LogVMOutput = false;
645 DisplayVMOutput = true;
646 LogCompilation = false;
647 }
648 }
649
650 void defaultStream::start_log() {
651 xmlStream* xs = _outer_xmlStream;
652 if (this == tty) xtty = xs;
653 // Write XML header.
654 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
655 // (For now, don't bother to issue a DTD for this private format.)
656 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
657 // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
658 // we ever get round to introduce that method on the os class
659 xs->head("hotspot_log version='%d %d'"
660 " process='%d' time_ms='"INT64_FORMAT"'",
661 LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
662 os::current_process_id(), time_ms);
663 // Write VM version header immediately.
664 xs->head("vm_version");
665 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
666 xs->tail("name");
667 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
668 xs->tail("release");
669 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
670 xs->tail("info");
671 xs->tail("vm_version");
672 // Record information about the command-line invocation.
673 xs->head("vm_arguments"); // Cf. Arguments::print_on()
674 if (Arguments::num_jvm_flags() > 0) {
675 xs->head("flags");
676 Arguments::print_jvm_flags_on(xs->text());
677 xs->tail("flags");
678 }
679 if (Arguments::num_jvm_args() > 0) {
680 xs->head("args");
681 Arguments::print_jvm_args_on(xs->text());
682 xs->tail("args");
683 }
684 if (Arguments::java_command() != NULL) {
685 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
686 xs->tail("command");
687 }
688 if (Arguments::sun_java_launcher() != NULL) {
689 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
690 xs->tail("launcher");
691 }
692 if (Arguments::system_properties() != NULL) {
693 xs->head("properties");
694 // Print it as a java-style property list.
695 // System properties don't generally contain newlines, so don't bother with unparsing.
696 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
697 xs->text()->print_cr("%s=%s", p->key(), p->value());
698 }
699 xs->tail("properties");
700 }
701 xs->tail("vm_arguments");
702 // tty output per se is grouped under the <tty>...</tty> element.
703 xs->head("tty");
704 // All further non-markup text gets copied to the tty:
705 xs->_text = this; // requires friend declaration!
706 }
707
708 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
709 // called by ostream_abort() after a fatal error.
710 //
711 void defaultStream::finish_log() {
712 xmlStream* xs = _outer_xmlStream;
713 xs->done("tty");
714
715 // Other log forks are appended here, at the End of Time:
716 CompileLog::finish_log(xs->out()); // write compile logging, if any, now
717
718 xs->done("hotspot_log");
719 xs->flush();
720
721 fileStream* file = _log_file;
722 _log_file = NULL;
723
724 delete _outer_xmlStream;
725 _outer_xmlStream = NULL;
726
727 file->flush();
728 delete file;
729 }
730
731 void defaultStream::finish_log_on_error(char *buf, int buflen) {
732 xmlStream* xs = _outer_xmlStream;
733
734 if (xs && xs->out()) {
735
736 xs->done_raw("tty");
737
738 // Other log forks are appended here, at the End of Time:
739 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now
740
741 xs->done_raw("hotspot_log");
742 xs->flush();
743
744 fileStream* file = _log_file;
745 _log_file = NULL;
746 _outer_xmlStream = NULL;
747
748 if (file) {
749 file->flush();
750
751 // Can't delete or close the file because delete and fclose aren't
752 // async-safe. We are about to die, so leave it to the kernel.
753 // delete file;
754 }
755 }
756 }
757
758 intx defaultStream::hold(intx writer_id) {
759 bool has_log = has_log_file(); // check before locking
760 if (// impossible, but who knows?
761 writer_id == NO_WRITER ||
762
763 // bootstrap problem
764 tty_lock == NULL ||
765
766 // can't grab a lock or call Thread::current() if TLS isn't initialized
767 ThreadLocalStorage::thread() == NULL ||
768
769 // developer hook
770 !SerializeVMOutput ||
771
772 // VM already unhealthy
773 is_error_reported() ||
774
775 // safepoint == global lock (for VM only)
776 (SafepointSynchronize::is_synchronizing() &&
777 Thread::current()->is_VM_thread())
778 ) {
779 // do not attempt to lock unless we know the thread and the VM is healthy
780 return NO_WRITER;
781 }
782 if (_writer == writer_id) {
783 // already held, no need to re-grab the lock
784 return NO_WRITER;
785 }
786 tty_lock->lock_without_safepoint_check();
787 // got the lock
788 if (writer_id != _last_writer) {
789 if (has_log) {
790 _log_file->bol();
791 // output a hint where this output is coming from:
792 _log_file->print_cr("<writer thread='"INTX_FORMAT"'/>", writer_id);
793 }
794 _last_writer = writer_id;
795 }
796 _writer = writer_id;
797 return writer_id;
798 }
799
800 void defaultStream::release(intx holder) {
801 if (holder == NO_WRITER) {
802 // nothing to release: either a recursive lock, or we scribbled (too bad)
803 return;
804 }
805 if (_writer != holder) {
806 return; // already unlocked, perhaps via break_tty_lock_for_safepoint
807 }
808 _writer = NO_WRITER;
809 tty_lock->unlock();
810 }
811
812
813 // Yuck: jio_print does not accept char*/len.
814 static void call_jio_print(const char* s, size_t len) {
815 char buffer[O_BUFLEN+100];
816 if (len > sizeof(buffer)-1) {
817 warning("increase O_BUFLEN in ostream.cpp -- output truncated");
818 len = sizeof(buffer)-1;
819 }
820 strncpy(buffer, s, len);
821 buffer[len] = '\0';
822 jio_print(buffer);
823 }
824
825
826 void defaultStream::write(const char* s, size_t len) {
827 intx thread_id = os::current_thread_id();
828 intx holder = hold(thread_id);
829
830 if (DisplayVMOutput &&
831 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
832 // print to output stream. It can be redirected by a vfprintf hook
833 if (s[len] == '\0') {
834 jio_print(s);
835 } else {
836 call_jio_print(s, len);
837 }
838 }
839
840 // print to log file
841 if (has_log_file()) {
842 int nl0 = _newlines;
843 xmlTextStream::write(s, len);
844 // flush the log file too, if there were any newlines
845 if (nl0 != _newlines){
846 flush();
847 }
848 } else {
849 update_position(s, len);
850 }
851
852 release(holder);
853 }
854
855 intx ttyLocker::hold_tty() {
856 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER;
857 intx thread_id = os::current_thread_id();
858 return defaultStream::instance->hold(thread_id);
859 }
860
861 void ttyLocker::release_tty(intx holder) {
862 if (holder == defaultStream::NO_WRITER) return;
863 defaultStream::instance->release(holder);
864 }
865
866 bool ttyLocker::release_tty_if_locked() {
867 intx thread_id = os::current_thread_id();
868 if (defaultStream::instance->writer() == thread_id) {
869 // release the lock and return true so callers know if was
870 // previously held.
871 release_tty(thread_id);
872 return true;
873 }
874 return false;
875 }
876
877 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
878 if (defaultStream::instance != NULL &&
879 defaultStream::instance->writer() == holder) {
880 if (xtty != NULL) {
881 xtty->print_cr("<!-- safepoint while printing -->");
882 }
883 defaultStream::instance->release(holder);
884 }
885 // (else there was no lock to break)
886 }
887
888 void ostream_init() {
889 if (defaultStream::instance == NULL) {
890 defaultStream::instance = new(ResourceObj::C_HEAP) defaultStream();
891 tty = defaultStream::instance;
892
893 // We want to ensure that time stamps in GC logs consider time 0
894 // the time when the JVM is initialized, not the first time we ask
895 // for a time stamp. So, here, we explicitly update the time stamp
896 // of tty.
897 tty->time_stamp().update_to(1);
898 }
899 }
900
901 void ostream_init_log() {
902 // For -Xloggc:<file> option - called in runtime/thread.cpp
903 // Note : this must be called AFTER ostream_init()
904
905 gclog_or_tty = tty; // default to tty
906 if (Arguments::gc_log_filename() != NULL) {
907 fileStream * gclog = UseGCLogFileRotation ?
908 new(ResourceObj::C_HEAP)
909 rotatingFileStream(Arguments::gc_log_filename()) :
910 new(ResourceObj::C_HEAP)
911 fileStream(Arguments::gc_log_filename());
912 if (gclog->is_open()) {
913 // now we update the time stamp of the GC log to be synced up
914 // with tty.
915 gclog->time_stamp().update_to(tty->time_stamp().ticks());
916 }
917 gclog_or_tty = gclog;
918 }
919
920 // If we haven't lazily initialized the logfile yet, do it now,
921 // to avoid the possibility of lazy initialization during a VM
922 // crash, which can affect the stability of the fatal error handler.
923 defaultStream::instance->has_log_file();
924 }
925
926 // ostream_exit() is called during normal VM exit to finish log files, flush
927 // output and free resource.
928 void ostream_exit() {
929 static bool ostream_exit_called = false;
930 if (ostream_exit_called) return;
931 ostream_exit_called = true;
932 if (gclog_or_tty != tty) {
933 delete gclog_or_tty;
934 }
935 {
936 // we temporaly disable PrintMallocFree here
937 // as otherwise it'll lead to using of almost deleted
938 // tty or defaultStream::instance in logging facility
939 // of HeapFree(), see 6391258
940 DEBUG_ONLY(FlagSetting fs(PrintMallocFree, false);)
941 if (tty != defaultStream::instance) {
942 delete tty;
943 }
944 if (defaultStream::instance != NULL) {
945 delete defaultStream::instance;
946 }
947 }
948 tty = NULL;
949 xtty = NULL;
950 gclog_or_tty = NULL;
951 defaultStream::instance = NULL;
952 }
953
954 // ostream_abort() is called by os::abort() when VM is about to die.
955 void ostream_abort() {
956 // Here we can't delete gclog_or_tty and tty, just flush their output
957 if (gclog_or_tty) gclog_or_tty->flush();
958 if (tty) tty->flush();
959
960 if (defaultStream::instance != NULL) {
961 static char buf[4096];
962 defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
963 }
964 }
965
966 staticBufferStream::staticBufferStream(char* buffer, size_t buflen,
967 outputStream *outer_stream) {
968 _buffer = buffer;
969 _buflen = buflen;
970 _outer_stream = outer_stream;
971 // compile task prints time stamp relative to VM start
972 _stamp.update_to(1);
973 }
974
975 void staticBufferStream::write(const char* c, size_t len) {
976 _outer_stream->print_raw(c, (int)len);
977 }
978
979 void staticBufferStream::flush() {
980 _outer_stream->flush();
981 }
982
983 void staticBufferStream::print(const char* format, ...) {
984 va_list ap;
985 va_start(ap, format);
986 size_t len;
987 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, false, len);
988 write(str, len);
989 va_end(ap);
990 }
991
992 void staticBufferStream::print_cr(const char* format, ...) {
993 va_list ap;
994 va_start(ap, format);
995 size_t len;
996 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, true, len);
997 write(str, len);
998 va_end(ap);
999 }
1000
1001 void staticBufferStream::vprint(const char *format, va_list argptr) {
1002 size_t len;
1003 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, false, len);
1004 write(str, len);
1005 }
1006
1007 void staticBufferStream::vprint_cr(const char* format, va_list argptr) {
1008 size_t len;
1009 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, true, len);
1010 write(str, len);
1011 }
1012
1013 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
1014 buffer_length = initial_size;
1015 buffer = NEW_C_HEAP_ARRAY(char, buffer_length);
1016 buffer_pos = 0;
1017 buffer_fixed = false;
1018 buffer_max = bufmax;
1019 }
1020
1021 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
1022 buffer_length = fixed_buffer_size;
1023 buffer = fixed_buffer;
1024 buffer_pos = 0;
1025 buffer_fixed = true;
1026 buffer_max = bufmax;
1027 }
1028
1029 void bufferedStream::write(const char* s, size_t len) {
1030
1031 if(buffer_pos + len > buffer_max) {
1032 flush();
1033 }
1034
1035 size_t end = buffer_pos + len;
1036 if (end >= buffer_length) {
1037 if (buffer_fixed) {
1038 // if buffer cannot resize, silently truncate
1039 len = buffer_length - buffer_pos - 1;
1040 } else {
1041 // For small overruns, double the buffer. For larger ones,
1042 // increase to the requested size.
1043 if (end < buffer_length * 2) {
1044 end = buffer_length * 2;
1045 }
1046 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end);
1047 buffer_length = end;
1048 }
1049 }
1050 memcpy(buffer + buffer_pos, s, len);
1051 buffer_pos += len;
1052 update_position(s, len);
1053 }
1054
1055 char* bufferedStream::as_string() {
1056 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
1057 strncpy(copy, buffer, buffer_pos);
1058 copy[buffer_pos] = 0; // terminating null
1059 return copy;
1060 }
1061
1062 bufferedStream::~bufferedStream() {
1063 if (!buffer_fixed) {
1064 FREE_C_HEAP_ARRAY(char, buffer);
1065 }
1066 }
1067
1068 #ifndef PRODUCT
1069 void test_loggc_filename() {
1070 const char* o_result;
1071
1072 {
1073 // longest filename
1074 char longest_name[JVM_MAXPATHLEN];
1075 memset(longest_name, 'a', sizeof(longest_name));
1076 longest_name[JVM_MAXPATHLEN - 1] = '\0';
1077 o_result = make_log_name((const char*)&longest_name, NULL);
1078 assert(strcmp(longest_name, o_result) == 0, err_msg("longest name does not match. expected '%s' but got '%s'", longest_name, o_result));
1079 FREE_C_HEAP_ARRAY(char, o_result);
1080 }
1081
1082 {
1083 // too long file name
1084 char too_long_name[JVM_MAXPATHLEN + 100];
1085 int too_long_length = sizeof(too_long_name);
1086 memset(too_long_name, 'a', too_long_length);
1087 too_long_name[too_long_length - 1] = '\0';
1088 o_result = make_log_name((const char*)&too_long_name, NULL);
1089 assert(o_result == NULL, err_msg("Too long file name should return NULL, but got '%s'", o_result));
1090 }
1091
1092 {
1093 // too long with pid
1094 char longest_name[JVM_MAXPATHLEN];
1095 memset(longest_name, 'a', JVM_MAXPATHLEN);
1096 longest_name[JVM_MAXPATHLEN - 3] = '%';
1097 longest_name[JVM_MAXPATHLEN - 2] = 'p';
1098 longest_name[JVM_MAXPATHLEN - 1] = '\0';
1099 o_result = make_log_name((const char*)&longest_name, NULL);
1100 assert(o_result == NULL, err_msg("Too long file name after %%p pid expansion should return NULL, but got '%s'", o_result));
1101 }
1102
1103 {
1104 // too long with pid (star)
1105 char longest_name[JVM_MAXPATHLEN];
1106 memset(longest_name, 'a', JVM_MAXPATHLEN);
1107 longest_name[JVM_MAXPATHLEN - 2] = '*';
1108 longest_name[JVM_MAXPATHLEN - 1] = '\0';
1109 o_result = make_log_name((const char*)&longest_name, NULL);
1110 assert(o_result == NULL, err_msg("Too long file name after star (pid) expansion should return NULL, but got '%s'", o_result));
1111 }
1112 }
1113
1114 #if defined(SOLARIS) || defined(LINUX) || defined(_ALLBSD_SOURCE)
1115 #include <sys/types.h>
1116 #include <sys/socket.h>
1117 #include <netinet/in.h>
1118 #include <arpa/inet.h>
1119 #endif
1120
1121 // Network access
1122 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
1123
1124 _socket = -1;
1125
1126 int result = os::socket(AF_INET, SOCK_STREAM, 0);
1127 if (result <= 0) {
1128 assert(false, "Socket could not be created!");
1129 } else {
1130 _socket = result;
1131 }
1132 }
1133
1134 int networkStream::read(char *buf, size_t len) {
1135 return os::recv(_socket, buf, (int)len, 0);
1136 }
1137
1138 void networkStream::flush() {
1139 if (size() != 0) {
1140 int result = os::raw_send(_socket, (char *)base(), size(), 0);
1141 assert(result != -1, "connection error");
1142 assert(result == (int)size(), "didn't send enough data");
1143 }
1144 reset();
1145 }
1146
1147 networkStream::~networkStream() {
1148 close();
1149 }
1150
1151 void networkStream::close() {
1152 if (_socket != -1) {
1153 flush();
1154 os::socket_close(_socket);
1155 _socket = -1;
1156 }
1157 }
1158
1159 bool networkStream::connect(const char *ip, short port) {
1160
1161 struct sockaddr_in server;
1162 server.sin_family = AF_INET;
1163 server.sin_port = htons(port);
1164
1165 server.sin_addr.s_addr = inet_addr(ip);
1166 if (server.sin_addr.s_addr == (uint32_t)-1) {
1167 struct hostent* host = os::get_host_by_name((char*)ip);
1168 if (host != NULL) {
1169 memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
1170 } else {
1171 return false;
1172 }
1173 }
1174
1175
1176 int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
1177 return (result >= 0);
1178 }
1179
1180 #endif