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

Comparing libeio/eio.h (file contents):
Revision 1.31 by root, Sun Jun 5 22:44:30 2011 UTC vs.
Revision 1.37 by root, Thu Jul 7 22:36:18 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
… …
116 EIO_MS_INVALIDATE = 2, 117 EIO_MS_INVALIDATE = 2,
117 EIO_MS_SYNC = 4 118 EIO_MS_SYNC = 4
118}; 119};
119 120
120/* eio_mtouch flags */ 121/* eio_mtouch flags */
121
122enum 122enum
123{ 123{
124 EIO_MT_MODIFY = 1 124 EIO_MT_MODIFY = 1
125}; 125};
126 126
127/* eio_sync_file_range flags */ 127/* eio_sync_file_range flags */
128
129enum 128enum
130{ 129{
131 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 130 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
132 EIO_SYNC_FILE_RANGE_WRITE = 2, 131 EIO_SYNC_FILE_RANGE_WRITE = 2,
133 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 132 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
134}; 133};
135 134
136typedef double eio_tstamp; /* feel free to use double in your code directly */ 135/* eio_fallocate flags */
136enum
137{
138 EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
139};
140
141/* timestamps and differences - feel free to use double in your code directly */
142typedef double eio_tstamp;
137 143
138/* the eio request structure */ 144/* the eio request structure */
139
140enum 145enum
141{ 146{
142 EIO_CUSTOM, 147 EIO_CUSTOM,
143 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 148 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
144 EIO_READ, EIO_WRITE, 149 EIO_READ, EIO_WRITE,
… …
148 EIO_TRUNCATE, EIO_FTRUNCATE, 153 EIO_TRUNCATE, EIO_FTRUNCATE,
149 EIO_UTIME, EIO_FUTIME, 154 EIO_UTIME, EIO_FUTIME,
150 EIO_CHMOD, EIO_FCHMOD, 155 EIO_CHMOD, EIO_FCHMOD,
151 EIO_CHOWN, EIO_FCHOWN, 156 EIO_CHOWN, EIO_FCHOWN,
152 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 157 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
153 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 158 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
154 EIO_MLOCK, EIO_MLOCKALL, 159 EIO_MLOCK, EIO_MLOCKALL,
155 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 160 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
156 EIO_MKNOD, EIO_READDIR, 161 EIO_MKNOD, EIO_READDIR,
157 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 162 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
158 EIO_GROUP, EIO_NOP, 163 EIO_GROUP, EIO_NOP,
159 EIO_BUSY 164 EIO_BUSY
160}; 165};
161 166
162/* mlockall constants */ 167/* mlockall constants */
… …
180struct eio_req 185struct eio_req
181{ 186{
182 eio_req volatile *next; /* private ETP */ 187 eio_req volatile *next; /* private ETP */
183 188
184 ssize_t result; /* result of syscall, e.g. result = read (... */ 189 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 */ 190 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 */ 191 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 */ 192 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 */ 193 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
189 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 194 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
190 eio_tstamp nv2; /* utime, futime: mtime */ 195 eio_tstamp nv2; /* utime, futime: mtime */
191 196
192 int type; /* EIO_xxx constant ETP */ 197 int type; /* EIO_xxx constant ETP */
193 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 198 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 */ 199 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 */ 200 long int3; /* chown, fchown: gid */
196 int errorno; /* errno value on syscall return */ 201 int errorno; /* errno value on syscall return */
202
203#if __i386 || __amd64
204 unsigned char cancelled;
205#else
206 sig_atomic_t cancelled;
207#endif
197 208
198 unsigned char flags; /* private */ 209 unsigned char flags; /* private */
199 signed char pri; /* the priority */ 210 signed char pri; /* the priority */
200 211
201 void *data; 212 void *data;
… …
208 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 219 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
209}; 220};
210 221
211/* _private_ request flags */ 222/* _private_ request flags */
212enum { 223enum {
213 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
214 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 224 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
215 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 225 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
216 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 226 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
217}; 227};
218 228
219/* undocumented/unsupported/private helper */ 229/* undocumented/unsupported/private helper */
220/*void eio_page_align (void **addr, size_t *length);*/ 230/*void eio_page_align (void **addr, size_t *length);*/
221 231
… …
243void eio_set_max_idle (unsigned int nthreads); 253void eio_set_max_idle (unsigned int nthreads);
244void eio_set_idle_timeout (unsigned int seconds); 254void eio_set_idle_timeout (unsigned int seconds);
245 255
246unsigned int eio_nreqs (void); /* number of requests in-flight */ 256unsigned int eio_nreqs (void); /* number of requests in-flight */
247unsigned int eio_nready (void); /* number of not-yet handled requests */ 257unsigned int eio_nready (void); /* number of not-yet handled requests */
248unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 258unsigned int eio_npending (void); /* number of finished but unhandled requests */
249unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 259unsigned int eio_nthreads (void); /* number of worker threads in use currently */
250 260
251/*****************************************************************************/ 261/*****************************************************************************/
252/* convenience wrappers */ 262/* convenience wrappers */
253 263
… …
260eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 270eio_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); 271eio_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); 272eio_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); 273eio_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); 274eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
275eio_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); 276eio_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); 277eio_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); 278eio_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); 279eio_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 */ 280eio_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); 293eio_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 */ 294eio_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); 295eio_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); 296eio_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 */ 297eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
298eio_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 */ 299eio_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 */ 300eio_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 */ 301eio_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); 302eio_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); 303eio_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); 304eio_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); 305eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
294eio_req *eio_custom (void (*)(eio_req *) execute, int pri, eio_cb cb, void *data); 306eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
295#endif 307#endif
296 308
297/*****************************************************************************/ 309/*****************************************************************************/
298/* groups */ 310/* groups */
299 311
… …
305 317
306/*****************************************************************************/ 318/*****************************************************************************/
307/* request api */ 319/* request api */
308 320
309/* true if the request was cancelled, useful in the invoke callback */ 321/* true if the request was cancelled, useful in the invoke callback */
310#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 322#define EIO_CANCELLED(req) ((req)->cancelled)
311 323
312#define EIO_RESULT(req) ((req)->result) 324#define EIO_RESULT(req) ((req)->result)
313/* returns a pointer to the result buffer allocated by eio */ 325/* returns a pointer to the result buffer allocated by eio */
314#define EIO_BUF(req) ((req)->ptr2) 326#define EIO_BUF(req) ((req)->ptr2)
315#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 327#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
… …
318 330
319/* submit a request for execution */ 331/* submit a request for execution */
320void eio_submit (eio_req *req); 332void eio_submit (eio_req *req);
321/* cancel a request as soon fast as possible, if possible */ 333/* cancel a request as soon fast as possible, if possible */
322void eio_cancel (eio_req *req); 334void eio_cancel (eio_req *req);
323/* destroy a request that has never been submitted */
324void eio_destroy (eio_req *req);
325 335
326/*****************************************************************************/ 336/*****************************************************************************/
327/* convinience functions */ 337/* convenience functions */
328 338
329ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 339ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
330 340
331#ifdef __cplusplus 341#ifdef __cplusplus
332} 342}

Diff Legend

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