osfmk/ipc/ipc_pset.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60 /*
  61  *      File:   ipc/ipc_pset.h
  62  *      Author: Rich Draves
  63  *      Date:   1989
  64  *
  65  *      Definitions for port sets.
  66  */
  67
  68 #ifndef _IPC_IPC_PSET_H_
  69 #define _IPC_IPC_PSET_H_
  70
  71 #include <mach/mach_types.h>
  72 #include <mach/port.h>
  73 #include <mach/kern_return.h>
  74 #include <kern/kern_types.h>
  75 #include <ipc/ipc_types.h>
  76 #include <ipc/ipc_object.h>
  77 #include <ipc/ipc_mqueue.h>
  78
  79 #include <mach_kdb.h>
  80
  81 struct ipc_pset {
  82
  83         /*
  84          * Initial sub-structure in common with all ipc_objects.
  85          */
  86         struct ipc_object       ips_object;
  87         struct ipc_mqueue       ips_messages;
  88 };
  89
  90 #define ips_references          ips_object.io_references
  91 #define ips_local_name          ips_object.io_receiver_name
  92
  93
  94 #define ips_active(pset)        io_active(&(pset)->ips_object)
  95 #define ips_lock(pset)          io_lock(&(pset)->ips_object)
  96 #define ips_lock_try(pset)      io_lock_try(&(pset)->ips_object)
  97 #define ips_unlock(pset)        io_unlock(&(pset)->ips_object)
  98 #define ips_check_unlock(pset)  io_check_unlock(&(pset)->ips_object)
  99 #define ips_reference(pset)     io_reference(&(pset)->ips_object)
 100 #define ips_release(pset)       io_release(&(pset)->ips_object)
 101
 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
 114 /* Add a port to a port set */
 115 extern kern_return_t ipc_pset_add(
 116         ipc_pset_t      pset,
 117         ipc_port_t      port);
 118
 119 /* determine if port is a member of set */
 120 extern boolean_t ipc_pset_member(
 121         ipc_pset_t      pset,
 122         ipc_port_t      port);
 123
 124 /* Remove a port from a port set */
 125 extern kern_return_t ipc_pset_remove(
 126         ipc_pset_t      pset,
 127         ipc_port_t      port);
 128
 129 /* Remove a port from all its current port sets */
 130 extern kern_return_t ipc_pset_remove_from_all(
 131         ipc_port_t      port);
 132
 133 /* Destroy a port_set */
 134 extern void ipc_pset_destroy(
 135         ipc_pset_t      pset);
 136
 137 #define ipc_pset_reference(pset)        \
 138                 ipc_object_reference(&(pset)->ips_object)
 139
 140 #define ipc_pset_release(pset)          \
 141                 ipc_object_release(&(pset)->ips_object)
 142
 143
 144 #if     MACH_KDB
 145 int ipc_list_count(struct ipc_kmsg *base);
 146 #endif  /* MACH_KDB */
 147
 148 #endif  /* _IPC_IPC_PSET_H_ */