libeio/eio.h

/*
 * libeio API header
 *
 * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libeio@schmorp.de>
 * 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
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License ("GPL") version 2 or any later version,
 * in which case the provisions of the GPL are applicable instead of
 * the above. If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the BSD license, indicate your decision
 * by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL. If you do not delete the
 * provisions above, a recipient may use your version of this file under
 * either the BSD or the GPL.
 */

#ifndef EIO_H_
#define EIO_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <signal.h>
#include <sys/types.h>

typedef struct eio_req    eio_req;
typedef struct eio_dirent eio_dirent;

typedef int (*eio_cb)(eio_req *req);

#ifndef EIO_REQ_MEMBERS
# define EIO_REQ_MEMBERS
#endif

#ifndef EIO_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 */
enum
{
  EIO_READDIR_DENTS         = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
  EIO_READDIR_DIRS_FIRST    = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
  EIO_READDIR_STAT_ORDER    = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
  EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */

  EIO_READDIR_CUSTOM1       = 0x100, /* for use by apps */
  EIO_READDIR_CUSTOM2       = 0x200  /* for use by apps */
};

/* using "typical" values in the hope that the compiler will do something sensible */
enum eio_dtype
{
  EIO_DT_UNKNOWN =  0,
  EIO_DT_FIFO    =  1,
  EIO_DT_CHR     =  2,
  EIO_DT_MPC     =  3, /* multiplexed char device (v7+coherent) */
  EIO_DT_DIR     =  4,
  EIO_DT_NAM     =  5, /* xenix special named file */
  EIO_DT_BLK     =  6,
  EIO_DT_MPB     =  7, /* multiplexed block device (v7+coherent) */
  EIO_DT_REG     =  8,
  EIO_DT_NWK     =  9, /* HP-UX network special */
  EIO_DT_CMP     =  9, /* VxFS compressed */
  EIO_DT_LNK     = 10,
  /*  DT_SHAD    = 11,*/
  EIO_DT_SOCK    = 12,
  EIO_DT_DOOR    = 13, /* solaris door */
  EIO_DT_WHT     = 14,
  EIO_DT_MAX     = 15  /* highest DT_VALUE ever, hopefully */
};

struct eio_dirent
{
  int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
  unsigned short namelen; /* size of filename without trailing 0 */
  unsigned char type; /* one of EIO_DT_* */
  signed char score; /* internal use */
  eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
};

/* eio_msync flags */
enum
{
  EIO_MS_ASYNC      = 1,
  EIO_MS_INVALIDATE = 2,
  EIO_MS_SYNC       = 4
};

/* eio_mtouch flags */
enum
{
  EIO_MT_MODIFY     = 1
};

/* eio_sync_file_range flags */
enum
{
  EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
  EIO_SYNC_FILE_RANGE_WRITE       = 2,
  EIO_SYNC_FILE_RANGE_WAIT_AFTER  = 4
};

/* eio_fallocate flags */
enum
{
  EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
};

/* timestamps and differences - feel free to use double in your code directly */
typedef double eio_tstamp;

/* the eio request structure */
enum
{
  EIO_CUSTOM,
  EIO_WD_OPEN, EIO_WD_CLOSE,

  EIO_CLOSE, EIO_DUP2,
  EIO_READ, EIO_WRITE,
  EIO_READAHEAD, EIO_SENDFILE,
  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_STATVFS,
  EIO_READDIR,

  /* all the following requests use wd + ptr1 as path in xxxat functions */
  EIO_OPEN,
  EIO_STAT, EIO_LSTAT,
  EIO_TRUNCATE,
  EIO_UTIME,
  EIO_CHMOD,
  EIO_CHOWN,
  EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
  EIO_MKNOD,
  EIO_LINK, EIO_SYMLINK, EIO_READLINK,

  EIO_REQ_TYPE_NUM
};

/* mlockall constants */
enum
{
  EIO_MCL_CURRENT = 1,
  EIO_MCL_FUTURE  = 2,
};

/* request priorities */

enum {
  EIO_PRI_MIN     = -4,
  EIO_PRI_MAX     =  4,
  EIO_PRI_DEFAULT =  0,
};

/* eio request structure */
/* this structure is mostly read-only */
/* when initialising it, all members must be zero-initialised */
struct eio_req
{
  eio_req volatile *next; /* private ETP */

  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, fallocate: flags */
  long int3;       /* chown, fchown: gid; rename, link: working directory of new name */
  int errorno;     /* errno value on syscall return */

#if __i386 || __amd64
  unsigned char cancelled;
#else
  sig_atomic_t cancelled;
#endif

  unsigned char flags; /* private */
  signed char pri;     /* the priority */

  void *data;
  eio_cb finish;
  void (*destroy)(eio_req *req); /* called when request no longer needed */
  void (*feed)(eio_req *req);    /* only used for group requests */

  EIO_REQ_MEMBERS

  eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
};

/* _private_ request flags */
enum {
  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 */
/*void eio_page_align (void **addr, size_t *length);*/

/* returns < 0 on error, errno set
 * need_poll, if non-zero, will be called when results are available
 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
 * done_poll is called when the need to poll is gone.
 */
int eio_init (void (*want_poll)(void), void (*done_poll)(void));

/* must be called regularly to handle pending requests */
/* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
int eio_poll (void);

/* stop polling if poll took longer than duration seconds */
void eio_set_max_poll_time (eio_tstamp nseconds);
/* do not handle more then count requests in one call to eio_poll_cb */
void eio_set_max_poll_reqs (unsigned int nreqs);

/* set minimum required number
 * maximum wanted number
 * or maximum idle number of threads */
void eio_set_min_parallel (unsigned int nthreads);
void eio_set_max_parallel (unsigned int nthreads);
void eio_set_max_idle     (unsigned int nthreads);
void eio_set_idle_timeout (unsigned int seconds);

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); /* 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_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 */
eio_req *eio_fstatvfs  (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
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, 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, 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 */
eio_req *eio_mknod     (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
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 (*execute)(eio_req *), int pri, eio_cb cb, void *data);
#endif

/*****************************************************************************/
/* groups */

eio_req *eio_grp       (eio_cb cb, void *data);
void eio_grp_feed      (eio_req *grp, void (*feed)(eio_req *req), int limit);
void eio_grp_limit     (eio_req *grp, int limit);
void eio_grp_add       (eio_req *grp, eio_req *req);
void eio_grp_cancel    (eio_req *grp); /* cancels all sub requests but not the group */

/*****************************************************************************/
/* request api */

/* true if the request was cancelled, useful in the invoke callback */
#define EIO_CANCELLED(req)   ((req)->cancelled)

#define EIO_RESULT(req)      ((req)->result)
/* returns a pointer to the result buffer allocated by eio */
#define EIO_BUF(req)         ((req)->ptr2)
#define EIO_STAT_BUF(req)    ((EIO_STRUCT_STAT    *)EIO_BUF(req))
#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
#define EIO_PATH(req)        ((char *)(req)->ptr1)

/* submit a request for execution */
void eio_submit (eio_req *req);
/* cancel a request as soon fast as possible, if possible */
void eio_cancel (eio_req *req);

/*****************************************************************************/
/* convenience functions */

eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);

#ifdef __cplusplus
}
#endif

#endif

Revision:	1.49
Committed:	Tue Sep 27 12:36:19 2011 UTC (12 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-4_1, rel-4_12, rel-4_11
Changes since 1.48:	+2 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.12	/*
2			* libeio API header
3			*
4	root	1.28	* Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libeio@schmorp.de>
5	root	1.12	* All rights reserved.
6			*
7			* Redistribution and use in source and binary forms, with or without modifica-
8			* tion, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright notice,
11			* this list of conditions and the following disclaimer.
12			*
13			* 2. Redistributions in binary form must reproduce the above copyright
14			* notice, this list of conditions and the following disclaimer in the
15			* documentation and/or other materials provided with the distribution.
16			*
17			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18			* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19			* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20			* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21			* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22			* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23			* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24			* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25			* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26			* OF THE POSSIBILITY OF SUCH DAMAGE.
27			*
28			* Alternatively, the contents of this file may be used under the terms of
29			* the GNU General Public License ("GPL") version 2 or any later version,
30			* in which case the provisions of the GPL are applicable instead of
31			* the above. If you wish to allow the use of your version of this file
32			* only under the terms of the GPL and not to allow others to use your
33			* version of this file under the BSD license, indicate your decision
34			* by deleting the provisions above and replace them with the notice
35			* and other provisions required by the GPL. If you do not delete the
36			* provisions above, a recipient may use your version of this file under
37			* either the BSD or the GPL.
38			*/
39
40	root	1.1	#ifndef EIO_H_
41			#define EIO_H_
42
43	root	1.14	#ifdef __cplusplus
44			extern "C" {
45			#endif
46
47	root	1.1	#include <stddef.h>
48	root	1.35	#include <signal.h>
49	root	1.3	#include <sys/types.h>
50	root	1.1
51	root	1.19	typedef struct eio_req eio_req;
52			typedef struct eio_dirent eio_dirent;
53	root	1.1
54			typedef int (eio_cb)(eio_req req);
55
56	root	1.9	#ifndef EIO_REQ_MEMBERS
57			# define EIO_REQ_MEMBERS
58	root	1.1	#endif
59
60	root	1.6	#ifndef EIO_STRUCT_STAT
61	root	1.38	# ifdef _WIN32
62			# define EIO_STRUCT_STAT struct _stati64
63			# define EIO_STRUCT_STATI64
64			# else
65			# define EIO_STRUCT_STAT struct stat
66			# endif
67	root	1.6	#endif
68
69	root	1.39	#ifdef _WIN32
70	root	1.40	typedef int eio_uid_t;
71			typedef int eio_gid_t;
72	root	1.43	#ifdef __MINGW32__ /* no intptr_t */
73	root	1.42	typedef ssize_t eio_ssize_t;
74			#else
75			typedef intptr_t eio_ssize_t; /* or SSIZE_T */
76			#endif
77	root	1.40	#if __GNUC__
78	root	1.45	typedef long long eio_ino_t; /* signed for compatibility to msvc */
79	root	1.40	#else
80			typedef __int64 eio_ino_t; /* unsigned not supported by msvc */
81			#endif
82	root	1.39	#else
83	root	1.40	typedef uid_t eio_uid_t;
84			typedef gid_t eio_gid_t;
85			typedef ssize_t eio_ssize_t;
86			typedef ino_t eio_ino_t;
87	root	1.39	#endif
88
89	root	1.26	#ifndef EIO_STRUCT_STATVFS
90			# define EIO_STRUCT_STATVFS struct statvfs
91			#endif
92
93	root	1.46	/* managing working directories */
94
95	root	1.48	typedef struct eio_pwd *eio_wd;
96	root	1.46
97			#define EIO_CWD 0 /* the current working directory of the process, guaranteed to be a null pointer */
98			#define EIO_INVALID_WD ((eio_wd)(int)-1) /* failure return for eio_wd_open */
99
100			eio_wd eio_wd_open_sync (eio_wd wd, const char *path);
101			void eio_wd_close_sync (eio_wd wd);
102
103	root	1.19	/* for readdir */
104
105			/* eio_readdir flags */
106	root	1.27	enum
107			{
108	root	1.19	EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
109			EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
110			EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
111			EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when _ARRAY was set and any TYPE=UNKNOWN's were found /
112
113			EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
114			EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
115			};
116
117			/* using "typical" values in the hope that the compiler will do something sensible */
118	root	1.27	enum eio_dtype
119			{
120	root	1.19	EIO_DT_UNKNOWN = 0,
121			EIO_DT_FIFO = 1,
122			EIO_DT_CHR = 2,
123	root	1.22	EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
124	root	1.19	EIO_DT_DIR = 4,
125	root	1.21	EIO_DT_NAM = 5, /* xenix special named file */
126	root	1.19	EIO_DT_BLK = 6,
127	root	1.21	EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
128	root	1.19	EIO_DT_REG = 8,
129	root	1.21	EIO_DT_NWK = 9, /* HP-UX network special */
130			EIO_DT_CMP = 9, /* VxFS compressed */
131	root	1.19	EIO_DT_LNK = 10,
132	root	1.21	/* DT_SHAD = 11,*/
133	root	1.19	EIO_DT_SOCK = 12,
134	root	1.21	EIO_DT_DOOR = 13, /* solaris door */
135	root	1.19	EIO_DT_WHT = 14,
136	root	1.22	EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
137	root	1.19	};
138
139	root	1.27	struct eio_dirent
140			{
141	root	1.24	int nameofs; /* offset of null-terminated name string in (char )req->ptr2 /
142			unsigned short namelen; /* size of filename without trailing 0 */
143			unsigned char type; /* one of EIO_DT_* */
144	root	1.23	signed char score; /* internal use */
145	root	1.40	eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
146	root	1.19	};
147
148	root	1.25	/* eio_msync flags */
149	root	1.27	enum
150			{
151	root	1.25	EIO_MS_ASYNC = 1,
152			EIO_MS_INVALIDATE = 2,
153			EIO_MS_SYNC = 4
154			};
155
156			/* eio_mtouch flags */
157	root	1.27	enum
158			{
159	root	1.25	EIO_MT_MODIFY = 1
160			};
161
162	root	1.19	/* eio_sync_file_range flags */
163	root	1.27	enum
164			{
165	root	1.19	EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
166			EIO_SYNC_FILE_RANGE_WRITE = 2,
167			EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
168			};
169
170	root	1.37	/* eio_fallocate flags */
171			enum
172			{
173			EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
174			};
175
176			/* timestamps and differences - feel free to use double in your code directly */
177			typedef double eio_tstamp;
178	root	1.19
179			/* the eio request structure */
180	root	1.27	enum
181			{
182	root	1.16	EIO_CUSTOM,
183	root	1.46	EIO_WD_OPEN, EIO_WD_CLOSE,
184
185			EIO_CLOSE, EIO_DUP2,
186	root	1.1	EIO_READ, EIO_WRITE,
187			EIO_READAHEAD, EIO_SENDFILE,
188	root	1.46	EIO_FSTAT, EIO_FSTATVFS,
189			EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
190	root	1.44	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
191	root	1.37	EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
192	root	1.27	EIO_MLOCK, EIO_MLOCKALL,
193	root	1.46	EIO_GROUP, EIO_NOP,
194			EIO_BUSY,
195
196			/* these use wd + ptr1, but are emulated */
197			EIO_REALPATH,
198			EIO_STATVFS,
199			EIO_READDIR,
200
201			/* all the following requests use wd + ptr1 as path in xxxat functions */
202			EIO_OPEN,
203			EIO_STAT, EIO_LSTAT,
204			EIO_TRUNCATE,
205			EIO_UTIME,
206			EIO_CHMOD,
207			EIO_CHOWN,
208	root	1.1	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
209	root	1.46	EIO_MKNOD,
210			EIO_LINK, EIO_SYMLINK, EIO_READLINK,
211
212			EIO_REQ_TYPE_NUM
213	root	1.18	};
214
215	root	1.27	/* mlockall constants */
216			enum
217			{
218			EIO_MCL_CURRENT = 1,
219			EIO_MCL_FUTURE = 2,
220			};
221
222			/* request priorities */
223
224			enum {
225			EIO_PRI_MIN = -4,
226			EIO_PRI_MAX = 4,
227			EIO_PRI_DEFAULT = 0,
228			};
229
230	root	1.1	/* eio request structure */
231			/* this structure is mostly read-only */
232	root	1.19	/* when initialising it, all members must be zero-initialised */
233	root	1.1	struct eio_req
234			{
235	root	1.12	eio_req volatile next; / private ETP */
236	root	1.1
237	root	1.46	eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
238
239	root	1.39	eio_ssize_t result; /* result of syscall, e.g. result = read (... */
240	root	1.37	off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
241			size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
242	root	1.24	void ptr1; / all applicable requests: pathname, old name; readdir: optional eio_dirents */
243			void ptr2; / all applicable requests: new name or memory buffer; readdir: name strings */
244	root	1.2	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
245			eio_tstamp nv2; /* utime, futime: mtime */
246	root	1.1
247	root	1.12	int type; /* EIO_xxx constant ETP */
248	root	1.27	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
249	root	1.37	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
250	root	1.47	long int3; /* chown, fchown: gid; rename, link: working directory of new name */
251	root	1.1	int errorno; /* errno value on syscall return */
252
253	root	1.35	#if __i386 \|\| __amd64
254			unsigned char cancelled;
255			#else
256			sig_atomic_t cancelled;
257			#endif
258
259	root	1.1	unsigned char flags; /* private */
260	root	1.8	signed char pri; /* the priority */
261	root	1.1
262	root	1.8	void *data;
263	root	1.5	eio_cb finish;
264	root	1.30	void (destroy)(eio_req req); /* called when request no longer needed */
265	root	1.8	void (feed)(eio_req req); /* only used for group requests */
266	root	1.1
267	root	1.8	EIO_REQ_MEMBERS
268	root	1.1
269			eio_req grp, grp_prev, grp_next, grp_first; /* private */
270			};
271
272	root	1.27	/* _private_ request flags */
273	root	1.1	enum {
274	root	1.35	EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
275			EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
276			EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
277	root	1.1	};
278
279	root	1.27	/* undocumented/unsupported/private helper */
280			/void eio_page_align (void addr, size_t length);*/
281	root	1.1
282			/* returns < 0 on error, errno set
283			* need_poll, if non-zero, will be called when results are available
284			* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
285			* done_poll is called when the need to poll is gone.
286			*/
287			int eio_init (void (want_poll)(void), void (done_poll)(void));
288
289			/* must be called regularly to handle pending requests */
290			/* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
291			int eio_poll (void);
292
293			/* stop polling if poll took longer than duration seconds */
294			void eio_set_max_poll_time (eio_tstamp nseconds);
295			/* do not handle more then count requests in one call to eio_poll_cb */
296			void eio_set_max_poll_reqs (unsigned int nreqs);
297
298			/* set minimum required number
299			* maximum wanted number
300			* or maximum idle number of threads */
301			void eio_set_min_parallel (unsigned int nthreads);
302			void eio_set_max_parallel (unsigned int nthreads);
303			void eio_set_max_idle (unsigned int nthreads);
304	root	1.29	void eio_set_idle_timeout (unsigned int seconds);
305	root	1.1
306			unsigned int eio_nreqs (void); /* number of requests in-flight */
307			unsigned int eio_nready (void); /* number of not-yet handled requests */
308	sf-exg	1.36	unsigned int eio_npending (void); /* number of finished but unhandled requests */
309	root	1.1	unsigned int eio_nthreads (void); /* number of worker threads in use currently */
310
311			/*****************************************************************************/
312	root	1.31	/* convenience wrappers */
313	root	1.1
314	root	1.10	#ifndef EIO_NO_WRAPPERS
315	root	1.49	eio_req eio_wd_open (const char path, int pri, eio_cb cb, void data); / result=wd */
316			eio_req eio_wd_close (eio_wd wd, int pri, eio_cb cb, void data);
317	root	1.7	eio_req eio_nop (int pri, eio_cb cb, void data); /* does nothing except go through the whole process */
318			eio_req eio_busy (eio_tstamp delay, int pri, eio_cb cb, void data); /* ties a thread for this long, simulating busyness */
319			eio_req eio_sync (int pri, eio_cb cb, void data);
320			eio_req eio_fsync (int fd, int pri, eio_cb cb, void data);
321			eio_req eio_fdatasync (int fd, int pri, eio_cb cb, void data);
322	root	1.44	eio_req eio_syncfs (int fd, int pri, eio_cb cb, void data);
323	root	1.16	eio_req eio_msync (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
324			eio_req eio_mtouch (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
325	root	1.27	eio_req eio_mlock (void addr, size_t length, int pri, eio_cb cb, void *data);
326			eio_req eio_mlockall (int flags, int pri, eio_cb cb, void data);
327	root	1.18	eio_req eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void data);
328	root	1.37	eio_req eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void data);
329	root	1.7	eio_req eio_close (int fd, int pri, eio_cb cb, void data);
330			eio_req eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void data);
331			eio_req eio_read (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
332			eio_req eio_write (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
333			eio_req eio_fstat (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */
334	root	1.26	eio_req eio_fstatvfs (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */
335	root	1.7	eio_req eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void data);
336			eio_req eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void data);
337			eio_req eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void data);
338	root	1.41	eio_req eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void data);
339	root	1.7	eio_req eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void data);
340			eio_req eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void data);
341			eio_req eio_open (const char path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
342			eio_req eio_utime (const char path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
343			eio_req eio_truncate (const char path, off_t offset, int pri, eio_cb cb, void *data);
344	root	1.41	eio_req eio_chown (const char path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
345	root	1.7	eio_req eio_chmod (const char path, mode_t mode, int pri, eio_cb cb, void *data);
346			eio_req eio_mkdir (const char path, mode_t mode, int pri, eio_cb cb, void *data);
347	root	1.19	eio_req eio_readdir (const char path, int flags, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
348	root	1.7	eio_req eio_rmdir (const char path, int pri, eio_cb cb, void *data);
349			eio_req eio_unlink (const char path, int pri, eio_cb cb, void *data);
350			eio_req eio_readlink (const char path, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
351	root	1.33	eio_req eio_realpath (const char path, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
352	root	1.7	eio_req eio_stat (const char path, int pri, eio_cb cb, void data); / stat buffer=ptr2 allocated dynamically */
353			eio_req eio_lstat (const char path, int pri, eio_cb cb, void data); / stat buffer=ptr2 allocated dynamically */
354	root	1.26	eio_req eio_statvfs (const char path, int pri, eio_cb cb, void data); / stat buffer=ptr2 allocated dynamically */
355	root	1.7	eio_req eio_mknod (const char path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
356			eio_req eio_link (const char path, const char new_path, int pri, eio_cb cb, void data);
357			eio_req eio_symlink (const char path, const char new_path, int pri, eio_cb cb, void data);
358			eio_req eio_rename (const char path, const char new_path, int pri, eio_cb cb, void data);
359	root	1.32	eio_req eio_custom (void (execute)(eio_req ), int pri, eio_cb cb, void data);
360	root	1.10	#endif
361	root	1.1
362	root	1.11	/*****************************************************************************/
363			/* groups */
364
365	root	1.7	eio_req eio_grp (eio_cb cb, void data);
366	root	1.2	void eio_grp_feed (eio_req grp, void (feed)(eio_req *req), int limit);
367			void eio_grp_limit (eio_req *grp, int limit);
368	root	1.1	void eio_grp_add (eio_req grp, eio_req req);
369			void eio_grp_cancel (eio_req grp); / cancels all sub requests but not the group */
370
371	root	1.11	/*****************************************************************************/
372			/* request api */
373	root	1.6
374			/* true if the request was cancelled, useful in the invoke callback */
375	root	1.35	#define EIO_CANCELLED(req) ((req)->cancelled)
376	root	1.6
377	root	1.26	#define EIO_RESULT(req) ((req)->result)
378	root	1.6	/* returns a pointer to the result buffer allocated by eio */
379	root	1.26	#define EIO_BUF(req) ((req)->ptr2)
380			#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
381			#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
382			#define EIO_PATH(req) ((char *)(req)->ptr1)
383	root	1.6
384	root	1.1	/* submit a request for execution */
385			void eio_submit (eio_req *req);
386	root	1.11	/* cancel a request as soon fast as possible, if possible */
387			void eio_cancel (eio_req *req);
388	root	1.1
389	root	1.5	/*****************************************************************************/
390	root	1.34	/* convenience functions */
391	root	1.5
392	root	1.39	eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
393	root	1.5
394	root	1.14	#ifdef __cplusplus
395			}
396			#endif
397
398	root	1.1	#endif
399