bsd/sys/aio_kern.h

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