core_plugin_example.c File Reference

#include <rz_types.h>
#include <rz_lib.h>
#include <rz_cmd.h>
#include <rz_core.h>

Go to the source code of this file.

Macros
#define	RZ_API   static
#define	RZ_IPI   static
#define	_RZ_API

Functions
RZ_IPI RzCmdStatus	rz_cmd_example_handler (RzCore *core, int argc, const char **argv)
static bool	rz_cmd_example_init (RzCore *core)
static bool	rz_cmd_example_fini (RzCore *core)

Variables
static const RzCmdDescArg	cmd_example_args []
static const RzCmdDescHelp	cmd_example_help
RzCorePlugin	rz_core_plugin_example
_RZ_API RzLibStruct	rizin_plugin

Detailed Description

This file is an example on how to write core plugins for rizin.

Compilation:

• gcc -o core_plugin_example.so -O3 -std=c99 -Wall -fPIC pkg-config --cflags --libs rz_core core_plugin_example.c -shared

Installation via the RZ_USER_PLUGINS folder:

• mkdir -p ~/.local/share/rizin/plugins/
• rizin -H | grep RZ_USER_PLUGINS
• RZ_USER_PLUGINS=/home/username/.local/share/rizin/plugins
• mv core_plugin_example.so ~/.local/share/rizin/plugins/

Example of usage

• rizin = This init was called!
• [0x00000000]> example? Usage: example <number> # example summary that contains some description
• [0x00000000]> example 1777 WARNING: the parsed number is 1777
• [0x00000000]> example -777 ERROR: only positive numbers are accepted -777 Error while executing command: example -777
• [0x00000000]> q This fini was called!

Definition in file core_plugin_example.c.

Macro Definition Documentation

_RZ_API

#define _RZ_API

Definition at line 111 of file core_plugin_example.c.

RZ_API

#define RZ_API   static

Definition at line 36 of file core_plugin_example.c.

RZ_IPI

#define RZ_IPI   static

Definition at line 38 of file core_plugin_example.c.

Function Documentation

rz_cmd_example_fini()

static bool rz_cmd_example_fini ( RzCore *  core )

static

Definition at line 90 of file core_plugin_example.c.

                                              {
    /* Here you can end any aspect of the core
     * plugin (like free allocated memory, or
     * end sockets, etc..) */
    eprintf("This fini was called!\n");
    return true;
}

References eprintf.

rz_cmd_example_handler()

RZ_IPI RzCmdStatus rz_cmd_example_handler	(	RzCore *	core,
		int	argc,
		const char **	argv
	)

Definition at line 53 of file core_plugin_example.c.

                                                                                     {
    /* This is the handler on when `example [args]` is called. */
    if (argc != 2) {
        return RZ_CMD_STATUS_WRONG_ARGS;
    }
 
    st32 index = rz_num_math(core->num, argv[1]);
    if (index < 1) {
        RZ_LOG_ERROR("only positive numbers are accepted %d\n", index);
        return RZ_CMD_STATUS_INVALID;
    }
 
    RZ_LOG_WARN("the parsed number is %d\n", index);
    return RZ_CMD_STATUS_OK;
}

References argv, rz_core_t::num, RZ_CMD_STATUS_INVALID, RZ_CMD_STATUS_OK, RZ_CMD_STATUS_WRONG_ARGS, RZ_LOG_ERROR, RZ_LOG_WARN, rz_num_math(), and st32.

Referenced by rz_cmd_example_init().

rz_cmd_example_init()

static bool rz_cmd_example_init ( RzCore *  core )

static

Definition at line 69 of file core_plugin_example.c.

                                              {
    /* Here you can initialize any aspect of the
     * core plugin (like allocate memory or register
     * the core plugin on the shell or create a socket) */
    eprintf("This init was called!\n");
    RzCmd *rcmd = core->rcmd;
    RzCmdDesc *root_cd = rz_cmd_get_root(rcmd);
    if (!root_cd) {
        return false;
    }
 
    /* Here you will add your custom command and add it into the root tree. */
    RzCmdDesc *cd = rz_cmd_desc_argv_new(rcmd, root_cd, "example", rz_cmd_example_handler, &cmd_example_help);
    if (!cd) {
        rz_warn_if_reached();
        return false;
    }
 
    return true;
}

References cd, cmd_example_help, eprintf, rz_core_t::rcmd, cmd_descs_generate::root_cd, rz_cmd_desc_argv_new(), rz_cmd_example_handler(), rz_cmd_get_root(), and rz_warn_if_reached.

Variable Documentation

cmd_example_args

const RzCmdDescArg cmd_example_args[]

static

Initial value:

= {
    {
        .name = "number", 
        .type = RZ_CMD_ARG_TYPE_NUM, 
    },
    { 0 },
}

Definition at line 40 of file core_plugin_example.c.

cmd_example_help

const RzCmdDescHelp cmd_example_help

static

Initial value:

= {
    .summary = "example summary that contains some description",
    .args = cmd_example_args,
}

Definition at line 48 of file core_plugin_example.c.

Referenced by rz_cmd_example_init().

rizin_plugin

_RZ_API RzLibStruct rizin_plugin

Initial value:

= {
    .type = RZ_LIB_TYPE_CORE,
    .data = &rz_core_plugin_example,
    .version = RZ_VERSION,
    .pkgname = "example_package"
}

Definition at line 115 of file core_plugin_example.c.

rz_core_plugin_example

RzCorePlugin rz_core_plugin_example

Initial value:

= {
    .name = "test",
    .desc = "description of the example core plugin",
    .license = "LGPL",
    .author = "somebody",
    .version = "1.0",
    .init = rz_cmd_example_init,
    .fini = rz_cmd_example_fini,
}

Definition at line 98 of file core_plugin_example.c.