ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.37
Committed: Thu Jul 7 22:36:18 2011 UTC (12 years, 10 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.36: +13 -8 lines
Log Message: 
fallocate

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 root 1.27 enum
123     {
124 root 1.25 EIO_MT_MODIFY = 1
125     };
126    
127 root 1.19 /* eio_sync_file_range flags */
128 root 1.27 enum
129     {
130 root 1.19 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
131     EIO_SYNC_FILE_RANGE_WRITE = 2,
132     EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
133     };
134    
135 root 1.37 /* eio_fallocate flags */
136     enum
137     {
138     EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
139     };
140    
141     /* timestamps and differences - feel free to use double in your code directly */
142     typedef double eio_tstamp;
143 root 1.19
144     /* the eio request structure */
145 root 1.27 enum
146     {
147 root 1.16 EIO_CUSTOM,
148 root 1.1 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
149     EIO_READ, EIO_WRITE,
150     EIO_READAHEAD, EIO_SENDFILE,
151     EIO_STAT, EIO_LSTAT, EIO_FSTAT,
152 root 1.26 EIO_STATVFS, EIO_FSTATVFS,
153 root 1.1 EIO_TRUNCATE, EIO_FTRUNCATE,
154     EIO_UTIME, EIO_FUTIME,
155     EIO_CHMOD, EIO_FCHMOD,
156     EIO_CHOWN, EIO_FCHOWN,
157 root 1.18 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
158 root 1.37 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
159 root 1.27 EIO_MLOCK, EIO_MLOCKALL,
160 root 1.1 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
161     EIO_MKNOD, EIO_READDIR,
162 root 1.33 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
163 root 1.1 EIO_GROUP, EIO_NOP,
164 root 1.18 EIO_BUSY
165     };
166    
167 root 1.27 /* mlockall constants */
168     enum
169     {
170     EIO_MCL_CURRENT = 1,
171     EIO_MCL_FUTURE = 2,
172     };
173    
174     /* request priorities */
175    
176     enum {
177     EIO_PRI_MIN = -4,
178     EIO_PRI_MAX = 4,
179     EIO_PRI_DEFAULT = 0,
180     };
181    
182 root 1.1 /* eio request structure */
183     /* this structure is mostly read-only */
184 root 1.19 /* when initialising it, all members must be zero-initialised */
185 root 1.1 struct eio_req
186     {
187 root 1.12 eio_req volatile *next; /* private ETP */
188 root 1.1
189     ssize_t result; /* result of syscall, e.g. result = read (... */
190 root 1.37 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
191     size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
192 root 1.24 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
193     void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
194 root 1.2 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
195     eio_tstamp nv2; /* utime, futime: mtime */
196 root 1.1
197 root 1.12 int type; /* EIO_xxx constant ETP */
198 root 1.27 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
199 root 1.37 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
200 root 1.28 long int3; /* chown, fchown: gid */
201 root 1.1 int errorno; /* errno value on syscall return */
202    
203 root 1.35 #if __i386 || __amd64
204     unsigned char cancelled;
205     #else
206     sig_atomic_t cancelled;
207     #endif
208    
209 root 1.1 unsigned char flags; /* private */
210 root 1.8 signed char pri; /* the priority */
211 root 1.1
212 root 1.8 void *data;
213 root 1.5 eio_cb finish;
214 root 1.30 void (*destroy)(eio_req *req); /* called when request no longer needed */
215 root 1.8 void (*feed)(eio_req *req); /* only used for group requests */
216 root 1.1
217 root 1.8 EIO_REQ_MEMBERS
218 root 1.1
219     eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
220     };
221    
222 root 1.27 /* _private_ request flags */
223 root 1.1 enum {
224 root 1.35 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
225     EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
226     EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
227 root 1.1 };
228    
229 root 1.27 /* undocumented/unsupported/private helper */
230     /*void eio_page_align (void **addr, size_t *length);*/
231 root 1.1
232     /* returns < 0 on error, errno set
233     * need_poll, if non-zero, will be called when results are available
234     * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
235     * done_poll is called when the need to poll is gone.
236     */
237     int eio_init (void (*want_poll)(void), void (*done_poll)(void));
238    
239     /* must be called regularly to handle pending requests */
240     /* returns 0 if all requests were handled, -1 if not, or the value of EIO_FINISH if != 0 */
241     int eio_poll (void);
242    
243     /* stop polling if poll took longer than duration seconds */
244     void eio_set_max_poll_time (eio_tstamp nseconds);
245     /* do not handle more then count requests in one call to eio_poll_cb */
246     void eio_set_max_poll_reqs (unsigned int nreqs);
247    
248     /* set minimum required number
249     * maximum wanted number
250     * or maximum idle number of threads */
251     void eio_set_min_parallel (unsigned int nthreads);
252     void eio_set_max_parallel (unsigned int nthreads);
253     void eio_set_max_idle (unsigned int nthreads);
254 root 1.29 void eio_set_idle_timeout (unsigned int seconds);
255 root 1.1
256     unsigned int eio_nreqs (void); /* number of requests in-flight */
257     unsigned int eio_nready (void); /* number of not-yet handled requests */
258 sf-exg 1.36 unsigned int eio_npending (void); /* number of finished but unhandled requests */
259 root 1.1 unsigned int eio_nthreads (void); /* number of worker threads in use currently */
260    
261     /*****************************************************************************/
262 root 1.31 /* convenience wrappers */
263 root 1.1
264 root 1.10 #ifndef EIO_NO_WRAPPERS
265 root 1.7 eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
266     eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
267     eio_req *eio_sync (int pri, eio_cb cb, void *data);
268     eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
269     eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
270 root 1.16 eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
271     eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
272 root 1.27 eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
273     eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
274 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);
275 root 1.37 eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
276 root 1.7 eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
277     eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
278     eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
279     eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
280     eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
281 root 1.26 eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
282 root 1.7 eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
283     eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
284     eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
285     eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
286     eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
287     eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
288     eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
289     eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
290     eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
291     eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
292     eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
293     eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
294 root 1.19 eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
295 root 1.7 eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
296     eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
297     eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
298 root 1.33 eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
299 root 1.7 eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
300     eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
301 root 1.26 eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
302 root 1.7 eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
303     eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
304     eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
305     eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
306 root 1.32 eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
307 root 1.10 #endif
308 root 1.1
309 root 1.11 /*****************************************************************************/
310     /* groups */
311    
312 root 1.7 eio_req *eio_grp (eio_cb cb, void *data);
313 root 1.2 void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
314     void eio_grp_limit (eio_req *grp, int limit);
315 root 1.1 void eio_grp_add (eio_req *grp, eio_req *req);
316     void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
317    
318 root 1.11 /*****************************************************************************/
319     /* request api */
320 root 1.6
321     /* true if the request was cancelled, useful in the invoke callback */
322 root 1.35 #define EIO_CANCELLED(req) ((req)->cancelled)
323 root 1.6
324 root 1.26 #define EIO_RESULT(req) ((req)->result)
325 root 1.6 /* returns a pointer to the result buffer allocated by eio */
326 root 1.26 #define EIO_BUF(req) ((req)->ptr2)
327     #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
328     #define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
329     #define EIO_PATH(req) ((char *)(req)->ptr1)
330 root 1.6
331 root 1.1 /* submit a request for execution */
332     void eio_submit (eio_req *req);
333 root 1.11 /* cancel a request as soon fast as possible, if possible */
334     void eio_cancel (eio_req *req);
335 root 1.1
336 root 1.5 /*****************************************************************************/
337 root 1.34 /* convenience functions */
338 root 1.5
339 root 1.6 ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
340 root 1.5
341 root 1.14 #ifdef __cplusplus
342     }
343     #endif
344    
345 root 1.1 #endif
346