1 /*
   2  * Copyright (c) 1997, 2015, 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 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   }                                                                          \
 123 } while (0)
 124 #endif
 125 
 126 // For backward compatibility.
 127 #define assert(p, msg) vmassert(p, msg)
 128 
 129 // This version of vmassert is for use with checking return status from
 130 // library calls that return actual error values eg. EINVAL,
 131 // ENOMEM etc, rather than returning -1 and setting errno.
 132 // When the status is not what is expected it is very useful to know
 133 // what status was actually returned, so we pass the status variable as
 134 // an extra arg and use strerror to convert it to a meaningful string
 135 // like "Invalid argument", "out of memory" etc
 136 #define vmassert_status(p, status, msg) \
 137   vmassert(p, err_msg("error %s(%d), %s", strerror(status), status, msg))
 138 
 139 // For backward compatibility.
 140 #define assert_status(p, status, msg) vmassert_status(p, status, msg)
 141 
 142 // guarantee is like vmassert except it's always executed -- use it for
 143 // cheap tests that catch errors that would otherwise be hard to find.
 144 // guarantee is also used for Verify options.
 145 #define guarantee(p, msg)                                                    \
 146 do {                                                                         \
 147   if (!(p)) {                                                                \
 148     report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", msg);    \
 149   }                                                                          \
 150 } while (0)
 151 
 152 // out of memory
 153 #define vm_exit_out_of_memory(size, vm_err_type, msg) \
 154   report_vm_out_of_memory(__FILE__, __LINE__, size, vm_err_type, msg)
 155 
 156 #define fatal(msg)           report_fatal(__FILE__, __LINE__, msg)
 157 #define ShouldNotCallThis()  report_should_not_call(__FILE__, __LINE__)
 158 #define ShouldNotReachHere() report_should_not_reach_here(__FILE__, __LINE__)
 159 #define Unimplemented()      report_unimplemented(__FILE__, __LINE__)
 160 #define Untested(msg)        report_untested(__FILE__, __LINE__, msg)
 161 
 162 
 163 // types of VM error - originally in vmError.hpp
 164 enum VMErrorType {
 165   INTERNAL_ERROR   = 0xe0000000,
 166   OOM_MALLOC_ERROR = 0xe0000001,
 167   OOM_MMAP_ERROR   = 0xe0000002
 168 };
 169 
 170 // error reporting helper functions
 171 void report_vm_error(const char* file, int line, const char* error_msg,
 172                      const char* detail_msg = NULL);
 173 
 174 void report_unimplemented(const char* file, int line);
 175 void report_untested(const char* file, int line, const char* message);
 176 
 177 NORETURN_ATTRIBUTE(void report_vm_error_noreturn(const char* file, int line,
 178                                        const char* error_msg,
 179                                        const char* detail_msg = NULL));
 180 NORETURN_ATTRIBUTE(void report_vm_out_of_memory(const char* file, int line, size_t size,
 181                                       VMErrorType vm_err_type, const char* message));
 182 NORETURN_ATTRIBUTE(void report_fatal(const char* file, int line, const char* message));
 183 NORETURN_ATTRIBUTE(void report_should_not_call(const char* file, int line));
 184 NORETURN_ATTRIBUTE(void report_should_not_reach_here(const char* file, int line));
 185 
 186 void warning(const char* format, ...) ATTRIBUTE_PRINTF(1, 2);
 187 
 188 // Compile-time asserts.  Cond must be a compile-time constant expression that
 189 // is convertible to bool.  STATIC_ASSERT() can be used anywhere a declaration
 190 // may appear.
 191 //
 192 // Implementation Note: STATIC_ASSERT_FAILURE<true> provides a value member
 193 // rather than type member that could be used directly in the typedef, because
 194 // a type member would require conditional use of "typename", depending on
 195 // whether Cond is dependent or not.  The use of a value member leads to the
 196 // use of an array type.
 197 
 198 template<bool x> struct STATIC_ASSERT_FAILURE;
 199 template<> struct STATIC_ASSERT_FAILURE<true> { enum { value = 1 }; };
 200 
 201 #define STATIC_ASSERT(Cond) \
 202   typedef char STATIC_ASSERT_DUMMY_TYPE[ STATIC_ASSERT_FAILURE< (Cond) >::value ]
 203 
 204 // out of shared space reporting
 205 enum SharedSpaceType {
 206   SharedReadOnly,
 207   SharedReadWrite,
 208   SharedMiscData,
 209   SharedMiscCode
 210 };
 211 
 212 void report_out_of_shared_space(SharedSpaceType space_type);
 213 
 214 void report_insufficient_metaspace(size_t required_size);
 215 
 216 // out of memory reporting
 217 void report_java_out_of_memory(const char* message);
 218 
 219 // Support for self-destruct
 220 bool is_error_reported();
 221 void set_error_reported();
 222 
 223 /* Test vmassert(), fatal(), guarantee(), etc. */
 224 NOT_PRODUCT(void test_error_handler();)
 225 
 226 // crash in a controlled way:
 227 // how can be one of:
 228 // 1,2 - asserts
 229 // 3,4 - guarantee
 230 // 5-7 - fatal
 231 // 8 - vm_exit_out_of_memory
 232 // 9 - ShouldNotCallThis
 233 // 10 - ShouldNotReachHere
 234 // 11 - Unimplemented
 235 // 12,13 - (not guaranteed) crashes
 236 // 14 - SIGSEGV
 237 // 15 - SIGFPE
 238 NOT_PRODUCT(void controlled_crash(int how);)
 239 
 240 // returns an address which is guaranteed to generate a SIGSEGV on read,
 241 // for test purposes, which is not NULL and contains bits in every word
 242 NOT_PRODUCT(void* get_segfault_address();)
 243 
 244 void pd_ps(frame f);
 245 void pd_obfuscate_location(char *buf, size_t buflen);
 246 
 247 class outputStream;
 248 void print_native_stack(outputStream* st, frame fr, Thread* t, char* buf, int buf_size);
 249 
 250 #endif // SHARE_VM_UTILITIES_DEBUG_HPP