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

Comparing libeio/eio.h (file contents):
Revision 1.5 by root, Sun May 11 19:11:05 2008 UTC vs.
Revision 1.20 by root, Sat Jun 6 18:06:55 2009 UTC

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
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 void *data 56# define EIO_REQ_MEMBERS
13#endif 57#endif
14 58
59#ifndef EIO_STRUCT_STAT
60# define EIO_STRUCT_STAT struct stat
61#endif
62
63/* for readdir */
64
65/* eio_readdir flags */
15enum { 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_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
90struct 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
101enum {
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
107typedef double eio_tstamp; /* feel free to use double in your code directly */
108
109/* the eio request structure */
110
111enum {
16 EIO_QUIT, 112 EIO_CUSTOM,
17 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 113 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
18 EIO_READ, EIO_WRITE, 114 EIO_READ, EIO_WRITE,
19 EIO_READAHEAD, EIO_SENDFILE, 115 EIO_READAHEAD, EIO_SENDFILE,
20 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 116 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
21 EIO_TRUNCATE, EIO_FTRUNCATE, 117 EIO_TRUNCATE, EIO_FTRUNCATE,
22 EIO_UTIME, EIO_FUTIME, 118 EIO_UTIME, EIO_FUTIME,
23 EIO_CHMOD, EIO_FCHMOD, 119 EIO_CHMOD, EIO_FCHMOD,
24 EIO_CHOWN, EIO_FCHOWN, 120 EIO_CHOWN, EIO_FCHOWN,
25 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 121 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
122 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
26 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 123 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
27 EIO_MKNOD, EIO_READDIR, 124 EIO_MKNOD, EIO_READDIR,
28 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 125 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
29 EIO_GROUP, EIO_NOP, 126 EIO_GROUP, EIO_NOP,
30 EIO_BUSY, 127 EIO_BUSY
31}; 128};
32
33typedef double eio_tstamp; /* feel free to use double in your code directly */
34 129
35/* eio request structure */ 130/* eio request structure */
36/* this structure is mostly read-only */ 131/* this structure is mostly read-only */
132/* when initialising it, all members must be zero-initialised */
37struct eio_req 133struct eio_req
38{ 134{
39 eio_req volatile *next; /* private */ 135 eio_req volatile *next; /* private ETP */
40 136
41 ssize_t result; /* result of syscall, e.g. result = read (... */ 137 ssize_t result; /* result of syscall, e.g. result = read (... */
42 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 138 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
43 size_t size; /* read, write, readahead, sendfile: length */ 139 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
44 void *ptr1; /* all applicable requests: pathname, old name */ 140 void *ptr1; /* all applicable requests: pathname, old name; readdir: possible output memory buffer */
45 void *ptr2; /* all applicable requests: new name or memory buffer */ 141 void *ptr2; /* all applicable requests: new name or memory buffer */
46 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 142 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
47 eio_tstamp nv2; /* utime, futime: mtime */ 143 eio_tstamp nv2; /* utime, futime: mtime */
48 144
49 int type; /* EIO_xxx constant */ 145 int type; /* EIO_xxx constant ETP */
50 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 146 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
51 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 147 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
52 long int3; /* chown, fchown: gid */ 148 long int3; /* chown, fchown: gid; mknod: dev_t */
53 int errorno; /* errno value on syscall return */ 149 int errorno; /* errno value on syscall return */
54 150
55 unsigned char flags; /* private */ 151 unsigned char flags; /* private */
56 unsigned char pri; /* the priority */ 152 signed char pri; /* the priority */
57 153
154 void *data;
58 eio_cb finish; 155 eio_cb finish;
59 void (*destroy)(eio_req *req); 156 void (*destroy)(eio_req *req); /* called when requets no longer needed */
60 void (*feed)(eio_req *req); 157 void (*feed)(eio_req *req); /* only used for group requests */
61 158
62 EIO_COMMON; 159 EIO_REQ_MEMBERS
63 160
64 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 161 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
65}; 162};
66 163
164/* _private_ flags */
67enum { 165enum {
68 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 166 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
69 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 167 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
70 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 168 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
169 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
71}; 170};
72 171
73enum { 172enum {
74 EIO_PRI_MIN = -4, 173 EIO_PRI_MIN = -4,
75 EIO_PRI_MAX = 4, 174 EIO_PRI_MAX = 4,
76
77 EIO_DEFAULT_PRI = 0, 175 EIO_PRI_DEFAULT = 0,
78 EIO_PRI_BIAS = -EIO_PRI_MIN,
79 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
80}; 176};
81 177
82/* returns < 0 on error, errno set 178/* returns < 0 on error, errno set
83 * need_poll, if non-zero, will be called when results are available 179 * need_poll, if non-zero, will be called when results are available
84 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 180 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
… …
106unsigned int eio_nready (void); /* number of not-yet handled requests */ 202unsigned int eio_nready (void); /* number of not-yet handled requests */
107unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 203unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
108unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 204unsigned int eio_nthreads (void); /* number of worker threads in use currently */
109 205
110/*****************************************************************************/ 206/*****************************************************************************/
111/* high-level request API */ 207/* convinience wrappers */
112 208
113eio_req *eio_fsync (int fd, eio_cb cb); 209#ifndef EIO_NO_WRAPPERS
114eio_req *eio_fdatasync (int fd, eio_cb cb); 210eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
115eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb);
116eio_req *eio_read (int fd, off_t offset, size_t length, void *data, eio_cb cb);
117eio_req *eio_write (int fd, off_t offset, size_t length, void *data, eio_cb cb);
118eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
119eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
120eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb);
121eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb);
122eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb);
123eio_req *eio_dup2 (int fd, int fd2, eio_cb cb);
124eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb);
125eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb);
126eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
127eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
128eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
129eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
130eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb);
131eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb);
132eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb);
133eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb);
134eio_req *eio_unlink (const char *path, eio_cb cb);
135eio_req *eio_rmdir (const char *path, eio_cb cb);
136eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
137eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb);
138eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ 211eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
139eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 212eio_req *eio_sync (int pri, eio_cb cb, void *data);
213eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
214eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
215eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
216eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
217eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
218eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
219eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
220eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
221eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
222eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
223eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
224eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
225eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
226eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
227eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
228eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
229eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
230eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
231eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
232eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
233eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
234eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
235eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
236eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
237eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
238eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
239eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
240eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
241eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
242eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
243eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
244eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
245eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
246#endif
140 247
248/*****************************************************************************/
141/* for groups */ 249/* groups */
250
142eio_req *eio_grp (eio_cb cb); 251eio_req *eio_grp (eio_cb cb, void *data);
143void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); 252void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
144void eio_grp_limit (eio_req *grp, int limit); 253void eio_grp_limit (eio_req *grp, int limit);
145void eio_grp_add (eio_req *grp, eio_req *req); 254void eio_grp_add (eio_req *grp, eio_req *req);
146void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 255void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
147 256
148/*****************************************************************************/ 257/*****************************************************************************/
149/* low-level request API */ 258/* request api */
150
151/* must be used to initialise eio_req's */
152#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
153 memset ((req), 0, sizeof (eio_req)); \
154 (req)->pri = (prio) + EIO_PRI_BIAS; \
155 (req)->finish = (finish_cb); \
156 (req)->destroy = (destroy_cb)
157 259
158/* true if the request was cancelled, useful in the invoke callback */ 260/* true if the request was cancelled, useful in the invoke callback */
159#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 261#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
160 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
161/* submit a request for execution */ 269/* submit a request for execution */
162void eio_submit (eio_req *req); 270void eio_submit (eio_req *req);
163/* cancel a request as soon fast as possible */ 271/* cancel a request as soon fast as possible, if possible */
164void eio_cancel (eio_req *req); 272void eio_cancel (eio_req *req);
165/* destroy a request that has never been submitted */ 273/* destroy a request that has never been submitted */
166void eio_destroy (eio_req *req); 274void eio_destroy (eio_req *req);
167 275
168/*****************************************************************************/ 276/*****************************************************************************/
169/* convinience functions */ 277/* convinience functions */
170 278
171/*ssize_t eio_sendfile (int ofd, int ifd, off_t offset, size_t count)*/ 279ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
172 280
281#ifdef __cplusplus
282}
173#endif 283#endif
174 284
285#endif
286

Diff Legend

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