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

Comparing libeio/eio.h (file contents):
Revision 1.6 by root, Mon May 12 00:31:43 2008 UTC vs.
Revision 1.11 by root, Tue May 13 19:34:11 2008 UTC

… …
6 6
7typedef struct eio_req eio_req; 7typedef struct eio_req eio_req;
8 8
9typedef int (*eio_cb)(eio_req *req); 9typedef int (*eio_cb)(eio_req *req);
10 10
11#ifndef EIO_COMMON 11#ifndef EIO_REQ_MEMBERS
12# define EIO_COMMON void *data 12# define EIO_REQ_MEMBERS
13#endif 13#endif
14 14
15#ifndef EIO_STRUCT_STAT 15#ifndef EIO_STRUCT_STAT
16# define EIO_STRUCT_STAT struct stat 16# define EIO_STRUCT_STAT struct stat
17#endif 17#endif
… …
55 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ 55 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */
56 long int3; /* chown, fchown: gid */ 56 long int3; /* chown, fchown: gid */
57 int errorno; /* errno value on syscall return */ 57 int errorno; /* errno value on syscall return */
58 58
59 unsigned char flags; /* private */ 59 unsigned char flags; /* private */
60 unsigned char pri; /* the priority */ 60 signed char pri; /* the priority */
61 61
62 void *data;
62 eio_cb finish; 63 eio_cb finish;
63 void (*destroy)(eio_req *req); 64 void (*destroy)(eio_req *req); /* called when requets no longer needed */
64 void (*feed)(eio_req *req); 65 void (*feed)(eio_req *req); /* only used for group requests */
65 66
66 EIO_COMMON; 67 EIO_REQ_MEMBERS
67 68
68 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 69 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
69}; 70};
70 71
71enum { 72enum {
… …
76 77
77enum { 78enum {
78 EIO_PRI_MIN = -4, 79 EIO_PRI_MIN = -4,
79 EIO_PRI_MAX = 4, 80 EIO_PRI_MAX = 4,
80 81
81 EIO_DEFAULT_PRI = 0, 82 EIO_PRI_DEFAULT = 0,
82 EIO_PRI_BIAS = -EIO_PRI_MIN, 83 EIO_PRI_BIAS = -EIO_PRI_MIN,
83 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1 84 EIO_NUM_PRI = EIO_PRI_MAX + EIO_PRI_BIAS + 1
84}; 85};
85 86
86/* returns < 0 on error, errno set 87/* returns < 0 on error, errno set
… …
110unsigned int eio_nready (void); /* number of not-yet handled requests */ 111unsigned int eio_nready (void); /* number of not-yet handled requests */
111unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */ 112unsigned int eio_npending (void); /* numbe rof finished but unhandled requests */
112unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 113unsigned int eio_nthreads (void); /* number of worker threads in use currently */
113 114
114/*****************************************************************************/ 115/*****************************************************************************/
115/* high-level request API */ 116/* convinience wrappers */
116 117
118#ifndef EIO_NO_WRAPPERS
117eio_req *eio_nop (eio_cb cb); /* does nothing except go through the whole process */ 119eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
118eio_req *eio_busy (eio_tstamp delay, eio_cb cb); /* ties a thread for this long, simulating busyness */ 120eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
119eio_req *eio_sync (eio_cb cb);
120eio_req *eio_fsync (int fd, eio_cb cb); 121eio_req *eio_sync (int pri, eio_cb cb, void *data);
122eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
121eio_req *eio_fdatasync (int fd, eio_cb cb); 123eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
122eio_req *eio_close (int fd, eio_cb cb); 124eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
123eio_req *eio_readahead (int fd, off_t offset, size_t length, eio_cb cb); 125eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
124eio_req *eio_read (int fd, void *data, size_t length, off_t offset, eio_cb cb); 126eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
125eio_req *eio_write (int fd, void *data, size_t length, off_t offset, eio_cb cb); 127eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
126eio_req *eio_fstat (int fd, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 128eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
127eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 129eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
128eio_req *eio_ftruncate (int fd, off_t offset, eio_cb cb); 130eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
129eio_req *eio_fchmod (int fd, mode_t mode, eio_cb cb); 131eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
130eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, eio_cb cb); 132eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
131eio_req *eio_dup2 (int fd, int fd2, eio_cb cb); 133eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
132eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, eio_cb cb); 134eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
133eio_req *eio_open (const char *path, int flags, mode_t mode, eio_cb cb); 135eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data);
134eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, eio_cb cb); 136eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
135eio_req *eio_truncate (const char *path, off_t offset, eio_cb cb); 137eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
136eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, eio_cb cb); 138eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
137eio_req *eio_chmod (const char *path, mode_t mode, eio_cb cb); 139eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
138eio_req *eio_mkdir (const char *path, mode_t mode, eio_cb cb); 140eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
139eio_req *eio_readdir (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ 141eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
140eio_req *eio_rmdir (const char *path, eio_cb cb); 142eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
141eio_req *eio_unlink (const char *path, eio_cb cb); 143eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
142eio_req *eio_readlink (const char *path, eio_cb cb); /* result=ptr2 allocated dynamically */ 144eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
143eio_req *eio_stat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 145eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
144eio_req *eio_lstat (const char *path, eio_cb cb); /* stat buffer=ptr2 allocated dynamically */ 146eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
145eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, eio_cb cb); 147eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
146eio_req *eio_link (const char *path, const char *new_path, eio_cb cb); 148eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
147eio_req *eio_symlink (const char *path, const char *new_path, eio_cb cb); 149eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
148eio_req *eio_rename (const char *path, const char *new_path, eio_cb cb); 150eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
151#endif
149 152
153/*****************************************************************************/
150/* for groups */ 154/* groups */
155
151eio_req *eio_grp (eio_cb cb); 156eio_req *eio_grp (eio_cb cb, void *data);
152void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit); 157void eio_grp_feed (eio_req *grp, void (*feed)(eio_req *req), int limit);
153void eio_grp_limit (eio_req *grp, int limit); 158void eio_grp_limit (eio_req *grp, int limit);
154void eio_grp_add (eio_req *grp, eio_req *req); 159void eio_grp_add (eio_req *grp, eio_req *req);
155void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */ 160void eio_grp_cancel (eio_req *grp); /* cancels all sub requests but not the group */
156 161
157/* cancel a request as soon fast as possible */ 162/*****************************************************************************/
158void eio_cancel (eio_req *req); 163/* request api */
159/* destroy a request that has never been submitted */
160void eio_destroy (eio_req *req);
161 164
162/* true if the request was cancelled, useful in the invoke callback */ 165/* true if the request was cancelled, useful in the invoke callback */
163#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 166#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
164 167
165#define EIO_RESULT(req) ((req)->result) 168#define EIO_RESULT(req) ((req)->result)
166/* returns a pointer to the result buffer allocated by eio */ 169/* returns a pointer to the result buffer allocated by eio */
167#define EIO_BUF(req) ((req)->ptr2) 170#define EIO_BUF(req) ((req)->ptr2)
168#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) 171#define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req))
169#define EIO_PATH(req) ((char *)(req)->ptr1) 172#define EIO_PATH(req) ((char *)(req)->ptr1)
170 173
171/*****************************************************************************/
172/* low-level request API */
173
174/* must be used to initialise eio_req's */
175#define EIO_INIT(req,prio,finish_cb, destroy_cb) \
176 memset ((req), 0, sizeof (eio_req)); \
177 (req)->pri = (prio) + EIO_PRI_BIAS; \
178 (req)->finish = (finish_cb); \
179 (req)->destroy = (destroy_cb)
180
181/* submit a request for execution */ 174/* submit a request for execution */
182void eio_submit (eio_req *req); 175void eio_submit (eio_req *req);
176/* cancel a request as soon fast as possible, if possible */
177void eio_cancel (eio_req *req);
178/* destroy a request that has never been submitted */
179void eio_destroy (eio_req *req);
183 180
184/*****************************************************************************/ 181/*****************************************************************************/
185/* convinience functions */ 182/* convinience functions */
186 183
187ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 184ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);

Diff Legend

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