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

Comparing libeio/eio.h (file contents):
Revision 1.7 by root, Tue May 13 17:08:15 2008 UTC vs.
Revision 1.17 by root, Sun Oct 12 22:30:33 2008 UTC

1/*
2 * libeio API header
3 *
4 * Copyright (c) 2007,2008 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;
8 51
9typedef int (*eio_cb)(eio_req *req); 52typedef int (*eio_cb)(eio_req *req);
10 53
11#ifndef EIO_COMMON 54#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON void *data 55# define EIO_REQ_MEMBERS
13#endif 56#endif
14 57
15#ifndef EIO_STRUCT_STAT 58#ifndef EIO_STRUCT_STAT
16# define EIO_STRUCT_STAT struct stat 59# define EIO_STRUCT_STAT struct stat
17#endif 60#endif
18 61
19enum { 62enum {
20 EIO_QUIT, 63 EIO_CUSTOM,
21 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 64 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
22 EIO_READ, EIO_WRITE, 65 EIO_READ, EIO_WRITE,
23 EIO_READAHEAD, EIO_SENDFILE, 66 EIO_READAHEAD, EIO_SENDFILE,
24 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 67 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
25 EIO_TRUNCATE, EIO_FTRUNCATE, 68 EIO_TRUNCATE, EIO_FTRUNCATE,
26 EIO_UTIME, EIO_FUTIME, 69 EIO_UTIME, EIO_FUTIME,
27 EIO_CHMOD, EIO_FCHMOD, 70 EIO_CHMOD, EIO_FCHMOD,
28 EIO_CHOWN, EIO_FCHOWN, 71 EIO_CHOWN, EIO_FCHOWN,
29 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 72 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_MSYNC, EIO_MTOUCH,
30 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 73 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
31 EIO_MKNOD, EIO_READDIR, 74 EIO_MKNOD, EIO_READDIR,
32 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 75 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
33 EIO_GROUP, EIO_NOP, 76 EIO_GROUP, EIO_NOP,
34 EIO_BUSY, 77 EIO_BUSY,
… …
38 81
39/* eio request structure */ 82/* eio request structure */
40/* this structure is mostly read-only */ 83/* this structure is mostly read-only */
41struct eio_req 84struct eio_req
42{ 85{
43 eio_req volatile *next; /* private */ 86 eio_req volatile *next; /* private ETP */
44 87
45 ssize_t result; /* result of syscall, e.g. result = read (... */ 88 ssize_t result; /* result of syscall, e.g. result = read (... */
46 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 89 off_t offs; /* read, write, truncate, readahead: file offset */
47 size_t size; /* read, write, readahead, sendfile: length */ 90 size_t size; /* read, write, readahead, sendfile, msync: length */
48 void *ptr1; /* all applicable requests: pathname, old name */ 91 void *ptr1; /* all applicable requests: pathname, old name */
49 void *ptr2; /* all applicable requests: new name or memory buffer */ 92 void *ptr2; /* all applicable requests: new name or memory buffer */
50 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 93 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
51 eio_tstamp nv2; /* utime, futime: mtime */ 94 eio_tstamp nv2; /* utime, futime: mtime */
52 95
53 int type; /* EIO_xxx constant */ 96 int type; /* EIO_xxx constant ETP */
54 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 97 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync: flags */
55 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 98 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
56 long int3; /* chown, fchown: gid */ 99 long int3; /* chown, fchown: gid; mknod: dev_t */
57 int errorno; /* errno value on syscall return */ 100 int errorno; /* errno value on syscall return */
58 101
59 unsigned char flags; /* private */ 102 unsigned char flags; /* private */
60 unsigned char pri; /* the priority */ 103 signed char pri; /* the priority */
61 104
105 void *data;
62 eio_cb finish; 106 eio_cb finish;
63 void (*destroy)(eio_req *req); 107 void (*destroy)(eio_req *req); /* called when requets no longer needed */
64 void (*feed)(eio_req *req); 108 void (*feed)(eio_req *req); /* only used for group requests */
65 109
66 EIO_COMMON; 110 EIO_REQ_MEMBERS
67 111
68 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 112 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
69}; 113};
70 114
115/* _private_ flags */
71enum { 116enum {
72 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 117 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
73 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 118 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
74 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 119 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
120 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
75}; 121};
76 122
77enum { 123enum {
78 EIO_PRI_MIN = -4, 124 EIO_PRI_MIN = -4,
79 EIO_PRI_MAX = 4, 125 EIO_PRI_MAX = 4,
80
81 EIO_PRI_DEFAULT = 0, 126 EIO_PRI_DEFAULT = 0,
82 EIO_PRI_BIAS = -EIO_PRI_MIN,
83 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
84}; 127};
85 128
86/* returns < 0 on error, errno set 129/* returns < 0 on error, errno set
87 * need_poll, if non-zero, will be called when results are available 130 * 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). 131 * 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 */ 153unsigned int eio_nready (void); /* number of not-yet handled requests */
111unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 154unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
112unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 155unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113 156
114/*****************************************************************************/ 157/*****************************************************************************/
115/* high-level request API */ 158/* convinience wrappers */
116 159
160#ifndef EIO_NO_WRAPPERS
117eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 161eio_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, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 162eio_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 (int pri, eio_cb cb, void *data); 163eio_req *eio_sync (int pri, eio_cb cb, void *data);
120eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 164eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
121eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 165eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
166eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
167eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
122eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 168eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
123eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 169eio_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 *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 170eio_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 *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 171eio_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, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 172eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
… …
144eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 190eio_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, int pri, eio_cb cb, void *data); 191eio_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, int pri, eio_cb cb, void *data); 192eio_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, int pri, eio_cb cb, void *data); 193eio_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, int pri, eio_cb cb, void *data); 194eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
195eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
196#endif
149 197
198/*****************************************************************************/
150/* for groups */ 199/* groups */
200
151eio_req *eio_grp (eio_cb cb, void *data); 201eio_req *eio_grp (eio_cb cb, void *data);
152void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); 202void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
153void eio_grp_limit (eio_req *grp, int limit); 203void eio_grp_limit (eio_req *grp, int limit);
154void eio_grp_add (eio_req *grp, eio_req *req); 204void eio_grp_add (eio_req *grp, eio_req *req);
155void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 205void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
156 206
157/* cancel a request as soon fast as possible */ 207/*****************************************************************************/
158void eio_cancel (eio_req *req); 208/* request api */
159/* destroy a request that has never been submitted */
160void eio_destroy (eio_req *req);
161 209
162/* true if the request was cancelled, useful in the invoke callback */ 210/* true if the request was cancelled, useful in the invoke callback */
163#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 211#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
164 212
165#define EIO_RESULT(req) ((req)->result) 213#define EIO_RESULT(req) ((req)->result)
166/* returns a pointer to the result buffer allocated by eio */ 214/* returns a pointer to the result buffer allocated by eio */
167#define EIO_BUF(req) ((req)->ptr2) 215#define EIO_BUF(req) ((req)->ptr2)
168#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 216#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
169#define EIO_PATH(req) ((char *)(req)->ptr1) 217#define EIO_PATH(req) ((char *)(req)->ptr1)
170 218
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 */ 219/* submit a request for execution */
182void eio_submit (eio_req *req); 220void eio_submit (eio_req *req);
221/* cancel a request as soon fast as possible, if possible */
222void eio_cancel (eio_req *req);
223/* destroy a request that has never been submitted */
224void eio_destroy (eio_req *req);
183 225
184/*****************************************************************************/ 226/*****************************************************************************/
185/* convinience functions */ 227/* convinience functions */
186 228
187ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 229ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
188 230
231#ifdef __cplusplus
232}
189#endif 233#endif
190 234
235#endif
236

Diff Legend

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