osfmk/ipc/ipc_pset.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_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 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.
  14  *
  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
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  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
  69 #include <mach/mach_types.h>
  70 #include <mach/port.h>
  71 #include <mach/kern_return.h>
  72 #include <kern/kern_types.h>
  73 #include <ipc/ipc_types.h>
  74 #include <ipc/ipc_object.h>
  75 #include <ipc/ipc_mqueue.h>
  76
  77 struct ipc_pset {
  78         /*
  79          * Initial sub-structure in common with all ipc_objects.
  80          */
  81         struct ipc_object       ips_object;
  82         struct ipc_mqueue       ips_messages;
  83 };
  84
  85 #define ips_references          ips_object.io_references
  86
  87 #define ips_active(pset)        io_active(&(pset)->ips_object)
  88 #define ips_lock(pset)          io_lock(&(pset)->ips_object)
  89 #define ips_lock_try(pset)      io_lock_try(&(pset)->ips_object)
  90 #define ips_lock_held_kdp(pset) io_lock_held_kdp(&(pset)->ips_object)
  91 #define ips_unlock(pset)        io_unlock(&(pset)->ips_object)
  92 #define ips_reference(pset)     io_reference(&(pset)->ips_object)
  93 #define ips_release(pset)       io_release(&(pset)->ips_object)
  94
  95 /* get an ipc_pset pointer from an ipc_mqueue pointer */
  96 #define ips_from_mq(mq) \
  97                 __container_of(mq, struct ipc_pset, ips_messages)
  98
  99 /* Allocate a port set */
 100 extern kern_return_t ipc_pset_alloc(
 101         ipc_space_t             space,
 102         mach_port_name_t        *namep,
 103         ipc_pset_t              *psetp);
 104
 105 /* Allocate a port set, with a specific name */
 106 extern kern_return_t ipc_pset_alloc_name(
 107         ipc_space_t             space,
 108         mach_port_name_t        name,
 109         ipc_pset_t              *psetp);
 110
 111 /* Allocate a port set in a special space */
 112 extern ipc_pset_t ipc_pset_alloc_special(
 113         ipc_space_t             space);
 114
 115 /* Add a port to a port set */
 116 extern kern_return_t ipc_pset_add(
 117         ipc_pset_t      pset,
 118         ipc_port_t      port,
 119         uint64_t        *reserved_link,
 120         uint64_t        *reserved_prepost);
 121
 122 /* determine if port is a member of set */
 123 extern boolean_t ipc_pset_member(
 124         ipc_pset_t      pset,
 125         ipc_port_t      port);
 126
 127 /* Remove a port from a port set */
 128 extern kern_return_t ipc_pset_remove(
 129         ipc_pset_t      pset,
 130         ipc_port_t      port);
 131
 132 /* lazily initialize the wqset of a port set */
 133 extern kern_return_t ipc_pset_lazy_allocate(
 134         ipc_space_t      space,
 135         mach_port_name_t psname);
 136
 137 /* Remove a port from all its current port sets */
 138 extern kern_return_t ipc_pset_remove_from_all(
 139         ipc_port_t      port);
 140
 141 /* Destroy a port_set */
 142 extern void ipc_pset_destroy(
 143         ipc_space_t     space,
 144         ipc_pset_t      pset);
 145
 146 #if MACH_KERNEL_PRIVATE
 147 extern struct turnstile *filt_machport_kqueue_turnstile(
 148         struct knote *kn);
 149
 150 extern struct turnstile *filt_machport_stashed_special_reply_port_turnstile(
 151         ipc_port_t port);
 152
 153 extern void filt_machport_turnstile_prepare_lazily(
 154         struct knote *kn,
 155         mach_msg_type_name_t    msgt_name,
 156         ipc_port_t port);
 157
 158 extern struct turnstile *filt_machport_stash_port(
 159         struct knote *kn,
 160         ipc_port_t port,
 161         int *link);
 162 #endif
 163
 164 #endif  /* _IPC_IPC_PSET_H_ */