1 /*- 2 * Copyright (c) 1997 John S. Dyson. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. John S. Dyson's name may not be used to endorse or promote products 10 * derived from this software without specific prior written permission. 11 * 12 * DISCLAIMER: This code isn't warranted to do anything useful. Anything 13 * bad that happens because of using this software isn't the responsibility 14 * of the author. This software is distributed AS-IS. 15 * 16 * $FreeBSD$ 17 */ 18 19 #ifndef _SYS_AIO_H_ 20 #define _SYS_AIO_H_ 21 22 #include <sys/time.h> 23 #include <sys/types.h> 24 #include <sys/signal.h> 25 26 /* 27 * Returned by aio_cancel: 28 */ 29 #define AIO_CANCELED 0x1 30 #define AIO_NOTCANCELED 0x2 31 #define AIO_ALLDONE 0x3 32 33 /* 34 * LIO opcodes 35 */ 36 #define LIO_NOP 0x0 37 #define LIO_WRITE 0x1 38 #define LIO_READ 0x2 39 #ifdef _KERNEL 40 #define LIO_SYNC 0x3 41 #endif 42 43 /* 44 * LIO modes 45 */ 46 #define LIO_NOWAIT 0x0 47 #define LIO_WAIT 0x1 48 49 /* 50 * Maximum number of allowed LIO operations 51 */ 52 #define AIO_LISTIO_MAX 16 53 54 /* 55 * Private members for aiocb -- don't access 56 * directly. 57 */ 58 struct __aiocb_private { 59 long status; 60 long error; 61 void *kernelinfo; 62 }; 63 64 /* 65 * I/O control block 66 */ 67 typedef struct aiocb { 68 int aio_fildes; /* File descriptor */ 69 off_t aio_offset; /* File offset for I/O */ 70 volatile void *aio_buf; /* I/O buffer in process space */ 71 size_t aio_nbytes; /* Number of bytes for I/O */ 72 char __spare__[sizeof(int) * 2 + sizeof(void *)]; /* osigevent. */ 73 int aio_lio_opcode; /* LIO opcode */ 74 int aio_reqprio; /* Request priority -- ignored */ 75 struct __aiocb_private _aiocb_private; 76 struct sigevent aio_sigevent; /* Signal to deliver */ 77 } aiocb_t; 78 79 #ifndef _KERNEL 80 81 __BEGIN_DECLS 82 /* 83 * Asynchronously read from a file 84 */ 85 int aio_read(struct aiocb *); 86 87 /* 88 * Asynchronously write to file 89 */ 90 int aio_write(struct aiocb *); 91 92 /* 93 * List I/O Asynchronously/synchronously read/write to/from file 94 * "lio_mode" specifies whether or not the I/O is synchronous. 95 * "acb_list" is an array of "nacb_listent" I/O control blocks. 96 * when all I/Os are complete, the optional signal "sig" is sent. 97 */ 98 int lio_listio(int, struct aiocb * const [], int, struct sigevent *); 99 100 /* 101 * Get completion status 102 * returns EINPROGRESS until I/O is complete. 103 * this routine does not block. 104 */ 105 int aio_error(const struct aiocb *); 106 107 /* 108 * Finish up I/O, releasing I/O resources and returns the value 109 * that would have been associated with a synchronous I/O request. 110 * This routine must be called once and only once for each 111 * I/O control block who has had I/O associated with it. 112 */ 113 ssize_t aio_return(struct aiocb *); 114 115 /* 116 * Cancel I/O 117 */ 118 int aio_cancel(int, struct aiocb *); 119 120 /* 121 * Suspend until all specified I/O or timeout is complete. 122 */ 123 int aio_suspend(const struct aiocb * const[], int, const struct timespec *); 124 125 int aio_waitcomplete(struct aiocb **, struct timespec *); 126 127 int aio_fsync(int op, struct aiocb *aiocbp); 128 __END_DECLS 129 130 #else 131 132 /* Forward declarations for prototypes below. */ 133 struct socket; 134 struct sockbuf; 135 136 extern void (*aio_swake)(struct socket *, struct sockbuf *); 137 138 #endif 139 140 #endif 141