1 | /* |
1 | /* |
2 | * libeio API header |
2 | * libeio API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009 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 | * |
… | |
… | |
58 | |
58 | |
59 | #ifndef EIO_STRUCT_STAT |
59 | #ifndef EIO_STRUCT_STAT |
60 | # define EIO_STRUCT_STAT struct stat |
60 | # define EIO_STRUCT_STAT struct stat |
61 | #endif |
61 | #endif |
62 | |
62 | |
|
|
63 | #ifndef EIO_STRUCT_STATVFS |
|
|
64 | # define EIO_STRUCT_STATVFS struct statvfs |
|
|
65 | #endif |
|
|
66 | |
63 | /* for readdir */ |
67 | /* for readdir */ |
64 | |
68 | |
65 | /* eio_readdir flags */ |
69 | /* eio_readdir flags */ |
66 | enum { |
70 | enum { |
67 | EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
71 | EIO_READDIR_DENTS = 0x01, /* ptr2 contains eio_dirents, not just the (unsorted) names */ |
… | |
… | |
76 | /* using "typical" values in the hope that the compiler will do something sensible */ |
80 | /* using "typical" values in the hope that the compiler will do something sensible */ |
77 | enum eio_dtype { |
81 | enum eio_dtype { |
78 | EIO_DT_UNKNOWN = 0, |
82 | EIO_DT_UNKNOWN = 0, |
79 | EIO_DT_FIFO = 1, |
83 | EIO_DT_FIFO = 1, |
80 | EIO_DT_CHR = 2, |
84 | EIO_DT_CHR = 2, |
|
|
85 | EIO_DT_MPC = 3, /* multiplexed char device (v7+coherent) */ |
81 | EIO_DT_DIR = 4, |
86 | EIO_DT_DIR = 4, |
|
|
87 | EIO_DT_NAM = 5, /* xenix special named file */ |
82 | EIO_DT_BLK = 6, |
88 | EIO_DT_BLK = 6, |
|
|
89 | EIO_DT_MPB = 7, /* multiplexed block device (v7+coherent) */ |
83 | EIO_DT_REG = 8, |
90 | EIO_DT_REG = 8, |
|
|
91 | EIO_DT_NWK = 9, /* HP-UX network special */ |
|
|
92 | EIO_DT_CMP = 9, /* VxFS compressed */ |
84 | EIO_DT_LNK = 10, |
93 | EIO_DT_LNK = 10, |
|
|
94 | /* DT_SHAD = 11,*/ |
85 | EIO_DT_SOCK = 12, |
95 | EIO_DT_SOCK = 12, |
|
|
96 | EIO_DT_DOOR = 13, /* solaris door */ |
86 | EIO_DT_WHT = 14, |
97 | EIO_DT_WHT = 14, |
87 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
98 | EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */ |
88 | }; |
99 | }; |
89 | |
100 | |
90 | struct eio_dirent { |
101 | struct eio_dirent { |
91 | char *name; |
102 | int nameofs; /* offset of null-terminated name string in (char *)req->ptr2 */ |
92 | ino_t inode; |
103 | unsigned short namelen; /* size of filename without trailing 0 */ |
93 | unsigned short namelen; |
104 | unsigned char type; /* one of EIO_DT_* */ |
94 | unsigned char type; |
|
|
95 | unsigned char score; /* internal use */ |
105 | signed char score; /* internal use */ |
96 | /* 0-4 bytes padding */ |
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 |
97 | }; |
120 | }; |
98 | |
121 | |
99 | /* eio_sync_file_range flags */ |
122 | /* eio_sync_file_range flags */ |
100 | |
123 | |
101 | enum { |
124 | enum { |
… | |
… | |
112 | EIO_CUSTOM, |
135 | EIO_CUSTOM, |
113 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
136 | EIO_OPEN, EIO_CLOSE, EIO_DUP2, |
114 | EIO_READ, EIO_WRITE, |
137 | EIO_READ, EIO_WRITE, |
115 | EIO_READAHEAD, EIO_SENDFILE, |
138 | EIO_READAHEAD, EIO_SENDFILE, |
116 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
139 | EIO_STAT, EIO_LSTAT, EIO_FSTAT, |
|
|
140 | EIO_STATVFS, EIO_FSTATVFS, |
117 | EIO_TRUNCATE, EIO_FTRUNCATE, |
141 | EIO_TRUNCATE, EIO_FTRUNCATE, |
118 | EIO_UTIME, EIO_FUTIME, |
142 | EIO_UTIME, EIO_FUTIME, |
119 | EIO_CHMOD, EIO_FCHMOD, |
143 | EIO_CHMOD, EIO_FCHMOD, |
120 | EIO_CHOWN, EIO_FCHOWN, |
144 | EIO_CHOWN, EIO_FCHOWN, |
121 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
145 | EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, |
… | |
… | |
135 | eio_req volatile *next; /* private ETP */ |
159 | eio_req volatile *next; /* private ETP */ |
136 | |
160 | |
137 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
161 | ssize_t result; /* result of syscall, e.g. result = read (... */ |
138 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
162 | off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */ |
139 | size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
163 | size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */ |
140 | void *ptr1; /* all applicable requests: pathname, old name */ |
164 | void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ |
141 | void *ptr2; /* all applicable requests: new name or memory buffer */ |
165 | void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ |
142 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
166 | eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ |
143 | eio_tstamp nv2; /* utime, futime: mtime */ |
167 | eio_tstamp nv2; /* utime, futime: mtime */ |
144 | |
168 | |
145 | int type; /* EIO_xxx constant ETP */ |
169 | int type; /* EIO_xxx constant ETP */ |
146 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
170 | int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, readdir: flags */ |
… | |
… | |
218 | 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); |
219 | 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); |
220 | 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); |
221 | 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); |
222 | 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 */ |
223 | 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); |
224 | 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); |
225 | 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); |
226 | 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); |
227 | 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); |
… | |
… | |
236 | 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); |
237 | 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); |
238 | 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 */ |
239 | 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 */ |
240 | 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 */ |
241 | 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); |
242 | 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); |
243 | 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); |
244 | 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); |
245 | 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); |
… | |
… | |
256 | |
282 | |
257 | /*****************************************************************************/ |
283 | /*****************************************************************************/ |
258 | /* request api */ |
284 | /* request api */ |
259 | |
285 | |
260 | /* true if the request was cancelled, useful in the invoke callback */ |
286 | /* true if the request was cancelled, useful in the invoke callback */ |
261 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
287 | #define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) |
262 | |
288 | |
263 | #define EIO_RESULT(req) ((req)->result) |
289 | #define EIO_RESULT(req) ((req)->result) |
264 | /* returns a pointer to the result buffer allocated by eio */ |
290 | /* returns a pointer to the result buffer allocated by eio */ |
265 | #define EIO_BUF(req) ((req)->ptr2) |
291 | #define EIO_BUF(req) ((req)->ptr2) |
266 | #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)) |
267 | #define EIO_PATH(req) ((char *)(req)->ptr1) |
294 | #define EIO_PATH(req) ((char *)(req)->ptr1) |
268 | |
295 | |
269 | /* submit a request for execution */ |
296 | /* submit a request for execution */ |
270 | void eio_submit (eio_req *req); |
297 | void eio_submit (eio_req *req); |
271 | /* cancel a request as soon fast as possible, if possible */ |
298 | /* cancel a request as soon fast as possible, if possible */ |
272 | void eio_cancel (eio_req *req); |
299 | void eio_cancel (eio_req *req); |