1 /* 2 * Copyright (c) 1997, 2010, 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 #ifndef SHARE_VM_UTILITIES_OSTREAM_HPP 26 #define SHARE_VM_UTILITIES_OSTREAM_HPP 27 28 #include "memory/allocation.hpp" 29 #include "runtime/timer.hpp" 30 31 // Output streams for printing 32 // 33 // Printing guidelines: 34 // Where possible, please use tty->print() and tty->print_cr(). 35 // For product mode VM warnings use warning() which internally uses tty. 36 // In places where tty is not initialized yet or too much overhead, 37 // we may use jio_printf: 38 // jio_fprintf(defaultStream::output_stream(), "Message"); 39 // This allows for redirection via -XX:+DisplayVMOutputToStdout and 40 // -XX:+DisplayVMOutputToStderr 41 class outputStream : public ResourceObj { 42 protected: 43 int _indentation; // current indentation 44 int _width; // width of the page 45 int _position; // position on the current line 46 int _newlines; // number of '\n' output so far 47 julong _precount; // number of chars output, less _position 48 TimeStamp _stamp; // for time stamps 49 50 void update_position(const char* s, size_t len); 51 static const char* do_vsnprintf(char* buffer, size_t buflen, 52 const char* format, va_list ap, 53 bool add_cr, 54 size_t& result_len); 55 56 public: 57 // creation 58 outputStream(int width = 80); 59 outputStream(int width, bool has_time_stamps); 60 61 // indentation 62 void indent(); 63 void inc() { _indentation++; }; 64 void dec() { _indentation--; }; 65 int indentation() const { return _indentation; } 66 void set_indentation(int i) { _indentation = i; } 67 void fill_to(int col); 68 void move_to(int col, int slop = 6, int min_space = 2); 69 70 // sizing 71 int width() const { return _width; } 72 int position() const { return _position; } 73 int newlines() const { return _newlines; } 74 julong count() const { return _precount + _position; } 75 void set_count(julong count) { _precount = count - _position; } 76 void set_position(int pos) { _position = pos; } 77 78 // printing 79 void print(const char* format, ...); 80 void print_cr(const char* format, ...); 81 void vprint(const char *format, va_list argptr); 82 void vprint_cr(const char* format, va_list argptr); 83 void print_raw(const char* str) { write(str, strlen(str)); } 84 void print_raw(const char* str, int len) { write(str, len); } 85 void print_raw_cr(const char* str) { write(str, strlen(str)); cr(); } 86 void print_raw_cr(const char* str, int len){ write(str, len); cr(); } 87 void put(char ch); 88 void sp(int count = 1); 89 void cr(); 90 void bol() { if (_position > 0) cr(); } 91 92 // Time stamp 93 TimeStamp& time_stamp() { return _stamp; } 94 void stamp(); 95 void stamp(bool guard, const char* prefix, const char* suffix); 96 void stamp(bool guard) { 97 stamp(guard, "", ": "); 98 } 99 // Date stamp 100 void date_stamp(bool guard, const char* prefix, const char* suffix); 101 // A simplified call that includes a suffix of ": " 102 void date_stamp(bool guard) { 103 date_stamp(guard, "", ": "); 104 } 105 106 // portable printing of 64 bit integers 107 void print_jlong(jlong value); 108 void print_julong(julong value); 109 110 // flushing 111 virtual void flush() {} 112 virtual void write(const char* str, size_t len) = 0; 113 virtual ~outputStream() {} // close properly on deletion 114 115 void dec_cr() { dec(); cr(); } 116 void inc_cr() { inc(); cr(); } 117 }; 118 119 // standard output 120 // ANSI C++ name collision 121 extern outputStream* tty; // tty output 122 extern outputStream* gclog_or_tty; // stream for gc log if -Xloggc:<f>, or tty 123 124 // advisory locking for the shared tty stream: 125 class ttyLocker: StackObj { 126 private: 127 intx _holder; 128 129 public: 130 static intx hold_tty(); // returns a "holder" token 131 static void release_tty(intx holder); // must witness same token 132 static void break_tty_lock_for_safepoint(intx holder); 133 134 ttyLocker() { _holder = hold_tty(); } 135 ~ttyLocker() { release_tty(_holder); } 136 }; 137 138 // for writing to strings; buffer will expand automatically 139 class stringStream : public outputStream { 140 protected: 141 char* buffer; 142 size_t buffer_pos; 143 size_t buffer_length; 144 bool buffer_fixed; 145 public: 146 stringStream(size_t initial_bufsize = 256); 147 stringStream(char* fixed_buffer, size_t fixed_buffer_size); 148 ~stringStream(); 149 virtual void write(const char* c, size_t len); 150 size_t size() { return buffer_pos; } 151 const char* base() { return buffer; } 152 void reset() { buffer_pos = 0; _precount = 0; _position = 0; } 153 char* as_string(); 154 }; 155 156 class fileStream : public outputStream { 157 protected: 158 FILE* _file; 159 bool _need_close; 160 public: 161 fileStream(const char* file_name); 162 fileStream(FILE* file) { _file = file; _need_close = false; } 163 ~fileStream(); 164 bool is_open() const { return _file != NULL; } 165 virtual void write(const char* c, size_t len); 166 void flush(); 167 }; 168 169 // unlike fileStream, fdStream does unbuffered I/O by calling 170 // open() and write() directly. It is async-safe, but output 171 // from multiple thread may be mixed together. Used by fatal 172 // error handler. 173 class fdStream : public outputStream { 174 protected: 175 int _fd; 176 bool _need_close; 177 public: 178 fdStream(const char* file_name); 179 fdStream(int fd = -1) { _fd = fd; _need_close = false; } 180 ~fdStream(); 181 bool is_open() const { return _fd != -1; } 182 void set_fd(int fd) { _fd = fd; _need_close = false; } 183 int fd() const { return _fd; } 184 virtual void write(const char* c, size_t len); 185 void flush() {}; 186 }; 187 188 void ostream_init(); 189 void ostream_init_log(); 190 void ostream_exit(); 191 void ostream_abort(); 192 193 // staticBufferStream uses a user-supplied buffer for all formatting. 194 // Used for safe formatting during fatal error handling. Not MT safe. 195 // Do not share the stream between multiple threads. 196 class staticBufferStream : public outputStream { 197 private: 198 char* _buffer; 199 size_t _buflen; 200 outputStream* _outer_stream; 201 public: 202 staticBufferStream(char* buffer, size_t buflen, 203 outputStream *outer_stream); 204 ~staticBufferStream() {}; 205 virtual void write(const char* c, size_t len); 206 void flush(); 207 void print(const char* format, ...); 208 void print_cr(const char* format, ...); 209 void vprint(const char *format, va_list argptr); 210 void vprint_cr(const char* format, va_list argptr); 211 }; 212 213 // In the non-fixed buffer case an underlying buffer will be created and 214 // managed in C heap. Not MT-safe. 215 class bufferedStream : public outputStream { 216 protected: 217 char* buffer; 218 size_t buffer_pos; 219 size_t buffer_max; 220 size_t buffer_length; 221 bool buffer_fixed; 222 public: 223 bufferedStream(size_t initial_bufsize = 256, size_t bufmax = 1024*1024*10); 224 bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax = 1024*1024*10); 225 ~bufferedStream(); 226 virtual void write(const char* c, size_t len); 227 size_t size() { return buffer_pos; } 228 const char* base() { return buffer; } 229 void reset() { buffer_pos = 0; _precount = 0; _position = 0; } 230 char* as_string(); 231 }; 232 233 #define O_BUFLEN 2000 // max size of output of individual print() methods 234 235 #ifndef PRODUCT 236 237 class networkStream : public bufferedStream { 238 239 private: 240 int _socket; 241 242 public: 243 networkStream(); 244 ~networkStream(); 245 246 bool connect(const char *host, short port); 247 bool is_open() const { return _socket != -1; } 248 int read(char *buf, size_t len); 249 void close(); 250 virtual void flush(); 251 }; 252 253 #endif 254 255 #endif // SHARE_VM_UTILITIES_OSTREAM_HPP