configd.tproj/_configclose.c

   1 /*
   2  * Copyright (c) 2000, 2001, 2003, 2004, 2006-2010 Apple 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 24, 2000               Allan Nathanson <ajn@apple.com>
  31  * - initial revision
  32  */
  33
  34 #include <unistd.h>
  35
  36 #include "configd.h"
  37 #include "session.h"
  38
  39 #define N_QUICK 16
  40
  41 static Boolean
  42 isMySessionKey(CFStringRef sessionKey, CFStringRef key)
  43 {
  44         CFDictionaryRef dict;
  45         CFStringRef     storeSessionKey;
  46
  47         dict = CFDictionaryGetValue(storeData, key);
  48         if (!dict) {
  49                 /* if key no longer exists */
  50                 return FALSE;
  51         }
  52
  53         storeSessionKey = CFDictionaryGetValue(dict, kSCDSession);
  54         if (!storeSessionKey) {
  55                 /* if this is not a session key */
  56                 return FALSE;
  57         }
  58
  59         if (!CFEqual(sessionKey, storeSessionKey)) {
  60                 /* if this is not "my" session key */
  61                 return FALSE;
  62         }
  63
  64         return TRUE;
  65 }
  66
  67
  68 static void
  69 removeAllKeys(SCDynamicStoreRef store, Boolean isRegex)
  70 {
  71         SCDynamicStorePrivateRef        storePrivate    = (SCDynamicStorePrivateRef)store;
  72         CFArrayRef                      keys;
  73         CFIndex                         n;
  74
  75         keys = isRegex ? storePrivate->patterns : storePrivate->keys;
  76         n = (keys != NULL) ? CFArrayGetCount(keys) : 0;
  77         if (n > 0) {
  78                 CFIndex         i;
  79                 CFArrayRef      keysToRemove;
  80
  81                 keysToRemove = CFArrayCreateCopy(NULL, keys);
  82                 for (i = 0; i < n; i++) {
  83                         (void) __SCDynamicStoreRemoveWatchedKey(store,
  84                                                                 CFArrayGetValueAtIndex(keysToRemove, i),
  85                                                                 isRegex,
  86                                                                 TRUE);
  87                 }
  88                 CFRelease(keysToRemove);
  89         }
  90
  91         return;
  92 }
  93
  94
  95 __private_extern__
  96 int
  97 __SCDynamicStoreClose(SCDynamicStoreRef *store, Boolean internal)
  98 {
  99         CFDictionaryRef                 dict;
 100         CFArrayRef                      keys;
 101         CFIndex                         keyCnt;
 102         serverSessionRef                mySession;
 103         CFStringRef                     sessionKey;
 104         SCDynamicStorePrivateRef        storePrivate = (SCDynamicStorePrivateRef)*store;
 105
 106         if ((*store == NULL) || (storePrivate->server == MACH_PORT_NULL)) {
 107                 return kSCStatusNoStoreSession; /* you must have an open session to play */
 108         }
 109
 110         if (_configd_trace) {
 111                 SCTrace(TRUE, _configd_trace,
 112                         CFSTR("%s : %5d\n"),
 113                         internal ? "*close " : "close  ",
 114                         storePrivate->server);
 115         }
 116
 117         /* Remove all notification keys and patterns */
 118         removeAllKeys(*store, FALSE);   // keys
 119         removeAllKeys(*store, TRUE);    // patterns
 120
 121         /* Remove/cancel any outstanding notification requests. */
 122         __MACH_PORT_DEBUG(storePrivate->notifyPort != MACH_PORT_NULL, "*** __SCDynamicStoreClose", storePrivate->notifyPort);
 123         (void) __SCDynamicStoreNotifyCancel(*store);
 124
 125         /* Remove any session keys */
 126         sessionKey = CFStringCreateWithFormat(NULL, NULL, CFSTR("%d"), storePrivate->server);
 127         dict = CFDictionaryGetValue(sessionData, sessionKey);
 128         keys = CFDictionaryGetValue(dict, kSCDSessionKeys);
 129         if (keys && ((keyCnt = CFArrayGetCount(keys)) > 0)) {
 130                 Boolean wasLocked;
 131                 CFIndex i;
 132
 133                 /*
 134                  * if necessary, claim a lock to ensure that we inform
 135                  * any processes that a session key was removed.
 136                  */
 137                 wasLocked = (storeLocked > 0);
 138                 if (!wasLocked) {
 139                         (void) __SCDynamicStoreLock(*store, FALSE);
 140                 }
 141
 142                 /* remove keys from "locked" store" */
 143                 for (i = 0; i < keyCnt; i++) {
 144                         if (isMySessionKey(sessionKey, CFArrayGetValueAtIndex(keys, i))) {
 145                                 (void) __SCDynamicStoreRemoveValue(*store, CFArrayGetValueAtIndex(keys, i), TRUE);
 146                         }
 147                 }
 148
 149                 if (wasLocked) {
 150                         /* remove keys from "unlocked" store" */
 151                         _swapLockedStoreData();
 152                         for (i = 0; i < keyCnt; i++) {
 153                                 if (isMySessionKey(sessionKey, CFArrayGetValueAtIndex(keys, i)))
 154                                         (void) __SCDynamicStoreRemoveValue(*store, CFArrayGetValueAtIndex(keys, i), TRUE);
 155                         }
 156                         _swapLockedStoreData();
 157                 }
 158
 159                 /*
 160                  * Note: everyone who calls __SCDynamicStoreClose() ends
 161                  *       up removing this sessions dictionary. As such,
 162                  *       we don't need to worry about the session keys.
 163                  */
 164         }
 165         CFRelease(sessionKey);
 166
 167         /* release the lock */
 168         if (storePrivate->locked) {
 169                 (void) __SCDynamicStoreUnlock(*store, FALSE);
 170         }
 171
 172         /*
 173          * invalidate and release our run loop source on the server
 174          * port (for this client).  Then, release the port.
 175          */
 176         mySession = getSession(storePrivate->server);
 177         if (mySession->serverRunLoopSource) {
 178                 CFRunLoopSourceInvalidate(mySession->serverRunLoopSource);
 179                 CFRelease(mySession->serverRunLoopSource);
 180                 mySession->serverRunLoopSource = NULL;
 181         }
 182         if (mySession->serverPort != NULL) {
 183                 CFMachPortInvalidate(mySession->serverPort);
 184                 CFRelease(mySession->serverPort);
 185                 mySession->serverPort = NULL;
 186         }
 187
 188         storePrivate->server = MACH_PORT_NULL;
 189         CFRelease(*store);
 190         *store = NULL;
 191
 192         return kSCStatusOK;
 193 }
 194
 195
 196 __private_extern__
 197 kern_return_t
 198 _configclose(mach_port_t server, int *sc_status)
 199 {
 200         serverSessionRef        mySession = getSession(server);
 201
 202         if (mySession == NULL) {
 203                 *sc_status = kSCStatusNoStoreSession;   /* you must have an open session to play */
 204                 return KERN_SUCCESS;
 205         }
 206
 207         /*
 208          * Close the session.
 209          */
 210         __MACH_PORT_DEBUG(TRUE, "*** _configclose", server);
 211         *sc_status = __SCDynamicStoreClose(&mySession->store, FALSE);
 212         if (*sc_status != kSCStatusOK) {
 213                 SCLog(TRUE, LOG_ERR,
 214                       CFSTR("_configclose __SCDynamicStoreClose() failed, status = %s"),
 215                       SCErrorString(*sc_status));
 216                 return KERN_SUCCESS;
 217         }
 218         __MACH_PORT_DEBUG(TRUE, "*** _configclose (after __SCDynamicStoreClose)", server);
 219
 220         /*
 221          * Remove our receive right.
 222          *
 223          * Note: there is no need to cancel the notification request because the
 224          *       kernel will have no way to deliver the notification once the
 225          *       receive right has been removed.
 226          */
 227         (void) mach_port_mod_refs(mach_task_self(), server, MACH_PORT_RIGHT_RECEIVE, -1);
 228
 229         /*
 230          * Remove the session entry.
 231          */
 232         removeSession(server);
 233
 234         return KERN_SUCCESS;
 235 }