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

Comparing libeio/eio.h (file contents):
Revision 1.17 by root, Sun Oct 12 22:30:33 2008 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 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;
52typedef struct eio_dirent eio_dirent;
51 53
52typedef int (*eio_cb)(eio_req *req); 54typedef int (*eio_cb)(eio_req *req);
53 55
54#ifndef EIO_REQ_MEMBERS 56#ifndef EIO_REQ_MEMBERS
55# define EIO_REQ_MEMBERS 57# define EIO_REQ_MEMBERS
… …
57 59
58#ifndef EIO_STRUCT_STAT 60#ifndef EIO_STRUCT_STAT
59# define EIO_STRUCT_STAT struct stat 61# define EIO_STRUCT_STAT struct stat
60#endif 62#endif
61 63
64#ifndef EIO_STRUCT_STATVFS
65# define EIO_STRUCT_STATVFS struct statvfs
66#endif
67
68/* for readdir */
69
70/* eio_readdir flags */
62enum { 71enum
72{
73 EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */
74 EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */
75 EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */
76 EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */
77
78 EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */
79 EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */
80};
81
82/* using "typical" values in the hope that the compiler will do something sensible */
83enum eio_dtype
84{
85 EIO_DT_UNKNOWN = 0,
86 EIO_DT_FIFO = 1,
87 EIO_DT_CHR = 2,
88 EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */
89 EIO_DT_DIR = 4,
90 EIO_DT_NAM = 5, /* xenix special named file */
91 EIO_DT_BLK = 6,
92 EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */
93 EIO_DT_REG = 8,
94 EIO_DT_NWK = 9, /* HP-UX network special */
95 EIO_DT_CMP = 9, /* VxFS compressed */
96 EIO_DT_LNK = 10,
97 /* DT_SHAD = 11,*/
98 EIO_DT_SOCK = 12,
99 EIO_DT_DOOR = 13, /* solaris door */
100 EIO_DT_WHT = 14,
101 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
102};
103
104struct eio_dirent
105{
106 int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */
107 unsigned short namelen; /* size of filename without trailing 0 */
108 unsigned char type; /* one of EIO_DT_* */
109 signed char score; /* internal use */
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
125};
126
127/* eio_sync_file_range flags */
128enum
129{
130 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
131 EIO_SYNC_FILE_RANGE_WRITE = 2,
132 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
133};
134
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;
143
144/* the eio request structure */
145enum
146{
63 EIO_CUSTOM, 147 EIO_CUSTOM,
64 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 148 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
65 EIO_READ, EIO_WRITE, 149 EIO_READ, EIO_WRITE,
66 EIO_READAHEAD, EIO_SENDFILE, 150 EIO_READAHEAD, EIO_SENDFILE,
67 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 151 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
152 EIO_STATVFS, EIO_FSTATVFS,
68 EIO_TRUNCATE, EIO_FTRUNCATE, 153 EIO_TRUNCATE, EIO_FTRUNCATE,
69 EIO_UTIME, EIO_FUTIME, 154 EIO_UTIME, EIO_FUTIME,
70 EIO_CHMOD, EIO_FCHMOD, 155 EIO_CHMOD, EIO_FCHMOD,
71 EIO_CHOWN, EIO_FCHOWN, 156 EIO_CHOWN, EIO_FCHOWN,
72 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_MSYNC, EIO_MTOUCH, 157 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
158 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
159 EIO_MLOCK, EIO_MLOCKALL,
73 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 160 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
74 EIO_MKNOD, EIO_READDIR, 161 EIO_MKNOD, EIO_READDIR,
75 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 162 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
76 EIO_GROUP, EIO_NOP, 163 EIO_GROUP, EIO_NOP,
77 EIO_BUSY, 164 EIO_BUSY
78}; 165};
79 166
80typedef double eio_tstamp; /* feel free to use double in your code directly */ 167/* mlockall constants */
81
82/* eio request structure */
83/* this structure is mostly read-only */
84struct eio_req
85{
86 eio_req volatile *next; /* private ETP */
87
88 ssize_t result; /* result of syscall, e.g. result = read (... */
89 off_t offs; /* read, write, truncate, readahead: file offset */
90 size_t size; /* read, write, readahead, sendfile, msync: length */
91 void *ptr1; /* all applicable requests: pathname, old name */
92 void *ptr2; /* all applicable requests: new name or memory buffer */
93 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
94 eio_tstamp nv2; /* utime, futime: mtime */
95
96 int type; /* EIO_xxx constant ETP */
97 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync: flags */
98 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
99 long int3; /* chown, fchown: gid; mknod: dev_t */
100 int errorno; /* errno value on syscall return */
101
102 unsigned char flags; /* private */
103 signed char pri; /* the priority */
104
105 void *data;
106 eio_cb finish;
107 void (*destroy)(eio_req *req); /* called when requets no longer needed */
108 void (*feed)(eio_req *req); /* only used for group requests */
109
110 EIO_REQ_MEMBERS
111
112 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
113};
114
115/* _private_ flags */
116enum { 168enum
117 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 169{
118 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 170 EIO_MCL_CURRENT = 1,
119 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ 171 EIO_MCL_FUTURE = 2,
120 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
121}; 172};
173
174/* request priorities */
122 175
123enum { 176enum {
124 EIO_PRI_MIN = -4, 177 EIO_PRI_MIN = -4,
125 EIO_PRI_MAX = 4, 178 EIO_PRI_MAX = 4,
126 EIO_PRI_DEFAULT = 0, 179 EIO_PRI_DEFAULT = 0,
127}; 180};
181
182/* eio request structure */
183/* this structure is mostly read-only */
184/* when initialising it, all members must be zero-initialised */
185struct eio_req
186{
187 eio_req volatile *next; /* private ETP */
188
189 ssize_t result; /* result of syscall, e.g. result = read (... */
190 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
191 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
192 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
193 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
194 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
195 eio_tstamp nv2; /* utime, futime: mtime */
196
197 int type; /* EIO_xxx constant ETP */
198 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
199 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range, fallocate: flags */
200 long int3; /* chown, fchown: gid */
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
208
209 unsigned char flags; /* private */
210 signed char pri; /* the priority */
211
212 void *data;
213 eio_cb finish;
214 void (*destroy)(eio_req *req); /* called when request no longer needed */
215 void (*feed)(eio_req *req); /* only used for group requests */
216
217 EIO_REQ_MEMBERS
218
219 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
220};
221
222/* _private_ request flags */
223enum {
224 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
225 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
226 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
227};
228
229/* undocumented/unsupported/private helper */
230/*void eio_page_align (void **addr, size_t *length);*/
128 231
129/* returns < 0 on error, errno set 232/* returns < 0 on error, errno set
130 * 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
131 * 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).
132 * done_poll is called when the need to poll is gone. 235 * done_poll is called when the need to poll is gone.
… …
146 * maximum wanted number 249 * maximum wanted number
147 * or maximum idle number of threads */ 250 * or maximum idle number of threads */
148void eio_set_min_parallel (unsigned int nthreads); 251void eio_set_min_parallel (unsigned int nthreads);
149void eio_set_max_parallel (unsigned int nthreads); 252void eio_set_max_parallel (unsigned int nthreads);
150void eio_set_max_idle (unsigned int nthreads); 253void eio_set_max_idle (unsigned int nthreads);
254void eio_set_idle_timeout (unsigned int seconds);
151 255
152unsigned int eio_nreqs (void); /* number of requests in-flight */ 256unsigned int eio_nreqs (void); /* number of requests in-flight */
153unsigned int eio_nready (void); /* number of not-yet handled requests */ 257unsigned int eio_nready (void); /* number of not-yet handled requests */
154unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 258unsigned int eio_npending (void); /* number of finished but unhandled requests */
155unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 259unsigned int eio_nthreads (void); /* number of worker threads in use currently */
156 260
157/*****************************************************************************/ 261/*****************************************************************************/
158/* convinience wrappers */ 262/* convenience wrappers */
159 263
160#ifndef EIO_NO_WRAPPERS 264#ifndef EIO_NO_WRAPPERS
161eio_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 */
162eio_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 */
163eio_req *eio_sync (int pri, eio_cb cb, void *data); 267eio_req *eio_sync (int pri, eio_cb cb, void *data);
164eio_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);
165eio_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);
166eio_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);
167eio_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);
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);
168eio_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);
169eio_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);
170eio_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);
171eio_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);
172eio_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 */
173eio_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);
174eio_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);
175eio_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);
176eio_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);
177eio_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);
… …
180eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 289eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
181eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 290eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
182eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 291eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
183eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 292eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
184eio_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);
185eio_req *eio_readdir (const char *path, 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 */
186eio_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);
187eio_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);
188eio_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 */
189eio_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 */
190eio_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 */
191eio_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);
192eio_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);
193eio_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);
194eio_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);
195eio_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);
196#endif 307#endif
197 308
198/*****************************************************************************/ 309/*****************************************************************************/
199/* groups */ 310/* groups */
200 311
… …
206 317
207/*****************************************************************************/ 318/*****************************************************************************/
208/* request api */ 319/* request api */
209 320
210/* true if the request was cancelled, useful in the invoke callback */ 321/* true if the request was cancelled, useful in the invoke callback */
211#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 322#define EIO_CANCELLED(req) ((req)->cancelled)
212 323
213#define EIO_RESULT(req) ((req)->result) 324#define EIO_RESULT(req) ((req)->result)
214/* returns a pointer to the result buffer allocated by eio */ 325/* returns a pointer to the result buffer allocated by eio */
215#define EIO_BUF(req) ((req)->ptr2) 326#define EIO_BUF(req) ((req)->ptr2)
216#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))
217#define EIO_PATH(req) ((char *)(req)->ptr1) 329#define EIO_PATH(req) ((char *)(req)->ptr1)
218 330
219/* submit a request for execution */ 331/* submit a request for execution */
220void eio_submit (eio_req *req); 332void eio_submit (eio_req *req);
221/* cancel a request as soon fast as possible, if possible */ 333/* cancel a request as soon fast as possible, if possible */
222void eio_cancel (eio_req *req); 334void eio_cancel (eio_req *req);
223/* destroy a request that has never been submitted */
224void eio_destroy (eio_req *req);
225 335
226/*****************************************************************************/ 336/*****************************************************************************/
227/* convinience functions */ 337/* convenience functions */
228 338
229ssize_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);
230 340
231#ifdef __cplusplus 341#ifdef __cplusplus
232} 342}

Diff Legend

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