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 | * |
… | |
… | |
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 | EIO_FALLOC_FL_INSERT_RANGE = 0x20, |
|
|
179 | EIO_FALLOC_FL_UNSHARE_RANGE = 0x40 |
|
|
180 | }; |
|
|
181 | |
|
|
182 | /* eio_rename flags */ |
|
|
183 | enum |
|
|
184 | { |
|
|
185 | /* these MUST match the value in linux/fs.h */ |
|
|
186 | EIO_RENAME_NOREPLACE = 1 << 0, |
|
|
187 | EIO_RENAME_EXCHANGE = 1 << 1, |
|
|
188 | EIO_RENAME_WHITEOUT = 1 << 2 |
176 | }; |
189 | }; |
177 | |
190 | |
178 | /* timestamps and differences - feel free to use double in your code directly */ |
191 | /* timestamps and differences - feel free to use double in your code directly */ |
179 | typedef double eio_tstamp; |
192 | typedef double eio_tstamp; |
180 | |
193 | |
… | |
… | |
183 | { |
196 | { |
184 | EIO_CUSTOM, |
197 | EIO_CUSTOM, |
185 | EIO_WD_OPEN, EIO_WD_CLOSE, |
198 | EIO_WD_OPEN, EIO_WD_CLOSE, |
186 | |
199 | |
187 | EIO_CLOSE, EIO_DUP2, |
200 | EIO_CLOSE, EIO_DUP2, |
188 | EIO_SEEK, EIO_READ, EIO_WRITE, |
201 | EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL, |
189 | EIO_READAHEAD, EIO_SENDFILE, |
202 | EIO_READAHEAD, EIO_SENDFILE, |
190 | EIO_FSTAT, EIO_FSTATVFS, |
203 | EIO_FSTAT, EIO_FSTATVFS, |
191 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
204 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
192 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
205 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
193 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
206 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
… | |
… | |
249 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
262 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
250 | |
263 | |
251 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
264 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
252 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
265 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
253 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
266 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
254 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
267 | void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */ |
255 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
268 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
256 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
269 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
257 | eio_tstamp nv2; /* utime, futime: mtime */ |
270 | eio_tstamp nv2; /* utime, futime: mtime */ |
258 | |
271 | |
259 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
272 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
260 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ |
273 | 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 */ |
261 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
274 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
262 | int errorno; /* errno value on syscall return */ |
275 | int errorno; /* errno value on syscall return */ |
263 | |
276 | |
264 | unsigned char flags; /* private */ |
277 | unsigned char flags; /* private */ |
265 | |
278 | |
… | |
… | |
283 | |
296 | |
284 | /* _private_ request flags */ |
297 | /* _private_ request flags */ |
285 | enum { |
298 | enum { |
286 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
299 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
287 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
300 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
288 | EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ |
|
|
289 | }; |
301 | }; |
290 | |
302 | |
291 | /* undocumented/unsupported/private helper */ |
303 | /* undocumented/unsupported/private helper */ |
292 | /*void eio_page_align (void **addr, size_t *length);*/ |
304 | /*void eio_page_align (void **addr, size_t *length);*/ |
293 | |
305 | |
… | |
… | |
320 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
332 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
321 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
333 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
322 | |
334 | |
323 | /*****************************************************************************/ |
335 | /*****************************************************************************/ |
324 | /* convenience wrappers */ |
336 | /* convenience wrappers */ |
|
|
337 | /* these do not expose advanced syscalls and directory fds */ |
325 | |
338 | |
326 | #ifndef EIO_NO_WRAPPERS |
339 | #ifndef EIO_NO_WRAPPERS |
327 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
340 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
328 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
341 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
329 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
342 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
… | |
… | |
341 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
354 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
342 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
355 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
343 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
356 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
344 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
357 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
345 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
358 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
359 | eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data); |
|
|
360 | eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data); |
346 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
361 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
347 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
362 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
348 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
363 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
349 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
364 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
350 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
365 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |