1 | /* |
1 | /* |
2 | * libeio API header |
2 | * libeio API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009,2010,2011,2012,2015 Marc Alexander Lehmann <libeio@schmorp.de> |
4 | * Copyright (c) 2007,2008,2009,2010,2011,2012,2015,2016,2017 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 | * |
… | |
… | |
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 = 0x01, |
174 | EIO_FALLOC_FL_KEEP_SIZE = 0x01, |
175 | EIO_FALLOC_FL_PUNCH_HOLE = 0x02, |
175 | EIO_FALLOC_FL_PUNCH_HOLE = 0x02, |
176 | EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08, |
176 | EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08, |
177 | EIO_FALLOC_FL_ZERO_RANGE = 0x10 |
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 |
178 | }; |
189 | }; |
179 | |
190 | |
180 | /* 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 */ |
181 | typedef double eio_tstamp; |
192 | typedef double eio_tstamp; |
182 | |
193 | |
… | |
… | |
185 | { |
196 | { |
186 | EIO_CUSTOM, |
197 | EIO_CUSTOM, |
187 | EIO_WD_OPEN, EIO_WD_CLOSE, |
198 | EIO_WD_OPEN, EIO_WD_CLOSE, |
188 | |
199 | |
189 | EIO_CLOSE, EIO_DUP2, |
200 | EIO_CLOSE, EIO_DUP2, |
190 | EIO_SEEK, EIO_READ, EIO_WRITE, |
201 | EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL, |
191 | EIO_READAHEAD, EIO_SENDFILE, |
202 | EIO_READAHEAD, EIO_SENDFILE, |
192 | EIO_FSTAT, EIO_FSTATVFS, |
203 | EIO_FSTAT, EIO_FSTATVFS, |
193 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
204 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
194 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
205 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
195 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
206 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
… | |
… | |
209 | EIO_CHMOD, |
220 | EIO_CHMOD, |
210 | EIO_CHOWN, |
221 | EIO_CHOWN, |
211 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
222 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
212 | EIO_MKNOD, |
223 | EIO_MKNOD, |
213 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
224 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
|
|
225 | EIO_SLURP, /* open + read + close */ |
214 | |
226 | |
215 | EIO_REQ_TYPE_NUM |
227 | EIO_REQ_TYPE_NUM |
216 | }; |
228 | }; |
217 | |
229 | |
218 | /* seek whence modes */ |
230 | /* seek whence modes */ |
… | |
… | |
228 | |
240 | |
229 | /* mlockall constants */ |
241 | /* mlockall constants */ |
230 | enum |
242 | enum |
231 | { |
243 | { |
232 | EIO_MCL_CURRENT = 1, |
244 | EIO_MCL_CURRENT = 1, |
233 | EIO_MCL_FUTURE = 2 |
245 | EIO_MCL_FUTURE = 2, |
|
|
246 | EIO_MCL_ONFAULT = 4 |
234 | }; |
247 | }; |
235 | |
248 | |
236 | /* request priorities */ |
249 | /* request priorities */ |
237 | |
250 | |
238 | enum { |
251 | enum { |
… | |
… | |
249 | eio_req volatile *next; /* private ETP */ |
262 | eio_req volatile *next; /* private ETP */ |
250 | |
263 | |
251 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
264 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
252 | |
265 | |
253 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
266 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
254 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
267 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate, slurp: file offset, mknod: dev_t */ |
255 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
268 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate, slurp: length */ |
256 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
269 | void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */ |
257 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
270 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
258 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
271 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
259 | eio_tstamp nv2; /* utime, futime: mtime */ |
272 | eio_tstamp nv2; /* utime, futime: mtime */ |
260 | |
273 | |
261 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
274 | 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 */ |
275 | 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 */ |
276 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
264 | int errorno; /* errno value on syscall return */ |
277 | int errorno; /* errno value on syscall return */ |
265 | |
278 | |
266 | unsigned char flags; /* private */ |
279 | unsigned char flags; /* private */ |
267 | |
280 | |
… | |
… | |
285 | |
298 | |
286 | /* _private_ request flags */ |
299 | /* _private_ request flags */ |
287 | enum { |
300 | enum { |
288 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
301 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
289 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
302 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
290 | EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ |
|
|
291 | }; |
303 | }; |
292 | |
304 | |
293 | /* undocumented/unsupported/private helper */ |
305 | /* undocumented/unsupported/private helper */ |
294 | /*void eio_page_align (void **addr, size_t *length);*/ |
306 | /*void eio_page_align (void **addr, size_t *length);*/ |
295 | |
307 | |
… | |
… | |
322 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
334 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
323 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
335 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
324 | |
336 | |
325 | /*****************************************************************************/ |
337 | /*****************************************************************************/ |
326 | /* convenience wrappers */ |
338 | /* convenience wrappers */ |
|
|
339 | /* these do not expose advanced syscalls and directory fds */ |
327 | |
340 | |
328 | #ifndef EIO_NO_WRAPPERS |
341 | #ifndef EIO_NO_WRAPPERS |
329 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
342 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
330 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
343 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
331 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
344 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
… | |
… | |
343 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
356 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
344 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
357 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
345 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
358 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
346 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
359 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
347 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
360 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
361 | eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data); |
|
|
362 | eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data); |
348 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
363 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
349 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
364 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
350 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
365 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
351 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
366 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
352 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
367 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
… | |
… | |
369 | eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
384 | eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
370 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
385 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
371 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
386 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
372 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
387 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
373 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
388 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
|
|
389 | eio_req *eio_slurp (const char *path, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
374 | eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data); |
390 | eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data); |
375 | #endif |
391 | #endif |
376 | |
392 | |
377 | /*****************************************************************************/ |
393 | /*****************************************************************************/ |
378 | /* groups */ |
394 | /* groups */ |
… | |
… | |
403 | |
419 | |
404 | /*****************************************************************************/ |
420 | /*****************************************************************************/ |
405 | /* convenience functions */ |
421 | /* convenience functions */ |
406 | |
422 | |
407 | eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
423 | eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
|
|
424 | int eio_mlockall_sync (int flags); |
408 | |
425 | |
409 | #ifdef __cplusplus |
426 | #ifdef __cplusplus |
410 | } |
427 | } |
411 | #endif |
428 | #endif |
412 | |
429 | |