Debian Codegraph @

test/unit/tracing/stacktrace.cpp

raw
1 #include <vector>
2
3 #include <gtest/gtest.h>
4 #include <gtest/gtest-matchers.h>
5 #include <gmock/gmock.h>
6 #include <gmock/gmock-matchers.h>
7
8 #include "common.hpp"
9
10 #ifdef TEST_MODULE
11 import cpptrace;
12 #else
13 #include <cpptrace/cpptrace.hpp>
14 #endif
15
16
17 #ifdef _MSC_VER
18 #define CPPTRACE_FORCE_INLINE [[msvc::flatten]]
19 #else
20 #define CPPTRACE_FORCE_INLINE [[gnu::always_inline]] static
21 #endif
22
23
24
25 TEST(Stacktrace, Empty) {
26 cpptrace::stacktrace empty;
27 EXPECT_TRUE(empty.empty());
28 EXPECT_EQ(empty.to_string(), "Stack trace (most recent call first):\n<empty trace>");
29 }
30
31
32
33 CPPTRACE_FORCE_NO_INLINE void stacktrace_basic() {
34 static volatile int lto_guard; lto_guard = lto_guard + 1;
35 auto line = __LINE__ + 1;
36 auto trace = cpptrace::generate_trace();
37 ASSERT_GE(trace.frames.size(), 1);
38 EXPECT_FILE(trace.frames[0].filename, "stacktrace.cpp");
39 EXPECT_LINE(trace.frames[0].line.value(), line);
40 EXPECT_THAT(trace.frames[0].symbol, testing::HasSubstr("stacktrace_basic"));
41 }
42
43 TEST(Stacktrace, Basic) {
44 stacktrace_basic();
45 }
46
47
48
49 // NOTE: returning something and then return stacktrace_multi_3(line_numbers) * rand(); is done to prevent TCO even
50 // under LTO https://github.com/jeremy-rifkin/cpptrace/issues/179#issuecomment-2467302052
51 CPPTRACE_FORCE_NO_INLINE int stacktrace_multi_3(std::vector<int>& line_numbers) {
52 static volatile int lto_guard; lto_guard = lto_guard + 1;
53 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
54 auto trace = cpptrace::generate_trace();
55 if(trace.frames.size() < 4) {
56 ADD_FAILURE() << "trace.frames.size() >= 4";
57 return 2;
58 }
59 int i = 0;
60 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
61 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
62 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_multi_3"));
63 i++;
64 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
65 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
66 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_multi_2"));
67 i++;
68 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
69 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
70 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_multi_1"));
71 i++;
72 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
73 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
74 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("Stacktrace_MultipleFrames_Test::TestBody"));
75 return 2;
76 }
77
78 CPPTRACE_FORCE_NO_INLINE int stacktrace_multi_2(std::vector<int>& line_numbers) {
79 static volatile int lto_guard; lto_guard = lto_guard + 1;
80 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
81 return stacktrace_multi_3(line_numbers) * rand();
82 }
83
84 CPPTRACE_FORCE_NO_INLINE int stacktrace_multi_1(std::vector<int>& line_numbers) {
85 static volatile int lto_guard; lto_guard = lto_guard + 1;
86 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
87 return stacktrace_multi_2(line_numbers) * rand();
88 }
89
90 TEST(Stacktrace, MultipleFrames) {
91 std::vector<int> line_numbers;
92 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
93 stacktrace_multi_1(line_numbers);
94 }
95
96
97
98 CPPTRACE_FORCE_NO_INLINE cpptrace::raw_trace stacktrace_raw_resolve_3(std::vector<int>& line_numbers) {
99 static volatile int lto_guard; lto_guard = lto_guard + 1;
100 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
101 return cpptrace::generate_raw_trace();
102 }
103
104 CPPTRACE_FORCE_NO_INLINE cpptrace::raw_trace stacktrace_raw_resolve_2(std::vector<int>& line_numbers) {
105 static volatile int lto_guard; lto_guard = lto_guard + 1;
106 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
107 return stacktrace_raw_resolve_3(line_numbers);
108 }
109
110 CPPTRACE_FORCE_NO_INLINE cpptrace::raw_trace stacktrace_raw_resolve_1(std::vector<int>& line_numbers) {
111 static volatile int lto_guard; lto_guard = lto_guard + 1;
112 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
113 return stacktrace_raw_resolve_2(line_numbers);
114 }
115
116 TEST(Stacktrace, RawTraceResolution) {
117 std::vector<int> line_numbers;
118 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
119 auto raw = stacktrace_raw_resolve_1(line_numbers);
120 auto trace = raw.resolve();
121 ASSERT_GE(trace.frames.size(), 4);
122 int i = 0;
123 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
124 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
125 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_raw_resolve_3"));
126 i++;
127 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
128 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
129 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_raw_resolve_2"));
130 i++;
131 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
132 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
133 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_raw_resolve_1"));
134 i++;
135 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
136 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
137 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("Stacktrace_RawTraceResolution_Test::TestBody"));
138 }
139
140
141 #if defined(CPPTRACE_GET_SYMBOLS_WITH_LIBDWARF) && !defined(CPPTRACE_BUILD_NO_SYMBOLS)
142 CPPTRACE_FORCE_NO_INLINE int stacktrace_inline_resolution_3(std::vector<int>& line_numbers) {
143 static volatile int lto_guard; lto_guard = lto_guard + 1;
144 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
145 auto trace = cpptrace::generate_trace();
146 if(trace.frames.size() < 4) {
147 ADD_FAILURE() << "trace.frames.size() >= 4";
148 return 2;
149 }
150 int i = 0;
151 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
152 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
153 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_inline_resolution_3"));
154 EXPECT_FALSE(trace.frames[i].is_inline);
155 EXPECT_NE(trace.frames[i].raw_address, 0);
156 EXPECT_NE(trace.frames[i].object_address, 0);
157 i++;
158 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
159 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
160 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_inline_resolution_2"));
161 EXPECT_TRUE(trace.frames[i].is_inline);
162 EXPECT_EQ(trace.frames[i].raw_address, 0);
163 EXPECT_EQ(trace.frames[i].object_address, 0);
164 i++;
165 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
166 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
167 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("stacktrace_inline_resolution_1"));
168 EXPECT_FALSE(trace.frames[i].is_inline);
169 EXPECT_NE(trace.frames[i].raw_address, 0);
170 EXPECT_NE(trace.frames[i].object_address, 0);
171 i++;
172 EXPECT_FILE(trace.frames[i].filename, "stacktrace.cpp");
173 EXPECT_LINE(trace.frames[i].line.value(), line_numbers[i]);
174 EXPECT_THAT(trace.frames[i].symbol, testing::HasSubstr("Stacktrace_InlineResolution_Test::TestBody"));
175 EXPECT_FALSE(trace.frames[i].is_inline);
176 EXPECT_NE(trace.frames[i].raw_address, 0);
177 EXPECT_NE(trace.frames[i].object_address, 0);
178 return 2;
179 }
180
181 CPPTRACE_FORCE_INLINE int stacktrace_inline_resolution_2(std::vector<int>& line_numbers) {
182 static volatile int lto_guard; lto_guard = lto_guard + 1;
183 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
184 return stacktrace_inline_resolution_3(line_numbers) * rand();
185 }
186
187 CPPTRACE_FORCE_NO_INLINE int stacktrace_inline_resolution_1(std::vector<int>& line_numbers) {
188 static volatile int lto_guard; lto_guard = lto_guard + 1;
189 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
190 return stacktrace_inline_resolution_2(line_numbers) * rand();
191 }
192
193 TEST(Stacktrace, InlineResolution) {
194 std::vector<int> line_numbers;
195 line_numbers.insert(line_numbers.begin(), __LINE__ + 1);
196 stacktrace_inline_resolution_1(line_numbers);
197 }
198 #endif