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

Comparing libeio/eio.h (file contents):
Revision 1.26 by root, Thu Jan 7 18:08:21 2010 UTC vs.
Revision 1.35 by root, Tue Jul 5 20:34:42 2011 UTC

1/* 1/*
2 * libeio API header 2 * libeio API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libeio@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011 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 *
… …
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
47#include <stddef.h> 47#include <stddef.h>
48#include <signal.h>
48#include <sys/types.h> 49#include <sys/types.h>
49 50
50typedef struct eio_req eio_req; 51typedef struct eio_req eio_req;
51typedef struct eio_dirent eio_dirent; 52typedef struct eio_dirent eio_dirent;
52 53
… …
65#endif 66#endif
66 67
67/* for readdir */ 68/* for readdir */
68 69
69/* eio_readdir flags */ 70/* eio_readdir flags */
70enum { 71enum
72{
71 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ 73 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
72 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */ 74 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
73 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */ 75 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
74 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ 76 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
75 77
76 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ 78 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
77 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ 79 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
78}; 80};
79 81
80/* using "typical" values in the hope that the compiler will do something sensible */ 82/* using "typical" values in the hope that the compiler will do something sensible */
81enum eio_dtype { 83enum eio_dtype
84{
82 EIO_DT_UNKNOWN = 0, 85 EIO_DT_UNKNOWN = 0,
83 EIO_DT_FIFO = 1, 86 EIO_DT_FIFO = 1,
84 EIO_DT_CHR = 2, 87 EIO_DT_CHR = 2,
85 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ 88 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
86 EIO_DT_DIR = 4, 89 EIO_DT_DIR = 4,
… …
96 EIO_DT_DOOR = 13, /* solaris door */ 99 EIO_DT_DOOR = 13, /* solaris door */
97 EIO_DT_WHT = 14, 100 EIO_DT_WHT = 14,
98 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ 101 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
99}; 102};
100 103
101struct eio_dirent { 104struct eio_dirent
105{
102 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ 106 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
103 unsigned short namelen; /* size of filename without trailing 0 */ 107 unsigned short namelen; /* size of filename without trailing 0 */
104 unsigned char type; /* one of EIO_DT_* */ 108 unsigned char type; /* one of EIO_DT_* */
105 signed char score; /* internal use */ 109 signed char score; /* internal use */
106 ino_t inode; /* the inode number, if available, otherwise unspecified */ 110 ino_t inode; /* the inode number, if available, otherwise unspecified */
107}; 111};
108 112
109/* eio_msync flags */ 113/* eio_msync flags */
110enum { 114enum
115{
111 EIO_MS_ASYNC = 1, 116 EIO_MS_ASYNC = 1,
112 EIO_MS_INVALIDATE = 2, 117 EIO_MS_INVALIDATE = 2,
113 EIO_MS_SYNC = 4 118 EIO_MS_SYNC = 4
114}; 119};
115 120
116/* eio_mtouch flags */ 121/* eio_mtouch flags */
117 122
118enum { 123enum
124{
119 EIO_MT_MODIFY = 1 125 EIO_MT_MODIFY = 1
120}; 126};
121 127
122/* eio_sync_file_range flags */ 128/* eio_sync_file_range flags */
123 129
124enum { 130enum
131{
125 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 132 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
126 EIO_SYNC_FILE_RANGE_WRITE = 2, 133 EIO_SYNC_FILE_RANGE_WRITE = 2,
127 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 134 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
128}; 135};
129 136
130typedef double eio_tstamp; /* feel free to use double in your code directly */ 137typedef double eio_tstamp; /* feel free to use double in your code directly */
131 138
132/* the eio request structure */ 139/* the eio request structure */
133 140
134enum { 141enum
142{
135 EIO_CUSTOM, 143 EIO_CUSTOM,
136 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 144 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
137 EIO_READ, EIO_WRITE, 145 EIO_READ, EIO_WRITE,
138 EIO_READAHEAD, EIO_SENDFILE, 146 EIO_READAHEAD, EIO_SENDFILE,
139 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 147 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
… …
142 EIO_UTIME, EIO_FUTIME, 150 EIO_UTIME, EIO_FUTIME,
143 EIO_CHMOD, EIO_FCHMOD, 151 EIO_CHMOD, EIO_FCHMOD,
144 EIO_CHOWN, EIO_FCHOWN, 152 EIO_CHOWN, EIO_FCHOWN,
145 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 153 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
146 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 154 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
155 EIO_MLOCK, EIO_MLOCKALL,
147 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 156 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
148 EIO_MKNOD, EIO_READDIR, 157 EIO_MKNOD, EIO_READDIR,
149 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 158 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
150 EIO_GROUP, EIO_NOP, 159 EIO_GROUP, EIO_NOP,
151 EIO_BUSY 160 EIO_BUSY
161};
162
163/* mlockall constants */
164enum
165{
166 EIO_MCL_CURRENT = 1,
167 EIO_MCL_FUTURE = 2,
168};
169
170/* request priorities */
171
172enum {
173 EIO_PRI_MIN = -4,
174 EIO_PRI_MAX = 4,
175 EIO_PRI_DEFAULT = 0,
152}; 176};
153 177
154/* eio request structure */ 178/* eio request structure */
155/* this structure is mostly read-only */ 179/* this structure is mostly read-only */
156/* when initialising it, all members must be zero-initialised */ 180/* when initialising it, all members must be zero-initialised */
157struct eio_req 181struct eio_req
158{ 182{
159 eio_req volatile *next; /* private ETP */ 183 eio_req volatile *next; /* private ETP */
160 184
161 ssize_t result; /* result of syscall, e.g. result = read (... */ 185 ssize_t result; /* result of syscall, e.g. result = read (... */
162 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ 186 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */
163 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ 187 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */
164 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 188 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
165 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ 189 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
166 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 190 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
167 eio_tstamp nv2; /* utime, futime: mtime */ 191 eio_tstamp nv2; /* utime, futime: mtime */
168 192
169 int type; /* EIO_xxx constant ETP */ 193 int type; /* EIO_xxx constant ETP */
170 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ 194 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
171 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ 195 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
172 long int3; /* chown, fchown: gid; mknod: dev_t */ 196 long int3; /* chown, fchown: gid */
173 int errorno; /* errno value on syscall return */ 197 int errorno; /* errno value on syscall return */
198
199#if __i386 || __amd64
200 unsigned char cancelled;
201#else
202 sig_atomic_t cancelled;
203#endif
174 204
175 unsigned char flags; /* private */ 205 unsigned char flags; /* private */
176 signed char pri; /* the priority */ 206 signed char pri; /* the priority */
177 207
178 void *data; 208 void *data;
179 eio_cb finish; 209 eio_cb finish;
180 void (*destroy)(eio_req *req); /* called when requets no longer needed */ 210 void (*destroy)(eio_req *req); /* called when request no longer needed */
181 void (*feed)(eio_req *req); /* only used for group requests */ 211 void (*feed)(eio_req *req); /* only used for group requests */
182 212
183 EIO_REQ_MEMBERS 213 EIO_REQ_MEMBERS
184 214
185 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 215 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
186}; 216};
187 217
188/* _private_ flags */ 218/* _private_ request flags */
189enum { 219enum {
190 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
191 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 220 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
192 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 221 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
193 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 222 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
194}; 223};
195 224
196enum { 225/* undocumented/unsupported/private helper */
197 EIO_PRI_MIN = -4, 226/*void eio_page_align (void **addr, size_t *length);*/
198 EIO_PRI_MAX = 4,
199 EIO_PRI_DEFAULT = 0,
200};
201 227
202/* returns < 0 on error, errno set 228/* returns < 0 on error, errno set
203 * need_poll, if non-zero, will be called when results are available 229 * need_poll, if non-zero, will be called when results are available
204 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 230 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
205 * done_poll is called when the need to poll is gone. 231 * done_poll is called when the need to poll is gone.
… …
219 * maximum wanted number 245 * maximum wanted number
220 * or maximum idle number of threads */ 246 * or maximum idle number of threads */
221void eio_set_min_parallel (unsigned int nthreads); 247void eio_set_min_parallel (unsigned int nthreads);
222void eio_set_max_parallel (unsigned int nthreads); 248void eio_set_max_parallel (unsigned int nthreads);
223void eio_set_max_idle (unsigned int nthreads); 249void eio_set_max_idle (unsigned int nthreads);
250void eio_set_idle_timeout (unsigned int seconds);
224 251
225unsigned int eio_nreqs (void); /* number of requests in-flight */ 252unsigned int eio_nreqs (void); /* number of requests in-flight */
226unsigned int eio_nready (void); /* number of not-yet handled requests */ 253unsigned int eio_nready (void); /* number of not-yet handled requests */
227unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 254unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
228unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 255unsigned int eio_nthreads (void); /* number of worker threads in use currently */
229 256
230/*****************************************************************************/ 257/*****************************************************************************/
231/* convinience wrappers */ 258/* convenience wrappers */
232 259
233#ifndef EIO_NO_WRAPPERS 260#ifndef EIO_NO_WRAPPERS
234eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 261eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
235eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 262eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
236eio_req *eio_sync (int pri, eio_cb cb, void *data); 263eio_req *eio_sync (int pri, eio_cb cb, void *data);
237eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 264eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
238eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 265eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
239eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 266eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
240eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 267eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
268eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
269eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
241eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 270eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
242eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 271eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
243eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 272eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
244eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 273eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
245eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 274eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
… …
259eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 288eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
260eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 289eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
261eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 290eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
262eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 291eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
263eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 292eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
293eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
264eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 294eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
265eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 295eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
266eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 296eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
267eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 297eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
268eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 298eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
269eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 299eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
270eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 300eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
271eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); 301eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
272#endif 302#endif
273 303
274/*****************************************************************************/ 304/*****************************************************************************/
275/* groups */ 305/* groups */
276 306
… …
282 312
283/*****************************************************************************/ 313/*****************************************************************************/
284/* request api */ 314/* request api */
285 315
286/* true if the request was cancelled, useful in the invoke callback */ 316/* true if the request was cancelled, useful in the invoke callback */
287#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 317#define EIO_CANCELLED(req) ((req)->cancelled)
288 318
289#define EIO_RESULT(req) ((req)->result) 319#define EIO_RESULT(req) ((req)->result)
290/* returns a pointer to the result buffer allocated by eio */ 320/* returns a pointer to the result buffer allocated by eio */
291#define EIO_BUF(req) ((req)->ptr2) 321#define EIO_BUF(req) ((req)->ptr2)
292#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 322#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
… …
295 325
296/* submit a request for execution */ 326/* submit a request for execution */
297void eio_submit (eio_req *req); 327void eio_submit (eio_req *req);
298/* cancel a request as soon fast as possible, if possible */ 328/* cancel a request as soon fast as possible, if possible */
299void eio_cancel (eio_req *req); 329void eio_cancel (eio_req *req);
300/* destroy a request that has never been submitted */
301void eio_destroy (eio_req *req);
302 330
303/*****************************************************************************/ 331/*****************************************************************************/
304/* convinience functions */ 332/* convenience functions */
305 333
306ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 334ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
307 335
308#ifdef __cplusplus 336#ifdef __cplusplus
309} 337}

Diff Legend

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