rz_project.h File Reference

#include <rz_util/rz_serialize.h>
#include <rz_core.h>
#include <sdb.h>

Go to the source code of this file.

Macros
#define	RZ_PROJECT_VERSION   8

Typedefs
typedef Sdb	RzProject
typedef enum rz_project_err	RzProjectErr

Enumerations
enum	rz_project_err {   RZ_PROJECT_ERR_SUCCESS , RZ_PROJECT_ERR_FILE , RZ_PROJECT_ERR_INVALID_TYPE , RZ_PROJECT_ERR_INVALID_VERSION ,   RZ_PROJECT_ERR_NEWER_VERSION , RZ_PROJECT_ERR_INVALID_CONTENTS , RZ_PROJECT_ERR_MIGRATION_FAILED , RZ_PROJECT_ERR_COMPRESSION_FAILED ,   RZ_PROJECT_ERR_UNKNOWN }

Functions
RZ_API RZ_NONNULL const char *	rz_project_err_message (RzProjectErr err)
RZ_API RzProjectErr	rz_project_save (RzCore *core, RzProject *prj, const char *file)
RZ_API RzProjectErr	rz_project_save_file (RzCore *core, const char *file, bool compress)
RZ_API RzProject *	rz_project_load_file_raw (const char *file)
	Load a file into an RzProject but don't actually migrate anything or load it into an RzCore. More...
RZ_API void	rz_project_free (RzProject *prj)
RZ_API RzProjectErr	rz_project_load (RzCore *core, RzProject *prj, bool load_bin_io, RZ_NULLABLE const char *file, RzSerializeResultInfo *res)
RZ_API RzProjectErr	rz_project_load_file (RzCore *core, const char *file, bool load_bin_io, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v1_v2 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v2_v3 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v3_v4 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate (RzProject *prj, unsigned long version, RzSerializeResultInfo *res)
	Migrate the given project to the current version in-place. More...

Macro Definition Documentation

RZ_PROJECT_VERSION

#define RZ_PROJECT_VERSION   8

Definition at line 15 of file rz_project.h.

Typedef Documentation

RzProject

typedef Sdb RzProject

Definition at line 17 of file rz_project.h.

RzProjectErr

typedef enum rz_project_err RzProjectErr

Enumeration Type Documentation

rz_project_err

enum rz_project_err

Enumerator
RZ_PROJECT_ERR_SUCCESS
RZ_PROJECT_ERR_FILE
RZ_PROJECT_ERR_INVALID_TYPE
RZ_PROJECT_ERR_INVALID_VERSION
RZ_PROJECT_ERR_NEWER_VERSION
RZ_PROJECT_ERR_INVALID_CONTENTS
RZ_PROJECT_ERR_MIGRATION_FAILED
RZ_PROJECT_ERR_COMPRESSION_FAILED
RZ_PROJECT_ERR_UNKNOWN

Definition at line 19 of file rz_project.h.

                            {
    RZ_PROJECT_ERR_SUCCESS,
    RZ_PROJECT_ERR_FILE,
    RZ_PROJECT_ERR_INVALID_TYPE,
    RZ_PROJECT_ERR_INVALID_VERSION,
    RZ_PROJECT_ERR_NEWER_VERSION,
    RZ_PROJECT_ERR_INVALID_CONTENTS,
    RZ_PROJECT_ERR_MIGRATION_FAILED,
    RZ_PROJECT_ERR_COMPRESSION_FAILED,
    RZ_PROJECT_ERR_UNKNOWN
} RzProjectErr;

Function Documentation

rz_project_err_message()

RZ_API RZ_NONNULL const char* rz_project_err_message

(

RzProjectErr

err

)

Definition at line 11 of file project.c.

                                                                       {
    switch (err) {
    case RZ_PROJECT_ERR_SUCCESS:
        return "success";
    case RZ_PROJECT_ERR_FILE:
        return "file access error";
    case RZ_PROJECT_ERR_INVALID_TYPE:
        return "invalid file type";
    case RZ_PROJECT_ERR_INVALID_VERSION:
        return "invalid project version";
    case RZ_PROJECT_ERR_NEWER_VERSION:
        return "newer project version";
    case RZ_PROJECT_ERR_INVALID_CONTENTS:
        return "invalid content encountered";
    case RZ_PROJECT_ERR_MIGRATION_FAILED:
        return "migration failed";
    case RZ_PROJECT_ERR_COMPRESSION_FAILED:
        return "project file compression failed";
    case RZ_PROJECT_ERR_UNKNOWN:
        break;
    }
    return "unknown error";
}

References err, RZ_PROJECT_ERR_COMPRESSION_FAILED, RZ_PROJECT_ERR_FILE, RZ_PROJECT_ERR_INVALID_CONTENTS, RZ_PROJECT_ERR_INVALID_TYPE, RZ_PROJECT_ERR_INVALID_VERSION, RZ_PROJECT_ERR_MIGRATION_FAILED, RZ_PROJECT_ERR_NEWER_VERSION, RZ_PROJECT_ERR_SUCCESS, and RZ_PROJECT_ERR_UNKNOWN.

Referenced by rz_core_project_load_for_cli(), rz_main_rizin(), and rz_project_save_handler().

rz_project_free()

RZ_API void rz_project_free

(

RzProject *

prj

)

Definition at line 129 of file project.c.

                                            {
    sdb_free(prj);
}

References sdb_free().

rz_project_load()

RZ_API RzProjectErr rz_project_load	(	RzCore *	core,
		RzProject *	prj,
		bool	load_bin_io,
		RZ_NULLABLE const char *	file,
		RzSerializeResultInfo *	res
	)

Parameters

load_bin_io	whether to also load the underlying RIO and RBin state from the project. If false, the current state will be kept and the project loaded on top.
file	filename of the project that db comes from. This is only used to re-locate the loaded RIO descs, the project file itself is not touched by this function.

Definition at line 133 of file project.c.

                                                                                                                                              {
    rz_return_val_if_fail(core && prj, RZ_PROJECT_ERR_UNKNOWN);
    const char *type = sdb_const_get(prj, RZ_PROJECT_KEY_TYPE, 0);
    if (!type || strcmp(type, RZ_PROJECT_TYPE) != 0) {
        return RZ_PROJECT_ERR_INVALID_TYPE;
    }
    const char *version_str = sdb_const_get(prj, RZ_PROJECT_KEY_VERSION, 0);
    if (!version_str) {
        return RZ_PROJECT_ERR_INVALID_VERSION;
    }
    unsigned long version = strtoul(version_str, NULL, 0);
    if (!version || version == ULONG_MAX) {
        return RZ_PROJECT_ERR_INVALID_VERSION;
    }
    if (version > RZ_PROJECT_VERSION) {
        return RZ_PROJECT_ERR_NEWER_VERSION;
    }
    if (!rz_project_migrate(prj, version, res)) {
        return RZ_PROJECT_ERR_MIGRATION_FAILED;
    }
 
    Sdb *core_db = sdb_ns(prj, "core", false);
    if (!core_db) {
        RZ_SERIALIZE_ERR(res, "missing core namespace");
        return RZ_PROJECT_ERR_INVALID_CONTENTS;
    }
    if (!rz_serialize_core_load(core_db, core, load_bin_io, file, res)) {
        return RZ_PROJECT_ERR_INVALID_CONTENTS;
    }
 
    rz_config_set(core->config, "prj.file", file);
 
    return RZ_PROJECT_ERR_SUCCESS;
}

References rz_core_t::config, NULL, rz_config_set(), RZ_PROJECT_ERR_INVALID_CONTENTS, RZ_PROJECT_ERR_INVALID_TYPE, RZ_PROJECT_ERR_INVALID_VERSION, RZ_PROJECT_ERR_MIGRATION_FAILED, RZ_PROJECT_ERR_NEWER_VERSION, RZ_PROJECT_ERR_SUCCESS, RZ_PROJECT_ERR_UNKNOWN, RZ_PROJECT_KEY_TYPE, RZ_PROJECT_KEY_VERSION, rz_project_migrate(), RZ_PROJECT_TYPE, RZ_PROJECT_VERSION, rz_return_val_if_fail, rz_serialize_core_load(), RZ_SERIALIZE_ERR, sdb_const_get(), sdb_ns(), and type.

Referenced by rz_project_load_file().

rz_project_load_file()

RZ_API RzProjectErr rz_project_load_file	(	RzCore *	core,
		const char *	file,
		bool	load_bin_io,
		RzSerializeResultInfo *	res
	)

Parameters

load_bin_io	whether to also load the underlying RIO and RBin state from the project. If false, the current state will be kept and the project loaded on top.
file	filename of the project to load from

Definition at line 168 of file project.c.

                                                                                                                       {
    RzProject *prj = rz_project_load_file_raw(file);
    if (!prj) {
        RZ_SERIALIZE_ERR(res, "failed to read database file");
        return RZ_PROJECT_ERR_FILE;
    }
    RzProjectErr ret = rz_project_load(core, prj, load_bin_io, file, res);
    sdb_free(prj);
    return ret;
}

References RZ_PROJECT_ERR_FILE, rz_project_load(), rz_project_load_file_raw(), RZ_SERIALIZE_ERR, and sdb_free().

Referenced by rz_core_project_load_for_cli().

rz_project_load_file_raw()

RZ_API RzProject* rz_project_load_file_raw

(

const char *

file

)

Load a file into an RzProject but don't actually migrate anything or load it into an RzCore.

Definition at line 88 of file project.c.

                                                             {
    RzProject *prj = sdb_new0();
    if (!prj) {
        return NULL;
    }
 
    char *tmp_file;
    int mkstemp_fd = rz_file_mkstemp("ldprj", &tmp_file);
    close(mkstemp_fd);
 
    if (mkstemp_fd == -1 || !tmp_file) {
        free(tmp_file);
        return NULL;
    }
 
    const char *load_file = tmp_file;
 
    if (!rz_file_exists(file)) {
        prj = NULL;
        goto return_goto;
    }
    if (rz_file_is_deflated(file)) {
        if (!rz_file_inflate(file, tmp_file)) {
            prj = NULL;
            goto return_goto;
        }
    } else {
        load_file = file;
    }
 
    if (!sdb_text_load(prj, load_file)) {
        sdb_free(prj);
        prj = NULL;
    }
 
return_goto:
    rz_file_rm(tmp_file);
    free(tmp_file);
    return prj;
}

References close, file, free(), NULL, rz_file_exists(), rz_file_inflate(), rz_file_is_deflated(), rz_file_mkstemp(), rz_file_rm(), sdb_free(), sdb_new0(), and sdb_text_load().

Referenced by rz_project_load_file().

rz_project_migrate()

RZ_API bool rz_project_migrate	(	RzProject *	prj,
		unsigned long	version,
		RzSerializeResultInfo *	res
	)

Migrate the given project to the current version in-place.

Definition at line 318 of file project_migrate.c.

                                                                                                  {
    RZ_STATIC_ASSERT(RZ_ARRAY_SIZE(migrations) + 1 == RZ_PROJECT_VERSION);
    while (version < RZ_PROJECT_VERSION) {
        bool succ = migrations[version - 1](prj, res);
        if (!succ) {
            rz_list_push(res, rz_str_newf("project migration from version %lu to %lu failed.", version, version + 1));
            return false;
        }
        rz_list_push(res, rz_str_newf("project migrated from version %lu to %lu.", version, version + 1));
        version++;
    }
    return true;
}

References migrations, RZ_ARRAY_SIZE, rz_list_push(), RZ_PROJECT_VERSION, RZ_STATIC_ASSERT, and rz_str_newf().

Referenced by rz_project_load().

rz_project_migrate_v1_v2()

RZ_API bool rz_project_migrate_v1_v2	(	RzProject *	prj,
		RzSerializeResultInfo *	res
	)

Definition at line 53 of file project_migrate.c.

                                                                                 {
    Sdb *core_db;
    RZ_SERIALIZE_SUB(prj, core_db, res, "core", return false;);
    Sdb *analysis_db;
    RZ_SERIALIZE_SUB(core_db, analysis_db, res, "analysis", return false;);
    Sdb *types_db;
    RZ_SERIALIZE_SUB(analysis_db, types_db, res, "types", return false;);
    V1V2TypesCtx ctx = {
        .moved_keys = rz_list_newf(free),
        .noreturn_db = sdb_ns(analysis_db, "noreturn", true)
    };
    if (!ctx.moved_keys || !ctx.noreturn_db) {
        return false;
    }
    sdb_foreach(types_db, v1_v2_types_foreach_cb, &ctx);
    RzListIter *it;
    char *s;
    rz_list_foreach (ctx.moved_keys, it, s) {
        sdb_unset(types_db, s, 0);
    }
    rz_list_free(ctx.moved_keys);
    return true;
}

References free(), rz_list_free(), rz_list_newf(), RZ_SERIALIZE_SUB, s, sdb_foreach(), sdb_ns(), sdb_unset(), and v1_v2_types_foreach_cb().

rz_project_migrate_v2_v3()

RZ_API bool rz_project_migrate_v2_v3	(	RzProject *	prj,
		RzSerializeResultInfo *	res
	)

Definition at line 110 of file project_migrate.c.

                                                                                 {
    Sdb *core_db;
    RZ_SERIALIZE_SUB(prj, core_db, res, "core", return false;);
    Sdb *analysis_db;
    RZ_SERIALIZE_SUB(core_db, analysis_db, res, "analysis", return false;);
    Sdb *types_db;
    RZ_SERIALIZE_SUB(analysis_db, types_db, res, "types", return false;);
    V2V3TypesCtx ctx = {
        .moved_keys = rz_list_newf(free),
        .callables_db = sdb_ns(analysis_db, "callables", true),
        .typelinks_db = sdb_ns(analysis_db, "typelinks", true)
    };
    if (!ctx.moved_keys || !ctx.callables_db || !ctx.typelinks_db) {
        return false;
    }
    sdb_foreach(types_db, v2_v3_types_foreach_cb, &ctx);
    RzListIter *it;
    char *s;
    rz_list_foreach (ctx.moved_keys, it, s) {
        sdb_unset(types_db, s, 0);
    }
    rz_list_free(ctx.moved_keys);
    return true;
}

References free(), rz_list_free(), rz_list_newf(), RZ_SERIALIZE_SUB, s, sdb_foreach(), sdb_ns(), sdb_unset(), and v2_v3_types_foreach_cb().

rz_project_migrate_v3_v4()

RZ_API bool rz_project_migrate_v3_v4	(	RzProject *	prj,
		RzSerializeResultInfo *	res
	)

Definition at line 166 of file project_migrate.c.

                                                                                 {
    Sdb *core_db;
    RZ_SERIALIZE_SUB(prj, core_db, res, "core", return false;);
    Sdb *analysis_db;
    RZ_SERIALIZE_SUB(core_db, analysis_db, res, "analysis", return false;);
    // Kill me in the future
    sdb_ns(analysis_db, "vars", true);
#if 0
    V3V4TypesCtx ctx = {
        .moved_keys = rz_list_newf(free),
        .global_vars_db = sdb_ns(analysis_db, "vars", true)
    };
 
    if (!ctx.moved_keys || !ctx.global_vars_db) {
        return false;
    }
    Sdb *typelinks_db = sdb_ns(analysis_db, "typelinks", true);
    sdb_foreach(typelinks_db, v3_v4_types_foreach_cb, &ctx);
    RzListIter *it;
    char *s;
    rz_list_foreach (ctx.moved_keys, it, s) {
        sdb_unset(typelinks_db, s, 0);
    }
    rz_list_free(ctx.moved_keys);
#endif
    return true;
}

References free(), rz_list_free(), rz_list_newf(), RZ_SERIALIZE_SUB, s, sdb_foreach(), sdb_ns(), and sdb_unset().

rz_project_save()

RZ_API RzProjectErr rz_project_save	(	RzCore *	core,
		RzProject *	prj,
		const char *	file
	)

Definition at line 35 of file project.c.

                                                                                    {
    sdb_set(prj, RZ_PROJECT_KEY_TYPE, RZ_PROJECT_TYPE, 0);
    sdb_set(prj, RZ_PROJECT_KEY_VERSION, sdb_fmt("%u", RZ_PROJECT_VERSION), 0);
    rz_serialize_core_save(sdb_ns(prj, "core", true), core, file);
    return RZ_PROJECT_ERR_SUCCESS;
}

References RZ_PROJECT_ERR_SUCCESS, RZ_PROJECT_KEY_TYPE, RZ_PROJECT_KEY_VERSION, RZ_PROJECT_TYPE, RZ_PROJECT_VERSION, rz_serialize_core_save(), sdb_fmt(), sdb_ns(), and sdb_set().

Referenced by rz_project_save_file().

rz_project_save_file()

RZ_API RzProjectErr rz_project_save_file	(	RzCore *	core,
		const char *	file,
		bool	compress
	)

Definition at line 42 of file project.c.

                                                                                        {
    char *tmp_file = NULL;
 
    if (compress) {
        int mkstemp_fd = rz_file_mkstemp("svprj", &tmp_file);
        if (mkstemp_fd == -1 || !tmp_file) {
            return RZ_PROJECT_ERR_FILE;
        }
        close(mkstemp_fd);
    }
 
    RzProjectErr err;
    const char *save_file = compress ? tmp_file : file;
    RzProject *prj = sdb_new0();
    if (!prj) {
        err = RZ_PROJECT_ERR_UNKNOWN;
        goto tmp_file_err;
    }
    err = rz_project_save(core, prj, file);
    if (err != RZ_PROJECT_ERR_SUCCESS) {
        sdb_free(prj);
        return err;
    }
    if (!sdb_text_save(prj, save_file, true)) {
        err = RZ_PROJECT_ERR_FILE;
    }
    sdb_free(prj);
 
    if (err != RZ_PROJECT_ERR_SUCCESS) {
        goto tmp_file_err;
    }
 
    if (compress && !rz_file_deflate(tmp_file, file)) {
        err = RZ_PROJECT_ERR_COMPRESSION_FAILED;
        goto tmp_file_err;
    }
 
    rz_config_set(core->config, "prj.file", file);
 
tmp_file_err:
    rz_file_rm(tmp_file);
    free(tmp_file);
    return err;
}

References close, compress(), rz_core_t::config, err, file, free(), NULL, rz_config_set(), rz_file_deflate(), rz_file_mkstemp(), rz_file_rm(), RZ_PROJECT_ERR_COMPRESSION_FAILED, RZ_PROJECT_ERR_FILE, RZ_PROJECT_ERR_SUCCESS, RZ_PROJECT_ERR_UNKNOWN, rz_project_save(), sdb_free(), sdb_new0(), and sdb_text_save().

Referenced by rz_main_rizin(), and rz_project_save_handler().