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 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 | * |
… | |
… | |
45 | #endif |
45 | #endif |
46 | |
46 | |
47 | #include <stddef.h> |
47 | #include <stddef.h> |
48 | #include <sys/types.h> |
48 | #include <sys/types.h> |
49 | |
49 | |
50 | typedef struct eio_req eio_req; |
50 | typedef struct eio_req eio_req; |
|
|
51 | typedef struct eio_dirent eio_dirent; |
51 | |
52 | |
52 | typedef int (*eio_cb)(eio_req *req); |
53 | typedef int (*eio_cb)(eio_req *req); |
53 | |
54 | |
54 | #ifndef EIO_REQ_MEMBERS |
55 | #ifndef EIO_REQ_MEMBERS |
55 | # define EIO_REQ_MEMBERS |
56 | # define EIO_REQ_MEMBERS |
56 | #endif |
57 | #endif |
57 | |
58 | |
58 | #ifndef EIO_STRUCT_STAT |
59 | #ifndef EIO_STRUCT_STAT |
59 | # define EIO_STRUCT_STAT struct stat |
60 | # define EIO_STRUCT_STAT struct stat |
60 | #endif |
61 | #endif |
|
|
62 | |
|
|
63 | #ifndef EIO_STRUCT_STATVFS |
|
|
64 | # define EIO_STRUCT_STATVFS struct statvfs |
|
|
65 | #endif |
|
|
66 | |
|
|
67 | /* for readdir */ |
|
|
68 | |
|
|
69 | /* eio_readdir flags */ |
|
|
70 | enum { |
|
|
71 | EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
|
|
72 | EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */ |
|
|
73 | EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */ |
|
|
74 | EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ |
|
|
75 | |
|
|
76 | EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
|
|
77 | EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
|
|
78 | }; |
|
|
79 | |
|
|
80 | /* using "typical" values in the hope that the compiler will do something sensible */ |
|
|
81 | enum eio_dtype { |
|
|
82 | EIO_DT_UNKNOWN = 0, |
|
|
83 | EIO_DT_FIFO = 1, |
|
|
84 | EIO_DT_CHR = 2, |
|
|
85 | EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
|
|
86 | EIO_DT_DIR = 4, |
|
|
87 | EIO_DT_NAM = 5, /* xenix special named file */ |
|
|
88 | EIO_DT_BLK = 6, |
|
|
89 | EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */ |
|
|
90 | EIO_DT_REG = 8, |
|
|
91 | EIO_DT_NWK = 9, /* HP-UX network special */ |
|
|
92 | EIO_DT_CMP = 9, /* VxFS compressed */ |
|
|
93 | EIO_DT_LNK = 10, |
|
|
94 | /* DT_SHAD = 11,*/ |
|
|
95 | EIO_DT_SOCK = 12, |
|
|
96 | EIO_DT_DOOR = 13, /* solaris door */ |
|
|
97 | EIO_DT_WHT = 14, |
|
|
98 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
|
|
99 | }; |
|
|
100 | |
|
|
101 | struct eio_dirent { |
|
|
102 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
|
|
103 | unsigned short namelen; /* size of filename without trailing 0 */ |
|
|
104 | unsigned char type; /* one of EIO_DT_* */ |
|
|
105 | signed char score; /* internal use */ |
|
|
106 | ino_t inode; /* the inode number, if available, otherwise unspecified */ |
|
|
107 | }; |
|
|
108 | |
|
|
109 | /* eio_msync flags */ |
|
|
110 | enum { |
|
|
111 | EIO_MS_ASYNC = 1, |
|
|
112 | EIO_MS_INVALIDATE = 2, |
|
|
113 | EIO_MS_SYNC = 4 |
|
|
114 | }; |
|
|
115 | |
|
|
116 | /* eio_mtouch flags */ |
|
|
117 | |
|
|
118 | enum { |
|
|
119 | EIO_MT_MODIFY = 1 |
|
|
120 | }; |
|
|
121 | |
|
|
122 | /* eio_sync_file_range flags */ |
|
|
123 | |
|
|
124 | enum { |
|
|
125 | EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
|
|
126 | EIO_SYNC_FILE_RANGE_WRITE = 2, |
|
|
127 | EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
|
|
128 | }; |
|
|
129 | |
|
|
130 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
|
|
131 | |
|
|
132 | /* the eio request structure */ |
61 | |
133 | |
62 | enum { |
134 | enum { |
63 | EIO_CUSTOM, |
135 | EIO_CUSTOM, |
64 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
136 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
65 | EIO_READ, EIO_WRITE, |
137 | EIO_READ, EIO_WRITE, |
66 | EIO_READAHEAD, EIO_SENDFILE, |
138 | EIO_READAHEAD, EIO_SENDFILE, |
67 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
139 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
|
|
140 | EIO_STATVFS, EIO_FSTATVFS, |
68 | EIO_TRUNCATE, EIO_FTRUNCATE, |
141 | EIO_TRUNCATE, EIO_FTRUNCATE, |
69 | EIO_UTIME, EIO_FUTIME, |
142 | EIO_UTIME, EIO_FUTIME, |
70 | EIO_CHMOD, EIO_FCHMOD, |
143 | EIO_CHMOD, EIO_FCHMOD, |
71 | EIO_CHOWN, EIO_FCHOWN, |
144 | EIO_CHOWN, EIO_FCHOWN, |
72 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_MSYNC, EIO_MTOUCH, |
145 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
|
|
146 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
73 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
147 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
74 | EIO_MKNOD, EIO_READDIR, |
148 | EIO_MKNOD, EIO_READDIR, |
75 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
149 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
76 | EIO_GROUP, EIO_NOP, |
150 | EIO_GROUP, EIO_NOP, |
77 | EIO_BUSY, |
151 | EIO_BUSY |
78 | }; |
152 | }; |
79 | |
|
|
80 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
|
|
81 | |
153 | |
82 | /* eio request structure */ |
154 | /* eio request structure */ |
83 | /* this structure is mostly read-only */ |
155 | /* this structure is mostly read-only */ |
|
|
156 | /* when initialising it, all members must be zero-initialised */ |
84 | struct eio_req |
157 | struct eio_req |
85 | { |
158 | { |
86 | eio_req volatile *next; /* private ETP */ |
159 | eio_req volatile *next; /* private ETP */ |
87 | |
160 | |
88 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
161 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
89 | off_t offs; /* read, write, truncate, readahead: file offset */ |
162 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
90 | size_t size; /* read, write, readahead, sendfile, msync: length */ |
163 | size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
91 | void *ptr1; /* all applicable requests: pathname, old name */ |
164 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
92 | void *ptr2; /* all applicable requests: new name or memory buffer */ |
165 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
93 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
166 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
94 | eio_tstamp nv2; /* utime, futime: mtime */ |
167 | eio_tstamp nv2; /* utime, futime: mtime */ |
95 | |
168 | |
96 | int type; /* EIO_xxx constant ETP */ |
169 | int type; /* EIO_xxx constant ETP */ |
97 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync: flags */ |
170 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
98 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ |
171 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ |
99 | long int3; /* chown, fchown: gid; mknod: dev_t */ |
172 | long int3; /* chown, fchown: gid; mknod: dev_t */ |
100 | int errorno; /* errno value on syscall return */ |
173 | int errorno; /* errno value on syscall return */ |
101 | |
174 | |
102 | unsigned char flags; /* private */ |
175 | unsigned char flags; /* private */ |
103 | signed char pri; /* the priority */ |
176 | signed char pri; /* the priority */ |
… | |
… | |
163 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
236 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
164 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
237 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
165 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
238 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
166 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
239 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
167 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
240 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
|
|
241 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
168 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
242 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
169 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
243 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
170 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
244 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
171 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
245 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
172 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
246 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
|
|
247 | eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
173 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
248 | eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
174 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
249 | eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); |
175 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
250 | eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); |
176 | eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
251 | eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
177 | eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
252 | eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); |
… | |
… | |
180 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
255 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
181 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
256 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
182 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
257 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
183 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
258 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
184 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
259 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
185 | eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
260 | eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
186 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
261 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
187 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
262 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
188 | eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
263 | eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
189 | eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
264 | eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
190 | eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
265 | eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
|
|
266 | eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
191 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
267 | eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); |
192 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
268 | eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
193 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
269 | eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
194 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
270 | eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); |
195 | eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); |
271 | eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); |
… | |
… | |
206 | |
282 | |
207 | /*****************************************************************************/ |
283 | /*****************************************************************************/ |
208 | /* request api */ |
284 | /* request api */ |
209 | |
285 | |
210 | /* true if the request was cancelled, useful in the invoke callback */ |
286 | /* true if the request was cancelled, useful in the invoke callback */ |
211 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
287 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
212 | |
288 | |
213 | #define EIO_RESULT(req) ((req)->result) |
289 | #define EIO_RESULT(req) ((req)->result) |
214 | /* returns a pointer to the result buffer allocated by eio */ |
290 | /* returns a pointer to the result buffer allocated by eio */ |
215 | #define EIO_BUF(req) ((req)->ptr2) |
291 | #define EIO_BUF(req) ((req)->ptr2) |
216 | #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) |
292 | #define EIO_STAT_BUF(req) ((EIO_STRUCT_STAT *)EIO_BUF(req)) |
|
|
293 | #define EIO_STATVFS_BUF(req) ((EIO_STRUCT_STATVFS *)EIO_BUF(req)) |
217 | #define EIO_PATH(req) ((char *)(req)->ptr1) |
294 | #define EIO_PATH(req) ((char *)(req)->ptr1) |
218 | |
295 | |
219 | /* submit a request for execution */ |
296 | /* submit a request for execution */ |
220 | void eio_submit (eio_req *req); |
297 | void eio_submit (eio_req *req); |
221 | /* cancel a request as soon fast as possible, if possible */ |
298 | /* cancel a request as soon fast as possible, if possible */ |
222 | void eio_cancel (eio_req *req); |
299 | void eio_cancel (eio_req *req); |