ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
Revision: 1.12
Committed: Sat May 17 12:17:25 2008 UTC (16 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.11: +41 -5 lines
Log Message: 
*** empty log message ***

File Contents

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