4 * Babeltrace SO info tests
6 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
7 * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
8 * Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
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.
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.
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.
30 #include <babeltrace2/babeltrace-internal.h>
31 #include <babeltrace2/assert-internal.h>
32 #include <lttng-utils/debug-info/bin-info.h>
38 #define SO_NAME "libhello_so"
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
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"
49 /* Lower bound of PIC address mapping */
50 #define SO_LOW_ADDR 0x400000
51 /* Size of PIC address mapping */
52 #define SO_MEMSZ 0x800000
53 /* An address outside the PIC mapping */
54 #define SO_INV_ADDR 0x200000
56 #define BUILD_ID_HEX_LEN 20
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
;
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
];
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",
87 {"debug-info-dir", 0, 0, G_OPTION_ARG_STRING
, &opt_debug_info_dir
,
88 "Debug info directory", NULL
},
92 int build_id_to_bin(void)
96 if (opt_build_id
== NULL
) {
100 len
= strnlen(opt_build_id
, BUILD_ID_HEX_LEN
* 2);
101 if (len
!= (BUILD_ID_HEX_LEN
* 2)) {
105 for (i
= 0; i
< (len
/ 2); i
++) {
106 ret
= sscanf(opt_build_id
+ 2 * i
, "%02hhx", &build_id
[i
]);
112 if (i
!= BUILD_ID_HEX_LEN
) {
122 void subtest_has_address(struct bin_info
*bin
, uint64_t addr
)
126 ret
= bin_info_has_address(bin
, SO_LOW_ADDR
- 1);
127 ok(ret
== 0, "bin_info_has_address - address under SO's range");
129 ret
= bin_info_has_address(bin
, SO_LOW_ADDR
);
130 ok(ret
== 1, "bin_info_has_address - lower bound of SO's range");
132 ret
= bin_info_has_address(bin
, addr
);
133 ok(ret
== 1, "bin_info_has_address - address in SO's range");
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");
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");
143 void subtest_lookup_function_name(struct bin_info
*bin
, uint64_t addr
,
147 char *_func_name
= NULL
;
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
);
152 ok(strcmp(_func_name
, func_name
) == 0,
153 "bin_info_lookup_function_name - correct function name (%s == %s)",
154 func_name
, _func_name
);
159 "bin_info_lookup_function_name - function name is NULL");
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");
172 void subtest_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
173 uint64_t line_no
, char *filename
)
176 struct source_location
*src_loc
= NULL
;
178 ret
= bin_info_lookup_source_location(bin
, addr
, &src_loc
);
179 ok(ret
== 0, "bin_info_lookup_source_location successful at 0x%x",
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
);
191 fail("bin_info_lookup_source_location - src_loc is NULL");
192 fail("bin_info_lookup_source_location - src_loc is NULL");
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");
200 source_location_destroy(src_loc
);
205 void test_bin_info_build_id(const char *bin_info_dir
)
208 char *data_dir
, *bin_path
;
209 struct bin_info
*bin
= NULL
;
210 struct bt_fd_cache fdc
;
211 uint8_t invalid_build_id
[BUILD_ID_HEX_LEN
] = {
212 0xa3, 0xfd, 0x8b, 0xff, 0x45, 0xe1, 0xa9, 0x32, 0x15, 0xdd,
213 0x6d, 0xaa, 0xd5, 0x53, 0x98, 0x7e, 0xaf, 0xd4, 0x0c, 0xbb
216 diag("bin-info tests - separate DWARF via build ID");
218 data_dir
= g_build_filename(bin_info_dir
, BUILDID_DIR_NAME
, NULL
);
220 g_build_filename(bin_info_dir
, BUILDID_DIR_NAME
, SO_NAME
, NULL
);
222 if (data_dir
== NULL
|| bin_path
== NULL
) {
226 ret
= bt_fd_cache_init(&fdc
);
228 diag("Failed to initialize FD cache");
232 bin
= bin_info_create(&fdc
, bin_path
, SO_LOW_ADDR
, SO_MEMSZ
, true,
234 ok(bin
!= NULL
, "bin_info_create successful (%s)", bin_path
);
236 /* Test setting invalid build_id */
237 ret
= bin_info_set_build_id(bin
, invalid_build_id
, BUILD_ID_HEX_LEN
);
238 ok(ret
== -1, "bin_info_set_build_id fail on invalid build_id");
240 /* Test setting correct build_id */
241 ret
= bin_info_set_build_id(bin
, build_id
, BUILD_ID_HEX_LEN
);
242 ok(ret
== 0, "bin_info_set_build_id successful");
244 /* Test bin_info_has_address */
245 subtest_has_address(bin
, func_foo_printf_addr
);
247 /* Test function name lookup (with DWARF) */
248 subtest_lookup_function_name(bin
, func_foo_printf_addr
,
249 func_foo_printf_name
);
251 /* Test source location lookup */
252 subtest_lookup_source_location(bin
, func_foo_printf_addr
,
253 opt_func_foo_printf_line_no
,
256 bin_info_destroy(bin
);
257 bt_fd_cache_fini(&fdc
);
263 void test_bin_info_debug_link(const char *bin_info_dir
)
266 char *data_dir
, *bin_path
;
267 struct bin_info
*bin
= NULL
;
268 struct bt_fd_cache fdc
;
270 diag("bin-info tests - separate DWARF via debug link");
272 data_dir
= g_build_filename(bin_info_dir
, DEBUGLINK_DIR_NAME
, NULL
);
273 bin_path
= g_build_filename(bin_info_dir
, DEBUGLINK_DIR_NAME
, SO_NAME
,
276 if (data_dir
== NULL
|| bin_path
== NULL
) {
280 ret
= bt_fd_cache_init(&fdc
);
282 diag("Failed to initialize FD cache");
286 bin
= bin_info_create(&fdc
, bin_path
, SO_LOW_ADDR
, SO_MEMSZ
, true,
288 ok(bin
!= NULL
, "bin_info_create successful (%s)", bin_path
);
290 /* Test setting debug link */
291 ret
= bin_info_set_debug_link(bin
, DEBUG_NAME
, opt_debug_link_crc
);
292 ok(ret
== 0, "bin_info_set_debug_link successful");
294 /* Test bin_info_has_address */
295 subtest_has_address(bin
, func_foo_printf_addr
);
297 /* Test function name lookup (with DWARF) */
298 subtest_lookup_function_name(bin
, func_foo_printf_addr
,
299 func_foo_printf_name
);
301 /* Test source location lookup */
302 subtest_lookup_source_location(bin
, func_foo_printf_addr
,
303 opt_func_foo_printf_line_no
,
306 bin_info_destroy(bin
);
307 bt_fd_cache_fini(&fdc
);
313 void test_bin_info_elf(const char *bin_info_dir
)
316 char *data_dir
, *bin_path
;
317 struct bin_info
*bin
= NULL
;
318 struct source_location
*src_loc
= NULL
;
319 struct bt_fd_cache fdc
;
321 diag("bin-info tests - ELF only");
323 data_dir
= g_build_filename(bin_info_dir
, ELF_DIR_NAME
, NULL
);
324 bin_path
= g_build_filename(bin_info_dir
, ELF_DIR_NAME
, SO_NAME
, NULL
);
326 if (data_dir
== NULL
|| bin_path
== NULL
) {
330 ret
= bt_fd_cache_init(&fdc
);
332 diag("Failed to initialize FD cache");
336 bin
= bin_info_create(&fdc
, bin_path
, SO_LOW_ADDR
, SO_MEMSZ
, true,
338 ok(bin
!= NULL
, "bin_info_create successful (%s)", bin_path
);
340 /* Test bin_info_has_address */
341 subtest_has_address(bin
, func_foo_printf_addr
);
343 /* Test function name lookup (with ELF) */
344 subtest_lookup_function_name(bin
, func_foo_printf_addr
,
345 func_foo_printf_name
);
347 /* Test source location location - should fail on ELF only file */
348 ret
= bin_info_lookup_source_location(bin
, func_foo_printf_addr
,
351 "bin_info_lookup_source_location - fail on ELF only file");
353 source_location_destroy(src_loc
);
354 bin_info_destroy(bin
);
355 bt_fd_cache_fini(&fdc
);
361 void test_bin_info_bundled(const char *bin_info_dir
)
364 char *data_dir
, *bin_path
;
365 struct bin_info
*bin
= NULL
;
366 struct bt_fd_cache fdc
;
368 diag("bin-info tests - DWARF bundled in SO file");
370 data_dir
= g_build_filename(bin_info_dir
, DWARF_DIR_NAME
, NULL
);
372 g_build_filename(bin_info_dir
, DWARF_DIR_NAME
, SO_NAME
, NULL
);
374 if (data_dir
== NULL
|| bin_path
== NULL
) {
378 ret
= bt_fd_cache_init(&fdc
);
380 diag("Failed to initialize FD cache");
384 bin
= bin_info_create(&fdc
, bin_path
, SO_LOW_ADDR
, SO_MEMSZ
, true,
386 ok(bin
!= NULL
, "bin_info_create successful (%s)", bin_path
);
388 /* Test bin_info_has_address */
389 subtest_has_address(bin
, func_foo_printf_addr
);
391 /* Test function name lookup (with DWARF) */
392 subtest_lookup_function_name(bin
, func_foo_printf_addr
,
393 func_foo_printf_name
);
395 /* Test source location lookup */
396 subtest_lookup_source_location(bin
, func_foo_printf_addr
,
397 opt_func_foo_printf_line_no
,
400 /* Test source location lookup - inlined function */
401 subtest_lookup_source_location(bin
, func_foo_tp_addr
,
402 opt_func_foo_tp_line_no
,
405 bin_info_destroy(bin
);
406 bt_fd_cache_fini(&fdc
);
411 int main(int argc
, char **argv
)
414 GError
*error
= NULL
;
415 GOptionContext
*context
;
417 context
= g_option_context_new("- bin info test");
418 g_option_context_add_main_entries(context
, entries
, NULL
);
419 if (!g_option_context_parse(context
, &argc
, &argv
, &error
)) {
420 fprintf(stderr
, "option parsing failed: %s\n", error
->message
);
424 g_snprintf(func_foo_printf_name
, FUNC_FOO_NAME_LEN
,
425 FUNC_FOO_PRINTF_NAME_FMT
, opt_func_foo_printf_offset
);
426 func_foo_printf_addr
=
427 SO_LOW_ADDR
+ opt_func_foo_addr
+ opt_func_foo_printf_offset
;
429 SO_LOW_ADDR
+ opt_func_foo_addr
+ opt_func_foo_tp_offset
;
431 if (build_id_to_bin()) {
432 fprintf(stderr
, "Failed to parse / missing build id\n");
436 plan_tests(NR_TESTS
);
438 ret
= bin_info_init();
439 ok(ret
== 0, "bin_info_init successful");
441 test_bin_info_elf(opt_debug_info_dir
);
442 test_bin_info_bundled(opt_debug_info_dir
);
443 test_bin_info_build_id(opt_debug_info_dir
);
444 test_bin_info_debug_link(opt_debug_info_dir
);