rizin/test/integration/test_dwarf_integration.c
Giovanni f87025d1e8
Remove cb_printf() from RzBin (#2446)
* Remove `cb_printf()` from RzBin
* Removed `bin.rawstr` from `rz-bin`
* Dropping `izzz` since does the same as `izz`
* Fix PE one section executables
* Fix behaviour of BFLT, LE, and SMD bin plugins
2022-03-26 20:30:55 +08:00

331 lines
15 KiB
C

// SPDX-FileCopyrightText: 2020 HoundThe <cgkajm@gmail.com>
// SPDX-License-Identifier: LGPL-3.0-only
#include <rz_analysis.h>
#include <rz_bin.h>
#include <rz_type.h>
#include <rz_util/rz_path.h>
#include "test_types.h"
#include "../unit/minunit.h"
#define check_kv(k, v) \
do { \
value = sdb_get(sdb, k, NULL); \
mu_assert_nullable_streq(value, v, "Wrong key - value pair"); \
} while (0)
static bool test_parse_dwarf_types(void) {
RzBin *bin = rz_bin_new();
mu_assert_notnull(bin, "Couldn't create new RzBin");
RzIO *io = rz_io_new();
mu_assert_notnull(io, "Couldn't create new RzIO");
RzAnalysis *analysis = rz_analysis_new();
mu_assert_notnull(analysis, "Couldn't create new RzAnalysis");
rz_io_bind(io, &bin->iob);
analysis->binb.demangle = rz_bin_demangle;
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_set_cpu(analysis, "x86");
rz_analysis_set_bits(analysis, 32);
char *types_dir = rz_path_system(RZ_SDB_TYPES);
rz_type_db_init(analysis->typedb, types_dir, "x86", 32, "linux");
free(types_dir);
RzBinOptions opt = { 0 };
RzBinFile *bf = rz_bin_open(bin, "bins/pe/vista-glass.exe", &opt);
mu_assert_notnull(bf, "couldn't open file");
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_use(analysis, "x86");
rz_analysis_set_bits(analysis, 32);
RzBinDwarfDebugAbbrev *abbrevs = rz_bin_dwarf_parse_abbrev(bin->cur);
mu_assert_notnull(abbrevs, "Couldn't parse Abbreviations");
RzBinDwarfDebugInfo *info = rz_bin_dwarf_parse_info(bin->cur, abbrevs);
mu_assert_notnull(info, "Couldn't parse debug_info section");
HtUP /*<offset, List *<LocListEntry>*/ *loc_table = rz_bin_dwarf_parse_loc(bin->cur, 4);
mu_assert_notnull(loc_table, "Couldn't parse loc section");
RzAnalysisDwarfContext ctx = {
.info = info,
.loc = loc_table
};
rz_analysis_dwarf_process_info(analysis, &ctx);
// Check the enum presence and validity
RzBaseType *cairo = rz_type_db_get_base_type(analysis->typedb, "_cairo_status");
mu_assert_eq(cairo->kind, RZ_BASE_TYPE_KIND_ENUM, "_cairo_status is enum");
mu_assert_true(has_enum_val(cairo, "CAIRO_STATUS_SUCCESS", 0), "CAIRO_STATUS_SUCCESS = 0x0");
mu_assert_true(has_enum_val(cairo, "CAIRO_STATUS_INVALID_PATH_DATA", 0x9), "CAIRO_STATUS_INVALID_PATH_DATA = 0x9");
mu_assert_true(has_enum_val(cairo, "CAIRO_STATUS_INVALID_WEIGHT", 0x1f), "CAIRO_STATUS_INVALID_WEIGHT = 0x1f");
mu_assert_null(rz_type_db_enum_member_by_val(analysis->typedb, "_cairo_status", 0x20), "no 0x20 member");
RzBaseType *cairo1 = rz_type_db_get_enum(analysis->typedb, "_cairo_status");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_SUCCESS"), "CAIRO_STATUS_SUCCESS");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_NO_MEMORY"), "CAIRO_STATUS_NO_MEMORY");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_RESTORE"), "CAIRO_STATUS_INVALID_RESTORE");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_POP_GROUP"), "CAIRO_STATUS_INVALID_POP_GROUP");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_NO_CURRENT_POINT"), "CAIRO_STATUS_NO_CURRENT_POINT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_MATRIX"), "CAIRO_STATUS_INVALID_MATRIX");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_STATUS"), "CAIRO_STATUS_INVALID_STATUS");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_NULL_POINTER"), "CAIRO_STATUS_NULL_POINTER");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_STRING"), "CAIRO_STATUS_INVALID_STRING");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_PATH_DATA"), "CAIRO_STATUS_INVALID_PATH_DATA");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_READ_ERROR"), "CAIRO_STATUS_READ_ERROR");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_WRITE_ERROR"), "CAIRO_STATUS_WRITE_ERROR");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_SURFACE_FINISHED"), "CAIRO_STATUS_SURFACE_FINISHED");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_SURFACE_TYPE_MISMATCH"), "CAIRO_STATUS_SURFACE_TYPE_MISMATCH");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_PATTERN_TYPE_MISMATCH"), "CAIRO_STATUS_PATTERN_TYPE_MISMATCH");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_CONTENT"), "CAIRO_STATUS_INVALID_CONTENT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_FORMAT"), "CAIRO_STATUS_INVALID_FORMAT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_VISUAL"), "CAIRO_STATUS_INVALID_VISUAL");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_FILE_NOT_FOUND"), "CAIRO_STATUS_FILE_NOT_FOUND");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_DASH"), "CAIRO_STATUS_INVALID_DASH");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_DSC_COMMENT"), "CAIRO_STATUS_INVALID_DSC_COMMENT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_INDEX"), "CAIRO_STATUS_INVALID_INDEX");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_CLIP_NOT_REPRESENTABLE"), "CAIRO_STATUS_CLIP_NOT_REPRESENTABLE");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_TEMP_FILE_ERROR"), "CAIRO_STATUS_TEMP_FILE_ERROR");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_STRIDE"), "CAIRO_STATUS_INVALID_STRIDE");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_FONT_TYPE_MISMATCH"), "CAIRO_STATUS_FONT_TYPE_MISMATCH");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_USER_FONT_IMMUTABLE"), "CAIRO_STATUS_USER_FONT_IMMUTABLE");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_USER_FONT_ERROR"), "CAIRO_STATUS_USER_FONT_ERROR");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_NEGATIVE_COUNT"), "CAIRO_STATUS_NEGATIVE_COUNT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_CLUSTERS"), "CAIRO_STATUS_INVALID_CLUSTERS");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_SLANT"), "CAIRO_STATUS_INVALID_SLANT");
mu_assert_true(has_enum_case(cairo1, "CAIRO_STATUS_INVALID_WEIGHT"), "CAIRO_STATUS_INVALID_WEIGHT");
mu_assert_false(has_enum_case(cairo1, "CAIRO_NO_SUCH_CASE"), "no such enum case");
// Check the structure presence and validity
RzBaseType *margins = rz_type_db_get_base_type(analysis->typedb, "_MARGINS");
mu_assert_eq(margins->kind, RZ_BASE_TYPE_KIND_STRUCT, "_MARGINS is struct");
mu_assert_true(has_struct_member(margins, "cxLeftWidth"), "cxLeftWidth");
mu_assert_true(has_struct_member(margins, "cxRightWidth"), "cxRightWidth");
mu_assert_true(has_struct_member(margins, "cyTopHeight"), "cyTopHeight");
mu_assert_true(has_struct_member(margins, "cyBottomHeight"), "cyBottomHeight");
mu_assert_false(has_struct_member(margins, "noSuchMember"), "no such struct member");
// Check the union presence and validity
RzBaseType *unaligned = rz_type_db_get_base_type(analysis->typedb, "unaligned");
mu_assert_eq(unaligned->kind, RZ_BASE_TYPE_KIND_UNION, "unaligned is union");
mu_assert_true(has_union_member(unaligned, "ptr"), "ptr");
mu_assert_true(has_union_member(unaligned, "u2"), "u2");
mu_assert_true(has_union_member(unaligned, "u4"), "u4");
mu_assert_true(has_union_member(unaligned, "u8"), "u8");
mu_assert_true(has_union_member(unaligned, "s2"), "s2");
mu_assert_true(has_union_member(unaligned, "s4"), "s4");
mu_assert_true(has_union_member(unaligned, "s8"), "s8");
mu_assert_false(has_union_member(unaligned, "noSuchMember"), "no such union member");
// TODO: Check also the exact types of the members
// check_kv("union.unaligned.u2", "short unsigned int,0,0");
// check_kv("union.unaligned.s8", "long long int,0,0");
rz_bin_dwarf_debug_info_free(info);
rz_bin_dwarf_debug_abbrev_free(abbrevs);
rz_analysis_free(analysis);
rz_bin_free(bin);
rz_io_free(io);
mu_end;
}
static bool test_dwarf_function_parsing_cpp(void) {
#if WITH_GPL
RzBin *bin = rz_bin_new();
mu_assert_notnull(bin, "Couldn't create new RzBin");
RzIO *io = rz_io_new();
mu_assert_notnull(io, "Couldn't create new RzIO");
RzAnalysis *analysis = rz_analysis_new();
mu_assert_notnull(analysis, "Couldn't create new RzAnalysis");
rz_io_bind(io, &bin->iob);
analysis->binb.demangle = rz_bin_demangle;
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_set_cpu(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
char *types_dir = rz_path_system(RZ_SDB_TYPES);
rz_type_db_init(analysis->typedb, types_dir, "x86", 64, "linux");
free(types_dir);
RzBinOptions opt = { 0 };
rz_bin_options_init(&opt, 0, 0, 0, false);
RzBinFile *bf = rz_bin_open(bin, "bins/elf/dwarf4_many_comp_units.elf", &opt);
mu_assert_notnull(bf, "couldn't open file");
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_use(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
RzBinDwarfDebugAbbrev *abbrevs = rz_bin_dwarf_parse_abbrev(bin->cur);
mu_assert_notnull(abbrevs, "Couldn't parse Abbreviations");
RzBinDwarfDebugInfo *info = rz_bin_dwarf_parse_info(bin->cur, abbrevs);
mu_assert_notnull(info, "Couldn't parse debug_info section");
HtUP /*<offset, List *<LocListEntry>*/ *loc_table = rz_bin_dwarf_parse_loc(bin->cur, 8);
RzAnalysisDwarfContext ctx = {
.info = info,
.loc = loc_table
};
rz_analysis_dwarf_process_info(analysis, &ctx);
Sdb *sdb = sdb_ns(analysis->sdb, "dwarf", 0);
mu_assert_notnull(sdb, "No dwarf function information in db");
char *value = NULL;
check_kv("Mammal", "fcn");
check_kv("fcn.Mammal.addr", "0x401300");
check_kv("fcn.Mammal.sig", "void Mammal(Mammal * this);");
check_kv("fcn.Dog::walk__.addr", "0x401380");
check_kv("fcn.Dog::walk__.sig", "int Dog::walk()(Dog * this);");
check_kv("fcn.Dog::walk__.name", "Dog::walk()");
check_kv("fcn.Mammal::walk__.vars", "this");
check_kv("fcn.Mammal::walk__.var.this", "b,-8,Mammal *");
check_kv("main", "fcn");
check_kv("fcn.main.addr", "0x401160");
check_kv("fcn.main.sig", "int main();");
check_kv("fcn.main.vars", "b,m,output");
check_kv("fcn.main.var.output", "b,-40,int");
rz_bin_dwarf_debug_info_free(info);
rz_bin_dwarf_debug_abbrev_free(abbrevs);
if (loc_table) {
rz_bin_dwarf_loc_free(loc_table);
}
rz_analysis_free(analysis);
rz_bin_free(bin);
rz_io_free(io);
#endif
mu_end;
}
static bool test_dwarf_function_parsing_go(void) {
RzBin *bin = rz_bin_new();
mu_assert_notnull(bin, "Couldn't create new RzBin");
RzIO *io = rz_io_new();
mu_assert_notnull(io, "Couldn't create new RzIO");
RzAnalysis *analysis = rz_analysis_new();
mu_assert_notnull(analysis, "Couldn't create new RzAnalysis");
rz_io_bind(io, &bin->iob);
analysis->binb.demangle = rz_bin_demangle;
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_set_cpu(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
RzBinOptions opt = { 0 };
rz_bin_options_init(&opt, 0, 0, 0, false);
RzBinFile *bf = rz_bin_open(bin, "bins/elf/dwarf_go_tree", &opt);
mu_assert_notnull(bf, "couldn't open file");
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_use(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
RzBinDwarfDebugAbbrev *abbrevs = rz_bin_dwarf_parse_abbrev(bin->cur);
mu_assert_notnull(abbrevs, "Couldn't parse Abbreviations");
RzBinDwarfDebugInfo *info = rz_bin_dwarf_parse_info(bin->cur, abbrevs);
mu_assert_notnull(info, "Couldn't parse debug_info section");
HtUP /*<offset, List *<LocListEntry>*/ *loc_table = rz_bin_dwarf_parse_loc(bin->cur, 8);
mu_assert_notnull(loc_table, "Couldn't parse loc section");
RzAnalysisDwarfContext ctx = {
.info = info,
.loc = loc_table
};
rz_analysis_dwarf_process_info(analysis, &ctx);
Sdb *sdb = sdb_ns(analysis->sdb, "dwarf", 0);
mu_assert_notnull(sdb, "No dwarf function information in db");
char *value = NULL;
check_kv("main_main", "fcn");
check_kv("fcn.main_main.name", "main.main");
check_kv("fcn.main_main.addr", "0x491980");
check_kv("main_tree_iterInorder", "fcn");
check_kv("fcn.main_tree_iterInorder.name", "main.tree.iterInorder");
check_kv("fcn.main_tree_iterInorder.addr", "0x491d90");
check_kv("fcn.main_tree_iterInorder.sig", "void main.tree.iterInorder(main.tree t,func(int) visit);");
/* We do not parse variable information from .debug_frame that is this Go binary using, so
don't check variable information and add it in the future */
rz_bin_dwarf_debug_info_free(info);
rz_bin_dwarf_debug_abbrev_free(abbrevs);
rz_bin_dwarf_loc_free(loc_table);
rz_analysis_free(analysis);
rz_bin_free(bin);
rz_io_free(io);
mu_end;
}
static bool test_dwarf_function_parsing_rust(void) {
RzBin *bin = rz_bin_new();
mu_assert_notnull(bin, "Couldn't create new RzBin");
RzIO *io = rz_io_new();
mu_assert_notnull(io, "Couldn't create new RzIO");
RzAnalysis *analysis = rz_analysis_new();
mu_assert_notnull(analysis, "Couldn't create new RzAnalysis");
rz_io_bind(io, &bin->iob);
analysis->binb.demangle = rz_bin_demangle;
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_set_cpu(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
char *types_dir = rz_path_system(RZ_SDB_TYPES);
rz_type_db_init(analysis->typedb, types_dir, "x86", 64, "linux");
free(types_dir);
RzBinOptions opt = { 0 };
rz_bin_options_init(&opt, 0, 0, 0, false);
RzBinFile *bf = rz_bin_open(bin, "bins/elf/dwarf_rust_bubble", &opt);
mu_assert_notnull(bf, "couldn't open file");
// TODO fix, how to correctly promote binary info to the RzAnalysis in unit tests?
rz_analysis_use(analysis, "x86");
rz_analysis_set_bits(analysis, 64);
RzBinDwarfDebugAbbrev *abbrevs = rz_bin_dwarf_parse_abbrev(bin->cur);
mu_assert_notnull(abbrevs, "Couldn't parse Abbreviations");
RzBinDwarfDebugInfo *info = rz_bin_dwarf_parse_info(bin->cur, abbrevs);
mu_assert_notnull(info, "Couldn't parse debug_info section");
HtUP /*<offset, List *<LocListEntry>*/ *loc_table = rz_bin_dwarf_parse_loc(bin->cur, 8);
mu_assert_notnull(loc_table, "Couldn't parse loc section");
RzAnalysisDwarfContext ctx = {
.info = info,
.loc = loc_table
};
rz_analysis_dwarf_process_info(analysis, &ctx);
Sdb *sdb = sdb_ns(analysis->sdb, "dwarf", 0);
mu_assert_notnull(sdb, "No dwarf function information in db");
char *value = NULL;
check_kv("fcn.main.addr", "0x5750");
check_kv("fcn.main.name", "main");
check_kv("fcn.main.var.numbers", "s,128,i32[11]");
check_kv("fcn.main.var.strings", "s,312,&str[6]");
// check_kv ("fcn.main.vars", "numbers,arg0,arg0,strings,arg0,arg0"); Fix these collision by unique renaming in future
check_kv("fcn.lang_start_internal.sig", "isize lang_start_internal(&Fn<()> main,isize argc,u8 ** argv);");
check_kv("bubble_sort__str_", "fcn");
check_kv("bubble_sort_i32_", "fcn");
check_kv("fcn.bubble_sort_i32_.vars", "values,n,swapped,iter,__next,val,i");
check_kv("fcn.bubble_sort_i32_.var.iter", "s,112,Range<usize>");
check_kv("fcn.bubble_sort_i32_.var.i", "s,176,usize");
check_kv("fcn.bubble_sort_i32_.name", "bubble_sort<i32>");
check_kv("fcn.bubble_sort_i32_.addr", "0x5270");
rz_bin_dwarf_debug_info_free(info);
rz_bin_dwarf_debug_abbrev_free(abbrevs);
rz_bin_dwarf_loc_free(loc_table);
rz_analysis_free(analysis);
rz_bin_free(bin);
rz_io_free(io);
mu_end;
}
int all_tests(void) {
mu_run_test(test_parse_dwarf_types);
mu_run_test(test_dwarf_function_parsing_cpp);
mu_run_test(test_dwarf_function_parsing_rust);
mu_run_test(test_dwarf_function_parsing_go);
return tests_passed != tests_run;
}
mu_main(all_tests)