project_migrate.c File Reference

#include <rz_project.h>
#include <rz_util/rz_pj.h>

Go to the source code of this file.

Classes
struct	V1V2TypesCtx
struct	V2V3TypesCtx

Functions
bool	v1_v2_types_foreach_cb (void *user, const char *k, const char *v)
RZ_API bool	rz_project_migrate_v1_v2 (RzProject *prj, RzSerializeResultInfo *res)
bool	v2_v3_types_foreach_cb (void *user, const char *k, const char *v)
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_v4_v5 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v5_v6 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v6_v7 (RzProject *prj, RzSerializeResultInfo *res)
RZ_API bool	rz_project_migrate_v7_v8 (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...

Variables
static bool(*const	migrations [])(RzProject *prj, RzSerializeResultInfo *res)

Detailed Description

About Project Migrations: The project format is versioned, which means that a project saved with a certain version will always follow the exact same format. The current version is defined as RZ_PROJECT_VERSION and is completely independent of Rizin release versions. Do not confuse them! When any change in Rizin happens that changes the project format, this version must be raised and a migration must be implemented, which converts a given project from the previous version to the current and will be executed when loading an old project with new Rizin. These migrations always bring a project from version x to version x+1 and they may be executed sequentially if multiple versions are skipped. For example loading a project with version 1 in Rizin with version 3 will execute (1->2), then (2->3) and finally load the project just like any regular project of version 3.

After introducing format changes in Rizin, do the following:

• Raise RZ_PROJECT_VERSION by exactly 1.
• Implement a function like bool rz_project_migrate_migrate_v1_v2(RzProject *prj, RzSerializeResultInfo *res) which edits prj in-place and converts it from the previous to the current version.
• Append this function to the migrations array below.
• Implement tests in test/unit/test_project_migrate.c that cover all changes (see the documentation there).

Definition in file project_migrate.c.

Function Documentation

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_migrate_v4_v5()

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

Definition at line 201 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 *config_db;
    RZ_SERIALIZE_SUB(core_db, config_db, res, "config", return false;);
    Sdb *types_db;
    RZ_SERIALIZE_SUB(analysis_db, types_db, res, "types", return false;);
    // Common keys:
    // unknown_t=type
    // type.unknown_t.typeclass=Integral
    sdb_set(types_db, "unknown_t", "type", 0);
    sdb_set(types_db, "type.unknown_t.typeclass", "Integral", 0);
    // Now we read the bits value from "asm.bits=XX" in "/core/config"
    int bits = sdb_num_get(config_db, "asm.bits", 0);
    switch (bits) {
    case 16:
        // type.unknown_t=w
        // type.unknown_t.size=16
        sdb_set(types_db, "type.unknown_t", "w", 0);
        sdb_set(types_db, "type.unknown_t.size", "16", 0);
        break;
    case 64:
        // type.unknown_t=q
        // type.unknown_t.size=64
        sdb_set(types_db, "type.unknown_t", "q", 0);
        sdb_set(types_db, "type.unknown_t.size", "64", 0);
        break;
    case 32:
    default:
        // type.unknown_t=d
        // type.unknown_t.size=32
        sdb_set(types_db, "type.unknown_t", "d", 0);
        sdb_set(types_db, "type.unknown_t.size", "32", 0);
        break;
    }
    return true;
}

References bits(), RZ_SERIALIZE_SUB, sdb_num_get(), and sdb_set().

rz_project_migrate_v5_v6()

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

Definition at line 249 of file project_migrate.c.

                                                                                 {
    Sdb *core_db;
    RZ_SERIALIZE_SUB(prj, core_db, res, "core", return false;);
    Sdb *debug_db = sdb_ns(core_db, "debug", true);
    sdb_ns(debug_db, "breakpoints", true);
 
    return true;
}

References RZ_SERIALIZE_SUB, and sdb_ns().

rz_project_migrate_v6_v7()

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

Definition at line 264 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_ns_unset(analysis_db, "pins", NULL);
    return true;
}

References NULL, RZ_SERIALIZE_SUB, and sdb_ns_unset().

rz_project_migrate_v7_v8()

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

Definition at line 280 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_ns_unset(analysis_db, "zigns", NULL);
    Sdb *config_db;
    RZ_SERIALIZE_SUB(core_db, config_db, res, "config", return false;);
    sdb_unset(config_db, "zign.autoload", 0);
    sdb_unset(config_db, "zign.diff.bthresh", 0);
    sdb_unset(config_db, "zign.diff.gthresh", 0);
    sdb_unset(config_db, "zign.match.bytes", 0);
    sdb_unset(config_db, "zign.match.graph", 0);
    sdb_unset(config_db, "zign.match.hash", 0);
    sdb_unset(config_db, "zign.match.offset", 0);
    sdb_unset(config_db, "zign.match.refs", 0);
    sdb_unset(config_db, "zign.match.types", 0);
    sdb_unset(config_db, "zign.maxsz", 0);
    sdb_unset(config_db, "zign.mincc", 0);
    sdb_unset(config_db, "zign.minsz", 0);
    sdb_unset(config_db, "zign.prefix", 0);
    sdb_unset(config_db, "zign.threshold", 0);
    return true;
}

References NULL, RZ_SERIALIZE_SUB, sdb_ns_unset(), and sdb_unset().

v1_v2_types_foreach_cb()

bool v1_v2_types_foreach_cb	(	void *	user,
		const char *	k,
		const char *	v
	)

Definition at line 43 of file project_migrate.c.

                                                                      {
    if (!rz_str_startswith(k, "addr.") || !rz_str_endswith(k, ".noreturn")) {
        return true;
    }
    V1V2TypesCtx *ctx = user;
    sdb_set(ctx->noreturn_db, k, v, 0);
    rz_list_push(ctx->moved_keys, strdup(k));
    return true;
}

References k, rz_list_push(), rz_str_endswith(), rz_str_startswith(), sdb_set(), strdup(), and v.

Referenced by rz_project_migrate_v1_v2().

v2_v3_types_foreach_cb()

bool v2_v3_types_foreach_cb	(	void *	user,
		const char *	k,
		const char *	v
	)

Definition at line 94 of file project_migrate.c.

                                                                      {
    V2V3TypesCtx *ctx = user;
    if (rz_str_startswith(k, "func.") || !strcmp(v, "func")) {
        sdb_set(ctx->callables_db, k, v, 0);
        rz_list_push(ctx->moved_keys, strdup(k));
    } else if (rz_str_startswith(k, "link.")) {
        // Old addresses were stored as hexadecimal numbers without `0x` part
        // New addresses have them
        char *tl_key = rz_str_newf("0x%s", k + strlen("link."));
        sdb_set(ctx->typelinks_db, tl_key, v, 0);
        free(tl_key);
        rz_list_push(ctx->moved_keys, strdup(k));
    }
    return true;
}

References free(), k, rz_list_push(), rz_str_newf(), rz_str_startswith(), sdb_set(), strdup(), and v.

Referenced by rz_project_migrate_v2_v3().

Variable Documentation

migrations

bool(*const migrations[])(RzProject *prj, RzSerializeResultInfo *res) ( RzProject *  prj, RzSerializeResultInfo *  res  )

static

Initial value:

= {
    rz_project_migrate_v1_v2,
    rz_project_migrate_v2_v3,
    rz_project_migrate_v3_v4,
    rz_project_migrate_v4_v5,
    rz_project_migrate_v5_v6,
    rz_project_migrate_v6_v7,
    rz_project_migrate_v7_v8
}

Definition at line 307 of file project_migrate.c.

Referenced by rz_project_migrate().