X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/b0d623f7f2ae71ed96e60569f61f9a9a27016e80..c3c9b80d004dbbfdf763edeb97968c6997e3b45b:/iokit/Kernel/RootDomainUserClient.cpp diff --git a/iokit/Kernel/RootDomainUserClient.cpp b/iokit/Kernel/RootDomainUserClient.cpp index 8dbb20b0e..3fce5d5b0 100644 --- a/iokit/Kernel/RootDomainUserClient.cpp +++ b/iokit/Kernel/RootDomainUserClient.cpp @@ -1,8 +1,8 @@ /* - * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved. + * Copyright (c) 1998-2020 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 @@ -11,10 +11,10 @@ * 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@ */ /* @@ -36,6 +36,8 @@ #include #include "RootDomainUserClient.h" #include +#include +#include #define super IOUserClient @@ -45,260 +47,352 @@ 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 ) { - IOByteCount return_code_size = 1; + return secureSleepSystemOptions(NULL, 0, return_code); +} - return secureSleepSystemOptions( NULL, // inOptions - (void *)return_code, // returnCode - (void *)0, // inSize - (void *)&return_code_size, // returnSize - NULL, NULL); +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) { + 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::secureSleepSystemOptions( - void * p1, void * p2, void * p3, - void * p4, void * p5, void * p6 ) +IOReturn +RootDomainUserClient::secureSetAggressiveness( + unsigned long type, + unsigned long newLevel, + int *return_code ) { - void *inOptions = (void *)p1; - uint32_t *returnCode = (uint32_t *)p2; -// IOByteCount inOptionsSize = (uintptr_t)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; + 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::secureSetAggressiveness( - unsigned long type, - unsigned long newLevel, - int *return_code ) +IOReturn +RootDomainUserClient::secureSetMaintenanceWakeCalendar( + IOPMCalendarStruct *inCalendar, + 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->setAggressiveness(type, newLevel); - return kIOReturnSuccess; - } else { - *return_code = 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::secureSetMaintenanceWakeCalendar( - void * p1, void * p2, void * p3, - void * p4, void * p5, void * p6 ) +IOReturn +RootDomainUserClient::secureSetUserAssertionLevels( + uint32_t assertionBitfield) { -#if ROOT_DOMAIN_RUN_STATES - IOPMCalendarStruct * inCalendar = (IOPMCalendarStruct *) p1; - uint32_t * returnCode = (uint32_t *) p2; - IOByteCount * returnCodeSize = (IOByteCount *) p4; - int admin_priv = 0; - IOReturn ret = kIOReturnNotPrivileged; - - ret = clientHasPrivilege(fOwningTask, kIOClientPrivilegeAdministrator); - admin_priv = (kIOReturnSuccess == ret); - - *returnCodeSize = sizeof(uint32_t); - - if (admin_priv && fOwner) { - *returnCode = fOwner->setMaintenanceWakeCalendar(inCalendar); - return kIOReturnSuccess; - } else { - *returnCode = kIOReturnNotPrivileged; - return kIOReturnSuccess; - } -#else - return kIOReturnUnsupported; -#endif + 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::clientClose( void ) +IOReturn +RootDomainUserClient::secureGetSystemSleepType( + uint32_t *outSleepType, uint32_t *sleepTimer) { - detach(fOwner); - - if(fOwningTask) { - task_deallocate(fOwningTask); - fOwningTask = 0; - } - - return kIOReturnSuccess; + 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; } -IOExternalMethod * -RootDomainUserClient::getTargetAndMethodForIndex( IOService ** targetP, UInt32 index ) +IOReturn +RootDomainUserClient::clientClose( void ) { - static const IOExternalMethod 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 - }, - { // kPMSleepSystemOptions, 7 - (IOService *)1, (IOMethod)&RootDomainUserClient::secureSleepSystemOptions, - kIOUCStructIStructO, kIOUCVariableStructureSize, sizeof(uint32_t) - }, - { // kPMSetMaintenanceWakeCalendar, 8 - (IOService *)1, (IOMethod)&RootDomainUserClient::secureSetMaintenanceWakeCalendar, - kIOUCStructIStructO, sizeof(IOPMCalendarStruct), sizeof(uint32_t) - } - }; - - if(index >= kNumPMMethods) - return NULL; - else { - if (sMethods[index].object) - *targetP = this; - else - *targetP = fOwner; - - return (IOExternalMethod *)&sMethods[index]; - } + terminate(); + + return kIOReturnSuccess; } -#if 0 -IOReturn RootDomainUserClient::externalMethod( uint32_t selector, IOExternalMethodArguments * args, - IOExternalMethodDispatch * dispatch, OSObject * target, void * reference ) +void +RootDomainUserClient::stop( IOService *provider) { - 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)); + 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->setClamShellSleepDisable(arguments->scalarInput[0] ? true : false, + IOPMrootDomain::kClamshellSleepDisablePowerd); + 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 -void -RootDomainUserClient::setPreventative(UInt32 on_off, UInt32 types_of_sleep) + 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 ) { - return; + // 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