sys/sys/aio.h

   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: src/sys/sys/aio.h,v 1.13.2.8 2002/08/31 03:18:23 alc Exp $
  17  */
  18
  19 #ifndef _SYS_AIO_H_
  20 #define _SYS_AIO_H_
  21
  22 #include <sys/_timespec.h>
  23 #include <sys/signal.h>
  24
  25 /*
  26  * Returned by aio_cancel:
  27  */
  28 #define AIO_CANCELED            0x1
  29 #define AIO_NOTCANCELED         0x2
  30 #define AIO_ALLDONE             0x3
  31
  32 /*
  33  * LIO opcodes
  34  */
  35 #define LIO_NOP                 0x0
  36 #define LIO_WRITE               0x1
  37 #define LIO_READ                0x2
  38
  39 /*
  40  * LIO modes
  41  */
  42 #define LIO_NOWAIT              0x0
  43 #define LIO_WAIT                0x1
  44
  45 /*
  46  * Maximum number of allowed LIO operations
  47  */
  48 #define AIO_LISTIO_MAX          16
  49
  50 /*
  51  * I/O control block
  52  */
  53 typedef struct aiocb {
  54         int     aio_fildes;             /* File descriptor */
  55         off_t   aio_offset;             /* File offset for I/O */
  56         volatile void *aio_buf;         /* I/O buffer in process space */
  57         size_t  aio_nbytes;             /* Number of bytes for I/O */
  58         struct  sigevent aio_sigevent;  /* Signal to deliver */
  59         int     aio_lio_opcode;         /* LIO opcode */
  60         int     aio_reqprio;            /* Request priority -- ignored */
  61
  62         int     _aio_val;
  63         int     _aio_err;
  64 } aiocb_t;
  65
  66 #ifndef _KERNEL
  67
  68 __BEGIN_DECLS
  69 /*
  70  * Asynchronously read from a file
  71  */
  72 int     aio_read(struct aiocb *);
  73
  74 /*
  75  * Asynchronously write to file
  76  */
  77 int     aio_write(struct aiocb *);
  78
  79 /*
  80  * List I/O Asynchronously/synchronously read/write to/from file
  81  *      "lio_mode" specifies whether or not the I/O is synchronous.
  82  *      "acb_list" is an array of "nacb_listent" I/O control blocks.
  83  *      when all I/Os are complete, the optional signal "sig" is sent.
  84  */
  85 int     lio_listio(int, struct aiocb * const [], int, struct sigevent *);
  86
  87 /*
  88  * Get completion status
  89  *      returns EINPROGRESS until I/O is complete.
  90  *      this routine does not block.
  91  */
  92 int     aio_error(const struct aiocb *);
  93
  94 /*
  95  * Finish up I/O, releasing I/O resources and returns the value
  96  *      that would have been associated with a synchronous I/O request.
  97  *      This routine must be called once and only once for each
  98  *      I/O control block who has had I/O associated with it.
  99  */
 100 ssize_t aio_return(struct aiocb *);
 101
 102 /*
 103  * Cancel I/O
 104  */
 105 int     aio_cancel(int, struct aiocb *);
 106
 107 /*
 108  * Suspend until all specified I/O or timeout is complete.
 109  */
 110 int     aio_suspend(const struct aiocb * const[], int, const struct timespec *);
 111
 112 /*
 113  * Synchronize I/O
 114  */
 115 int     aio_fsync(int, struct aiocb *);
 116
 117 int     aio_waitcomplete(struct aiocb **, struct timespec *);
 118
 119 __END_DECLS
 120
 121 #endif
 122
 123 #endif