nio.h

Go to the documentation of this file.

/*              $Id: $          */

/*
 * Copyright (c) 2007 Mark Heily <devel@heily.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _NIO_H
#define _NIO_H

#include <sys/ipc.h>
#include <sys/shm.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
#include <fcntl.h>

/* Constants that correspond with syscalls or libc functions */
enum nio_op {
        NIO_INVALID = 0,

        /* Disk I/O */
        NIO_OPEN,
        NIO_CLOSE,
        NIO_READ,
        NIO_WRITE,
        NIO_LSEEK,
        NIO_OPENDIR,
        NIO_CLOSEDIR,
        NIO_REWINDDIR,
        NIO_READDIR,
        NIO_TELLDIR,
        NIO_LINK,
        NIO_SYMLINK,
        NIO_UNLINK,
        NIO_RENAME,
        NIO_FCNTL,
        NIO_STAT,
        NIO_FSTAT,
        NIO_LSTAT,
        NIO_FDATASYNC,
        NIO_FSYNC,
        NIO_TRUNCATE,
        NIO_FTRUNCATE,

        /* Network I/O */
        NIO_GETADDRINFO,
        NIO_GETNAMEINFO,
};

// TODO: split into nio_req and nio_res; have nio_req STAILQ to enqueue requests
//

struct niocb {

        /* The 'request' data fields filled in by the caller */

        enum nio_op req_op;             
        int         req_fd;             
        off_t       req_offset;         
        size_t      req_len;            
        mode_t      req_mode;           
        char       *req_path;           
        int         req_flags;          
        /* The 'response' data fields filled in after the syscall completes */

        union {
                struct stat    st;      
                struct dirent  ent;     
                int            fd;      
                size_t         len;     
                DIR           *dirh;    
                off_t          offset;  
        } res_data;
        int         res_errno;          
        int         res_retval;         
        int         res_shmid;          
};


/* Replacement for POSIX I/O system calls */

int nio_open(struct niocb *cb, const char *path, int flags, mode_t mode);
int nio_close(struct niocb *cb, int fd);
int nio_read(struct niocb *cb, int fd, size_t count);
int nio_write(struct niocb *cb, int fd, const void *buf, size_t count);
int nio_lseek(struct niocb *cb, int fd, off_t offset, int whence);

/* opendir(2) related */

int nio_opendir(struct niocb *cb, const char *name);
int nio_closedir(struct niocb *cb, DIR *dir);
int nio_rewinddir(struct niocb *cb, DIR *dir);
int nio_readdir(struct niocb *cb, DIR *dir);
int nio_telldir(struct niocb *cb, DIR *dir);

/* link(2) related */

int nio_link(struct niocb *cb, const char *oldpath, const char *newpath);
int nio_symlink(struct niocb *cb, const char *oldpath, const char *newpath);
int nio_unlink(struct niocb *cb, const char *path);
int nio_rename(struct niocb *cb, const char *oldpath, const char *newpath);

/* fnctl(2) file locking */

int nio_fcntl(struct niocb *cb, int fd, int op, const struct flock *fl);

/* stat(2) related */

int nio_stat(struct niocb *cb, const char *path);
int nio_fstat(struct niocb *cb, int fd);
int nio_lstat(struct niocb *cb, const char *path);

/* sync(2) related */

int nio_fdatasync(struct niocb *cb, int fd);
int nio_fsync(struct niocb *cb, int fd);

/* truncate(2) related */

int nio_truncate(struct niocb *cb, const char *path, off_t length);
int nio_ftruncate(struct niocb *cb, int fd, off_t length);

/* network I/O */

int nio_getaddrinfo(struct niocb *cb, 
                const char *node,
                const char *service,
                const struct addrinfo *hints,
                struct addrinfo **res);

int nio_getnameinfo(struct niocb *cb,
                const struct sockaddr *sa, 
                socklen_t salen,
                char *host,
                size_t hostlen,
                char *serv,
                size_t servlen,
                int flags);

#endif

---