var_global.c File Reference

#include <rz_analysis.h>
#include <rz_list.h>

Go to the source code of this file.

Classes
struct	list_addr

Functions
RZ_API RZ_OWN RzAnalysisVarGlobal *	rz_analysis_var_global_new (RZ_NONNULL const char *name, ut64 addr)
	Create a new instance of global variable. More...
int	global_var_node_cmp (const void *incoming, const RBNode *in_tree, void *user)
RZ_API RZ_OWN bool	rz_analysis_var_global_add (RzAnalysis *analysis, RZ_NONNULL RzAnalysisVarGlobal *global_var)
	Add the global variable into hashtable. More...
RZ_API void	rz_analysis_var_global_free (RzAnalysisVarGlobal *glob)
	Free the global variable instance. More...
RZ_API RZ_NULLABLE RzFlagItem *	rz_analysis_var_global_get_flag_item (RzAnalysisVarGlobal *glob)
	Get the flag item corresponding to the given variable. More...
RZ_API bool	rz_analysis_var_global_delete (RZ_NONNULL RzAnalysis *analysis, RZ_NONNULL RzAnalysisVarGlobal *glob)
	Delete and free the global variable. More...
RZ_API bool	rz_analysis_var_global_delete_byname (RzAnalysis *analysis, RZ_NONNULL const char *name)
	Delete and free the global variable by its name. More...
RZ_API bool	rz_analysis_var_global_delete_byaddr_at (RzAnalysis *analysis, ut64 addr)
	Same as rz_analysis_var_global_delete_byname at the address. More...
RZ_API bool	rz_analysis_var_global_delete_byaddr_in (RzAnalysis *analysis, ut64 addr)
	Same as rz_analysis_var_global_delete_byname in the address. More...
RZ_API RZ_BORROW RzAnalysisVarGlobal *	rz_analysis_var_global_get_byname (RzAnalysis *analysis, RZ_NONNULL const char *name)
	Get the instance of global variable by its name. More...
RZ_API RZ_BORROW RzAnalysisVarGlobal *	rz_analysis_var_global_get_byaddr_at (RzAnalysis *analysis, ut64 addr)
	Get the instance of global variable at the address. More...
RZ_API RZ_BORROW RzAnalysisVarGlobal *	rz_analysis_var_global_get_byaddr_in (RzAnalysis *analysis, ut64 addr)
	Get the instance of global variable contains the address. More...
static bool	global_var_collect_cb (void *user, const void *k, const void *v)
RZ_API RZ_OWN RzList *	rz_analysis_var_global_get_all (RzAnalysis *analysis)
	Get all of the added global variables. More...
RZ_API bool	rz_analysis_var_global_rename (RzAnalysis *analysis, RZ_NONNULL const char *old_name, RZ_NONNULL const char *newname)
	Rename the global variable. More...
RZ_API void	rz_analysis_var_global_set_type (RzAnalysisVarGlobal *glob, RZ_NONNULL RZ_BORROW RzType *type)
	Set the type of the global variable. More...
RZ_API void	rz_analysis_var_global_add_constraint (RzAnalysisVarGlobal *glob, RzTypeConstraint *constraint)
	Add a constaint to global variable. More...
RZ_API RZ_OWN char *	rz_analysis_var_global_get_constraints_readable (RzAnalysisVarGlobal *glob)
	Get the pritable string of global variable constraints. More...

Function Documentation

global_var_collect_cb()

static bool global_var_collect_cb ( void *  user, const void *  k, const void *  v  )

static

Definition at line 246 of file var_global.c.

                                                                            {
    RzList *l = user;
    RzAnalysisVarGlobal *glob = (RzAnalysisVarGlobal *)v;
    rz_list_append(l, glob);
    return true;
}

References rz_list_append(), and v.

Referenced by rz_analysis_var_global_get_all().

global_var_node_cmp()

int global_var_node_cmp	(	const void *	incoming,
		const RBNode *	in_tree,
		void *	user
	)

Definition at line 28 of file var_global.c.

                                                                                 {
    ut64 ia = *(ut64 *)incoming;
    ut64 ta = container_of(in_tree, const RzAnalysisVarGlobal, rb)->addr;
    if (ia < ta) {
        return -1;
    } else if (ia > ta) {
        return 1;
    }
    return 0;
}

References container_of, and ut64().

Referenced by rz_analysis_var_global_add(), rz_analysis_var_global_delete(), rz_analysis_var_global_get_byaddr_at(), and rz_analysis_var_global_get_byaddr_in().

rz_analysis_var_global_add()

RZ_API RZ_OWN bool rz_analysis_var_global_add	(	RzAnalysis *	analysis,
		RZ_NONNULL RzAnalysisVarGlobal *	global_var
	)

Add the global variable into hashtable.

Parameters

analysis	RzAnalysis
global_var	Global variable instance

Returns

true if succeed

Definition at line 46 of file var_global.c.

                                                                                                                {
    rz_return_val_if_fail(analysis && global_var, false);
 
    RzAnalysisVarGlobal *existing_glob = NULL;
    if ((existing_glob = rz_analysis_var_global_get_byaddr_in(analysis, global_var->addr))) {
        RZ_LOG_ERROR("Global variable %s at 0x%" PFMT64x " already exists!\n", existing_glob->name, existing_glob->addr);
        return false;
    }
    if ((existing_glob = rz_analysis_var_global_get_byname(analysis, global_var->name))) {
        RZ_LOG_ERROR("Global variable %s at 0x%" PFMT64x " already exists!\n", existing_glob->name, existing_glob->addr);
        return false;
    }
    if (!ht_pp_insert(analysis->ht_global_var, global_var->name, global_var)) {
        return false;
    }
    if (!rz_rbtree_aug_insert(&analysis->global_var_tree, &global_var->addr, &global_var->rb, global_var_node_cmp, NULL, NULL)) {
        return false;
    }
 
    global_var->analysis = analysis;
    rz_flag_space_push(global_var->analysis->flb.f, "globals");
    rz_flag_set(global_var->analysis->flb.f, global_var->name, global_var->addr, rz_type_db_get_bitsize(global_var->analysis->typedb, global_var->type) / 8);
    rz_flag_space_pop(global_var->analysis->flb.f);
 
    return true;
}

References rz_analysis_var_global_t::addr, global_var_node_cmp(), rz_analysis_t::global_var_tree, rz_analysis_t::ht_global_var, rz_analysis_var_global_t::name, NULL, PFMT64x, rz_analysis_var_global_get_byaddr_in(), rz_analysis_var_global_get_byname(), rz_flag_set(), RZ_LOG_ERROR, rz_rbtree_aug_insert(), rz_return_val_if_fail, and rz_type_db_get_bitsize().

Referenced by rz_analysis_global_variable_add_handler().

rz_analysis_var_global_add_constraint()

RZ_API void rz_analysis_var_global_add_constraint	(	RzAnalysisVarGlobal *	glob,
		RzTypeConstraint *	constraint
	)

Add a constaint to global variable.

Parameters

glob	Global variable instance
constraint	RzTypeConstraint

Returns

void

Definition at line 320 of file var_global.c.

                                                                                                           {
    rz_return_if_fail(glob && constraint);
    rz_vector_push(&glob->constraints, constraint);
}

References rz_analysis_var_global_t::constraints, rz_return_if_fail, and rz_vector_push().

rz_analysis_var_global_delete()

RZ_API bool rz_analysis_var_global_delete	(	RZ_NONNULL RzAnalysis *	analysis,
		RZ_NONNULL RzAnalysisVarGlobal *	glob
	)

Delete and free the global variable.

Parameters

analysis	RzAnalysis
glob	global variable to be deleted

Returns

true if succeed

Definition at line 121 of file var_global.c.

                                                                                                                 {
    rz_return_val_if_fail(analysis && glob, false);
 
    // We need to delete RBTree first because ht_pp_delete will free its member
    bool deleted = rz_rbtree_delete(&analysis->global_var_tree, &glob->addr, global_var_node_cmp, NULL, NULL, NULL);
    return deleted ? ht_pp_delete(analysis->ht_global_var, glob->name) : deleted;
}

References global_var_node_cmp(), NULL, rz_rbtree_delete(), and rz_return_val_if_fail.

Referenced by rz_analysis_var_global_delete_byaddr_at(), rz_analysis_var_global_delete_byaddr_in(), and rz_analysis_var_global_delete_byname().

rz_analysis_var_global_delete_byaddr_at()

RZ_API bool rz_analysis_var_global_delete_byaddr_at	(	RzAnalysis *	analysis,
		ut64	addr
	)

Same as rz_analysis_var_global_delete_byname at the address.

Parameters

analysis	RzAnalysis
addr	Global Variable address

Returns

true if succeed

Definition at line 154 of file var_global.c.

                                                                                     {
    rz_return_val_if_fail(analysis, false);
    RzAnalysisVarGlobal *glob = rz_analysis_var_global_get_byaddr_at(analysis, addr);
    if (!glob) {
        RZ_LOG_ERROR("No global variable found at 0x%" PFMT64x "\n", addr);
        return false;
    }
 
    return rz_analysis_var_global_delete(analysis, glob);
}

References addr, PFMT64x, rz_analysis_var_global_delete(), rz_analysis_var_global_get_byaddr_at(), RZ_LOG_ERROR, and rz_return_val_if_fail.

rz_analysis_var_global_delete_byaddr_in()

RZ_API bool rz_analysis_var_global_delete_byaddr_in	(	RzAnalysis *	analysis,
		ut64	addr
	)

Same as rz_analysis_var_global_delete_byname in the address.

Parameters

analysis	RzAnalysis
addr	Global Variable address

Returns

true if succeed

Definition at line 172 of file var_global.c.

                                                                                     {
    rz_return_val_if_fail(analysis, false);
    RzAnalysisVarGlobal *glob = rz_analysis_var_global_get_byaddr_in(analysis, addr);
    if (!glob) {
        RZ_LOG_ERROR("No global variable found in 0x%" PFMT64x "\n", addr);
        return false;
    }
 
    return rz_analysis_var_global_delete(analysis, glob);
}

References addr, PFMT64x, rz_analysis_var_global_delete(), rz_analysis_var_global_get_byaddr_in(), RZ_LOG_ERROR, and rz_return_val_if_fail.

Referenced by rz_analysis_global_variable_delete_byaddr_handler().

rz_analysis_var_global_delete_byname()

RZ_API bool rz_analysis_var_global_delete_byname	(	RzAnalysis *	analysis,
		RZ_NONNULL const char *	name
	)

Delete and free the global variable by its name.

Parameters

analysis	RzAnalysis
name	Global Variable name

Returns

true if succeed

Definition at line 136 of file var_global.c.

                                                                                                    {
    rz_return_val_if_fail(analysis && name, false);
    RzAnalysisVarGlobal *glob = rz_analysis_var_global_get_byname(analysis, name);
    if (!glob) {
        RZ_LOG_ERROR("No global variable found having name %s\n", name);
        return false;
    }
 
    return rz_analysis_var_global_delete(analysis, glob);
}

References rz_analysis_var_global_delete(), rz_analysis_var_global_get_byname(), RZ_LOG_ERROR, and rz_return_val_if_fail.

Referenced by rz_analysis_global_variable_delete_byname_handler().

rz_analysis_var_global_free()

RZ_API void rz_analysis_var_global_free

(

RzAnalysisVarGlobal *

glob

)

Free the global variable instance.

Parameters

glob	Global variable instance

Returns

void

Definition at line 79 of file var_global.c.

                                                                   {
    if (!glob) {
        return;
    }
    RzFlagItem *flag = rz_analysis_var_global_get_flag_item(glob);
    if (flag) {
        rz_flag_unset(glob->analysis->flb.f, flag);
    }
    RZ_FREE(glob->name);
    rz_type_free(glob->type);
    rz_vector_fini(&glob->constraints);
    RZ_FREE(glob);
}

References rz_analysis_var_global_t::analysis, rz_analysis_var_global_t::constraints, rz_flag_bind_t::f, rz_analysis_t::flb, rz_analysis_var_global_t::name, rz_analysis_var_global_get_flag_item(), rz_flag_unset(), RZ_FREE, rz_type_free(), rz_vector_fini(), and rz_analysis_var_global_t::type.

Referenced by global_kv_free(), and rz_analysis_global_variable_add_handler().

rz_analysis_var_global_get_all()

RZ_API RZ_OWN RzList* rz_analysis_var_global_get_all

(

RzAnalysis *

analysis

)

Get all of the added global variables.

Parameters

analysis

RzAnalysis

Returns

RzList *

Definition at line 259 of file var_global.c.

                                                                             {
    rz_return_val_if_fail(analysis, NULL);
    RzList *globals = rz_list_new();
    if (!globals) {
        return NULL;
    }
    ht_pp_foreach(analysis->ht_global_var, global_var_collect_cb, globals);
    return globals;
}

References global_var_collect_cb(), rz_analysis_t::ht_global_var, NULL, rz_list_new(), and rz_return_val_if_fail.

Referenced by autocmplt_cmd_arg_global_var(), and rz_analysis_var_global_list_show().

rz_analysis_var_global_get_byaddr_at()

RZ_API RZ_BORROW RzAnalysisVarGlobal* rz_analysis_var_global_get_byaddr_at	(	RzAnalysis *	analysis,
		ut64	addr
	)

Get the instance of global variable at the address.

Parameters

analysis	RzAnalysis
addr	Global variable address

Returns

RzAnalysisVarGlobal *

Definition at line 207 of file var_global.c.

                                                                                                            {
    rz_return_val_if_fail(analysis, NULL);
 
    RBNode *node = rz_rbtree_find(analysis->global_var_tree, &addr, global_var_node_cmp, NULL);
    if (!node) {
        return NULL;
    }
    RzAnalysisVarGlobal *var = (RzAnalysisVarGlobal *)container_of(node, RzAnalysisVarGlobal, rb);
    if (!var) {
        return NULL;
    }
    return var;
}

References addr, container_of, global_var_node_cmp(), rz_analysis_t::global_var_tree, NULL, rz_rbtree_find(), and rz_return_val_if_fail.

Referenced by rz_analysis_var_global_delete_byaddr_at().

rz_analysis_var_global_get_byaddr_in()

RZ_API RZ_BORROW RzAnalysisVarGlobal* rz_analysis_var_global_get_byaddr_in	(	RzAnalysis *	analysis,
		ut64	addr
	)

Get the instance of global variable contains the address.

Parameters

analysis	RzAnalysis
addr	Global variable address

Returns

RzAnalysisVarGlobal *

Definition at line 228 of file var_global.c.

                                                                                                            {
    rz_return_val_if_fail(analysis, NULL);
 
    RBNode *node = rz_rbtree_upper_bound(analysis->global_var_tree, &addr, global_var_node_cmp, NULL);
    if (!node) {
        return NULL;
    }
    RzAnalysisVarGlobal *var = (RzAnalysisVarGlobal *)container_of(node, RzAnalysisVarGlobal, rb);
    if (!var) {
        return NULL;
    }
    ut64 size = rz_type_db_get_bitsize(analysis->typedb, var->type) / 8;
    if (addr >= var->addr + size) {
        return NULL;
    }
    return var;
}

References addr, rz_analysis_var_global_t::addr, container_of, global_var_node_cmp(), rz_analysis_t::global_var_tree, NULL, rz_rbtree_upper_bound(), rz_return_val_if_fail, rz_type_db_get_bitsize(), rz_analysis_var_global_t::type, rz_analysis_t::typedb, and ut64().

Referenced by rz_analysis_var_global_add(), and rz_analysis_var_global_delete_byaddr_in().

rz_analysis_var_global_get_byname()

RZ_API RZ_BORROW RzAnalysisVarGlobal* rz_analysis_var_global_get_byname	(	RzAnalysis *	analysis,
		RZ_NONNULL const char *	name
	)

Get the instance of global variable by its name.

Parameters

analysis	RzAnalysis
name	Global variable name

Returns

RzAnalysisVarGlobal *

Definition at line 190 of file var_global.c.

                                                                                                                           {
    rz_return_val_if_fail(analysis && name, NULL);
    return (RzAnalysisVarGlobal *)ht_pp_find(analysis->ht_global_var, name, NULL);
}

References rz_analysis_t::ht_global_var, NULL, and rz_return_val_if_fail.

Referenced by rz_analysis_global_variable_retype_handler(), rz_analysis_var_global_add(), rz_analysis_var_global_delete_byname(), rz_analysis_var_global_list_show(), and rz_analysis_var_global_rename().

rz_analysis_var_global_get_constraints_readable()

RZ_API RZ_OWN char* rz_analysis_var_global_get_constraints_readable

(

RzAnalysisVarGlobal *

glob

)

Get the pritable string of global variable constraints.

Parameters

glob	Global variable instance

Returns

char *

Definition at line 331 of file var_global.c.

                                                                                               {
    size_t n = glob->constraints.len;
    if (!n) {
        return NULL;
    }
    bool low = false, high = false;
    RzStrBuf sb;
    rz_strbuf_init(&sb);
    size_t i;
    for (i = 0; i < n; i += 1) {
        RzTypeConstraint *constr = rz_vector_index_ptr(&glob->constraints, i);
        switch (constr->cond) {
        case RZ_TYPE_COND_LE:
            if (high) {
                rz_strbuf_append(&sb, " && ");
            }
            rz_strbuf_appendf(&sb, "<= 0x%" PFMT64x "", constr->val);
            low = true;
            break;
        case RZ_TYPE_COND_LT:
            if (high) {
                rz_strbuf_append(&sb, " && ");
            }
            rz_strbuf_appendf(&sb, "< 0x%" PFMT64x "", constr->val);
            low = true;
            break;
        case RZ_TYPE_COND_GE:
            rz_strbuf_appendf(&sb, ">= 0x%" PFMT64x "", constr->val);
            high = true;
            break;
        case RZ_TYPE_COND_GT:
            rz_strbuf_appendf(&sb, "> 0x%" PFMT64x "", constr->val);
            high = true;
            break;
        default:
            break;
        }
        if (low && high && i != n - 1) {
            rz_strbuf_append(&sb, " || ");
            low = false;
            high = false;
        }
    }
    return rz_strbuf_drain_nofree(&sb);
}

References rz_type_constraint_t::cond, rz_analysis_var_global_t::constraints, i, rz_vector_t::len, n, NULL, PFMT64x, rz_strbuf_append(), rz_strbuf_appendf(), rz_strbuf_drain_nofree(), rz_strbuf_init(), RZ_TYPE_COND_GE, RZ_TYPE_COND_GT, RZ_TYPE_COND_LE, RZ_TYPE_COND_LT, rz_vector_index_ptr(), sb, and rz_type_constraint_t::val.

rz_analysis_var_global_get_flag_item()

RZ_API RZ_NULLABLE RzFlagItem* rz_analysis_var_global_get_flag_item

(

RzAnalysisVarGlobal *

glob

)

Get the flag item corresponding to the given variable.

This will search for the matching flag that has been created along with the global variable. It can happen that the flag has manually been deleted, in which case this returns NULL.

Returns

a flag item or NULL

Definition at line 101 of file var_global.c.

                                                                                               {
    rz_return_val_if_fail(glob, NULL);
    RzAnalysis *a = glob->analysis;
    if (!a) {
        return NULL;
    }
    RzFlagItem *r = rz_flag_get(a->flb.f, glob->name);
    if (r && r->offset != glob->addr) {
        return NULL;
    }
    return r;
}

References a, rz_analysis_var_global_t::addr, rz_analysis_var_global_t::analysis, rz_analysis_var_global_t::name, NULL, r, rz_flag_get(), and rz_return_val_if_fail.

Referenced by rz_analysis_var_global_free(), rz_analysis_var_global_rename(), and rz_analysis_var_global_set_type().

rz_analysis_var_global_new()

RZ_API RZ_OWN RzAnalysisVarGlobal* rz_analysis_var_global_new	(	RZ_NONNULL const char *	name,
		ut64	addr
	)

Create a new instance of global variable.

Parameters

name	variable name
addr	variable address
comment	variable comment

Returns

RzAnalysisVarGlobal *

Definition at line 15 of file var_global.c.

                                                                                                      {
    rz_return_val_if_fail(name, NULL);
    RzAnalysisVarGlobal *glob = RZ_NEW0(RzAnalysisVarGlobal);
    if (!glob) {
        return NULL;
    }
    glob->name = strdup(name);
    glob->addr = addr;
    glob->analysis = NULL;
 
    return glob;
}

References addr, rz_analysis_var_global_t::addr, rz_analysis_var_global_t::analysis, rz_analysis_var_global_t::name, NULL, RZ_NEW0, rz_return_val_if_fail, and strdup().

Referenced by rz_analysis_global_variable_add_handler().

rz_analysis_var_global_rename()

RZ_API bool rz_analysis_var_global_rename	(	RzAnalysis *	analysis,
		RZ_NONNULL const char *	old_name,
		RZ_NONNULL const char *	newname
	)

Rename the global variable.

Parameters

analysis	RzAnalysis
old_name	The old name of the global variable
newname	The new name of the global variable

Returns

true if succeed

Definition at line 277 of file var_global.c.

                                                                                                                                 {
    rz_return_val_if_fail(analysis && old_name && newname, false);
    RzAnalysisVarGlobal *glob = rz_analysis_var_global_get_byname(analysis, old_name);
    if (!glob) {
        RZ_LOG_ERROR("Global variable '%s' does not exist!\n", old_name);
        return false;
    }
 
    RzFlagItem *flag = rz_analysis_var_global_get_flag_item(glob);
    if (flag) {
        rz_flag_rename(analysis->flb.f, flag, newname);
    }
 
    RZ_FREE(glob->name);
    glob->name = strdup(newname);
    return ht_pp_update_key(analysis->ht_global_var, old_name, newname);
}

References rz_flag_bind_t::f, rz_analysis_t::flb, rz_analysis_t::ht_global_var, rz_analysis_var_global_t::name, rz_analysis_var_global_get_byname(), rz_analysis_var_global_get_flag_item(), rz_flag_rename(), RZ_FREE, RZ_LOG_ERROR, rz_return_val_if_fail, and strdup().

Referenced by rz_analysis_global_variable_rename_handler().

rz_analysis_var_global_set_type()

RZ_API void rz_analysis_var_global_set_type	(	RzAnalysisVarGlobal *	glob,
		RZ_NONNULL RZ_BORROW RzType *	type
	)

Set the type of the global variable.

Parameters

glob	Global variable instance
type	The type to set. RzType*

Returns

void

Definition at line 302 of file var_global.c.

                                                                                                          {
    rz_return_if_fail(glob && type);
    rz_type_free(glob->type);
    glob->type = type;
 
    RzFlagItem *flag = rz_analysis_var_global_get_flag_item(glob);
    if (flag) {
        flag->size = rz_type_db_get_bitsize(glob->analysis->typedb, glob->type) / 8;
    }
}

References rz_analysis_var_global_t::analysis, rz_analysis_var_global_get_flag_item(), rz_return_if_fail, rz_type_db_get_bitsize(), rz_type_free(), rz_flag_item_t::size, type, rz_analysis_var_global_t::type, and rz_analysis_t::typedb.

Referenced by rz_analysis_global_variable_add_handler(), and rz_analysis_global_variable_retype_handler().