Mon, 16 Sep 2013 15:35:04 -0700
7164841: Improvements to the GC log file rotation
Summary: made changes to easily identify current log file in rotation. Parameterize the input with %t for time replacement in file name.
Reviewed-by: ccheung, tschatzl, tamao, zgu
Contributed-by: yumin.qi@oracle.com
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 | |
fparain@5409 | 31 | DEBUG_ONLY(class ResourceMark;) |
fparain@5409 | 32 | |
duke@435 | 33 | // Output streams for printing |
duke@435 | 34 | // |
duke@435 | 35 | // Printing guidelines: |
duke@435 | 36 | // Where possible, please use tty->print() and tty->print_cr(). |
duke@435 | 37 | // For product mode VM warnings use warning() which internally uses tty. |
duke@435 | 38 | // In places where tty is not initialized yet or too much overhead, |
duke@435 | 39 | // we may use jio_printf: |
duke@435 | 40 | // jio_fprintf(defaultStream::output_stream(), "Message"); |
duke@435 | 41 | // This allows for redirection via -XX:+DisplayVMOutputToStdout and |
duke@435 | 42 | // -XX:+DisplayVMOutputToStderr |
duke@435 | 43 | class outputStream : public ResourceObj { |
duke@435 | 44 | protected: |
duke@435 | 45 | int _indentation; // current indentation |
duke@435 | 46 | int _width; // width of the page |
duke@435 | 47 | int _position; // position on the current line |
duke@435 | 48 | int _newlines; // number of '\n' output so far |
duke@435 | 49 | julong _precount; // number of chars output, less _position |
duke@435 | 50 | TimeStamp _stamp; // for time stamps |
duke@435 | 51 | |
duke@435 | 52 | void update_position(const char* s, size_t len); |
duke@435 | 53 | static const char* do_vsnprintf(char* buffer, size_t buflen, |
duke@435 | 54 | const char* format, va_list ap, |
duke@435 | 55 | bool add_cr, |
duke@435 | 56 | size_t& result_len); |
duke@435 | 57 | |
duke@435 | 58 | public: |
duke@435 | 59 | // creation |
duke@435 | 60 | outputStream(int width = 80); |
duke@435 | 61 | outputStream(int width, bool has_time_stamps); |
duke@435 | 62 | |
duke@435 | 63 | // indentation |
kamg@3992 | 64 | outputStream& indent(); |
duke@435 | 65 | void inc() { _indentation++; }; |
duke@435 | 66 | void dec() { _indentation--; }; |
kamg@3992 | 67 | void inc(int n) { _indentation += n; }; |
kamg@3992 | 68 | void dec(int n) { _indentation -= n; }; |
duke@435 | 69 | int indentation() const { return _indentation; } |
duke@435 | 70 | void set_indentation(int i) { _indentation = i; } |
duke@435 | 71 | void fill_to(int col); |
jrose@535 | 72 | void move_to(int col, int slop = 6, int min_space = 2); |
duke@435 | 73 | |
duke@435 | 74 | // sizing |
duke@435 | 75 | int width() const { return _width; } |
duke@435 | 76 | int position() const { return _position; } |
duke@435 | 77 | int newlines() const { return _newlines; } |
duke@435 | 78 | julong count() const { return _precount + _position; } |
duke@435 | 79 | void set_count(julong count) { _precount = count - _position; } |
duke@435 | 80 | void set_position(int pos) { _position = pos; } |
duke@435 | 81 | |
duke@435 | 82 | // printing |
duke@435 | 83 | void print(const char* format, ...); |
duke@435 | 84 | void print_cr(const char* format, ...); |
duke@435 | 85 | void vprint(const char *format, va_list argptr); |
duke@435 | 86 | void vprint_cr(const char* format, va_list argptr); |
duke@435 | 87 | void print_raw(const char* str) { write(str, strlen(str)); } |
duke@435 | 88 | void print_raw(const char* str, int len) { write(str, len); } |
duke@435 | 89 | void print_raw_cr(const char* str) { write(str, strlen(str)); cr(); } |
duke@435 | 90 | void print_raw_cr(const char* str, int len){ write(str, len); cr(); } |
kamg@3992 | 91 | void print_data(void* data, size_t len, bool with_ascii); |
duke@435 | 92 | void put(char ch); |
jrose@535 | 93 | void sp(int count = 1); |
duke@435 | 94 | void cr(); |
duke@435 | 95 | void bol() { if (_position > 0) cr(); } |
duke@435 | 96 | |
duke@435 | 97 | // Time stamp |
duke@435 | 98 | TimeStamp& time_stamp() { return _stamp; } |
duke@435 | 99 | void stamp(); |
ysr@777 | 100 | void stamp(bool guard, const char* prefix, const char* suffix); |
ysr@777 | 101 | void stamp(bool guard) { |
ysr@777 | 102 | stamp(guard, "", ": "); |
ysr@777 | 103 | } |
duke@435 | 104 | // Date stamp |
duke@435 | 105 | void date_stamp(bool guard, const char* prefix, const char* suffix); |
duke@435 | 106 | // A simplified call that includes a suffix of ": " |
duke@435 | 107 | void date_stamp(bool guard) { |
duke@435 | 108 | date_stamp(guard, "", ": "); |
duke@435 | 109 | } |
duke@435 | 110 | |
duke@435 | 111 | // portable printing of 64 bit integers |
duke@435 | 112 | void print_jlong(jlong value); |
duke@435 | 113 | void print_julong(julong value); |
duke@435 | 114 | |
duke@435 | 115 | // flushing |
duke@435 | 116 | virtual void flush() {} |
duke@435 | 117 | virtual void write(const char* str, size_t len) = 0; |
minqi@2964 | 118 | virtual void rotate_log() {} // GC log rotation |
minqi@2964 | 119 | virtual ~outputStream() {} // close properly on deletion |
duke@435 | 120 | |
duke@435 | 121 | void dec_cr() { dec(); cr(); } |
duke@435 | 122 | void inc_cr() { inc(); cr(); } |
duke@435 | 123 | }; |
duke@435 | 124 | |
duke@435 | 125 | // standard output |
minqi@2964 | 126 | // ANSI C++ name collision |
duke@435 | 127 | extern outputStream* tty; // tty output |
duke@435 | 128 | extern outputStream* gclog_or_tty; // stream for gc log if -Xloggc:<f>, or tty |
duke@435 | 129 | |
kamg@3992 | 130 | class streamIndentor : public StackObj { |
kamg@3992 | 131 | private: |
kamg@3992 | 132 | outputStream* _str; |
kamg@3992 | 133 | int _amount; |
kamg@3992 | 134 | |
kamg@3992 | 135 | public: |
kamg@3992 | 136 | streamIndentor(outputStream* str, int amt = 2) : _str(str), _amount(amt) { |
kamg@3992 | 137 | _str->inc(_amount); |
kamg@3992 | 138 | } |
kamg@3992 | 139 | ~streamIndentor() { _str->dec(_amount); } |
kamg@3992 | 140 | }; |
kamg@3992 | 141 | |
kamg@3992 | 142 | |
duke@435 | 143 | // advisory locking for the shared tty stream: |
duke@435 | 144 | class ttyLocker: StackObj { |
never@2570 | 145 | friend class ttyUnlocker; |
duke@435 | 146 | private: |
duke@435 | 147 | intx _holder; |
duke@435 | 148 | |
duke@435 | 149 | public: |
duke@435 | 150 | static intx hold_tty(); // returns a "holder" token |
duke@435 | 151 | static void release_tty(intx holder); // must witness same token |
never@2570 | 152 | static bool release_tty_if_locked(); // returns true if lock was released |
duke@435 | 153 | static void break_tty_lock_for_safepoint(intx holder); |
duke@435 | 154 | |
duke@435 | 155 | ttyLocker() { _holder = hold_tty(); } |
duke@435 | 156 | ~ttyLocker() { release_tty(_holder); } |
duke@435 | 157 | }; |
duke@435 | 158 | |
never@2570 | 159 | // Release the tty lock if it's held and reacquire it if it was |
never@2570 | 160 | // locked. Used to avoid lock ordering problems. |
never@2570 | 161 | class ttyUnlocker: StackObj { |
never@2570 | 162 | private: |
never@2570 | 163 | bool _was_locked; |
never@2570 | 164 | public: |
never@2570 | 165 | ttyUnlocker() { |
never@2570 | 166 | _was_locked = ttyLocker::release_tty_if_locked(); |
never@2570 | 167 | } |
never@2570 | 168 | ~ttyUnlocker() { |
never@2570 | 169 | if (_was_locked) { |
never@2570 | 170 | ttyLocker::hold_tty(); |
never@2570 | 171 | } |
never@2570 | 172 | } |
never@2570 | 173 | }; |
never@2570 | 174 | |
duke@435 | 175 | // for writing to strings; buffer will expand automatically |
duke@435 | 176 | class stringStream : public outputStream { |
duke@435 | 177 | protected: |
duke@435 | 178 | char* buffer; |
duke@435 | 179 | size_t buffer_pos; |
duke@435 | 180 | size_t buffer_length; |
duke@435 | 181 | bool buffer_fixed; |
fparain@5409 | 182 | DEBUG_ONLY(ResourceMark* rm;) |
duke@435 | 183 | public: |
duke@435 | 184 | stringStream(size_t initial_bufsize = 256); |
duke@435 | 185 | stringStream(char* fixed_buffer, size_t fixed_buffer_size); |
duke@435 | 186 | ~stringStream(); |
duke@435 | 187 | virtual void write(const char* c, size_t len); |
duke@435 | 188 | size_t size() { return buffer_pos; } |
duke@435 | 189 | const char* base() { return buffer; } |
duke@435 | 190 | void reset() { buffer_pos = 0; _precount = 0; _position = 0; } |
duke@435 | 191 | char* as_string(); |
duke@435 | 192 | }; |
duke@435 | 193 | |
duke@435 | 194 | class fileStream : public outputStream { |
duke@435 | 195 | protected: |
duke@435 | 196 | FILE* _file; |
duke@435 | 197 | bool _need_close; |
duke@435 | 198 | public: |
minqi@2964 | 199 | fileStream() { _file = NULL; _need_close = false; } |
duke@435 | 200 | fileStream(const char* file_name); |
kamg@2515 | 201 | fileStream(const char* file_name, const char* opentype); |
vlivanov@5027 | 202 | fileStream(FILE* file, bool need_close = false) { _file = file; _need_close = need_close; } |
duke@435 | 203 | ~fileStream(); |
duke@435 | 204 | bool is_open() const { return _file != NULL; } |
kamg@2515 | 205 | void set_need_close(bool b) { _need_close = b;} |
duke@435 | 206 | virtual void write(const char* c, size_t len); |
kamg@2515 | 207 | size_t read(void *data, size_t size, size_t count) { return ::fread(data, size, count, _file); } |
kamg@2515 | 208 | char* readln(char *data, int count); |
kamg@2515 | 209 | int eof() { return feof(_file); } |
kamg@2515 | 210 | long fileSize(); |
kamg@2515 | 211 | void rewind() { ::rewind(_file); } |
duke@435 | 212 | void flush(); |
duke@435 | 213 | }; |
duke@435 | 214 | |
duke@435 | 215 | // unlike fileStream, fdStream does unbuffered I/O by calling |
duke@435 | 216 | // open() and write() directly. It is async-safe, but output |
duke@435 | 217 | // from multiple thread may be mixed together. Used by fatal |
duke@435 | 218 | // error handler. |
duke@435 | 219 | class fdStream : public outputStream { |
duke@435 | 220 | protected: |
duke@435 | 221 | int _fd; |
duke@435 | 222 | bool _need_close; |
duke@435 | 223 | public: |
duke@435 | 224 | fdStream(const char* file_name); |
duke@435 | 225 | fdStream(int fd = -1) { _fd = fd; _need_close = false; } |
duke@435 | 226 | ~fdStream(); |
duke@435 | 227 | bool is_open() const { return _fd != -1; } |
duke@435 | 228 | void set_fd(int fd) { _fd = fd; _need_close = false; } |
duke@435 | 229 | int fd() const { return _fd; } |
duke@435 | 230 | virtual void write(const char* c, size_t len); |
duke@435 | 231 | void flush() {}; |
duke@435 | 232 | }; |
duke@435 | 233 | |
minqi@5683 | 234 | class gcLogFileStream : public fileStream { |
minqi@2964 | 235 | protected: |
minqi@5683 | 236 | const char* _file_name; |
jwilhelm@4647 | 237 | jlong _bytes_written; |
minqi@5683 | 238 | uintx _cur_file_num; // current logfile rotation number, from 0 to NumberOfGCLogFiles-1 |
minqi@2964 | 239 | public: |
minqi@5683 | 240 | gcLogFileStream(const char* file_name); |
minqi@5683 | 241 | ~gcLogFileStream(); |
minqi@2964 | 242 | virtual void write(const char* c, size_t len); |
minqi@2964 | 243 | virtual void rotate_log(); |
minqi@5683 | 244 | void dump_loggc_header(); |
minqi@2964 | 245 | }; |
minqi@2964 | 246 | |
minqi@5683 | 247 | #ifndef PRODUCT |
minqi@5683 | 248 | // unit test for checking -Xloggc:<filename> parsing result |
minqi@5683 | 249 | void test_loggc_filename(); |
minqi@5683 | 250 | #endif |
minqi@5683 | 251 | |
duke@435 | 252 | void ostream_init(); |
duke@435 | 253 | void ostream_init_log(); |
duke@435 | 254 | void ostream_exit(); |
duke@435 | 255 | void ostream_abort(); |
duke@435 | 256 | |
duke@435 | 257 | // staticBufferStream uses a user-supplied buffer for all formatting. |
duke@435 | 258 | // Used for safe formatting during fatal error handling. Not MT safe. |
duke@435 | 259 | // Do not share the stream between multiple threads. |
duke@435 | 260 | class staticBufferStream : public outputStream { |
duke@435 | 261 | private: |
duke@435 | 262 | char* _buffer; |
duke@435 | 263 | size_t _buflen; |
duke@435 | 264 | outputStream* _outer_stream; |
duke@435 | 265 | public: |
duke@435 | 266 | staticBufferStream(char* buffer, size_t buflen, |
duke@435 | 267 | outputStream *outer_stream); |
duke@435 | 268 | ~staticBufferStream() {}; |
duke@435 | 269 | virtual void write(const char* c, size_t len); |
duke@435 | 270 | void flush(); |
duke@435 | 271 | void print(const char* format, ...); |
duke@435 | 272 | void print_cr(const char* format, ...); |
duke@435 | 273 | void vprint(const char *format, va_list argptr); |
duke@435 | 274 | void vprint_cr(const char* format, va_list argptr); |
duke@435 | 275 | }; |
duke@435 | 276 | |
duke@435 | 277 | // In the non-fixed buffer case an underlying buffer will be created and |
duke@435 | 278 | // managed in C heap. Not MT-safe. |
duke@435 | 279 | class bufferedStream : public outputStream { |
duke@435 | 280 | protected: |
duke@435 | 281 | char* buffer; |
duke@435 | 282 | size_t buffer_pos; |
never@657 | 283 | size_t buffer_max; |
duke@435 | 284 | size_t buffer_length; |
duke@435 | 285 | bool buffer_fixed; |
duke@435 | 286 | public: |
never@657 | 287 | bufferedStream(size_t initial_bufsize = 256, size_t bufmax = 1024*1024*10); |
never@657 | 288 | bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax = 1024*1024*10); |
duke@435 | 289 | ~bufferedStream(); |
duke@435 | 290 | virtual void write(const char* c, size_t len); |
duke@435 | 291 | size_t size() { return buffer_pos; } |
duke@435 | 292 | const char* base() { return buffer; } |
duke@435 | 293 | void reset() { buffer_pos = 0; _precount = 0; _position = 0; } |
duke@435 | 294 | char* as_string(); |
duke@435 | 295 | }; |
duke@435 | 296 | |
duke@435 | 297 | #define O_BUFLEN 2000 // max size of output of individual print() methods |
duke@435 | 298 | |
duke@435 | 299 | #ifndef PRODUCT |
duke@435 | 300 | |
duke@435 | 301 | class networkStream : public bufferedStream { |
duke@435 | 302 | |
duke@435 | 303 | private: |
duke@435 | 304 | int _socket; |
duke@435 | 305 | |
duke@435 | 306 | public: |
duke@435 | 307 | networkStream(); |
duke@435 | 308 | ~networkStream(); |
duke@435 | 309 | |
duke@435 | 310 | bool connect(const char *host, short port); |
duke@435 | 311 | bool is_open() const { return _socket != -1; } |
duke@435 | 312 | int read(char *buf, size_t len); |
duke@435 | 313 | void close(); |
duke@435 | 314 | virtual void flush(); |
duke@435 | 315 | }; |
duke@435 | 316 | |
duke@435 | 317 | #endif |
stefank@2314 | 318 | |
stefank@2314 | 319 | #endif // SHARE_VM_UTILITIES_OSTREAM_HPP |