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