[babeltrace.git] / tests / plugins / test_bin_info.c

/*
 * test_bin_info.c
 *
 * Babeltrace SO info tests
 *
 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
 * Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; under version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <inttypes.h>
#include <glib.h>

#include "common/macros.h"
#include "common/assert.h"
#include <lttng-utils/debug-info/bin-info.h>

#include "tap/tap.h"

#define NR_TESTS 57

#define SO_NAME "libhello_so"
#define DEBUG_NAME "libhello_so.debug"
#define FUNC_FOO_FILENAME "./libhello.c"
#define FUNC_FOO_PRINTF_NAME_FMT "foo+0x%" PRIx64
#define FUNC_FOO_NAME_LEN 64

#define DWARF_DIR_NAME "dwarf_full"
#define ELF_DIR_NAME "elf_only"
#define BUILDID_DIR_NAME "build_id"
#define DEBUGLINK_DIR_NAME "debug_link"

/* Lower bound of PIC address mapping */
#define SO_LOW_ADDR 0x400000
/* Size of PIC address mapping */
#define SO_MEMSZ 0x800000
/* An address outside the PIC mapping */
#define SO_INV_ADDR 0x200000

#define BUILD_ID_HEX_LEN 20

static uint64_t opt_func_foo_addr;
static uint64_t opt_func_foo_printf_offset;
static uint64_t opt_func_foo_printf_line_no;
static uint64_t opt_func_foo_tp_offset;
static uint64_t opt_func_foo_tp_line_no;
static uint64_t opt_debug_link_crc;
static gchar *opt_build_id;
static gchar *opt_debug_info_dir;

static uint64_t func_foo_printf_addr;
static uint64_t func_foo_tp_addr;
static char func_foo_printf_name[FUNC_FOO_NAME_LEN];
static uint8_t build_id[BUILD_ID_HEX_LEN];

static GOptionEntry entries[] = {
	{"foo-addr", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_addr,
	 "Offset to printf in foo", "0xX"},
	{"printf-offset", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_printf_offset,
	 "Offset to printf in foo", "0xX"},
	{"printf-lineno", 0, 0, G_OPTION_ARG_INT64,
	 &opt_func_foo_printf_line_no, "Line number to printf in foo", "N"},
	{"tp-offset", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_tp_offset,
	 "Offset to tp in foo", "0xX"},
	{"tp-lineno", 0, 0, G_OPTION_ARG_INT64, &opt_func_foo_tp_line_no,
	 "Line number to tp in foo", "N"},
	{"debug-link-crc", 0, 0, G_OPTION_ARG_INT64, &opt_debug_link_crc,
	 "Debug link CRC", "0xX"},
	{"build-id", 0, 0, G_OPTION_ARG_STRING, &opt_build_id, "Build ID",
	 "XXXXXXXXXXXXXXX"},
	{"debug-info-dir", 0, 0, G_OPTION_ARG_STRING, &opt_debug_info_dir,
	 "Debug info directory", NULL},
	{NULL}};

static
int build_id_to_bin(void)
{
	int ret, len, i;

	if (opt_build_id == NULL) {
		goto error;
	}

	len = strnlen(opt_build_id, BUILD_ID_HEX_LEN * 2);
	if (len != (BUILD_ID_HEX_LEN * 2)) {
		goto error;
	}

	for (i = 0; i < (len / 2); i++) {
		ret = sscanf(opt_build_id + 2 * i, "%02hhx", &build_id[i]);
		if (ret != 1) {
			goto error;
		}
	}

	if (i != BUILD_ID_HEX_LEN) {
		goto error;
	}

	return 0;
error:
	return -1;
}

static
void subtest_has_address(struct bin_info *bin, uint64_t addr)
{
	int ret;

	ret = bin_info_has_address(bin, SO_LOW_ADDR - 1);
	ok(ret == 0, "bin_info_has_address - address under SO's range");

	ret = bin_info_has_address(bin, SO_LOW_ADDR);
	ok(ret == 1, "bin_info_has_address - lower bound of SO's range");

	ret = bin_info_has_address(bin, addr);
	ok(ret == 1, "bin_info_has_address - address in SO's range");

	ret = bin_info_has_address(bin, SO_LOW_ADDR + SO_MEMSZ - 1);
	ok(ret == 1, "bin_info_has_address - upper bound of SO's range");

	ret = bin_info_has_address(bin, SO_LOW_ADDR + SO_MEMSZ);
	ok(ret == 0, "bin_info_has_address - address above SO's range");
}

static
void subtest_lookup_function_name(struct bin_info *bin, uint64_t addr,
					 char *func_name)
{
	int ret;
	char *_func_name = NULL;

	ret = bin_info_lookup_function_name(bin, addr, &_func_name);
	ok(ret == 0, "bin_info_lookup_function_name successful at 0x%x", addr);
	if (_func_name) {
		ok(strcmp(_func_name, func_name) == 0,
		   "bin_info_lookup_function_name - correct function name (%s == %s)",
		   func_name, _func_name);
		free(_func_name);
		_func_name = NULL;
	} else {
		skip(1,
		     "bin_info_lookup_function_name - function name is NULL");
	}

	/* Test function name lookup - erroneous address */
	ret = bin_info_lookup_function_name(bin, SO_INV_ADDR, &_func_name);
	ok(ret == -1 && _func_name == NULL,
	   "bin_info_lookup_function_name - fail on invalid addr");
	if (_func_name) {
		free(_func_name);
	}
}

static
void subtest_lookup_source_location(struct bin_info *bin, uint64_t addr,
					   uint64_t line_no, char *filename)
{
	int ret;
	struct source_location *src_loc = NULL;

	ret = bin_info_lookup_source_location(bin, addr, &src_loc);
	ok(ret == 0, "bin_info_lookup_source_location successful at 0x%x",
	   addr);
	if (src_loc) {
		ok(src_loc->line_no == line_no,
		   "bin_info_lookup_source_location - correct line_no (%d == %d)",
		   line_no, src_loc->line_no);
		ok(strcmp(src_loc->filename, filename) == 0,
		   "bin_info_lookup_source_location - correct filename (%s == %s)",
		   filename, src_loc->filename);
		source_location_destroy(src_loc);
		src_loc = NULL;
	} else {
		fail("bin_info_lookup_source_location - src_loc is NULL");
		fail("bin_info_lookup_source_location - src_loc is NULL");
	}

	/* Test source location lookup - erroneous address */
	ret = bin_info_lookup_source_location(bin, SO_INV_ADDR, &src_loc);
	ok(ret == -1 && src_loc == NULL,
	   "bin_info_lookup_source_location - fail on invalid addr");
	if (src_loc) {
		source_location_destroy(src_loc);
	}
}

static
void test_bin_info_build_id(const char *bin_info_dir)
{
	int ret;
	char *data_dir, *bin_path;
	struct bin_info *bin = NULL;
	struct bt_fd_cache fdc;
	uint8_t invalid_build_id[BUILD_ID_HEX_LEN] = {
		0xa3, 0xfd, 0x8b, 0xff, 0x45, 0xe1, 0xa9, 0x32, 0x15, 0xdd,
		0x6d, 0xaa, 0xd5, 0x53, 0x98, 0x7e, 0xaf, 0xd4, 0x0c, 0xbb
	};

	diag("bin-info tests - separate DWARF via build ID");

	data_dir = g_build_filename(bin_info_dir, BUILDID_DIR_NAME, NULL);
	bin_path =
		g_build_filename(bin_info_dir, BUILDID_DIR_NAME, SO_NAME, NULL);

	if (data_dir == NULL || bin_path == NULL) {
		exit(EXIT_FAILURE);
	}

	ret = bt_fd_cache_init(&fdc);
	if (ret != 0) {
		diag("Failed to initialize FD cache");
		exit(EXIT_FAILURE);
	}

	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
			      data_dir, NULL);
	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);

	/* Test setting invalid build_id */
	ret = bin_info_set_build_id(bin, invalid_build_id, BUILD_ID_HEX_LEN);
	ok(ret == -1, "bin_info_set_build_id fail on invalid build_id");

	/* Test setting correct build_id */
	ret = bin_info_set_build_id(bin, build_id, BUILD_ID_HEX_LEN);
	ok(ret == 0, "bin_info_set_build_id successful");

	/* Test bin_info_has_address */
	subtest_has_address(bin, func_foo_printf_addr);

	/* Test function name lookup (with DWARF) */
	subtest_lookup_function_name(bin, func_foo_printf_addr,
				     func_foo_printf_name);

	/* Test source location lookup */
	subtest_lookup_source_location(bin, func_foo_printf_addr,
				       opt_func_foo_printf_line_no,
				       FUNC_FOO_FILENAME);

	bin_info_destroy(bin);
	bt_fd_cache_fini(&fdc);
	g_free(data_dir);
	g_free(bin_path);
}

static
void test_bin_info_debug_link(const char *bin_info_dir)
{
	int ret;
	char *data_dir, *bin_path;
	struct bin_info *bin = NULL;
	struct bt_fd_cache fdc;

	diag("bin-info tests - separate DWARF via debug link");

	data_dir = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, NULL);
	bin_path = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, SO_NAME,
				    NULL);

	if (data_dir == NULL || bin_path == NULL) {
		exit(EXIT_FAILURE);
	}

	ret = bt_fd_cache_init(&fdc);
	if (ret != 0) {
		diag("Failed to initialize FD cache");
		exit(EXIT_FAILURE);
	}

	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
			      data_dir, NULL);
	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);

	/* Test setting debug link */
	ret = bin_info_set_debug_link(bin, DEBUG_NAME, opt_debug_link_crc);
	ok(ret == 0, "bin_info_set_debug_link successful");

	/* Test bin_info_has_address */
	subtest_has_address(bin, func_foo_printf_addr);

	/* Test function name lookup (with DWARF) */
	subtest_lookup_function_name(bin, func_foo_printf_addr,
				     func_foo_printf_name);

	/* Test source location lookup */
	subtest_lookup_source_location(bin, func_foo_printf_addr,
				       opt_func_foo_printf_line_no,
				       FUNC_FOO_FILENAME);

	bin_info_destroy(bin);
	bt_fd_cache_fini(&fdc);
	g_free(data_dir);
	g_free(bin_path);
}

static
void test_bin_info_elf(const char *bin_info_dir)
{
	int ret;
	char *data_dir, *bin_path;
	struct bin_info *bin = NULL;
	struct source_location *src_loc = NULL;
	struct bt_fd_cache fdc;

	diag("bin-info tests - ELF only");

	data_dir = g_build_filename(bin_info_dir, ELF_DIR_NAME, NULL);
	bin_path = g_build_filename(bin_info_dir, ELF_DIR_NAME, SO_NAME, NULL);

	if (data_dir == NULL || bin_path == NULL) {
		exit(EXIT_FAILURE);
	}

	ret = bt_fd_cache_init(&fdc);
	if (ret != 0) {
		diag("Failed to initialize FD cache");
		exit(EXIT_FAILURE);
	}

	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
			      data_dir, NULL);
	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);

	/* Test bin_info_has_address */
	subtest_has_address(bin, func_foo_printf_addr);

	/* Test function name lookup (with ELF) */
	subtest_lookup_function_name(bin, func_foo_printf_addr,
				     func_foo_printf_name);

	/* Test source location location - should fail on ELF only file  */
	ret = bin_info_lookup_source_location(bin, func_foo_printf_addr,
					      &src_loc);
	ok(ret == -1,
	   "bin_info_lookup_source_location - fail on ELF only file");

	source_location_destroy(src_loc);
	bin_info_destroy(bin);
	bt_fd_cache_fini(&fdc);
	g_free(data_dir);
	g_free(bin_path);
}

static
void test_bin_info_bundled(const char *bin_info_dir)
{
	int ret;
	char *data_dir, *bin_path;
	struct bin_info *bin = NULL;
	struct bt_fd_cache fdc;

	diag("bin-info tests - DWARF bundled in SO file");

	data_dir = g_build_filename(bin_info_dir, DWARF_DIR_NAME, NULL);
	bin_path =
		g_build_filename(bin_info_dir, DWARF_DIR_NAME, SO_NAME, NULL);

	if (data_dir == NULL || bin_path == NULL) {
		exit(EXIT_FAILURE);
	}

	ret = bt_fd_cache_init(&fdc);
	if (ret != 0) {
		diag("Failed to initialize FD cache");
		exit(EXIT_FAILURE);
	}

	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
			      data_dir, NULL);
	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);

	/* Test bin_info_has_address */
	subtest_has_address(bin, func_foo_printf_addr);

	/* Test function name lookup (with DWARF) */
	subtest_lookup_function_name(bin, func_foo_printf_addr,
				     func_foo_printf_name);

	/* Test source location lookup */
	subtest_lookup_source_location(bin, func_foo_printf_addr,
				       opt_func_foo_printf_line_no,
				       FUNC_FOO_FILENAME);

	/* Test source location lookup - inlined function */
	subtest_lookup_source_location(bin, func_foo_tp_addr,
				       opt_func_foo_tp_line_no,
				       FUNC_FOO_FILENAME);

	bin_info_destroy(bin);
	bt_fd_cache_fini(&fdc);
	g_free(data_dir);
	g_free(bin_path);
}

int main(int argc, char **argv)
{
	int ret;
	GError *error = NULL;
	GOptionContext *context;

	context = g_option_context_new("- bin info test");
	g_option_context_add_main_entries(context, entries, NULL);
	if (!g_option_context_parse(context, &argc, &argv, &error)) {
		fprintf(stderr, "option parsing failed: %s\n", error->message);
		exit(EXIT_FAILURE);
	}

	g_snprintf(func_foo_printf_name, FUNC_FOO_NAME_LEN,
		   FUNC_FOO_PRINTF_NAME_FMT, opt_func_foo_printf_offset);
	func_foo_printf_addr =
		SO_LOW_ADDR + opt_func_foo_addr + opt_func_foo_printf_offset;
	func_foo_tp_addr =
		SO_LOW_ADDR + opt_func_foo_addr + opt_func_foo_tp_offset;

	if (build_id_to_bin()) {
		fprintf(stderr, "Failed to parse / missing build id\n");
		exit(EXIT_FAILURE);
	}

	plan_tests(NR_TESTS);

	ret = bin_info_init();
	ok(ret == 0, "bin_info_init successful");

	test_bin_info_elf(opt_debug_info_dir);
	test_bin_info_bundled(opt_debug_info_dir);
	test_bin_info_build_id(opt_debug_info_dir);
	test_bin_info_debug_link(opt_debug_info_dir);

	return EXIT_SUCCESS;
}
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>
882adb99 MJ	28	#include <glib.h>
1e638f98	29
91d81473	30	#include "common/macros.h"
578e048b	31	#include "common/assert.h"
c283522b	32	#include <lttng-utils/debug-info/bin-info.h>
1e638f98	33
6ab5bdaa AB	34	#include "tap/tap.h"
6ab5bdaa AB	35
882adb99 MJ	36	#define NR_TESTS 57
882adb99 MJ	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
6ab5bdaa AB	204	static
6a284733	205	void test_bin_info_build_id(const char *bin_info_dir)
6ab5bdaa AB	206	{
6ab5bdaa AB	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] = {
882adb99 MJ	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 =
882adb99 MJ	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	226	ret = bt_fd_cache_init(&fdc);
7de0939d MJ	227	if (ret != 0) {
	228	diag("Failed to initialize FD cache");
	229	exit(EXIT_FAILURE);
	230	}
6ab5bdaa	231
882adb99 MJ	232	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
	233	data_dir, NULL);
	234	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);
	235
	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");
	239
	240	/* Test setting correct build_id */
	241	ret = bin_info_set_build_id(bin, build_id, BUILD_ID_HEX_LEN);
4caab45b	242	ok(ret == 0, "bin_info_set_build_id successful");
6ab5bdaa	243
882adb99 MJ	244	/* Test bin_info_has_address */
	245	subtest_has_address(bin, func_foo_printf_addr);
	246
6ab5bdaa	247	/* Test function name lookup (with DWARF) */
882adb99 MJ	248	subtest_lookup_function_name(bin, func_foo_printf_addr,
882adb99 MJ	249	func_foo_printf_name);
6ab5bdaa AB	250
6ab5bdaa AB	251	/* Test source location lookup */
882adb99 MJ	252	subtest_lookup_source_location(bin, func_foo_printf_addr,
	253	opt_func_foo_printf_line_no,
	254	FUNC_FOO_FILENAME);
6ab5bdaa	255
d5ddf820	256	bin_info_destroy(bin);
1e638f98	257	bt_fd_cache_fini(&fdc);
6a284733 MJ	258	g_free(data_dir);
6a284733 MJ	259	g_free(bin_path);
6ab5bdaa AB	260	}
	261
	262	static
6a284733	263	void test_bin_info_debug_link(const char *bin_info_dir)
6ab5bdaa AB	264	{
6ab5bdaa AB	265	int ret;
6a284733	266	char data_dir, bin_path;
d5ddf820	267	struct bin_info *bin = NULL;
1e638f98	268	struct bt_fd_cache fdc;
6ab5bdaa	269
d5ddf820	270	diag("bin-info tests - separate DWARF via debug link");
6ab5bdaa	271
6a284733	272	data_dir = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, NULL);
882adb99 MJ	273	bin_path = g_build_filename(bin_info_dir, DEBUGLINK_DIR_NAME, SO_NAME,
882adb99 MJ	274	NULL);
6a284733 MJ	275
	276	if (data_dir == NULL \|\| bin_path == NULL) {
	277	exit(EXIT_FAILURE);
	278	}
6ab5bdaa	279
1e638f98	280	ret = bt_fd_cache_init(&fdc);
7de0939d MJ	281	if (ret != 0) {
	282	diag("Failed to initialize FD cache");
	283	exit(EXIT_FAILURE);
	284	}
882adb99 MJ	285
	286	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
	287	data_dir, NULL);
	288	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);
6ab5bdaa AB	289
6ab5bdaa AB	290	/* Test setting debug link */
882adb99	291	ret = bin_info_set_debug_link(bin, DEBUG_NAME, opt_debug_link_crc);
4caab45b	292	ok(ret == 0, "bin_info_set_debug_link successful");
6ab5bdaa	293
882adb99 MJ	294	/* Test bin_info_has_address */
	295	subtest_has_address(bin, func_foo_printf_addr);
	296
6ab5bdaa	297	/* Test function name lookup (with DWARF) */
882adb99 MJ	298	subtest_lookup_function_name(bin, func_foo_printf_addr,
882adb99 MJ	299	func_foo_printf_name);
6ab5bdaa AB	300
6ab5bdaa AB	301	/* Test source location lookup */
882adb99 MJ	302	subtest_lookup_source_location(bin, func_foo_printf_addr,
	303	opt_func_foo_printf_line_no,
	304	FUNC_FOO_FILENAME);
6ab5bdaa	305
d5ddf820	306	bin_info_destroy(bin);
1e638f98	307	bt_fd_cache_fini(&fdc);
6a284733 MJ	308	g_free(data_dir);
6a284733 MJ	309	g_free(bin_path);
6ab5bdaa AB	310	}
	311
	312	static
6a284733	313	void test_bin_info_elf(const char *bin_info_dir)
6ab5bdaa AB	314	{
6ab5bdaa AB	315	int ret;
6a284733	316	char data_dir, bin_path;
d5ddf820	317	struct bin_info *bin = NULL;
6ab5bdaa	318	struct source_location *src_loc = NULL;
1e638f98	319	struct bt_fd_cache fdc;
6ab5bdaa	320
d5ddf820	321	diag("bin-info tests - ELF only");
6ab5bdaa	322
6a284733 MJ	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);
	325
	326	if (data_dir == NULL \|\| bin_path == NULL) {
	327	exit(EXIT_FAILURE);
	328	}
6ab5bdaa	329
1e638f98	330	ret = bt_fd_cache_init(&fdc);
7de0939d MJ	331	if (ret != 0) {
	332	diag("Failed to initialize FD cache");
	333	exit(EXIT_FAILURE);
	334	}
6ab5bdaa	335
882adb99 MJ	336	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
	337	data_dir, NULL);
	338	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);
6ab5bdaa	339
882adb99 MJ	340	/* Test bin_info_has_address */
	341	subtest_has_address(bin, func_foo_printf_addr);
	342
	343	/* Test function name lookup (with ELF) */
	344	subtest_lookup_function_name(bin, func_foo_printf_addr,
	345	func_foo_printf_name);
6ab5bdaa AB	346
6ab5bdaa AB	347	/* Test source location location - should fail on ELF only file */
882adb99 MJ	348	ret = bin_info_lookup_source_location(bin, func_foo_printf_addr,
	349	&src_loc);
	350	ok(ret == -1,
	351	"bin_info_lookup_source_location - fail on ELF only file");
6ab5bdaa AB	352
6ab5bdaa AB	353	source_location_destroy(src_loc);
d5ddf820	354	bin_info_destroy(bin);
1e638f98	355	bt_fd_cache_fini(&fdc);
6a284733 MJ	356	g_free(data_dir);
6a284733 MJ	357	g_free(bin_path);
6ab5bdaa AB	358	}
	359
	360	static
882adb99	361	void test_bin_info_bundled(const char *bin_info_dir)
6ab5bdaa AB	362	{
6ab5bdaa AB	363	int ret;
6a284733	364	char data_dir, bin_path;
d5ddf820	365	struct bin_info *bin = NULL;
1e638f98	366	struct bt_fd_cache fdc;
6ab5bdaa	367
882adb99	368	diag("bin-info tests - DWARF bundled in SO file");
1e638f98	369
6a284733	370	data_dir = g_build_filename(bin_info_dir, DWARF_DIR_NAME, NULL);
882adb99 MJ	371	bin_path =
882adb99 MJ	372	g_build_filename(bin_info_dir, DWARF_DIR_NAME, SO_NAME, NULL);
6a284733 MJ	373
	374	if (data_dir == NULL \|\| bin_path == NULL) {
	375	exit(EXIT_FAILURE);
	376	}
6ab5bdaa	377
1e638f98	378	ret = bt_fd_cache_init(&fdc);
7de0939d MJ	379	if (ret != 0) {
	380	diag("Failed to initialize FD cache");
	381	exit(EXIT_FAILURE);
	382	}
882adb99 MJ	383
	384	bin = bin_info_create(&fdc, bin_path, SO_LOW_ADDR, SO_MEMSZ, true,
	385	data_dir, NULL);
	386	ok(bin != NULL, "bin_info_create successful (%s)", bin_path);
d5ddf820 AB	387
d5ddf820 AB	388	/* Test bin_info_has_address */
882adb99	389	subtest_has_address(bin, func_foo_printf_addr);
6ab5bdaa AB	390
6ab5bdaa AB	391	/* Test function name lookup (with DWARF) */
882adb99 MJ	392	subtest_lookup_function_name(bin, func_foo_printf_addr,
882adb99 MJ	393	func_foo_printf_name);
6ab5bdaa AB	394
6ab5bdaa AB	395	/* Test source location lookup */
882adb99 MJ	396	subtest_lookup_source_location(bin, func_foo_printf_addr,
	397	opt_func_foo_printf_line_no,
	398	FUNC_FOO_FILENAME);
6ab5bdaa AB	399
6ab5bdaa AB	400	/* Test source location lookup - inlined function */
882adb99 MJ	401	subtest_lookup_source_location(bin, func_foo_tp_addr,
	402	opt_func_foo_tp_line_no,
	403	FUNC_FOO_FILENAME);
6ab5bdaa	404
d5ddf820	405	bin_info_destroy(bin);
1e638f98	406	bt_fd_cache_fini(&fdc);
6a284733 MJ	407	g_free(data_dir);
6a284733 MJ	408	g_free(bin_path);
6ab5bdaa AB	409	}
	410
	411	int main(int argc, char **argv)
	412	{
	413	int ret;
882adb99 MJ	414	GError *error = NULL;
882adb99 MJ	415	GOptionContext *context;
6ab5bdaa	416
882adb99 MJ	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);
	421	exit(EXIT_FAILURE);
	422	}
6ab5bdaa	423
882adb99 MJ	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;
	428	func_foo_tp_addr =
	429	SO_LOW_ADDR + opt_func_foo_addr + opt_func_foo_tp_offset;
	430
	431	if (build_id_to_bin()) {
	432	fprintf(stderr, "Failed to parse / missing build id\n");
	433	exit(EXIT_FAILURE);
6ab5bdaa AB	434	}
6ab5bdaa AB	435
882adb99 MJ	436	plan_tests(NR_TESTS);
882adb99 MJ	437
d5ddf820	438	ret = bin_info_init();
4caab45b	439	ok(ret == 0, "bin_info_init successful");
6ab5bdaa	440
d5ddf820	441	test_bin_info_elf(opt_debug_info_dir);
882adb99	442	test_bin_info_bundled(opt_debug_info_dir);
d5ddf820 AB	443	test_bin_info_build_id(opt_debug_info_dir);
d5ddf820 AB	444	test_bin_info_debug_link(opt_debug_info_dir);
6ab5bdaa AB	445
	446	return EXIT_SUCCESS;
	447	}