Wed, 10 Jul 2013 15:49:15 +0000
7143807: ResourceMark nesting problem in stringStream
Reviewed-by: kvn, dcubed
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 */
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
46 extern "C" void jio_print(const char* s); // Declarationtion of jvm method
48 outputStream::outputStream(int width) {
49 _width = width;
50 _position = 0;
51 _newlines = 0;
52 _precount = 0;
53 _indentation = 0;
54 }
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 }
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 }
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 }
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 }
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 }
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 }
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 }
154 void outputStream::fill_to(int col) {
155 int need_fill = col - position();
156 sp(need_fill);
157 }
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 }
168 void outputStream::put(char ch) {
169 assert(ch != 0, "please fix call site");
170 char buf[] = { ch, '\0' };
171 write(buf, 1);
172 }
174 #define SP_USE_TABS false
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 }
193 void outputStream::cr() {
194 this->write("\n", 1);
195 }
197 void outputStream::stamp() {
198 if (! _stamp.is_updated()) {
199 _stamp.update(); // start at 0 on first call to stamp()
200 }
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 }
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 }
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 }
240 outputStream& outputStream::indent() {
241 while (_position < _indentation) sp();
242 return *this;
243 }
245 void outputStream::print_jlong(jlong value) {
246 print(JLONG_FORMAT, value);
247 }
249 void outputStream::print_julong(julong value) {
250 print(JULONG_FORMAT, value);
251 }
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 }
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 }
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 }
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;
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 }
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 }
351 stringStream::~stringStream() {}
353 xmlStream* xtty;
354 outputStream* tty;
355 outputStream* gclog_or_tty;
356 extern Mutex* tty_lock;
358 fileStream::fileStream(const char* file_name) {
359 _file = fopen(file_name, "w");
360 _need_close = true;
361 }
363 fileStream::fileStream(const char* file_name, const char* opentype) {
364 _file = fopen(file_name, opentype);
365 _need_close = true;
366 }
368 void fileStream::write(const char* s, size_t len) {
369 if (_file != NULL) {
370 // Make an unused local variable to avoid warning from gcc 4.x compiler.
371 size_t count = fwrite(s, 1, len, _file);
372 }
373 update_position(s, len);
374 }
376 long fileStream::fileSize() {
377 long size = -1;
378 if (_file != NULL) {
379 long pos = ::ftell(_file);
380 if (::fseek(_file, 0, SEEK_END) == 0) {
381 size = ::ftell(_file);
382 }
383 ::fseek(_file, pos, SEEK_SET);
384 }
385 return size;
386 }
388 char* fileStream::readln(char *data, int count ) {
389 char * ret = ::fgets(data, count, _file);
390 //Get rid of annoying \n char
391 data[::strlen(data)-1] = '\0';
392 return ret;
393 }
395 fileStream::~fileStream() {
396 if (_file != NULL) {
397 if (_need_close) fclose(_file);
398 _file = NULL;
399 }
400 }
402 void fileStream::flush() {
403 fflush(_file);
404 }
406 fdStream::fdStream(const char* file_name) {
407 _fd = open(file_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
408 _need_close = true;
409 }
411 fdStream::~fdStream() {
412 if (_fd != -1) {
413 if (_need_close) close(_fd);
414 _fd = -1;
415 }
416 }
418 void fdStream::write(const char* s, size_t len) {
419 if (_fd != -1) {
420 // Make an unused local variable to avoid warning from gcc 4.x compiler.
421 size_t count = ::write(_fd, s, (int)len);
422 }
423 update_position(s, len);
424 }
426 rotatingFileStream::~rotatingFileStream() {
427 if (_file != NULL) {
428 if (_need_close) fclose(_file);
429 _file = NULL;
430 FREE_C_HEAP_ARRAY(char, _file_name, mtInternal);
431 _file_name = NULL;
432 }
433 }
435 rotatingFileStream::rotatingFileStream(const char* file_name) {
436 _cur_file_num = 0;
437 _bytes_written = 0L;
438 _file_name = NEW_C_HEAP_ARRAY(char, strlen(file_name)+10, mtInternal);
439 jio_snprintf(_file_name, strlen(file_name)+10, "%s.%d", file_name, _cur_file_num);
440 _file = fopen(_file_name, "w");
441 _need_close = true;
442 }
444 rotatingFileStream::rotatingFileStream(const char* file_name, const char* opentype) {
445 _cur_file_num = 0;
446 _bytes_written = 0L;
447 _file_name = NEW_C_HEAP_ARRAY(char, strlen(file_name)+10, mtInternal);
448 jio_snprintf(_file_name, strlen(file_name)+10, "%s.%d", file_name, _cur_file_num);
449 _file = fopen(_file_name, opentype);
450 _need_close = true;
451 }
453 void rotatingFileStream::write(const char* s, size_t len) {
454 if (_file != NULL) {
455 size_t count = fwrite(s, 1, len, _file);
456 _bytes_written += count;
457 }
458 update_position(s, len);
459 }
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_written < (jlong)GCLogFileSize) {
471 return;
472 }
474 #ifdef ASSERT
475 Thread *thread = Thread::current();
476 assert(thread == NULL ||
477 (thread->is_VM_thread() && SafepointSynchronize::is_at_safepoint()),
478 "Must be VMThread at safepoint");
479 #endif
480 if (NumberOfGCLogFiles == 1) {
481 // rotate in same file
482 rewind();
483 _bytes_written = 0L;
484 return;
485 }
487 // rotate file in names file.0, file.1, file.2, ..., file.<MaxGCLogFileNumbers-1>
488 // close current file, rotate to next file
489 if (_file != NULL) {
490 _cur_file_num ++;
491 if (_cur_file_num >= NumberOfGCLogFiles) _cur_file_num = 0;
492 jio_snprintf(_file_name, strlen(Arguments::gc_log_filename()) + 10, "%s.%d",
493 Arguments::gc_log_filename(), _cur_file_num);
494 fclose(_file);
495 _file = NULL;
496 }
497 _file = fopen(_file_name, "w");
498 if (_file != NULL) {
499 _bytes_written = 0L;
500 _need_close = true;
501 } else {
502 tty->print_cr("failed to open rotation log file %s due to %s\n",
503 _file_name, strerror(errno));
504 _need_close = false;
505 }
506 }
508 defaultStream* defaultStream::instance = NULL;
509 int defaultStream::_output_fd = 1;
510 int defaultStream::_error_fd = 2;
511 FILE* defaultStream::_output_stream = stdout;
512 FILE* defaultStream::_error_stream = stderr;
514 #define LOG_MAJOR_VERSION 160
515 #define LOG_MINOR_VERSION 1
517 void defaultStream::init() {
518 _inited = true;
519 if (LogVMOutput || LogCompilation) {
520 init_log();
521 }
522 }
524 bool defaultStream::has_log_file() {
525 // lazily create log file (at startup, LogVMOutput is false even
526 // if +LogVMOutput is used, because the flags haven't been parsed yet)
527 // For safer printing during fatal error handling, do not init logfile
528 // if a VM error has been reported.
529 if (!_inited && !is_error_reported()) init();
530 return _log_file != NULL;
531 }
533 static const char* make_log_name(const char* log_name, const char* force_directory) {
534 const char* basename = log_name;
535 char file_sep = os::file_separator()[0];
536 const char* cp;
537 for (cp = log_name; *cp != '\0'; cp++) {
538 if (*cp == '/' || *cp == file_sep) {
539 basename = cp+1;
540 }
541 }
542 const char* nametail = log_name;
544 // Compute buffer length
545 size_t buffer_length;
546 if (force_directory != NULL) {
547 buffer_length = strlen(force_directory) + strlen(os::file_separator()) +
548 strlen(basename) + 1;
549 } else {
550 buffer_length = strlen(log_name) + 1;
551 }
553 const char* star = strchr(basename, '*');
554 int star_pos = (star == NULL) ? -1 : (star - nametail);
555 int skip = 1;
556 if (star == NULL) {
557 // Try %p
558 star = strstr(basename, "%p");
559 if (star != NULL) {
560 skip = 2;
561 }
562 }
563 star_pos = (star == NULL) ? -1 : (star - nametail);
565 char pid[32];
566 if (star_pos >= 0) {
567 jio_snprintf(pid, sizeof(pid), "%u", os::current_process_id());
568 buffer_length += strlen(pid);
569 }
571 // Create big enough buffer.
572 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
574 strcpy(buf, "");
575 if (force_directory != NULL) {
576 strcat(buf, force_directory);
577 strcat(buf, os::file_separator());
578 nametail = basename; // completely skip directory prefix
579 }
581 if (star_pos >= 0) {
582 // convert foo*bar.log or foo%pbar.log to foo123bar.log
583 int buf_pos = (int) strlen(buf);
584 strncpy(&buf[buf_pos], nametail, star_pos);
585 strcpy(&buf[buf_pos + star_pos], pid);
586 nametail += star_pos + skip; // skip prefix and pid format
587 }
589 strcat(buf, nametail); // append rest of name, or all of name
590 return buf;
591 }
593 void defaultStream::init_log() {
594 // %%% Need a MutexLocker?
595 const char* log_name = LogFile != NULL ? LogFile : "hotspot.log";
596 const char* try_name = make_log_name(log_name, NULL);
597 fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
598 if (!file->is_open()) {
599 // Try again to open the file.
600 char warnbuf[O_BUFLEN*2];
601 jio_snprintf(warnbuf, sizeof(warnbuf),
602 "Warning: Cannot open log file: %s\n", try_name);
603 // Note: This feature is for maintainer use only. No need for L10N.
604 jio_print(warnbuf);
605 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
606 try_name = make_log_name("hs_pid%p.log", os::get_temp_directory());
607 jio_snprintf(warnbuf, sizeof(warnbuf),
608 "Warning: Forcing option -XX:LogFile=%s\n", try_name);
609 jio_print(warnbuf);
610 delete file;
611 file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
612 FREE_C_HEAP_ARRAY(char, try_name, mtInternal);
613 }
614 if (file->is_open()) {
615 _log_file = file;
616 xmlStream* xs = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
617 _outer_xmlStream = xs;
618 if (this == tty) xtty = xs;
619 // Write XML header.
620 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
621 // (For now, don't bother to issue a DTD for this private format.)
622 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
623 // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
624 // we ever get round to introduce that method on the os class
625 xs->head("hotspot_log version='%d %d'"
626 " process='%d' time_ms='"INT64_FORMAT"'",
627 LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
628 os::current_process_id(), time_ms);
629 // Write VM version header immediately.
630 xs->head("vm_version");
631 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
632 xs->tail("name");
633 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
634 xs->tail("release");
635 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
636 xs->tail("info");
637 xs->tail("vm_version");
638 // Record information about the command-line invocation.
639 xs->head("vm_arguments"); // Cf. Arguments::print_on()
640 if (Arguments::num_jvm_flags() > 0) {
641 xs->head("flags");
642 Arguments::print_jvm_flags_on(xs->text());
643 xs->tail("flags");
644 }
645 if (Arguments::num_jvm_args() > 0) {
646 xs->head("args");
647 Arguments::print_jvm_args_on(xs->text());
648 xs->tail("args");
649 }
650 if (Arguments::java_command() != NULL) {
651 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
652 xs->tail("command");
653 }
654 if (Arguments::sun_java_launcher() != NULL) {
655 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
656 xs->tail("launcher");
657 }
658 if (Arguments::system_properties() != NULL) {
659 xs->head("properties");
660 // Print it as a java-style property list.
661 // System properties don't generally contain newlines, so don't bother with unparsing.
662 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
663 xs->text()->print_cr("%s=%s", p->key(), p->value());
664 }
665 xs->tail("properties");
666 }
667 xs->tail("vm_arguments");
668 // tty output per se is grouped under the <tty>...</tty> element.
669 xs->head("tty");
670 // All further non-markup text gets copied to the tty:
671 xs->_text = this; // requires friend declaration!
672 } else {
673 delete(file);
674 // and leave xtty as NULL
675 LogVMOutput = false;
676 DisplayVMOutput = true;
677 LogCompilation = false;
678 }
679 }
681 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
682 // called by ostream_abort() after a fatal error.
683 //
684 void defaultStream::finish_log() {
685 xmlStream* xs = _outer_xmlStream;
686 xs->done("tty");
688 // Other log forks are appended here, at the End of Time:
689 CompileLog::finish_log(xs->out()); // write compile logging, if any, now
691 xs->done("hotspot_log");
692 xs->flush();
694 fileStream* file = _log_file;
695 _log_file = NULL;
697 delete _outer_xmlStream;
698 _outer_xmlStream = NULL;
700 file->flush();
701 delete file;
702 }
704 void defaultStream::finish_log_on_error(char *buf, int buflen) {
705 xmlStream* xs = _outer_xmlStream;
707 if (xs && xs->out()) {
709 xs->done_raw("tty");
711 // Other log forks are appended here, at the End of Time:
712 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now
714 xs->done_raw("hotspot_log");
715 xs->flush();
717 fileStream* file = _log_file;
718 _log_file = NULL;
719 _outer_xmlStream = NULL;
721 if (file) {
722 file->flush();
724 // Can't delete or close the file because delete and fclose aren't
725 // async-safe. We are about to die, so leave it to the kernel.
726 // delete file;
727 }
728 }
729 }
731 intx defaultStream::hold(intx writer_id) {
732 bool has_log = has_log_file(); // check before locking
733 if (// impossible, but who knows?
734 writer_id == NO_WRITER ||
736 // bootstrap problem
737 tty_lock == NULL ||
739 // can't grab a lock or call Thread::current() if TLS isn't initialized
740 ThreadLocalStorage::thread() == NULL ||
742 // developer hook
743 !SerializeVMOutput ||
745 // VM already unhealthy
746 is_error_reported() ||
748 // safepoint == global lock (for VM only)
749 (SafepointSynchronize::is_synchronizing() &&
750 Thread::current()->is_VM_thread())
751 ) {
752 // do not attempt to lock unless we know the thread and the VM is healthy
753 return NO_WRITER;
754 }
755 if (_writer == writer_id) {
756 // already held, no need to re-grab the lock
757 return NO_WRITER;
758 }
759 tty_lock->lock_without_safepoint_check();
760 // got the lock
761 if (writer_id != _last_writer) {
762 if (has_log) {
763 _log_file->bol();
764 // output a hint where this output is coming from:
765 _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
766 }
767 _last_writer = writer_id;
768 }
769 _writer = writer_id;
770 return writer_id;
771 }
773 void defaultStream::release(intx holder) {
774 if (holder == NO_WRITER) {
775 // nothing to release: either a recursive lock, or we scribbled (too bad)
776 return;
777 }
778 if (_writer != holder) {
779 return; // already unlocked, perhaps via break_tty_lock_for_safepoint
780 }
781 _writer = NO_WRITER;
782 tty_lock->unlock();
783 }
786 // Yuck: jio_print does not accept char*/len.
787 static void call_jio_print(const char* s, size_t len) {
788 char buffer[O_BUFLEN+100];
789 if (len > sizeof(buffer)-1) {
790 warning("increase O_BUFLEN in ostream.cpp -- output truncated");
791 len = sizeof(buffer)-1;
792 }
793 strncpy(buffer, s, len);
794 buffer[len] = '\0';
795 jio_print(buffer);
796 }
799 void defaultStream::write(const char* s, size_t len) {
800 intx thread_id = os::current_thread_id();
801 intx holder = hold(thread_id);
803 if (DisplayVMOutput &&
804 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
805 // print to output stream. It can be redirected by a vfprintf hook
806 if (s[len] == '\0') {
807 jio_print(s);
808 } else {
809 call_jio_print(s, len);
810 }
811 }
813 // print to log file
814 if (has_log_file()) {
815 int nl0 = _newlines;
816 xmlTextStream::write(s, len);
817 // flush the log file too, if there were any newlines
818 if (nl0 != _newlines){
819 flush();
820 }
821 } else {
822 update_position(s, len);
823 }
825 release(holder);
826 }
828 intx ttyLocker::hold_tty() {
829 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER;
830 intx thread_id = os::current_thread_id();
831 return defaultStream::instance->hold(thread_id);
832 }
834 void ttyLocker::release_tty(intx holder) {
835 if (holder == defaultStream::NO_WRITER) return;
836 defaultStream::instance->release(holder);
837 }
839 bool ttyLocker::release_tty_if_locked() {
840 intx thread_id = os::current_thread_id();
841 if (defaultStream::instance->writer() == thread_id) {
842 // release the lock and return true so callers know if was
843 // previously held.
844 release_tty(thread_id);
845 return true;
846 }
847 return false;
848 }
850 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
851 if (defaultStream::instance != NULL &&
852 defaultStream::instance->writer() == holder) {
853 if (xtty != NULL) {
854 xtty->print_cr("<!-- safepoint while printing -->");
855 }
856 defaultStream::instance->release(holder);
857 }
858 // (else there was no lock to break)
859 }
861 void ostream_init() {
862 if (defaultStream::instance == NULL) {
863 defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
864 tty = defaultStream::instance;
866 // We want to ensure that time stamps in GC logs consider time 0
867 // the time when the JVM is initialized, not the first time we ask
868 // for a time stamp. So, here, we explicitly update the time stamp
869 // of tty.
870 tty->time_stamp().update_to(1);
871 }
872 }
874 void ostream_init_log() {
875 // For -Xloggc:<file> option - called in runtime/thread.cpp
876 // Note : this must be called AFTER ostream_init()
878 gclog_or_tty = tty; // default to tty
879 if (Arguments::gc_log_filename() != NULL) {
880 fileStream * gclog = UseGCLogFileRotation ?
881 new(ResourceObj::C_HEAP, mtInternal)
882 rotatingFileStream(Arguments::gc_log_filename()) :
883 new(ResourceObj::C_HEAP, mtInternal)
884 fileStream(Arguments::gc_log_filename());
885 if (gclog->is_open()) {
886 // now we update the time stamp of the GC log to be synced up
887 // with tty.
888 gclog->time_stamp().update_to(tty->time_stamp().ticks());
889 }
890 gclog_or_tty = gclog;
891 }
893 // If we haven't lazily initialized the logfile yet, do it now,
894 // to avoid the possibility of lazy initialization during a VM
895 // crash, which can affect the stability of the fatal error handler.
896 defaultStream::instance->has_log_file();
897 }
899 // ostream_exit() is called during normal VM exit to finish log files, flush
900 // output and free resource.
901 void ostream_exit() {
902 static bool ostream_exit_called = false;
903 if (ostream_exit_called) return;
904 ostream_exit_called = true;
905 if (gclog_or_tty != tty) {
906 delete gclog_or_tty;
907 }
908 {
909 // we temporaly disable PrintMallocFree here
910 // as otherwise it'll lead to using of almost deleted
911 // tty or defaultStream::instance in logging facility
912 // of HeapFree(), see 6391258
913 DEBUG_ONLY(FlagSetting fs(PrintMallocFree, false);)
914 if (tty != defaultStream::instance) {
915 delete tty;
916 }
917 if (defaultStream::instance != NULL) {
918 delete defaultStream::instance;
919 }
920 }
921 tty = NULL;
922 xtty = NULL;
923 gclog_or_tty = NULL;
924 defaultStream::instance = NULL;
925 }
927 // ostream_abort() is called by os::abort() when VM is about to die.
928 void ostream_abort() {
929 // Here we can't delete gclog_or_tty and tty, just flush their output
930 if (gclog_or_tty) gclog_or_tty->flush();
931 if (tty) tty->flush();
933 if (defaultStream::instance != NULL) {
934 static char buf[4096];
935 defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
936 }
937 }
939 staticBufferStream::staticBufferStream(char* buffer, size_t buflen,
940 outputStream *outer_stream) {
941 _buffer = buffer;
942 _buflen = buflen;
943 _outer_stream = outer_stream;
944 // compile task prints time stamp relative to VM start
945 _stamp.update_to(1);
946 }
948 void staticBufferStream::write(const char* c, size_t len) {
949 _outer_stream->print_raw(c, (int)len);
950 }
952 void staticBufferStream::flush() {
953 _outer_stream->flush();
954 }
956 void staticBufferStream::print(const char* format, ...) {
957 va_list ap;
958 va_start(ap, format);
959 size_t len;
960 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, false, len);
961 write(str, len);
962 va_end(ap);
963 }
965 void staticBufferStream::print_cr(const char* format, ...) {
966 va_list ap;
967 va_start(ap, format);
968 size_t len;
969 const char* str = do_vsnprintf(_buffer, _buflen, format, ap, true, len);
970 write(str, len);
971 va_end(ap);
972 }
974 void staticBufferStream::vprint(const char *format, va_list argptr) {
975 size_t len;
976 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, false, len);
977 write(str, len);
978 }
980 void staticBufferStream::vprint_cr(const char* format, va_list argptr) {
981 size_t len;
982 const char* str = do_vsnprintf(_buffer, _buflen, format, argptr, true, len);
983 write(str, len);
984 }
986 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
987 buffer_length = initial_size;
988 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
989 buffer_pos = 0;
990 buffer_fixed = false;
991 buffer_max = bufmax;
992 }
994 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
995 buffer_length = fixed_buffer_size;
996 buffer = fixed_buffer;
997 buffer_pos = 0;
998 buffer_fixed = true;
999 buffer_max = bufmax;
1000 }
1002 void bufferedStream::write(const char* s, size_t len) {
1004 if(buffer_pos + len > buffer_max) {
1005 flush();
1006 }
1008 size_t end = buffer_pos + len;
1009 if (end >= buffer_length) {
1010 if (buffer_fixed) {
1011 // if buffer cannot resize, silently truncate
1012 len = buffer_length - buffer_pos - 1;
1013 } else {
1014 // For small overruns, double the buffer. For larger ones,
1015 // increase to the requested size.
1016 if (end < buffer_length * 2) {
1017 end = buffer_length * 2;
1018 }
1019 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
1020 buffer_length = end;
1021 }
1022 }
1023 memcpy(buffer + buffer_pos, s, len);
1024 buffer_pos += len;
1025 update_position(s, len);
1026 }
1028 char* bufferedStream::as_string() {
1029 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
1030 strncpy(copy, buffer, buffer_pos);
1031 copy[buffer_pos] = 0; // terminating null
1032 return copy;
1033 }
1035 bufferedStream::~bufferedStream() {
1036 if (!buffer_fixed) {
1037 FREE_C_HEAP_ARRAY(char, buffer, mtInternal);
1038 }
1039 }
1041 #ifndef PRODUCT
1043 #if defined(SOLARIS) || defined(LINUX) || defined(_ALLBSD_SOURCE)
1044 #include <sys/types.h>
1045 #include <sys/socket.h>
1046 #include <netinet/in.h>
1047 #include <arpa/inet.h>
1048 #endif
1050 // Network access
1051 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
1053 _socket = -1;
1055 int result = os::socket(AF_INET, SOCK_STREAM, 0);
1056 if (result <= 0) {
1057 assert(false, "Socket could not be created!");
1058 } else {
1059 _socket = result;
1060 }
1061 }
1063 int networkStream::read(char *buf, size_t len) {
1064 return os::recv(_socket, buf, (int)len, 0);
1065 }
1067 void networkStream::flush() {
1068 if (size() != 0) {
1069 int result = os::raw_send(_socket, (char *)base(), size(), 0);
1070 assert(result != -1, "connection error");
1071 assert(result == (int)size(), "didn't send enough data");
1072 }
1073 reset();
1074 }
1076 networkStream::~networkStream() {
1077 close();
1078 }
1080 void networkStream::close() {
1081 if (_socket != -1) {
1082 flush();
1083 os::socket_close(_socket);
1084 _socket = -1;
1085 }
1086 }
1088 bool networkStream::connect(const char *ip, short port) {
1090 struct sockaddr_in server;
1091 server.sin_family = AF_INET;
1092 server.sin_port = htons(port);
1094 server.sin_addr.s_addr = inet_addr(ip);
1095 if (server.sin_addr.s_addr == (uint32_t)-1) {
1096 struct hostent* host = os::get_host_by_name((char*)ip);
1097 if (host != NULL) {
1098 memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
1099 } else {
1100 return false;
1101 }
1102 }
1105 int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
1106 return (result >= 0);
1107 }
1109 #endif