ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
(Generate patch)

Comparing libeio/eio.h (file contents):
Revision 1.1 by root, Sat May 10 17:16:39 2008 UTC vs.
Revision 1.44 by root, Sun Jul 24 03:32:54 2011 UTC

1/*
2 * libeio API header
3 *
4 * Copyright (c) 2007,2008,2009,2010,2011 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
44extern "C" {
45#endif
46
4#include <stddef.h> 47#include <stddef.h>
5#include <stdlib.h> 48#include <signal.h>
49#include <sys/types.h>
6 50
7typedef struct eio_req eio_req; 51typedef struct eio_req eio_req;
52typedef struct eio_dirent eio_dirent;
8 53
9typedef int (*eio_cb)(eio_req *req); 54typedef int (*eio_cb)(eio_req *req);
10 55
11#ifndef EIO_COMMON 56#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON \ 57# define EIO_REQ_MEMBERS
13 eio_cb finish; \ 58#endif
14 void (*destroy)(eio_req *req);\ 59
15 void *data 60#ifndef EIO_STRUCT_STAT
61# ifdef _WIN32
62# define EIO_STRUCT_STAT struct _stati64
63# define EIO_STRUCT_STATI64
64# else
65# define EIO_STRUCT_STAT struct stat
16#endif 66# endif
67#endif
17 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;
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;
87#endif
88
89#ifndef EIO_STRUCT_STATVFS
90# define EIO_STRUCT_STATVFS struct statvfs
91#endif
92
93/* for readdir */
94
95/* eio_readdir flags */
18enum { 96enum
97{
98 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
99 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
100 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
101 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
102
103 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
104 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
105};
106
107/* using "typical" values in the hope that the compiler will do something sensible */
108enum eio_dtype
109{
110 EIO_DT_UNKNOWN = 0,
111 EIO_DT_FIFO = 1,
112 EIO_DT_CHR = 2,
113 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
114 EIO_DT_DIR = 4,
115 EIO_DT_NAM = 5, /* xenix special named file */
116 EIO_DT_BLK = 6,
117 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
118 EIO_DT_REG = 8,
119 EIO_DT_NWK = 9, /* HP-UX network special */
120 EIO_DT_CMP = 9, /* VxFS compressed */
121 EIO_DT_LNK = 10,
122 /* DT_SHAD = 11,*/
123 EIO_DT_SOCK = 12,
124 EIO_DT_DOOR = 13, /* solaris door */
125 EIO_DT_WHT = 14,
126 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
127};
128
129struct eio_dirent
130{
131 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
132 unsigned short namelen; /* size of filename without trailing 0 */
133 unsigned char type; /* one of EIO_DT_* */
134 signed char score; /* internal use */
135 eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
136};
137
138/* eio_msync flags */
139enum
140{
141 EIO_MS_ASYNC = 1,
142 EIO_MS_INVALIDATE = 2,
143 EIO_MS_SYNC = 4
144};
145
146/* eio_mtouch flags */
147enum
148{
149 EIO_MT_MODIFY = 1
150};
151
152/* eio_sync_file_range flags */
153enum
154{
155 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
156 EIO_SYNC_FILE_RANGE_WRITE = 2,
157 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
158};
159
160/* eio_fallocate flags */
161enum
162{
163 EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
164};
165
166/* timestamps and differences - feel free to use double in your code directly */
167typedef double eio_tstamp;
168
169/* the eio request structure */
170enum
171{
19 EIO_QUIT, 172 EIO_CUSTOM,
20 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 173 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
21 EIO_READ, EIO_WRITE, 174 EIO_READ, EIO_WRITE,
22 EIO_READAHEAD, EIO_SENDFILE, 175 EIO_READAHEAD, EIO_SENDFILE,
23 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 176 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
177 EIO_STATVFS, EIO_FSTATVFS,
24 EIO_TRUNCATE, EIO_FTRUNCATE, 178 EIO_TRUNCATE, EIO_FTRUNCATE,
25 EIO_UTIME, EIO_FUTIME, 179 EIO_UTIME, EIO_FUTIME,
26 EIO_CHMOD, EIO_FCHMOD, 180 EIO_CHMOD, EIO_FCHMOD,
27 EIO_CHOWN, EIO_FCHOWN, 181 EIO_CHOWN, EIO_FCHOWN,
28 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 182 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
183 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
184 EIO_MLOCK, EIO_MLOCKALL,
29 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 185 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
30 EIO_MKNOD, EIO_READDIR, 186 EIO_MKNOD, EIO_READDIR,
31 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 187 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
32 EIO_GROUP, EIO_NOP, 188 EIO_GROUP, EIO_NOP,
33 EIO_BUSY, 189 EIO_BUSY
34}; 190};
35 191
36typedef double eio_tstamp; /* feel free to use double in your code directly */ 192/* mlockall constants */
37
38/* eio request structure */
39/* this structure is mostly read-only */
40struct eio_req
41{
42 eio_req volatile *next; /* private */
43
44 ssize_t result; /* result of syscall, e.g. result = read (... */
45 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */
46 size_t size; /* read, write, readahead, sendfile: length */
47 void *ptr1; /* all applicable requests: pathname, old name */
48 void *ptr2; /* all applicable requests: new name or memory buffer */
49 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
50 eio_tstamp nv2; /* utime, futime: mtime */
51
52 int type; /* EIO_xxx constant */
53 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */
54 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
55 long int3; /* chown, fchown: gid */
56 int errorno; /* errno value on syscall return */
57
58 unsigned char flags; /* private */
59 unsigned char pri; /* the priority */
60
61 void (*feed)(eio_req *req);
62
63 EIO_COMMON;
64
65 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
66};
67
68enum { 193enum
69 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 194{
70 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 195 EIO_MCL_CURRENT = 1,
196 EIO_MCL_FUTURE = 2,
71}; 197};
198
199/* request priorities */
72 200
73enum { 201enum {
74 EIO_PRI_MIN = -4, 202 EIO_PRI_MIN = -4,
75 EIO_PRI_MAX = 4, 203 EIO_PRI_MAX = 4,
76
77 EIO_DEFAULT_PRI = 0, 204 EIO_PRI_DEFAULT = 0,
78 EIO_PRI_BIAS = -EIO_PRI_MIN,
79 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1,
80}; 205};
206
207/* eio request structure */
208/* this structure is mostly read-only */
209/* when initialising it, all members must be zero-initialised */
210struct eio_req
211{
212 eio_req volatile *next; /* private ETP */
213
214 eio_ssize_t result; /* result of syscall, e.g. result = read (... */
215 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
216 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
217 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
218 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
219 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
220 eio_tstamp nv2; /* utime, futime: mtime */
221
222 int type; /* EIO_xxx constant ETP */
223 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
224 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
225 long int3; /* chown, fchown: gid */
226 int errorno; /* errno value on syscall return */
227
228#if __i386 || __amd64
229 unsigned char cancelled;
230#else
231 sig_atomic_t cancelled;
232#endif
233
234 unsigned char flags; /* private */
235 signed char pri; /* the priority */
236
237 void *data;
238 eio_cb finish;
239 void (*destroy)(eio_req *req); /* called when request no longer needed */
240 void (*feed)(eio_req *req); /* only used for group requests */
241
242 EIO_REQ_MEMBERS
243
244 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
245};
246
247/* _private_ request flags */
248enum {
249 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
250 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
251 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
252};
253
254/* undocumented/unsupported/private helper */
255/*void eio_page_align (void **addr, size_t *length);*/
81 256
82/* returns < 0 on error, errno set 257/* returns < 0 on error, errno set
83 * need_poll, if non-zero, will be called when results are available 258 * 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). 259 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
85 * done_poll is called when the need to poll is gone. 260 * done_poll is called when the need to poll is gone.
92 267
93/* stop polling if poll took longer than duration seconds */ 268/* stop polling if poll took longer than duration seconds */
94void eio_set_max_poll_time (eio_tstamp nseconds); 269void eio_set_max_poll_time (eio_tstamp nseconds);
95/* do not handle more then count requests in one call to eio_poll_cb */ 270/* do not handle more then count requests in one call to eio_poll_cb */
96void eio_set_max_poll_reqs (unsigned int nreqs); 271void eio_set_max_poll_reqs (unsigned int nreqs);
97/* when != 0, then eio_submit blocks as long as nready > count */
98void eio_set_max_outstanding (unsigned int maxreqs);
99/* set maxinum number of idle threads */
100void eio_set_max_idle (unsigned int nthreads);
101 272
102/* set minimum required number 273/* set minimum required number
103 * maximum wanted number 274 * maximum wanted number
104 * or maximum idle number of threads */ 275 * or maximum idle number of threads */
105void eio_set_min_parallel (unsigned int nthreads); 276void eio_set_min_parallel (unsigned int nthreads);
106void eio_set_max_parallel (unsigned int nthreads); 277void eio_set_max_parallel (unsigned int nthreads);
107void eio_set_max_idle (unsigned int nthreads); 278void eio_set_max_idle (unsigned int nthreads);
279void eio_set_idle_timeout (unsigned int seconds);
108 280
109unsigned int eio_nreqs (void); /* number of requests in-flight */ 281unsigned int eio_nreqs (void); /* number of requests in-flight */
110unsigned int eio_nready (void); /* number of not-yet handled requests */ 282unsigned int eio_nready (void); /* number of not-yet handled requests */
111unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 283unsigned int eio_npending (void); /* number of finished but unhandled requests */
112unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 284unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113 285
114/*****************************************************************************/ 286/*****************************************************************************/
115/* high-level request API */ 287/* convenience wrappers */
116 288
117eio_req *eio_fsync (int fd, eio_cb cb); 289#ifndef EIO_NO_WRAPPERS
118eio_req *eio_fdatasync (int fd, eio_cb cb); 290eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
119eio_req *eio_dupclose (int fd, eio_cb cb);
120eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb);
121eio_req *eio_read (int fd, off_t offs, size_t length, char *data, eio_cb cb);
122eio_req *eio_write (int fd, off_t offs, size_t length, char *data, eio_cb cb);
123eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
124eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
125eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb);
126eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb);
127eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb);
128eio_req *eio_dup2 (int fd, int fd2, eio_cb cb);
129eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb);
130eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb);
131eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
132eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
133eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
134eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
135eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb);
136eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb);
137eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb);
138eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb);
139eio_req *eio_unlink (const char *path, eio_cb cb);
140eio_req *eio_rmdir (const char *path, eio_cb cb);
141eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
142eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb);
143eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ 291eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
144eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 292eio_req *eio_sync (int pri, eio_cb cb, void *data);
293eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
294eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
295eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data);
296eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
297eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
298eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
299eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
300eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
301eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
302eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
303eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
304eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
305eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
306eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
307eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
308eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
309eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
310eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
311eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
312eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
313eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
314eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
315eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
316eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
317eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
318eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
319eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
320eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
321eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
322eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
323eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
324eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
325eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
326eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
327eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
328eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
329eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
330eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
331eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
332eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
333#endif
145 334
335/*****************************************************************************/
146/* for groups */ 336/* groups */
337
147eio_req *eio_grp (eio_cb cb); 338eio_req *eio_grp (eio_cb cb, void *data);
148void eio_grp_feed (eio_req *grp, int limit, void (*feed)(eio_req *req)); 339void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
340void eio_grp_limit (eio_req *grp, int limit);
149void eio_grp_add (eio_req *grp, eio_req *req); 341void eio_grp_add (eio_req *grp, eio_req *req);
150void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 342void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
151 343
152/*****************************************************************************/ 344/*****************************************************************************/
153/* low-level request API */ 345/* 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 346
162/* true if the request was cancelled, useful in the invoke callback */ 347/* true if the request was cancelled, useful in the invoke callback */
163#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 348#define EIO_CANCELLED(req) ((req)->cancelled)
349
350#define EIO_RESULT(req) ((req)->result)
351/* returns a pointer to the result buffer allocated by eio */
352#define EIO_BUF(req) ((req)->ptr2)
353#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
354#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
355#define EIO_PATH(req) ((char *)(req)->ptr1)
164 356
165/* submit a request for execution */ 357/* submit a request for execution */
166void eio_submit (eio_req *req); 358void eio_submit (eio_req *req);
167/* cancel a request as soon fast as possible */ 359/* cancel a request as soon fast as possible, if possible */
168void eio_cancel (eio_req *req); 360void eio_cancel (eio_req *req);
169/* destroy a request that has never been submitted */
170void eio_destroy (eio_req *req);
171 361
172#endif 362/*****************************************************************************/
363/* convenience functions */
173 364
365eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
366
367#ifdef __cplusplus
368}
369#endif
370
371#endif
372

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines