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

Comparing libeio/eio.h (file contents):
Revision 1.40 by root, Sun Jul 17 04:20:04 2011 UTC vs.
Revision 1.58 by root, Fri Jun 23 03:10:19 2017 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 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
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);
88 102
89/* for readdir */ 103/* for readdir */
90 104
91/* eio_readdir flags */ 105/* eio_readdir flags */
92enum 106enum
… …
154}; 168};
155 169
156/* eio_fallocate flags */ 170/* eio_fallocate flags */
157enum 171enum
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 = 0x01,
175 EIO_FALLOC_FL_PUNCH_HOLE = 0x02,
176 EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08,
177 EIO_FALLOC_FL_ZERO_RANGE = 0x10
178};
179
180/* eio_rename flags */
181enum
182{
183 /* these MUST match the value in linux/fs.h */
184 EIO_RENAME_NOREPLACE = 1 << 0,
185 EIO_RENAME_EXCHANGE = 1 << 1,
186 EIO_RENAME_WHITEOUT = 1 << 2
160}; 187};
161 188
162/* timestamps and differences - feel free to use double in your code directly */ 189/* timestamps and differences - feel free to use double in your code directly */
163typedef double eio_tstamp; 190typedef double eio_tstamp;
164 191
165/* the eio request structure */ 192/* the eio request structure */
166enum 193enum
167{ 194{
168 EIO_CUSTOM, 195 EIO_CUSTOM,
196 EIO_WD_OPEN, EIO_WD_CLOSE,
197
169 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 198 EIO_CLOSE, EIO_DUP2,
170 EIO_READ, EIO_WRITE, 199 EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL,
171 EIO_READAHEAD, EIO_SENDFILE, 200 EIO_READAHEAD, EIO_SENDFILE,
172 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
173 EIO_STATVFS, EIO_FSTATVFS, 201 EIO_FSTAT, EIO_FSTATVFS,
174 EIO_TRUNCATE, EIO_FTRUNCATE, 202 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, 203 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
179 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, 204 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
180 EIO_MLOCK, EIO_MLOCKALL, 205 EIO_MLOCK, EIO_MLOCKALL,
206 EIO_GROUP, EIO_NOP,
207 EIO_BUSY,
208
209 /* these use wd + ptr1, but are emulated */
210 EIO_REALPATH,
211 EIO_READDIR,
212
213 /* all the following requests use wd + ptr1 as path in xxxat functions */
214 EIO_OPEN,
215 EIO_STAT, EIO_LSTAT, EIO_STATVFS,
216 EIO_TRUNCATE,
217 EIO_UTIME,
218 EIO_CHMOD,
219 EIO_CHOWN,
181 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 220 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
182 EIO_MKNOD, EIO_READDIR, 221 EIO_MKNOD,
183 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, 222 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
184 EIO_GROUP, EIO_NOP, 223
185 EIO_BUSY 224 EIO_REQ_TYPE_NUM
186}; 225};
226
227/* seek whence modes */
228/* these are guaranteed to hasve the traditional 0, 1, 2 values, */
229/* so you might as wlel use those */
230enum
231{
232 EIO_SEEK_SET = 0,
233 EIO_SEEK_CUR = 1,
234 EIO_SEEK_END = 2
235};
236
187 237
188/* mlockall constants */ 238/* mlockall constants */
189enum 239enum
190{ 240{
191 EIO_MCL_CURRENT = 1, 241 EIO_MCL_CURRENT = 1,
192 EIO_MCL_FUTURE = 2, 242 EIO_MCL_FUTURE = 2
193}; 243};
194 244
195/* request priorities */ 245/* request priorities */
196 246
197enum { 247enum {
198 EIO_PRI_MIN = -4, 248 EIO_PRI_MIN = -4,
199 EIO_PRI_MAX = 4, 249 EIO_PRI_MAX = 4,
200 EIO_PRI_DEFAULT = 0, 250 EIO_PRI_DEFAULT = 0
201}; 251};
202 252
203/* eio request structure */ 253/* eio request structure */
204/* this structure is mostly read-only */ 254/* this structure is mostly read-only */
205/* when initialising it, all members must be zero-initialised */ 255/* when initialising it, all members must be zero-initialised */
206struct eio_req 256struct eio_req
207{ 257{
208 eio_req volatile *next; /* private ETP */ 258 eio_req volatile *next; /* private ETP */
209 259
260 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
261
210 eio_ssize_t result; /* result of syscall, e.g. result = read (... */ 262 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 */ 263 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 */ 264 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 */ 265 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 */ 266 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
215 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 267 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
216 eio_tstamp nv2; /* utime, futime: mtime */ 268 eio_tstamp nv2; /* utime, futime: mtime */
217 269
218 int type; /* EIO_xxx constant ETP */
219 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 270 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 */ 271 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 */
221 long int3; /* chown, fchown: gid */ 272 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
222 int errorno; /* errno value on syscall return */ 273 int errorno; /* errno value on syscall return */
223 274
275 unsigned char flags; /* private */
276
277 signed char type;/* EIO_xxx constant ETP */
278 signed char pri; /* the priority ETP */
224#if __i386 || __amd64 279#if __i386 || __amd64
225 unsigned char cancelled; 280 unsigned char cancelled; /* ETP */
226#else 281#else
227 sig_atomic_t cancelled; 282 sig_atomic_t cancelled; /* ETP */
228#endif 283#endif
229
230 unsigned char flags; /* private */
231 signed char pri; /* the priority */
232 284
233 void *data; 285 void *data;
234 eio_cb finish; 286 eio_cb finish;
235 void (*destroy)(eio_req *req); /* called when request no longer needed */ 287 void (*destroy)(eio_req *req); /* called when request no longer needed */
236 void (*feed)(eio_req *req); /* only used for group requests */ 288 void (*feed)(eio_req *req); /* only used for group requests */
237 289
238 EIO_REQ_MEMBERS 290 EIO_REQ_MEMBERS
239 291
240 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 292 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */
241}; 293};
242 294
243/* _private_ request flags */ 295/* _private_ request flags */
244enum { 296enum {
245 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ 297 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
246 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 298 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
247 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
248}; 299};
249 300
250/* undocumented/unsupported/private helper */ 301/* undocumented/unsupported/private helper */
251/*void eio_page_align (void **addr, size_t *length);*/ 302/*void eio_page_align (void **addr, size_t *length);*/
252 303
… …
281 332
282/*****************************************************************************/ 333/*****************************************************************************/
283/* convenience wrappers */ 334/* convenience wrappers */
284 335
285#ifndef EIO_NO_WRAPPERS 336#ifndef EIO_NO_WRAPPERS
337eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
338eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
286eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 339eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
287eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 340eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
288eio_req *eio_sync (int pri, eio_cb cb, void *data); 341eio_req *eio_sync (int pri, eio_cb cb, void *data);
289eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 342eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
290eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 343eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
344eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data);
291eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 345eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
292eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 346eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
293eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); 347eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
294eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 348eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
295eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 349eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
296eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); 350eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
297eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 351eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
298eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 352eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
353eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
299eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 354eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
300eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 355eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
356eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data);
357eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data);
301eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 358eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
302eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 359eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
303eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 360eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
304eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 361eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
305eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 362eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
306eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 363eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
307eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 364eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
308eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); 365eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
309eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); 366eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
310eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 367eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
311eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 368eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
312eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 369eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
313eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 370eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
314eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 371eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
315eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 372eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
316eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 373eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
317eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 374eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);

Diff Legend

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