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, |
… | |
… | |
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 */ |
|
|
73 | typedef ssize_t eio_ssize_t; |
|
|
74 | #else |
72 | typedef intptr_t eio_ssize_t; /* or SSIZE_T */ |
75 | typedef intptr_t eio_ssize_t; /* or SSIZE_T */ |
|
|
76 | #endif |
73 | #if __GNUC__ |
77 | #if __GNUC__ |
74 | typedef long long eio_ino_t; |
78 | typedef long long eio_ino_t; /* signed for compatibility to msvc */ |
75 | #else |
79 | #else |
76 | typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ |
80 | typedef __int64 eio_ino_t; /* unsigned not supported by msvc */ |
77 | #endif |
81 | #endif |
78 | #else |
82 | #else |
79 | typedef uid_t eio_uid_t; |
83 | typedef uid_t eio_uid_t; |
… | |
… | |
83 | #endif |
87 | #endif |
84 | |
88 | |
85 | #ifndef EIO_STRUCT_STATVFS |
89 | #ifndef EIO_STRUCT_STATVFS |
86 | # define EIO_STRUCT_STATVFS struct statvfs |
90 | # define EIO_STRUCT_STATVFS struct statvfs |
87 | #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); |
88 | |
102 | |
89 | /* for readdir */ |
103 | /* for readdir */ |
90 | |
104 | |
91 | /* eio_readdir flags */ |
105 | /* eio_readdir flags */ |
92 | enum |
106 | enum |
… | |
… | |
154 | }; |
168 | }; |
155 | |
169 | |
156 | /* eio_fallocate flags */ |
170 | /* eio_fallocate flags */ |
157 | enum |
171 | enum |
158 | { |
172 | { |
159 | 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 |
160 | }; |
176 | }; |
161 | |
177 | |
162 | /* 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 */ |
163 | typedef double eio_tstamp; |
179 | typedef double eio_tstamp; |
164 | |
180 | |
165 | /* the eio request structure */ |
181 | /* the eio request structure */ |
166 | enum |
182 | enum |
167 | { |
183 | { |
168 | EIO_CUSTOM, |
184 | EIO_CUSTOM, |
|
|
185 | EIO_WD_OPEN, EIO_WD_CLOSE, |
|
|
186 | |
169 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
187 | EIO_CLOSE, EIO_DUP2, |
170 | EIO_READ, EIO_WRITE, |
188 | EIO_SEEK, EIO_READ, EIO_WRITE, |
171 | EIO_READAHEAD, EIO_SENDFILE, |
189 | EIO_READAHEAD, EIO_SENDFILE, |
172 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
|
|
173 | EIO_STATVFS, EIO_FSTATVFS, |
190 | EIO_FSTAT, EIO_FSTATVFS, |
174 | EIO_TRUNCATE, EIO_FTRUNCATE, |
191 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
175 | EIO_UTIME, EIO_FUTIME, |
|
|
176 | EIO_CHMOD, EIO_FCHMOD, |
|
|
177 | EIO_CHOWN, EIO_FCHOWN, |
|
|
178 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
192 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
179 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
193 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
180 | 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, |
181 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
209 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
182 | EIO_MKNOD, EIO_READDIR, |
210 | EIO_MKNOD, |
183 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, |
211 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
184 | EIO_GROUP, EIO_NOP, |
212 | |
185 | EIO_BUSY |
213 | EIO_REQ_TYPE_NUM |
186 | }; |
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 | |
187 | |
226 | |
188 | /* mlockall constants */ |
227 | /* mlockall constants */ |
189 | enum |
228 | enum |
190 | { |
229 | { |
191 | EIO_MCL_CURRENT = 1, |
230 | EIO_MCL_CURRENT = 1, |
192 | EIO_MCL_FUTURE = 2, |
231 | EIO_MCL_FUTURE = 2 |
193 | }; |
232 | }; |
194 | |
233 | |
195 | /* request priorities */ |
234 | /* request priorities */ |
196 | |
235 | |
197 | enum { |
236 | enum { |
198 | EIO_PRI_MIN = -4, |
237 | EIO_PRI_MIN = -4, |
199 | EIO_PRI_MAX = 4, |
238 | EIO_PRI_MAX = 4, |
200 | EIO_PRI_DEFAULT = 0, |
239 | EIO_PRI_DEFAULT = 0 |
201 | }; |
240 | }; |
202 | |
241 | |
203 | /* eio request structure */ |
242 | /* eio request structure */ |
204 | /* this structure is mostly read-only */ |
243 | /* this structure is mostly read-only */ |
205 | /* when initialising it, all members must be zero-initialised */ |
244 | /* when initialising it, all members must be zero-initialised */ |
206 | struct eio_req |
245 | struct eio_req |
207 | { |
246 | { |
208 | eio_req volatile *next; /* private ETP */ |
247 | eio_req volatile *next; /* private ETP */ |
|
|
248 | |
|
|
249 | eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ |
209 | |
250 | |
210 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
251 | eio_ssize_t result; /* result of syscall, e.g. result = read (... */ |
211 | 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 */ |
212 | 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 */ |
213 | 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 */ |
214 | 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 */ |
215 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
256 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
216 | eio_tstamp nv2; /* utime, futime: mtime */ |
257 | eio_tstamp nv2; /* utime, futime: mtime */ |
217 | |
258 | |
218 | int type; /* EIO_xxx constant ETP */ |
|
|
219 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
259 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
220 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */ |
260 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ |
221 | long int3; /* chown, fchown: gid */ |
261 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
222 | int errorno; /* errno value on syscall return */ |
262 | int errorno; /* errno value on syscall return */ |
223 | |
263 | |
|
|
264 | signed char type;/* EIO_xxx constant ETP */ |
|
|
265 | |
224 | #if __i386 || __amd64 |
266 | #if __i386 || __amd64 |
225 | unsigned char cancelled; |
267 | unsigned char cancelled; /* ETP */ |
226 | #else |
268 | #else |
227 | sig_atomic_t cancelled; |
269 | sig_atomic_t cancelled; /* ETP */ |
228 | #endif |
270 | #endif |
229 | |
271 | |
230 | unsigned char flags; /* private */ |
272 | unsigned char flags; /* private */ |
231 | signed char pri; /* the priority */ |
273 | signed char pri; /* the priority */ |
232 | |
274 | |
… | |
… | |
235 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
277 | void (*destroy)(eio_req *req); /* called when request no longer needed */ |
236 | void (*feed)(eio_req *req); /* only used for group requests */ |
278 | void (*feed)(eio_req *req); /* only used for group requests */ |
237 | |
279 | |
238 | EIO_REQ_MEMBERS |
280 | EIO_REQ_MEMBERS |
239 | |
281 | |
240 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
282 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */ |
241 | }; |
283 | }; |
242 | |
284 | |
243 | /* _private_ request flags */ |
285 | /* _private_ request flags */ |
244 | enum { |
286 | enum { |
245 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
287 | EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ |
… | |
… | |
281 | |
323 | |
282 | /*****************************************************************************/ |
324 | /*****************************************************************************/ |
283 | /* convenience wrappers */ |
325 | /* convenience wrappers */ |
284 | |
326 | |
285 | #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); |
286 | 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 */ |
287 | 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 */ |
288 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
332 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
289 | 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); |
290 | 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); |
291 | 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); |
292 | 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); |
293 | 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); |
294 | 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); |
295 | 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); |
296 | 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); |
297 | 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); |
298 | 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); |
299 | 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); |
300 | 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); |
301 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
347 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
302 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
348 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
303 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
349 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |