graal-jvmci-8: src/share/vm/utilities/debug.hpp annotate

annotate src/share/vm/utilities/debug.hpp @ 1972:f95d63e2154a

6989984: Use standard include model for Hospot Summary: Replaced MakeDeps and the includeDB files with more standardized solutions. Reviewed-by: coleenp, kvn, kamg

author	stefank
date	Tue, 23 Nov 2010 13:22:55 -0800
parents	c18cbe5936b8
children	0fa27f37d4d4

rev	line source
0 a61af66fc99e Initial load duke parents: diff changeset	1 /*
1972 f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
0 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 *
1552 c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories trims parents: 1490 diff changeset	19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories trims parents: 1490 diff changeset	20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories trims parents: 1490 diff changeset	21 * questions.
0 a61af66fc99e Initial load duke parents: diff changeset	22 *
a61af66fc99e Initial load duke parents: diff changeset	23 */
a61af66fc99e Initial load duke parents: diff changeset	24
1972 f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	25 #ifndef SHARE_VM_UTILITIES_DEBUG_HPP
f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	26 #define SHARE_VM_UTILITIES_DEBUG_HPP
f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	27
f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	28 #include "utilities/globalDefinitions.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	29
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	30 #include <stdarg.h>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	31
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	32 // 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	33 template <size_t bufsz = 256>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	34 class FormatBuffer {
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	35 public:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	36 inline FormatBuffer(const char * format, ...);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	37 operator const char *() const { return _buf; }
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	38
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	39 private:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	40 FormatBuffer(const FormatBuffer &); // prevent copies
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	41
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	42 private:
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	43 char _buf[bufsz];
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	44 };
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	45
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	46 template <size_t bufsz>
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	47 FormatBuffer<bufsz>::FormatBuffer(const char * format, ...) {
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	48 va_list argp;
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	49 va_start(argp, format);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	50 vsnprintf(_buf, bufsz, format, argp);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	51 va_end(argp);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	52 }
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	53
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	54 // Used to format messages for assert(), guarantee(), fatal(), etc.
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	55 typedef FormatBuffer<> err_msg;
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	56
0 a61af66fc99e Initial load duke parents: diff changeset	57 // assertions
a61af66fc99e Initial load duke parents: diff changeset	58 #ifdef ASSERT
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	59 #ifndef USE_REPEATED_ASSERTS
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	60 #define assert(p, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	61 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	62 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	63 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	64 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	65 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	66 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	67 #else // #ifndef USE_REPEATED_ASSERTS
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	68 #define assert(p, msg)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	69 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	70 for (int __i = 0; __i < AssertRepeat; __i++) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	71 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	72 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	73 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	74 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	75 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	76 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	77 #endif // #ifndef USE_REPEATED_ASSERTS
0 a61af66fc99e Initial load duke parents: diff changeset	78
a61af66fc99e Initial load duke parents: diff changeset	79 // This version of assert is for use with checking return status from
a61af66fc99e Initial load duke parents: diff changeset	80 // library calls that return actual error values eg. EINVAL,
a61af66fc99e Initial load duke parents: diff changeset	81 // ENOMEM etc, rather than returning -1 and setting errno.
a61af66fc99e Initial load duke parents: diff changeset	82 // When the status is not what is expected it is very useful to know
a61af66fc99e Initial load duke parents: diff changeset	83 // what status was actually returned, so we pass the status variable as
a61af66fc99e Initial load duke parents: diff changeset	84 // an extra arg and use strerror to convert it to a meaningful string
a61af66fc99e Initial load duke parents: diff changeset	85 // like "Invalid argument", "out of memory" etc
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	86 #define assert_status(p, status, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	87 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	88 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	89 report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	90 err_msg("error %s(%d) %s", strerror(status), \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	91 status, msg)); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	92 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	93 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	94 } while (0)
0 a61af66fc99e Initial load duke parents: diff changeset	95
a61af66fc99e Initial load duke parents: diff changeset	96 // Do not assert this condition if there's already another error reported.
a61af66fc99e Initial load duke parents: diff changeset	97 #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	98 #else // #ifdef ASSERT
0 a61af66fc99e Initial load duke parents: diff changeset	99 #define assert(p,msg)
a61af66fc99e Initial load duke parents: diff changeset	100 #define assert_status(p,status,msg)
a61af66fc99e Initial load duke parents: diff changeset	101 #define assert_if_no_error(cond,msg)
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	102 #endif // #ifdef ASSERT
0 a61af66fc99e Initial load duke parents: diff changeset	103
a61af66fc99e Initial load duke parents: diff changeset	104 // 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	105 // cheap tests that catch errors that would otherwise be hard to find.
0 a61af66fc99e Initial load duke parents: diff changeset	106 // guarantee is also used for Verify options.
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	107 #define guarantee(p, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	108 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	109 if (!(p)) { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	110 report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	111 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	112 } \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	113 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	114
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	115 #define fatal(msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	116 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	117 report_fatal(__FILE__, __LINE__, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	118 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	119 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	120
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	121 // out of memory
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	122 #define vm_exit_out_of_memory(size, msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	123 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	124 report_vm_out_of_memory(__FILE__, __LINE__, size, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	125 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	126 } while (0)
0 a61af66fc99e Initial load duke parents: diff changeset	127
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	128 #define ShouldNotCallThis() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	129 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	130 report_should_not_call(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	131 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	132 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	133
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	134 #define ShouldNotReachHere() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	135 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	136 report_should_not_reach_here(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	137 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	138 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	139
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	140 #define Unimplemented() \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	141 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	142 report_unimplemented(__FILE__, __LINE__); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	143 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	144 } while (0)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	145
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	146 #define Untested(msg) \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	147 do { \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	148 report_untested(__FILE__, __LINE__, msg); \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	149 BREAKPOINT; \
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	150 } while (0);
0 a61af66fc99e Initial load duke parents: diff changeset	151
a61af66fc99e Initial load duke parents: diff changeset	152 // error reporting helper functions
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	153 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	154 const char* detail_msg = NULL);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	155 void report_fatal(const char* file, int line, const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	156 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	157 const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	158 void report_should_not_call(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	159 void report_should_not_reach_here(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	160 void report_unimplemented(const char* file, int line);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	161 void report_untested(const char* file, int line, const char* message);
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	162
0 a61af66fc99e Initial load duke parents: diff changeset	163 void warning(const char* format, ...);
a61af66fc99e Initial load duke parents: diff changeset	164
a61af66fc99e Initial load duke parents: diff changeset	165 // out of memory reporting
a61af66fc99e Initial load duke parents: diff changeset	166 void report_java_out_of_memory(const char* message);
a61af66fc99e Initial load duke parents: diff changeset	167
a61af66fc99e Initial load duke parents: diff changeset	168 // Support for self-destruct
a61af66fc99e Initial load duke parents: diff changeset	169 bool is_error_reported();
a61af66fc99e Initial load duke parents: diff changeset	170 void set_error_reported();
a61af66fc99e Initial load duke parents: diff changeset	171
1490 f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	172 /* Test assert(), fatal(), guarantee(), etc. */
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	173 NOT_PRODUCT(void test_error_handler(size_t test_num);)
f03d0a26bf83 6888954: argument formatting for assert() and friends jcoomes parents: 0 diff changeset	174
0 a61af66fc99e Initial load duke parents: diff changeset	175 void pd_ps(frame f);
a61af66fc99e Initial load duke parents: diff changeset	176 void pd_obfuscate_location(char *buf, size_t buflen);
1972 f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	177
f95d63e2154a 6989984: Use standard include model for Hospot stefank parents: 1552 diff changeset	178 #endif // SHARE_VM_UTILITIES_DEBUG_HPP

Mercurial > hg > graal-jvmci-8

annotate src/share/vm/utilities/debug.hpp @ 1972:f95d63e2154a