/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "utilities/breakpoint.hpp"

#include "utilities/compilerWarnings.hpp"

#include "utilities/macros.hpp"

#include <stddef.h>

// ShowRegistersOnAssert support (for now Linux only)

#if defined(LINUX) && !defined(ZERO)

#define CAN_SHOW_REGISTERS_ON_ASSERT

extern char* g_assert_poison;

#define TOUCH_ASSERT_POISON (*g_assert_poison) = 'X';

void initialize_assert_poison();

bool handle_assert_poison_fault(const void* ucVoid, const void* faulting_address);

#else

#define TOUCH_ASSERT_POISON

#endif // CAN_SHOW_REGISTERS_ON_ASSERT

// assertions

#ifndef ASSERT

#define vmassert(p, ...)

#else

// Note: message says "assert" rather than "vmassert" for backward

// compatibility with tools that parse/match the message text.

// Note: The signature is vmassert(p, format, ...), but the solaris

// compiler can't handle an empty ellipsis in a macro without a warning.

#define vmassert(p, ...)                                                       \

do {                                                                           \

  if (!(p)) {                                                                  \

    TOUCH_ASSERT_POISON;                                                       \

    if (is_executing_unit_tests()) {                                           \

      report_assert_msg(__VA_ARGS__);                                          \

    }                                                                          \

    report_vm_error(__FILE__, __LINE__, "assert(" #p ") failed", __VA_ARGS__); \

    BREAKPOINT;                                                                \

  }                                                                            \

} while (0)

#endif

// For backward compatibility.

#define assert(p, ...) vmassert(p, __VA_ARGS__)

#ifndef ASSERT

#define vmassert_status(p, status, msg)

#else

// This version of vmassert is for use with checking return status from

// library calls that return actual error values eg. EINVAL,

// ENOMEM etc, rather than returning -1 and setting errno.

// When the status is not what is expected it is very useful to know

// what status was actually returned, so we pass the status variable as

// an extra arg and use strerror to convert it to a meaningful string

// like "Invalid argument", "out of memory" etc

#define vmassert_status(p, status, msg) \

do {                                                                           \

  if (!(p)) {                                                                  \

    TOUCH_ASSERT_POISON;                                                       \

    report_vm_status_error(__FILE__, __LINE__, "assert(" #p ") failed",        \

                           status, msg);                                       \

    BREAKPOINT;                                                                \

  }                                                                            \

} while (0)

#endif

// For backward compatibility.

#define assert_status(p, status, msg) vmassert_status(p, status, msg)

// guarantee is like vmassert except it's always executed -- use it for

// cheap tests that catch errors that would otherwise be hard to find.

// guarantee is also used for Verify options.

#define guarantee(p, ...)                                                         \

do {                                                                              \

  if (!(p)) {                                                                     \

    TOUCH_ASSERT_POISON;                                                          \

    report_vm_error(__FILE__, __LINE__, "guarantee(" #p ") failed", __VA_ARGS__); \

    BREAKPOINT;                                                                   \

  }                                                                               \

} while (0)

#define fatal(...)                                                                \

do {                                                                              \

  TOUCH_ASSERT_POISON;                                                            \

  report_fatal(__FILE__, __LINE__, __VA_ARGS__);                                  \

  BREAKPOINT;                                                                     \

} while (0)

// out of memory

#define vm_exit_out_of_memory(size, vm_err_type, ...)                             \

do {                                                                              \

  report_vm_out_of_memory(__FILE__, __LINE__, size, vm_err_type, __VA_ARGS__);    \

  BREAKPOINT;                                                                     \

} while (0)

#define ShouldNotCallThis()                                                       \

do {                                                                              \

  TOUCH_ASSERT_POISON;                                                            \

  report_should_not_call(__FILE__, __LINE__);                                     \

  BREAKPOINT;                                                                     \

} while (0)

#define ShouldNotReachHere()                                                      \

do {                                                                              \

  TOUCH_ASSERT_POISON;                                                            \

  report_should_not_reach_here(__FILE__, __LINE__);                               \

  BREAKPOINT;                                                                     \

} while (0)

#define Unimplemented()                                                           \

do {                                                                              \

  TOUCH_ASSERT_POISON;                                                            \

  report_unimplemented(__FILE__, __LINE__);                                       \

  BREAKPOINT;                                                                     \

} while (0)

#define Untested(msg)                                                             \

do {                                                                              \

  report_untested(__FILE__, __LINE__, msg);                                       \

  BREAKPOINT;                                                                     \

} while (0);

// types of VM error - originally in vmError.hpp

enum VMErrorType {

  INTERNAL_ERROR   = 0xe0000000,

  OOM_MALLOC_ERROR = 0xe0000001,

  OOM_MMAP_ERROR   = 0xe0000002

};

// error reporting helper functions

void report_vm_error(const char* file, int line, const char* error_msg);

#if !defined(__GNUC__) || defined (__clang_major__) || (((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8)) || __GNUC__ > 4)

// ATTRIBUTE_PRINTF works with gcc >= 4.8 and any other compiler.

void report_vm_error(const char* file, int line, const char* error_msg,

                     const char* detail_fmt, ...) ATTRIBUTE_PRINTF(4, 5);

#ifdef ASSERT

void report_assert_msg(const char* msg, ...) ATTRIBUTE_PRINTF(1, 2);

#endif // ASSERT

#else

// GCC < 4.8 warns because of empty format string.  Warning can not be switched off selectively.

void report_vm_error(const char* file, int line, const char* error_msg,

                     const char* detail_fmt, ...);

#ifdef ASSERT

void report_assert_msg(const char* msg, ...);

#endif // ASSERT

#endif

void report_vm_status_error(const char* file, int line, const char* error_msg,

                            int status, const char* detail);

void report_fatal(const char* file, int line, const char* detail_fmt, ...) ATTRIBUTE_PRINTF(3, 4);

void report_vm_out_of_memory(const char* file, int line, size_t size, VMErrorType vm_err_type,

                             const char* detail_fmt, ...) ATTRIBUTE_PRINTF(5, 6);

void report_should_not_call(const char* file, int line);

void report_should_not_reach_here(const char* file, int line);

void report_unimplemented(const char* file, int line);

void report_untested(const char* file, int line, const char* message);

#ifdef ASSERT

// unit test support

bool is_executing_unit_tests();

#endif // ASSERT

void warning(const char* format, ...) ATTRIBUTE_PRINTF(1, 2);

// Compile-time asserts.  Cond must be a compile-time constant expression that

// is convertible to bool.  STATIC_ASSERT() can be used anywhere a declaration

// may appear.

//

// Implementation Note: STATIC_ASSERT_FAILURE<true> provides a value member

// rather than type member that could be used directly in the typedef, because

// a type member would require conditional use of "typename", depending on

// whether Cond is dependent or not.  The use of a value member leads to the

// use of an array type.

template<bool x> struct STATIC_ASSERT_FAILURE;

template<> struct STATIC_ASSERT_FAILURE<true> { enum { value = 1 }; };

#define STATIC_ASSERT(Cond) \

  typedef char PASTE_TOKENS(STATIC_ASSERT_DUMMY_TYPE_, __LINE__)[ \

    STATIC_ASSERT_FAILURE< (Cond) >::value ]

// out of memory reporting

void report_java_out_of_memory(const char* message);