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

/*
 * Copyright (c) 2000 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@
 */
/*
 * @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/port.h>
#include <mach/kern_return.h>
#include <kern/ipc_kobject.h>
#include <ipc/ipc_object.h>
#include <ipc/ipc_mqueue.h>

#include <mach_kdb.h>

typedef struct ipc_pset {

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

#define	ips_references		ips_object.io_references
#define ips_local_name		ips_object.io_receiver_name

#define	IPS_NULL		((ipc_pset_t) IO_NULL)

#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_unlock(pset)	io_unlock(&(pset)->ips_object)
#define	ips_check_unlock(pset)	io_check_unlock(&(pset)->ips_object)
#define	ips_reference(pset)	io_reference(&(pset)->ips_object)
#define	ips_release(pset)	io_release(&(pset)->ips_object)

/* 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);

/* Add a port to a port set */
extern kern_return_t ipc_pset_add(
	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);

#define	ipc_pset_reference(pset)	\
		ipc_object_reference(&(pset)->ips_object)

#define	ipc_pset_release(pset)		\
		ipc_object_release(&(pset)->ips_object)


#if	MACH_KDB
int ipc_list_count(struct ipc_kmsg *base);
#endif	/* MACH_KDB */

#endif	/* _IPC_IPC_PSET_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
de355530 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.
1c79356b	11	*
de355530 A	12	* This Original Code and all software distributed under the License are
de355530 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
de355530 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.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* @OSF_COPYRIGHT@
	24	*/
	25	/*
	26	* Mach Operating System
	27	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	28	* All Rights Reserved.
	29	*
	30	* Permission to use, copy, modify and distribute this software and its
	31	* documentation is hereby granted, provided that both the copyright
	32	* notice and this permission notice appear in all copies of the
	33	* software, derivative works or modified versions, and any portions
	34	* thereof, and that both notices appear in supporting documentation.
	35	*
	36	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	37	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	38	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	39	*
	40	* Carnegie Mellon requests users of this software to return to
	41	*
	42	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	43	* School of Computer Science
	44	* Carnegie Mellon University
	45	* Pittsburgh PA 15213-3890
	46	*
	47	* any improvements or extensions that they make and grant Carnegie Mellon
	48	* the rights to redistribute these changes.
	49	*/
	50	/*
	51	*/
	52	/*
	53	* File: ipc/ipc_pset.h
	54	* Author: Rich Draves
	55	* Date: 1989
	56	*
	57	* Definitions for port sets.
	58	*/
	59
	60	#ifndef _IPC_IPC_PSET_H_
	61	#define _IPC_IPC_PSET_H_
	62
	63	#include <mach/port.h>
	64	#include <mach/kern_return.h>
	65	#include <kern/ipc_kobject.h>
	66	#include <ipc/ipc_object.h>
	67	#include <ipc/ipc_mqueue.h>
1c79356b A	68
	69	#include <mach_kdb.h>
	70
	71	typedef struct ipc_pset {
	72
	73	/*
	74	* Initial sub-structure in common with all ipc_objects.
	75	*/
	76	struct ipc_object ips_object;
1c79356b	77	struct ipc_mqueue ips_messages;
1c79356b A	78	} *ipc_pset_t;
1c79356b A	79
1c79356b A	80	#define ips_references ips_object.io_references
1c79356b A	81	#define ips_local_name ips_object.io_receiver_name
1c79356b A	82
	83	#define IPS_NULL ((ipc_pset_t) IO_NULL)
	84
	85	#define ips_active(pset) io_active(&(pset)->ips_object)
	86	#define ips_lock(pset) io_lock(&(pset)->ips_object)
	87	#define ips_lock_try(pset) io_lock_try(&(pset)->ips_object)
	88	#define ips_unlock(pset) io_unlock(&(pset)->ips_object)
	89	#define ips_check_unlock(pset) io_check_unlock(&(pset)->ips_object)
	90	#define ips_reference(pset) io_reference(&(pset)->ips_object)
	91	#define ips_release(pset) io_release(&(pset)->ips_object)
	92
	93	/* Allocate a port set */
	94	extern kern_return_t ipc_pset_alloc(
	95	ipc_space_t space,
	96	mach_port_name_t *namep,
	97	ipc_pset_t *psetp);
	98
	99	/* Allocate a port set, with a specific name */
	100	extern kern_return_t ipc_pset_alloc_name(
	101	ipc_space_t space,
	102	mach_port_name_t name,
	103	ipc_pset_t *psetp);
	104
	105	/* Add a port to a port set */
	106	extern kern_return_t ipc_pset_add(
	107	ipc_pset_t pset,
	108	ipc_port_t port);
	109
	110	/* Remove a port from a port set */
	111	extern kern_return_t ipc_pset_remove(
	112	ipc_pset_t pset,
	113	ipc_port_t port);
	114
	115	/* Remove a port from all its current port sets */
9bccf70c	116	extern kern_return_t ipc_pset_remove_from_all(
1c79356b A	117	ipc_port_t port);
	118
	119	/* Destroy a port_set */
	120	extern void ipc_pset_destroy(
	121	ipc_pset_t pset);
	122
	123	#define ipc_pset_reference(pset) \
	124	ipc_object_reference(&(pset)->ips_object)
	125
	126	#define ipc_pset_release(pset) \
	127	ipc_object_release(&(pset)->ips_object)
	128
	129
	130	#if MACH_KDB
	131	int ipc_list_count(struct ipc_kmsg *base);
	132	#endif /* MACH_KDB */
	133
	134	#endif /* _IPC_IPC_PSET_H_ */