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

Comparing libeio/eio.h (file contents):
Revision 1.28 by root, Fri Feb 11 00:53:24 2011 UTC vs.
Revision 1.40 by root, Sun Jul 17 04:20:04 2011 UTC

… …
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
… …
55#ifndef EIO_REQ_MEMBERS 56#ifndef EIO_REQ_MEMBERS
56# define EIO_REQ_MEMBERS 57# define EIO_REQ_MEMBERS
57#endif 58#endif
58 59
59#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
60# 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 typedef intptr_t eio_ssize_t; /* or SSIZE_T */
73 #if __GNUC__
74 typedef long long eio_ino_t;
75 #else
76 typedef __int64 eio_ino_t; /* unsigned not supported by msvc */
77 #endif
78#else
79 typedef uid_t eio_uid_t;
80 typedef gid_t eio_gid_t;
81 typedef ssize_t eio_ssize_t;
82 typedef ino_t eio_ino_t;
61#endif 83#endif
62 84
63#ifndef EIO_STRUCT_STATVFS 85#ifndef EIO_STRUCT_STATVFS
64# define EIO_STRUCT_STATVFS struct statvfs 86# define EIO_STRUCT_STATVFS struct statvfs
65#endif 87#endif
… …
104{ 126{
105 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ 127 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
106 unsigned short namelen; /* size of filename without trailing 0 */ 128 unsigned short namelen; /* size of filename without trailing 0 */
107 unsigned char type; /* one of EIO_DT_* */ 129 unsigned char type; /* one of EIO_DT_* */
108 signed char score; /* internal use */ 130 signed char score; /* internal use */
109 ino_t inode; /* the inode number, if available, otherwise unspecified */ 131 eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
110}; 132};
111 133
112/* eio_msync flags */ 134/* eio_msync flags */
113enum 135enum
114{ 136{
… …
116 EIO_MS_INVALIDATE = 2, 138 EIO_MS_INVALIDATE = 2,
117 EIO_MS_SYNC = 4 139 EIO_MS_SYNC = 4
118}; 140};
119 141
120/* eio_mtouch flags */ 142/* eio_mtouch flags */
121
122enum 143enum
123{ 144{
124 EIO_MT_MODIFY = 1 145 EIO_MT_MODIFY = 1
125}; 146};
126 147
127/* eio_sync_file_range flags */ 148/* eio_sync_file_range flags */
128
129enum 149enum
130{ 150{
131 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 151 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
132 EIO_SYNC_FILE_RANGE_WRITE = 2, 152 EIO_SYNC_FILE_RANGE_WRITE = 2,
133 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 153 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
134}; 154};
135 155
136typedef double eio_tstamp; /* feel free to use double in your code directly */ 156/* eio_fallocate flags */
157enum
158{
159 EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
160};
161
162/* timestamps and differences - feel free to use double in your code directly */
163typedef double eio_tstamp;
137 164
138/* the eio request structure */ 165/* the eio request structure */
139
140enum 166enum
141{ 167{
142 EIO_CUSTOM, 168 EIO_CUSTOM,
143 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 169 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
144 EIO_READ, EIO_WRITE, 170 EIO_READ, EIO_WRITE,
… …
148 EIO_TRUNCATE, EIO_FTRUNCATE, 174 EIO_TRUNCATE, EIO_FTRUNCATE,
149 EIO_UTIME, EIO_FUTIME, 175 EIO_UTIME, EIO_FUTIME,
150 EIO_CHMOD, EIO_FCHMOD, 176 EIO_CHMOD, EIO_FCHMOD,
151 EIO_CHOWN, EIO_FCHOWN, 177 EIO_CHOWN, EIO_FCHOWN,
152 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 178 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
153 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 179 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
154 EIO_MLOCK, EIO_MLOCKALL, 180 EIO_MLOCK, EIO_MLOCKALL,
155 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 181 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
156 EIO_MKNOD, EIO_READDIR, 182 EIO_MKNOD, EIO_READDIR,
157 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 183 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
158 EIO_GROUP, EIO_NOP, 184 EIO_GROUP, EIO_NOP,
159 EIO_BUSY 185 EIO_BUSY
160}; 186};
161 187
162/* mlockall constants */ 188/* mlockall constants */
… …
179/* when initialising it, all members must be zero-initialised */ 205/* when initialising it, all members must be zero-initialised */
180struct eio_req 206struct eio_req
181{ 207{
182 eio_req volatile *next; /* private ETP */ 208 eio_req volatile *next; /* private ETP */
183 209
184 ssize_t result; /* result of syscall, e.g. result = read (... */ 210 eio_ssize_t result; /* result of syscall, e.g. result = read (... */
185 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */ 211 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
186 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ 212 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
187 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 213 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
188 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ 214 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
189 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 215 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
190 eio_tstamp nv2; /* utime, futime: mtime */ 216 eio_tstamp nv2; /* utime, futime: mtime */
191 217
192 int type; /* EIO_xxx constant ETP */ 218 int type; /* EIO_xxx constant ETP */
193 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 219 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
194 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ 220 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
195 long int3; /* chown, fchown: gid */ 221 long int3; /* chown, fchown: gid */
196 int errorno; /* errno value on syscall return */ 222 int errorno; /* errno value on syscall return */
197 223
224#if __i386 || __amd64
225 unsigned char cancelled;
226#else
227 sig_atomic_t cancelled;
228#endif
229
198 unsigned char flags; /* private */ 230 unsigned char flags; /* private */
199 signed char pri; /* the priority */ 231 signed char pri; /* the priority */
200 232
201 void *data; 233 void *data;
202 eio_cb finish; 234 eio_cb finish;
203 void (*destroy)(eio_req *req); /* called when requets no longer needed */ 235 void (*destroy)(eio_req *req); /* called when request no longer needed */
204 void (*feed)(eio_req *req); /* only used for group requests */ 236 void (*feed)(eio_req *req); /* only used for group requests */
205 237
206 EIO_REQ_MEMBERS 238 EIO_REQ_MEMBERS
207 239
208 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 240 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
209}; 241};
210 242
211/* _private_ request flags */ 243/* _private_ request flags */
212enum { 244enum {
213 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
214 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 245 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
215 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 246 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
216 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 247 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
217}; 248};
218 249
219/* undocumented/unsupported/private helper */ 250/* undocumented/unsupported/private helper */
220/*void eio_page_align (void **addr, size_t *length);*/ 251/*void eio_page_align (void **addr, size_t *length);*/
221 252
… …
239 * maximum wanted number 270 * maximum wanted number
240 * or maximum idle number of threads */ 271 * or maximum idle number of threads */
241void eio_set_min_parallel (unsigned int nthreads); 272void eio_set_min_parallel (unsigned int nthreads);
242void eio_set_max_parallel (unsigned int nthreads); 273void eio_set_max_parallel (unsigned int nthreads);
243void eio_set_max_idle (unsigned int nthreads); 274void eio_set_max_idle (unsigned int nthreads);
275void eio_set_idle_timeout (unsigned int seconds);
244 276
245unsigned int eio_nreqs (void); /* number of requests in-flight */ 277unsigned int eio_nreqs (void); /* number of requests in-flight */
246unsigned int eio_nready (void); /* number of not-yet handled requests */ 278unsigned int eio_nready (void); /* number of not-yet handled requests */
247unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 279unsigned int eio_npending (void); /* number of finished but unhandled requests */
248unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 280unsigned int eio_nthreads (void); /* number of worker threads in use currently */
249 281
250/*****************************************************************************/ 282/*****************************************************************************/
251/* convinience wrappers */ 283/* convenience wrappers */
252 284
253#ifndef EIO_NO_WRAPPERS 285#ifndef EIO_NO_WRAPPERS
254eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 286eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
255eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 287eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
256eio_req *eio_sync (int pri, eio_cb cb, void *data); 288eio_req *eio_sync (int pri, eio_cb cb, void *data);
… …
259eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 291eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
260eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 292eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
261eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); 293eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
262eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 294eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
263eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 295eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
296eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
264eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 297eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
265eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 298eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
266eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 299eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
267eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 300eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
268eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 301eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
… …
281eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 314eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
282eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 315eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
283eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 316eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
284eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 317eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
285eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 318eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
319eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
286eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 320eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
287eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 321eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
288eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 322eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
289eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 323eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
290eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 324eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
291eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 325eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
292eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 326eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
293eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); 327eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
294#endif 328#endif
295 329
296/*****************************************************************************/ 330/*****************************************************************************/
297/* groups */ 331/* groups */
298 332
… …
304 338
305/*****************************************************************************/ 339/*****************************************************************************/
306/* request api */ 340/* request api */
307 341
308/* true if the request was cancelled, useful in the invoke callback */ 342/* true if the request was cancelled, useful in the invoke callback */
309#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 343#define EIO_CANCELLED(req) ((req)->cancelled)
310 344
311#define EIO_RESULT(req) ((req)->result) 345#define EIO_RESULT(req) ((req)->result)
312/* returns a pointer to the result buffer allocated by eio */ 346/* returns a pointer to the result buffer allocated by eio */
313#define EIO_BUF(req) ((req)->ptr2) 347#define EIO_BUF(req) ((req)->ptr2)
314#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 348#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
… …
317 351
318/* submit a request for execution */ 352/* submit a request for execution */
319void eio_submit (eio_req *req); 353void eio_submit (eio_req *req);
320/* cancel a request as soon fast as possible, if possible */ 354/* cancel a request as soon fast as possible, if possible */
321void eio_cancel (eio_req *req); 355void eio_cancel (eio_req *req);
322/* destroy a request that has never been submitted */
323void eio_destroy (eio_req *req);
324 356
325/*****************************************************************************/ 357/*****************************************************************************/
326/* convinience functions */ 358/* convenience functions */
327 359
328ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 360eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
329 361
330#ifdef __cplusplus 362#ifdef __cplusplus
331} 363}
332#endif 364#endif
333 365

Diff Legend

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