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