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

Comparing libeio/eio.h (file contents):
Revision 1.22 by root, Fri Jun 12 00:43:16 2009 UTC vs.
Revision 1.37 by root, Thu Jul 7 22:36:18 2011 UTC

1/* 1/*
2 * libeio API header 2 * libeio API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libeio@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011 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
… …
58 59
59#ifndef EIO_STRUCT_STAT 60#ifndef EIO_STRUCT_STAT
60# define EIO_STRUCT_STAT struct stat 61# define EIO_STRUCT_STAT struct stat
61#endif 62#endif
62 63
64#ifndef EIO_STRUCT_STATVFS
65# define EIO_STRUCT_STATVFS struct statvfs
66#endif
67
63/* for readdir */ 68/* for readdir */
64 69
65/* eio_readdir flags */ 70/* eio_readdir flags */
66enum { 71enum
72{
67 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ 73 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
68 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */ 74 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
69 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */ 75 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
70 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ 76 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
71 77
72 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ 78 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
73 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ 79 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
74}; 80};
75 81
76/* using "typical" values in the hope that the compiler will do something sensible */ 82/* using "typical" values in the hope that the compiler will do something sensible */
77enum eio_dtype { 83enum eio_dtype
84{
78 EIO_DT_UNKNOWN = 0, 85 EIO_DT_UNKNOWN = 0,
79 EIO_DT_FIFO = 1, 86 EIO_DT_FIFO = 1,
80 EIO_DT_CHR = 2, 87 EIO_DT_CHR = 2,
81 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ 88 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
82 EIO_DT_DIR = 4, 89 EIO_DT_DIR = 4,
… …
92 EIO_DT_DOOR = 13, /* solaris door */ 99 EIO_DT_DOOR = 13, /* solaris door */
93 EIO_DT_WHT = 14, 100 EIO_DT_WHT = 14,
94 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ 101 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
95}; 102};
96 103
97struct eio_dirent { 104struct eio_dirent
98 char *name; 105{
99 ino_t inode; 106 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
100 unsigned short namelen; 107 unsigned short namelen; /* size of filename without trailing 0 */
101 unsigned char type; 108 unsigned char type; /* one of EIO_DT_* */
102 unsigned char score; /* internal use */ 109 signed char score; /* internal use */
103 /* 0-4 bytes padding */ 110 ino_t inode; /* the inode number, if available, otherwise unspecified */
111};
112
113/* eio_msync flags */
114enum
115{
116 EIO_MS_ASYNC = 1,
117 EIO_MS_INVALIDATE = 2,
118 EIO_MS_SYNC = 4
119};
120
121/* eio_mtouch flags */
122enum
123{
124 EIO_MT_MODIFY = 1
104}; 125};
105 126
106/* eio_sync_file_range flags */ 127/* eio_sync_file_range flags */
107
108enum { 128enum
129{
109 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 130 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
110 EIO_SYNC_FILE_RANGE_WRITE = 2, 131 EIO_SYNC_FILE_RANGE_WRITE = 2,
111 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 132 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
112}; 133};
113 134
114typedef double eio_tstamp; /* feel free to use double in your code directly */ 135/* eio_fallocate flags */
136enum
137{
138 EIO_FALLOC_FL_KEEP_SIZE = 1 /* MUST match the value in linux/falloc.h */
139};
140
141/* timestamps and differences - feel free to use double in your code directly */
142typedef double eio_tstamp;
115 143
116/* the eio request structure */ 144/* the eio request structure */
117
118enum { 145enum
146{
119 EIO_CUSTOM, 147 EIO_CUSTOM,
120 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 148 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
121 EIO_READ, EIO_WRITE, 149 EIO_READ, EIO_WRITE,
122 EIO_READAHEAD, EIO_SENDFILE, 150 EIO_READAHEAD, EIO_SENDFILE,
123 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 151 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
152 EIO_STATVFS, EIO_FSTATVFS,
124 EIO_TRUNCATE, EIO_FTRUNCATE, 153 EIO_TRUNCATE, EIO_FTRUNCATE,
125 EIO_UTIME, EIO_FUTIME, 154 EIO_UTIME, EIO_FUTIME,
126 EIO_CHMOD, EIO_FCHMOD, 155 EIO_CHMOD, EIO_FCHMOD,
127 EIO_CHOWN, EIO_FCHOWN, 156 EIO_CHOWN, EIO_FCHOWN,
128 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 157 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
129 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 158 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
159 EIO_MLOCK, EIO_MLOCKALL,
130 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 160 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
131 EIO_MKNOD, EIO_READDIR, 161 EIO_MKNOD, EIO_READDIR,
132 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 162 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
133 EIO_GROUP, EIO_NOP, 163 EIO_GROUP, EIO_NOP,
134 EIO_BUSY 164 EIO_BUSY
165};
166
167/* mlockall constants */
168enum
169{
170 EIO_MCL_CURRENT = 1,
171 EIO_MCL_FUTURE = 2,
172};
173
174/* request priorities */
175
176enum {
177 EIO_PRI_MIN = -4,
178 EIO_PRI_MAX = 4,
179 EIO_PRI_DEFAULT = 0,
135}; 180};
136 181
137/* eio request structure */ 182/* eio request structure */
138/* this structure is mostly read-only */ 183/* this structure is mostly read-only */
139/* when initialising it, all members must be zero-initialised */ 184/* when initialising it, all members must be zero-initialised */
140struct eio_req 185struct eio_req
141{ 186{
142 eio_req volatile *next; /* private ETP */ 187 eio_req volatile *next; /* private ETP */
143 188
144 ssize_t result; /* result of syscall, e.g. result = read (... */ 189 ssize_t result; /* result of syscall, e.g. result = read (... */
145 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ 190 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
146 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ 191 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
147 void *ptr1; /* all applicable requests: pathname, old name; readdir: possible output memory buffer */ 192 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
148 void *ptr2; /* all applicable requests: new name or memory buffer */ 193 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
149 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 194 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
150 eio_tstamp nv2; /* utime, futime: mtime */ 195 eio_tstamp nv2; /* utime, futime: mtime */
151 196
152 int type; /* EIO_xxx constant ETP */ 197 int type; /* EIO_xxx constant ETP */
153 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ 198 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
154 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ 199 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
155 long int3; /* chown, fchown: gid; mknod: dev_t */ 200 long int3; /* chown, fchown: gid */
156 int errorno; /* errno value on syscall return */ 201 int errorno; /* errno value on syscall return */
202
203#if __i386 || __amd64
204 unsigned char cancelled;
205#else
206 sig_atomic_t cancelled;
207#endif
157 208
158 unsigned char flags; /* private */ 209 unsigned char flags; /* private */
159 signed char pri; /* the priority */ 210 signed char pri; /* the priority */
160 211
161 void *data; 212 void *data;
162 eio_cb finish; 213 eio_cb finish;
163 void (*destroy)(eio_req *req); /* called when requets no longer needed */ 214 void (*destroy)(eio_req *req); /* called when request no longer needed */
164 void (*feed)(eio_req *req); /* only used for group requests */ 215 void (*feed)(eio_req *req); /* only used for group requests */
165 216
166 EIO_REQ_MEMBERS 217 EIO_REQ_MEMBERS
167 218
168 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 219 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
169}; 220};
170 221
171/* _private_ flags */ 222/* _private_ request flags */
172enum { 223enum {
173 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
174 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 224 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
175 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 225 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
176 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ 226 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
177}; 227};
178 228
179enum { 229/* undocumented/unsupported/private helper */
180 EIO_PRI_MIN = -4, 230/*void eio_page_align (void **addr, size_t *length);*/
181 EIO_PRI_MAX = 4,
182 EIO_PRI_DEFAULT = 0,
183};
184 231
185/* returns < 0 on error, errno set 232/* returns < 0 on error, errno set
186 * need_poll, if non-zero, will be called when results are available 233 * need_poll, if non-zero, will be called when results are available
187 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 234 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
188 * done_poll is called when the need to poll is gone. 235 * done_poll is called when the need to poll is gone.
… …
202 * maximum wanted number 249 * maximum wanted number
203 * or maximum idle number of threads */ 250 * or maximum idle number of threads */
204void eio_set_min_parallel (unsigned int nthreads); 251void eio_set_min_parallel (unsigned int nthreads);
205void eio_set_max_parallel (unsigned int nthreads); 252void eio_set_max_parallel (unsigned int nthreads);
206void eio_set_max_idle (unsigned int nthreads); 253void eio_set_max_idle (unsigned int nthreads);
254void eio_set_idle_timeout (unsigned int seconds);
207 255
208unsigned int eio_nreqs (void); /* number of requests in-flight */ 256unsigned int eio_nreqs (void); /* number of requests in-flight */
209unsigned int eio_nready (void); /* number of not-yet handled requests */ 257unsigned int eio_nready (void); /* number of not-yet handled requests */
210unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 258unsigned int eio_npending (void); /* number of finished but unhandled requests */
211unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 259unsigned int eio_nthreads (void); /* number of worker threads in use currently */
212 260
213/*****************************************************************************/ 261/*****************************************************************************/
214/* convinience wrappers */ 262/* convenience wrappers */
215 263
216#ifndef EIO_NO_WRAPPERS 264#ifndef EIO_NO_WRAPPERS
217eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 265eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
218eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 266eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
219eio_req *eio_sync (int pri, eio_cb cb, void *data); 267eio_req *eio_sync (int pri, eio_cb cb, void *data);
220eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 268eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
221eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 269eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
222eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 270eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
223eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); 271eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
272eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
273eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
224eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); 274eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
275eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
225eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 276eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
226eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 277eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
227eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 278eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
228eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 279eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
229eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 280eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
281eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
230eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 282eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
231eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 283eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
232eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 284eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
233eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 285eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
234eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 286eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
… …
241eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 293eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
242eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 294eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
243eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 295eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
244eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 296eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
245eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 297eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
298eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
246eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 299eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
247eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 300eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
301eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
248eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 302eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
249eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 303eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
250eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 304eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
251eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 305eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
252eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); 306eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
253#endif 307#endif
254 308
255/*****************************************************************************/ 309/*****************************************************************************/
256/* groups */ 310/* groups */
257 311
… …
263 317
264/*****************************************************************************/ 318/*****************************************************************************/
265/* request api */ 319/* request api */
266 320
267/* true if the request was cancelled, useful in the invoke callback */ 321/* true if the request was cancelled, useful in the invoke callback */
268#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 322#define EIO_CANCELLED(req) ((req)->cancelled)
269 323
270#define EIO_RESULT(req) ((req)->result) 324#define EIO_RESULT(req) ((req)->result)
271/* returns a pointer to the result buffer allocated by eio */ 325/* returns a pointer to the result buffer allocated by eio */
272#define EIO_BUF(req) ((req)->ptr2) 326#define EIO_BUF(req) ((req)->ptr2)
273#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 327#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
328#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
274#define EIO_PATH(req) ((char *)(req)->ptr1) 329#define EIO_PATH(req) ((char *)(req)->ptr1)
275 330
276/* submit a request for execution */ 331/* submit a request for execution */
277void eio_submit (eio_req *req); 332void eio_submit (eio_req *req);
278/* cancel a request as soon fast as possible, if possible */ 333/* cancel a request as soon fast as possible, if possible */
279void eio_cancel (eio_req *req); 334void eio_cancel (eio_req *req);
280/* destroy a request that has never been submitted */
281void eio_destroy (eio_req *req);
282 335
283/*****************************************************************************/ 336/*****************************************************************************/
284/* convinience functions */ 337/* convenience functions */
285 338
286ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 339ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
287 340
288#ifdef __cplusplus 341#ifdef __cplusplus
289} 342}

Diff Legend

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