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

Comparing libeio/eio.h (file contents):
Revision 1.13 by root, Sat May 17 12:26:57 2008 UTC vs.
Revision 1.26 by root, Thu Jan 7 18:08:21 2010 UTC

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
44extern "C" {
45#endif
46
43#include <stddef.h> 47#include <stddef.h>
44#include <sys/types.h> 48#include <sys/types.h>
45 49
46typedef struct eio_req eio_req; 50typedef struct eio_req eio_req;
51typedef struct eio_dirent eio_dirent;
47 52
48typedef int (*eio_cb)(eio_req *req); 53typedef 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#ifndef EIO_STRUCT_STATVFS
64# define EIO_STRUCT_STATVFS struct statvfs
65#endif
66
67/* for readdir */
68
69/* eio_readdir flags */
58enum { 70enum {
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 */
81enum 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
101struct 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 */
110enum {
111 EIO_MS_ASYNC = 1,
112 EIO_MS_INVALIDATE = 2,
113 EIO_MS_SYNC = 4
114};
115
116/* eio_mtouch flags */
117
118enum {
119 EIO_MT_MODIFY = 1
120};
121
122/* eio_sync_file_range flags */
123
124enum {
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
130typedef double eio_tstamp; /* feel free to use double in your code directly */
131
132/* the eio request structure */
133
134enum {
135 EIO_CUSTOM,
59 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 136 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
60 EIO_READ, EIO_WRITE, 137 EIO_READ, EIO_WRITE,
61 EIO_READAHEAD, EIO_SENDFILE, 138 EIO_READAHEAD, EIO_SENDFILE,
62 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 139 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
140 EIO_STATVFS, EIO_FSTATVFS,
63 EIO_TRUNCATE, EIO_FTRUNCATE, 141 EIO_TRUNCATE, EIO_FTRUNCATE,
64 EIO_UTIME, EIO_FUTIME, 142 EIO_UTIME, EIO_FUTIME,
65 EIO_CHMOD, EIO_FCHMOD, 143 EIO_CHMOD, EIO_FCHMOD,
66 EIO_CHOWN, EIO_FCHOWN, 144 EIO_CHOWN, EIO_FCHOWN,
67 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 145 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
146 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
68 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 147 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
69 EIO_MKNOD, EIO_READDIR, 148 EIO_MKNOD, EIO_READDIR,
70 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 149 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
71 EIO_GROUP, EIO_NOP, 150 EIO_GROUP, EIO_NOP,
72 EIO_BUSY, EIO_CUSTOM 151 EIO_BUSY
73}; 152};
74
75typedef double eio_tstamp; /* feel free to use double in your code directly */
76 153
77/* eio request structure */ 154/* eio request structure */
78/* this structure is mostly read-only */ 155/* this structure is mostly read-only */
156/* when initialising it, all members must be zero-initialised */
79struct eio_req 157struct eio_req
80{ 158{
81 eio_req volatile *next; /* private ETP */ 159 eio_req volatile *next; /* private ETP */
82 160
83 ssize_t result; /* result of syscall, e.g. result = read (... */ 161 ssize_t result; /* result of syscall, e.g. result = read (... */
84 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 162 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
85 size_t size; /* read, write, readahead, sendfile: length */ 163 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
86 void *ptr1; /* all applicable requests: pathname, old name */ 164 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
87 void *ptr2; /* all applicable requests: new name or memory buffer */ 165 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
88 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 166 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
89 eio_tstamp nv2; /* utime, futime: mtime */ 167 eio_tstamp nv2; /* utime, futime: mtime */
90 168
91 int type; /* EIO_xxx constant ETP */ 169 int type; /* EIO_xxx constant ETP */
92 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 170 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 */ 171 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
94 long int3; /* chown, fchown: gid */ 172 long int3; /* chown, fchown: gid; mknod: dev_t */
95 int errorno; /* errno value on syscall return */ 173 int errorno; /* errno value on syscall return */
96 174
97 unsigned char flags; /* private */ 175 unsigned char flags; /* private */
98 signed char pri; /* the priority */ 176 signed char pri; /* the priority */
99 177
… …
105 EIO_REQ_MEMBERS 183 EIO_REQ_MEMBERS
106 184
107 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 185 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
108}; 186};
109 187
188/* _private_ flags */
110enum { 189enum {
111 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 190 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
112 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 191 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
113 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 192 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
193 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
114}; 194};
115 195
116enum { 196enum {
117 EIO_PRI_MIN = -4, 197 EIO_PRI_MIN = -4,
118 EIO_PRI_MAX = 4, 198 EIO_PRI_MAX = 4,
… …
154eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 234eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
155eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 235eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
156eio_req *eio_sync (int pri, eio_cb cb, void *data); 236eio_req *eio_sync (int pri, eio_cb cb, void *data);
157eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 237eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
158eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 238eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
239eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
240eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
241eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
159eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 242eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
160eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 243eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
161eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 244eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
162eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 245eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
163eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 246eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
247eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
164eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 248eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
165eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 249eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
166eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 250eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);
167eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 251eio_req *eio_fchown (int fd, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
168eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data); 252eio_req *eio_dup2 (int fd, int fd2, int pri, eio_cb cb, void *data);
… …
171eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 255eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
172eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 256eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
173eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 257eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
174eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 258eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
175eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 259eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
176eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 260eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
177eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 261eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
178eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 262eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
179eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 263eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
180eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 264eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
181eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 265eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
266eio_req *eio_statvfs (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
182eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 267eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
183eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 268eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
184eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 269eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
185eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 270eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
186eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data); 271eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
… …
197 282
198/*****************************************************************************/ 283/*****************************************************************************/
199/* request api */ 284/* request api */
200 285
201/* true if the request was cancelled, useful in the invoke callback */ 286/* true if the request was cancelled, useful in the invoke callback */
202#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED) 287#define EIO_CANCELLED(req) ((req)->flags & EIO_FLAG_CANCELLED)
203 288
204#define EIO_RESULT(req) ((req)->result) 289#define EIO_RESULT(req) ((req)->result)
205/* returns a pointer to the result buffer allocated by eio */ 290/* returns a pointer to the result buffer allocated by eio */
206#define EIO_BUF(req) ((req)->ptr2) 291#define EIO_BUF(req) ((req)->ptr2)
207#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))
208#define EIO_PATH(req) ((char *)(req)->ptr1) 294#define EIO_PATH(req) ((char *)(req)->ptr1)
209 295
210/* submit a request for execution */ 296/* submit a request for execution */
211void eio_submit (eio_req *req); 297void eio_submit (eio_req *req);
212/* cancel a request as soon fast as possible, if possible */ 298/* cancel a request as soon fast as possible, if possible */
213void eio_cancel (eio_req *req); 299void eio_cancel (eio_req *req);
… …
217/*****************************************************************************/ 303/*****************************************************************************/
218/* convinience functions */ 304/* convinience functions */
219 305
220ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 306ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
221 307
308#ifdef __cplusplus
309}
222#endif 310#endif
223 311
312#endif
313

Diff Legend

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