ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
(Generate patch)

Comparing libeio/eio.h (file contents):
Revision 1.6 by root, Mon May 12 00:31:43 2008 UTC vs.
Revision 1.24 by root, Mon Jun 15 05:34:49 2009 UTC

1/*
2 * libeio API header
3 *
4 * Copyright (c) 2007,2008,2009 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
44extern "C" {
45#endif
46
4#include <stddef.h> 47#include <stddef.h>
5#include <sys/types.h> 48#include <sys/types.h>
6 49
7typedef struct eio_req eio_req; 50typedef struct eio_req eio_req;
51typedef struct eio_dirent eio_dirent;
8 52
9typedef int (*eio_cb)(eio_req *req); 53typedef int (*eio_cb)(eio_req *req);
10 54
11#ifndef EIO_COMMON 55#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON void *data 56# define EIO_REQ_MEMBERS
13#endif 57#endif
14 58
15#ifndef EIO_STRUCT_STAT 59#ifndef EIO_STRUCT_STAT
16# define EIO_STRUCT_STAT struct stat 60# define EIO_STRUCT_STAT struct stat
17#endif 61#endif
18 62
63/* for readdir */
64
65/* eio_readdir flags */
19enum { 66enum {
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 */
77enum eio_dtype {
78 EIO_DT_UNKNOWN = 0,
79 EIO_DT_FIFO = 1,
80 EIO_DT_CHR = 2,
81 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
82 EIO_DT_DIR = 4,
83 EIO_DT_NAM = 5, /* xenix special named file */
84 EIO_DT_BLK = 6,
85 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
86 EIO_DT_REG = 8,
87 EIO_DT_NWK = 9, /* HP-UX network special */
88 EIO_DT_CMP = 9, /* VxFS compressed */
89 EIO_DT_LNK = 10,
90 /* DT_SHAD = 11,*/
91 EIO_DT_SOCK = 12,
92 EIO_DT_DOOR = 13, /* solaris door */
93 EIO_DT_WHT = 14,
94 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
95};
96
97struct eio_dirent {
98 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
99 unsigned short namelen; /* size of filename without trailing 0 */
100 unsigned char type; /* one of EIO_DT_* */
101 signed char score; /* internal use */
102 ino_t inode; /* the inode number, if available, otherwise unspecified */
103};
104
105/* eio_sync_file_range flags */
106
107enum {
108 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
109 EIO_SYNC_FILE_RANGE_WRITE = 2,
110 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
111};
112
113typedef double eio_tstamp; /* feel free to use double in your code directly */
114
115/* the eio request structure */
116
117enum {
20 EIO_QUIT, 118 EIO_CUSTOM,
21 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 119 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
22 EIO_READ, EIO_WRITE, 120 EIO_READ, EIO_WRITE,
23 EIO_READAHEAD, EIO_SENDFILE, 121 EIO_READAHEAD, EIO_SENDFILE,
24 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 122 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
25 EIO_TRUNCATE, EIO_FTRUNCATE, 123 EIO_TRUNCATE, EIO_FTRUNCATE,
26 EIO_UTIME, EIO_FUTIME, 124 EIO_UTIME, EIO_FUTIME,
27 EIO_CHMOD, EIO_FCHMOD, 125 EIO_CHMOD, EIO_FCHMOD,
28 EIO_CHOWN, EIO_FCHOWN, 126 EIO_CHOWN, EIO_FCHOWN,
29 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 127 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
128 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
30 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 129 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
31 EIO_MKNOD, EIO_READDIR, 130 EIO_MKNOD, EIO_READDIR,
32 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 131 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
33 EIO_GROUP, EIO_NOP, 132 EIO_GROUP, EIO_NOP,
34 EIO_BUSY, 133 EIO_BUSY
35}; 134};
36
37typedef double eio_tstamp; /* feel free to use double in your code directly */
38 135
39/* eio request structure */ 136/* eio request structure */
40/* this structure is mostly read-only */ 137/* this structure is mostly read-only */
138/* when initialising it, all members must be zero-initialised */
41struct eio_req 139struct eio_req
42{ 140{
43 eio_req volatile *next; /* private */ 141 eio_req volatile *next; /* private ETP */
44 142
45 ssize_t result; /* result of syscall, e.g. result = read (... */ 143 ssize_t result; /* result of syscall, e.g. result = read (... */
46 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 144 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
47 size_t size; /* read, write, readahead, sendfile: length */ 145 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
48 void *ptr1; /* all applicable requests: pathname, old name */ 146 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
49 void *ptr2; /* all applicable requests: new name or memory buffer */ 147 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
50 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 148 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
51 eio_tstamp nv2; /* utime, futime: mtime */ 149 eio_tstamp nv2; /* utime, futime: mtime */
52 150
53 int type; /* EIO_xxx constant */ 151 int type; /* EIO_xxx constant ETP */
54 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 152 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */
55 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 153 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
56 long int3; /* chown, fchown: gid */ 154 long int3; /* chown, fchown: gid; mknod: dev_t */
57 int errorno; /* errno value on syscall return */ 155 int errorno; /* errno value on syscall return */
58 156
59 unsigned char flags; /* private */ 157 unsigned char flags; /* private */
60 unsigned char pri; /* the priority */ 158 signed char pri; /* the priority */
61 159
160 void *data;
62 eio_cb finish; 161 eio_cb finish;
63 void (*destroy)(eio_req *req); 162 void (*destroy)(eio_req *req); /* called when requets no longer needed */
64 void (*feed)(eio_req *req); 163 void (*feed)(eio_req *req); /* only used for group requests */
65 164
66 EIO_COMMON; 165 EIO_REQ_MEMBERS
67 166
68 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 167 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
69}; 168};
70 169
170/* _private_ flags */
71enum { 171enum {
72 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 172 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
73 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 173 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
74 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 174 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
175 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
75}; 176};
76 177
77enum { 178enum {
78 EIO_PRI_MIN = -4, 179 EIO_PRI_MIN = -4,
79 EIO_PRI_MAX = 4, 180 EIO_PRI_MAX = 4,
80
81 EIO_DEFAULT_PRI = 0, 181 EIO_PRI_DEFAULT = 0,
82 EIO_PRI_BIAS = -EIO_PRI_MIN,
83 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
84}; 182};
85 183
86/* returns < 0 on error, errno set 184/* returns < 0 on error, errno set
87 * need_poll, if non-zero, will be called when results are available 185 * need_poll, if non-zero, will be called when results are available
88 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 186 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
… …
110unsigned int eio_nready (void); /* number of not-yet handled requests */ 208unsigned int eio_nready (void); /* number of not-yet handled requests */
111unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 209unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
112unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 210unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113 211
114/*****************************************************************************/ 212/*****************************************************************************/
115/* high-level request API */ 213/* convinience wrappers */
116 214
215#ifndef EIO_NO_WRAPPERS
117eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 216eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
118eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ 217eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
119eio_req *eio_sync (eio_cb cb);
120eio_req *eio_fsync (int fd, eio_cb cb); 218eio_req *eio_sync (int pri, eio_cb cb, void *data);
219eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
121eio_req *eio_fdatasync (int fd, eio_cb cb); 220eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
221eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
222eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
223eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
122eio_req *eio_close (int fd, eio_cb cb); 224eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
123eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb); 225eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
124eio_req *eio_read (int fd, void *data, size_t length, off_t offset, eio_cb cb); 226eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
125eio_req *eio_write (int fd, void *data, size_t length, off_t offset, eio_cb cb); 227eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
126eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 228eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
127eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 229eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
128eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb); 230eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
129eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb); 231eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
130eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb); 232eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
131eio_req *eio_dup2 (int fd, int fd2, eio_cb cb); 233eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
132eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb); 234eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
133eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb); 235eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
134eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 236eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
135eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb); 237eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
136eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb); 238eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
137eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb); 239eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
138eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb); 240eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
139eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ 241eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
140eio_req *eio_rmdir (const char *path, eio_cb cb); 242eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
141eio_req *eio_unlink (const char *path, eio_cb cb); 243eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
142eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ 244eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
143eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 245eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
144eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 246eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
145eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb); 247eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
146eio_req *eio_link (const char *path, const char *new_path, eio_cb cb); 248eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
147eio_req *eio_symlink (const char *path, const char *new_path, eio_cb cb); 249eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
148eio_req *eio_rename (const char *path, const char *new_path, eio_cb cb); 250eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
251eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
252#endif
149 253
254/*****************************************************************************/
150/* for groups */ 255/* groups */
256
151eio_req *eio_grp (eio_cb cb); 257eio_req *eio_grp (eio_cb cb, void *data);
152void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); 258void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
153void eio_grp_limit (eio_req *grp, int limit); 259void eio_grp_limit (eio_req *grp, int limit);
154void eio_grp_add (eio_req *grp, eio_req *req); 260void eio_grp_add (eio_req *grp, eio_req *req);
155void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 261void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
156 262
157/* cancel a request as soon fast as possible */ 263/*****************************************************************************/
158void eio_cancel (eio_req *req); 264/* request api */
159/* destroy a request that has never been submitted */
160void eio_destroy (eio_req *req);
161 265
162/* true if the request was cancelled, useful in the invoke callback */ 266/* true if the request was cancelled, useful in the invoke callback */
163#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 267#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
164 268
165#define EIO_RESULT(req) ((req)->result) 269#define EIO_RESULT(req) ((req)->result)
166/* returns a pointer to the result buffer allocated by eio */ 270/* returns a pointer to the result buffer allocated by eio */
167#define EIO_BUF(req) ((req)->ptr2) 271#define EIO_BUF(req) ((req)->ptr2)
168#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 272#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
169#define EIO_PATH(req) ((char *)(req)->ptr1) 273#define EIO_PATH(req) ((char *)(req)->ptr1)
170 274
171/*****************************************************************************/
172/* low-level request API */
173
174/* must be used to initialise eio_req's */
175#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
176 memset ((req), 0, sizeof (eio_req)); \
177 (req)->pri = (prio) + EIO_PRI_BIAS; \
178 (req)->finish = (finish_cb); \
179 (req)->destroy = (destroy_cb)
180
181/* submit a request for execution */ 275/* submit a request for execution */
182void eio_submit (eio_req *req); 276void eio_submit (eio_req *req);
277/* cancel a request as soon fast as possible, if possible */
278void eio_cancel (eio_req *req);
279/* destroy a request that has never been submitted */
280void eio_destroy (eio_req *req);
183 281
184/*****************************************************************************/ 282/*****************************************************************************/
185/* convinience functions */ 283/* convinience functions */
186 284
187ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 285ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
188 286
287#ifdef __cplusplus
288}
189#endif 289#endif
190 290
291#endif
292

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines