xnu-1228.9.59.tar.gz

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

diff --git a/iokit/Kernel/RootDomainUserClient.cpp b/iokit/Kernel/RootDomainUserClient.cpp
index d28948a310051e22593452ff8a1be9b69d11bebe..170ab0eaef04b27ed629ab3682f69cad3e0b3e97 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-2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_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 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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.
+ * 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_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

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


@@ -26,6 +32,7 @@
 
 #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>


@@ -38,6 +45,21 @@ OSDefineMetaClassAndStructors(RootDomainUserClient, IOUserClient)
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 

+bool RootDomainUserClient::initWithTask(task_t owningTask, void *security_id, 
+                                       UInt32 type, OSDictionary * properties)
+{
+    if (properties)
+       properties->setObject(kIOUserClientCrossEndianCompatibleKey, kOSBooleanTrue);
+
+    if (!super::initWithTask(owningTask, security_id, type, properties))
+       return false;
+
+    fOwningTask = owningTask;
+    task_reference (fOwningTask);    
+    return true;
+}
+
+

 bool RootDomainUserClient::start( IOService * provider )
 {
     assert(OSDynamicCast(IOPMrootDomain, provider));
 bool RootDomainUserClient::start( IOService * provider )
 {
     assert(OSDynamicCast(IOPMrootDomain, provider));


@@ -49,25 +71,127 @@ bool RootDomainUserClient::start( IOService * provider )
     return true;
 }
 
     return true;
 }
 

+IOReturn RootDomainUserClient::secureSleepSystem( uint32_t *return_code )
+{
+    IOByteCount     return_code_size = 1;
+
+    return secureSleepSystemOptions( NULL,      // inOptions
+                                     (void *)return_code, // returnCode
+                                     (void *)0,     // inSize
+                                     (void *)&return_code_size, // returnSize
+                                     NULL, NULL);
+}
+
+IOReturn RootDomainUserClient::secureSleepSystemOptions( 
+    void * p1, void * p2, void * p3,
+    void * p4, void * p5, void * p6 )
+{
+    void            *inOptions = (void *)p1; 
+    uint32_t        *returnCode = (uint32_t *)p2;
+    IOByteCount     inOptionsSize = (IOByteCount)p3;
+    IOByteCount     *returnCodeSize = (IOByteCount *)p4;
+
+    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);
+    
+    *returnCodeSize = sizeof(uint32_t);
+    
+    if (inOptions)
+    {
+        unserializedOptions = OSDynamicCast( OSDictionary,
+                                             OSUnserializeXML((const char *)inOptions, &unserializeErrorString));
+    
+        if (!unserializedOptions) {
+            IOLog("IOPMRootDomain SleepSystem unserialization failure: %s\n", 
+                unserializeErrorString ? unserializeErrorString->getCStringNoCopy() : "Unknown");
+        }
+    }
+
+    if ( (local_priv || admin_priv) 
+          && fOwner ) 
+    {
+        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;
+}
+
+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;
+    }
+
+}
+

 
 IOReturn RootDomainUserClient::clientClose( void )
 {
     detach(fOwner);
 
 IOReturn RootDomainUserClient::clientClose( void )
 {
     detach(fOwner);

+    
+    if(fOwningTask) {
+        task_deallocate(fOwningTask);
+        fOwningTask = 0;
+    }   
+    

     return kIOReturnSuccess;
 }
 
 IOExternalMethod *
 RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 index )
 {
     return kIOReturnSuccess;
 }
 
 IOExternalMethod *
 RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 index )
 {

-    static IOExternalMethod sMethods[] = {
+    static const IOExternalMethod sMethods[] = {

         { // kPMSetAggressiveness, 0
         { // kPMSetAggressiveness, 0

-            0, (IOMethod)&IOPMrootDomain::setAggressiveness, kIOUCScalarIScalarO, 2, 0
+            (IOService *)1, (IOMethod)&RootDomainUserClient::secureSetAggressiveness, kIOUCScalarIScalarO, 2, 1

         },
         { // kPMGetAggressiveness, 1
             0, (IOMethod)&IOPMrootDomain::getAggressiveness, kIOUCScalarIScalarO, 1, 1
         },
         { // kPMSleepSystem, 2
         },
         { // kPMGetAggressiveness, 1
             0, (IOMethod)&IOPMrootDomain::getAggressiveness, kIOUCScalarIScalarO, 1, 1
         },
         { // kPMSleepSystem, 2

-            0, (IOMethod)&IOPMrootDomain::sleepSystem, kIOUCScalarIScalarO, 0, 0
+            (IOService *)1, (IOMethod)&RootDomainUserClient::secureSleepSystem, kIOUCScalarIScalarO, 0, 1

         },
         { // kPMAllowPowerChange, 3
             0, (IOMethod)&IOPMrootDomain::allowPowerChange, kIOUCScalarIScalarO, 1, 0
         },
         { // kPMAllowPowerChange, 3
             0, (IOMethod)&IOPMrootDomain::allowPowerChange, kIOUCScalarIScalarO, 1, 0


@@ -81,11 +205,12 @@ RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 i
         { // kPMRestartSystem, 6
             0, (IOMethod)&IOPMrootDomain::restartSystem, kIOUCScalarIScalarO, 0, 0
         },
         { // kPMRestartSystem, 6
             0, (IOMethod)&IOPMrootDomain::restartSystem, kIOUCScalarIScalarO, 0, 0
         },

-        { // kPMSetPreventative, 7
-            1, (IOMethod) &RootDomainUserClient::setPreventative, kIOUCScalarIScalarO, 2, 0
-        },
+        { // kPMSleepSystemOptions, 7
+            (IOService *)1, (IOMethod)&RootDomainUserClient::secureSleepSystemOptions, 
+            kIOUCStructIStructO, kIOUCVariableStructureSize, sizeof(uint32_t)
+        }

     };
     };

-
+    

     if(index >= kNumPMMethods)
        return NULL;
     else {
     if(index >= kNumPMMethods)
        return NULL;
     else {


@@ -94,10 +219,53 @@ RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 i
         else
             *targetP = fOwner;
 
         else
             *targetP = fOwner;
 

-        return &sMethods[index];
+        return (IOExternalMethod *)&sMethods[index];

     }
 }
 
     }
 }
 

+#if 0
+IOReturn RootDomainUserClient::externalMethod( uint32_t selector, IOExternalMethodArguments * args,
+                                               IOExternalMethodDispatch * dispatch, OSObject * target, void * reference )
+{
+    static const IOExternalMethodDispatch sMethods[] = {
+        { // kPMSetAggressiveness, 0
+            (IOService *)1, (IOMethod)&RootDomainUserClient::secureSetAggressiveness, kIOUCScalarIScalarO, 2, 1
+        },
+        { // kPMGetAggressiveness, 1
+            0, (IOMethod)&IOPMrootDomain::getAggressiveness, kIOUCScalarIScalarO, 1, 1
+        },
+        { // kPMSleepSystem, 2
+            (IOService *)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
+            (IOService *)1, (IOMethod)&RootDomainUserClient::setPreventative, kIOUCScalarIScalarO, 2, 0
+        },
+    };
+
+    if (selector > (sizeof(sMethods) / sizeof(sMethods[0])))
+       return (kIOReturnBadArgument);
+
+    if ((1 << selector) & ((1 << 0) | (1 << 7))
+       target = this;
+    else
+       target = fOwner;
+
+    return (super::externalMethod(selector, args, &sMethods[selector], target, 0));
+}
+#endif
+

 void 
 RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep)
 {
 void 
 RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep)
 {