truffle: src/share/vm/utilities/debug.hpp annotate

annotate src/share/vm/utilities/debug.hpp @ 1490:f03d0a26bf83

6888954: argument formatting for assert() and friends Reviewed-by: kvn, twisti, apetrusenko, never, dcubed

author	jcoomes
date	Thu, 22 Apr 2010 13:23:15 -0700
parents	a61af66fc99e
children	c18cbe5936b8

rev	line source
0 a61af66fc99e Initial load duke parents: diff changeset	1 /*
a61af66fc99e Initial load duke parents: diff changeset	2 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
a61af66fc99e Initial load duke parents: diff changeset	3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load duke parents: diff changeset	4 *
a61af66fc99e Initial load duke parents: diff changeset	5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load duke parents: diff changeset	6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load duke parents: diff changeset	7 * published by the Free Software Foundation.
a61af66fc99e Initial load duke parents: diff changeset	8 *
a61af66fc99e Initial load duke parents: diff changeset	9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load duke parents: diff changeset	10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load duke parents: diff changeset	11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load duke parents: diff changeset	12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load duke parents: diff changeset	13 * accompanied this code).
a61af66fc99e Initial load duke parents: diff changeset	14 *
a61af66fc99e Initial load duke parents: diff changeset	15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load duke parents: diff changeset	16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load duke parents: diff changeset	17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load duke parents: diff changeset	18 *
a61af66fc99e Initial load duke parents: diff changeset	19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
a61af66fc99e Initial load duke parents: diff changeset	20 * CA 95054 USA or visit www.sun.com if you need additional information or
a61af66fc99e Initial load duke parents: diff changeset	21 * have any questions.
a61af66fc99e Initial load duke parents: diff changeset	22 *
a61af66fc99e Initial load duke parents: diff changeset	23 */
a61af66fc99e Initial load duke parents: diff changeset	24
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	25 #include <stdarg.h>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	26
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	27 // Simple class to format the ctor arguments into a fixed-sized buffer.
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	28 template <size_t bufsz = 256>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	29 class FormatBuffer {
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	30 public:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	31 inline FormatBuffer(const char * format, ...);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	32 operator const char *() const { return _buf; }
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	33
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	34 private:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	35 FormatBuffer(const FormatBuffer &); // prevent copies
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	36
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	37 private:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	38 char _buf[bufsz];
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	39 };
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	40
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	41 template <size_t bufsz>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	42 FormatBuffer<bufsz>::FormatBuffer(const char * format, ...) {
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	43 va_list argp;
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	44 va_start(argp, format);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	45 vsnprintf(_buf, bufsz, format, argp);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	46 va_end(argp);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	47 }
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	48
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	49 // Used to format messages for assert(), guarantee(), fatal(), etc.
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	50 typedef FormatBuffer<> err_msg;
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	51
0 a61af66fc99e Initial load duke parents: diff changeset	52 // assertions
a61af66fc99e Initial load duke parents: diff changeset	53 #ifdef ASSERT
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	54 #ifndef USE_REPEATED_ASSERTS
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	55 #define assert(p, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	56 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	57 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	58 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	59 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	60 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	61 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	62 #else // #ifndef USE_REPEATED_ASSERTS
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	63 #define assert(p, msg)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	64 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	65 for (int __i = 0; __i < AssertRepeat; __i++) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	66 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	67 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	68 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	69 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	70 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	71 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	72 #endif // #ifndef USE_REPEATED_ASSERTS
0 a61af66fc99e Initial load duke parents: diff changeset	73
a61af66fc99e Initial load duke parents: diff changeset	74 // This version of assert is for use with checking return status from
a61af66fc99e Initial load duke parents: diff changeset	75 // library calls that return actual error values eg. EINVAL,
a61af66fc99e Initial load duke parents: diff changeset	76 // ENOMEM etc, rather than returning -1 and setting errno.
a61af66fc99e Initial load duke parents: diff changeset	77 // When the status is not what is expected it is very useful to know
a61af66fc99e Initial load duke parents: diff changeset	78 // what status was actually returned, so we pass the status variable as
a61af66fc99e Initial load duke parents: diff changeset	79 // an extra arg and use strerror to convert it to a meaningful string
a61af66fc99e Initial load duke parents: diff changeset	80 // like "Invalid argument", "out of memory" etc
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	81 #define assert_status(p, status, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	82 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	83 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	84 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	85 err_msg("error %s(%d) %s", strerror(status), \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	86 status, msg)); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	87 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	88 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	89 } while (0)
0 a61af66fc99e Initial load duke parents: diff changeset	90
a61af66fc99e Initial load duke parents: diff changeset	91 // Do not assert this condition if there's already another error reported.
a61af66fc99e Initial load duke parents: diff changeset	92 #define assert_if_no_error(cond,msg) assert((cond) \|\| is_error_reported(), msg)
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	93 #else // #ifdef ASSERT
0 a61af66fc99e Initial load duke parents: diff changeset	94 #define assert(p,msg)
a61af66fc99e Initial load duke parents: diff changeset	95 #define assert_status(p,status,msg)
a61af66fc99e Initial load duke parents: diff changeset	96 #define assert_if_no_error(cond,msg)
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	97 #endif // #ifdef ASSERT
0 a61af66fc99e Initial load duke parents: diff changeset	98
a61af66fc99e Initial load duke parents: diff changeset	99 // guarantee is like assert except it's always executed -- use it for
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	100 // cheap tests that catch errors that would otherwise be hard to find.
0 a61af66fc99e Initial load duke parents: diff changeset	101 // guarantee is also used for Verify options.
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	102 #define guarantee(p, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	103 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	104 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	105 report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	106 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	107 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	108 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	109
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	110 #define fatal(msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	111 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	112 report_fatal(__FILE__, __LINE__, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	113 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	114 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	115
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	116 // out of memory
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	117 #define vm_exit_out_of_memory(size, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	118 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	119 report_vm_out_of_memory(__FILE__, __LINE__, size, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	120 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	121 } while (0)
0 a61af66fc99e Initial load duke parents: diff changeset	122
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	123 #define ShouldNotCallThis() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	124 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	125 report_should_not_call(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	126 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	127 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	128
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	129 #define ShouldNotReachHere() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	130 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	131 report_should_not_reach_here(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	132 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	133 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	134
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	135 #define Unimplemented() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	136 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	137 report_unimplemented(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	138 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	139 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	140
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	141 #define Untested(msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	142 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	143 report_untested(__FILE__, __LINE__, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	144 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	145 } while (0);
0 a61af66fc99e Initial load duke parents: diff changeset	146
a61af66fc99e Initial load duke parents: diff changeset	147 // error reporting helper functions
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	148 void report_vm_error(const char* file, int line, const char* error_msg,
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	149 const char* detail_msg = NULL);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	150 void report_fatal(const char* file, int line, const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	151 void report_vm_out_of_memory(const char* file, int line, size_t size,
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	152 const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	153 void report_should_not_call(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	154 void report_should_not_reach_here(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	155 void report_unimplemented(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	156 void report_untested(const char* file, int line, const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	157
0 a61af66fc99e Initial load duke parents: diff changeset	158 void warning(const char* format, ...);
a61af66fc99e Initial load duke parents: diff changeset	159
a61af66fc99e Initial load duke parents: diff changeset	160 // out of memory reporting
a61af66fc99e Initial load duke parents: diff changeset	161 void report_java_out_of_memory(const char* message);
a61af66fc99e Initial load duke parents: diff changeset	162
a61af66fc99e Initial load duke parents: diff changeset	163 // Support for self-destruct
a61af66fc99e Initial load duke parents: diff changeset	164 bool is_error_reported();
a61af66fc99e Initial load duke parents: diff changeset	165 void set_error_reported();
a61af66fc99e Initial load duke parents: diff changeset	166
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	167 /* Test assert(), fatal(), guarantee(), etc. */
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	168 NOT_PRODUCT(void test_error_handler(size_t test_num);)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	169
0 a61af66fc99e Initial load duke parents: diff changeset	170 void pd_ps(frame f);
a61af66fc99e Initial load duke parents: diff changeset	171 void pd_obfuscate_location(char *buf, size_t buflen);

Mercurial > hg > truffle

annotate src/share/vm/utilities/debug.hpp @ 1490:f03d0a26bf83