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

Comparing libeio/eio.h (file contents):
Revision 1.12 by root, Sat May 17 12:17:25 2008 UTC vs.
Revision 1.24 by root, Mon Jun 15 05:34:49 2009 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 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/* for readdir */
64
65/* eio_readdir flags */
58enum { 66enum {
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 */
77enum 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
97struct 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_sync_file_range flags */
106
107enum {
108 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
109 EIO_SYNC_FILE_RANGE_WRITE = 2,
110 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
111};
112
113typedef double eio_tstamp; /* feel free to use double in your code directly */
114
115/* the eio request structure */
116
117enum {
118 EIO_CUSTOM,
59 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 119 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
60 EIO_READ, EIO_WRITE, 120 EIO_READ, EIO_WRITE,
61 EIO_READAHEAD, EIO_SENDFILE, 121 EIO_READAHEAD, EIO_SENDFILE,
62 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 122 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
63 EIO_TRUNCATE, EIO_FTRUNCATE, 123 EIO_TRUNCATE, EIO_FTRUNCATE,
64 EIO_UTIME, EIO_FUTIME, 124 EIO_UTIME, EIO_FUTIME,
65 EIO_CHMOD, EIO_FCHMOD, 125 EIO_CHMOD, EIO_FCHMOD,
66 EIO_CHOWN, EIO_FCHOWN, 126 EIO_CHOWN, EIO_FCHOWN,
67 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 127 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
128 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
68 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 129 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
69 EIO_MKNOD, EIO_READDIR, 130 EIO_MKNOD, EIO_READDIR,
70 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 131 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
71 EIO_GROUP, EIO_NOP, 132 EIO_GROUP, EIO_NOP,
72 EIO_BUSY, 133 EIO_BUSY
73}; 134};
74
75typedef double eio_tstamp; /* feel free to use double in your code directly */
76 135
77/* eio request structure */ 136/* eio request structure */
78/* this structure is mostly read-only */ 137/* this structure is mostly read-only */
138/* when initialising it, all members must be zero-initialised */
79struct eio_req 139struct eio_req
80{ 140{
81 eio_req volatile *next; /* private ETP */ 141 eio_req volatile *next; /* private ETP */
82 142
83 ssize_t result; /* result of syscall, e.g. result = read (... */ 143 ssize_t result; /* result of syscall, e.g. result = read (... */
84 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 144 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
85 size_t size; /* read, write, readahead, sendfile: length */ 145 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
86 void *ptr1; /* all applicable requests: pathname, old name */ 146 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */
87 void *ptr2; /* all applicable requests: new name or memory buffer */ 147 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
88 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 148 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
89 eio_tstamp nv2; /* utime, futime: mtime */ 149 eio_tstamp nv2; /* utime, futime: mtime */
90 150
91 int type; /* EIO_xxx constant ETP */ 151 int type; /* EIO_xxx constant ETP */
92 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 152 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 */ 153 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
94 long int3; /* chown, fchown: gid */ 154 long int3; /* chown, fchown: gid; mknod: dev_t */
95 int errorno; /* errno value on syscall return */ 155 int errorno; /* errno value on syscall return */
96 156
97 unsigned char flags; /* private */ 157 unsigned char flags; /* private */
98 signed char pri; /* the priority */ 158 signed char pri; /* the priority */
99 159
… …
105 EIO_REQ_MEMBERS 165 EIO_REQ_MEMBERS
106 166
107 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 167 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
108}; 168};
109 169
170/* _private_ flags */
110enum { 171enum {
111 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 172 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
112 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 173 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
113 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 174 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
175 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
114}; 176};
115 177
116enum { 178enum {
117 EIO_PRI_MIN = -4, 179 EIO_PRI_MIN = -4,
118 EIO_PRI_MAX = 4, 180 EIO_PRI_MAX = 4,
119
120 EIO_PRI_DEFAULT = 0, 181 EIO_PRI_DEFAULT = 0,
121}; 182};
122 183
123/* returns < 0 on error, errno set 184/* returns < 0 on error, errno set
124 * need_poll, if non-zero, will be called when results are available 185 * need_poll, if non-zero, will be called when results are available
125 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself). 186 * and eio_poll_cb needs to be invoked (it MUST NOT call eio_poll_cb itself).
… …
155eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 216eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
156eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */ 217eio_req *eio_busy (eio_tstamp delay, int pri, eio_cb cb, void *data); /* ties a thread for this long, simulating busyness */
157eio_req *eio_sync (int pri, eio_cb cb, void *data); 218eio_req *eio_sync (int pri, eio_cb cb, void *data);
158eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 219eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data);
159eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data); 220eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
221eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
222eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
223eio_req *eio_sync_file_range (int fd, off_t offset, size_t nbytes, unsigned int flags, int pri, eio_cb cb, void *data);
160eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 224eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
161eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 225eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
162eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 226eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
163eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 227eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
164eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 228eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
… …
172eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 236eio_req *eio_utime (const char *path, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
173eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data); 237eio_req *eio_truncate (const char *path, off_t offset, int pri, eio_cb cb, void *data);
174eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data); 238eio_req *eio_chown (const char *path, uid_t uid, gid_t gid, int pri, eio_cb cb, void *data);
175eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 239eio_req *eio_chmod (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
176eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data); 240eio_req *eio_mkdir (const char *path, mode_t mode, int pri, eio_cb cb, void *data);
177eio_req *eio_readdir (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 241eio_req *eio_readdir (const char *path, int flags, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
178eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data); 242eio_req *eio_rmdir (const char *path, int pri, eio_cb cb, void *data);
179eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data); 243eio_req *eio_unlink (const char *path, int pri, eio_cb cb, void *data);
180eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */ 244eio_req *eio_readlink (const char *path, int pri, eio_cb cb, void *data); /* result=ptr2 allocated dynamically */
181eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 245eio_req *eio_stat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
182eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 246eio_req *eio_lstat (const char *path, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
183eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data); 247eio_req *eio_mknod (const char *path, mode_t mode, dev_t dev, int pri, eio_cb cb, void *data);
184eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 248eio_req *eio_link (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
185eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 249eio_req *eio_symlink (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
186eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data); 250eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
251eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
187#endif 252#endif
188 253
189/*****************************************************************************/ 254/*****************************************************************************/
190/* groups */ 255/* groups */
191 256
… …
217/*****************************************************************************/ 282/*****************************************************************************/
218/* convinience functions */ 283/* convinience functions */
219 284
220ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 285ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
221 286
287#ifdef __cplusplus
288}
222#endif 289#endif
223 290
291#endif
292

Diff Legend

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