ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.26
Committed: Thu Jan 7 18:08:21 2010 UTC (14 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-3_6, rel-3_5, rel-3_65
Changes since 1.25: +13 -5 lines
Log Message: 
*** empty log message ***

File Contents

# User Rev Content
1 root 1.12 /*
2     * libeio API header
3     *
4 root 1.25 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libeio@schmorp.de>
5 root 1.12 * 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 root 1.1 #ifndef EIO_H_
41     #define EIO_H_
42    
43 root 1.14 #ifdef __cplusplus
44     extern "C" {
45     #endif
46    
47 root 1.1 #include <stddef.h>
48 root 1.3 #include <sys/types.h>
49 root 1.1
50 root 1.19 typedef struct eio_req eio_req;
51     typedef struct eio_dirent eio_dirent;
52 root 1.1
53     typedef int (*eio_cb)(eio_req *req);
54    
55 root 1.9 #ifndef EIO_REQ_MEMBERS
56     # define EIO_REQ_MEMBERS
57 root 1.1 #endif
58    
59 root 1.6 #ifndef EIO_STRUCT_STAT
60     # define EIO_STRUCT_STAT struct stat
61     #endif
62    
63 root 1.26 #ifndef EIO_STRUCT_STATVFS
64     # define EIO_STRUCT_STATVFS struct statvfs
65     #endif
66    
67 root 1.19 /* for readdir */
68    
69     /* eio_readdir flags */
70     enum {
71     EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
72     EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
73     EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
74     EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
75    
76     EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
77     EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
78     };
79    
80     /* using "typical" values in the hope that the compiler will do something sensible */
81     enum eio_dtype {
82     EIO_DT_UNKNOWN = 0,
83     EIO_DT_FIFO = 1,
84     EIO_DT_CHR = 2,
85 root 1.22 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
86 root 1.19 EIO_DT_DIR = 4,
87 root 1.21 EIO_DT_NAM = 5, /* xenix special named file */
88 root 1.19 EIO_DT_BLK = 6,
89 root 1.21 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
90 root 1.19 EIO_DT_REG = 8,
91 root 1.21 EIO_DT_NWK = 9, /* HP-UX network special */
92     EIO_DT_CMP = 9, /* VxFS compressed */
93 root 1.19 EIO_DT_LNK = 10,
94 root 1.21 /* DT_SHAD = 11,*/
95 root 1.19 EIO_DT_SOCK = 12,
96 root 1.21 EIO_DT_DOOR = 13, /* solaris door */
97 root 1.19 EIO_DT_WHT = 14,
98 root 1.22 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
99 root 1.19 };
100    
101     struct eio_dirent {
102 root 1.24 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
103     unsigned short namelen; /* size of filename without trailing 0 */
104     unsigned char type; /* one of EIO_DT_* */
105 root 1.23 signed char score; /* internal use */
106 root 1.24 ino_t inode; /* the inode number, if available, otherwise unspecified */
107 root 1.19 };
108    
109 root 1.25 /* eio_msync flags */
110     enum {
111     EIO_MS_ASYNC = 1,
112     EIO_MS_INVALIDATE = 2,
113     EIO_MS_SYNC = 4
114     };
115    
116     /* eio_mtouch flags */
117    
118     enum {
119     EIO_MT_MODIFY = 1
120     };
121    
122 root 1.19 /* eio_sync_file_range flags */
123    
124     enum {
125     EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
126     EIO_SYNC_FILE_RANGE_WRITE = 2,
127     EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
128     };
129    
130     typedef double eio_tstamp; /* feel free to use double in your code directly */
131    
132     /* the eio request structure */
133    
134 root 1.1 enum {
135 root 1.16 EIO_CUSTOM,
136 root 1.1 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
137     EIO_READ, EIO_WRITE,
138     EIO_READAHEAD, EIO_SENDFILE,
139     EIO_STAT, EIO_LSTAT, EIO_FSTAT,
140 root 1.26 EIO_STATVFS, EIO_FSTATVFS,
141 root 1.1 EIO_TRUNCATE, EIO_FTRUNCATE,
142     EIO_UTIME, EIO_FUTIME,
143     EIO_CHMOD, EIO_FCHMOD,
144     EIO_CHOWN, EIO_FCHOWN,
145 root 1.18 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
146     EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
147 root 1.1 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
148     EIO_MKNOD, EIO_READDIR,
149     EIO_LINK, EIO_SYMLINK, EIO_READLINK,
150     EIO_GROUP, EIO_NOP,
151 root 1.18 EIO_BUSY
152     };
153    
154 root 1.1 /* eio request structure */
155     /* this structure is mostly read-only */
156 root 1.19 /* when initialising it, all members must be zero-initialised */
157 root 1.1 struct eio_req
158     {
159 root 1.12 eio_req volatile *next; /* private ETP */
160 root 1.1
161     ssize_t result; /* result of syscall, e.g. result = read (... */
162 root 1.18 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
163     size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
164 root 1.24 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
165     void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
166 root 1.2 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
167     eio_tstamp nv2; /* utime, futime: mtime */
168 root 1.1
169 root 1.12 int type; /* EIO_xxx constant ETP */
170 root 1.19 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
171 root 1.18 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
172 root 1.15 long int3; /* chown, fchown: gid; mknod: dev_t */
173 root 1.1 int errorno; /* errno value on syscall return */
174    
175     unsigned char flags; /* private */
176 root 1.8 signed char pri; /* the priority */
177 root 1.1
178 root 1.8 void *data;
179 root 1.5 eio_cb finish;
180 root 1.8 void (*destroy)(eio_req *req); /* called when requets no longer needed */
181     void (*feed)(eio_req *req); /* only used for group requests */
182 root 1.1
183 root 1.8 EIO_REQ_MEMBERS
184 root 1.1
185     eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
186     };
187    
188 root 1.17 /* _private_ flags */
189 root 1.1 enum {
190     EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
191 root 1.5 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
192 root 1.17 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
193     EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
194 root 1.1 };
195    
196     enum {
197     EIO_PRI_MIN = -4,
198     EIO_PRI_MAX = 4,
199 root 1.13 EIO_PRI_DEFAULT = 0,
200 root 1.1 };
201    
202     /* returns < 0 on error, errno set
203     * need_poll, if non-zero, will be called when results are available
204     * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
205     * done_poll is called when the need to poll is gone.
206     */
207     int eio_init (void (*want_poll)(void), void (*done_poll)(void));
208    
209     /* must be called regularly to handle pending requests */
210     /* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
211     int eio_poll (void);
212    
213     /* stop polling if poll took longer than duration seconds */
214     void eio_set_max_poll_time (eio_tstamp nseconds);
215     /* do not handle more then count requests in one call to eio_poll_cb */
216     void eio_set_max_poll_reqs (unsigned int nreqs);
217    
218     /* set minimum required number
219     * maximum wanted number
220     * or maximum idle number of threads */
221     void eio_set_min_parallel (unsigned int nthreads);
222     void eio_set_max_parallel (unsigned int nthreads);
223     void eio_set_max_idle (unsigned int nthreads);
224    
225     unsigned int eio_nreqs (void); /* number of requests in-flight */
226     unsigned int eio_nready (void); /* number of not-yet handled requests */
227     unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
228     unsigned int eio_nthreads (void); /* number of worker threads in use currently */
229    
230     /*****************************************************************************/
231 root 1.11 /* convinience wrappers */
232 root 1.1
233 root 1.10 #ifndef EIO_NO_WRAPPERS
234 root 1.7 eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
235     eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
236     eio_req *eio_sync (int pri, eio_cb cb, void *data);
237     eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
238     eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
239 root 1.16 eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
240     eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
241 root 1.18 eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
242 root 1.7 eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
243     eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
244     eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
245     eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
246     eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
247 root 1.26 eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
248 root 1.7 eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
249     eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
250     eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
251     eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
252     eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
253     eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
254     eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
255     eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
256     eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
257     eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
258     eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
259     eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
260 root 1.19 eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
261 root 1.7 eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
262     eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
263     eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
264     eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
265     eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
266 root 1.26 eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
267 root 1.7 eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
268     eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
269     eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
270     eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
271 root 1.13 eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
272 root 1.10 #endif
273 root 1.1
274 root 1.11 /*****************************************************************************/
275     /* groups */
276    
277 root 1.7 eio_req *eio_grp (eio_cb cb, void *data);
278 root 1.2 void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
279     void eio_grp_limit (eio_req *grp, int limit);
280 root 1.1 void eio_grp_add (eio_req *grp, eio_req *req);
281     void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
282    
283 root 1.11 /*****************************************************************************/
284     /* request api */
285 root 1.6
286     /* true if the request was cancelled, useful in the invoke callback */
287 root 1.26 #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
288 root 1.6
289 root 1.26 #define EIO_RESULT(req) ((req)->result)
290 root 1.6 /* returns a pointer to the result buffer allocated by eio */
291 root 1.26 #define EIO_BUF(req) ((req)->ptr2)
292     #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
293     #define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
294     #define EIO_PATH(req) ((char *)(req)->ptr1)
295 root 1.6
296 root 1.1 /* submit a request for execution */
297     void eio_submit (eio_req *req);
298 root 1.11 /* cancel a request as soon fast as possible, if possible */
299     void eio_cancel (eio_req *req);
300     /* destroy a request that has never been submitted */
301     void eio_destroy (eio_req *req);
302 root 1.1
303 root 1.5 /*****************************************************************************/
304     /* convinience functions */
305    
306 root 1.6 ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
307 root 1.5
308 root 1.14 #ifdef __cplusplus
309     }
310     #endif
311    
312 root 1.1 #endif
313