function.c File Reference

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

Go to the source code of this file.

Functions
RZ_API RZ_OWN RzCallable *	rz_type_callable_new (RZ_NULLABLE const char *name)
	Creates a new RzCallable type. More...
RZ_API RZ_OWN RzCallable *	rz_type_callable_clone (RZ_BORROW RZ_NONNULL const RzCallable *callable)
	Creates an exact clone of the RzCallable type. More...
RZ_API void	rz_type_callable_free (RZ_NONNULL RzCallable *callable)
	Frees the RzCallable. More...
RZ_API RZ_OWN RzCallableArg *	rz_type_callable_arg_new (RzTypeDB *typedb, RZ_NONNULL const char *name, RZ_OWN RZ_NONNULL RzType *type)
	Creates a new RzCallableArg given the name and type. More...
RZ_API RZ_OWN RzCallableArg *	rz_type_callable_arg_clone (RZ_BORROW RZ_NONNULL const RzCallableArg *arg)
	Creates am exact clone of RzCallableArg. More...
RZ_API void	rz_type_callable_arg_free (RzCallableArg *arg)
	Frees the RzCallableArg. More...
RZ_API bool	rz_type_callable_arg_add (RZ_NONNULL RzCallable *callable, RZ_OWN RZ_NONNULL RzCallableArg *arg)
	Adds a new argument to the RzCallable. More...
RZ_API RZ_OWN RzCallable *	rz_type_func_new (RzTypeDB *typedb, RZ_NONNULL const char *name, RZ_OWN RZ_NULLABLE RzType *type)
	Creates a new RzCallable type. More...
RZ_API bool	rz_type_func_save (RzTypeDB *typedb, RZ_NONNULL RzCallable *callable)
	Stores RzCallable type in the types database. More...
RZ_API RZ_BORROW RzCallable *	rz_type_func_get (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Returns the RzCallable from the database by name. More...
RZ_API bool	rz_type_func_delete (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Removes RzCallable type from the types database. More...
static void	callables_ht_free (HtPPKv *kv)
RZ_API void	rz_type_func_delete_all (RzTypeDB *typedb)
	Removes all RzCallable types. More...
RZ_API bool	rz_type_func_exist (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Checks if the RzCallable type exists in the database given the name. More...
RZ_API RZ_BORROW RzType *	rz_type_func_ret (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Searches for the RzCallable type in types database and returns return type. More...
RZ_API RZ_BORROW const char *	rz_type_func_cc (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Searches for the RzCallable type in types database and returns calling convention. More...
RZ_API bool	rz_type_func_cc_set (RzTypeDB *typedb, const char *name, const char *cc)
	Searches for the RzCallable type in types database and set the calling convention. More...
RZ_API int	rz_type_func_args_count (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Searches for the RzCallable type in types database and returns arguments' count. More...
RZ_API RZ_BORROW RzType *	rz_type_func_args_type (RzTypeDB *typedb, RZ_NONNULL const char *name, int i)
	Searches for the RzCallable type in types database and returns argument type. More...
RZ_API RZ_BORROW const char *	rz_type_func_args_name (RzTypeDB *typedb, RZ_NONNULL const char *name, int i)
	Searches for the RzCallable type in types database and returns argument name. More...
RZ_API bool	rz_type_func_arg_add (RzTypeDB *typedb, RZ_NONNULL const char *func_name, RZ_NONNULL const char *arg_name, RZ_OWN RZ_NONNULL RzType *arg_type)
	Adds a new argument to the RzCallable type at the end of the arguments vector. More...
RZ_API bool	rz_type_func_ret_set (RzTypeDB *typedb, const char *name, RZ_OWN RZ_NONNULL RzType *type)
	Sets the new return type for the RzCallable. More...
RZ_API bool	rz_type_is_callable (RZ_NONNULL const RzType *type)
	Checks if the RzType is the pointer to the RzCallable. More...
RZ_API bool	rz_type_is_callable_ptr (RZ_NONNULL const RzType *type)
	Checks if the RzType is the pointer to the RzCallable. More...
RZ_API bool	rz_type_is_callable_ptr_nested (RZ_NONNULL const RzType *type)
	Checks if the RzType is the nested pointer to the RzCallable. More...
static const RzCallable *	callable_ptr_unwrap (RZ_NONNULL const RzType *type, size_t *acc)
static char *	callable_name_or_ptr (RZ_NONNULL const RzCallable *callable, size_t ptr_depth)
static bool	callable_as_string (RzStrBuf *buf, const RzTypeDB *typedb, RZ_NONNULL const RzCallable *callable, size_t ptr_depth)
RZ_API RZ_OWN char *	rz_type_callable_ptr_as_string (const RzTypeDB *typedb, RZ_NONNULL const RzType *type)
	Returns the callable pointer C representation. More...
RZ_API RZ_OWN char *	rz_type_callable_as_string (const RzTypeDB *typedb, RZ_NONNULL const RzCallable *callable)
	Returns the callable C representation. More...
RZ_API bool	rz_type_func_is_noreturn (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Checks if the RzCallable type is defined as "noreturn". More...
RZ_API bool	rz_type_func_noreturn_add (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Adds the "noreturn" attribute to the RzCallable type. More...
RZ_API bool	rz_type_func_noreturn_drop (RzTypeDB *typedb, RZ_NONNULL const char *name)
	Drops the "noreturn" attribute from the RzCallable type. More...
static bool	function_names_collect_cb (void *user, const void *k, const void *v)
RZ_API RZ_OWN RzList *	rz_type_function_names (RzTypeDB *typedb)
	Returns the list of all function type names. More...
static bool	noreturn_function_names_collect_cb (void *user, const void *k, const void *v)
RZ_API RZ_OWN RzList *	rz_type_noreturn_function_names (RzTypeDB *typedb)
	Returns the list of all noreturn function type names. More...

Function Documentation

callable_as_string()

static bool callable_as_string ( RzStrBuf *  buf, const RzTypeDB *  typedb, RZ_NONNULL const RzCallable *  callable, size_t  ptr_depth  )

static

Definition at line 431 of file function.c.

                                                                                                                               {
    rz_return_val_if_fail(buf && typedb && callable, false);
 
    if (callable->noret) {
        rz_strbuf_append(buf, "__attribute__((noreturn)) ");
    }
    char *ret_str = callable->ret ? rz_type_as_string(typedb, callable->ret) : NULL;
    char *callable_name = callable_name_or_ptr(callable, ptr_depth);
    rz_strbuf_appendf(buf, "%s %s(", ret_str ? ret_str : "void", callable_name);
    free(ret_str);
    free(callable_name);
    void **it;
    bool first = true;
    rz_pvector_foreach (callable->args, it) {
        RzCallableArg *arg = *it;
        if (arg) {
            char *argstr = rz_type_identifier_declaration_as_string(typedb, arg->type, rz_str_get(arg->name));
            const char *comma = first ? "" : ", ";
            rz_strbuf_appendf(buf, "%s%s", comma, argstr);
            first = false;
            free(argstr);
        }
    }
    rz_strbuf_append(buf, ")");
    return true;
}

References callable_name_or_ptr(), comma, free(), arg::name, NULL, rz_pvector_foreach, rz_return_val_if_fail, rz_str_get(), rz_strbuf_append(), rz_strbuf_appendf(), rz_type_as_string(), and rz_type_identifier_declaration_as_string().

Referenced by rz_type_callable_as_string(), and rz_type_callable_ptr_as_string().

callable_name_or_ptr()

static char* callable_name_or_ptr ( RZ_NONNULL const RzCallable *  callable, size_t  ptr_depth  )

inlinestatic

Definition at line 422 of file function.c.

                                                                                                  {
    if (ptr_depth > 0) {
        // Due to the portability issues with other solutions we use this hack to repeat the '*' character
        return rz_str_newf("(%.*s%s)", (int)ptr_depth, "****************", rz_str_get(callable->name));
    } else {
        return strdup(rz_str_get(callable->name));
    }
}

References rz_str_get(), rz_str_newf(), and strdup().

Referenced by callable_as_string().

callable_ptr_unwrap()

static const RzCallable* callable_ptr_unwrap ( RZ_NONNULL const RzType *  type, size_t *  acc  )

static

Definition at line 413 of file function.c.

                                                                                         {
    rz_return_val_if_fail(type && acc, NULL);
    if (type->kind == RZ_TYPE_KIND_POINTER) {
        *acc = *acc + 1;
        return callable_ptr_unwrap(type->pointer.type, acc);
    }
    return type->kind == RZ_TYPE_KIND_CALLABLE ? type->callable : NULL;
}

References NULL, rz_return_val_if_fail, RZ_TYPE_KIND_CALLABLE, RZ_TYPE_KIND_POINTER, and type.

Referenced by rz_type_callable_ptr_as_string().

callables_ht_free()

static void callables_ht_free ( HtPPKv *  kv )

static

Definition at line 185 of file function.c.

                                          {
    rz_type_callable_free(kv->value);
}

References rz_type_callable_free().

Referenced by rz_type_func_delete_all().

function_names_collect_cb()

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

static

Definition at line 555 of file function.c.

                                                                                {
    RzList *l = (RzList *)user;
    RzCallable *callable = (RzCallable *)v;
    rz_list_append(l, strdup(callable->name));
    return true;
}

References rz_callable_at::name, rz_list_append(), strdup(), and v.

Referenced by rz_type_function_names().

noreturn_function_names_collect_cb()

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

static

Definition at line 574 of file function.c.

                                                                                         {
    RzList *l = (RzList *)user;
    RzCallable *callable = (RzCallable *)v;
    if (callable->noret) {
        rz_list_append(l, strdup(callable->name));
    }
    return true;
}

References rz_callable_at::name, rz_callable_at::noret, rz_list_append(), strdup(), and v.

Referenced by rz_type_noreturn_function_names().

rz_type_callable_arg_add()

RZ_API bool rz_type_callable_arg_add	(	RZ_NONNULL RzCallable *	callable,
		RZ_OWN RZ_NONNULL RzCallableArg *	arg
	)

Adds a new argument to the RzCallable.

Parameters

callable	RzCallable instance
arg	Argument to add

Definition at line 116 of file function.c.

                                                                                                            {
    rz_return_val_if_fail(callable && arg, false);
    rz_pvector_push(callable->args, arg);
    return true;
}

References rz_pvector_push(), and rz_return_val_if_fail.

Referenced by rz_analysis_fcn_vars_add_types(), and rz_analysis_function_derive_args().

rz_type_callable_arg_clone()

RZ_API RZ_OWN RzCallableArg* rz_type_callable_arg_clone

(

RZ_BORROW RZ_NONNULL const RzCallableArg *

arg

)

Creates am exact clone of RzCallableArg.

Parameters

arg	RzCallable argument pointer

Definition at line 85 of file function.c.

                                                                                                       {
    rz_return_val_if_fail(arg, NULL);
    RzCallableArg *newarg = RZ_NEW0(RzCallableArg);
    if (!newarg) {
        return NULL;
    }
    newarg->name = strdup(arg->name);
    newarg->type = rz_type_clone(arg->type);
    return newarg;
}

References arg::name, rz_callable_arg_t::name, NULL, RZ_NEW0, rz_return_val_if_fail, rz_type_clone(), strdup(), and rz_callable_arg_t::type.

Referenced by rz_type_callable_clone().

rz_type_callable_arg_free()

RZ_API void rz_type_callable_arg_free

(

RzCallableArg *

arg

)

Frees the RzCallableArg.

Parameters

arg	RzCallableArg instance

Definition at line 101 of file function.c.

                                                          {
    if (!arg) {
        return;
    }
    free(arg->name);
    rz_type_free(arg->type);
    free(arg);
}

References free(), arg::name, and rz_type_free().

Referenced by c_parser_new_callable(), c_parser_new_naked_callable(), get_callable_type(), parse_type_mfunction(), parse_type_procedure(), rz_type_callable_clone(), and rz_type_callable_new().

rz_type_callable_arg_new()

RZ_API RZ_OWN RzCallableArg* rz_type_callable_arg_new	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name,
		RZ_OWN RZ_NONNULL RzType *	type
	)

Creates a new RzCallableArg given the name and type.

Parameters

typedb	RzTypeDB instance
name	Name of the argument
type	RzType type of the argument

Definition at line 69 of file function.c.

                                                                                                                                     {
    rz_return_val_if_fail(typedb && name && type, NULL);
    RzCallableArg *arg = RZ_NEW0(RzCallableArg);
    if (!arg) {
        return NULL;
    }
    arg->name = strdup(name);
    arg->type = type;
    return arg;
}

References arg(), arg::name, NULL, RZ_NEW0, rz_return_val_if_fail, strdup(), and type.

Referenced by rz_analysis_fcn_vars_add_types(), rz_analysis_function_derive_args(), and rz_type_func_arg_add().

rz_type_callable_as_string()

RZ_API RZ_OWN char* rz_type_callable_as_string	(	const RzTypeDB *	typedb,
		RZ_NONNULL const RzCallable *	callable
	)

Returns the callable C representation.

Parameters

typedb	Types Database instance
callable	RzCallable instance

Definition at line 487 of file function.c.

                                                                                                              {
    rz_return_val_if_fail(typedb && callable, NULL);
    RzStrBuf *buf = rz_strbuf_new("");
    if (!callable_as_string(buf, typedb, callable, 0)) {
        rz_strbuf_free(buf);
        return NULL;
    }
    return rz_strbuf_drain(buf);
}

References callable_as_string(), NULL, rz_return_val_if_fail, rz_strbuf_drain(), rz_strbuf_free(), and rz_strbuf_new().

Referenced by rz_analysis_function_get_signature(), rz_core_types_function_print(), and type_decl_as_pretty_string().

rz_type_callable_clone()

RZ_API RZ_OWN RzCallable* rz_type_callable_clone

(

RZ_BORROW RZ_NONNULL const RzCallable *

callable

)

Creates an exact clone of the RzCallable type.

Parameters

callable

RzCallable instance to clone

Definition at line 33 of file function.c.

                                                                                                  {
    rz_return_val_if_fail(callable, NULL);
    RzCallable *newcallable = RZ_NEW0(RzCallable);
    if (!newcallable) {
        return NULL;
    }
    newcallable->ret = callable->ret ? rz_type_clone(callable->ret) : NULL;
    newcallable->name = callable->name ? strdup(callable->name) : NULL;
    newcallable->args = rz_pvector_new((RzPVectorFree)rz_type_callable_arg_free);
    void **it;
    rz_pvector_foreach (callable->args, it) {
        RzCallableArg *arg = *it;
        rz_pvector_push(newcallable->args, rz_type_callable_arg_clone(arg));
    }
    return newcallable;
}

References rz_callable_at::args, rz_callable_at::name, NULL, rz_callable_at::ret, RZ_NEW0, rz_pvector_foreach, rz_pvector_new(), rz_pvector_push(), rz_return_val_if_fail, rz_type_callable_arg_clone(), rz_type_callable_arg_free(), rz_type_clone(), and strdup().

Referenced by rz_analysis_function_clone_type(), and rz_type_clone().

rz_type_callable_free()

RZ_API void rz_type_callable_free

(

RZ_NONNULL RzCallable *

callable

)

Frees the RzCallable.

Parameters

callable

RzCallable type

Definition at line 55 of file function.c.

                                                                   {
    rz_type_free(callable->ret);
    rz_pvector_free(callable->args);
    free(callable->name);
    free(callable);
}

References free(), rz_pvector_free(), and rz_type_free().

Referenced by callables_ht_free(), get_callable_type(), rz_analysis_function_derive_args(), rz_analysis_function_get_signature(), and type_match().

rz_type_callable_new()

RZ_API RZ_OWN RzCallable* rz_type_callable_new

(

RZ_NULLABLE const char *

name

)

Creates a new RzCallable type.

Parameters

name	Name of the callable type
type	A return type of the callable type

Definition at line 17 of file function.c.

                                                                             {
    RzCallable *callable = RZ_NEW0(RzCallable);
    if (!callable) {
        return NULL;
    }
    callable->ret = NULL;
    callable->name = name ? strdup(name) : NULL;
    callable->args = rz_pvector_new((RzPVectorFree)rz_type_callable_arg_free);
    return callable;
}

References rz_callable_at::args, rz_callable_at::name, NULL, rz_callable_at::ret, RZ_NEW0, rz_pvector_new(), rz_type_callable_arg_free(), and strdup().

Referenced by rz_type_func_new().

rz_type_callable_ptr_as_string()

RZ_API RZ_OWN char* rz_type_callable_ptr_as_string	(	const RzTypeDB *	typedb,
		RZ_NONNULL const RzType *	type
	)

Returns the callable pointer C representation.

Parameters

typedb	Types Database instance
callable	RzCallable instance

Definition at line 464 of file function.c.

                                                                                                          {
    rz_return_val_if_fail(typedb && type, NULL);
    rz_return_val_if_fail(type->kind == RZ_TYPE_KIND_POINTER, NULL);
 
    size_t ptr_depth = 0;
    const RzCallable *callable = callable_ptr_unwrap(type, &ptr_depth);
    if (!callable) {
        return NULL;
    }
    RzStrBuf *buf = rz_strbuf_new("");
    if (!callable_as_string(buf, typedb, callable, ptr_depth)) {
        rz_strbuf_free(buf);
        return NULL;
    }
    return rz_strbuf_drain(buf);
}

References callable_as_string(), callable_ptr_unwrap(), NULL, rz_return_val_if_fail, rz_strbuf_drain(), rz_strbuf_free(), rz_strbuf_new(), RZ_TYPE_KIND_POINTER, and type.

Referenced by type_decl_as_pretty_string().

rz_type_func_arg_add()

RZ_API bool rz_type_func_arg_add	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	func_name,
		RZ_NONNULL const char *	arg_name,
		RZ_OWN RZ_NONNULL RzType *	arg_type
	)

Adds a new argument to the RzCallable type at the end of the arguments vector.

Parameters

typedb	Type Database instance
func_name	Name of the callable to search
arg_name	Name of the new argument
arg_type	RzType type of the new argument

Definition at line 327 of file function.c.

                                                                                                                                                          {
    rz_return_val_if_fail(typedb && func_name, false);
    RzCallable *callable = rz_type_func_get(typedb, func_name);
    if (!callable) {
        return false;
    }
    RzCallableArg *arg = rz_type_callable_arg_new(typedb, arg_name, arg_type);
    if (!arg) {
        return false;
    }
    rz_pvector_push(callable->args, arg);
    return true;
}

References rz_callable_at::args, rz_pvector_push(), rz_return_val_if_fail, rz_type_callable_arg_new(), and rz_type_func_get().

rz_type_func_args_count()

RZ_API int rz_type_func_args_count	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Searches for the RzCallable type in types database and returns arguments' count.

Parameters

typedb	Type Database instance
name	Name of the callable to search

Definition at line 262 of file function.c.

                                                                                  {
    rz_return_val_if_fail(typedb && name, 0);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return -1;
    }
    return rz_pvector_len(callable->args);
}

References rz_callable_at::args, rz_pvector_len(), rz_return_val_if_fail, and rz_type_func_get().

Referenced by ds_print_calls_hints(), ds_print_esil_analysis(), extract_arg(), rz_analysis_extract_rarg(), rz_analysis_fcn_format_sig(), rz_core_analysis_function_signature(), rz_core_get_func_args(), and type_match().

rz_type_func_args_name()

RZ_API RZ_BORROW const char* rz_type_func_args_name	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name,
		int	i
	)

Searches for the RzCallable type in types database and returns argument name.

Parameters

typedb	Type Database instance
name	Name of the callable to search
i	Index of the argument go get type of

Definition at line 302 of file function.c.

                                                                                                          {
    rz_return_val_if_fail(typedb && name, NULL);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return NULL;
    }
    if (i >= rz_pvector_len(callable->args)) {
        return NULL;
    }
    RzCallableArg *arg = *rz_pvector_index_ptr(callable->args, i);
    if (!arg) {
        rz_warn_if_reached(); // should not happen in the types database
        return NULL;
    }
    return arg->name;
}

References rz_callable_at::args, i, arg::name, NULL, rz_pvector_index_ptr(), rz_pvector_len(), rz_return_val_if_fail, rz_type_func_get(), and rz_warn_if_reached.

Referenced by ds_print_calls_hints(), extract_arg(), rz_analysis_extract_rarg(), rz_analysis_fcn_format_sig(), rz_analysis_function_get_json(), and set_fcn_args_info().

rz_type_func_args_type()

RZ_API RZ_BORROW RzType* rz_type_func_args_type	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name,
		int	i
	)

Searches for the RzCallable type in types database and returns argument type.

Parameters

typedb	Type Database instance
name	Name of the callable to search
i	Index of the argument go get type of

Definition at line 278 of file function.c.

                                                                                                      {
    rz_return_val_if_fail(typedb && name, NULL);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return NULL;
    }
    if (i >= rz_pvector_len(callable->args)) {
        return NULL;
    }
    RzCallableArg *arg = *rz_pvector_index_ptr(callable->args, i);
    if (!arg) {
        rz_warn_if_reached(); // should not happen in the types database
        return NULL;
    }
    return arg->type;
}

References rz_callable_at::args, i, NULL, rz_pvector_index_ptr(), rz_pvector_len(), rz_return_val_if_fail, rz_type_func_get(), and rz_warn_if_reached.

Referenced by ds_print_calls_hints(), extract_arg(), rz_analysis_extract_rarg(), rz_analysis_fcn_format_sig(), rz_analysis_function_get_json(), and set_fcn_args_info().

rz_type_func_cc()

RZ_API RZ_BORROW const char* rz_type_func_cc	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Searches for the RzCallable type in types database and returns calling convention.

Parameters

typedb	Type Database instance
name	Name of the callable to search

Definition at line 230 of file function.c.

                                                                                            {
    rz_return_val_if_fail(typedb && name, NULL);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return NULL;
    }
    return callable->cc;
}

References rz_callable_at::cc, NULL, rz_return_val_if_fail, and rz_type_func_get().

Referenced by rz_analysis_cc_func(), and rz_type_function_cc_handler().

rz_type_func_cc_set()

RZ_API bool rz_type_func_cc_set	(	RzTypeDB *	typedb,
		const char *	name,
		const char *	cc
	)

Searches for the RzCallable type in types database and set the calling convention.

Parameters

typedb	Type Database instance
name	Name of the callable to search
name	Name of the calling convention to set

Definition at line 246 of file function.c.

                                                                                    {
    rz_return_val_if_fail(typedb && name, false);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return false;
    }
    callable->cc = strdup(cc);
    return true;
}

References rz_callable_at::cc, rz_return_val_if_fail, rz_type_func_get(), and strdup().

Referenced by rz_type_function_cc_handler().

rz_type_func_delete()

RZ_API bool rz_type_func_delete	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Removes RzCallable type from the types database.

Parameters

typedb	Type Database instance
name	Name of the callable to search

Definition at line 179 of file function.c.

                                                                               {
    rz_return_val_if_fail(typedb && name, false);
    ht_pp_delete(typedb->callables, name);
    return true;
}

References rz_type_db_t::callables, and rz_return_val_if_fail.

Referenced by rz_analysis_function_set_type_str(), rz_type_db_del(), and rz_type_function_del_handler().

rz_type_func_delete_all()

RZ_API void rz_type_func_delete_all

(

RzTypeDB *

typedb

)

Removes all RzCallable types.

Definition at line 192 of file function.c.

                                                      {
    ht_pp_free(typedb->callables);
    typedb->callables = ht_pp_new(NULL, callables_ht_free, NULL);
}

References rz_type_db_t::callables, callables_ht_free(), and NULL.

Referenced by rz_type_function_del_all_handler().

rz_type_func_exist()

RZ_API bool rz_type_func_exist	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Checks if the RzCallable type exists in the database given the name.

Parameters

typedb	Type Database instance
name	Name of the callable to search

Definition at line 203 of file function.c.

                                                                              {
    rz_return_val_if_fail(typedb && name, false);
    bool found = false;
    return ht_pp_find(typedb->callables, name, &found) && found;
}

References rz_type_db_t::callables, found, and rz_return_val_if_fail.

Referenced by ds_print_calls_hints(), function_name_try_guess(), propagate_types_among_used_variables(), resolve_fcn_name(), rz_analysis_fcn_format_sig(), rz_analysis_fcn_vars_add_types(), rz_analysis_function_set_type_str(), rz_analysis_noreturn_add(), rz_type_db_del(), and rz_type_func_save().

rz_type_func_get()

RZ_API RZ_BORROW RzCallable* rz_type_func_get	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Returns the RzCallable from the database by name.

Parameters

typedb	Type Database instance
name	RzCallable (function) name to search

Definition at line 162 of file function.c.

                                                                                             {
    rz_return_val_if_fail(typedb && name, NULL);
    bool found = false;
    RzCallable *callable = ht_pp_find(typedb->callables, name, &found);
    if (!found || !callable) {
        RZ_LOG_DEBUG("Cannot find function type \"%s\"\n", name);
        return NULL;
    }
    return callable;
}

References rz_type_db_t::callables, found, NULL, RZ_LOG_DEBUG, and rz_return_val_if_fail.

Referenced by function_type_derive(), rz_analysis_function_clone_type(), rz_core_types_function_print(), rz_type_func_arg_add(), rz_type_func_args_count(), rz_type_func_args_name(), rz_type_func_args_type(), rz_type_func_cc(), rz_type_func_cc_set(), rz_type_func_is_noreturn(), rz_type_func_noreturn_add(), rz_type_func_noreturn_drop(), rz_type_func_ret(), and rz_type_func_ret_set().

rz_type_func_is_noreturn()

RZ_API bool rz_type_func_is_noreturn	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Checks if the RzCallable type is defined as "noreturn".

Parameters

typedb	Types Database instance
name	Name of the RzCallable type

Definition at line 503 of file function.c.

                                                                                    {
    rz_return_val_if_fail(typedb && name, false);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return false;
    }
    return callable->noret;
}

References rz_callable_at::noret, rz_return_val_if_fail, and rz_type_func_get().

Referenced by rz_analysis_is_noreturn().

rz_type_func_new()

RZ_API RZ_OWN RzCallable* rz_type_func_new	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name,
		RZ_OWN RZ_NULLABLE RzType *	type
	)

Creates a new RzCallable type.

Parameters

typedb	RzTypeDB instance
name	Name of the callable type
type	A return type of the callable type

Definition at line 131 of file function.c.

                                                                                                                           {
    rz_return_val_if_fail(typedb && name, NULL);
    RzCallable *callable = rz_type_callable_new(name);
    if (!callable) {
        return NULL;
    }
    callable->ret = type;
    return callable;
}

References NULL, rz_callable_at::ret, rz_return_val_if_fail, rz_type_callable_new(), and type.

Referenced by get_callable_type(), rz_analysis_fcn_vars_add_types(), rz_analysis_function_create_type(), and rz_type_func_noreturn_add().

rz_type_func_noreturn_add()

RZ_API bool rz_type_func_noreturn_add	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Adds the "noreturn" attribute to the RzCallable type.

Parameters

typedb	Types Database instance
name	Name of the RzCallable type

Definition at line 518 of file function.c.

                                                                                     {
    rz_return_val_if_fail(typedb && name, false);
    // If the function exists with the specified name already, we set the noreturn flag for it
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (callable) {
        callable->noret = true;
    } else {
        // If it doesn't - we create a new dummy RzCallable for it
        // The return type is default and no arguments
        callable = rz_type_func_new(typedb, name, NULL);
        if (!callable) {
            return false;
        }
        callable->noret = true;
        rz_type_func_save(typedb, callable);
    }
    return true;
}

References rz_callable_at::noret, NULL, rz_return_val_if_fail, rz_type_func_get(), rz_type_func_new(), and rz_type_func_save().

Referenced by rz_type_list_noreturn_handler().

rz_type_func_noreturn_drop()

RZ_API bool rz_type_func_noreturn_drop	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Drops the "noreturn" attribute from the RzCallable type.

Parameters

typedb	Types Database instance
name	Name of the RzCallable type

Definition at line 543 of file function.c.

                                                                                      {
    rz_return_val_if_fail(typedb && name, false);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return false;
    }
    callable->noret = false;
    return true;
}

References rz_callable_at::noret, rz_return_val_if_fail, and rz_type_func_get().

Referenced by rz_type_noreturn_del_all_handler(), and rz_type_noreturn_del_handler().

rz_type_func_ret()

RZ_API RZ_BORROW RzType* rz_type_func_ret	(	RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Searches for the RzCallable type in types database and returns return type.

Parameters

typedb	Type Database instance
name	Name of the callable to search

Definition at line 215 of file function.c.

                                                                                         {
    rz_return_val_if_fail(typedb && name, NULL);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return NULL;
    }
    return callable->ret;
}

References NULL, rz_callable_at::ret, rz_return_val_if_fail, and rz_type_func_get().

Referenced by ds_print_calls_hints(), ds_print_esil_analysis(), propagate_types_among_used_variables(), rz_analysis_fcn_format_sig(), rz_analysis_function_get_json(), and rz_core_analysis_function_signature().

rz_type_func_ret_set()

RZ_API bool rz_type_func_ret_set	(	RzTypeDB *	typedb,
		const char *	name,
		RZ_OWN RZ_NONNULL RzType *	type
	)

Sets the new return type for the RzCallable.

Parameters

typedb	Type Database instance
name	Name of the callable to search
type	RzType return type

Definition at line 348 of file function.c.

                                                                                                     {
    rz_return_val_if_fail(typedb && name && type, false);
    RzCallable *callable = rz_type_func_get(typedb, name);
    if (!callable) {
        return false;
    }
    callable->ret = type;
    return true;
}

References rz_callable_at::ret, rz_return_val_if_fail, rz_type_func_get(), and type.

Referenced by rz_analysis_function_signature_type_handler().

rz_type_func_save()

RZ_API bool rz_type_func_save	(	RzTypeDB *	typedb,
		RZ_NONNULL RzCallable *	callable
	)

Stores RzCallable type in the types database.

Parameters

typedb	Type Database instance
callable	RzCallable type to save

Definition at line 147 of file function.c.

                                                                                 {
    rz_return_val_if_fail(typedb && callable && callable->name, false);
    if (rz_type_func_exist(typedb, callable->name)) {
        return false;
    }
    ht_pp_insert(typedb->callables, callable->name, callable);
    return true;
}

References rz_type_db_t::callables, rz_return_val_if_fail, and rz_type_func_exist().

Referenced by parse_type_mfunction(), parse_type_procedure(), rz_analysis_fcn_vars_add_types(), rz_analysis_function_get_arg_count(), and rz_type_func_noreturn_add().

rz_type_function_names()

RZ_API RZ_OWN RzList* rz_type_function_names

(

RzTypeDB *

typedb

)

Returns the list of all function type names.

Parameters

typedb

Types Database instance

Definition at line 567 of file function.c.

                                                                 {
    rz_return_val_if_fail(typedb, NULL);
    RzList *result = rz_list_newf(free);
    ht_pp_foreach(typedb->callables, function_names_collect_cb, result);
    return result;
}

References rz_type_db_t::callables, free(), function_names_collect_cb(), NULL, rz_list_newf(), and rz_return_val_if_fail.

Referenced by rz_core_types_function_print_all().

rz_type_is_callable()

RZ_API bool rz_type_is_callable

(

RZ_NONNULL const RzType *

type

)

Checks if the RzType is the pointer to the RzCallable.

Parameters

typedb	Types Database instance
type	RzType

Definition at line 364 of file function.c.

                                                               {
    rz_return_val_if_fail(type, false);
    return type->kind == RZ_TYPE_KIND_CALLABLE;
}

References rz_return_val_if_fail, RZ_TYPE_KIND_CALLABLE, and type.

rz_type_is_callable_ptr()

RZ_API bool rz_type_is_callable_ptr

(

RZ_NONNULL const RzType *

type

)

Checks if the RzType is the pointer to the RzCallable.

Parameters

typedb	Types Database instance
type	RzType

Definition at line 375 of file function.c.

                                                                   {
    rz_return_val_if_fail(type, false);
    if (type->kind != RZ_TYPE_KIND_POINTER) {
        return false;
    }
    if (type->pointer.type->kind == RZ_TYPE_KIND_CALLABLE) {
        return true;
    } else if (type->pointer.type->kind == RZ_TYPE_KIND_POINTER) {
        return rz_type_is_callable_ptr(type->pointer.type);
    }
    return false;
}

References rz_return_val_if_fail, RZ_TYPE_KIND_CALLABLE, RZ_TYPE_KIND_POINTER, and type.

Referenced by rz_type_as_format().

rz_type_is_callable_ptr_nested()

RZ_API bool rz_type_is_callable_ptr_nested

(

RZ_NONNULL const RzType *

type

)

Checks if the RzType is the nested pointer to the RzCallable.

For example it could be one of those:

• int (*func)(int a, char *b)
• int (**func)(int a, char *b)
• int (****func)(int a, char *b)

Parameters

typedb	Types Database instance
type	RzType

Definition at line 399 of file function.c.

                                                                          {
    rz_return_val_if_fail(type, false);
    if (type->kind != RZ_TYPE_KIND_POINTER) {
        return false;
    }
    // There should not exist pointers to the empty types
    RzType *ptr = type->pointer.type;
    rz_return_val_if_fail(ptr, false);
    if (ptr->kind == RZ_TYPE_KIND_POINTER) {
        return rz_type_is_callable_ptr_nested(ptr);
    }
    return ptr->kind == RZ_TYPE_KIND_CALLABLE;
}

References rz_type_t::kind, rz_return_val_if_fail, RZ_TYPE_KIND_CALLABLE, RZ_TYPE_KIND_POINTER, and type.

Referenced by type_as_pretty_string(), type_decl_as_pretty_string(), and type_to_format_pair().

rz_type_noreturn_function_names()

RZ_API RZ_OWN RzList* rz_type_noreturn_function_names

(

RzTypeDB *

typedb

)

Returns the list of all noreturn function type names.

Parameters

typedb

Types Database instance

Definition at line 588 of file function.c.

                                                                        {
    rz_return_val_if_fail(typedb, NULL);
    RzList *noretl = rz_list_newf(free);
    ht_pp_foreach(typedb->callables, noreturn_function_names_collect_cb, noretl);
    return noretl;
}

References rz_type_db_t::callables, free(), noreturn_function_names_collect_cb(), NULL, rz_list_newf(), and rz_return_val_if_fail.

Referenced by rz_analysis_noreturn_functions(), rz_core_types_function_noreturn_print(), and rz_type_noreturn_del_all_handler().