|
|
1 | /* |
|
|
2 | * libeio API header |
|
|
3 | * |
|
|
4 | * Copyright (c) 2007,2008 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 |
|
|
44 | extern "C" { |
|
|
45 | #endif |
|
|
46 | |
| 4 | #include <stddef.h> |
47 | #include <stddef.h> |
| 5 | #include <sys/types.h> |
48 | #include <sys/types.h> |
| 6 | |
49 | |
| 7 | typedef struct eio_req eio_req; |
50 | typedef struct eio_req eio_req; |
| 8 | |
51 | |
| 9 | typedef int (*eio_cb)(eio_req *req); |
52 | typedef int (*eio_cb)(eio_req *req); |
| 10 | |
53 | |
| 11 | #ifndef EIO_COMMON |
54 | #ifndef EIO_REQ_MEMBERS |
| 12 | # define EIO_COMMON \ |
55 | # define EIO_REQ_MEMBERS |
| 13 | eio_cb finish; \ |
56 | #endif |
| 14 | void (*destroy)(eio_req *req);\ |
57 | |
| 15 | void *data |
58 | #ifndef EIO_STRUCT_STAT |
|
|
59 | # define EIO_STRUCT_STAT struct stat |
| 16 | #endif |
60 | #endif |
| 17 | |
61 | |
| 18 | enum { |
62 | enum { |
| 19 | EIO_QUIT, |
|
|
| 20 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
63 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
| 21 | EIO_READ, EIO_WRITE, |
64 | EIO_READ, EIO_WRITE, |
| 22 | EIO_READAHEAD, EIO_SENDFILE, |
65 | EIO_READAHEAD, EIO_SENDFILE, |
| 23 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
66 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
| 24 | EIO_TRUNCATE, EIO_FTRUNCATE, |
67 | EIO_TRUNCATE, EIO_FTRUNCATE, |
| … | |
… | |
| 28 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
71 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
| 29 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
72 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
| 30 | EIO_MKNOD, EIO_READDIR, |
73 | EIO_MKNOD, EIO_READDIR, |
| 31 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
74 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
| 32 | EIO_GROUP, EIO_NOP, |
75 | EIO_GROUP, EIO_NOP, |
| 33 | EIO_BUSY, |
76 | EIO_BUSY, EIO_CUSTOM |
| 34 | }; |
77 | }; |
| 35 | |
78 | |
| 36 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
79 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
| 37 | |
80 | |
| 38 | /* eio request structure */ |
81 | /* eio request structure */ |
| 39 | /* this structure is mostly read-only */ |
82 | /* this structure is mostly read-only */ |
| 40 | struct eio_req |
83 | struct eio_req |
| 41 | { |
84 | { |
| 42 | eio_req volatile *next; /* private */ |
85 | eio_req volatile *next; /* private ETP */ |
| 43 | |
86 | |
| 44 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
87 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
| 45 | off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ |
88 | off_t offs; /* read, write, truncate, readahead: file offset */ |
| 46 | size_t size; /* read, write, readahead, sendfile: length */ |
89 | size_t size; /* read, write, readahead, sendfile: length */ |
| 47 | void *ptr1; /* all applicable requests: pathname, old name */ |
90 | void *ptr1; /* all applicable requests: pathname, old name */ |
| 48 | void *ptr2; /* all applicable requests: new name or memory buffer */ |
91 | void *ptr2; /* all applicable requests: new name or memory buffer */ |
| 49 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
92 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
| 50 | eio_tstamp nv2; /* utime, futime: mtime */ |
93 | eio_tstamp nv2; /* utime, futime: mtime */ |
| 51 | |
94 | |
| 52 | int type; /* EIO_xxx constant */ |
95 | int type; /* EIO_xxx constant ETP */ |
| 53 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ |
96 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ |
| 54 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ |
97 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ |
| 55 | long int3; /* chown, fchown: gid */ |
98 | long int3; /* chown, fchown: gid; mknod: dev_t */ |
| 56 | int errorno; /* errno value on syscall return */ |
99 | int errorno; /* errno value on syscall return */ |
| 57 | |
100 | |
| 58 | unsigned char flags; /* private */ |
101 | unsigned char flags; /* private */ |
| 59 | unsigned char pri; /* the priority */ |
102 | signed char pri; /* the priority */ |
| 60 | |
103 | |
| 61 | void (*feed)(eio_req *req); |
104 | void *data; |
|
|
105 | eio_cb finish; |
|
|
106 | void (*destroy)(eio_req *req); /* called when requets no longer needed */ |
|
|
107 | void (*feed)(eio_req *req); /* only used for group requests */ |
| 62 | |
108 | |
| 63 | EIO_COMMON; |
109 | EIO_REQ_MEMBERS |
| 64 | |
110 | |
| 65 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
111 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
| 66 | }; |
112 | }; |
| 67 | |
113 | |
| 68 | enum { |
114 | enum { |
| 69 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
115 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
| 70 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
116 | EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
|
|
117 | EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ |
| 71 | }; |
118 | }; |
| 72 | |
119 | |
| 73 | enum { |
120 | enum { |
| 74 | EIO_PRI_MIN = -4, |
121 | EIO_PRI_MIN = -4, |
| 75 | EIO_PRI_MAX = 4, |
122 | EIO_PRI_MAX = 4, |
| 76 | |
|
|
| 77 | EIO_DEFAULT_PRI = 0, |
123 | EIO_PRI_DEFAULT = 0, |
| 78 | EIO_PRI_BIAS = -EIO_PRI_MIN, |
|
|
| 79 | EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1, |
|
|
| 80 | }; |
124 | }; |
| 81 | |
125 | |
| 82 | /* returns < 0 on error, errno set |
126 | /* returns < 0 on error, errno set |
| 83 | * need_poll, if non-zero, will be called when results are available |
127 | * 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). |
128 | * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). |
| … | |
… | |
| 106 | unsigned int eio_nready (void); /* number of not-yet handled requests */ |
150 | unsigned int eio_nready (void); /* number of not-yet handled requests */ |
| 107 | unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ |
151 | unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ |
| 108 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
152 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
| 109 | |
153 | |
| 110 | /*****************************************************************************/ |
154 | /*****************************************************************************/ |
| 111 | /* high-level request API */ |
155 | /* convinience wrappers */ |
| 112 | |
156 | |
| 113 | eio_req *eio_fsync (int fd, eio_cb cb); |
157 | #ifndef EIO_NO_WRAPPERS |
| 114 | eio_req *eio_fdatasync (int fd, eio_cb cb); |
158 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
| 115 | eio_req *eio_dupclose (int fd, eio_cb cb); |
|
|
| 116 | eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb); |
|
|
| 117 | eio_req *eio_read (int fd, off_t offs, size_t length, char *data, eio_cb cb); |
|
|
| 118 | eio_req *eio_write (int fd, off_t offs, size_t length, char *data, eio_cb cb); |
|
|
| 119 | eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */ |
|
|
| 120 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); |
|
|
| 121 | eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb); |
|
|
| 122 | eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb); |
|
|
| 123 | eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb); |
|
|
| 124 | eio_req *eio_dup2 (int fd, int fd2, eio_cb cb); |
|
|
| 125 | eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb); |
|
|
| 126 | eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb); |
|
|
| 127 | eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ |
|
|
| 128 | eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */ |
|
|
| 129 | eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */ |
|
|
| 130 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); |
|
|
| 131 | eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb); |
|
|
| 132 | eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb); |
|
|
| 133 | eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb); |
|
|
| 134 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb); |
|
|
| 135 | eio_req *eio_unlink (const char *path, eio_cb cb); |
|
|
| 136 | eio_req *eio_rmdir (const char *path, eio_cb cb); |
|
|
| 137 | eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ |
|
|
| 138 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb); |
|
|
| 139 | eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ |
159 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
| 140 | eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ |
160 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
|
|
161 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
|
|
162 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
|
|
163 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
|
|
164 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
|
|
165 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
166 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
167 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
|
|
168 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
|
|
169 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
|
|
170 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
|
|
171 | eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
|
|
172 | eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
|
|
173 | eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); |
|
|
174 | eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); |
|
|
175 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
|
|
176 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
|
|
177 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
|
|
178 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
|
|
179 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
|
|
180 | eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
|
|
181 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
|
|
182 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
|
|
183 | eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
|
|
184 | eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
|
|
185 | eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
|
|
186 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
|
|
187 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
|
|
188 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
|
|
189 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
|
|
190 | eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); |
|
|
191 | #endif |
| 141 | |
192 | |
|
|
193 | /*****************************************************************************/ |
| 142 | /* for groups */ |
194 | /* groups */ |
|
|
195 | |
| 143 | eio_req *eio_grp (eio_cb cb); |
196 | eio_req *eio_grp (eio_cb cb, void *data); |
| 144 | void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); |
197 | void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); |
| 145 | void eio_grp_limit (eio_req *grp, int limit); |
198 | void eio_grp_limit (eio_req *grp, int limit); |
| 146 | void eio_grp_add (eio_req *grp, eio_req *req); |
199 | void eio_grp_add (eio_req *grp, eio_req *req); |
| 147 | void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ |
200 | void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ |
| 148 | |
201 | |
| 149 | /*****************************************************************************/ |
202 | /*****************************************************************************/ |
| 150 | /* low-level request API */ |
203 | /* request api */ |
| 151 | |
|
|
| 152 | /* must be used to initialise eio_req's */ |
|
|
| 153 | #define EIO_INIT(req,prio,finish_cb, destroy_cb) \ |
|
|
| 154 | memset ((req), 0, sizeof (eio_req)); \ |
|
|
| 155 | (req)->pri = (prio) + EIO_PRI_BIAS; \ |
|
|
| 156 | (req)->finish = (finish_cb); \ |
|
|
| 157 | (req)->destroy = (destroy_cb) |
|
|
| 158 | |
204 | |
| 159 | /* true if the request was cancelled, useful in the invoke callback */ |
205 | /* true if the request was cancelled, useful in the invoke callback */ |
| 160 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
206 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
| 161 | |
207 | |
|
|
208 | #define EIO_RESULT(req) ((req)->result) |
|
|
209 | /* returns a pointer to the result buffer allocated by eio */ |
|
|
210 | #define EIO_BUF(req) ((req)->ptr2) |
|
|
211 | #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) |
|
|
212 | #define EIO_PATH(req) ((char *)(req)->ptr1) |
|
|
213 | |
| 162 | /* submit a request for execution */ |
214 | /* submit a request for execution */ |
| 163 | void eio_submit (eio_req *req); |
215 | void eio_submit (eio_req *req); |
| 164 | /* cancel a request as soon fast as possible */ |
216 | /* cancel a request as soon fast as possible, if possible */ |
| 165 | void eio_cancel (eio_req *req); |
217 | void eio_cancel (eio_req *req); |
| 166 | /* destroy a request that has never been submitted */ |
218 | /* destroy a request that has never been submitted */ |
| 167 | void eio_destroy (eio_req *req); |
219 | void eio_destroy (eio_req *req); |
| 168 | |
220 | |
| 169 | #endif |
221 | /*****************************************************************************/ |
|
|
222 | /* convinience functions */ |
| 170 | |
223 | |
|
|
224 | ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
|
|
225 | |
|
|
226 | #ifdef __cplusplus |
|
|
227 | } |
|
|
228 | #endif |
|
|
229 | |
|
|
230 | #endif |
|
|
231 | |
