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

Comparing libeio/eio.h (file contents):
Revision 1.29 by root, Tue Feb 15 03:15:16 2011 UTC vs.
Revision 1.38 by root, Thu Jul 14 19:19:22 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
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
… …
116 EIO_MS_INVALIDATE = 2, 122 EIO_MS_INVALIDATE = 2,
117 EIO_MS_SYNC = 4 123 EIO_MS_SYNC = 4
118}; 124};
119 125
120/* eio_mtouch flags */ 126/* eio_mtouch flags */
121
122enum 127enum
123{ 128{
124 EIO_MT_MODIFY = 1 129 EIO_MT_MODIFY = 1
125}; 130};
126 131
127/* eio_sync_file_range flags */ 132/* eio_sync_file_range flags */
128
129enum 133enum
130{ 134{
131 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 135 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
132 EIO_SYNC_FILE_RANGE_WRITE = 2, 136 EIO_SYNC_FILE_RANGE_WRITE = 2,
133 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 137 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
134}; 138};
135 139
136typedef 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;
137 148
138/* the eio request structure */ 149/* the eio request structure */
139
140enum 150enum
141{ 151{
142 EIO_CUSTOM, 152 EIO_CUSTOM,
143 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 153 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
144 EIO_READ, EIO_WRITE, 154 EIO_READ, EIO_WRITE,
… …
148 EIO_TRUNCATE, EIO_FTRUNCATE, 158 EIO_TRUNCATE, EIO_FTRUNCATE,
149 EIO_UTIME, EIO_FUTIME, 159 EIO_UTIME, EIO_FUTIME,
150 EIO_CHMOD, EIO_FCHMOD, 160 EIO_CHMOD, EIO_FCHMOD,
151 EIO_CHOWN, EIO_FCHOWN, 161 EIO_CHOWN, EIO_FCHOWN,
152 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 162 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
153 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 163 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
154 EIO_MLOCK, EIO_MLOCKALL, 164 EIO_MLOCK, EIO_MLOCKALL,
155 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 165 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
156 EIO_MKNOD, EIO_READDIR, 166 EIO_MKNOD, EIO_READDIR,
157 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 167 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
158 EIO_GROUP, EIO_NOP, 168 EIO_GROUP, EIO_NOP,
159 EIO_BUSY 169 EIO_BUSY
160}; 170};
161 171
162/* mlockall constants */ 172/* mlockall constants */
… …
180struct eio_req 190struct eio_req
181{ 191{
182 eio_req volatile *next; /* private ETP */ 192 eio_req volatile *next; /* private ETP */
183 193
184 ssize_t result; /* result of syscall, e.g. result = read (... */ 194 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 */ 195 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 */ 196 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 */ 197 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 */ 198 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
189 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 199 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
190 eio_tstamp nv2; /* utime, futime: mtime */ 200 eio_tstamp nv2; /* utime, futime: mtime */
191 201
192 int type; /* EIO_xxx constant ETP */ 202 int type; /* EIO_xxx constant ETP */
193 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 203 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 */ 204 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 */ 205 long int3; /* chown, fchown: gid */
196 int errorno; /* errno value on syscall return */ 206 int errorno; /* errno value on syscall return */
197 207
208#if __i386 || __amd64
209 unsigned char cancelled;
210#else
211 sig_atomic_t cancelled;
212#endif
213
198 unsigned char flags; /* private */ 214 unsigned char flags; /* private */
199 signed char pri; /* the priority */ 215 signed char pri; /* the priority */
200 216
201 void *data; 217 void *data;
202 eio_cb finish; 218 eio_cb finish;
203 void (*destroy)(eio_req *req); /* called when requets no longer needed */ 219 void (*destroy)(eio_req *req); /* called when request no longer needed */
204 void (*feed)(eio_req *req); /* only used for group requests */ 220 void (*feed)(eio_req *req); /* only used for group requests */
205 221
206 EIO_REQ_MEMBERS 222 EIO_REQ_MEMBERS
207 223
208 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 224 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
209}; 225};
210 226
211/* _private_ request flags */ 227/* _private_ request flags */
212enum { 228enum {
213 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
214 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 229 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
215 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 230 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
216 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 231 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
217}; 232};
218 233
219/* undocumented/unsupported/private helper */ 234/* undocumented/unsupported/private helper */
220/*void eio_page_align (void **addr, size_t *length);*/ 235/*void eio_page_align (void **addr, size_t *length);*/
221 236
… …
243void eio_set_max_idle (unsigned int nthreads); 258void eio_set_max_idle (unsigned int nthreads);
244void eio_set_idle_timeout (unsigned int seconds); 259void eio_set_idle_timeout (unsigned int seconds);
245 260
246unsigned int eio_nreqs (void); /* number of requests in-flight */ 261unsigned int eio_nreqs (void); /* number of requests in-flight */
247unsigned int eio_nready (void); /* number of not-yet handled requests */ 262unsigned int eio_nready (void); /* number of not-yet handled requests */
248unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 263unsigned int eio_npending (void); /* number of finished but unhandled requests */
249unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 264unsigned int eio_nthreads (void); /* number of worker threads in use currently */
250 265
251/*****************************************************************************/ 266/*****************************************************************************/
252/* convinience wrappers */ 267/* convenience wrappers */
253 268
254#ifndef EIO_NO_WRAPPERS 269#ifndef EIO_NO_WRAPPERS
255eio_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 */
256eio_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 */
257eio_req *eio_sync (int pri, eio_cb cb, void *data); 272eio_req *eio_sync (int pri, eio_cb cb, void *data);
… …
260eio_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);
261eio_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);
262eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); 277eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
263eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 278eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
264eio_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);
265eio_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);
266eio_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);
267eio_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);
268eio_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);
269eio_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 */
… …
282eio_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);
283eio_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 */
284eio_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);
285eio_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);
286eio_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 */
287eio_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 */
288eio_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 */
289eio_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 */
290eio_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);
291eio_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);
292eio_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);
293eio_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);
294eio_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);
295#endif 312#endif
296 313
297/*****************************************************************************/ 314/*****************************************************************************/
298/* groups */ 315/* groups */
299 316
… …
305 322
306/*****************************************************************************/ 323/*****************************************************************************/
307/* request api */ 324/* request api */
308 325
309/* true if the request was cancelled, useful in the invoke callback */ 326/* true if the request was cancelled, useful in the invoke callback */
310#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 327#define EIO_CANCELLED(req) ((req)->cancelled)
311 328
312#define EIO_RESULT(req) ((req)->result) 329#define EIO_RESULT(req) ((req)->result)
313/* returns a pointer to the result buffer allocated by eio */ 330/* returns a pointer to the result buffer allocated by eio */
314#define EIO_BUF(req) ((req)->ptr2) 331#define EIO_BUF(req) ((req)->ptr2)
315#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 332#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
… …
318 335
319/* submit a request for execution */ 336/* submit a request for execution */
320void eio_submit (eio_req *req); 337void eio_submit (eio_req *req);
321/* cancel a request as soon fast as possible, if possible */ 338/* cancel a request as soon fast as possible, if possible */
322void eio_cancel (eio_req *req); 339void eio_cancel (eio_req *req);
323/* destroy a request that has never been submitted */
324void eio_destroy (eio_req *req);
325 340
326/*****************************************************************************/ 341/*****************************************************************************/
327/* convinience functions */ 342/* convenience functions */
328 343
329ssize_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);
330 345
331#ifdef __cplusplus 346#ifdef __cplusplus
332} 347}

Diff Legend

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