bsd/sys/aio_kern.h

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