rz_spaces.h File Reference

#include "rz_util.h"
#include "rz_serialize.h"
#include <sdb.h>

Go to the source code of this file.

Classes
struct	rz_space_t
struct	rz_space_event_t
struct	rz_spaces_t

Macros
#define	RZ_SPACES_MAX   512
#define	rz_spaces_foreach(sp, it, s)    rz_rbtree_foreach ((sp)->spaces, (it), (s), RzSpace, rb)

Typedefs
typedef struct rz_space_t	RzSpace
typedef struct rz_space_event_t	RzSpaceEvent
typedef struct rz_spaces_t	RzSpaces
typedef RBIter	RzSpaceIter

Enumerations
enum	RzSpaceEventType { RZ_SPACE_EVENT_COUNT = 1 , RZ_SPACE_EVENT_RENAME , RZ_SPACE_EVENT_UNSET }

Functions
RZ_API RzSpaces *	rz_spaces_new (const char *name)
RZ_API bool	rz_spaces_init (RzSpaces *sp, const char *name)
RZ_API void	rz_spaces_fini (RzSpaces *sp)
RZ_API void	rz_spaces_free (RzSpaces *sp)
RZ_API void	rz_spaces_purge (RzSpaces *sp)
RZ_API RzSpace *	rz_spaces_get (RzSpaces *sp, const char *name)
RZ_API RzSpace *	rz_spaces_add (RzSpaces *sp, const char *name)
RZ_API RzSpace *	rz_spaces_set (RzSpaces *sp, const char *name)
RZ_API bool	rz_spaces_unset (RzSpaces *sp, const char *name)
RZ_API bool	rz_spaces_rename (RzSpaces *sp, const char *oname, const char *nname)
RZ_API int	rz_spaces_count (RzSpaces *sp, const char *name)
RZ_API bool	rz_spaces_push (RzSpaces *sp, const char *name)
RZ_API bool	rz_spaces_pop (RzSpaces *sp)
static RzSpace *	rz_spaces_current (RzSpaces *sp)
static const char *	rz_spaces_current_name (RzSpaces *sp)
static bool	rz_spaces_is_empty (RzSpaces *sp)
RZ_API void	rz_serialize_spaces_save (RZ_NONNULL Sdb *db, RZ_NONNULL RzSpaces *spaces)
RZ_API bool	rz_serialize_spaces_load (RZ_NONNULL Sdb *db, RZ_NONNULL RzSpaces *spaces, bool load_name, RZ_NULLABLE RzSerializeResultInfo *res)

Macro Definition Documentation

rz_spaces_foreach

#define rz_spaces_foreach	(		sp,
			it,
			s
	)		rz_rbtree_foreach ((sp)->spaces, (it), (s), RzSpace, rb)

Definition at line 105 of file rz_spaces.h.

RZ_SPACES_MAX

#define RZ_SPACES_MAX   512

Definition at line 4 of file rz_spaces.h.

Typedef Documentation

RzSpace

typedef struct rz_space_t RzSpace

RzSpaceEvent

typedef struct rz_space_event_t RzSpaceEvent

RzSpaceIter

typedef RBIter RzSpaceIter

Definition at line 104 of file rz_spaces.h.

RzSpaces

typedef struct rz_spaces_t RzSpaces

Enumeration Type Documentation

RzSpaceEventType

enum RzSpaceEventType

Enumerator
RZ_SPACE_EVENT_COUNT
RZ_SPACE_EVENT_RENAME
RZ_SPACE_EVENT_UNSET

Definition at line 33 of file rz_spaces.h.

             {
    RZ_SPACE_EVENT_COUNT = 1,
    RZ_SPACE_EVENT_RENAME,
    RZ_SPACE_EVENT_UNSET,
} RzSpaceEventType;

Function Documentation

rz_serialize_spaces_load()

RZ_API bool rz_serialize_spaces_load	(	RZ_NONNULL Sdb *	db,
		RZ_NONNULL RzSpaces *	spaces,
		bool	load_name,
		RZ_NULLABLE RzSerializeResultInfo *	res
	)

Parameters

load_name

whether to overwrite the name in spaces with the value from db

Definition at line 54 of file serialize_spaces.c.

                                                                                                                                              {
    if (load_name) {
        char *old_name = (char *)spaces->name;
        spaces->name = sdb_get(db, KEY_NAME, NULL);
        if (!spaces->name) {
            spaces->name = old_name;
            RZ_SERIALIZE_ERR(res, "failed to get spaces name from db");
            return false;
        }
        free(old_name);
    }
 
    rz_spaces_purge(spaces);
 
    Sdb *db_spaces = sdb_ns(db, KEY_SPACES, false);
    if (!db_spaces) {
        RZ_SERIALIZE_ERR(res, "failed to get spaces sub-namespace");
        return false;
    }
    sdb_foreach(db_spaces, foreach_space_cb, spaces);
 
    char *stack_json_str = sdb_get(db, KEY_SPACESTACK, NULL);
    if (!stack_json_str) {
        RZ_SERIALIZE_ERR(res, "spacestack is missing");
        return false;
    }
 
    bool ret = true;
    RzJson *stack_json = rz_json_parse(stack_json_str);
    if (!stack_json) {
        RZ_SERIALIZE_ERR(res, "failed to parse stackspace json");
        ret = false;
        goto beach;
    }
    if (stack_json->type != RZ_JSON_ARRAY) {
        RZ_SERIALIZE_ERR(res, "stackspace json is not an array");
        ret = false;
        goto beach;
    }
    RzJson *stack_element;
    for (stack_element = stack_json->children.first; stack_element; stack_element = stack_element->next) {
        if (stack_element->type != RZ_JSON_STRING) {
            RZ_SERIALIZE_ERR(res, "stackspace element is not a string");
            ret = false;
            goto beach;
        }
        RzSpace *space = rz_spaces_get(spaces, stack_element->str_value);
        rz_list_append(spaces->spacestack, space ? space->name : "*");
    }
 
    rz_spaces_pop(spaces); // current is the top stack element, pop it
 
beach:
    rz_json_free(stack_json);
    free(stack_json_str);
    return ret;
}

References rz_json_t::children, foreach_space_cb(), free(), KEY_NAME, KEY_SPACES, KEY_SPACESTACK, rz_space_t::name, rz_json_t::next, NULL, RZ_JSON_ARRAY, rz_json_free(), rz_json_parse(), RZ_JSON_STRING, rz_list_append(), RZ_SERIALIZE_ERR, rz_spaces_get(), rz_spaces_pop(), rz_spaces_purge(), sdb_foreach(), sdb_get(), sdb_ns(), spaces(), rz_json_t::str_value, and rz_json_t::type.

Referenced by rz_serialize_analysis_meta_load(), and rz_serialize_flag_load().

rz_serialize_spaces_save()

RZ_API void rz_serialize_spaces_save	(	RZ_NONNULL Sdb *	db,
		RZ_NONNULL RzSpaces *	spaces
	)

Definition at line 22 of file serialize_spaces.c.

                                                                                      {
    sdb_set(db, KEY_NAME, spaces->name, 0);
 
    PJ *j = pj_new();
    if (!j) {
        return;
    }
    pj_a(j);
    RzListIter *iter;
    char *spacename;
    rz_list_foreach (spaces->spacestack, iter, spacename) {
        pj_s(j, spacename);
    }
    pj_s(j, spaces->current ? spaces->current->name : "*"); // push current manually, will be popped on load
    pj_end(j);
    sdb_set(db, KEY_SPACESTACK, pj_string(j), 0);
    pj_free(j);
 
    Sdb *db_spaces = sdb_ns(db, KEY_SPACES, true);
    RBIter rbiter;
    RzSpace *space;
    rz_rbtree_foreach (spaces->spaces, rbiter, space, RzSpace, rb) {
        sdb_set(db_spaces, space->name, "s", 0);
    }
}

References KEY_NAME, KEY_SPACES, KEY_SPACESTACK, rz_space_t::name, pj_a(), pj_end(), pj_free(), pj_new(), pj_s(), pj_string(), rz_rbtree_foreach, sdb_ns(), sdb_set(), and spaces().

Referenced by rz_serialize_analysis_meta_save(), and rz_serialize_flag_save().

rz_spaces_add()

RZ_API RzSpace* rz_spaces_add	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 96 of file spaces.c.

                                                              {
    rz_return_val_if_fail(sp, NULL);
    if (!name || !*name || *name == '*') {
        return NULL;
    }
 
    RzSpace *s = rz_spaces_get(sp, name);
    if (s) {
        return s;
    }
 
    s = RZ_NEW0(RzSpace);
    if (!s) {
        return NULL;
    }
 
    s->name = strdup(name);
    if (!s->name) {
        free(s);
        return NULL;
    }
 
    rz_rbtree_insert(&sp->spaces, s, &s->rb, space_cmp, NULL);
    return s;
}

References free(), NULL, RZ_NEW0, rz_rbtree_insert(), rz_return_val_if_fail, rz_spaces_get(), s, sp, space_cmp(), and strdup().

Referenced by foreach_space_cb(), rz_meta_space_handler(), and rz_spaces_set().

rz_spaces_count()

RZ_API int rz_spaces_count	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 167 of file spaces.c.

                                                           {
    RzSpace *s = rz_spaces_get(sp, name);
    if (!s) {
        return 0;
    }
    RzSpaceEvent ev = { .data.count.space = s, .res = 0 };
    rz_event_send(sp->event, RZ_SPACE_EVENT_COUNT, &ev);
    return ev.res;
}

References rz_space_event_t::count, rz_space_event_t::data, rz_space_event_t::res, rz_event_send(), RZ_SPACE_EVENT_COUNT, rz_spaces_get(), s, and sp.

Referenced by rz_core_spaces_print().

rz_spaces_current()

static RzSpace* rz_spaces_current ( RzSpaces *  sp )

inlinestatic

Definition at line 91 of file rz_spaces.h.

                                                       {
    return sp->current;
}

References sp.

Referenced by meta_set(), rz_core_meta_print(), rz_core_meta_print_list_at(), rz_core_spaces_print(), rz_meta_del(), rz_meta_get_all_at(), rz_meta_get_all_in(), rz_meta_get_all_intersect(), rz_meta_get_at(), rz_meta_get_in(), and rz_meta_get_string().

rz_spaces_current_name()

static const char* rz_spaces_current_name ( RzSpaces *  sp )

inlinestatic

Definition at line 95 of file rz_spaces.h.

                                                               {
    return sp->current ? sp->current->name : "*";
}

References sp.

Referenced by rz_core_spaces_print().

rz_spaces_fini()

RZ_API void rz_spaces_fini

(

RzSpaces *

sp

)

Definition at line 59 of file spaces.c.

                                         {
    rz_list_free(sp->spacestack);
    sp->spacestack = NULL;
    rz_rbtree_free(sp->spaces, space_node_free, NULL);
    sp->spaces = NULL;
    rz_event_free(sp->event);
    sp->event = NULL;
    sp->current = NULL;
    RZ_FREE(sp->name);
}

References NULL, rz_event_free(), RZ_FREE, rz_list_free(), rz_rbtree_free(), sp, and space_node_free().

Referenced by rz_analysis_free(), rz_flag_free(), rz_flag_unset_all(), rz_spaces_free(), and rz_spaces_init().

rz_spaces_free()

RZ_API void rz_spaces_free

(

RzSpaces *

sp

)

Definition at line 42 of file spaces.c.

                                         {
    rz_spaces_fini(sp);
    free(sp);
}

References free(), rz_spaces_fini(), and sp.

rz_spaces_get()

RZ_API RzSpace* rz_spaces_get	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 82 of file spaces.c.

                                                              {
    if (!name) {
        return NULL;
    }
    RBNode *n = rz_rbtree_find(sp->spaces, (void *)name, name_space_cmp, NULL);
    return n ? container_of(n, RzSpace, rb) : NULL;
}

References container_of, n, name_space_cmp(), NULL, rz_rbtree_find(), and sp.

Referenced by meta_load_cb(), rz_core_reg_set_by_role_or_name(), rz_serialize_spaces_load(), rz_spaces_add(), rz_spaces_count(), rz_spaces_pop(), rz_spaces_rename(), and spaces_unset_single().

rz_spaces_init()

RZ_API bool rz_spaces_init	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 16 of file spaces.c.

                                                           {
    rz_return_val_if_fail(sp && name, false);
    sp->name = strdup(name);
    if (!sp->name) {
        goto fail;
    }
 
    sp->spaces = NULL;
    sp->current = NULL;
    sp->spacestack = rz_list_new();
    if (!sp->spacestack) {
        goto fail;
    }
 
    sp->event = rz_event_new(sp);
    if (!sp->event) {
        goto fail;
    }
 
    return true;
 
fail:
    rz_spaces_fini(sp);
    return false;
}

References fail, NULL, rz_event_new(), rz_list_new(), rz_return_val_if_fail, rz_spaces_fini(), sp, and strdup().

Referenced by new_spaces(), rz_analysis_new(), and rz_spaces_new().

rz_spaces_is_empty()

static bool rz_spaces_is_empty ( RzSpaces *  sp )

inlinestatic

Definition at line 99 of file rz_spaces.h.

                                                    {
    RBIter it = rz_rbtree_first(sp->spaces);
    return it.len == 0;
}

References rz_rb_iter_t::len, rz_rbtree_first(), and sp.

rz_spaces_new()

RZ_API RzSpaces* rz_spaces_new

(

const char *

name

)

Definition at line 7 of file spaces.c.

                                                 {
    RzSpaces *sp = RZ_NEW0(RzSpaces);
    if (!sp || !rz_spaces_init(sp, name)) {
        free(sp);
        return NULL;
    }
    return sp;
}

References free(), NULL, RZ_NEW0, rz_spaces_init(), and sp.

rz_spaces_pop()

RZ_API bool rz_spaces_pop

(

RzSpaces *

sp

)

Definition at line 185 of file spaces.c.

                                        {
    char *name = rz_list_pop(sp->spacestack);
    if (!name) {
        return false;
    }
 
    RzSpace *s = rz_spaces_get(sp, name);
    rz_spaces_set(sp, s ? s->name : NULL);
    return true;
}

References NULL, rz_list_pop(), rz_spaces_get(), rz_spaces_set(), s, and sp.

Referenced by rz_core_bin_apply_symbols(), and rz_serialize_spaces_load().

rz_spaces_purge()

RZ_API void rz_spaces_purge

(

RzSpaces *

sp

)

Definition at line 70 of file spaces.c.

                                          {
    sp->current = NULL;
    rz_list_purge(sp->spacestack);
    rz_rbtree_free(sp->spaces, space_node_free, NULL);
    sp->spaces = NULL;
}

References NULL, rz_list_purge(), rz_rbtree_free(), sp, and space_node_free().

Referenced by rz_serialize_spaces_load().

rz_spaces_push()

RZ_API bool rz_spaces_push	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 177 of file spaces.c.

                                                           {
    rz_return_val_if_fail(sp, false);
 
    rz_list_push(sp->spacestack, sp->current ? sp->current->name : "*");
    rz_spaces_set(sp, name);
    return true;
}

References rz_list_push(), rz_return_val_if_fail, rz_spaces_set(), and sp.

Referenced by rz_core_bin_apply_symbols().

rz_spaces_rename()

RZ_API bool rz_spaces_rename	(	RzSpaces *	sp,
		const char *	oname,
		const char *	nname
	)

Definition at line 196 of file spaces.c.

                                                                                 {
    if (!oname && !sp->current) {
        return false;
    }
 
    RzSpace *s;
    if (oname) {
        s = rz_spaces_get(sp, oname);
        if (!s) {
            return false;
        }
    } else {
        s = sp->current;
    }
 
    RzSpace *sn = rz_spaces_get(sp, nname);
    if (sn) {
        return false;
    }
 
    RzSpaceEvent ev = {
        .data.rename.oldname = s->name,
        .data.rename.newname = nname,
        .data.rename.space = s
    };
    rz_event_send(sp->event, RZ_SPACE_EVENT_RENAME, &ev);
 
    rz_rbtree_delete(&sp->spaces, (void *)s->name, name_space_cmp, NULL, NULL, NULL);
    free(s->name);
    s->name = strdup(nname);
    rz_rbtree_insert(&sp->spaces, s, &s->rb, space_cmp, NULL);
 
    return true;
}

References rz_space_event_t::data, free(), name_space_cmp(), NULL, rz_space_event_t::rename, rz_event_send(), rz_rbtree_delete(), rz_rbtree_insert(), RZ_SPACE_EVENT_RENAME, rz_spaces_get(), s, sp, space_cmp(), and strdup().

Referenced by rz_meta_space_rename_handler().

rz_spaces_set()

RZ_API RzSpace* rz_spaces_set	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 122 of file spaces.c.

                                                              {
    sp->current = rz_spaces_add(sp, name);
    return sp->current;
}

References rz_spaces_add(), and sp.

Referenced by rz_spaces_pop(), and rz_spaces_push().

rz_spaces_unset()

RZ_API bool rz_spaces_unset	(	RzSpaces *	sp,
		const char *	name
	)

Definition at line 141 of file spaces.c.

                                                            {
    if (name) {
        return spaces_unset_single(sp, name);
    }
 
    RzList *names = rz_list_newf((RzListFree)free);
    if (!names) {
        return false;
    }
 
    RBIter it;
    RzSpace *s;
    rz_spaces_foreach(sp, it, s) {
        rz_list_append(names, strdup(s->name));
    }
 
    RzListIter *lit;
    const char *n;
    bool res = false;
    rz_list_foreach (names, lit, n) {
        res |= spaces_unset_single(sp, n);
    }
    rz_list_free(names);
    return res;
}

References free(), n, rz_list_append(), rz_list_free(), rz_list_newf(), rz_spaces_foreach, s, sp, spaces_unset_single(), and strdup().

Referenced by rz_meta_space_remove_all_handler(), and rz_meta_space_remove_handler().