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

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

Diff Legend

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