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

Diff Legend

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