1 |
/* |
2 |
* libeio API header |
3 |
* |
4 |
* Copyright (c) 2007,2008,2009 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 |
/* for readdir */ |
64 |
|
65 |
/* eio_readdir flags */ |
66 |
enum { |
67 |
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 */ |
69 |
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 */ |
71 |
|
72 |
EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
73 |
EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
74 |
}; |
75 |
|
76 |
/* using "typical" values in the hope that the compiler will do something sensible */ |
77 |
enum eio_dtype { |
78 |
EIO_DT_UNKNOWN = 0, |
79 |
EIO_DT_FIFO = 1, |
80 |
EIO_DT_CHR = 2, |
81 |
EIO_DT_DIR = 4, |
82 |
EIO_DT_BLK = 6, |
83 |
EIO_DT_REG = 8, |
84 |
EIO_DT_LNK = 10, |
85 |
EIO_DT_SOCK = 12, |
86 |
EIO_DT_WHT = 14, |
87 |
EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
88 |
}; |
89 |
|
90 |
struct eio_dirent { |
91 |
char *name; |
92 |
ino_t inode; |
93 |
unsigned short namelen; |
94 |
unsigned char type; |
95 |
unsigned char score; /* internal use */ |
96 |
/* 0-4 bytes padding */ |
97 |
}; |
98 |
|
99 |
/* eio_sync_file_range flags */ |
100 |
|
101 |
enum { |
102 |
EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
103 |
EIO_SYNC_FILE_RANGE_WRITE = 2, |
104 |
EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
105 |
}; |
106 |
|
107 |
typedef double eio_tstamp; /* feel free to use double in your code directly */ |
108 |
|
109 |
/* the eio request structure */ |
110 |
|
111 |
enum { |
112 |
EIO_CUSTOM, |
113 |
EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
114 |
EIO_READ, EIO_WRITE, |
115 |
EIO_READAHEAD, EIO_SENDFILE, |
116 |
EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
117 |
EIO_TRUNCATE, EIO_FTRUNCATE, |
118 |
EIO_UTIME, EIO_FUTIME, |
119 |
EIO_CHMOD, EIO_FCHMOD, |
120 |
EIO_CHOWN, EIO_FCHOWN, |
121 |
EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
122 |
EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
123 |
EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
124 |
EIO_MKNOD, EIO_READDIR, |
125 |
EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
126 |
EIO_GROUP, EIO_NOP, |
127 |
EIO_BUSY |
128 |
}; |
129 |
|
130 |
/* eio request structure */ |
131 |
/* this structure is mostly read-only */ |
132 |
/* when initialising it, all members must be zero-initialised */ |
133 |
struct eio_req |
134 |
{ |
135 |
eio_req volatile *next; /* private ETP */ |
136 |
|
137 |
ssize_t result; /* result of syscall, e.g. result = read (... */ |
138 |
off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
139 |
size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
140 |
void *ptr1; /* all applicable requests: pathname, old name */ |
141 |
void *ptr2; /* all applicable requests: new name or memory buffer */ |
142 |
eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
143 |
eio_tstamp nv2; /* utime, futime: mtime */ |
144 |
|
145 |
int type; /* EIO_xxx constant ETP */ |
146 |
int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
147 |
long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ |
148 |
long int3; /* chown, fchown: gid; mknod: dev_t */ |
149 |
int errorno; /* errno value on syscall return */ |
150 |
|
151 |
unsigned char flags; /* private */ |
152 |
signed char pri; /* the priority */ |
153 |
|
154 |
void *data; |
155 |
eio_cb finish; |
156 |
void (*destroy)(eio_req *req); /* called when requets no longer needed */ |
157 |
void (*feed)(eio_req *req); /* only used for group requests */ |
158 |
|
159 |
EIO_REQ_MEMBERS |
160 |
|
161 |
eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
162 |
}; |
163 |
|
164 |
/* _private_ flags */ |
165 |
enum { |
166 |
EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
167 |
EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
168 |
EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ |
169 |
EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ |
170 |
}; |
171 |
|
172 |
enum { |
173 |
EIO_PRI_MIN = -4, |
174 |
EIO_PRI_MAX = 4, |
175 |
EIO_PRI_DEFAULT = 0, |
176 |
}; |
177 |
|
178 |
/* returns < 0 on error, errno set |
179 |
* need_poll, if non-zero, will be called when results are available |
180 |
* and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). |
181 |
* done_poll is called when the need to poll is gone. |
182 |
*/ |
183 |
int eio_init (void (*want_poll)(void), void (*done_poll)(void)); |
184 |
|
185 |
/* must be called regularly to handle pending requests */ |
186 |
/* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */ |
187 |
int eio_poll (void); |
188 |
|
189 |
/* stop polling if poll took longer than duration seconds */ |
190 |
void eio_set_max_poll_time (eio_tstamp nseconds); |
191 |
/* do not handle more then count requests in one call to eio_poll_cb */ |
192 |
void eio_set_max_poll_reqs (unsigned int nreqs); |
193 |
|
194 |
/* set minimum required number |
195 |
* maximum wanted number |
196 |
* or maximum idle number of threads */ |
197 |
void eio_set_min_parallel (unsigned int nthreads); |
198 |
void eio_set_max_parallel (unsigned int nthreads); |
199 |
void eio_set_max_idle (unsigned int nthreads); |
200 |
|
201 |
unsigned int eio_nreqs (void); /* number of requests in-flight */ |
202 |
unsigned int eio_nready (void); /* number of not-yet handled requests */ |
203 |
unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ |
204 |
unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
205 |
|
206 |
/*****************************************************************************/ |
207 |
/* convinience wrappers */ |
208 |
|
209 |
#ifndef EIO_NO_WRAPPERS |
210 |
eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
211 |
eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
212 |
eio_req *eio_sync (int pri, eio_cb cb, void *data); |
213 |
eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
214 |
eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
215 |
eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
216 |
eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
217 |
eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
218 |
eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
219 |
eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
220 |
eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
221 |
eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
222 |
eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
223 |
eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
224 |
eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
225 |
eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
226 |
eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
227 |
eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
228 |
eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); |
229 |
eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); |
230 |
eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
231 |
eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
232 |
eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
233 |
eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
234 |
eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
235 |
eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
236 |
eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
237 |
eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
238 |
eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
239 |
eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
240 |
eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
241 |
eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
242 |
eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
243 |
eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
244 |
eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
245 |
eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); |
246 |
#endif |
247 |
|
248 |
/*****************************************************************************/ |
249 |
/* groups */ |
250 |
|
251 |
eio_req *eio_grp (eio_cb cb, void *data); |
252 |
void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); |
253 |
void eio_grp_limit (eio_req *grp, int limit); |
254 |
void eio_grp_add (eio_req *grp, eio_req *req); |
255 |
void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ |
256 |
|
257 |
/*****************************************************************************/ |
258 |
/* request api */ |
259 |
|
260 |
/* true if the request was cancelled, useful in the invoke callback */ |
261 |
#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
262 |
|
263 |
#define EIO_RESULT(req) ((req)->result) |
264 |
/* returns a pointer to the result buffer allocated by eio */ |
265 |
#define EIO_BUF(req) ((req)->ptr2) |
266 |
#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) |
267 |
#define EIO_PATH(req) ((char *)(req)->ptr1) |
268 |
|
269 |
/* submit a request for execution */ |
270 |
void eio_submit (eio_req *req); |
271 |
/* cancel a request as soon fast as possible, if possible */ |
272 |
void eio_cancel (eio_req *req); |
273 |
/* destroy a request that has never been submitted */ |
274 |
void eio_destroy (eio_req *req); |
275 |
|
276 |
/*****************************************************************************/ |
277 |
/* convinience functions */ |
278 |
|
279 |
ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
280 |
|
281 |
#ifdef __cplusplus |
282 |
} |
283 |
#endif |
284 |
|
285 |
#endif |
286 |
|