xnu-6153.61.1.tar.gz

[apple/xnu.git] / iokit / Kernel / RootDomainUserClient.cpp

diff --git a/iokit/Kernel/RootDomainUserClient.cpp b/iokit/Kernel/RootDomainUserClient.cpp
index 923831637eb3ced0831771bcf6ebfc7d5bf827a9..632b97ae550e5aee6b065414446a36511a14831c 100644 (file)
--- a/iokit/Kernel/RootDomainUserClient.cpp
+++ b/iokit/Kernel/RootDomainUserClient.cpp
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2012 Apple Computer, Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @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
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * 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,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * 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@

  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.


@@ -26,9 +32,12 @@
 
 #include <IOKit/assert.h>
 #include <IOKit/IOLib.h>
 
 #include <IOKit/assert.h>
 #include <IOKit/IOLib.h>

+#include <IOKit/IOKitKeys.h>

 #include <IOKit/IOBufferMemoryDescriptor.h>
 #include "RootDomainUserClient.h"
 #include <IOKit/pwr_mgt/IOPMLibDefs.h>
 #include <IOKit/IOBufferMemoryDescriptor.h>
 #include "RootDomainUserClient.h"
 #include <IOKit/pwr_mgt/IOPMLibDefs.h>

+#include <IOKit/pwr_mgt/IOPMPrivate.h>
+#include <sys/proc.h>

 
 #define super IOUserClient
 
 
 #define super IOUserClient
 


@@ -38,133 +47,351 @@ OSDefineMetaClassAndStructors(RootDomainUserClient, IOUserClient)
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 

-bool RootDomainUserClient::initWithTask(task_t owningTask, void *security_id, UInt32)
+bool
+RootDomainUserClient::initWithTask(task_t owningTask, void *security_id,
+    UInt32 type, OSDictionary * properties)

 {
 {

-    if (!super::init())
-       return false;
+       if (properties) {
+               properties->setObject(kIOUserClientCrossEndianCompatibleKey, kOSBooleanTrue);
+       }

 
 

-    fOwningTask = owningTask;
-    task_reference (fOwningTask);    
-    return true;
+       if (!super::initWithTask(owningTask, security_id, type, properties)) {
+               return false;
+       }
+
+       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 )
+{
+       return secureSleepSystemOptions(NULL, 0, return_code);

 }
 
 }
 

-IOReturn RootDomainUserClient::secureSleepSystem( int *return_code )
+IOReturn
+RootDomainUserClient::secureSleepSystemOptions(
+       const void      *inOptions,
+       IOByteCount     inOptionsSize,
+       uint32_t        *returnCode)

 {
 {

-    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->sleepSystem();
-        return kIOReturnSuccess;
-    } 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) {
+               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);
-        return kIOReturnSuccess;
-    } 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)
+{
+       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::clientClose( void )
+IOReturn
+RootDomainUserClient::secureSetUserAssertionLevels(
+       uint32_t    assertionBitfield)

 {
 {

-    detach(fOwner);
-    
-    if(fOwningTask) {
-        task_deallocate(fOwningTask);
-        fOwningTask = 0;
-    }   
-    
-    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;

 }
 
 }
 

-IOExternalMethod *
-RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 index )
+IOReturn
+RootDomainUserClient::secureGetSystemSleepType(
+       uint32_t    *outSleepType, uint32_t *sleepTimer)

 {
 {

-    static IOExternalMethod sMethods[] = {
-        { // kPMSetAggressiveness, 0
-            1, (IOMethod)&RootDomainUserClient::secureSetAggressiveness, kIOUCScalarIScalarO, 2, 1
-        },
-        { // kPMGetAggressiveness, 1
-            0, (IOMethod)&IOPMrootDomain::getAggressiveness, kIOUCScalarIScalarO, 1, 1
-        },
-        { // kPMSleepSystem, 2
-            1, (IOMethod)&RootDomainUserClient::secureSleepSystem, kIOUCScalarIScalarO, 0, 1
-        },
-        { // kPMAllowPowerChange, 3
-            0, (IOMethod)&IOPMrootDomain::allowPowerChange, kIOUCScalarIScalarO, 1, 0
-        },
-        { // kPMCancelPowerChange, 4
-            0, (IOMethod)&IOPMrootDomain::cancelPowerChange, kIOUCScalarIScalarO, 1, 0
-        },
-        { // kPMShutdownSystem, 5
-            0, (IOMethod)&IOPMrootDomain::shutdownSystem, kIOUCScalarIScalarO, 0, 0
-        },
-        { // kPMRestartSystem, 6
-            0, (IOMethod)&IOPMrootDomain::restartSystem, kIOUCScalarIScalarO, 0, 0
-        },
-        { // kPMSetPreventative, 7
-            1, (IOMethod) &RootDomainUserClient::setPreventative, kIOUCScalarIScalarO, 2, 0
-        },
-    };
-    
-    if(index >= kNumPMMethods)
-       return NULL;
-    else {
-        if (sMethods[index].object)
-            *targetP = this;
-        else
-            *targetP = fOwner;
-
-        return &sMethods[index];
-    }
+       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;

 }
 
 }
 

-void 
-RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep)
+IOReturn
+RootDomainUserClient::clientClose( void )

 {
 {

-    return;
+       terminate();
+
+       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    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;
+#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;
+}
+
+/* getTargetAndMethodForIndex
+ * Not used. We prefer to use externalMethod() for user client invocations.
+ * We maintain getTargetAndExternalMethod since it's an exported symbol,
+ * and only for that reason.
+ */
+IOExternalMethod *
+RootDomainUserClient::getTargetAndMethodForIndex(
+       IOService ** targetP, UInt32 index )
+{
+       // DO NOT EDIT
+       return super::getTargetAndMethodForIndex(targetP, index);
+}
+
+/* setPreventative
+ * Does nothing. Exists only for exported symbol compatibility.
+ */
+void
+RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep)
+{
+       return;
+}           // DO NOT EDIT