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.5 by root, Sun May 11 19:11:05 2008 UTC

1#ifndef EIO_H_ 1#ifndef EIO_H_
2#define EIO_H_ 2#define EIO_H_
3 3
4#include <stddef.h> 4#include <stddef.h>
5#include <stdlib.h> 5#include <sys/types.h>
6 6
7typedef struct eio_req eio_req; 7typedef struct eio_req eio_req;
8 8
9typedef int (*eio_cb)(eio_req *req); 9typedef int (*eio_cb)(eio_req *req);
10 10
11#ifndef EIO_COMMON 11#ifndef EIO_COMMON
12# define EIO_COMMON \ 12# define EIO_COMMON void *data
13 eio_cb finish; \
14 void (*destroy)(eio_req *req);\
15 void *data
16#endif 13#endif
17 14
18enum { 15enum {
19 EIO_QUIT, 16 EIO_QUIT,
20 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 17 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
44 ssize_t result; /* result of syscall, e.g. result = read (... */ 41 ssize_t result; /* result of syscall, e.g. result = read (... */
45 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 42 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */
46 size_t size; /* read, write, readahead, sendfile: length */ 43 size_t size; /* read, write, readahead, sendfile: length */
47 void *ptr1; /* all applicable requests: pathname, old name */ 44 void *ptr1; /* all applicable requests: pathname, old name */
48 void *ptr2; /* all applicable requests: new name or memory buffer */ 45 void *ptr2; /* all applicable requests: new name or memory buffer */
49 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 46 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
50 eio_tstamp nv2; /* utime, futime: mtime */ 47 eio_tstamp nv2; /* utime, futime: mtime */
51 48
52 int type; /* EIO_xxx constant */ 49 int type; /* EIO_xxx constant */
53 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 50 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 */ 51 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
55 long int3; /* chown, fchown: gid */ 52 long int3; /* chown, fchown: gid */
56 int errorno; /* errno value on syscall return */ 53 int errorno; /* errno value on syscall return */
57 54
58 unsigned char flags; /* private */ 55 unsigned char flags; /* private */
59 unsigned char pri; /* the priority */ 56 unsigned char pri; /* the priority */
60 57
58 eio_cb finish;
59 void (*destroy)(eio_req *req);
61 void (*feed)(eio_req *req); 60 void (*feed)(eio_req *req);
62 61
63 EIO_COMMON; 62 EIO_COMMON;
64 63
65 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 64 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
66}; 65};
67 66
68enum { 67enum {
69 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 68 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
70 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 69 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
70 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */
71}; 71};
72 72
73enum { 73enum {
74 EIO_PRI_MIN = -4, 74 EIO_PRI_MIN = -4,
75 EIO_PRI_MAX = 4, 75 EIO_PRI_MAX = 4,
76 76
77 EIO_DEFAULT_PRI = 0, 77 EIO_DEFAULT_PRI = 0,
78 EIO_PRI_BIAS = -EIO_PRI_MIN, 78 EIO_PRI_BIAS = -EIO_PRI_MIN,
79 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1, 79 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
80}; 80};
81 81
82/* returns < 0 on error, errno set 82/* returns < 0 on error, errno set
83 * need_poll, if non-zero, will be called when results are available 83 * 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). 84 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
92 92
93/* stop polling if poll took longer than duration seconds */ 93/* stop polling if poll took longer than duration seconds */
94void eio_set_max_poll_time (eio_tstamp nseconds); 94void eio_set_max_poll_time (eio_tstamp nseconds);
95/* do not handle more then count requests in one call to eio_poll_cb */ 95/* do not handle more then count requests in one call to eio_poll_cb */
96void eio_set_max_poll_reqs (unsigned int nreqs); 96void 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 97
102/* set minimum required number 98/* set minimum required number
103 * maximum wanted number 99 * maximum wanted number
104 * or maximum idle number of threads */ 100 * or maximum idle number of threads */
105void eio_set_min_parallel (unsigned int nthreads); 101void eio_set_min_parallel (unsigned int nthreads);
114/*****************************************************************************/ 110/*****************************************************************************/
115/* high-level request API */ 111/* high-level request API */
116 112
117eio_req *eio_fsync (int fd, eio_cb cb); 113eio_req *eio_fsync (int fd, eio_cb cb);
118eio_req *eio_fdatasync (int fd, eio_cb cb); 114eio_req *eio_fdatasync (int fd, eio_cb cb);
119eio_req *eio_dupclose (int fd, eio_cb cb);
120eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb); 115eio_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); 116eio_req *eio_read (int fd, off_t offset, size_t length, void *data, eio_cb cb);
122eio_req *eio_write (int fd, off_t offs, size_t length, char *data, eio_cb cb); 117eio_req *eio_write (int fd, off_t offset, size_t length, void *data, eio_cb cb);
123eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */ 118eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
124eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 119eio_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); 120eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb);
126eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb); 121eio_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); 122eio_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); 123eio_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); 124eio_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); 125eio_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 */ 126eio_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 */ 127eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
133eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocates dynamically */ 128eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */
134eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 129eio_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); 130eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb);
131eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb);
136eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb); 132eio_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); 133eio_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); 134eio_req *eio_unlink (const char *path, eio_cb cb);
140eio_req *eio_rmdir (const char *path, eio_cb cb); 135eio_req *eio_rmdir (const char *path, eio_cb cb);
141eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ 136eio_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); 137eio_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 */ 138eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */
144eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 139eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */
145 140
146/* for groups */ 141/* for groups */
147eio_req *eio_grp (eio_cb cb); 142eio_req *eio_grp (eio_cb cb);
148void eio_grp_feed (eio_req *grp, int limit, void (*feed)(eio_req *req)); 143void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
144void eio_grp_limit (eio_req *grp, int limit);
149void eio_grp_add (eio_req *grp, eio_req *req); 145void eio_grp_add (eio_req *grp, eio_req *req);
150void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 146void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
151 147
152/*****************************************************************************/ 148/*****************************************************************************/
153/* low-level request API */ 149/* low-level request API */
167/* cancel a request as soon fast as possible */ 163/* cancel a request as soon fast as possible */
168void eio_cancel (eio_req *req); 164void eio_cancel (eio_req *req);
169/* destroy a request that has never been submitted */ 165/* destroy a request that has never been submitted */
170void eio_destroy (eio_req *req); 166void eio_destroy (eio_req *req);
171 167
168/*****************************************************************************/
169/* convinience functions */
170
171/*ssize_t eio_sendfile (int ofd, int ifd, off_t offset, size_t count)*/
172
172#endif 173#endif
173 174

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines