typelink.c File Reference

#include <rz_util.h>
#include <rz_type.h>
#include <rz_analysis.h>
#include <string.h>
#include <sdb.h>

Go to the source code of this file.

Classes
struct	TListMeta

Functions
RZ_API bool	rz_analysis_type_link_exists (RzAnalysis *analysis, ut64 addr)
	Checks if the RzType linked to the given address. More...
RZ_API RZ_BORROW RzType *	rz_analysis_type_link_at (RzAnalysis *analysis, ut64 addr)
	Returns the RzType linked to the given address. More...
RZ_API bool	rz_analysis_type_set_link (RzAnalysis *analysis, RZ_BORROW RzType *type, ut64 addr)
	Links the given RzType to the address. More...
RZ_API bool	rz_analysis_type_unlink (RzAnalysis *analysis, ut64 addr)
	Removes the type link given the address. More...
RZ_API bool	rz_analysis_type_unlink_all (RzAnalysis *analysis)
	Removes all type links. More...
static bool	type_collect_cb (void *user, ut64 k, const void *v)
RZ_API RZ_OWN RzList *	rz_analysis_type_links (RzAnalysis *analysis)
	Returns the list of all linked types. More...
static bool	type_paths_collect_by_offset_cb (void *user, ut64 k, const void *v)
RZ_API RZ_OWN RzList *	rz_analysis_type_links_by_offset (RzAnalysis *analysis, ut64 offset)
	Returns the list of all structured types that are linked and have members matching the offset. More...
static bool	type_paths_collect_by_address_cb (void *user, ut64 k, const void *v)
RZ_API RZ_OWN RzList *	rz_analysis_type_paths_by_address (RzAnalysis *analysis, ut64 addr)
	Returns the list of all type paths that are linked to some address and have suitable offset. More...

Function Documentation

rz_analysis_type_link_at()

RZ_API RZ_BORROW RzType* rz_analysis_type_link_at	(	RzAnalysis *	analysis,
		ut64	addr
	)

Returns the RzType linked to the given address.

Parameters

analysis	RzAnalysis instance
addr	The address to check the link at

Definition at line 31 of file typelink.c.

                                                                                   {
    rz_return_val_if_fail(analysis, NULL);
    if (addr == UT64_MAX) {
        return NULL;
    }
    bool found = false;
    RzType *result = ht_up_find(analysis->type_links, addr, &found);
    if (!found || !result) {
        return NULL;
    }
    return result;
}

References addr, found, NULL, rz_return_val_if_fail, rz_analysis_t::type_links, and UT64_MAX.

Referenced by rz_core_print_disasm(), and rz_core_types_link_show().

rz_analysis_type_link_exists()

RZ_API bool rz_analysis_type_link_exists	(	RzAnalysis *	analysis,
		ut64	addr
	)

Checks if the RzType linked to the given address.

Parameters

analysis	RzAnalysis instance
addr	The address to check the link at

Definition at line 16 of file typelink.c.

                                                                          {
    rz_return_val_if_fail(analysis, false);
    if (addr == UT64_MAX) {
        return false;
    }
    bool found = false;
    return ht_up_find(analysis->type_links, addr, &found) && found;
}

References addr, found, rz_return_val_if_fail, rz_analysis_t::type_links, and UT64_MAX.

rz_analysis_type_links()

RZ_API RZ_OWN RzList* rz_analysis_type_links

(

RzAnalysis *

analysis

)

Returns the list of all linked types.

Parameters

analysis

RzAnalysis instance

Definition at line 96 of file typelink.c.

                                                                     {
    rz_return_val_if_fail(analysis, NULL);
    RzList *types = rz_list_new();
    ht_up_foreach(analysis->type_links, type_collect_cb, types);
    return types;
}

References NULL, rz_list_new(), rz_return_val_if_fail, type_collect_cb(), rz_analysis_t::type_links, and types.

rz_analysis_type_links_by_offset()

RZ_API RZ_OWN RzList* rz_analysis_type_links_by_offset	(	RzAnalysis *	analysis,
		ut64	offset
	)

Returns the list of all structured types that are linked and have members matching the offset.

Parameters

analysis	RzAnalysis instance
offset	The offset of the member to match against

Definition at line 142 of file typelink.c.

                                                                                            {
    rz_return_val_if_fail(analysis, NULL);
    if (offset == UT64_MAX) {
        return NULL;
    }
    RzList *typepaths = rz_list_new();
    struct TListMeta tl = {
        .typedb = analysis->typedb,
        .l = typepaths,
        .addr = 0,
        .offset = offset
    };
    ht_up_foreach(analysis->type_links, type_paths_collect_by_offset_cb, &tl);
    return typepaths;
}

References NULL, rz_list_new(), rz_return_val_if_fail, rz_analysis_t::type_links, type_paths_collect_by_offset_cb(), TListMeta::typedb, rz_analysis_t::typedb, and UT64_MAX.

rz_analysis_type_paths_by_address()

RZ_API RZ_OWN RzList* rz_analysis_type_paths_by_address	(	RzAnalysis *	analysis,
		ut64	addr
	)

Returns the list of all type paths that are linked to some address and have suitable offset.

Parameters

analysis	RzAnalysis instance
addr	The address to check against possible matches

Definition at line 201 of file typelink.c.

                                                                                           {
    rz_return_val_if_fail(analysis, NULL);
    if (addr == UT64_MAX) {
        return NULL;
    }
    RzList *typepaths = rz_list_new();
    struct TListMeta tl = {
        .typedb = analysis->typedb,
        .l = typepaths,
        .addr = addr,
        .offset = 0
    };
    ht_up_foreach(analysis->type_links, type_paths_collect_by_address_cb, &tl);
    return typepaths;
}

References addr, NULL, rz_list_new(), rz_return_val_if_fail, rz_analysis_t::type_links, type_paths_collect_by_address_cb(), TListMeta::typedb, rz_analysis_t::typedb, and UT64_MAX.

Referenced by resolve_type_links(), and set_offset_hint().

rz_analysis_type_set_link()

RZ_API bool rz_analysis_type_set_link	(	RzAnalysis *	analysis,
		RZ_BORROW RzType *	type,
		ut64	addr
	)

Links the given RzType to the address.

Parameters

analysis	RzAnalysis instance
type	RzType to link
addr	The address to add the type link

Definition at line 51 of file typelink.c.

                                                                                               {
    rz_return_val_if_fail(analysis && type, false);
    ht_up_insert(analysis->type_links, addr, type);
    return true;
}

References addr, rz_return_val_if_fail, type, and rz_analysis_t::type_links.

Referenced by rz_core_types_link().

rz_analysis_type_unlink()

RZ_API bool rz_analysis_type_unlink	(	RzAnalysis *	analysis,
		ut64	addr
	)

Removes the type link given the address.

Parameters

analysis	RzAnalysis instance
addr	The address to remove the type link from

Definition at line 63 of file typelink.c.

                                                                     {
    rz_return_val_if_fail(analysis, false);
    ht_up_delete(analysis->type_links, addr);
    return true;
}

References addr, rz_return_val_if_fail, and rz_analysis_t::type_links.

Referenced by rz_type_link_del_handler().

rz_analysis_type_unlink_all()

RZ_API bool rz_analysis_type_unlink_all

(

RzAnalysis *

analysis

)

Removes all type links.

Parameters

analysis

RzAnalysis instance

Definition at line 74 of file typelink.c.

                                                              {
    rz_return_val_if_fail(analysis, false);
    ht_up_free(analysis->type_links);
    analysis->type_links = ht_up_new0();
    if (!analysis->type_links) {
        return false;
    }
    return true;
}

References rz_return_val_if_fail, and rz_analysis_t::type_links.

Referenced by rz_type_link_del_all_handler().

type_collect_cb()

static bool type_collect_cb ( void *  user, ut64  k, const void *  v  )

static

Definition at line 84 of file typelink.c.

                                                               {
    rz_return_val_if_fail(user && v, false);
    RzList *l = user;
    rz_list_append(l, (RzType *)v);
    return true;
}

References rz_list_append(), rz_return_val_if_fail, and v.

Referenced by rz_analysis_type_links().

type_paths_collect_by_address_cb()

static bool type_paths_collect_by_address_cb ( void *  user, ut64  k, const void *  v  )

static

Definition at line 159 of file typelink.c.

                                                                                {
    rz_return_val_if_fail(user && v, false);
    struct TListMeta *tl = (struct TListMeta *)user;
    // If the possible offset doesn't make sense - we skip it
    if (tl->addr < k) {
        return true;
    }
 
    RzType *t = (RzType *)v;
    // Handle only identifiers here
    if (t->kind != RZ_TYPE_KIND_IDENTIFIER) {
        return true;
    }
    if (!t->identifier.name) {
        return true;
    }
    // Get the base type
    RzBaseType *btype = rz_type_db_get_base_type(tl->typedb, t->identifier.name);
    if (!btype) {
        return true;
    }
    // Calculate the possible offset as a difference between base address of the type link
    // and the given address to check against
    st64 offset = (st64)(tl->addr - k);
    if (offset < 0) {
        return true;
    }
    if (btype->kind == RZ_BASE_TYPE_KIND_STRUCT || btype->kind == RZ_BASE_TYPE_KIND_UNION) {
        RzList *list = rz_type_path_by_offset(tl->typedb, btype, offset);
        if (list) {
            rz_list_join(tl->l, list);
        }
    }
    return true;
}

References TListMeta::addr, rz_type_t::identifier, k, rz_base_type_t::kind, rz_type_t::kind, TListMeta::l, list(), RZ_BASE_TYPE_KIND_STRUCT, RZ_BASE_TYPE_KIND_UNION, rz_list_join(), rz_return_val_if_fail, rz_type_db_get_base_type(), RZ_TYPE_KIND_IDENTIFIER, rz_type_path_by_offset(), st64, TListMeta::typedb, and v.

Referenced by rz_analysis_type_paths_by_address().

type_paths_collect_by_offset_cb()

static bool type_paths_collect_by_offset_cb ( void *  user, ut64  k, const void *  v  )

static

Definition at line 111 of file typelink.c.

                                                                               {
    rz_return_val_if_fail(user && v, false);
    struct TListMeta *tl = (struct TListMeta *)user;
    RzType *t = (RzType *)v;
    // Handle only identifiers here
    if (t->kind != RZ_TYPE_KIND_IDENTIFIER) {
        return true;
    }
    if (!t->identifier.name) {
        return true;
    }
    // Get the base type
    RzBaseType *btype = rz_type_db_get_base_type(tl->typedb, t->identifier.name);
    if (!btype) {
        return true;
    }
    if (btype->kind == RZ_BASE_TYPE_KIND_STRUCT || btype->kind == RZ_BASE_TYPE_KIND_UNION) {
        RzList *list = rz_type_path_by_offset(tl->typedb, btype, tl->offset);
        if (list) {
            rz_list_join(tl->l, list);
        }
    }
    return true;
}

References rz_type_t::identifier, rz_base_type_t::kind, rz_type_t::kind, TListMeta::l, list(), TListMeta::offset, RZ_BASE_TYPE_KIND_STRUCT, RZ_BASE_TYPE_KIND_UNION, rz_list_join(), rz_return_val_if_fail, rz_type_db_get_base_type(), RZ_TYPE_KIND_IDENTIFIER, rz_type_path_by_offset(), TListMeta::typedb, and v.

Referenced by rz_analysis_type_links_by_offset().