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

Comparing libeio/eio.h (file contents):
Revision 1.35 by root, Tue Jul 5 20:34:42 2011 UTC vs.
Revision 1.51 by root, Wed Jul 25 16:12:28 2012 UTC

…		…
1	/*	1	/*
2	* libeio API header	2	* libeio API header
3	*	3	*
4	* Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libeio@schmorp.de>	4	* Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libeio@schmorp.de>
5	* All rights reserved.	5	* All rights reserved.
6	*	6	*
7	* Redistribution and use in source and binary forms, with or without modifica-	7	* Redistribution and use in source and binary forms, with or without modifica-
8	* tion, are permitted provided that the following conditions are met:	8	* tion, are permitted provided that the following conditions are met:
9	*	9	*
56	#ifndef EIO_REQ_MEMBERS	56	#ifndef EIO_REQ_MEMBERS
57	# define EIO_REQ_MEMBERS	57	# define EIO_REQ_MEMBERS
58	#endif	58	#endif
59		59
60	#ifndef EIO_STRUCT_STAT	60	#ifndef EIO_STRUCT_STAT
		61	# ifdef _WIN32
		62	# define EIO_STRUCT_STAT struct _stati64
		63	# define EIO_STRUCT_STATI64
		64	# else
61	# define EIO_STRUCT_STAT struct stat	65	# define EIO_STRUCT_STAT struct stat
		66	# endif
		67	#endif
		68
		69	#ifdef _WIN32
		70	typedef int eio_uid_t;
		71	typedef int eio_gid_t;
		72	#ifdef __MINGW32__ /* no intptr_t */
		73	typedef ssize_t eio_ssize_t;
		74	#else
		75	typedef intptr_t eio_ssize_t; /* or SSIZE_T */
		76	#endif
		77	#if __GNUC__
		78	typedef long long eio_ino_t; /* signed for compatibility to msvc */
		79	#else
		80	typedef __int64 eio_ino_t; /* unsigned not supported by msvc */
		81	#endif
		82	#else
		83	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;
62	#endif	87	#endif
63		88
64	#ifndef EIO_STRUCT_STATVFS	89	#ifndef EIO_STRUCT_STATVFS
65	# define EIO_STRUCT_STATVFS struct statvfs	90	# define EIO_STRUCT_STATVFS struct statvfs
66	#endif	91	#endif
		92
		93	/* managing working directories */
		94
		95	typedef struct eio_pwd *eio_wd;
		96
		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);
67		102
68	/* for readdir */	103	/* for readdir */
69		104
70	/* eio_readdir flags */	105	/* eio_readdir flags */
71	enum	106	enum
…		…
105	{	140	{
106	int nameofs; /* offset of null-terminated name string in (char )req->ptr2 /	141	int nameofs; /* offset of null-terminated name string in (char )req->ptr2 /
107	unsigned short namelen; /* size of filename without trailing 0 */	142	unsigned short namelen; /* size of filename without trailing 0 */
108	unsigned char type; /* one of EIO_DT_* */	143	unsigned char type; /* one of EIO_DT_* */
109	signed char score; /* internal use */	144	signed char score; /* internal use */
110	ino_t inode; /* the inode number, if available, otherwise unspecified */	145	eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
111	};	146	};
112		147
113	/* eio_msync flags */	148	/* eio_msync flags */
114	enum	149	enum
115	{	150	{
…		…
117	EIO_MS_INVALIDATE = 2,	152	EIO_MS_INVALIDATE = 2,
118	EIO_MS_SYNC = 4	153	EIO_MS_SYNC = 4
119	};	154	};
120		155
121	/* eio_mtouch flags */	156	/* eio_mtouch flags */
122
123	enum	157	enum
124	{	158	{
125	EIO_MT_MODIFY = 1	159	EIO_MT_MODIFY = 1
126	};	160	};
127		161
128	/* eio_sync_file_range flags */	162	/* eio_sync_file_range flags */
129
130	enum	163	enum
131	{	164	{
132	EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,	165	EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
133	EIO_SYNC_FILE_RANGE_WRITE = 2,	166	EIO_SYNC_FILE_RANGE_WRITE = 2,
134	EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4	167	EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
135	};	168	};
136		169
137	typedef double eio_tstamp; /* feel free to use double in your code directly */	170	/* eio_fallocate flags */
		171	enum
		172	{
		173	/* these MUST match the value in linux/falloc.h */
		174	EIO_FALLOC_FL_KEEP_SIZE = 1,
		175	EIO_FALLOC_FL_PUNCH_HOLE = 2
		176	};
		177
		178	/* timestamps and differences - feel free to use double in your code directly */
		179	typedef double eio_tstamp;
138		180
139	/* the eio request structure */	181	/* the eio request structure */
140
141	enum	182	enum
142	{	183	{
143	EIO_CUSTOM,	184	EIO_CUSTOM,
		185	EIO_WD_OPEN, EIO_WD_CLOSE,
		186
144	EIO_OPEN, EIO_CLOSE, EIO_DUP2,	187	EIO_CLOSE, EIO_DUP2,
145	EIO_READ, EIO_WRITE,	188	EIO_SEEK, EIO_READ, EIO_WRITE,
146	EIO_READAHEAD, EIO_SENDFILE,	189	EIO_READAHEAD, EIO_SENDFILE,
147	EIO_STAT, EIO_LSTAT, EIO_FSTAT,
148	EIO_STATVFS, EIO_FSTATVFS,	190	EIO_FSTAT, EIO_FSTATVFS,
149	EIO_TRUNCATE, EIO_FTRUNCATE,	191	EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
150	EIO_UTIME, EIO_FUTIME,
151	EIO_CHMOD, EIO_FCHMOD,
152	EIO_CHOWN, EIO_FCHOWN,
153	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,	192	EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
154	EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,	193	EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
155	EIO_MLOCK, EIO_MLOCKALL,	194	EIO_MLOCK, EIO_MLOCKALL,
		195	EIO_GROUP, EIO_NOP,
		196	EIO_BUSY,
		197
		198	/* these use wd + ptr1, but are emulated */
		199	EIO_REALPATH,
		200	EIO_STATVFS,
		201	EIO_READDIR,
		202
		203	/* all the following requests use wd + ptr1 as path in xxxat functions */
		204	EIO_OPEN,
		205	EIO_STAT, EIO_LSTAT,
		206	EIO_TRUNCATE,
		207	EIO_UTIME,
		208	EIO_CHMOD,
		209	EIO_CHOWN,
156	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,	210	EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
157	EIO_MKNOD, EIO_READDIR,	211	EIO_MKNOD,
158	EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,	212	EIO_LINK, EIO_SYMLINK, EIO_READLINK,
159	EIO_GROUP, EIO_NOP,	213
160	EIO_BUSY	214	EIO_REQ_TYPE_NUM
161	};	215	};
		216
		217	/* seek whence modes */
		218	/* these are guaranteed to hasve the traditional 0, 1, 2 values, */
		219	/* so you might as wlel use those */
		220	enum
		221	{
		222	EIO_SEEK_SET = 0,
		223	EIO_SEEK_CUR = 1,
		224	EIO_SEEK_END = 2
		225	};
		226
162		227
163	/* mlockall constants */	228	/* mlockall constants */
164	enum	229	enum
165	{	230	{
166	EIO_MCL_CURRENT = 1,	231	EIO_MCL_CURRENT = 1,
167	EIO_MCL_FUTURE = 2,	232	EIO_MCL_FUTURE = 2
168	};	233	};
169		234
170	/* request priorities */	235	/* request priorities */
171		236
172	enum {	237	enum {
173	EIO_PRI_MIN = -4,	238	EIO_PRI_MIN = -4,
174	EIO_PRI_MAX = 4,	239	EIO_PRI_MAX = 4,
175	EIO_PRI_DEFAULT = 0,	240	EIO_PRI_DEFAULT = 0
176	};	241	};
177		242
178	/* eio request structure */	243	/* eio request structure */
179	/* this structure is mostly read-only */	244	/* this structure is mostly read-only */
180	/* when initialising it, all members must be zero-initialised */	245	/* when initialising it, all members must be zero-initialised */
181	struct eio_req	246	struct eio_req
182	{	247	{
183	eio_req volatile next; / private ETP */	248	eio_req volatile next; / private ETP */
184		249
		250	eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
		251
185	ssize_t result; /* result of syscall, e.g. result = read (... */	252	eio_ssize_t result; /* result of syscall, e.g. result = read (... */
186	off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */	253	off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
187	size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */	254	size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
188	void ptr1; / all applicable requests: pathname, old name; readdir: optional eio_dirents */	255	void ptr1; / all applicable requests: pathname, old name; readdir: optional eio_dirents */
189	void ptr2; / all applicable requests: new name or memory buffer; readdir: name strings */	256	void ptr2; / all applicable requests: new name or memory buffer; readdir: name strings */
190	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */	257	eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
191	eio_tstamp nv2; /* utime, futime: mtime */	258	eio_tstamp nv2; /* utime, futime: mtime */
192		259
193	int type; /* EIO_xxx constant ETP */	260	int type; /* EIO_xxx constant ETP */
194	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */	261	int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
195	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */	262	long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */
196	long int3; /* chown, fchown: gid */	263	long int3; /* chown, fchown: gid; rename, link: working directory of new name */
197	int errorno; /* errno value on syscall return */	264	int errorno; /* errno value on syscall return */
198		265
199	#if __i386 \|\| __amd64	266	#if __i386 \|\| __amd64
200	unsigned char cancelled;	267	unsigned char cancelled;
201	#else	268	#else
…		…
249	void eio_set_max_idle (unsigned int nthreads);	316	void eio_set_max_idle (unsigned int nthreads);
250	void eio_set_idle_timeout (unsigned int seconds);	317	void eio_set_idle_timeout (unsigned int seconds);
251		318
252	unsigned int eio_nreqs (void); /* number of requests in-flight */	319	unsigned int eio_nreqs (void); /* number of requests in-flight */
253	unsigned int eio_nready (void); /* number of not-yet handled requests */	320	unsigned int eio_nready (void); /* number of not-yet handled requests */
254	unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */	321	unsigned int eio_npending (void); /* number of finished but unhandled requests */
255	unsigned int eio_nthreads (void); /* number of worker threads in use currently */	322	unsigned int eio_nthreads (void); /* number of worker threads in use currently */
256		323
257	/*****************************************************************************/	324	/*****************************************************************************/
258	/* convenience wrappers */	325	/* convenience wrappers */
259		326
260	#ifndef EIO_NO_WRAPPERS	327	#ifndef EIO_NO_WRAPPERS
		328	eio_req eio_wd_open (const char path, int pri, eio_cb cb, void data); / result=wd */
		329	eio_req eio_wd_close (eio_wd wd, int pri, eio_cb cb, void data);
261	eio_req eio_nop (int pri, eio_cb cb, void data); /* does nothing except go through the whole process */	330	eio_req eio_nop (int pri, eio_cb cb, void data); /* does nothing except go through the whole process */
262	eio_req eio_busy (eio_tstamp delay, int pri, eio_cb cb, void data); /* ties a thread for this long, simulating busyness */	331	eio_req eio_busy (eio_tstamp delay, int pri, eio_cb cb, void data); /* ties a thread for this long, simulating busyness */
263	eio_req eio_sync (int pri, eio_cb cb, void data);	332	eio_req eio_sync (int pri, eio_cb cb, void data);
264	eio_req eio_fsync (int fd, int pri, eio_cb cb, void data);	333	eio_req eio_fsync (int fd, int pri, eio_cb cb, void data);
265	eio_req eio_fdatasync (int fd, int pri, eio_cb cb, void data);	334	eio_req eio_fdatasync (int fd, int pri, eio_cb cb, void data);
		335	eio_req eio_syncfs (int fd, int pri, eio_cb cb, void data);
266	eio_req eio_msync (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);	336	eio_req eio_msync (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
267	eio_req eio_mtouch (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);	337	eio_req eio_mtouch (void addr, size_t length, int flags, int pri, eio_cb cb, void *data);
268	eio_req eio_mlock (void addr, size_t length, int pri, eio_cb cb, void *data);	338	eio_req eio_mlock (void addr, size_t length, int pri, eio_cb cb, void *data);
269	eio_req eio_mlockall (int flags, int pri, eio_cb cb, void data);	339	eio_req eio_mlockall (int flags, int pri, eio_cb cb, void data);
270	eio_req eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void data);	340	eio_req eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void data);
		341	eio_req eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void data);
271	eio_req eio_close (int fd, int pri, eio_cb cb, void data);	342	eio_req eio_close (int fd, int pri, eio_cb cb, void data);
272	eio_req eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void data);	343	eio_req eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void data);
		344	eio_req eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void data);
273	eio_req eio_read (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);	345	eio_req eio_read (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
274	eio_req eio_write (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);	346	eio_req eio_write (int fd, void buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
275	eio_req eio_fstat (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */	347	eio_req eio_fstat (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */
276	eio_req eio_fstatvfs (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */	348	eio_req eio_fstatvfs (int fd, int pri, eio_cb cb, void data); /* stat buffer=ptr2 allocated dynamically */
277	eio_req eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void data);	349	eio_req eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void data);
278	eio_req eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void data);	350	eio_req eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void data);
279	eio_req eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void data);	351	eio_req eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void data);
280	eio_req eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void data);	352	eio_req eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void data);
281	eio_req eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void data);	353	eio_req eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void data);
282	eio_req eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void data);	354	eio_req eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void data);
283	eio_req eio_open (const char path, int flags, mode_t mode, int pri, eio_cb cb, void *data);	355	eio_req eio_open (const char path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
284	eio_req eio_utime (const char path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);	356	eio_req eio_utime (const char path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
285	eio_req eio_truncate (const char path, off_t offset, int pri, eio_cb cb, void *data);	357	eio_req eio_truncate (const char path, off_t offset, int pri, eio_cb cb, void *data);
286	eio_req eio_chown (const char path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);	358	eio_req eio_chown (const char path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
287	eio_req eio_chmod (const char path, mode_t mode, int pri, eio_cb cb, void *data);	359	eio_req eio_chmod (const char path, mode_t mode, int pri, eio_cb cb, void *data);
288	eio_req eio_mkdir (const char path, mode_t mode, int pri, eio_cb cb, void *data);	360	eio_req eio_mkdir (const char path, mode_t mode, int pri, eio_cb cb, void *data);
289	eio_req eio_readdir (const char path, int flags, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */	361	eio_req eio_readdir (const char path, int flags, int pri, eio_cb cb, void data); / result=ptr2 allocated dynamically */
290	eio_req eio_rmdir (const char path, int pri, eio_cb cb, void *data);	362	eio_req eio_rmdir (const char path, int pri, eio_cb cb, void *data);
291	eio_req eio_unlink (const char path, int pri, eio_cb cb, void *data);	363	eio_req eio_unlink (const char path, int pri, eio_cb cb, void *data);
…		…
329	void eio_cancel (eio_req *req);	401	void eio_cancel (eio_req *req);
330		402
331	/*****************************************************************************/	403	/*****************************************************************************/
332	/* convenience functions */	404	/* convenience functions */
333		405
334	ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);	406	eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
335		407
336	#ifdef __cplusplus	408	#ifdef __cplusplus
337	}	409	}
338	#endif	410	#endif
339		411

Diff Legend

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

Comparing libeio/eio.h (file contents): Revision 1.35 by root, Tue Jul 5 20:34:42 2011 UTC vs. Revision 1.51 by root, Wed Jul 25 16:12:28 2012 UTC

Diff Legend

Comparing libeio/eio.h (file contents):
Revision 1.35 by root, Tue Jul 5 20:34:42 2011 UTC vs.
Revision 1.51 by root, Wed Jul 25 16:12:28 2012 UTC