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
43struct aio_workq_entry
44{
45	TAILQ_ENTRY( aio_workq_entry )	aio_workq_link; /* Protected by queue lock */
46	TAILQ_ENTRY( aio_workq_entry )  aio_proc_link;  /* Proteced by proc's aio lock */
47
48	/* Proc lock */
49	void		*group_tag;	/* identifier used to group IO requests */
50
51	/* Initialized and never changed, safe to access */
52	struct proc	*procp;		/* user proc that queued this request */
53	user_addr_t	uaiocbp;  	/* pointer passed in from user land */
54	struct user_aiocb	aiocb;	/* copy of aiocb from user land */
55	vm_map_t	aio_map;	/* user land map we have a reference to */
56	thread_t	thread;		/* thread that queued this request */
57
58	/* Entry lock */
59	int		aio_refcount;
60	user_ssize_t	returnval;	/* return value from read / write request */
61	int		errorval;	/* error value from read / write request */
62	int		flags;
63};
64typedef struct aio_workq_entry aio_workq_entry;
65
66/*
67 * definitions for aio_workq_entry.flags
68 */
69#define	AIO_READ		0x00000001	/* a read */
70#define	AIO_WRITE		0x00000002	/* a write */
71#define	AIO_FSYNC		0x00000004	/* aio_fsync with op = O_SYNC */
72#define	AIO_DSYNC		0x00000008	/* aio_fsync with op = O_DSYNC (not supported yet) */
73#define	AIO_LIO			0x00000010	/* lio_listio generated IO */
74#define	AIO_DO_FREE		0x00000800	/* entry should be freed when last reference is dropped. */
75						/* 	set by aio_return() and _aio_exit() */
76#define	AIO_DISABLE		0x00002000	/* process is trying to exit or exec and we need */
77						/* 	to not try to send a signal from do_aio_completion() */
78#define	AIO_CLOSE_WAIT		0x00004000	/* process is trying to close and is */
79						/* 	waiting for one or more active IO requests to */
80						/*	complete */
81#define AIO_EXIT_WAIT		0x00008000	/* process is trying to exit or exec and is */
82						/* 	waiting for one or more active IO requests to */
83						/*	complete */
84
85#define AIO_LIO_NOTIFY		0x00010000	/* wait for list complete */
86
87/*
88 * Prototypes
89 */
90
91__private_extern__ void
92_aio_close(struct proc *p, int fd);
93
94__private_extern__ void
95_aio_exit(struct proc *p);
96
97__private_extern__ void
98_aio_exec(struct proc *p);
99
100__private_extern__ void
101_aio_create_worker_threads(int num);
102
103__private_extern__ void
104aio_init(void);
105
106task_t
107get_aiotask(void);
108
109#endif /* KERNEL */
110
111#endif /* _SYS_AIO_KERN_H_ */
112