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

Comparing libeio/eio.h (file contents):
Revision 1.4 by root, Sun May 11 13:05:10 2008 UTC vs.
Revision 1.51 by root, Wed Jul 25 16:12:28 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines