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

Comparing libeio/eio.h (file contents):
Revision 1.8 by root, Tue May 13 18:50:27 2008 UTC vs.
Revision 1.25 by root, Sat Jan 2 14:11:32 2010 UTC

1/*
2 * libeio API header
3 *
4 * Copyright (c) 2007,2008,2009,2010 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
1#ifndef EIO_H_ 40#ifndef EIO_H_
2#define EIO_H_ 41#define EIO_H_
3 42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
4#include <stddef.h> 47#include <stddef.h>
5#include <sys/types.h> 48#include <sys/types.h>
6 49
7typedef struct eio_req eio_req; 50typedef struct eio_req eio_req;
51typedef struct eio_dirent eio_dirent;
8 52
9typedef int (*eio_cb)(eio_req *req); 53typedef int (*eio_cb)(eio_req *req);
10 54
11#ifndef EIO_COMMON 55#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON 56# define EIO_REQ_MEMBERS
13#endif 57#endif
14 58
15#ifndef EIO_STRUCT_STAT 59#ifndef EIO_STRUCT_STAT
16# define EIO_STRUCT_STAT struct stat 60# define EIO_STRUCT_STAT struct stat
17#endif 61#endif
18 62
63/* for readdir */
64
65/* eio_readdir flags */
19enum { 66enum {
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 */
77enum eio_dtype {
78 EIO_DT_UNKNOWN = 0,
79 EIO_DT_FIFO = 1,
80 EIO_DT_CHR = 2,
81 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
82 EIO_DT_DIR = 4,
83 EIO_DT_NAM = 5, /* xenix special named file */
84 EIO_DT_BLK = 6,
85 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
86 EIO_DT_REG = 8,
87 EIO_DT_NWK = 9, /* HP-UX network special */
88 EIO_DT_CMP = 9, /* VxFS compressed */
89 EIO_DT_LNK = 10,
90 /* DT_SHAD = 11,*/
91 EIO_DT_SOCK = 12,
92 EIO_DT_DOOR = 13, /* solaris door */
93 EIO_DT_WHT = 14,
94 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
95};
96
97struct eio_dirent {
98 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
99 unsigned short namelen; /* size of filename without trailing 0 */
100 unsigned char type; /* one of EIO_DT_* */
101 signed char score; /* internal use */
102 ino_t inode; /* the inode number, if available, otherwise unspecified */
103};
104
105/* eio_msync flags */
106enum {
107 EIO_MS_ASYNC = 1,
108 EIO_MS_INVALIDATE = 2,
109 EIO_MS_SYNC = 4
110};
111
112/* eio_mtouch flags */
113
114enum {
115 EIO_MT_MODIFY = 1
116};
117
118/* eio_sync_file_range flags */
119
120enum {
121 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
122 EIO_SYNC_FILE_RANGE_WRITE = 2,
123 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
124};
125
126typedef double eio_tstamp; /* feel free to use double in your code directly */
127
128/* the eio request structure */
129
130enum {
20 EIO_QUIT, 131 EIO_CUSTOM,
21 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 132 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
22 EIO_READ, EIO_WRITE, 133 EIO_READ, EIO_WRITE,
23 EIO_READAHEAD, EIO_SENDFILE, 134 EIO_READAHEAD, EIO_SENDFILE,
24 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 135 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
25 EIO_TRUNCATE, EIO_FTRUNCATE, 136 EIO_TRUNCATE, EIO_FTRUNCATE,
26 EIO_UTIME, EIO_FUTIME, 137 EIO_UTIME, EIO_FUTIME,
27 EIO_CHMOD, EIO_FCHMOD, 138 EIO_CHMOD, EIO_FCHMOD,
28 EIO_CHOWN, EIO_FCHOWN, 139 EIO_CHOWN, EIO_FCHOWN,
29 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 140 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
141 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
30 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 142 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
31 EIO_MKNOD, EIO_READDIR, 143 EIO_MKNOD, EIO_READDIR,
32 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 144 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
33 EIO_GROUP, EIO_NOP, 145 EIO_GROUP, EIO_NOP,
34 EIO_BUSY, 146 EIO_BUSY
35}; 147};
36
37typedef double eio_tstamp; /* feel free to use double in your code directly */
38 148
39/* eio request structure */ 149/* eio request structure */
40/* this structure is mostly read-only */ 150/* this structure is mostly read-only */
151/* when initialising it, all members must be zero-initialised */
41struct eio_req 152struct eio_req
42{ 153{
43 eio_req volatile *next; /* private */ 154 eio_req volatile *next; /* private ETP */
44 155
45 ssize_t result; /* result of syscall, e.g. result = read (... */ 156 ssize_t result; /* result of syscall, e.g. result = read (... */
46 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 157 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
47 size_t size; /* read, write, readahead, sendfile: length */ 158 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
48 void *ptr1; /* all applicable requests: pathname, old name */ 159 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
49 void *ptr2; /* all applicable requests: new name or memory buffer */ 160 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
50 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 161 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
51 eio_tstamp nv2; /* utime, futime: mtime */ 162 eio_tstamp nv2; /* utime, futime: mtime */
52 163
53 int type; /* EIO_xxx constant */ 164 int type; /* EIO_xxx constant ETP */
54 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 165 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
55 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 166 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
56 long int3; /* chown, fchown: gid */ 167 long int3; /* chown, fchown: gid; mknod: dev_t */
57 int errorno; /* errno value on syscall return */ 168 int errorno; /* errno value on syscall return */
58 169
59 unsigned char flags; /* private */ 170 unsigned char flags; /* private */
60 signed char pri; /* the priority */ 171 signed char pri; /* the priority */
61 172
… …
67 EIO_REQ_MEMBERS 178 EIO_REQ_MEMBERS
68 179
69 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 180 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
70}; 181};
71 182
183/* _private_ flags */
72enum { 184enum {
73 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 185 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
74 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 186 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
75 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 187 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
188 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
76}; 189};
77 190
78enum { 191enum {
79 EIO_PRI_MIN = -4, 192 EIO_PRI_MIN = -4,
80 EIO_PRI_MAX = 4, 193 EIO_PRI_MAX = 4,
81
82 EIO_PRI_DEFAULT = 0, 194 EIO_PRI_DEFAULT = 0,
83 EIO_PRI_BIAS = -EIO_PRI_MIN,
84 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
85}; 195};
86 196
87/* returns < 0 on error, errno set 197/* returns < 0 on error, errno set
88 * need_poll, if non-zero, will be called when results are available 198 * need_poll, if non-zero, will be called when results are available
89 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 199 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
… …
111unsigned int eio_nready (void); /* number of not-yet handled requests */ 221unsigned int eio_nready (void); /* number of not-yet handled requests */
112unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 222unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
113unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 223unsigned int eio_nthreads (void); /* number of worker threads in use currently */
114 224
115/*****************************************************************************/ 225/*****************************************************************************/
116/* high-level request API */ 226/* convinience wrappers */
117 227
228#ifndef EIO_NO_WRAPPERS
118eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 229eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
119eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 230eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
120eio_req *eio_sync (int pri, eio_cb cb, void *data); 231eio_req *eio_sync (int pri, eio_cb cb, void *data);
121eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 232eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
122eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 233eio_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);
235eio_req *eio_mtouch (void *addr, size_t length, 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);
123eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 237eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
124eio_req *eio_readahead (int fd, off_t offset, size_t length, 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);
125eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, 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);
126eio_req *eio_write (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);
127eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 241eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
… …
135eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 249eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
136eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 250eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
137eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 251eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
138eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 252eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
139eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 253eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
140eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 254eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
141eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 255eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
142eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 256eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
143eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 257eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
144eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 258eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
145eio_req *eio_lstat (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 */
146eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 260eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
147eio_req *eio_link (const char *path, const char *new_path, 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);
148eio_req *eio_symlink (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);
149eio_req *eio_rename (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);
264eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
265#endif
150 266
267/*****************************************************************************/
151/* for groups */ 268/* groups */
269
152eio_req *eio_grp (eio_cb cb, void *data); 270eio_req *eio_grp (eio_cb cb, void *data);
153void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); 271void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
154void eio_grp_limit (eio_req *grp, int limit); 272void eio_grp_limit (eio_req *grp, int limit);
155void eio_grp_add (eio_req *grp, eio_req *req); 273void eio_grp_add (eio_req *grp, eio_req *req);
156void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 274void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
157 275
158/* cancel a request as soon fast as possible */ 276/*****************************************************************************/
159void eio_cancel (eio_req *req); 277/* request api */
160/* destroy a request that has never been submitted */
161void eio_destroy (eio_req *req);
162 278
163/* true if the request was cancelled, useful in the invoke callback */ 279/* true if the request was cancelled, useful in the invoke callback */
164#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 280#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
165 281
166#define EIO_RESULT(req) ((req)->result) 282#define EIO_RESULT(req) ((req)->result)
167/* returns a pointer to the result buffer allocated by eio */ 283/* returns a pointer to the result buffer allocated by eio */
168#define EIO_BUF(req) ((req)->ptr2) 284#define EIO_BUF(req) ((req)->ptr2)
169#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 285#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
170#define EIO_PATH(req) ((char *)(req)->ptr1) 286#define EIO_PATH(req) ((char *)(req)->ptr1)
171 287
172/*****************************************************************************/
173/* low-level request API */
174
175/* must be used to initialise eio_req's */
176#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
177 memset ((req), 0, sizeof (eio_req)); \
178 (req)->pri = (prio) + EIO_PRI_BIAS; \
179 (req)->finish = (finish_cb); \
180 (req)->destroy = (destroy_cb)
181
182/* submit a request for execution */ 288/* submit a request for execution */
183void eio_submit (eio_req *req); 289void eio_submit (eio_req *req);
290/* cancel a request as soon fast as possible, if possible */
291void eio_cancel (eio_req *req);
292/* destroy a request that has never been submitted */
293void eio_destroy (eio_req *req);
184 294
185/*****************************************************************************/ 295/*****************************************************************************/
186/* convinience functions */ 296/* convinience functions */
187 297
188ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 298ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
189 299
300#ifdef __cplusplus
301}
190#endif 302#endif
191 303
304#endif
305

Diff Legend

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