libeio/eio.h

/*
 * libeio API header
 *
 * Copyright (c) 2007,2008,2009,2010 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 <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
# define EIO_STRUCT_STAT struct stat
#endif

/* 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 */
  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
};

typedef double eio_tstamp; /* feel free to use double in your code directly */

/* the eio request structure */

enum {
  EIO_CUSTOM,
  EIO_OPEN, EIO_CLOSE, EIO_DUP2,
  EIO_READ, EIO_WRITE,
  EIO_READAHEAD, EIO_SENDFILE,
  EIO_STAT, EIO_LSTAT, EIO_FSTAT,
  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_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
  EIO_MKNOD, EIO_READDIR,
  EIO_LINK, EIO_SYMLINK, EIO_READLINK,
  EIO_GROUP, EIO_NOP,
  EIO_BUSY
};

/* 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 */

  ssize_t result;  /* result of syscall, e.g. result = read (... */
  off_t offs;      /* read, write, truncate, readahead, sync_file_range: file offset */
  size_t size;     /* read, write, readahead, sendfile, msync, sync_file_range: 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, 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; mknod: dev_t */
  int errorno;     /* errno value on syscall return */

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

  void *data;
  eio_cb finish;
  void (*destroy)(eio_req *req); /* called when requets 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_ 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 */
};

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

/* 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);

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_nthreads (void); /* number of worker threads in use currently */

/*****************************************************************************/
/* convinience wrappers */

#ifndef EIO_NO_WRAPPERS
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_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_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, 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_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_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_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_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_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    (eio_cb execute, 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)->flags & EIO_FLAG_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_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);
/* destroy a request that has never been submitted */
void eio_destroy (eio_req *req);

/*****************************************************************************/
/* convinience functions */

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

#ifdef __cplusplus
}
#endif

#endif

Revision:	1.25
Committed:	Sat Jan 2 14:11:32 2010 UTC (14 years, 4 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-3_4
Changes since 1.24:	+14 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.12	/*
2			* libeio API header
3			*
4	root	1.25	* Copyright (c) 2007,2008,2009,2010 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.3	#include <sys/types.h>
49	root	1.1
50	root	1.19	typedef struct eio_req eio_req;
51			typedef struct eio_dirent eio_dirent;
52	root	1.1
53			typedef int (eio_cb)(eio_req req);
54
55	root	1.9	#ifndef EIO_REQ_MEMBERS
56			# define EIO_REQ_MEMBERS
57	root	1.1	#endif
58
59	root	1.6	#ifndef EIO_STRUCT_STAT
60			# define EIO_STRUCT_STAT struct stat
61			#endif
62
63	root	1.19	/* for readdir */
64
65			/* eio_readdir flags */
66			enum {
67			EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
68			EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
69			EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
70			EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when _ARRAY was set and any TYPE=UNKNOWN's were found /
71
72			EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
73			EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
74			};
75
76			/* using "typical" values in the hope that the compiler will do something sensible */
77			enum eio_dtype {
78			EIO_DT_UNKNOWN = 0,
79			EIO_DT_FIFO = 1,
80			EIO_DT_CHR = 2,
81	root	1.22	EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
82	root	1.19	EIO_DT_DIR = 4,
83	root	1.21	EIO_DT_NAM = 5, /* xenix special named file */
84	root	1.19	EIO_DT_BLK = 6,
85	root	1.21	EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
86	root	1.19	EIO_DT_REG = 8,
87	root	1.21	EIO_DT_NWK = 9, /* HP-UX network special */
88			EIO_DT_CMP = 9, /* VxFS compressed */
89	root	1.19	EIO_DT_LNK = 10,
90	root	1.21	/* DT_SHAD = 11,*/
91	root	1.19	EIO_DT_SOCK = 12,
92	root	1.21	EIO_DT_DOOR = 13, /* solaris door */
93	root	1.19	EIO_DT_WHT = 14,
94	root	1.22	EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
95	root	1.19	};
96
97			struct eio_dirent {
98	root	1.24	int nameofs; /* offset of null-terminated name string in (char )req->ptr2 /
99			unsigned short namelen; /* size of filename without trailing 0 */
100			unsigned char type; /* one of EIO_DT_* */
101	root	1.23	signed char score; /* internal use */
102	root	1.24	ino_t inode; /* the inode number, if available, otherwise unspecified */
103	root	1.19	};
104
105	root	1.25	/* eio_msync flags */
106			enum {
107			EIO_MS_ASYNC = 1,
108			EIO_MS_INVALIDATE = 2,
109			EIO_MS_SYNC = 4
110			};
111
112			/* eio_mtouch flags */
113
114			enum {
115			EIO_MT_MODIFY = 1
116			};
117
118	root	1.19	/* eio_sync_file_range flags */
119
120			enum {
121			EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
122			EIO_SYNC_FILE_RANGE_WRITE = 2,
123			EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
124			};
125
126			typedef double eio_tstamp; /* feel free to use double in your code directly */
127
128			/* the eio request structure */
129
130	root	1.1	enum {
131	root	1.16	EIO_CUSTOM,
132	root	1.1	EIO_OPEN, EIO_CLOSE, EIO_DUP2,
133			EIO_READ, EIO_WRITE,
134			EIO_READAHEAD, EIO_SENDFILE,
135			EIO_STAT, EIO_LSTAT, EIO_FSTAT,
136			EIO_TRUNCATE, EIO_FTRUNCATE,
137			EIO_UTIME, EIO_FUTIME,
138			EIO_CHMOD, EIO_FCHMOD,
139			EIO_CHOWN, EIO_FCHOWN,
140	root	1.18	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
141			EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
142	root	1.1	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
143			EIO_MKNOD, EIO_READDIR,
144			EIO_LINK, EIO_SYMLINK, EIO_READLINK,
145			EIO_GROUP, EIO_NOP,
146	root	1.18	EIO_BUSY
147			};
148
149	root	1.1	/* eio request structure */
150			/* this structure is mostly read-only */
151	root	1.19	/* when initialising it, all members must be zero-initialised */
152	root	1.1	struct eio_req
153			{
154	root	1.12	eio_req volatile next; / private ETP */
155	root	1.1
156			ssize_t result; /* result of syscall, e.g. result = read (... */
157	root	1.18	off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
158			size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
159	root	1.24	void ptr1; / all applicable requests: pathname, old name; readdir: optional eio_dirents */
160			void ptr2; / all applicable requests: new name or memory buffer; readdir: name strings */
161	root	1.2	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
162			eio_tstamp nv2; /* utime, futime: mtime */
163	root	1.1
164	root	1.12	int type; /* EIO_xxx constant ETP */
165	root	1.19	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
166	root	1.18	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
167	root	1.15	long int3; /* chown, fchown: gid; mknod: dev_t */
168	root	1.1	int errorno; /* errno value on syscall return */
169
170			unsigned char flags; /* private */
171	root	1.8	signed char pri; /* the priority */
172	root	1.1
173	root	1.8	void *data;
174	root	1.5	eio_cb finish;
175	root	1.8	void (destroy)(eio_req req); /* called when requets no longer needed */
176			void (feed)(eio_req req); /* only used for group requests */
177	root	1.1
178	root	1.8	EIO_REQ_MEMBERS
179	root	1.1
180			eio_req grp, grp_prev, grp_next, grp_first; /* private */
181			};
182
183	root	1.17	/* _private_ flags */
184	root	1.1	enum {
185			EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
186	root	1.5	EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
187	root	1.17	EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
188			EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
189	root	1.1	};
190
191			enum {
192			EIO_PRI_MIN = -4,
193			EIO_PRI_MAX = 4,
194	root	1.13	EIO_PRI_DEFAULT = 0,
195	root	1.1	};
196
197			/* returns < 0 on error, errno set
198			* need_poll, if non-zero, will be called when results are available
199			* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
200			* done_poll is called when the need to poll is gone.
201			*/
202			int eio_init (void (want_poll)(void), void (done_poll)(void));
203
204			/* must be called regularly to handle pending requests */
205			/* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
206			int eio_poll (void);
207
208			/* stop polling if poll took longer than duration seconds */
209			void eio_set_max_poll_time (eio_tstamp nseconds);
210			/* do not handle more then count requests in one call to eio_poll_cb */
211			void eio_set_max_poll_reqs (unsigned int nreqs);
212
213			/* set minimum required number
214			* maximum wanted number
215			* or maximum idle number of threads */
216			void eio_set_min_parallel (unsigned int nthreads);
217			void eio_set_max_parallel (unsigned int nthreads);
218			void eio_set_max_idle (unsigned int nthreads);
219
220			unsigned int eio_nreqs (void); /* number of requests in-flight */
221			unsigned int eio_nready (void); /* number of not-yet handled requests */
222			unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
223			unsigned int eio_nthreads (void); /* number of worker threads in use currently */
224
225			/*****************************************************************************/
226	root	1.11	/* convinience wrappers */
227	root	1.1
228	root	1.10	#ifndef EIO_NO_WRAPPERS
229	root	1.7	eio_req eio_nop (int pri, eio_cb cb, void data); /* does nothing except go through the whole process */
230			eio_req eio_busy (eio_tstamp delay, int pri, eio_cb cb, void data); /* ties a thread for this long, simulating busyness */
231			eio_req eio_sync (int pri, eio_cb cb, void data);
232			eio_req eio_fsync (int fd, int pri, eio_cb cb, void data);
233			eio_req eio_fdatasync (int fd, int pri, eio_cb cb, void data);
234	root	1.16	eio_req eio_msync (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
235			eio_req eio_mtouch (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
236	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);
237	root	1.7	eio_req eio_close (int fd, int pri, eio_cb cb, void data);
238			eio_req eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void data);
239			eio_req eio_read (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
240			eio_req eio_write (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
241			eio_req eio_fstat (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */
242			eio_req eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void data);
243			eio_req eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void data);
244			eio_req eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void data);
245			eio_req eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void data);
246			eio_req eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void data);
247			eio_req eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void data);
248			eio_req eio_open (const char path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
249			eio_req eio_utime (const char path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
250			eio_req eio_truncate (const char path, off_t offset, int pri, eio_cb cb, void *data);
251			eio_req eio_chown (const char path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
252			eio_req eio_chmod (const char path, mode_t mode, int pri, eio_cb cb, void *data);
253			eio_req eio_mkdir (const char path, mode_t mode, int pri, eio_cb cb, void *data);
254	root	1.19	eio_req eio_readdir (const char path, int flags, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
255	root	1.7	eio_req eio_rmdir (const char path, int pri, eio_cb cb, void *data);
256			eio_req eio_unlink (const char path, int pri, eio_cb cb, void *data);
257			eio_req eio_readlink (const char path, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
258			eio_req eio_stat (const char path, int pri, eio_cb cb, void data); / stat buffer=ptr2 allocated dynamically */
259			eio_req eio_lstat (const char path, int pri, eio_cb cb, void data); / stat buffer=ptr2 allocated dynamically */
260			eio_req eio_mknod (const char path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
261			eio_req eio_link (const char path, const char new_path, int pri, eio_cb cb, void data);
262			eio_req eio_symlink (const char path, const char new_path, int pri, eio_cb cb, void data);
263			eio_req eio_rename (const char path, const char new_path, int pri, eio_cb cb, void data);
264	root	1.13	eio_req eio_custom (eio_cb execute, int pri, eio_cb cb, void data);
265	root	1.10	#endif
266	root	1.1
267	root	1.11	/*****************************************************************************/
268			/* groups */
269
270	root	1.7	eio_req eio_grp (eio_cb cb, void data);
271	root	1.2	void eio_grp_feed (eio_req grp, void (feed)(eio_req *req), int limit);
272			void eio_grp_limit (eio_req *grp, int limit);
273	root	1.1	void eio_grp_add (eio_req grp, eio_req req);
274			void eio_grp_cancel (eio_req grp); / cancels all sub requests but not the group */
275
276	root	1.11	/*****************************************************************************/
277			/* request api */
278	root	1.6
279			/* true if the request was cancelled, useful in the invoke callback */
280			#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
281
282			#define EIO_RESULT(req) ((req)->result)
283			/* returns a pointer to the result buffer allocated by eio */
284			#define EIO_BUF(req) ((req)->ptr2)
285			#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
286			#define EIO_PATH(req) ((char *)(req)->ptr1)
287
288	root	1.1	/* submit a request for execution */
289			void eio_submit (eio_req *req);
290	root	1.11	/* cancel a request as soon fast as possible, if possible */
291			void eio_cancel (eio_req *req);
292			/* destroy a request that has never been submitted */
293			void eio_destroy (eio_req *req);
294	root	1.1
295	root	1.5	/*****************************************************************************/
296			/* convinience functions */
297
298	root	1.6	ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
299	root	1.5
300	root	1.14	#ifdef __cplusplus
301			}
302			#endif
303
304	root	1.1	#endif
305