1 | /* |
1 | /* |
2 | * libeio API header |
2 | * libeio API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libeio@schmorp.de> |
4 | * Copyright (c) 2007,2008,2009,2010,2011,2012,2015,2016 Marc Alexander Lehmann <libeio@schmorp.de> |
5 | * All rights reserved. |
5 | * All rights reserved. |
6 | * |
6 | * |
7 | * Redistribution and use in source and binary forms, with or without modifica- |
7 | * Redistribution and use in source and binary forms, with or without modifica- |
8 | * tion, are permitted provided that the following conditions are met: |
8 | * tion, are permitted provided that the following conditions are met: |
9 | * |
9 | * |
10 | * 1. Redistributions of source code must retain the above copyright notice, |
10 | * 1. Redistributions of source code must retain the above copyright notice, |
11 | * this list of conditions and the following disclaimer. |
11 | * this list of conditions and the following disclaimer. |
12 | * |
12 | * |
13 | * 2. Redistributions in binary form must reproduce the above copyright |
13 | * 2. Redistributions in binary form must reproduce the above copyright |
14 | * notice, this list of conditions and the following disclaimer in the |
14 | * notice, this list of conditions and the following disclaimer in the |
15 | * documentation and/or other materials provided with the distribution. |
15 | * documentation and/or other materials provided with the distribution. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
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- |
18 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
19 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
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- |
20 | * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
21 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
21 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
… | |
… | |
169 | |
169 | |
170 | /* eio_fallocate flags */ |
170 | /* eio_fallocate flags */ |
171 | enum |
171 | enum |
172 | { |
172 | { |
173 | /* these MUST match the value in linux/falloc.h */ |
173 | /* these MUST match the value in linux/falloc.h */ |
174 | EIO_FALLOC_FL_KEEP_SIZE = 1, |
174 | EIO_FALLOC_FL_KEEP_SIZE = 0x01, |
175 | EIO_FALLOC_FL_PUNCH_HOLE = 2 |
175 | EIO_FALLOC_FL_PUNCH_HOLE = 0x02, |
|
|
176 | EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08, |
|
|
177 | EIO_FALLOC_FL_ZERO_RANGE = 0x10 |
|
|
178 | }; |
|
|
179 | |
|
|
180 | /* eio_rename flags */ |
|
|
181 | enum |
|
|
182 | { |
|
|
183 | /* these MUST match the value in linux/fs.h */ |
|
|
184 | EIO_RENAME_NOREPLACE = 1 << 0, |
|
|
185 | EIO_RENAME_EXCHANGE = 1 << 1, |
|
|
186 | EIO_RENAME_WHITEOUT = 1 << 2 |
176 | }; |
187 | }; |
177 | |
188 | |
178 | /* timestamps and differences - feel free to use double in your code directly */ |
189 | /* timestamps and differences - feel free to use double in your code directly */ |
179 | typedef double eio_tstamp; |
190 | typedef double eio_tstamp; |
180 | |
191 | |
… | |
… | |
183 | { |
194 | { |
184 | EIO_CUSTOM, |
195 | EIO_CUSTOM, |
185 | EIO_WD_OPEN, EIO_WD_CLOSE, |
196 | EIO_WD_OPEN, EIO_WD_CLOSE, |
186 | |
197 | |
187 | EIO_CLOSE, EIO_DUP2, |
198 | EIO_CLOSE, EIO_DUP2, |
188 | EIO_SEEK, EIO_READ, EIO_WRITE, |
199 | EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL, |
189 | EIO_READAHEAD, EIO_SENDFILE, |
200 | EIO_READAHEAD, EIO_SENDFILE, |
190 | EIO_FSTAT, EIO_FSTATVFS, |
201 | EIO_FSTAT, EIO_FSTATVFS, |
191 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
202 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
192 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
203 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
193 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
204 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
… | |
… | |
195 | EIO_GROUP, EIO_NOP, |
206 | EIO_GROUP, EIO_NOP, |
196 | EIO_BUSY, |
207 | EIO_BUSY, |
197 | |
208 | |
198 | /* these use wd + ptr1, but are emulated */ |
209 | /* these use wd + ptr1, but are emulated */ |
199 | EIO_REALPATH, |
210 | EIO_REALPATH, |
200 | EIO_STATVFS, |
|
|
201 | EIO_READDIR, |
211 | EIO_READDIR, |
202 | |
212 | |
203 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
213 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
204 | EIO_OPEN, |
214 | EIO_OPEN, |
205 | EIO_STAT, EIO_LSTAT, |
215 | EIO_STAT, EIO_LSTAT, EIO_STATVFS, |
206 | EIO_TRUNCATE, |
216 | EIO_TRUNCATE, |
207 | EIO_UTIME, |
217 | EIO_UTIME, |
208 | EIO_CHMOD, |
218 | EIO_CHMOD, |
209 | EIO_CHOWN, |
219 | EIO_CHOWN, |
210 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
220 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
… | |
… | |
250 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
260 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
251 | |
261 | |
252 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
262 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
253 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
263 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
254 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
264 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
255 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
265 | void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */ |
256 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
266 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
257 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
267 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
258 | eio_tstamp nv2; /* utime, futime: mtime */ |
268 | eio_tstamp nv2; /* utime, futime: mtime */ |
259 | |
269 | |
260 | int type; /* EIO_xxx constant ETP */ |
|
|
261 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
270 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
262 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ |
271 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, fcntl, ioctl: request, sync_file_range, fallocate, rename: flags */ |
263 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
272 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
264 | int errorno; /* errno value on syscall return */ |
273 | int errorno; /* errno value on syscall return */ |
265 | |
274 | |
|
|
275 | unsigned char flags; /* private */ |
|
|
276 | |
|
|
277 | signed char type;/* EIO_xxx constant ETP */ |
|
|
278 | signed char pri; /* the priority ETP */ |
266 | #if __i386 || __amd64 |
279 | #if __i386 || __amd64 |
267 | unsigned char cancelled; |
280 | unsigned char cancelled; /* ETP */ |
268 | #else |
281 | #else |
269 | sig_atomic_t cancelled; |
282 | sig_atomic_t cancelled; /* ETP */ |
270 | #endif |
283 | #endif |
271 | |
|
|
272 | unsigned char flags; /* private */ |
|
|
273 | signed char pri; /* the priority */ |
|
|
274 | |
284 | |
275 | void *data; |
285 | void *data; |
276 | eio_cb finish; |
286 | eio_cb finish; |
277 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
287 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
278 | void (*feed)(eio_req *req); /* only used for group requests */ |
288 | void (*feed)(eio_req *req); /* only used for group requests */ |
279 | |
289 | |
280 | EIO_REQ_MEMBERS |
290 | EIO_REQ_MEMBERS |
281 | |
291 | |
282 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
292 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */ |
283 | }; |
293 | }; |
284 | |
294 | |
285 | /* _private_ request flags */ |
295 | /* _private_ request flags */ |
286 | enum { |
296 | enum { |
287 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
297 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
288 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
298 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
289 | EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ |
|
|
290 | }; |
299 | }; |
291 | |
300 | |
292 | /* undocumented/unsupported/private helper */ |
301 | /* undocumented/unsupported/private helper */ |
293 | /*void eio_page_align (void **addr, size_t *length);*/ |
302 | /*void eio_page_align (void **addr, size_t *length);*/ |
294 | |
303 | |
… | |
… | |
342 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
351 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
343 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
352 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
344 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
353 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
345 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
354 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
346 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
355 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
356 | eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data); |
|
|
357 | eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data); |
347 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
358 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
348 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
359 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
349 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
360 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
350 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
361 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
351 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
362 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |