[apple/xnu.git] / osfmk / ipc / ipc_pset.h

/*
 * Copyright (c) 2000-2004 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@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	ipc/ipc_pset.h
 *	Author:	Rich Draves
 *	Date:	1989
 *
 *	Definitions for port sets.
 */

#ifndef	_IPC_IPC_PSET_H_
#define _IPC_IPC_PSET_H_

#include <mach/mach_types.h>
#include <mach/port.h>
#include <mach/kern_return.h>
#include <kern/kern_types.h>
#include <ipc/ipc_types.h>
#include <ipc/ipc_object.h>
#include <ipc/ipc_mqueue.h>

struct ipc_pset {

	/*
	 * Initial sub-structure in common with all ipc_objects.
	 */
	struct ipc_object	ips_object;
	struct ipc_mqueue	ips_messages;
};

#define	ips_references		ips_object.io_references

#define	ips_active(pset)	io_active(&(pset)->ips_object)
#define	ips_lock(pset)		io_lock(&(pset)->ips_object)
#define	ips_lock_try(pset)	io_lock_try(&(pset)->ips_object)
#define ips_lock_held_kdp(pset)	io_lock_held_kdp(&(pset)->ips_object)
#define	ips_unlock(pset)	io_unlock(&(pset)->ips_object)
#define	ips_reference(pset)	io_reference(&(pset)->ips_object)
#define	ips_release(pset)	io_release(&(pset)->ips_object)

/* get an ipc_pset pointer from an ipc_mqueue pointer */
#define	ips_from_mq(mq)		((struct ipc_pset *)((void *)( \
					(char *)(mq) - \
					__offsetof(struct ipc_pset, ips_messages)) \
				))

/* Allocate a port set */
extern kern_return_t ipc_pset_alloc(
	ipc_space_t		space,
	mach_port_name_t	*namep,
	ipc_pset_t		*psetp);

/* Allocate a port set, with a specific name */
extern kern_return_t ipc_pset_alloc_name(
	ipc_space_t		space,
	mach_port_name_t	name,
	ipc_pset_t		*psetp);

/* Allocate a port set in a special space */
extern ipc_pset_t ipc_pset_alloc_special(
	ipc_space_t		space);

/* Add a port to a port set */
extern kern_return_t ipc_pset_add(
	ipc_pset_t	pset,
	ipc_port_t	port,
	uint64_t	*reserved_link,
	uint64_t	*reserved_prepost);

/* determine if port is a member of set */
extern boolean_t ipc_pset_member(
	ipc_pset_t	pset,
	ipc_port_t	port);

/* Remove a port from a port set */
extern kern_return_t ipc_pset_remove(
	ipc_pset_t	pset,
	ipc_port_t	port);

/* Remove a port from all its current port sets */
extern kern_return_t ipc_pset_remove_from_all(
	ipc_port_t	port);

/* Destroy a port_set */
extern void ipc_pset_destroy(
	ipc_pset_t	pset);

#endif	/* _IPC_IPC_PSET_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58	/*
	59	* File: ipc/ipc_pset.h
	60	* Author: Rich Draves
	61	* Date: 1989
	62	*
	63	* Definitions for port sets.
	64	*/
	65
	66	#ifndef _IPC_IPC_PSET_H_
	67	#define _IPC_IPC_PSET_H_
	68
91447636	69	#include <mach/mach_types.h>
1c79356b A	70	#include <mach/port.h>
1c79356b A	71	#include <mach/kern_return.h>
91447636 A	72	#include <kern/kern_types.h>
91447636 A	73	#include <ipc/ipc_types.h>
1c79356b A	74	#include <ipc/ipc_object.h>
1c79356b A	75	#include <ipc/ipc_mqueue.h>
1c79356b	76
91447636	77	struct ipc_pset {
1c79356b A	78
	79	/*
	80	* Initial sub-structure in common with all ipc_objects.
	81	*/
	82	struct ipc_object ips_object;
1c79356b	83	struct ipc_mqueue ips_messages;
91447636	84	};
1c79356b	85
1c79356b	86	#define ips_references ips_object.io_references
1c79356b A	87
	88	#define ips_active(pset) io_active(&(pset)->ips_object)
	89	#define ips_lock(pset) io_lock(&(pset)->ips_object)
	90	#define ips_lock_try(pset) io_lock_try(&(pset)->ips_object)
813fb2f6	91	#define ips_lock_held_kdp(pset) io_lock_held_kdp(&(pset)->ips_object)
1c79356b	92	#define ips_unlock(pset) io_unlock(&(pset)->ips_object)
1c79356b A	93	#define ips_reference(pset) io_reference(&(pset)->ips_object)
	94	#define ips_release(pset) io_release(&(pset)->ips_object)
	95
813fb2f6 A	96	/* get an ipc_pset pointer from an ipc_mqueue pointer */
	97	#define ips_from_mq(mq) ((struct ipc_pset )((void )( \
	98	(char *)(mq) - \
	99	__offsetof(struct ipc_pset, ips_messages)) \
	100	))
	101
1c79356b A	102	/* Allocate a port set */
	103	extern kern_return_t ipc_pset_alloc(
	104	ipc_space_t space,
	105	mach_port_name_t *namep,
	106	ipc_pset_t *psetp);
	107
	108	/* Allocate a port set, with a specific name */
	109	extern kern_return_t ipc_pset_alloc_name(
	110	ipc_space_t space,
	111	mach_port_name_t name,
	112	ipc_pset_t *psetp);
	113
39037602 A	114	/* Allocate a port set in a special space */
	115	extern ipc_pset_t ipc_pset_alloc_special(
	116	ipc_space_t space);
	117
1c79356b A	118	/* Add a port to a port set */
	119	extern kern_return_t ipc_pset_add(
	120	ipc_pset_t pset,
316670eb	121	ipc_port_t port,
3e170ce0 A	122	uint64_t *reserved_link,
3e170ce0 A	123	uint64_t *reserved_prepost);
1c79356b	124
91447636 A	125	/* determine if port is a member of set */
	126	extern boolean_t ipc_pset_member(
	127	ipc_pset_t pset,
	128	ipc_port_t port);
	129
1c79356b A	130	/* Remove a port from a port set */
	131	extern kern_return_t ipc_pset_remove(
	132	ipc_pset_t pset,
3e170ce0	133	ipc_port_t port);
1c79356b A	134
1c79356b A	135	/* Remove a port from all its current port sets */
9bccf70c	136	extern kern_return_t ipc_pset_remove_from_all(
3e170ce0	137	ipc_port_t port);
1c79356b A	138
	139	/* Destroy a port_set */
	140	extern void ipc_pset_destroy(
	141	ipc_pset_t pset);
	142
1c79356b	143	#endif /* _IPC_IPC_PSET_H_ */