< prev index next >

src/share/vm/utilities/debug.hpp

Print this page
rev 8977 : imported patch assert
rev 8978 : imported patch remove_err_msg
rev 8979 : [mq]: vmerr_static


  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) {


  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 vmassert(), guarantee(), fatal(), etc.
 109 typedef FormatBuffer<> err_msg;
 110 typedef FormatBufferResource err_msg_res;
 111 
 112 // assertions
 113 #ifndef ASSERT
 114 #define vmassert(p, msg)
 115 #else
 116 // Note: message says "assert" rather than "vmassert" for backward
 117 // compatibility with tools that parse/match the message text.
 118 #define vmassert(p, msg)                                                     \
 119 do {                                                                         \
 120   if (!(p)) {                                                                \
 121     report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", msg);       \
 122     BREAKPOINT;                                                              \
 123   }                                                                          \
 124 } while (0)

 125 #endif
 126 
 127 // For backward compatibility.
 128 #define assert(p, msg) vmassert(p, msg)
 129 
 130 // This version of vmassert is for use with checking return status from
 131 // library calls that return actual error values eg. EINVAL,
 132 // ENOMEM etc, rather than returning -1 and setting errno.
 133 // When the status is not what is expected it is very useful to know
 134 // what status was actually returned, so we pass the status variable as
 135 // an extra arg and use strerror to convert it to a meaningful string
 136 // like "Invalid argument", "out of memory" etc
 137 #define vmassert_status(p, status, msg) \
 138   vmassert(p, err_msg("error %s(%d), %s", strerror(status), status, msg))
 139 
 140 // For backward compatibility.
 141 #define assert_status(p, status, msg) vmassert_status(p, status, msg)
 142 
 143 // guarantee is like vmassert except it's always executed -- use it for
 144 // cheap tests that catch errors that would otherwise be hard to find.
 145 // guarantee is also used for Verify options.
 146 #define guarantee(p, msg)                                                    \
 147 do {                                                                         \
 148   if (!(p)) {                                                                \
 149     report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", msg);    \
 150     BREAKPOINT;                                                              \
 151   }                                                                          \
 152 } while (0)
 153 
 154 #define fatal(msg)                                                           \
 155 do {                                                                         \
 156   report_fatal(__FILE__, __LINE__, msg);                                     \
 157   BREAKPOINT;                                                                \
 158 } while (0)
 159 
 160 // out of memory
 161 #define vm_exit_out_of_memory(size, vm_err_type, msg)                        \
 162 do {                                                                         \
 163   report_vm_out_of_memory(__FILE__, __LINE__, size, vm_err_type, msg);       \
 164   BREAKPOINT;                                                                \
 165 } while (0)
 166 
 167 #define ShouldNotCallThis()                                                  \
 168 do {                                                                         \
 169   report_should_not_call(__FILE__, __LINE__);                                \
 170   BREAKPOINT;                                                                \
 171 } while (0)
 172 
 173 #define ShouldNotReachHere()                                                 \
 174 do {                                                                         \
 175   report_should_not_reach_here(__FILE__, __LINE__);                          \
 176   BREAKPOINT;                                                                \
 177 } while (0)
 178 
 179 #define Unimplemented()                                                      \
 180 do {                                                                         \
 181   report_unimplemented(__FILE__, __LINE__);                                  \
 182   BREAKPOINT;                                                                \
 183 } while (0)
 184 
 185 #define Untested(msg)                                                        \
 186 do {                                                                         \
 187   report_untested(__FILE__, __LINE__, msg);                                  \
 188   BREAKPOINT;                                                                \
 189 } while (0);
 190 
 191 
 192 // types of VM error - originally in vmError.hpp
 193 enum VMErrorType {
 194   INTERNAL_ERROR   = 0xe0000000,
 195   OOM_MALLOC_ERROR = 0xe0000001,
 196   OOM_MMAP_ERROR   = 0xe0000002
 197 };
 198 
 199 // error reporting helper functions

 200 void report_vm_error(const char* file, int line, const char* error_msg,
 201                      const char* detail_msg = NULL);
 202 void report_fatal(const char* file, int line, const char* message);
 203 void report_vm_out_of_memory(const char* file, int line, size_t size,
 204                              VMErrorType vm_err_type, const char* message);
 205 void report_should_not_call(const char* file, int line);
 206 void report_should_not_reach_here(const char* file, int line);
 207 void report_unimplemented(const char* file, int line);
 208 void report_untested(const char* file, int line, const char* message);
 209 
 210 void warning(const char* format, ...) ATTRIBUTE_PRINTF(1, 2);
 211 
 212 // Compile-time asserts.  Cond must be a compile-time constant expression that
 213 // is convertible to bool.  STATIC_ASSERT() can be used anywhere a declaration
 214 // may appear.
 215 //
 216 // Implementation Note: STATIC_ASSERT_FAILURE<true> provides a value member
 217 // rather than type member that could be used directly in the typedef, because
 218 // a type member would require conditional use of "typename", depending on
 219 // whether Cond is dependent or not.  The use of a value member leads to the
 220 // use of an array type.
 221 
 222 template<bool x> struct STATIC_ASSERT_FAILURE;
 223 template<> struct STATIC_ASSERT_FAILURE<true> { enum { value = 1 }; };
 224 




  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 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 = BUFSZ>
  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) {


  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
 109 typedef FormatBuffer<> err_msg;

 110 
 111 // assertions
 112 #ifndef ASSERT
 113 #define vmassert(p, ...)
 114 #else
 115 // Note: message says "assert" rather than "vmassert" for backward
 116 // compatibility with tools that parse/match the message text.
 117 #define vmassert(p, ...)                                                       \
 118 do {                                                                           \
 119   if (!(p)) {                                                                  \
 120     report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", __VA_ARGS__); \
 121     BREAKPOINT;                                                                \
 122   }                                                                            \
 123 } while (0)
 124 
 125 #endif
 126 
 127 // For backward compatibility.
 128 #define assert(p, ...) vmassert(p, __VA_ARGS__)
 129 
 130 // This version of vmassert is for use with checking return status from
 131 // library calls that return actual error values eg. EINVAL,
 132 // ENOMEM etc, rather than returning -1 and setting errno.
 133 // When the status is not what is expected it is very useful to know
 134 // what status was actually returned, so we pass the status variable as
 135 // an extra arg and use strerror to convert it to a meaningful string
 136 // like "Invalid argument", "out of memory" etc
 137 #define vmassert_status(p, status, msg) \
 138   vmassert(p, "error %s(%d), %s", strerror(status), status, msg)
 139 
 140 // For backward compatibility.
 141 #define assert_status(p, status, msg) vmassert_status(p, status, msg)
 142 
 143 // guarantee is like vmassert except it's always executed -- use it for
 144 // cheap tests that catch errors that would otherwise be hard to find.
 145 // guarantee is also used for Verify options.
 146 #define guarantee(p, ...)                                                         \
 147 do {                                                                              \
 148   if (!(p)) {                                                                     \
 149     report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", __VA_ARGS__); \
 150     BREAKPOINT;                                                                   \
 151   }                                                                               \
 152 } while (0)
 153 
 154 #define fatal(...)                                                                \
 155 do {                                                                              \
 156   report_fatal(__FILE__, __LINE__, __VA_ARGS__);                                  \
 157   BREAKPOINT;                                                                     \
 158 } while (0)
 159 
 160 // out of memory
 161 #define vm_exit_out_of_memory(size, vm_err_type, ...)                             \
 162 do {                                                                              \
 163   report_vm_out_of_memory(__FILE__, __LINE__, size, vm_err_type, __VA_ARGS__);    \
 164   BREAKPOINT;                                                                     \
 165 } while (0)
 166 
 167 #define ShouldNotCallThis()                                                       \
 168 do {                                                                              \
 169   report_should_not_call(__FILE__, __LINE__);                                     \
 170   BREAKPOINT;                                                                     \
 171 } while (0)
 172 
 173 #define ShouldNotReachHere()                                                      \
 174 do {                                                                              \
 175   report_should_not_reach_here(__FILE__, __LINE__);                               \
 176   BREAKPOINT;                                                                     \
 177 } while (0)
 178 
 179 #define Unimplemented()                                                           \
 180 do {                                                                              \
 181   report_unimplemented(__FILE__, __LINE__);                                       \
 182   BREAKPOINT;                                                                     \
 183 } while (0)
 184 
 185 #define Untested(msg)                                                             \
 186 do {                                                                              \
 187   report_untested(__FILE__, __LINE__, msg);                                       \
 188   BREAKPOINT;                                                                     \
 189 } while (0);
 190 
 191 
 192 // types of VM error - originally in vmError.hpp
 193 enum VMErrorType {
 194   INTERNAL_ERROR   = 0xe0000000,
 195   OOM_MALLOC_ERROR = 0xe0000001,
 196   OOM_MMAP_ERROR   = 0xe0000002
 197 };
 198 
 199 // error reporting helper functions
 200 void report_vm_error(const char* file, int line, const char* error_msg);
 201 void report_vm_error(const char* file, int line, const char* error_msg,
 202                      const char* detail_fmt, ...) ATTRIBUTE_PRINTF(4, 5);
 203 void report_fatal(const char* file, int line, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(3, 4);
 204 void report_vm_out_of_memory(const char* file, int line, size_t size, VMErrorType vm_err_type,
 205                              const char* detail_fmt, ...) ATTRIBUTE_PRINTF(5, 6);
 206 void report_should_not_call(const char* file, int line);
 207 void report_should_not_reach_here(const char* file, int line);
 208 void report_unimplemented(const char* file, int line);
 209 void report_untested(const char* file, int line, const char* message);
 210 
 211 void warning(const char* format, ...) ATTRIBUTE_PRINTF(1, 2);
 212 
 213 // Compile-time asserts.  Cond must be a compile-time constant expression that
 214 // is convertible to bool.  STATIC_ASSERT() can be used anywhere a declaration
 215 // may appear.
 216 //
 217 // Implementation Note: STATIC_ASSERT_FAILURE<true> provides a value member
 218 // rather than type member that could be used directly in the typedef, because
 219 // a type member would require conditional use of "typename", depending on
 220 // whether Cond is dependent or not.  The use of a value member leads to the
 221 // use of an array type.
 222 
 223 template<bool x> struct STATIC_ASSERT_FAILURE;
 224 template<> struct STATIC_ASSERT_FAILURE<true> { enum { value = 1 }; };
 225 


< prev index next >