osfmk/ipc/ipc_notify.c

   1 /*
   2  * Copyright (c) 2000-2006 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_notify.c
  60  *      Author: Rich Draves
  61  *      Date:   1989
  62  *
  63  *      Notification-sending functions.
  64  */
  65
  66 #include <mach/port.h>
  67 #include <mach/message.h>
  68 #include <mach/mach_notify.h>
  69 #include <kern/misc_protos.h>
  70 #include <ipc/ipc_notify.h>
  71 #include <ipc/ipc_port.h>
  72
  73 /*
  74  *      Routine:        ipc_notify_port_deleted
  75  *      Purpose:
  76  *              Send a port-deleted notification.
  77  *      Conditions:
  78  *              Nothing locked.
  79  *              Consumes a ref/soright for port.
  80  */
  81
  82 void
  83 ipc_notify_port_deleted(
  84         ipc_port_t              port,
  85         mach_port_name_t        name)
  86 {
  87         (void)mach_notify_port_deleted(port, name);
  88         /* send-once right consumed */
  89 }
  90
  91 /*
  92  *      Routine:        ipc_notify_send_possible
  93  *      Purpose:
  94  *              Send a send-possible notification.
  95  *      Conditions:
  96  *              Nothing locked.
  97  *              Consumes a ref/soright for port.
  98  */
  99
 100 void
 101 ipc_notify_send_possible(
 102         ipc_port_t              port,
 103         mach_port_name_t        name)
 104 {
 105         (void)mach_notify_send_possible(port, name);
 106         /* send-once right consumed */
 107 }
 108
 109 /*
 110  *      Routine:        ipc_notify_port_destroyed
 111  *      Purpose:
 112  *              Send a port-destroyed notification.
 113  *      Conditions:
 114  *              Nothing locked.
 115  *              Consumes a ref/soright for port.
 116  *              Consumes a ref for right, which should be a receive right
 117  *              prepped for placement into a message.  (In-transit,
 118  *              or in-limbo if a circularity was detected.)
 119  */
 120
 121 void
 122 ipc_notify_port_destroyed(
 123         ipc_port_t      port,
 124         ipc_port_t      right)
 125 {
 126         mach_notify_port_destroyed(port, right);
 127         /* send-once and receive rights consumed */
 128 }
 129
 130 /*
 131  *      Routine:        ipc_notify_no_senders
 132  *      Purpose:
 133  *              Send a no-senders notification.
 134  *      Conditions:
 135  *              Nothing locked.
 136  *              Consumes a ref/soright for port.
 137  */
 138
 139 void
 140 ipc_notify_no_senders(
 141         ipc_port_t              port,
 142         mach_port_mscount_t     mscount)
 143 {
 144         (void)mach_notify_no_senders(port, mscount);
 145         /* send-once right consumed */
 146 }
 147
 148 /*
 149  *      Routine:        ipc_notify_send_once
 150  *      Purpose:
 151  *              Send a send-once notification.
 152  *      Conditions:
 153  *              Nothing locked.
 154  *              Consumes a ref/soright for port.
 155  */
 156
 157 void
 158 ipc_notify_send_once(
 159         ipc_port_t      port)
 160 {
 161         ipc_port_adjust_special_reply_port(port, IPC_PORT_ADJUST_RESET_BOOSTRAP_CHECKIN);
 162
 163         (void)mach_notify_send_once(port);
 164         /* send-once right consumed */
 165 }
 166
 167 /*
 168  *      Routine:        ipc_notify_dead_name
 169  *      Purpose:
 170  *              Send a dead-name notification.
 171  *      Conditions:
 172  *              Nothing locked.
 173  *              Consumes a ref/soright for port.
 174  */
 175
 176 void
 177 ipc_notify_dead_name(
 178         ipc_port_t              port,
 179         mach_port_name_t        name)
 180 {
 181         (void)mach_notify_dead_name(port, name);
 182         /* send-once right consumed */
 183 }