bsd/sys/aio_kern.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  *      File:   sys/aio_kern.h
  25  *      Author: Jerry Cottingham [jerryc@apple.com]
  26  *
  27  *      Header file for kernel only portion of POSIX Asynchronous IO APIs
  28  *
  29  */
  30
  31 #include <sys/aio.h>
  32
  33 #ifndef _SYS_AIO_KERN_H_
  34 #define _SYS_AIO_KERN_H_
  35
  36 #ifdef KERNEL
  37
  38 struct aio_workq_entry
  39 {
  40         TAILQ_ENTRY( aio_workq_entry )  aio_workq_link;
  41         struct proc                                             *procp;         /* user proc that queued this request */
  42         user_addr_t                                             uaiocbp;        /* pointer passed in from user land */
  43         user_addr_t                                             fsyncp;         /* not NULL means this request must complete */
  44                                                                                                 /* before an aio_fsync call can proceed. */
  45         vm_map_t                                                aio_map;        /* user land map we have a reference to */
  46         user_ssize_t                                    returnval;      /* return value from read / write request */
  47         int                                                             errorval;       /* error value from read / write request */
  48         int                                                             flags;
  49         long                                                    group_tag;      /* identifier used to group IO requests */
  50         struct user_aiocb                               aiocb;          /* copy of aiocb from user land */
  51 };
  52 typedef struct aio_workq_entry aio_workq_entry;
  53
  54 /*
  55  * definitions for aio_workq_entry.flags
  56  */
  57 #define AIO_READ                0x00000001
  58 #define AIO_WRITE               0x00000002
  59 #define AIO_FSYNC               0x00000004      /* aio_fsync with op = O_SYNC */
  60 #define AIO_DSYNC               0x00000008      /* aio_fsync with op = O_DSYNC (not supported yet) */
  61 #define AIO_LIO                 0x00000010      /* lio_listio generated IO */
  62 #define AIO_DO_FREE             0x00000800      /* entry needs to be freed */
  63 #define AIO_COMPLETION  0x00001000      /* entry is in completion processing (not freeable yet) */
  64 #define AIO_DISABLE             0x00002000      /* process is trying to exit or exec and we need */
  65                                                                         /*      to disable normal completion notification */
  66 #define AIO_WAITING             0x00004000      /* process is trying to exit, exec, or close and is */
  67                                                                         /*      waiting for one or more active IO requests to */
  68                                                                         /*      complete */
  69
  70 /*
  71  * Prototypes
  72  */
  73
  74 __private_extern__ void
  75 _aio_close(struct proc *p, int fd);
  76
  77 __private_extern__ void
  78 _aio_exit(struct proc *p);
  79
  80 __private_extern__ void
  81 _aio_exec(struct proc *p);
  82
  83 __private_extern__ void
  84 _aio_create_worker_threads(int num);
  85
  86 __private_extern__ void
  87 aio_init(void);
  88
  89 task_t
  90 get_aiotask(void);
  91
  92 #endif /* KERNEL */
  93
  94 #endif /* _SYS_AIO_KERN_H_ */