1 | /* |
1 | /* |
2 | * libeio API header |
2 | * libeio API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009,2010 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 | * |
… | |
… | |
65 | #endif |
65 | #endif |
66 | |
66 | |
67 | /* for readdir */ |
67 | /* for readdir */ |
68 | |
68 | |
69 | /* eio_readdir flags */ |
69 | /* eio_readdir flags */ |
70 | enum { |
70 | enum |
|
|
71 | { |
71 | EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
72 | 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_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_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 | EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ |
75 | |
76 | |
76 | EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
77 | EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
77 | EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
78 | EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
78 | }; |
79 | }; |
79 | |
80 | |
80 | /* using "typical" values in the hope that the compiler will do something sensible */ |
81 | /* using "typical" values in the hope that the compiler will do something sensible */ |
81 | enum eio_dtype { |
82 | enum eio_dtype |
|
|
83 | { |
82 | EIO_DT_UNKNOWN = 0, |
84 | EIO_DT_UNKNOWN = 0, |
83 | EIO_DT_FIFO = 1, |
85 | EIO_DT_FIFO = 1, |
84 | EIO_DT_CHR = 2, |
86 | EIO_DT_CHR = 2, |
85 | EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
87 | EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
86 | EIO_DT_DIR = 4, |
88 | EIO_DT_DIR = 4, |
… | |
… | |
96 | EIO_DT_DOOR = 13, /* solaris door */ |
98 | EIO_DT_DOOR = 13, /* solaris door */ |
97 | EIO_DT_WHT = 14, |
99 | EIO_DT_WHT = 14, |
98 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
100 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
99 | }; |
101 | }; |
100 | |
102 | |
101 | struct eio_dirent { |
103 | struct eio_dirent |
|
|
104 | { |
102 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
105 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
103 | unsigned short namelen; /* size of filename without trailing 0 */ |
106 | unsigned short namelen; /* size of filename without trailing 0 */ |
104 | unsigned char type; /* one of EIO_DT_* */ |
107 | unsigned char type; /* one of EIO_DT_* */ |
105 | signed char score; /* internal use */ |
108 | signed char score; /* internal use */ |
106 | ino_t inode; /* the inode number, if available, otherwise unspecified */ |
109 | ino_t inode; /* the inode number, if available, otherwise unspecified */ |
107 | }; |
110 | }; |
108 | |
111 | |
109 | /* eio_msync flags */ |
112 | /* eio_msync flags */ |
110 | enum { |
113 | enum |
|
|
114 | { |
111 | EIO_MS_ASYNC = 1, |
115 | EIO_MS_ASYNC = 1, |
112 | EIO_MS_INVALIDATE = 2, |
116 | EIO_MS_INVALIDATE = 2, |
113 | EIO_MS_SYNC = 4 |
117 | EIO_MS_SYNC = 4 |
114 | }; |
118 | }; |
115 | |
119 | |
116 | /* eio_mtouch flags */ |
120 | /* eio_mtouch flags */ |
117 | |
121 | |
118 | enum { |
122 | enum |
|
|
123 | { |
119 | EIO_MT_MODIFY = 1 |
124 | EIO_MT_MODIFY = 1 |
120 | }; |
125 | }; |
121 | |
126 | |
122 | /* eio_sync_file_range flags */ |
127 | /* eio_sync_file_range flags */ |
123 | |
128 | |
124 | enum { |
129 | enum |
|
|
130 | { |
125 | EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
131 | EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
126 | EIO_SYNC_FILE_RANGE_WRITE = 2, |
132 | EIO_SYNC_FILE_RANGE_WRITE = 2, |
127 | EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
133 | EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
128 | }; |
134 | }; |
129 | |
135 | |
130 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
136 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
131 | |
137 | |
132 | /* the eio request structure */ |
138 | /* the eio request structure */ |
133 | |
139 | |
134 | enum { |
140 | enum |
|
|
141 | { |
135 | EIO_CUSTOM, |
142 | EIO_CUSTOM, |
136 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
143 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
137 | EIO_READ, EIO_WRITE, |
144 | EIO_READ, EIO_WRITE, |
138 | EIO_READAHEAD, EIO_SENDFILE, |
145 | EIO_READAHEAD, EIO_SENDFILE, |
139 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
146 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
… | |
… | |
142 | EIO_UTIME, EIO_FUTIME, |
149 | EIO_UTIME, EIO_FUTIME, |
143 | EIO_CHMOD, EIO_FCHMOD, |
150 | EIO_CHMOD, EIO_FCHMOD, |
144 | EIO_CHOWN, EIO_FCHOWN, |
151 | EIO_CHOWN, EIO_FCHOWN, |
145 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
152 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
146 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
153 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
|
|
154 | EIO_MLOCK, EIO_MLOCKALL, |
147 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
155 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
148 | EIO_MKNOD, EIO_READDIR, |
156 | EIO_MKNOD, EIO_READDIR, |
149 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
157 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
150 | EIO_GROUP, EIO_NOP, |
158 | EIO_GROUP, EIO_NOP, |
151 | EIO_BUSY |
159 | EIO_BUSY |
152 | }; |
160 | }; |
153 | |
161 | |
|
|
162 | /* mlockall constants */ |
|
|
163 | enum |
|
|
164 | { |
|
|
165 | EIO_MCL_CURRENT = 1, |
|
|
166 | EIO_MCL_FUTURE = 2, |
|
|
167 | }; |
|
|
168 | |
|
|
169 | /* request priorities */ |
|
|
170 | |
|
|
171 | enum { |
|
|
172 | EIO_PRI_MIN = -4, |
|
|
173 | EIO_PRI_MAX = 4, |
|
|
174 | EIO_PRI_DEFAULT = 0, |
|
|
175 | }; |
|
|
176 | |
154 | /* eio request structure */ |
177 | /* eio request structure */ |
155 | /* this structure is mostly read-only */ |
178 | /* this structure is mostly read-only */ |
156 | /* when initialising it, all members must be zero-initialised */ |
179 | /* when initialising it, all members must be zero-initialised */ |
157 | struct eio_req |
180 | struct eio_req |
158 | { |
181 | { |
159 | eio_req volatile *next; /* private ETP */ |
182 | eio_req volatile *next; /* private ETP */ |
160 | |
183 | |
161 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
184 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
162 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
185 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset, mknod: dev_t */ |
163 | size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
186 | size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range: length */ |
164 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
187 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
165 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
188 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
166 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
189 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
167 | eio_tstamp nv2; /* utime, futime: mtime */ |
190 | eio_tstamp nv2; /* utime, futime: mtime */ |
168 | |
191 | |
169 | int type; /* EIO_xxx constant ETP */ |
192 | int type; /* EIO_xxx constant ETP */ |
170 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
193 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ |
171 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ |
194 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ |
172 | long int3; /* chown, fchown: gid; mknod: dev_t */ |
195 | long int3; /* chown, fchown: gid */ |
173 | int errorno; /* errno value on syscall return */ |
196 | int errorno; /* errno value on syscall return */ |
174 | |
197 | |
175 | unsigned char flags; /* private */ |
198 | unsigned char flags; /* private */ |
176 | signed char pri; /* the priority */ |
199 | signed char pri; /* the priority */ |
177 | |
200 | |
… | |
… | |
183 | EIO_REQ_MEMBERS |
206 | EIO_REQ_MEMBERS |
184 | |
207 | |
185 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
208 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
186 | }; |
209 | }; |
187 | |
210 | |
188 | /* _private_ flags */ |
211 | /* _private_ request flags */ |
189 | enum { |
212 | enum { |
190 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
213 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
191 | EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
214 | EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
192 | EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ |
215 | EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ |
193 | EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ |
216 | EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ |
194 | }; |
217 | }; |
195 | |
218 | |
196 | enum { |
219 | /* undocumented/unsupported/private helper */ |
197 | EIO_PRI_MIN = -4, |
220 | /*void eio_page_align (void **addr, size_t *length);*/ |
198 | EIO_PRI_MAX = 4, |
|
|
199 | EIO_PRI_DEFAULT = 0, |
|
|
200 | }; |
|
|
201 | |
221 | |
202 | /* returns < 0 on error, errno set |
222 | /* returns < 0 on error, errno set |
203 | * need_poll, if non-zero, will be called when results are available |
223 | * need_poll, if non-zero, will be called when results are available |
204 | * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). |
224 | * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). |
205 | * done_poll is called when the need to poll is gone. |
225 | * done_poll is called when the need to poll is gone. |
… | |
… | |
236 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
256 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
237 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
257 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
238 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
258 | eio_req *eio_fdatasync (int fd, 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); |
259 | eio_req *eio_msync (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); |
260 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
|
|
261 | eio_req *eio_mlock (void *addr, size_t length, int pri, eio_cb cb, void *data); |
|
|
262 | eio_req *eio_mlockall (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); |
263 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
242 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
264 | eio_req *eio_close (int fd, 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); |
265 | eio_req *eio_readahead (int fd, off_t offset, size_t length, 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); |
266 | eio_req *eio_read (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); |
267 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |