osfmk/ipc/ipc_pset.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  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/mach_types.h>
  64 #include <mach/port.h>
  65 #include <mach/kern_return.h>
  66 #include <kern/kern_types.h>
  67 #include <ipc/ipc_types.h>
  68 #include <ipc/ipc_object.h>
  69 #include <ipc/ipc_mqueue.h>
  70
  71 #include <mach_kdb.h>
  72
  73 struct ipc_pset {
  74
  75         /*
  76          * Initial sub-structure in common with all ipc_objects.
  77          */
  78         struct ipc_object       ips_object;
  79         struct ipc_mqueue       ips_messages;
  80 };
  81
  82 #define ips_references          ips_object.io_references
  83 #define ips_local_name          ips_object.io_receiver_name
  84
  85
  86 #define ips_active(pset)        io_active(&(pset)->ips_object)
  87 #define ips_lock(pset)          io_lock(&(pset)->ips_object)
  88 #define ips_lock_try(pset)      io_lock_try(&(pset)->ips_object)
  89 #define ips_unlock(pset)        io_unlock(&(pset)->ips_object)
  90 #define ips_check_unlock(pset)  io_check_unlock(&(pset)->ips_object)
  91 #define ips_reference(pset)     io_reference(&(pset)->ips_object)
  92 #define ips_release(pset)       io_release(&(pset)->ips_object)
  93
  94 /* Allocate a port set */
  95 extern kern_return_t ipc_pset_alloc(
  96         ipc_space_t             space,
  97         mach_port_name_t        *namep,
  98         ipc_pset_t              *psetp);
  99
 100 /* Allocate a port set, with a specific name */
 101 extern kern_return_t ipc_pset_alloc_name(
 102         ipc_space_t             space,
 103         mach_port_name_t        name,
 104         ipc_pset_t              *psetp);
 105
 106 /* Add a port to a port set */
 107 extern kern_return_t ipc_pset_add(
 108         ipc_pset_t      pset,
 109         ipc_port_t      port);
 110
 111 /* determine if port is a member of set */
 112 extern boolean_t ipc_pset_member(
 113         ipc_pset_t      pset,
 114         ipc_port_t      port);
 115
 116 /* Remove a port from a port set */
 117 extern kern_return_t ipc_pset_remove(
 118         ipc_pset_t      pset,
 119         ipc_port_t      port);
 120
 121 /* Remove a port from all its current port sets */
 122 extern kern_return_t ipc_pset_remove_from_all(
 123         ipc_port_t      port);
 124
 125 /* Destroy a port_set */
 126 extern void ipc_pset_destroy(
 127         ipc_pset_t      pset);
 128
 129 #define ipc_pset_reference(pset)        \
 130                 ipc_object_reference(&(pset)->ips_object)
 131
 132 #define ipc_pset_release(pset)          \
 133                 ipc_object_release(&(pset)->ips_object)
 134
 135
 136 #if     MACH_KDB
 137 int ipc_list_count(struct ipc_kmsg *base);
 138 #endif  /* MACH_KDB */
 139
 140 #endif  /* _IPC_IPC_PSET_H_ */