--- libeio/eio.h 2011/06/05 22:44:30 1.31 +++ libeio/eio.h 2015/06/13 00:06:13 1.55 @@ -1,19 +1,19 @@ /* * libeio API header * - * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann + * Copyright (c) 2007,2008,2009,2010,2011,2012,2015 Marc Alexander Lehmann * All rights reserved. * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * + * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO @@ -45,6 +45,7 @@ #endif #include +#include #include typedef struct eio_req eio_req; @@ -57,13 +58,48 @@ #endif #ifndef EIO_STRUCT_STAT -# define EIO_STRUCT_STAT struct stat +# ifdef _WIN32 +# define EIO_STRUCT_STAT struct _stati64 +# define EIO_STRUCT_STATI64 +# else +# define EIO_STRUCT_STAT struct stat +# endif +#endif + +#ifdef _WIN32 + typedef int eio_uid_t; + typedef int eio_gid_t; + #ifdef __MINGW32__ /* no intptr_t */ + typedef ssize_t eio_ssize_t; + #else + typedef intptr_t eio_ssize_t; /* or SSIZE_T */ + #endif + #if __GNUC__ + typedef long long eio_ino_t; /* signed for compatibility to msvc */ + #else + typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ + #endif +#else + typedef uid_t eio_uid_t; + typedef gid_t eio_gid_t; + typedef ssize_t eio_ssize_t; + typedef ino_t eio_ino_t; #endif #ifndef EIO_STRUCT_STATVFS # define EIO_STRUCT_STATVFS struct statvfs #endif +/* managing working directories */ + +typedef struct eio_pwd *eio_wd; + +#define EIO_CWD 0 /* the current working directory of the process, guaranteed to be a null pointer */ +#define EIO_INVALID_WD ((eio_wd)(int)-1) /* failure return for eio_wd_open */ + +eio_wd eio_wd_open_sync (eio_wd wd, const char *path); +void eio_wd_close_sync (eio_wd wd); + /* for readdir */ /* eio_readdir flags */ @@ -106,7 +142,7 @@ unsigned short namelen; /* size of filename without trailing 0 */ unsigned char type; /* one of EIO_DT_* */ signed char score; /* internal use */ - ino_t inode; /* the inode number, if available, otherwise unspecified */ + eio_ino_t inode; /* the inode number, if available, otherwise unspecified */ }; /* eio_msync flags */ @@ -118,14 +154,12 @@ }; /* eio_mtouch flags */ - enum { EIO_MT_MODIFY = 1 }; /* eio_sync_file_range flags */ - enum { EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, @@ -133,37 +167,70 @@ EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 }; -typedef double eio_tstamp; /* feel free to use double in your code directly */ +/* eio_fallocate flags */ +enum +{ + /* these MUST match the value in linux/falloc.h */ + EIO_FALLOC_FL_KEEP_SIZE = 0x01, + EIO_FALLOC_FL_PUNCH_HOLE = 0x02, + EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08, + EIO_FALLOC_FL_ZERO_RANGE = 0x10 +}; -/* the eio request structure */ +/* timestamps and differences - feel free to use double in your code directly */ +typedef double eio_tstamp; +/* the eio request structure */ enum { EIO_CUSTOM, - EIO_OPEN, EIO_CLOSE, EIO_DUP2, - EIO_READ, EIO_WRITE, + EIO_WD_OPEN, EIO_WD_CLOSE, + + EIO_CLOSE, EIO_DUP2, + EIO_SEEK, EIO_READ, EIO_WRITE, EIO_READAHEAD, EIO_SENDFILE, - EIO_STAT, EIO_LSTAT, EIO_FSTAT, - EIO_STATVFS, EIO_FSTATVFS, - EIO_TRUNCATE, EIO_FTRUNCATE, - EIO_UTIME, EIO_FUTIME, - EIO_CHMOD, EIO_FCHMOD, - EIO_CHOWN, EIO_FCHOWN, - EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, - EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, + EIO_FSTAT, EIO_FSTATVFS, + EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, + EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, + EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, EIO_MLOCK, EIO_MLOCKALL, + EIO_GROUP, EIO_NOP, + EIO_BUSY, + + /* these use wd + ptr1, but are emulated */ + EIO_REALPATH, + EIO_READDIR, + + /* all the following requests use wd + ptr1 as path in xxxat functions */ + EIO_OPEN, + EIO_STAT, EIO_LSTAT, EIO_STATVFS, + EIO_TRUNCATE, + EIO_UTIME, + EIO_CHMOD, + EIO_CHOWN, EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, - EIO_MKNOD, EIO_READDIR, + EIO_MKNOD, EIO_LINK, EIO_SYMLINK, EIO_READLINK, - EIO_GROUP, EIO_NOP, - EIO_BUSY + + EIO_REQ_TYPE_NUM +}; + +/* seek whence modes */ +/* these are guaranteed to hasve the traditional 0, 1, 2 values, */ +/* so you might as wlel use those */ +enum +{ + EIO_SEEK_SET = 0, + EIO_SEEK_CUR = 1, + EIO_SEEK_END = 2 }; + /* mlockall constants */ enum { EIO_MCL_CURRENT = 1, - EIO_MCL_FUTURE = 2, + EIO_MCL_FUTURE = 2 }; /* request priorities */ @@ -171,7 +238,7 @@ enum { EIO_PRI_MIN = -4, EIO_PRI_MAX = 4, - EIO_PRI_DEFAULT = 0, + EIO_PRI_DEFAULT = 0 }; /* eio request structure */ @@ -181,22 +248,30 @@ { eio_req volatile *next; /* private ETP */ - ssize_t result; /* result of syscall, e.g. result = read (... */ - off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */ - size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ + eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ + + eio_ssize_t result; /* result of syscall, e.g. result = read (... */ + off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ + size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ eio_tstamp nv2; /* utime, futime: mtime */ - int type; /* EIO_xxx constant ETP */ int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ - long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ - long int3; /* chown, fchown: gid */ + long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ + long int3; /* chown, fchown: gid; rename, link: working directory of new name */ int errorno; /* errno value on syscall return */ unsigned char flags; /* private */ - signed char pri; /* the priority */ + + signed char type;/* EIO_xxx constant ETP */ + signed char pri; /* the priority ETP */ +#if __i386 || __amd64 + unsigned char cancelled; /* ETP */ +#else + sig_atomic_t cancelled; /* ETP */ +#endif void *data; eio_cb finish; @@ -205,15 +280,14 @@ EIO_REQ_MEMBERS - eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ + eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */ }; /* _private_ request flags */ enum { - EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ - EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ - EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ - EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ + EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ + EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ + EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ }; /* undocumented/unsupported/private helper */ @@ -245,25 +319,30 @@ unsigned int eio_nreqs (void); /* number of requests in-flight */ unsigned int eio_nready (void); /* number of not-yet handled requests */ -unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ +unsigned int eio_npending (void); /* number of finished but unhandled requests */ unsigned int eio_nthreads (void); /* number of worker threads in use currently */ /*****************************************************************************/ /* convenience wrappers */ #ifndef EIO_NO_WRAPPERS +eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ +eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ eio_req *eio_sync (int pri, eio_cb cb, void *data); eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); +eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data); eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); +eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); +eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ @@ -271,19 +350,20 @@ eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); -eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); +eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data); eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); -eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); +eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data); eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ +eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ @@ -291,7 +371,7 @@ eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); -eio_req *eio_custom (void (*)(eio_req *) execute, int pri, eio_cb cb, void *data); +eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data); #endif /*****************************************************************************/ @@ -307,7 +387,7 @@ /* request api */ /* true if the request was cancelled, useful in the invoke callback */ -#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) +#define EIO_CANCELLED(req) ((req)->cancelled) #define EIO_RESULT(req) ((req)->result) /* returns a pointer to the result buffer allocated by eio */ @@ -320,13 +400,11 @@ void eio_submit (eio_req *req); /* cancel a request as soon fast as possible, if possible */ void eio_cancel (eio_req *req); -/* destroy a request that has never been submitted */ -void eio_destroy (eio_req *req); /*****************************************************************************/ -/* convinience functions */ +/* convenience functions */ -ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); +eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); #ifdef __cplusplus }