]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/Kernel/RootDomainUserClient.cpp
xnu-6153.61.1.tar.gz
[apple/xnu.git] / iokit / Kernel / RootDomainUserClient.cpp
index ae122f4c1494b218e69b15de9379c550ad578fcd..632b97ae550e5aee6b065414446a36511a14831c 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1998-2012 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- * 
+ *
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
- * 
+ *
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
- * 
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -22,7 +22,7 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
+ *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
@@ -47,321 +47,331 @@ OSDefineMetaClassAndStructors(RootDomainUserClient, IOUserClient)
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-bool RootDomainUserClient::initWithTask(task_t owningTask, void *security_id,
-                    UInt32 type, OSDictionary * properties)
+bool
+RootDomainUserClient::initWithTask(task_t owningTask, void *security_id,
+    UInt32 type, OSDictionary * properties)
 {
-    if (properties)
-    properties->setObject(kIOUserClientCrossEndianCompatibleKey, kOSBooleanTrue);
+       if (properties) {
+               properties->setObject(kIOUserClientCrossEndianCompatibleKey, kOSBooleanTrue);
+       }
 
-    if (!super::initWithTask(owningTask, security_id, type, properties))
-    return false;
+       if (!super::initWithTask(owningTask, security_id, type, properties)) {
+               return false;
+       }
 
-    fOwningTask = owningTask;
-    task_reference (fOwningTask);
-    return true;
+       fOwningTask = owningTask;
+       task_reference(fOwningTask);
+       return true;
 }
 
 
-bool RootDomainUserClient::start( IOService * provider )
+bool
+RootDomainUserClient::start( IOService * provider )
 {
-    assert(OSDynamicCast(IOPMrootDomain, provider));
-    if(!super::start(provider))
-        return false;
-    fOwner = (IOPMrootDomain *)provider;
+       assert(OSDynamicCast(IOPMrootDomain, provider));
+       if (!super::start(provider)) {
+               return false;
+       }
+       fOwner = (IOPMrootDomain *)provider;
 
 
-    return true;
+       return true;
 }
 
-IOReturn RootDomainUserClient::secureSleepSystem( uint32_t *return_code )
+IOReturn
+RootDomainUserClient::secureSleepSystem( uint32_t *return_code )
 {
-    return secureSleepSystemOptions(NULL, 0, return_code);
+       return secureSleepSystemOptions(NULL, 0, return_code);
 }
 
-IOReturn RootDomainUserClient::secureSleepSystemOptions(
-    const void      *inOptions,
-    IOByteCount     inOptionsSize,
-    uint32_t        *returnCode)
+IOReturn
+RootDomainUserClient::secureSleepSystemOptions(
+       const void      *inOptions,
+       IOByteCount     inOptionsSize,
+       uint32_t        *returnCode)
 {
-
-    int             local_priv = 0;
-    int             admin_priv = 0;
-    IOReturn        ret = kIOReturnNotPrivileged;
-    OSDictionary    *unserializedOptions =  NULL;
-    OSString        *unserializeErrorString = NULL;
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeLocalUser);
-    local_priv = (kIOReturnSuccess == ret);
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-    admin_priv = (kIOReturnSuccess == ret);
-
-
-    if (inOptions)
-    {
-        unserializedOptions = OSDynamicCast( OSDictionary,
-                                             OSUnserializeXML((const char *)inOptions, inOptionsSize, &unserializeErrorString));
-
-        if (!unserializedOptions) {
-            IOLog("IOPMRootDomain SleepSystem unserialization failure: %s\n",
-                unserializeErrorString ? unserializeErrorString->getCStringNoCopy() : "Unknown");
-        }
-    }
-
-    if ( (local_priv || admin_priv) && fOwner )
-    {
-        proc_t p;
-        p = (proc_t)get_bsdtask_info(fOwningTask);
-        if (p) {
-            fOwner->setProperty("SleepRequestedByPID", proc_pid(p), 32);
-        }
-
-        if (unserializedOptions)
-        {
-            // Publish Sleep Options in registry under root_domain
-            fOwner->setProperty( kRootDomainSleepOptionsKey, unserializedOptions);
-
-            *returnCode = fOwner->sleepSystemOptions( unserializedOptions );
-
-            unserializedOptions->release();
-        } else {
-            // No options
-            // Clear any pre-existing options
-            fOwner->removeProperty( kRootDomainSleepOptionsKey );
-
-            *returnCode = fOwner->sleepSystemOptions( NULL );
-        }
-
-    } else {
-        *returnCode = kIOReturnNotPrivileged;
-    }
-
-    return kIOReturnSuccess;
+       int             local_priv = 0;
+       int             admin_priv = 0;
+       IOReturn        ret = kIOReturnNotPrivileged;
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeLocalUser);
+       local_priv = (kIOReturnSuccess == ret);
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+       admin_priv = (kIOReturnSuccess == ret);
+
+       if ((local_priv || admin_priv) && fOwner) {
+               OSString        *unserializeErrorString = NULL;
+               OSObject        *unserializedObject = NULL;
+               OSDictionary    *sleepOptionsDict = NULL; // do not release
+
+               proc_t p;
+               p = (proc_t)get_bsdtask_info(fOwningTask);
+               if (p) {
+                       fOwner->setProperty("SleepRequestedByPID", proc_pid(p), 32);
+               }
+
+               if (inOptions) {
+                       unserializedObject = OSUnserializeXML((const char *)inOptions, inOptionsSize, &unserializeErrorString);
+                       sleepOptionsDict = OSDynamicCast( OSDictionary, unserializedObject);
+                       if (!sleepOptionsDict) {
+                               IOLog("IOPMRootDomain SleepSystem unserialization failure: %s\n",
+                                   unserializeErrorString ? unserializeErrorString->getCStringNoCopy() : "Unknown");
+                       }
+               }
+
+               if (sleepOptionsDict) {
+                       // Publish Sleep Options in registry under root_domain
+                       fOwner->setProperty( kRootDomainSleepOptionsKey, sleepOptionsDict);
+               } else {
+                       // No options
+                       // Clear any pre-existing options
+                       fOwner->removeProperty( kRootDomainSleepOptionsKey );
+               }
+
+               *returnCode = fOwner->sleepSystemOptions( sleepOptionsDict );
+               OSSafeReleaseNULL(unserializedObject);
+               OSSafeReleaseNULL(unserializeErrorString);
+       } else {
+               *returnCode = kIOReturnNotPrivileged;
+       }
+
+       return kIOReturnSuccess;
 }
 
-IOReturn RootDomainUserClient::secureSetAggressiveness(
-    unsigned long   type,
-    unsigned long   newLevel,
-    int             *return_code )
+IOReturn
+RootDomainUserClient::secureSetAggressiveness(
+       unsigned long   type,
+       unsigned long   newLevel,
+       int             *return_code )
 {
-    int             local_priv = 0;
-    int             admin_priv = 0;
-    IOReturn        ret = kIOReturnNotPrivileged;
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeLocalUser);
-    local_priv = (kIOReturnSuccess == ret);
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-    admin_priv = (kIOReturnSuccess == ret);
-
-    if((local_priv || admin_priv) && fOwner) {
-        *return_code = fOwner->setAggressiveness(type, newLevel);
-    } else {
-        *return_code = kIOReturnNotPrivileged;
-    }
-    return kIOReturnSuccess;
+       int             local_priv = 0;
+       int             admin_priv = 0;
+       IOReturn        ret = kIOReturnNotPrivileged;
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeLocalUser);
+       local_priv = (kIOReturnSuccess == ret);
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+       admin_priv = (kIOReturnSuccess == ret);
+
+       if ((local_priv || admin_priv) && fOwner) {
+               *return_code = fOwner->setAggressiveness(type, newLevel);
+       } else {
+               *return_code = kIOReturnNotPrivileged;
+       }
+       return kIOReturnSuccess;
 }
 
-IOReturn RootDomainUserClient::secureSetMaintenanceWakeCalendar(
-    IOPMCalendarStruct      *inCalendar,
-    uint32_t                *returnCode)
+IOReturn
+RootDomainUserClient::secureSetMaintenanceWakeCalendar(
+       IOPMCalendarStruct      *inCalendar,
+       uint32_t                *returnCode)
 {
-    int                     admin_priv = 0;
-    IOReturn                ret = kIOReturnNotPrivileged;
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-    admin_priv = (kIOReturnSuccess == ret);
-
-    if (admin_priv && fOwner) {
-        *returnCode = fOwner->setMaintenanceWakeCalendar(inCalendar);
-    } else {
-        *returnCode = kIOReturnNotPrivileged;
-    }
-    return kIOReturnSuccess;
+       int                     admin_priv = 0;
+       IOReturn                ret = kIOReturnNotPrivileged;
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+       admin_priv = (kIOReturnSuccess == ret);
+
+       if (admin_priv && fOwner) {
+               *returnCode = fOwner->setMaintenanceWakeCalendar(inCalendar);
+       } else {
+               *returnCode = kIOReturnNotPrivileged;
+       }
+       return kIOReturnSuccess;
 }
 
-IOReturn RootDomainUserClient::secureSetUserAssertionLevels(
-    uint32_t    assertionBitfield)
+IOReturn
+RootDomainUserClient::secureSetUserAssertionLevels(
+       uint32_t    assertionBitfield)
 {
-    int                     admin_priv = 0;
-    IOReturn                ret = kIOReturnNotPrivileged;
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-    admin_priv = (kIOReturnSuccess == ret);
-
-    if (admin_priv && fOwner) {
-        ret = fOwner->setPMAssertionUserLevels(assertionBitfield);
-    } else {
-        ret = kIOReturnNotPrivileged;
-    }
-    return kIOReturnSuccess;
+       int                     admin_priv = 0;
+       IOReturn                ret = kIOReturnNotPrivileged;
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+       admin_priv = (kIOReturnSuccess == ret);
+
+       if (admin_priv && fOwner) {
+               ret = fOwner->setPMAssertionUserLevels(assertionBitfield);
+       } else {
+               ret = kIOReturnNotPrivileged;
+       }
+       return kIOReturnSuccess;
 }
 
-IOReturn RootDomainUserClient::secureGetSystemSleepType(
-    uint32_t    *outSleepType)
+IOReturn
+RootDomainUserClient::secureGetSystemSleepType(
+       uint32_t    *outSleepType, uint32_t *sleepTimer)
 {
-    int                     admin_priv = 0;
-    IOReturn                ret;
-
-    ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-    admin_priv = (kIOReturnSuccess == ret);
-
-    if (admin_priv && fOwner) {
-        ret = fOwner->getSystemSleepType(outSleepType);
-    } else {
-        ret = kIOReturnNotPrivileged;
-    }
-    return ret;
+       int                     admin_priv = 0;
+       IOReturn                ret;
+
+       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+       admin_priv = (kIOReturnSuccess == ret);
+
+       if (admin_priv && fOwner) {
+               ret = fOwner->getSystemSleepType(outSleepType, sleepTimer);
+       } else {
+               ret = kIOReturnNotPrivileged;
+       }
+       return ret;
 }
 
-IOReturn RootDomainUserClient::clientClose( void )
+IOReturn
+RootDomainUserClient::clientClose( void )
 {
-    detach(fOwner);
+       terminate();
 
-    if(fOwningTask) {
-        task_deallocate(fOwningTask);
-        fOwningTask = 0;
-    }
+       return kIOReturnSuccess;
+}
 
-    return kIOReturnSuccess;
+void
+RootDomainUserClient::stop( IOService *provider)
+{
+       if (fOwningTask) {
+               task_deallocate(fOwningTask);
+               fOwningTask = NULL;
+       }
+
+       super::stop(provider);
 }
 
-IOReturn RootDomainUserClient::externalMethod(
-    uint32_t selector,
-    IOExternalMethodArguments * arguments,
-    IOExternalMethodDispatch * dispatch __unused,
-    OSObject * target __unused,
-    void * reference __unused )
+IOReturn
+RootDomainUserClient::externalMethod(
+       uint32_t selector,
+       IOExternalMethodArguments * arguments,
+       IOExternalMethodDispatch * dispatch __unused,
+       OSObject * target __unused,
+       void * reference __unused )
 {
-    IOReturn    ret = kIOReturnBadArgument;
-
-    switch (selector)
-    {
-        case kPMSetAggressiveness:
-            if ((2 == arguments->scalarInputCount)
-                && (1 == arguments->scalarOutputCount))
-            {
-                ret = this->secureSetAggressiveness(
-                                (unsigned long)arguments->scalarInput[0],
-                                (unsigned long)arguments->scalarInput[1],
-                                (int *)&arguments->scalarOutput[0]);
-            }
-            break;
-
-        case kPMGetAggressiveness:
-            if ((1 == arguments->scalarInputCount)
-                && (1 == arguments->scalarOutputCount))
-            {
-                ret = fOwner->getAggressiveness(
-                                (unsigned long)arguments->scalarInput[0],
-                                (unsigned long *)&arguments->scalarOutput[0]);
-            }
-            break;
-
-        case kPMSleepSystem:
-            if (1 == arguments->scalarOutputCount)
-            {
-                ret = this->secureSleepSystem(
-                                (uint32_t *)&arguments->scalarOutput[0]);
-            }
-            break;
-
-        case kPMAllowPowerChange:
-            if (1 == arguments->scalarInputCount)
-            {
-                ret = fOwner->allowPowerChange(
-                                arguments->scalarInput[0]);
-            }
-            break;
-
-        case kPMCancelPowerChange:
-            if (1 == arguments->scalarInputCount)
-            {
-                ret = fOwner->cancelPowerChange(
-                                arguments->scalarInput[0]);
-            }
-            break;
-
-        case kPMShutdownSystem:
-            // deperecated interface
-            ret = kIOReturnUnsupported;
-            break;
-
-        case kPMRestartSystem:
-            // deperecated interface
-            ret = kIOReturnUnsupported;
-            break;
-
-        case kPMSleepSystemOptions:
-            ret = this->secureSleepSystemOptions(
-                    arguments->structureInput,
-                    arguments->structureInputSize,
-                    (uint32_t *)&arguments->scalarOutput[0]);
-            break;
-        case kPMSetMaintenanceWakeCalendar:
-            ret = this->secureSetMaintenanceWakeCalendar(
-                    (IOPMCalendarStruct *)arguments->structureInput,
-                    (uint32_t *)&arguments->structureOutput);
-            arguments->structureOutputSize = sizeof(uint32_t);
-            break;
-
-        case kPMSetUserAssertionLevels:
-            ret = this->secureSetUserAssertionLevels(
-                        (uint32_t)arguments->scalarInput[0]);
-            break;
-
-        case kPMActivityTickle:
-            if ( fOwner->checkSystemCanSustainFullWake() )
-            {
-               fOwner->reportUserInput( );
-               fOwner->setProperty(kIOPMRootDomainWakeTypeKey, "UserActivity Assertion");
-            }
-            ret = kIOReturnSuccess;
-            break;
-
-        case kPMSetClamshellSleepState:
-            fOwner->setDisableClamShellSleep(arguments->scalarInput[0] ? true : false);
-            ret = kIOReturnSuccess;
-            break;
-
-        case kPMGetSystemSleepType:
-            if (1 == arguments->scalarOutputCount)
-            {
-                ret = this->secureGetSystemSleepType(
-                        (uint32_t *) &arguments->scalarOutput[0]);
-            }
-            break;
+       IOReturn    ret = kIOReturnBadArgument;
+
+       switch (selector) {
+       case kPMSetAggressiveness:
+               if ((2 == arguments->scalarInputCount)
+                   && (1 == arguments->scalarOutputCount)) {
+                       ret = this->secureSetAggressiveness(
+                               (unsigned long)arguments->scalarInput[0],
+                               (unsigned long)arguments->scalarInput[1],
+                               (int *)&arguments->scalarOutput[0]);
+               }
+               break;
+
+       case kPMGetAggressiveness:
+               if ((1 == arguments->scalarInputCount)
+                   && (1 == arguments->scalarOutputCount)) {
+                       ret = fOwner->getAggressiveness(
+                               (unsigned long)arguments->scalarInput[0],
+                               (unsigned long *)&arguments->scalarOutput[0]);
+               }
+               break;
+
+       case kPMSleepSystem:
+               if (1 == arguments->scalarOutputCount) {
+                       ret = this->secureSleepSystem(
+                               (uint32_t *)&arguments->scalarOutput[0]);
+               }
+               break;
+
+       case kPMAllowPowerChange:
+               if (1 == arguments->scalarInputCount) {
+                       ret = fOwner->allowPowerChange(
+                               arguments->scalarInput[0]);
+               }
+               break;
+
+       case kPMCancelPowerChange:
+               if (1 == arguments->scalarInputCount) {
+                       ret = fOwner->cancelPowerChange(
+                               arguments->scalarInput[0]);
+               }
+               break;
+
+       case kPMShutdownSystem:
+               // deperecated interface
+               ret = kIOReturnUnsupported;
+               break;
+
+       case kPMRestartSystem:
+               // deperecated interface
+               ret = kIOReturnUnsupported;
+               break;
+
+       case kPMSleepSystemOptions:
+               ret = this->secureSleepSystemOptions(
+                       arguments->structureInput,
+                       arguments->structureInputSize,
+                       (uint32_t *)&arguments->scalarOutput[0]);
+               break;
+       case kPMSetMaintenanceWakeCalendar:
+               if ((arguments->structureInputSize >= sizeof(IOPMCalendarStruct)) &&
+                   (arguments->structureOutputSize >= sizeof(uint32_t))) {
+                       ret = this->secureSetMaintenanceWakeCalendar(
+                               (IOPMCalendarStruct *)arguments->structureInput,
+                               (uint32_t *)&arguments->structureOutput);
+                       arguments->structureOutputSize = sizeof(uint32_t);
+               }
+               break;
+
+       case kPMSetUserAssertionLevels:
+               ret = this->secureSetUserAssertionLevels(
+                       (uint32_t)arguments->scalarInput[0]);
+               break;
+
+       case kPMActivityTickle:
+               if (fOwner->checkSystemCanSustainFullWake()) {
+                       fOwner->reportUserInput();
+                       fOwner->setProperty(kIOPMRootDomainWakeTypeKey, "UserActivity Assertion");
+               }
+               ret = kIOReturnSuccess;
+               break;
+
+       case kPMSetClamshellSleepState:
+               fOwner->setDisableClamShellSleep(arguments->scalarInput[0] ? true : false);
+               ret = kIOReturnSuccess;
+               break;
+
+       case kPMGetSystemSleepType:
+               if (2 == arguments->scalarOutputCount) {
+                       ret = this->secureGetSystemSleepType(
+                               (uint32_t *) &arguments->scalarOutput[0],
+                               (uint32_t *) &arguments->scalarOutput[1]);
+               }
+               break;
 
 #if defined(__i386__) || defined(__x86_64__)
-        case kPMSleepWakeWatchdogEnable:
-            ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-            if (ret == kIOReturnSuccess)
-               fOwner->sleepWakeDebugEnableWdog();
-            break;
-
-
-        case kPMSleepWakeDebugTrig:
-            ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-            if (ret == kIOReturnSuccess)
-               fOwner->sleepWakeDebugTrig(false);
-            break;
+       case kPMSleepWakeWatchdogEnable:
+               ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+               if (ret == kIOReturnSuccess) {
+                       fOwner->sleepWakeDebugEnableWdog();
+               }
+               break;
+
+
+       case kPMSleepWakeDebugTrig:
+               ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+               if (ret == kIOReturnSuccess) {
+                       fOwner->sleepWakeDebugTrig(false);
+               }
+               break;
 #endif
 
-        case kPMSetDisplayPowerOn:
-            if (1 == arguments->scalarInputCount)
-            {
-                ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
-                if (ret == kIOReturnSuccess)
-                    fOwner->setDisplayPowerOn((uint32_t)arguments->scalarInput[0]);
-            }
-            break;
-
-        default:
-            // bad selector
-            return kIOReturnBadArgument;
-    }
-
-    return ret;
+       case kPMSetDisplayPowerOn:
+               if (1 == arguments->scalarInputCount) {
+                       ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator);
+                       if (ret == kIOReturnSuccess) {
+                               fOwner->setDisplayPowerOn((uint32_t)arguments->scalarInput[0]);
+                       }
+               }
+               break;
+
+       default:
+               // bad selector
+               return kIOReturnBadArgument;
+       }
+
+       return ret;
 }
 
 /* getTargetAndMethodForIndex
@@ -369,11 +379,12 @@ IOReturn RootDomainUserClient::externalMethod(
  * We maintain getTargetAndExternalMethod since it's an exported symbol,
  * and only for that reason.
  */
-IOExternalMethod * RootDomainUserClient::getTargetAndMethodForIndex(
-    IOService ** targetP, UInt32 index )
+IOExternalMethod *
+RootDomainUserClient::getTargetAndMethodForIndex(
+       IOService ** targetP, UInt32 index )
 {
-    // DO NOT EDIT
-    return super::getTargetAndMethodForIndex(targetP, index);
+       // DO NOT EDIT
+       return super::getTargetAndMethodForIndex(targetP, index);
 }
 
 /* setPreventative
@@ -381,4 +392,6 @@ IOExternalMethod * RootDomainUserClient::getTargetAndMethodForIndex(
  */
 void
 RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep)
-{ return; } // DO NOT EDIT
+{
+       return;
+}           // DO NOT EDIT