io_default.c File Reference

#include <rz_userconf.h>
#include <rz_io.h>
#include <rz_lib.h>
#include <stdio.h>

Go to the source code of this file.

Classes
struct	rz_io_mmo_t

Typedefs
typedef struct rz_io_mmo_t	RzIOMMapFileObj

Functions
static int	iowhence2buf (int whence)
static ut64	rz_io_def_mmap_seek (RzIO *io, RzIOMMapFileObj *mmo, ut64 offset, int whence)
static void	rz_io_def_mmap_free (RzIOMMapFileObj *mmo)
static void	disable_fd_cache (int fd)
RzIOMMapFileObj *	rz_io_def_mmap_create_new_file (RzIO *io, const char *filename, int perm, int mode)
static int	rz_io_def_mmap_close (RzIODesc *fd)
static bool	rz_io_def_mmap_check_default (const char *filename)
static int	rz_io_def_mmap_read (RzIO *io, RzIODesc *fd, ut8 *buf, int count)
static int	rz_io_def_mmap_write (RzIO *io, RzIODesc *fd, const ut8 *buf, int count)
static RzIODesc *	rz_io_def_mmap_open (RzIO *io, const char *file, int perm, int mode)
static ut64	rz_io_def_mmap_lseek (RzIO *io, RzIODesc *fd, ut64 offset, int whence)
static int	rz_io_def_mmap_truncate (RzIOMMapFileObj *mmo, ut64 size)
static bool	__plugin_open_default (RzIO *io, const char *file, bool many)
static RzIODesc *	__open_default (RzIO *io, const char *file, int perm, int mode)
static int	__read (RzIO *io, RzIODesc *fd, ut8 *buf, int len)
static int	__write (RzIO *io, RzIODesc *fd, const ut8 *buf, int len)
static ut64	__lseek (RzIO *io, RzIODesc *fd, ut64 offset, int whence)
static int	__close (RzIODesc *fd)
static bool	__resize (RzIO *io, RzIODesc *fd, ut64 size)
static ut8 *	io_default_get_buf (RzIODesc *desc, ut64 *size)

Variables
RzIOPlugin	rz_io_plugin_default
RZ_API RzLibStruct	rizin_plugin

Typedef Documentation

RzIOMMapFileObj

typedef struct rz_io_mmo_t RzIOMMapFileObj

Function Documentation

__close()

static int __close ( RzIODesc *  fd )

static

Definition at line 169 of file io_default.c.

                                 {
    return rz_io_def_mmap_close(fd);
}

References fd, and rz_io_def_mmap_close().

__lseek()

static ut64 __lseek ( RzIO *  io, RzIODesc *  fd, ut64  offset, int  whence  )

static

Definition at line 165 of file io_default.c.

                                                                     {
    return rz_io_def_mmap_lseek(io, fd, offset, whence);
}

References fd, and rz_io_def_mmap_lseek().

__open_default()

static RzIODesc* __open_default ( RzIO *  io, const char *  file, int  perm, int  mode  )

static

Definition at line 150 of file io_default.c.

                                                                                {
    if (rz_io_def_mmap_check_default(file)) {
        return rz_io_def_mmap_open(io, file, perm, mode);
    }
    return NULL;
}

References NULL, rz_io_def_mmap_check_default(), and rz_io_def_mmap_open().

__plugin_open_default()

static bool __plugin_open_default ( RzIO *  io, const char *  file, bool  many  )

static

Definition at line 145 of file io_default.c.

                                                                         {
    return rz_io_def_mmap_check_default(file);
}

References rz_io_def_mmap_check_default().

__read()

static int __read ( RzIO *  io, RzIODesc *  fd, ut8 *  buf, int  len  )

static

Definition at line 157 of file io_default.c.

                                                             {
    return rz_io_def_mmap_read(io, fd, buf, len);
}

References fd, len, and rz_io_def_mmap_read().

__resize()

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

static

Definition at line 173 of file io_default.c.

                                                        {
    rz_return_val_if_fail(io && fd && fd->data, false);
    RzIOMMapFileObj *mmo = fd->data;
    if (!(mmo->perm & RZ_PERM_W)) {
        return false;
    }
    return rz_io_def_mmap_truncate(mmo, size);
}

References fd, rz_io_mmo_t::perm, rz_io_def_mmap_truncate(), RZ_PERM_W, and rz_return_val_if_fail.

__write()

static int __write ( RzIO *  io, RzIODesc *  fd, const ut8 *  buf, int  len  )

static

Definition at line 161 of file io_default.c.

                                                                    {
    return rz_io_def_mmap_write(io, fd, buf, len);
}

References fd, len, and rz_io_def_mmap_write().

disable_fd_cache()

static void disable_fd_cache ( int  fd )

static

Definition at line 50 of file io_default.c.

                                     {
#if F_NOCACHE
    fcntl(fd, F_NOCACHE, 1);
#elif O_DIRECT
    int open_flags = fcntl(fd, F_GETFL);
    fcntl(fd, F_SETFL, open_flags | O_DIRECT);
#endif
}

References F_GETFL, F_SETFL, fcntl, fd, and O_DIRECT.

Referenced by rz_io_def_mmap_create_new_file().

io_default_get_buf()

static ut8* io_default_get_buf ( RzIODesc *  desc, ut64 *  size  )

static

Definition at line 194 of file io_default.c.

                                                           {
    rz_return_val_if_fail(desc && size, NULL);
    RzIOMMapFileObj *mmo = desc->data;
    return rz_buf_data(mmo->buf, size);
}

References rz_io_mmo_t::buf, desc, NULL, rz_buf_data(), and rz_return_val_if_fail.

iowhence2buf()

static int iowhence2buf ( int  whence )

static

Definition at line 18 of file io_default.c.

                                    {
    switch (whence) {
    case RZ_BUF_CUR:
        return RZ_IO_SEEK_CUR;
    case RZ_BUF_SET:
        return RZ_IO_SEEK_SET;
    case RZ_BUF_END:
        return RZ_IO_SEEK_END;
    default:
        rz_warn_if_reached();
        return -1;
    }
}

References RZ_BUF_CUR, RZ_BUF_END, RZ_BUF_SET, RZ_IO_SEEK_CUR, RZ_IO_SEEK_END, RZ_IO_SEEK_SET, and rz_warn_if_reached.

Referenced by rz_io_def_mmap_seek().

rz_io_def_mmap_check_default()

static bool rz_io_def_mmap_check_default ( const char *  filename )

static

Definition at line 98 of file io_default.c.

                                                               {
    rz_return_val_if_fail(filename && *filename, false);
    if (rz_str_startswith(filename, "file://")) {
        filename += strlen("file://");
    }
    const char *peekaboo = (!strncmp(filename, "nocache://", 10))
        ? NULL
        : strstr(filename, "://");
    return (!peekaboo || (peekaboo - filename) > 10);
}

References NULL, rz_return_val_if_fail, and rz_str_startswith().

Referenced by __open_default(), and __plugin_open_default().

rz_io_def_mmap_close()

static int rz_io_def_mmap_close ( RzIODesc *  fd )

static

Definition at line 91 of file io_default.c.

                                              {
    rz_return_val_if_fail(fd && fd->data, -1);
    rz_io_def_mmap_free((RzIOMMapFileObj *)fd->data);
    fd->data = NULL;
    return 0;
}

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

Referenced by __close().

rz_io_def_mmap_create_new_file()

RzIOMMapFileObj* rz_io_def_mmap_create_new_file	(	RzIO *	io,
		const char *	filename,
		int	perm,
		int	mode
	)

Definition at line 59 of file io_default.c.

                                                                                                    {
    rz_return_val_if_fail(io && filename, NULL);
    RzIOMMapFileObj *mmo = RZ_NEW0(RzIOMMapFileObj);
    if (!mmo) {
        return NULL;
    }
    if (rz_str_startswith(filename, "file://")) {
        filename += strlen("file://");
    }
    mmo->nocache = rz_str_startswith(filename, "nocache://");
    if (mmo->nocache) {
        filename += strlen("nocache://");
    }
    mmo->filename = strdup(filename);
    mmo->perm = rz_sys_open_perms(perm);
    mmo->mode = mode;
    if (!mmo->nocache) {
        mmo->buf = rz_buf_new_mmap(mmo->filename, mmo->perm, mmo->mode);
    }
    if (!mmo->buf) {
        mmo->buf = rz_buf_new_file(mmo->filename, mmo->perm, mmo->mode);
        if (!mmo->buf) {
            rz_io_def_mmap_free(mmo);
            return NULL;
        }
        if (mmo->nocache) {
            disable_fd_cache(mmo->buf->fd);
        }
    }
    return mmo;
}

References rz_io_mmo_t::buf, disable_fd_cache(), rz_buf_t::fd, rz_io_mmo_t::filename, rz_io_mmo_t::mode, rz_io_mmo_t::nocache, NULL, rz_io_mmo_t::perm, rz_buf_new_file(), rz_buf_new_mmap(), rz_io_def_mmap_free(), RZ_NEW0, rz_return_val_if_fail, rz_str_startswith(), rz_sys_open_perms(), and strdup().

Referenced by rz_io_def_mmap_open().

rz_io_def_mmap_free()

static void rz_io_def_mmap_free ( RzIOMMapFileObj *  mmo )

static

Definition at line 41 of file io_default.c.

                                                      {
    if (!mmo) {
        return;
    }
    free(mmo->filename);
    rz_buf_free(mmo->buf);
    free(mmo);
}

References rz_io_mmo_t::buf, rz_io_mmo_t::filename, free(), and rz_buf_free().

Referenced by rz_io_def_mmap_close(), and rz_io_def_mmap_create_new_file().

rz_io_def_mmap_lseek()

static ut64 rz_io_def_mmap_lseek ( RzIO *  io, RzIODesc *  fd, ut64  offset, int  whence  )

static

Definition at line 136 of file io_default.c.

                                                                                  {
    rz_return_val_if_fail(fd && fd->data, UT64_MAX);
    return rz_io_def_mmap_seek(io, (RzIOMMapFileObj *)fd->data, offset, whence);
}

References fd, rz_io_def_mmap_seek(), rz_return_val_if_fail, and UT64_MAX.

Referenced by __lseek().

rz_io_def_mmap_open()

static RzIODesc* rz_io_def_mmap_open ( RzIO *  io, const char *  file, int  perm, int  mode  )

static

Definition at line 123 of file io_default.c.

                                                                                     {
    rz_return_val_if_fail(io && file, NULL);
    RzIOMMapFileObj *mmo = rz_io_def_mmap_create_new_file(io, file, perm, mode);
    if (!mmo) {
        return NULL;
    }
    RzIODesc *d = rz_io_desc_new(io, &rz_io_plugin_default, mmo->filename, perm, mode, mmo);
    if (!d->name) {
        d->name = strdup(mmo->filename);
    }
    return d;
}

References d, rz_io_mmo_t::filename, NULL, rz_io_def_mmap_create_new_file(), rz_io_desc_new(), rz_io_plugin_default, rz_return_val_if_fail, and strdup().

Referenced by __open_default().

rz_io_def_mmap_read()

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

static

Definition at line 109 of file io_default.c.

                                                                            {
    rz_return_val_if_fail(fd && fd->data && buf, -1);
    RzIOMMapFileObj *mmo = (RzIOMMapFileObj *)fd->data;
    rz_return_val_if_fail(mmo && mmo->buf, -1);
    return (int)rz_buf_read(mmo->buf, buf, count);
}

References rz_io_mmo_t::buf, count, fd, rz_buf_read(), and rz_return_val_if_fail.

Referenced by __read().

rz_io_def_mmap_seek()

static ut64 rz_io_def_mmap_seek ( RzIO *  io, RzIOMMapFileObj *  mmo, ut64  offset, int  whence  )

static

Definition at line 32 of file io_default.c.

                                                                                         {
    rz_return_val_if_fail(io && mmo, UT64_MAX);
    // NOTE: io->off should not be set here and code outside RzIO should not
    // rely on it to get the current seek. They should use `rz_io_seek` instead.
    // Keep it here until all use cases of io->off are converted.
    io->off = rz_buf_seek(mmo->buf, offset, iowhence2buf(whence));
    return io->off;
}

References rz_io_mmo_t::buf, iowhence2buf(), rz_io_t::off, rz_buf_seek(), rz_return_val_if_fail, and UT64_MAX.

Referenced by rz_io_def_mmap_lseek().

rz_io_def_mmap_truncate()

static int rz_io_def_mmap_truncate ( RzIOMMapFileObj *  mmo, ut64  size  )

static

Definition at line 141 of file io_default.c.

                                                                    {
    return rz_buf_resize(mmo->buf, size);
}

References rz_io_mmo_t::buf, and rz_buf_resize().

Referenced by __resize().

rz_io_def_mmap_write()

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

static

Definition at line 116 of file io_default.c.

                                                                                   {
    rz_return_val_if_fail(io && fd && fd->data && buf, -1);
    RzIOMMapFileObj *mmo = (RzIOMMapFileObj *)fd->data;
    rz_return_val_if_fail(mmo && mmo->buf, -1);
    return (int)rz_buf_write(mmo->buf, buf, count);
}

References rz_io_mmo_t::buf, count, fd, rz_buf_write(), and rz_return_val_if_fail.

Referenced by __write().

Variable Documentation

rizin_plugin

RZ_API RzLibStruct rizin_plugin

Initial value:

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

Definition at line 219 of file io_default.c.

rz_io_plugin_default

RzIOPlugin rz_io_plugin_default

Initial value:

= {
    .name = "default",
    .desc = "Open local files",
    .license = "LGPL3",
    .uris = "file://,nocache://",
    .open = __open_default,
    .close = __close,
    .read = __read,
    .check = __plugin_open_default,
    .lseek = __lseek,
    .write = __write,
    .resize = __resize,
 
 
 
    .get_buf = io_default_get_buf
}

Definition at line 200 of file io_default.c.

Referenced by rz_io_def_mmap_open().