1 | /* |
1 | /* |
2 | * libeio API header |
2 | * libeio API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009,2010,2011 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 | * |
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, |
… | |
… | |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
91 | #endif |
91 | #endif |
92 | |
92 | |
93 | /* managing working directories */ |
93 | /* managing working directories */ |
94 | |
94 | |
95 | typedef void *eio_wd; |
95 | typedef struct eio_pwd *eio_wd; |
96 | |
96 | |
97 | #define EIO_CWD 0 /* the current working directory of the process, guaranteed to be a null pointer */ |
97 | #define EIO_CWD 0 /* the current working directory of the process, guaranteed to be a null pointer */ |
98 | #define EIO_INVALID_WD ((eio_wd)(int)-1) /* failure return for eio_wd_open */ |
98 | #define EIO_INVALID_WD ((eio_wd)(int)-1) /* failure return for eio_wd_open */ |
99 | |
99 | |
100 | eio_wd eio_wd_open_sync (eio_wd wd, const char *path); |
100 | eio_wd eio_wd_open_sync (eio_wd wd, const char *path); |
… | |
… | |
168 | }; |
168 | }; |
169 | |
169 | |
170 | /* eio_fallocate flags */ |
170 | /* eio_fallocate flags */ |
171 | enum |
171 | enum |
172 | { |
172 | { |
173 | EIO_FALLOC_FL_KEEP_SIZE = 1 /* 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, |
|
|
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 |
174 | }; |
189 | }; |
175 | |
190 | |
176 | /* 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 */ |
177 | typedef double eio_tstamp; |
192 | typedef double eio_tstamp; |
178 | |
193 | |
… | |
… | |
181 | { |
196 | { |
182 | EIO_CUSTOM, |
197 | EIO_CUSTOM, |
183 | EIO_WD_OPEN, EIO_WD_CLOSE, |
198 | EIO_WD_OPEN, EIO_WD_CLOSE, |
184 | |
199 | |
185 | EIO_CLOSE, EIO_DUP2, |
200 | EIO_CLOSE, EIO_DUP2, |
186 | EIO_READ, EIO_WRITE, |
201 | EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL, |
187 | EIO_READAHEAD, EIO_SENDFILE, |
202 | EIO_READAHEAD, EIO_SENDFILE, |
188 | EIO_FSTAT, EIO_FSTATVFS, |
203 | EIO_FSTAT, EIO_FSTATVFS, |
189 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
204 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
190 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
205 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
191 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
206 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
… | |
… | |
193 | EIO_GROUP, EIO_NOP, |
208 | EIO_GROUP, EIO_NOP, |
194 | EIO_BUSY, |
209 | EIO_BUSY, |
195 | |
210 | |
196 | /* these use wd + ptr1, but are emulated */ |
211 | /* these use wd + ptr1, but are emulated */ |
197 | EIO_REALPATH, |
212 | EIO_REALPATH, |
198 | EIO_STATVFS, |
|
|
199 | EIO_READDIR, |
213 | EIO_READDIR, |
200 | |
214 | |
201 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
215 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
202 | EIO_OPEN, |
216 | EIO_OPEN, |
203 | EIO_STAT, EIO_LSTAT, |
217 | EIO_STAT, EIO_LSTAT, EIO_STATVFS, |
204 | EIO_TRUNCATE, |
218 | EIO_TRUNCATE, |
205 | EIO_UTIME, |
219 | EIO_UTIME, |
206 | EIO_CHMOD, |
220 | EIO_CHMOD, |
207 | EIO_CHOWN, |
221 | EIO_CHOWN, |
208 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
222 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
209 | EIO_MKNOD, |
223 | EIO_MKNOD, |
210 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
224 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
|
|
225 | EIO_SLURP, /* open + read + close */ |
211 | |
226 | |
212 | EIO_REQ_TYPE_NUM |
227 | EIO_REQ_TYPE_NUM |
213 | }; |
228 | }; |
214 | |
229 | |
|
|
230 | /* seek whence modes */ |
|
|
231 | /* these are guaranteed to hasve the traditional 0, 1, 2 values, */ |
|
|
232 | /* so you might as wlel use those */ |
|
|
233 | enum |
|
|
234 | { |
|
|
235 | EIO_SEEK_SET = 0, |
|
|
236 | EIO_SEEK_CUR = 1, |
|
|
237 | EIO_SEEK_END = 2 |
|
|
238 | }; |
|
|
239 | |
|
|
240 | |
215 | /* mlockall constants */ |
241 | /* mlockall constants */ |
216 | enum |
242 | enum |
217 | { |
243 | { |
218 | EIO_MCL_CURRENT = 1, |
244 | EIO_MCL_CURRENT = 1, |
219 | EIO_MCL_FUTURE = 2, |
245 | EIO_MCL_FUTURE = 2 |
220 | }; |
246 | }; |
221 | |
247 | |
222 | /* request priorities */ |
248 | /* request priorities */ |
223 | |
249 | |
224 | enum { |
250 | enum { |
225 | EIO_PRI_MIN = -4, |
251 | EIO_PRI_MIN = -4, |
226 | EIO_PRI_MAX = 4, |
252 | EIO_PRI_MAX = 4, |
227 | EIO_PRI_DEFAULT = 0, |
253 | EIO_PRI_DEFAULT = 0 |
228 | }; |
254 | }; |
229 | |
255 | |
230 | /* eio request structure */ |
256 | /* eio request structure */ |
231 | /* this structure is mostly read-only */ |
257 | /* this structure is mostly read-only */ |
232 | /* when initialising it, all members must be zero-initialised */ |
258 | /* when initialising it, all members must be zero-initialised */ |
… | |
… | |
235 | eio_req volatile *next; /* private ETP */ |
261 | eio_req volatile *next; /* private ETP */ |
236 | |
262 | |
237 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
263 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
238 | |
264 | |
239 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
265 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
240 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
266 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate, slurp: file offset, mknod: dev_t */ |
241 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
267 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate, slurp: length */ |
242 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
268 | void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */ |
243 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
269 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
244 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
270 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
245 | eio_tstamp nv2; /* utime, futime: mtime */ |
271 | eio_tstamp nv2; /* utime, futime: mtime */ |
246 | |
272 | |
247 | int type; /* EIO_xxx constant ETP */ |
|
|
248 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
273 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
249 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */ |
274 | 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 */ |
250 | long int3; /* chown, fchown: gid; rename: working directory of new name */ |
275 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
251 | int errorno; /* errno value on syscall return */ |
276 | int errorno; /* errno value on syscall return */ |
252 | |
277 | |
|
|
278 | unsigned char flags; /* private */ |
|
|
279 | |
|
|
280 | signed char type;/* EIO_xxx constant ETP */ |
|
|
281 | signed char pri; /* the priority ETP */ |
253 | #if __i386 || __amd64 |
282 | #if __i386 || __amd64 |
254 | unsigned char cancelled; |
283 | unsigned char cancelled; /* ETP */ |
255 | #else |
284 | #else |
256 | sig_atomic_t cancelled; |
285 | sig_atomic_t cancelled; /* ETP */ |
257 | #endif |
286 | #endif |
258 | |
|
|
259 | unsigned char flags; /* private */ |
|
|
260 | signed char pri; /* the priority */ |
|
|
261 | |
287 | |
262 | void *data; |
288 | void *data; |
263 | eio_cb finish; |
289 | eio_cb finish; |
264 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
290 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
265 | void (*feed)(eio_req *req); /* only used for group requests */ |
291 | void (*feed)(eio_req *req); /* only used for group requests */ |
266 | |
292 | |
267 | EIO_REQ_MEMBERS |
293 | EIO_REQ_MEMBERS |
268 | |
294 | |
269 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
295 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */ |
270 | }; |
296 | }; |
271 | |
297 | |
272 | /* _private_ request flags */ |
298 | /* _private_ request flags */ |
273 | enum { |
299 | enum { |
274 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
300 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
275 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
301 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
276 | EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ |
|
|
277 | }; |
302 | }; |
278 | |
303 | |
279 | /* undocumented/unsupported/private helper */ |
304 | /* undocumented/unsupported/private helper */ |
280 | /*void eio_page_align (void **addr, size_t *length);*/ |
305 | /*void eio_page_align (void **addr, size_t *length);*/ |
281 | |
306 | |
… | |
… | |
308 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
333 | unsigned int eio_npending (void); /* number of finished but unhandled requests */ |
309 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
334 | unsigned int eio_nthreads (void); /* number of worker threads in use currently */ |
310 | |
335 | |
311 | /*****************************************************************************/ |
336 | /*****************************************************************************/ |
312 | /* convenience wrappers */ |
337 | /* convenience wrappers */ |
|
|
338 | /* these do not expose advanced syscalls and directory fds */ |
313 | |
339 | |
314 | #ifndef EIO_NO_WRAPPERS |
340 | #ifndef EIO_NO_WRAPPERS |
|
|
341 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
|
|
342 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
315 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
343 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
316 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
344 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
317 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
345 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
318 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
346 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
319 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
347 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
… | |
… | |
324 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
352 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
325 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
353 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
326 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
354 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
327 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
355 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
328 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
356 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
|
|
357 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
329 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
358 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
330 | 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_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
|
|
360 | eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data); |
|
|
361 | eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data); |
331 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
362 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
332 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
363 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
333 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
364 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
334 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
365 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
335 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
366 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
… | |
… | |
352 | eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
383 | eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
353 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
384 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
354 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
385 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
355 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
386 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
356 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
387 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
|
|
388 | eio_req *eio_slurp (const char *path, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
357 | eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data); |
389 | eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data); |
358 | #endif |
390 | #endif |
359 | |
391 | |
360 | /*****************************************************************************/ |
392 | /*****************************************************************************/ |
361 | /* groups */ |
393 | /* groups */ |