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

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

Diff Legend

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