syscall.c File Reference

#include <rz_types.h>
#include <rz_util.h>
#include <rz_syscall.h>
#include <stdio.h>
#include <string.h>

Go to the source code of this file.

Functions
	RZ_LIB_VERSION (rz_syscall)
RZ_API RzSyscall *	rz_syscall_ref (RzSyscall *sc)
RZ_API RZ_OWN RzSysregItem *	rz_sysreg_item_new (RZ_NULLABLE const char *name)
	Creates a new RzSysregItem type. More...
static void	free_port_kv (HtUPKv *kv)
RZ_API RzSysregsDB *	rz_sysregs_db_new ()
	Creates a new RzSysregDB type. More...
RZ_API void	rz_sysregs_db_free (RzSysregsDB *sysregdb)
	Frees a RzSysregDB type. More...
RZ_API RzSyscall *	rz_syscall_new (void)
	Creates a new RzSyscall type. More...
RZ_API void	rz_syscall_free (RzSyscall *s)
	Frees an RzSyscall type. More...
RZ_API void	rz_sysreg_item_free (RzSysregItem *s)
	Frees an RzSysregItem type. More...
static bool	load_sdb (Sdb **db, const char *name)
static bool	syscall_reload_needed (RzSyscall *s, const char *os, const char *arch, int bits)
static bool	sysregs_reload_needed (RzSyscall *s, const char *arch, int bits, const char *cpu)
static bool	sdb_load_sysregs (RzSysregsDB *sysregdb, Sdb *sdb)
static bool	sdb_load_by_path (RZ_NONNULL RzSysregsDB *sysregdb, const char *path)
RZ_API bool	rz_sysreg_load_sdb (RzSysregsDB *sysregdb, const char *path)
	Loads the RzSysregDB from the path to the hashtable. More...
RZ_API bool	rz_sysreg_set_arch (RzSyscall *s, RZ_NONNULL const char *arch, RZ_NONNULL const char *regs_dir)
	Sets the architecture for sysregs during analysis and loads up the sysregs SDB database. More...
RZ_API bool	rz_syscall_setup (RzSyscall *s, const char *arch, int bits, const char *cpu, const char *os)
RZ_API RzSyscallItem *	rz_syscall_item_new_from_string (const char *name, const char *s)
RZ_API void	rz_syscall_item_free (RzSyscallItem *si)
static int	getswi (RzSyscall *s, int swi)
RZ_API int	rz_syscall_get_swi (RzSyscall *s)
RZ_API RzSyscallItem *	rz_syscall_get (RzSyscall *s, int num, int swi)
RZ_API int	rz_syscall_get_num (RzSyscall *s, const char *str)
RZ_API const char *	rz_syscall_get_i (RzSyscall *s, int num, int swi)
static bool	callback_list (void *u, const char *k, const char *v)
RZ_API RzList *	rz_syscall_list (RzSyscall *s)
RZ_API const char *	rz_sysreg_get (RzSyscall *s, const char *type, ut64 port)
	Searches the sysregs SDB database inside librz/reg/d for the type (mmio/reg) and returns its value as a string. More...

Function Documentation

callback_list()

static bool callback_list ( void *  u, const char *  k, const char *  v  )

static

Definition at line 399 of file syscall.c.

                                                                 {
    RzList *list = (RzList *)u;
    if (!strchr(k, '.')) {
        RzSyscallItem *si = rz_syscall_item_new_from_string(k, v);
        if (!si) {
            return true;
        }
        if (!strchr(si->name, '.')) {
            rz_list_append(list, si);
        } else {
            rz_syscall_item_free(si);
        }
    }
    return true; // continue loop
}

References k, list(), rz_list_append(), rz_syscall_item_free(), rz_syscall_item_new_from_string(), si, and v.

Referenced by rz_syscall_list().

free_port_kv()

static void free_port_kv ( HtUPKv *  kv )

static

Definition at line 33 of file syscall.c.

                                     {
    rz_sysreg_item_free(kv->value);
}

References rz_sysreg_item_free().

Referenced by rz_sysregs_db_new().

getswi()

static int getswi ( RzSyscall *  s, int  swi  )

static

Definition at line 334 of file syscall.c.

                                         {
    if (s && swi == -1) {
        return rz_syscall_get_swi(s);
    }
    return swi;
}

References rz_syscall_get_swi(), and s.

Referenced by rz_syscall_get(), and rz_syscall_get_i().

load_sdb()

static bool load_sdb ( Sdb **  db, const char *  name  )

static

Definition at line 107 of file syscall.c.

                                                 {
    rz_return_val_if_fail(db, false);
    char *sdb_path = rz_path_system(RZ_SDB);
    char *file_name = rz_str_newf("%s.sdb", name);
    char *file = rz_file_path_join(sdb_path, file_name);
    free(file_name);
    free(sdb_path);
    if (rz_file_exists(file)) {
        if (*db) {
            sdb_reset(*db);
            sdb_open(*db, file);
        } else {
            *db = sdb_new(0, file, 0);
        }
        free(file);
        return true;
    }
    free(file);
    return false;
}

References file_name, free(), rz_file_exists(), rz_file_path_join(), rz_path_system(), rz_return_val_if_fail, RZ_SDB, rz_str_newf(), sdb_new(), sdb_open(), and sdb_reset().

Referenced by rz_syscall_setup().

RZ_LIB_VERSION()

RZ_LIB_VERSION

(

rz_syscall

)

rz_syscall_free()

RZ_API void rz_syscall_free

(

RzSyscall *

s

)

Frees an RzSyscall type.

Definition at line 79 of file syscall.c.

                                          {
    if (s) {
        if (s->refs > 0) {
            s->refs--;
            return;
        }
        sdb_free(s->db);
        free(s->os);
        free(s->cpu);
        free(s->arch);
        rz_sysregs_db_free(s->srdb);
        free(s);
    }
}

References free(), rz_sysregs_db_free(), s, and sdb_free().

Referenced by resolve_syscalls(), rz_analysis_free(), rz_asm_free(), and rz_egg_free().

rz_syscall_get()

RZ_API RzSyscallItem* rz_syscall_get	(	RzSyscall *	s,
		int	num,
		int	swi
	)

Definition at line 345 of file syscall.c.

                                                                     {
    rz_return_val_if_fail(s, NULL);
    if (!s->db) {
        return NULL;
    }
    const char *ret, *ret2, *key;
    swi = getswi(s, swi);
    if (swi < 16) {
        key = sdb_fmt("%d.%d", swi, num);
    } else {
        key = sdb_fmt("0x%02x.%d", swi, num);
    }
    ret = sdb_const_get(s->db, key, 0);
    if (!ret) {
        key = sdb_fmt("0x%02x.0x%02x", swi, num); // Workaround until Syscall SDB is fixed
        ret = sdb_const_get(s->db, key, 0);
        if (!ret) {
            key = sdb_fmt("0x%02x.%d", num, swi); // Workaround until Syscall SDB is fixed
            ret = sdb_const_get(s->db, key, 0);
            if (!ret) {
                return NULL;
            }
        }
    }
    ret2 = sdb_const_get(s->db, ret, 0);
    if (!ret2) {
        return NULL;
    }
    return rz_syscall_item_new_from_string(ret, ret2);
}

References getswi(), key, NULL, num, rz_return_val_if_fail, rz_syscall_item_new_from_string(), s, sdb_const_get(), and sdb_fmt().

Referenced by do_syscall_search(), filter(), resolve_syscalls(), rz_analysis_syscall_number_handler(), rz_core_analysis_esil(), rz_core_syscall_as_string(), rz_egg_syscall(), show_syscall(), and syscalls_dump().

rz_syscall_get_i()

RZ_API const char* rz_syscall_get_i	(	RzSyscall *	s,
		int	num,
		int	swi
	)

Definition at line 388 of file syscall.c.

                                                                    {
    rz_return_val_if_fail(s, NULL);
    if (!s->db) {
        return NULL;
    }
    char foo[32];
    swi = getswi(s, swi);
    snprintf(foo, sizeof(foo), "0x%x.%d", swi, num);
    return sdb_const_get(s->db, foo, 0);
}

References foo, getswi(), NULL, num, rz_return_val_if_fail, s, sdb_const_get(), and snprintf.

rz_syscall_get_num()

RZ_API int rz_syscall_get_num	(	RzSyscall *	s,
		const char *	str
	)

Definition at line 376 of file syscall.c.

                                                             {
    rz_return_val_if_fail(s && str, -1);
    if (!s->db) {
        return -1;
    }
    int sn = (int)sdb_array_get_num(s->db, str, 1, NULL);
    if (sn == 0) {
        return (int)sdb_array_get_num(s->db, str, 0, NULL);
    }
    return sn;
}

References int, NULL, rz_return_val_if_fail, s, sdb_array_get_num(), and cmd_descs_generate::str.

Referenced by cmd_debug_cont_syscall(), rz_analysis_syscall_name_handler(), rz_asm_massemble(), rz_core_syscall(), rz_egg_syscall(), and syscalls_dump().

rz_syscall_get_swi()

RZ_API int rz_syscall_get_swi

(

RzSyscall *

s

)

Definition at line 341 of file syscall.c.

                                            {
    return (int)sdb_num_get(s->db, "_", NULL);
}

References NULL, s, and sdb_num_get().

Referenced by getswi(), and rz_core_syscall_as_string().

rz_syscall_item_free()

RZ_API void rz_syscall_item_free

(

RzSyscallItem *

si

)

Definition at line 325 of file syscall.c.

                                                    {
    if (!si) {
        return;
    }
    free(si->name);
    free(si->sargs);
    free(si);
}

References free(), and si.

Referenced by callback_list(), do_syscall_search(), filter(), resolve_syscalls(), rz_core_analysis_esil(), rz_core_syscall_as_string(), rz_egg_syscall(), rz_syscall_list(), show_syscall(), and syscalls_dump().

rz_syscall_item_new_from_string()

RZ_API RzSyscallItem* rz_syscall_item_new_from_string	(	const char *	name,
		const char *	s
	)

Definition at line 290 of file syscall.c.

                                                                                       {
    RzSyscallItem *si;
    char *o;
    if (!name || !s) {
        return NULL;
    }
    o = strdup(s);
    int cols = rz_str_split(o, ',');
    if (cols < 3) {
        free(o);
        return NULL;
    }
 
    si = RZ_NEW0(RzSyscallItem);
    if (!si) {
        free(o);
        return NULL;
    }
    si->name = strdup(name);
    si->swi = (int)rz_num_get(NULL, rz_str_word_get0(o, 0));
    si->num = (int)rz_num_get(NULL, rz_str_word_get0(o, 1));
    si->args = (int)rz_num_get(NULL, rz_str_word_get0(o, 2));
    si->sargs = calloc(si->args + 1, sizeof(char));
    if (!si->sargs) {
        free(si);
        free(o);
        return NULL;
    }
    if (cols > 3) {
        strncpy(si->sargs, rz_str_word_get0(o, 3), si->args);
    }
    free(o);
    return si;
}

References calloc(), free(), int, NULL, RZ_NEW0, rz_num_get(), rz_str_split(), rz_str_word_get0(), s, si, and strdup().

Referenced by callback_list(), and rz_syscall_get().

rz_syscall_list()

RZ_API RzList* rz_syscall_list

(

RzSyscall *

s

)

Definition at line 415 of file syscall.c.

                                             {
    rz_return_val_if_fail(s, NULL);
    if (!s->db) {
        return NULL;
    }
    RzList *list = rz_list_newf((RzListFree)rz_syscall_item_free);
    sdb_foreach(s->db, callback_list, list);
    return list;
}

References callback_list(), list(), NULL, rz_list_newf(), rz_return_val_if_fail, rz_syscall_item_free(), s, and sdb_foreach().

Referenced by do_analysis_search(), rz_analysis_syscall_print_handler(), and syscalls_dump().

rz_syscall_new()

RZ_API RzSyscall* rz_syscall_new

(

void

)

Creates a new RzSyscall type.

Definition at line 67 of file syscall.c.

                                       {
    RzSyscall *rs = RZ_NEW0(RzSyscall);
    if (rs) {
        rs->srdb = rz_sysregs_db_new(); // sysregs database
        rs->db = sdb_new0();
    }
    return rs;
}

References rs, RZ_NEW0, rz_sysregs_db_new(), and sdb_new0().

Referenced by resolve_syscalls(), rz_analysis_new(), rz_egg_new(), and rz_main_rz_asm().

rz_syscall_ref()

RZ_API RzSyscall* rz_syscall_ref

(

RzSyscall *

sc

)

Definition at line 12 of file syscall.c.

                                                {
    sc->refs++;
    return sc;
}

References sc.

Referenced by rz_core_init().

rz_syscall_setup()

RZ_API bool rz_syscall_setup	(	RzSyscall *	s,
		const char *	arch,
		int	bits,
		const char *	cpu,
		const char *	os
	)

Definition at line 234 of file syscall.c.

                                                                                                        {
    bool syscall_changed, sysregs_changed;
 
    if (!os || !*os) {
        os = RZ_SYS_OS;
    }
    if (!arch) {
        arch = RZ_SYS_ARCH;
    }
    if (!cpu) {
        cpu = arch;
    }
    syscall_changed = syscall_reload_needed(s, os, arch, bits);
    sysregs_changed = sysregs_reload_needed(s, arch, bits, cpu);
 
    free(s->os);
    s->os = strdup(os);
 
    free(s->cpu);
    s->cpu = strdup(cpu);
 
    free(s->arch);
    s->arch = strdup(arch);
 
    s->bits = bits;
 
    if (!strcmp(os, "any")) { // ignored
        return true;
    } else if (!strcmp(os, "darwin") || !strcmp(os, "osx") || !strcmp(os, "macos")) {
        os = "darwin";
    }
 
    if (syscall_changed) {
        char *dbName = rz_str_newf(RZ_JOIN_2_PATHS("syscall", "%s-%s-%d"),
            os, arch, bits);
        if (dbName) {
            if (!load_sdb(&s->db, dbName)) {
                sdb_free(s->db);
                s->db = NULL;
            }
            free(dbName);
        }
    }
 
    if (sysregs_changed) {
        char *regs_dir = rz_path_system(RZ_SDB_REG);
        rz_sysreg_set_arch(s, arch, regs_dir);
        free(regs_dir);
    }
    if (s->fd) {
        fclose(s->fd);
        s->fd = NULL;
    }
    return true;
}

References arch, bits(), cpu, rz_socket_t::fd, free(), load_sdb(), NULL, RZ_JOIN_2_PATHS, rz_path_system(), RZ_SDB_REG, rz_str_newf(), RZ_SYS_ARCH, RZ_SYS_OS, rz_sysreg_set_arch(), s, sdb_free(), strdup(), syscall_reload_needed(), and sysregs_reload_needed().

Referenced by cb_asmarch(), cb_asmbits(), cb_asmos(), resolve_syscalls(), rz_asm_massemble(), rz_egg_setup(), and rz_main_rz_asm().

rz_sysreg_get()

RZ_API const char* rz_sysreg_get	(	RzSyscall *	s,
		const char *	type,
		ut64	port
	)

Searches the sysregs SDB database inside librz/reg/d for the type (mmio/reg) and returns its value as a string.

Parameters

s	reference to RzSyscall
type	reference to the type of key: mmio/reg
port	reference to the io port

Definition at line 433 of file syscall.c.

                                                                            {
    rz_return_val_if_fail(s, NULL);
    if (!s->srdb) {
        return NULL;
    }
    RzSysregItem *item = ht_up_find(s->srdb->port, port, NULL);
    if (item && !strcmp(item->type, type)) {
        return item->comment;
    }
    return NULL;
}

References rz_sysreg_item_t::comment, NULL, rz_socket_t::port, rz_return_val_if_fail, s, type, and rz_sysreg_item_t::type.

Referenced by ds_print_sysregs().

rz_sysreg_item_free()

RZ_API void rz_sysreg_item_free

(

RzSysregItem *

s

)

Frees an RzSysregItem type.

Definition at line 97 of file syscall.c.

                                                 {
    if (!s) {
        return;
    }
    free(s->comment);
    free(s->name);
    free(s->type);
    free(s);
}

References free(), and s.

Referenced by free_port_kv(), and sdb_load_sysregs().

rz_sysreg_item_new()

RZ_API RZ_OWN RzSysregItem* rz_sysreg_item_new

(

RZ_NULLABLE const char *

name

)

Creates a new RzSysregItem type.

Parameters

name	Name of the SysregItem (sysregitem->name)

Definition at line 22 of file syscall.c.

                                                                             {
    RzSysregItem *sysregitem = RZ_NEW0(RzSysregItem);
    if (!sysregitem) {
        return NULL;
    }
    sysregitem->comment = NULL;
    sysregitem->type = NULL;
    sysregitem->name = name ? strdup(name) : NULL;
    return sysregitem;
}

References rz_sysreg_item_t::comment, rz_sysreg_item_t::name, NULL, RZ_NEW0, strdup(), and rz_sysreg_item_t::type.

Referenced by sdb_load_sysregs().

rz_sysreg_load_sdb()

RZ_API bool rz_sysreg_load_sdb	(	RzSysregsDB *	sysregdb,
		const char *	path
	)

Loads the RzSysregDB from the path to the hashtable.

Parameters

s	reference to RzSysregDB
path	reference to path of the SDB file

Definition at line 198 of file syscall.c.

                                                                        {
    if (!rz_file_exists(path) || !sysregdb) {
        return false;
    }
    return sdb_load_by_path(sysregdb, path);
}

References path, rz_file_exists(), and sdb_load_by_path().

Referenced by rz_sysreg_set_arch().

rz_sysreg_set_arch()

RZ_API bool rz_sysreg_set_arch	(	RzSyscall *	s,
		RZ_NONNULL const char *	arch,
		RZ_NONNULL const char *	regs_dir
	)

Sets the architecture for sysregs during analysis and loads up the sysregs SDB database.

Parameters

s	reference to RzSyscall
arch	reference to value of asm.arch
regs_dir	path where registers SDB files are located

Definition at line 213 of file syscall.c.

                                                                                                           {
    rz_return_val_if_fail(s && regs_dir && arch, false);
 
    char buf[60];
    char *path = rz_file_path_join(regs_dir, rz_strf(buf, "%s-%s-%d.sdb", arch, s->cpu, s->bits));
    if (!path) {
        return true;
    }
    rz_sysregs_db_free(s->srdb);
    s->srdb = rz_sysregs_db_new();
    if (!rz_sysreg_load_sdb(s->srdb, path)) {
        free(path);
        rz_sysregs_db_free(s->srdb);
        s->srdb = rz_sysregs_db_new();
        return false;
    }
    free(path);
    return true;
}

References arch, free(), path, rz_file_path_join(), rz_return_val_if_fail, rz_strf, rz_sysreg_load_sdb(), rz_sysregs_db_free(), rz_sysregs_db_new(), and s.

Referenced by rz_syscall_setup().

rz_sysregs_db_free()

RZ_API void rz_sysregs_db_free

(

RzSysregsDB *

sysregdb

)

Frees a RzSysregDB type.

Definition at line 56 of file syscall.c.

                                                      {
    if (!sysregdb) {
        return;
    }
    ht_up_free(sysregdb->port);
    free(sysregdb);
}

References free(), and rz_sysreg_db_t::port.

Referenced by rz_syscall_free(), and rz_sysreg_set_arch().

rz_sysregs_db_new()

RZ_API RzSysregsDB* rz_sysregs_db_new

(

)

Creates a new RzSysregDB type.

Definition at line 40 of file syscall.c.

                                        {
    RzSysregsDB *sysregdb = RZ_NEW0(RzSysregsDB);
    if (!sysregdb) {
        return NULL;
    }
    sysregdb->port = ht_up_new(NULL, free_port_kv, NULL);
    if (!sysregdb->port) {
        free(sysregdb);
        return NULL;
    }
    return sysregdb;
}

References free(), free_port_kv(), NULL, rz_sysreg_db_t::port, and RZ_NEW0.

Referenced by rz_syscall_new(), and rz_sysreg_set_arch().

sdb_load_by_path()

static bool sdb_load_by_path ( RZ_NONNULL RzSysregsDB *  sysregdb, const char *  path  )

static

Definition at line 184 of file syscall.c.

                                                                                 {
    Sdb *db = sdb_new(0, path, 0);
    bool result = sdb_load_sysregs(sysregdb, db);
    sdb_close(db);
    sdb_free(db);
    return result;
}

References path, sdb_close(), sdb_free(), sdb_load_sysregs(), and sdb_new().

Referenced by rz_sysreg_load_sdb().

sdb_load_sysregs()

static bool sdb_load_sysregs ( RzSysregsDB *  sysregdb, Sdb *  sdb  )

static

Definition at line 148 of file syscall.c.

                                                              {
    rz_return_val_if_fail(sysregdb && sdb, false);
    RzSysregItem *sysregitem;
    SdbKv *kv;
    SdbListIter *iter;
    SdbList *l = sdb_foreach_list(sdb, false);
    char *argument_key, *comment, *name;
    ls_foreach (l, iter, kv) {
        if (!strcmp(sdbkv_value(kv), "mmio") || !strcmp(sdbkv_value(kv), "reg")) {
            name = sdbkv_key(kv);
            sysregitem = rz_sysreg_item_new(name);
            argument_key = rz_str_newf("%s.address", name);
            if (!argument_key) {
                rz_sysreg_item_free(sysregitem);
                return false;
            }
            ut64 address = sdb_num_get(sdb, argument_key, NULL);
            free(argument_key);
            if (!address) {
                rz_sysreg_item_free(sysregitem);
                return false;
            }
 
            argument_key = rz_str_newf("%s.comment", name);
            comment = sdb_get(sdb, argument_key, NULL);
            free(argument_key);
            sysregitem->type = strdup(sdbkv_value(kv));
            sysregitem->comment = comment;
 
            ht_up_insert(sysregdb->port, address, sysregitem);
        }
    }
    ls_free(l);
    return true;
}

References rz_sysreg_item_t::comment, free(), ls_foreach, ls_free(), name, NULL, rz_sysreg_db_t::port, rz_return_val_if_fail, rz_str_newf(), rz_sysreg_item_free(), rz_sysreg_item_new(), sdb_foreach_list(), sdb_get(), sdb_num_get(), sdbkv_key(), sdbkv_value(), strdup(), rz_sysreg_item_t::type, and ut64().

Referenced by sdb_load_by_path().

syscall_reload_needed()

static bool syscall_reload_needed ( RzSyscall *  s, const char *  os, const char *  arch, int  bits  )

inlinestatic

Definition at line 128 of file syscall.c.

                                                                                                   {
    if (!s->os || strcmp(s->os, os)) {
        return true;
    }
    if (!s->arch || strcmp(s->arch, arch)) {
        return true;
    }
    return s->bits != bits;
}

References arch, bits(), and s.

Referenced by rz_syscall_setup().

sysregs_reload_needed()

static bool sysregs_reload_needed ( RzSyscall *  s, const char *  arch, int  bits, const char *  cpu  )

inlinestatic

Definition at line 138 of file syscall.c.

                                                                                                    {
    if (!s->arch || strcmp(s->arch, arch)) {
        return true;
    }
    if (s->bits != bits) {
        return true;
    }
    return !s->cpu || strcmp(s->cpu, cpu);
}

References arch, bits(), cpu, and s.

Referenced by rz_syscall_setup().