src/share/vm/utilities/ostream.hpp

Thu, 25 Apr 2013 11:02:32 -0700

author
vlivanov
date
Thu, 25 Apr 2013 11:02:32 -0700
changeset 5027
e12c9b3740db
parent 4647
0598674c0056
child 5409
dbc0b5dc08f5
permissions
-rw-r--r--

8012260: ciReplay: Include PID into the name of replay data file
Reviewed-by: kvn, twisti

duke@435 1 /*
kamg@3992 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_UTILITIES_OSTREAM_HPP
stefank@2314 26 #define SHARE_VM_UTILITIES_OSTREAM_HPP
stefank@2314 27
stefank@2314 28 #include "memory/allocation.hpp"
stefank@2314 29 #include "runtime/timer.hpp"
stefank@2314 30
duke@435 31 // Output streams for printing
duke@435 32 //
duke@435 33 // Printing guidelines:
duke@435 34 // Where possible, please use tty->print() and tty->print_cr().
duke@435 35 // For product mode VM warnings use warning() which internally uses tty.
duke@435 36 // In places where tty is not initialized yet or too much overhead,
duke@435 37 // we may use jio_printf:
duke@435 38 // jio_fprintf(defaultStream::output_stream(), "Message");
duke@435 39 // This allows for redirection via -XX:+DisplayVMOutputToStdout and
duke@435 40 // -XX:+DisplayVMOutputToStderr
duke@435 41 class outputStream : public ResourceObj {
duke@435 42 protected:
duke@435 43 int _indentation; // current indentation
duke@435 44 int _width; // width of the page
duke@435 45 int _position; // position on the current line
duke@435 46 int _newlines; // number of '\n' output so far
duke@435 47 julong _precount; // number of chars output, less _position
duke@435 48 TimeStamp _stamp; // for time stamps
duke@435 49
duke@435 50 void update_position(const char* s, size_t len);
duke@435 51 static const char* do_vsnprintf(char* buffer, size_t buflen,
duke@435 52 const char* format, va_list ap,
duke@435 53 bool add_cr,
duke@435 54 size_t& result_len);
duke@435 55
duke@435 56 public:
duke@435 57 // creation
duke@435 58 outputStream(int width = 80);
duke@435 59 outputStream(int width, bool has_time_stamps);
duke@435 60
duke@435 61 // indentation
kamg@3992 62 outputStream& indent();
duke@435 63 void inc() { _indentation++; };
duke@435 64 void dec() { _indentation--; };
kamg@3992 65 void inc(int n) { _indentation += n; };
kamg@3992 66 void dec(int n) { _indentation -= n; };
duke@435 67 int indentation() const { return _indentation; }
duke@435 68 void set_indentation(int i) { _indentation = i; }
duke@435 69 void fill_to(int col);
jrose@535 70 void move_to(int col, int slop = 6, int min_space = 2);
duke@435 71
duke@435 72 // sizing
duke@435 73 int width() const { return _width; }
duke@435 74 int position() const { return _position; }
duke@435 75 int newlines() const { return _newlines; }
duke@435 76 julong count() const { return _precount + _position; }
duke@435 77 void set_count(julong count) { _precount = count - _position; }
duke@435 78 void set_position(int pos) { _position = pos; }
duke@435 79
duke@435 80 // printing
duke@435 81 void print(const char* format, ...);
duke@435 82 void print_cr(const char* format, ...);
duke@435 83 void vprint(const char *format, va_list argptr);
duke@435 84 void vprint_cr(const char* format, va_list argptr);
duke@435 85 void print_raw(const char* str) { write(str, strlen(str)); }
duke@435 86 void print_raw(const char* str, int len) { write(str, len); }
duke@435 87 void print_raw_cr(const char* str) { write(str, strlen(str)); cr(); }
duke@435 88 void print_raw_cr(const char* str, int len){ write(str, len); cr(); }
kamg@3992 89 void print_data(void* data, size_t len, bool with_ascii);
duke@435 90 void put(char ch);
jrose@535 91 void sp(int count = 1);
duke@435 92 void cr();
duke@435 93 void bol() { if (_position > 0) cr(); }
duke@435 94
duke@435 95 // Time stamp
duke@435 96 TimeStamp& time_stamp() { return _stamp; }
duke@435 97 void stamp();
ysr@777 98 void stamp(bool guard, const char* prefix, const char* suffix);
ysr@777 99 void stamp(bool guard) {
ysr@777 100 stamp(guard, "", ": ");
ysr@777 101 }
duke@435 102 // Date stamp
duke@435 103 void date_stamp(bool guard, const char* prefix, const char* suffix);
duke@435 104 // A simplified call that includes a suffix of ": "
duke@435 105 void date_stamp(bool guard) {
duke@435 106 date_stamp(guard, "", ": ");
duke@435 107 }
duke@435 108
duke@435 109 // portable printing of 64 bit integers
duke@435 110 void print_jlong(jlong value);
duke@435 111 void print_julong(julong value);
duke@435 112
duke@435 113 // flushing
duke@435 114 virtual void flush() {}
duke@435 115 virtual void write(const char* str, size_t len) = 0;
minqi@2964 116 virtual void rotate_log() {} // GC log rotation
minqi@2964 117 virtual ~outputStream() {} // close properly on deletion
duke@435 118
duke@435 119 void dec_cr() { dec(); cr(); }
duke@435 120 void inc_cr() { inc(); cr(); }
duke@435 121 };
duke@435 122
duke@435 123 // standard output
minqi@2964 124 // ANSI C++ name collision
duke@435 125 extern outputStream* tty; // tty output
duke@435 126 extern outputStream* gclog_or_tty; // stream for gc log if -Xloggc:<f>, or tty
duke@435 127
kamg@3992 128 class streamIndentor : public StackObj {
kamg@3992 129 private:
kamg@3992 130 outputStream* _str;
kamg@3992 131 int _amount;
kamg@3992 132
kamg@3992 133 public:
kamg@3992 134 streamIndentor(outputStream* str, int amt = 2) : _str(str), _amount(amt) {
kamg@3992 135 _str->inc(_amount);
kamg@3992 136 }
kamg@3992 137 ~streamIndentor() { _str->dec(_amount); }
kamg@3992 138 };
kamg@3992 139
kamg@3992 140
duke@435 141 // advisory locking for the shared tty stream:
duke@435 142 class ttyLocker: StackObj {
never@2570 143 friend class ttyUnlocker;
duke@435 144 private:
duke@435 145 intx _holder;
duke@435 146
duke@435 147 public:
duke@435 148 static intx hold_tty(); // returns a "holder" token
duke@435 149 static void release_tty(intx holder); // must witness same token
never@2570 150 static bool release_tty_if_locked(); // returns true if lock was released
duke@435 151 static void break_tty_lock_for_safepoint(intx holder);
duke@435 152
duke@435 153 ttyLocker() { _holder = hold_tty(); }
duke@435 154 ~ttyLocker() { release_tty(_holder); }
duke@435 155 };
duke@435 156
never@2570 157 // Release the tty lock if it's held and reacquire it if it was
never@2570 158 // locked. Used to avoid lock ordering problems.
never@2570 159 class ttyUnlocker: StackObj {
never@2570 160 private:
never@2570 161 bool _was_locked;
never@2570 162 public:
never@2570 163 ttyUnlocker() {
never@2570 164 _was_locked = ttyLocker::release_tty_if_locked();
never@2570 165 }
never@2570 166 ~ttyUnlocker() {
never@2570 167 if (_was_locked) {
never@2570 168 ttyLocker::hold_tty();
never@2570 169 }
never@2570 170 }
never@2570 171 };
never@2570 172
duke@435 173 // for writing to strings; buffer will expand automatically
duke@435 174 class stringStream : public outputStream {
duke@435 175 protected:
duke@435 176 char* buffer;
duke@435 177 size_t buffer_pos;
duke@435 178 size_t buffer_length;
duke@435 179 bool buffer_fixed;
duke@435 180 public:
duke@435 181 stringStream(size_t initial_bufsize = 256);
duke@435 182 stringStream(char* fixed_buffer, size_t fixed_buffer_size);
duke@435 183 ~stringStream();
duke@435 184 virtual void write(const char* c, size_t len);
duke@435 185 size_t size() { return buffer_pos; }
duke@435 186 const char* base() { return buffer; }
duke@435 187 void reset() { buffer_pos = 0; _precount = 0; _position = 0; }
duke@435 188 char* as_string();
duke@435 189 };
duke@435 190
duke@435 191 class fileStream : public outputStream {
duke@435 192 protected:
duke@435 193 FILE* _file;
duke@435 194 bool _need_close;
duke@435 195 public:
minqi@2964 196 fileStream() { _file = NULL; _need_close = false; }
duke@435 197 fileStream(const char* file_name);
kamg@2515 198 fileStream(const char* file_name, const char* opentype);
vlivanov@5027 199 fileStream(FILE* file, bool need_close = false) { _file = file; _need_close = need_close; }
duke@435 200 ~fileStream();
duke@435 201 bool is_open() const { return _file != NULL; }
kamg@2515 202 void set_need_close(bool b) { _need_close = b;}
duke@435 203 virtual void write(const char* c, size_t len);
kamg@2515 204 size_t read(void *data, size_t size, size_t count) { return ::fread(data, size, count, _file); }
kamg@2515 205 char* readln(char *data, int count);
kamg@2515 206 int eof() { return feof(_file); }
kamg@2515 207 long fileSize();
kamg@2515 208 void rewind() { ::rewind(_file); }
duke@435 209 void flush();
duke@435 210 };
duke@435 211
duke@435 212 // unlike fileStream, fdStream does unbuffered I/O by calling
duke@435 213 // open() and write() directly. It is async-safe, but output
duke@435 214 // from multiple thread may be mixed together. Used by fatal
duke@435 215 // error handler.
duke@435 216 class fdStream : public outputStream {
duke@435 217 protected:
duke@435 218 int _fd;
duke@435 219 bool _need_close;
duke@435 220 public:
duke@435 221 fdStream(const char* file_name);
duke@435 222 fdStream(int fd = -1) { _fd = fd; _need_close = false; }
duke@435 223 ~fdStream();
duke@435 224 bool is_open() const { return _fd != -1; }
duke@435 225 void set_fd(int fd) { _fd = fd; _need_close = false; }
duke@435 226 int fd() const { return _fd; }
duke@435 227 virtual void write(const char* c, size_t len);
duke@435 228 void flush() {};
duke@435 229 };
duke@435 230
minqi@2964 231 class rotatingFileStream : public fileStream {
minqi@2964 232 protected:
minqi@2964 233 char* _file_name;
jwilhelm@4647 234 jlong _bytes_written;
minqi@2964 235 uintx _cur_file_num; // current logfile rotation number, from 0 to MaxGCLogFileNumbers-1
minqi@2964 236 public:
minqi@2964 237 rotatingFileStream(const char* file_name);
minqi@2964 238 rotatingFileStream(const char* file_name, const char* opentype);
minqi@2964 239 rotatingFileStream(FILE* file) : fileStream(file) {}
minqi@2964 240 ~rotatingFileStream();
minqi@2964 241 virtual void write(const char* c, size_t len);
minqi@2964 242 virtual void rotate_log();
minqi@2964 243 };
minqi@2964 244
duke@435 245 void ostream_init();
duke@435 246 void ostream_init_log();
duke@435 247 void ostream_exit();
duke@435 248 void ostream_abort();
duke@435 249
duke@435 250 // staticBufferStream uses a user-supplied buffer for all formatting.
duke@435 251 // Used for safe formatting during fatal error handling. Not MT safe.
duke@435 252 // Do not share the stream between multiple threads.
duke@435 253 class staticBufferStream : public outputStream {
duke@435 254 private:
duke@435 255 char* _buffer;
duke@435 256 size_t _buflen;
duke@435 257 outputStream* _outer_stream;
duke@435 258 public:
duke@435 259 staticBufferStream(char* buffer, size_t buflen,
duke@435 260 outputStream *outer_stream);
duke@435 261 ~staticBufferStream() {};
duke@435 262 virtual void write(const char* c, size_t len);
duke@435 263 void flush();
duke@435 264 void print(const char* format, ...);
duke@435 265 void print_cr(const char* format, ...);
duke@435 266 void vprint(const char *format, va_list argptr);
duke@435 267 void vprint_cr(const char* format, va_list argptr);
duke@435 268 };
duke@435 269
duke@435 270 // In the non-fixed buffer case an underlying buffer will be created and
duke@435 271 // managed in C heap. Not MT-safe.
duke@435 272 class bufferedStream : public outputStream {
duke@435 273 protected:
duke@435 274 char* buffer;
duke@435 275 size_t buffer_pos;
never@657 276 size_t buffer_max;
duke@435 277 size_t buffer_length;
duke@435 278 bool buffer_fixed;
duke@435 279 public:
never@657 280 bufferedStream(size_t initial_bufsize = 256, size_t bufmax = 1024*1024*10);
never@657 281 bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax = 1024*1024*10);
duke@435 282 ~bufferedStream();
duke@435 283 virtual void write(const char* c, size_t len);
duke@435 284 size_t size() { return buffer_pos; }
duke@435 285 const char* base() { return buffer; }
duke@435 286 void reset() { buffer_pos = 0; _precount = 0; _position = 0; }
duke@435 287 char* as_string();
duke@435 288 };
duke@435 289
duke@435 290 #define O_BUFLEN 2000 // max size of output of individual print() methods
duke@435 291
duke@435 292 #ifndef PRODUCT
duke@435 293
duke@435 294 class networkStream : public bufferedStream {
duke@435 295
duke@435 296 private:
duke@435 297 int _socket;
duke@435 298
duke@435 299 public:
duke@435 300 networkStream();
duke@435 301 ~networkStream();
duke@435 302
duke@435 303 bool connect(const char *host, short port);
duke@435 304 bool is_open() const { return _socket != -1; }
duke@435 305 int read(char *buf, size_t len);
duke@435 306 void close();
duke@435 307 virtual void flush();
duke@435 308 };
duke@435 309
duke@435 310 #endif
stefank@2314 311
stefank@2314 312 #endif // SHARE_VM_UTILITIES_OSTREAM_HPP

mercurial