ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libeio/eio.h
(Generate patch)

Comparing libeio/eio.h (file contents):
Revision 1.43 by root, Tue Jul 19 05:18:22 2011 UTC vs.
Revision 1.63 by root, Thu Nov 29 21:48:44 2018 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines