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

Comparing libeio/eio.h (file contents):
Revision 1.48 by root, Tue Sep 27 00:41:52 2011 UTC vs.
Revision 1.52 by root, Tue Aug 14 04:15:35 2012 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 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 = 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 */
177typedef double eio_tstamp; 179typedef 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,
… …
193 EIO_GROUP, EIO_NOP, 195 EIO_GROUP, EIO_NOP,
194 EIO_BUSY, 196 EIO_BUSY,
195 197
196 /* these use wd + ptr1, but are emulated */ 198 /* these use wd + ptr1, but are emulated */
197 EIO_REALPATH, 199 EIO_REALPATH,
198 EIO_STATVFS,
199 EIO_READDIR, 200 EIO_READDIR,
200 201
201 /* all the following requests use wd + ptr1 as path in xxxat functions */ 202 /* all the following requests use wd + ptr1 as path in xxxat functions */
202 EIO_OPEN, 203 EIO_OPEN,
203 EIO_STAT, EIO_LSTAT, 204 EIO_STAT, EIO_LSTAT, EIO_STATVFS,
204 EIO_TRUNCATE, 205 EIO_TRUNCATE,
205 EIO_UTIME, 206 EIO_UTIME,
206 EIO_CHMOD, 207 EIO_CHMOD,
207 EIO_CHOWN, 208 EIO_CHOWN,
208 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 209 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
… …
210 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 211 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
211 212
212 EIO_REQ_TYPE_NUM 213 EIO_REQ_TYPE_NUM
213}; 214};
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 */
219enum
220{
221 EIO_SEEK_SET = 0,
222 EIO_SEEK_CUR = 1,
223 EIO_SEEK_END = 2
224};
225
226
215/* mlockall constants */ 227/* mlockall constants */
216enum 228enum
217{ 229{
218 EIO_MCL_CURRENT = 1, 230 EIO_MCL_CURRENT = 1,
219 EIO_MCL_FUTURE = 2, 231 EIO_MCL_FUTURE = 2
220}; 232};
221 233
222/* request priorities */ 234/* request priorities */
223 235
224enum { 236enum {
225 EIO_PRI_MIN = -4, 237 EIO_PRI_MIN = -4,
226 EIO_PRI_MAX = 4, 238 EIO_PRI_MAX = 4,
227 EIO_PRI_DEFAULT = 0, 239 EIO_PRI_DEFAULT = 0
228}; 240};
229 241
230/* eio request structure */ 242/* eio request structure */
231/* this structure is mostly read-only */ 243/* this structure is mostly read-only */
232/* when initialising it, all members must be zero-initialised */ 244/* when initialising it, all members must be zero-initialised */
… …
244 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 256 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
245 eio_tstamp nv2; /* utime, futime: mtime */ 257 eio_tstamp nv2; /* utime, futime: mtime */
246 258
247 int type; /* EIO_xxx constant ETP */ 259 int type; /* EIO_xxx constant ETP */
248 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 260 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 */ 261 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 */ 262 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
251 int errorno; /* errno value on syscall return */ 263 int errorno; /* errno value on syscall return */
252 264
253#if __i386 || __amd64 265#if __i386 || __amd64
254 unsigned char cancelled; 266 unsigned char cancelled;
… …
310 322
311/*****************************************************************************/ 323/*****************************************************************************/
312/* convenience wrappers */ 324/* convenience wrappers */
313 325
314#ifndef EIO_NO_WRAPPERS 326#ifndef EIO_NO_WRAPPERS
327eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
328eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
315eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 329eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
316eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 330eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
317eio_req *eio_sync (int pri, eio_cb cb, void *data); 331eio_req *eio_sync (int pri, eio_cb cb, void *data);
318eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 332eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
319eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 333eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
… …
324eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 338eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
325eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 339eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
326eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data); 340eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
327eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 341eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
328eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 342eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
343eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
329eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 344eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
330eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 345eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
331eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 346eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
332eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 347eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
333eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 348eio_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