aboutsummaryrefslogtreecommitdiffstats
path: root/vespalib/src/tests/signalhandler/signalhandler_test.cpp
blob: f15233e78a3a77c451a2d6a7c0ef1e16875d8f71 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/vespalib/util/signalhandler.h>
#include <vespa/vespalib/gtest/gtest.h>
#include <gmock/gmock.h>
#include <latch>
#include <thread>
#include <unistd.h>

#include <vespa/log/log.h>
LOG_SETUP("signalhandler_test");

using namespace vespalib;
using namespace ::testing;

TEST(SignalHandlerTest, signal_handler_can_intercept_hooked_signals)
{
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(!SignalHandler::TERM.check());
    SignalHandler::INT.ignore();
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(!SignalHandler::TERM.check());
    SignalHandler::TERM.hook();
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(!SignalHandler::TERM.check());
    kill(getpid(), SIGINT);
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(!SignalHandler::TERM.check());
    kill(getpid(), SIGTERM);
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(SignalHandler::TERM.check());
    SignalHandler::TERM.clear();
    EXPECT_TRUE(!SignalHandler::INT.check());
    EXPECT_TRUE(!SignalHandler::TERM.check());
    EXPECT_EQ(0, system("res=`./vespalib_victim_app`; test \"$res\" = \"GOT TERM\""));
}

void my_cool_function(std::latch&, std::latch&) __attribute__((noinline));

// Could have used a single std::barrier<no op functor> here, but when using explicit
// phase latches it sort of feels like the semantics are more immediately obvious.
void my_cool_function(std::latch& arrival_latch, std::latch& departure_latch) {
    arrival_latch.arrive_and_wait();
    // Twiddle thumbs in departure latch until main test thread has dumped our stack
    departure_latch.arrive_and_wait();
}

TEST(SignalHandlerTest, can_dump_stack_of_another_thread)
{
    std::latch arrival_latch(2);
    std::latch departure_latch(2);

    std::thread t([&]{
        my_cool_function(arrival_latch, departure_latch);
    });
    arrival_latch.arrive_and_wait();

    auto trace = SignalHandler::get_cross_thread_stack_trace(t.native_handle());
    EXPECT_THAT(trace, HasSubstr("my_cool_function"));

    departure_latch.arrive_and_wait();
    t.join();
}

TEST(SignalHandlerTest, dumping_stack_of_an_ex_thread_does_not_crash)
{
    std::thread t([]() noexcept {
        // Do a lot of nothing at all.
    });
    auto tid = t.native_handle();
    t.join();
    auto trace = SignalHandler::get_cross_thread_stack_trace(tid);
    EXPECT_EQ(trace, "(pthread_kill() failed; could not get backtrace)");
}

string my_totally_tubular_and_groovy_function() __attribute__((noinline));
string my_totally_tubular_and_groovy_function() {
    return SignalHandler::get_cross_thread_stack_trace(pthread_self());
}

TEST(SignalHandlerTest, can_get_stack_trace_of_own_thread)
{
    auto trace = my_totally_tubular_and_groovy_function();
    EXPECT_THAT(trace, HasSubstr("my_totally_tubular_and_groovy_function"));
}

int main(int argc, char* argv[]) {
    ::testing::InitGoogleTest(&argc, argv);
    SignalHandler::enable_cross_thread_stack_tracing();
    return RUN_ALL_TESTS();
}