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

Comparing libeio/eio.h (file contents):
Revision 1.36 by sf-exg, Thu Jul 7 17:35:52 2011 UTC vs.
Revision 1.54 by root, Mon Aug 18 08:11:54 2014 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 *
10 * 1. Redistributions of source code must retain the above copyright notice, 10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer. 11 * this list of conditions and the following disclaimer.
12 * 12 *
13 * 2. Redistributions in binary form must reproduce the above copyright 13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the 14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution. 15 * documentation and/or other materials provided with the distribution.
16 * 16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- 20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
… …
56#ifndef EIO_REQ_MEMBERS 56#ifndef EIO_REQ_MEMBERS
57# define EIO_REQ_MEMBERS 57# define EIO_REQ_MEMBERS
58#endif 58#endif
59 59
60#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
61# 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;
62#endif 87#endif
63 88
64#ifndef EIO_STRUCT_STATVFS 89#ifndef EIO_STRUCT_STATVFS
65# define EIO_STRUCT_STATVFS struct statvfs 90# define EIO_STRUCT_STATVFS struct statvfs
66#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);
67 102
68/* for readdir */ 103/* for readdir */
69 104
70/* eio_readdir flags */ 105/* eio_readdir flags */
71enum 106enum
… …
105{ 140{
106 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 */
107 unsigned short namelen; /* size of filename without trailing 0 */ 142 unsigned short namelen; /* size of filename without trailing 0 */
108 unsigned char type; /* one of EIO_DT_* */ 143 unsigned char type; /* one of EIO_DT_* */
109 signed char score; /* internal use */ 144 signed char score; /* internal use */
110 ino_t inode; /* the inode number, if available, otherwise unspecified */ 145 eio_ino_t inode; /* the inode number, if available, otherwise unspecified */
111}; 146};
112 147
113/* eio_msync flags */ 148/* eio_msync flags */
114enum 149enum
115{ 150{
… …
117 EIO_MS_INVALIDATE = 2, 152 EIO_MS_INVALIDATE = 2,
118 EIO_MS_SYNC = 4 153 EIO_MS_SYNC = 4
119}; 154};
120 155
121/* eio_mtouch flags */ 156/* eio_mtouch flags */
122
123enum 157enum
124{ 158{
125 EIO_MT_MODIFY = 1 159 EIO_MT_MODIFY = 1
126}; 160};
127 161
128/* eio_sync_file_range flags */ 162/* eio_sync_file_range flags */
129
130enum 163enum
131{ 164{
132 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, 165 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
133 EIO_SYNC_FILE_RANGE_WRITE = 2, 166 EIO_SYNC_FILE_RANGE_WRITE = 2,
134 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 167 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
135}; 168};
136 169
137typedef double eio_tstamp; /* feel free to use double in your code directly */ 170/* eio_fallocate flags */
171enum
172{
173 /* these MUST match the value in linux/falloc.h */
174 EIO_FALLOC_FL_KEEP_SIZE = 1,
175 EIO_FALLOC_FL_PUNCH_HOLE = 2
176};
177
178/* timestamps and differences - feel free to use double in your code directly */
179typedef double eio_tstamp;
138 180
139/* the eio request structure */ 181/* the eio request structure */
140
141enum 182enum
142{ 183{
143 EIO_CUSTOM, 184 EIO_CUSTOM,
185 EIO_WD_OPEN, EIO_WD_CLOSE,
186
144 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 187 EIO_CLOSE, EIO_DUP2,
145 EIO_READ, EIO_WRITE, 188 EIO_SEEK, EIO_READ, EIO_WRITE,
146 EIO_READAHEAD, EIO_SENDFILE, 189 EIO_READAHEAD, EIO_SENDFILE,
147 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
148 EIO_STATVFS, EIO_FSTATVFS, 190 EIO_FSTAT, EIO_FSTATVFS,
149 EIO_TRUNCATE, EIO_FTRUNCATE, 191 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
150 EIO_UTIME, EIO_FUTIME,
151 EIO_CHMOD, EIO_FCHMOD,
152 EIO_CHOWN, EIO_FCHOWN,
153 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 192 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
154 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, 193 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
155 EIO_MLOCK, EIO_MLOCKALL, 194 EIO_MLOCK, EIO_MLOCKALL,
195 EIO_GROUP, EIO_NOP,
196 EIO_BUSY,
197
198 /* these use wd + ptr1, but are emulated */
199 EIO_REALPATH,
200 EIO_READDIR,
201
202 /* all the following requests use wd + ptr1 as path in xxxat functions */
203 EIO_OPEN,
204 EIO_STAT, EIO_LSTAT, EIO_STATVFS,
205 EIO_TRUNCATE,
206 EIO_UTIME,
207 EIO_CHMOD,
208 EIO_CHOWN,
156 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 209 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
157 EIO_MKNOD, EIO_READDIR, 210 EIO_MKNOD,
158 EIO_LINK, EIO_SYMLINK, EIO_READLINK, EIO_REALPATH, 211 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
159 EIO_GROUP, EIO_NOP, 212
160 EIO_BUSY 213 EIO_REQ_TYPE_NUM
161}; 214};
215
216/* seek whence modes */
217/* these are guaranteed to hasve the traditional 0, 1, 2 values, */
218/* so you might as wlel use those */
219enum
220{
221 EIO_SEEK_SET = 0,
222 EIO_SEEK_CUR = 1,
223 EIO_SEEK_END = 2
224};
225
162 226
163/* mlockall constants */ 227/* mlockall constants */
164enum 228enum
165{ 229{
166 EIO_MCL_CURRENT = 1, 230 EIO_MCL_CURRENT = 1,
167 EIO_MCL_FUTURE = 2, 231 EIO_MCL_FUTURE = 2
168}; 232};
169 233
170/* request priorities */ 234/* request priorities */
171 235
172enum { 236enum {
173 EIO_PRI_MIN = -4, 237 EIO_PRI_MIN = -4,
174 EIO_PRI_MAX = 4, 238 EIO_PRI_MAX = 4,
175 EIO_PRI_DEFAULT = 0, 239 EIO_PRI_DEFAULT = 0
176}; 240};
177 241
178/* eio request structure */ 242/* eio request structure */
179/* this structure is mostly read-only */ 243/* this structure is mostly read-only */
180/* when initialising it, all members must be zero-initialised */ 244/* when initialising it, all members must be zero-initialised */
181struct eio_req 245struct eio_req
182{ 246{
183 eio_req volatile *next; /* private ETP */ 247 eio_req volatile *next; /* private ETP */
184 248
249 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
250
185 ssize_t result; /* result of syscall, e.g. result = read (... */ 251 eio_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 */ 252 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
187 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ 253 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
188 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 254 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 */ 255 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
190 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 256 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
191 eio_tstamp nv2; /* utime, futime: mtime */ 257 eio_tstamp nv2; /* utime, futime: mtime */
192 258
193 int type; /* EIO_xxx constant ETP */
194 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 */
195 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 */
196 long int3; /* chown, fchown: gid */ 261 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
197 int errorno; /* errno value on syscall return */ 262 int errorno; /* errno value on syscall return */
198 263
264 unsigned char flags; /* private */
265
266 signed char type;/* EIO_xxx constant ETP */
267 signed char pri; /* the priority ETP */
199#if __i386 || __amd64 268#if __i386 || __amd64
200 unsigned char cancelled; 269 unsigned char cancelled; /* ETP */
201#else 270#else
202 sig_atomic_t cancelled; 271 sig_atomic_t cancelled; /* ETP */
203#endif 272#endif
204
205 unsigned char flags; /* private */
206 signed char pri; /* the priority */
207 273
208 void *data; 274 void *data;
209 eio_cb finish; 275 eio_cb finish;
210 void (*destroy)(eio_req *req); /* called when request no longer needed */ 276 void (*destroy)(eio_req *req); /* called when request no longer needed */
211 void (*feed)(eio_req *req); /* only used for group requests */ 277 void (*feed)(eio_req *req); /* only used for group requests */
212 278
213 EIO_REQ_MEMBERS 279 EIO_REQ_MEMBERS
214 280
215 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 281 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private ETP */
216}; 282};
217 283
218/* _private_ request flags */ 284/* _private_ request flags */
219enum { 285enum {
220 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ 286 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
… …
256 322
257/*****************************************************************************/ 323/*****************************************************************************/
258/* convenience wrappers */ 324/* convenience wrappers */
259 325
260#ifndef EIO_NO_WRAPPERS 326#ifndef EIO_NO_WRAPPERS
327eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
328eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
261eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 329eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
262eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 330eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
263eio_req *eio_sync (int pri, eio_cb cb, void *data); 331eio_req *eio_sync (int pri, eio_cb cb, void *data);
264eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 332eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
265eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 333eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
334eio_req *eio_syncfs (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); 335eio_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); 336eio_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); 337eio_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); 338eio_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); 339eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
340eio_req *eio_fallocate (int fd, int mode, off_t offset, size_t len, int pri, eio_cb cb, void *data);
271eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 341eio_req *eio_close (int fd, 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); 342eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
343eio_req *eio_seek (int fd, off_t offset, int whence, 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); 344eio_req *eio_read (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); 345eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
275eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 346eio_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 */ 347eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
277eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 348eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
278eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 349eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
279eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 350eio_req *eio_fchmod (int fd, mode_t mode, 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); 351eio_req *eio_fchown (int fd, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
281eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 352eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
282eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data); 353eio_req *eio_sendfile (int out_fd, int in_fd, off_t in_offset, size_t length, int pri, eio_cb cb, void *data);
283eio_req *eio_open (const char *path, int flags, mode_t mode, int pri, eio_cb cb, void *data); 354eio_req *eio_open (const char *path, int flags, mode_t mode, 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); 355eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
285eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 356eio_req *eio_truncate (const char *path, off_t offset, 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); 357eio_req *eio_chown (const char *path, eio_uid_t uid, eio_gid_t gid, int pri, eio_cb cb, void *data);
287eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 358eio_req *eio_chmod (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); 359eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
289eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 360eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
290eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 361eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
291eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 362eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
… …
329void eio_cancel (eio_req *req); 400void eio_cancel (eio_req *req);
330 401
331/*****************************************************************************/ 402/*****************************************************************************/
332/* convenience functions */ 403/* convenience functions */
333 404
334ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 405eio_ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
335 406
336#ifdef __cplusplus 407#ifdef __cplusplus
337} 408}
338#endif 409#endif
339 410

Diff Legend

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