1 /*
2 * Copyright (c) 1997, 2019, 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 "jvm.h"
27 #include "compiler/compileLog.hpp"
28 #include "memory/allocation.inline.hpp"
29 #include "oops/oop.inline.hpp"
30 #include "runtime/arguments.hpp"
31 #include "runtime/mutex.inline.hpp"
32 #include "runtime/os.inline.hpp"
33 #include "runtime/vm_version.hpp"
34 #include "utilities/defaultStream.hpp"
35 #include "utilities/macros.hpp"
36 #include "utilities/ostream.hpp"
37 #include "utilities/vmError.hpp"
38 #include "utilities/xmlstream.hpp"
39
40 // Declarations of jvm methods
41 extern "C" void jio_print(const char* s, size_t len);
42 extern "C" int jio_printf(const char *fmt, ...);
43
44 outputStream::outputStream(int width) {
45 _width = width;
46 _position = 0;
47 _newlines = 0;
48 _precount = 0;
49 _indentation = 0;
50 _scratch = NULL;
51 _scratch_len = 0;
52 }
53
54 outputStream::outputStream(int width, bool has_time_stamps) {
55 _width = width;
56 _position = 0;
57 _newlines = 0;
58 _precount = 0;
59 _indentation = 0;
60 _scratch = NULL;
61 _scratch_len = 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 assert(buflen >= 2, "buffer too small");
89
90 const char* result;
91 if (add_cr) buflen--;
92 if (!strchr(format, '%')) {
93 // constant format string
94 result = format;
95 result_len = strlen(result);
96 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate
97 } else if (format[0] == '%' && format[1] == 's' && format[2] == '\0') {
98 // trivial copy-through format string
99 result = va_arg(ap, const char*);
100 result_len = strlen(result);
101 if (add_cr && result_len >= buflen) result_len = buflen-1; // truncate
102 } else {
103 int required_len = os::vsnprintf(buffer, buflen, format, ap);
104 assert(required_len >= 0, "vsnprintf encoding error");
105 result = buffer;
106 if ((size_t)required_len < buflen) {
107 result_len = required_len;
108 } else {
109 DEBUG_ONLY(warning("outputStream::do_vsnprintf output truncated -- buffer length is %d bytes but %d bytes are needed.",
110 add_cr ? (int)buflen + 1 : (int)buflen, add_cr ? required_len + 2 : required_len + 1);)
111 result_len = buflen - 1;
112 }
113 }
114 if (add_cr) {
115 if (result != buffer) {
116 memcpy(buffer, result, result_len);
117 result = buffer;
118 }
119 buffer[result_len++] = '\n';
120 buffer[result_len] = 0;
121 }
122 return result;
123 }
124
125 void outputStream::do_vsnprintf_and_write_with_automatic_buffer(const char* format, va_list ap, bool add_cr) {
126 char buffer[O_BUFLEN];
127 size_t len;
128 const char* str = do_vsnprintf(buffer, sizeof(buffer), format, ap, add_cr, len);
129 write(str, len);
130 }
131
132 void outputStream::do_vsnprintf_and_write_with_scratch_buffer(const char* format, va_list ap, bool add_cr) {
133 size_t len;
134 const char* str = do_vsnprintf(_scratch, _scratch_len, format, ap, add_cr, len);
135 write(str, len);
136 }
137
138 void outputStream::do_vsnprintf_and_write(const char* format, va_list ap, bool add_cr) {
139 if (_scratch) {
140 do_vsnprintf_and_write_with_scratch_buffer(format, ap, add_cr);
141 } else {
142 do_vsnprintf_and_write_with_automatic_buffer(format, ap, add_cr);
143 }
144 }
145
146 void outputStream::print(const char* format, ...) {
147 va_list ap;
148 va_start(ap, format);
149 do_vsnprintf_and_write(format, ap, false);
150 va_end(ap);
151 }
152
153 void outputStream::print_cr(const char* format, ...) {
154 va_list ap;
155 va_start(ap, format);
156 do_vsnprintf_and_write(format, ap, true);
157 va_end(ap);
158 }
159
160 void outputStream::vprint(const char *format, va_list argptr) {
161 do_vsnprintf_and_write(format, argptr, false);
162 }
163
164 void outputStream::vprint_cr(const char* format, va_list argptr) {
165 do_vsnprintf_and_write(format, argptr, true);
166 }
167
168 void outputStream::fill_to(int col) {
169 int need_fill = col - position();
170 sp(need_fill);
171 }
172
173 void outputStream::move_to(int col, int slop, int min_space) {
174 if (position() >= col + slop)
175 cr();
176 int need_fill = col - position();
177 if (need_fill < min_space)
178 need_fill = min_space;
179 sp(need_fill);
180 }
181
182 void outputStream::put(char ch) {
183 assert(ch != 0, "please fix call site");
184 char buf[] = { ch, '\0' };
185 write(buf, 1);
186 }
187
188 #define SP_USE_TABS false
189
190 void outputStream::sp(int count) {
191 if (count < 0) return;
192 if (SP_USE_TABS && count >= 8) {
193 int target = position() + count;
194 while (count >= 8) {
195 this->write("\t", 1);
196 count -= 8;
197 }
198 count = target - position();
199 }
200 while (count > 0) {
201 int nw = (count > 8) ? 8 : count;
202 this->write(" ", nw);
203 count -= nw;
204 }
205 }
206
207 void outputStream::cr() {
208 this->write("\n", 1);
209 }
210
211 void outputStream::cr_indent() {
212 cr(); indent();
213 }
214
215 void outputStream::stamp() {
216 if (! _stamp.is_updated()) {
217 _stamp.update(); // start at 0 on first call to stamp()
218 }
219
220 // outputStream::stamp() may get called by ostream_abort(), use snprintf
221 // to avoid allocating large stack buffer in print().
222 char buf[40];
223 jio_snprintf(buf, sizeof(buf), "%.3f", _stamp.seconds());
224 print_raw(buf);
225 }
226
227 void outputStream::stamp(bool guard,
228 const char* prefix,
229 const char* suffix) {
230 if (!guard) {
231 return;
232 }
233 print_raw(prefix);
234 stamp();
235 print_raw(suffix);
236 }
237
238 void outputStream::date_stamp(bool guard,
239 const char* prefix,
240 const char* suffix) {
241 if (!guard) {
242 return;
243 }
244 print_raw(prefix);
245 static const char error_time[] = "yyyy-mm-ddThh:mm:ss.mmm+zzzz";
246 static const int buffer_length = 32;
247 char buffer[buffer_length];
248 const char* iso8601_result = os::iso8601_time(buffer, buffer_length);
249 if (iso8601_result != NULL) {
250 print_raw(buffer);
251 } else {
252 print_raw(error_time);
253 }
254 print_raw(suffix);
255 return;
256 }
257
258 outputStream& outputStream::indent() {
259 while (_position < _indentation) sp();
260 return *this;
261 }
262
263 void outputStream::print_jlong(jlong value) {
264 print(JLONG_FORMAT, value);
265 }
266
267 void outputStream::print_julong(julong value) {
268 print(JULONG_FORMAT, value);
269 }
270
271 /**
272 * This prints out hex data in a 'windbg' or 'xxd' form, where each line is:
273 * <hex-address>: 8 * <hex-halfword> <ascii translation (optional)>
274 * example:
275 * 0000000: 7f44 4f46 0102 0102 0000 0000 0000 0000 .DOF............
276 * 0000010: 0000 0000 0000 0040 0000 0020 0000 0005 .......@... ....
277 * 0000020: 0000 0000 0000 0040 0000 0000 0000 015d .......@.......]
278 * ...
279 *
280 * indent is applied to each line. Ends with a CR.
281 */
282 void outputStream::print_data(void* data, size_t len, bool with_ascii) {
283 size_t limit = (len + 16) / 16 * 16;
284 for (size_t i = 0; i < limit; ++i) {
285 if (i % 16 == 0) {
286 indent().print(INTPTR_FORMAT_W(07) ":", i);
287 }
288 if (i % 2 == 0) {
289 print(" ");
290 }
291 if (i < len) {
292 print("%02x", ((unsigned char*)data)[i]);
293 } else {
294 print(" ");
295 }
296 if ((i + 1) % 16 == 0) {
297 if (with_ascii) {
298 print(" ");
299 for (size_t j = 0; j < 16; ++j) {
300 size_t idx = i + j - 15;
301 if (idx < len) {
302 char c = ((char*)data)[idx];
303 print("%c", c >= 32 && c <= 126 ? c : '.');
304 }
305 }
306 }
307 cr();
308 }
309 }
310 }
311
312 stringStream::stringStream(size_t initial_size) : outputStream() {
313 buffer_length = initial_size;
314 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
315 buffer_pos = 0;
316 buffer_fixed = false;
317 zero_terminate();
318 }
319
320 // useful for output to fixed chunks of memory, such as performance counters
321 stringStream::stringStream(char* fixed_buffer, size_t fixed_buffer_size) : outputStream() {
322 buffer_length = fixed_buffer_size;
323 buffer = fixed_buffer;
324 buffer_pos = 0;
325 buffer_fixed = true;
326 zero_terminate();
327 }
328
329 void stringStream::write(const char* s, size_t len) {
330 size_t write_len = len; // number of non-null bytes to write
331 size_t end = buffer_pos + len + 1; // position after write and final '\0'
332 if (end > buffer_length) {
333 if (buffer_fixed) {
334 // if buffer cannot resize, silently truncate
335 end = buffer_length;
336 write_len = end - buffer_pos - 1; // leave room for the final '\0'
337 } else {
338 // For small overruns, double the buffer. For larger ones,
339 // increase to the requested size.
340 if (end < buffer_length * 2) {
341 end = buffer_length * 2;
342 }
343 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
344 buffer_length = end;
345 }
346 }
347 // invariant: buffer is always null-terminated
348 guarantee(buffer_pos + write_len + 1 <= buffer_length, "stringStream oob");
349 if (write_len > 0) {
350 memcpy(buffer + buffer_pos, s, write_len);
351 buffer_pos += write_len;
352 zero_terminate();
353 }
354
355 // Note that the following does not depend on write_len.
356 // This means that position and count get updated
357 // even when overflow occurs.
358 update_position(s, len);
359 }
360
361 void stringStream::zero_terminate() {
362 assert(buffer != NULL &&
363 buffer_pos < buffer_length, "sanity");
364 buffer[buffer_pos] = '\0';
365 }
366
367 void stringStream::reset() {
368 buffer_pos = 0; _precount = 0; _position = 0;
369 zero_terminate();
370 }
371
372 char* stringStream::as_string() const {
373 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos + 1);
374 strncpy(copy, buffer, buffer_pos);
375 copy[buffer_pos] = 0; // terminating null
376 return copy;
377 }
378
379 stringStream::~stringStream() {
380 if (buffer_fixed == false && buffer != NULL) {
381 FREE_C_HEAP_ARRAY(char, buffer);
382 }
383 }
384
385 xmlStream* xtty;
386 outputStream* tty;
387 CDS_ONLY(fileStream* classlist_file;) // Only dump the classes that can be stored into the CDS archive
388 extern Mutex* tty_lock;
389
390 #define EXTRACHARLEN 32
391 #define CURRENTAPPX ".current"
392 // convert YYYY-MM-DD HH:MM:SS to YYYY-MM-DD_HH-MM-SS
393 char* get_datetime_string(char *buf, size_t len) {
394 os::local_time_string(buf, len);
395 int i = (int)strlen(buf);
396 while (--i >= 0) {
397 if (buf[i] == ' ') buf[i] = '_';
398 else if (buf[i] == ':') buf[i] = '-';
399 }
400 return buf;
401 }
402
403 static const char* make_log_name_internal(const char* log_name, const char* force_directory,
404 int pid, const char* tms) {
405 const char* basename = log_name;
406 char file_sep = os::file_separator()[0];
407 const char* cp;
408 char pid_text[32];
409
410 for (cp = log_name; *cp != '\0'; cp++) {
411 if (*cp == '/' || *cp == file_sep) {
412 basename = cp + 1;
413 }
414 }
415 const char* nametail = log_name;
416 // Compute buffer length
417 size_t buffer_length;
418 if (force_directory != NULL) {
419 buffer_length = strlen(force_directory) + strlen(os::file_separator()) +
420 strlen(basename) + 1;
421 } else {
422 buffer_length = strlen(log_name) + 1;
423 }
424
425 const char* pts = strstr(basename, "%p");
426 int pid_pos = (pts == NULL) ? -1 : (pts - nametail);
427
428 if (pid_pos >= 0) {
429 jio_snprintf(pid_text, sizeof(pid_text), "pid%u", pid);
430 buffer_length += strlen(pid_text);
431 }
432
433 pts = strstr(basename, "%t");
434 int tms_pos = (pts == NULL) ? -1 : (pts - nametail);
435 if (tms_pos >= 0) {
436 buffer_length += strlen(tms);
437 }
438
439 // File name is too long.
440 if (buffer_length > JVM_MAXPATHLEN) {
441 return NULL;
442 }
443
444 // Create big enough buffer.
445 char *buf = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
446
447 strcpy(buf, "");
448 if (force_directory != NULL) {
449 strcat(buf, force_directory);
450 strcat(buf, os::file_separator());
451 nametail = basename; // completely skip directory prefix
452 }
453
454 // who is first, %p or %t?
455 int first = -1, second = -1;
456 const char *p1st = NULL;
457 const char *p2nd = NULL;
458
459 if (pid_pos >= 0 && tms_pos >= 0) {
460 // contains both %p and %t
461 if (pid_pos < tms_pos) {
462 // case foo%pbar%tmonkey.log
463 first = pid_pos;
464 p1st = pid_text;
465 second = tms_pos;
466 p2nd = tms;
467 } else {
468 // case foo%tbar%pmonkey.log
469 first = tms_pos;
470 p1st = tms;
471 second = pid_pos;
472 p2nd = pid_text;
473 }
474 } else if (pid_pos >= 0) {
475 // contains %p only
476 first = pid_pos;
477 p1st = pid_text;
478 } else if (tms_pos >= 0) {
479 // contains %t only
480 first = tms_pos;
481 p1st = tms;
482 }
483
484 int buf_pos = (int)strlen(buf);
485 const char* tail = nametail;
486
487 if (first >= 0) {
488 tail = nametail + first + 2;
489 strncpy(&buf[buf_pos], nametail, first);
490 strcpy(&buf[buf_pos + first], p1st);
491 buf_pos = (int)strlen(buf);
492 if (second >= 0) {
493 strncpy(&buf[buf_pos], tail, second - first - 2);
494 strcpy(&buf[buf_pos + second - first - 2], p2nd);
495 tail = nametail + second + 2;
496 }
497 }
498 strcat(buf, tail); // append rest of name, or all of name
499 return buf;
500 }
501
502 // log_name comes from -XX:LogFile=log_name or
503 // -XX:DumpLoadedClassList=<file_name>
504 // in log_name, %p => pid1234 and
505 // %t => YYYY-MM-DD_HH-MM-SS
506 static const char* make_log_name(const char* log_name, const char* force_directory) {
507 char timestr[32];
508 get_datetime_string(timestr, sizeof(timestr));
509 return make_log_name_internal(log_name, force_directory, os::current_process_id(),
510 timestr);
511 }
512
513 fileStream::fileStream(const char* file_name) {
514 _file = fopen(file_name, "w");
515 if (_file != NULL) {
516 _need_close = true;
517 } else {
518 warning("Cannot open file %s due to %s\n", file_name, os::strerror(errno));
519 _need_close = false;
520 }
521 }
522
523 fileStream::fileStream(const char* file_name, const char* opentype) {
524 _file = fopen(file_name, opentype);
525 if (_file != NULL) {
526 _need_close = true;
527 } else {
528 warning("Cannot open file %s due to %s\n", file_name, os::strerror(errno));
529 _need_close = false;
530 }
531 }
532
533 void fileStream::write(const char* s, size_t len) {
534 if (_file != NULL) {
535 // Make an unused local variable to avoid warning from gcc 4.x compiler.
536 size_t count = fwrite(s, 1, len, _file);
537 }
538 update_position(s, len);
539 }
540
541 long fileStream::fileSize() {
542 long size = -1;
543 if (_file != NULL) {
544 long pos = ::ftell(_file);
545 if (pos < 0) return pos;
546 if (::fseek(_file, 0, SEEK_END) == 0) {
547 size = ::ftell(_file);
548 }
549 ::fseek(_file, pos, SEEK_SET);
550 }
551 return size;
552 }
553
554 char* fileStream::readln(char *data, int count ) {
555 char * ret = ::fgets(data, count, _file);
556 //Get rid of annoying \n char
557 data[::strlen(data)-1] = '\0';
558 return ret;
559 }
560
561 fileStream::~fileStream() {
562 if (_file != NULL) {
563 if (_need_close) fclose(_file);
564 _file = NULL;
565 }
566 }
567
568 void fileStream::flush() {
569 fflush(_file);
570 }
571
572 void fdStream::write(const char* s, size_t len) {
573 if (_fd != -1) {
574 // Make an unused local variable to avoid warning from gcc 4.x compiler.
575 size_t count = ::write(_fd, s, (int)len);
576 }
577 update_position(s, len);
578 }
579
580 defaultStream* defaultStream::instance = NULL;
581 int defaultStream::_output_fd = 1;
582 int defaultStream::_error_fd = 2;
583 FILE* defaultStream::_output_stream = stdout;
584 FILE* defaultStream::_error_stream = stderr;
585
586 #define LOG_MAJOR_VERSION 160
587 #define LOG_MINOR_VERSION 1
588
589 void defaultStream::init() {
590 _inited = true;
591 if (LogVMOutput || LogCompilation) {
592 init_log();
593 }
594 }
595
596 bool defaultStream::has_log_file() {
597 // lazily create log file (at startup, LogVMOutput is false even
598 // if +LogVMOutput is used, because the flags haven't been parsed yet)
599 // For safer printing during fatal error handling, do not init logfile
600 // if a VM error has been reported.
601 if (!_inited && !VMError::is_error_reported()) init();
602 return _log_file != NULL;
603 }
604
605 fileStream* defaultStream::open_file(const char* log_name) {
606 const char* try_name = make_log_name(log_name, NULL);
607 if (try_name == NULL) {
608 warning("Cannot open file %s: file name is too long.\n", log_name);
609 return NULL;
610 }
611
612 fileStream* file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
613 FREE_C_HEAP_ARRAY(char, try_name);
614 if (file->is_open()) {
615 return file;
616 }
617
618 // Try again to open the file in the temp directory.
619 delete file;
620 // Note: This feature is for maintainer use only. No need for L10N.
621 jio_printf("Warning: Cannot open log file: %s\n", log_name);
622 try_name = make_log_name(log_name, os::get_temp_directory());
623 if (try_name == NULL) {
624 warning("Cannot open file %s: file name is too long for directory %s.\n", log_name, os::get_temp_directory());
625 return NULL;
626 }
627
628 jio_printf("Warning: Forcing option -XX:LogFile=%s\n", try_name);
629
630 file = new(ResourceObj::C_HEAP, mtInternal) fileStream(try_name);
631 FREE_C_HEAP_ARRAY(char, try_name);
632 if (file->is_open()) {
633 return file;
634 }
635
636 delete file;
637 return NULL;
638 }
639
640 void defaultStream::init_log() {
641 // %%% Need a MutexLocker?
642 const char* log_name = LogFile != NULL ? LogFile : "hotspot_%p.log";
643 fileStream* file = open_file(log_name);
644
645 if (file != NULL) {
646 _log_file = file;
647 _outer_xmlStream = new(ResourceObj::C_HEAP, mtInternal) xmlStream(file);
648 start_log();
649 } else {
650 // and leave xtty as NULL
651 LogVMOutput = false;
652 DisplayVMOutput = true;
653 LogCompilation = false;
654 }
655 }
656
657 void defaultStream::start_log() {
658 xmlStream*xs = _outer_xmlStream;
659 if (this == tty) xtty = xs;
660 // Write XML header.
661 xs->print_cr("<?xml version='1.0' encoding='UTF-8'?>");
662 // (For now, don't bother to issue a DTD for this private format.)
663 jlong time_ms = os::javaTimeMillis() - tty->time_stamp().milliseconds();
664 // %%% Should be: jlong time_ms = os::start_time_milliseconds(), if
665 // we ever get round to introduce that method on the os class
666 xs->head("hotspot_log version='%d %d'"
667 " process='%d' time_ms='" INT64_FORMAT "'",
668 LOG_MAJOR_VERSION, LOG_MINOR_VERSION,
669 os::current_process_id(), (int64_t)time_ms);
670 // Write VM version header immediately.
671 xs->head("vm_version");
672 xs->head("name"); xs->text("%s", VM_Version::vm_name()); xs->cr();
673 xs->tail("name");
674 xs->head("release"); xs->text("%s", VM_Version::vm_release()); xs->cr();
675 xs->tail("release");
676 xs->head("info"); xs->text("%s", VM_Version::internal_vm_info_string()); xs->cr();
677 xs->tail("info");
678 xs->tail("vm_version");
679 // Record information about the command-line invocation.
680 xs->head("vm_arguments"); // Cf. Arguments::print_on()
681 if (Arguments::num_jvm_flags() > 0) {
682 xs->head("flags");
683 Arguments::print_jvm_flags_on(xs->text());
684 xs->tail("flags");
685 }
686 if (Arguments::num_jvm_args() > 0) {
687 xs->head("args");
688 Arguments::print_jvm_args_on(xs->text());
689 xs->tail("args");
690 }
691 if (Arguments::java_command() != NULL) {
692 xs->head("command"); xs->text()->print_cr("%s", Arguments::java_command());
693 xs->tail("command");
694 }
695 if (Arguments::sun_java_launcher() != NULL) {
696 xs->head("launcher"); xs->text()->print_cr("%s", Arguments::sun_java_launcher());
697 xs->tail("launcher");
698 }
699 if (Arguments::system_properties() != NULL) {
700 xs->head("properties");
701 // Print it as a java-style property list.
702 // System properties don't generally contain newlines, so don't bother with unparsing.
703 outputStream *text = xs->text();
704 for (SystemProperty* p = Arguments::system_properties(); p != NULL; p = p->next()) {
705 assert(p->key() != NULL, "p->key() is NULL");
706 if (p->is_readable()) {
707 // Print in two stages to avoid problems with long
708 // keys/values.
709 text->print_raw(p->key());
710 text->put('=');
711 assert(p->value() != NULL, "p->value() is NULL");
712 text->print_raw_cr(p->value());
713 }
714 }
715 xs->tail("properties");
716 }
717 xs->tail("vm_arguments");
718 // tty output per se is grouped under the <tty>...</tty> element.
719 xs->head("tty");
720 // All further non-markup text gets copied to the tty:
721 xs->_text = this; // requires friend declaration!
722 }
723
724 // finish_log() is called during normal VM shutdown. finish_log_on_error() is
725 // called by ostream_abort() after a fatal error.
726 //
727 void defaultStream::finish_log() {
728 xmlStream* xs = _outer_xmlStream;
729 xs->done("tty");
730
731 // Other log forks are appended here, at the End of Time:
732 CompileLog::finish_log(xs->out()); // write compile logging, if any, now
733
734 xs->done("hotspot_log");
735 xs->flush();
736
737 fileStream* file = _log_file;
738 _log_file = NULL;
739
740 delete _outer_xmlStream;
741 _outer_xmlStream = NULL;
742
743 file->flush();
744 delete file;
745 }
746
747 void defaultStream::finish_log_on_error(char *buf, int buflen) {
748 xmlStream* xs = _outer_xmlStream;
749
750 if (xs && xs->out()) {
751
752 xs->done_raw("tty");
753
754 // Other log forks are appended here, at the End of Time:
755 CompileLog::finish_log_on_error(xs->out(), buf, buflen); // write compile logging, if any, now
756
757 xs->done_raw("hotspot_log");
758 xs->flush();
759
760 fileStream* file = _log_file;
761 _log_file = NULL;
762 _outer_xmlStream = NULL;
763
764 if (file) {
765 file->flush();
766
767 // Can't delete or close the file because delete and fclose aren't
768 // async-safe. We are about to die, so leave it to the kernel.
769 // delete file;
770 }
771 }
772 }
773
774 intx defaultStream::hold(intx writer_id) {
775 bool has_log = has_log_file(); // check before locking
776 if (// impossible, but who knows?
777 writer_id == NO_WRITER ||
778
779 // bootstrap problem
780 tty_lock == NULL ||
781
782 // can't grab a lock if current Thread isn't set
783 Thread::current_or_null() == NULL ||
784
785 // developer hook
786 !SerializeVMOutput ||
787
788 // VM already unhealthy
789 VMError::is_error_reported() ||
790
791 // safepoint == global lock (for VM only)
792 (SafepointSynchronize::is_synchronizing() &&
793 Thread::current()->is_VM_thread())
794 ) {
795 // do not attempt to lock unless we know the thread and the VM is healthy
796 return NO_WRITER;
797 }
798 if (_writer == writer_id) {
799 // already held, no need to re-grab the lock
800 return NO_WRITER;
801 }
802 tty_lock->lock_without_safepoint_check();
803 // got the lock
804 if (writer_id != _last_writer) {
805 if (has_log) {
806 _log_file->bol();
807 // output a hint where this output is coming from:
808 _log_file->print_cr("<writer thread='" UINTX_FORMAT "'/>", writer_id);
809 }
810 _last_writer = writer_id;
811 }
812 _writer = writer_id;
813 return writer_id;
814 }
815
816 void defaultStream::release(intx holder) {
817 if (holder == NO_WRITER) {
818 // nothing to release: either a recursive lock, or we scribbled (too bad)
819 return;
820 }
821 if (_writer != holder) {
822 return; // already unlocked, perhaps via break_tty_lock_for_safepoint
823 }
824 _writer = NO_WRITER;
825 tty_lock->unlock();
826 }
827
828 void defaultStream::write(const char* s, size_t len) {
829 intx thread_id = os::current_thread_id();
830 intx holder = hold(thread_id);
831
832 if (DisplayVMOutput &&
833 (_outer_xmlStream == NULL || !_outer_xmlStream->inside_attrs())) {
834 // print to output stream. It can be redirected by a vfprintf hook
835 jio_print(s, len);
836 }
837
838 // print to log file
839 if (has_log_file()) {
840 int nl0 = _newlines;
841 xmlTextStream::write(s, len);
842 // flush the log file too, if there were any newlines
843 if (nl0 != _newlines){
844 flush();
845 }
846 } else {
847 update_position(s, len);
848 }
849
850 release(holder);
851 }
852
853 intx ttyLocker::hold_tty() {
854 if (defaultStream::instance == NULL) return defaultStream::NO_WRITER;
855 intx thread_id = os::current_thread_id();
856 return defaultStream::instance->hold(thread_id);
857 }
858
859 void ttyLocker::release_tty(intx holder) {
860 if (holder == defaultStream::NO_WRITER) return;
861 defaultStream::instance->release(holder);
862 }
863
864 bool ttyLocker::release_tty_if_locked() {
865 intx thread_id = os::current_thread_id();
866 if (defaultStream::instance->writer() == thread_id) {
867 // release the lock and return true so callers know if was
868 // previously held.
869 release_tty(thread_id);
870 return true;
871 }
872 return false;
873 }
874
875 void ttyLocker::break_tty_lock_for_safepoint(intx holder) {
876 if (defaultStream::instance != NULL &&
877 defaultStream::instance->writer() == holder) {
878 if (xtty != NULL) {
879 xtty->print_cr("<!-- safepoint while printing -->");
880 }
881 defaultStream::instance->release(holder);
882 }
883 // (else there was no lock to break)
884 }
885
886 void ostream_init() {
887 if (defaultStream::instance == NULL) {
888 defaultStream::instance = new(ResourceObj::C_HEAP, mtInternal) defaultStream();
889 tty = defaultStream::instance;
890
891 // We want to ensure that time stamps in GC logs consider time 0
892 // the time when the JVM is initialized, not the first time we ask
893 // for a time stamp. So, here, we explicitly update the time stamp
894 // of tty.
895 tty->time_stamp().update_to(1);
896 }
897 }
898
899 void ostream_init_log() {
900 // Note : this must be called AFTER ostream_init()
901
902 #if INCLUDE_CDS
903 // For -XX:DumpLoadedClassList=<file> option
904 if (DumpLoadedClassList != NULL) {
905 const char* list_name = make_log_name(DumpLoadedClassList, NULL);
906 classlist_file = new(ResourceObj::C_HEAP, mtInternal)
907 fileStream(list_name);
908 FREE_C_HEAP_ARRAY(char, list_name);
909 }
910 #endif
911
912 // If we haven't lazily initialized the logfile yet, do it now,
913 // to avoid the possibility of lazy initialization during a VM
914 // crash, which can affect the stability of the fatal error handler.
915 defaultStream::instance->has_log_file();
916 }
917
918 // ostream_exit() is called during normal VM exit to finish log files, flush
919 // output and free resource.
920 void ostream_exit() {
921 static bool ostream_exit_called = false;
922 if (ostream_exit_called) return;
923 ostream_exit_called = true;
924 #if INCLUDE_CDS
925 if (classlist_file != NULL) {
926 delete classlist_file;
927 }
928 #endif
929 if (tty != defaultStream::instance) {
930 delete tty;
931 }
932 if (defaultStream::instance != NULL) {
933 delete defaultStream::instance;
934 }
935 tty = NULL;
936 xtty = NULL;
937 defaultStream::instance = NULL;
938 }
939
940 // ostream_abort() is called by os::abort() when VM is about to die.
941 void ostream_abort() {
942 // Here we can't delete tty, just flush its output
943 if (tty) tty->flush();
944
945 if (defaultStream::instance != NULL) {
946 static char buf[4096];
947 defaultStream::instance->finish_log_on_error(buf, sizeof(buf));
948 }
949 }
950
951 bufferedStream::bufferedStream(size_t initial_size, size_t bufmax) : outputStream() {
952 buffer_length = initial_size;
953 buffer = NEW_C_HEAP_ARRAY(char, buffer_length, mtInternal);
954 buffer_pos = 0;
955 buffer_fixed = false;
956 buffer_max = bufmax;
957 truncated = false;
958 }
959
960 bufferedStream::bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax) : outputStream() {
961 buffer_length = fixed_buffer_size;
962 buffer = fixed_buffer;
963 buffer_pos = 0;
964 buffer_fixed = true;
965 buffer_max = bufmax;
966 truncated = false;
967 }
968
969 void bufferedStream::write(const char* s, size_t len) {
970
971 if (truncated) {
972 return;
973 }
974
975 if(buffer_pos + len > buffer_max) {
976 flush(); // Note: may be a noop.
977 }
978
979 size_t end = buffer_pos + len;
980 if (end >= buffer_length) {
981 if (buffer_fixed) {
982 // if buffer cannot resize, silently truncate
983 len = buffer_length - buffer_pos - 1;
984 truncated = true;
985 } else {
986 // For small overruns, double the buffer. For larger ones,
987 // increase to the requested size.
988 if (end < buffer_length * 2) {
989 end = buffer_length * 2;
990 }
991 // Impose a cap beyond which the buffer cannot grow - a size which
992 // in all probability indicates a real error, e.g. faulty printing
993 // code looping, while not affecting cases of just-very-large-but-its-normal
994 // output.
995 const size_t reasonable_cap = MAX2(100 * M, buffer_max * 2);
996 if (end > reasonable_cap) {
997 // In debug VM, assert right away.
998 assert(false, "Exceeded max buffer size for this string.");
999 // Release VM: silently truncate. We do this since these kind of errors
1000 // are both difficult to predict with testing (depending on logging content)
1001 // and usually not serious enough to kill a production VM for it.
1002 end = reasonable_cap;
1003 size_t remaining = end - buffer_pos;
1004 if (len >= remaining) {
1005 len = remaining - 1;
1006 truncated = true;
1007 }
1008 }
1009 if (buffer_length < end) {
1010 buffer = REALLOC_C_HEAP_ARRAY(char, buffer, end, mtInternal);
1011 buffer_length = end;
1012 }
1013 }
1014 }
1015 if (len > 0) {
1016 memcpy(buffer + buffer_pos, s, len);
1017 buffer_pos += len;
1018 update_position(s, len);
1019 }
1020 }
1021
1022 char* bufferedStream::as_string() {
1023 char* copy = NEW_RESOURCE_ARRAY(char, buffer_pos+1);
1024 strncpy(copy, buffer, buffer_pos);
1025 copy[buffer_pos] = 0; // terminating null
1026 return copy;
1027 }
1028
1029 bufferedStream::~bufferedStream() {
1030 if (!buffer_fixed) {
1031 FREE_C_HEAP_ARRAY(char, buffer);
1032 }
1033 }
1034
1035 #ifndef PRODUCT
1036
1037 #if defined(SOLARIS) || defined(LINUX) || defined(AIX) || defined(_ALLBSD_SOURCE)
1038 #include <sys/types.h>
1039 #include <sys/socket.h>
1040 #include <netinet/in.h>
1041 #include <arpa/inet.h>
1042 #elif defined(_WINDOWS)
1043 #include <winsock2.h>
1044 #endif
1045
1046 // Network access
1047 networkStream::networkStream() : bufferedStream(1024*10, 1024*10) {
1048
1049 _socket = -1;
1050
1051 int result = os::socket(AF_INET, SOCK_STREAM, 0);
1052 if (result <= 0) {
1053 assert(false, "Socket could not be created!");
1054 } else {
1055 _socket = result;
1056 }
1057 }
1058
1059 int networkStream::read(char *buf, size_t len) {
1060 return os::recv(_socket, buf, (int)len, 0);
1061 }
1062
1063 void networkStream::flush() {
1064 if (size() != 0) {
1065 int result = os::raw_send(_socket, (char *)base(), size(), 0);
1066 assert(result != -1, "connection error");
1067 assert(result == (int)size(), "didn't send enough data");
1068 }
1069 reset();
1070 }
1071
1072 networkStream::~networkStream() {
1073 close();
1074 }
1075
1076 void networkStream::close() {
1077 if (_socket != -1) {
1078 flush();
1079 os::socket_close(_socket);
1080 _socket = -1;
1081 }
1082 }
1083
1084 bool networkStream::connect(const char *ip, short port) {
1085
1086 struct sockaddr_in server;
1087 server.sin_family = AF_INET;
1088 server.sin_port = htons(port);
1089
1090 server.sin_addr.s_addr = inet_addr(ip);
1091 if (server.sin_addr.s_addr == (uint32_t)-1) {
1092 struct hostent* host = os::get_host_by_name((char*)ip);
1093 if (host != NULL) {
1094 memcpy(&server.sin_addr, host->h_addr_list[0], host->h_length);
1095 } else {
1096 return false;
1097 }
1098 }
1099
1100
1101 int result = os::connect(_socket, (struct sockaddr*)&server, sizeof(struct sockaddr_in));
1102 return (result >= 0);
1103 }
1104
1105 #endif