ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.36
Committed: Thu Jul 7 17:35:52 2011 UTC (12 years, 10 months ago) by sf-exg
Content type: text/plain
Branch: MAIN
Changes since 1.35: +1 -1 lines
Log Message: 
Fix typos.

File Contents

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