1 /* 2 * Copyright (c) 1997, 2014, 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_DEBUG_HPP 26 #define SHARE_VM_UTILITIES_DEBUG_HPP 27 28 #include "utilities/globalDefinitions.hpp" 29 #include "prims/jvm.h" 30 31 #include <stdarg.h> 32 33 // Simple class to format the ctor arguments into a fixed-sized buffer. 34 class FormatBufferBase { 35 protected: 36 char* _buf; 37 inline FormatBufferBase(char* buf) : _buf(buf) {} 38 public: 39 operator const char *() const { return _buf; } 40 }; 41 42 // Use resource area for buffer 43 #define RES_BUFSZ 256 44 class FormatBufferResource : public FormatBufferBase { 45 public: 46 FormatBufferResource(const char * format, ...) ATTRIBUTE_PRINTF(2, 3); 47 }; 48 49 // Use stack for buffer 50 template <size_t bufsz = 256> 51 class FormatBuffer : public FormatBufferBase { 52 public: 53 inline FormatBuffer(const char * format, ...) ATTRIBUTE_PRINTF(2, 3); 54 inline void append(const char* format, ...) ATTRIBUTE_PRINTF(2, 3); 55 inline void print(const char* format, ...) ATTRIBUTE_PRINTF(2, 3); 56 inline void printv(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0); 57 58 char* buffer() { return _buf; } 59 int size() { return bufsz; } 60 61 private: 62 FormatBuffer(const FormatBuffer &); // prevent copies 63 char _buffer[bufsz]; 64 65 protected: 66 inline FormatBuffer(); 67 }; 68 69 template <size_t bufsz> 70 FormatBuffer<bufsz>::FormatBuffer(const char * format, ...) : FormatBufferBase(_buffer) { 71 va_list argp; 72 va_start(argp, format); 73 jio_vsnprintf(_buf, bufsz, format, argp); 74 va_end(argp); 75 } 76 77 template <size_t bufsz> 78 FormatBuffer<bufsz>::FormatBuffer() : FormatBufferBase(_buffer) { 79 _buf[0] = '\0'; 80 } 81 82 template <size_t bufsz> 83 void FormatBuffer<bufsz>::print(const char * format, ...) { 84 va_list argp; 85 va_start(argp, format); 86 jio_vsnprintf(_buf, bufsz, format, argp); 87 va_end(argp); 88 } 89 90 template <size_t bufsz> 91 void FormatBuffer<bufsz>::printv(const char * format, va_list argp) { 92 jio_vsnprintf(_buf, bufsz, format, argp); 93 } 94 95 template <size_t bufsz> 96 void FormatBuffer<bufsz>::append(const char* format, ...) { 97 // Given that the constructor does a vsnprintf we can assume that 98 // _buf is already initialized. 99 size_t len = strlen(_buf); 100 char* buf_end = _buf + len; 101 102 va_list argp; 103 va_start(argp, format); 104 jio_vsnprintf(buf_end, bufsz - len, format, argp); 105 va_end(argp); 106 } 107 108 // Used to format messages for assert(), guarantee(), fatal(), etc. 109 typedef FormatBuffer<> err_msg; 110 typedef FormatBufferResource err_msg_res; 111 112 // assertions 113 #ifdef ASSERT 114 #ifndef USE_REPEATED_ASSERTS 115 #define assert(p, msg) \ 116 do { \ 117 if (!(p)) { \ 118 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \ 119 BREAKPOINT; \ 120 } \ 121 } while (0) 122 #else // #ifndef USE_REPEATED_ASSERTS 123 #define assert(p, msg) 124 do { \ 125 for (int __i = 0; __i < AssertRepeat; __i++) { \ 126 if (!(p)) { \ 127 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \ 128 BREAKPOINT; \ 129 } \ 130 } \ 131 } while (0) 132 #endif // #ifndef USE_REPEATED_ASSERTS 133 134 // This version of assert is for use with checking return status from 135 // library calls that return actual error values eg. EINVAL, 136 // ENOMEM etc, rather than returning -1 and setting errno. 137 // When the status is not what is expected it is very useful to know 138 // what status was actually returned, so we pass the status variable as 139 // an extra arg and use strerror to convert it to a meaningful string 140 // like "Invalid argument", "out of memory" etc 141 #define assert_status(p, status, msg) \ 142 do { \ 143 if (!(p)) { \ 144 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", \ 145 err_msg("error %s(%d) %s", strerror(status), \ 146 status, msg)); \ 147 BREAKPOINT; \ 148 } \ 149 } while (0) 150 151 // Do not assert this condition if there's already another error reported. 152 #define assert_if_no_error(cond,msg) assert((cond) || is_error_reported(), msg) 153 #else // #ifdef ASSERT 154 #define assert(p,msg) 155 #define assert_status(p,status,msg) 156 #define assert_if_no_error(cond,msg) 157 #endif // #ifdef ASSERT 158 159 // guarantee is like assert except it's always executed -- use it for 160 // cheap tests that catch errors that would otherwise be hard to find. 161 // guarantee is also used for Verify options. 162 #define guarantee(p, msg) \ 163 do { \ 164 if (!(p)) { \ 165 report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", msg); \ 166 BREAKPOINT; \ 167 } \ 168 } while (0) 169 170 #define fatal(msg) \ 171 do { \ 172 report_fatal(__FILE__, __LINE__, msg); \ 173 BREAKPOINT; \ 174 } while (0) 175 176 // out of memory 177 #define vm_exit_out_of_memory(size, vm_err_type, msg) \ 178 do { \ 179 report_vm_out_of_memory(__FILE__, __LINE__, size, vm_err_type, msg); \ 180 BREAKPOINT; \ 181 } while (0) 182 183 #define ShouldNotCallThis() \ 184 do { \ 185 report_should_not_call(__FILE__, __LINE__); \ 186 BREAKPOINT; \ 187 } while (0) 188 189 #define ShouldNotReachHere() \ 190 do { \ 191 report_should_not_reach_here(__FILE__, __LINE__); \ 192 BREAKPOINT; \ 193 } while (0) 194 195 #define Unimplemented() \ 196 do { \ 197 report_unimplemented(__FILE__, __LINE__); \ 198 BREAKPOINT; \ 199 } while (0) 200 201 #define Untested(msg) \ 202 do { \ 203 report_untested(__FILE__, __LINE__, msg); \ 204 BREAKPOINT; \ 205 } while (0); 206 207 208 // types of VM error - originally in vmError.hpp 209 enum VMErrorType { 210 INTERNAL_ERROR = 0xe0000000, 211 OOM_MALLOC_ERROR = 0xe0000001, 212 OOM_MMAP_ERROR = 0xe0000002 213 }; 214 215 // error reporting helper functions 216 void report_vm_error(const char* file, int line, const char* error_msg, 217 const char* detail_msg = NULL); 218 void report_fatal(const char* file, int line, const char* message); 219 void report_vm_out_of_memory(const char* file, int line, size_t size, 220 VMErrorType vm_err_type, const char* message); 221 void report_should_not_call(const char* file, int line); 222 void report_should_not_reach_here(const char* file, int line); 223 void report_unimplemented(const char* file, int line); 224 void report_untested(const char* file, int line, const char* message); 225 226 void warning(const char* format, ...) ATTRIBUTE_PRINTF(1, 2); 227 228 #ifdef ASSERT 229 // Compile-time asserts. 230 template <bool> struct StaticAssert; 231 template <> struct StaticAssert<true> {}; 232 233 // Only StaticAssert<true> is defined, so if cond evaluates to false we get 234 // a compile time exception when trying to use StaticAssert<false>. 235 #define STATIC_ASSERT(cond) \ 236 do { \ 237 StaticAssert<(cond)> DUMMY_STATIC_ASSERT; \ 238 (void)DUMMY_STATIC_ASSERT; /* ignore */ \ 239 } while (false) 240 #else 241 #define STATIC_ASSERT(cond) 242 #endif 243 244 // out of shared space reporting 245 enum SharedSpaceType { 246 SharedReadOnly, 247 SharedReadWrite, 248 SharedMiscData, 249 SharedMiscCode 250 }; 251 252 void report_out_of_shared_space(SharedSpaceType space_type); 253 254 // out of memory reporting 255 void report_java_out_of_memory(const char* message); 256 257 // Support for self-destruct 258 bool is_error_reported(); 259 void set_error_reported(); 260 261 /* Test assert(), fatal(), guarantee(), etc. */ 262 NOT_PRODUCT(void test_error_handler();) 263 264 // crash in a controlled way: 265 // how can be one of: 266 // 1,2 - asserts 267 // 3,4 - guarantee 268 // 5-7 - fatal 269 // 8 - vm_exit_out_of_memory 270 // 9 - ShouldNotCallThis 271 // 10 - ShouldNotReachHere 272 // 11 - Unimplemented 273 // 12,13 - (not guaranteed) crashes 274 // 14 - SIGSEGV 275 // 15 - SIGILL 276 NOT_PRODUCT(void controlled_crash(int how);) 277 278 // returns an address which is guaranteed to generate a SIGSEGV on read, 279 // for test purposes, which is not NULL and contains bits in every word 280 NOT_PRODUCT(void* get_segfault_address();) 281 282 // return an instruction which will generate a SIGILL 283 NOT_PRODUCT(bool get_illegal_instruction_sequence(uint8_t buf[8]);) 284 285 void pd_ps(frame f); 286 void pd_obfuscate_location(char *buf, size_t buflen); 287 288 class outputStream; 289 void print_native_stack(outputStream* st, frame fr, Thread* t, char* buf, int buf_size); 290 291 #endif // SHARE_VM_UTILITIES_DEBUG_HPP