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

Comparing libeio/eio.h (file contents):
Revision 1.33 by root, Tue Jul 5 09:24:12 2011 UTC vs.
Revision 1.50 by root, Sun Apr 1 17:22:42 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 *
… …
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
47#include <stddef.h> 47#include <stddef.h>
48#include <signal.h>
48#include <sys/types.h> 49#include <sys/types.h>
49 50
50typedef struct eio_req eio_req; 51typedef struct eio_req eio_req;
51typedef struct eio_dirent eio_dirent; 52typedef struct eio_dirent eio_dirent;
52 53
… …
55#ifndef EIO_REQ_MEMBERS 56#ifndef EIO_REQ_MEMBERS
56# define EIO_REQ_MEMBERS 57# define EIO_REQ_MEMBERS
57#endif 58#endif
58 59
59#ifndef EIO_STRUCT_STAT 60#ifndef EIO_STRUCT_STAT
61# ifdef _WIN32
62# define EIO_STRUCT_STAT struct _stati64
63# define EIO_STRUCT_STATI64
64# else
60# define EIO_STRUCT_STAT struct stat 65# define EIO_STRUCT_STAT struct stat
66# endif
67#endif
68
69#ifdef _WIN32
70 typedef int eio_uid_t;
71 typedef int eio_gid_t;
72 #ifdef __MINGW32__ /* no intptr_t */
73 typedef ssize_t eio_ssize_t;
74 #else
75 typedef intptr_t eio_ssize_t; /* or SSIZE_T */
76 #endif
77 #if __GNUC__
78 typedef long long eio_ino_t; /* signed for compatibility to msvc */
79 #else
80 typedef __int64 eio_ino_t; /* unsigned not supported by msvc */
81 #endif
82#else
83 typedef uid_t eio_uid_t;
84 typedef gid_t eio_gid_t;
85 typedef ssize_t eio_ssize_t;
86 typedef ino_t eio_ino_t;
61#endif 87#endif
62 88
63#ifndef EIO_STRUCT_STATVFS 89#ifndef EIO_STRUCT_STATVFS
64# define EIO_STRUCT_STATVFS struct statvfs 90# define EIO_STRUCT_STATVFS struct statvfs
65#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);
66 102
67/* for readdir */ 103/* for readdir */
68 104
69/* eio_readdir flags */ 105/* eio_readdir flags */
70enum 106enum
… …
104{ 140{
105 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ 141 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
106 unsigned short namelen; /* size of filename without trailing 0 */ 142 unsigned short namelen; /* size of filename without trailing 0 */
107 unsigned char type; /* one of EIO_DT_* */ 143 unsigned char type; /* one of EIO_DT_* */
108 signed char score; /* internal use */ 144 signed char score; /* internal use */
109 ino_t inode; /* the inode number, if available, otherwise unspecified */ 145 eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
110}; 146};
111 147
112/* eio_msync flags */ 148/* eio_msync flags */
113enum 149enum
114{ 150{
… …
116 EIO_MS_INVALIDATE = 2, 152 EIO_MS_INVALIDATE = 2,
117 EIO_MS_SYNC = 4 153 EIO_MS_SYNC = 4
118}; 154};
119 155
120/* eio_mtouch flags */ 156/* eio_mtouch flags */
121
122enum 157enum
123{ 158{
124 EIO_MT_MODIFY = 1 159 EIO_MT_MODIFY = 1
125}; 160};
126 161
127/* eio_sync_file_range flags */ 162/* eio_sync_file_range flags */
128
129enum 163enum
130{ 164{
131 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 165 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
132 EIO_SYNC_FILE_RANGE_WRITE = 2, 166 EIO_SYNC_FILE_RANGE_WRITE = 2,
133 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 167 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
134}; 168};
135 169
136typedef double eio_tstamp; /* feel free to use double in your code directly */ 170/* eio_fallocate flags */
171enum
172{
173 EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
174};
175
176/* timestamps and differences - feel free to use double in your code directly */
177typedef double eio_tstamp;
137 178
138/* the eio request structure */ 179/* the eio request structure */
139
140enum 180enum
141{ 181{
142 EIO_CUSTOM, 182 EIO_CUSTOM,
183 EIO_WD_OPEN, EIO_WD_CLOSE,
184
143 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 185 EIO_CLOSE, EIO_DUP2,
144 EIO_READ, EIO_WRITE, 186 EIO_SEEK, EIO_READ, EIO_WRITE,
145 EIO_READAHEAD, EIO_SENDFILE, 187 EIO_READAHEAD, EIO_SENDFILE,
146 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
147 EIO_STATVFS, EIO_FSTATVFS, 188 EIO_FSTAT, EIO_FSTATVFS,
148 EIO_TRUNCATE, EIO_FTRUNCATE, 189 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
149 EIO_UTIME, EIO_FUTIME,
150 EIO_CHMOD, EIO_FCHMOD,
151 EIO_CHOWN, EIO_FCHOWN,
152 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 190 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
153 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 191 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
154 EIO_MLOCK, EIO_MLOCKALL, 192 EIO_MLOCK, EIO_MLOCKALL,
193 EIO_GROUP, EIO_NOP,
194 EIO_BUSY,
195
196 /* these use wd + ptr1, but are emulated */
197 EIO_REALPATH,
198 EIO_STATVFS,
199 EIO_READDIR,
200
201 /* all the following requests use wd + ptr1 as path in xxxat functions */
202 EIO_OPEN,
203 EIO_STAT, EIO_LSTAT,
204 EIO_TRUNCATE,
205 EIO_UTIME,
206 EIO_CHMOD,
207 EIO_CHOWN,
155 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 208 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
156 EIO_MKNOD, EIO_READDIR, 209 EIO_MKNOD,
157 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, 210 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
158 EIO_GROUP, EIO_NOP, 211
159 EIO_BUSY 212 EIO_REQ_TYPE_NUM
160}; 213};
214
215/* seek whence modes */
216/* these are guaranteed to hasve the traditional 0, 1, 2 values, */
217/* so you might as wlel use those */
218enum
219{
220 EIO_SEEK_SET = 0,
221 EIO_SEEK_CUR = 1,
222 EIO_SEEK_END = 2
223};
224
161 225
162/* mlockall constants */ 226/* mlockall constants */
163enum 227enum
164{ 228{
165 EIO_MCL_CURRENT = 1, 229 EIO_MCL_CURRENT = 1,
166 EIO_MCL_FUTURE = 2, 230 EIO_MCL_FUTURE = 2
167}; 231};
168 232
169/* request priorities */ 233/* request priorities */
170 234
171enum { 235enum {
172 EIO_PRI_MIN = -4, 236 EIO_PRI_MIN = -4,
173 EIO_PRI_MAX = 4, 237 EIO_PRI_MAX = 4,
174 EIO_PRI_DEFAULT = 0, 238 EIO_PRI_DEFAULT = 0
175}; 239};
176 240
177/* eio request structure */ 241/* eio request structure */
178/* this structure is mostly read-only */ 242/* this structure is mostly read-only */
179/* when initialising it, all members must be zero-initialised */ 243/* when initialising it, all members must be zero-initialised */
180struct eio_req 244struct eio_req
181{ 245{
182 eio_req volatile *next; /* private ETP */ 246 eio_req volatile *next; /* private ETP */
183 247
248 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
249
184 ssize_t result; /* result of syscall, e.g. result = read (... */ 250 eio_ssize_t result; /* result of syscall, e.g. result = read (... */
185 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */ 251 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
186 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ 252 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
187 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 253 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
188 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ 254 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
189 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 255 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
190 eio_tstamp nv2; /* utime, futime: mtime */ 256 eio_tstamp nv2; /* utime, futime: mtime */
191 257
192 int type; /* EIO_xxx constant ETP */ 258 int type; /* EIO_xxx constant ETP */
193 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 259 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
194 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ 260 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */
195 long int3; /* chown, fchown: gid */ 261 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
196 int errorno; /* errno value on syscall return */ 262 int errorno; /* errno value on syscall return */
263
264#if __i386 || __amd64
265 unsigned char cancelled;
266#else
267 sig_atomic_t cancelled;
268#endif
197 269
198 unsigned char flags; /* private */ 270 unsigned char flags; /* private */
199 signed char pri; /* the priority */ 271 signed char pri; /* the priority */
200 272
201 void *data; 273 void *data;
… …
208 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 280 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
209}; 281};
210 282
211/* _private_ request flags */ 283/* _private_ request flags */
212enum { 284enum {
213 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
214 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 285 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
215 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 286 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
216 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 287 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
217}; 288};
218 289
219/* undocumented/unsupported/private helper */ 290/* undocumented/unsupported/private helper */
220/*void eio_page_align (void **addr, size_t *length);*/ 291/*void eio_page_align (void **addr, size_t *length);*/
221 292
… …
243void eio_set_max_idle (unsigned int nthreads); 314void eio_set_max_idle (unsigned int nthreads);
244void eio_set_idle_timeout (unsigned int seconds); 315void eio_set_idle_timeout (unsigned int seconds);
245 316
246unsigned int eio_nreqs (void); /* number of requests in-flight */ 317unsigned int eio_nreqs (void); /* number of requests in-flight */
247unsigned int eio_nready (void); /* number of not-yet handled requests */ 318unsigned int eio_nready (void); /* number of not-yet handled requests */
248unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 319unsigned int eio_npending (void); /* number of finished but unhandled requests */
249unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 320unsigned int eio_nthreads (void); /* number of worker threads in use currently */
250 321
251/*****************************************************************************/ 322/*****************************************************************************/
252/* convenience wrappers */ 323/* convenience wrappers */
253 324
254#ifndef EIO_NO_WRAPPERS 325#ifndef EIO_NO_WRAPPERS
326eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
327eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
255eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 328eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
256eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 329eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
257eio_req *eio_sync (int pri, eio_cb cb, void *data); 330eio_req *eio_sync (int pri, eio_cb cb, void *data);
258eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 331eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
259eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 332eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
333eio_req *eio_syncfs (int fd, int pri, eio_cb cb, void *data);
260eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 334eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
261eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 335eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
262eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); 336eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
263eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data); 337eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
264eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 338eio_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_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
265eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 340eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
266eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 341eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
342eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
267eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 343eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
268eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 344eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
269eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 345eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
270eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 346eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
271eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 347eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
272eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 348eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
273eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 349eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
274eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 350eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
275eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 351eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
276eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); 352eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
277eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); 353eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
278eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 354eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
279eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 355eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
280eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 356eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
281eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 357eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
282eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 358eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
283eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 359eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
284eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 360eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
285eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 361eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
… …
306 382
307/*****************************************************************************/ 383/*****************************************************************************/
308/* request api */ 384/* request api */
309 385
310/* true if the request was cancelled, useful in the invoke callback */ 386/* true if the request was cancelled, useful in the invoke callback */
311#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 387#define EIO_CANCELLED(req) ((req)->cancelled)
312 388
313#define EIO_RESULT(req) ((req)->result) 389#define EIO_RESULT(req) ((req)->result)
314/* returns a pointer to the result buffer allocated by eio */ 390/* returns a pointer to the result buffer allocated by eio */
315#define EIO_BUF(req) ((req)->ptr2) 391#define EIO_BUF(req) ((req)->ptr2)
316#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 392#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
… …
319 395
320/* submit a request for execution */ 396/* submit a request for execution */
321void eio_submit (eio_req *req); 397void eio_submit (eio_req *req);
322/* cancel a request as soon fast as possible, if possible */ 398/* cancel a request as soon fast as possible, if possible */
323void eio_cancel (eio_req *req); 399void eio_cancel (eio_req *req);
324/* destroy a request that has never been submitted */
325void eio_destroy (eio_req *req);
326 400
327/*****************************************************************************/ 401/*****************************************************************************/
328/* convinience functions */ 402/* convenience functions */
329 403
330ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 404eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
331 405
332#ifdef __cplusplus 406#ifdef __cplusplus
333} 407}
334#endif 408#endif
335 409

Diff Legend

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