ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.54
Committed: Mon Aug 18 08:11:54 2014 UTC (10 years, 3 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-4_32
Changes since 1.53: +3 -4 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * libeio API header
3 *
4 * Copyright (c) 2007,2008,2009,2010,2011,2012 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 <signal.h>
49 #include <sys/types.h>
50
51 typedef struct eio_req eio_req;
52 typedef struct eio_dirent eio_dirent;
53
54 typedef int (*eio_cb)(eio_req *req);
55
56 #ifndef EIO_REQ_MEMBERS
57 # define EIO_REQ_MEMBERS
58 #endif
59
60 #ifndef EIO_STRUCT_STAT
61 # ifdef _WIN32
62 # define EIO_STRUCT_STAT struct _stati64
63 # define EIO_STRUCT_STATI64
64 # else
65 # define EIO_STRUCT_STAT struct stat
66 # endif
67 #endif
68
69 #ifdef _WIN32
70 typedef int eio_uid_t;
71 typedef int eio_gid_t;
72 #ifdef __MINGW32__ /* no intptr_t */
73 typedef ssize_t eio_ssize_t;
74 #else
75 typedef intptr_t eio_ssize_t; /* or SSIZE_T */
76 #endif
77 #if __GNUC__
78 typedef long long eio_ino_t; /* signed for compatibility to msvc */
79 #else
80 typedef __int64 eio_ino_t; /* unsigned not supported by msvc */
81 #endif
82 #else
83 typedef uid_t eio_uid_t;
84 typedef gid_t eio_gid_t;
85 typedef ssize_t eio_ssize_t;
86 typedef ino_t eio_ino_t;
87 #endif
88
89 #ifndef EIO_STRUCT_STATVFS
90 # define EIO_STRUCT_STATVFS struct statvfs
91 #endif
92
93 /* managing working directories */
94
95 typedef struct eio_pwd *eio_wd;
96
97 #define EIO_CWD 0 /* the current working directory of the process, guaranteed to be a null pointer */
98 #define EIO_INVALID_WD ((eio_wd)(int)-1) /* failure return for eio_wd_open */
99
100 eio_wd eio_wd_open_sync (eio_wd wd, const char *path);
101 void eio_wd_close_sync (eio_wd wd);
102
103 /* for readdir */
104
105 /* eio_readdir flags */
106 enum
107 {
108 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
109 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
110 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
111 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
112
113 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
114 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
115 };
116
117 /* using "typical" values in the hope that the compiler will do something sensible */
118 enum eio_dtype
119 {
120 EIO_DT_UNKNOWN = 0,
121 EIO_DT_FIFO = 1,
122 EIO_DT_CHR = 2,
123 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
124 EIO_DT_DIR = 4,
125 EIO_DT_NAM = 5, /* xenix special named file */
126 EIO_DT_BLK = 6,
127 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
128 EIO_DT_REG = 8,
129 EIO_DT_NWK = 9, /* HP-UX network special */
130 EIO_DT_CMP = 9, /* VxFS compressed */
131 EIO_DT_LNK = 10,
132 /* DT_SHAD = 11,*/
133 EIO_DT_SOCK = 12,
134 EIO_DT_DOOR = 13, /* solaris door */
135 EIO_DT_WHT = 14,
136 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
137 };
138
139 struct eio_dirent
140 {
141 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
142 unsigned short namelen; /* size of filename without trailing 0 */
143 unsigned char type; /* one of EIO_DT_* */
144 signed char score; /* internal use */
145 eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
146 };
147
148 /* eio_msync flags */
149 enum
150 {
151 EIO_MS_ASYNC = 1,
152 EIO_MS_INVALIDATE = 2,
153 EIO_MS_SYNC = 4
154 };
155
156 /* eio_mtouch flags */
157 enum
158 {
159 EIO_MT_MODIFY = 1
160 };
161
162 /* eio_sync_file_range flags */
163 enum
164 {
165 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
166 EIO_SYNC_FILE_RANGE_WRITE = 2,
167 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
168 };
169
170 /* eio_fallocate flags */
171 enum
172 {
173 /* these MUST match the value in linux/falloc.h */
174 EIO_FALLOC_FL_KEEP_SIZE = 1,
175 EIO_FALLOC_FL_PUNCH_HOLE = 2
176 };
177
178 /* timestamps and differences - feel free to use double in your code directly */
179 typedef double eio_tstamp;
180
181 /* the eio request structure */
182 enum
183 {
184 EIO_CUSTOM,
185 EIO_WD_OPEN, EIO_WD_CLOSE,
186
187 EIO_CLOSE, EIO_DUP2,
188 EIO_SEEK, EIO_READ, EIO_WRITE,
189 EIO_READAHEAD, EIO_SENDFILE,
190 EIO_FSTAT, EIO_FSTATVFS,
191 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
192 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
193 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
194 EIO_MLOCK, EIO_MLOCKALL,
195 EIO_GROUP, EIO_NOP,
196 EIO_BUSY,
197
198 /* these use wd + ptr1, but are emulated */
199 EIO_REALPATH,
200 EIO_READDIR,
201
202 /* all the following requests use wd + ptr1 as path in xxxat functions */
203 EIO_OPEN,
204 EIO_STAT, EIO_LSTAT, EIO_STATVFS,
205 EIO_TRUNCATE,
206 EIO_UTIME,
207 EIO_CHMOD,
208 EIO_CHOWN,
209 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
210 EIO_MKNOD,
211 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
212
213 EIO_REQ_TYPE_NUM
214 };
215
216 /* seek whence modes */
217 /* these are guaranteed to hasve the traditional 0, 1, 2 values, */
218 /* so you might as wlel use those */
219 enum
220 {
221 EIO_SEEK_SET = 0,
222 EIO_SEEK_CUR = 1,
223 EIO_SEEK_END = 2
224 };
225
226
227 /* mlockall constants */
228 enum
229 {
230 EIO_MCL_CURRENT = 1,
231 EIO_MCL_FUTURE = 2
232 };
233
234 /* request priorities */
235
236 enum {
237 EIO_PRI_MIN = -4,
238 EIO_PRI_MAX = 4,
239 EIO_PRI_DEFAULT = 0
240 };
241
242 /* eio request structure */
243 /* this structure is mostly read-only */
244 /* when initialising it, all members must be zero-initialised */
245 struct eio_req
246 {
247 eio_req volatile *next; /* private ETP */
248
249 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
250
251 eio_ssize_t result; /* result of syscall, e.g. result = read (... */
252 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
253 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
254 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
255 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
256 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
257 eio_tstamp nv2; /* utime, futime: mtime */
258
259 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
260 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */
261 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
262 int errorno; /* errno value on syscall return */
263
264 unsigned char flags; /* private */
265
266 signed char type;/* EIO_xxx constant ETP */
267 signed char pri; /* the priority ETP */
268 #if __i386 || __amd64
269 unsigned char cancelled; /* ETP */
270 #else
271 sig_atomic_t cancelled; /* ETP */
272 #endif
273
274 void *data;
275 eio_cb finish;
276 void (*destroy)(eio_req *req); /* called when request no longer needed */
277 void (*feed)(eio_req *req); /* only used for group requests */
278
279 EIO_REQ_MEMBERS
280
281 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */
282 };
283
284 /* _private_ request flags */
285 enum {
286 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
287 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
288 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
289 };
290
291 /* undocumented/unsupported/private helper */
292 /*void eio_page_align (void **addr, size_t *length);*/
293
294 /* returns < 0 on error, errno set
295 * need_poll, if non-zero, will be called when results are available
296 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
297 * done_poll is called when the need to poll is gone.
298 */
299 int eio_init (void (*want_poll)(void), void (*done_poll)(void));
300
301 /* must be called regularly to handle pending requests */
302 /* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
303 int eio_poll (void);
304
305 /* stop polling if poll took longer than duration seconds */
306 void eio_set_max_poll_time (eio_tstamp nseconds);
307 /* do not handle more then count requests in one call to eio_poll_cb */
308 void eio_set_max_poll_reqs (unsigned int nreqs);
309
310 /* set minimum required number
311 * maximum wanted number
312 * or maximum idle number of threads */
313 void eio_set_min_parallel (unsigned int nthreads);
314 void eio_set_max_parallel (unsigned int nthreads);
315 void eio_set_max_idle (unsigned int nthreads);
316 void eio_set_idle_timeout (unsigned int seconds);
317
318 unsigned int eio_nreqs (void); /* number of requests in-flight */
319 unsigned int eio_nready (void); /* number of not-yet handled requests */
320 unsigned int eio_npending (void); /* number of finished but unhandled requests */
321 unsigned int eio_nthreads (void); /* number of worker threads in use currently */
322
323 /*****************************************************************************/
324 /* convenience wrappers */
325
326 #ifndef EIO_NO_WRAPPERS
327 eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
328 eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
329 eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
330 eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
331 eio_req *eio_sync (int pri, eio_cb cb, void *data);
332 eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
333 eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
334 eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data);
335 eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
336 eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
337 eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
338 eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
339 eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
340 eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
341 eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
342 eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
343 eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
344 eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
345 eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
346 eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
347 eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
348 eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
349 eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
350 eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
351 eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
352 eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
353 eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
354 eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
355 eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
356 eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
357 eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
358 eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
359 eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
360 eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
361 eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
362 eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
363 eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
364 eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
365 eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
366 eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
367 eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
368 eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
369 eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
370 eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
371 eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
372 eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
373 #endif
374
375 /*****************************************************************************/
376 /* groups */
377
378 eio_req *eio_grp (eio_cb cb, void *data);
379 void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
380 void eio_grp_limit (eio_req *grp, int limit);
381 void eio_grp_add (eio_req *grp, eio_req *req);
382 void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
383
384 /*****************************************************************************/
385 /* request api */
386
387 /* true if the request was cancelled, useful in the invoke callback */
388 #define EIO_CANCELLED(req) ((req)->cancelled)
389
390 #define EIO_RESULT(req) ((req)->result)
391 /* returns a pointer to the result buffer allocated by eio */
392 #define EIO_BUF(req) ((req)->ptr2)
393 #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
394 #define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
395 #define EIO_PATH(req) ((char *)(req)->ptr1)
396
397 /* submit a request for execution */
398 void eio_submit (eio_req *req);
399 /* cancel a request as soon fast as possible, if possible */
400 void eio_cancel (eio_req *req);
401
402 /*****************************************************************************/
403 /* convenience functions */
404
405 eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
406
407 #ifdef __cplusplus
408 }
409 #endif
410
411 #endif
412