[ViewVC] Diff of: cvs/libeio/eio.h

Comparing libeio/eio.h (file contents):
Revision 1.1 by root, Sat May 10 17:16:39 2008 UTC vs.
Revision 1.25 by root, Sat Jan 2 14:11:32 2010 UTC

…		…
		1	/*
		2	* libeio API header
		3	*
		4	* Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libeio@schmorp.de>
		5	* 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
1	#ifndef EIO_H_	40	#ifndef EIO_H_
2	#define EIO_H_	41	#define EIO_H_
3		42
		43	#ifdef __cplusplus
		44	extern "C" {
		45	#endif
		46
4	#include <stddef.h>	47	#include <stddef.h>
5	#include <stdlib.h>	48	#include <sys/types.h>
6		49
7	typedef struct eio_req eio_req;	50	typedef struct eio_req eio_req;
		51	typedef struct eio_dirent eio_dirent;
8		52
9	typedef int (eio_cb)(eio_req req);	53	typedef int (eio_cb)(eio_req req);
10		54
11	#ifndef EIO_COMMON	55	#ifndef EIO_REQ_MEMBERS
12	# define EIO_COMMON \	56	# define EIO_REQ_MEMBERS
13	eio_cb finish; \
14	void (destroy)(eio_req req);\
15	void *data
16	#endif	57	#endif
17		58
		59	#ifndef EIO_STRUCT_STAT
		60	# define EIO_STRUCT_STAT struct stat
		61	#endif
		62
		63	/* for readdir */
		64
		65	/* eio_readdir flags */
18	enum {	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	EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
		82	EIO_DT_DIR = 4,
		83	EIO_DT_NAM = 5, /* xenix special named file */
		84	EIO_DT_BLK = 6,
		85	EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
		86	EIO_DT_REG = 8,
		87	EIO_DT_NWK = 9, /* HP-UX network special */
		88	EIO_DT_CMP = 9, /* VxFS compressed */
		89	EIO_DT_LNK = 10,
		90	/* DT_SHAD = 11,*/
		91	EIO_DT_SOCK = 12,
		92	EIO_DT_DOOR = 13, /* solaris door */
		93	EIO_DT_WHT = 14,
		94	EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
		95	};
		96
		97	struct eio_dirent {
		98	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	signed char score; /* internal use */
		102	ino_t inode; /* the inode number, if available, otherwise unspecified */
		103	};
		104
		105	/* 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	/* 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	enum {
19	EIO_QUIT,	131	EIO_CUSTOM,
20	EIO_OPEN, EIO_CLOSE, EIO_DUP2,	132	EIO_OPEN, EIO_CLOSE, EIO_DUP2,
21	EIO_READ, EIO_WRITE,	133	EIO_READ, EIO_WRITE,
22	EIO_READAHEAD, EIO_SENDFILE,	134	EIO_READAHEAD, EIO_SENDFILE,
23	EIO_STAT, EIO_LSTAT, EIO_FSTAT,	135	EIO_STAT, EIO_LSTAT, EIO_FSTAT,
24	EIO_TRUNCATE, EIO_FTRUNCATE,	136	EIO_TRUNCATE, EIO_FTRUNCATE,
25	EIO_UTIME, EIO_FUTIME,	137	EIO_UTIME, EIO_FUTIME,
26	EIO_CHMOD, EIO_FCHMOD,	138	EIO_CHMOD, EIO_FCHMOD,
27	EIO_CHOWN, EIO_FCHOWN,	139	EIO_CHOWN, EIO_FCHOWN,
28	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,	140	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
		141	EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
29	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,	142	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
30	EIO_MKNOD, EIO_READDIR,	143	EIO_MKNOD, EIO_READDIR,
31	EIO_LINK, EIO_SYMLINK, EIO_READLINK,	144	EIO_LINK, EIO_SYMLINK, EIO_READLINK,
32	EIO_GROUP, EIO_NOP,	145	EIO_GROUP, EIO_NOP,
33	EIO_BUSY,	146	EIO_BUSY
34	};	147	};
35
36	typedef double eio_tstamp; /* feel free to use double in your code directly */
37		148
38	/* eio request structure */	149	/* eio request structure */
39	/* this structure is mostly read-only */	150	/* this structure is mostly read-only */
		151	/* when initialising it, all members must be zero-initialised */
40	struct eio_req	152	struct eio_req
41	{	153	{
42	eio_req volatile next; / private */	154	eio_req volatile next; / private ETP */
43		155
44	ssize_t result; /* result of syscall, e.g. result = read (... */	156	ssize_t result; /* result of syscall, e.g. result = read (... */
45	off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */	157	off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
46	size_t size; /* read, write, readahead, sendfile: length */	158	size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
47	void ptr1; / all applicable requests: pathname, old name */	159	void ptr1; / all applicable requests: pathname, old name; readdir: optional eio_dirents */
48	void ptr2; / all applicable requests: new name or memory buffer */	160	void ptr2; / all applicable requests: new name or memory buffer; readdir: name strings */
49	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */	161	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
50	eio_tstamp nv2; /* utime, futime: mtime */	162	eio_tstamp nv2; /* utime, futime: mtime */
51		163
52	int type; /* EIO_xxx constant */	164	int type; /* EIO_xxx constant ETP */
53	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */	165	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
54	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */	166	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
55	long int3; /* chown, fchown: gid */	167	long int3; /* chown, fchown: gid; mknod: dev_t */
56	int errorno; /* errno value on syscall return */	168	int errorno; /* errno value on syscall return */
57		169
58	unsigned char flags; /* private */	170	unsigned char flags; /* private */
59	unsigned char pri; /* the priority */	171	signed char pri; /* the priority */
60		172
61	void (feed)(eio_req req);	173	void *data;
		174	eio_cb finish;
		175	void (destroy)(eio_req req); /* called when requets no longer needed */
		176	void (feed)(eio_req req); /* only used for group requests */
62		177
63	EIO_COMMON;	178	EIO_REQ_MEMBERS
64		179
65	eio_req grp, grp_prev, grp_next, grp_first; /* private */	180	eio_req grp, grp_prev, grp_next, grp_first; /* private */
66	};	181	};
67		182
		183	/* _private_ flags */
68	enum {	184	enum {
69	EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */	185	EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
		186	EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
70	EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */	187	EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
		188	EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
71	};	189	};
72		190
73	enum {	191	enum {
74	EIO_PRI_MIN = -4,	192	EIO_PRI_MIN = -4,
75	EIO_PRI_MAX = 4,	193	EIO_PRI_MAX = 4,
76
77	EIO_DEFAULT_PRI = 0,	194	EIO_PRI_DEFAULT = 0,
78	EIO_PRI_BIAS = -EIO_PRI_MIN,
79	EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1,
80	};	195	};
81		196
82	/* returns < 0 on error, errno set	197	/* returns < 0 on error, errno set
83	* need_poll, if non-zero, will be called when results are available	198	* need_poll, if non-zero, will be called when results are available
84	* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).	199	* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
92		207
93	/* stop polling if poll took longer than duration seconds */	208	/* stop polling if poll took longer than duration seconds */
94	void eio_set_max_poll_time (eio_tstamp nseconds);	209	void eio_set_max_poll_time (eio_tstamp nseconds);
95	/* do not handle more then count requests in one call to eio_poll_cb */	210	/* do not handle more then count requests in one call to eio_poll_cb */
96	void eio_set_max_poll_reqs (unsigned int nreqs);	211	void eio_set_max_poll_reqs (unsigned int nreqs);
97	/* when != 0, then eio_submit blocks as long as nready > count */
98	void eio_set_max_outstanding (unsigned int maxreqs);
99	/* set maxinum number of idle threads */
100	void eio_set_max_idle (unsigned int nthreads);
101		212
102	/* set minimum required number	213	/* set minimum required number
103	* maximum wanted number	214	* maximum wanted number
104	* or maximum idle number of threads */	215	* or maximum idle number of threads */
105	void eio_set_min_parallel (unsigned int nthreads);	216	void eio_set_min_parallel (unsigned int nthreads);
…		…
110	unsigned int eio_nready (void); /* number of not-yet handled requests */	221	unsigned int eio_nready (void); /* number of not-yet handled requests */
111	unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */	222	unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
112	unsigned int eio_nthreads (void); /* number of worker threads in use currently */	223	unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113		224
114	/*****************************************************************************/	225	/*****************************************************************************/
115	/* high-level request API */	226	/* convinience wrappers */
116		227
117	eio_req *eio_fsync (int fd, eio_cb cb);	228	#ifndef EIO_NO_WRAPPERS
118	eio_req *eio_fdatasync (int fd, eio_cb cb);	229	eio_req eio_nop (int pri, eio_cb cb, void data); /* does nothing except go through the whole process */
119	eio_req *eio_dupclose (int fd, eio_cb cb);
120	eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb);
121	eio_req eio_read (int fd, off_t offs, size_t length, char data, eio_cb cb);
122	eio_req eio_write (int fd, off_t offs, size_t length, char data, eio_cb cb);
123	eio_req eio_fstat (int fd, eio_cb cb); / stat buffer=ptr2 allocates dynamically */
124	eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
125	eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb);
126	eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb);
127	eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb);
128	eio_req *eio_dup2 (int fd, int fd2, eio_cb cb);
129	eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb);
130	eio_req eio_open (const char path, int flags, mode_t mode, eio_cb cb);
131	eio_req eio_readlink (const char path, eio_cb cb); /* result=ptr2 allocated dynamically */
132	eio_req eio_stat (const char path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
133	eio_req eio_lstat (const char path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
134	eio_req eio_utime (const char path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
135	eio_req eio_truncate (const char path, off_t offset, eio_cb cb);
136	eio_req eio_chmod (const char path, mode_t mode, eio_cb cb);
137	eio_req eio_mkdir (const char path, mode_t mode, eio_cb cb);
138	eio_req eio_chown (const char path, uid_t uid, gid_t gid, eio_cb cb);
139	eio_req eio_unlink (const char path, eio_cb cb);
140	eio_req eio_rmdir (const char path, eio_cb cb);
141	eio_req eio_readdir (const char path, eio_cb cb); /* result=ptr2 allocated dynamically */
142	eio_req eio_mknod (const char path, mode_t mode, dev_t dev, eio_cb cb);
143	eio_req eio_busy (eio_tstamp delay, eio_cb cb); / ties a thread for this long, simulating busyness */	230	eio_req eio_busy (eio_tstamp delay, int pri, eio_cb cb, void data); /* ties a thread for this long, simulating busyness */
144	eio_req eio_nop (eio_cb cb); / does nothing except go through the whole process */	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	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	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	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	eio_req eio_readdir (const char path, int flags, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
		255	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	eio_req eio_custom (eio_cb execute, int pri, eio_cb cb, void data);
		265	#endif
145		266
		267	/*****************************************************************************/
146	/* for groups */	268	/* groups */
		269
147	eio_req *eio_grp (eio_cb cb);	270	eio_req eio_grp (eio_cb cb, void data);
148	void eio_grp_feed (eio_req grp, int limit, void (feed)(eio_req *req));	271	void eio_grp_feed (eio_req grp, void (feed)(eio_req *req), int limit);
		272	void eio_grp_limit (eio_req *grp, int limit);
149	void eio_grp_add (eio_req grp, eio_req req);	273	void eio_grp_add (eio_req grp, eio_req req);
150	void eio_grp_cancel (eio_req grp); / cancels all sub requests but not the group */	274	void eio_grp_cancel (eio_req grp); / cancels all sub requests but not the group */
151		275
152	/*****************************************************************************/	276	/*****************************************************************************/
153	/* low-level request API */	277	/* request api */
154
155	/* must be used to initialise eio_req's */
156	#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
157	memset ((req), 0, sizeof (eio_req)); \
158	(req)->pri = (prio) + EIO_PRI_BIAS; \
159	(req)->finish = (finish_cb); \
160	(req)->destroy = (destroy_cb)
161		278
162	/* true if the request was cancelled, useful in the invoke callback */	279	/* true if the request was cancelled, useful in the invoke callback */
163	#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)	280	#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
164		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
165	/* submit a request for execution */	288	/* submit a request for execution */
166	void eio_submit (eio_req *req);	289	void eio_submit (eio_req *req);
167	/* cancel a request as soon fast as possible */	290	/* cancel a request as soon fast as possible, if possible */
168	void eio_cancel (eio_req *req);	291	void eio_cancel (eio_req *req);
169	/* destroy a request that has never been submitted */	292	/* destroy a request that has never been submitted */
170	void eio_destroy (eio_req *req);	293	void eio_destroy (eio_req *req);
171		294
172	#endif	295	/*****************************************************************************/
		296	/* convinience functions */
173		297
		298	ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
		299
		300	#ifdef __cplusplus
		301	}
		302	#endif
		303
		304	#endif
		305

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing libeio/eio.h (file contents): Revision 1.1 by root, Sat May 10 17:16:39 2008 UTC vs. Revision 1.25 by root, Sat Jan 2 14:11:32 2010 UTC

Diff Legend

Comparing libeio/eio.h (file contents):
Revision 1.1 by root, Sat May 10 17:16:39 2008 UTC vs.
Revision 1.25 by root, Sat Jan 2 14:11:32 2010 UTC