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 * (Note that FreeBSD's aio is not cancellable -- yet.) 29 */ 30 #define AIO_CANCELED 0x1 31 #define AIO_NOTCANCELED 0x2 32 #define AIO_ALLDONE 0x3 33 34 /* 35 * LIO opcodes 36 */ 37 #define LIO_NOP 0x0 38 #define LIO_WRITE 0x1 39 #define LIO_READ 0x2 40 41 /* 42 * LIO modes 43 */ 44 #define LIO_NOWAIT 0x0 45 #define LIO_WAIT 0x1 46 47 /* 48 * Maximum number of allowed LIO operations 49 */ 50 #define AIO_LISTIO_MAX 16 51 52 /* 53 * Private mode bit for aio. 54 * (This bit is set by the library routine 55 * to allow the kernel to support sync 56 * or async operations in the future.) 57 */ 58 #define AIO_PMODE_SYNC 0x1 59 #define AIO_PMODE_DONE 0x2 60 #define AIO_PMODE_SUSPEND 0x4 61 #define AIO_PMODE_ACTIVE 0x2357c0de 62 63 /* 64 * Private members for aiocb -- don't access 65 * directly. 66 */ 67 struct __aiocb_private { 68 long status; 69 long error; 70 long privatemodes; 71 void *kernelinfo; 72 }; 73 74 /* 75 * I/O control block 76 */ 77 typedef struct aiocb { 78 int aio_fildes; /* File descriptor */ 79 off_t aio_offset; /* File offset for I/O */ 80 volatile void *aio_buf; /* I/O buffer in process space */ 81 size_t aio_nbytes; /* Number of bytes for I/O */ 82 struct sigevent aio_sigevent; /* Signal to deliver */ 83 int aio_lio_opcode; /* LIO opcode */ 84 int aio_reqprio; /* Request priority -- ignored */ 85 struct __aiocb_private _aiocb_private; 86 } aiocb_t; 87 88 #ifndef _KERNEL 89 90 __BEGIN_DECLS 91 /* 92 * Asynchronously read from a file 93 */ 94 int aio_read(struct aiocb *); 95 96 /* 97 * Asynchronously write to file 98 */ 99 int aio_write(struct aiocb *); 100 101 /* 102 * List I/O Asynchronously/synchronously read/write to/from file 103 * "lio_mode" specifies whether or not the I/O is synchronous. 104 * "acb_list" is an array of "nacb_listent" I/O control blocks. 105 * when all I/Os are complete, the optional signal "sig" is sent. 106 */ 107 int lio_listio(int, struct aiocb * const [], int, struct sigevent *); 108 109 /* 110 * Get completion status 111 * returns EINPROGRESS until I/O is complete. 112 * this routine does not block. 113 */ 114 int aio_error(const struct aiocb *); 115 116 /* 117 * Finish up I/O, releasing I/O resources and returns the value 118 * that would have been associated with a synchronous I/O request. 119 * This routine must be called once and only once for each 120 * I/O control block who has had I/O associated with it. 121 */ 122 ssize_t aio_return(struct aiocb *); 123 124 /* 125 * Cancel I/O -- implemented only to return AIO_NOTCANCELLED or 126 * AIO_ALLDONE. No cancellation operation will occur. 127 */ 128 int aio_cancel(int, struct aiocb *); 129 130 /* 131 * Suspend until all specified I/O or timeout is complete. 132 */ 133 int aio_suspend(const struct aiocb * const[], int, const struct timespec *); 134 135 int aio_waitcomplete(struct aiocb **, struct timespec *); 136 137 __END_DECLS 138 139 #else 140 /* 141 * Job queue item 142 */ 143 144 #define AIOCBLIST_CANCELLED 0x1 145 #define AIOCBLIST_RUNDOWN 0x4 146 #define AIOCBLIST_ASYNCFREE 0x8 147 #define AIOCBLIST_DONE 0x10 148 149 struct aiocblist { 150 TAILQ_ENTRY (aiocblist) list; /* List of jobs */ 151 TAILQ_ENTRY (aiocblist) plist; /* List of jobs for proc */ 152 int jobflags; 153 int jobstate; 154 int inputcharge, outputcharge; 155 struct buf *bp; /* Buffer pointer */ 156 struct proc *userproc; /* User process */ 157 struct file *fd_file; /* Pointer to file structure */ 158 struct aioproclist *jobaioproc;/* AIO process descriptor */ 159 struct aio_liojob *lio; /* Optional lio job */ 160 struct aiocb *uuaiocb; /* Pointer in userspace of aiocb */ 161 struct klist klist; /* list of knotes */ 162 struct aiocb uaiocb; /* Kernel I/O control block */ 163 }; 164 165 /* Forward declarations for prototypes below. */ 166 struct socket; 167 struct sockbuf; 168 169 void aio_proc_rundown(struct proc *p); 170 void aio_swake(struct socket *, struct sockbuf *); 171 172 #endif 173 174 #endif 175