• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/vm/utilities/debug.hpp@f03d0a26bf83 (annotated)

src/share/vm/utilities/debug.hpp

Thu, 22 Apr 2010 13:23:15 -0700

author

jcoomes

date

Thu, 22 Apr 2010 13:23:15 -0700

changeset 1845

f03d0a26bf83

parent 435

a61af66fc99e

child 1907

c18cbe5936b8

permissions

-rw-r--r--

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

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