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 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, |
… | |
… | |
64 | # else |
64 | # else |
65 | # define EIO_STRUCT_STAT struct stat |
65 | # define EIO_STRUCT_STAT struct stat |
66 | # endif |
66 | # endif |
67 | #endif |
67 | #endif |
68 | |
68 | |
|
|
69 | #ifdef _WIN32 |
|
|
70 | typedef int eio_uid_t; |
|
|
71 | typedef int eio_gid_t; |
|
|
72 | #ifdef __MINGW32__ /* no intptr_t */ |
|
|
73 | typedef ssize_t eio_ssize_t; |
|
|
74 | #else |
|
|
75 | typedef intptr_t eio_ssize_t; /* or SSIZE_T */ |
|
|
76 | #endif |
|
|
77 | #if __GNUC__ |
|
|
78 | typedef long long eio_ino_t; /* signed for compatibility to msvc */ |
|
|
79 | #else |
|
|
80 | typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ |
|
|
81 | #endif |
|
|
82 | #else |
|
|
83 | typedef uid_t eio_uid_t; |
|
|
84 | typedef gid_t eio_gid_t; |
|
|
85 | typedef ssize_t eio_ssize_t; |
|
|
86 | typedef ino_t eio_ino_t; |
|
|
87 | #endif |
|
|
88 | |
69 | #ifndef EIO_STRUCT_STATVFS |
89 | #ifndef EIO_STRUCT_STATVFS |
70 | # define EIO_STRUCT_STATVFS struct statvfs |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
71 | #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); |
72 | |
102 | |
73 | /* for readdir */ |
103 | /* for readdir */ |
74 | |
104 | |
75 | /* eio_readdir flags */ |
105 | /* eio_readdir flags */ |
76 | enum |
106 | enum |
… | |
… | |
110 | { |
140 | { |
111 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
141 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
112 | unsigned short namelen; /* size of filename without trailing 0 */ |
142 | unsigned short namelen; /* size of filename without trailing 0 */ |
113 | unsigned char type; /* one of EIO_DT_* */ |
143 | unsigned char type; /* one of EIO_DT_* */ |
114 | signed char score; /* internal use */ |
144 | signed char score; /* internal use */ |
115 | ino_t inode; /* the inode number, if available, otherwise unspecified */ |
145 | eio_ino_t inode; /* the inode number, if available, otherwise unspecified */ |
116 | }; |
146 | }; |
117 | |
147 | |
118 | /* eio_msync flags */ |
148 | /* eio_msync flags */ |
119 | enum |
149 | enum |
120 | { |
150 | { |
… | |
… | |
138 | }; |
168 | }; |
139 | |
169 | |
140 | /* eio_fallocate flags */ |
170 | /* eio_fallocate flags */ |
141 | enum |
171 | enum |
142 | { |
172 | { |
143 | 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 = 1, |
|
|
175 | EIO_FALLOC_FL_PUNCH_HOLE = 2 |
144 | }; |
176 | }; |
145 | |
177 | |
146 | /* timestamps and differences - feel free to use double in your code directly */ |
178 | /* timestamps and differences - feel free to use double in your code directly */ |
147 | typedef double eio_tstamp; |
179 | typedef double eio_tstamp; |
148 | |
180 | |
149 | /* the eio request structure */ |
181 | /* the eio request structure */ |
150 | enum |
182 | enum |
151 | { |
183 | { |
152 | EIO_CUSTOM, |
184 | EIO_CUSTOM, |
|
|
185 | EIO_WD_OPEN, EIO_WD_CLOSE, |
|
|
186 | |
153 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
187 | EIO_CLOSE, EIO_DUP2, |
154 | EIO_READ, EIO_WRITE, |
188 | EIO_SEEK, EIO_READ, EIO_WRITE, |
155 | EIO_READAHEAD, EIO_SENDFILE, |
189 | EIO_READAHEAD, EIO_SENDFILE, |
156 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
|
|
157 | EIO_STATVFS, EIO_FSTATVFS, |
190 | EIO_FSTAT, EIO_FSTATVFS, |
158 | EIO_TRUNCATE, EIO_FTRUNCATE, |
191 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
159 | EIO_UTIME, EIO_FUTIME, |
|
|
160 | EIO_CHMOD, EIO_FCHMOD, |
|
|
161 | EIO_CHOWN, EIO_FCHOWN, |
|
|
162 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
192 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
163 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
193 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
164 | EIO_MLOCK, EIO_MLOCKALL, |
194 | EIO_MLOCK, EIO_MLOCKALL, |
|
|
195 | EIO_GROUP, EIO_NOP, |
|
|
196 | EIO_BUSY, |
|
|
197 | |
|
|
198 | /* these use wd + ptr1, but are emulated */ |
|
|
199 | EIO_REALPATH, |
|
|
200 | EIO_READDIR, |
|
|
201 | |
|
|
202 | /* all the following requests use wd + ptr1 as path in xxxat functions */ |
|
|
203 | EIO_OPEN, |
|
|
204 | EIO_STAT, EIO_LSTAT, EIO_STATVFS, |
|
|
205 | EIO_TRUNCATE, |
|
|
206 | EIO_UTIME, |
|
|
207 | EIO_CHMOD, |
|
|
208 | EIO_CHOWN, |
165 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
209 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
166 | EIO_MKNOD, EIO_READDIR, |
210 | EIO_MKNOD, |
167 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, |
211 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
168 | EIO_GROUP, EIO_NOP, |
212 | |
169 | EIO_BUSY |
213 | EIO_REQ_TYPE_NUM |
170 | }; |
214 | }; |
|
|
215 | |
|
|
216 | /* seek whence modes */ |
|
|
217 | /* these are guaranteed to hasve the traditional 0, 1, 2 values, */ |
|
|
218 | /* so you might as wlel use those */ |
|
|
219 | enum |
|
|
220 | { |
|
|
221 | EIO_SEEK_SET = 0, |
|
|
222 | EIO_SEEK_CUR = 1, |
|
|
223 | EIO_SEEK_END = 2 |
|
|
224 | }; |
|
|
225 | |
171 | |
226 | |
172 | /* mlockall constants */ |
227 | /* mlockall constants */ |
173 | enum |
228 | enum |
174 | { |
229 | { |
175 | EIO_MCL_CURRENT = 1, |
230 | EIO_MCL_CURRENT = 1, |
176 | EIO_MCL_FUTURE = 2, |
231 | EIO_MCL_FUTURE = 2 |
177 | }; |
232 | }; |
178 | |
233 | |
179 | /* request priorities */ |
234 | /* request priorities */ |
180 | |
235 | |
181 | enum { |
236 | enum { |
182 | EIO_PRI_MIN = -4, |
237 | EIO_PRI_MIN = -4, |
183 | EIO_PRI_MAX = 4, |
238 | EIO_PRI_MAX = 4, |
184 | EIO_PRI_DEFAULT = 0, |
239 | EIO_PRI_DEFAULT = 0 |
185 | }; |
240 | }; |
186 | |
241 | |
187 | /* eio request structure */ |
242 | /* eio request structure */ |
188 | /* this structure is mostly read-only */ |
243 | /* this structure is mostly read-only */ |
189 | /* when initialising it, all members must be zero-initialised */ |
244 | /* when initialising it, all members must be zero-initialised */ |
190 | struct eio_req |
245 | struct eio_req |
191 | { |
246 | { |
192 | eio_req volatile *next; /* private ETP */ |
247 | eio_req volatile *next; /* private ETP */ |
193 | |
248 | |
|
|
249 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
|
|
250 | |
194 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
251 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
195 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
252 | off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ |
196 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
253 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ |
197 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
254 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
198 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
255 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
199 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
256 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
200 | eio_tstamp nv2; /* utime, futime: mtime */ |
257 | eio_tstamp nv2; /* utime, futime: mtime */ |
201 | |
258 | |
202 | int type; /* EIO_xxx constant ETP */ |
259 | int type; /* EIO_xxx constant ETP */ |
203 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
260 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
204 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */ |
261 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ |
205 | long int3; /* chown, fchown: gid */ |
262 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
206 | int errorno; /* errno value on syscall return */ |
263 | int errorno; /* errno value on syscall return */ |
207 | |
264 | |
208 | #if __i386 || __amd64 |
265 | #if __i386 || __amd64 |
209 | unsigned char cancelled; |
266 | unsigned char cancelled; |
210 | #else |
267 | #else |
… | |
… | |
265 | |
322 | |
266 | /*****************************************************************************/ |
323 | /*****************************************************************************/ |
267 | /* convenience wrappers */ |
324 | /* convenience wrappers */ |
268 | |
325 | |
269 | #ifndef EIO_NO_WRAPPERS |
326 | #ifndef EIO_NO_WRAPPERS |
|
|
327 | 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); |
270 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
329 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
271 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
330 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
272 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
331 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
273 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
332 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
274 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
333 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
|
|
334 | eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data); |
275 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
335 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
276 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
336 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
277 | eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
337 | eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
278 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
338 | eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); |
279 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
339 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
280 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
340 | eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); |
281 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
341 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
282 | eio_req *eio_readahead (int fd, off_t offset, size_t length, 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); |
|
|
343 | eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); |
283 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, 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); |
284 | eio_req *eio_write (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); |
285 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
346 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
286 | eio_req *eio_fstatvfs (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 */ |
287 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
348 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
288 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
349 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
289 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
350 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
290 | eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
351 | eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data); |
291 | eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
352 | eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
292 | eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); |
353 | eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); |
293 | eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); |
354 | eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); |
294 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
355 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
295 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
356 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
296 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
357 | eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data); |
297 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
358 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
298 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
359 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
299 | eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
360 | eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
300 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
361 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
301 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
362 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
… | |
… | |
339 | void eio_cancel (eio_req *req); |
400 | void eio_cancel (eio_req *req); |
340 | |
401 | |
341 | /*****************************************************************************/ |
402 | /*****************************************************************************/ |
342 | /* convenience functions */ |
403 | /* convenience functions */ |
343 | |
404 | |
344 | ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
405 | eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
345 | |
406 | |
346 | #ifdef __cplusplus |
407 | #ifdef __cplusplus |
347 | } |
408 | } |
348 | #endif |
409 | #endif |
349 | |
410 | |