sys/sys/aio.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 1997 John S. Dyson.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. John S. Dyson's name may not be used to endorse or promote products
  12  *    derived from this software without specific prior written permission.
  13  *
  14  * DISCLAIMER:  This code isn't warranted to do anything useful.  Anything
  15  * bad that happens because of using this software isn't the responsibility
  16  * of the author.  This software is distributed AS-IS.
  17  */
  18
  19 #ifndef _SYS_AIO_H_
  20 #define _SYS_AIO_H_
  21
  22 #include <sys/types.h>
  23 #include <sys/signal.h>
  24 #ifdef _KERNEL
  25 #include <sys/queue.h>
  26 #include <sys/event.h>
  27 #include <sys/signalvar.h>
  28 #include <sys/uio.h>
  29 #endif
  30
  31 /*
  32  * Returned by aio_cancel:
  33  */
  34 #define AIO_CANCELED            0x1
  35 #define AIO_NOTCANCELED         0x2
  36 #define AIO_ALLDONE             0x3
  37
  38 /*
  39  * LIO opcodes
  40  */
  41 #define LIO_NOP                 0x0
  42 #define LIO_WRITE               0x1
  43 #define LIO_READ                0x2
  44 #if __BSD_VISIBLE
  45 #define LIO_VECTORED            0x4
  46 #define LIO_WRITEV              (LIO_WRITE | LIO_VECTORED)
  47 #define LIO_READV               (LIO_READ | LIO_VECTORED)
  48 #endif
  49 #if defined(_KERNEL) || defined(_WANT_ALL_LIO_OPCODES)
  50 #define LIO_SYNC                0x8
  51 #define LIO_DSYNC               (0x10 | LIO_SYNC)
  52 #define LIO_MLOCK               0x20
  53 #endif
  54 #if __BSD_VISIBLE
  55 #define LIO_FOFFSET             0x40
  56 #endif
  57
  58 /* aio_read2/aio_write2 flags */
  59 #if __BSD_VISIBLE
  60 #define AIO_OP2_FOFFSET         0x00000001
  61 #endif
  62
  63 /*
  64  * LIO modes
  65  */
  66 #define LIO_NOWAIT              0x0
  67 #define LIO_WAIT                0x1
  68
  69 /*
  70  * Maximum number of operations in a single lio_listio call
  71  */
  72 #define AIO_LISTIO_MAX          16
  73
  74 #ifdef _KERNEL
  75
  76 /* Default values of tunables for the AIO worker pool. */
  77
  78 #ifndef MAX_AIO_PROCS
  79 #define MAX_AIO_PROCS           32
  80 #endif
  81
  82 #ifndef TARGET_AIO_PROCS
  83 #define TARGET_AIO_PROCS        4
  84 #endif
  85
  86 #ifndef AIOD_LIFETIME_DEFAULT
  87 #define AIOD_LIFETIME_DEFAULT   (30 * hz)
  88 #endif
  89
  90 #endif
  91
  92 /*
  93  * Private members for aiocb -- don't access
  94  * directly.
  95  */
  96 struct __aiocb_private {
  97         long    status;
  98         long    error;
  99         void    *kernelinfo;
 100 };
 101
 102 /*
 103  * I/O control block
 104  */
 105 typedef struct aiocb {
 106         int     aio_fildes;             /* File descriptor */
 107         off_t   aio_offset;             /* File offset for I/O */
 108         volatile void *aio_buf;         /* I/O buffer in process space */
 109         size_t  aio_nbytes;             /* Number of bytes for I/O */
 110         int     __spare__[2];
 111         void    *__spare2__;
 112         int     aio_lio_opcode;         /* LIO opcode */
 113         int     aio_reqprio;            /* Request priority -- ignored */
 114         struct  __aiocb_private _aiocb_private;
 115         struct  sigevent aio_sigevent;  /* Signal to deliver */
 116 } aiocb_t;
 117
 118 #define aio_iov aio_buf                 /* I/O scatter/gather list */
 119 #define aio_iovcnt      aio_nbytes      /* Length of aio_iov */
 120
 121 #ifdef _KERNEL
 122
 123 typedef void aio_cancel_fn_t(struct kaiocb *);
 124 typedef void aio_handle_fn_t(struct kaiocb *);
 125
 126 /*
 127  * Kernel version of an I/O control block.
 128  *
 129  * Locking key:
 130  * * - need not protected
 131  * a - locked by kaioinfo lock
 132  * b - locked by backend lock
 133  * c - locked by aio_job_mtx
 134  */
 135 struct kaiocb {
 136         TAILQ_ENTRY(kaiocb) list;       /* (b) backend-specific list of jobs */
 137         TAILQ_ENTRY(kaiocb) plist;      /* (a) lists of pending / done jobs */
 138         TAILQ_ENTRY(kaiocb) allist;     /* (a) list of all jobs in proc */
 139         int     jobflags;               /* (a) job flags */
 140         int     ioflags;                /* (*) io flags */
 141         int     inblock;                /* (*) input blocks */
 142         int     outblock;               /* (*) output blocks */
 143         int     msgsnd;                 /* (*) messages sent */
 144         int     msgrcv;                 /* (*) messages received */
 145         struct  proc *userproc;         /* (*) user process */
 146         struct  ucred *cred;            /* (*) active credential when created */
 147         struct  file *fd_file;          /* (*) pointer to file structure */
 148         struct  aioliojob *lio;         /* (*) optional lio job */
 149         struct  aiocb *ujob;            /* (*) pointer in userspace of aiocb */
 150         struct  knlist klist;           /* (a) list of knotes */
 151         struct  aiocb uaiocb;           /* (*) copy of user I/O control block */
 152         struct  uio uio;                /* (*) storage for non-vectored uio */
 153         struct  iovec iov[1];           /* (*) storage for non-vectored uio */
 154         struct  uio *uiop;              /* (*) Possibly malloced uio */
 155         ksiginfo_t ksi;                 /* (a) realtime signal info */
 156         uint64_t seqno;                 /* (*) job number */
 157         aio_cancel_fn_t *cancel_fn;     /* (a) backend cancel function */
 158         aio_handle_fn_t *handle_fn;     /* (c) backend handle function */
 159         union {                         /* Backend-specific data fields */
 160                 struct {                /* BIO backend */
 161                         volatile u_int nbio; /* Number of remaining bios */
 162                         int     error;  /* Worst error of all bios */
 163                         long    nbytes; /* Bytes completed so far */
 164                 };
 165                 struct {                /* fsync() requests */
 166                         int     pending; /* (a) number of pending I/O */
 167                 };
 168                 struct {                /* socket backend */
 169                         void    *backend1;
 170                         long    backend3;
 171                         int     backend4;
 172                 };
 173         };
 174 };
 175
 176 struct socket;
 177 struct sockbuf;
 178
 179 /*
 180  * AIO backends should permit cancellation of queued requests waiting to
 181  * be serviced by installing a cancel routine while the request is
 182  * queued.  The cancellation routine should dequeue the request if
 183  * necessary and cancel it.  Care must be used to handle races between
 184  * queueing and dequeueing requests and cancellation.
 185  *
 186  * When queueing a request somewhere such that it can be cancelled, the
 187  * caller should:
 188  *
 189  *  1) Acquire lock that protects the associated queue.
 190  *  2) Call aio_set_cancel_function() to install the cancel routine.
 191  *  3) If that fails, the request has a pending cancel and should be
 192  *     cancelled via aio_cancel().
 193  *  4) Queue the request.
 194  *
 195  * When dequeueing a request to service it or hand it off to somewhere else,
 196  * the caller should:
 197  *
 198  *  1) Acquire the lock that protects the associated queue.
 199  *  2) Dequeue the request.
 200  *  3) Call aio_clear_cancel_function() to clear the cancel routine.
 201  *  4) If that fails, the cancel routine is about to be called.  The
 202  *     caller should ignore the request.
 203  *
 204  * The cancel routine should:
 205  *
 206  *  1) Acquire the lock that protects the associated queue.
 207  *  2) Call aio_cancel_cleared() to determine if the request is already
 208  *     dequeued due to a race with dequeueing thread.
 209  *  3) If that fails, dequeue the request.
 210  *  4) Cancel the request via aio_cancel().
 211  */
 212
 213 bool    aio_cancel_cleared(struct kaiocb *job);
 214 void    aio_cancel(struct kaiocb *job);
 215 bool    aio_clear_cancel_function(struct kaiocb *job);
 216 void    aio_complete(struct kaiocb *job, long status, int error);
 217 void    aio_schedule(struct kaiocb *job, aio_handle_fn_t *func);
 218 bool    aio_set_cancel_function(struct kaiocb *job, aio_cancel_fn_t *func);
 219 void    aio_switch_vmspace(struct kaiocb *job);
 220
 221 #else /* !_KERNEL */
 222
 223 struct timespec;
 224
 225 __BEGIN_DECLS
 226 /*
 227  * Asynchronously read from a file
 228  */
 229 int     aio_read(struct aiocb *);
 230 #if __BSD_VISIBLE
 231 int     aio_readv(struct aiocb *);
 232 #endif
 233
 234 /*
 235  * Asynchronously write to file
 236  */
 237 int     aio_write(struct aiocb *);
 238 #if __BSD_VISIBLE
 239 int     aio_writev(struct aiocb *);
 240 #endif
 241
 242 /*
 243  * List I/O Asynchronously/synchronously read/write to/from file
 244  *      "lio_mode" specifies whether or not the I/O is synchronous.
 245  *      "acb_list" is an array of "nacb_listent" I/O control blocks.
 246  *      when all I/Os are complete, the optional signal "sig" is sent.
 247  */
 248 int     lio_listio(int, struct aiocb *__restrict const *__restrict, int,
 249     struct sigevent *);
 250
 251 /*
 252  * Get completion status
 253  *      returns EINPROGRESS until I/O is complete.
 254  *      this routine does not block.
 255  */
 256 int     aio_error(const struct aiocb *);
 257
 258 /*
 259  * Finish up I/O, releasing I/O resources and returns the value
 260  *      that would have been associated with a synchronous I/O request.
 261  *      This routine must be called once and only once for each
 262  *      I/O control block who has had I/O associated with it.
 263  */
 264 ssize_t aio_return(struct aiocb *);
 265
 266 /*
 267  * Cancel I/O
 268  */
 269 int     aio_cancel(int, struct aiocb *);
 270
 271 /*
 272  * Suspend until all specified I/O or timeout is complete.
 273  */
 274 int     aio_suspend(const struct aiocb * const[], int, const struct timespec *);
 275
 276 /*
 277  * Asynchronous mlock
 278  */
 279 int     aio_mlock(struct aiocb *);
 280
 281 #if __BSD_VISIBLE
 282 ssize_t aio_waitcomplete(struct aiocb **, struct timespec *);
 283 int     aio_read2(struct aiocb *, int);
 284 int     aio_write2(struct aiocb *, int);
 285 #endif
 286
 287 int     aio_fsync(int op, struct aiocb *aiocbp);
 288 __END_DECLS
 289
 290 #endif /* !_KERNEL */
 291
 292 #endif /* !_SYS_AIO_H_ */