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

Comparing libeio/eio.h (file contents):
Revision 1.53 by root, Sun Apr 14 09:43:19 2013 UTC vs.
Revision 1.60 by root, Fri Jun 23 23:50:25 2017 UTC

1/* 1/*
2 * libeio API header 2 * libeio API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libeio@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011,2012,2015,2016 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 *
169 169
170/* eio_fallocate flags */ 170/* eio_fallocate flags */
171enum 171enum
172{ 172{
173 /* these MUST match the value in linux/falloc.h */ 173 /* these MUST match the value in linux/falloc.h */
174 EIO_FALLOC_FL_KEEP_SIZE = 1, 174 EIO_FALLOC_FL_KEEP_SIZE = 0x01,
175 EIO_FALLOC_FL_PUNCH_HOLE = 2 175 EIO_FALLOC_FL_PUNCH_HOLE = 0x02,
176 EIO_FALLOC_FL_COLLAPSE_RANGE = 0x08,
177 EIO_FALLOC_FL_ZERO_RANGE = 0x10,
178 EIO_FALLOC_FL_INSERT_RANGE = 0x20,
179 EIO_FALLOC_FL_UNSHARE_RANGE = 0x40
180};
181
182/* eio_rename flags */
183enum
184{
185 /* these MUST match the value in linux/fs.h */
186 EIO_RENAME_NOREPLACE = 1 << 0,
187 EIO_RENAME_EXCHANGE = 1 << 1,
188 EIO_RENAME_WHITEOUT = 1 << 2
176}; 189};
177 190
178/* timestamps and differences - feel free to use double in your code directly */ 191/* timestamps and differences - feel free to use double in your code directly */
179typedef double eio_tstamp; 192typedef double eio_tstamp;
180 193
183{ 196{
184 EIO_CUSTOM, 197 EIO_CUSTOM,
185 EIO_WD_OPEN, EIO_WD_CLOSE, 198 EIO_WD_OPEN, EIO_WD_CLOSE,
186 199
187 EIO_CLOSE, EIO_DUP2, 200 EIO_CLOSE, EIO_DUP2,
188 EIO_SEEK, EIO_READ, EIO_WRITE, 201 EIO_SEEK, EIO_READ, EIO_WRITE, EIO_FCNTL, EIO_IOCTL,
189 EIO_READAHEAD, EIO_SENDFILE, 202 EIO_READAHEAD, EIO_SENDFILE,
190 EIO_FSTAT, EIO_FSTATVFS, 203 EIO_FSTAT, EIO_FSTATVFS,
191 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN, 204 EIO_FTRUNCATE, EIO_FUTIME, EIO_FCHMOD, EIO_FCHOWN,
192 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS, 205 EIO_SYNC, EIO_FSYNC, EIO_FDATASYNC, EIO_SYNCFS,
193 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE, 206 EIO_MSYNC, EIO_MTOUCH, EIO_SYNC_FILE_RANGE, EIO_FALLOCATE,
249 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */ 262 eio_wd wd; /* all applicable requests: working directory of pathname, old name; wd_open: return wd */
250 263
251 eio_ssize_t result; /* result of syscall, e.g. result = read (... */ 264 eio_ssize_t result; /* result of syscall, e.g. result = read (... */
252 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */ 265 off_t offs; /* read, write, truncate, readahead, sync_file_range, fallocate: file offset, mknod: dev_t */
253 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */ 266 size_t size; /* read, write, readahead, sendfile, msync, mlock, sync_file_range, fallocate: length */
254 void *ptr1; /* all applicable requests: pathname, old name; readdir: optional eio_dirents */ 267 void *ptr1; /* all applicable requests: pathname, old name, readdir: optional eio_dirents */
255 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */ 268 void *ptr2; /* all applicable requests: new name or memory buffer; readdir: name strings */
256 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */ 269 eio_tstamp nv1; /* utime, futime: atime; busy: sleep time */
257 eio_tstamp nv2; /* utime, futime: mtime */ 270 eio_tstamp nv2; /* utime, futime: mtime */
258 271
259 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */ 272 int int1; /* all applicable requests: file descriptor; sendfile: output fd; open, msync, mlockall, readdir: flags */
260 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, sync_file_range, fallocate: flags */ 273 long int2; /* chown, fchown: uid; sendfile: input fd; open, chmod, mkdir, mknod: file mode, seek: whence, fcntl, ioctl: request, sync_file_range, fallocate, rename: flags */
261 long int3; /* chown, fchown: gid; rename, link: working directory of new name */ 274 long int3; /* chown, fchown: gid; rename, link: working directory of new name */
262 int errorno; /* errno value on syscall return */ 275 int errorno; /* errno value on syscall return */
263 276
277 unsigned char flags; /* private */
278
264 signed char type;/* EIO_xxx constant ETP */ 279 signed char type;/* EIO_xxx constant ETP */
265 280 signed char pri; /* the priority ETP */
266#if __i386 || __amd64 281#if __i386 || __amd64
267 unsigned char cancelled; /* ETP */ 282 unsigned char cancelled; /* ETP */
268#else 283#else
269 sig_atomic_t cancelled; /* ETP */ 284 sig_atomic_t cancelled; /* ETP */
270#endif 285#endif
271 286
272 unsigned char flags; /* private */
273 signed char pri; /* the priority */
274
275 void *data; 287 void *data;
276 eio_cb finish; 288 eio_cb finish;
277 void (*destroy)(eio_req *req); /* called when request no longer needed */ 289 void (*destroy)(eio_req *req); /* called when request no longer needed */
278 void (*feed)(eio_req *req); /* only used for group requests */ 290 void (*feed)(eio_req *req); /* only used for group requests */
279 291
284 296
285/* _private_ request flags */ 297/* _private_ request flags */
286enum { 298enum {
287 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */ 299 EIO_FLAG_PTR1_FREE = 0x01, /* need to free(ptr1) */
288 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */ 300 EIO_FLAG_PTR2_FREE = 0x02, /* need to free(ptr2) */
289 EIO_FLAG_GROUPADD = 0x04 /* some request was added to the group */
290}; 301};
291 302
292/* undocumented/unsupported/private helper */ 303/* undocumented/unsupported/private helper */
293/*void eio_page_align (void **addr, size_t *length);*/ 304/*void eio_page_align (void **addr, size_t *length);*/
294 305
321unsigned int eio_npending (void); /* number of finished but unhandled requests */ 332unsigned int eio_npending (void); /* number of finished but unhandled requests */
322unsigned int eio_nthreads (void); /* number of worker threads in use currently */ 333unsigned int eio_nthreads (void); /* number of worker threads in use currently */
323 334
324/*****************************************************************************/ 335/*****************************************************************************/
325/* convenience wrappers */ 336/* convenience wrappers */
337/* these do not expose advanced syscalls and directory fds */
326 338
327#ifndef EIO_NO_WRAPPERS 339#ifndef EIO_NO_WRAPPERS
328eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */ 340eio_req *eio_wd_open (const char *path, int pri, eio_cb cb, void *data); /* result=wd */
329eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data); 341eio_req *eio_wd_close (eio_wd wd, int pri, eio_cb cb, void *data);
330eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */ 342eio_req *eio_nop (int pri, eio_cb cb, void *data); /* does nothing except go through the whole process */
342eio_req *eio_close (int fd, int pri, eio_cb cb, void *data); 354eio_req *eio_close (int fd, int pri, eio_cb cb, void *data);
343eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data); 355eio_req *eio_readahead (int fd, off_t offset, size_t length, int pri, eio_cb cb, void *data);
344eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data); 356eio_req *eio_seek (int fd, off_t offset, int whence, int pri, eio_cb cb, void *data);
345eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 357eio_req *eio_read (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
346eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data); 358eio_req *eio_write (int fd, void *buf, size_t length, off_t offset, int pri, eio_cb cb, void *data);
359eio_req *eio_fcntl (int fd, int cmd, void *arg, int pri, eio_cb cb, void *data);
360eio_req *eio_ioctl (int fd, unsigned long request, void *buf, int pri, eio_cb cb, void *data);
347eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 361eio_req *eio_fstat (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
348eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */ 362eio_req *eio_fstatvfs (int fd, int pri, eio_cb cb, void *data); /* stat buffer=ptr2 allocated dynamically */
349eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data); 363eio_req *eio_futime (int fd, eio_tstamp atime, eio_tstamp mtime, int pri, eio_cb cb, void *data);
350eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data); 364eio_req *eio_ftruncate (int fd, off_t offset, int pri, eio_cb cb, void *data);
351eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data); 365eio_req *eio_fchmod (int fd, mode_t mode, int pri, eio_cb cb, void *data);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines