Tue, 23 Nov 2010 13:22:55 -0800
6989984: Use standard include model for Hospot
Summary: Replaced MakeDeps and the includeDB files with more standardized solutions.
Reviewed-by: coleenp, kvn, kamg
duke@435 | 1 | /* |
stefank@2314 | 2 | * Copyright (c) 1997, 2010, 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 |
duke@435 | 62 | void indent(); |
duke@435 | 63 | void inc() { _indentation++; }; |
duke@435 | 64 | void dec() { _indentation--; }; |
duke@435 | 65 | int indentation() const { return _indentation; } |
duke@435 | 66 | void set_indentation(int i) { _indentation = i; } |
duke@435 | 67 | void fill_to(int col); |
jrose@535 | 68 | void move_to(int col, int slop = 6, int min_space = 2); |
duke@435 | 69 | |
duke@435 | 70 | // sizing |
duke@435 | 71 | int width() const { return _width; } |
duke@435 | 72 | int position() const { return _position; } |
duke@435 | 73 | int newlines() const { return _newlines; } |
duke@435 | 74 | julong count() const { return _precount + _position; } |
duke@435 | 75 | void set_count(julong count) { _precount = count - _position; } |
duke@435 | 76 | void set_position(int pos) { _position = pos; } |
duke@435 | 77 | |
duke@435 | 78 | // printing |
duke@435 | 79 | void print(const char* format, ...); |
duke@435 | 80 | void print_cr(const char* format, ...); |
duke@435 | 81 | void vprint(const char *format, va_list argptr); |
duke@435 | 82 | void vprint_cr(const char* format, va_list argptr); |
duke@435 | 83 | void print_raw(const char* str) { write(str, strlen(str)); } |
duke@435 | 84 | void print_raw(const char* str, int len) { write(str, len); } |
duke@435 | 85 | void print_raw_cr(const char* str) { write(str, strlen(str)); cr(); } |
duke@435 | 86 | void print_raw_cr(const char* str, int len){ write(str, len); cr(); } |
duke@435 | 87 | void put(char ch); |
jrose@535 | 88 | void sp(int count = 1); |
duke@435 | 89 | void cr(); |
duke@435 | 90 | void bol() { if (_position > 0) cr(); } |
duke@435 | 91 | |
duke@435 | 92 | // Time stamp |
duke@435 | 93 | TimeStamp& time_stamp() { return _stamp; } |
duke@435 | 94 | void stamp(); |
ysr@777 | 95 | void stamp(bool guard, const char* prefix, const char* suffix); |
ysr@777 | 96 | void stamp(bool guard) { |
ysr@777 | 97 | stamp(guard, "", ": "); |
ysr@777 | 98 | } |
duke@435 | 99 | // Date stamp |
duke@435 | 100 | void date_stamp(bool guard, const char* prefix, const char* suffix); |
duke@435 | 101 | // A simplified call that includes a suffix of ": " |
duke@435 | 102 | void date_stamp(bool guard) { |
duke@435 | 103 | date_stamp(guard, "", ": "); |
duke@435 | 104 | } |
duke@435 | 105 | |
duke@435 | 106 | // portable printing of 64 bit integers |
duke@435 | 107 | void print_jlong(jlong value); |
duke@435 | 108 | void print_julong(julong value); |
duke@435 | 109 | |
duke@435 | 110 | // flushing |
duke@435 | 111 | virtual void flush() {} |
duke@435 | 112 | virtual void write(const char* str, size_t len) = 0; |
duke@435 | 113 | virtual ~outputStream() {} // close properly on deletion |
duke@435 | 114 | |
duke@435 | 115 | void dec_cr() { dec(); cr(); } |
duke@435 | 116 | void inc_cr() { inc(); cr(); } |
duke@435 | 117 | }; |
duke@435 | 118 | |
duke@435 | 119 | // standard output |
duke@435 | 120 | // ANSI C++ name collision |
duke@435 | 121 | extern outputStream* tty; // tty output |
duke@435 | 122 | extern outputStream* gclog_or_tty; // stream for gc log if -Xloggc:<f>, or tty |
duke@435 | 123 | |
duke@435 | 124 | // advisory locking for the shared tty stream: |
duke@435 | 125 | class ttyLocker: StackObj { |
duke@435 | 126 | private: |
duke@435 | 127 | intx _holder; |
duke@435 | 128 | |
duke@435 | 129 | public: |
duke@435 | 130 | static intx hold_tty(); // returns a "holder" token |
duke@435 | 131 | static void release_tty(intx holder); // must witness same token |
duke@435 | 132 | static void break_tty_lock_for_safepoint(intx holder); |
duke@435 | 133 | |
duke@435 | 134 | ttyLocker() { _holder = hold_tty(); } |
duke@435 | 135 | ~ttyLocker() { release_tty(_holder); } |
duke@435 | 136 | }; |
duke@435 | 137 | |
duke@435 | 138 | // for writing to strings; buffer will expand automatically |
duke@435 | 139 | class stringStream : public outputStream { |
duke@435 | 140 | protected: |
duke@435 | 141 | char* buffer; |
duke@435 | 142 | size_t buffer_pos; |
duke@435 | 143 | size_t buffer_length; |
duke@435 | 144 | bool buffer_fixed; |
duke@435 | 145 | public: |
duke@435 | 146 | stringStream(size_t initial_bufsize = 256); |
duke@435 | 147 | stringStream(char* fixed_buffer, size_t fixed_buffer_size); |
duke@435 | 148 | ~stringStream(); |
duke@435 | 149 | virtual void write(const char* c, size_t len); |
duke@435 | 150 | size_t size() { return buffer_pos; } |
duke@435 | 151 | const char* base() { return buffer; } |
duke@435 | 152 | void reset() { buffer_pos = 0; _precount = 0; _position = 0; } |
duke@435 | 153 | char* as_string(); |
duke@435 | 154 | }; |
duke@435 | 155 | |
duke@435 | 156 | class fileStream : public outputStream { |
duke@435 | 157 | protected: |
duke@435 | 158 | FILE* _file; |
duke@435 | 159 | bool _need_close; |
duke@435 | 160 | public: |
duke@435 | 161 | fileStream(const char* file_name); |
duke@435 | 162 | fileStream(FILE* file) { _file = file; _need_close = false; } |
duke@435 | 163 | ~fileStream(); |
duke@435 | 164 | bool is_open() const { return _file != NULL; } |
duke@435 | 165 | virtual void write(const char* c, size_t len); |
duke@435 | 166 | void flush(); |
duke@435 | 167 | }; |
duke@435 | 168 | |
duke@435 | 169 | // unlike fileStream, fdStream does unbuffered I/O by calling |
duke@435 | 170 | // open() and write() directly. It is async-safe, but output |
duke@435 | 171 | // from multiple thread may be mixed together. Used by fatal |
duke@435 | 172 | // error handler. |
duke@435 | 173 | class fdStream : public outputStream { |
duke@435 | 174 | protected: |
duke@435 | 175 | int _fd; |
duke@435 | 176 | bool _need_close; |
duke@435 | 177 | public: |
duke@435 | 178 | fdStream(const char* file_name); |
duke@435 | 179 | fdStream(int fd = -1) { _fd = fd; _need_close = false; } |
duke@435 | 180 | ~fdStream(); |
duke@435 | 181 | bool is_open() const { return _fd != -1; } |
duke@435 | 182 | void set_fd(int fd) { _fd = fd; _need_close = false; } |
duke@435 | 183 | int fd() const { return _fd; } |
duke@435 | 184 | virtual void write(const char* c, size_t len); |
duke@435 | 185 | void flush() {}; |
duke@435 | 186 | }; |
duke@435 | 187 | |
duke@435 | 188 | void ostream_init(); |
duke@435 | 189 | void ostream_init_log(); |
duke@435 | 190 | void ostream_exit(); |
duke@435 | 191 | void ostream_abort(); |
duke@435 | 192 | |
duke@435 | 193 | // staticBufferStream uses a user-supplied buffer for all formatting. |
duke@435 | 194 | // Used for safe formatting during fatal error handling. Not MT safe. |
duke@435 | 195 | // Do not share the stream between multiple threads. |
duke@435 | 196 | class staticBufferStream : public outputStream { |
duke@435 | 197 | private: |
duke@435 | 198 | char* _buffer; |
duke@435 | 199 | size_t _buflen; |
duke@435 | 200 | outputStream* _outer_stream; |
duke@435 | 201 | public: |
duke@435 | 202 | staticBufferStream(char* buffer, size_t buflen, |
duke@435 | 203 | outputStream *outer_stream); |
duke@435 | 204 | ~staticBufferStream() {}; |
duke@435 | 205 | virtual void write(const char* c, size_t len); |
duke@435 | 206 | void flush(); |
duke@435 | 207 | void print(const char* format, ...); |
duke@435 | 208 | void print_cr(const char* format, ...); |
duke@435 | 209 | void vprint(const char *format, va_list argptr); |
duke@435 | 210 | void vprint_cr(const char* format, va_list argptr); |
duke@435 | 211 | }; |
duke@435 | 212 | |
duke@435 | 213 | // In the non-fixed buffer case an underlying buffer will be created and |
duke@435 | 214 | // managed in C heap. Not MT-safe. |
duke@435 | 215 | class bufferedStream : public outputStream { |
duke@435 | 216 | protected: |
duke@435 | 217 | char* buffer; |
duke@435 | 218 | size_t buffer_pos; |
never@657 | 219 | size_t buffer_max; |
duke@435 | 220 | size_t buffer_length; |
duke@435 | 221 | bool buffer_fixed; |
duke@435 | 222 | public: |
never@657 | 223 | bufferedStream(size_t initial_bufsize = 256, size_t bufmax = 1024*1024*10); |
never@657 | 224 | bufferedStream(char* fixed_buffer, size_t fixed_buffer_size, size_t bufmax = 1024*1024*10); |
duke@435 | 225 | ~bufferedStream(); |
duke@435 | 226 | virtual void write(const char* c, size_t len); |
duke@435 | 227 | size_t size() { return buffer_pos; } |
duke@435 | 228 | const char* base() { return buffer; } |
duke@435 | 229 | void reset() { buffer_pos = 0; _precount = 0; _position = 0; } |
duke@435 | 230 | char* as_string(); |
duke@435 | 231 | }; |
duke@435 | 232 | |
duke@435 | 233 | #define O_BUFLEN 2000 // max size of output of individual print() methods |
duke@435 | 234 | |
duke@435 | 235 | #ifndef PRODUCT |
duke@435 | 236 | |
duke@435 | 237 | class networkStream : public bufferedStream { |
duke@435 | 238 | |
duke@435 | 239 | private: |
duke@435 | 240 | int _socket; |
duke@435 | 241 | |
duke@435 | 242 | public: |
duke@435 | 243 | networkStream(); |
duke@435 | 244 | ~networkStream(); |
duke@435 | 245 | |
duke@435 | 246 | bool connect(const char *host, short port); |
duke@435 | 247 | bool is_open() const { return _socket != -1; } |
duke@435 | 248 | int read(char *buf, size_t len); |
duke@435 | 249 | void close(); |
duke@435 | 250 | virtual void flush(); |
duke@435 | 251 | }; |
duke@435 | 252 | |
duke@435 | 253 | #endif |
stefank@2314 | 254 | |
stefank@2314 | 255 | #endif // SHARE_VM_UTILITIES_OSTREAM_HPP |