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.19 by root, Sat Jun 6 17:25:13 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_DIR = 4,
82 EIO_DT_BLK = 6,
83 EIO_DT_REG = 8,
84 EIO_DT_LNK = 10,
85 EIO_DT_SOCK = 12,
86 EIO_DT_WHT = 14,
87 EIO_DT_MAX = 15 /* highest DT_VALUE ever, hopefully */
88};
89
90struct eio_dirent {
91 char *name;
92 ino_t inode;
93 unsigned short namelen;
94 unsigned char type;
95 unsigned char score; /* internal use */
96 /* 0-4 bytes padding */
97};
98
99/* eio_sync_file_range flags */
100
101enum {
102 EIO_SYNC_FILE_RANGE_WAIT_BEFORE = 1,
103 EIO_SYNC_FILE_RANGE_WRITE = 2,
104 EIO_SYNC_FILE_RANGE_WAIT_AFTER = 4
105};
106
107typedef double eio_tstamp; /* feel free to use double in your code directly */
108
109/* the eio request structure */
110
111enum {
112 EIO_CUSTOM,
59 EIO_OPEN, EIO_CLOSE, EIO_DUP2, 113 EIO_OPEN, EIO_CLOSE, EIO_DUP2,
60 EIO_READ, EIO_WRITE, 114 EIO_READ, EIO_WRITE,
61 EIO_READAHEAD, EIO_SENDFILE, 115 EIO_READAHEAD, EIO_SENDFILE,
62 EIO_STAT, EIO_LSTAT, EIO_FSTAT, 116 EIO_STAT, EIO_LSTAT, EIO_FSTAT,
63 EIO_TRUNCATE, EIO_FTRUNCATE, 117 EIO_TRUNCATE, EIO_FTRUNCATE,
64 EIO_UTIME, EIO_FUTIME, 118 EIO_UTIME, EIO_FUTIME,
65 EIO_CHMOD, EIO_FCHMOD, 119 EIO_CHMOD, EIO_FCHMOD,
66 EIO_CHOWN, EIO_FCHOWN, 120 EIO_CHOWN, EIO_FCHOWN,
67 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, 121 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC,
122 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE,
68 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME, 123 EIO_UNLINK, EIO_RMDIR, EIO_MKDIR, EIO_RENAME,
69 EIO_MKNOD, EIO_READDIR, 124 EIO_MKNOD, EIO_READDIR,
70 EIO_LINK, EIO_SYMLINK, EIO_READLINK, 125 EIO_LINK, EIO_SYMLINK, EIO_READLINK,
71 EIO_GROUP, EIO_NOP, 126 EIO_GROUP, EIO_NOP,
72 EIO_BUSY, 127 EIO_BUSY
73}; 128};
74
75typedef double eio_tstamp; /* feel free to use double in your code directly */
76 129
77/* eio request structure */ 130/* eio request structure */
78/* this structure is mostly read-only */ 131/* this structure is mostly read-only */
132/* when initialising it, all members must be zero-initialised */
79struct eio_req 133struct eio_req
80{ 134{
81 eio_req volatile *next; /* private ETP */ 135 eio_req volatile *next; /* private ETP */
82 136
83 ssize_t result; /* result of syscall, e.g. result = read (... */ 137 ssize_t result; /* result of syscall, e.g. result = read (... */
84 off_t offs; /* read, write, truncate, readahead: file offset; mknod: dev_t */ 138 off_t offs; /* read, write, truncate, readahead, sync_file_range: file offset */
85 size_t size; /* read, write, readahead, sendfile: length */ 139 size_t size; /* read, write, readahead, sendfile, msync, sync_file_range: length */
86 void *ptr1; /* all applicable requests: pathname, old name */ 140 void *ptr1; /* all applicable requests: pathname, old name */
87 void *ptr2; /* all applicable requests: new name or memory buffer */ 141 void *ptr2; /* all applicable requests: new name or memory buffer */
88 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 142 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
89 eio_tstamp nv2; /* utime, futime: mtime */ 143 eio_tstamp nv2; /* utime, futime: mtime */
90 144
91 int type; /* EIO_xxx constant ETP */ 145 int type; /* EIO_xxx constant ETP */
92 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open: flags */ 146 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 */ 147 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, sync_file_range: flags */
94 long int3; /* chown, fchown: gid */ 148 long int3; /* chown, fchown: gid; mknod: dev_t */
95 int errorno; /* errno value on syscall return */ 149 int errorno; /* errno value on syscall return */
96 150
97 unsigned char flags; /* private */ 151 unsigned char flags; /* private */
98 signed char pri; /* the priority */ 152 signed char pri; /* the priority */
99 153
… …
105 EIO_REQ_MEMBERS 159 EIO_REQ_MEMBERS
106 160
107 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */ 161 eio_req *grp, *grp_prev, *grp_next, *grp_first; /* private */
108}; 162};
109 163
164/* _private_ flags */
110enum { 165enum {
111 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */ 166 EIO_FLAG_CANCELLED = 0x01, /* request was cancelled */
112 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */ 167 EIO_FLAG_PTR1_FREE = 0x02, /* need to free(ptr1) */
113 EIO_FLAG_PTR2_FREE = 0x04 /* need to free(ptr2) */ 168 EIO_FLAG_PTR2_FREE = 0x04, /* need to free(ptr2) */
169 EIO_FLAG_GROUPADD = 0x08 /* some request was added to the group */
114}; 170};
115 171
116enum { 172enum {
117 EIO_PRI_MIN = -4, 173 EIO_PRI_MIN = -4,
118 EIO_PRI_MAX = 4, 174 EIO_PRI_MAX = 4,
119
120 EIO_PRI_DEFAULT = 0, 175 EIO_PRI_DEFAULT = 0,
121}; 176};
122 177
123/* returns < 0 on error, errno set 178/* returns < 0 on error, errno set
124 * need_poll, if non-zero, will be called when results are available 179 * 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). 180 * 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 */ 210eio_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 */ 211eio_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); 212eio_req *eio_sync (int pri, eio_cb cb, void *data);
158eio_req *eio_fsync (int fd, int pri, eio_cb cb, void *data); 213eio_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); 214eio_req *eio_fdatasync (int fd, int pri, eio_cb cb, void *data);
215eio_req *eio_msync (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
216eio_req *eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data);
217eio_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); 218eio_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); 219eio_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); 220eio_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); 221eio_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 */ 222eio_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); 230eio_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); 231eio_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); 232eio_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); 233eio_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); 234eio_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 */ 235eio_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); 236eio_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); 237eio_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 */ 238eio_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 */ 239eio_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 */ 240eio_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); 241eio_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); 242eio_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); 243eio_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); 244eio_req *eio_rename (const char *path, const char *new_path, int pri, eio_cb cb, void *data);
245eio_req *eio_custom (eio_cb execute, int pri, eio_cb cb, void *data);
187#endif 246#endif
188 247
189/*****************************************************************************/ 248/*****************************************************************************/
190/* groups */ 249/* groups */
191 250
… …
217/*****************************************************************************/ 276/*****************************************************************************/
218/* convinience functions */ 277/* convinience functions */
219 278
220ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count); 279ssize_t eio_sendfile_sync (int ofd, int ifd, off_t offset, size_t count);
221 280
281#ifdef __cplusplus
282}
222#endif 283#endif
223 284
285#endif
286

Diff Legend

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