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