cvfile.c File Reference

#include <rz_core.h>

Go to the source code of this file.

Classes
struct	VFileCtx

Macros
#define	URI_SCHEME   "vfile://"
#define	URI_SCHEME_LEN   8

Functions
static bool	vf_check (RzIO *io, const char *pathname, bool many)
static RzBinVirtualFile *	find_vfile (RzBinFile *bf, const char *name)
static RzIODesc *	vf_open (RzIO *io, const char *pathname, int rw, int mode)
static int	vf_write (RzIO *io, RzIODesc *fd, const ut8 *buf, int count)
static int	vf_read (RzIO *io, RzIODesc *fd, ut8 *buf, int count)
static int	vf_close (RzIODesc *fd)
static ut64	vf_lseek (struct rz_io_t *io, RzIODesc *fd, ut64 offset, int whence)
static bool	vf_resize (RzIO *io, RzIODesc *fd, ut64 size)
RZ_IPI void	rz_core_vfile_bin_file_deleted (RzCore *core, RzBinFile *bf)

Variables
RzIOPlugin	rz_core_io_plugin_vfile
	IO Plugin that opens RzBinVirtualFiles supplied by the plugin of an RzBinFile. More...
RZ_API RzLibStruct	rizin_plugin

Macro Definition Documentation

URI_SCHEME

#define URI_SCHEME   "vfile://"

Definition at line 6 of file cvfile.c.

URI_SCHEME_LEN

#define URI_SCHEME_LEN   8

Definition at line 7 of file cvfile.c.

Function Documentation

find_vfile()

static RzBinVirtualFile* find_vfile ( RzBinFile *  bf, const char *  name  )

static

Definition at line 22 of file cvfile.c.

                                                                     {
    if (!bf->o || !bf->o->vfiles) {
        return NULL;
    }
    RzListIter *it;
    RzBinVirtualFile *vfile;
    rz_list_foreach (bf->o->vfiles, it, vfile) {
        if (!strcmp(vfile->name, name)) {
            return vfile;
        }
    }
    return NULL;
}

References rz_bin_virtual_file_t::name, NULL, rz_bin_file_t::o, and rz_bin_object_t::vfiles.

Referenced by vf_open().

rz_core_vfile_bin_file_deleted()

RZ_IPI void rz_core_vfile_bin_file_deleted	(	RzCore *	core,
		RzBinFile *	bf
	)

Definition at line 156 of file cvfile.c.

                                                                        {
    // close all vfile descs that point into the binfile that is about to be closed
    // This is strictly necessary because VFileCtx holds pointers into it!
    RzList *descs = rz_id_storage_list(core->io->files);
    if (!descs) {
        return;
    }
    RzListIter *it;
    RzIODesc *desc;
    rz_list_foreach (descs, it, desc) {
        if (strcmp(desc->plugin->name, rz_core_io_plugin_vfile.name)) {
            continue;
        }
        VFileCtx *ctx = desc->data;
        if (ctx->bf == bf) {
            rz_io_desc_close(desc);
        }
    }
    rz_list_free(descs);
}

References desc, rz_io_t::files, rz_core_t::io, rz_io_plugin_t::name, rz_core_io_plugin_vfile, rz_id_storage_list(), rz_io_desc_close(), and rz_list_free().

Referenced by ev_binfiledel_cb().

vf_check()

static bool vf_check ( RzIO *  io, const char *  pathname, bool  many  )

static

Definition at line 17 of file cvfile.c.

                                                                {
    // be careful if changing this, vf_open relies on its behavior!
    return !strncmp(pathname, URI_SCHEME, URI_SCHEME_LEN);
}

References pathname, URI_SCHEME, and URI_SCHEME_LEN.

Referenced by vf_open().

vf_close()

static int vf_close ( RzIODesc *  fd )

static

Definition at line 94 of file cvfile.c.

                                  {
    rz_return_val_if_fail(fd && fd->data, -1);
    VFileCtx *ctx = fd->data;
    free(ctx);
    fd->data = NULL;
    return 0;
}

References fd, free(), NULL, and rz_return_val_if_fail.

vf_lseek()

static ut64 vf_lseek ( struct rz_io_t *  io, RzIODesc *  fd, ut64  offset, int  whence  )

static

Definition at line 102 of file cvfile.c.

                                                                                {
    rz_return_val_if_fail(fd && fd->data, UT64_MAX);
    VFileCtx *ctx = fd->data;
    // we store the offset ourselves instead of using the RzBuffer's because
    // there might be multiple io files accessing the same vfile.
    switch (whence) {
    case SEEK_SET:
        ctx->off = offset;
        break;
    case SEEK_CUR:
        ctx->off += offset;
        break;
    case SEEK_END:
        ctx->off = rz_buf_size(ctx->vfile->buf);
        break;
    }
    return ctx->off;
}

References fd, rz_buf_size(), rz_return_val_if_fail, SEEK_CUR, SEEK_END, SEEK_SET, and UT64_MAX.

vf_open()

static RzIODesc* vf_open ( RzIO *  io, const char *  pathname, int  rw, int  mode  )

static

Definition at line 36 of file cvfile.c.

                                                                           {
    if (!vf_check(io, pathname, false)) {
        return NULL;
    }
    char *vfile_path = strdup(pathname + URI_SCHEME_LEN); // path like "<binfile id>/<filename>"
    if (!vfile_path) {
        return NULL;
    }
    RzIODesc *desc = NULL;
    char *filename = strchr(vfile_path, '/');
    if (!filename) {
        RZ_LOG_ERROR("Invalid URI \"%s\", expected " URI_SCHEME "<fd>/<filename>\n", pathname);
        goto beach;
    }
    *filename++ = '\0';
    ut32 bfid = (ut32)strtoull(vfile_path, NULL, 0);
    RzCore *core = io->corebind.core; // We are in the core already so this is fine.
    RzBinFile *bf = rz_bin_file_find_by_id(core->bin, bfid);
    if (!bf) {
        RZ_LOG_ERROR("No bin file for id %" PFMT32u " from URI \"%s\"\n", bfid, pathname);
        goto beach;
    }
    RzBinVirtualFile *vfile = find_vfile(bf, filename);
    if (!vfile) {
        RZ_LOG_ERROR("No virtual file called \"%s\" for bin file id %" PFMT32u " from URI \"%s\"\n", filename, bfid, pathname);
        goto beach;
    }
    VFileCtx *ctx = RZ_NEW(VFileCtx);
    if (!ctx) {
        goto beach;
    }
    ctx->bf = bf;
    ctx->vfile = vfile;
    ctx->off = 0;
    desc = rz_io_desc_new(io, &rz_core_io_plugin_vfile, pathname, rw, mode, ctx);
    if (!desc) {
        free(ctx);
    }
beach:
    free(vfile_path);
    return desc;
}

References rz_core_t::bin, rz_core_bind_t::core, rz_io_t::corebind, desc, find_vfile(), free(), NULL, pathname, PFMT32u, rz_bin_file_find_by_id(), rz_core_io_plugin_vfile, rz_io_desc_new(), RZ_LOG_ERROR, RZ_NEW, strdup(), URI_SCHEME, URI_SCHEME_LEN, and vf_check().

vf_read()

static int vf_read ( RzIO *  io, RzIODesc *  fd, ut8 *  buf, int  count  )

static

Definition at line 88 of file cvfile.c.

                                                                {
    rz_return_val_if_fail(fd && fd->data, -1);
    VFileCtx *ctx = fd->data;
    return rz_buf_read_at(ctx->vfile->buf, ctx->off, buf, count);
}

References count, fd, rz_buf_read_at(), and rz_return_val_if_fail.

vf_resize()

static bool vf_resize ( RzIO *  io, RzIODesc *  fd, ut64  size  )

static

Definition at line 121 of file cvfile.c.

                                                         {
    rz_return_val_if_fail(fd && fd->data, false);
    VFileCtx *ctx = fd->data;
    return rz_buf_resize(ctx->vfile->buf, size);
}

References fd, rz_buf_resize(), and rz_return_val_if_fail.

vf_write()

static int vf_write ( RzIO *  io, RzIODesc *  fd, const ut8 *  buf, int  count  )

static

Definition at line 79 of file cvfile.c.

                                                                       {
    rz_return_val_if_fail(fd && fd->data, -1);
    if (!(fd->perm & RZ_PERM_W)) {
        return -1;
    }
    VFileCtx *ctx = fd->data;
    return rz_buf_write_at(ctx->vfile->buf, ctx->off, buf, count);
}

References count, fd, rz_buf_write_at(), RZ_PERM_W, and rz_return_val_if_fail.

Variable Documentation

rizin_plugin

RZ_API RzLibStruct rizin_plugin

Initial value:

= {
    .type = RZ_LIB_TYPE_IO,
    .data = &rz_io_plugin_vfile,
    .version = RZ_VERSION
}

Definition at line 149 of file cvfile.c.

rz_core_io_plugin_vfile

RZ_IPI RzIOPlugin rz_core_io_plugin_vfile

Initial value:

= {
    .name = "vfile",
    .desc = "Virtual Files provided by RzBin Files",
    .uris = URI_SCHEME,
    .license = "LGPL",
    .open = vf_open,
    .close = vf_close,
    .read = vf_read,
    .check = vf_check,
    .lseek = vf_lseek,
    .write = vf_write,
    .resize = vf_resize
}

IO Plugin that opens RzBinVirtualFiles supplied by the plugin of an RzBinFile.

URIs look like vfile://1/decompressed_data_0 where 1 is the id of a loaded RzBinFile and decompressed_data_0 is the name of the RzBinVirtualFile inside this RzBinFile that provides the data.

Definition at line 134 of file cvfile.c.

Referenced by rz_core_init(), rz_core_vfile_bin_file_deleted(), and vf_open().