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 | * |
… | |
… | |
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 = 1, |
|
|
175 | EIO_FALLOC_FL_PUNCH_HOLE = 2 |
174 | }; |
176 | }; |
175 | |
177 | |
176 | /* 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 */ |
177 | typedef double eio_tstamp; |
179 | typedef double eio_tstamp; |
178 | |
180 | |
… | |
… | |
181 | { |
183 | { |
182 | EIO_CUSTOM, |
184 | EIO_CUSTOM, |
183 | EIO_WD_OPEN, EIO_WD_CLOSE, |
185 | EIO_WD_OPEN, EIO_WD_CLOSE, |
184 | |
186 | |
185 | EIO_CLOSE, EIO_DUP2, |
187 | EIO_CLOSE, EIO_DUP2, |
186 | EIO_READ, EIO_WRITE, |
188 | EIO_SEEK, EIO_READ, EIO_WRITE, |
187 | EIO_READAHEAD, EIO_SENDFILE, |
189 | EIO_READAHEAD, EIO_SENDFILE, |
188 | EIO_FSTAT, EIO_FSTATVFS, |
190 | EIO_FSTAT, EIO_FSTATVFS, |
189 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
191 | EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, |
190 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
192 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, |
191 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
193 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, |
… | |
… | |
210 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
212 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
211 | |
213 | |
212 | EIO_REQ_TYPE_NUM |
214 | EIO_REQ_TYPE_NUM |
213 | }; |
215 | }; |
214 | |
216 | |
|
|
217 | /* seek whence modes */ |
|
|
218 | /* these are guaranteed to hasve the traditional 0, 1, 2 values, */ |
|
|
219 | /* so you might as wlel use those */ |
|
|
220 | enum |
|
|
221 | { |
|
|
222 | EIO_SEEK_SET = 0, |
|
|
223 | EIO_SEEK_CUR = 1, |
|
|
224 | EIO_SEEK_END = 2 |
|
|
225 | }; |
|
|
226 | |
|
|
227 | |
215 | /* mlockall constants */ |
228 | /* mlockall constants */ |
216 | enum |
229 | enum |
217 | { |
230 | { |
218 | EIO_MCL_CURRENT = 1, |
231 | EIO_MCL_CURRENT = 1, |
219 | EIO_MCL_FUTURE = 2, |
232 | EIO_MCL_FUTURE = 2 |
220 | }; |
233 | }; |
221 | |
234 | |
222 | /* request priorities */ |
235 | /* request priorities */ |
223 | |
236 | |
224 | enum { |
237 | enum { |
225 | EIO_PRI_MIN = -4, |
238 | EIO_PRI_MIN = -4, |
226 | EIO_PRI_MAX = 4, |
239 | EIO_PRI_MAX = 4, |
227 | EIO_PRI_DEFAULT = 0, |
240 | EIO_PRI_DEFAULT = 0 |
228 | }; |
241 | }; |
229 | |
242 | |
230 | /* eio request structure */ |
243 | /* eio request structure */ |
231 | /* this structure is mostly read-only */ |
244 | /* this structure is mostly read-only */ |
232 | /* when initialising it, all members must be zero-initialised */ |
245 | /* when initialising it, all members must be zero-initialised */ |
… | |
… | |
244 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
257 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
245 | eio_tstamp nv2; /* utime, futime: mtime */ |
258 | eio_tstamp nv2; /* utime, futime: mtime */ |
246 | |
259 | |
247 | int type; /* EIO_xxx constant ETP */ |
260 | int type; /* EIO_xxx constant ETP */ |
248 | 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 */ |
249 | 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, sync_file_range, fallocate: flags */ |
250 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
263 | long int3; /* chown, fchown: gid; rename, link: working directory of new name */ |
251 | int errorno; /* errno value on syscall return */ |
264 | int errorno; /* errno value on syscall return */ |
252 | |
265 | |
253 | #if __i386 || __amd64 |
266 | #if __i386 || __amd64 |
254 | unsigned char cancelled; |
267 | unsigned char cancelled; |
… | |
… | |
310 | |
323 | |
311 | /*****************************************************************************/ |
324 | /*****************************************************************************/ |
312 | /* convenience wrappers */ |
325 | /* convenience wrappers */ |
313 | |
326 | |
314 | #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); |
315 | 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 */ |
316 | 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 */ |
317 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
332 | 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); |
333 | 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); |
334 | 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); |
339 | 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); |
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); |
326 | 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); |
327 | 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); |
328 | 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); |
329 | 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); |
330 | 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); |
331 | 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 */ |
332 | 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 */ |
333 | 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); |