ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.22
Committed: Fri Jun 12 00:43:16 2009 UTC (14 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.21: +2 -2 lines
Log Message: 
*** empty log message ***

File Contents

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