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

Comparing libeio/eio.h (file contents):
Revision 1.13 by root, Sat May 17 12:26:57 2008 UTC vs.
Revision 1.36 by sf-exg, Thu Jul 7 17:35:52 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 *
… …
38 */ 38 */
39 39
40#ifndef EIO_H_ 40#ifndef EIO_H_
41#define EIO_H_ 41#define EIO_H_
42 42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
43#include <stddef.h> 47#include <stddef.h>
48#include <signal.h>
44#include <sys/types.h> 49#include <sys/types.h>
45 50
46typedef struct eio_req eio_req; 51typedef struct eio_req eio_req;
52typedef struct eio_dirent eio_dirent;
47 53
48typedef int (*eio_cb)(eio_req *req); 54typedef int (*eio_cb)(eio_req *req);
49 55
50#ifndef EIO_REQ_MEMBERS 56#ifndef EIO_REQ_MEMBERS
51# define EIO_REQ_MEMBERS 57# define EIO_REQ_MEMBERS
… …
53 59
54#ifndef EIO_STRUCT_STAT 60#ifndef EIO_STRUCT_STAT
55# define EIO_STRUCT_STAT struct stat 61# define EIO_STRUCT_STAT struct stat
56#endif 62#endif
57 63
64#ifndef EIO_STRUCT_STATVFS
65# define EIO_STRUCT_STATVFS struct statvfs
66#endif
67
68/* for readdir */
69
70/* eio_readdir flags */
58enum { 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 */
122
123enum
124{
125 EIO_MT_MODIFY = 1
126};
127
128/* eio_sync_file_range flags */
129
130enum
131{
132 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
133 EIO_SYNC_FILE_RANGE_WRITE = 2,
134 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
135};
136
137typedef double eio_tstamp; /* feel free to use double in your code directly */
138
139/* the eio request structure */
140
141enum
142{
143 EIO_CUSTOM,
59 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 144 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
60 EIO_READ, EIO_WRITE, 145 EIO_READ, EIO_WRITE,
61 EIO_READAHEAD, EIO_SENDFILE, 146 EIO_READAHEAD, EIO_SENDFILE,
62 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 147 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
148 EIO_STATVFS, EIO_FSTATVFS,
63 EIO_TRUNCATE, EIO_FTRUNCATE, 149 EIO_TRUNCATE, EIO_FTRUNCATE,
64 EIO_UTIME, EIO_FUTIME, 150 EIO_UTIME, EIO_FUTIME,
65 EIO_CHMOD, EIO_FCHMOD, 151 EIO_CHMOD, EIO_FCHMOD,
66 EIO_CHOWN, EIO_FCHOWN, 152 EIO_CHOWN, EIO_FCHOWN,
67 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 153 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
154 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
155 EIO_MLOCK, EIO_MLOCKALL,
68 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 156 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
69 EIO_MKNOD, EIO_READDIR, 157 EIO_MKNOD, EIO_READDIR,
70 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 158 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH,
71 EIO_GROUP, EIO_NOP, 159 EIO_GROUP, EIO_NOP,
72 EIO_BUSY, EIO_CUSTOM 160 EIO_BUSY
73}; 161};
74 162
75typedef double eio_tstamp; /* feel free to use double in your code directly */ 163/* mlockall constants */
76
77/* eio request structure */
78/* this structure is mostly read-only */
79struct eio_req
80{
81 eio_req volatile *next; /* private ETP */
82
83 ssize_t result; /* result of syscall, e.g. result = read (... */
84 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */
85 size_t size; /* read, write, readahead, sendfile: length */
86 void *ptr1; /* all applicable requests: pathname, old name */
87 void *ptr2; /* all applicable requests: new name or memory buffer */
88 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
89 eio_tstamp nv2; /* utime, futime: mtime */
90
91 int type; /* EIO_xxx constant ETP */
92 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */
93 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
94 long int3; /* chown, fchown: gid */
95 int errorno; /* errno value on syscall return */
96
97 unsigned char flags; /* private */
98 signed char pri; /* the priority */
99
100 void *data;
101 eio_cb finish;
102 void (*destroy)(eio_req *req); /* called when requets no longer needed */
103 void (*feed)(eio_req *req); /* only used for group requests */
104
105 EIO_REQ_MEMBERS
106
107 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
108};
109
110enum { 164enum
111 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 165{
112 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 166 EIO_MCL_CURRENT = 1,
113 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 167 EIO_MCL_FUTURE = 2,
114}; 168};
169
170/* request priorities */
115 171
116enum { 172enum {
117 EIO_PRI_MIN = -4, 173 EIO_PRI_MIN = -4,
118 EIO_PRI_MAX = 4, 174 EIO_PRI_MAX = 4,
119 EIO_PRI_DEFAULT = 0, 175 EIO_PRI_DEFAULT = 0,
120}; 176};
177
178/* eio request structure */
179/* this structure is mostly read-only */
180/* when initialising it, all members must be zero-initialised */
181struct eio_req
182{
183 eio_req volatile *next; /* private ETP */
184
185 ssize_t result; /* result of syscall, e.g. result = read (... */
186 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */
187 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */
188 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
189 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
190 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
191 eio_tstamp nv2; /* utime, futime: mtime */
192
193 int type; /* EIO_xxx constant ETP */
194 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
195 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
196 long int3; /* chown, fchown: gid */
197 int errorno; /* errno value on syscall return */
198
199#if __i386 || __amd64
200 unsigned char cancelled;
201#else
202 sig_atomic_t cancelled;
203#endif
204
205 unsigned char flags; /* private */
206 signed char pri; /* the priority */
207
208 void *data;
209 eio_cb finish;
210 void (*destroy)(eio_req *req); /* called when request no longer needed */
211 void (*feed)(eio_req *req); /* only used for group requests */
212
213 EIO_REQ_MEMBERS
214
215 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
216};
217
218/* _private_ request flags */
219enum {
220 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
221 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
222 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
223};
224
225/* undocumented/unsupported/private helper */
226/*void eio_page_align (void **addr, size_t *length);*/
121 227
122/* returns < 0 on error, errno set 228/* returns < 0 on error, errno set
123 * need_poll, if non-zero, will be called when results are available 229 * need_poll, if non-zero, will be called when results are available
124 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 230 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
125 * done_poll is called when the need to poll is gone. 231 * done_poll is called when the need to poll is gone.
… …
139 * maximum wanted number 245 * maximum wanted number
140 * or maximum idle number of threads */ 246 * or maximum idle number of threads */
141void eio_set_min_parallel (unsigned int nthreads); 247void eio_set_min_parallel (unsigned int nthreads);
142void eio_set_max_parallel (unsigned int nthreads); 248void eio_set_max_parallel (unsigned int nthreads);
143void eio_set_max_idle (unsigned int nthreads); 249void eio_set_max_idle (unsigned int nthreads);
250void eio_set_idle_timeout (unsigned int seconds);
144 251
145unsigned int eio_nreqs (void); /* number of requests in-flight */ 252unsigned int eio_nreqs (void); /* number of requests in-flight */
146unsigned int eio_nready (void); /* number of not-yet handled requests */ 253unsigned int eio_nready (void); /* number of not-yet handled requests */
147unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 254unsigned int eio_npending (void); /* number of finished but unhandled requests */
148unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 255unsigned int eio_nthreads (void); /* number of worker threads in use currently */
149 256
150/*****************************************************************************/ 257/*****************************************************************************/
151/* convinience wrappers */ 258/* convenience wrappers */
152 259
153#ifndef EIO_NO_WRAPPERS 260#ifndef EIO_NO_WRAPPERS
154eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 261eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
155eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 262eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
156eio_req *eio_sync (int pri, eio_cb cb, void *data); 263eio_req *eio_sync (int pri, eio_cb cb, void *data);
157eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 264eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
158eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 265eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
266eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
267eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
268eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data);
269eio_req *eio_mlockall (int flags, int pri, eio_cb cb, void *data);
270eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
159eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 271eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
160eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 272eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
161eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 273eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
162eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 274eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
163eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 275eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
276eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
164eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 277eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
165eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 278eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
166eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 279eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
167eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 280eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
168eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 281eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
… …
171eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 284eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
172eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 285eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
173eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 286eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
174eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 287eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
175eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 288eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
176eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 289eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
177eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 290eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
178eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 291eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
179eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 292eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
293eio_req *eio_realpath (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
180eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 294eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
181eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 295eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
296eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
182eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 297eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
183eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 298eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
184eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 299eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
185eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 300eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
186eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); 301eio_req *eio_custom (void (*execute)(eio_req *), int pri, eio_cb cb, void *data);
187#endif 302#endif
188 303
189/*****************************************************************************/ 304/*****************************************************************************/
190/* groups */ 305/* groups */
191 306
… …
197 312
198/*****************************************************************************/ 313/*****************************************************************************/
199/* request api */ 314/* request api */
200 315
201/* true if the request was cancelled, useful in the invoke callback */ 316/* true if the request was cancelled, useful in the invoke callback */
202#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 317#define EIO_CANCELLED(req) ((req)->cancelled)
203 318
204#define EIO_RESULT(req) ((req)->result) 319#define EIO_RESULT(req) ((req)->result)
205/* returns a pointer to the result buffer allocated by eio */ 320/* returns a pointer to the result buffer allocated by eio */
206#define EIO_BUF(req) ((req)->ptr2) 321#define EIO_BUF(req) ((req)->ptr2)
207#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 322#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
323#define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req))
208#define EIO_PATH(req) ((char *)(req)->ptr1) 324#define EIO_PATH(req) ((char *)(req)->ptr1)
209 325
210/* submit a request for execution */ 326/* submit a request for execution */
211void eio_submit (eio_req *req); 327void eio_submit (eio_req *req);
212/* cancel a request as soon fast as possible, if possible */ 328/* cancel a request as soon fast as possible, if possible */
213void eio_cancel (eio_req *req); 329void eio_cancel (eio_req *req);
214/* destroy a request that has never been submitted */
215void eio_destroy (eio_req *req);
216 330
217/*****************************************************************************/ 331/*****************************************************************************/
218/* convinience functions */ 332/* convenience functions */
219 333
220ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 334ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
221 335
336#ifdef __cplusplus
337}
222#endif 338#endif
223 339
340#endif
341

Diff Legend

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