blob: 0ad239a888f2a6b7f77f449ecae3160ae5c35e15 [file]
/*
* Copyright 2010-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
* that can be found in the LICENSE file.
*/
#include "Exceptions.h"
#include <csignal>
#include <memory>
#include <future>
#include "gtest/gtest.h"
#include "gmock/gmock.h"
#include "Memory.h"
#include "ObjectTestSupport.hpp"
#include "concurrent/ScopedThread.hpp"
#include "TestSupportCompilerGenerated.hpp"
#include "TestSupport.hpp"
using namespace kotlin;
using namespace testing;
using namespace kotlin;
using ::testing::_;
using ::kotlin::test_support::ScopedReportUnhandledExceptionMock;
using ::kotlin::test_support::ScopedKotlin_runUnhandledExceptionHookMock;
namespace {
struct Payload {
int value = 0;
static constexpr test_support::NoRefFields<Payload> kFields{};
};
using Object = test_support::Object<Payload>;
} // namespace
TEST(ExceptionTest, ProcessUnhandledException_WithHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
kotlin::RunInNewThread([&typeHolder]() {
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
EXPECT_CALL(*reportUnhandledExceptionMock, Call(_)).Times(0);
EXPECT_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillOnce([](KRef exception) {
EXPECT_THAT(Object::FromObjHeader(exception)->value, 42);
});
kotlin::ProcessUnhandledException(exception.header());
});
}
TEST(ExceptionDeathTest, ProcessUnhandledException_NoHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
kotlin::RunInNewThread([&typeHolder]() {
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
// Kotlin_runUnhandledExceptionHookMock rethrows original exception when hook is unset.
ThrowException(exception);
});
EXPECT_DEATH({ kotlin::ProcessUnhandledException(exception.header()); }, "Hook 42\nReporting 42\n");
});
}
TEST(ExceptionDeathTest, ProcessUnhandledException_WithFailingHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
kotlin::RunInNewThread([&typeHolder]() {
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
Object hookException(typeHolder.typeInfo());
hookException.header()->typeInfoOrMeta_ = setPointerBits(hookException.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
hookException->value = 13;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([&hookException](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
ThrowException(hookException.header());
});
EXPECT_DEATH({ kotlin::ProcessUnhandledException(exception.header()); }, "Hook 42\nReporting 13\n");
});
}
TEST(ExceptionDeathTest, ProcessUnhandledException_WithTerminatingFailingHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
kotlin::RunInNewThread([&typeHolder]() {
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
Object hookException(typeHolder.typeInfo());
hookException.header()->typeInfoOrMeta_ = setPointerBits(hookException.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
hookException->value = 13;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([&hookException](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
kotlin::TerminateWithUnhandledException(hookException.header());
});
EXPECT_DEATH({ kotlin::ProcessUnhandledException(exception.header()); }, "Hook 42\nReporting 13\n");
});
}
TEST(ExceptionDeathTest, TerminateWithUnhandledException) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
kotlin::RunInNewThread([&typeHolder]() {
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
});
EXPECT_DEATH({ kotlin::TerminateWithUnhandledException(exception.header()); }, "Reporting 42\n");
});
}
TEST(ExceptionDeathTest, TerminateHandler_WithHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
});
EXPECT_DEATH(
{
std::set_terminate([]() {
konan::consoleErrorf("Custom terminate\n");
if (auto exception = std::current_exception()) {
try {
std::rethrow_exception(exception);
} catch (int i) {
konan::consoleErrorf("Exception %d\n", i);
} catch (...) {
konan::consoleErrorf("Unknown Exception\n");
}
}
std::abort();
});
// The termination handler will check the initialization of the whole runtime, so we cannot use RunInNewThread here.
// This call also sets the K/N termination handler.
Kotlin_initRuntimeIfNeeded();
try {
ThrowException(exception.header());
} catch (...) {
std::terminate();
}
},
"Hook 42\n");
}
TEST(ExceptionDeathTest, TerminateHandler_NoHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
// Kotlin_runUnhandledExceptionHookMock rethrows original exception when hook is unset.
ThrowException(exception);
});
EXPECT_DEATH(
{
std::set_terminate([]() {
konan::consoleErrorf("Custom terminate\n");
if (auto exception = std::current_exception()) {
try {
std::rethrow_exception(exception);
} catch (int i) {
konan::consoleErrorf("Exception %d\n", i);
} catch (...) {
konan::consoleErrorf("Unknown Exception\n");
}
}
std::abort();
});
// The termination handler will check the initialization of the whole runtime, so we cannot use RunInNewThread here.
// This call also sets the K/N termination handler.
Kotlin_initRuntimeIfNeeded();
try {
ThrowException(exception.header());
} catch (...) {
std::terminate();
}
},
"Hook 42\nReporting 42\n");
}
TEST(ExceptionDeathTest, TerminateHandler_WithFailingHook) {
test_support::TypeInfoHolder typeHolder{test_support::TypeInfoHolder::ObjectBuilder<Payload>().setSuperType(theThrowableTypeInfo)};
Object exception(typeHolder.typeInfo());
exception.header()->typeInfoOrMeta_ = setPointerBits(exception.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
exception->value = 42;
Object hookException(typeHolder.typeInfo());
hookException.header()->typeInfoOrMeta_ = setPointerBits(hookException.header()->typeInfoOrMeta_, OBJECT_TAG_PERMANENT_CONTAINER);
hookException->value = 13;
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([&hookException](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
ThrowException(hookException.header());
});
EXPECT_DEATH(
{
std::set_terminate([]() {
konan::consoleErrorf("Custom terminate\n");
if (auto exception = std::current_exception()) {
try {
std::rethrow_exception(exception);
} catch (int i) {
konan::consoleErrorf("Exception %d\n", i);
} catch (...) {
konan::consoleErrorf("Unknown Exception\n");
}
}
std::abort();
});
// The termination handler will check the initialization of the whole runtime, so we cannot use RunInNewThread here.
// This call also sets the K/N termination handler.
Kotlin_initRuntimeIfNeeded();
try {
ThrowException(exception.header());
} catch (...) {
std::terminate();
}
},
"Hook 42\nReporting 13\n");
}
TEST(ExceptionDeathTest, TerminateHandler_IgnoreHooks) {
kotlin::RunInNewThread([]() {
auto reportUnhandledExceptionMock = ScopedReportUnhandledExceptionMock();
auto Kotlin_runUnhandledExceptionHookMock = ScopedKotlin_runUnhandledExceptionHookMock();
ON_CALL(*reportUnhandledExceptionMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Reporting %d\n", Object::FromObjHeader(exception)->value);
});
ON_CALL(*Kotlin_runUnhandledExceptionHookMock, Call(_)).WillByDefault([](KRef exception) {
konan::consoleErrorf("Hook %d\n", Object::FromObjHeader(exception)->value);
ThrowException(exception);
});
EXPECT_DEATH(
{
std::set_terminate([]() {
konan::consoleErrorf("Custom terminate\n");
if (auto exception = std::current_exception()) {
try {
std::rethrow_exception(exception);
} catch (int i) {
konan::consoleErrorf("Exception %d\n", i);
} catch (...) {
konan::consoleErrorf("Unknown Exception\n");
}
}
std::abort();
});
SetKonanTerminateHandler();
try {
throw 3;
} catch (...) {
std::terminate();
}
},
"Custom terminate\nException 3\n");
});
}
namespace {
using NativeHandlerMock = NiceMock<MockFunction<void(void)>>;
using OnUnhandledExceptionMock = NiceMock<MockFunction<void(KRef)>>;
std::unique_ptr<NativeHandlerMock> gNativeHandlerMock = nullptr;
std::unique_ptr<test_support::ScopedMockFunction<void(KRef), /* Strict = */ false>> gOnUnhandledExceptionMock = nullptr;
// Google Test's death tests do not fail in case of a failed EXPECT_*/ASSERT_* check in a death statement.
// To workaround it, manually check the conditions to be asserted, log all failed conditions and then
// validate that there were no failure messages.
void loggingAssert(bool condition, const char* message) noexcept {
if (!condition) {
std::cerr << "FAIL: " << message << std::endl;
}
}
void log(const char* message) noexcept {
std::cerr << message << std::endl;
}
NativeHandlerMock& setNativeTerminateHandler() noexcept {
gNativeHandlerMock = std::make_unique<NativeHandlerMock>();
std::set_terminate([]() {
gNativeHandlerMock->Call();
std::abort();
});
return *gNativeHandlerMock;
}
OnUnhandledExceptionMock& setKotlinTerminationHandler() noexcept {
gOnUnhandledExceptionMock = std::make_unique<test_support::ScopedMockFunction<void(KRef), /* Strict = */ false>>(
ScopedKotlin_runUnhandledExceptionHookMock</* Strict = */ false>());
SetKonanTerminateHandler();
return gOnUnhandledExceptionMock->get();
}
void setupMocks(bool expectRegisteredThread = true) noexcept {
auto& nativeHandlerMock = setNativeTerminateHandler();
ON_CALL(nativeHandlerMock, Call)
.WillByDefault([expectRegisteredThread]() {
if (expectRegisteredThread) {
loggingAssert(mm::IsCurrentThreadRegistered(), "Expected registered thread in the native handler");
loggingAssert(GetThreadState() == ThreadState::kNative, "Expected kNative thread state in the native handler");
} else {
loggingAssert(!mm::IsCurrentThreadRegistered(), "Expected unregistered thread in the native handler");
}
log("Native handler");
});
auto& onUnhandledExceptionMock = setKotlinTerminationHandler();
ON_CALL(onUnhandledExceptionMock, Call)
.WillByDefault([]() {
loggingAssert(GetThreadState() == ThreadState::kRunnable, "Expected kRunnable state in the Kotlin handler");
log("Kotlin handler");
});
}
} // namespace
#define ASSERTS_PASSED AllOf(Not(HasSubstr("FAIL")), Not(HasSubstr("runtime assert")))
#define KOTLIN_HANDLER_RAN HasSubstr("Kotlin handler")
#define NATIVE_HANDLER_RAN HasSubstr("Native handler")
TEST(TerminationThreadStateDeathTest, TerminationInRunnableState) {
auto testBlock = []() {
setupMocks();
ScopedMemoryInit init;
loggingAssert(GetThreadState() == ThreadState::kRunnable, "Expected kRunnable thread state before std::terminate");
std::terminate();
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, TerminationInNativeState) {
auto testBlock = []() {
setupMocks();
ScopedMemoryInit init;
ThreadStateGuard stateGuard(ThreadState::kNative);
loggingAssert(GetThreadState() == ThreadState::kNative, "Expected native thread state before std::terminate");
std::terminate();
};
EXPECT_DEATH(testBlock(),
AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, TerminationInForeignThread) {
auto testBlock = []() {
setupMocks(/* expectRegisteredThread = */ false);
loggingAssert(!mm::IsCurrentThreadRegistered(), "Expected unregistered thread before std::terminate");
std::terminate();
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, UnhandledKotlinExceptionInRunnableState) {
auto testBlock = []() {
setupMocks();
// Do not use RunInNewThread because the termination handler will check initiliazation
// of the whole runtime while RunInNewThread initializes the memory only.
ScopedThread([]() {
Kotlin_initRuntimeIfNeeded();
SwitchThreadState(mm::GetMemoryState(), ThreadState::kRunnable);
loggingAssert(GetThreadState() == ThreadState::kRunnable, "Expected kRunanble thread state before throwing");
ObjHeader exception{};
ExceptionObjHolder::Throw(&exception);
});
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, KOTLIN_HANDLER_RAN, Not(NATIVE_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, UnhandledKotlinExceptionInNativeState) {
auto testBlock = []() {
setupMocks();
// This situation is possible if a Kotlin exception thrown by a Kotlin callback is re-thrown in
// another thread which is attached to the Kotlin runtime but has the kNative state.
// Do not use RunInNewThread because the termination handler will check initiliazation
// of the whole runtime while RunInNewThread initializes the memory only.
ScopedThread([]() {
Kotlin_initRuntimeIfNeeded();
loggingAssert(GetThreadState() == ThreadState::kNative, "Expected kNative thread state before throwing");
ObjHeader exception{};
ExceptionObjHolder::Throw(&exception);
});
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, KOTLIN_HANDLER_RAN, Not(NATIVE_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, UnhandledKotlinExceptionInForeignThread) {
auto testBlock = []() {
setupMocks(/* expectRegisteredThread = */ false);
// It is possible if a Kotlin exception thrown by a Kotlin callback is re-thrown in
// another thread which is not attached to the Kotlin runtime at all.
ScopedThread([]() {
loggingAssert(!mm::IsCurrentThreadRegistered(), "Expected unregistered thread before throwing");
auto future = std::async(std::launch::async, []() {
// Initial Kotlin exception throwing requires the runtime to be initialized.
// Do not use ScopedMemoryInit because it clears the stable ref queue
// of the current thread on deinitialization. After that the ExceptionObjHolder
// will contain a dangling pointer to the stable ref queue entry.
Kotlin_initRuntimeIfNeeded();
ObjHeader exception{};
ExceptionObjHolder::Throw(&exception);
});
// Re-throw the Kotlin exception in a foreign thread.
future.get();
});
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, KOTLIN_HANDLER_RAN, Not(NATIVE_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, UnhandledForeignExceptionInNativeState) {
auto testBlock = []() {
setupMocks();
RunInNewThread([](MemoryState* thread) {
SwitchThreadState(thread, ThreadState::kNative);
loggingAssert(GetThreadState(thread) == ThreadState::kNative, "Expected kNative thread state before throwing");
throw std::runtime_error("Foreign exception");
});
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}
TEST(TerminationThreadStateDeathTest, UnhandledForeignExceptionInForeignThread) {
auto testBlock = []() {
setupMocks(/* expectRegisteredThread = */ false);
ScopedThread([]() {
loggingAssert(!mm::IsCurrentThreadRegistered(), "Expected unregistered thread before throwing");
throw std::runtime_error("Foreign exception");
});
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}
// Model a filtering exception handler which terminates the program if an interop call throws a foreign exception.
TEST(TerminationThreadStateDeathTest, TerminationInForeignExceptionCatch) {
auto testBlock = []() {
setupMocks();
ScopedMemoryInit init;
loggingAssert(GetThreadState(init.memoryState()) == ThreadState::kRunnable, "Expected kRunnable state before catching");
try {
throw std::runtime_error("Foreign exception");
} catch(...) {
std::terminate();
}
};
EXPECT_DEATH(testBlock(), AllOf(ASSERTS_PASSED, NATIVE_HANDLER_RAN, Not(KOTLIN_HANDLER_RAN)));
}