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

Comparing libeio/eio.h (file contents):
Revision 1.49 by root, Tue Sep 27 12:36:19 2011 UTC vs.
Revision 1.56 by root, Thu Jun 25 17:05:07 2015 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 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,
… …
168}; 168};
169 169
170/* eio_fallocate flags */ 170/* eio_fallocate flags */
171enum 171enum
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 = 0x01,
175 EIO_FALLOC_FL_PUNCH_HOLE = 0x02,
176 EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08,
177 EIO_FALLOC_FL_ZERO_RANGE = 0x10
174}; 178};
175 179
176/* timestamps and differences - feel free to use double in your code directly */ 180/* timestamps and differences - feel free to use double in your code directly */
177typedef double eio_tstamp; 181typedef double eio_tstamp;
178 182
… …
181{ 185{
182 EIO_CUSTOM, 186 EIO_CUSTOM,
183 EIO_WD_OPEN, EIO_WD_CLOSE, 187 EIO_WD_OPEN, EIO_WD_CLOSE,
184 188
185 EIO_CLOSE, EIO_DUP2, 189 EIO_CLOSE, EIO_DUP2,
186 EIO_READ, EIO_WRITE, 190 EIO_SEEK, EIO_READ, EIO_WRITE,
187 EIO_READAHEAD, EIO_SENDFILE, 191 EIO_READAHEAD, EIO_SENDFILE,
188 EIO_FSTAT, EIO_FSTATVFS, 192 EIO_FSTAT, EIO_FSTATVFS,
189 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, 193 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
190 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, 194 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
191 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, 195 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
… …
193 EIO_GROUP, EIO_NOP, 197 EIO_GROUP, EIO_NOP,
194 EIO_BUSY, 198 EIO_BUSY,
195 199
196 /* these use wd + ptr1, but are emulated */ 200 /* these use wd + ptr1, but are emulated */
197 EIO_REALPATH, 201 EIO_REALPATH,
198 EIO_STATVFS,
199 EIO_READDIR, 202 EIO_READDIR,
200 203
201 /* all the following requests use wd + ptr1 as path in xxxat functions */ 204 /* all the following requests use wd + ptr1 as path in xxxat functions */
202 EIO_OPEN, 205 EIO_OPEN,
203 EIO_STAT, EIO_LSTAT, 206 EIO_STAT, EIO_LSTAT, EIO_STATVFS,
204 EIO_TRUNCATE, 207 EIO_TRUNCATE,
205 EIO_UTIME, 208 EIO_UTIME,
206 EIO_CHMOD, 209 EIO_CHMOD,
207 EIO_CHOWN, 210 EIO_CHOWN,
208 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 211 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
… …
210 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 213 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
211 214
212 EIO_REQ_TYPE_NUM 215 EIO_REQ_TYPE_NUM
213}; 216};
214 217
218/* seek whence modes */
219/* these are guaranteed to hasve the traditional 0, 1, 2 values, */
220/* so you might as wlel use those */
221enum
222{
223 EIO_SEEK_SET = 0,
224 EIO_SEEK_CUR = 1,
225 EIO_SEEK_END = 2
226};
227
228
215/* mlockall constants */ 229/* mlockall constants */
216enum 230enum
217{ 231{
218 EIO_MCL_CURRENT = 1, 232 EIO_MCL_CURRENT = 1,
219 EIO_MCL_FUTURE = 2, 233 EIO_MCL_FUTURE = 2
220}; 234};
221 235
222/* request priorities */ 236/* request priorities */
223 237
224enum { 238enum {
225 EIO_PRI_MIN = -4, 239 EIO_PRI_MIN = -4,
226 EIO_PRI_MAX = 4, 240 EIO_PRI_MAX = 4,
227 EIO_PRI_DEFAULT = 0, 241 EIO_PRI_DEFAULT = 0
228}; 242};
229 243
230/* eio request structure */ 244/* eio request structure */
231/* this structure is mostly read-only */ 245/* this structure is mostly read-only */
232/* when initialising it, all members must be zero-initialised */ 246/* when initialising it, all members must be zero-initialised */
… …
242 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 256 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
243 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ 257 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
244 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 258 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
245 eio_tstamp nv2; /* utime, futime: mtime */ 259 eio_tstamp nv2; /* utime, futime: mtime */
246 260
247 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
266 unsigned char flags; /* private */
267
268 signed char type;/* EIO_xxx constant ETP */
269 signed char pri; /* the priority ETP */
253#if __i386 || __amd64 270#if __i386 || __amd64
254 unsigned char cancelled; 271 unsigned char cancelled; /* ETP */
255#else 272#else
256 sig_atomic_t cancelled; 273 sig_atomic_t cancelled; /* ETP */
257#endif 274#endif
258
259 unsigned char flags; /* private */
260 signed char pri; /* the priority */
261 275
262 void *data; 276 void *data;
263 eio_cb finish; 277 eio_cb finish;
264 void (*destroy)(eio_req *req); /* called when request no longer needed */ 278 void (*destroy)(eio_req *req); /* called when request no longer needed */
265 void (*feed)(eio_req *req); /* only used for group requests */ 279 void (*feed)(eio_req *req); /* only used for group requests */
266 280
267 EIO_REQ_MEMBERS 281 EIO_REQ_MEMBERS
268 282
269 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 283 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */
270}; 284};
271 285
272/* _private_ request flags */ 286/* _private_ request flags */
273enum { 287enum {
274 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ 288 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
275 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 289 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
276 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
277}; 290};
278 291
279/* undocumented/unsupported/private helper */ 292/* undocumented/unsupported/private helper */
280/*void eio_page_align (void **addr, size_t *length);*/ 293/*void eio_page_align (void **addr, size_t *length);*/
281 294
… …
326eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 339eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
327eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 340eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
328eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); 341eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
329eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 342eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
330eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 343eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
344eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
331eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 345eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
332eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 346eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
333eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 347eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
334eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 348eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
335eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 349eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);

Diff Legend

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