SystemConfiguration.fproj/SCDNotifierWait.c

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * Modification History
  26  *
  27  * June 1, 2001                 Allan Nathanson <ajn@apple.com>
  28  * - public API conversion
  29  *
  30  * March 31, 2000               Allan Nathanson <ajn@apple.com>
  31  * - initial revision
  32  */
  33
  34 #include <mach/mach.h>
  35 #include <mach/mach_error.h>
  36
  37 #include <SystemConfiguration/SystemConfiguration.h>
  38 #include <SystemConfiguration/SCPrivate.h>
  39 #include "SCDynamicStoreInternal.h"
  40 #include "config.h"             /* MiG generated file */
  41
  42 static mach_msg_id_t
  43 waitForMachMessage(mach_port_t port)
  44 {
  45         kern_return_t           status;
  46         mach_msg_empty_rcv_t    *buf;
  47
  48         mach_msg_size_t         size = sizeof(mach_msg_empty_t) + MAX_TRAILER_SIZE;
  49
  50         status = vm_allocate(mach_task_self(), (vm_address_t *)&buf, size, TRUE);
  51         if (status != KERN_SUCCESS) {
  52                 SCLog(TRUE, LOG_DEBUG, CFSTR("waitForMachMessage vm_allocate(): %s"), mach_error_string(status));
  53                 return -1;
  54         }
  55
  56         status = mach_msg(&buf->header,                 /* msg */
  57                           MACH_RCV_MSG,                 /* options */
  58                           0,                            /* send_size */
  59                           size,                         /* rcv_size */
  60                           port,                         /* rcv_name */
  61                           MACH_MSG_TIMEOUT_NONE,        /* timeout */
  62                           MACH_PORT_NULL);              /* notify */
  63         if (status != KERN_SUCCESS) {
  64                 SCLog(TRUE, LOG_DEBUG, CFSTR("waitForMachMessage mach_msg(): %s"), mach_error_string(status));
  65                 return -1;
  66         }
  67
  68         return buf->header.msgh_id;
  69 }
  70
  71
  72 Boolean
  73 SCDynamicStoreNotifyWait(SCDynamicStoreRef store)
  74 {
  75         SCDynamicStorePrivateRef        storePrivate = (SCDynamicStorePrivateRef)store;
  76         kern_return_t                   status;
  77         mach_port_t                     port;
  78         mach_port_t                     oldNotify;
  79         int                             sc_status;
  80         mach_msg_id_t                   msgid;
  81
  82         if (store == NULL) {
  83                 /* sorry, you must provide a session */
  84                 _SCErrorSet(kSCStatusNoStoreSession);
  85                 return FALSE;
  86         }
  87
  88         if (storePrivate->server == MACH_PORT_NULL) {
  89                 /* sorry, you must have an open session to play */
  90                 _SCErrorSet(kSCStatusNoStoreServer);
  91                 return FALSE;
  92         }
  93
  94         if (storePrivate->notifyStatus != NotifierNotRegistered) {
  95                 /* sorry, you can only have one notification registered at once */
  96                 _SCErrorSet(kSCStatusNotifierActive);
  97                 return FALSE;
  98         }
  99
 100         /* Allocating port (for server response) */
 101         status = mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &port);
 102         if (status != KERN_SUCCESS) {
 103                 SCLog(TRUE, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait mach_port_allocate(): %s"), mach_error_string(status));
 104                 _SCErrorSet(status);
 105                 return FALSE;
 106         }
 107
 108         status = mach_port_insert_right(mach_task_self(),
 109                                         port,
 110                                         port,
 111                                         MACH_MSG_TYPE_MAKE_SEND);
 112         if (status != KERN_SUCCESS) {
 113                 SCLog(TRUE, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait mach_port_insert_right(): %s"), mach_error_string(status));
 114                 (void) mach_port_destroy(mach_task_self(), port);
 115                 _SCErrorSet(status);
 116                 return FALSE;
 117         }
 118
 119         /* Request a notification when/if the server dies */
 120         status = mach_port_request_notification(mach_task_self(),
 121                                                 port,
 122                                                 MACH_NOTIFY_NO_SENDERS,
 123                                                 1,
 124                                                 port,
 125                                                 MACH_MSG_TYPE_MAKE_SEND_ONCE,
 126                                                 &oldNotify);
 127         if (status != KERN_SUCCESS) {
 128                 SCLog(TRUE, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait mach_port_request_notification(): %s"), mach_error_string(status));
 129                 (void) mach_port_destroy(mach_task_self(), port);
 130                 _SCErrorSet(status);
 131                 return FALSE;
 132         }
 133
 134 #ifdef  DEBUG
 135         if (oldNotify != MACH_PORT_NULL) {
 136                 SCLog(TRUE, LOG_ERR, CFSTR("SCDynamicStoreNotifyWait(): why is oldNotify != MACH_PORT_NULL?"));
 137         }
 138 #endif  /* DEBUG */
 139
 140         status = notifyviaport(storePrivate->server,
 141                                port,
 142                                0,
 143                                (int *)&sc_status);
 144
 145         if (status != KERN_SUCCESS) {
 146 #ifdef  DEBUG
 147                 if (status != MACH_SEND_INVALID_DEST)
 148                         SCLog(TRUE, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait notifyviaport(): %s"), mach_error_string(status));
 149 #endif  /* DEBUG */
 150                 (void) mach_port_destroy(mach_task_self(), storePrivate->server);
 151                 storePrivate->server = MACH_PORT_NULL;
 152                 _SCErrorSet(status);
 153                 return FALSE;
 154         }
 155
 156         if (sc_status != kSCStatusOK) {
 157                 _SCErrorSet(sc_status);
 158                 return FALSE;
 159         }
 160
 161         /* set notifier active */
 162         storePrivate->notifyStatus = Using_NotifierWait;
 163
 164         msgid = waitForMachMessage(port);
 165
 166         /* set notifier inactive */
 167         storePrivate->notifyStatus = NotifierNotRegistered;
 168
 169         if (msgid == MACH_NOTIFY_NO_SENDERS) {
 170                 /* the server closed the notifier port */
 171 #ifdef  DEBUG
 172                 SCLog(_sc_verbose, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait notifier port closed, destroying port %d"), port);
 173 #endif  /* DEBUG */
 174                 _SCErrorSet(kSCStatusNoStoreServer);
 175                 return FALSE;
 176         }
 177
 178         if (msgid == -1) {
 179                 /* one of the mach routines returned an error */
 180 #ifdef  DEBUG
 181                 SCLog(_sc_verbose, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait communication with server failed, destroying port %d"), port);
 182 #endif  /* DEBUG */
 183                 (void) mach_port_destroy(mach_task_self(), port);
 184                 _SCErrorSet(kSCStatusNoStoreServer);
 185                 return FALSE;
 186         }
 187
 188         // something changed, cancelling notification request
 189         status = notifycancel(storePrivate->server,
 190                               (int *)&sc_status);
 191
 192         if (status != KERN_SUCCESS) {
 193 #ifdef  DEBUG
 194                 if (status != MACH_SEND_INVALID_DEST)
 195                         SCLog(_sc_verbose, LOG_DEBUG, CFSTR("SCDynamicStoreNotifyWait notifycancel(): %s"), mach_error_string(status));
 196 #endif  /* DEBUG */
 197                 (void) mach_port_destroy(mach_task_self(), storePrivate->server);
 198                 storePrivate->server = MACH_PORT_NULL;
 199                 _SCErrorSet(status);
 200                 return FALSE;
 201         }
 202
 203         (void) mach_port_destroy(mach_task_self(), port);
 204
 205         return TRUE;
 206 }