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

Comparing libeio/eio.h (file contents):
Revision 1.1 by root, Sat May 10 17:16:39 2008 UTC vs.
Revision 1.12 by root, Sat May 17 12:17:25 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
4#include <stddef.h> 43#include <stddef.h>
5#include <stdlib.h> 44#include <sys/types.h>
6 45
7typedef struct eio_req eio_req; 46typedef struct eio_req eio_req;
8 47
9typedef int (*eio_cb)(eio_req *req); 48typedef int (*eio_cb)(eio_req *req);
10 49
11#ifndef EIO_COMMON 50#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON \ 51# define EIO_REQ_MEMBERS
13 eio_cb finish; \ 52#endif
14 void (*destroy)(eio_req *req);\ 53
15 void *data 54#ifndef EIO_STRUCT_STAT
55# define EIO_STRUCT_STAT struct stat
16#endif 56#endif
17 57
18enum { 58enum {
19 EIO_QUIT,
20 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 59 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
21 EIO_READ, EIO_WRITE, 60 EIO_READ, EIO_WRITE,
22 EIO_READAHEAD, EIO_SENDFILE, 61 EIO_READAHEAD, EIO_SENDFILE,
23 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 62 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
24 EIO_TRUNCATE, EIO_FTRUNCATE, 63 EIO_TRUNCATE, EIO_FTRUNCATE,
… …
37 76
38/* eio request structure */ 77/* eio request structure */
39/* this structure is mostly read-only */ 78/* this structure is mostly read-only */
40struct eio_req 79struct eio_req
41{ 80{
42 eio_req volatile *next; /* private */ 81 eio_req volatile *next; /* private ETP */
43 82
44 ssize_t result; /* result of syscall, e.g. result = read (... */ 83 ssize_t result; /* result of syscall, e.g. result = read (... */
45 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 84 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */
46 size_t size; /* read, write, readahead, sendfile: length */ 85 size_t size; /* read, write, readahead, sendfile: length */
47 void *ptr1; /* all applicable requests: pathname, old name */ 86 void *ptr1; /* all applicable requests: pathname, old name */
48 void *ptr2; /* all applicable requests: new name or memory buffer */ 87 void *ptr2; /* all applicable requests: new name or memory buffer */
49 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 88 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
50 eio_tstamp nv2; /* utime, futime: mtime */ 89 eio_tstamp nv2; /* utime, futime: mtime */
51 90
52 int type; /* EIO_xxx constant */ 91 int type; /* EIO_xxx constant ETP */
53 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 92 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */
54 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 93 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
55 long int3; /* chown, fchown: gid */ 94 long int3; /* chown, fchown: gid */
56 int errorno; /* errno value on syscall return */ 95 int errorno; /* errno value on syscall return */
57 96
58 unsigned char flags; /* private */ 97 unsigned char flags; /* private */
59 unsigned char pri; /* the priority */ 98 signed char pri; /* the priority */
60 99
61 void (*feed)(eio_req *req); 100 void *data;
101 eio_cb finish;
102 void (*destroy)(eio_req *req); /* called when requets no longer needed */
103 void (*feed)(eio_req *req); /* only used for group requests */
62 104
63 EIO_COMMON; 105 EIO_REQ_MEMBERS
64 106
65 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 107 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
66}; 108};
67 109
68enum { 110enum {
69 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 111 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
70 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 112 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
113 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */
71}; 114};
72 115
73enum { 116enum {
74 EIO_PRI_MIN = -4, 117 EIO_PRI_MIN = -4,
75 EIO_PRI_MAX = 4, 118 EIO_PRI_MAX = 4,
76 119
77 EIO_DEFAULT_PRI = 0, 120 EIO_PRI_DEFAULT = 0,
78 EIO_PRI_BIAS = -EIO_PRI_MIN,
79 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1,
80}; 121};
81 122
82/* returns < 0 on error, errno set 123/* returns < 0 on error, errno set
83 * need_poll, if non-zero, will be called when results are available 124 * need_poll, if non-zero, will be called when results are available
84 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 125 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
… …
92 133
93/* stop polling if poll took longer than duration seconds */ 134/* stop polling if poll took longer than duration seconds */
94void eio_set_max_poll_time (eio_tstamp nseconds); 135void eio_set_max_poll_time (eio_tstamp nseconds);
95/* do not handle more then count requests in one call to eio_poll_cb */ 136/* do not handle more then count requests in one call to eio_poll_cb */
96void eio_set_max_poll_reqs (unsigned int nreqs); 137void eio_set_max_poll_reqs (unsigned int nreqs);
97/* when != 0, then eio_submit blocks as long as nready > count */
98void eio_set_max_outstanding (unsigned int maxreqs);
99/* set maxinum number of idle threads */
100void eio_set_max_idle (unsigned int nthreads);
101 138
102/* set minimum required number 139/* set minimum required number
103 * maximum wanted number 140 * maximum wanted number
104 * or maximum idle number of threads */ 141 * or maximum idle number of threads */
105void eio_set_min_parallel (unsigned int nthreads); 142void eio_set_min_parallel (unsigned int nthreads);
… …
110unsigned int eio_nready (void); /* number of not-yet handled requests */ 147unsigned int eio_nready (void); /* number of not-yet handled requests */
111unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 148unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
112unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 149unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113 150
114/*****************************************************************************/ 151/*****************************************************************************/
115/* high-level request API */ 152/* convinience wrappers */
116 153
117eio_req *eio_fsync (int fd, eio_cb cb); 154#ifndef EIO_NO_WRAPPERS
118eio_req *eio_fdatasync (int fd, eio_cb cb); 155eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
119eio_req *eio_dupclose (int fd, eio_cb cb);
120eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb);
121eio_req *eio_read (int fd, off_t offs, size_t length, char *data, eio_cb cb);
122eio_req *eio_write (int fd, off_t offs, size_t length, char *data, eio_cb cb);
123eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
124eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
125eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb);
126eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb);
127eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb);
128eio_req *eio_dup2 (int fd, int fd2, eio_cb cb);
129eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb);
130eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb);
131eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
132eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
133eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */
134eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb);
135eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb);
136eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb);
137eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb);
138eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb);
139eio_req *eio_unlink (const char *path, eio_cb cb);
140eio_req *eio_rmdir (const char *path, eio_cb cb);
141eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */
142eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb);
143eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ 156eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
144eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 157eio_req *eio_sync (int pri, eio_cb cb, void *data);
158eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
159eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
160eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
161eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
162eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
163eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
164eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
165eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
166eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
167eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
168eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
169eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
170eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
171eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
172eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
173eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
174eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
175eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
176eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
177eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
178eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
179eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
180eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
181eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
182eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
183eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
184eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
185eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
186eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
187#endif
145 188
189/*****************************************************************************/
146/* for groups */ 190/* groups */
191
147eio_req *eio_grp (eio_cb cb); 192eio_req *eio_grp (eio_cb cb, void *data);
148void eio_grp_feed (eio_req *grp, int limit, void (*feed)(eio_req *req)); 193void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
194void eio_grp_limit (eio_req *grp, int limit);
149void eio_grp_add (eio_req *grp, eio_req *req); 195void eio_grp_add (eio_req *grp, eio_req *req);
150void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 196void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
151 197
152/*****************************************************************************/ 198/*****************************************************************************/
153/* low-level request API */ 199/* request api */
154
155/* must be used to initialise eio_req's */
156#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
157 memset ((req), 0, sizeof (eio_req)); \
158 (req)->pri = (prio) + EIO_PRI_BIAS; \
159 (req)->finish = (finish_cb); \
160 (req)->destroy = (destroy_cb)
161 200
162/* true if the request was cancelled, useful in the invoke callback */ 201/* true if the request was cancelled, useful in the invoke callback */
163#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 202#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
164 203
204#define EIO_RESULT(req) ((req)->result)
205/* returns a pointer to the result buffer allocated by eio */
206#define EIO_BUF(req) ((req)->ptr2)
207#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
208#define EIO_PATH(req) ((char *)(req)->ptr1)
209
165/* submit a request for execution */ 210/* submit a request for execution */
166void eio_submit (eio_req *req); 211void eio_submit (eio_req *req);
167/* cancel a request as soon fast as possible */ 212/* cancel a request as soon fast as possible, if possible */
168void eio_cancel (eio_req *req); 213void eio_cancel (eio_req *req);
169/* destroy a request that has never been submitted */ 214/* destroy a request that has never been submitted */
170void eio_destroy (eio_req *req); 215void eio_destroy (eio_req *req);
171 216
172#endif 217/*****************************************************************************/
218/* convinience functions */
173 219
220ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
221
222#endif
223

Diff Legend

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