1 |
/* |
2 |
* libeio API header |
3 |
* |
4 |
* Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libeio@schmorp.de> |
5 |
* All rights reserved. |
6 |
* |
7 |
* Redistribution and use in source and binary forms, with or without modifica- |
8 |
* tion, are permitted provided that the following conditions are met: |
9 |
* |
10 |
* 1. Redistributions of source code must retain the above copyright notice, |
11 |
* this list of conditions and the following disclaimer. |
12 |
* |
13 |
* 2. Redistributions in binary form must reproduce the above copyright |
14 |
* notice, this list of conditions and the following disclaimer in the |
15 |
* documentation and/or other materials provided with the distribution. |
16 |
* |
17 |
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
18 |
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
19 |
* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
20 |
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
21 |
* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
22 |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
23 |
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
24 |
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
25 |
* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
26 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
27 |
* |
28 |
* Alternatively, the contents of this file may be used under the terms of |
29 |
* the GNU General Public License ("GPL") version 2 or any later version, |
30 |
* in which case the provisions of the GPL are applicable instead of |
31 |
* the above. If you wish to allow the use of your version of this file |
32 |
* only under the terms of the GPL and not to allow others to use your |
33 |
* version of this file under the BSD license, indicate your decision |
34 |
* by deleting the provisions above and replace them with the notice |
35 |
* and other provisions required by the GPL. If you do not delete the |
36 |
* provisions above, a recipient may use your version of this file under |
37 |
* either the BSD or the GPL. |
38 |
*/ |
39 |
|
40 |
#ifndef EIO_H_ |
41 |
#define EIO_H_ |
42 |
|
43 |
#ifdef __cplusplus |
44 |
extern "C" { |
45 |
#endif |
46 |
|
47 |
#include <stddef.h> |
48 |
#include <sys/types.h> |
49 |
|
50 |
typedef struct eio_req eio_req; |
51 |
typedef struct eio_dirent eio_dirent; |
52 |
|
53 |
typedef int (*eio_cb)(eio_req *req); |
54 |
|
55 |
#ifndef EIO_REQ_MEMBERS |
56 |
# define EIO_REQ_MEMBERS |
57 |
#endif |
58 |
|
59 |
#ifndef EIO_STRUCT_STAT |
60 |
# define EIO_STRUCT_STAT struct stat |
61 |
#endif |
62 |
|
63 |
#ifndef EIO_STRUCT_STATVFS |
64 |
# define EIO_STRUCT_STATVFS struct statvfs |
65 |
#endif |
66 |
|
67 |
/* for readdir */ |
68 |
|
69 |
/* eio_readdir flags */ |
70 |
enum |
71 |
{ |
72 |
EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
73 |
EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */ |
74 |
EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */ |
75 |
EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ |
76 |
|
77 |
EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
78 |
EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
79 |
}; |
80 |
|
81 |
/* using "typical" values in the hope that the compiler will do something sensible */ |
82 |
enum eio_dtype |
83 |
{ |
84 |
EIO_DT_UNKNOWN = 0, |
85 |
EIO_DT_FIFO = 1, |
86 |
EIO_DT_CHR = 2, |
87 |
EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
88 |
EIO_DT_DIR = 4, |
89 |
EIO_DT_NAM = 5, /* xenix special named file */ |
90 |
EIO_DT_BLK = 6, |
91 |
EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */ |
92 |
EIO_DT_REG = 8, |
93 |
EIO_DT_NWK = 9, /* HP-UX network special */ |
94 |
EIO_DT_CMP = 9, /* VxFS compressed */ |
95 |
EIO_DT_LNK = 10, |
96 |
/* DT_SHAD = 11,*/ |
97 |
EIO_DT_SOCK = 12, |
98 |
EIO_DT_DOOR = 13, /* solaris door */ |
99 |
EIO_DT_WHT = 14, |
100 |
EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
101 |
}; |
102 |
|
103 |
struct eio_dirent |
104 |
{ |
105 |
int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
106 |
unsigned short namelen; /* size of filename without trailing 0 */ |
107 |
unsigned char type; /* one of EIO_DT_* */ |
108 |
signed char score; /* internal use */ |
109 |
ino_t inode; /* the inode number, if available, otherwise unspecified */ |
110 |
}; |
111 |
|
112 |
/* eio_msync flags */ |
113 |
enum |
114 |
{ |
115 |
EIO_MS_ASYNC = 1, |
116 |
EIO_MS_INVALIDATE = 2, |
117 |
EIO_MS_SYNC = 4 |
118 |
}; |
119 |
|
120 |
/* eio_mtouch flags */ |
121 |
|
122 |
enum |
123 |
{ |
124 |
EIO_MT_MODIFY = 1 |
125 |
}; |
126 |
|
127 |
/* eio_sync_file_range flags */ |
128 |
|
129 |
enum |
130 |
{ |
131 |
EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
132 |
EIO_SYNC_FILE_RANGE_WRITE = 2, |
133 |
EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
134 |
}; |
135 |
|
136 |
typedef double eio_tstamp; /* feel free to use double in your code directly */ |
137 |
|
138 |
/* the eio request structure */ |
139 |
|
140 |
enum |
141 |
{ |
142 |
EIO_CUSTOM, |
143 |
EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
144 |
EIO_READ, EIO_WRITE, |
145 |
EIO_READAHEAD, EIO_SENDFILE, |
146 |
EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
147 |
EIO_STATVFS, EIO_FSTATVFS, |
148 |
EIO_TRUNCATE, EIO_FTRUNCATE, |
149 |
EIO_UTIME, EIO_FUTIME, |
150 |
EIO_CHMOD, EIO_FCHMOD, |
151 |
EIO_CHOWN, EIO_FCHOWN, |
152 |
EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
153 |
EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
154 |
EIO_MLOCK, EIO_MLOCKALL, |
155 |
EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
156 |
EIO_MKNOD, EIO_READDIR, |
157 |
EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
158 |
EIO_GROUP, EIO_NOP, |
159 |
EIO_BUSY |
160 |
}; |
161 |
|
162 |
/* mlockall constants */ |
163 |
enum |
164 |
{ |
165 |
EIO_MCL_CURRENT = 1, |
166 |
EIO_MCL_FUTURE = 2, |
167 |
}; |
168 |
|
169 |
/* request priorities */ |
170 |
|
171 |
enum { |
172 |
EIO_PRI_MIN = -4, |
173 |
EIO_PRI_MAX = 4, |
174 |
EIO_PRI_DEFAULT = 0, |
175 |
}; |
176 |
|
177 |
/* eio request structure */ |
178 |
/* this structure is mostly read-only */ |
179 |
/* when initialising it, all members must be zero-initialised */ |
180 |
struct eio_req |
181 |
{ |
182 |
eio_req volatile *next; /* private ETP */ |
183 |
|
184 |
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 */ |
186 |
size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ |
187 |
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 */ |
189 |
eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
190 |
eio_tstamp nv2; /* utime, futime: mtime */ |
191 |
|
192 |
int type; /* EIO_xxx constant ETP */ |
193 |
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 */ |
195 |
long int3; /* chown, fchown: gid */ |
196 |
int errorno; /* errno value on syscall return */ |
197 |
|
198 |
unsigned char flags; /* private */ |
199 |
signed char pri; /* the priority */ |
200 |
|
201 |
void *data; |
202 |
eio_cb finish; |
203 |
void (*destroy)(eio_req *req); /* called when requets no longer needed */ |
204 |
void (*feed)(eio_req *req); /* only used for group requests */ |
205 |
|
206 |
EIO_REQ_MEMBERS |
207 |
|
208 |
eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
209 |
}; |
210 |
|
211 |
/* _private_ request flags */ |
212 |
enum { |
213 |
EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
214 |
EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
215 |
EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ |
216 |
EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ |
217 |
}; |
218 |
|
219 |
/* undocumented/unsupported/private helper */ |
220 |
/*void eio_page_align (void **addr, size_t *length);*/ |
221 |
|
222 |
/* returns < 0 on error, errno set |
223 |
* need_poll, if non-zero, will be called when results are available |
224 |
* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). |
225 |
* done_poll is called when the need to poll is gone. |
226 |
*/ |
227 |
int eio_init (void (*want_poll)(void), void (*done_poll)(void)); |
228 |
|
229 |
/* must be called regularly to handle pending requests */ |
230 |
/* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */ |
231 |
int eio_poll (void); |
232 |
|
233 |
/* stop polling if poll took longer than duration seconds */ |
234 |
void eio_set_max_poll_time (eio_tstamp nseconds); |
235 |
/* do not handle more then count requests in one call to eio_poll_cb */ |
236 |
void eio_set_max_poll_reqs (unsigned int nreqs); |
237 |
|
238 |
/* set minimum required number |
239 |
* maximum wanted number |
240 |
* or maximum idle number of threads */ |
241 |
void eio_set_min_parallel (unsigned int nthreads); |
242 |
void eio_set_max_parallel (unsigned int nthreads); |
243 |
void eio_set_max_idle (unsigned int nthreads); |
244 |
|
245 |
unsigned int eio_nreqs (void); /* number of requests in-flight */ |
246 |
unsigned int eio_nready (void); /* number of not-yet handled requests */ |
247 |
unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ |
248 |
unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
249 |
|
250 |
/*****************************************************************************/ |
251 |
/* convinience wrappers */ |
252 |
|
253 |
#ifndef EIO_NO_WRAPPERS |
254 |
eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
255 |
eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
256 |
eio_req *eio_sync (int pri, eio_cb cb, void *data); |
257 |
eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
258 |
eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
259 |
eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
260 |
eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
261 |
eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
262 |
eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
263 |
eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
264 |
eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
265 |
eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
266 |
eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
267 |
eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
268 |
eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
269 |
eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
270 |
eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
271 |
eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
272 |
eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
273 |
eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
274 |
eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
275 |
eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); |
276 |
eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); |
277 |
eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
278 |
eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
279 |
eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
280 |
eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
281 |
eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
282 |
eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
283 |
eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
284 |
eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
285 |
eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
286 |
eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
287 |
eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
288 |
eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
289 |
eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
290 |
eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
291 |
eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
292 |
eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
293 |
eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); |
294 |
#endif |
295 |
|
296 |
/*****************************************************************************/ |
297 |
/* groups */ |
298 |
|
299 |
eio_req *eio_grp (eio_cb cb, void *data); |
300 |
void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); |
301 |
void eio_grp_limit (eio_req *grp, int limit); |
302 |
void eio_grp_add (eio_req *grp, eio_req *req); |
303 |
void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ |
304 |
|
305 |
/*****************************************************************************/ |
306 |
/* request api */ |
307 |
|
308 |
/* true if the request was cancelled, useful in the invoke callback */ |
309 |
#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
310 |
|
311 |
#define EIO_RESULT(req) ((req)->result) |
312 |
/* returns a pointer to the result buffer allocated by eio */ |
313 |
#define EIO_BUF(req) ((req)->ptr2) |
314 |
#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) |
315 |
#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req)) |
316 |
#define EIO_PATH(req) ((char *)(req)->ptr1) |
317 |
|
318 |
/* submit a request for execution */ |
319 |
void eio_submit (eio_req *req); |
320 |
/* cancel a request as soon fast as possible, if possible */ |
321 |
void eio_cancel (eio_req *req); |
322 |
/* destroy a request that has never been submitted */ |
323 |
void eio_destroy (eio_req *req); |
324 |
|
325 |
/*****************************************************************************/ |
326 |
/* convinience functions */ |
327 |
|
328 |
ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
329 |
|
330 |
#ifdef __cplusplus |
331 |
} |
332 |
#endif |
333 |
|
334 |
#endif |
335 |
|