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

/*
 * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1996 John S. Dyson
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice immediately at the beginning of the file, without modification,
 *    this list of conditions, and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Absolutely no warranty of function or purpose is made by the author
 *    John S. Dyson.
 * 4. This work was done expressly for inclusion into FreeBSD.  Other use
 *    is allowed if this notation is included.
 * 5. Modifications may be freely made to this file if the above conditions
 *    are met.
 *
 * $FreeBSD: src/sys/sys/pipe.h,v 1.24 2003/08/13 20:01:38 alc Exp $
 */
/*
 * NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 */

#ifndef _SYS_PIPE_H_
#define _SYS_PIPE_H_

#ifdef	KERNEL
#include <libkern/locks.h>
#endif
#include <sys/queue.h>			/* for TAILQ macros */
#include <sys/ev.h>
#include <sys/cdefs.h>

/*
 * Pipe buffer size, keep moderate in value, pipes take kva space.
 */
#ifndef PIPE_SIZE
#define PIPE_SIZE	16384
#endif

#define PIPE_KVAMAX	(1024 * 1024 * 16)

#ifndef BIG_PIPE_SIZE
#define BIG_PIPE_SIZE	(64*1024)
#endif

#ifndef SMALL_PIPE_SIZE
#define SMALL_PIPE_SIZE	PAGE_SIZE
#endif

/*
 * PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
 * than PIPE_BUF.
 */
#ifndef PIPE_MINDIRECT
#define PIPE_MINDIRECT	8192
#endif

#define PIPENPAGES	(BIG_PIPE_SIZE / PAGE_SIZE + 1)

/*
 * Pipe buffer information.
 * Separate in, out, cnt are used to simplify calculations.
 * Buffered write is active when the buffer.cnt field is set.
 */
struct pipebuf {
	u_int	cnt;		/* number of chars currently in buffer */
	u_int	in;		/* in pointer */
	u_int	out;		/* out pointer */
	u_int	size;		/* size of buffer */
	caddr_t	buffer;		/* kva of buffer */
};


#ifdef PIPE_DIRECT
/*
 * Information to support direct transfers between processes for pipes.
 */
struct pipemapping {
	vm_offset_t	kva;		/* kernel virtual address */
	vm_size_t	cnt;		/* number of chars in buffer */
	vm_size_t	pos;		/* current position of transfer */
	int		npages;		/* number of pages */
	vm_page_t	ms[PIPENPAGES];	/* pages in source process */
};
#endif

/*
 * Bits in pipe_state.
 */
#define PIPE_ASYNC	0x004	/* Async? I/O. */
#define PIPE_WANTR	0x008	/* Reader wants some characters. */
#define PIPE_WANTW	0x010	/* Writer wants space to put characters. */
#define PIPE_WANT	0x020	/* Pipe is wanted to be run-down. */
#define PIPE_SEL	0x040	/* Pipe has a select active. */
#define PIPE_EOF	0x080	/* Pipe is in EOF condition. */
#define PIPE_LOCKFL	0x100	/* Process has exclusive access to pointers/data. */
#define PIPE_LWANT	0x200	/* Process wants exclusive access to pointers/data. */
#define PIPE_DIRECTW	0x400	/* Pipe direct write active. */
#define PIPE_DIRECTOK	0x800	/* Direct mode ok. */
#define PIPE_KNOTE	0x1000   /* Pipe has kernel events activated */
#define PIPE_DRAIN	0x2000  /* Waiting for I/O to drop for a close.  Treated like EOF;
					only separate for easier debugging. */
#define PIPE_WSELECT	0x4000  /* Some thread has done an FWRITE select on the pipe */
#define PIPE_DEAD	0x8000  /* Pipe is dead and needs garbage collection */

#ifdef	KERNEL

struct label;

/*
 * Per-pipe data structure.
 * Two of these are linked together to produce bi-directional pipes.
 */
struct pipe {
	struct	pipebuf pipe_buffer;	/* data storage */
#ifdef PIPE_DIRECT
	struct	pipemapping pipe_map;	/* pipe mapping for direct I/O */
#endif
	struct	selinfo pipe_sel;	/* for compat with select */
	pid_t	pipe_pgid;		/* information for async I/O */
	struct	pipe *pipe_peer;	/* link with other direction */
	u_int	pipe_state;		/* pipe status info */
	int	pipe_busy;		/* busy flag, mostly to handle rundown sanely */
	TAILQ_HEAD(,eventqelt) pipe_evlist;
	lck_mtx_t *pipe_mtxp;		/* shared mutex between both pipes */
	struct	timespec st_atimespec;	/* time of last access */
	struct	timespec st_mtimespec;	/* time of last data modification */
	struct	timespec st_ctimespec;	/* time of last status change */
	struct	label *pipe_label;	/* pipe MAC label - shared */
};

#define PIPE_MTX(pipe)		((pipe)->pipe_mtxp)

#define PIPE_LOCK(pipe)		lck_mtx_lock(PIPE_MTX(pipe))
#define PIPE_UNLOCK(pipe)	lck_mtx_unlock(PIPE_MTX(pipe))
#define PIPE_LOCK_ASSERT(pipe, type)  lck_mtx_assert(PIPE_MTX(pipe), (type))

__BEGIN_DECLS
void pipeinit(void);
extern int pipe_stat(struct pipe *, void *, int);
__END_DECLS

#endif	/* KERNEL */

#endif /* !_SYS_PIPE_H_ */
Commit	Line	Data
91447636 A	1	/*
	2	* Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636 A	27	*/
	28	/*
	29	* Copyright (c) 1996 John S. Dyson
	30	* All rights reserved.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice immediately at the beginning of the file, without modification,
	37	* this list of conditions, and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. Absolutely no warranty of function or purpose is made by the author
	42	* John S. Dyson.
	43	* 4. This work was done expressly for inclusion into FreeBSD. Other use
	44	* is allowed if this notation is included.
	45	* 5. Modifications may be freely made to this file if the above conditions
	46	* are met.
	47	*
	48	* $FreeBSD: src/sys/sys/pipe.h,v 1.24 2003/08/13 20:01:38 alc Exp $
	49	*/
2d21ac55 A	50	/*
	51	* NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce
	52	* support for mandatory and extensible security protections. This notice
	53	* is included in support of clause 2.2 (b) of the Apple Public License,
	54	* Version 2.0.
	55	*/
91447636 A	56
	57	#ifndef _SYS_PIPE_H_
	58	#define _SYS_PIPE_H_
	59
	60	#ifdef KERNEL
	61	#include <libkern/locks.h>
	62	#endif
	63	#include <sys/queue.h> /* for TAILQ macros */
	64	#include <sys/ev.h>
	65	#include <sys/cdefs.h>
	66
	67	/*
	68	* Pipe buffer size, keep moderate in value, pipes take kva space.
	69	*/
	70	#ifndef PIPE_SIZE
	71	#define PIPE_SIZE 16384
	72	#endif
	73
316670eb A	74	#define PIPE_KVAMAX (1024 * 1024 * 16)
316670eb A	75
91447636 A	76	#ifndef BIG_PIPE_SIZE
	77	#define BIG_PIPE_SIZE (64*1024)
	78	#endif
	79
	80	#ifndef SMALL_PIPE_SIZE
	81	#define SMALL_PIPE_SIZE PAGE_SIZE
	82	#endif
	83
	84	/*
	85	* PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
	86	* than PIPE_BUF.
	87	*/
	88	#ifndef PIPE_MINDIRECT
	89	#define PIPE_MINDIRECT 8192
	90	#endif
	91
	92	#define PIPENPAGES (BIG_PIPE_SIZE / PAGE_SIZE + 1)
	93
	94	/*
	95	* Pipe buffer information.
	96	* Separate in, out, cnt are used to simplify calculations.
	97	* Buffered write is active when the buffer.cnt field is set.
	98	*/
	99	struct pipebuf {
	100	u_int cnt; /* number of chars currently in buffer */
	101	u_int in; /* in pointer */
	102	u_int out; /* out pointer */
	103	u_int size; /* size of buffer */
	104	caddr_t buffer; /* kva of buffer */
	105	};
	106
	107
	108	#ifdef PIPE_DIRECT
	109	/*
	110	* Information to support direct transfers between processes for pipes.
	111	*/
91447636 A	112	struct pipemapping {
	113	vm_offset_t kva; /* kernel virtual address */
	114	vm_size_t cnt; /* number of chars in buffer */
	115	vm_size_t pos; /* current position of transfer */
	116	int npages; /* number of pages */
	117	vm_page_t ms[PIPENPAGES]; /* pages in source process */
	118	};
	119	#endif
	120
	121	/*
	122	* Bits in pipe_state.
	123	*/
	124	#define PIPE_ASYNC 0x004 /* Async? I/O. */
	125	#define PIPE_WANTR 0x008 /* Reader wants some characters. */
	126	#define PIPE_WANTW 0x010 /* Writer wants space to put characters. */
	127	#define PIPE_WANT 0x020 /* Pipe is wanted to be run-down. */
	128	#define PIPE_SEL 0x040 /* Pipe has a select active. */
	129	#define PIPE_EOF 0x080 /* Pipe is in EOF condition. */
	130	#define PIPE_LOCKFL 0x100 /* Process has exclusive access to pointers/data. */
	131	#define PIPE_LWANT 0x200 /* Process wants exclusive access to pointers/data. */
	132	#define PIPE_DIRECTW 0x400 /* Pipe direct write active. */
	133	#define PIPE_DIRECTOK 0x800 /* Direct mode ok. */
b0d623f7 A	134	#define PIPE_KNOTE 0x1000 /* Pipe has kernel events activated */
	135	#define PIPE_DRAIN 0x2000 /* Waiting for I/O to drop for a close. Treated like EOF;
	136	only separate for easier debugging. */
ebb1b9f4 A	137	#define PIPE_WSELECT 0x4000 /* Some thread has done an FWRITE select on the pipe */
ebb1b9f4 A	138	#define PIPE_DEAD 0x8000 /* Pipe is dead and needs garbage collection */
91447636 A	139
91447636 A	140	#ifdef KERNEL
2d21ac55 A	141
	142	struct label;
	143
91447636 A	144	/*
	145	* Per-pipe data structure.
	146	* Two of these are linked together to produce bi-directional pipes.
	147	*/
	148	struct pipe {
	149	struct pipebuf pipe_buffer; /* data storage */
	150	#ifdef PIPE_DIRECT
	151	struct pipemapping pipe_map; /* pipe mapping for direct I/O */
	152	#endif
	153	struct selinfo pipe_sel; /* for compat with select */
	154	pid_t pipe_pgid; /* information for async I/O */
	155	struct pipe pipe_peer; / link with other direction */
	156	u_int pipe_state; /* pipe status info */
	157	int pipe_busy; /* busy flag, mostly to handle rundown sanely */
91447636 A	158	TAILQ_HEAD(,eventqelt) pipe_evlist;
91447636 A	159	lck_mtx_t pipe_mtxp; / shared mutex between both pipes */
2d21ac55 A	160	struct timespec st_atimespec; /* time of last access */
	161	struct timespec st_mtimespec; /* time of last data modification */
	162	struct timespec st_ctimespec; /* time of last status change */
	163	struct label pipe_label; / pipe MAC label - shared */
91447636 A	164	};
	165
	166	#define PIPE_MTX(pipe) ((pipe)->pipe_mtxp)
	167
	168	#define PIPE_LOCK(pipe) lck_mtx_lock(PIPE_MTX(pipe))
	169	#define PIPE_UNLOCK(pipe) lck_mtx_unlock(PIPE_MTX(pipe))
	170	#define PIPE_LOCK_ASSERT(pipe, type) lck_mtx_assert(PIPE_MTX(pipe), (type))
	171
	172	__BEGIN_DECLS
2d21ac55 A	173	void pipeinit(void);
2d21ac55 A	174	extern int pipe_stat(struct pipe , void , int);
91447636 A	175	__END_DECLS
	176
	177	#endif /* KERNEL */
	178
	179	#endif /* !_SYS_PIPE_H_ */