Commit | Line | Data |
---|---|---|
6ab5bdaa | 1 | /* |
d5ddf820 | 2 | * test_bin_info.c |
6ab5bdaa AB |
3 | * |
4 | * Babeltrace SO info tests | |
5 | * | |
6 | * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation | |
7 | * Copyright (c) 2015 Antoine Busque <abusque@efficios.com> | |
882adb99 | 8 | * Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com> |
6ab5bdaa AB |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; under version 2 of the License. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License along | |
20 | * with this program; if not, write to the Free Software Foundation, Inc., | |
21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
22 | */ | |
23 | ||
24 | #include <stdio.h> | |
25 | #include <stdlib.h> | |
26 | #include <string.h> | |
882adb99 MJ |
27 | #include <inttypes.h> |
28 | #include <glib.h> | |
1e638f98 | 29 | |
882adb99 | 30 | #include <babeltrace/babeltrace-internal.h> |
1e638f98 | 31 | #include <babeltrace/assert-internal.h> |
c283522b | 32 | #include <lttng-utils/debug-info/bin-info.h> |
1e638f98 | 33 | |
6ab5bdaa AB |
34 | #include "tap/tap.h" |
35 | ||
882adb99 MJ |
36 | #define NR_TESTS 57 |
37 | ||
24d3147c | 38 | #define SO_NAME "libhello_so" |
882adb99 MJ |
39 | #define DEBUG_NAME "libhello_so.debug" |
40 | #define FUNC_FOO_FILENAME "./libhello.c" | |
41 | #define FUNC_FOO_PRINTF_NAME_FMT "foo+0x%" PRIx64 | |
42 | #define FUNC_FOO_NAME_LEN 64 | |
6a284733 MJ |
43 | |
44 | #define DWARF_DIR_NAME "dwarf_full" | |
45 | #define ELF_DIR_NAME "elf_only" | |
46 | #define BUILDID_DIR_NAME "build_id" | |
47 | #define DEBUGLINK_DIR_NAME "debug_link" | |
48 | ||
882adb99 | 49 | /* Lower bound of PIC address mapping */ |
6ab5bdaa | 50 | #define SO_LOW_ADDR 0x400000 |
882adb99 MJ |
51 | /* Size of PIC address mapping */ |
52 | #define SO_MEMSZ 0x800000 | |
53 | /* An address outside the PIC mapping */ | |
54 | #define SO_INV_ADDR 0x200000 | |
55 | ||
56 | #define BUILD_ID_HEX_LEN 20 | |
57 | ||
58 | static uint64_t opt_func_foo_addr; | |
59 | static uint64_t opt_func_foo_printf_offset; | |
60 | static uint64_t opt_func_foo_printf_line_no; | |
61 | static uint64_t opt_func_foo_tp_offset; | |
62 | static uint64_t opt_func_foo_tp_line_no; | |
63 | static uint64_t opt_debug_link_crc; | |
64 | static gchar *opt_build_id; | |
65 | static gchar *opt_debug_info_dir; | |
66 | ||
67 | static uint64_t func_foo_printf_addr; | |
68 | static uint64_t func_foo_tp_addr; | |
69 | static char func_foo_printf_name[FUNC_FOO_NAME_LEN]; | |
70 | static uint8_t build_id[BUILD_ID_HEX_LEN]; | |
71 | ||
72 | static GOptionEntry entries[] = { | |
73 | {"foo-addr", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_addr, | |
74 | "Offset to printf in foo", "0xX"}, | |
75 | {"printf-offset", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_printf_offset, | |
76 | "Offset to printf in foo", "0xX"}, | |
77 | {"printf-lineno", 0, 0, G_OPTION_ARG_INT64, | |
78 | &opt_func_foo_printf_line_no, "Line number to printf in foo", "N"}, | |
79 | {"tp-offset", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_tp_offset, | |
80 | "Offset to tp in foo", "0xX"}, | |
81 | {"tp-lineno", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_tp_line_no, | |
82 | "Line number to tp in foo", "N"}, | |
83 | {"debug-link-crc", 0, 0, G_OPTION_ARG_INT64, &opt_debug_link_crc, | |
84 | "Debug link CRC", "0xX"}, | |
85 | {"build-id", 0, 0, G_OPTION_ARG_STRING, &opt_build_id, "Build ID", | |
86 | "XXXXXXXXXXXXXXX"}, | |
87 | {"debug-info-dir", 0, 0, G_OPTION_ARG_STRING, &opt_debug_info_dir, | |
88 | "Debug info directory", NULL}, | |
89 | {NULL}}; | |
90 | ||
91 | static | |
92 | int build_id_to_bin(void) | |
93 | { | |
94 | int ret, len, i; | |
95 | ||
96 | if (opt_build_id == NULL) { | |
97 | goto error; | |
98 | } | |
99 | ||
100 | len = strnlen(opt_build_id, BUILD_ID_HEX_LEN * 2); | |
101 | if (len != (BUILD_ID_HEX_LEN * 2)) { | |
102 | goto error; | |
103 | } | |
104 | ||
105 | for (i = 0; i < (len / 2); i++) { | |
106 | ret = sscanf(opt_build_id + 2 * i, "%02hhx", &build_id[i]); | |
107 | if (ret != 1) { | |
108 | goto error; | |
109 | } | |
110 | } | |
111 | ||
112 | if (i != BUILD_ID_HEX_LEN) { | |
113 | goto error; | |
114 | } | |
115 | ||
116 | return 0; | |
117 | error: | |
118 | return -1; | |
119 | } | |
120 | ||
121 | static | |
122 | void subtest_has_address(struct bin_info *bin, uint64_t addr) | |
123 | { | |
124 | int ret; | |
125 | ||
126 | ret = bin_info_has_address(bin, SO_LOW_ADDR - 1); | |
127 | ok(ret == 0, "bin_info_has_address - address under SO's range"); | |
128 | ||
129 | ret = bin_info_has_address(bin, SO_LOW_ADDR); | |
130 | ok(ret == 1, "bin_info_has_address - lower bound of SO's range"); | |
131 | ||
132 | ret = bin_info_has_address(bin, addr); | |
133 | ok(ret == 1, "bin_info_has_address - address in SO's range"); | |
134 | ||
135 | ret = bin_info_has_address(bin, SO_LOW_ADDR + SO_MEMSZ - 1); | |
136 | ok(ret == 1, "bin_info_has_address - upper bound of SO's range"); | |
137 | ||
138 | ret = bin_info_has_address(bin, SO_LOW_ADDR + SO_MEMSZ); | |
139 | ok(ret == 0, "bin_info_has_address - address above SO's range"); | |
140 | } | |
141 | ||
142 | static | |
143 | void subtest_lookup_function_name(struct bin_info *bin, uint64_t addr, | |
144 | char *func_name) | |
145 | { | |
146 | int ret; | |
147 | char *_func_name = NULL; | |
148 | ||
149 | ret = bin_info_lookup_function_name(bin, addr, &_func_name); | |
150 | ok(ret == 0, "bin_info_lookup_function_name successful at 0x%x", addr); | |
151 | if (_func_name) { | |
152 | ok(strcmp(_func_name, func_name) == 0, | |
153 | "bin_info_lookup_function_name - correct function name (%s == %s)", | |
154 | func_name, _func_name); | |
155 | free(_func_name); | |
156 | _func_name = NULL; | |
157 | } else { | |
158 | skip(1, | |
159 | "bin_info_lookup_function_name - function name is NULL"); | |
160 | } | |
161 | ||
162 | /* Test function name lookup - erroneous address */ | |
163 | ret = bin_info_lookup_function_name(bin, SO_INV_ADDR, &_func_name); | |
164 | ok(ret == -1 && _func_name == NULL, | |
165 | "bin_info_lookup_function_name - fail on invalid addr"); | |
166 | if (_func_name) { | |
167 | free(_func_name); | |
168 | } | |
169 | } | |
170 | ||
171 | static | |
172 | void subtest_lookup_source_location(struct bin_info *bin, uint64_t addr, | |
173 | uint64_t line_no, char *filename) | |
174 | { | |
175 | int ret; | |
176 | struct source_location *src_loc = NULL; | |
177 | ||
178 | ret = bin_info_lookup_source_location(bin, addr, &src_loc); | |
179 | ok(ret == 0, "bin_info_lookup_source_location successful at 0x%x", | |
180 | addr); | |
181 | if (src_loc) { | |
182 | ok(src_loc->line_no == line_no, | |
183 | "bin_info_lookup_source_location - correct line_no (%d == %d)", | |
184 | line_no, src_loc->line_no); | |
185 | ok(strcmp(src_loc->filename, filename) == 0, | |
186 | "bin_info_lookup_source_location - correct filename (%s == %s)", | |
187 | filename, src_loc->filename); | |
188 | source_location_destroy(src_loc); | |
189 | src_loc = NULL; | |
190 | } else { | |
191 | fail("bin_info_lookup_source_location - src_loc is NULL"); | |
192 | fail("bin_info_lookup_source_location - src_loc is NULL"); | |
193 | } | |
194 | ||
195 | /* Test source location lookup - erroneous address */ | |
196 | ret = bin_info_lookup_source_location(bin, SO_INV_ADDR, &src_loc); | |
197 | ok(ret == -1 && src_loc == NULL, | |
198 | "bin_info_lookup_source_location - fail on invalid addr"); | |
199 | if (src_loc) { | |
200 | source_location_destroy(src_loc); | |
201 | } | |
202 | } | |
6ab5bdaa AB |
203 | |
204 | static | |
6a284733 | 205 | void test_bin_info_build_id(const char *bin_info_dir) |
6ab5bdaa AB |
206 | { |
207 | int ret; | |
6a284733 | 208 | char *data_dir, *bin_path; |
d5ddf820 | 209 | struct bin_info *bin = NULL; |
1e638f98 | 210 | struct bt_fd_cache fdc; |
882adb99 MJ |
211 | uint8_t invalid_build_id[BUILD_ID_HEX_LEN] = { |
212 | 0xa3, 0xfd, 0x8b, 0xff, 0x45, 0xe1, 0xa9, 0x32, 0x15, 0xdd, | |
6ab5bdaa AB |
213 | 0x6d, 0xaa, 0xd5, 0x53, 0x98, 0x7e, 0xaf, 0xd4, 0x0c, 0xbb |
214 | }; | |
215 | ||
d5ddf820 | 216 | diag("bin-info tests - separate DWARF via build ID"); |
6ab5bdaa | 217 | |
6a284733 | 218 | data_dir = g_build_filename(bin_info_dir, BUILDID_DIR_NAME, NULL); |
882adb99 MJ |
219 | bin_path = |
220 | g_build_filename(bin_info_dir, BUILDID_DIR_NAME, SO_NAME, NULL); | |
6a284733 MJ |
221 | |
222 | if (data_dir == NULL || bin_path == NULL) { | |
223 | exit(EXIT_FAILURE); | |
224 | } | |
6ab5bdaa | 225 | |
1e638f98 FD |
226 | ret = bt_fd_cache_init(&fdc); |
227 | BT_ASSERT(ret == 0); | |
6ab5bdaa | 228 | |
882adb99 MJ |
229 | bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true, |
230 | data_dir, NULL); | |
231 | ok(bin != NULL, "bin_info_create successful (%s)", bin_path); | |
232 | ||
233 | /* Test setting invalid build_id */ | |
234 | ret = bin_info_set_build_id(bin, invalid_build_id, BUILD_ID_HEX_LEN); | |
235 | ok(ret == -1, "bin_info_set_build_id fail on invalid build_id"); | |
236 | ||
237 | /* Test setting correct build_id */ | |
238 | ret = bin_info_set_build_id(bin, build_id, BUILD_ID_HEX_LEN); | |
4caab45b | 239 | ok(ret == 0, "bin_info_set_build_id successful"); |
6ab5bdaa | 240 | |
882adb99 MJ |
241 | /* Test bin_info_has_address */ |
242 | subtest_has_address(bin, func_foo_printf_addr); | |
243 | ||
6ab5bdaa | 244 | /* Test function name lookup (with DWARF) */ |
882adb99 MJ |
245 | subtest_lookup_function_name(bin, func_foo_printf_addr, |
246 | func_foo_printf_name); | |
6ab5bdaa AB |
247 | |
248 | /* Test source location lookup */ | |
882adb99 MJ |
249 | subtest_lookup_source_location(bin, func_foo_printf_addr, |
250 | opt_func_foo_printf_line_no, | |
251 | FUNC_FOO_FILENAME); | |
6ab5bdaa | 252 | |
d5ddf820 | 253 | bin_info_destroy(bin); |
1e638f98 | 254 | bt_fd_cache_fini(&fdc); |
6a284733 MJ |
255 | g_free(data_dir); |
256 | g_free(bin_path); | |
6ab5bdaa AB |
257 | } |
258 | ||
259 | static | |
6a284733 | 260 | void test_bin_info_debug_link(const char *bin_info_dir) |
6ab5bdaa AB |
261 | { |
262 | int ret; | |
6a284733 | 263 | char *data_dir, *bin_path; |
d5ddf820 | 264 | struct bin_info *bin = NULL; |
1e638f98 | 265 | struct bt_fd_cache fdc; |
6ab5bdaa | 266 | |
d5ddf820 | 267 | diag("bin-info tests - separate DWARF via debug link"); |
6ab5bdaa | 268 | |
6a284733 | 269 | data_dir = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, NULL); |
882adb99 MJ |
270 | bin_path = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, SO_NAME, |
271 | NULL); | |
6a284733 MJ |
272 | |
273 | if (data_dir == NULL || bin_path == NULL) { | |
274 | exit(EXIT_FAILURE); | |
275 | } | |
6ab5bdaa | 276 | |
1e638f98 FD |
277 | ret = bt_fd_cache_init(&fdc); |
278 | BT_ASSERT(ret == 0); | |
882adb99 MJ |
279 | |
280 | bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true, | |
281 | data_dir, NULL); | |
282 | ok(bin != NULL, "bin_info_create successful (%s)", bin_path); | |
6ab5bdaa AB |
283 | |
284 | /* Test setting debug link */ | |
882adb99 | 285 | ret = bin_info_set_debug_link(bin, DEBUG_NAME, opt_debug_link_crc); |
4caab45b | 286 | ok(ret == 0, "bin_info_set_debug_link successful"); |
6ab5bdaa | 287 | |
882adb99 MJ |
288 | /* Test bin_info_has_address */ |
289 | subtest_has_address(bin, func_foo_printf_addr); | |
290 | ||
6ab5bdaa | 291 | /* Test function name lookup (with DWARF) */ |
882adb99 MJ |
292 | subtest_lookup_function_name(bin, func_foo_printf_addr, |
293 | func_foo_printf_name); | |
6ab5bdaa AB |
294 | |
295 | /* Test source location lookup */ | |
882adb99 MJ |
296 | subtest_lookup_source_location(bin, func_foo_printf_addr, |
297 | opt_func_foo_printf_line_no, | |
298 | FUNC_FOO_FILENAME); | |
6ab5bdaa | 299 | |
d5ddf820 | 300 | bin_info_destroy(bin); |
1e638f98 | 301 | bt_fd_cache_fini(&fdc); |
6a284733 MJ |
302 | g_free(data_dir); |
303 | g_free(bin_path); | |
6ab5bdaa AB |
304 | } |
305 | ||
306 | static | |
6a284733 | 307 | void test_bin_info_elf(const char *bin_info_dir) |
6ab5bdaa AB |
308 | { |
309 | int ret; | |
6a284733 | 310 | char *data_dir, *bin_path; |
d5ddf820 | 311 | struct bin_info *bin = NULL; |
6ab5bdaa | 312 | struct source_location *src_loc = NULL; |
1e638f98 | 313 | struct bt_fd_cache fdc; |
6ab5bdaa | 314 | |
d5ddf820 | 315 | diag("bin-info tests - ELF only"); |
6ab5bdaa | 316 | |
6a284733 MJ |
317 | data_dir = g_build_filename(bin_info_dir, ELF_DIR_NAME, NULL); |
318 | bin_path = g_build_filename(bin_info_dir, ELF_DIR_NAME, SO_NAME, NULL); | |
319 | ||
320 | if (data_dir == NULL || bin_path == NULL) { | |
321 | exit(EXIT_FAILURE); | |
322 | } | |
6ab5bdaa | 323 | |
1e638f98 FD |
324 | ret = bt_fd_cache_init(&fdc); |
325 | BT_ASSERT(ret == 0); | |
6ab5bdaa | 326 | |
882adb99 MJ |
327 | bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true, |
328 | data_dir, NULL); | |
329 | ok(bin != NULL, "bin_info_create successful (%s)", bin_path); | |
6ab5bdaa | 330 | |
882adb99 MJ |
331 | /* Test bin_info_has_address */ |
332 | subtest_has_address(bin, func_foo_printf_addr); | |
333 | ||
334 | /* Test function name lookup (with ELF) */ | |
335 | subtest_lookup_function_name(bin, func_foo_printf_addr, | |
336 | func_foo_printf_name); | |
6ab5bdaa AB |
337 | |
338 | /* Test source location location - should fail on ELF only file */ | |
882adb99 MJ |
339 | ret = bin_info_lookup_source_location(bin, func_foo_printf_addr, |
340 | &src_loc); | |
341 | ok(ret == -1, | |
342 | "bin_info_lookup_source_location - fail on ELF only file"); | |
6ab5bdaa AB |
343 | |
344 | source_location_destroy(src_loc); | |
d5ddf820 | 345 | bin_info_destroy(bin); |
1e638f98 | 346 | bt_fd_cache_fini(&fdc); |
6a284733 MJ |
347 | g_free(data_dir); |
348 | g_free(bin_path); | |
6ab5bdaa AB |
349 | } |
350 | ||
351 | static | |
882adb99 | 352 | void test_bin_info_bundled(const char *bin_info_dir) |
6ab5bdaa AB |
353 | { |
354 | int ret; | |
6a284733 | 355 | char *data_dir, *bin_path; |
d5ddf820 | 356 | struct bin_info *bin = NULL; |
1e638f98 | 357 | struct bt_fd_cache fdc; |
6ab5bdaa | 358 | |
882adb99 | 359 | diag("bin-info tests - DWARF bundled in SO file"); |
1e638f98 | 360 | |
6a284733 | 361 | data_dir = g_build_filename(bin_info_dir, DWARF_DIR_NAME, NULL); |
882adb99 MJ |
362 | bin_path = |
363 | g_build_filename(bin_info_dir, DWARF_DIR_NAME, SO_NAME, NULL); | |
6a284733 MJ |
364 | |
365 | if (data_dir == NULL || bin_path == NULL) { | |
366 | exit(EXIT_FAILURE); | |
367 | } | |
6ab5bdaa | 368 | |
1e638f98 FD |
369 | ret = bt_fd_cache_init(&fdc); |
370 | BT_ASSERT(ret == 0); | |
882adb99 MJ |
371 | |
372 | bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true, | |
373 | data_dir, NULL); | |
374 | ok(bin != NULL, "bin_info_create successful (%s)", bin_path); | |
d5ddf820 AB |
375 | |
376 | /* Test bin_info_has_address */ | |
882adb99 | 377 | subtest_has_address(bin, func_foo_printf_addr); |
6ab5bdaa AB |
378 | |
379 | /* Test function name lookup (with DWARF) */ | |
882adb99 MJ |
380 | subtest_lookup_function_name(bin, func_foo_printf_addr, |
381 | func_foo_printf_name); | |
6ab5bdaa AB |
382 | |
383 | /* Test source location lookup */ | |
882adb99 MJ |
384 | subtest_lookup_source_location(bin, func_foo_printf_addr, |
385 | opt_func_foo_printf_line_no, | |
386 | FUNC_FOO_FILENAME); | |
6ab5bdaa AB |
387 | |
388 | /* Test source location lookup - inlined function */ | |
882adb99 MJ |
389 | subtest_lookup_source_location(bin, func_foo_tp_addr, |
390 | opt_func_foo_tp_line_no, | |
391 | FUNC_FOO_FILENAME); | |
6ab5bdaa | 392 | |
d5ddf820 | 393 | bin_info_destroy(bin); |
1e638f98 | 394 | bt_fd_cache_fini(&fdc); |
6a284733 MJ |
395 | g_free(data_dir); |
396 | g_free(bin_path); | |
6ab5bdaa AB |
397 | } |
398 | ||
399 | int main(int argc, char **argv) | |
400 | { | |
401 | int ret; | |
882adb99 MJ |
402 | GError *error = NULL; |
403 | GOptionContext *context; | |
6ab5bdaa | 404 | |
882adb99 MJ |
405 | context = g_option_context_new("- bin info test"); |
406 | g_option_context_add_main_entries(context, entries, NULL); | |
407 | if (!g_option_context_parse(context, &argc, &argv, &error)) { | |
408 | fprintf(stderr, "option parsing failed: %s\n", error->message); | |
409 | exit(EXIT_FAILURE); | |
410 | } | |
6ab5bdaa | 411 | |
882adb99 MJ |
412 | g_snprintf(func_foo_printf_name, FUNC_FOO_NAME_LEN, |
413 | FUNC_FOO_PRINTF_NAME_FMT, opt_func_foo_printf_offset); | |
414 | func_foo_printf_addr = | |
415 | SO_LOW_ADDR + opt_func_foo_addr + opt_func_foo_printf_offset; | |
416 | func_foo_tp_addr = | |
417 | SO_LOW_ADDR + opt_func_foo_addr + opt_func_foo_tp_offset; | |
418 | ||
419 | if (build_id_to_bin()) { | |
420 | fprintf(stderr, "Failed to parse / missing build id\n"); | |
421 | exit(EXIT_FAILURE); | |
6ab5bdaa AB |
422 | } |
423 | ||
882adb99 MJ |
424 | plan_tests(NR_TESTS); |
425 | ||
d5ddf820 | 426 | ret = bin_info_init(); |
4caab45b | 427 | ok(ret == 0, "bin_info_init successful"); |
6ab5bdaa | 428 | |
d5ddf820 | 429 | test_bin_info_elf(opt_debug_info_dir); |
882adb99 | 430 | test_bin_info_bundled(opt_debug_info_dir); |
d5ddf820 AB |
431 | test_bin_info_build_id(opt_debug_info_dir); |
432 | test_bin_info_debug_link(opt_debug_info_dir); | |
6ab5bdaa AB |
433 | |
434 | return EXIT_SUCCESS; | |
435 | } |