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 | * |
… | |
… | |
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 |
|
|
44 | extern "C" { |
|
|
45 | #endif |
|
|
46 | |
43 | #include <stddef.h> |
47 | #include <stddef.h> |
44 | #include <sys/types.h> |
48 | #include <sys/types.h> |
45 | |
49 | |
46 | typedef struct eio_req eio_req; |
50 | typedef struct eio_req eio_req; |
|
|
51 | typedef struct eio_dirent eio_dirent; |
47 | |
52 | |
48 | typedef int (*eio_cb)(eio_req *req); |
53 | typedef int (*eio_cb)(eio_req *req); |
49 | |
54 | |
50 | #ifndef EIO_REQ_MEMBERS |
55 | #ifndef EIO_REQ_MEMBERS |
51 | # define EIO_REQ_MEMBERS |
56 | # define EIO_REQ_MEMBERS |
… | |
… | |
53 | |
58 | |
54 | #ifndef EIO_STRUCT_STAT |
59 | #ifndef EIO_STRUCT_STAT |
55 | # define EIO_STRUCT_STAT struct stat |
60 | # define EIO_STRUCT_STAT struct stat |
56 | #endif |
61 | #endif |
57 | |
62 | |
|
|
63 | /* for readdir */ |
|
|
64 | |
|
|
65 | /* eio_readdir flags */ |
58 | enum { |
66 | enum { |
|
|
67 | EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
|
|
68 | EIO_READDIR_DIRS_FIRST = 0x02, /* dirents gets sorted into a good stat() ing order to find directories first */ |
|
|
69 | EIO_READDIR_STAT_ORDER = 0x04, /* dirents gets sorted into a good stat() ing order to quickly stat all files */ |
|
|
70 | EIO_READDIR_FOUND_UNKNOWN = 0x80, /* set by eio_readdir when *_ARRAY was set and any TYPE=UNKNOWN's were found */ |
|
|
71 | |
|
|
72 | EIO_READDIR_CUSTOM1 = 0x100, /* for use by apps */ |
|
|
73 | EIO_READDIR_CUSTOM2 = 0x200 /* for use by apps */ |
|
|
74 | }; |
|
|
75 | |
|
|
76 | /* using "typical" values in the hope that the compiler will do something sensible */ |
|
|
77 | enum eio_dtype { |
|
|
78 | EIO_DT_UNKNOWN = 0, |
|
|
79 | EIO_DT_FIFO = 1, |
|
|
80 | EIO_DT_CHR = 2, |
|
|
81 | EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
|
|
82 | EIO_DT_DIR = 4, |
|
|
83 | EIO_DT_NAM = 5, /* xenix special named file */ |
|
|
84 | EIO_DT_BLK = 6, |
|
|
85 | EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */ |
|
|
86 | EIO_DT_REG = 8, |
|
|
87 | EIO_DT_NWK = 9, /* HP-UX network special */ |
|
|
88 | EIO_DT_CMP = 9, /* VxFS compressed */ |
|
|
89 | EIO_DT_LNK = 10, |
|
|
90 | /* DT_SHAD = 11,*/ |
|
|
91 | EIO_DT_SOCK = 12, |
|
|
92 | EIO_DT_DOOR = 13, /* solaris door */ |
|
|
93 | EIO_DT_WHT = 14, |
|
|
94 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
|
|
95 | }; |
|
|
96 | |
|
|
97 | struct eio_dirent { |
|
|
98 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
|
|
99 | unsigned short namelen; /* size of filename without trailing 0 */ |
|
|
100 | unsigned char type; /* one of EIO_DT_* */ |
|
|
101 | signed char score; /* internal use */ |
|
|
102 | ino_t inode; /* the inode number, if available, otherwise unspecified */ |
|
|
103 | }; |
|
|
104 | |
|
|
105 | /* eio_msync flags */ |
|
|
106 | enum { |
|
|
107 | EIO_MS_ASYNC = 1, |
|
|
108 | EIO_MS_INVALIDATE = 2, |
|
|
109 | EIO_MS_SYNC = 4 |
|
|
110 | }; |
|
|
111 | |
|
|
112 | /* eio_mtouch flags */ |
|
|
113 | |
|
|
114 | enum { |
|
|
115 | EIO_MT_MODIFY = 1 |
|
|
116 | }; |
|
|
117 | |
|
|
118 | /* eio_sync_file_range flags */ |
|
|
119 | |
|
|
120 | enum { |
|
|
121 | EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1, |
|
|
122 | EIO_SYNC_FILE_RANGE_WRITE = 2, |
|
|
123 | EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4 |
|
|
124 | }; |
|
|
125 | |
|
|
126 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
|
|
127 | |
|
|
128 | /* the eio request structure */ |
|
|
129 | |
|
|
130 | enum { |
|
|
131 | EIO_CUSTOM, |
59 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
132 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
60 | EIO_READ, EIO_WRITE, |
133 | EIO_READ, EIO_WRITE, |
61 | EIO_READAHEAD, EIO_SENDFILE, |
134 | EIO_READAHEAD, EIO_SENDFILE, |
62 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
135 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
63 | EIO_TRUNCATE, EIO_FTRUNCATE, |
136 | EIO_TRUNCATE, EIO_FTRUNCATE, |
64 | EIO_UTIME, EIO_FUTIME, |
137 | EIO_UTIME, EIO_FUTIME, |
65 | EIO_CHMOD, EIO_FCHMOD, |
138 | EIO_CHMOD, EIO_FCHMOD, |
66 | EIO_CHOWN, EIO_FCHOWN, |
139 | EIO_CHOWN, EIO_FCHOWN, |
67 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
140 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
|
|
141 | EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, |
68 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
142 | EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, |
69 | EIO_MKNOD, EIO_READDIR, |
143 | EIO_MKNOD, EIO_READDIR, |
70 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
144 | EIO_LINK, EIO_SYMLINK, EIO_READLINK, |
71 | EIO_GROUP, EIO_NOP, |
145 | EIO_GROUP, EIO_NOP, |
72 | EIO_BUSY, EIO_CUSTOM |
146 | EIO_BUSY |
73 | }; |
147 | }; |
74 | |
|
|
75 | typedef double eio_tstamp; /* feel free to use double in your code directly */ |
|
|
76 | |
148 | |
77 | /* eio request structure */ |
149 | /* eio request structure */ |
78 | /* this structure is mostly read-only */ |
150 | /* this structure is mostly read-only */ |
|
|
151 | /* when initialising it, all members must be zero-initialised */ |
79 | struct eio_req |
152 | struct eio_req |
80 | { |
153 | { |
81 | eio_req volatile *next; /* private ETP */ |
154 | eio_req volatile *next; /* private ETP */ |
82 | |
155 | |
83 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
156 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
84 | off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ |
157 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
85 | size_t size; /* read, write, readahead, sendfile: length */ |
158 | size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
86 | void *ptr1; /* all applicable requests: pathname, old name */ |
159 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
87 | void *ptr2; /* all applicable requests: new name or memory buffer */ |
160 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
88 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
161 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
89 | eio_tstamp nv2; /* utime, futime: mtime */ |
162 | eio_tstamp nv2; /* utime, futime: mtime */ |
90 | |
163 | |
91 | int type; /* EIO_xxx constant ETP */ |
164 | int type; /* EIO_xxx constant ETP */ |
92 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ |
165 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
93 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode */ |
166 | long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */ |
94 | long int3; /* chown, fchown: gid */ |
167 | long int3; /* chown, fchown: gid; mknod: dev_t */ |
95 | int errorno; /* errno value on syscall return */ |
168 | int errorno; /* errno value on syscall return */ |
96 | |
169 | |
97 | unsigned char flags; /* private */ |
170 | unsigned char flags; /* private */ |
98 | signed char pri; /* the priority */ |
171 | signed char pri; /* the priority */ |
99 | |
172 | |
… | |
… | |
105 | EIO_REQ_MEMBERS |
178 | EIO_REQ_MEMBERS |
106 | |
179 | |
107 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
180 | eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ |
108 | }; |
181 | }; |
109 | |
182 | |
|
|
183 | /* _private_ flags */ |
110 | enum { |
184 | enum { |
111 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
185 | EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ |
112 | EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
186 | EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ |
113 | EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ |
187 | EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */ |
|
|
188 | EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */ |
114 | }; |
189 | }; |
115 | |
190 | |
116 | enum { |
191 | enum { |
117 | EIO_PRI_MIN = -4, |
192 | EIO_PRI_MIN = -4, |
118 | EIO_PRI_MAX = 4, |
193 | EIO_PRI_MAX = 4, |
… | |
… | |
154 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
229 | eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ |
155 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
230 | eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ |
156 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
231 | eio_req *eio_sync (int pri, eio_cb cb, void *data); |
157 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
232 | eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); |
158 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
233 | eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); |
|
|
234 | eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
|
|
235 | eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data); |
|
|
236 | eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data); |
159 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
237 | eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); |
160 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
238 | eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); |
161 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
239 | eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
162 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
240 | eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); |
163 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
241 | eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
… | |
… | |
171 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
249 | eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); |
172 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
250 | eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); |
173 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
251 | eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); |
174 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
252 | eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
175 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
253 | eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); |
176 | eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
254 | eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
177 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
255 | eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); |
178 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
256 | eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); |
179 | eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
257 | eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ |
180 | eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
258 | eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
181 | eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
259 | eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ |
… | |
… | |
217 | /*****************************************************************************/ |
295 | /*****************************************************************************/ |
218 | /* convinience functions */ |
296 | /* convinience functions */ |
219 | |
297 | |
220 | ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
298 | ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); |
221 | |
299 | |
|
|
300 | #ifdef __cplusplus |
|
|
301 | } |
222 | #endif |
302 | #endif |
223 | |
303 | |
|
|
304 | #endif |
|
|
305 | |