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 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, |
… | |
… | |
67 | #endif |
67 | #endif |
68 | |
68 | |
69 | #ifdef _WIN32 |
69 | #ifdef _WIN32 |
70 | typedef int eio_uid_t; |
70 | typedef int eio_uid_t; |
71 | typedef int eio_gid_t; |
71 | typedef int eio_gid_t; |
72 | #ifdef _MINGW32_ /* no intptr_t */ |
72 | #ifdef __MINGW32__ /* no intptr_t */ |
73 | typedef ssize_t eio_ssize_t; |
73 | typedef ssize_t eio_ssize_t; |
74 | #else |
74 | #else |
75 | typedef intptr_t eio_ssize_t; /* or SSIZE_T */ |
75 | typedef intptr_t eio_ssize_t; /* or SSIZE_T */ |
76 | #endif |
76 | #endif |
77 | #if __GNUC__ |
77 | #if __GNUC__ |
78 | typedef long long eio_ino_t; |
78 | typedef long long eio_ino_t; /* signed for compatibility to msvc */ |
79 | #else |
79 | #else |
80 | typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ |
80 | typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ |
81 | #endif |
81 | #endif |
82 | #else |
82 | #else |
83 | typedef uid_t eio_uid_t; |
83 | typedef uid_t eio_uid_t; |
… | |
… | |
87 | #endif |
87 | #endif |
88 | |
88 | |
89 | #ifndef EIO_STRUCT_STATVFS |
89 | #ifndef EIO_STRUCT_STATVFS |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
91 | #endif |
91 | #endif |
|
|
92 | |
|
|
93 | /* managing working directories */ |
|
|
94 | |
|
|
95 | typedef struct eio_pwd *eio_wd; |
|
|
96 | |
|
|
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 */ |
|
|
99 | |
|
|
100 | eio_wd eio_wd_open_sync (eio_wd wd, const char *path); |
|
|
101 | void eio_wd_close_sync (eio_wd wd); |
92 | |
102 | |
93 | /* for readdir */ |
103 | /* for readdir */ |
94 | |
104 | |
95 | /* eio_readdir flags */ |
105 | /* eio_readdir flags */ |
96 | enum |
106 | enum |
… | |
… | |
158 | }; |
168 | }; |
159 | |
169 | |
160 | /* eio_fallocate flags */ |
170 | /* eio_fallocate flags */ |
161 | enum |
171 | enum |
162 | { |
172 | { |
163 | 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 |
164 | }; |
178 | }; |
165 | |
179 | |
166 | /* timestamps and differences - feel free to use double in your code directly */ |
180 | /* timestamps and differences - feel free to use double in your code directly */ |
167 | typedef double eio_tstamp; |
181 | typedef double eio_tstamp; |
168 | |
182 | |
169 | /* the eio request structure */ |
183 | /* the eio request structure */ |
170 | enum |
184 | enum |
171 | { |
185 | { |
172 | EIO_CUSTOM, |
186 | EIO_CUSTOM, |
|
|
187 | EIO_WD_OPEN, EIO_WD_CLOSE, |
|
|
188 | |
173 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
189 | EIO_CLOSE, EIO_DUP2, |
174 | EIO_READ, EIO_WRITE, |
190 | EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL, |
175 | EIO_READAHEAD, EIO_SENDFILE, |
191 | EIO_READAHEAD, EIO_SENDFILE, |
176 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
|
|
177 | EIO_STATVFS, EIO_FSTATVFS, |
192 | EIO_FSTAT, EIO_FSTATVFS, |
178 | EIO_TRUNCATE, EIO_FTRUNCATE, |
193 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
179 | EIO_UTIME, EIO_FUTIME, |
|
|
180 | EIO_CHMOD, EIO_FCHMOD, |
|
|
181 | EIO_CHOWN, EIO_FCHOWN, |
|
|
182 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
194 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
183 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
195 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
184 | EIO_MLOCK, EIO_MLOCKALL, |
196 | EIO_MLOCK, EIO_MLOCKALL, |
|
|
197 | EIO_GROUP, EIO_NOP, |
|
|
198 | EIO_BUSY, |
|
|
199 | |
|
|
200 | /* these use wd + ptr1, but are emulated */ |
|
|
201 | EIO_REALPATH, |
|
|
202 | EIO_READDIR, |
|
|
203 | |
|
|
204 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
|
|
205 | EIO_OPEN, |
|
|
206 | EIO_STAT, EIO_LSTAT, EIO_STATVFS, |
|
|
207 | EIO_TRUNCATE, |
|
|
208 | EIO_UTIME, |
|
|
209 | EIO_CHMOD, |
|
|
210 | EIO_CHOWN, |
185 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
211 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
186 | EIO_MKNOD, EIO_READDIR, |
212 | EIO_MKNOD, |
187 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, |
213 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
188 | EIO_GROUP, EIO_NOP, |
214 | |
189 | EIO_BUSY |
215 | EIO_REQ_TYPE_NUM |
190 | }; |
216 | }; |
|
|
217 | |
|
|
218 | /* seek whence modes */ |
|
|
219 | /* these are guaranteed to hasve the traditional 0, 1, 2 values, */ |
|
|
220 | /* so you might as wlel use those */ |
|
|
221 | enum |
|
|
222 | { |
|
|
223 | EIO_SEEK_SET = 0, |
|
|
224 | EIO_SEEK_CUR = 1, |
|
|
225 | EIO_SEEK_END = 2 |
|
|
226 | }; |
|
|
227 | |
191 | |
228 | |
192 | /* mlockall constants */ |
229 | /* mlockall constants */ |
193 | enum |
230 | enum |
194 | { |
231 | { |
195 | EIO_MCL_CURRENT = 1, |
232 | EIO_MCL_CURRENT = 1, |
196 | EIO_MCL_FUTURE = 2, |
233 | EIO_MCL_FUTURE = 2 |
197 | }; |
234 | }; |
198 | |
235 | |
199 | /* request priorities */ |
236 | /* request priorities */ |
200 | |
237 | |
201 | enum { |
238 | enum { |
202 | EIO_PRI_MIN = -4, |
239 | EIO_PRI_MIN = -4, |
203 | EIO_PRI_MAX = 4, |
240 | EIO_PRI_MAX = 4, |
204 | EIO_PRI_DEFAULT = 0, |
241 | EIO_PRI_DEFAULT = 0 |
205 | }; |
242 | }; |
206 | |
243 | |
207 | /* eio request structure */ |
244 | /* eio request structure */ |
208 | /* this structure is mostly read-only */ |
245 | /* this structure is mostly read-only */ |
209 | /* when initialising it, all members must be zero-initialised */ |
246 | /* when initialising it, all members must be zero-initialised */ |
210 | struct eio_req |
247 | struct eio_req |
211 | { |
248 | { |
212 | eio_req volatile *next; /* private ETP */ |
249 | eio_req volatile *next; /* private ETP */ |
213 | |
250 | |
|
|
251 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
|
|
252 | |
214 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
253 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
215 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
254 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
216 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
255 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
217 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
256 | void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */ |
218 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
257 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
219 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
258 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
220 | eio_tstamp nv2; /* utime, futime: mtime */ |
259 | eio_tstamp nv2; /* utime, futime: mtime */ |
221 | |
260 | |
222 | int type; /* EIO_xxx constant ETP */ |
|
|
223 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
261 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
224 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */ |
262 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, fcntl, ioctl: request, sync_file_range, fallocate: flags */ |
225 | long int3; /* chown, fchown: gid */ |
263 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
226 | int errorno; /* errno value on syscall return */ |
264 | int errorno; /* errno value on syscall return */ |
227 | |
265 | |
|
|
266 | unsigned char flags; /* private */ |
|
|
267 | |
|
|
268 | signed char type;/* EIO_xxx constant ETP */ |
|
|
269 | signed char pri; /* the priority ETP */ |
228 | #if __i386 || __amd64 |
270 | #if __i386 || __amd64 |
229 | unsigned char cancelled; |
271 | unsigned char cancelled; /* ETP */ |
230 | #else |
272 | #else |
231 | sig_atomic_t cancelled; |
273 | sig_atomic_t cancelled; /* ETP */ |
232 | #endif |
274 | #endif |
233 | |
|
|
234 | unsigned char flags; /* private */ |
|
|
235 | signed char pri; /* the priority */ |
|
|
236 | |
275 | |
237 | void *data; |
276 | void *data; |
238 | eio_cb finish; |
277 | eio_cb finish; |
239 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
278 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
240 | void (*feed)(eio_req *req); /* only used for group requests */ |
279 | void (*feed)(eio_req *req); /* only used for group requests */ |
241 | |
280 | |
242 | EIO_REQ_MEMBERS |
281 | EIO_REQ_MEMBERS |
243 | |
282 | |
244 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
283 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */ |
245 | }; |
284 | }; |
246 | |
285 | |
247 | /* _private_ request flags */ |
286 | /* _private_ request flags */ |
248 | enum { |
287 | enum { |
249 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
288 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
250 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
289 | EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ |
251 | EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */ |
|
|
252 | }; |
290 | }; |
253 | |
291 | |
254 | /* undocumented/unsupported/private helper */ |
292 | /* undocumented/unsupported/private helper */ |
255 | /*void eio_page_align (void **addr, size_t *length);*/ |
293 | /*void eio_page_align (void **addr, size_t *length);*/ |
256 | |
294 | |
… | |
… | |
285 | |
323 | |
286 | /*****************************************************************************/ |
324 | /*****************************************************************************/ |
287 | /* convenience wrappers */ |
325 | /* convenience wrappers */ |
288 | |
326 | |
289 | #ifndef EIO_NO_WRAPPERS |
327 | #ifndef EIO_NO_WRAPPERS |
|
|
328 | eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ |
|
|
329 | eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); |
290 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
330 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
291 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
331 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
292 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
332 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
293 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
333 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
294 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
334 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
|
|
335 | eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data); |
295 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
336 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
296 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
337 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
297 | eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
338 | eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
298 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
339 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
299 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
340 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
300 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
341 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
301 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
342 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
302 | eio_req *eio_readahead (int fd, off_t offset, size_t length, 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); |
|
|
344 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
303 | 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_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
304 | eio_req *eio_write (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); |
|
|
347 | eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data); |
|
|
348 | eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data); |
305 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
349 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
306 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
350 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
307 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
351 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
308 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
352 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
309 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
353 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |