1/*
2 * Copyright (c) 2016, 2019, 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#ifndef UNITTEST_HPP
25#define UNITTEST_HPP
26
27#include <stdlib.h>
28#include <stdio.h>
29
30#define GTEST_DONT_DEFINE_TEST 1
31
32// googlemock has ::testing::internal::Log function, so we need to temporary
33// undefine 'Log' from logging/log.hpp and define it back after gmock header
34// file is included. As SS compiler doesn't have push_/pop_macro pragmas and
35// log.hpp might have been already included, we have to copy-paste macro definition.
36#ifdef Log
37 #define UNDEFINED_Log
38 #undef Log
39#endif
40
41// R macro is defined by src/hotspot/cpu/arm/register_arm.hpp, F$n are defined
42// in ppc/register_ppc.hpp, these macros conflict with typenames used in
43// internal googlemock templates. As the macros are not expected to be used by
44// any of tests directly, and this header file is supposed to be the last
45// include, we just undefine it; if/when it changes, we will need to re-define
46// the macros after the following includes.
47#undef R
48#undef F1
49#undef F2
50
51#include "gmock/gmock.h"
52#include "gtest/gtest.h"
53
54#ifdef UNDEFINED_Log
55 #define Log(...) LogImpl<LOG_TAGS(__VA_ARGS__)> // copied from logging/log.hpp
56 #undef UNDEFINED_Log
57#endif
58
59// gtest/gtest.h includes assert.h which will define the assert macro, but hotspot has its
60// own standards incompatible assert macro that takes two parameters.
61// The workaround is to undef assert and then re-define it. The re-definition
62// must unfortunately be copied since debug.hpp might already have been
63// included and a second include wouldn't work due to the header guards in debug.hpp.
64#ifdef assert
65 #undef assert
66 #ifdef vmassert
67 #define assert(p, ...) vmassert(p, __VA_ARGS__)
68 #endif
69#endif
70
71#define CONCAT(a, b) a ## b
72
73#define TEST(category, name) GTEST_TEST(category, CONCAT(name, _test))
74
75#define TEST_VM(category, name) GTEST_TEST(category, CONCAT(name, _test_vm))
76
77#define TEST_VM_F(test_fixture, name) \
78 GTEST_TEST_(test_fixture, name ## _test_vm, test_fixture, \
79 ::testing::internal::GetTypeId<test_fixture>())
80
81#define TEST_OTHER_VM(category, name) \
82 static void test_ ## category ## _ ## name ## _(); \
83 \
84 static void child_ ## category ## _ ## name ## _() { \
85 ::testing::GTEST_FLAG(throw_on_failure) = true; \
86 test_ ## category ## _ ## name ## _(); \
87 fprintf(stderr, "OKIDOKI"); \
88 exit(0); \
89 } \
90 \
91 TEST(category, CONCAT(name, _other_vm)) { \
92 ASSERT_EXIT(child_ ## category ## _ ## name ## _(), \
93 ::testing::ExitedWithCode(0), \
94 ".*OKIDOKI.*"); \
95 } \
96 \
97 void test_ ## category ## _ ## name ## _()
98
99#ifdef ASSERT
100#define TEST_VM_ASSERT(category, name) \
101 static void test_ ## category ## _ ## name ## _(); \
102 \
103 static void child_ ## category ## _ ## name ## _() { \
104 ::testing::GTEST_FLAG(throw_on_failure) = true; \
105 test_ ## category ## _ ## name ## _(); \
106 exit(0); \
107 } \
108 \
109 TEST(category, CONCAT(name, _vm_assert)) { \
110 ASSERT_EXIT(child_ ## category ## _ ## name ## _(), \
111 ::testing::ExitedWithCode(1), \
112 "assert failed"); \
113 } \
114 \
115 void test_ ## category ## _ ## name ## _()
116#else
117#define TEST_VM_ASSERT(...) \
118 TEST_VM_ASSERT is only available in debug builds
119#endif
120
121#ifdef ASSERT
122#define TEST_VM_ASSERT_MSG(category, name, msg) \
123 static void test_ ## category ## _ ## name ## _(); \
124 \
125 static void child_ ## category ## _ ## name ## _() { \
126 ::testing::GTEST_FLAG(throw_on_failure) = true; \
127 test_ ## category ## _ ## name ## _(); \
128 exit(0); \
129 } \
130 \
131 TEST(category, CONCAT(name, _vm_assert)) { \
132 ASSERT_EXIT(child_ ## category ## _ ## name ## _(), \
133 ::testing::ExitedWithCode(1), \
134 "^assert failed: " msg); \
135 } \
136 \
137 void test_ ## category ## _ ## name ## _()
138#else
139#define TEST_VM_ASSERT_MSG(...) \
140 TEST_VM_ASSERT_MSG is only available in debug builds
141#endif
142
143#endif // UNITTEST_HPP
144