[apple/xnu.git] / bsd / sys / aio_kern.h

/*
 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* 
 *	File:	sys/aio_kern.h
 *	Author:	Jerry Cottingham [jerryc@apple.com]
 *
 *	Header file for kernel only portion of POSIX Asynchronous IO APIs
 *
 */ 

#include <sys/aio.h>

#ifndef _SYS_AIO_KERN_H_
#define	_SYS_AIO_KERN_H_

#ifdef KERNEL

struct aio_workq_entry
{
	TAILQ_ENTRY( aio_workq_entry )	aio_workq_link;
	struct proc						*procp;		/* user proc that queued this request */
	user_addr_t						uaiocbp;  	/* pointer passed in from user land */
	user_addr_t						fsyncp;		/* not NULL means this request must complete */
												/* before an aio_fsync call can proceed. */
	vm_map_t						aio_map;	/* user land map we have a reference to */
	user_ssize_t					returnval;	/* return value from read / write request */	
	int								errorval;	/* error value from read / write request */
	int								flags;		
	long							group_tag;	/* identifier used to group IO requests */
	struct user_aiocb				aiocb;		/* copy of aiocb from user land */
};
typedef struct aio_workq_entry aio_workq_entry;

/*
 * definitions for aio_workq_entry.flags
 */
#define	AIO_READ		0x00000001	
#define	AIO_WRITE		0x00000002
#define	AIO_FSYNC		0x00000004	/* aio_fsync with op = O_SYNC */
#define	AIO_DSYNC		0x00000008	/* aio_fsync with op = O_DSYNC (not supported yet) */
#define	AIO_LIO			0x00000010	/* lio_listio generated IO */
#define	AIO_DO_FREE		0x00000800	/* entry needs to be freed */
#define	AIO_COMPLETION	0x00001000	/* entry is in completion processing (not freeable yet) */
#define	AIO_DISABLE		0x00002000	/* process is trying to exit or exec and we need */
									/* 	to disable normal completion notification */
#define	AIO_WAITING		0x00004000	/* process is trying to exit, exec, or close and is */
									/* 	waiting for one or more active IO requests to */
									/*	complete */

/*
 * Prototypes
 */

__private_extern__ void		
_aio_close(struct proc *p, int fd);

__private_extern__ void		
_aio_exit(struct proc *p);

__private_extern__ void		
_aio_exec(struct proc *p);

__private_extern__ void		
_aio_create_worker_threads(int num);

__private_extern__ void		
aio_init(void);

task_t						
get_aiotask(void);

#endif /* KERNEL */

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