private.h File Reference

#include <rz_bin.h>
#include <rz_util.h>
#include <rz_types.h>

Go to the source code of this file.

Classes
struct	rz_bin_string_database_t

Functions
RZ_IPI RzBinFile *	rz_bin_file_new (RzBin *bin, const char *file, ut64 file_sz, int fd, const char *xtrname, bool steal_ptr)
RZ_IPI RzBinObject *	rz_bin_file_object_find_by_id (RzBinFile *binfile, ut32 binobj_id)
RZ_IPI RzBinFile *	rz_bin_file_find_by_object_id (RzBin *bin, ut32 binobj_id)
RZ_IPI bool	rz_bin_file_set_obj (RzBin *bin, RzBinFile *bf, RzBinObject *obj)
RZ_IPI RzBinFile *	rz_bin_file_xtr_load_bytes (RzBin *bin, RzBinXtrPlugin *xtr, const char *filename, const ut8 *bytes, ut64 sz, ut64 file_sz, ut64 baseaddr, ut64 loadaddr, int idx, int fd)
RZ_IPI bool	rz_bin_file_set_bytes (RzBinFile *binfile, const ut8 *bytes, ut64 sz, bool steal_ptr)
RZ_IPI RzBinPlugin *	rz_bin_get_binplugin_any (RzBin *bin)
RZ_IPI RzBinXtrPlugin *	rz_bin_get_xtrplugin_by_name (RzBin *bin, const char *name)
RZ_IPI RzBinPlugin *	rz_bin_get_binplugin_by_name (RzBin *bin, const char *name)
RZ_IPI RzBinPlugin *	rz_bin_get_binplugin_by_filename (RzBin *bin)
RZ_IPI RZ_OWN char *	rz_bin_file_golang_compiler (RZ_NONNULL RzBinFile *binfile)
	Returns the golang compiler info if buildinfo struct is found. More...
RZ_IPI void	rz_bin_object_free (RzBinObject *o)
RZ_IPI ut64	rz_bin_object_get_baddr (RzBinObject *o)
RZ_IPI RzBinObject *	rz_bin_object_new (RzBinFile *binfile, RzBinPlugin *plugin, RzBinObjectLoadOptions *opts, ut64 offset, ut64 sz)
RZ_IPI RzBinObject *	rz_bin_object_get_cur (RzBin *bin)
RZ_IPI RzBinObject *	rz_bin_object_find_by_arch_bits (RzBinFile *binfile, const char *arch, int bits, const char *name)
RZ_IPI void	rz_bin_class_free (RzBinClass *c)
RZ_IPI RzBinSymbol *	rz_bin_class_add_method (RzBinFile *binfile, const char *classname, const char *name, int nargs)
RZ_IPI void	rz_bin_class_add_field (RzBinFile *binfile, const char *classname, const char *name)
RZ_IPI RzBinFile *	rz_bin_file_xtr_load_buffer (RzBin *bin, RzBinXtrPlugin *xtr, const char *filename, RzBuffer *buf, RzBinObjectLoadOptions *obj_opts, int idx, int fd)
RZ_IPI RzBinFile *	rz_bin_file_new_from_buffer (RzBin *bin, const char *file, RzBuffer *buf, RzBinObjectLoadOptions *opts, int fd, const char *pluginname)

Function Documentation

rz_bin_class_add_field()

RZ_IPI void rz_bin_class_add_field	(	RzBinFile *	binfile,
		const char *	classname,
		const char *	name
	)

rz_bin_class_add_method()

RZ_IPI RzBinSymbol* rz_bin_class_add_method	(	RzBinFile *	binfile,
		const char *	classname,
		const char *	name,
		int	nargs
	)

rz_bin_class_free()

RZ_IPI void rz_bin_class_free

(

RzBinClass *

c

)

Definition at line 512 of file bfile.c.

                                             {
    if (k && k->name) {
        free(k->name);
        free(k->super);
        rz_list_free(k->methods);
        rz_list_free(k->fields);
        free(k->visibility_str);
        free(k);
    }
}

References free(), k, and rz_list_free().

Referenced by parse_categories(), parse_classes(), and rz_bin_object_new().

rz_bin_file_find_by_object_id()

RZ_IPI RzBinFile* rz_bin_file_find_by_object_id	(	RzBin *	bin,
		ut32	binobj_id
	)

rz_bin_file_golang_compiler()

RZ_IPI RZ_OWN char* rz_bin_file_golang_compiler

(

RZ_NONNULL RzBinFile *

bf

)

Returns the golang compiler info if buildinfo struct is found.

Parameters

RzBinFile

The RzBinFile to use for the search

Returns

Returns a string on success, otherwise NULL

Definition at line 265 of file golang.c.

                                                                          {
    rz_return_val_if_fail(bf && bf->o, NULL);
 
    bool is_pe = false;
    GoBuildInfo go_info = { 0 };
    RzBinSection *section = NULL;
    RzListIter *it = NULL;
    RzList *sections = NULL;
    const char *plugname = bf->o->plugin->name;
 
    if (!strcmp(plugname, "pe") || !strcmp(plugname, "pe64")) {
        is_pe = true;
    } else if (strcmp(plugname, "elf") && strcmp(plugname, "elf64") &&
        strcmp(plugname, "mach0") && strcmp(plugname, "mach064")) {
        RZ_LOG_INFO("goinfo: unsupported bin format '%s'\n", plugname);
        return NULL;
    }
 
    sections = rz_bin_object_get_sections(bf->o);
    if (!sections) {
        return NULL;
    }
 
    rz_list_foreach (sections, it, section) {
        if (is_pe && strstr(section->name, "data") && section->size > 16) {
            find_go_build_info(bf, &go_info, section);
        } else if (!is_pe && (strstr(section->name, "go_buildinfo") || strstr(section->name, "go.buildinfo"))) {
            parse_go_build_info(bf, &go_info, section->paddr);
        }
        if (go_info.version) {
            break;
        }
    }
    rz_list_free(sections);
 
    if (!go_info.version) {
        return NULL;
    } else if (go_info.settings) {
        char *res = rz_str_newf("%s (%s)", go_info.version, go_info.settings);
        free(go_info.version);
        free(go_info.settings);
        return res;
    }
 
    return go_info.version;
}

References scan_go_info_s::bf, find_go_build_info(), free(), scan_go_info_s::go_info, rz_bin_plugin_t::name, NULL, rz_bin_file_t::o, parse_go_build_info(), rz_bin_object_t::plugin, rz_bin_object_get_sections(), rz_list_free(), RZ_LOG_INFO, rz_return_val_if_fail, rz_str_newf(), sections(), golang_build_info_t::settings, section::size, and golang_build_info_t::version.

Referenced by rz_bin_object_set_items().

rz_bin_file_new()

RZ_IPI RzBinFile* rz_bin_file_new	(	RzBin *	bin,
		const char *	file,
		ut64	file_sz,
		int	fd,
		const char *	xtrname,
		bool	steal_ptr
	)

Definition at line 22 of file bfile.c.

                                                                                                                           {
    ut32 bf_id;
    if (!rz_id_pool_grab_id(bin->ids->pool, &bf_id)) {
        return NULL;
    }
    RzBinFile *bf = RZ_NEW0(RzBinFile);
    if (!bf) {
        return NULL;
    }
 
    bf->id = bf_id;
    bf->rbin = bin;
    bf->file = RZ_STR_DUP(file);
    bf->fd = fd;
    bf->curxtr = xtrname ? rz_bin_get_xtrplugin_by_name(bin, xtrname) : NULL;
    bf->size = file_sz;
    bf->xtr_data = rz_list_newf((RzListFree)rz_bin_xtrdata_free);
    bf->xtr_obj = NULL;
    bf->sdb = sdb_new0();
    return bf;
}

References rz_bin_file_t::curxtr, fd, rz_bin_file_t::fd, rz_bin_file_t::file, rz_bin_file_t::id, NULL, rz_bin_file_t::rbin, rz_bin_get_xtrplugin_by_name(), rz_bin_xtrdata_free(), rz_id_pool_grab_id(), rz_list_newf(), RZ_NEW0, RZ_STR_DUP, rz_bin_file_t::sdb, sdb_new0(), rz_bin_file_t::size, rz_bin_file_t::xtr_data, and rz_bin_file_t::xtr_obj.

Referenced by rz_bin_file_new_from_buffer(), and rz_bin_file_xtr_load_buffer().

rz_bin_file_new_from_buffer()

RZ_IPI RzBinFile* rz_bin_file_new_from_buffer	(	RzBin *	bin,
		const char *	file,
		RzBuffer *	buf,
		RzBinObjectLoadOptions *	opts,
		int	fd,
		const char *	pluginname
	)

Definition at line 139 of file bfile.c.

                                                                                                                                                         {
    rz_return_val_if_fail(bin && file && buf, NULL);
 
    RzBinFile *bf = rz_bin_file_new(bin, file, rz_buf_size(buf), fd, pluginname, false);
    if (!bf) {
        return NULL;
    }
 
    RzListIter *item = rz_list_append(bin->binfiles, bf);
    bf->buf = rz_buf_ref(buf);
    RzBinPlugin *plugin = get_plugin_from_buffer(bin, pluginname, bf->buf);
    RzBinObject *o = rz_bin_object_new(bf, plugin, opts, 0, rz_buf_size(bf->buf));
    if (!o) {
        rz_list_delete(bin->binfiles, item);
        return NULL;
    }
    // size is set here because the reported size of the object depends on
    // if loaded from xtr plugin or partially read
    if (!o->size) {
        o->size = rz_buf_size(buf);
    }
    return bf;
}

References rz_bin_file_t::buf, fd, get_plugin_from_buffer(), NULL, rz_bin_file_new(), rz_bin_object_new(), rz_buf_ref(), rz_buf_size(), rz_list_append(), rz_list_delete(), rz_return_val_if_fail, and rz_bin_object_t::size.

Referenced by rz_bin_open_buf().

rz_bin_file_object_find_by_id()

RZ_IPI RzBinObject* rz_bin_file_object_find_by_id	(	RzBinFile *	binfile,
		ut32	binobj_id
	)

rz_bin_file_set_bytes()

RZ_IPI bool rz_bin_file_set_bytes	(	RzBinFile *	binfile,
		const ut8 *	bytes,
		ut64	sz,
		bool	steal_ptr
	)

Definition at line 337 of file bfile.c.

                                                                                            {
    rz_return_val_if_fail(bf && bytes, false);
    rz_buf_free(bf->buf);
    if (steal_ptr) {
        bf->buf = rz_buf_new_with_pointers(bytes, sz, true);
    } else {
        bf->buf = rz_buf_new_with_bytes(bytes, sz);
    }
    return bf->buf != NULL;
}

References rz_bin_file_t::buf, bytes, NULL, rz_buf_free(), rz_buf_new_with_bytes(), rz_buf_new_with_pointers(), and rz_return_val_if_fail.

rz_bin_file_set_obj()

RZ_IPI bool rz_bin_file_set_obj	(	RzBin *	bin,
		RzBinFile *	bf,
		RzBinObject *	obj
	)

Definition at line 263 of file bfile.c.

                                                                             {
    rz_return_val_if_fail(bin && bf, false);
    bin->file = bf->file;
    bin->cur = bf;
    bin->narch = bf->narch;
    if (obj) {
        bf->o = obj;
    } else {
        obj = bf->o;
    }
    RzBinPlugin *plugin = rz_bin_file_cur_plugin(bf);
    if (bin->minstrlen < 1) {
        bin->minstrlen = plugin ? plugin->minstrlen : bin->minstrlen;
    }
    if (obj) {
        if (!obj->info) {
            return false;
        }
        if (!obj->info->lang) {
            obj->info->lang = rz_bin_language_to_string(obj->lang);
        }
    }
    return true;
}

References rz_bin_file_t::file, rz_bin_object_t::info, rz_bin_info_t::lang, rz_bin_object_t::lang, rz_bin_plugin_t::minstrlen, rz_bin_file_t::narch, rz_bin_file_t::o, rz_bin_file_cur_plugin(), rz_bin_language_to_string(), and rz_return_val_if_fail.

Referenced by rz_bin_file_set_cur_binfile(), rz_bin_object_new(), rz_bin_select(), rz_bin_select_bfid(), rz_bin_select_object(), and rz_bin_use_arch().

rz_bin_file_xtr_load_buffer()

RZ_IPI RzBinFile* rz_bin_file_xtr_load_buffer	(	RzBin *	bin,
		RzBinXtrPlugin *	xtr,
		const char *	filename,
		RzBuffer *	buf,
		RzBinObjectLoadOptions *	obj_opts,
		int	idx,
		int	fd
	)

Definition at line 299 of file bfile.c.

                                                                                                                                                                       {
    rz_return_val_if_fail(bin && xtr && buf, NULL);
 
    RzBinFile *bf = rz_bin_file_find_by_name(bin, filename);
    if (!bf) {
        bf = rz_bin_file_new(bin, filename, rz_buf_size(buf), fd, xtr->name, false);
        if (!bf) {
            return NULL;
        }
        rz_list_append(bin->binfiles, bf);
        if (!bin->cur) {
            bin->cur = bf;
        }
    }
    rz_list_free(bf->xtr_data);
    bf->xtr_data = NULL;
    if (xtr->extractall_from_buffer) {
        bf->xtr_data = xtr->extractall_from_buffer(bin, buf);
    } else if (xtr->extractall_from_bytes) {
        ut64 sz = 0;
        const ut8 *bytes = rz_buf_data(buf, &sz);
        RZ_LOG_INFO("TODO: Implement extractall_from_buffer in '%s' xtr.bin plugin\n", xtr->name);
        bf->xtr_data = xtr->extractall_from_bytes(bin, bytes, sz);
    }
    if (bf->xtr_data) {
        RzListIter *iter;
        RzBinXtrData *x;
        // populate xtr_data with baddr and laddr that will be used later on
        // rz_bin_file_object_new_from_xtr_data
        rz_list_foreach (bf->xtr_data, iter, x) {
            x->obj_opts = *obj_opts;
        }
    }
    bf->loadaddr = obj_opts->loadaddr;
    return bf;
}

References bytes, rz_bin_xtr_plugin_t::extractall_from_buffer, rz_bin_xtr_plugin_t::extractall_from_bytes, fd, rz_bin_file_load_options_t::loadaddr, rz_bin_file_t::loadaddr, rz_bin_xtr_plugin_t::name, NULL, rz_bin_file_find_by_name(), rz_bin_file_new(), rz_buf_data(), rz_buf_size(), rz_list_append(), rz_list_free(), RZ_LOG_INFO, rz_return_val_if_fail, ut64(), x, and rz_bin_file_t::xtr_data.

Referenced by rz_bin_open_buf().

rz_bin_file_xtr_load_bytes()

RZ_IPI RzBinFile* rz_bin_file_xtr_load_bytes	(	RzBin *	bin,
		RzBinXtrPlugin *	xtr,
		const char *	filename,
		const ut8 *	bytes,
		ut64	sz,
		ut64	file_sz,
		ut64	baseaddr,
		ut64	loadaddr,
		int	idx,
		int	fd
	)

rz_bin_get_binplugin_any()

RZ_IPI RzBinPlugin* rz_bin_get_binplugin_any

(

RzBin *

bin

)

rz_bin_get_binplugin_by_filename()

RZ_IPI RzBinPlugin* rz_bin_get_binplugin_by_filename

(

RzBin *

bin

)

Definition at line 365 of file bin.c.

                                                                 {
    RzBinPlugin *plugin;
    RzListIter *it;
 
    rz_return_val_if_fail(bin, NULL);
 
    const char *filename = strrchr(bin->file, RZ_SYS_DIR[0]);
    filename = filename ? filename + 1 : bin->file;
    rz_list_foreach (bin->plugins, it, plugin) {
        if (plugin->check_filename) {
            if (plugin->check_filename(filename)) {
                return plugin;
            }
        }
    }
    return NULL;
}

References rz_bin_plugin_t::check_filename, NULL, rz_return_val_if_fail, and RZ_SYS_DIR.

Referenced by get_plugin_from_buffer().

rz_bin_get_binplugin_by_name()

RZ_IPI RzBinPlugin* rz_bin_get_binplugin_by_name	(	RzBin *	bin,
		const char *	name
	)

Definition at line 335 of file bin.c.

                                                                               {
    RzBinPlugin *plugin;
    RzListIter *it;
 
    rz_return_val_if_fail(bin && name, NULL);
 
    rz_list_foreach (bin->plugins, it, plugin) {
        if (!strcmp(plugin->name, name)) {
            return plugin;
        }
    }
    return NULL;
}

References rz_bin_plugin_t::name, NULL, and rz_return_val_if_fail.

Referenced by get_plugin_from_buffer(), and rz_bin_create().

rz_bin_get_xtrplugin_by_name()

RZ_IPI RzBinXtrPlugin* rz_bin_get_xtrplugin_by_name	(	RzBin *	bin,
		const char *	name
	)

Definition at line 383 of file bin.c.

                                                                                  {
    RzBinXtrPlugin *xtr;
    RzListIter *it;
 
    rz_return_val_if_fail(bin && name, NULL);
 
    // TODO: use a hashtable here
    rz_list_foreach (bin->binxtrs, it, xtr) {
        if (!strcmp(xtr->name, name)) {
            return xtr;
        }
        // must be set to null
        xtr = NULL;
    }
    return NULL;
}

References rz_bin_xtr_plugin_t::name, NULL, and rz_return_val_if_fail.

Referenced by rz_bin_file_new().

rz_bin_object_find_by_arch_bits()

RZ_IPI RzBinObject* rz_bin_object_find_by_arch_bits	(	RzBinFile *	binfile,
		const char *	arch,
		int	bits,
		const char *	name
	)

Definition at line 644 of file bobj.c.

                                                                                                                 {
    rz_return_val_if_fail(bf && arch && name, NULL);
    if (bf->o) {
        RzBinInfo *info = bf->o->info;
        if (info && info->arch && info->file &&
            (bits == info->bits) &&
            !strcmp(info->arch, arch) &&
            !strcmp(info->file, name)) {
            return bf->o;
        }
    }
    return NULL;
}

References rz_bin_info_t::arch, arch, rz_bin_info_t::bits, bits(), rz_bin_info_t::file, info(), rz_bin_object_t::info, NULL, rz_bin_file_t::o, and rz_return_val_if_fail.

Referenced by rz_bin_select(), rz_bin_select_object(), and rz_bin_use_arch().

rz_bin_object_free()

RZ_IPI void rz_bin_object_free

(

RzBinObject *

o

)

Definition at line 188 of file bobj.c.

                                               {
    if (!o) {
        return;
    }
    free(o->regstate);
    rz_bin_info_free(o->info);
    ht_up_free(o->addrzklassmethod);
    rz_list_free(o->entries);
    rz_list_free(o->maps);
    rz_list_free(o->vfiles);
    rz_list_free(o->fields);
    rz_list_free(o->imports);
    rz_list_free(o->libs);
    rz_bin_reloc_storage_free(o->relocs);
    rz_list_free(o->sections);
    rz_bin_string_database_free(o->strings);
    ht_pp_free(o->import_name_symbols);
    rz_list_free(o->symbols);
    rz_list_free(o->classes);
    ht_pp_free(o->classes_ht);
    ht_pp_free(o->methods_ht);
    rz_bin_source_line_info_free(o->lines);
    rz_list_free(o->mem);
    for (ut32 i = 0; i < RZ_BIN_SPECIAL_SYMBOL_LAST; i++) {
        free(o->binsym[i]);
    }
    free(o);
}

References rz_bin_object_t::addrzklassmethod, rz_bin_object_t::binsym, rz_bin_object_t::classes, rz_bin_object_t::classes_ht, rz_bin_object_t::entries, rz_bin_object_t::fields, free(), i, rz_bin_object_t::import_name_symbols, rz_bin_object_t::imports, rz_bin_object_t::info, rz_bin_object_t::libs, rz_bin_object_t::lines, rz_bin_object_t::maps, rz_bin_object_t::mem, rz_bin_object_t::methods_ht, rz_bin_object_t::regstate, rz_bin_object_t::relocs, rz_bin_info_free(), rz_bin_reloc_storage_free(), rz_bin_source_line_info_free(), RZ_BIN_SPECIAL_SYMBOL_LAST, rz_bin_string_database_free(), rz_list_free(), rz_bin_object_t::sections, rz_bin_object_t::strings, rz_bin_object_t::symbols, and rz_bin_object_t::vfiles.

Referenced by rz_bin_file_free(), and rz_bin_object_new().

rz_bin_object_get_baddr()

RZ_IPI ut64 rz_bin_object_get_baddr

(

RzBinObject *

o

)

rz_bin_object_get_cur()

RZ_IPI RzBinObject* rz_bin_object_get_cur

(

RzBin *

bin

)

Definition at line 639 of file bobj.c.

                                                      {
    rz_return_val_if_fail(bin && bin->cur, NULL);
    return bin->cur->o;
}

References NULL, and rz_return_val_if_fail.

rz_bin_object_new()

RZ_IPI RzBinObject* rz_bin_object_new	(	RzBinFile *	binfile,
		RzBinPlugin *	plugin,
		RzBinObjectLoadOptions *	opts,
		ut64	offset,
		ut64	sz
	)

Definition at line 278 of file bobj.c.

                                                                                                                              {
    rz_return_val_if_fail(bf && plugin, NULL);
    ut64 bytes_sz = rz_buf_size(bf->buf);
    RzBinObject *o = RZ_NEW0(RzBinObject);
    if (!o) {
        return NULL;
    }
    o->opts = *opts;
    if (o->opts.loadaddr == UT64_MAX) {
        // no loadaddr means 0 loadaddr
        o->opts.loadaddr = 0;
    }
    o->obj_size = (bytes_sz >= sz + offset) ? sz : 0;
    o->boffset = offset;
    o->regstate = NULL;
    o->classes = rz_list_newf((RzListFree)rz_bin_class_free);
    o->classes_ht = ht_pp_new0();
    o->methods_ht = ht_pp_new0();
    o->baddr_shift = 0;
    o->plugin = plugin;
 
    if (plugin && plugin->load_buffer) {
        if (!plugin->load_buffer(bf, o, bf->buf, bf->sdb)) {
            if (bf->rbin->verbose) {
                RZ_LOG_ERROR("rz_bin_object_new: load_buffer failed for %s plugin\n", plugin->name);
            }
            rz_bin_object_free(o);
            return NULL;
        }
    } else {
        RZ_LOG_WARN("Plugin %s should implement load_buffer method.\n", plugin->name);
        rz_bin_object_free(o);
        return NULL;
    }
 
    // XXX - object size can't be set here and needs to be set where where
    // the object is created from. The reason for this is to prevent
    // mis-reporting when the file is loaded from impartial bytes or is
    // extracted from a set of bytes in the file
    rz_bin_file_set_obj(bf->rbin, bf, o);
    rz_bin_set_baddr(bf->rbin, o->opts.baseaddr);
    rz_bin_object_set_items(bf, o);
 
    if (!bf->rbin->sdb) {
        return o;
    }
 
    sdb_ns_set(bf->sdb, "info", o->kv);
    sdb_ns_set(bf->rbin->sdb, "cur", bf->sdb);
    char *fdns = rz_str_newf("fd.%d", bf->fd);
    if (fdns) {
        sdb_ns_set(bf->rbin->sdb, fdns, bf->sdb);
        free(fdns);
    }
    bf->sdb->refs++;
 
    return o;
}

References rz_bin_object_t::baddr_shift, rz_bin_file_load_options_t::baseaddr, rz_bin_object_t::boffset, rz_bin_file_t::buf, rz_bin_object_t::classes, rz_bin_object_t::classes_ht, rz_bin_file_t::fd, free(), rz_bin_object_t::kv, rz_bin_plugin_t::load_buffer, rz_bin_file_load_options_t::loadaddr, rz_bin_object_t::methods_ht, rz_bin_plugin_t::name, NULL, rz_bin_object_t::obj_size, rz_bin_object_t::opts, rz_bin_object_t::plugin, rz_bin_file_t::rbin, sdb_t::refs, rz_bin_object_t::regstate, rz_bin_class_free(), rz_bin_file_set_obj(), rz_bin_object_free(), rz_bin_object_set_items(), rz_bin_set_baddr(), rz_buf_size(), rz_list_newf(), RZ_LOG_ERROR, RZ_LOG_WARN, RZ_NEW0, rz_return_val_if_fail, rz_str_newf(), rz_bin_file_t::sdb, rz_bin_t::sdb, sdb_ns_set(), ut64(), UT64_MAX, and rz_bin_t::verbose.

Referenced by rz_bin_file_new_from_buffer(), and rz_bin_file_object_new_from_xtr_data().