X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/39236c6e673c41db228275375ab7fdb0f837b292..4ba76501152d51ccb5647018f3192c6096367d48:/iokit/Kernel/IOPMrootDomain.cpp diff --git a/iokit/Kernel/IOPMrootDomain.cpp b/iokit/Kernel/IOPMrootDomain.cpp index d0c2d7d2c..c1114f9ec 100644 --- a/iokit/Kernel/IOPMrootDomain.cpp +++ b/iokit/Kernel/IOPMrootDomain.cpp @@ -1,8 +1,8 @@ /* - * Copyright (c) 1998-2008 Apple Inc. All rights reserved. + * Copyright (c) 1998-2019 Apple 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@ */ #include @@ -31,7 +31,9 @@ #include #include #include +#include #include +#include #include #include #include @@ -46,6 +48,9 @@ #include "IOPMPowerStateQueue.h" #include #include +#include +#include +#include "IOKitKernelInternal.h" #if HIBERNATION #include #endif @@ -55,25 +60,31 @@ #include #include #include +#include +#include +#include #include -#include "IOServicePrivate.h" // _IOServiceInterestNotifier +#include "IOServicePrivate.h" // _IOServiceInterestNotifier #include "IOServicePMPrivate.h" +#include + __BEGIN_DECLS #include +#include __END_DECLS #if defined(__i386__) || defined(__x86_64__) __BEGIN_DECLS #include "IOPMrootDomainInternal.h" +const char *processor_to_datastring(const char *prefix, processor_t target_processor); __END_DECLS #endif #define kIOPMrootDomainClass "IOPMrootDomain" #define LOG_PREFIX "PMRD: " -#define OBFUSCATE(x) ((void *)(VM_KERNEL_ADDRPERM(x))) #define MSG(x...) \ do { kprintf(LOG_PREFIX x); IOLog(x); } while (false) @@ -81,22 +92,39 @@ __END_DECLS #define LOG(x...) \ do { kprintf(LOG_PREFIX x); } while (false) +#if DEVELOPMENT || DEBUG +#define DEBUG_LOG(x...) do { \ + if (kIOLogPMRootDomain & gIOKitDebug) \ + kprintf(LOG_PREFIX x); \ + os_log_debug(OS_LOG_DEFAULT, LOG_PREFIX x); \ +} while (false) +#else +#define DEBUG_LOG(x...) +#endif + #define DLOG(x...) do { \ - if (kIOLogPMRootDomain & gIOKitDebug) \ - kprintf(LOG_PREFIX x); \ - gRootDomain->sleepWakeDebugLog(x);} while (false) + if (kIOLogPMRootDomain & gIOKitDebug) \ + kprintf(LOG_PREFIX x); \ + else \ + os_log(OS_LOG_DEFAULT, LOG_PREFIX x); \ +} while (false) + +#define DMSG(x...) do { \ + if (kIOLogPMRootDomain & gIOKitDebug) { \ + kprintf(LOG_PREFIX x); \ + } \ +} while (false) -#define _LOG(x...) -#define SUSPEND_PM_NOTIFICATIONS_DEBUG 1 +#define _LOG(x...) #define CHECK_THREAD_CONTEXT #ifdef CHECK_THREAD_CONTEXT -static IOWorkLoop * gIOPMWorkLoop = 0; +static IOWorkLoop * gIOPMWorkLoop = NULL; #define ASSERT_GATED() \ do { \ if (gIOPMWorkLoop && gIOPMWorkLoop->inGate() != true) { \ - panic("RootDomain: not inside PM gate"); \ + panic("RootDomain: not inside PM gate"); \ } \ } while(false) #else @@ -104,21 +132,21 @@ do { \ #endif /* CHECK_THREAD_CONTEXT */ #define CAP_LOSS(c) \ - (((_pendingCapability & (c)) == 0) && \ - ((_currentCapability & (c)) != 0)) + (((_pendingCapability & (c)) == 0) && \ + ((_currentCapability & (c)) != 0)) #define CAP_GAIN(c) \ - (((_currentCapability & (c)) == 0) && \ - ((_pendingCapability & (c)) != 0)) + (((_currentCapability & (c)) == 0) && \ + ((_pendingCapability & (c)) != 0)) #define CAP_CHANGE(c) \ - (((_currentCapability ^ _pendingCapability) & (c)) != 0) + (((_currentCapability ^ _pendingCapability) & (c)) != 0) #define CAP_CURRENT(c) \ - ((_currentCapability & (c)) != 0) + ((_currentCapability & (c)) != 0) #define CAP_HIGHEST(c) \ - ((_highestCapability & (c)) != 0) + ((_highestCapability & (c)) != 0) #if defined(__i386__) || defined(__x86_64__) #define DARK_TO_FULL_EVALUATE_CLAMSHELL 1 @@ -126,121 +154,212 @@ do { \ // Event types for IOPMPowerStateQueue::submitPowerEvent() enum { - kPowerEventFeatureChanged = 1, // 1 - kPowerEventReceivedPowerNotification, // 2 - kPowerEventSystemBootCompleted, // 3 - kPowerEventSystemShutdown, // 4 - kPowerEventUserDisabledSleep, // 5 - kPowerEventRegisterSystemCapabilityClient, // 6 - kPowerEventRegisterKernelCapabilityClient, // 7 - kPowerEventPolicyStimulus, // 8 - kPowerEventAssertionCreate, // 9 - kPowerEventAssertionRelease, // 10 - kPowerEventAssertionSetLevel, // 11 - kPowerEventQueueSleepWakeUUID, // 12 - kPowerEventPublishSleepWakeUUID, // 13 - kPowerEventSuspendClient, // 14 - kPowerEventSetDisplayPowerOn // 15 + kPowerEventFeatureChanged = 1, // 1 + kPowerEventReceivedPowerNotification, // 2 + kPowerEventSystemBootCompleted, // 3 + kPowerEventSystemShutdown, // 4 + kPowerEventUserDisabledSleep, // 5 + kPowerEventRegisterSystemCapabilityClient, // 6 + kPowerEventRegisterKernelCapabilityClient, // 7 + kPowerEventPolicyStimulus, // 8 + kPowerEventAssertionCreate, // 9 + kPowerEventAssertionRelease, // 10 + kPowerEventAssertionSetLevel, // 11 + kPowerEventQueueSleepWakeUUID, // 12 + kPowerEventPublishSleepWakeUUID, // 13 + kPowerEventSetDisplayPowerOn // 14 }; // For evaluatePolicy() // List of stimuli that affects the root domain policy. enum { - kStimulusDisplayWranglerSleep, // 0 - kStimulusDisplayWranglerWake, // 1 - kStimulusAggressivenessChanged, // 2 - kStimulusDemandSystemSleep, // 3 - kStimulusAllowSystemSleepChanged, // 4 - kStimulusDarkWakeActivityTickle, // 5 - kStimulusDarkWakeEntry, // 6 - kStimulusDarkWakeReentry, // 7 - kStimulusDarkWakeEvaluate, // 8 - kStimulusNoIdleSleepPreventers, // 9 - kStimulusUserIsActive, // 10 - kStimulusUserIsInactive // 11 + kStimulusDisplayWranglerSleep, // 0 + kStimulusDisplayWranglerWake, // 1 + kStimulusAggressivenessChanged, // 2 + kStimulusDemandSystemSleep, // 3 + kStimulusAllowSystemSleepChanged, // 4 + kStimulusDarkWakeActivityTickle, // 5 + kStimulusDarkWakeEntry, // 6 + kStimulusDarkWakeReentry, // 7 + kStimulusDarkWakeEvaluate, // 8 + kStimulusNoIdleSleepPreventers, // 9 + kStimulusEnterUserActiveState, // 10 + kStimulusLeaveUserActiveState // 11 }; extern "C" { IOReturn OSKextSystemSleepOrWake( UInt32 ); } -extern "C" ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va); -extern "C" addr64_t kvtophys(vm_offset_t va); -extern "C" int stack_snapshot_from_kernel(pid_t pid, void *buf, uint32_t size, uint32_t flags, unsigned *bytesTraced); +extern "C" ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va); +extern "C" addr64_t kvtophys(vm_offset_t va); +extern "C" boolean_t kdp_has_polled_corefile(); static void idleSleepTimerExpired( thread_call_param_t, thread_call_param_t ); -static void notifySystemShutdown( IOService * root, unsigned long event ); +static void notifySystemShutdown( IOService * root, uint32_t messageType ); static void handleAggressivesFunction( thread_call_param_t, thread_call_param_t ); static void pmEventTimeStamp(uint64_t *recordTS); +static void powerButtonUpCallout( thread_call_param_t, thread_call_param_t ); +static void powerButtonDownCallout( thread_call_param_t, thread_call_param_t ); + +static int IOPMConvertSecondsToCalendar(long secs, IOPMCalendarStruct * dt); +static long IOPMConvertCalendarToSeconds(const IOPMCalendarStruct * dt); +#define YMDTF "%04d/%02d/%d %02d:%02d:%02d" +#define YMDT(cal) ((int)(cal)->year), (cal)->month, (cal)->day, (cal)->hour, (cal)->minute, (cal)->second // "IOPMSetSleepSupported" callPlatformFunction name static const OSSymbol *sleepSupportedPEFunction = NULL; static const OSSymbol *sleepMessagePEFunction = NULL; +static const OSSymbol * gIOPMPSExternalConnectedKey; +static const OSSymbol * gIOPMPSExternalChargeCapableKey; +static const OSSymbol * gIOPMPSBatteryInstalledKey; +static const OSSymbol * gIOPMPSIsChargingKey; +static const OSSymbol * gIOPMPSAtWarnLevelKey; +static const OSSymbol * gIOPMPSAtCriticalLevelKey; +static const OSSymbol * gIOPMPSCurrentCapacityKey; +static const OSSymbol * gIOPMPSMaxCapacityKey; +static const OSSymbol * gIOPMPSDesignCapacityKey; +static const OSSymbol * gIOPMPSTimeRemainingKey; +static const OSSymbol * gIOPMPSAmperageKey; +static const OSSymbol * gIOPMPSVoltageKey; +static const OSSymbol * gIOPMPSCycleCountKey; +static const OSSymbol * gIOPMPSMaxErrKey; +static const OSSymbol * gIOPMPSAdapterInfoKey; +static const OSSymbol * gIOPMPSLocationKey; +static const OSSymbol * gIOPMPSErrorConditionKey; +static const OSSymbol * gIOPMPSManufacturerKey; +static const OSSymbol * gIOPMPSManufactureDateKey; +static const OSSymbol * gIOPMPSModelKey; +static const OSSymbol * gIOPMPSSerialKey; +static const OSSymbol * gIOPMPSLegacyBatteryInfoKey; +static const OSSymbol * gIOPMPSBatteryHealthKey; +static const OSSymbol * gIOPMPSHealthConfidenceKey; +static const OSSymbol * gIOPMPSCapacityEstimatedKey; +static const OSSymbol * gIOPMPSBatteryChargeStatusKey; +static const OSSymbol * gIOPMPSBatteryTemperatureKey; +static const OSSymbol * gIOPMPSAdapterDetailsKey; +static const OSSymbol * gIOPMPSChargerConfigurationKey; +static const OSSymbol * gIOPMPSAdapterDetailsIDKey; +static const OSSymbol * gIOPMPSAdapterDetailsWattsKey; +static const OSSymbol * gIOPMPSAdapterDetailsRevisionKey; +static const OSSymbol * gIOPMPSAdapterDetailsSerialNumberKey; +static const OSSymbol * gIOPMPSAdapterDetailsFamilyKey; +static const OSSymbol * gIOPMPSAdapterDetailsAmperageKey; +static const OSSymbol * gIOPMPSAdapterDetailsDescriptionKey; +static const OSSymbol * gIOPMPSAdapterDetailsPMUConfigurationKey; +static const OSSymbol * gIOPMPSAdapterDetailsSourceIDKey; +static const OSSymbol * gIOPMPSAdapterDetailsErrorFlagsKey; +static const OSSymbol * gIOPMPSAdapterDetailsSharedSourceKey; +static const OSSymbol * gIOPMPSAdapterDetailsCloakedKey; +static const OSSymbol * gIOPMPSInvalidWakeSecondsKey; +static const OSSymbol * gIOPMPSPostChargeWaitSecondsKey; +static const OSSymbol * gIOPMPSPostDishargeWaitSecondsKey; + #define kIOSleepSupportedKey "IOSleepSupported" #define kIOPMSystemCapabilitiesKey "System Capabilities" #define kIORequestWranglerIdleKey "IORequestIdle" -#define kDefaultWranglerIdlePeriod 25 // in milliseconds +#define kDefaultWranglerIdlePeriod 1000 // in milliseconds -#define kIOSleepWakeDebugKey "Persistent-memory-note" +#define kIOSleepWakeFailureString "SleepWakeFailureString" +#define kIOEFIBootRomFailureKey "wake-failure" +#define kIOSleepWakeFailurePanic "SleepWakeFailurePanic" #define kRD_AllPowerSources (kIOPMSupportedOnAC \ - | kIOPMSupportedOnBatt \ - | kIOPMSupportedOnUPS) - -enum -{ - // not idle around autowake time, secs - kAutoWakePreWindow = 45, - kAutoWakePostWindow = 15 -}; + | kIOPMSupportedOnBatt \ + | kIOPMSupportedOnUPS) #define kLocalEvalClamshellCommand (1 << 15) #define kIdleSleepRetryInterval (3 * 60) enum { - kWranglerPowerStateMin = 0, - kWranglerPowerStateSleep = 2, - kWranglerPowerStateDim = 3, - kWranglerPowerStateMax = 4 + kWranglerPowerStateMin = 0, + kWranglerPowerStateSleep = 2, + kWranglerPowerStateDim = 3, + kWranglerPowerStateMax = 4 }; enum { - OFF_STATE = 0, - RESTART_STATE = 1, - SLEEP_STATE = 2, - ON_STATE = 3, - NUM_POWER_STATES + OFF_STATE = 0, + RESTART_STATE = 1, + SLEEP_STATE = 2, + AOT_STATE = 3, + ON_STATE = 4, + NUM_POWER_STATES }; +const char * +getPowerStateString( uint32_t state ) +{ +#define POWER_STATE(x) {(uint32_t) x, #x} + + static const IONamedValue powerStates[] = { + POWER_STATE( OFF_STATE ), + POWER_STATE( RESTART_STATE ), + POWER_STATE( SLEEP_STATE ), + POWER_STATE( AOT_STATE ), + POWER_STATE( ON_STATE ), + { 0, NULL } + }; + return IOFindNameForValue(state, powerStates); +} + #define ON_POWER kIOPMPowerOn #define RESTART_POWER kIOPMRestart #define SLEEP_POWER kIOPMAuxPowerOn -static IOPMPowerState ourPowerStates[NUM_POWER_STATES] = -{ - {1, 0, 0, 0, 0,0,0,0,0,0,0,0}, - {1, kIOPMRestartCapability, kIOPMRestart, RESTART_POWER, 0,0,0,0,0,0,0,0}, - {1, kIOPMSleepCapability, kIOPMSleep, SLEEP_POWER, 0,0,0,0,0,0,0,0}, - {1, kIOPMPowerOn, kIOPMPowerOn, ON_POWER, 0,0,0,0,0,0,0,0} +static IOPMPowerState + ourPowerStates[NUM_POWER_STATES] = +{ + { .version = 1, + .capabilityFlags = 0, + .outputPowerCharacter = 0, + .inputPowerRequirement = 0 }, + { .version = 1, + .capabilityFlags = kIOPMRestartCapability, + .outputPowerCharacter = kIOPMRestart, + .inputPowerRequirement = RESTART_POWER }, + { .version = 1, + .capabilityFlags = kIOPMSleepCapability, + .outputPowerCharacter = kIOPMSleep, + .inputPowerRequirement = SLEEP_POWER }, + { .version = 1, +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + .capabilityFlags = kIOPMAOTCapability, + .outputPowerCharacter = kIOPMAOTPower, + .inputPowerRequirement = ON_POWER }, +#else /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + .capabilityFlags = 0, + .outputPowerCharacter = 0, + .inputPowerRequirement = 0xFFFFFFFF }, +#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + { .version = 1, + .capabilityFlags = kIOPMPowerOn, + .outputPowerCharacter = kIOPMPowerOn, + .inputPowerRequirement = ON_POWER }, }; -#define kIOPMRootDomainWakeTypeSleepService "SleepService" -#define kIOPMRootDomainWakeTypeMaintenance "Maintenance" -#define kIOPMRootDomainWakeTypeSleepTimer "SleepTimer" -#define kIOPMrootDomainWakeTypeLowBattery "LowBattery" -#define kIOPMRootDomainWakeTypeUser "User" -#define kIOPMRootDomainWakeTypeAlarm "Alarm" -#define kIOPMRootDomainWakeTypeNetwork "Network" -#define kIOPMRootDomainWakeTypeHIDActivity "HID Activity" -#define kIOPMRootDomainWakeTypeNotification "Notification" +#define kIOPMRootDomainWakeTypeSleepService "SleepService" +#define kIOPMRootDomainWakeTypeMaintenance "Maintenance" +#define kIOPMRootDomainWakeTypeSleepTimer "SleepTimer" +#define kIOPMrootDomainWakeTypeLowBattery "LowBattery" +#define kIOPMRootDomainWakeTypeUser "User" +#define kIOPMRootDomainWakeTypeAlarm "Alarm" +#define kIOPMRootDomainWakeTypeNetwork "Network" +#define kIOPMRootDomainWakeTypeHIDActivity "HID Activity" +#define kIOPMRootDomainWakeTypeNotification "Notification" +#define kIOPMRootDomainWakeTypeHibernateError "HibernateError" // Special interest that entitles the interested client from receiving // all system messages. Only used by powerd. // #define kIOPMSystemCapabilityInterest "IOPMSystemCapabilityInterest" -#define kPMSuspendedNotificationClients "PMSuspendedNotificationClients" +// Entitlement required for root domain clients +#define kRootDomainEntitlementSetProperty "com.apple.private.iokit.rootdomain-set-property" + +#define WAKEEVENT_LOCK() IOLockLock(wakeEventLock) +#define WAKEEVENT_UNLOCK() IOLockUnlock(wakeEventLock) /* * Aggressiveness @@ -250,92 +369,184 @@ static IOPMPowerState ourPowerStates[NUM_POWER_STATES] = #define kAggressivesMinValue 1 +const char * +getAggressivenessTypeString( uint32_t type ) +{ +#define AGGRESSIVENESS_TYPE(x) {(uint32_t) x, #x} + + static const IONamedValue aggressivenessTypes[] = { + AGGRESSIVENESS_TYPE( kPMGeneralAggressiveness ), + AGGRESSIVENESS_TYPE( kPMMinutesToDim ), + AGGRESSIVENESS_TYPE( kPMMinutesToSpinDown ), + AGGRESSIVENESS_TYPE( kPMMinutesToSleep ), + AGGRESSIVENESS_TYPE( kPMEthernetWakeOnLANSettings ), + AGGRESSIVENESS_TYPE( kPMSetProcessorSpeed ), + AGGRESSIVENESS_TYPE( kPMPowerSource), + AGGRESSIVENESS_TYPE( kPMMotionSensor ), + AGGRESSIVENESS_TYPE( kPMLastAggressivenessType ), + { 0, NULL } + }; + return IOFindNameForValue(type, aggressivenessTypes); +} + enum { - kAggressivesStateBusy = 0x01, - kAggressivesStateQuickSpindown = 0x02 + kAggressivesStateBusy = 0x01, + kAggressivesStateQuickSpindown = 0x02 }; struct AggressivesRecord { - uint32_t flags; - uint32_t type; - uint32_t value; + uint32_t flags; + uint32_t type; + uint32_t value; }; struct AggressivesRequest { - queue_chain_t chain; - uint32_t options; - uint32_t dataType; - union { - IOService * service; - AggressivesRecord record; - } data; + queue_chain_t chain; + uint32_t options; + uint32_t dataType; + union { + IOService * service; + AggressivesRecord record; + } data; +}; + +enum { + kAggressivesRequestTypeService = 1, + kAggressivesRequestTypeRecord }; enum { - kAggressivesRequestTypeService = 1, - kAggressivesRequestTypeRecord + kAggressivesOptionSynchronous = 0x00000001, + kAggressivesOptionQuickSpindownEnable = 0x00000100, + kAggressivesOptionQuickSpindownDisable = 0x00000200, + kAggressivesOptionQuickSpindownMask = 0x00000300 }; enum { - kAggressivesOptionSynchronous = 0x00000001, - kAggressivesOptionQuickSpindownEnable = 0x00000100, - kAggressivesOptionQuickSpindownDisable = 0x00000200, - kAggressivesOptionQuickSpindownMask = 0x00000300 + kAggressivesRecordFlagModified = 0x00000001, + kAggressivesRecordFlagMinValue = 0x00000002 }; +// System Sleep Preventers + enum { - kAggressivesRecordFlagModified = 0x00000001, - kAggressivesRecordFlagMinValue = 0x00000002 + kPMUserDisabledAllSleep = 1, + kPMSystemRestartBootingInProgress, + kPMConfigPreventSystemSleep, + kPMChildPreventSystemSleep, + kPMCPUAssertion, + kPMPCIUnsupported, }; +const char * +getSystemSleepPreventerString( uint32_t preventer ) +{ +#define SYSTEM_SLEEP_PREVENTER(x) {(int) x, #x} + static const IONamedValue systemSleepPreventers[] = { + SYSTEM_SLEEP_PREVENTER( kPMUserDisabledAllSleep ), + SYSTEM_SLEEP_PREVENTER( kPMSystemRestartBootingInProgress ), + SYSTEM_SLEEP_PREVENTER( kPMConfigPreventSystemSleep ), + SYSTEM_SLEEP_PREVENTER( kPMChildPreventSystemSleep ), + SYSTEM_SLEEP_PREVENTER( kPMCPUAssertion ), + SYSTEM_SLEEP_PREVENTER( kPMPCIUnsupported ), + { 0, NULL } + }; + return IOFindNameForValue(preventer, systemSleepPreventers); +} + // gDarkWakeFlags enum { - kDarkWakeFlagHIDTickleEarly = 0x01, // hid tickle before gfx suppression - kDarkWakeFlagHIDTickleLate = 0x02, // hid tickle after gfx suppression - kDarkWakeFlagHIDTickleNone = 0x03, // hid tickle is not posted - kDarkWakeFlagHIDTickleMask = 0x03, - kDarkWakeFlagIgnoreDiskIOInDark = 0x04, // ignore disk idle in DW - kDarkWakeFlagIgnoreDiskIOAlways = 0x08, // always ignore disk idle - kDarkWakeFlagIgnoreDiskIOMask = 0x0C, - kDarkWakeFlagAlarmIsDark = 0x0100, - kDarkWakeFlagGraphicsPowerState1 = 0x0200, - kDarkWakeFlagAudioNotSuppressed = 0x0400 + kDarkWakeFlagHIDTickleEarly = 0x01,// hid tickle before gfx suppression + kDarkWakeFlagHIDTickleLate = 0x02,// hid tickle after gfx suppression + kDarkWakeFlagHIDTickleNone = 0x03,// hid tickle is not posted + kDarkWakeFlagHIDTickleMask = 0x03, + kDarkWakeFlagAlarmIsDark = 0x0100, + kDarkWakeFlagGraphicsPowerState1 = 0x0200, + kDarkWakeFlagAudioNotSuppressed = 0x0400 }; static IOPMrootDomain * gRootDomain; -static IONotifier * gSysPowerDownNotifier = 0; +static IONotifier * gSysPowerDownNotifier = NULL; static UInt32 gSleepOrShutdownPending = 0; static UInt32 gWillShutdown = 0; static UInt32 gPagingOff = 0; static UInt32 gSleepWakeUUIDIsSet = false; static uint32_t gAggressivesState = 0; +static uint32_t gHaltTimeMaxLog; +static uint32_t gHaltTimeMaxPanic; +IOLock * gHaltLogLock; +static char * gHaltLog; +enum { kHaltLogSize = 2048 }; +static size_t gHaltLogPos; +static uint64_t gHaltStartTime; -uuid_string_t bootsessionuuid_string; -static uint32_t gDarkWakeFlags = kDarkWakeFlagHIDTickleNone | kDarkWakeFlagIgnoreDiskIOAlways; +uuid_string_t bootsessionuuid_string; +static uint32_t gDarkWakeFlags = kDarkWakeFlagHIDTickleNone; +static uint32_t gNoIdleFlag = 0; +static uint32_t gSwdPanic = 1; +static uint32_t gSwdSleepTimeout = 0; +static uint32_t gSwdWakeTimeout = 0; +static uint32_t gSwdSleepWakeTimeout = 0; static PMStatsStruct gPMStats; +#if DEVELOPMENT || DEBUG +static uint32_t swd_panic_phase; +#endif + #if HIBERNATION -static IOPMSystemSleepPolicyHandler gSleepPolicyHandler = 0; -static IOPMSystemSleepPolicyVariables * gSleepPolicyVars = 0; +static IOPMSystemSleepPolicyHandler gSleepPolicyHandler = NULL; +static IOPMSystemSleepPolicyVariables * gSleepPolicyVars = NULL; static void * gSleepPolicyTarget; #endif struct timeval gIOLastSleepTime; struct timeval gIOLastWakeTime; +struct timeval gIOLastUserSleepTime; + +static char gWakeReasonString[128]; +static bool gWakeReasonSysctlRegistered = false; +static AbsoluteTime gIOLastWakeAbsTime; +static AbsoluteTime gIOLastSleepAbsTime; +static AbsoluteTime gUserActiveAbsTime; +static AbsoluteTime gUserInactiveAbsTime; + +#if defined(__i386__) || defined(__x86_64__) +static bool gSpinDumpBufferFull = false; +#endif + +z_stream swd_zs; +vm_offset_t swd_zs_zmem; +//size_t swd_zs_zsize; +size_t swd_zs_zoffset; +#if defined(__i386__) || defined(__x86_64__) +IOCPU *currentShutdownTarget = NULL; +#endif + +static unsigned int gPMHaltBusyCount; +static unsigned int gPMHaltIdleCount; +static int gPMHaltDepth; +static uint32_t gPMHaltMessageType; +static IOLock * gPMHaltLock = NULL; +static OSArray * gPMHaltArray = NULL; +static const OSSymbol * gPMHaltClientAcknowledgeKey = NULL; +static bool gPMQuiesced; + // Constants used as arguments to IOPMrootDomain::informCPUStateChange #define kCPUUnknownIndex 9999999 enum { - kInformAC = 0, - kInformLid = 1, - kInformableCount = 2 + kInformAC = 0, + kInformLid = 1, + kInformableCount = 2 }; -const OSSymbol *gIOPMStatsApplicationResponseTimedOut; -const OSSymbol *gIOPMStatsApplicationResponseCancel; -const OSSymbol *gIOPMStatsApplicationResponseSlow; +const OSSymbol *gIOPMStatsResponseTimedOut; +const OSSymbol *gIOPMStatsResponseCancel; +const OSSymbol *gIOPMStatsResponseSlow; +const OSSymbol *gIOPMStatsResponsePrompt; +const OSSymbol *gIOPMStatsDriverPSChangeSlow; #define kBadPMFeatureID 0 @@ -345,12 +556,12 @@ const OSSymbol *gIOPMStatsApplicationResponseSlow; */ class PMSettingHandle : public OSObject { - OSDeclareFinalStructors( PMSettingHandle ) - friend class PMSettingObject; + OSDeclareFinalStructors( PMSettingHandle ); + friend class PMSettingObject; private: - PMSettingObject *pmso; - void free(void); + PMSettingObject *pmso; + void free(void) APPLE_KEXT_OVERRIDE; }; /* @@ -359,40 +570,40 @@ private: */ class PMSettingObject : public OSObject { - OSDeclareFinalStructors( PMSettingObject ) - friend class IOPMrootDomain; + OSDeclareFinalStructors( PMSettingObject ); + friend class IOPMrootDomain; private: - queue_head_t calloutQueue; - thread_t waitThread; - IOPMrootDomain *parent; - PMSettingHandle *pmsh; - IOPMSettingControllerCallback func; - OSObject *target; - uintptr_t refcon; - uint32_t *publishedFeatureID; - uint32_t settingCount; - bool disabled; - - void free(void); + queue_head_t calloutQueue; + thread_t waitThread; + IOPMrootDomain *parent; + PMSettingHandle *pmsh; + IOPMSettingControllerCallback func; + OSObject *target; + uintptr_t refcon; + uint32_t *publishedFeatureID; + uint32_t settingCount; + bool disabled; + + void free(void) APPLE_KEXT_OVERRIDE; public: - static PMSettingObject *pmSettingObject( - IOPMrootDomain *parent_arg, - IOPMSettingControllerCallback handler_arg, - OSObject *target_arg, - uintptr_t refcon_arg, - uint32_t supportedPowerSources, - const OSSymbol *settings[], - OSObject **handle_obj); - - void dispatchPMSetting(const OSSymbol *type, OSObject *object); - void clientHandleFreed(void); + static PMSettingObject *pmSettingObject( + IOPMrootDomain *parent_arg, + IOPMSettingControllerCallback handler_arg, + OSObject *target_arg, + uintptr_t refcon_arg, + uint32_t supportedPowerSources, + const OSSymbol *settings[], + OSObject **handle_obj); + + void dispatchPMSetting(const OSSymbol *type, OSObject *object); + void clientHandleFreed(void); }; struct PMSettingCallEntry { - queue_chain_t link; - thread_t thread; + queue_chain_t link; + thread_t thread; }; #define PMSETTING_LOCK() IOLockLock(settingsCtrlLock) @@ -400,74 +611,6 @@ struct PMSettingCallEntry { #define PMSETTING_WAIT(p) IOLockSleep(settingsCtrlLock, p, THREAD_UNINT) #define PMSETTING_WAKEUP(p) IOLockWakeup(settingsCtrlLock, p, true) -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* - -/* @class IOPMTimeline - * @astract Tracks & records PM activity. - * @discussion Intended for use only as a helper-class to IOPMrootDomain. - * Do not subclass or directly invoke iOPMTimeline - */ -class IOPMTimeline : public OSObject -{ - OSDeclareDefaultStructors( IOPMTimeline ); - -public: - static IOPMTimeline* timeline(IOPMrootDomain *root_domain); - - bool setProperties(OSDictionary *d); - OSDictionary *copyInfoDictionary(void); - - IOReturn recordSystemPowerEvent( PMEventDetails *details ); - - IOReturn recordDetailedPowerEvent( PMEventDetails *details ); - - IOMemoryDescriptor *getPMTraceMemoryDescriptor(); - - uint32_t getNumEventsLoggedThisPeriod(); - void setNumEventsLoggedThisPeriod(uint32_t newCount); - bool isSleepCycleInProgress(); - void setSleepCycleInProgressFlag(bool flag); -private: - bool init(void); - void free(void); - - void setEventsTrackedCount(uint32_t newTracked); - void setEventsRecordingLevel(uint32_t eventsTrackedBits); - static uint32_t _atomicIndexIncrement(uint32_t *index, uint32_t limit); - - enum { - kPMTimelineRecordTardyDrivers = 1 << 0, - kPMTmielineRecordSystemEvents = 1 << 1, - kPMTimelineRecordAllDrivers = 1 << 2, - kPMTimelineRecordOff = 0, - kPMTimelineRecordDefault = 3, - kPMTimelineRecordDebug = 7 - }; - - // eventsRecordingLevel is a bitfield defining which PM driver events will get logged - // into the PM buffer. - uint32_t eventsRecordingLevel; - - // pmTraceMemoryDescriptor represents the memory block that IOPMTimeLine records PM trace points into. - IOBufferMemoryDescriptor *pmTraceMemoryDescriptor; - - // Pointer to starting address in pmTraceMemoryDescriptor - IOPMSystemEventRecord *traceBuffer; - IOPMTraceBufferHeader *hdr; - - uint16_t systemState; - - IOLock *logLock; - IOPMrootDomain *owner; - - uint32_t numEventsLoggedThisPeriod; - bool sleepCycleInProgress; -}; - -OSDefineMetaClassAndStructors( IOPMTimeline, OSObject ) - /* * PMTraceWorker * Internal helper object for logging trace points to RTC @@ -476,37 +619,39 @@ OSDefineMetaClassAndStructors( IOPMTimeline, OSObject ) */ typedef void (*IOPMTracePointHandler)( - void * target, uint32_t code, uint32_t data ); + void * target, uint32_t code, uint32_t data ); class PMTraceWorker : public OSObject { - OSDeclareDefaultStructors(PMTraceWorker) + OSDeclareDefaultStructors(PMTraceWorker); public: - typedef enum { kPowerChangeStart, kPowerChangeCompleted } change_t; - - static PMTraceWorker *tracer( IOPMrootDomain * ); - void tracePCIPowerChange(change_t, IOService *, uint32_t, uint32_t); - void tracePoint(uint8_t phase); - void tracePoint(uint8_t phase, uint8_t data8); - void traceDetail(uint32_t detail); - void traceLoginWindowPhase(uint8_t phase); - int recordTopLevelPCIDevice(IOService *); - void RTC_TRACE(void); - virtual bool serialize(OSSerialize *s) const; - - IOPMTracePointHandler tracePointHandler; - void * tracePointTarget; - uint64_t getPMStatusCode(); + typedef enum { kPowerChangeStart, kPowerChangeCompleted } change_t; + + static PMTraceWorker *tracer( IOPMrootDomain * ); + void tracePCIPowerChange(change_t, IOService *, uint32_t, uint32_t); + void tracePoint(uint8_t phase); + void traceDetail(uint32_t detail); + void traceComponentWakeProgress(uint32_t component, uint32_t data); + int recordTopLevelPCIDevice(IOService *); + void RTC_TRACE(void); + virtual bool serialize(OSSerialize *s) const APPLE_KEXT_OVERRIDE; + + IOPMTracePointHandler tracePointHandler; + void * tracePointTarget; + uint64_t getPMStatusCode(); + uint8_t getTracePhase(); + uint32_t getTraceData(); private: - IOPMrootDomain *owner; - IOLock *pciMappingLock; - OSArray *pciDeviceBitMappings; - - uint8_t addedToRegistry; - uint8_t tracePhase; - uint8_t loginWindowPhase; - uint8_t traceData8; - uint32_t traceData32; + IOPMrootDomain *owner; + IOLock *pmTraceWorkerLock; + OSArray *pciDeviceBitMappings; + + uint8_t addedToRegistry; + uint8_t tracePhase; + uint32_t traceData32; + uint8_t loginWindowData; + uint8_t coreDisplayData; + uint8_t coreGraphicsData; }; /* @@ -515,54 +660,54 @@ private: */ class PMAssertionsTracker : public OSObject { - OSDeclareFinalStructors(PMAssertionsTracker) + OSDeclareFinalStructors(PMAssertionsTracker); public: - static PMAssertionsTracker *pmAssertionsTracker( IOPMrootDomain * ); - - IOReturn createAssertion(IOPMDriverAssertionType, IOPMDriverAssertionLevel, IOService *, const char *, IOPMDriverAssertionID *); - IOReturn releaseAssertion(IOPMDriverAssertionID); - IOReturn setAssertionLevel(IOPMDriverAssertionID, IOPMDriverAssertionLevel); - IOReturn setUserAssertionLevels(IOPMDriverAssertionType); - - OSArray *copyAssertionsArray(void); - IOPMDriverAssertionType getActivatedAssertions(void); - IOPMDriverAssertionLevel getAssertionLevel(IOPMDriverAssertionType); - - IOReturn handleCreateAssertion(OSData *); - IOReturn handleReleaseAssertion(IOPMDriverAssertionID); - IOReturn handleSetAssertionLevel(IOPMDriverAssertionID, IOPMDriverAssertionLevel); - IOReturn handleSetUserAssertionLevels(void * arg0); - void publishProperties(void); + static PMAssertionsTracker *pmAssertionsTracker( IOPMrootDomain * ); + + IOReturn createAssertion(IOPMDriverAssertionType, IOPMDriverAssertionLevel, IOService *, const char *, IOPMDriverAssertionID *); + IOReturn releaseAssertion(IOPMDriverAssertionID); + IOReturn setAssertionLevel(IOPMDriverAssertionID, IOPMDriverAssertionLevel); + IOReturn setUserAssertionLevels(IOPMDriverAssertionType); + + OSArray *copyAssertionsArray(void); + IOPMDriverAssertionType getActivatedAssertions(void); + IOPMDriverAssertionLevel getAssertionLevel(IOPMDriverAssertionType); + + IOReturn handleCreateAssertion(OSData *); + IOReturn handleReleaseAssertion(IOPMDriverAssertionID); + IOReturn handleSetAssertionLevel(IOPMDriverAssertionID, IOPMDriverAssertionLevel); + IOReturn handleSetUserAssertionLevels(void * arg0); + void publishProperties(void); private: - typedef struct { - IOPMDriverAssertionID id; - IOPMDriverAssertionType assertionBits; - uint64_t createdTime; - uint64_t modifiedTime; - const OSSymbol *ownerString; - IOService *ownerService; - uint64_t registryEntryID; - IOPMDriverAssertionLevel level; - } PMAssertStruct; - - uint32_t tabulateProducerCount; - uint32_t tabulateConsumerCount; - - PMAssertStruct *detailsForID(IOPMDriverAssertionID, int *); - void tabulate(void); - - IOPMrootDomain *owner; - OSArray *assertionsArray; - IOLock *assertionsArrayLock; - IOPMDriverAssertionID issuingUniqueID __attribute__((aligned(8))); /* aligned for atomic access */ - IOPMDriverAssertionType assertionsKernel; - IOPMDriverAssertionType assertionsUser; - IOPMDriverAssertionType assertionsCombined; + typedef struct { + IOPMDriverAssertionID id; + IOPMDriverAssertionType assertionBits; + uint64_t createdTime; + uint64_t modifiedTime; + const OSSymbol *ownerString; + IOService *ownerService; + uint64_t registryEntryID; + IOPMDriverAssertionLevel level; + } PMAssertStruct; + + uint32_t tabulateProducerCount; + uint32_t tabulateConsumerCount; + + PMAssertStruct *detailsForID(IOPMDriverAssertionID, int *); + void tabulate(void); + + IOPMrootDomain *owner; + OSArray *assertionsArray; + IOLock *assertionsArrayLock; + IOPMDriverAssertionID issuingUniqueID __attribute__((aligned(8)));/* aligned for atomic access */ + IOPMDriverAssertionType assertionsKernel; + IOPMDriverAssertionType assertionsUser; + IOPMDriverAssertionType assertionsCombined; }; - + OSDefineMetaClassAndFinalStructors(PMAssertionsTracker, OSObject); - + /* * PMHaltWorker * Internal helper object for Shutdown/Restart notifications. @@ -572,21 +717,21 @@ OSDefineMetaClassAndFinalStructors(PMAssertionsTracker, OSObject); class PMHaltWorker : public OSObject { - OSDeclareFinalStructors( PMHaltWorker ) + OSDeclareFinalStructors( PMHaltWorker ); public: - IOService * service; // service being worked on - AbsoluteTime startTime; // time when work started - int depth; // work on nubs at this PM-tree depth - int visits; // number of nodes visited (debug) - IOLock * lock; - bool timeout; // service took too long - - static PMHaltWorker * worker( void ); - static void main( void * arg, wait_result_t waitResult ); - static void work( PMHaltWorker * me ); - static void checkTimeout( PMHaltWorker * me, AbsoluteTime * now ); - virtual void free( void ); + IOService * service;// service being worked on + AbsoluteTime startTime; // time when work started + int depth; // work on nubs at this PM-tree depth + int visits; // number of nodes visited (debug) + IOLock * lock; + bool timeout;// service took too long + + static PMHaltWorker * worker( void ); + static void main( void * arg, wait_result_t waitResult ); + static void work( PMHaltWorker * me ); + static void checkTimeout( PMHaltWorker * me, AbsoluteTime * now ); + virtual void free( void ) APPLE_KEXT_OVERRIDE; }; OSDefineMetaClassAndFinalStructors( PMHaltWorker, OSObject ) @@ -595,158 +740,311 @@ OSDefineMetaClassAndFinalStructors( PMHaltWorker, OSObject ) #define super IOService OSDefineMetaClassAndFinalStructors(IOPMrootDomain, IOService) -static void IOPMRootDomainWillShutdown(void) +boolean_t +IOPMRootDomainGetWillShutdown(void) { - if (OSCompareAndSwap(0, 1, &gWillShutdown)) - { - OSKext::willShutdown(); - for (int i = 0; i < 100; i++) - { - if (OSCompareAndSwap(0, 1, &gSleepOrShutdownPending)) break; - IOSleep( 100 ); - } - } -} - -extern "C" -{ - IONotifier * registerSleepWakeInterest(IOServiceInterestHandler handler, void * self, void * ref) - { - return gRootDomain->registerInterest( gIOGeneralInterest, handler, self, ref ); - } - - IONotifier * registerPrioritySleepWakeInterest(IOServiceInterestHandler handler, void * self, void * ref) - { - return gRootDomain->registerInterest( gIOPriorityPowerStateInterest, handler, self, ref ); - } - - IOReturn acknowledgeSleepWakeNotification(void * PMrefcon) - { - return gRootDomain->allowPowerChange ( (unsigned long)PMrefcon ); - } - - IOReturn vetoSleepWakeNotification(void * PMrefcon) - { - return gRootDomain->cancelPowerChange ( (unsigned long)PMrefcon ); - } - - IOReturn rootDomainRestart ( void ) - { - return gRootDomain->restartSystem(); - } - - IOReturn rootDomainShutdown ( void ) - { - return gRootDomain->shutdownSystem(); - } - - void IOSystemShutdownNotification(void) - { - IOPMRootDomainWillShutdown(); - if (OSCompareAndSwap(0, 1, &gPagingOff)) - { - gRootDomain->handlePlatformHaltRestart(kPEPagingOff); + return gWillShutdown != 0; +} + +static void +IOPMRootDomainWillShutdown(void) +{ + if (OSCompareAndSwap(0, 1, &gWillShutdown)) { + IOService::willShutdown(); + for (int i = 0; i < 100; i++) { + if (OSCompareAndSwap(0, 1, &gSleepOrShutdownPending)) { + break; + } + IOSleep( 100 ); } - } + } +} - int sync_internal(void); +extern "C" IONotifier * +registerSleepWakeInterest(IOServiceInterestHandler handler, void * self, void * ref) +{ + return gRootDomain->registerInterest( gIOGeneralInterest, handler, self, ref ); +} + +extern "C" IONotifier * +registerPrioritySleepWakeInterest(IOServiceInterestHandler handler, void * self, void * ref) +{ + return gRootDomain->registerInterest( gIOPriorityPowerStateInterest, handler, self, ref ); +} + +extern "C" IOReturn +acknowledgeSleepWakeNotification(void * PMrefcon) +{ + return gRootDomain->allowPowerChange((unsigned long)PMrefcon ); +} + +extern "C" IOReturn +vetoSleepWakeNotification(void * PMrefcon) +{ + return gRootDomain->cancelPowerChange((unsigned long)PMrefcon ); +} + +extern "C" IOReturn +rootDomainRestart( void ) +{ + return gRootDomain->restartSystem(); +} + +extern "C" IOReturn +rootDomainShutdown( void ) +{ + return gRootDomain->shutdownSystem(); +} + +static void +halt_log_putc(char c) +{ + if (gHaltLogPos >= (kHaltLogSize - 2)) { + return; + } + gHaltLog[gHaltLogPos++] = c; +} + +extern "C" void +_doprnt_log(const char *fmt, + va_list *argp, + void (*putc)(char), + int radix); + +static int +halt_log(const char *fmt, ...) +{ + va_list listp; + + va_start(listp, fmt); + _doprnt_log(fmt, &listp, &halt_log_putc, 16); + va_end(listp); + + return 0; +} + +extern "C" void +halt_log_enter(const char * what, const void * pc, uint64_t time) +{ + uint64_t nano, millis; + + if (!gHaltLog) { + return; + } + absolutetime_to_nanoseconds(time, &nano); + millis = nano / NSEC_PER_MSEC; + if (millis < 100) { + return; + } + + IOLockLock(gHaltLogLock); + if (pc) { + halt_log("%s: %qd ms @ 0x%lx, ", what, millis, VM_KERNEL_UNSLIDE(pc)); + OSKext::printKextsInBacktrace((vm_offset_t *) &pc, 1, &halt_log, + OSKext::kPrintKextsLock | OSKext::kPrintKextsUnslide | OSKext::kPrintKextsTerse); + } else { + halt_log("%s: %qd ms\n", what, millis); + } + + gHaltLog[gHaltLogPos] = 0; + IOLockUnlock(gHaltLogLock); +} + +extern uint32_t gFSState; + +extern "C" void +IOSystemShutdownNotification(int stage) +{ + uint64_t startTime; + + if (kIOSystemShutdownNotificationStageRootUnmount == stage) { +#if !CONFIG_EMBEDDED + uint64_t nano, millis; + startTime = mach_absolute_time(); + IOService::getPlatform()->waitQuiet(30 * NSEC_PER_SEC); + absolutetime_to_nanoseconds(mach_absolute_time() - startTime, &nano); + millis = nano / NSEC_PER_MSEC; + if (gHaltTimeMaxLog && (millis >= gHaltTimeMaxLog)) { + printf("waitQuiet() for unmount %qd ms\n", millis); + } +#endif + return; + } + + assert(kIOSystemShutdownNotificationStageProcessExit == stage); + + IOLockLock(gHaltLogLock); + if (!gHaltLog) { + gHaltLog = IONew(char, kHaltLogSize); + gHaltStartTime = mach_absolute_time(); + if (gHaltLog) { + halt_log_putc('\n'); + } + } + IOLockUnlock(gHaltLogLock); + + startTime = mach_absolute_time(); + IOPMRootDomainWillShutdown(); + halt_log_enter("IOPMRootDomainWillShutdown", NULL, mach_absolute_time() - startTime); +#if HIBERNATION + startTime = mach_absolute_time(); + IOHibernateSystemPostWake(true); + halt_log_enter("IOHibernateSystemPostWake", NULL, mach_absolute_time() - startTime); +#endif + if (OSCompareAndSwap(0, 1, &gPagingOff)) { + gRootDomain->handlePlatformHaltRestart(kPEPagingOff); + } } -/* -A device is always in the highest power state which satisfies its driver, -its policy-maker, and any power children it has, but within the constraint -of the power state provided by its parent. The driver expresses its desire by -calling changePowerStateTo(), the policy-maker expresses its desire by calling -changePowerStateToPriv(), and the children express their desires by calling -requestPowerDomainState(). -The Root Power Domain owns the policy for idle and demand sleep for the system. -It is a power-managed IOService just like the others in the system. -It implements several power states which map to what we see as Sleep and On. +extern "C" int sync_internal(void); -The sleep policy is as follows: -1. Sleep is prevented if the case is open so that nobody will think the machine - is off and plug/unplug cards. -2. Sleep is prevented if the sleep timeout slider in the prefs panel is zero. -3. System cannot Sleep if some object in the tree is in a power state marked - kIOPMPreventSystemSleep. +/* + * A device is always in the highest power state which satisfies its driver, + * its policy-maker, and any power children it has, but within the constraint + * of the power state provided by its parent. The driver expresses its desire by + * calling changePowerStateTo(), the policy-maker expresses its desire by calling + * changePowerStateToPriv(), and the children express their desires by calling + * requestPowerDomainState(). + * + * The Root Power Domain owns the policy for idle and demand sleep for the system. + * It is a power-managed IOService just like the others in the system. + * It implements several power states which map to what we see as Sleep and On. + * + * The sleep policy is as follows: + * 1. Sleep is prevented if the case is open so that nobody will think the machine + * is off and plug/unplug cards. + * 2. Sleep is prevented if the sleep timeout slider in the prefs panel is zero. + * 3. System cannot Sleep if some object in the tree is in a power state marked + * kIOPMPreventSystemSleep. + * + * These three conditions are enforced using the "driver clamp" by calling + * changePowerStateTo(). For example, if the case is opened, + * changePowerStateTo(ON_STATE) is called to hold the system on regardless + * of the desires of the children of the root or the state of the other clamp. + * + * Demand Sleep is initiated by pressing the front panel power button, closing + * the clamshell, or selecting the menu item. In this case the root's parent + * actually initiates the power state change so that the root domain has no + * choice and does not give applications the opportunity to veto the change. + * + * Idle Sleep occurs if no objects in the tree are in a state marked + * kIOPMPreventIdleSleep. When this is true, the root's children are not holding + * the root on, so it sets the "policy-maker clamp" by calling + * changePowerStateToPriv(ON_STATE) to hold itself on until the sleep timer expires. + * This timer is set for the difference between the sleep timeout slider and the + * display dim timeout slider. When the timer expires, it releases its clamp and + * now nothing is holding it awake, so it falls asleep. + * + * Demand sleep is prevented when the system is booting. When preferences are + * transmitted by the loginwindow at the end of boot, a flag is cleared, + * and this allows subsequent Demand Sleep. + */ -These three conditions are enforced using the "driver clamp" by calling -changePowerStateTo(). For example, if the case is opened, -changePowerStateTo(ON_STATE) is called to hold the system on regardless -of the desires of the children of the root or the state of the other clamp. +//****************************************************************************** -Demand Sleep is initiated by pressing the front panel power button, closing -the clamshell, or selecting the menu item. In this case the root's parent -actually initiates the power state change so that the root domain has no -choice and does not give applications the opportunity to veto the change. +IOPMrootDomain * +IOPMrootDomain::construct( void ) +{ + IOPMrootDomain *root; -Idle Sleep occurs if no objects in the tree are in a state marked -kIOPMPreventIdleSleep. When this is true, the root's children are not holding -the root on, so it sets the "policy-maker clamp" by calling -changePowerStateToPriv(ON_STATE) to hold itself on until the sleep timer expires. -This timer is set for the difference between the sleep timeout slider and the -display dim timeout slider. When the timer expires, it releases its clamp and -now nothing is holding it awake, so it falls asleep. + root = new IOPMrootDomain; + if (root) { + root->init(); + } -Demand sleep is prevented when the system is booting. When preferences are -transmitted by the loginwindow at the end of boot, a flag is cleared, -and this allows subsequent Demand Sleep. -*/ + return root; +} //****************************************************************************** +// updateConsoleUsersCallout +// +//****************************************************************************** + +static void +updateConsoleUsersCallout(thread_call_param_t p0, thread_call_param_t p1) +{ + IOPMrootDomain * rootDomain = (IOPMrootDomain *) p0; + rootDomain->updateConsoleUsers(); +} -IOPMrootDomain * IOPMrootDomain::construct( void ) +void +IOPMrootDomain::updateConsoleUsers(void) { - IOPMrootDomain *root; + IOService::updateConsoleUsers(NULL, kIOMessageSystemHasPoweredOn); + if (tasksSuspended) { + tasksSuspended = FALSE; + updateTasksSuspend(); + } +} - root = new IOPMrootDomain; - if( root) - root->init(); +void +IOPMrootDomain::updateTasksSuspend(void) +{ + bool newSuspend; - return( root ); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + newSuspend = (tasksSuspended || _aotTasksSuspended); +#else /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + newSuspend = tasksSuspended; +#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + if (newSuspend == tasksSuspendState) { + return; + } + tasksSuspendState = newSuspend; + tasks_system_suspend(newSuspend); } //****************************************************************************** -static void disk_sync_callout( thread_call_param_t p0, thread_call_param_t p1 ) +static void +disk_sync_callout( thread_call_param_t p0, thread_call_param_t p1 ) { - IOService * rootDomain = (IOService *) p0; - uint32_t notifyRef = (uint32_t)(uintptr_t) p1; - uint32_t powerState = rootDomain->getPowerState(); + IOService * rootDomain = (IOService *) p0; + uint32_t notifyRef = (uint32_t)(uintptr_t) p1; + uint32_t powerState = rootDomain->getPowerState(); - DLOG("disk_sync_callout ps=%u\n", powerState); + DLOG("disk_sync_callout ps=%u\n", powerState); - if (ON_STATE == powerState) - { - sync_internal(); - } -#if HIBERNATION - else - { - IOHibernateSystemPostWake(); - } + if (ON_STATE == powerState) { + sync_internal(); + +#if HIBERNATION + // Block sleep until trim issued on previous wake path is completed. + IOHibernateSystemPostWake(true); +#endif + } +#if HIBERNATION + else { + IOHibernateSystemPostWake(false); + + if (gRootDomain) { + gRootDomain->sleepWakeDebugSaveSpinDumpFile(); + } + } #endif - rootDomain->allowPowerChange(notifyRef); - DLOG("disk_sync_callout finish\n"); + rootDomain->allowPowerChange(notifyRef); + DLOG("disk_sync_callout finish\n"); } //****************************************************************************** - -static UInt32 computeDeltaTimeMS( const AbsoluteTime * startTime ) +static UInt32 +computeDeltaTimeMS( const AbsoluteTime * startTime, AbsoluteTime * elapsedTime ) { - AbsoluteTime endTime; - UInt64 nano = 0; + AbsoluteTime endTime; + UInt64 nano = 0; clock_get_uptime(&endTime); - if (CMP_ABSOLUTETIME(&endTime, startTime) > 0) - { + if (CMP_ABSOLUTETIME(&endTime, startTime) <= 0) { + *elapsedTime = 0; + } else { SUB_ABSOLUTETIME(&endTime, startTime); absolutetime_to_nanoseconds(endTime, &nano); + *elapsedTime = endTime; } - return (UInt32)(nano / 1000000ULL); + return (UInt32)(nano / NSEC_PER_MSEC); } //****************************************************************************** @@ -754,5981 +1052,7223 @@ static UInt32 computeDeltaTimeMS( const AbsoluteTime * startTime ) static int sysctl_sleepwaketime SYSCTL_HANDLER_ARGS { - struct timeval *swt = (struct timeval *)arg1; - struct proc *p = req->p; - - if (p == kernproc) { - return sysctl_io_opaque(req, swt, sizeof(*swt), NULL); - } else if(proc_is64bit(p)) { - struct user64_timeval t; - t.tv_sec = swt->tv_sec; - t.tv_usec = swt->tv_usec; - return sysctl_io_opaque(req, &t, sizeof(t), NULL); - } else { - struct user32_timeval t; - t.tv_sec = swt->tv_sec; - t.tv_usec = swt->tv_usec; - return sysctl_io_opaque(req, &t, sizeof(t), NULL); - } + struct timeval *swt = (struct timeval *)arg1; + struct proc *p = req->p; + + if (p == kernproc) { + return sysctl_io_opaque(req, swt, sizeof(*swt), NULL); + } else if (proc_is64bit(p)) { + struct user64_timeval t = {}; + t.tv_sec = swt->tv_sec; + t.tv_usec = swt->tv_usec; + return sysctl_io_opaque(req, &t, sizeof(t), NULL); + } else { + struct user32_timeval t = {}; + t.tv_sec = swt->tv_sec; + t.tv_usec = swt->tv_usec; + return sysctl_io_opaque(req, &t, sizeof(t), NULL); + } } static SYSCTL_PROC(_kern, OID_AUTO, sleeptime, - CTLTYPE_STRUCT | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, - &gIOLastSleepTime, 0, sysctl_sleepwaketime, "S,timeval", ""); + CTLTYPE_STRUCT | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + &gIOLastUserSleepTime, 0, sysctl_sleepwaketime, "S,timeval", ""); static SYSCTL_PROC(_kern, OID_AUTO, waketime, - CTLTYPE_STRUCT | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, - &gIOLastWakeTime, 0, sysctl_sleepwaketime, "S,timeval", ""); + CTLTYPE_STRUCT | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + &gIOLastWakeTime, 0, sysctl_sleepwaketime, "S,timeval", ""); +SYSCTL_QUAD(_kern, OID_AUTO, wake_abs_time, CTLFLAG_RD | CTLFLAG_LOCKED, &gIOLastWakeAbsTime, ""); +SYSCTL_QUAD(_kern, OID_AUTO, sleep_abs_time, CTLFLAG_RD | CTLFLAG_LOCKED, &gIOLastSleepAbsTime, ""); +SYSCTL_QUAD(_kern, OID_AUTO, useractive_abs_time, CTLFLAG_RD | CTLFLAG_LOCKED, &gUserActiveAbsTime, ""); +SYSCTL_QUAD(_kern, OID_AUTO, userinactive_abs_time, CTLFLAG_RD | CTLFLAG_LOCKED, &gUserInactiveAbsTime, ""); static int sysctl_willshutdown (__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) { - int new_value, changed; - int error = sysctl_io_number(req, gWillShutdown, sizeof(int), &new_value, &changed); - if (changed) { - if (!gWillShutdown && (new_value == 1)) { - IOPMRootDomainWillShutdown(); - } else - error = EINVAL; - } - return(error); + int new_value, changed; + int error = sysctl_io_number(req, gWillShutdown, sizeof(int), &new_value, &changed); + if (changed) { + if (!gWillShutdown && (new_value == 1)) { + IOPMRootDomainWillShutdown(); + } else { + error = EINVAL; + } + } + return error; } static SYSCTL_PROC(_kern, OID_AUTO, willshutdown, - CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, - 0, 0, sysctl_willshutdown, "I", ""); + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_willshutdown, "I", ""); +extern struct sysctl_oid sysctl__kern_iokittest; +extern struct sysctl_oid sysctl__debug_iokit; + +#if !CONFIG_EMBEDDED static int sysctl_progressmeterenable (__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) { - int error; - int new_value, changed; + int error; + int new_value, changed; - error = sysctl_io_number(req, vc_progress_meter_enable, sizeof(int), &new_value, &changed); + error = sysctl_io_number(req, vc_progressmeter_enable, sizeof(int), &new_value, &changed); - if (changed) - vc_enable_progressmeter(new_value); + if (changed) { + vc_enable_progressmeter(new_value); + } - return (error); + return error; } static int sysctl_progressmeter (__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) { - int error; - int new_value, changed; + int error; + int new_value, changed; - error = sysctl_io_number(req, vc_progress_meter_value, sizeof(int), &new_value, &changed); + error = sysctl_io_number(req, vc_progressmeter_value, sizeof(int), &new_value, &changed); - if (changed) - vc_set_progressmeter(new_value); + if (changed) { + vc_set_progressmeter(new_value); + } - return (error); + return error; } static SYSCTL_PROC(_kern, OID_AUTO, progressmeterenable, - CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, - 0, 0, sysctl_progressmeterenable, "I", ""); + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_progressmeterenable, "I", ""); static SYSCTL_PROC(_kern, OID_AUTO, progressmeter, - CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, - 0, 0, sysctl_progressmeter, "I", ""); + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_progressmeter, "I", ""); +#endif /* !CONFIG_EMBEDDED */ -static SYSCTL_INT(_debug, OID_AUTO, darkwake, CTLFLAG_RW, &gDarkWakeFlags, 0, ""); -static const OSSymbol * gIOPMSettingAutoWakeCalendarKey; -static const OSSymbol * gIOPMSettingAutoWakeSecondsKey; -static const OSSymbol * gIOPMSettingDebugWakeRelativeKey; -static const OSSymbol * gIOPMSettingMaintenanceWakeCalendarKey; -static const OSSymbol * gIOPMSettingSleepServiceWakeCalendarKey; -static const OSSymbol * gIOPMSettingSilentRunningKey; -static const OSSymbol * gIOPMUserTriggeredFullWakeKey; -static const OSSymbol * gIOPMUserIsActiveKey; -//****************************************************************************** -// start -// -//****************************************************************************** +static int +sysctl_consoleoptions +(__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) +{ + int error, changed; + uint32_t new_value; -#define kRootDomainSettingsCount 17 + error = sysctl_io_number(req, vc_user_options.options, sizeof(uint32_t), &new_value, &changed); -bool IOPMrootDomain::start( IOService * nub ) -{ - OSIterator *psIterator; - OSDictionary *tmpDict; - IORootParent * patriarch; -#if defined(__i386__) || defined(__x86_64__) - IONotifier * notifier; -#endif + if (changed) { + vc_user_options.options = new_value; + } - super::start(nub); - - gRootDomain = this; - gIOPMSettingAutoWakeCalendarKey = OSSymbol::withCString(kIOPMSettingAutoWakeCalendarKey); - gIOPMSettingAutoWakeSecondsKey = OSSymbol::withCString(kIOPMSettingAutoWakeSecondsKey); - gIOPMSettingDebugWakeRelativeKey = OSSymbol::withCString(kIOPMSettingDebugWakeRelativeKey); - gIOPMSettingMaintenanceWakeCalendarKey = OSSymbol::withCString(kIOPMSettingMaintenanceWakeCalendarKey); - gIOPMSettingSleepServiceWakeCalendarKey = OSSymbol::withCString(kIOPMSettingSleepServiceWakeCalendarKey); - gIOPMSettingSilentRunningKey = OSSymbol::withCStringNoCopy(kIOPMSettingSilentRunningKey); - gIOPMUserTriggeredFullWakeKey = OSSymbol::withCStringNoCopy(kIOPMUserTriggeredFullWakeKey); - gIOPMUserIsActiveKey = OSSymbol::withCStringNoCopy(kIOPMUserIsActiveKey); - - gIOPMStatsApplicationResponseTimedOut = OSSymbol::withCString(kIOPMStatsResponseTimedOut); - gIOPMStatsApplicationResponseCancel = OSSymbol::withCString(kIOPMStatsResponseCancel); - gIOPMStatsApplicationResponseSlow = OSSymbol::withCString(kIOPMStatsResponseSlow); - - sleepSupportedPEFunction = OSSymbol::withCString("IOPMSetSleepSupported"); - sleepMessagePEFunction = OSSymbol::withCString("IOPMSystemSleepMessage"); - - const OSSymbol *settingsArr[kRootDomainSettingsCount] = - { - OSSymbol::withCString(kIOPMSettingSleepOnPowerButtonKey), - gIOPMSettingAutoWakeSecondsKey, - OSSymbol::withCString(kIOPMSettingAutoPowerSecondsKey), - gIOPMSettingAutoWakeCalendarKey, - OSSymbol::withCString(kIOPMSettingAutoPowerCalendarKey), - gIOPMSettingDebugWakeRelativeKey, - OSSymbol::withCString(kIOPMSettingDebugPowerRelativeKey), - OSSymbol::withCString(kIOPMSettingWakeOnRingKey), - OSSymbol::withCString(kIOPMSettingRestartOnPowerLossKey), - OSSymbol::withCString(kIOPMSettingWakeOnClamshellKey), - OSSymbol::withCString(kIOPMSettingWakeOnACChangeKey), - OSSymbol::withCString(kIOPMSettingTimeZoneOffsetKey), - OSSymbol::withCString(kIOPMSettingDisplaySleepUsesDimKey), - OSSymbol::withCString(kIOPMSettingMobileMotionModuleKey), - OSSymbol::withCString(kIOPMSettingGraphicsSwitchKey), - OSSymbol::withCString(kIOPMStateConsoleShutdown), - gIOPMSettingSilentRunningKey - }; - - PE_parse_boot_argn("darkwake", &gDarkWakeFlags, sizeof(gDarkWakeFlags)); - - queue_init(&aggressivesQueue); - aggressivesThreadCall = thread_call_allocate(handleAggressivesFunction, this); - aggressivesData = OSData::withCapacity( - sizeof(AggressivesRecord) * (kPMLastAggressivenessType + 4)); - - featuresDictLock = IOLockAlloc(); - settingsCtrlLock = IOLockAlloc(); - setPMRootDomain(this); - - extraSleepTimer = thread_call_allocate( - idleSleepTimerExpired, - (thread_call_param_t) this); - - diskSyncCalloutEntry = thread_call_allocate( - &disk_sync_callout, - (thread_call_param_t) this); - - stackshotOffloader = thread_call_allocate(&saveTimeoutAppStackShot, - (thread_call_param_t) this); + return error; +} -#if DARK_TO_FULL_EVALUATE_CLAMSHELL - fullWakeThreadCall = thread_call_allocate( - OSMemberFunctionCast(thread_call_func_t, this, - &IOPMrootDomain::fullWakeDelayedWork), - (thread_call_param_t) this); -#endif +static SYSCTL_PROC(_kern, OID_AUTO, consoleoptions, + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_consoleoptions, "I", ""); - setProperty(kIOSleepSupportedKey, true); - - bzero(&gPMStats, sizeof(gPMStats)); - - pmTracer = PMTraceWorker::tracer(this); - - pmAssertions = PMAssertionsTracker::pmAssertionsTracker(this); - - userDisabledAllSleep = false; - systemBooting = true; - sleepSlider = 0; - idleSleepTimerPending = false; - wrangler = NULL; - clamshellClosed = false; - clamshellExists = false; - clamshellDisabled = true; - acAdaptorConnected = true; - clamshellSleepDisabled = false; - - // User active state at boot - fullWakeReason = kFullWakeReasonLocalUser; - userIsActive = userWasActive = true; - setProperty(gIOPMUserIsActiveKey, kOSBooleanTrue); - - // Set the default system capabilities at boot. - _currentCapability = kIOPMSystemCapabilityCPU | - kIOPMSystemCapabilityGraphics | - kIOPMSystemCapabilityAudio | - kIOPMSystemCapabilityNetwork; - - _pendingCapability = _currentCapability; - _desiredCapability = _currentCapability; - _highestCapability = _currentCapability; - setProperty(kIOPMSystemCapabilitiesKey, _currentCapability, 64); - - queuedSleepWakeUUIDString = NULL; - initializeBootSessionUUID(); - pmStatsAppResponses = OSArray::withCapacity(5); - _statsNameKey = OSSymbol::withCString(kIOPMStatsNameKey); - _statsPIDKey = OSSymbol::withCString(kIOPMStatsPIDKey); - _statsTimeMSKey = OSSymbol::withCString(kIOPMStatsTimeMSKey); - _statsResponseTypeKey = OSSymbol::withCString(kIOPMStatsApplicationResponseTypeKey); - _statsMessageTypeKey = OSSymbol::withCString(kIOPMStatsMessageTypeKey); - _statsPowerCapsKey = OSSymbol::withCString(kIOPMStatsPowerCapabilityKey); - noAckApps = OSOrderedSet::withCapacity(16); - - idxPMCPUClamshell = kCPUUnknownIndex; - idxPMCPULimitedPower = kCPUUnknownIndex; - - tmpDict = OSDictionary::withCapacity(1); - setProperty(kRootDomainSupportedFeatures, tmpDict); - tmpDict->release(); - - settingsCallbacks = OSDictionary::withCapacity(1); - - // Create a list of the valid PM settings that we'll relay to - // interested clients in setProperties() => setPMSetting() - allowedPMSettings = OSArray::withObjects( - (const OSObject **)settingsArr, - kRootDomainSettingsCount, - 0); - - // List of PM settings that should not automatically publish itself - // as a feature when registered by a listener. - noPublishPMSettings = OSArray::withObjects( - (const OSObject **) &gIOPMSettingSilentRunningKey, 1, 0); - - fPMSettingsDict = OSDictionary::withCapacity(5); - preventIdleSleepList = OSSet::withCapacity(8); - preventSystemSleepList = OSSet::withCapacity(2); - - PMinit(); // creates gIOPMWorkLoop - - // Create IOPMPowerStateQueue used to queue external power - // events, and to handle those events on the PM work loop. - pmPowerStateQueue = IOPMPowerStateQueue::PMPowerStateQueue( - this, OSMemberFunctionCast(IOEventSource::Action, this, - &IOPMrootDomain::dispatchPowerEvent)); - getPMworkloop()->addEventSource(pmPowerStateQueue); -#ifdef CHECK_THREAD_CONTEXT - gIOPMWorkLoop = getPMworkloop(); -#endif - // create our power parent - patriarch = new IORootParent; - patriarch->init(); - patriarch->attach(this); - patriarch->start(this); - patriarch->addPowerChild(this); - - registerPowerDriver(this, ourPowerStates, NUM_POWER_STATES); - changePowerStateToPriv(ON_STATE); - - if (gIOKitDebug & (kIOLogDriverPower1 | kIOLogDriverPower2)) - { - // Setup our PM logging & recording code - timeline = IOPMTimeline::timeline(this); - if (timeline) { - OSDictionary *tlInfo = timeline->copyInfoDictionary(); - - if (tlInfo) - { - setProperty(kIOPMTimelineDictionaryKey, tlInfo); - tlInfo->release(); - } - } - } - - // install power change handler - gSysPowerDownNotifier = registerPrioritySleepWakeInterest( &sysPowerDownHandler, this, 0); +static int +sysctl_progressoptions SYSCTL_HANDLER_ARGS +{ + return sysctl_io_opaque(req, &vc_user_options, sizeof(vc_user_options), NULL); +} -#if !NO_KERNEL_HID - // Register for a notification when IODisplayWrangler is published - if ((tmpDict = serviceMatching("IODisplayWrangler"))) - { - _displayWranglerNotifier = addMatchingNotification( - gIOPublishNotification, tmpDict, - (IOServiceMatchingNotificationHandler) &displayWranglerMatchPublished, - this, 0); - tmpDict->release(); - } -#endif +static SYSCTL_PROC(_kern, OID_AUTO, progressoptions, + CTLTYPE_STRUCT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED | CTLFLAG_ANYBODY, + NULL, 0, sysctl_progressoptions, "S,vc_progress_user_options", ""); -#if defined(__i386__) || defined(__x86_64__) - if ((tmpDict = serviceMatching("IODTNVRAM"))) - { - notifier = addMatchingNotification( - gIOFirstPublishNotification, tmpDict, - (IOServiceMatchingNotificationHandler) &IONVRAMMatchPublished, - this, 0); - tmpDict->release(); - } - - wranglerIdleSettings = NULL; - OSNumber * wranglerIdlePeriod = NULL; - wranglerIdleSettings = OSDictionary::withCapacity(1); - wranglerIdlePeriod = OSNumber::withNumber(kDefaultWranglerIdlePeriod, 32); - - if(wranglerIdleSettings && wranglerIdlePeriod) - wranglerIdleSettings->setObject(kIORequestWranglerIdleKey, - wranglerIdlePeriod); - - if(wranglerIdlePeriod) - wranglerIdlePeriod->release(); -#endif +static int +sysctl_wakereason SYSCTL_HANDLER_ARGS +{ + char wr[sizeof(gWakeReasonString)]; - const OSSymbol *ucClassName = OSSymbol::withCStringNoCopy("RootDomainUserClient"); - setProperty(gIOUserClientClassKey, (OSObject *) ucClassName); - ucClassName->release(); - - // IOBacklightDisplay can take a long time to load at boot, or it may - // not load at all if you're booting with clamshell closed. We publish - // 'DisplayDims' here redundantly to get it published early and at all. - psIterator = getMatchingServices( serviceMatching("IOPMPowerSource") ); - if( psIterator && psIterator->getNextObject() ) - { - // There's at least one battery on the system, so we publish - // 'DisplayDims' support for the LCD. - publishFeature("DisplayDims"); - } - if(psIterator) { - psIterator->release(); - } - - - pmSuspendedCapacity = pmSuspendedSize = 0; - pmSuspendedPIDS = NULL; - - - sysctl_register_oid(&sysctl__kern_sleeptime); - sysctl_register_oid(&sysctl__kern_waketime); - sysctl_register_oid(&sysctl__kern_willshutdown); - sysctl_register_oid(&sysctl__kern_progressmeterenable); - sysctl_register_oid(&sysctl__kern_progressmeter); - -#if HIBERNATION - IOHibernateSystemInit(this); -#endif + wr[0] = '\0'; + if (gRootDomain) { + gRootDomain->copyWakeReasonString(wr, sizeof(wr)); + } - registerService(); // let clients find us - - return true; -} - - - - -void IOPMrootDomain::handleSuspendPMNotificationClient(uint32_t pid, bool doSuspend) -{ - ASSERT_GATED(); - - int index = -1; - unsigned int i; - - if (!pmSuspendedPIDS) { - pmSuspendedCapacity = 8; - pmSuspendedSize = pmSuspendedCapacity * sizeof(PMNotifySuspendedStruct); - pmSuspendedPIDS = (PMNotifySuspendedStruct *)IOMalloc(pmSuspendedSize); - bzero(pmSuspendedPIDS, pmSuspendedSize); - } - - /* Find the existing pid in the existing array */ - - for (i=0; i < pmSuspendedCapacity; i++) { - if (pmSuspendedPIDS[i].pid == pid) { - index = i; - break; - } - } - - if (-1 == index) - { - /* Find an unused slot in the suspended pids table. */ - - for (i=0; i < pmSuspendedCapacity; i++) { - if (pmSuspendedPIDS[i].refcount == 0) { - break; - } - } - - if (pmSuspendedCapacity == i) - { - /* GROW if necessary */ - - PMNotifySuspendedStruct *newSuspended = NULL; - pmSuspendedCapacity *= 2; - pmSuspendedSize = pmSuspendedCapacity * sizeof(PMNotifySuspendedStruct); - newSuspended = (PMNotifySuspendedStruct *)IOMalloc(pmSuspendedSize); - - bzero(newSuspended, pmSuspendedSize); - bcopy(pmSuspendedPIDS, newSuspended, pmSuspendedSize/2); - IOFree(pmSuspendedPIDS, pmSuspendedSize/2); - - pmSuspendedPIDS = newSuspended; - } - - index = i; - pmSuspendedPIDS[index].pid = pid; - } - - if (doSuspend) { - pmSuspendedPIDS[index].refcount++; - } else { - pmSuspendedPIDS[index].refcount--; - } - - /* - * Publish array of suspended pids in IOPMrootDomain - */ - OSArray *publish = OSArray::withCapacity(pmSuspendedCapacity); - - for (i=0; i 0) { - OSDictionary *suspended = OSDictionary::withCapacity(2); - OSNumber *n = NULL; - - n = OSNumber::withNumber(pmSuspendedPIDS[i].pid, 32); - suspended->setObject("pid", n); - n->release(); - - n = OSNumber::withNumber(pmSuspendedPIDS[i].refcount, 32); - suspended->setObject("refcount", n); - n->release(); - - publish->setObject(suspended); - suspended->release(); - - } - } - - if (0 != publish->getCount()) { - setProperty(kPMSuspendedNotificationClients, publish); - } else { - removeProperty(kPMSuspendedNotificationClients); - } - - publish->release(); - - return; -} - -bool IOPMrootDomain::pmNotificationIsSuspended(uint32_t pid) -{ - unsigned int index; - - for (index=0; index < pmSuspendedCapacity; index++) { - if (pmSuspendedPIDS[index].pid == pid) { - return pmSuspendedPIDS[index].refcount > 0; - } - } - - return false; -} - - -void IOPMrootDomain::suspendPMNotificationsForPID(uint32_t pid, bool doSuspend) -{ - if(pmPowerStateQueue) { - pmPowerStateQueue->submitPowerEvent(kPowerEventSuspendClient, (void *)(uintptr_t)pid, (uint64_t)doSuspend ); - } - return; + return sysctl_io_string(req, wr, 0, 0, NULL); } -//****************************************************************************** -// setProperties -// -// Receive a setProperty call -// The "System Boot" property means the system is completely booted. -//****************************************************************************** - -IOReturn IOPMrootDomain::setProperties( OSObject * props_obj ) -{ - IOReturn return_value = kIOReturnSuccess; - OSDictionary *dict = OSDynamicCast(OSDictionary, props_obj); - OSBoolean *b; - OSNumber *n; - OSDictionary *d; - const OSSymbol *key; - OSObject *obj; - OSCollectionIterator * iter = 0; - - const OSSymbol *publish_simulated_battery_string = OSSymbol::withCString("SoftwareSimulatedBatteries"); - const OSSymbol *boot_complete_string = OSSymbol::withCString("System Boot Complete"); - const OSSymbol *sys_shutdown_string = OSSymbol::withCString("System Shutdown"); - const OSSymbol *stall_halt_string = OSSymbol::withCString("StallSystemAtHalt"); - const OSSymbol *battery_warning_disabled_string = OSSymbol::withCString("BatteryWarningsDisabled"); - const OSSymbol *idle_seconds_string = OSSymbol::withCString("System Idle Seconds"); - const OSSymbol *sleepdisabled_string = OSSymbol::withCString("SleepDisabled"); - const OSSymbol *ondeck_sleepwake_uuid_string = OSSymbol::withCString(kIOPMSleepWakeUUIDKey); - const OSSymbol *loginwindow_tracepoint_string = OSSymbol::withCString(kIOPMLoginWindowSecurityDebugKey); - const OSSymbol *pmTimelineLogging_string = OSSymbol::withCString(kIOPMTimelineDictionaryKey); -#if HIBERNATION - const OSSymbol *hibernatemode_string = OSSymbol::withCString(kIOHibernateModeKey); - const OSSymbol *hibernatefile_string = OSSymbol::withCString(kIOHibernateFileKey); - const OSSymbol *hibernatefilemin_string = OSSymbol::withCString(kIOHibernateFileMinSizeKey); - const OSSymbol *hibernatefilemax_string = OSSymbol::withCString(kIOHibernateFileMaxSizeKey); - const OSSymbol *hibernatefreeratio_string = OSSymbol::withCString(kIOHibernateFreeRatioKey); - const OSSymbol *hibernatefreetime_string = OSSymbol::withCString(kIOHibernateFreeTimeKey); -#endif -#if SUSPEND_PM_NOTIFICATIONS_DEBUG - const OSSymbol *suspendPMClient_string = OSSymbol::withCString(kPMSuspendedNotificationClients); -#endif - - if (!dict) - { - return_value = kIOReturnBadArgument; - goto exit; - } - - iter = OSCollectionIterator::withCollection(dict); - if (!iter) - { - return_value = kIOReturnNoMemory; - goto exit; - } - - while ((key = (const OSSymbol *) iter->getNextObject()) && - (obj = dict->getObject(key))) - { - if (key->isEqualTo(publish_simulated_battery_string)) - { - if (OSDynamicCast(OSBoolean, obj)) - publishResource(key, kOSBooleanTrue); - } - else if (key->isEqualTo(idle_seconds_string)) - { - if ((n = OSDynamicCast(OSNumber, obj))) - { - setProperty(key, n); - idleSeconds = n->unsigned32BitValue(); - } - } - else if (key->isEqualTo(boot_complete_string)) - { - pmPowerStateQueue->submitPowerEvent(kPowerEventSystemBootCompleted); - } - else if (key->isEqualTo(sys_shutdown_string)) - { - if ((b = OSDynamicCast(OSBoolean, obj))) - pmPowerStateQueue->submitPowerEvent(kPowerEventSystemShutdown, (void *) b); - } - else if (key->isEqualTo(battery_warning_disabled_string)) - { - setProperty(key, obj); - } - else if (key->isEqualTo(pmTimelineLogging_string)) - { - if ((d = OSDynamicCast(OSDictionary, obj)) && - timeline && timeline->setProperties(d)) - { - OSDictionary *tlInfo = timeline->copyInfoDictionary(); - if (tlInfo) { - setProperty(kIOPMTimelineDictionaryKey, tlInfo); - tlInfo->release(); - } - } - } -#if HIBERNATION - else if (key->isEqualTo(hibernatemode_string) || - key->isEqualTo(hibernatefilemin_string) || - key->isEqualTo(hibernatefilemax_string) || - key->isEqualTo(hibernatefreeratio_string) || - key->isEqualTo(hibernatefreetime_string)) - { - if ((n = OSDynamicCast(OSNumber, obj))) - setProperty(key, n); - } - else if (key->isEqualTo(hibernatefile_string)) - { - OSString * str = OSDynamicCast(OSString, obj); - if (str) setProperty(key, str); - } -#endif - else if (key->isEqualTo(sleepdisabled_string)) - { - if ((b = OSDynamicCast(OSBoolean, obj))) - { - setProperty(key, b); - pmPowerStateQueue->submitPowerEvent(kPowerEventUserDisabledSleep, (void *) b); - } - } - else if (key->isEqualTo(ondeck_sleepwake_uuid_string)) - { - obj->retain(); - pmPowerStateQueue->submitPowerEvent(kPowerEventQueueSleepWakeUUID, (void *)obj); - } - else if (key->isEqualTo(loginwindow_tracepoint_string)) - { - if (pmTracer && (n = OSDynamicCast(OSNumber, obj))) - pmTracer->traceLoginWindowPhase(n->unsigned8BitValue()); - } - else if (key->isEqualTo(kIOPMDeepSleepEnabledKey) || - key->isEqualTo(kIOPMDestroyFVKeyOnStandbyKey) || - key->isEqualTo(kIOPMAutoPowerOffEnabledKey) || - key->isEqualTo(stall_halt_string)) - { - if ((b = OSDynamicCast(OSBoolean, obj))) - setProperty(key, b); - } - else if (key->isEqualTo(kIOPMDeepSleepDelayKey) || - key->isEqualTo(kIOPMAutoPowerOffDelayKey) || - key->isEqualTo(kIOPMAutoPowerOffTimerKey)) - { - if ((n = OSDynamicCast(OSNumber, obj))) - setProperty(key, n); - } - else if (key->isEqualTo(kIOPMUserWakeAlarmScheduledKey)) - { - if (kOSBooleanTrue == obj) - OSBitOrAtomic(kIOPMAlarmBitCalendarWake, &_userScheduledAlarm); - else - OSBitAndAtomic(~kIOPMAlarmBitCalendarWake, &_userScheduledAlarm); - DLOG("_userScheduledAlarm = 0x%x\n", (uint32_t) _userScheduledAlarm); - } -#if SUSPEND_PM_NOTIFICATIONS_DEBUG - else if (key->isEqualTo(suspendPMClient_string)) - { - if ((n = OSDynamicCast(OSNumber, obj))) - { - // Toggle the suspended status for pid n. - uint32_t pid_int = n->unsigned32BitValue(); - suspendPMNotificationsForPID(pid_int, !pmNotificationIsSuspended(pid_int)); - } - } -#endif - // Relay our allowed PM settings onto our registered PM clients - else if ((allowedPMSettings->getNextIndexOfObject(key, 0) != (unsigned int) -1)) - { - if ((gIOPMSettingAutoWakeSecondsKey == key) && ((n = OSDynamicCast(OSNumber, obj)))) - { - UInt32 rsecs = n->unsigned32BitValue(); - if (!rsecs) - autoWakeStart = autoWakeEnd = 0; - else - { - AbsoluteTime deadline; - clock_interval_to_deadline(rsecs + kAutoWakePostWindow, kSecondScale, &deadline); - autoWakeEnd = AbsoluteTime_to_scalar(&deadline); - if (rsecs > kAutoWakePreWindow) - rsecs -= kAutoWakePreWindow; - else - rsecs = 0; - clock_interval_to_deadline(rsecs, kSecondScale, &deadline); - autoWakeStart = AbsoluteTime_to_scalar(&deadline); - } - } - - return_value = setPMSetting(key, obj); - if (kIOReturnSuccess != return_value) - break; - - if (gIOPMSettingDebugWakeRelativeKey == key) - { - if ((n = OSDynamicCast(OSNumber, obj)) && - (_debugWakeSeconds = n->unsigned32BitValue())) - { - OSBitOrAtomic(kIOPMAlarmBitDebugWake, &_scheduledAlarms); - } - else - { - _debugWakeSeconds = 0; - OSBitAndAtomic(~kIOPMAlarmBitDebugWake, &_scheduledAlarms); - } - DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); - } - else if (gIOPMSettingAutoWakeCalendarKey == key) - { - OSData * data; - if ((data = OSDynamicCast(OSData, obj)) && - (data->getLength() == sizeof(IOPMCalendarStruct))) - { - const IOPMCalendarStruct * cs = - (const IOPMCalendarStruct *) data->getBytesNoCopy(); - - if (cs->year) - OSBitOrAtomic(kIOPMAlarmBitCalendarWake, &_scheduledAlarms); - else - OSBitAndAtomic(~kIOPMAlarmBitCalendarWake, &_scheduledAlarms); - DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); - } - } - } - else - { - DLOG("setProperties(%s) not handled\n", key->getCStringNoCopy()); - } - } +SYSCTL_PROC(_kern, OID_AUTO, wakereason, + CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_wakereason, "A", "wakereason"); -exit: - if(publish_simulated_battery_string) publish_simulated_battery_string->release(); - if(boot_complete_string) boot_complete_string->release(); - if(sys_shutdown_string) sys_shutdown_string->release(); - if(stall_halt_string) stall_halt_string->release(); - if(battery_warning_disabled_string) battery_warning_disabled_string->release(); - if(idle_seconds_string) idle_seconds_string->release(); - if(sleepdisabled_string) sleepdisabled_string->release(); - if(ondeck_sleepwake_uuid_string) ondeck_sleepwake_uuid_string->release(); - if(loginwindow_tracepoint_string) loginwindow_tracepoint_string->release(); - if(pmTimelineLogging_string) pmTimelineLogging_string->release(); -#if HIBERNATION - if(hibernatemode_string) hibernatemode_string->release(); - if(hibernatefile_string) hibernatefile_string->release(); - if(hibernatefreeratio_string) hibernatefreeratio_string->release(); - if(hibernatefreetime_string) hibernatefreetime_string->release(); -#endif -#if SUSPEND_PM_NOTIFICATIONS_DEBUG - if(suspendPMClient_string) suspendPMClient_string->release(); -#endif - if (iter) iter->release(); - return return_value; +static int +sysctl_targettype SYSCTL_HANDLER_ARGS +{ + IOService * root; + OSObject * obj; + OSData * data; + char tt[32]; + + tt[0] = '\0'; + root = IOService::getServiceRoot(); + if (root && (obj = root->copyProperty(gIODTTargetTypeKey))) { + if ((data = OSDynamicCast(OSData, obj))) { + strlcpy(tt, (const char *) data->getBytesNoCopy(), sizeof(tt)); + } + obj->release(); + } + return sysctl_io_string(req, tt, 0, 0, NULL); } -// MARK: - -// MARK: Aggressiveness +SYSCTL_PROC(_hw, OID_AUTO, targettype, + CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_targettype, "A", "targettype"); +static SYSCTL_INT(_debug, OID_AUTO, darkwake, CTLFLAG_RW, &gDarkWakeFlags, 0, ""); +static SYSCTL_INT(_debug, OID_AUTO, noidle, CTLFLAG_RW, &gNoIdleFlag, 0, ""); +static SYSCTL_INT(_debug, OID_AUTO, swd_sleep_timeout, CTLFLAG_RW, &gSwdSleepTimeout, 0, ""); +static SYSCTL_INT(_debug, OID_AUTO, swd_wake_timeout, CTLFLAG_RW, &gSwdWakeTimeout, 0, ""); +static SYSCTL_INT(_debug, OID_AUTO, swd_timeout, CTLFLAG_RW, &gSwdSleepWakeTimeout, 0, ""); +static SYSCTL_INT(_debug, OID_AUTO, swd_panic, CTLFLAG_RW, &gSwdPanic, 0, ""); +#if DEVELOPMENT || DEBUG +static SYSCTL_INT(_debug, OID_AUTO, swd_panic_phase, CTLFLAG_RW, &swd_panic_phase, 0, ""); +#endif + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) //****************************************************************************** -// setAggressiveness -// -// Override IOService::setAggressiveness() -//****************************************************************************** +// AOT -IOReturn IOPMrootDomain::setAggressiveness( - unsigned long type, - unsigned long value ) +static int +sysctl_aotmetrics SYSCTL_HANDLER_ARGS { - return setAggressiveness( type, value, 0 ); -} - -/* - * Private setAggressiveness() with an internal options argument. - */ -IOReturn IOPMrootDomain::setAggressiveness( - unsigned long type, - unsigned long value, - IOOptionBits options ) -{ - AggressivesRequest * entry; - AggressivesRequest * request; - bool found = false; - - DLOG("setAggressiveness(%x) 0x%x = %u\n", - (uint32_t) options, (uint32_t) type, (uint32_t) value); - - request = IONew(AggressivesRequest, 1); - if (!request) - return kIOReturnNoMemory; - - memset(request, 0, sizeof(*request)); - request->options = options; - request->dataType = kAggressivesRequestTypeRecord; - request->data.record.type = (uint32_t) type; - request->data.record.value = (uint32_t) value; - - AGGRESSIVES_LOCK(); - - // Update disk quick spindown flag used by getAggressiveness(). - // Never merge requests with quick spindown flags set. - - if (options & kAggressivesOptionQuickSpindownEnable) - gAggressivesState |= kAggressivesStateQuickSpindown; - else if (options & kAggressivesOptionQuickSpindownDisable) - gAggressivesState &= ~kAggressivesStateQuickSpindown; - else - { - // Coalesce requests with identical aggressives types. - // Deal with callers that calls us too "aggressively". - - queue_iterate(&aggressivesQueue, entry, AggressivesRequest *, chain) - { - if ((entry->dataType == kAggressivesRequestTypeRecord) && - (entry->data.record.type == type) && - ((entry->options & kAggressivesOptionQuickSpindownMask) == 0)) - { - entry->data.record.value = value; - found = true; - break; - } - } - } - - if (!found) - { - queue_enter(&aggressivesQueue, request, AggressivesRequest *, chain); - } - - AGGRESSIVES_UNLOCK(); - - if (found) - IODelete(request, AggressivesRequest, 1); - - if (options & kAggressivesOptionSynchronous) - handleAggressivesRequests(); // not truly synchronous - else - thread_call_enter(aggressivesThreadCall); - - return kIOReturnSuccess; + if (NULL == gRootDomain) { + return ENOENT; + } + if (NULL == gRootDomain->_aotMetrics) { + return ENOENT; + } + return sysctl_io_opaque(req, gRootDomain->_aotMetrics, sizeof(IOPMAOTMetrics), NULL); } -//****************************************************************************** -// getAggressiveness -// -// Override IOService::setAggressiveness() -// Fetch the aggressiveness factor with the given type. -//****************************************************************************** - -IOReturn IOPMrootDomain::getAggressiveness ( - unsigned long type, - unsigned long * outLevel ) -{ - uint32_t value = 0; - int source = 0; - - if (!outLevel) - return kIOReturnBadArgument; - - AGGRESSIVES_LOCK(); - - // Disk quick spindown in effect, report value = 1 - - if ((gAggressivesState & kAggressivesStateQuickSpindown) && - (type == kPMMinutesToSpinDown)) - { - value = kAggressivesMinValue; - source = 1; - } - - // Consult the pending request queue. - - if (!source) - { - AggressivesRequest * entry; - - queue_iterate(&aggressivesQueue, entry, AggressivesRequest *, chain) - { - if ((entry->dataType == kAggressivesRequestTypeRecord) && - (entry->data.record.type == type) && - ((entry->options & kAggressivesOptionQuickSpindownMask) == 0)) - { - value = entry->data.record.value; - source = 2; - break; - } - } - } - - // Consult the backend records. - - if (!source && aggressivesData) - { - AggressivesRecord * record; - int i, count; - - count = aggressivesData->getLength() / sizeof(AggressivesRecord); - record = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); - - for (i = 0; i < count; i++, record++) - { - if (record->type == type) - { - value = record->value; - source = 3; - break; - } - } - } - - AGGRESSIVES_UNLOCK(); - - if (source) - { - DLOG("getAggressiveness(%d) 0x%x = %u\n", - source, (uint32_t) type, value); - *outLevel = (unsigned long) value; - return kIOReturnSuccess; - } - else - { - DLOG("getAggressiveness type 0x%x not found\n", (uint32_t) type); - *outLevel = 0; // default return = 0, driver may not check for error - return kIOReturnInvalid; - } -} +static SYSCTL_PROC(_kern, OID_AUTO, aotmetrics, + CTLTYPE_STRUCT | CTLFLAG_RD | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED | CTLFLAG_ANYBODY, + NULL, 0, sysctl_aotmetrics, "S,IOPMAOTMetrics", ""); -//****************************************************************************** -// joinAggressiveness -// -// Request from IOService to join future aggressiveness broadcasts. -//****************************************************************************** -IOReturn IOPMrootDomain::joinAggressiveness( - IOService * service ) +static int +update_aotmode(uint32_t mode) { - AggressivesRequest * request; - - if (!service || (service == this)) - return kIOReturnBadArgument; + int result; - DLOG("joinAggressiveness %s %p\n", service->getName(), OBFUSCATE(service)); + if (!gIOPMWorkLoop) { + return ENOENT; + } + result = gIOPMWorkLoop->runActionBlock(^IOReturn (void) { + unsigned int oldCount; - request = IONew(AggressivesRequest, 1); - if (!request) - return kIOReturnNoMemory; + if (mode && !gRootDomain->_aotMetrics) { + gRootDomain->_aotMetrics = IONewZero(IOPMAOTMetrics, 1); + if (!gRootDomain->_aotMetrics) { + return ENOMEM; + } + } - service->retain(); // released by synchronizeAggressives() + oldCount = gRootDomain->idleSleepPreventersCount(); + gRootDomain->_aotMode = mode; + gRootDomain->updatePreventIdleSleepListInternal(NULL, false, oldCount); + return 0; + }); + return result; +} - memset(request, 0, sizeof(*request)); - request->dataType = kAggressivesRequestTypeService; - request->data.service = service; - - AGGRESSIVES_LOCK(); - queue_enter(&aggressivesQueue, request, AggressivesRequest *, chain); - AGGRESSIVES_UNLOCK(); +static int +sysctl_aotmodebits +(__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) +{ + int error, changed; + uint32_t new_value; - thread_call_enter(aggressivesThreadCall); + if (NULL == gRootDomain) { + return ENOENT; + } + error = sysctl_io_number(req, gRootDomain->_aotMode, sizeof(uint32_t), &new_value, &changed); + if (changed && gIOPMWorkLoop) { + error = update_aotmode(new_value); + } - return kIOReturnSuccess; + return error; } -//****************************************************************************** -// handleAggressivesRequests -// -// Backend thread processes all incoming aggressiveness requests in the queue. -//****************************************************************************** - -static void -handleAggressivesFunction( - thread_call_param_t param1, - thread_call_param_t param2 ) -{ - if (param1) - { - ((IOPMrootDomain *) param1)->handleAggressivesRequests(); - } -} - -void IOPMrootDomain::handleAggressivesRequests( void ) -{ - AggressivesRecord * start; - AggressivesRecord * record; - AggressivesRequest * request; - queue_head_t joinedQueue; - int i, count; - bool broadcast; - bool found; - bool pingSelf = false; - - AGGRESSIVES_LOCK(); - - if ((gAggressivesState & kAggressivesStateBusy) || !aggressivesData || - queue_empty(&aggressivesQueue)) - goto unlock_done; - - gAggressivesState |= kAggressivesStateBusy; - count = aggressivesData->getLength() / sizeof(AggressivesRecord); - start = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); - - do - { - broadcast = false; - queue_init(&joinedQueue); - - do - { - // Remove request from the incoming queue in FIFO order. - queue_remove_first(&aggressivesQueue, request, AggressivesRequest *, chain); - switch (request->dataType) - { - case kAggressivesRequestTypeRecord: - // Update existing record if found. - found = false; - for (i = 0, record = start; i < count; i++, record++) - { - if (record->type == request->data.record.type) - { - found = true; - - if (request->options & kAggressivesOptionQuickSpindownEnable) - { - if ((record->flags & kAggressivesRecordFlagMinValue) == 0) - { - broadcast = true; - record->flags |= (kAggressivesRecordFlagMinValue | - kAggressivesRecordFlagModified); - DLOG("disk spindown accelerated, was %u min\n", - record->value); - } - } - else if (request->options & kAggressivesOptionQuickSpindownDisable) - { - if (record->flags & kAggressivesRecordFlagMinValue) - { - broadcast = true; - record->flags |= kAggressivesRecordFlagModified; - record->flags &= ~kAggressivesRecordFlagMinValue; - DLOG("disk spindown restored to %u min\n", - record->value); - } - } - else if (record->value != request->data.record.value) - { - record->value = request->data.record.value; - if ((record->flags & kAggressivesRecordFlagMinValue) == 0) - { - broadcast = true; - record->flags |= kAggressivesRecordFlagModified; - } - } - break; - } - } - - // No matching record, append a new record. - if (!found && - ((request->options & kAggressivesOptionQuickSpindownDisable) == 0)) - { - AggressivesRecord newRecord; - - newRecord.flags = kAggressivesRecordFlagModified; - newRecord.type = request->data.record.type; - newRecord.value = request->data.record.value; - if (request->options & kAggressivesOptionQuickSpindownEnable) - { - newRecord.flags |= kAggressivesRecordFlagMinValue; - DLOG("disk spindown accelerated\n"); - } - - aggressivesData->appendBytes(&newRecord, sizeof(newRecord)); - - // OSData may have switched to another (larger) buffer. - count = aggressivesData->getLength() / sizeof(AggressivesRecord); - start = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); - broadcast = true; - } - - // Finished processing the request, release it. - IODelete(request, AggressivesRequest, 1); - break; - - case kAggressivesRequestTypeService: - // synchronizeAggressives() will free request. - queue_enter(&joinedQueue, request, AggressivesRequest *, chain); - break; - - default: - panic("bad aggressives request type %x\n", request->dataType); - break; - } - } while (!queue_empty(&aggressivesQueue)); - - // Release the lock to perform work, with busy flag set. - if (!queue_empty(&joinedQueue) || broadcast) - { - AGGRESSIVES_UNLOCK(); - if (!queue_empty(&joinedQueue)) - synchronizeAggressives(&joinedQueue, start, count); - if (broadcast) - broadcastAggressives(start, count); - AGGRESSIVES_LOCK(); - } - - // Remove the modified flag from all records. - for (i = 0, record = start; i < count; i++, record++) - { - if ((record->flags & kAggressivesRecordFlagModified) && - ((record->type == kPMMinutesToDim) || - (record->type == kPMMinutesToSleep))) - pingSelf = true; - - record->flags &= ~kAggressivesRecordFlagModified; - } - - // Check the incoming queue again since new entries may have been - // added while lock was released above. - - } while (!queue_empty(&aggressivesQueue)); - - gAggressivesState &= ~kAggressivesStateBusy; +static SYSCTL_PROC(_kern, OID_AUTO, aotmodebits, + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED, + NULL, 0, sysctl_aotmodebits, "I", ""); -unlock_done: - AGGRESSIVES_UNLOCK(); +static int +sysctl_aotmode +(__unused struct sysctl_oid *oidp, __unused void *arg1, __unused int arg2, struct sysctl_req *req) +{ + int error, changed; + uint32_t new_value; - // Root domain is interested in system and display sleep slider changes. - // Submit a power event to handle those changes on the PM work loop. + if (NULL == gRootDomain) { + return ENOENT; + } + error = sysctl_io_number(req, gRootDomain->_aotMode, sizeof(uint32_t), &new_value, &changed); + if (changed && gIOPMWorkLoop) { + if (new_value) { + new_value = kIOPMAOTModeDefault; // & ~kIOPMAOTModeRespectTimers; + } + error = update_aotmode(new_value); + } - if (pingSelf && pmPowerStateQueue) { - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusAggressivenessChanged ); - } + return error; } -//****************************************************************************** -// synchronizeAggressives -// -// Push all known aggressiveness records to one or more IOService. -//****************************************************************************** - -void IOPMrootDomain::synchronizeAggressives( - queue_head_t * joinedQueue, - const AggressivesRecord * array, - int count ) -{ - IOService * service; - AggressivesRequest * request; - const AggressivesRecord * record; - IOPMDriverCallEntry callEntry; - uint32_t value; - int i; - - while (!queue_empty(joinedQueue)) - { - queue_remove_first(joinedQueue, request, AggressivesRequest *, chain); - if (request->dataType == kAggressivesRequestTypeService) - service = request->data.service; - else - service = 0; - - IODelete(request, AggressivesRequest, 1); - request = 0; - - if (service) - { - if (service->assertPMDriverCall(&callEntry)) - { - for (i = 0, record = array; i < count; i++, record++) - { - value = record->value; - if (record->flags & kAggressivesRecordFlagMinValue) - value = kAggressivesMinValue; - - _LOG("synchronizeAggressives 0x%x = %u to %s\n", - record->type, value, service->getName()); - service->setAggressiveness(record->type, value); - } - service->deassertPMDriverCall(&callEntry); - } - service->release(); // retained by joinAggressiveness() - } - } -} +static SYSCTL_PROC(_kern, OID_AUTO, aotmode, + CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NOAUTO | CTLFLAG_KERN | CTLFLAG_LOCKED | CTLFLAG_ANYBODY, + NULL, 0, sysctl_aotmode, "I", ""); //****************************************************************************** -// broadcastAggressives -// -// Traverse PM tree and call setAggressiveness() for records that have changed. -//****************************************************************************** +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ -void IOPMrootDomain::broadcastAggressives( - const AggressivesRecord * array, - int count ) -{ - IORegistryIterator * iter; - IORegistryEntry * entry; - IOPowerConnection * connect; - IOService * service; - const AggressivesRecord * record; - IOPMDriverCallEntry callEntry; - uint32_t value; - int i; - - iter = IORegistryIterator::iterateOver( - this, gIOPowerPlane, kIORegistryIterateRecursively); - if (iter) - { - do - { - iter->reset(); - while ((entry = iter->getNextObject())) - { - connect = OSDynamicCast(IOPowerConnection, entry); - if (!connect || !connect->getReadyFlag()) - continue; - - if ((service = (IOService *) connect->copyChildEntry(gIOPowerPlane))) - { - if (service->assertPMDriverCall(&callEntry)) - { - for (i = 0, record = array; i < count; i++, record++) - { - if (record->flags & kAggressivesRecordFlagModified) - { - value = record->value; - if (record->flags & kAggressivesRecordFlagMinValue) - value = kAggressivesMinValue; - _LOG("broadcastAggressives %x = %u to %s\n", - record->type, value, service->getName()); - service->setAggressiveness(record->type, value); - } - } - service->deassertPMDriverCall(&callEntry); - } - service->release(); - } - } - } - while (!entry && !iter->isValid()); - iter->release(); - } -} -// MARK: - -// MARK: System Sleep +static const OSSymbol * gIOPMSettingAutoWakeCalendarKey; +static const OSSymbol * gIOPMSettingAutoWakeSecondsKey; +static const OSSymbol * gIOPMSettingAutoPowerCalendarKey; +static const OSSymbol * gIOPMSettingAutoPowerSecondsKey; +static const OSSymbol * gIOPMSettingDebugWakeRelativeKey; +static const OSSymbol * gIOPMSettingDebugPowerRelativeKey; +static const OSSymbol * gIOPMSettingMaintenanceWakeCalendarKey; +static const OSSymbol * gIOPMSettingSleepServiceWakeCalendarKey; +static const OSSymbol * gIOPMSettingSilentRunningKey; +static const OSSymbol * gIOPMUserTriggeredFullWakeKey; +static const OSSymbol * gIOPMUserIsActiveKey; //****************************************************************************** -// startIdleSleepTimer +// start // //****************************************************************************** -void IOPMrootDomain::startIdleSleepTimer( uint32_t inSeconds ) +#define kRootDomainSettingsCount 19 +#define kRootDomainNoPublishSettingsCount 3 + +bool +IOPMrootDomain::start( IOService * nub ) { - AbsoluteTime deadline; + OSIterator *psIterator; + OSDictionary *tmpDict; + IORootParent * patriarch; - ASSERT_GATED(); - if (inSeconds) - { - clock_interval_to_deadline(inSeconds, kSecondScale, &deadline); - thread_call_enter_delayed(extraSleepTimer, deadline); - idleSleepTimerPending = true; - } - else - { - thread_call_enter(extraSleepTimer); - } - DLOG("idle timer set for %u seconds\n", inSeconds); -} + super::start(nub); -//****************************************************************************** -// cancelIdleSleepTimer -// -//****************************************************************************** + gRootDomain = this; + gIOPMSettingAutoWakeCalendarKey = OSSymbol::withCString(kIOPMSettingAutoWakeCalendarKey); + gIOPMSettingAutoWakeSecondsKey = OSSymbol::withCString(kIOPMSettingAutoWakeSecondsKey); + gIOPMSettingAutoPowerCalendarKey = OSSymbol::withCString(kIOPMSettingAutoPowerCalendarKey); + gIOPMSettingAutoPowerSecondsKey = OSSymbol::withCString(kIOPMSettingAutoPowerSecondsKey); + gIOPMSettingDebugWakeRelativeKey = OSSymbol::withCString(kIOPMSettingDebugWakeRelativeKey); + gIOPMSettingDebugPowerRelativeKey = OSSymbol::withCString(kIOPMSettingDebugPowerRelativeKey); + gIOPMSettingMaintenanceWakeCalendarKey = OSSymbol::withCString(kIOPMSettingMaintenanceWakeCalendarKey); + gIOPMSettingSleepServiceWakeCalendarKey = OSSymbol::withCString(kIOPMSettingSleepServiceWakeCalendarKey); + gIOPMSettingSilentRunningKey = OSSymbol::withCStringNoCopy(kIOPMSettingSilentRunningKey); + gIOPMUserTriggeredFullWakeKey = OSSymbol::withCStringNoCopy(kIOPMUserTriggeredFullWakeKey); + gIOPMUserIsActiveKey = OSSymbol::withCStringNoCopy(kIOPMUserIsActiveKey); -void IOPMrootDomain::cancelIdleSleepTimer( void ) -{ - ASSERT_GATED(); - if (idleSleepTimerPending) - { - DLOG("idle timer cancelled\n"); - thread_call_cancel(extraSleepTimer); - idleSleepTimerPending = false; - } -} + gIOPMStatsResponseTimedOut = OSSymbol::withCString(kIOPMStatsResponseTimedOut); + gIOPMStatsResponseCancel = OSSymbol::withCString(kIOPMStatsResponseCancel); + gIOPMStatsResponseSlow = OSSymbol::withCString(kIOPMStatsResponseSlow); + gIOPMStatsResponsePrompt = OSSymbol::withCString(kIOPMStatsResponsePrompt); + gIOPMStatsDriverPSChangeSlow = OSSymbol::withCString(kIOPMStatsDriverPSChangeSlow); -//****************************************************************************** -// idleSleepTimerExpired -// -//****************************************************************************** + sleepSupportedPEFunction = OSSymbol::withCString("IOPMSetSleepSupported"); + sleepMessagePEFunction = OSSymbol::withCString("IOPMSystemSleepMessage"); -static void idleSleepTimerExpired( - thread_call_param_t us, thread_call_param_t ) -{ - ((IOPMrootDomain *)us)->handleSleepTimerExpiration(); -} + const OSSymbol *settingsArr[kRootDomainSettingsCount] = + { + OSSymbol::withCString(kIOPMSettingSleepOnPowerButtonKey), + gIOPMSettingAutoWakeSecondsKey, + gIOPMSettingAutoPowerSecondsKey, + gIOPMSettingAutoWakeCalendarKey, + gIOPMSettingAutoPowerCalendarKey, + gIOPMSettingDebugWakeRelativeKey, + gIOPMSettingDebugPowerRelativeKey, + OSSymbol::withCString(kIOPMSettingWakeOnRingKey), + OSSymbol::withCString(kIOPMSettingRestartOnPowerLossKey), + OSSymbol::withCString(kIOPMSettingWakeOnClamshellKey), + OSSymbol::withCString(kIOPMSettingWakeOnACChangeKey), + OSSymbol::withCString(kIOPMSettingTimeZoneOffsetKey), + OSSymbol::withCString(kIOPMSettingDisplaySleepUsesDimKey), + OSSymbol::withCString(kIOPMSettingMobileMotionModuleKey), + OSSymbol::withCString(kIOPMSettingGraphicsSwitchKey), + OSSymbol::withCString(kIOPMStateConsoleShutdown), + OSSymbol::withCString(kIOPMSettingProModeControl), + OSSymbol::withCString(kIOPMSettingProModeDefer), + gIOPMSettingSilentRunningKey, + }; + + const OSSymbol *noPublishSettingsArr[kRootDomainNoPublishSettingsCount] = + { + OSSymbol::withCString(kIOPMSettingProModeControl), + OSSymbol::withCString(kIOPMSettingProModeDefer), + gIOPMSettingSilentRunningKey, + }; + + PE_parse_boot_argn("darkwake", &gDarkWakeFlags, sizeof(gDarkWakeFlags)); + PE_parse_boot_argn("noidle", &gNoIdleFlag, sizeof(gNoIdleFlag)); + PE_parse_boot_argn("swd_sleeptimeout", &gSwdSleepTimeout, sizeof(gSwdSleepTimeout)); + PE_parse_boot_argn("swd_waketimeout", &gSwdWakeTimeout, sizeof(gSwdWakeTimeout)); + PE_parse_boot_argn("swd_timeout", &gSwdSleepWakeTimeout, sizeof(gSwdSleepWakeTimeout)); + PE_parse_boot_argn("haltmspanic", &gHaltTimeMaxPanic, sizeof(gHaltTimeMaxPanic)); + PE_parse_boot_argn("haltmslog", &gHaltTimeMaxLog, sizeof(gHaltTimeMaxLog)); + + queue_init(&aggressivesQueue); + aggressivesThreadCall = thread_call_allocate(handleAggressivesFunction, this); + aggressivesData = OSData::withCapacity( + sizeof(AggressivesRecord) * (kPMLastAggressivenessType + 4)); + + featuresDictLock = IOLockAlloc(); + settingsCtrlLock = IOLockAlloc(); + wakeEventLock = IOLockAlloc(); + gHaltLogLock = IOLockAlloc(); + setPMRootDomain(this); + + extraSleepTimer = thread_call_allocate( + idleSleepTimerExpired, + (thread_call_param_t) this); + + powerButtonDown = thread_call_allocate( + powerButtonDownCallout, + (thread_call_param_t) this); + + powerButtonUp = thread_call_allocate( + powerButtonUpCallout, + (thread_call_param_t) this); + + diskSyncCalloutEntry = thread_call_allocate( + &disk_sync_callout, + (thread_call_param_t) this); + updateConsoleUsersEntry = thread_call_allocate( + &updateConsoleUsersCallout, + (thread_call_param_t) this); -//****************************************************************************** -// handleSleepTimerExpiration -// -// The time between the sleep idle timeout and the next longest one has elapsed. -// It's time to sleep. Start that by removing the clamp that's holding us awake. -//****************************************************************************** +#if DARK_TO_FULL_EVALUATE_CLAMSHELL + fullWakeThreadCall = thread_call_allocate( + OSMemberFunctionCast(thread_call_func_t, this, + &IOPMrootDomain::fullWakeDelayedWork), + (thread_call_param_t) this); +#endif -void IOPMrootDomain::handleSleepTimerExpiration( void ) -{ - if (!getPMworkloop()->inGate()) - { - getPMworkloop()->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, this, - &IOPMrootDomain::handleSleepTimerExpiration), - this); - return; - } + setProperty(kIOSleepSupportedKey, true); + + bzero(&gPMStats, sizeof(gPMStats)); + + pmTracer = PMTraceWorker::tracer(this); + + pmAssertions = PMAssertionsTracker::pmAssertionsTracker(this); + + userDisabledAllSleep = false; + systemBooting = true; + idleSleepEnabled = false; + sleepSlider = 0; + idleSleepTimerPending = false; + wrangler = NULL; + clamshellClosed = false; + clamshellExists = false; + clamshellDisabled = true; + acAdaptorConnected = true; + clamshellSleepDisabled = false; + gWakeReasonString[0] = '\0'; + + // Initialize to user active. + // Will never transition to user inactive w/o wrangler. + fullWakeReason = kFullWakeReasonLocalUser; + userIsActive = userWasActive = true; + clock_get_uptime(&gUserActiveAbsTime); + setProperty(gIOPMUserIsActiveKey, kOSBooleanTrue); + + // Set the default system capabilities at boot. + _currentCapability = kIOPMSystemCapabilityCPU | + kIOPMSystemCapabilityGraphics | + kIOPMSystemCapabilityAudio | + kIOPMSystemCapabilityNetwork; + + _pendingCapability = _currentCapability; + _desiredCapability = _currentCapability; + _highestCapability = _currentCapability; + setProperty(kIOPMSystemCapabilitiesKey, _currentCapability, 64); + + queuedSleepWakeUUIDString = NULL; + initializeBootSessionUUID(); + pmStatsAppResponses = OSArray::withCapacity(5); + _statsNameKey = OSSymbol::withCString(kIOPMStatsNameKey); + _statsPIDKey = OSSymbol::withCString(kIOPMStatsPIDKey); + _statsTimeMSKey = OSSymbol::withCString(kIOPMStatsTimeMSKey); + _statsResponseTypeKey = OSSymbol::withCString(kIOPMStatsApplicationResponseTypeKey); + _statsMessageTypeKey = OSSymbol::withCString(kIOPMStatsMessageTypeKey); + _statsPowerCapsKey = OSSymbol::withCString(kIOPMStatsPowerCapabilityKey); + assertOnWakeSecs = -1;// Invalid value to prevent updates + + pmStatsLock = IOLockAlloc(); + idxPMCPUClamshell = kCPUUnknownIndex; + idxPMCPULimitedPower = kCPUUnknownIndex; + + tmpDict = OSDictionary::withCapacity(1); + setProperty(kRootDomainSupportedFeatures, tmpDict); + tmpDict->release(); + + settingsCallbacks = OSDictionary::withCapacity(1); + + // Create a list of the valid PM settings that we'll relay to + // interested clients in setProperties() => setPMSetting() + allowedPMSettings = OSArray::withObjects( + (const OSObject **)settingsArr, + kRootDomainSettingsCount, + 0); + + // List of PM settings that should not automatically publish itself + // as a feature when registered by a listener. + noPublishPMSettings = OSArray::withObjects( + (const OSObject **)noPublishSettingsArr, + kRootDomainNoPublishSettingsCount, + 0); + + fPMSettingsDict = OSDictionary::withCapacity(5); + preventIdleSleepList = OSSet::withCapacity(8); + preventSystemSleepList = OSSet::withCapacity(2); + + PMinit(); // creates gIOPMWorkLoop + gIOPMWorkLoop = getIOPMWorkloop(); + + // Create IOPMPowerStateQueue used to queue external power + // events, and to handle those events on the PM work loop. + pmPowerStateQueue = IOPMPowerStateQueue::PMPowerStateQueue( + this, OSMemberFunctionCast(IOEventSource::Action, this, + &IOPMrootDomain::dispatchPowerEvent)); + gIOPMWorkLoop->addEventSource(pmPowerStateQueue); + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + _aotMode = 0; + _aotTimerES = IOTimerEventSource::timerEventSource(this, + OSMemberFunctionCast(IOTimerEventSource::Action, + this, &IOPMrootDomain::aotEvaluate)); + gIOPMWorkLoop->addEventSource(_aotTimerES); +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + // create our power parent + patriarch = new IORootParent; + patriarch->init(); + patriarch->attach(this); + patriarch->start(this); + patriarch->addPowerChild(this); + + registerPowerDriver(this, ourPowerStates, NUM_POWER_STATES); + changePowerStateToPriv(ON_STATE); + + // install power change handler + gSysPowerDownNotifier = registerPrioritySleepWakeInterest( &sysPowerDownHandler, this, NULL); + +#if !NO_KERNEL_HID + // Register for a notification when IODisplayWrangler is published + if ((tmpDict = serviceMatching("IODisplayWrangler"))) { + _displayWranglerNotifier = addMatchingNotification( + gIOPublishNotification, tmpDict, + (IOServiceMatchingNotificationHandler) & displayWranglerMatchPublished, + this, NULL); + tmpDict->release(); + } +#endif + +#if defined(__i386__) || defined(__x86_64__) + + wranglerIdleSettings = NULL; + OSNumber * wranglerIdlePeriod = NULL; + wranglerIdleSettings = OSDictionary::withCapacity(1); + wranglerIdlePeriod = OSNumber::withNumber(kDefaultWranglerIdlePeriod, 32); + + if (wranglerIdleSettings && wranglerIdlePeriod) { + wranglerIdleSettings->setObject(kIORequestWranglerIdleKey, + wranglerIdlePeriod); + } + + if (wranglerIdlePeriod) { + wranglerIdlePeriod->release(); + } +#endif - AbsoluteTime time; + const OSSymbol *ucClassName = OSSymbol::withCStringNoCopy("RootDomainUserClient"); + setProperty(gIOUserClientClassKey, (OSObject *) ucClassName); + ucClassName->release(); + + // IOBacklightDisplay can take a long time to load at boot, or it may + // not load at all if you're booting with clamshell closed. We publish + // 'DisplayDims' here redundantly to get it published early and at all. + OSDictionary * matching; + matching = serviceMatching("IOPMPowerSource"); + psIterator = getMatchingServices( matching ); + if (matching) { + matching->release(); + } + if (psIterator && psIterator->getNextObject()) { + // There's at least one battery on the system, so we publish + // 'DisplayDims' support for the LCD. + publishFeature("DisplayDims"); + } + if (psIterator) { + psIterator->release(); + } - DLOG("sleep timer expired\n"); - ASSERT_GATED(); + // read swd_panic boot-arg + PE_parse_boot_argn("swd_panic", &gSwdPanic, sizeof(gSwdPanic)); + sysctl_register_oid(&sysctl__kern_sleeptime); + sysctl_register_oid(&sysctl__kern_waketime); + sysctl_register_oid(&sysctl__kern_willshutdown); + sysctl_register_oid(&sysctl__kern_iokittest); + sysctl_register_oid(&sysctl__debug_iokit); + sysctl_register_oid(&sysctl__hw_targettype); + +#if !CONFIG_EMBEDDED + sysctl_register_oid(&sysctl__kern_progressmeterenable); + sysctl_register_oid(&sysctl__kern_progressmeter); + sysctl_register_oid(&sysctl__kern_wakereason); +#endif /* !CONFIG_EMBEDDED */ + sysctl_register_oid(&sysctl__kern_consoleoptions); + sysctl_register_oid(&sysctl__kern_progressoptions); + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + sysctl_register_oid(&sysctl__kern_aotmode); + sysctl_register_oid(&sysctl__kern_aotmodebits); + sysctl_register_oid(&sysctl__kern_aotmetrics); +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ - idleSleepTimerPending = false; +#if HIBERNATION + IOHibernateSystemInit(this); +#endif - clock_get_uptime(&time); - if ((AbsoluteTime_to_scalar(&time) > autoWakeStart) && - (AbsoluteTime_to_scalar(&time) < autoWakeEnd)) - { - thread_call_enter_delayed(extraSleepTimer, *((AbsoluteTime *) &autoWakeEnd)); - return; - } + registerService(); // let clients find us - setQuickSpinDownTimeout(); - adjustPowerState(true); + return true; } //****************************************************************************** -// getTimeToIdleSleep +// setProperties // -// Returns number of seconds left before going into idle sleep. -// Caller has to make sure that idle sleep is allowed at the time of calling -// this function +// Receive a setProperty call +// The "System Boot" property means the system is completely booted. //****************************************************************************** -uint32_t IOPMrootDomain::getTimeToIdleSleep( void ) +IOReturn +IOPMrootDomain::setProperties( OSObject * props_obj ) { + IOReturn return_value = kIOReturnSuccess; + OSDictionary *dict = OSDynamicCast(OSDictionary, props_obj); + OSBoolean *b; + OSNumber *n; + const OSSymbol *key; + OSObject *obj; + OSCollectionIterator * iter = NULL; - AbsoluteTime now, lastActivityTime; - uint64_t nanos; - uint32_t minutesSinceUserInactive = 0; - uint32_t sleepDelay = 0; + if (!dict) { + return kIOReturnBadArgument; + } - if (sleepSlider == 0) - return 0xffffffff; + bool clientEntitled = false; + obj = IOUserClient::copyClientEntitlement(current_task(), kRootDomainEntitlementSetProperty); + clientEntitled = (obj == kOSBooleanTrue); + OSSafeReleaseNULL(obj); + + if (!clientEntitled) { + const char * errorSuffix = NULL; + + // IOPMSchedulePowerEvent() clients may not be entitled, but must be root. + // That API can set 6 possible keys that are checked below. + if ((dict->getCount() == 1) && + (dict->getObject(gIOPMSettingAutoWakeSecondsKey) || + dict->getObject(gIOPMSettingAutoPowerSecondsKey) || + dict->getObject(gIOPMSettingAutoWakeCalendarKey) || + dict->getObject(gIOPMSettingAutoPowerCalendarKey) || + dict->getObject(gIOPMSettingDebugWakeRelativeKey) || + dict->getObject(gIOPMSettingDebugPowerRelativeKey))) { + return_value = IOUserClient::clientHasPrivilege(current_task(), kIOClientPrivilegeAdministrator); + if (return_value != kIOReturnSuccess) { + errorSuffix = "privileged"; + } + } else { + return_value = kIOReturnNotPermitted; + errorSuffix = "entitled"; + } - if (userActivityTime) - lastActivityTime = userActivityTime; - else - lastActivityTime = userBecameInactiveTime; + if (return_value != kIOReturnSuccess) { + OSString * procName = IOCopyLogNameForPID(proc_selfpid()); + DLOG("%s failed, process %s is not %s\n", __func__, + procName ? procName->getCStringNoCopy() : "", errorSuffix); + OSSafeReleaseNULL(procName); + return return_value; + } + } - clock_get_uptime(&now); - if (CMP_ABSOLUTETIME(&now, &lastActivityTime) > 0) - { - SUB_ABSOLUTETIME(&now, &lastActivityTime); - absolutetime_to_nanoseconds(now, &nanos); - minutesSinceUserInactive = nanos / (60000000000ULL); - - if (minutesSinceUserInactive >= sleepSlider) - sleepDelay = 0; - else - sleepDelay = sleepSlider - minutesSinceUserInactive; - } - else - { - sleepDelay = sleepSlider; - } + const OSSymbol *publish_simulated_battery_string = OSSymbol::withCString("SoftwareSimulatedBatteries"); + const OSSymbol *boot_complete_string = OSSymbol::withCString("System Boot Complete"); + const OSSymbol *sys_shutdown_string = OSSymbol::withCString("System Shutdown"); + const OSSymbol *stall_halt_string = OSSymbol::withCString("StallSystemAtHalt"); + const OSSymbol *battery_warning_disabled_string = OSSymbol::withCString("BatteryWarningsDisabled"); + const OSSymbol *idle_seconds_string = OSSymbol::withCString("System Idle Seconds"); + const OSSymbol *sleepdisabled_string = OSSymbol::withCString("SleepDisabled"); + const OSSymbol *ondeck_sleepwake_uuid_string = OSSymbol::withCString(kIOPMSleepWakeUUIDKey); + const OSSymbol *loginwindow_progress_string = OSSymbol::withCString(kIOPMLoginWindowProgressKey); + const OSSymbol *coredisplay_progress_string = OSSymbol::withCString(kIOPMCoreDisplayProgressKey); + const OSSymbol *coregraphics_progress_string = OSSymbol::withCString(kIOPMCoreGraphicsProgressKey); +#if HIBERNATION + const OSSymbol *hibernatemode_string = OSSymbol::withCString(kIOHibernateModeKey); + const OSSymbol *hibernatefile_string = OSSymbol::withCString(kIOHibernateFileKey); + const OSSymbol *hibernatefilemin_string = OSSymbol::withCString(kIOHibernateFileMinSizeKey); + const OSSymbol *hibernatefilemax_string = OSSymbol::withCString(kIOHibernateFileMaxSizeKey); + const OSSymbol *hibernatefreeratio_string = OSSymbol::withCString(kIOHibernateFreeRatioKey); + const OSSymbol *hibernatefreetime_string = OSSymbol::withCString(kIOHibernateFreeTimeKey); +#endif - DLOG("user inactive %u min, time to idle sleep %u min\n", - minutesSinceUserInactive, sleepDelay); + iter = OSCollectionIterator::withCollection(dict); + if (!iter) { + return_value = kIOReturnNoMemory; + goto exit; + } - return (sleepDelay * 60); -} + while ((key = (const OSSymbol *) iter->getNextObject()) && + (obj = dict->getObject(key))) { + if (key->isEqualTo(publish_simulated_battery_string)) { + if (OSDynamicCast(OSBoolean, obj)) { + publishResource(key, kOSBooleanTrue); + } + } else if (key->isEqualTo(idle_seconds_string)) { + if ((n = OSDynamicCast(OSNumber, obj))) { + setProperty(key, n); + idleSeconds = n->unsigned32BitValue(); + } + } else if (key->isEqualTo(boot_complete_string)) { + pmPowerStateQueue->submitPowerEvent(kPowerEventSystemBootCompleted); + } else if (key->isEqualTo(sys_shutdown_string)) { + if ((b = OSDynamicCast(OSBoolean, obj))) { + pmPowerStateQueue->submitPowerEvent(kPowerEventSystemShutdown, (void *) b); + } + } else if (key->isEqualTo(battery_warning_disabled_string)) { + setProperty(key, obj); + } +#if HIBERNATION + else if (key->isEqualTo(hibernatemode_string) || + key->isEqualTo(hibernatefilemin_string) || + key->isEqualTo(hibernatefilemax_string) || + key->isEqualTo(hibernatefreeratio_string) || + key->isEqualTo(hibernatefreetime_string)) { + if ((n = OSDynamicCast(OSNumber, obj))) { + setProperty(key, n); + } + } else if (key->isEqualTo(hibernatefile_string)) { + OSString * str = OSDynamicCast(OSString, obj); + if (str) { + setProperty(key, str); + } + } +#endif + else if (key->isEqualTo(sleepdisabled_string)) { + if ((b = OSDynamicCast(OSBoolean, obj))) { + setProperty(key, b); + pmPowerStateQueue->submitPowerEvent(kPowerEventUserDisabledSleep, (void *) b); + } + } else if (key->isEqualTo(ondeck_sleepwake_uuid_string)) { + obj->retain(); + pmPowerStateQueue->submitPowerEvent(kPowerEventQueueSleepWakeUUID, (void *)obj); + } else if (key->isEqualTo(loginwindow_progress_string)) { + if (pmTracer && (n = OSDynamicCast(OSNumber, obj))) { + uint32_t data = n->unsigned32BitValue(); + pmTracer->traceComponentWakeProgress(kIOPMLoginWindowProgress, data); + kdebugTrace(kPMLogComponentWakeProgress, 0, kIOPMLoginWindowProgress, data); + } + } else if (key->isEqualTo(coredisplay_progress_string)) { + if (pmTracer && (n = OSDynamicCast(OSNumber, obj))) { + uint32_t data = n->unsigned32BitValue(); + pmTracer->traceComponentWakeProgress(kIOPMCoreDisplayProgress, data); + kdebugTrace(kPMLogComponentWakeProgress, 0, kIOPMCoreDisplayProgress, data); + } + } else if (key->isEqualTo(coregraphics_progress_string)) { + if (pmTracer && (n = OSDynamicCast(OSNumber, obj))) { + uint32_t data = n->unsigned32BitValue(); + pmTracer->traceComponentWakeProgress(kIOPMCoreGraphicsProgress, data); + kdebugTrace(kPMLogComponentWakeProgress, 0, kIOPMCoreGraphicsProgress, data); + } + } else if (key->isEqualTo(kIOPMDeepSleepEnabledKey) || + key->isEqualTo(kIOPMDestroyFVKeyOnStandbyKey) || + key->isEqualTo(kIOPMAutoPowerOffEnabledKey) || + key->isEqualTo(stall_halt_string)) { + if ((b = OSDynamicCast(OSBoolean, obj))) { + setProperty(key, b); + } + } else if (key->isEqualTo(kIOPMDeepSleepDelayKey) || + key->isEqualTo(kIOPMDeepSleepTimerKey) || + key->isEqualTo(kIOPMAutoPowerOffDelayKey) || + key->isEqualTo(kIOPMAutoPowerOffTimerKey)) { + if ((n = OSDynamicCast(OSNumber, obj))) { + setProperty(key, n); + } + } else if (key->isEqualTo(kIOPMUserWakeAlarmScheduledKey)) { + if (kOSBooleanTrue == obj) { + OSBitOrAtomic(kIOPMAlarmBitCalendarWake, &_userScheduledAlarm); + } else { + OSBitAndAtomic(~kIOPMAlarmBitCalendarWake, &_userScheduledAlarm); + } + DLOG("_userScheduledAlarm = 0x%x\n", (uint32_t) _userScheduledAlarm); + } + // Relay our allowed PM settings onto our registered PM clients + else if ((allowedPMSettings->getNextIndexOfObject(key, 0) != (unsigned int) -1)) { + return_value = setPMSetting(key, obj); + if (kIOReturnSuccess != return_value) { + break; + } -//****************************************************************************** -// setQuickSpinDownTimeout -// -//****************************************************************************** + if (gIOPMSettingDebugWakeRelativeKey == key) { + if ((n = OSDynamicCast(OSNumber, obj)) && + (_debugWakeSeconds = n->unsigned32BitValue())) { + OSBitOrAtomic(kIOPMAlarmBitDebugWake, &_scheduledAlarms); + } else { + _debugWakeSeconds = 0; + OSBitAndAtomic(~kIOPMAlarmBitDebugWake, &_scheduledAlarms); + } + DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); + } else if (gIOPMSettingAutoWakeCalendarKey == key) { + OSData * data; + if ((data = OSDynamicCast(OSData, obj)) && + (data->getLength() == sizeof(IOPMCalendarStruct))) { + const IOPMCalendarStruct * cs = + (const IOPMCalendarStruct *) data->getBytesNoCopy(); + IOLog("gIOPMSettingAutoWakeCalendarKey " YMDTF "\n", YMDT(cs)); + if (cs->year) { + _scheduledAlarmUTC = IOPMConvertCalendarToSeconds(cs); + OSBitOrAtomic(kIOPMAlarmBitCalendarWake, &_scheduledAlarms); + } else { + _scheduledAlarmUTC = 0; + OSBitAndAtomic(~kIOPMAlarmBitCalendarWake, &_scheduledAlarms); + } + DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); + } + } + } else { + DLOG("setProperties(%s) not handled\n", key->getCStringNoCopy()); + } + } -void IOPMrootDomain::setQuickSpinDownTimeout( void ) -{ - ASSERT_GATED(); - setAggressiveness( - kPMMinutesToSpinDown, 0, kAggressivesOptionQuickSpindownEnable ); +exit: + if (publish_simulated_battery_string) { + publish_simulated_battery_string->release(); + } + if (boot_complete_string) { + boot_complete_string->release(); + } + if (sys_shutdown_string) { + sys_shutdown_string->release(); + } + if (stall_halt_string) { + stall_halt_string->release(); + } + if (battery_warning_disabled_string) { + battery_warning_disabled_string->release(); + } + if (idle_seconds_string) { + idle_seconds_string->release(); + } + if (sleepdisabled_string) { + sleepdisabled_string->release(); + } + if (ondeck_sleepwake_uuid_string) { + ondeck_sleepwake_uuid_string->release(); + } + if (loginwindow_progress_string) { + loginwindow_progress_string->release(); + } + if (coredisplay_progress_string) { + coredisplay_progress_string->release(); + } + if (coregraphics_progress_string) { + coregraphics_progress_string->release(); + } +#if HIBERNATION + if (hibernatemode_string) { + hibernatemode_string->release(); + } + if (hibernatefile_string) { + hibernatefile_string->release(); + } + if (hibernatefreeratio_string) { + hibernatefreeratio_string->release(); + } + if (hibernatefreetime_string) { + hibernatefreetime_string->release(); + } +#endif + if (iter) { + iter->release(); + } + return return_value; } +// MARK: - +// MARK: Aggressiveness + //****************************************************************************** -// restoreUserSpinDownTimeout +// setAggressiveness // +// Override IOService::setAggressiveness() //****************************************************************************** -void IOPMrootDomain::restoreUserSpinDownTimeout( void ) +IOReturn +IOPMrootDomain::setAggressiveness( + unsigned long type, + unsigned long value ) { - ASSERT_GATED(); - setAggressiveness( - kPMMinutesToSpinDown, 0, kAggressivesOptionQuickSpindownDisable ); + return setAggressiveness( type, value, 0 ); } -//****************************************************************************** -// sleepSystem -// -//****************************************************************************** +/* + * Private setAggressiveness() with an internal options argument. + */ +IOReturn +IOPMrootDomain::setAggressiveness( + unsigned long type, + unsigned long value, + IOOptionBits options ) +{ + AggressivesRequest * entry; + AggressivesRequest * request; + bool found = false; + + if (type == kPMMinutesToDim || type == kPMMinutesToSleep) { + DLOG("setAggressiveness(%x) %s = %u\n", + (uint32_t) options, getAggressivenessTypeString((uint32_t) type), (uint32_t) value); + } else { + DEBUG_LOG("setAggressiveness(%x) %s = %u\n", + (uint32_t) options, getAggressivenessTypeString((uint32_t) type), (uint32_t) value); + } -/* public */ -IOReturn IOPMrootDomain::sleepSystem( void ) -{ - return sleepSystemOptions(NULL); -} + request = IONew(AggressivesRequest, 1); + if (!request) { + return kIOReturnNoMemory; + } -/* private */ -IOReturn IOPMrootDomain::sleepSystemOptions( OSDictionary *options ) -{ - OSObject *obj = NULL; - OSString *reason = NULL; - /* sleepSystem is a public function, and may be called by any kernel driver. - * And that's bad - drivers should sleep the system by calling - * receivePowerNotification() instead. Drivers should not use sleepSystem. - * - * Note that user space app calls to IOPMSleepSystem() will also travel - * this code path and thus be correctly identified as software sleeps. - */ + memset(request, 0, sizeof(*request)); + request->options = options; + request->dataType = kAggressivesRequestTypeRecord; + request->data.record.type = (uint32_t) type; + request->data.record.value = (uint32_t) value; - if (options && options->getObject("OSSwitch")) - { - // Log specific sleep cause for OS Switch hibernation - return privateSleepSystem( kIOPMSleepReasonOSSwitchHibernate); - } + AGGRESSIVES_LOCK(); - if (options && (obj = options->getObject("Sleep Reason"))) - { - reason = OSDynamicCast(OSString, obj); - if (reason && reason->isEqualTo(kIOPMDarkWakeThermalEmergencyKey)) - return privateSleepSystem(kIOPMSleepReasonDarkWakeThermalEmergency); - } + // Update disk quick spindown flag used by getAggressiveness(). + // Never merge requests with quick spindown flags set. - return privateSleepSystem( kIOPMSleepReasonSoftware); -} + if (options & kAggressivesOptionQuickSpindownEnable) { + gAggressivesState |= kAggressivesStateQuickSpindown; + } else if (options & kAggressivesOptionQuickSpindownDisable) { + gAggressivesState &= ~kAggressivesStateQuickSpindown; + } else { + // Coalesce requests with identical aggressives types. + // Deal with callers that calls us too "aggressively". -/* private */ -IOReturn IOPMrootDomain::privateSleepSystem( uint32_t sleepReason ) -{ - /* Called from both gated and non-gated context */ + queue_iterate(&aggressivesQueue, entry, AggressivesRequest *, chain) + { + if ((entry->dataType == kAggressivesRequestTypeRecord) && + (entry->data.record.type == type) && + ((entry->options & kAggressivesOptionQuickSpindownMask) == 0)) { + entry->data.record.value = value; + found = true; + break; + } + } + } + + if (!found) { + queue_enter(&aggressivesQueue, request, AggressivesRequest *, chain); + } - if (!checkSystemSleepEnabled() || !pmPowerStateQueue) - { - recordPMEvent(kIOPMEventTypeSleep, NULL, - sleepReason, kIOReturnNotPermitted); + AGGRESSIVES_UNLOCK(); - return kIOReturnNotPermitted; - } + if (found) { + IODelete(request, AggressivesRequest, 1); + } - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusDemandSystemSleep, - sleepReason); + if (options & kAggressivesOptionSynchronous) { + handleAggressivesRequests(); // not truly synchronous + } else { + thread_call_enter(aggressivesThreadCall); + } - return kIOReturnSuccess; + return kIOReturnSuccess; } //****************************************************************************** -// powerChangeDone +// getAggressiveness // -// This overrides powerChangeDone in IOService. +// Override IOService::setAggressiveness() +// Fetch the aggressiveness factor with the given type. //****************************************************************************** -void IOPMrootDomain::powerChangeDone( unsigned long previousPowerState ) +IOReturn +IOPMrootDomain::getAggressiveness( + unsigned long type, + unsigned long * outLevel ) { - ASSERT_GATED(); - DLOG("PowerChangeDone: %u->%u\n", - (uint32_t) previousPowerState, (uint32_t) getPowerState()); - - switch ( getPowerState() ) - { - case SLEEP_STATE: { - if (previousPowerState != ON_STATE) - break; - - recordPMEvent(kIOPMEventTypeSleepDone, NULL, 0, kIOReturnSuccess); + uint32_t value = 0; + int source = 0; - // re-enable this timer for next sleep - cancelIdleSleepTimer(); - - clock_sec_t secs; - clock_usec_t microsecs; - clock_get_calendar_microtime(&secs, µsecs); - logtime(secs); - gIOLastSleepTime.tv_sec = secs; - gIOLastSleepTime.tv_usec = microsecs; - gIOLastWakeTime.tv_sec = 0; - gIOLastWakeTime.tv_usec = 0; - -#if HIBERNATION - LOG("System %sSleep\n", gIOHibernateState ? "Safe" : ""); - - IOHibernateSystemHasSlept(); + if (!outLevel) { + return kIOReturnBadArgument; + } - evaluateSystemSleepPolicyFinal(); -#else - LOG("System Sleep\n"); -#endif + AGGRESSIVES_LOCK(); - ((IOService *)this)->stop_watchdog_timer(); //14456299 - getPlatform()->sleepKernel(); + // Disk quick spindown in effect, report value = 1 - // The CPU(s) are off at this point, - // Code will resume execution here upon wake. + if ((gAggressivesState & kAggressivesStateQuickSpindown) && + (type == kPMMinutesToSpinDown)) { + value = kAggressivesMinValue; + source = 1; + } - clock_get_uptime(&systemWakeTime); - _highestCapability = 0; + // Consult the pending request queue. - ((IOService *)this)->start_watchdog_timer(); //14456299 -#if HIBERNATION - IOHibernateSystemWake(); -#endif + if (!source) { + AggressivesRequest * entry; - // sleep transition complete - gSleepOrShutdownPending = 0; + queue_iterate(&aggressivesQueue, entry, AggressivesRequest *, chain) + { + if ((entry->dataType == kAggressivesRequestTypeRecord) && + (entry->data.record.type == type) && + ((entry->options & kAggressivesOptionQuickSpindownMask) == 0)) { + value = entry->data.record.value; + source = 2; + break; + } + } + } - // trip the reset of the calendar clock - clock_wakeup_calendar(); + // Consult the backend records. -#if HIBERNATION - LOG("System %sWake\n", gIOHibernateState ? "SafeSleep " : ""); -#endif + if (!source && aggressivesData) { + AggressivesRecord * record; + int i, count; - // log system wake - PMDebug(kPMLogSystemWake, 0, 0); - lowBatteryCondition = false; - lastSleepReason = 0; - - _lastDebugWakeSeconds = _debugWakeSeconds; - _debugWakeSeconds = 0; - _scheduledAlarms = 0; - - // And start logging the wake event here - // TODO: Publish the wakeReason string as an integer - recordPMEvent(kIOPMEventTypeWake, NULL, 0, kIOReturnSuccess); - -#ifndef __LP64__ - systemWake(); -#endif + count = aggressivesData->getLength() / sizeof(AggressivesRecord); + record = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); -#if defined(__i386__) || defined(__x86_64__) - wranglerTickled = false; - graphicsSuppressed = false; - darkWakePostTickle = false; - darkWakeToSleepASAP = true; - logGraphicsClamp = true; - sleepTimerMaintenance = false; - sleepToStandby = false; - wranglerTickleLatched = false; - userWasActive = false; - fullWakeReason = kFullWakeReasonNone; - - OSString * wakeType = OSDynamicCast( - OSString, getProperty(kIOPMRootDomainWakeTypeKey)); - OSString * wakeReason = OSDynamicCast( - OSString, getProperty(kIOPMRootDomainWakeReasonKey)); - - if (wakeType && wakeType->isEqualTo(kIOPMrootDomainWakeTypeLowBattery)) - { - lowBatteryCondition = true; - darkWakeMaintenance = true; - } - else if ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) != 0) - { - OSNumber * hibOptions = OSDynamicCast( - OSNumber, getProperty(kIOHibernateOptionsKey)); - - if (hibernateAborted || ((hibOptions && - !(hibOptions->unsigned32BitValue() & kIOHibernateOptionDarkWake)))) - { - // Hibernate aborted, or EFI brought up graphics - wranglerTickled = true; - DLOG("hibernation aborted %d, options 0x%x\n", - hibernateAborted, - hibOptions ? hibOptions->unsigned32BitValue() : 0); - } - else - if (wakeType && ( - wakeType->isEqualTo(kIOPMRootDomainWakeTypeUser) || - wakeType->isEqualTo(kIOPMRootDomainWakeTypeAlarm))) - { - // User wake or RTC alarm - wranglerTickled = true; - } - else - if (wakeType && - wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepTimer)) - { - // SMC standby timer trumps SleepX - darkWakeMaintenance = true; - sleepTimerMaintenance = true; - } - else - if ((_lastDebugWakeSeconds != 0) && - ((gDarkWakeFlags & kDarkWakeFlagAlarmIsDark) == 0)) - { - // SleepX before maintenance - wranglerTickled = true; - } - else - if (wakeType && - wakeType->isEqualTo(kIOPMRootDomainWakeTypeMaintenance)) - { - darkWakeMaintenance = true; - } - else - if (wakeType && - wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepService)) - { - darkWakeMaintenance = true; - darkWakeSleepService = true; - if (kIOHibernateStateWakingFromHibernate == gIOHibernateState) { - sleepToStandby = true; - } - } - else - { - // Unidentified wake source, resume to full wake if debug - // alarm is pending. - - if (_lastDebugWakeSeconds && - (!wakeReason || wakeReason->isEqualTo(""))) - wranglerTickled = true; - } - } - else - { - if (wakeType && - wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepTimer)) - { - darkWakeMaintenance = true; - sleepTimerMaintenance = true; - } - else if (hibernateAborted || !wakeType || - !wakeType->isEqualTo(kIOPMRootDomainWakeTypeMaintenance) || - !wakeReason || !wakeReason->isEqualTo("RTC")) - { - // Post a HID tickle immediately - except for RTC maintenance wake. - wranglerTickled = true; - } - else - { - darkWakeMaintenance = true; - } - } - - if (wranglerTickled) - { - darkWakeToSleepASAP = false; - fullWakeReason = kFullWakeReasonLocalUser; - reportUserInput(); - } - else if (!darkWakeMaintenance) - { - // Early/late tickle for non-maintenance wake. - if (((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == - kDarkWakeFlagHIDTickleEarly) || - ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == - kDarkWakeFlagHIDTickleLate)) - { - darkWakePostTickle = true; - } - } -#else /* !__i386__ && !__x86_64__ */ - // stay awake for at least 30 seconds - wranglerTickled = true; - fullWakeReason = kFullWakeReasonLocalUser; - startIdleSleepTimer(30); -#endif - sleepCnt++; + for (i = 0; i < count; i++, record++) { + if (record->type == type) { + value = record->value; + source = 3; + break; + } + } + } - changePowerStateToPriv(ON_STATE); - } break; + AGGRESSIVES_UNLOCK(); - case ON_STATE: { - if (previousPowerState != ON_STATE) - { - recordPMEvent(kIOPMEventTypeWakeDone, NULL, 0, kIOReturnSuccess); - } - } break; - } + if (source) { + *outLevel = (unsigned long) value; + return kIOReturnSuccess; + } else { + DLOG("getAggressiveness type 0x%x not found\n", (uint32_t) type); + *outLevel = 0; // default return = 0, driver may not check for error + return kIOReturnInvalid; + } } //****************************************************************************** -// requestPowerDomainState +// joinAggressiveness // -// Extend implementation in IOService. Running on PM work loop thread. +// Request from IOService to join future aggressiveness broadcasts. //****************************************************************************** -IOReturn IOPMrootDomain::requestPowerDomainState ( - IOPMPowerFlags childDesire, - IOPowerConnection * childConnection, - unsigned long specification ) +IOReturn +IOPMrootDomain::joinAggressiveness( + IOService * service ) { - // Idle and system sleep prevention flags affects driver desire. - // Children desire are irrelevant so they are cleared. + AggressivesRequest * request; - return super::requestPowerDomainState(0, childConnection, specification); -} + if (!service || (service == this)) { + return kIOReturnBadArgument; + } -//****************************************************************************** -// updatePreventIdleSleepList -// -// Called by IOService on PM work loop. -// Returns true if PM policy recognized the driver's desire to prevent idle -// sleep and updated the list of idle sleep preventers. Returns false otherwise -//****************************************************************************** + DEBUG_LOG("joinAggressiveness %s %p\n", service->getName(), OBFUSCATE(service)); -bool IOPMrootDomain::updatePreventIdleSleepList( - IOService * service, bool addNotRemove ) -{ - unsigned int oldCount, newCount; + request = IONew(AggressivesRequest, 1); + if (!request) { + return kIOReturnNoMemory; + } - ASSERT_GATED(); + service->retain(); // released by synchronizeAggressives() -#if defined(__i386__) || defined(__x86_64__) - // Disregard disk I/O (anything besides the display wrangler) - // as a factor preventing idle sleep,except in the case of legacy disk I/O - if ((gDarkWakeFlags & kDarkWakeFlagIgnoreDiskIOAlways) && - addNotRemove && (service != wrangler) && (service != this)) - { - return false; - } -#endif - oldCount = preventIdleSleepList->getCount(); - if (addNotRemove) - { - preventIdleSleepList->setObject(service); - DLOG("prevent idle sleep list: %s+ (%u)\n", - service->getName(), preventIdleSleepList->getCount()); - } - else if (preventIdleSleepList->member(service)) - { - preventIdleSleepList->removeObject(service); - DLOG("prevent idle sleep list: %s- (%u)\n", - service->getName(), preventIdleSleepList->getCount()); - } - newCount = preventIdleSleepList->getCount(); - - if ((oldCount == 0) && (newCount != 0)) - { - // Driver added to empty prevent list. - // Update the driver desire to prevent idle sleep. - // Driver desire does not prevent demand sleep. - - changePowerStateTo(ON_STATE); - } - else if ((oldCount != 0) && (newCount == 0)) - { - // Last driver removed from prevent list. - // Drop the driver clamp to allow idle sleep. - - changePowerStateTo(SLEEP_STATE); - evaluatePolicy( kStimulusNoIdleSleepPreventers ); - } + memset(request, 0, sizeof(*request)); + request->dataType = kAggressivesRequestTypeService; + request->data.service = service; -#if defined(__i386__) || defined(__x86_64__) - if (addNotRemove && (service == wrangler) && !checkSystemCanSustainFullWake()) - { - return false; - } -#endif + AGGRESSIVES_LOCK(); + queue_enter(&aggressivesQueue, request, AggressivesRequest *, chain); + AGGRESSIVES_UNLOCK(); - return true; + thread_call_enter(aggressivesThreadCall); + + return kIOReturnSuccess; } //****************************************************************************** -// preventSystemSleepListUpdate +// handleAggressivesRequests // -// Called by IOService on PM work loop. +// Backend thread processes all incoming aggressiveness requests in the queue. //****************************************************************************** -void IOPMrootDomain::updatePreventSystemSleepList( - IOService * service, bool addNotRemove ) +static void +handleAggressivesFunction( + thread_call_param_t param1, + thread_call_param_t param2 ) { - unsigned int oldCount; + if (param1) { + ((IOPMrootDomain *) param1)->handleAggressivesRequests(); + } +} - ASSERT_GATED(); - if (this == service) - return; +void +IOPMrootDomain::handleAggressivesRequests( void ) +{ + AggressivesRecord * start; + AggressivesRecord * record; + AggressivesRequest * request; + queue_head_t joinedQueue; + int i, count; + bool broadcast; + bool found; + bool pingSelf = false; - oldCount = preventSystemSleepList->getCount(); - if (addNotRemove) - { - preventSystemSleepList->setObject(service); - DLOG("prevent system sleep list: %s+ (%u)\n", - service->getName(), preventSystemSleepList->getCount()); - } - else if (preventSystemSleepList->member(service)) - { - preventSystemSleepList->removeObject(service); - DLOG("prevent system sleep list: %s- (%u)\n", - service->getName(), preventSystemSleepList->getCount()); + AGGRESSIVES_LOCK(); - if ((oldCount != 0) && (preventSystemSleepList->getCount() == 0)) - { - // Lost all system sleep preventers. - // Send stimulus if system sleep was blocked, and is in dark wake. - evaluatePolicy( kStimulusDarkWakeEvaluate ); - } - } -} + if ((gAggressivesState & kAggressivesStateBusy) || !aggressivesData || + queue_empty(&aggressivesQueue)) { + goto unlock_done; + } -//****************************************************************************** -// tellChangeDown -// -// Override the superclass implementation to send a different message type. -//****************************************************************************** + gAggressivesState |= kAggressivesStateBusy; + count = aggressivesData->getLength() / sizeof(AggressivesRecord); + start = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); + + do{ + broadcast = false; + queue_init(&joinedQueue); + + do{ + // Remove request from the incoming queue in FIFO order. + queue_remove_first(&aggressivesQueue, request, AggressivesRequest *, chain); + switch (request->dataType) { + case kAggressivesRequestTypeRecord: + // Update existing record if found. + found = false; + for (i = 0, record = start; i < count; i++, record++) { + if (record->type == request->data.record.type) { + found = true; + + if (request->options & kAggressivesOptionQuickSpindownEnable) { + if ((record->flags & kAggressivesRecordFlagMinValue) == 0) { + broadcast = true; + record->flags |= (kAggressivesRecordFlagMinValue | + kAggressivesRecordFlagModified); + DLOG("disk spindown accelerated, was %u min\n", + record->value); + } + } else if (request->options & kAggressivesOptionQuickSpindownDisable) { + if (record->flags & kAggressivesRecordFlagMinValue) { + broadcast = true; + record->flags |= kAggressivesRecordFlagModified; + record->flags &= ~kAggressivesRecordFlagMinValue; + DLOG("disk spindown restored to %u min\n", + record->value); + } + } else if (record->value != request->data.record.value) { + record->value = request->data.record.value; + if ((record->flags & kAggressivesRecordFlagMinValue) == 0) { + broadcast = true; + record->flags |= kAggressivesRecordFlagModified; + } + } + break; + } + } -bool IOPMrootDomain::tellChangeDown( unsigned long stateNum ) -{ - DLOG("tellChangeDown %u->%u\n", - (uint32_t) getPowerState(), (uint32_t) stateNum); + // No matching record, append a new record. + if (!found && + ((request->options & kAggressivesOptionQuickSpindownDisable) == 0)) { + AggressivesRecord newRecord; + + newRecord.flags = kAggressivesRecordFlagModified; + newRecord.type = request->data.record.type; + newRecord.value = request->data.record.value; + if (request->options & kAggressivesOptionQuickSpindownEnable) { + newRecord.flags |= kAggressivesRecordFlagMinValue; + DLOG("disk spindown accelerated\n"); + } - if (SLEEP_STATE == stateNum) - { - // Legacy apps were already told in the full->dark transition - if (!ignoreTellChangeDown) - tracePoint( kIOPMTracePointSleepApplications ); - else - tracePoint( kIOPMTracePointSleepPriorityClients ); - } + aggressivesData->appendBytes(&newRecord, sizeof(newRecord)); - if ((SLEEP_STATE == stateNum) && !ignoreTellChangeDown) - { - userActivityAtSleep = userActivityCount; - hibernateAborted = false; - DLOG("tellChangeDown::userActivityAtSleep %d\n", userActivityAtSleep); + // OSData may have switched to another (larger) buffer. + count = aggressivesData->getLength() / sizeof(AggressivesRecord); + start = (AggressivesRecord *) aggressivesData->getBytesNoCopy(); + broadcast = true; + } - // Direct callout into OSKext so it can disable kext unloads - // during sleep/wake to prevent deadlocks. - OSKextSystemSleepOrWake( kIOMessageSystemWillSleep ); + // Finished processing the request, release it. + IODelete(request, AggressivesRequest, 1); + break; - IOService::updateConsoleUsers(NULL, kIOMessageSystemWillSleep); + case kAggressivesRequestTypeService: + // synchronizeAggressives() will free request. + queue_enter(&joinedQueue, request, AggressivesRequest *, chain); + break; - // Two change downs are sent by IOServicePM. Ignore the 2nd. - // But tellClientsWithResponse() must be called for both. - ignoreTellChangeDown = true; - } + default: + panic("bad aggressives request type %x\n", request->dataType); + break; + } + } while (!queue_empty(&aggressivesQueue)); - return super::tellClientsWithResponse( kIOMessageSystemWillSleep ); -} + // Release the lock to perform work, with busy flag set. + if (!queue_empty(&joinedQueue) || broadcast) { + AGGRESSIVES_UNLOCK(); + if (!queue_empty(&joinedQueue)) { + synchronizeAggressives(&joinedQueue, start, count); + } + if (broadcast) { + broadcastAggressives(start, count); + } + AGGRESSIVES_LOCK(); + } -//****************************************************************************** -// askChangeDown -// -// Override the superclass implementation to send a different message type. -// This must be idle sleep since we don't ask during any other power change. -//****************************************************************************** - -bool IOPMrootDomain::askChangeDown( unsigned long stateNum ) -{ - DLOG("askChangeDown %u->%u\n", - (uint32_t) getPowerState(), (uint32_t) stateNum); - - // Don't log for dark wake entry - if (kSystemTransitionSleep == _systemTransitionType) - tracePoint( kIOPMTracePointSleepApplications ); + // Remove the modified flag from all records. + for (i = 0, record = start; i < count; i++, record++) { + if ((record->flags & kAggressivesRecordFlagModified) && + ((record->type == kPMMinutesToDim) || + (record->type == kPMMinutesToSleep))) { + pingSelf = true; + } - return super::tellClientsWithResponse( kIOMessageCanSystemSleep ); -} + record->flags &= ~kAggressivesRecordFlagModified; + } -//****************************************************************************** -// askChangeDownDone -// -// An opportunity for root domain to cancel the power transition, -// possibily due to an assertion created by powerd in response to -// kIOMessageCanSystemSleep. -// -// Idle sleep: -// full -> dark wake transition -// 1. Notify apps and powerd with kIOMessageCanSystemSleep -// 2. askChangeDownDone() -// dark -> sleep transition -// 1. Notify powerd with kIOMessageCanSystemSleep -// 2. askChangeDownDone() -// -// Demand sleep: -// full -> dark wake transition -// 1. Notify powerd with kIOMessageCanSystemSleep -// 2. askChangeDownDone() -// dark -> sleep transition -// 1. Notify powerd with kIOMessageCanSystemSleep -// 2. askChangeDownDone() -//****************************************************************************** + // Check the incoming queue again since new entries may have been + // added while lock was released above. + } while (!queue_empty(&aggressivesQueue)); -void IOPMrootDomain::askChangeDownDone( - IOPMPowerChangeFlags * inOutChangeFlags, bool * cancel ) -{ - DLOG("askChangeDownDone(0x%x, %u) type %x, cap %x->%x\n", - *inOutChangeFlags, *cancel, - _systemTransitionType, - _currentCapability, _pendingCapability); + gAggressivesState &= ~kAggressivesStateBusy; - if ((false == *cancel) && (kSystemTransitionSleep == _systemTransitionType)) - { - // Dark->Sleep transition. - // Check if there are any deny sleep assertions. - // lastSleepReason already set by handleOurPowerChangeStart() +unlock_done: + AGGRESSIVES_UNLOCK(); - if (!checkSystemCanSleep(lastSleepReason)) - { - // Cancel dark wake to sleep transition. - // Must re-scan assertions upon entering dark wake. + // Root domain is interested in system and display sleep slider changes. + // Submit a power event to handle those changes on the PM work loop. - *cancel = true; - DLOG("cancel dark->sleep\n"); - } - } + if (pingSelf && pmPowerStateQueue) { + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusAggressivenessChanged ); + } } //****************************************************************************** -// tellNoChangeDown -// -// Notify registered applications and kernel clients that we are not dropping -// power. -// -// We override the superclass implementation so we can send a different message -// type to the client or application being notified. +// synchronizeAggressives // -// This must be a vetoed idle sleep, since no other power change can be vetoed. +// Push all known aggressiveness records to one or more IOService. //****************************************************************************** -void IOPMrootDomain::tellNoChangeDown( unsigned long stateNum ) -{ - DLOG("tellNoChangeDown %u->%u\n", - (uint32_t) getPowerState(), (uint32_t) stateNum); +void +IOPMrootDomain::synchronizeAggressives( + queue_head_t * joinedQueue, + const AggressivesRecord * array, + int count ) +{ + IOService * service; + AggressivesRequest * request; + const AggressivesRecord * record; + IOPMDriverCallEntry callEntry; + uint32_t value; + int i; + + while (!queue_empty(joinedQueue)) { + queue_remove_first(joinedQueue, request, AggressivesRequest *, chain); + if (request->dataType == kAggressivesRequestTypeService) { + service = request->data.service; + } else { + service = NULL; + } - // Sleep canceled, clear the sleep trace point. - tracePoint(kIOPMTracePointSystemUp); - - if (!wrangler) - { - if (idleSeconds) - { - // stay awake for at least idleSeconds - startIdleSleepTimer(idleSeconds); - } - } - else if (sleepSlider && !userIsActive) - { - // Display wrangler is already asleep, it won't trigger the next - // idle sleep attempt. Schedule a future idle sleep attempt, and - // also push out the next idle sleep attempt. - - startIdleSleepTimer( kIdleSleepRetryInterval ); - } - - IOService::setAdvisoryTickleEnable( true ); - return tellClients( kIOMessageSystemWillNotSleep ); + IODelete(request, AggressivesRequest, 1); + request = NULL; + + if (service) { + if (service->assertPMDriverCall(&callEntry, kIOPMDriverCallMethodSetAggressive)) { + for (i = 0, record = array; i < count; i++, record++) { + value = record->value; + if (record->flags & kAggressivesRecordFlagMinValue) { + value = kAggressivesMinValue; + } + + _LOG("synchronizeAggressives 0x%x = %u to %s\n", + record->type, value, service->getName()); + service->setAggressiveness(record->type, value); + } + service->deassertPMDriverCall(&callEntry); + } + service->release(); // retained by joinAggressiveness() + } + } } //****************************************************************************** -// tellChangeUp -// -// Notify registered applications and kernel clients that we are raising power. +// broadcastAggressives // -// We override the superclass implementation so we can send a different message -// type to the client or application being notified. +// Traverse PM tree and call setAggressiveness() for records that have changed. //****************************************************************************** -void IOPMrootDomain::tellChangeUp( unsigned long stateNum ) +void +IOPMrootDomain::broadcastAggressives( + const AggressivesRecord * array, + int count ) { + IORegistryIterator * iter; + IORegistryEntry * entry; + IOPowerConnection * connect; + IOService * service; + const AggressivesRecord * record; + IOPMDriverCallEntry callEntry; + uint32_t value; + int i; - DLOG("tellChangeUp %u->%u\n", - (uint32_t) getPowerState(), (uint32_t) stateNum); - - ignoreTellChangeDown = false; - - if ( stateNum == ON_STATE ) - { - // Direct callout into OSKext so it can disable kext unloads - // during sleep/wake to prevent deadlocks. - OSKextSystemSleepOrWake( kIOMessageSystemHasPoweredOn ); - - // Notify platform that sleep was cancelled or resumed. - getPlatform()->callPlatformFunction( - sleepMessagePEFunction, false, - (void *)(uintptr_t) kIOMessageSystemHasPoweredOn, - NULL, NULL, NULL); - - if (getPowerState() == ON_STATE) - { - // this is a quick wake from aborted sleep - ignoreIdleSleepTimer = false; - if (idleSeconds && !wrangler) - { - // stay awake for at least idleSeconds - startIdleSleepTimer(idleSeconds); - } - IOService::setAdvisoryTickleEnable( true ); - tellClients( kIOMessageSystemWillPowerOn ); - } - - tracePoint( kIOPMTracePointWakeApplications ); - - -#if defined(__i386__) || defined(__x86_64__) - if (spindumpDesc) - { - AbsoluteTime deadline; - clock_interval_to_deadline( 30, kSecondScale, &deadline ); - thread_call_enter_delayed(stackshotOffloader, deadline); - } -#endif + iter = IORegistryIterator::iterateOver( + this, gIOPowerPlane, kIORegistryIterateRecursively); + if (iter) { + do{ + iter->reset(); + while ((entry = iter->getNextObject())) { + connect = OSDynamicCast(IOPowerConnection, entry); + if (!connect || !connect->getReadyFlag()) { + continue; + } - tellClients( kIOMessageSystemHasPoweredOn ); - } + if ((service = OSDynamicCast(IOService, connect->copyChildEntry(gIOPowerPlane)))) { + if (service->assertPMDriverCall(&callEntry, kIOPMDriverCallMethodSetAggressive)) { + for (i = 0, record = array; i < count; i++, record++) { + if (record->flags & kAggressivesRecordFlagModified) { + value = record->value; + if (record->flags & kAggressivesRecordFlagMinValue) { + value = kAggressivesMinValue; + } + _LOG("broadcastAggressives %x = %u to %s\n", + record->type, value, service->getName()); + service->setAggressiveness(record->type, value); + } + } + service->deassertPMDriverCall(&callEntry); + } + service->release(); + } + } + }while (!entry && !iter->isValid()); + iter->release(); + } } -//****************************************************************************** -// sysPowerDownHandler -// -// Perform a vfs sync before system sleep. -//****************************************************************************** - -IOReturn IOPMrootDomain::sysPowerDownHandler( - void * target, void * refCon, - UInt32 messageType, IOService * service, - void * messageArgs, vm_size_t argSize ) -{ - IOReturn ret = 0; - - DLOG("sysPowerDownHandler message %s\n", getIOMessageString(messageType)); - - if (!gRootDomain) - return kIOReturnUnsupported; - - if (messageType == kIOMessageSystemCapabilityChange) - { - IOPMSystemCapabilityChangeParameters * params = - (IOPMSystemCapabilityChangeParameters *) messageArgs; - - // Interested applications have been notified of an impending power - // change and have acked (when applicable). - // This is our chance to save whatever state we can before powering - // down. - // We call sync_internal defined in xnu/bsd/vfs/vfs_syscalls.c, - // via callout - - DLOG("sysPowerDownHandler cap %x -> %x (flags %x)\n", - params->fromCapabilities, params->toCapabilities, - params->changeFlags); - - if ((params->changeFlags & kIOPMSystemCapabilityWillChange) && - (params->fromCapabilities & kIOPMSystemCapabilityCPU) && - (params->toCapabilities & kIOPMSystemCapabilityCPU) == 0) - { - // We will ack within 20 seconds - params->maxWaitForReply = 20 * 1000 * 1000; -#if HIBERNATION - gRootDomain->evaluateSystemSleepPolicyEarly(); - - // add in time we could spend freeing pages - if (gRootDomain->hibernateMode && !gRootDomain->hibernateDisabled) - { - params->maxWaitForReply = kCapabilityClientMaxWait; - } - DLOG("sysPowerDownHandler max wait %d s\n", - (int) (params->maxWaitForReply / 1000 / 1000)); -#endif - - // Notify platform that sleep has begun, after the early - // sleep policy evaluation. - getPlatform()->callPlatformFunction( - sleepMessagePEFunction, false, - (void *)(uintptr_t) kIOMessageSystemWillSleep, - NULL, NULL, NULL); - - if ( !OSCompareAndSwap( 0, 1, &gSleepOrShutdownPending ) ) - { - // Purposely delay the ack and hope that shutdown occurs quickly. - // Another option is not to schedule the thread and wait for - // ack timeout... - AbsoluteTime deadline; - clock_interval_to_deadline( 30, kSecondScale, &deadline ); - thread_call_enter1_delayed( - gRootDomain->diskSyncCalloutEntry, - (thread_call_param_t)(uintptr_t) params->notifyRef, - deadline ); - } - else - thread_call_enter1( - gRootDomain->diskSyncCalloutEntry, - (thread_call_param_t)(uintptr_t) params->notifyRef); - } - else - if ((params->changeFlags & kIOPMSystemCapabilityDidChange) && - (params->toCapabilities & kIOPMSystemCapabilityCPU) && - (params->fromCapabilities & kIOPMSystemCapabilityCPU) == 0) - { -#if HIBERNATION - // We will ack within 110 seconds - params->maxWaitForReply = 110 * 1000 * 1000; - - thread_call_enter1( - gRootDomain->diskSyncCalloutEntry, - (thread_call_param_t)(uintptr_t) params->notifyRef); -#endif - } - ret = kIOReturnSuccess; - } - - return ret; +//***************************************** +// stackshot on power button press +// *************************************** +static void +powerButtonDownCallout(thread_call_param_t us, thread_call_param_t ) +{ + /* Power button pressed during wake + * Take a stackshot + */ + DEBUG_LOG("Powerbutton: down. Taking stackshot\n"); + ((IOPMrootDomain *)us)->takeStackshot(false); } -//****************************************************************************** -// handleQueueSleepWakeUUID -// -// Called from IOPMrootDomain when we're initiating a sleep, -// or indirectly from PM configd when PM decides to clear the UUID. -// PM clears the UUID several minutes after successful wake from sleep, -// so that we might associate App spindumps with the immediately previous -// sleep/wake. +static void +powerButtonUpCallout(thread_call_param_t us, thread_call_param_t) +{ + /* Power button released. + * Delete any stackshot data + */ + DEBUG_LOG("PowerButton: up callout. Delete stackshot\n"); + ((IOPMrootDomain *)us)->deleteStackshot(); +} +//************************************************************************* // -// @param obj has a retain on it. We're responsible for releasing that retain. -//****************************************************************************** - -void IOPMrootDomain::handleQueueSleepWakeUUID(OSObject *obj) -{ - OSString *str = NULL; - - if (kOSBooleanFalse == obj) - { - handlePublishSleepWakeUUID(NULL); - } - else if ((str = OSDynamicCast(OSString, obj))) - { - // This branch caches the UUID for an upcoming sleep/wake - if (queuedSleepWakeUUIDString) { - queuedSleepWakeUUIDString->release(); - queuedSleepWakeUUIDString = NULL; - } - queuedSleepWakeUUIDString = str; - queuedSleepWakeUUIDString->retain(); - - DLOG("SleepWake UUID queued: %s\n", queuedSleepWakeUUIDString->getCStringNoCopy()); - } - if (obj) { - obj->release(); - } - return; +// MARK: - +// MARK: System Sleep -} //****************************************************************************** -// handlePublishSleepWakeUUID +// startIdleSleepTimer // -// Called from IOPMrootDomain when we're initiating a sleep, -// or indirectly from PM configd when PM decides to clear the UUID. -// PM clears the UUID several minutes after successful wake from sleep, -// so that we might associate App spindumps with the immediately previous -// sleep/wake. //****************************************************************************** -void IOPMrootDomain::handlePublishSleepWakeUUID( bool shouldPublish ) -{ - ASSERT_GATED(); - - /* - * Clear the current UUID - */ - if (gSleepWakeUUIDIsSet) - { - DLOG("SleepWake UUID cleared\n"); - - OSString *UUIDstring = NULL; - - if (timeline && - (UUIDstring = OSDynamicCast(OSString, getProperty(kIOPMSleepWakeUUIDKey)))) - { - PMEventDetails *details = PMEventDetails::eventDetails(kIOPMEventTypeUUIDClear, - UUIDstring->getCStringNoCopy(), NULL, 0); - if (details) { - timeline->recordSystemPowerEvent( details ); - details->release(); - } - timeline->setNumEventsLoggedThisPeriod(0); - } - - gSleepWakeUUIDIsSet = false; - - removeProperty(kIOPMSleepWakeUUIDKey); - messageClients(kIOPMMessageSleepWakeUUIDChange, kIOPMMessageSleepWakeUUIDCleared); - } - - /* - * Optionally, publish a new UUID - */ - if (queuedSleepWakeUUIDString && shouldPublish) { - - OSString *publishThisUUID = NULL; - - publishThisUUID = queuedSleepWakeUUIDString; - publishThisUUID->retain(); - - if (timeline) { - PMEventDetails *details; - details = PMEventDetails::eventDetails(kIOPMEventTypeUUIDSet, - publishThisUUID->getCStringNoCopy(), NULL, 0); - if (details) { - timeline->recordSystemPowerEvent( details ); - details->release(); - } - } - - if (publishThisUUID) - { - setProperty(kIOPMSleepWakeUUIDKey, publishThisUUID); - publishThisUUID->release(); - } - - gSleepWakeUUIDIsSet = true; - messageClients(kIOPMMessageSleepWakeUUIDChange, kIOPMMessageSleepWakeUUIDSet); - - queuedSleepWakeUUIDString->release(); - queuedSleepWakeUUIDString = NULL; - } +void +IOPMrootDomain::startIdleSleepTimer( uint32_t inSeconds ) +{ + AbsoluteTime deadline; + + ASSERT_GATED(); + if (gNoIdleFlag) { + DLOG("idle timer not set (noidle=%d)\n", gNoIdleFlag); + return; + } + if (inSeconds) { + clock_interval_to_deadline(inSeconds, kSecondScale, &deadline); + thread_call_enter_delayed(extraSleepTimer, deadline); + idleSleepTimerPending = true; + } else { + thread_call_enter(extraSleepTimer); + } + DLOG("idle timer set for %u seconds\n", inSeconds); } //****************************************************************************** -// initializeBootSessionUUID +// cancelIdleSleepTimer // -// Initialize the boot session uuid at boot up and sets it into registry. //****************************************************************************** -void IOPMrootDomain::initializeBootSessionUUID(void) +void +IOPMrootDomain::cancelIdleSleepTimer( void ) { - uuid_t new_uuid; - uuid_string_t new_uuid_string; + ASSERT_GATED(); + if (idleSleepTimerPending) { + DLOG("idle timer cancelled\n"); + thread_call_cancel(extraSleepTimer); + idleSleepTimerPending = false; - uuid_generate(new_uuid); - uuid_unparse_upper(new_uuid, new_uuid_string); - memcpy(bootsessionuuid_string, new_uuid_string, sizeof(uuid_string_t)); - - setProperty(kIOPMBootSessionUUIDKey, new_uuid_string); + if (!assertOnWakeSecs && gIOLastWakeAbsTime) { + AbsoluteTime now; + clock_usec_t microsecs; + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_microtime(now, &assertOnWakeSecs, µsecs); + if (assertOnWakeReport) { + HISTREPORT_TALLYVALUE(assertOnWakeReport, (int64_t)assertOnWakeSecs); + DLOG("Updated assertOnWake %lu\n", (unsigned long)assertOnWakeSecs); + } + } + } } //****************************************************************************** -// changePowerStateTo & changePowerStateToPriv +// idleSleepTimerExpired // -// Override of these methods for logging purposes. //****************************************************************************** -IOReturn IOPMrootDomain::changePowerStateTo( unsigned long ordinal ) -{ - DLOG("changePowerStateTo(%lu)\n", ordinal); - - if ((ordinal != ON_STATE) && (ordinal != SLEEP_STATE)) - return kIOReturnUnsupported; - - return super::changePowerStateTo(ordinal); -} - -IOReturn IOPMrootDomain::changePowerStateToPriv( unsigned long ordinal ) +static void +idleSleepTimerExpired( + thread_call_param_t us, thread_call_param_t ) { - DLOG("changePowerStateToPriv(%lu)\n", ordinal); - - if ((ordinal != ON_STATE) && (ordinal != SLEEP_STATE)) - return kIOReturnUnsupported; - - return super::changePowerStateToPriv(ordinal); + ((IOPMrootDomain *)us)->handleSleepTimerExpiration(); } //****************************************************************************** -// activity detect +// handleSleepTimerExpiration // +// The time between the sleep idle timeout and the next longest one has elapsed. +// It's time to sleep. Start that by removing the clamp that's holding us awake. //****************************************************************************** -bool IOPMrootDomain::activitySinceSleep(void) -{ - return (userActivityCount != userActivityAtSleep); -} - -bool IOPMrootDomain::abortHibernation(void) +void +IOPMrootDomain::handleSleepTimerExpiration( void ) { - bool ret = activitySinceSleep(); + if (!gIOPMWorkLoop->inGate()) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, + &IOPMrootDomain::handleSleepTimerExpiration), + this); + return; + } - if (ret && !hibernateAborted && checkSystemCanSustainFullWake()) - { - DLOG("activitySinceSleep ABORT [%d, %d]\n", userActivityCount, userActivityAtSleep); - hibernateAborted = true; - } - return (ret); -} + AbsoluteTime time; -extern "C" int -hibernate_should_abort(void) -{ - if (gRootDomain) - return (gRootDomain->abortHibernation()); - else - return (0); -} + DLOG("sleep timer expired\n"); + ASSERT_GATED(); -//****************************************************************************** -// willNotifyPowerChildren -// -// Called after all interested drivers have all acknowledged the power change, -// but before any power children is informed. Dispatched though a thread call, -// so it is safe to perform work that might block on a sleeping disk. PM state -// machine (not thread) will block w/o timeout until this function returns. -//****************************************************************************** + idleSleepTimerPending = false; -void IOPMrootDomain::willNotifyPowerChildren( IOPMPowerStateIndex newPowerState ) -{ -#if HIBERNATION - if (SLEEP_STATE == newPowerState) - { - IOHibernateSystemSleep(); - IOHibernateIOKitSleep(); - } -#endif + clock_get_uptime(&time); + setQuickSpinDownTimeout(); + adjustPowerState(true); } //****************************************************************************** -// sleepOnClamshellClosed +// getTimeToIdleSleep // -// contains the logic to determine if the system should sleep when the clamshell -// is closed. +// Returns number of seconds left before going into idle sleep. +// Caller has to make sure that idle sleep is allowed at the time of calling +// this function //****************************************************************************** -bool IOPMrootDomain::shouldSleepOnClamshellClosed( void ) +uint32_t +IOPMrootDomain::getTimeToIdleSleep( void ) { - if (!clamshellExists) - return false; + AbsoluteTime now, lastActivityTime; + uint64_t nanos; + uint32_t minutesSinceUserInactive = 0; + uint32_t sleepDelay = 0; - DLOG("clamshell closed %d, disabled %d, desktopMode %d, ac %d sleepDisabled %d\n", - clamshellClosed, clamshellDisabled, desktopMode, acAdaptorConnected, clamshellSleepDisabled); + if (!idleSleepEnabled) { + return 0xffffffff; + } - return ( !clamshellDisabled && !(desktopMode && acAdaptorConnected) && !clamshellSleepDisabled ); -} + if (userActivityTime) { + lastActivityTime = userActivityTime; + } else { + lastActivityTime = userBecameInactiveTime; + } -void IOPMrootDomain::sendClientClamshellNotification( void ) -{ - /* Only broadcast clamshell alert if clamshell exists. */ - if (!clamshellExists) - return; + clock_get_uptime(&now); + if (CMP_ABSOLUTETIME(&now, &lastActivityTime) > 0) { + SUB_ABSOLUTETIME(&now, &lastActivityTime); + absolutetime_to_nanoseconds(now, &nanos); + minutesSinceUserInactive = nanos / (60000000000ULL); - setProperty(kAppleClamshellStateKey, - clamshellClosed ? kOSBooleanTrue : kOSBooleanFalse); + if (minutesSinceUserInactive >= sleepSlider) { + sleepDelay = 0; + } else { + sleepDelay = sleepSlider - minutesSinceUserInactive; + } + } else { + sleepDelay = sleepSlider; + } - setProperty(kAppleClamshellCausesSleepKey, - shouldSleepOnClamshellClosed() ? kOSBooleanTrue : kOSBooleanFalse); + DLOG("user inactive %u min, time to idle sleep %u min\n", + minutesSinceUserInactive, sleepDelay); - /* Argument to message is a bitfiel of - * ( kClamshellStateBit | kClamshellSleepBit ) - */ - messageClients(kIOPMMessageClamshellStateChange, - (void *)(uintptr_t) ( (clamshellClosed ? kClamshellStateBit : 0) - | ( shouldSleepOnClamshellClosed() ? kClamshellSleepBit : 0)) ); + return sleepDelay * 60; } //****************************************************************************** -// getSleepSupported +// setQuickSpinDownTimeout // -// Deprecated //****************************************************************************** -IOOptionBits IOPMrootDomain::getSleepSupported( void ) +void +IOPMrootDomain::setQuickSpinDownTimeout( void ) { - return( platformSleepSupport ); + ASSERT_GATED(); + setAggressiveness( + kPMMinutesToSpinDown, 0, kAggressivesOptionQuickSpindownEnable ); } //****************************************************************************** -// setSleepSupported +// restoreUserSpinDownTimeout // -// Deprecated //****************************************************************************** -void IOPMrootDomain::setSleepSupported( IOOptionBits flags ) +void +IOPMrootDomain::restoreUserSpinDownTimeout( void ) { - DLOG("setSleepSupported(%x)\n", (uint32_t) flags); - OSBitOrAtomic(flags, &platformSleepSupport); + ASSERT_GATED(); + setAggressiveness( + kPMMinutesToSpinDown, 0, kAggressivesOptionQuickSpindownDisable ); } //****************************************************************************** -// setDisableClamShellSleep +// sleepSystem // //****************************************************************************** -void IOPMrootDomain::setDisableClamShellSleep( bool val ) +/* public */ +IOReturn +IOPMrootDomain::sleepSystem( void ) { - if (gIOPMWorkLoop->inGate() == false) { - - gIOPMWorkLoop->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::setDisableClamShellSleep), - (OSObject *)this, - (void *)val); - - return; - } - else { - DLOG("setDisableClamShellSleep(%x)\n", (uint32_t) val); - if ( clamshellSleepDisabled != val ) - { - clamshellSleepDisabled = val; - // If clamshellSleepDisabled is reset to 0, reevaluate if - // system need to go to sleep due to clamshell state - if ( !clamshellSleepDisabled && clamshellClosed) - handlePowerNotification(kLocalEvalClamshellCommand); - } - } + return sleepSystemOptions(NULL); } -//****************************************************************************** -// wakeFromDoze -// -// Deprecated. -//****************************************************************************** - -void IOPMrootDomain::wakeFromDoze( void ) +/* private */ +IOReturn +IOPMrootDomain::sleepSystemOptions( OSDictionary *options ) { - // Preserve symbol for familes (IOUSBFamily and IOGraphics) -} - -// MARK: - -// MARK: Features + OSObject *obj = NULL; + OSString *reason = NULL; + /* sleepSystem is a public function, and may be called by any kernel driver. + * And that's bad - drivers should sleep the system by calling + * receivePowerNotification() instead. Drivers should not use sleepSystem. + * + * Note that user space app calls to IOPMSleepSystem() will also travel + * this code path and thus be correctly identified as software sleeps. + */ + + if (options && options->getObject("OSSwitch")) { + // Log specific sleep cause for OS Switch hibernation + return privateSleepSystem( kIOPMSleepReasonOSSwitchHibernate); + } -//****************************************************************************** -// publishFeature -// -// Adds a new feature to the supported features dictionary -//****************************************************************************** + if (options && (obj = options->getObject("Sleep Reason"))) { + reason = OSDynamicCast(OSString, obj); + if (reason && reason->isEqualTo(kIOPMDarkWakeThermalEmergencyKey)) { + return privateSleepSystem(kIOPMSleepReasonDarkWakeThermalEmergency); + } + } -void IOPMrootDomain::publishFeature( const char * feature ) -{ - publishFeature(feature, kRD_AllPowerSources, NULL); + return privateSleepSystem( kIOPMSleepReasonSoftware); } -//****************************************************************************** -// publishFeature (with supported power source specified) -// -// Adds a new feature to the supported features dictionary -//****************************************************************************** +/* private */ +IOReturn +IOPMrootDomain::privateSleepSystem( uint32_t sleepReason ) +{ + /* Called from both gated and non-gated context */ -void IOPMrootDomain::publishFeature( - const char *feature, - uint32_t supportedWhere, - uint32_t *uniqueFeatureID) -{ - static uint16_t next_feature_id = 500; - - OSNumber *new_feature_data = NULL; - OSNumber *existing_feature = NULL; - OSArray *existing_feature_arr = NULL; - OSObject *osObj = NULL; - uint32_t feature_value = 0; - - supportedWhere &= kRD_AllPowerSources; // mask off any craziness! - - if(!supportedWhere) { - // Feature isn't supported anywhere! - return; - } - - if(next_feature_id > 5000) { - // Far, far too many features! - return; - } - - if(featuresDictLock) IOLockLock(featuresDictLock); - - OSDictionary *features = - (OSDictionary *) getProperty(kRootDomainSupportedFeatures); - - // Create new features dict if necessary - if ( features && OSDynamicCast(OSDictionary, features)) { - features = OSDictionary::withDictionary(features); - } else { - features = OSDictionary::withCapacity(1); - } - - // Create OSNumber to track new feature - - next_feature_id += 1; - if( uniqueFeatureID ) { - // We don't really mind if the calling kext didn't give us a place - // to stash their unique id. Many kexts don't plan to unload, and thus - // have no need to remove themselves later. - *uniqueFeatureID = next_feature_id; - } - - feature_value = (uint32_t)next_feature_id; - feature_value <<= 16; - feature_value += supportedWhere; - - new_feature_data = OSNumber::withNumber( - (unsigned long long)feature_value, 32); - - // Does features object already exist? - if( (osObj = features->getObject(feature)) ) - { - if(( existing_feature = OSDynamicCast(OSNumber, osObj) )) - { - // We need to create an OSArray to hold the now 2 elements. - existing_feature_arr = OSArray::withObjects( - (const OSObject **)&existing_feature, 1, 2); - } else if(( existing_feature_arr = OSDynamicCast(OSArray, osObj) )) - { - // Add object to existing array - existing_feature_arr = OSArray::withArray( - existing_feature_arr, - existing_feature_arr->getCount() + 1); - } - - if (existing_feature_arr) - { - existing_feature_arr->setObject(new_feature_data); - features->setObject(feature, existing_feature_arr); - existing_feature_arr->release(); - existing_feature_arr = 0; - } - } else { - // The easy case: no previously existing features listed. We simply - // set the OSNumber at key 'feature' and we're on our way. - features->setObject(feature, new_feature_data); - } - - new_feature_data->release(); - - setProperty(kRootDomainSupportedFeatures, features); - - features->release(); - - if(featuresDictLock) IOLockUnlock(featuresDictLock); - - // Notify EnergySaver and all those in user space so they might - // re-populate their feature specific UI - if(pmPowerStateQueue) { - pmPowerStateQueue->submitPowerEvent( kPowerEventFeatureChanged ); - } -} + if (!checkSystemSleepEnabled() || !pmPowerStateQueue) { + return kIOReturnNotPermitted; + } -//****************************************************************************** -// removePublishedFeature -// -// Removes previously published feature -//****************************************************************************** + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDemandSystemSleep, + sleepReason); -IOReturn IOPMrootDomain::removePublishedFeature( uint32_t removeFeatureID ) -{ - IOReturn ret = kIOReturnError; - uint32_t feature_value = 0; - uint16_t feature_id = 0; - bool madeAChange = false; - - OSSymbol *dictKey = NULL; - OSCollectionIterator *dictIterator = NULL; - OSArray *arrayMember = NULL; - OSNumber *numberMember = NULL; - OSObject *osObj = NULL; - OSNumber *osNum = NULL; - OSArray *arrayMemberCopy; - - if (kBadPMFeatureID == removeFeatureID) - return kIOReturnNotFound; - - if(featuresDictLock) IOLockLock(featuresDictLock); - - OSDictionary *features = - (OSDictionary *) getProperty(kRootDomainSupportedFeatures); - - if ( features && OSDynamicCast(OSDictionary, features) ) - { - // Any modifications to the dictionary are made to the copy to prevent - // races & crashes with userland clients. Dictionary updated - // automically later. - features = OSDictionary::withDictionary(features); - } else { - features = NULL; - ret = kIOReturnNotFound; - goto exit; - } - - // We iterate 'features' dictionary looking for an entry tagged - // with 'removeFeatureID'. If found, we remove it from our tracking - // structures and notify the OS via a general interest message. - - dictIterator = OSCollectionIterator::withCollection(features); - if(!dictIterator) { - goto exit; - } - - while( (dictKey = OSDynamicCast(OSSymbol, dictIterator->getNextObject())) ) - { - osObj = features->getObject(dictKey); - - // Each Feature is either tracked by an OSNumber - if( osObj && (numberMember = OSDynamicCast(OSNumber, osObj)) ) - { - feature_value = numberMember->unsigned32BitValue(); - feature_id = (uint16_t)(feature_value >> 16); - - if( feature_id == (uint16_t)removeFeatureID ) - { - // Remove this node - features->removeObject(dictKey); - madeAChange = true; - break; - } - - // Or tracked by an OSArray of OSNumbers - } else if( osObj && (arrayMember = OSDynamicCast(OSArray, osObj)) ) - { - unsigned int arrayCount = arrayMember->getCount(); - - for(unsigned int i=0; igetObject(i)); - if(!osNum) { - continue; - } - - feature_value = osNum->unsigned32BitValue(); - feature_id = (uint16_t)(feature_value >> 16); - - if( feature_id == (uint16_t)removeFeatureID ) - { - // Remove this node - if( 1 == arrayCount ) { - // If the array only contains one element, remove - // the whole thing. - features->removeObject(dictKey); - } else { - // Otherwise remove the element from a copy of the array. - arrayMemberCopy = OSArray::withArray(arrayMember); - if (arrayMemberCopy) - { - arrayMemberCopy->removeObject(i); - features->setObject(dictKey, arrayMemberCopy); - arrayMemberCopy->release(); - } - } - - madeAChange = true; - break; - } - } - } - } - - dictIterator->release(); - - if( madeAChange ) - { - ret = kIOReturnSuccess; - - setProperty(kRootDomainSupportedFeatures, features); - - // Notify EnergySaver and all those in user space so they might - // re-populate their feature specific UI - if(pmPowerStateQueue) { - pmPowerStateQueue->submitPowerEvent( kPowerEventFeatureChanged ); - } - } else { - ret = kIOReturnNotFound; - } - -exit: - if(features) features->release(); - if(featuresDictLock) IOLockUnlock(featuresDictLock); - return ret; + return kIOReturnSuccess; } //****************************************************************************** -// publishPMSetting (private) +// powerChangeDone // -// Should only be called by PMSettingObject to publish a PM Setting as a -// supported feature. +// This overrides powerChangeDone in IOService. //****************************************************************************** - -void IOPMrootDomain::publishPMSetting( - const OSSymbol * feature, uint32_t where, uint32_t * featureID ) +void +IOPMrootDomain::powerChangeDone( unsigned long previousPowerState ) { - if (noPublishPMSettings && - (noPublishPMSettings->getNextIndexOfObject(feature, 0) != (unsigned int)-1)) - { - // Setting found in noPublishPMSettings array - *featureID = kBadPMFeatureID; - return; - } +#if !__i386__ && !__x86_64__ + uint64_t timeSinceReset = 0; +#endif + uint64_t now; + unsigned long newState; + clock_sec_t secs; + clock_usec_t microsecs; +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + clock_sec_t adjWakeTime; + IOPMCalendarStruct nowCalendar; +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + ASSERT_GATED(); + newState = getPowerState(); + DLOG("PowerChangeDone: %s->%s\n", + getPowerStateString((uint32_t) previousPowerState), getPowerStateString((uint32_t) getPowerState())); + + if (previousPowerState == newState) { + return; + } - publishFeature( - feature->getCStringNoCopy(), where, featureID); -} + notifierThread = current_thread(); + switch (getPowerState()) { + case SLEEP_STATE: { +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (kPMCalendarTypeInvalid != _aotWakeTimeCalendar.selector) { + secs = 0; + microsecs = 0; + PEGetUTCTimeOfDay(&secs, µsecs); + + adjWakeTime = 0; + if ((kIOPMAOTModeRespectTimers & _aotMode) && (_scheduledAlarmUTC < _aotWakeTimeUTC)) { + IOLog("use _scheduledAlarmUTC\n"); + adjWakeTime = _scheduledAlarmUTC; + } else if (_aotExit || (kIOPMWakeEventAOTExitFlags & _aotPendingFlags)) { + IOLog("accelerate _aotWakeTime for exit\n"); + adjWakeTime = secs; + } else if (kIOPMDriverAssertionLevelOn == getPMAssertionLevel(kIOPMDriverAssertionCPUBit)) { + IOLog("accelerate _aotWakeTime for assertion\n"); + adjWakeTime = secs; + } + if (adjWakeTime) { + IOPMConvertSecondsToCalendar(adjWakeTime, &_aotWakeTimeCalendar); + } -//****************************************************************************** -// setPMSetting (private) -// -// Internal helper to relay PM settings changes from user space to individual -// drivers. Should be called only by IOPMrootDomain::setProperties. -//****************************************************************************** + IOPMConvertSecondsToCalendar(secs, &nowCalendar); + IOLog("aotSleep at " YMDTF " sched: " YMDTF "\n", YMDT(&nowCalendar), YMDT(&_aotWakeTimeCalendar)); -IOReturn IOPMrootDomain::setPMSetting( - const OSSymbol *type, - OSObject *object ) -{ - PMSettingCallEntry *entries = 0; - OSArray *chosen = 0; - const OSArray *array; - PMSettingObject *pmso; - thread_t thisThread; - int i, j, count, capacity; - - if (NULL == type) - return kIOReturnBadArgument; - - PMSETTING_LOCK(); - - // Update settings dict so changes are visible from copyPMSetting(). - fPMSettingsDict->setObject(type, object); - - // Prep all PMSetting objects with the given 'type' for callout. - array = (const OSArray *) settingsCallbacks->getObject(type); - if (!array || ((capacity = array->getCount()) == 0)) - goto unlock_exit; - - // Array to retain PMSetting objects targeted for callout. - chosen = OSArray::withCapacity(capacity); - if (!chosen) - goto unlock_exit; // error - - entries = IONew(PMSettingCallEntry, capacity); - if (!entries) - goto unlock_exit; // error - memset(entries, 0, sizeof(PMSettingCallEntry) * capacity); - - thisThread = current_thread(); - - for (i = 0, j = 0; igetObject(i); - if (pmso->disabled) - continue; - entries[j].thread = thisThread; - queue_enter(&pmso->calloutQueue, &entries[j], PMSettingCallEntry *, link); - chosen->setObject(pmso); - j++; - } - count = j; - if (!count) - goto unlock_exit; - - PMSETTING_UNLOCK(); - - // Call each pmso in the chosen array. - for (i=0; igetObject(i); - pmso->dispatchPMSetting(type, object); - } - - PMSETTING_LOCK(); - for (i=0; igetObject(i); - queue_remove(&pmso->calloutQueue, &entries[i], PMSettingCallEntry *, link); - if (pmso->waitThread) - { - PMSETTING_WAKEUP(pmso); - } - } -unlock_exit: - PMSETTING_UNLOCK(); + IOReturn __unused ret = setMaintenanceWakeCalendar(&_aotWakeTimeCalendar); + assert(kIOReturnSuccess == ret); + } + if (_aotLastWakeTime) { + _aotMetrics->totalTime += mach_absolute_time() - _aotLastWakeTime; + if (_aotMetrics->sleepCount && (_aotMetrics->sleepCount <= kIOPMAOTMetricsKernelWakeCountMax)) { + strlcpy(&_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount - 1][0], + gWakeReasonString, + sizeof(_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount])); + } + } + _aotPendingFlags &= ~kIOPMWakeEventAOTPerCycleFlags; +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + acceptSystemWakeEvents(true); + + // re-enable this timer for next sleep + cancelIdleSleepTimer(); + + clock_get_calendar_absolute_and_microtime(&secs, µsecs, &now); + logtime(secs); + gIOLastSleepTime.tv_sec = secs; + gIOLastSleepTime.tv_usec = microsecs; +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (!_aotLastWakeTime) { + gIOLastUserSleepTime = gIOLastSleepTime; + } +#else + gIOLastUserSleepTime = gIOLastSleepTime; +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ - if (chosen) chosen->release(); - if (entries) IODelete(entries, PMSettingCallEntry, capacity); + gIOLastWakeTime.tv_sec = 0; + gIOLastWakeTime.tv_usec = 0; + gIOLastSleepAbsTime = now; - return kIOReturnSuccess; -} + if (wake2DarkwakeDelay && sleepDelaysReport) { + clock_sec_t wake2DarkwakeSecs, darkwake2SleepSecs; + // Update 'wake2DarkwakeDelay' histogram if this is a fullwake->sleep transition -//****************************************************************************** -// copyPMSetting (public) -// -// Allows kexts to safely read setting values, without being subscribed to -// notifications. -//****************************************************************************** + SUB_ABSOLUTETIME(&now, &ts_sleepStart); + absolutetime_to_microtime(now, &darkwake2SleepSecs, µsecs); + absolutetime_to_microtime(wake2DarkwakeDelay, &wake2DarkwakeSecs, µsecs); + HISTREPORT_TALLYVALUE(sleepDelaysReport, + (int64_t)(wake2DarkwakeSecs + darkwake2SleepSecs)); -OSObject * IOPMrootDomain::copyPMSetting( - OSSymbol *whichSetting) + DLOG("Updated sleepDelaysReport %lu %lu\n", (unsigned long)wake2DarkwakeSecs, (unsigned long)darkwake2SleepSecs); + wake2DarkwakeDelay = 0; + } +#if HIBERNATION + LOG("System %sSleep\n", gIOHibernateState ? "Safe" : ""); + + IOHibernateSystemHasSlept(); + + evaluateSystemSleepPolicyFinal(); +#else + LOG("System Sleep\n"); +#endif + if (thermalWarningState) { + const OSSymbol *event = OSSymbol::withCString(kIOPMThermalLevelWarningKey); + if (event) { + systemPowerEventOccurred(event, kIOPMThermalLevelUnknown); + event->release(); + } + } + assertOnWakeSecs = 0; + lowBatteryCondition = false; + +#if DEVELOPMENT || DEBUG + extern int g_should_log_clock_adjustments; + if (g_should_log_clock_adjustments) { + clock_sec_t secs = 0; + clock_usec_t microsecs = 0; + uint64_t now_b = mach_absolute_time(); + + secs = 0; + microsecs = 0; + PEGetUTCTimeOfDay(&secs, µsecs); + + uint64_t now_a = mach_absolute_time(); + os_log(OS_LOG_DEFAULT, "%s PMU before going to sleep %lu s %d u %llu abs_b_PEG %llu abs_a_PEG \n", + __func__, (unsigned long)secs, microsecs, now_b, now_a); + } +#endif + + getPlatform()->sleepKernel(); + + // The CPU(s) are off at this point, + // Code will resume execution here upon wake. + + clock_get_uptime(&gIOLastWakeAbsTime); + IOLog("gIOLastWakeAbsTime: %lld\n", gIOLastWakeAbsTime); + _highestCapability = 0; + +#if HIBERNATION + IOHibernateSystemWake(); +#endif + + // sleep transition complete + gSleepOrShutdownPending = 0; + + // trip the reset of the calendar clock + clock_wakeup_calendar(); + clock_get_calendar_microtime(&secs, µsecs); + gIOLastWakeTime.tv_sec = secs; + gIOLastWakeTime.tv_usec = microsecs; + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + // aot + if (_aotWakeTimeCalendar.selector != kPMCalendarTypeInvalid) { + _aotWakeTimeCalendar.selector = kPMCalendarTypeInvalid; + secs = 0; + microsecs = 0; + PEGetUTCTimeOfDay(&secs, µsecs); + IOPMConvertSecondsToCalendar(secs, &nowCalendar); + IOLog("aotWake at " YMDTF " sched: " YMDTF "\n", YMDT(&nowCalendar), YMDT(&_aotWakeTimeCalendar)); + _aotMetrics->sleepCount++; + _aotLastWakeTime = gIOLastWakeAbsTime; + if (_aotMetrics->sleepCount <= kIOPMAOTMetricsKernelWakeCountMax) { + _aotMetrics->kernelSleepTime[_aotMetrics->sleepCount - 1] + = (((uint64_t) gIOLastSleepTime.tv_sec) << 10) + (gIOLastSleepTime.tv_usec / 1000); + _aotMetrics->kernelWakeTime[_aotMetrics->sleepCount - 1] + = (((uint64_t) gIOLastWakeTime.tv_sec) << 10) + (gIOLastWakeTime.tv_usec / 1000); + } + + if (_aotTestTime) { + if (_aotWakeTimeUTC <= secs) { + _aotTestTime = _aotTestTime + _aotTestInterval; + } + setWakeTime(_aotTestTime); + } + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + +#if HIBERNATION + LOG("System %sWake\n", gIOHibernateState ? "SafeSleep " : ""); +#endif + + lastSleepReason = 0; + + _lastDebugWakeSeconds = _debugWakeSeconds; + _debugWakeSeconds = 0; + _scheduledAlarms = 0; + +#if defined(__i386__) || defined(__x86_64__) + kdebugTrace(kPMLogSystemWake, 0, 0, 0); + wranglerTickled = false; + graphicsSuppressed = false; + darkWakePostTickle = false; + darkWakeHibernateError = false; + darkWakeToSleepASAP = true; + logGraphicsClamp = true; + sleepTimerMaintenance = false; + sleepToStandby = false; + wranglerTickleLatched = false; + userWasActive = false; + isRTCAlarmWake = false; + fullWakeReason = kFullWakeReasonNone; + + OSString * wakeType = OSDynamicCast( + OSString, getProperty(kIOPMRootDomainWakeTypeKey)); + OSString * wakeReason = OSDynamicCast( + OSString, getProperty(kIOPMRootDomainWakeReasonKey)); + + if (wakeReason && (wakeReason->getLength() >= 2) && + gWakeReasonString[0] == '\0') { + // Until the platform driver can claim its wake reasons + strlcat(gWakeReasonString, wakeReason->getCStringNoCopy(), + sizeof(gWakeReasonString)); + } + + if (wakeType && wakeType->isEqualTo(kIOPMrootDomainWakeTypeLowBattery)) { + lowBatteryCondition = true; + darkWakeMaintenance = true; + } else if ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) != 0) { +#if HIBERNATION + OSNumber * hibOptions = OSDynamicCast( + OSNumber, getProperty(kIOHibernateOptionsKey)); + if (hibernateAborted || ((hibOptions && + !(hibOptions->unsigned32BitValue() & kIOHibernateOptionDarkWake)))) { + // Hibernate aborted, or EFI brought up graphics + wranglerTickled = true; + if (hibernateAborted) { + DLOG("Hibernation aborted\n"); + } else { + DLOG("EFI brought up graphics. Going to full wake. HibOptions: 0x%x\n", hibOptions->unsigned32BitValue()); + } + } else +#endif + if (wakeType && ( + wakeType->isEqualTo(kIOPMRootDomainWakeTypeUser) || + wakeType->isEqualTo(kIOPMRootDomainWakeTypeAlarm))) { + // User wake or RTC alarm + wranglerTickled = true; + if (wakeType->isEqualTo(kIOPMRootDomainWakeTypeAlarm)) { + isRTCAlarmWake = true; + } + } else if (wakeType && + wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepTimer)) { + // SMC standby timer trumps SleepX + darkWakeMaintenance = true; + sleepTimerMaintenance = true; + } else if ((_lastDebugWakeSeconds != 0) && + ((gDarkWakeFlags & kDarkWakeFlagAlarmIsDark) == 0)) { + // SleepX before maintenance + wranglerTickled = true; + } else if (wakeType && + wakeType->isEqualTo(kIOPMRootDomainWakeTypeMaintenance)) { + darkWakeMaintenance = true; + } else if (wakeType && + wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepService)) { + darkWakeMaintenance = true; + darkWakeSleepService = true; +#if HIBERNATION + if (kIOHibernateStateWakingFromHibernate == gIOHibernateState) { + sleepToStandby = true; + } +#endif + } else if (wakeType && + wakeType->isEqualTo(kIOPMRootDomainWakeTypeHibernateError)) { + darkWakeMaintenance = true; + darkWakeHibernateError = true; + } else { + // Unidentified wake source, resume to full wake if debug + // alarm is pending. + + if (_lastDebugWakeSeconds && + (!wakeReason || wakeReason->isEqualTo(""))) { + wranglerTickled = true; + } + } + } else { + if (wakeType && + wakeType->isEqualTo(kIOPMRootDomainWakeTypeSleepTimer)) { + darkWakeMaintenance = true; + sleepTimerMaintenance = true; + } else if (hibernateAborted || !wakeType || + !wakeType->isEqualTo(kIOPMRootDomainWakeTypeMaintenance) || + !wakeReason || !wakeReason->isEqualTo("RTC")) { + // Post a HID tickle immediately - except for RTC maintenance wake. + wranglerTickled = true; + } else { + darkWakeMaintenance = true; + } + } + + if (wranglerTickled) { + darkWakeToSleepASAP = false; + fullWakeReason = kFullWakeReasonLocalUser; + reportUserInput(); + } else if (displayPowerOnRequested && checkSystemCanSustainFullWake()) { + handleDisplayPowerOn(); + } else if (!darkWakeMaintenance) { + // Early/late tickle for non-maintenance wake. + if (((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == + kDarkWakeFlagHIDTickleEarly) || + ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == + kDarkWakeFlagHIDTickleLate)) { + darkWakePostTickle = true; + } + } +#else /* !__i386__ && !__x86_64__ */ + timeSinceReset = ml_get_time_since_reset(); + + kdebugTrace(kPMLogSystemWake, 0, timeSinceReset >> 32, timeSinceReset); + // stay awake for at least 30 seconds + wranglerTickled = true; + fullWakeReason = kFullWakeReasonLocalUser; + startIdleSleepTimer(30); +#endif + sleepCnt++; + + thread_call_enter(updateConsoleUsersEntry); + + changePowerStateToPriv(getRUN_STATE()); + break; + } +#if !__i386__ && !__x86_64__ + case ON_STATE: + case AOT_STATE: + { + DLOG("Force re-evaluating aggressiveness\n"); + /* Force re-evaluate the aggressiveness values to set appropriate idle sleep timer */ + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusNoIdleSleepPreventers ); + + // After changing to ON_STATE, invalidate any previously queued + // request to change to a state less than ON_STATE. This isn't + // necessary for AOT_STATE or if the device has only one running + // state since the changePowerStateToPriv() issued at the tail + // end of SLEEP_STATE case should take care of that. + if (getPowerState() == ON_STATE) { + changePowerStateToPriv(ON_STATE); + } + break; + } +#endif /* !__i386__ && !__x86_64__ */ + } + notifierThread = NULL; +} + +//****************************************************************************** +// requestPowerDomainState +// +// Extend implementation in IOService. Running on PM work loop thread. +//****************************************************************************** + +IOReturn +IOPMrootDomain::requestPowerDomainState( + IOPMPowerFlags childDesire, + IOPowerConnection * childConnection, + unsigned long specification ) +{ + // Idle and system sleep prevention flags affects driver desire. + // Children desire are irrelevant so they are cleared. + + return super::requestPowerDomainState(0, childConnection, specification); +} + + +//****************************************************************************** +// updatePreventIdleSleepList +// +// Called by IOService on PM work loop. +// Returns true if PM policy recognized the driver's desire to prevent idle +// sleep and updated the list of idle sleep preventers. Returns false otherwise +//****************************************************************************** + +bool +IOPMrootDomain::updatePreventIdleSleepList( + IOService * service, bool addNotRemove) +{ + unsigned int oldCount; + + oldCount = idleSleepPreventersCount(); + return updatePreventIdleSleepListInternal(service, addNotRemove, oldCount); +} + +bool +IOPMrootDomain::updatePreventIdleSleepListInternal( + IOService * service, bool addNotRemove, unsigned int oldCount) +{ + unsigned int newCount; + + ASSERT_GATED(); + +#if defined(__i386__) || defined(__x86_64__) + // Disregard disk I/O (besides the display wrangler) as a factor preventing + // idle sleep, except in the case of legacy disk I/O + if (service && (service != wrangler) && (service != this)) { + return false; + } +#endif + + if (service) { + if (addNotRemove) { + preventIdleSleepList->setObject(service); + DLOG("prevent idle sleep list: %s+ (%u)\n", + service->getName(), preventIdleSleepList->getCount()); + } else if (preventIdleSleepList->member(service)) { + preventIdleSleepList->removeObject(service); + DLOG("prevent idle sleep list: %s- (%u)\n", + service->getName(), preventIdleSleepList->getCount()); + } + } + newCount = idleSleepPreventersCount(); + + if ((oldCount == 0) && (newCount != 0)) { + // Driver added to empty prevent list. + // Update the driver desire to prevent idle sleep. + // Driver desire does not prevent demand sleep. + + changePowerStateTo(getRUN_STATE()); + } else if ((oldCount != 0) && (newCount == 0)) { + // Last driver removed from prevent list. + // Drop the driver clamp to allow idle sleep. + + changePowerStateTo(SLEEP_STATE); + evaluatePolicy( kStimulusNoIdleSleepPreventers ); + } + messageClient(kIOPMMessageIdleSleepPreventers, systemCapabilityNotifier, + &newCount, sizeof(newCount)); + +#if defined(__i386__) || defined(__x86_64__) + if (addNotRemove && (service == wrangler) && !checkSystemCanSustainFullWake()) { + DLOG("Cannot cancel idle sleep\n"); + return false; // do not idle-cancel + } +#endif + + return true; +} + +//****************************************************************************** +// startSpinDump +//****************************************************************************** + +void +IOPMrootDomain::startSpinDump(uint32_t spindumpKind) +{ + messageClients(kIOPMMessageLaunchBootSpinDump, (void *)(uintptr_t)spindumpKind); +} + +//****************************************************************************** +// preventSystemSleepListUpdate +// +// Called by IOService on PM work loop. +//****************************************************************************** + +void +IOPMrootDomain::updatePreventSystemSleepList( + IOService * service, bool addNotRemove ) +{ + unsigned int oldCount, newCount; + + ASSERT_GATED(); + if (this == service) { + return; + } + + oldCount = preventSystemSleepList->getCount(); + if (addNotRemove) { + preventSystemSleepList->setObject(service); + DLOG("prevent system sleep list: %s+ (%u)\n", + service->getName(), preventSystemSleepList->getCount()); + if (!assertOnWakeSecs && gIOLastWakeAbsTime) { + AbsoluteTime now; + clock_usec_t microsecs; + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_microtime(now, &assertOnWakeSecs, µsecs); + if (assertOnWakeReport) { + HISTREPORT_TALLYVALUE(assertOnWakeReport, (int64_t)assertOnWakeSecs); + DLOG("Updated assertOnWake %lu\n", (unsigned long)assertOnWakeSecs); + } + } + } else if (preventSystemSleepList->member(service)) { + preventSystemSleepList->removeObject(service); + DLOG("prevent system sleep list: %s- (%u)\n", + service->getName(), preventSystemSleepList->getCount()); + + if ((oldCount != 0) && (preventSystemSleepList->getCount() == 0)) { + // Lost all system sleep preventers. + // Send stimulus if system sleep was blocked, and is in dark wake. + evaluatePolicy( kStimulusDarkWakeEvaluate ); + } + } + newCount = preventSystemSleepList->getCount(); + messageClient(kIOPMMessageSystemSleepPreventers, systemCapabilityNotifier, + &newCount, sizeof(newCount)); +} + +void +IOPMrootDomain::copySleepPreventersList(OSArray **idleSleepList, OSArray **systemSleepList) +{ + OSCollectionIterator *iterator = NULL; + OSObject *object = NULL; + OSArray *array = NULL; + + if (!gIOPMWorkLoop->inGate()) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, + &IOPMrootDomain::IOPMrootDomain::copySleepPreventersList), + this, (void *)idleSleepList, (void *)systemSleepList); + return; + } + + if (idleSleepList && preventIdleSleepList && (preventIdleSleepList->getCount() != 0)) { + iterator = OSCollectionIterator::withCollection(preventIdleSleepList); + array = OSArray::withCapacity(5); + + while ((object = iterator->getNextObject())) { + IOService *service = OSDynamicCast(IOService, object); + if (object) { + array->setObject(OSSymbol::withCString(service->getName())); + } + } + + iterator->release(); + *idleSleepList = array; + } + + if (systemSleepList && preventSystemSleepList && (preventSystemSleepList->getCount() != 0)) { + iterator = OSCollectionIterator::withCollection(preventSystemSleepList); + array = OSArray::withCapacity(5); + + while ((object = iterator->getNextObject())) { + IOService *service = OSDynamicCast(IOService, object); + if (object) { + array->setObject(OSSymbol::withCString(service->getName())); + } + } + + iterator->release(); + *systemSleepList = array; + } +} + +void +IOPMrootDomain::copySleepPreventersListWithID(OSArray **idleSleepList, OSArray **systemSleepList) +{ + OSCollectionIterator *iterator = NULL; + OSObject *object = NULL; + OSArray *array = NULL; + + if (!gIOPMWorkLoop->inGate()) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, + &IOPMrootDomain::IOPMrootDomain::copySleepPreventersListWithID), + this, (void *)idleSleepList, (void *)systemSleepList); + return; + } + + if (idleSleepList && preventIdleSleepList && (preventIdleSleepList->getCount() != 0)) { + iterator = OSCollectionIterator::withCollection(preventIdleSleepList); + array = OSArray::withCapacity(5); + + while ((object = iterator->getNextObject())) { + IOService *service = OSDynamicCast(IOService, object); + if (object) { + OSDictionary *dict = OSDictionary::withCapacity(2); + if (dict) { + OSNumber *id = OSNumber::withNumber(service->getRegistryEntryID(), 64); + dict->setObject(kIOPMDriverAssertionRegistryEntryIDKey, id); + dict->setObject(kIOPMDriverAssertionOwnerStringKey, OSSymbol::withCString(service->getName())); + array->setObject(dict); + id->release(); + dict->release(); + } + } + } + + iterator->release(); + *idleSleepList = array; + } + + if (systemSleepList && preventSystemSleepList && (preventSystemSleepList->getCount() != 0)) { + iterator = OSCollectionIterator::withCollection(preventSystemSleepList); + array = OSArray::withCapacity(5); + + while ((object = iterator->getNextObject())) { + IOService *service = OSDynamicCast(IOService, object); + if (object) { + OSDictionary *dict = OSDictionary::withCapacity(2); + if (dict) { + OSNumber *id = OSNumber::withNumber(service->getRegistryEntryID(), 64); + dict->setObject(kIOPMDriverAssertionRegistryEntryIDKey, id); + dict->setObject(kIOPMDriverAssertionOwnerStringKey, OSSymbol::withCString(service->getName())); + array->setObject(dict); + id->release(); + dict->release(); + } + } + } + + iterator->release(); + *systemSleepList = array; + } +} + +//****************************************************************************** +// tellChangeDown +// +// Override the superclass implementation to send a different message type. +//****************************************************************************** + +bool +IOPMrootDomain::tellChangeDown( unsigned long stateNum ) +{ + DLOG("tellChangeDown %s->%s\n", + getPowerStateString((uint32_t) getPowerState()), getPowerStateString((uint32_t) stateNum)); + + if (SLEEP_STATE == stateNum) { + // Legacy apps were already told in the full->dark transition + if (!ignoreTellChangeDown) { + tracePoint( kIOPMTracePointSleepApplications ); + } else { + tracePoint( kIOPMTracePointSleepPriorityClients ); + } + } + + if (!ignoreTellChangeDown) { + userActivityAtSleep = userActivityCount; + DLOG("tellChangeDown::userActivityAtSleep %d\n", userActivityAtSleep); + + if (SLEEP_STATE == stateNum) { + hibernateAborted = false; + + // Direct callout into OSKext so it can disable kext unloads + // during sleep/wake to prevent deadlocks. + OSKextSystemSleepOrWake( kIOMessageSystemWillSleep ); + + IOService::updateConsoleUsers(NULL, kIOMessageSystemWillSleep); + + // Two change downs are sent by IOServicePM. Ignore the 2nd. + // But tellClientsWithResponse() must be called for both. + ignoreTellChangeDown = true; + } + } + + return super::tellClientsWithResponse( kIOMessageSystemWillSleep ); +} + +//****************************************************************************** +// askChangeDown +// +// Override the superclass implementation to send a different message type. +// This must be idle sleep since we don't ask during any other power change. +//****************************************************************************** + +bool +IOPMrootDomain::askChangeDown( unsigned long stateNum ) +{ + DLOG("askChangeDown %s->%s\n", + getPowerStateString((uint32_t) getPowerState()), getPowerStateString((uint32_t) stateNum)); + + // Don't log for dark wake entry + if (kSystemTransitionSleep == _systemTransitionType) { + tracePoint( kIOPMTracePointSleepApplications ); + } + + return super::tellClientsWithResponse( kIOMessageCanSystemSleep ); +} + +//****************************************************************************** +// askChangeDownDone +// +// An opportunity for root domain to cancel the power transition, +// possibily due to an assertion created by powerd in response to +// kIOMessageCanSystemSleep. +// +// Idle sleep: +// full -> dark wake transition +// 1. Notify apps and powerd with kIOMessageCanSystemSleep +// 2. askChangeDownDone() +// dark -> sleep transition +// 1. Notify powerd with kIOMessageCanSystemSleep +// 2. askChangeDownDone() +// +// Demand sleep: +// full -> dark wake transition +// 1. Notify powerd with kIOMessageCanSystemSleep +// 2. askChangeDownDone() +// dark -> sleep transition +// 1. Notify powerd with kIOMessageCanSystemSleep +// 2. askChangeDownDone() +//****************************************************************************** + +void +IOPMrootDomain::askChangeDownDone( + IOPMPowerChangeFlags * inOutChangeFlags, bool * cancel ) +{ + DLOG("askChangeDownDone(0x%x, %u) type %x, cap %x->%x\n", + *inOutChangeFlags, *cancel, + _systemTransitionType, + _currentCapability, _pendingCapability); + + if ((false == *cancel) && (kSystemTransitionSleep == _systemTransitionType)) { + // Dark->Sleep transition. + // Check if there are any deny sleep assertions. + // lastSleepReason already set by handleOurPowerChangeStart() + + if (!checkSystemCanSleep(lastSleepReason)) { + // Cancel dark wake to sleep transition. + // Must re-scan assertions upon entering dark wake. + + *cancel = true; + DLOG("cancel dark->sleep\n"); + } +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (_aotMode && (kPMCalendarTypeInvalid != _aotWakeTimeCalendar.selector)) { + uint64_t now = mach_continuous_time(); + if (((now + _aotWakePreWindow) >= _aotWakeTimeContinuous) + && (now < (_aotWakeTimeContinuous + _aotWakePostWindow))) { + *cancel = true; + IOLog("AOT wake window cancel: %qd, %qd\n", now, _aotWakeTimeContinuous); + } + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + } +} + +//****************************************************************************** +// systemDidNotSleep +// +// Work common to both canceled or aborted sleep. +//****************************************************************************** + +void +IOPMrootDomain::systemDidNotSleep( void ) +{ + // reset console lock state + thread_call_enter(updateConsoleUsersEntry); + + if (!wrangler) { + if (idleSleepEnabled) { + // stay awake for at least idleSeconds + startIdleSleepTimer(idleSeconds); + } + } else { + if (idleSleepEnabled && !userIsActive) { + // Manually start the idle sleep timer besides waiting for + // the user to become inactive. + startIdleSleepTimer( kIdleSleepRetryInterval ); + } + } + + preventTransitionToUserActive(false); + IOService::setAdvisoryTickleEnable( true ); + + // After idle revert and cancel, send a did-change message to powerd + // to balance the previous will-change message. Kernel clients do not + // need this since sleep cannot be canceled once they are notified. + + if (toldPowerdCapWillChange && systemCapabilityNotifier && + (_pendingCapability != _currentCapability) && + ((_systemMessageClientMask & kSystemMessageClientPowerd) != 0)) { + // Differs from a real capability gain change where notifyRef != 0, + // but it is zero here since no response is expected. + + IOPMSystemCapabilityChangeParameters params; + + bzero(¶ms, sizeof(params)); + params.fromCapabilities = _pendingCapability; + params.toCapabilities = _currentCapability; + params.changeFlags = kIOPMSystemCapabilityDidChange; + + DLOG("MESG cap %x->%x did change\n", + params.fromCapabilities, params.toCapabilities); + messageClient(kIOMessageSystemCapabilityChange, systemCapabilityNotifier, + ¶ms, sizeof(params)); + } +} + +//****************************************************************************** +// tellNoChangeDown +// +// Notify registered applications and kernel clients that we are not dropping +// power. +// +// We override the superclass implementation so we can send a different message +// type to the client or application being notified. +// +// This must be a vetoed idle sleep, since no other power change can be vetoed. +//****************************************************************************** + +void +IOPMrootDomain::tellNoChangeDown( unsigned long stateNum ) +{ + DLOG("tellNoChangeDown %s->%s\n", + getPowerStateString((uint32_t) getPowerState()), getPowerStateString((uint32_t) stateNum)); + + // Sleep canceled, clear the sleep trace point. + tracePoint(kIOPMTracePointSystemUp); + + systemDidNotSleep(); + return tellClients( kIOMessageSystemWillNotSleep ); +} + +//****************************************************************************** +// tellChangeUp +// +// Notify registered applications and kernel clients that we are raising power. +// +// We override the superclass implementation so we can send a different message +// type to the client or application being notified. +//****************************************************************************** + +void +IOPMrootDomain::tellChangeUp( unsigned long stateNum ) +{ + DLOG("tellChangeUp %s->%s\n", + getPowerStateString((uint32_t) getPowerState()), getPowerStateString((uint32_t) stateNum)); + + ignoreTellChangeDown = false; + + if (stateNum == ON_STATE) { + // Direct callout into OSKext so it can disable kext unloads + // during sleep/wake to prevent deadlocks. + OSKextSystemSleepOrWake( kIOMessageSystemHasPoweredOn ); + + // Notify platform that sleep was cancelled or resumed. + getPlatform()->callPlatformFunction( + sleepMessagePEFunction, false, + (void *)(uintptr_t) kIOMessageSystemHasPoweredOn, + NULL, NULL, NULL); + + if (getPowerState() == ON_STATE) { + // Sleep was cancelled by idle cancel or revert + if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics)) { + // rdar://problem/50363791 + // If system is in dark wake and sleep is cancelled, do not + // send SystemWillPowerOn/HasPoweredOn messages to kernel + // priority clients. They haven't yet seen a SystemWillSleep + // message before the cancellation. So make sure the kernel + // client bit is cleared in _systemMessageClientMask before + // invoking the tellClients() below. This bit may have been + // set by handleOurPowerChangeStart() anticipating a successful + // sleep and setting the filter mask ahead of time allows the + // SystemWillSleep message to go through. + _systemMessageClientMask &= ~kSystemMessageClientKernel; + } + + systemDidNotSleep(); + tellClients( kIOMessageSystemWillPowerOn ); + } + + tracePoint( kIOPMTracePointWakeApplications ); + tellClients( kIOMessageSystemHasPoweredOn ); + } +} + +#define CAP_WILL_CHANGE_TO_OFF(params, flag) \ + (((params)->changeFlags & kIOPMSystemCapabilityWillChange) && \ + ((params)->fromCapabilities & (flag)) && \ + (((params)->toCapabilities & (flag)) == 0)) + +#define CAP_DID_CHANGE_TO_ON(params, flag) \ + (((params)->changeFlags & kIOPMSystemCapabilityDidChange) && \ + ((params)->toCapabilities & (flag)) && \ + (((params)->fromCapabilities & (flag)) == 0)) + +#define CAP_DID_CHANGE_TO_OFF(params, flag) \ + (((params)->changeFlags & kIOPMSystemCapabilityDidChange) && \ + ((params)->fromCapabilities & (flag)) && \ + (((params)->toCapabilities & (flag)) == 0)) + +#define CAP_WILL_CHANGE_TO_ON(params, flag) \ + (((params)->changeFlags & kIOPMSystemCapabilityWillChange) && \ + ((params)->toCapabilities & (flag)) && \ + (((params)->fromCapabilities & (flag)) == 0)) + +//****************************************************************************** +// sysPowerDownHandler +// +// Perform a vfs sync before system sleep. +//****************************************************************************** + +IOReturn +IOPMrootDomain::sysPowerDownHandler( + void * target, void * refCon, + UInt32 messageType, IOService * service, + void * messageArgs, vm_size_t argSize ) +{ + static UInt32 lastSystemMessageType = 0; + IOReturn ret = 0; + + DLOG("sysPowerDownHandler message %s\n", getIOMessageString(messageType)); + + // rdar://problem/50363791 + // Sanity check to make sure the SystemWill/Has message types are + // received in the expected order for all kernel priority clients. + if (messageType == kIOMessageSystemWillSleep || + messageType == kIOMessageSystemWillPowerOn || + messageType == kIOMessageSystemHasPoweredOn) { + switch (messageType) { + case kIOMessageSystemWillPowerOn: + assert(lastSystemMessageType == kIOMessageSystemWillSleep); + break; + case kIOMessageSystemHasPoweredOn: + assert(lastSystemMessageType == kIOMessageSystemWillPowerOn); + break; + } + + lastSystemMessageType = messageType; + } + + if (!gRootDomain) { + return kIOReturnUnsupported; + } + + if (messageType == kIOMessageSystemCapabilityChange) { + IOPMSystemCapabilityChangeParameters * params = + (IOPMSystemCapabilityChangeParameters *) messageArgs; + + // Interested applications have been notified of an impending power + // change and have acked (when applicable). + // This is our chance to save whatever state we can before powering + // down. + // We call sync_internal defined in xnu/bsd/vfs/vfs_syscalls.c, + // via callout + + DLOG("sysPowerDownHandler cap %x -> %x (flags %x)\n", + params->fromCapabilities, params->toCapabilities, + params->changeFlags); + + if (CAP_WILL_CHANGE_TO_OFF(params, kIOPMSystemCapabilityCPU)) { + // We will ack within 20 seconds + params->maxWaitForReply = 20 * 1000 * 1000; + +#if HIBERNATION + gRootDomain->evaluateSystemSleepPolicyEarly(); + + // add in time we could spend freeing pages + if (gRootDomain->hibernateMode && !gRootDomain->hibernateDisabled) { + params->maxWaitForReply = kCapabilityClientMaxWait; + } + DLOG("sysPowerDownHandler max wait %d s\n", + (int) (params->maxWaitForReply / 1000 / 1000)); +#endif + + // Notify platform that sleep has begun, after the early + // sleep policy evaluation. + getPlatform()->callPlatformFunction( + sleepMessagePEFunction, false, + (void *)(uintptr_t) kIOMessageSystemWillSleep, + NULL, NULL, NULL); + + if (!OSCompareAndSwap( 0, 1, &gSleepOrShutdownPending )) { + // Purposely delay the ack and hope that shutdown occurs quickly. + // Another option is not to schedule the thread and wait for + // ack timeout... + AbsoluteTime deadline; + clock_interval_to_deadline( 30, kSecondScale, &deadline ); + thread_call_enter1_delayed( + gRootDomain->diskSyncCalloutEntry, + (thread_call_param_t)(uintptr_t) params->notifyRef, + deadline ); + } else { + thread_call_enter1( + gRootDomain->diskSyncCalloutEntry, + (thread_call_param_t)(uintptr_t) params->notifyRef); + } + } +#if HIBERNATION + else if (CAP_DID_CHANGE_TO_ON(params, kIOPMSystemCapabilityCPU)) { + // We will ack within 110 seconds + params->maxWaitForReply = 110 * 1000 * 1000; + + thread_call_enter1( + gRootDomain->diskSyncCalloutEntry, + (thread_call_param_t)(uintptr_t) params->notifyRef); + } +#endif + ret = kIOReturnSuccess; + } + + return ret; +} + +//****************************************************************************** +// handleQueueSleepWakeUUID +// +// Called from IOPMrootDomain when we're initiating a sleep, +// or indirectly from PM configd when PM decides to clear the UUID. +// PM clears the UUID several minutes after successful wake from sleep, +// so that we might associate App spindumps with the immediately previous +// sleep/wake. +// +// @param obj has a retain on it. We're responsible for releasing that retain. +//****************************************************************************** + +void +IOPMrootDomain::handleQueueSleepWakeUUID(OSObject *obj) +{ + OSString *str = NULL; + + if (kOSBooleanFalse == obj) { + handlePublishSleepWakeUUID(NULL); + } else if ((str = OSDynamicCast(OSString, obj))) { + // This branch caches the UUID for an upcoming sleep/wake + if (queuedSleepWakeUUIDString) { + queuedSleepWakeUUIDString->release(); + queuedSleepWakeUUIDString = NULL; + } + queuedSleepWakeUUIDString = str; + queuedSleepWakeUUIDString->retain(); + + DLOG("SleepWake UUID queued: %s\n", queuedSleepWakeUUIDString->getCStringNoCopy()); + } + + if (obj) { + obj->release(); + } + return; +} +//****************************************************************************** +// handlePublishSleepWakeUUID +// +// Called from IOPMrootDomain when we're initiating a sleep, +// or indirectly from PM configd when PM decides to clear the UUID. +// PM clears the UUID several minutes after successful wake from sleep, +// so that we might associate App spindumps with the immediately previous +// sleep/wake. +//****************************************************************************** + +void +IOPMrootDomain::handlePublishSleepWakeUUID( bool shouldPublish ) +{ + ASSERT_GATED(); + + /* + * Clear the current UUID + */ + if (gSleepWakeUUIDIsSet) { + DLOG("SleepWake UUID cleared\n"); + + gSleepWakeUUIDIsSet = false; + + removeProperty(kIOPMSleepWakeUUIDKey); + messageClients(kIOPMMessageSleepWakeUUIDChange, kIOPMMessageSleepWakeUUIDCleared); + } + + /* + * Optionally, publish a new UUID + */ + if (queuedSleepWakeUUIDString && shouldPublish) { + OSString *publishThisUUID = NULL; + + publishThisUUID = queuedSleepWakeUUIDString; + publishThisUUID->retain(); + + if (publishThisUUID) { + setProperty(kIOPMSleepWakeUUIDKey, publishThisUUID); + publishThisUUID->release(); + } + + gSleepWakeUUIDIsSet = true; + messageClients(kIOPMMessageSleepWakeUUIDChange, kIOPMMessageSleepWakeUUIDSet); + + queuedSleepWakeUUIDString->release(); + queuedSleepWakeUUIDString = NULL; + } +} + +//****************************************************************************** +// IOPMGetSleepWakeUUIDKey +// +// Return the truth value of gSleepWakeUUIDIsSet and optionally copy the key. +// To get the full key -- a C string -- the buffer must large enough for +// the end-of-string character. +// The key is expected to be an UUID string +//****************************************************************************** + +extern "C" bool +IOPMCopySleepWakeUUIDKey(char *buffer, size_t buf_len) +{ + if (!gSleepWakeUUIDIsSet) { + return false; + } + + if (buffer != NULL) { + OSString *string; + + string = (OSString *) + gRootDomain->copyProperty(kIOPMSleepWakeUUIDKey); + + if (string == NULL) { + *buffer = '\0'; + } else { + strlcpy(buffer, string->getCStringNoCopy(), buf_len); + + string->release(); + } + } + + return true; +} + +//****************************************************************************** +// initializeBootSessionUUID +// +// Initialize the boot session uuid at boot up and sets it into registry. +//****************************************************************************** + +void +IOPMrootDomain::initializeBootSessionUUID(void) +{ + uuid_t new_uuid; + uuid_string_t new_uuid_string; + + uuid_generate(new_uuid); + uuid_unparse_upper(new_uuid, new_uuid_string); + memcpy(bootsessionuuid_string, new_uuid_string, sizeof(uuid_string_t)); + + setProperty(kIOPMBootSessionUUIDKey, new_uuid_string); +} + +//****************************************************************************** +// changePowerStateTo & changePowerStateToPriv +// +// Override of these methods for logging purposes. +//****************************************************************************** + +IOReturn +IOPMrootDomain::changePowerStateTo( unsigned long ordinal ) +{ + DLOG("changePowerStateTo(%u)\n", (uint32_t) ordinal); + + if ((ordinal != ON_STATE) && (ordinal != AOT_STATE) && (ordinal != SLEEP_STATE)) { + return kIOReturnUnsupported; + } + + return super::changePowerStateTo(ordinal); +} + +IOReturn +IOPMrootDomain::changePowerStateToPriv( unsigned long ordinal ) +{ + DLOG("changePowerStateToPriv(%u)\n", (uint32_t) ordinal); + + if ((ordinal != ON_STATE) && (ordinal != AOT_STATE) && (ordinal != SLEEP_STATE)) { + return kIOReturnUnsupported; + } + + return super::changePowerStateToPriv(ordinal); +} + +//****************************************************************************** +// activity detect +// +//****************************************************************************** + +bool +IOPMrootDomain::activitySinceSleep(void) +{ + return userActivityCount != userActivityAtSleep; +} + +bool +IOPMrootDomain::abortHibernation(void) +{ + bool ret = activitySinceSleep(); + + if (ret && !hibernateAborted && checkSystemCanSustainFullWake()) { + DLOG("activitySinceSleep ABORT [%d, %d]\n", userActivityCount, userActivityAtSleep); + hibernateAborted = true; + } + return ret; +} + +extern "C" int +hibernate_should_abort(void) +{ + if (gRootDomain) { + return gRootDomain->abortHibernation(); + } else { + return 0; + } +} + +//****************************************************************************** +// willNotifyPowerChildren +// +// Called after all interested drivers have all acknowledged the power change, +// but before any power children is informed. Dispatched though a thread call, +// so it is safe to perform work that might block on a sleeping disk. PM state +// machine (not thread) will block w/o timeout until this function returns. +//****************************************************************************** + +void +IOPMrootDomain::willNotifyPowerChildren( IOPMPowerStateIndex newPowerState ) +{ + OSDictionary *dict; + OSNumber *secs; + + if (SLEEP_STATE == newPowerState) { + notifierThread = current_thread(); + if (!tasksSuspended) { + AbsoluteTime deadline; + tasksSuspended = TRUE; + updateTasksSuspend(); + + clock_interval_to_deadline(10, kSecondScale, &deadline); +#if !CONFIG_EMBEDDED + vm_pageout_wait(AbsoluteTime_to_scalar(&deadline)); +#endif /* !CONFIG_EMBEDDED */ + } + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + _aotReadyToFullWake = false; +#if 0 + if (_aotLingerTime) { + uint64_t deadline; + IOLog("aot linger no return\n"); + clock_absolutetime_interval_to_deadline(_aotLingerTime, &deadline); + clock_delay_until(deadline); + } +#endif + if (!_aotMode) { + _aotTestTime = 0; + _aotWakeTimeCalendar.selector = kPMCalendarTypeInvalid; + if (_aotMetrics) { + bzero(_aotMetrics, sizeof(IOPMAOTMetrics)); + } + } else if (!_aotNow && !_debugWakeSeconds) { + _aotNow = true; + _aotExit = false; + _aotPendingFlags = 0; + _aotTasksSuspended = true; + _aotLastWakeTime = 0; + bzero(_aotMetrics, sizeof(IOPMAOTMetrics)); + if (kIOPMAOTModeCycle & _aotMode) { + clock_interval_to_absolutetime_interval(60, kSecondScale, &_aotTestInterval); + _aotTestTime = mach_continuous_time() + _aotTestInterval; + setWakeTime(_aotTestTime); + } + uint32_t lingerSecs; + if (!PE_parse_boot_argn("aotlinger", &lingerSecs, sizeof(lingerSecs))) { + lingerSecs = 0; + } + clock_interval_to_absolutetime_interval(lingerSecs, kSecondScale, &_aotLingerTime); + clock_interval_to_absolutetime_interval(2000, kMillisecondScale, &_aotWakePreWindow); + clock_interval_to_absolutetime_interval(1100, kMillisecondScale, &_aotWakePostWindow); + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + +#if HIBERNATION + IOHibernateSystemSleep(); + IOHibernateIOKitSleep(); +#endif + if (gRootDomain->activitySinceSleep()) { + dict = OSDictionary::withCapacity(1); + secs = OSNumber::withNumber(1, 32); + + if (dict && secs) { + dict->setObject(gIOPMSettingDebugWakeRelativeKey, secs); + gRootDomain->setProperties(dict); + MSG("Reverting sleep with relative wake\n"); + } + if (dict) { + dict->release(); + } + if (secs) { + secs->release(); + } + } + + notifierThread = NULL; + } +} + +//****************************************************************************** +// sleepOnClamshellClosed +// +// contains the logic to determine if the system should sleep when the clamshell +// is closed. +//****************************************************************************** + +bool +IOPMrootDomain::shouldSleepOnClamshellClosed( void ) +{ + if (!clamshellExists) { + return false; + } + + DLOG("clamshell closed %d, disabled %d, desktopMode %d, ac %d sleepDisabled %d\n", + clamshellClosed, clamshellDisabled, desktopMode, acAdaptorConnected, clamshellSleepDisabled); + + return !clamshellDisabled && !(desktopMode && acAdaptorConnected) && !clamshellSleepDisabled; +} + +bool +IOPMrootDomain::shouldSleepOnRTCAlarmWake( void ) +{ + // Called once every RTC/Alarm wake. Device should go to sleep if on clamshell + // closed && battery + if (!clamshellExists) { + return false; + } + + DLOG("shouldSleepOnRTCAlarmWake: clamshell closed %d, disabled %d, desktopMode %d, ac %d sleepDisabled %d\n", + clamshellClosed, clamshellDisabled, desktopMode, acAdaptorConnected, clamshellSleepDisabled); + + return !acAdaptorConnected && !clamshellSleepDisabled; +} + +void +IOPMrootDomain::sendClientClamshellNotification( void ) +{ + /* Only broadcast clamshell alert if clamshell exists. */ + if (!clamshellExists) { + return; + } + + setProperty(kAppleClamshellStateKey, + clamshellClosed ? kOSBooleanTrue : kOSBooleanFalse); + + setProperty(kAppleClamshellCausesSleepKey, + shouldSleepOnClamshellClosed() ? kOSBooleanTrue : kOSBooleanFalse); + + /* Argument to message is a bitfiel of + * ( kClamshellStateBit | kClamshellSleepBit ) + */ + messageClients(kIOPMMessageClamshellStateChange, + (void *)(uintptr_t) ((clamshellClosed ? kClamshellStateBit : 0) + | (shouldSleepOnClamshellClosed() ? kClamshellSleepBit : 0))); +} + +//****************************************************************************** +// getSleepSupported +// +// Deprecated +//****************************************************************************** + +IOOptionBits +IOPMrootDomain::getSleepSupported( void ) +{ + return platformSleepSupport; +} + +//****************************************************************************** +// setSleepSupported +// +// Deprecated +//****************************************************************************** + +void +IOPMrootDomain::setSleepSupported( IOOptionBits flags ) +{ + DLOG("setSleepSupported(%x)\n", (uint32_t) flags); + OSBitOrAtomic(flags, &platformSleepSupport); +} + +//****************************************************************************** +// setDisableClamShellSleep +// +//****************************************************************************** + +void +IOPMrootDomain::setDisableClamShellSleep( bool val ) +{ + if (gIOPMWorkLoop->inGate() == false) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::setDisableClamShellSleep), + (OSObject *)this, + (void *)val); + + return; + } else { + DLOG("setDisableClamShellSleep(%x)\n", (uint32_t) val); + if (clamshellSleepDisabled != val) { + clamshellSleepDisabled = val; + // If clamshellSleepDisabled is reset to 0, reevaluate if + // system need to go to sleep due to clamshell state + if (!clamshellSleepDisabled && clamshellClosed) { + handlePowerNotification(kLocalEvalClamshellCommand); + } + } + } +} + +//****************************************************************************** +// wakeFromDoze +// +// Deprecated. +//****************************************************************************** + +void +IOPMrootDomain::wakeFromDoze( void ) +{ + // Preserve symbol for familes (IOUSBFamily and IOGraphics) +} + +// MARK: - +// MARK: Features + +//****************************************************************************** +// publishFeature +// +// Adds a new feature to the supported features dictionary +//****************************************************************************** + +void +IOPMrootDomain::publishFeature( const char * feature ) +{ + publishFeature(feature, kRD_AllPowerSources, NULL); +} + +//****************************************************************************** +// publishFeature (with supported power source specified) +// +// Adds a new feature to the supported features dictionary +//****************************************************************************** + +void +IOPMrootDomain::publishFeature( + const char *feature, + uint32_t supportedWhere, + uint32_t *uniqueFeatureID) +{ + static uint16_t next_feature_id = 500; + + OSNumber *new_feature_data = NULL; + OSNumber *existing_feature = NULL; + OSArray *existing_feature_arr = NULL; + OSObject *osObj = NULL; + uint32_t feature_value = 0; + + supportedWhere &= kRD_AllPowerSources; // mask off any craziness! + + if (!supportedWhere) { + // Feature isn't supported anywhere! + return; + } + + if (next_feature_id > 5000) { + // Far, far too many features! + return; + } + + if (featuresDictLock) { + IOLockLock(featuresDictLock); + } + + OSDictionary *features = + (OSDictionary *) getProperty(kRootDomainSupportedFeatures); + + // Create new features dict if necessary + if (features && OSDynamicCast(OSDictionary, features)) { + features = OSDictionary::withDictionary(features); + } else { + features = OSDictionary::withCapacity(1); + } + + // Create OSNumber to track new feature + + next_feature_id += 1; + if (uniqueFeatureID) { + // We don't really mind if the calling kext didn't give us a place + // to stash their unique id. Many kexts don't plan to unload, and thus + // have no need to remove themselves later. + *uniqueFeatureID = next_feature_id; + } + + feature_value = (uint32_t)next_feature_id; + feature_value <<= 16; + feature_value += supportedWhere; + + new_feature_data = OSNumber::withNumber( + (unsigned long long)feature_value, 32); + + // Does features object already exist? + if ((osObj = features->getObject(feature))) { + if ((existing_feature = OSDynamicCast(OSNumber, osObj))) { + // We need to create an OSArray to hold the now 2 elements. + existing_feature_arr = OSArray::withObjects( + (const OSObject **)&existing_feature, 1, 2); + } else if ((existing_feature_arr = OSDynamicCast(OSArray, osObj))) { + // Add object to existing array + existing_feature_arr = OSArray::withArray( + existing_feature_arr, + existing_feature_arr->getCount() + 1); + } + + if (existing_feature_arr) { + existing_feature_arr->setObject(new_feature_data); + features->setObject(feature, existing_feature_arr); + existing_feature_arr->release(); + existing_feature_arr = NULL; + } + } else { + // The easy case: no previously existing features listed. We simply + // set the OSNumber at key 'feature' and we're on our way. + features->setObject(feature, new_feature_data); + } + + new_feature_data->release(); + + setProperty(kRootDomainSupportedFeatures, features); + + features->release(); + + if (featuresDictLock) { + IOLockUnlock(featuresDictLock); + } + + // Notify EnergySaver and all those in user space so they might + // re-populate their feature specific UI + if (pmPowerStateQueue) { + pmPowerStateQueue->submitPowerEvent( kPowerEventFeatureChanged ); + } +} + +//****************************************************************************** +// removePublishedFeature +// +// Removes previously published feature +//****************************************************************************** + +IOReturn +IOPMrootDomain::removePublishedFeature( uint32_t removeFeatureID ) +{ + IOReturn ret = kIOReturnError; + uint32_t feature_value = 0; + uint16_t feature_id = 0; + bool madeAChange = false; + + OSSymbol *dictKey = NULL; + OSCollectionIterator *dictIterator = NULL; + OSArray *arrayMember = NULL; + OSNumber *numberMember = NULL; + OSObject *osObj = NULL; + OSNumber *osNum = NULL; + OSArray *arrayMemberCopy; + + if (kBadPMFeatureID == removeFeatureID) { + return kIOReturnNotFound; + } + + if (featuresDictLock) { + IOLockLock(featuresDictLock); + } + + OSDictionary *features = + (OSDictionary *) getProperty(kRootDomainSupportedFeatures); + + if (features && OSDynamicCast(OSDictionary, features)) { + // Any modifications to the dictionary are made to the copy to prevent + // races & crashes with userland clients. Dictionary updated + // automically later. + features = OSDictionary::withDictionary(features); + } else { + features = NULL; + ret = kIOReturnNotFound; + goto exit; + } + + // We iterate 'features' dictionary looking for an entry tagged + // with 'removeFeatureID'. If found, we remove it from our tracking + // structures and notify the OS via a general interest message. + + dictIterator = OSCollectionIterator::withCollection(features); + if (!dictIterator) { + goto exit; + } + + while ((dictKey = OSDynamicCast(OSSymbol, dictIterator->getNextObject()))) { + osObj = features->getObject(dictKey); + + // Each Feature is either tracked by an OSNumber + if (osObj && (numberMember = OSDynamicCast(OSNumber, osObj))) { + feature_value = numberMember->unsigned32BitValue(); + feature_id = (uint16_t)(feature_value >> 16); + + if (feature_id == (uint16_t)removeFeatureID) { + // Remove this node + features->removeObject(dictKey); + madeAChange = true; + break; + } + + // Or tracked by an OSArray of OSNumbers + } else if (osObj && (arrayMember = OSDynamicCast(OSArray, osObj))) { + unsigned int arrayCount = arrayMember->getCount(); + + for (unsigned int i = 0; i < arrayCount; i++) { + osNum = OSDynamicCast(OSNumber, arrayMember->getObject(i)); + if (!osNum) { + continue; + } + + feature_value = osNum->unsigned32BitValue(); + feature_id = (uint16_t)(feature_value >> 16); + + if (feature_id == (uint16_t)removeFeatureID) { + // Remove this node + if (1 == arrayCount) { + // If the array only contains one element, remove + // the whole thing. + features->removeObject(dictKey); + } else { + // Otherwise remove the element from a copy of the array. + arrayMemberCopy = OSArray::withArray(arrayMember); + if (arrayMemberCopy) { + arrayMemberCopy->removeObject(i); + features->setObject(dictKey, arrayMemberCopy); + arrayMemberCopy->release(); + } + } + + madeAChange = true; + break; + } + } + } + } + + dictIterator->release(); + + if (madeAChange) { + ret = kIOReturnSuccess; + + setProperty(kRootDomainSupportedFeatures, features); + + // Notify EnergySaver and all those in user space so they might + // re-populate their feature specific UI + if (pmPowerStateQueue) { + pmPowerStateQueue->submitPowerEvent( kPowerEventFeatureChanged ); + } + } else { + ret = kIOReturnNotFound; + } + +exit: + if (features) { + features->release(); + } + if (featuresDictLock) { + IOLockUnlock(featuresDictLock); + } + return ret; +} + +//****************************************************************************** +// publishPMSetting (private) +// +// Should only be called by PMSettingObject to publish a PM Setting as a +// supported feature. +//****************************************************************************** + +void +IOPMrootDomain::publishPMSetting( + const OSSymbol * feature, uint32_t where, uint32_t * featureID ) +{ + if (noPublishPMSettings && + (noPublishPMSettings->getNextIndexOfObject(feature, 0) != (unsigned int)-1)) { + // Setting found in noPublishPMSettings array + *featureID = kBadPMFeatureID; + return; + } + + publishFeature( + feature->getCStringNoCopy(), where, featureID); +} + +//****************************************************************************** +// setPMSetting (private) +// +// Internal helper to relay PM settings changes from user space to individual +// drivers. Should be called only by IOPMrootDomain::setProperties. +//****************************************************************************** + +IOReturn +IOPMrootDomain::setPMSetting( + const OSSymbol *type, + OSObject *object ) +{ + PMSettingCallEntry *entries = NULL; + OSArray *chosen = NULL; + const OSArray *array; + PMSettingObject *pmso; + thread_t thisThread; + int i, j, count, capacity; + + if (NULL == type) { + return kIOReturnBadArgument; + } + + PMSETTING_LOCK(); + + // Update settings dict so changes are visible from copyPMSetting(). + fPMSettingsDict->setObject(type, object); + + // Prep all PMSetting objects with the given 'type' for callout. + array = OSDynamicCast(OSArray, settingsCallbacks->getObject(type)); + if (!array || ((capacity = array->getCount()) == 0)) { + goto unlock_exit; + } + + // Array to retain PMSetting objects targeted for callout. + chosen = OSArray::withCapacity(capacity); + if (!chosen) { + goto unlock_exit; // error + } + entries = IONew(PMSettingCallEntry, capacity); + if (!entries) { + goto unlock_exit; // error + } + memset(entries, 0, sizeof(PMSettingCallEntry) * capacity); + + thisThread = current_thread(); + + for (i = 0, j = 0; i < capacity; i++) { + pmso = (PMSettingObject *) array->getObject(i); + if (pmso->disabled) { + continue; + } + entries[j].thread = thisThread; + queue_enter(&pmso->calloutQueue, &entries[j], PMSettingCallEntry *, link); + chosen->setObject(pmso); + j++; + } + count = j; + if (!count) { + goto unlock_exit; + } + + PMSETTING_UNLOCK(); + + // Call each pmso in the chosen array. + for (i = 0; i < count; i++) { + pmso = (PMSettingObject *) chosen->getObject(i); + pmso->dispatchPMSetting(type, object); + } + + PMSETTING_LOCK(); + for (i = 0; i < count; i++) { + pmso = (PMSettingObject *) chosen->getObject(i); + queue_remove(&pmso->calloutQueue, &entries[i], PMSettingCallEntry *, link); + if (pmso->waitThread) { + PMSETTING_WAKEUP(pmso); + } + } +unlock_exit: + PMSETTING_UNLOCK(); + + if (chosen) { + chosen->release(); + } + if (entries) { + IODelete(entries, PMSettingCallEntry, capacity); + } + + return kIOReturnSuccess; +} + +//****************************************************************************** +// copyPMSetting (public) +// +// Allows kexts to safely read setting values, without being subscribed to +// notifications. +//****************************************************************************** + +OSObject * +IOPMrootDomain::copyPMSetting( + OSSymbol *whichSetting) +{ + OSObject *obj = NULL; + + if (!whichSetting) { + return NULL; + } + + PMSETTING_LOCK(); + obj = fPMSettingsDict->getObject(whichSetting); + if (obj) { + obj->retain(); + } + PMSETTING_UNLOCK(); + + return obj; +} + +//****************************************************************************** +// registerPMSettingController (public) +// +// direct wrapper to registerPMSettingController with uint32_t power source arg +//****************************************************************************** + +IOReturn +IOPMrootDomain::registerPMSettingController( + const OSSymbol * settings[], + IOPMSettingControllerCallback func, + OSObject *target, + uintptr_t refcon, + OSObject **handle) +{ + return registerPMSettingController( + settings, + (kIOPMSupportedOnAC | kIOPMSupportedOnBatt | kIOPMSupportedOnUPS), + func, target, refcon, handle); +} + +//****************************************************************************** +// registerPMSettingController (public) +// +// Kexts may register for notifications when a particular setting is changed. +// A list of settings is available in IOPM.h. +// Arguments: +// * settings - An OSArray containing OSSymbols. Caller should populate this +// array with a list of settings caller wants notifications from. +// * func - A C function callback of the type IOPMSettingControllerCallback +// * target - caller may provide an OSObject *, which PM will pass as an +// target to calls to "func" +// * refcon - caller may provide an void *, which PM will pass as an +// argument to calls to "func" +// * handle - This is a return argument. We will populate this pointer upon +// call success. Hold onto this and pass this argument to +// IOPMrootDomain::deRegisterPMSettingCallback when unloading your kext +// Returns: +// kIOReturnSuccess on success +//****************************************************************************** + +IOReturn +IOPMrootDomain::registerPMSettingController( + const OSSymbol * settings[], + uint32_t supportedPowerSources, + IOPMSettingControllerCallback func, + OSObject *target, + uintptr_t refcon, + OSObject **handle) +{ + PMSettingObject *pmso = NULL; + OSObject *pmsh = NULL; + OSArray *list = NULL; + int i; + + if (NULL == settings || + NULL == func || + NULL == handle) { + return kIOReturnBadArgument; + } + + pmso = PMSettingObject::pmSettingObject( + (IOPMrootDomain *) this, func, target, + refcon, supportedPowerSources, settings, &pmsh); + + if (!pmso) { + *handle = NULL; + return kIOReturnInternalError; + } + + PMSETTING_LOCK(); + for (i = 0; settings[i]; i++) { + list = OSDynamicCast(OSArray, settingsCallbacks->getObject(settings[i])); + if (!list) { + // New array of callbacks for this setting + list = OSArray::withCapacity(1); + settingsCallbacks->setObject(settings[i], list); + list->release(); + } + + // Add caller to the callback list + list->setObject(pmso); + } + PMSETTING_UNLOCK(); + + // Return handle to the caller, the setting object is private. + *handle = pmsh; + + return kIOReturnSuccess; +} + +//****************************************************************************** +// deregisterPMSettingObject (private) +// +// Only called from PMSettingObject. +//****************************************************************************** + +void +IOPMrootDomain::deregisterPMSettingObject( PMSettingObject * pmso ) +{ + thread_t thisThread = current_thread(); + PMSettingCallEntry *callEntry; + OSCollectionIterator *iter; + OSSymbol *sym; + OSArray *array; + int index; + bool wait; + + PMSETTING_LOCK(); + + pmso->disabled = true; + + // Wait for all callout threads to finish. + do { + wait = false; + queue_iterate(&pmso->calloutQueue, callEntry, PMSettingCallEntry *, link) + { + if (callEntry->thread != thisThread) { + wait = true; + break; + } + } + if (wait) { + assert(NULL == pmso->waitThread); + pmso->waitThread = thisThread; + PMSETTING_WAIT(pmso); + pmso->waitThread = NULL; + } + } while (wait); + + // Search each PM settings array in the kernel. + iter = OSCollectionIterator::withCollection(settingsCallbacks); + if (iter) { + while ((sym = OSDynamicCast(OSSymbol, iter->getNextObject()))) { + array = OSDynamicCast(OSArray, settingsCallbacks->getObject(sym)); + index = array->getNextIndexOfObject(pmso, 0); + if (-1 != index) { + array->removeObject(index); + } + } + iter->release(); + } + + PMSETTING_UNLOCK(); + + pmso->release(); +} + +//****************************************************************************** +// informCPUStateChange +// +// Call into PM CPU code so that CPU power savings may dynamically adjust for +// running on battery, with the lid closed, etc. +// +// informCPUStateChange is a no-op on non x86 systems +// only x86 has explicit support in the IntelCPUPowerManagement kext +//****************************************************************************** + +void +IOPMrootDomain::informCPUStateChange( + uint32_t type, + uint32_t value ) +{ +#if defined(__i386__) || defined(__x86_64__) + + pmioctlVariableInfo_t varInfoStruct; + int pmCPUret = 0; + const char *varNameStr = NULL; + int32_t *varIndex = NULL; + + if (kInformAC == type) { + varNameStr = kIOPMRootDomainBatPowerCString; + varIndex = &idxPMCPULimitedPower; + } else if (kInformLid == type) { + varNameStr = kIOPMRootDomainLidCloseCString; + varIndex = &idxPMCPUClamshell; + } else { + return; + } + + // Set the new value! + // pmCPUControl will assign us a new ID if one doesn't exist yet + bzero(&varInfoStruct, sizeof(pmioctlVariableInfo_t)); + varInfoStruct.varID = *varIndex; + varInfoStruct.varType = vBool; + varInfoStruct.varInitValue = value; + varInfoStruct.varCurValue = value; + strlcpy((char *)varInfoStruct.varName, + (const char *)varNameStr, + sizeof(varInfoStruct.varName)); + + // Set! + pmCPUret = pmCPUControl( PMIOCSETVARINFO, (void *)&varInfoStruct ); + + // pmCPU only assigns numerical id's when a new varName is specified + if ((0 == pmCPUret) + && (*varIndex == kCPUUnknownIndex)) { + // pmCPUControl has assigned us a new variable ID. + // Let's re-read the structure we just SET to learn that ID. + pmCPUret = pmCPUControl( PMIOCGETVARNAMEINFO, (void *)&varInfoStruct ); + + if (0 == pmCPUret) { + // Store it in idxPMCPUClamshell or idxPMCPULimitedPower + *varIndex = varInfoStruct.varID; + } + } + + return; + +#endif /* __i386__ || __x86_64__ */ +} + +// MARK: - +// MARK: Deep Sleep Policy + +#if HIBERNATION + +//****************************************************************************** +// evaluateSystemSleepPolicy +//****************************************************************************** + +#define kIOPlatformSystemSleepPolicyKey "IOPlatformSystemSleepPolicy" + +// Sleep flags +enum { + kIOPMSleepFlagHibernate = 0x00000001, + kIOPMSleepFlagSleepTimerEnable = 0x00000002 +}; + +struct IOPMSystemSleepPolicyEntry { + uint32_t factorMask; + uint32_t factorBits; + uint32_t sleepFlags; + uint32_t wakeEvents; +} __attribute__((packed)); + +struct IOPMSystemSleepPolicyTable { + uint32_t signature; + uint16_t version; + uint16_t entryCount; + IOPMSystemSleepPolicyEntry entries[]; +} __attribute__((packed)); + +enum { + kIOPMSleepAttributeHibernateSetup = 0x00000001, + kIOPMSleepAttributeHibernateSleep = 0x00000002 +}; + +static uint32_t +getSleepTypeAttributes( uint32_t sleepType ) +{ + static const uint32_t sleepTypeAttributes[kIOPMSleepTypeLast] = + { + /* invalid */ 0, + /* abort */ 0, + /* normal */ 0, + /* safesleep */ kIOPMSleepAttributeHibernateSetup, + /* hibernate */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, + /* standby */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, + /* poweroff */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, + /* deepidle */ 0 + }; + + if (sleepType >= kIOPMSleepTypeLast) { + return 0; + } + + return sleepTypeAttributes[sleepType]; +} + +bool +IOPMrootDomain::evaluateSystemSleepPolicy( + IOPMSystemSleepParameters * params, int sleepPhase, uint32_t * hibMode ) +{ + const IOPMSystemSleepPolicyTable * pt; + OSObject * prop = NULL; + OSData * policyData; + uint64_t currentFactors = 0; + char currentFactorsBuf[512]; + uint32_t standbyDelay = 0; + uint32_t powerOffDelay = 0; + uint32_t powerOffTimer = 0; + uint32_t standbyTimer = 0; + uint32_t mismatch; + bool standbyEnabled; + bool powerOffEnabled; + bool found = false; + + // Get platform's sleep policy table + if (!gSleepPolicyHandler) { + prop = getServiceRoot()->copyProperty(kIOPlatformSystemSleepPolicyKey); + if (!prop) { + goto done; + } + } + + // Fetch additional settings + standbyEnabled = (getSleepOption(kIOPMDeepSleepDelayKey, &standbyDelay) + && (getProperty(kIOPMDeepSleepEnabledKey) == kOSBooleanTrue)); + powerOffEnabled = (getSleepOption(kIOPMAutoPowerOffDelayKey, &powerOffDelay) + && (getProperty(kIOPMAutoPowerOffEnabledKey) == kOSBooleanTrue)); + if (!getSleepOption(kIOPMAutoPowerOffTimerKey, &powerOffTimer)) { + powerOffTimer = powerOffDelay; + } + if (!getSleepOption(kIOPMDeepSleepTimerKey, &standbyTimer)) { + standbyTimer = standbyDelay; + } + + DLOG("phase %d, standby %d delay %u timer %u, poweroff %d delay %u timer %u, hibernate 0x%x\n", + sleepPhase, standbyEnabled, standbyDelay, standbyTimer, + powerOffEnabled, powerOffDelay, powerOffTimer, *hibMode); + + currentFactorsBuf[0] = 0; + // pmset level overrides + if ((*hibMode & kIOHibernateModeOn) == 0) { + if (!gSleepPolicyHandler) { + standbyEnabled = false; + powerOffEnabled = false; + } + } else if (!(*hibMode & kIOHibernateModeSleep)) { + // Force hibernate (i.e. mode 25) + // If standby is enabled, force standy. + // If poweroff is enabled, force poweroff. + if (standbyEnabled) { + currentFactors |= kIOPMSleepFactorStandbyForced; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyForced"); + } else if (powerOffEnabled) { + currentFactors |= kIOPMSleepFactorAutoPowerOffForced; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "AutoPowerOffForced"); + } else { + currentFactors |= kIOPMSleepFactorHibernateForced; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "HibernateForced"); + } + } + + // Current factors based on environment and assertions + if (sleepTimerMaintenance) { + currentFactors |= kIOPMSleepFactorSleepTimerWake; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "SleepTimerWake"); + } + if (standbyEnabled && sleepToStandby && !gSleepPolicyHandler) { + currentFactors |= kIOPMSleepFactorSleepTimerWake; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "SleepTimerWake"); + } + if (!clamshellClosed) { + currentFactors |= kIOPMSleepFactorLidOpen; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LidOpen"); + } + if (acAdaptorConnected) { + currentFactors |= kIOPMSleepFactorACPower; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ACPower"); + } + if (lowBatteryCondition) { + currentFactors |= kIOPMSleepFactorBatteryLow; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "BatteryLow"); + } + if (!standbyDelay || !standbyTimer) { + currentFactors |= kIOPMSleepFactorStandbyNoDelay; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyNoDelay"); + } + if (standbyNixed || !standbyEnabled) { + currentFactors |= kIOPMSleepFactorStandbyDisabled; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyDisabled"); + } + if (resetTimers) { + currentFactors |= kIOPMSleepFactorLocalUserActivity; + currentFactors &= ~kIOPMSleepFactorSleepTimerWake; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LocalUserActivity, !SleepTimerWake"); + } + if (getPMAssertionLevel(kIOPMDriverAssertionUSBExternalDeviceBit) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorUSBExternalDevice; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "USBExternalDevice"); + } + if (getPMAssertionLevel(kIOPMDriverAssertionBluetoothHIDDevicePairedBit) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorBluetoothHIDDevice; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "BluetoothHIDDevice"); + } + if (getPMAssertionLevel(kIOPMDriverAssertionExternalMediaMountedBit) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorExternalMediaMounted; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ExternalMediaMounted"); + } + if (getPMAssertionLevel(kIOPMDriverAssertionReservedBit5) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorThunderboltDevice; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ThunderboltDevice"); + } + if (_scheduledAlarms != 0) { + currentFactors |= kIOPMSleepFactorRTCAlarmScheduled; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "RTCAlaramScheduled"); + } + if (getPMAssertionLevel(kIOPMDriverAssertionMagicPacketWakeEnabledBit) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorMagicPacketWakeEnabled; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "MagicPacketWakeEnabled"); + } +#define TCPKEEPALIVE 1 +#if TCPKEEPALIVE + if (getPMAssertionLevel(kIOPMDriverAssertionNetworkKeepAliveActiveBit) != + kIOPMDriverAssertionLevelOff) { + currentFactors |= kIOPMSleepFactorNetworkKeepAliveActive; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "NetworkKeepAliveActive"); + } +#endif + if (!powerOffEnabled) { + currentFactors |= kIOPMSleepFactorAutoPowerOffDisabled; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "AutoPowerOffDisabled"); + } + if (desktopMode) { + currentFactors |= kIOPMSleepFactorExternalDisplay; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ExternalDisplay"); + } + if (userWasActive) { + currentFactors |= kIOPMSleepFactorLocalUserActivity; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LocalUserActivity"); + } + if (darkWakeHibernateError && !CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) { + currentFactors |= kIOPMSleepFactorHibernateFailed; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "HibernateFailed"); + } + if (thermalWarningState) { + currentFactors |= kIOPMSleepFactorThermalWarning; + snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ThermalWarning"); + } + + DLOG("sleep factors 0x%llx %s\n", currentFactors, currentFactorsBuf); + + if (gSleepPolicyHandler) { + uint32_t savedHibernateMode; + IOReturn result; + + if (!gSleepPolicyVars) { + gSleepPolicyVars = IONew(IOPMSystemSleepPolicyVariables, 1); + if (!gSleepPolicyVars) { + goto done; + } + bzero(gSleepPolicyVars, sizeof(*gSleepPolicyVars)); + } + gSleepPolicyVars->signature = kIOPMSystemSleepPolicySignature; + gSleepPolicyVars->version = kIOPMSystemSleepPolicyVersion; + gSleepPolicyVars->currentCapability = _currentCapability; + gSleepPolicyVars->highestCapability = _highestCapability; + gSleepPolicyVars->sleepFactors = currentFactors; + gSleepPolicyVars->sleepReason = lastSleepReason; + gSleepPolicyVars->sleepPhase = sleepPhase; + gSleepPolicyVars->standbyDelay = standbyDelay; + gSleepPolicyVars->standbyTimer = standbyTimer; + gSleepPolicyVars->poweroffDelay = powerOffDelay; + gSleepPolicyVars->scheduledAlarms = _scheduledAlarms | _userScheduledAlarm; + gSleepPolicyVars->poweroffTimer = powerOffTimer; + + if (kIOPMSleepPhase0 == sleepPhase) { + // preserve hibernateMode + savedHibernateMode = gSleepPolicyVars->hibernateMode; + gSleepPolicyVars->hibernateMode = *hibMode; + } else if (kIOPMSleepPhase1 == sleepPhase) { + // use original hibernateMode for phase2 + gSleepPolicyVars->hibernateMode = *hibMode; + } + + result = gSleepPolicyHandler(gSleepPolicyTarget, gSleepPolicyVars, params); + + if (kIOPMSleepPhase0 == sleepPhase) { + // restore hibernateMode + gSleepPolicyVars->hibernateMode = savedHibernateMode; + } + + if ((result != kIOReturnSuccess) || + (kIOPMSleepTypeInvalid == params->sleepType) || + (params->sleepType >= kIOPMSleepTypeLast) || + (kIOPMSystemSleepParametersVersion != params->version)) { + MSG("sleep policy handler error\n"); + goto done; + } + + if ((getSleepTypeAttributes(params->sleepType) & + kIOPMSleepAttributeHibernateSetup) && + ((*hibMode & kIOHibernateModeOn) == 0)) { + *hibMode |= (kIOHibernateModeOn | kIOHibernateModeSleep); + } + + DLOG("sleep params v%u, type %u, flags 0x%x, wake 0x%x, timer %u, poweroff %u\n", + params->version, params->sleepType, params->sleepFlags, + params->ecWakeEvents, params->ecWakeTimer, params->ecPoweroffTimer); + found = true; + goto done; + } + + // Policy table is meaningless without standby enabled + if (!standbyEnabled) { + goto done; + } + + // Validate the sleep policy table + policyData = OSDynamicCast(OSData, prop); + if (!policyData || (policyData->getLength() <= sizeof(IOPMSystemSleepPolicyTable))) { + goto done; + } + + pt = (const IOPMSystemSleepPolicyTable *) policyData->getBytesNoCopy(); + if ((pt->signature != kIOPMSystemSleepPolicySignature) || + (pt->version != 1) || (0 == pt->entryCount)) { + goto done; + } + + if (((policyData->getLength() - sizeof(IOPMSystemSleepPolicyTable)) != + (sizeof(IOPMSystemSleepPolicyEntry) * pt->entryCount))) { + goto done; + } + + for (uint32_t i = 0; i < pt->entryCount; i++) { + const IOPMSystemSleepPolicyEntry * entry = &pt->entries[i]; + mismatch = (((uint32_t)currentFactors ^ entry->factorBits) & entry->factorMask); + + DLOG("mask 0x%08x, bits 0x%08x, flags 0x%08x, wake 0x%08x, mismatch 0x%08x\n", + entry->factorMask, entry->factorBits, + entry->sleepFlags, entry->wakeEvents, mismatch); + if (mismatch) { + continue; + } + + DLOG("^ found match\n"); + found = true; + + params->version = kIOPMSystemSleepParametersVersion; + params->reserved1 = 1; + if (entry->sleepFlags & kIOPMSleepFlagHibernate) { + params->sleepType = kIOPMSleepTypeStandby; + } else { + params->sleepType = kIOPMSleepTypeNormalSleep; + } + + params->ecWakeEvents = entry->wakeEvents; + if (entry->sleepFlags & kIOPMSleepFlagSleepTimerEnable) { + if (kIOPMSleepPhase2 == sleepPhase) { + clock_sec_t now_secs = gIOLastSleepTime.tv_sec; + + if (!_standbyTimerResetSeconds || + (now_secs <= _standbyTimerResetSeconds)) { + // Reset standby timer adjustment + _standbyTimerResetSeconds = now_secs; + DLOG("standby delay %u, reset %u\n", + standbyDelay, (uint32_t) _standbyTimerResetSeconds); + } else if (standbyDelay) { + // Shorten the standby delay timer + clock_sec_t elapsed = now_secs - _standbyTimerResetSeconds; + if (standbyDelay > elapsed) { + standbyDelay -= elapsed; + } else { + standbyDelay = 1; // must be > 0 + } + DLOG("standby delay %u, elapsed %u\n", + standbyDelay, (uint32_t) elapsed); + } + } + params->ecWakeTimer = standbyDelay; + } else if (kIOPMSleepPhase2 == sleepPhase) { + // A sleep that does not enable the sleep timer will reset + // the standby delay adjustment. + _standbyTimerResetSeconds = 0; + } + break; + } + +done: + if (prop) { + prop->release(); + } + + return found; +} + +static IOPMSystemSleepParameters gEarlySystemSleepParams; + +void +IOPMrootDomain::evaluateSystemSleepPolicyEarly( void ) +{ + // Evaluate early (priority interest phase), before drivers sleep. + + DLOG("%s\n", __FUNCTION__); + removeProperty(kIOPMSystemSleepParametersKey); + + // Full wake resets the standby timer delay adjustment + if (_highestCapability & kIOPMSystemCapabilityGraphics) { + _standbyTimerResetSeconds = 0; + } + + hibernateDisabled = false; + hibernateMode = 0; + getSleepOption(kIOHibernateModeKey, &hibernateMode); + + // Save for late evaluation if sleep is aborted + bzero(&gEarlySystemSleepParams, sizeof(gEarlySystemSleepParams)); + + if (evaluateSystemSleepPolicy(&gEarlySystemSleepParams, kIOPMSleepPhase1, + &hibernateMode)) { + if (!hibernateRetry && + ((getSleepTypeAttributes(gEarlySystemSleepParams.sleepType) & + kIOPMSleepAttributeHibernateSetup) == 0)) { + // skip hibernate setup + hibernateDisabled = true; + } + } + + // Publish IOPMSystemSleepType + uint32_t sleepType = gEarlySystemSleepParams.sleepType; + if (sleepType == kIOPMSleepTypeInvalid) { + // no sleep policy + sleepType = kIOPMSleepTypeNormalSleep; + if (hibernateMode & kIOHibernateModeOn) { + sleepType = (hibernateMode & kIOHibernateModeSleep) ? + kIOPMSleepTypeSafeSleep : kIOPMSleepTypeHibernate; + } + } else if ((sleepType == kIOPMSleepTypeStandby) && + (gEarlySystemSleepParams.ecPoweroffTimer)) { + // report the lowest possible sleep state + sleepType = kIOPMSleepTypePowerOff; + } + + setProperty(kIOPMSystemSleepTypeKey, sleepType, 32); +} + +void +IOPMrootDomain::evaluateSystemSleepPolicyFinal( void ) +{ + IOPMSystemSleepParameters params; + OSData * paramsData; + bool wakeNow; + // Evaluate sleep policy after sleeping drivers but before platform sleep. + + DLOG("%s\n", __FUNCTION__); + + bzero(¶ms, sizeof(params)); + wakeNow = false; + if (evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase2, &hibernateMode)) { + if ((kIOPMSleepTypeStandby == params.sleepType) + && gIOHibernateStandbyDisabled && gSleepPolicyVars + && (!((kIOPMSleepFactorStandbyForced | kIOPMSleepFactorAutoPowerOffForced | kIOPMSleepFactorHibernateForced) + & gSleepPolicyVars->sleepFactors))) { + standbyNixed = true; + wakeNow = true; + } + if (wakeNow + || ((hibernateDisabled || hibernateAborted) && + (getSleepTypeAttributes(params.sleepType) & + kIOPMSleepAttributeHibernateSetup))) { + // Final evaluation picked a state requiring hibernation, + // but hibernate isn't going to proceed. Arm a short sleep using + // the early non-hibernate sleep parameters. + bcopy(&gEarlySystemSleepParams, ¶ms, sizeof(params)); + params.sleepType = kIOPMSleepTypeAbortedSleep; + params.ecWakeTimer = 1; + if (standbyNixed) { + resetTimers = true; + } else { + // Set hibernateRetry flag to force hibernate setup on the + // next sleep. + hibernateRetry = true; + } + DLOG("wake in %u secs for hibernateDisabled %d, hibernateAborted %d, standbyNixed %d\n", + params.ecWakeTimer, hibernateDisabled, hibernateAborted, standbyNixed); + } else { + hibernateRetry = false; + } + + if (kIOPMSleepTypeAbortedSleep != params.sleepType) { + resetTimers = false; + } + + paramsData = OSData::withBytes(¶ms, sizeof(params)); + if (paramsData) { + setProperty(kIOPMSystemSleepParametersKey, paramsData); + paramsData->release(); + } + + if (getSleepTypeAttributes(params.sleepType) & + kIOPMSleepAttributeHibernateSleep) { + // Disable sleep to force hibernation + gIOHibernateMode &= ~kIOHibernateModeSleep; + } + } +} + +bool +IOPMrootDomain::getHibernateSettings( + uint32_t * hibernateModePtr, + uint32_t * hibernateFreeRatio, + uint32_t * hibernateFreeTime ) +{ + // Called by IOHibernateSystemSleep() after evaluateSystemSleepPolicyEarly() + // has updated the hibernateDisabled flag. + + bool ok = getSleepOption(kIOHibernateModeKey, hibernateModePtr); + getSleepOption(kIOHibernateFreeRatioKey, hibernateFreeRatio); + getSleepOption(kIOHibernateFreeTimeKey, hibernateFreeTime); + if (hibernateDisabled) { + *hibernateModePtr = 0; + } else if (gSleepPolicyHandler) { + *hibernateModePtr = hibernateMode; + } + DLOG("hibernateMode 0x%x\n", *hibernateModePtr); + return ok; +} + +bool +IOPMrootDomain::getSleepOption( const char * key, uint32_t * option ) +{ + OSObject * optionsProp; + OSDictionary * optionsDict; + OSObject * obj = NULL; + OSNumber * num; + bool ok = false; + + optionsProp = copyProperty(kRootDomainSleepOptionsKey); + optionsDict = OSDynamicCast(OSDictionary, optionsProp); + + if (optionsDict) { + obj = optionsDict->getObject(key); + if (obj) { + obj->retain(); + } + } + if (!obj) { + obj = copyProperty(key); + } + if (obj) { + if ((num = OSDynamicCast(OSNumber, obj))) { + *option = num->unsigned32BitValue(); + ok = true; + } else if (OSDynamicCast(OSBoolean, obj)) { + *option = (obj == kOSBooleanTrue) ? 1 : 0; + ok = true; + } + } + + if (obj) { + obj->release(); + } + if (optionsProp) { + optionsProp->release(); + } + + return ok; +} +#endif /* HIBERNATION */ + +IOReturn +IOPMrootDomain::getSystemSleepType( uint32_t * sleepType, uint32_t * standbyTimer ) +{ +#if HIBERNATION + IOPMSystemSleepParameters params; + uint32_t hibMode = 0; + bool ok; + + if (gIOPMWorkLoop->inGate() == false) { + IOReturn ret = gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, + &IOPMrootDomain::getSystemSleepType), + (OSObject *) this, + (void *) sleepType, (void *) standbyTimer); + return ret; + } + + getSleepOption(kIOHibernateModeKey, &hibMode); + bzero(¶ms, sizeof(params)); + + ok = evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase0, &hibMode); + if (ok) { + *sleepType = params.sleepType; + if (!getSleepOption(kIOPMDeepSleepTimerKey, standbyTimer) && + !getSleepOption(kIOPMDeepSleepDelayKey, standbyTimer)) { + DLOG("Standby delay is not set\n"); + *standbyTimer = 0; + } + return kIOReturnSuccess; + } +#endif + + return kIOReturnUnsupported; +} + +// MARK: - +// MARK: Shutdown and Restart + +//****************************************************************************** +// handlePlatformHaltRestart +// +//****************************************************************************** + +// Phases while performing shutdown/restart +typedef enum { + kNotifyDone = 0x00, + kNotifyPriorityClients = 0x10, + kNotifyPowerPlaneDrivers = 0x20, + kNotifyHaltRestartAction = 0x30, + kQuiescePM = 0x40, +} shutdownPhase_t; + + +struct HaltRestartApplierContext { + IOPMrootDomain * RootDomain; + unsigned long PowerState; + IOPMPowerFlags PowerFlags; + UInt32 MessageType; + UInt32 Counter; + const char * LogString; + shutdownPhase_t phase; + + IOServiceInterestHandler handler; +} gHaltRestartCtx; + +const char * +shutdownPhase2String(shutdownPhase_t phase) +{ + switch (phase) { + case kNotifyDone: + return "Notifications completed"; + case kNotifyPriorityClients: + return "Notifying priority clients"; + case kNotifyPowerPlaneDrivers: + return "Notifying power plane drivers"; + case kNotifyHaltRestartAction: + return "Notifying HaltRestart action handlers"; + case kQuiescePM: + return "Quiescing PM"; + default: + return "Unknown"; + } +} + +static void +platformHaltRestartApplier( OSObject * object, void * context ) +{ + IOPowerStateChangeNotification notify; + HaltRestartApplierContext * ctx; + AbsoluteTime startTime, elapsedTime; + uint32_t deltaTime; + + ctx = (HaltRestartApplierContext *) context; + + _IOServiceInterestNotifier * notifier; + notifier = OSDynamicCast(_IOServiceInterestNotifier, object); + memset(¬ify, 0, sizeof(notify)); + notify.powerRef = (void *)(uintptr_t)ctx->Counter; + notify.returnValue = 0; + notify.stateNumber = ctx->PowerState; + notify.stateFlags = ctx->PowerFlags; + + if (notifier) { + ctx->handler = notifier->handler; + } + + clock_get_uptime(&startTime); + ctx->RootDomain->messageClient( ctx->MessageType, object, (void *)¬ify ); + deltaTime = computeDeltaTimeMS(&startTime, &elapsedTime); + + if ((deltaTime > kPMHaltTimeoutMS) && notifier) { + LOG("%s handler %p took %u ms\n", + ctx->LogString, OBFUSCATE(notifier->handler), deltaTime); + halt_log_enter("PowerOff/Restart message to priority client", (const void *) notifier->handler, elapsedTime); + } + + ctx->handler = NULL; + ctx->Counter++; +} + +static void +quiescePowerTreeCallback( void * target, void * param ) +{ + IOLockLock(gPMHaltLock); + gPMQuiesced = true; + thread_wakeup(param); + IOLockUnlock(gPMHaltLock); +} + +void +IOPMrootDomain::handlePlatformHaltRestart( UInt32 pe_type ) +{ + AbsoluteTime startTime, elapsedTime; + uint32_t deltaTime; + + memset(&gHaltRestartCtx, 0, sizeof(gHaltRestartCtx)); + gHaltRestartCtx.RootDomain = this; + + clock_get_uptime(&startTime); + switch (pe_type) { + case kPEHaltCPU: + case kPEUPSDelayHaltCPU: + gHaltRestartCtx.PowerState = OFF_STATE; + gHaltRestartCtx.MessageType = kIOMessageSystemWillPowerOff; + gHaltRestartCtx.LogString = "PowerOff"; + break; + + case kPERestartCPU: + gHaltRestartCtx.PowerState = RESTART_STATE; + gHaltRestartCtx.MessageType = kIOMessageSystemWillRestart; + gHaltRestartCtx.LogString = "Restart"; + break; + + case kPEPagingOff: + gHaltRestartCtx.PowerState = ON_STATE; + gHaltRestartCtx.MessageType = kIOMessageSystemPagingOff; + gHaltRestartCtx.LogString = "PagingOff"; + IOService::updateConsoleUsers(NULL, kIOMessageSystemPagingOff); +#if HIBERNATION + IOHibernateSystemRestart(); +#endif + break; + + default: + return; + } + + gHaltRestartCtx.phase = kNotifyPriorityClients; + // Notify legacy clients + applyToInterested(gIOPriorityPowerStateInterest, platformHaltRestartApplier, &gHaltRestartCtx); + + // For normal shutdown, turn off File Server Mode. + if (kPEHaltCPU == pe_type) { + const OSSymbol * setting = OSSymbol::withCString(kIOPMSettingRestartOnPowerLossKey); + OSNumber * num = OSNumber::withNumber((unsigned long long) 0, 32); + if (setting && num) { + setPMSetting(setting, num); + setting->release(); + num->release(); + } + } + + + if (kPEPagingOff != pe_type) { + gHaltRestartCtx.phase = kNotifyPowerPlaneDrivers; + // Notify in power tree order + notifySystemShutdown(this, gHaltRestartCtx.MessageType); + } + + gHaltRestartCtx.phase = kNotifyHaltRestartAction; +#if !CONFIG_EMBEDDED + IOCPURunPlatformHaltRestartActions(pe_type); +#else + if (kPEPagingOff != pe_type) { + IOCPURunPlatformHaltRestartActions(pe_type); + } +#endif + + // Wait for PM to quiesce + if ((kPEPagingOff != pe_type) && gPMHaltLock) { + gHaltRestartCtx.phase = kQuiescePM; + AbsoluteTime quiesceTime = mach_absolute_time(); + + IOLockLock(gPMHaltLock); + gPMQuiesced = false; + if (quiescePowerTree(this, &quiescePowerTreeCallback, &gPMQuiesced) == + kIOReturnSuccess) { + while (!gPMQuiesced) { + IOLockSleep(gPMHaltLock, &gPMQuiesced, THREAD_UNINT); + } + } + IOLockUnlock(gPMHaltLock); + deltaTime = computeDeltaTimeMS(&quiesceTime, &elapsedTime); + DLOG("PM quiesce took %u ms\n", deltaTime); + halt_log_enter("Quiesce", NULL, elapsedTime); + } + gHaltRestartCtx.phase = kNotifyDone; + + deltaTime = computeDeltaTimeMS(&startTime, &elapsedTime); + LOG("%s all drivers took %u ms\n", gHaltRestartCtx.LogString, deltaTime); + + halt_log_enter(gHaltRestartCtx.LogString, NULL, elapsedTime); + + deltaTime = computeDeltaTimeMS(&gHaltStartTime, &elapsedTime); + LOG("%s total %u ms\n", gHaltRestartCtx.LogString, deltaTime); + + if (gHaltLog && gHaltTimeMaxLog && (deltaTime >= gHaltTimeMaxLog)) { + printf("%s total %d ms:%s\n", gHaltRestartCtx.LogString, deltaTime, gHaltLog); + } + + checkShutdownTimeout(); +} + +bool +IOPMrootDomain::checkShutdownTimeout() +{ + AbsoluteTime elapsedTime; + uint32_t deltaTime = computeDeltaTimeMS(&gHaltStartTime, &elapsedTime); + + if (gHaltTimeMaxPanic && (deltaTime >= gHaltTimeMaxPanic)) { + return true; + } + return false; +} + +void +IOPMrootDomain::panicWithShutdownLog(uint32_t timeoutInMs) +{ + if (gHaltLog) { + if ((gHaltRestartCtx.phase == kNotifyPriorityClients) && gHaltRestartCtx.handler) { + halt_log_enter("Blocked on priority client", (void *)gHaltRestartCtx.handler, mach_absolute_time() - gHaltStartTime); + } + panic("%s timed out in phase '%s'. Total %d ms:%s", + gHaltRestartCtx.LogString, shutdownPhase2String(gHaltRestartCtx.phase), timeoutInMs, gHaltLog); + } else { + panic("%s timed out in phase \'%s\'. Total %d ms", + gHaltRestartCtx.LogString, shutdownPhase2String(gHaltRestartCtx.phase), timeoutInMs); + } +} + +//****************************************************************************** +// shutdownSystem +// +//****************************************************************************** + +IOReturn +IOPMrootDomain::shutdownSystem( void ) +{ + return kIOReturnUnsupported; +} + +//****************************************************************************** +// restartSystem +// +//****************************************************************************** + +IOReturn +IOPMrootDomain::restartSystem( void ) +{ + return kIOReturnUnsupported; +} + +// MARK: - +// MARK: System Capability + +//****************************************************************************** +// tagPowerPlaneService +// +// Running on PM work loop thread. +//****************************************************************************** + +void +IOPMrootDomain::tagPowerPlaneService( + IOService * service, + IOPMActions * actions ) +{ + uint32_t flags = 0; + bool isDisplayWrangler; + + memset(actions, 0, sizeof(*actions)); + actions->target = this; + + if (service == this) { + actions->actionPowerChangeStart = + OSMemberFunctionCast( + IOPMActionPowerChangeStart, this, + &IOPMrootDomain::handleOurPowerChangeStart); + + actions->actionPowerChangeDone = + OSMemberFunctionCast( + IOPMActionPowerChangeDone, this, + &IOPMrootDomain::handleOurPowerChangeDone); + + actions->actionPowerChangeOverride = + OSMemberFunctionCast( + IOPMActionPowerChangeOverride, this, + &IOPMrootDomain::overrideOurPowerChange); + return; + } + +#if !NO_KERNEL_HID + isDisplayWrangler = (NULL != service->metaCast("IODisplayWrangler")); + if (isDisplayWrangler) { + wrangler = service; + // found the display wrangler, check for any display assertions already created + if (pmAssertions->getActivatedAssertions() & kIOPMDriverAssertionPreventDisplaySleepBit) { + DLOG("wrangler setIgnoreIdleTimer\(1) due to pre-existing assertion\n"); + wrangler->setIgnoreIdleTimer( true ); + } + } +#else + isDisplayWrangler = false; +#endif + +#if defined(__i386__) || defined(__x86_64__) + if (isDisplayWrangler) { + flags |= kPMActionsFlagIsDisplayWrangler; + } + if (service->getProperty("IOPMStrictTreeOrder")) { + flags |= kPMActionsFlagIsGraphicsDevice; + } + if (service->getProperty("IOPMUnattendedWakePowerState")) { + flags |= kPMActionsFlagIsAudioDevice; + } +#endif + + // Find the power connection object that is a child of the PCI host + // bridge, and has a graphics/audio device attached below. Mark the + // power branch for delayed child notifications. + + if (flags) { + IORegistryEntry * child = service; + IORegistryEntry * parent = child->getParentEntry(gIOPowerPlane); + + while (child != this) { + if (child->getProperty("IOPCITunnelled") == kOSBooleanTrue) { + // Skip delaying notifications and clamping power on external graphics and audio devices. + DLOG("Avoiding delayChildNotification on object 0x%llx. flags: 0x%x\n", service->getRegistryEntryID(), flags); + flags = 0; + break; + } + if ((parent == pciHostBridgeDriver) || + (parent == this)) { + if (OSDynamicCast(IOPowerConnection, child)) { + IOPowerConnection * conn = (IOPowerConnection *) child; + conn->delayChildNotification = true; + DLOG("delayChildNotification for 0x%llx\n", conn->getRegistryEntryID()); + } + break; + } + child = parent; + parent = child->getParentEntry(gIOPowerPlane); + } + } + + if (flags) { + DLOG("%s tag flags %x\n", service->getName(), flags); + actions->parameter |= flags; + actions->actionPowerChangeOverride = + OSMemberFunctionCast( + IOPMActionPowerChangeOverride, this, + &IOPMrootDomain::overridePowerChangeForUIService); + + if (flags & kPMActionsFlagIsDisplayWrangler) { + actions->actionActivityTickle = + OSMemberFunctionCast( + IOPMActionActivityTickle, this, + &IOPMrootDomain::handleActivityTickleForDisplayWrangler); + + actions->actionUpdatePowerClient = + OSMemberFunctionCast( + IOPMActionUpdatePowerClient, this, + &IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler); + } + return; + } + + // Locate the first PCI host bridge for PMTrace. + if (!pciHostBridgeDevice && service->metaCast("IOPCIBridge")) { + IOService * provider = service->getProvider(); + if (OSDynamicCast(IOPlatformDevice, provider) && + provider->inPlane(gIODTPlane)) { + pciHostBridgeDevice = provider; + pciHostBridgeDriver = service; + DLOG("PMTrace found PCI host bridge %s->%s\n", + provider->getName(), service->getName()); + } + } + + // Tag top-level PCI devices. The order of PMinit() call does not + // change across boots and is used as the PCI bit number. + if (pciHostBridgeDevice && service->metaCast("IOPCIDevice")) { + // Would prefer to check built-in property, but tagPowerPlaneService() + // is called before pciDevice->registerService(). + IORegistryEntry * parent = service->getParentEntry(gIODTPlane); + if ((parent == pciHostBridgeDevice) && service->getProperty("acpi-device")) { + int bit = pmTracer->recordTopLevelPCIDevice( service ); + if (bit >= 0) { + // Save the assigned bit for fast lookup. + actions->parameter |= (bit & kPMActionsPCIBitNumberMask); + + actions->actionPowerChangeStart = + OSMemberFunctionCast( + IOPMActionPowerChangeStart, this, + &IOPMrootDomain::handlePowerChangeStartForPCIDevice); + + actions->actionPowerChangeDone = + OSMemberFunctionCast( + IOPMActionPowerChangeDone, this, + &IOPMrootDomain::handlePowerChangeDoneForPCIDevice); + } + } + } +} + +//****************************************************************************** +// PM actions for root domain +//****************************************************************************** + +void +IOPMrootDomain::overrideOurPowerChange( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex * inOutPowerState, + IOPMPowerChangeFlags * inOutChangeFlags, + IOPMRequestTag requestTag ) +{ + uint32_t powerState = (uint32_t) *inOutPowerState; + uint32_t changeFlags = *inOutChangeFlags; + uint32_t currentPowerState = (uint32_t) getPowerState(); + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if ((AOT_STATE == powerState) && (ON_STATE == currentPowerState)) { + // Assertion may have been taken in AOT leading to changePowerStateTo(AOT) + *inOutChangeFlags |= kIOPMNotDone; + return; + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + if (changeFlags & kIOPMParentInitiated) { + // Root parent is permanently pegged at max power, + // a parent initiated power change is unexpected. + *inOutChangeFlags |= kIOPMNotDone; + return; + } + + if (powerState < currentPowerState) { + if (CAP_CURRENT(kIOPMSystemCapabilityGraphics)) { + // Root domain is dropping power state ON->SLEEP. + // If system is in full wake, first enter dark wake by + // converting the power drop to a capability change. + // Once in dark wake, transition to sleep state ASAP. + + darkWakeToSleepASAP = true; + + // Drop graphics and audio capability + _desiredCapability &= ~( + kIOPMSystemCapabilityGraphics | + kIOPMSystemCapabilityAudio); + + // Convert to capability change (ON->ON) + *inOutPowerState = getRUN_STATE(); + *inOutChangeFlags |= kIOPMSynchronize; + + // Revert device desire from SLEEP to ON + changePowerStateToPriv(getRUN_STATE()); + } else { + // System is in dark wake, ok to drop power state. + // Broadcast root powering down to entire tree. + *inOutChangeFlags |= kIOPMRootChangeDown; + } + } else if (powerState > currentPowerState) { + if ((_currentCapability & kIOPMSystemCapabilityCPU) == 0) { + // Broadcast power up when waking from sleep, but not for the + // initial power change at boot by checking for cpu capability. + *inOutChangeFlags |= kIOPMRootChangeUp; + } + } +} + +void +IOPMrootDomain::handleOurPowerChangeStart( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex powerState, + IOPMPowerChangeFlags * inOutChangeFlags, + IOPMRequestTag requestTag ) +{ + uint32_t changeFlags = *inOutChangeFlags; + uint32_t currentPowerState = (uint32_t) getPowerState(); + uint32_t sleepReason = requestTag ? requestTag : kIOPMSleepReasonIdle; + bool publishSleepReason = false; + + _systemTransitionType = kSystemTransitionNone; + _systemMessageClientMask = 0; + capabilityLoss = false; + toldPowerdCapWillChange = false; + + if (lowBatteryCondition) { + // Low battery notification may arrive after the initial sleep request + // has been queued. Override the sleep reason so powerd and others can + // treat this as an emergency sleep. + sleepReason = kIOPMSleepReasonLowPower; + } + + // 1. Explicit capability change. + + if (changeFlags & kIOPMSynchronize) { + if (powerState == ON_STATE) { + if (changeFlags & kIOPMSyncNoChildNotify) { + _systemTransitionType = kSystemTransitionNewCapClient; + } else { + _systemTransitionType = kSystemTransitionCapability; + } + } + } + // 2. Going to sleep (cancellation still possible). + else if (powerState < currentPowerState) { + _systemTransitionType = kSystemTransitionSleep; + } + // 3. Woke from (idle or demand) sleep. + else if (!systemBooting && + (changeFlags & kIOPMSelfInitiated) && + (powerState > currentPowerState)) { + _systemTransitionType = kSystemTransitionWake; + _desiredCapability = kIOPMSystemCapabilityCPU | + kIOPMSystemCapabilityNetwork; + + // Early exit from dark wake to full (e.g. LID open) + if (kFullWakeReasonNone != fullWakeReason) { + _desiredCapability |= ( + kIOPMSystemCapabilityGraphics | + kIOPMSystemCapabilityAudio); + } +#if HIBERNATION + IOHibernateSetWakeCapabilities(_desiredCapability); +#endif + } + + // Update pending wake capability at the beginning of every + // state transition (including synchronize). This will become + // the current capability at the end of the transition. + + if (kSystemTransitionSleep == _systemTransitionType) { + _pendingCapability = 0; + capabilityLoss = true; + } else if (kSystemTransitionNewCapClient != _systemTransitionType) { + _pendingCapability = _desiredCapability | + kIOPMSystemCapabilityCPU | + kIOPMSystemCapabilityNetwork; + + if (_pendingCapability & kIOPMSystemCapabilityGraphics) { + _pendingCapability |= kIOPMSystemCapabilityAudio; + } + + if ((kSystemTransitionCapability == _systemTransitionType) && + (_pendingCapability == _currentCapability)) { + // Cancel the PM state change. + _systemTransitionType = kSystemTransitionNone; + *inOutChangeFlags |= kIOPMNotDone; + } + if (__builtin_popcount(_pendingCapability) < + __builtin_popcount(_currentCapability)) { + capabilityLoss = true; + } + } + + // 1. Capability change. + + if (kSystemTransitionCapability == _systemTransitionType) { + // Dark to Full transition. + if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) { + tracePoint( kIOPMTracePointDarkWakeExit ); + + willEnterFullWake(); + } + + // Full to Dark transition. + if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) { + // Clear previous stats + IOLockLock(pmStatsLock); + if (pmStatsAppResponses) { + pmStatsAppResponses->release(); + pmStatsAppResponses = OSArray::withCapacity(5); + } + IOLockUnlock(pmStatsLock); + + + tracePoint( kIOPMTracePointDarkWakeEntry ); + *inOutChangeFlags |= kIOPMSyncTellPowerDown; + _systemMessageClientMask = kSystemMessageClientPowerd | + kSystemMessageClientLegacyApp; + + + // rdar://15971327 + // Prevent user active transitions before notifying clients + // that system will sleep. + preventTransitionToUserActive(true); + + IOService::setAdvisoryTickleEnable( false ); + + // Publish the sleep reason for full to dark wake + publishSleepReason = true; + lastSleepReason = fullToDarkReason = sleepReason; + + // Publish a UUID for the Sleep --> Wake cycle + handlePublishSleepWakeUUID(true); + if (sleepDelaysReport) { + clock_get_uptime(&ts_sleepStart); + DLOG("sleepDelaysReport f->9 start at 0x%llx\n", ts_sleepStart); + } + + wranglerTickled = false; + } + } + // 2. System sleep. + else if (kSystemTransitionSleep == _systemTransitionType) { + // Beginning of a system sleep transition. + // Cancellation is still possible. + tracePoint( kIOPMTracePointSleepStarted ); + + _systemMessageClientMask = kSystemMessageClientAll; + if ((_currentCapability & kIOPMSystemCapabilityGraphics) == 0) { + _systemMessageClientMask &= ~kSystemMessageClientLegacyApp; + } + if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) { + // Kernel priority clients are only notified on the initial + // transition to full wake, so don't notify them unless system + // has gained graphics capability since the last system wake. + _systemMessageClientMask &= ~kSystemMessageClientKernel; + } +#if HIBERNATION + gIOHibernateState = 0; +#endif + + // Record the reason for dark wake back to sleep + // System may not have ever achieved full wake + + publishSleepReason = true; + lastSleepReason = sleepReason; + if (sleepDelaysReport) { + clock_get_uptime(&ts_sleepStart); + DLOG("sleepDelaysReport 9->0 start at 0x%llx\n", ts_sleepStart); + } + } + // 3. System wake. + else if (kSystemTransitionWake == _systemTransitionType) { + tracePoint( kIOPMTracePointWakeWillPowerOnClients ); + // Clear stats about sleep + + if (AOT_STATE == powerState) { + _pendingCapability = 0; + } + + if (_pendingCapability & kIOPMSystemCapabilityGraphics) { + willEnterFullWake(); + } else { + // Message powerd only + _systemMessageClientMask = kSystemMessageClientPowerd; + tellClients(kIOMessageSystemWillPowerOn); + } + } + + // The only location where the sleep reason is published. At this point + // sleep can still be cancelled, but sleep reason should be published + // early for logging purposes. + + if (publishSleepReason) { + static const char * IOPMSleepReasons[] = + { + kIOPMClamshellSleepKey, + kIOPMPowerButtonSleepKey, + kIOPMSoftwareSleepKey, + kIOPMOSSwitchHibernationKey, + kIOPMIdleSleepKey, + kIOPMLowPowerSleepKey, + kIOPMThermalEmergencySleepKey, + kIOPMMaintenanceSleepKey, + kIOPMSleepServiceExitKey, + kIOPMDarkWakeThermalEmergencyKey + }; + + // Record sleep cause in IORegistry + uint32_t reasonIndex = sleepReason - kIOPMSleepReasonClamshell; + if (reasonIndex < sizeof(IOPMSleepReasons) / sizeof(IOPMSleepReasons[0])) { + DLOG("sleep reason %s\n", IOPMSleepReasons[reasonIndex]); + setProperty(kRootDomainSleepReasonKey, IOPMSleepReasons[reasonIndex]); + } + } + + if ((kSystemTransitionNone != _systemTransitionType) && + (kSystemTransitionNewCapClient != _systemTransitionType)) { + _systemStateGeneration++; + systemDarkWake = false; + + DLOG("=== START (%s->%s, 0x%x) type %u, gen %u, msg %x, " + "dcp %x:%x:%x\n", + getPowerStateString(currentPowerState), getPowerStateString((uint32_t) powerState), *inOutChangeFlags, + _systemTransitionType, _systemStateGeneration, + _systemMessageClientMask, + _desiredCapability, _currentCapability, _pendingCapability); + } + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if ((AOT_STATE == powerState) && (SLEEP_STATE != currentPowerState)) { + panic("illegal AOT entry from %s", getPowerStateString(currentPowerState)); + } + if (_aotNow && (ON_STATE == powerState)) { + aotShouldExit(false, true); + aotExit(false); + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ +} + +void +IOPMrootDomain::handleOurPowerChangeDone( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex powerState, + IOPMPowerChangeFlags changeFlags, + IOPMRequestTag requestTag __unused ) +{ + if (kSystemTransitionNewCapClient == _systemTransitionType) { + _systemTransitionType = kSystemTransitionNone; + return; + } + + if (_systemTransitionType != kSystemTransitionNone) { + uint32_t currentPowerState = (uint32_t) getPowerState(); + + if (changeFlags & kIOPMNotDone) { + // Power down was cancelled or vetoed. + _pendingCapability = _currentCapability; + lastSleepReason = 0; + + if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics) && + CAP_CURRENT(kIOPMSystemCapabilityCPU)) { +#if !CONFIG_EMBEDDED + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDarkWakeReentry, + _systemStateGeneration ); +#else + // On embedded, there are no factors that can prolong a + // "darkWake" when a power down is vetoed. We need to + // promote to "fullWake" at least once so that factors + // that prevent idle sleep can assert themselves if required + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDarkWakeActivityTickle); +#endif + } + + // Revert device desire to max. + changePowerStateToPriv(getRUN_STATE()); + } else { + // Send message on dark wake to full wake promotion. + // tellChangeUp() handles the normal SLEEP->ON case. + + if (kSystemTransitionCapability == _systemTransitionType) { + if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) { + lastSleepReason = 0; // stop logging wrangler tickles + tellClients(kIOMessageSystemHasPoweredOn); + } + if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) { + // Going dark, reset full wake state + // userIsActive will be cleared by wrangler powering down + fullWakeReason = kFullWakeReasonNone; + + if (ts_sleepStart) { + clock_get_uptime(&wake2DarkwakeDelay); + SUB_ABSOLUTETIME(&wake2DarkwakeDelay, &ts_sleepStart); + DLOG("sleepDelaysReport f->9 end 0x%llx\n", wake2DarkwakeDelay); + ts_sleepStart = 0; + } + } + } + + // Reset state after exiting from dark wake. + + if (CAP_GAIN(kIOPMSystemCapabilityGraphics) || + CAP_LOSS(kIOPMSystemCapabilityCPU)) { + darkWakeMaintenance = false; + darkWakeToSleepASAP = false; + pciCantSleepValid = false; + darkWakeSleepService = false; + + if (CAP_LOSS(kIOPMSystemCapabilityCPU)) { + // Remove the influence of display power assertion + // before next system wake. + if (wrangler) { + wrangler->changePowerStateForRootDomain( + kWranglerPowerStateMin ); + } + removeProperty(gIOPMUserTriggeredFullWakeKey); + } + } + + // Entered dark mode. + + if (((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) && + (_pendingCapability & kIOPMSystemCapabilityCPU)) { + // Queue an evaluation of whether to remain in dark wake, + // and for how long. This serves the purpose of draining + // any assertions from the queue. + + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDarkWakeEntry, + _systemStateGeneration ); + } + } + + DLOG("=== FINISH (%s->%s, 0x%x) type %u, gen %u, msg %x, " + "dcp %x:%x:%x, dbgtimer %u\n", + getPowerStateString(currentPowerState), getPowerStateString((uint32_t) powerState), changeFlags, + _systemTransitionType, _systemStateGeneration, + _systemMessageClientMask, + _desiredCapability, _currentCapability, _pendingCapability, + _lastDebugWakeSeconds); + + if (_pendingCapability & kIOPMSystemCapabilityGraphics) { + displayWakeCnt++; +#if DARK_TO_FULL_EVALUATE_CLAMSHELL + if (clamshellExists && fullWakeThreadCall && + CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) { + // Not the initial graphics full power, graphics won't + // send a power notification to trigger a lid state + // evaluation. + + AbsoluteTime deadline; + clock_interval_to_deadline(45, kSecondScale, &deadline); + thread_call_enter_delayed(fullWakeThreadCall, deadline); + } +#endif + } else if (CAP_GAIN(kIOPMSystemCapabilityCPU)) { + darkWakeCnt++; + } + + // Update current system capability. + if (_currentCapability != _pendingCapability) { + _currentCapability = _pendingCapability; + } + + // Update highest system capability. + + _highestCapability |= _currentCapability; + + if (darkWakePostTickle && + (kSystemTransitionWake == _systemTransitionType) && + (gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == + kDarkWakeFlagHIDTickleLate) { + darkWakePostTickle = false; + reportUserInput(); + } else if (wranglerTickled) { + requestFullWake( kFullWakeReasonLocalUser ); + } + + // Reset tracepoint at completion of capability change, + // completion of wake transition, and aborted sleep transition. + + if ((_systemTransitionType == kSystemTransitionCapability) || + (_systemTransitionType == kSystemTransitionWake) || + ((_systemTransitionType == kSystemTransitionSleep) && + (changeFlags & kIOPMNotDone))) { + setProperty(kIOPMSystemCapabilitiesKey, _currentCapability, 64); + tracePoint( kIOPMTracePointSystemUp ); + } + + _systemTransitionType = kSystemTransitionNone; + _systemMessageClientMask = 0; + toldPowerdCapWillChange = false; + + logGraphicsClamp = false; + + if (lowBatteryCondition) { + privateSleepSystem(kIOPMSleepReasonLowPower); + } else if ((fullWakeReason == kFullWakeReasonDisplayOn) && (!displayPowerOnRequested)) { + // Request for full wake is removed while system is waking up to full wake + DLOG("DisplayOn fullwake request is removed\n"); + handleDisplayPowerOn(); + } + + if (isRTCAlarmWake) { + pmPowerStateQueue->submitPowerEvent( + kPowerEventReceivedPowerNotification, (void *)(uintptr_t) kLocalEvalClamshellCommand ); + } + } +} + +//****************************************************************************** +// PM actions for graphics and audio. +//****************************************************************************** + +void +IOPMrootDomain::overridePowerChangeForUIService( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex * inOutPowerState, + IOPMPowerChangeFlags * inOutChangeFlags ) +{ + uint32_t powerState = (uint32_t) *inOutPowerState; + uint32_t changeFlags = (uint32_t) *inOutChangeFlags; + + if (kSystemTransitionNone == _systemTransitionType) { + // Not in midst of a system transition. + // Do not modify power limit enable state. + } else if ((actions->parameter & kPMActionsFlagLimitPower) == 0) { + // Activate power limiter. + + if ((actions->parameter & kPMActionsFlagIsDisplayWrangler) && + ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) && + (changeFlags & kIOPMSynchronize)) { + actions->parameter |= kPMActionsFlagLimitPower; + } else if ((actions->parameter & kPMActionsFlagIsAudioDevice) && + ((gDarkWakeFlags & kDarkWakeFlagAudioNotSuppressed) == 0) && + ((_pendingCapability & kIOPMSystemCapabilityAudio) == 0) && + (changeFlags & kIOPMSynchronize)) { + actions->parameter |= kPMActionsFlagLimitPower; + } else if ((actions->parameter & kPMActionsFlagIsGraphicsDevice) && + (_systemTransitionType == kSystemTransitionSleep)) { + // For graphics devices, arm the limiter when entering + // system sleep. Not when dropping to dark wake. + actions->parameter |= kPMActionsFlagLimitPower; + } + + if (actions->parameter & kPMActionsFlagLimitPower) { + DLOG("+ plimit %s %p\n", + service->getName(), OBFUSCATE(service)); + } + } else { + // Remove power limit. + + if ((actions->parameter & ( + kPMActionsFlagIsDisplayWrangler | + kPMActionsFlagIsGraphicsDevice)) && + (_pendingCapability & kIOPMSystemCapabilityGraphics)) { + actions->parameter &= ~kPMActionsFlagLimitPower; + } else if ((actions->parameter & kPMActionsFlagIsAudioDevice) && + (_pendingCapability & kIOPMSystemCapabilityAudio)) { + actions->parameter &= ~kPMActionsFlagLimitPower; + } + + if ((actions->parameter & kPMActionsFlagLimitPower) == 0) { + DLOG("- plimit %s %p\n", + service->getName(), OBFUSCATE(service)); + } + } + + if (actions->parameter & kPMActionsFlagLimitPower) { + uint32_t maxPowerState = (uint32_t)(-1); + + if (changeFlags & (kIOPMDomainDidChange | kIOPMDomainWillChange)) { + // Enforce limit for system power/cap transitions. + + maxPowerState = 0; + if ((service->getPowerState() > maxPowerState) && + (actions->parameter & kPMActionsFlagIsDisplayWrangler)) { + maxPowerState++; + + // Remove lingering effects of any tickle before entering + // dark wake. It will take a new tickle to return to full + // wake, so the existing tickle state is useless. + + if (changeFlags & kIOPMDomainDidChange) { + *inOutChangeFlags |= kIOPMExpireIdleTimer; + } + } else if (actions->parameter & kPMActionsFlagIsGraphicsDevice) { + maxPowerState++; + } + } else { + // Deny all self-initiated changes when power is limited. + // Wrangler tickle should never defeat the limiter. + + maxPowerState = service->getPowerState(); + } + + if (powerState > maxPowerState) { + DLOG("> plimit %s %p (%u->%u, 0x%x)\n", + service->getName(), OBFUSCATE(service), powerState, maxPowerState, + changeFlags); + *inOutPowerState = maxPowerState; + + if (darkWakePostTickle && + (actions->parameter & kPMActionsFlagIsDisplayWrangler) && + (changeFlags & kIOPMDomainWillChange) && + ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == + kDarkWakeFlagHIDTickleEarly)) { + darkWakePostTickle = false; + reportUserInput(); + } + } + + if (!graphicsSuppressed && (changeFlags & kIOPMDomainDidChange)) { + if (logGraphicsClamp) { + AbsoluteTime now; + uint64_t nsec; + + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_nanoseconds(now, &nsec); + if (kIOLogPMRootDomain & gIOKitDebug) { + MSG("Graphics suppressed %u ms\n", + ((int)((nsec) / NSEC_PER_MSEC))); + } + } + graphicsSuppressed = true; + } + } +} + +void +IOPMrootDomain::handleActivityTickleForDisplayWrangler( + IOService * service, + IOPMActions * actions ) +{ +#if !NO_KERNEL_HID + // Warning: Not running in PM work loop context - don't modify state !!! + // Trap tickle directed to IODisplayWrangler while running with graphics + // capability suppressed. + + assert(service == wrangler); + + clock_get_uptime(&userActivityTime); + bool aborting = ((lastSleepReason == kIOPMSleepReasonIdle) + || (lastSleepReason == kIOPMSleepReasonMaintenance) + || (lastSleepReason == kIOPMSleepReasonSoftware)); + if (aborting) { + userActivityCount++; + DLOG("display wrangler tickled1 %d lastSleepReason %d\n", + userActivityCount, lastSleepReason); + } + + if (!wranglerTickled && + ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0)) { + DLOG("display wrangler tickled\n"); + if (kIOLogPMRootDomain & gIOKitDebug) { + OSReportWithBacktrace("Dark wake display tickle"); + } + if (pmPowerStateQueue) { + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDarkWakeActivityTickle, + true /* set wake type */ ); + } + } +#endif +} + +void +IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler( + IOService * service, + IOPMActions * actions, + const OSSymbol * powerClient, + IOPMPowerStateIndex oldPowerState, + IOPMPowerStateIndex newPowerState ) +{ +#if !NO_KERNEL_HID + assert(service == wrangler); + + // This function implements half of the user active detection + // by monitoring changes to the display wrangler's device desire. + // + // User becomes active when either: + // 1. Wrangler's DeviceDesire increases to max, but wrangler is already + // in max power state. This desire change in absence of a power state + // change is detected within. This handles the case when user becomes + // active while the display is already lit by setDisplayPowerOn(). + // + // 2. Power state change to max, and DeviceDesire is also at max. + // Handled by displayWranglerNotification(). + // + // User becomes inactive when DeviceDesire drops to sleep state or below. + + DLOG("wrangler %s (ps %u, %u->%u)\n", + powerClient->getCStringNoCopy(), + (uint32_t) service->getPowerState(), + (uint32_t) oldPowerState, (uint32_t) newPowerState); + + if (powerClient == gIOPMPowerClientDevice) { + if ((newPowerState > oldPowerState) && + (newPowerState == kWranglerPowerStateMax) && + (service->getPowerState() == kWranglerPowerStateMax)) { + evaluatePolicy( kStimulusEnterUserActiveState ); + } else if ((newPowerState < oldPowerState) && + (newPowerState <= kWranglerPowerStateSleep)) { + evaluatePolicy( kStimulusLeaveUserActiveState ); + } + } + + if (newPowerState <= kWranglerPowerStateSleep) { + evaluatePolicy( kStimulusDisplayWranglerSleep ); + } else if (newPowerState == kWranglerPowerStateMax) { + evaluatePolicy( kStimulusDisplayWranglerWake ); + } +#endif +} + +//****************************************************************************** +// User active state management +//****************************************************************************** + +void +IOPMrootDomain::preventTransitionToUserActive( bool prevent ) +{ +#if !NO_KERNEL_HID + _preventUserActive = prevent; + if (wrangler && !_preventUserActive) { + // Allowing transition to user active, but the wrangler may have + // already powered ON in case of sleep cancel/revert. Poll the + // same conditions checked for in displayWranglerNotification() + // to bring the user active state up to date. + + if ((wrangler->getPowerState() == kWranglerPowerStateMax) && + (wrangler->getPowerStateForClient(gIOPMPowerClientDevice) == + kWranglerPowerStateMax)) { + evaluatePolicy( kStimulusEnterUserActiveState ); + } + } +#endif +} + +//****************************************************************************** +// Approve usage of delayed child notification by PM. +//****************************************************************************** + +bool +IOPMrootDomain::shouldDelayChildNotification( + IOService * service ) +{ + if (((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) != 0) && + (kFullWakeReasonNone == fullWakeReason) && + (kSystemTransitionWake == _systemTransitionType)) { + DLOG("%s: delay child notify\n", service->getName()); + return true; + } + return false; +} + +//****************************************************************************** +// PM actions for PCI device. +//****************************************************************************** + +void +IOPMrootDomain::handlePowerChangeStartForPCIDevice( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex powerState, + IOPMPowerChangeFlags * inOutChangeFlags ) +{ + pmTracer->tracePCIPowerChange( + PMTraceWorker::kPowerChangeStart, + service, *inOutChangeFlags, + (actions->parameter & kPMActionsPCIBitNumberMask)); +} + +void +IOPMrootDomain::handlePowerChangeDoneForPCIDevice( + IOService * service, + IOPMActions * actions, + IOPMPowerStateIndex powerState, + IOPMPowerChangeFlags changeFlags ) +{ + pmTracer->tracePCIPowerChange( + PMTraceWorker::kPowerChangeCompleted, + service, changeFlags, + (actions->parameter & kPMActionsPCIBitNumberMask)); +} + +//****************************************************************************** +// registerInterest +// +// Override IOService::registerInterest() to intercept special clients. +//****************************************************************************** + +class IOPMServiceInterestNotifier : public _IOServiceInterestNotifier +{ + friend class IOPMrootDomain; + OSDeclareDefaultStructors(IOPMServiceInterestNotifier); + +protected: + uint32_t ackTimeoutCnt; + uint32_t msgType;// Message pending ack + + uint64_t uuid0; + uint64_t uuid1; + const OSSymbol *identifier; +}; + +OSDefineMetaClassAndStructors(IOPMServiceInterestNotifier, _IOServiceInterestNotifier) + +IONotifier * IOPMrootDomain::registerInterest( + const OSSymbol * typeOfInterest, + IOServiceInterestHandler handler, + void * target, void * ref ) +{ + IOPMServiceInterestNotifier *notifier = NULL; + bool isSystemCapabilityClient; + bool isKernelCapabilityClient; + IOReturn rc = kIOReturnError;; + + isSystemCapabilityClient = + typeOfInterest && + typeOfInterest->isEqualTo(kIOPMSystemCapabilityInterest); + + isKernelCapabilityClient = + typeOfInterest && + typeOfInterest->isEqualTo(gIOPriorityPowerStateInterest); + + if (isSystemCapabilityClient) { + typeOfInterest = gIOAppPowerStateInterest; + } + + notifier = new IOPMServiceInterestNotifier; + if (!notifier) { + return NULL; + } + + if (notifier->init()) { + rc = super::registerInterestForNotifier(notifier, typeOfInterest, handler, target, ref); + } + if (rc != kIOReturnSuccess) { + notifier->release(); + notifier = NULL; + + return NULL; + } + if (pmPowerStateQueue) { + notifier->ackTimeoutCnt = 0; + if (isSystemCapabilityClient) { + notifier->retain(); + if (pmPowerStateQueue->submitPowerEvent( + kPowerEventRegisterSystemCapabilityClient, notifier) == false) { + notifier->release(); + } + } + + if (isKernelCapabilityClient) { + notifier->retain(); + if (pmPowerStateQueue->submitPowerEvent( + kPowerEventRegisterKernelCapabilityClient, notifier) == false) { + notifier->release(); + } + } + } + + OSData *data = NULL; + uint8_t *uuid = NULL; + OSKext *kext = OSKext::lookupKextWithAddress((vm_address_t)handler); + if (kext) { + data = kext->copyUUID(); + } + if (data && (data->getLength() == sizeof(uuid_t))) { + uuid = (uint8_t *)(data->getBytesNoCopy()); + + notifier->uuid0 = ((uint64_t)(uuid[0]) << 56) | ((uint64_t)(uuid[1]) << 48) | ((uint64_t)(uuid[2]) << 40) | + ((uint64_t)(uuid[3]) << 32) | ((uint64_t)(uuid[4]) << 24) | ((uint64_t)(uuid[5]) << 16) | + ((uint64_t)(uuid[6]) << 8) | (uuid[7]); + notifier->uuid1 = ((uint64_t)(uuid[8]) << 56) | ((uint64_t)(uuid[9]) << 48) | ((uint64_t)(uuid[10]) << 40) | + ((uint64_t)(uuid[11]) << 32) | ((uint64_t)(uuid[12]) << 24) | ((uint64_t)(uuid[13]) << 16) | + ((uint64_t)(uuid[14]) << 8) | (uuid[15]); + + notifier->identifier = kext->getIdentifier(); + } + if (kext) { + kext->release(); + } + if (data) { + data->release(); + } + + return notifier; +} + +//****************************************************************************** +// systemMessageFilter +// +//****************************************************************************** + +bool +IOPMrootDomain::systemMessageFilter( + void * object, void * arg1, void * arg2, void * arg3 ) +{ + const IOPMInterestContext * context = (const IOPMInterestContext *) arg1; + bool isCapMsg = (context->messageType == kIOMessageSystemCapabilityChange); + bool isCapClient = false; + bool allow = false; + IOPMServiceInterestNotifier *notifier; + + notifier = OSDynamicCast(IOPMServiceInterestNotifier, (OSObject *)object); + + do { + if ((kSystemTransitionNewCapClient == _systemTransitionType) && + (!isCapMsg || !_joinedCapabilityClients || + !_joinedCapabilityClients->containsObject((OSObject *) object))) { + break; + } + + // Capability change message for app and kernel clients. + + if (isCapMsg) { + if ((context->notifyType == kNotifyPriority) || + (context->notifyType == kNotifyCapabilityChangePriority)) { + isCapClient = true; + } + + if ((context->notifyType == kNotifyCapabilityChangeApps) && + (object == (void *) systemCapabilityNotifier)) { + isCapClient = true; + } + } + + if (isCapClient) { + IOPMSystemCapabilityChangeParameters * capArgs = + (IOPMSystemCapabilityChangeParameters *) arg2; + + if (kSystemTransitionNewCapClient == _systemTransitionType) { + capArgs->fromCapabilities = 0; + capArgs->toCapabilities = _currentCapability; + capArgs->changeFlags = 0; + } else { + capArgs->fromCapabilities = _currentCapability; + capArgs->toCapabilities = _pendingCapability; + + if (context->isPreChange) { + capArgs->changeFlags = kIOPMSystemCapabilityWillChange; + } else { + capArgs->changeFlags = kIOPMSystemCapabilityDidChange; + } + + if ((object == (void *) systemCapabilityNotifier) && + context->isPreChange) { + toldPowerdCapWillChange = true; + } + } + + // Capability change messages only go to the PM configd plugin. + // Wait for response post-change if capabilitiy is increasing. + // Wait for response pre-change if capability is decreasing. + + if ((context->notifyType == kNotifyCapabilityChangeApps) && arg3 && + ((capabilityLoss && context->isPreChange) || + (!capabilityLoss && !context->isPreChange))) { + // app has not replied yet, wait for it + *((OSObject **) arg3) = kOSBooleanFalse; + } + + allow = true; + break; + } + + // Capability client will always see kIOMessageCanSystemSleep, + // even for demand sleep. It will also have a chance to veto + // sleep one last time after all clients have responded to + // kIOMessageSystemWillSleep + + if ((kIOMessageCanSystemSleep == context->messageType) || + (kIOMessageSystemWillNotSleep == context->messageType)) { + if (object == (OSObject *) systemCapabilityNotifier) { + allow = true; + break; + } + + // Not idle sleep, don't ask apps. + if (context->changeFlags & kIOPMSkipAskPowerDown) { + break; + } + } + + if (kIOPMMessageLastCallBeforeSleep == context->messageType) { + if ((object == (OSObject *) systemCapabilityNotifier) && + CAP_HIGHEST(kIOPMSystemCapabilityGraphics) && + (fullToDarkReason == kIOPMSleepReasonIdle)) { + allow = true; + } + break; + } + + // Reject capability change messages for legacy clients. + // Reject legacy system sleep messages for capability client. + + if (isCapMsg || (object == (OSObject *) systemCapabilityNotifier)) { + break; + } + + // Filter system sleep messages. + + if ((context->notifyType == kNotifyApps) && + (_systemMessageClientMask & kSystemMessageClientLegacyApp)) { + allow = true; + + if (notifier) { + if (arg3) { + if (notifier->ackTimeoutCnt >= 3) { + *((OSObject **) arg3) = kOSBooleanFalse; + } else { + *((OSObject **) arg3) = kOSBooleanTrue; + } + } + } + } else if ((context->notifyType == kNotifyPriority) && + (_systemMessageClientMask & kSystemMessageClientKernel)) { + allow = true; + } + }while (false); + + if (allow && isCapMsg && _joinedCapabilityClients) { + _joinedCapabilityClients->removeObject((OSObject *) object); + if (_joinedCapabilityClients->getCount() == 0) { + DLOG("destroyed capability client set %p\n", + OBFUSCATE(_joinedCapabilityClients)); + _joinedCapabilityClients->release(); + _joinedCapabilityClients = NULL; + } + } + if (notifier) { + notifier->msgType = context->messageType; + } + + return allow; +} + +//****************************************************************************** +// setMaintenanceWakeCalendar +// +//****************************************************************************** + +IOReturn +IOPMrootDomain::setMaintenanceWakeCalendar( + const IOPMCalendarStruct * calendar ) +{ + OSData * data; + IOReturn ret = 0; + + if (!calendar) { + return kIOReturnBadArgument; + } + + data = OSData::withBytes((void *) calendar, sizeof(*calendar)); + if (!data) { + return kIOReturnNoMemory; + } + + if (kPMCalendarTypeMaintenance == calendar->selector) { + ret = setPMSetting(gIOPMSettingMaintenanceWakeCalendarKey, data); + if (kIOReturnSuccess == ret) { + OSBitOrAtomic(kIOPMAlarmBitMaintenanceWake, &_scheduledAlarms); + } + } else if (kPMCalendarTypeSleepService == calendar->selector) { + ret = setPMSetting(gIOPMSettingSleepServiceWakeCalendarKey, data); + if (kIOReturnSuccess == ret) { + OSBitOrAtomic(kIOPMAlarmBitSleepServiceWake, &_scheduledAlarms); + } + } + DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); + + data->release(); + return ret; +} + +// MARK: - +// MARK: Display Wrangler + +//****************************************************************************** +// displayWranglerNotification +// +// Handle the notification when the IODisplayWrangler changes power state. +//****************************************************************************** + +IOReturn +IOPMrootDomain::displayWranglerNotification( + void * target, void * refCon, + UInt32 messageType, IOService * service, + void * messageArgument, vm_size_t argSize ) +{ +#if !NO_KERNEL_HID + int displayPowerState; + IOPowerStateChangeNotification * params = + (IOPowerStateChangeNotification *) messageArgument; + + if ((messageType != kIOMessageDeviceWillPowerOff) && + (messageType != kIOMessageDeviceHasPoweredOn)) { + return kIOReturnUnsupported; + } + + ASSERT_GATED(); + if (!gRootDomain) { + return kIOReturnUnsupported; + } + + displayPowerState = params->stateNumber; + DLOG("wrangler %s ps %d\n", + getIOMessageString(messageType), displayPowerState); + + switch (messageType) { + case kIOMessageDeviceWillPowerOff: + // Display wrangler has dropped power due to display idle + // or force system sleep. + // + // 4 Display ON kWranglerPowerStateMax + // 3 Display Dim kWranglerPowerStateDim + // 2 Display Sleep kWranglerPowerStateSleep + // 1 Not visible to user + // 0 Not visible to user kWranglerPowerStateMin + + if (displayPowerState <= kWranglerPowerStateSleep) { + gRootDomain->evaluatePolicy( kStimulusDisplayWranglerSleep ); + } + break; + + case kIOMessageDeviceHasPoweredOn: + // Display wrangler has powered on due to user activity + // or wake from sleep. + + if (kWranglerPowerStateMax == displayPowerState) { + gRootDomain->evaluatePolicy( kStimulusDisplayWranglerWake ); + + // See comment in handleUpdatePowerClientForDisplayWrangler + if (service->getPowerStateForClient(gIOPMPowerClientDevice) == + kWranglerPowerStateMax) { + gRootDomain->evaluatePolicy( kStimulusEnterUserActiveState ); + } + } + break; + } +#endif + return kIOReturnUnsupported; +} + +//****************************************************************************** +// displayWranglerMatchPublished +// +// Receives a notification when the IODisplayWrangler is published. +// When it's published we install a power state change handler. +//****************************************************************************** + +bool +IOPMrootDomain::displayWranglerMatchPublished( + void * target, + void * refCon, + IOService * newService, + IONotifier * notifier __unused) +{ +#if !NO_KERNEL_HID + // install a handler + if (!newService->registerInterest( gIOGeneralInterest, + &displayWranglerNotification, target, NULL)) { + return false; + } +#endif + return true; +} + +//****************************************************************************** +// reportUserInput +// +//****************************************************************************** + +void +IOPMrootDomain::reportUserInput( void ) +{ +#if !NO_KERNEL_HID + OSIterator * iter; + OSDictionary * matching; + + if (!wrangler) { + matching = serviceMatching("IODisplayWrangler"); + iter = getMatchingServices(matching); + if (matching) { + matching->release(); + } + if (iter) { + wrangler = OSDynamicCast(IOService, iter->getNextObject()); + iter->release(); + } + } + + if (wrangler) { + wrangler->activityTickle(0, 0); + } +#endif +} + +//****************************************************************************** +// latchDisplayWranglerTickle +//****************************************************************************** + +bool +IOPMrootDomain::latchDisplayWranglerTickle( bool latch ) +{ +#if !NO_KERNEL_HID + if (latch) { + if (!(_currentCapability & kIOPMSystemCapabilityGraphics) && + !(_pendingCapability & kIOPMSystemCapabilityGraphics) && + !checkSystemCanSustainFullWake()) { + // Currently in dark wake, and not transitioning to full wake. + // Full wake is unsustainable, so latch the tickle to prevent + // the display from lighting up momentarily. + wranglerTickleLatched = true; + } else { + wranglerTickleLatched = false; + } + } else if (wranglerTickleLatched && checkSystemCanSustainFullWake()) { + wranglerTickleLatched = false; + + pmPowerStateQueue->submitPowerEvent( + kPowerEventPolicyStimulus, + (void *) kStimulusDarkWakeActivityTickle ); + } + + return wranglerTickleLatched; +#else + return false; +#endif +} + +//****************************************************************************** +// setDisplayPowerOn +// +// For root domain user client +//****************************************************************************** + +void +IOPMrootDomain::setDisplayPowerOn( uint32_t options ) +{ + pmPowerStateQueue->submitPowerEvent( kPowerEventSetDisplayPowerOn, + (void *) NULL, options ); +} + +// MARK: - +// MARK: Battery + +//****************************************************************************** +// batteryPublished +// +// Notification on battery class IOPowerSource appearance +//****************************************************************************** + +bool +IOPMrootDomain::batteryPublished( + void * target, + void * root_domain, + IOService * resourceService, + IONotifier * notifier __unused ) +{ + // rdar://2936060&4435589 + // All laptops have dimmable LCD displays + // All laptops have batteries + // So if this machine has a battery, publish the fact that the backlight + // supports dimming. + ((IOPMrootDomain *)root_domain)->publishFeature("DisplayDims"); + + return true; +} + +// MARK: - +// MARK: System PM Policy + +//****************************************************************************** +// checkSystemSleepAllowed +// +//****************************************************************************** + +bool +IOPMrootDomain::checkSystemSleepAllowed( IOOptionBits options, + uint32_t sleepReason ) { - OSObject *obj = NULL; + uint32_t err = 0; + + // Conditions that prevent idle and demand system sleep. + + do { + if (userDisabledAllSleep) { + err = kPMUserDisabledAllSleep; // 1. user-space sleep kill switch + break; + } + + if (systemBooting || systemShutdown || gWillShutdown) { + err = kPMSystemRestartBootingInProgress; // 2. restart or shutdown in progress + break; + } + + if (options == 0) { + break; + } + + // Conditions above pegs the system at full wake. + // Conditions below prevent system sleep but does not prevent + // dark wake, and must be called from gated context. + +#if !CONFIG_SLEEP + err = kPMConfigPreventSystemSleep; // 3. config does not support sleep + break; +#endif + + if (lowBatteryCondition || thermalWarningState) { + break; // always sleep on low battery or when in thermal warning state + } + + if (sleepReason == kIOPMSleepReasonDarkWakeThermalEmergency) { + break; // always sleep on dark wake thermal emergencies + } + + if (preventSystemSleepList->getCount() != 0) { + err = kPMChildPreventSystemSleep; // 4. child prevent system sleep clamp + break; + } + + if (getPMAssertionLevel( kIOPMDriverAssertionCPUBit ) == + kIOPMDriverAssertionLevelOn) { + err = kPMCPUAssertion; // 5. CPU assertion + break; + } + + if (pciCantSleepValid) { + if (pciCantSleepFlag) { + err = kPMPCIUnsupported; // 6. PCI card does not support PM (cached) + } + break; + } else if (sleepSupportedPEFunction && + CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) { + IOReturn ret; + OSBitAndAtomic(~kPCICantSleep, &platformSleepSupport); + ret = getPlatform()->callPlatformFunction( + sleepSupportedPEFunction, false, + NULL, NULL, NULL, NULL); + pciCantSleepValid = true; + pciCantSleepFlag = false; + if ((platformSleepSupport & kPCICantSleep) || + ((ret != kIOReturnSuccess) && (ret != kIOReturnUnsupported))) { + err = 6; // 6. PCI card does not support PM + pciCantSleepFlag = true; + break; + } + } + }while (false); + + if (err) { + DLOG("System sleep prevented by %s\n", getSystemSleepPreventerString(err)); + return false; + } + return true; +} - if(!whichSetting) return NULL; +bool +IOPMrootDomain::checkSystemSleepEnabled( void ) +{ + return checkSystemSleepAllowed(0, 0); +} - PMSETTING_LOCK(); - obj = fPMSettingsDict->getObject(whichSetting); - if(obj) { - obj->retain(); - } - PMSETTING_UNLOCK(); - - return obj; +bool +IOPMrootDomain::checkSystemCanSleep( uint32_t sleepReason ) +{ + ASSERT_GATED(); + return checkSystemSleepAllowed(1, sleepReason); } //****************************************************************************** -// registerPMSettingController (public) -// -// direct wrapper to registerPMSettingController with uint32_t power source arg +// checkSystemCanSustainFullWake //****************************************************************************** -IOReturn IOPMrootDomain::registerPMSettingController( - const OSSymbol * settings[], - IOPMSettingControllerCallback func, - OSObject *target, - uintptr_t refcon, - OSObject **handle) +bool +IOPMrootDomain::checkSystemCanSustainFullWake( void ) { - return registerPMSettingController( - settings, - (kIOPMSupportedOnAC | kIOPMSupportedOnBatt | kIOPMSupportedOnUPS), - func, target, refcon, handle); +#if !NO_KERNEL_HID + if (lowBatteryCondition || thermalWarningState) { + // Low battery wake, or received a low battery notification + // while system is awake. This condition will persist until + // the following wake. + return false; + } + + if (clamshellExists && clamshellClosed && !clamshellSleepDisabled) { + // Graphics state is unknown and external display might not be probed. + // Do not incorporate state that requires graphics to be in max power + // such as desktopMode or clamshellDisabled. + + if (!acAdaptorConnected) { + DLOG("full wake check: no AC\n"); + return false; + } + } +#endif + return true; } //****************************************************************************** -// registerPMSettingController (public) -// -// Kexts may register for notifications when a particular setting is changed. -// A list of settings is available in IOPM.h. -// Arguments: -// * settings - An OSArray containing OSSymbols. Caller should populate this -// array with a list of settings caller wants notifications from. -// * func - A C function callback of the type IOPMSettingControllerCallback -// * target - caller may provide an OSObject *, which PM will pass as an -// target to calls to "func" -// * refcon - caller may provide an void *, which PM will pass as an -// argument to calls to "func" -// * handle - This is a return argument. We will populate this pointer upon -// call success. Hold onto this and pass this argument to -// IOPMrootDomain::deRegisterPMSettingCallback when unloading your kext -// Returns: -// kIOReturnSuccess on success +// mustHibernate //****************************************************************************** -IOReturn IOPMrootDomain::registerPMSettingController( - const OSSymbol * settings[], - uint32_t supportedPowerSources, - IOPMSettingControllerCallback func, - OSObject *target, - uintptr_t refcon, - OSObject **handle) +#if HIBERNATION + +bool +IOPMrootDomain::mustHibernate( void ) { - PMSettingObject *pmso = NULL; - OSObject *pmsh = NULL; - OSArray *list = NULL; - int i; + return lowBatteryCondition || thermalWarningState; +} - if (NULL == settings || - NULL == func || - NULL == handle) - { - return kIOReturnBadArgument; - } +#endif /* HIBERNATION */ - pmso = PMSettingObject::pmSettingObject( - (IOPMrootDomain *) this, func, target, - refcon, supportedPowerSources, settings, &pmsh); +//****************************************************************************** +// AOT +//****************************************************************************** - if (!pmso) { - *handle = NULL; - return kIOReturnInternalError; - } +// Tables for accumulated days in year by month, latter used for leap years - PMSETTING_LOCK(); - for (i=0; settings[i]; i++) - { - list = (OSArray *) settingsCallbacks->getObject(settings[i]); - if (!list) { - // New array of callbacks for this setting - list = OSArray::withCapacity(1); - settingsCallbacks->setObject(settings[i], list); - list->release(); - } +static const int daysbymonth[] = +{ 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 }; - // Add caller to the callback list - list->setObject(pmso); - } - PMSETTING_UNLOCK(); +static const int lydaysbymonth[] = +{ 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 }; - // Return handle to the caller, the setting object is private. - *handle = pmsh; +static int __unused +IOPMConvertSecondsToCalendar(long secs, IOPMCalendarStruct * dt) +{ + const int * dbm = daysbymonth; + long n, x, y, z; - return kIOReturnSuccess; -} + if (secs < 0) { + return 0; + } -//****************************************************************************** -// deregisterPMSettingObject (private) -// -// Only called from PMSettingObject. -//****************************************************************************** + // Calculate seconds, minutes and hours -void IOPMrootDomain::deregisterPMSettingObject( PMSettingObject * pmso ) -{ - thread_t thisThread = current_thread(); - PMSettingCallEntry *callEntry; - OSCollectionIterator *iter; - OSSymbol *sym; - OSArray *array; - int index; - bool wait; - - PMSETTING_LOCK(); - - pmso->disabled = true; - - // Wait for all callout threads to finish. - do { - wait = false; - queue_iterate(&pmso->calloutQueue, callEntry, PMSettingCallEntry *, link) - { - if (callEntry->thread != thisThread) - { - wait = true; - break; - } - } - if (wait) - { - assert(0 == pmso->waitThread); - pmso->waitThread = thisThread; - PMSETTING_WAIT(pmso); - pmso->waitThread = 0; - } - } while (wait); - - // Search each PM settings array in the kernel. - iter = OSCollectionIterator::withCollection(settingsCallbacks); - if (iter) - { - while ((sym = OSDynamicCast(OSSymbol, iter->getNextObject()))) - { - array = (OSArray *) settingsCallbacks->getObject(sym); - index = array->getNextIndexOfObject(pmso, 0); - if (-1 != index) { - array->removeObject(index); - } - } - iter->release(); - } - - PMSETTING_UNLOCK(); - - pmso->release(); -} + n = secs % (24 * 3600); + dt->second = n % 60; + n /= 60; + dt->minute = n % 60; + dt->hour = n / 60; -//****************************************************************************** -// informCPUStateChange -// -// Call into PM CPU code so that CPU power savings may dynamically adjust for -// running on battery, with the lid closed, etc. -// -// informCPUStateChange is a no-op on non x86 systems -// only x86 has explicit support in the IntelCPUPowerManagement kext -//****************************************************************************** + // Calculate day of week -void IOPMrootDomain::informCPUStateChange( - uint32_t type, - uint32_t value ) -{ -#if defined(__i386__) || defined(__x86_64__) + n = secs / (24 * 3600); +// dt->dayWeek = (n + 4) % 7; - pmioctlVariableInfo_t varInfoStruct; - int pmCPUret = 0; - const char *varNameStr = NULL; - int32_t *varIndex = NULL; - - if (kInformAC == type) { - varNameStr = kIOPMRootDomainBatPowerCString; - varIndex = &idxPMCPULimitedPower; - } else if (kInformLid == type) { - varNameStr = kIOPMRootDomainLidCloseCString; - varIndex = &idxPMCPUClamshell; - } else { - return; - } - - // Set the new value! - // pmCPUControl will assign us a new ID if one doesn't exist yet - bzero(&varInfoStruct, sizeof(pmioctlVariableInfo_t)); - varInfoStruct.varID = *varIndex; - varInfoStruct.varType = vBool; - varInfoStruct.varInitValue = value; - varInfoStruct.varCurValue = value; - strncpy( (char *)varInfoStruct.varName, - (const char *)varNameStr, - strlen(varNameStr) + 1 ); - - // Set! - pmCPUret = pmCPUControl( PMIOCSETVARINFO, (void *)&varInfoStruct ); - - // pmCPU only assigns numerical id's when a new varName is specified - if ((0 == pmCPUret) - && (*varIndex == kCPUUnknownIndex)) - { - // pmCPUControl has assigned us a new variable ID. - // Let's re-read the structure we just SET to learn that ID. - pmCPUret = pmCPUControl( PMIOCGETVARNAMEINFO, (void *)&varInfoStruct ); - - if (0 == pmCPUret) - { - // Store it in idxPMCPUClamshell or idxPMCPULimitedPower - *varIndex = varInfoStruct.varID; - } - } - - return; - -#endif /* __i386__ || __x86_64__ */ -} + // Calculate year + // Rebase from days since Unix epoch (1/1/1970) store in 'n', + // to days since 1/1/1968 to start on 4 year cycle, beginning + // on a leap year. -// MARK: - -// MARK: Deep Sleep Policy + n += (366 + 365); -#if HIBERNATION + // Every 4 year cycle will be exactly (366 + 365 * 3) = 1461 days. + // Valid before 2100, since 2100 is not a leap year. -//****************************************************************************** -// evaluateSystemSleepPolicy -//****************************************************************************** + x = n / 1461; // number of 4 year cycles + y = n % 1461; // days into current 4 year cycle + z = 1968 + (4 * x); -#define kIOPlatformSystemSleepPolicyKey "IOPlatformSystemSleepPolicy" + // Add in years in the current 4 year cycle -// Sleep flags -enum { - kIOPMSleepFlagHibernate = 0x00000001, - kIOPMSleepFlagSleepTimerEnable = 0x00000002 -}; + if (y >= 366) { + y -= 366; // days after the leap year + n = y % 365; // days into the current year + z += (1 + y / 365); // years after the past 4-yr cycle + } else { + n = y; + dbm = lydaysbymonth; + } + if (z > 2099) { + return 0; + } -struct IOPMSystemSleepPolicyEntry -{ - uint32_t factorMask; - uint32_t factorBits; - uint32_t sleepFlags; - uint32_t wakeEvents; -} __attribute__((packed)); + dt->year = z; -struct IOPMSystemSleepPolicyTable -{ - uint32_t signature; - uint16_t version; - uint16_t entryCount; - IOPMSystemSleepPolicyEntry entries[]; -} __attribute__((packed)); + // Adjust remaining days value to start at 1 -enum { - kIOPMSleepAttributeHibernateSetup = 0x00000001, - kIOPMSleepAttributeHibernateSleep = 0x00000002 -}; + n += 1; -static uint32_t -getSleepTypeAttributes( uint32_t sleepType ) -{ - static const uint32_t sleepTypeAttributes[ kIOPMSleepTypeLast ] = - { - /* invalid */ 0, - /* abort */ 0, - /* normal */ 0, - /* safesleep */ kIOPMSleepAttributeHibernateSetup, - /* hibernate */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, - /* standby */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, - /* poweroff */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep, - /* deepidle */ 0 - }; - - if (sleepType >= kIOPMSleepTypeLast) - return 0; - - return sleepTypeAttributes[sleepType]; -} - -bool IOPMrootDomain::evaluateSystemSleepPolicy( - IOPMSystemSleepParameters * params, int sleepPhase, uint32_t * hibMode ) -{ - const IOPMSystemSleepPolicyTable * pt; - OSObject * prop = 0; - OSData * policyData; - uint64_t currentFactors = 0; - uint32_t standbyDelay = 0; - uint32_t powerOffDelay = 0; - uint32_t powerOffTimer = 0; - uint32_t mismatch; - bool standbyEnabled; - bool powerOffEnabled; - bool found = false; - - // Get platform's sleep policy table - if (!gSleepPolicyHandler) - { - prop = getServiceRoot()->copyProperty(kIOPlatformSystemSleepPolicyKey); - if (!prop) goto done; - } - - // Fetch additional settings - standbyEnabled = (getSleepOption(kIOPMDeepSleepDelayKey, &standbyDelay) - && (getProperty(kIOPMDeepSleepEnabledKey) == kOSBooleanTrue)); - powerOffEnabled = (getSleepOption(kIOPMAutoPowerOffDelayKey, &powerOffDelay) - && (getProperty(kIOPMAutoPowerOffEnabledKey) == kOSBooleanTrue)); - if (!getSleepOption(kIOPMAutoPowerOffTimerKey, &powerOffTimer)) - powerOffTimer = powerOffDelay; - - DLOG("phase %d, standby %d delay %u, poweroff %d delay %u timer %u, hibernate 0x%x\n", - sleepPhase, standbyEnabled, standbyDelay, - powerOffEnabled, powerOffDelay, powerOffTimer, *hibMode); - - // pmset level overrides - if ((*hibMode & kIOHibernateModeOn) == 0) - { - if (!gSleepPolicyHandler) - { - standbyEnabled = false; - powerOffEnabled = false; - } - } - else if (!(*hibMode & kIOHibernateModeSleep)) - { - // Force hibernate (i.e. mode 25) - // If standby is enabled, force standy. - // If poweroff is enabled, force poweroff. - if (standbyEnabled) - currentFactors |= kIOPMSleepFactorStandbyForced; - else if (powerOffEnabled) - currentFactors |= kIOPMSleepFactorAutoPowerOffForced; - else - currentFactors |= kIOPMSleepFactorHibernateForced; - } - - // Current factors based on environment and assertions - if (sleepTimerMaintenance) - currentFactors |= kIOPMSleepFactorSleepTimerWake; - if (standbyEnabled && sleepToStandby) - currentFactors |= kIOPMSleepFactorSleepTimerWake; - if (!clamshellClosed) - currentFactors |= kIOPMSleepFactorLidOpen; - if (acAdaptorConnected) - currentFactors |= kIOPMSleepFactorACPower; - if (lowBatteryCondition) - currentFactors |= kIOPMSleepFactorBatteryLow; - if (!standbyDelay) - currentFactors |= kIOPMSleepFactorStandbyNoDelay; - if (!standbyEnabled) - currentFactors |= kIOPMSleepFactorStandbyDisabled; - if (getPMAssertionLevel(kIOPMDriverAssertionUSBExternalDeviceBit) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorUSBExternalDevice; - if (getPMAssertionLevel(kIOPMDriverAssertionBluetoothHIDDevicePairedBit) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorBluetoothHIDDevice; - if (getPMAssertionLevel(kIOPMDriverAssertionExternalMediaMountedBit) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorExternalMediaMounted; - if (getPMAssertionLevel(kIOPMDriverAssertionReservedBit5) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorThunderboltDevice; - if (_scheduledAlarms != 0) - currentFactors |= kIOPMSleepFactorRTCAlarmScheduled; - if (getPMAssertionLevel(kIOPMDriverAssertionMagicPacketWakeEnabledBit) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorMagicPacketWakeEnabled; -#if TCPKEEPALIVE - if (getPMAssertionLevel(kIOPMDriverAssertionNetworkKeepAliveActiveBit) != - kIOPMDriverAssertionLevelOff) - currentFactors |= kIOPMSleepFactorNetworkKeepAliveActive; -#endif - if (!powerOffEnabled) - currentFactors |= kIOPMSleepFactorAutoPowerOffDisabled; - if (desktopMode) - currentFactors |= kIOPMSleepFactorExternalDisplay; - if (userWasActive) - currentFactors |= kIOPMSleepFactorLocalUserActivity; - - DLOG("sleep factors 0x%llx\n", currentFactors); - - if (gSleepPolicyHandler) - { - uint32_t savedHibernateMode; - IOReturn result; - - if (!gSleepPolicyVars) - { - gSleepPolicyVars = IONew(IOPMSystemSleepPolicyVariables, 1); - if (!gSleepPolicyVars) - goto done; - bzero(gSleepPolicyVars, sizeof(*gSleepPolicyVars)); - } - gSleepPolicyVars->signature = kIOPMSystemSleepPolicySignature; - gSleepPolicyVars->version = kIOPMSystemSleepPolicyVersion; - gSleepPolicyVars->currentCapability = _currentCapability; - gSleepPolicyVars->highestCapability = _highestCapability; - gSleepPolicyVars->sleepFactors = currentFactors; - gSleepPolicyVars->sleepReason = lastSleepReason; - gSleepPolicyVars->sleepPhase = sleepPhase; - gSleepPolicyVars->standbyDelay = standbyDelay; - gSleepPolicyVars->poweroffDelay = powerOffDelay; - gSleepPolicyVars->scheduledAlarms = _scheduledAlarms | _userScheduledAlarm; - gSleepPolicyVars->poweroffTimer = powerOffTimer; - - if (kIOPMSleepPhase0 == sleepPhase) - { - // preserve hibernateMode - savedHibernateMode = gSleepPolicyVars->hibernateMode; - gSleepPolicyVars->hibernateMode = *hibMode; - } - else if (kIOPMSleepPhase1 == sleepPhase) - { - // use original hibernateMode for phase2 - gSleepPolicyVars->hibernateMode = *hibMode; - } - - result = gSleepPolicyHandler(gSleepPolicyTarget, gSleepPolicyVars, params); - - if (kIOPMSleepPhase0 == sleepPhase) - { - // restore hibernateMode - gSleepPolicyVars->hibernateMode = savedHibernateMode; - } - - if ((result != kIOReturnSuccess) || - (kIOPMSleepTypeInvalid == params->sleepType) || - (params->sleepType >= kIOPMSleepTypeLast) || - (kIOPMSystemSleepParametersVersion != params->version)) - { - MSG("sleep policy handler error\n"); - goto done; - } - - if ((getSleepTypeAttributes(params->sleepType) & - kIOPMSleepAttributeHibernateSetup) && - ((*hibMode & kIOHibernateModeOn) == 0)) - { - *hibMode |= (kIOHibernateModeOn | kIOHibernateModeSleep); - } - - DLOG("sleep params v%u, type %u, flags 0x%x, wake 0x%x, timer %u, poweroff %u\n", - params->version, params->sleepType, params->sleepFlags, - params->ecWakeEvents, params->ecWakeTimer, params->ecPoweroffTimer); - found = true; - goto done; - } - - // Policy table is meaningless without standby enabled - if (!standbyEnabled) - goto done; - - // Validate the sleep policy table - policyData = OSDynamicCast(OSData, prop); - if (!policyData || (policyData->getLength() <= sizeof(IOPMSystemSleepPolicyTable))) - goto done; - - pt = (const IOPMSystemSleepPolicyTable *) policyData->getBytesNoCopy(); - if ((pt->signature != kIOPMSystemSleepPolicySignature) || - (pt->version != 1) || (0 == pt->entryCount)) - goto done; - - if (((policyData->getLength() - sizeof(IOPMSystemSleepPolicyTable)) != - (sizeof(IOPMSystemSleepPolicyEntry) * pt->entryCount))) - goto done; - - for (uint32_t i = 0; i < pt->entryCount; i++) - { - const IOPMSystemSleepPolicyEntry * entry = &pt->entries[i]; - mismatch = (((uint32_t)currentFactors ^ entry->factorBits) & entry->factorMask); - - DLOG("mask 0x%08x, bits 0x%08x, flags 0x%08x, wake 0x%08x, mismatch 0x%08x\n", - entry->factorMask, entry->factorBits, - entry->sleepFlags, entry->wakeEvents, mismatch); - if (mismatch) - continue; - - DLOG("^ found match\n"); - found = true; - - params->version = kIOPMSystemSleepParametersVersion; - params->reserved1 = 1; - if (entry->sleepFlags & kIOPMSleepFlagHibernate) - params->sleepType = kIOPMSleepTypeStandby; - else - params->sleepType = kIOPMSleepTypeNormalSleep; - - params->ecWakeEvents = entry->wakeEvents; - if (entry->sleepFlags & kIOPMSleepFlagSleepTimerEnable) - { - if (kIOPMSleepPhase2 == sleepPhase) - { - clock_sec_t now_secs = gIOLastSleepTime.tv_sec; - - if (!_standbyTimerResetSeconds || - (now_secs <= _standbyTimerResetSeconds)) - { - // Reset standby timer adjustment - _standbyTimerResetSeconds = now_secs; - DLOG("standby delay %u, reset %u\n", - standbyDelay, (uint32_t) _standbyTimerResetSeconds); - } - else if (standbyDelay) - { - // Shorten the standby delay timer - clock_sec_t elapsed = now_secs - _standbyTimerResetSeconds; - if (standbyDelay > elapsed) - standbyDelay -= elapsed; - else - standbyDelay = 1; // must be > 0 - - DLOG("standby delay %u, elapsed %u\n", - standbyDelay, (uint32_t) elapsed); - } - } - params->ecWakeTimer = standbyDelay; - } - else if (kIOPMSleepPhase2 == sleepPhase) - { - // A sleep that does not enable the sleep timer will reset - // the standby delay adjustment. - _standbyTimerResetSeconds = 0; - } - break; - } + // Calculate month -done: - if (prop) - prop->release(); + for (x = 1; n > dbm[x]; x++) { + continue; + } + dt->month = x; - return found; -} + // Calculate day of month -static IOPMSystemSleepParameters gEarlySystemSleepParams; + dt->day = n - dbm[x - 1]; -void IOPMrootDomain::evaluateSystemSleepPolicyEarly( void ) -{ - // Evaluate early (priority interest phase), before drivers sleep. - - DLOG("%s\n", __FUNCTION__); - removeProperty(kIOPMSystemSleepParametersKey); - - // Full wake resets the standby timer delay adjustment - if (_highestCapability & kIOPMSystemCapabilityGraphics) - _standbyTimerResetSeconds = 0; - - hibernateDisabled = false; - hibernateMode = 0; - getSleepOption(kIOHibernateModeKey, &hibernateMode); - - // Save for late evaluation if sleep is aborted - bzero(&gEarlySystemSleepParams, sizeof(gEarlySystemSleepParams)); - - if (evaluateSystemSleepPolicy(&gEarlySystemSleepParams, kIOPMSleepPhase1, - &hibernateMode)) - { - if (!hibernateRetry && - ((getSleepTypeAttributes(gEarlySystemSleepParams.sleepType) & - kIOPMSleepAttributeHibernateSetup) == 0)) - { - // skip hibernate setup - hibernateDisabled = true; - } - } - - // Publish IOPMSystemSleepType - uint32_t sleepType = gEarlySystemSleepParams.sleepType; - if (sleepType == kIOPMSleepTypeInvalid) - { - // no sleep policy - sleepType = kIOPMSleepTypeNormalSleep; - if (hibernateMode & kIOHibernateModeOn) - sleepType = (hibernateMode & kIOHibernateModeSleep) ? - kIOPMSleepTypeSafeSleep : kIOPMSleepTypeHibernate; - } - else if ((sleepType == kIOPMSleepTypeStandby) && - (gEarlySystemSleepParams.ecPoweroffTimer)) - { - // report the lowest possible sleep state - sleepType = kIOPMSleepTypePowerOff; - } - - setProperty(kIOPMSystemSleepTypeKey, sleepType, 32); -} - -void IOPMrootDomain::evaluateSystemSleepPolicyFinal( void ) -{ - IOPMSystemSleepParameters params; - OSData * paramsData; - - // Evaluate sleep policy after sleeping drivers but before platform sleep. - - DLOG("%s\n", __FUNCTION__); - - bzero(¶ms, sizeof(params)); - if (evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase2, &hibernateMode)) - { - if ((hibernateDisabled || hibernateAborted) && - (getSleepTypeAttributes(params.sleepType) & - kIOPMSleepAttributeHibernateSetup)) - { - // Final evaluation picked a state requiring hibernation, - // but hibernate setup was skipped. Arm a short sleep using - // the early non-hibernate sleep parameters. - // Set hibernateRetry flag to force hibernate setup on the - // next sleep. - - bcopy(&gEarlySystemSleepParams, ¶ms, sizeof(params)); - params.sleepType = kIOPMSleepTypeAbortedSleep; - params.ecWakeTimer = 1; - hibernateRetry = true; - DLOG("wake in %u secs for hibernateDisabled %d, hibernateAborted %d\n", - params.ecWakeTimer, hibernateDisabled, hibernateAborted); - } - else - { - hibernateRetry = false; - } - - paramsData = OSData::withBytes(¶ms, sizeof(params)); - if (paramsData) - { - setProperty(kIOPMSystemSleepParametersKey, paramsData); - paramsData->release(); - } - - if (getSleepTypeAttributes(params.sleepType) & - kIOPMSleepAttributeHibernateSleep) - { - // Disable sleep to force hibernation - gIOHibernateMode &= ~kIOHibernateModeSleep; - } - } -} - -bool IOPMrootDomain::getHibernateSettings( - uint32_t * hibernateModePtr, - uint32_t * hibernateFreeRatio, - uint32_t * hibernateFreeTime ) -{ - // Called by IOHibernateSystemSleep() after evaluateSystemSleepPolicyEarly() - // has updated the hibernateDisabled flag. - - bool ok = getSleepOption(kIOHibernateModeKey, hibernateModePtr); - getSleepOption(kIOHibernateFreeRatioKey, hibernateFreeRatio); - getSleepOption(kIOHibernateFreeTimeKey, hibernateFreeTime); - if (hibernateDisabled) - *hibernateModePtr = 0; - else if (gSleepPolicyHandler) - *hibernateModePtr = hibernateMode; - DLOG("hibernateMode 0x%x\n", *hibernateModePtr); - return ok; -} - -bool IOPMrootDomain::getSleepOption( const char * key, uint32_t * option ) -{ - OSObject * optionsProp; - OSDictionary * optionsDict; - OSObject * obj = 0; - OSNumber * num; - bool ok = false; - - optionsProp = copyProperty(kRootDomainSleepOptionsKey); - optionsDict = OSDynamicCast(OSDictionary, optionsProp); - - if (optionsDict) - { - obj = optionsDict->getObject(key); - if (obj) obj->retain(); - } - if (!obj) - { - obj = copyProperty(key); - } - if (obj && (num = OSDynamicCast(OSNumber, obj))) - { - *option = num->unsigned32BitValue(); - ok = true; - } - - if (obj) - obj->release(); - if (optionsProp) - optionsProp->release(); - - return true; + return 1; } -#endif /* HIBERNATION */ -IOReturn IOPMrootDomain::getSystemSleepType( uint32_t * sleepType ) +static long +IOPMConvertCalendarToSeconds(const IOPMCalendarStruct * dt) { -#if HIBERNATION - IOPMSystemSleepParameters params; - uint32_t hibMode = 0; - bool ok; - - if (gIOPMWorkLoop->inGate() == false) - { - IOReturn ret = gIOPMWorkLoop->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, this, - &IOPMrootDomain::getSystemSleepType), - (OSObject *) this, - (void *) sleepType); - return ret; - } - - getSleepOption(kIOHibernateModeKey, &hibMode); - bzero(¶ms, sizeof(params)); - - ok = evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase0, &hibMode); - if (ok) - { - *sleepType = params.sleepType; - return kIOReturnSuccess; - } -#endif + const int * dbm = daysbymonth; + long y, secs, days; - return kIOReturnUnsupported; -} + if (dt->year < 1970) { + return 0; + } -// MARK: - -// MARK: Shutdown and Restart + // Seconds elapsed in the current day -//****************************************************************************** -// handlePlatformHaltRestart -// -//****************************************************************************** + secs = dt->second + 60 * dt->minute + 3600 * dt->hour; -struct HaltRestartApplierContext { - IOPMrootDomain * RootDomain; - unsigned long PowerState; - IOPMPowerFlags PowerFlags; - UInt32 MessageType; - UInt32 Counter; -}; + // Number of days from 1/1/70 to beginning of current year + // Account for extra day every 4 years starting at 1973 -static void -platformHaltRestartApplier( OSObject * object, void * context ) -{ - IOPowerStateChangeNotification notify; - HaltRestartApplierContext * ctx; - AbsoluteTime startTime; - UInt32 deltaTime; + y = dt->year - 1970; + days = (y * 365) + ((y + 1) / 4); - ctx = (HaltRestartApplierContext *) context; - - memset(¬ify, 0, sizeof(notify)); - notify.powerRef = (void *)(uintptr_t)ctx->Counter; - notify.returnValue = 0; - notify.stateNumber = ctx->PowerState; - notify.stateFlags = ctx->PowerFlags; + // Change table if current year is a leap year - clock_get_uptime(&startTime); - ctx->RootDomain->messageClient( ctx->MessageType, object, (void *)¬ify ); - deltaTime = computeDeltaTimeMS(&startTime); + if ((dt->year % 4) == 0) { + dbm = lydaysbymonth; + } - if ((deltaTime > kPMHaltTimeoutMS) || - (gIOKitDebug & kIOLogPMRootDomain)) - { - _IOServiceInterestNotifier * notifier; - notifier = OSDynamicCast(_IOServiceInterestNotifier, object); + // Add in days elapsed in the current year - // IOService children of IOPMrootDomain are not instrumented. - // Only IORootParent currently falls under that group. + days += (dt->day - 1) + dbm[dt->month - 1]; - if (notifier) - { - LOG("%s handler %p took %u ms\n", - (ctx->MessageType == kIOMessageSystemWillPowerOff) ? "PowerOff" : - (ctx->MessageType == kIOMessageSystemPagingOff) ? "PagingOff" : "Restart", - OBFUSCATE(notifier->handler), (uint32_t) deltaTime ); - } - } + // Add accumulated days to accumulated seconds - ctx->Counter++; + secs += 24 * 3600 * days; + + return secs; } -void IOPMrootDomain::handlePlatformHaltRestart( UInt32 pe_type ) +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + +unsigned long +IOPMrootDomain::getRUN_STATE(void) { - HaltRestartApplierContext ctx; - AbsoluteTime startTime; - UInt32 deltaTime; + return _aotNow ? AOT_STATE : ON_STATE; +} - memset(&ctx, 0, sizeof(ctx)); - ctx.RootDomain = this; +bool +IOPMrootDomain::isAOTMode() +{ + return _aotNow; +} - clock_get_uptime(&startTime); - switch (pe_type) - { - case kPEHaltCPU: - case kPEUPSDelayHaltCPU: - ctx.PowerState = OFF_STATE; - ctx.MessageType = kIOMessageSystemWillPowerOff; - break; +IOReturn +IOPMrootDomain::setWakeTime(uint64_t wakeContinuousTime) +{ + clock_sec_t nowsecs, wakesecs; + clock_usec_t nowmicrosecs, wakemicrosecs; + uint64_t nowAbs, wakeAbs; - case kPERestartCPU: - ctx.PowerState = RESTART_STATE; - ctx.MessageType = kIOMessageSystemWillRestart; - break; + clock_gettimeofday_and_absolute_time(&nowsecs, &nowmicrosecs, &nowAbs); + wakeAbs = continuoustime_to_absolutetime(wakeContinuousTime); + if (wakeAbs < nowAbs) { + printf(LOG_PREFIX "wakeAbs %qd < nowAbs %qd\n", wakeAbs, nowAbs); + wakeAbs = nowAbs; + } + wakeAbs -= nowAbs; + absolutetime_to_microtime(wakeAbs, &wakesecs, &wakemicrosecs); + + wakesecs += nowsecs; + wakemicrosecs += nowmicrosecs; + if (wakemicrosecs >= USEC_PER_SEC) { + wakesecs++; + wakemicrosecs -= USEC_PER_SEC; + } + if (wakemicrosecs >= (USEC_PER_SEC / 10)) { + wakesecs++; + } - case kPEPagingOff: - ctx.PowerState = ON_STATE; - ctx.MessageType = kIOMessageSystemPagingOff; - IOService::updateConsoleUsers(NULL, kIOMessageSystemPagingOff); -#if HIBERNATION - IOHibernateSystemRestart(); -#endif - break; + IOPMConvertSecondsToCalendar(wakesecs, &_aotWakeTimeCalendar); - default: - return; + if (_aotWakeTimeContinuous != wakeContinuousTime) { + _aotWakeTimeContinuous = wakeContinuousTime; + IOLog(LOG_PREFIX "setWakeTime: " YMDTF "\n", YMDT(&_aotWakeTimeCalendar)); + } + _aotWakeTimeCalendar.selector = kPMCalendarTypeMaintenance; + _aotWakeTimeUTC = wakesecs; + + return kIOReturnSuccess; +} + +// assumes WAKEEVENT_LOCK +bool +IOPMrootDomain::aotShouldExit(bool checkTimeSet, bool software) +{ + bool exitNow; + const char * reason = ""; + + if (software) { + _aotExit = true; + _aotMetrics->softwareRequestCount++; + reason = "software request"; + } else if (kIOPMWakeEventAOTExitFlags & _aotPendingFlags) { + _aotExit = true; + reason = gWakeReasonString; + } else if (checkTimeSet && (kPMCalendarTypeInvalid == _aotWakeTimeCalendar.selector)) { + _aotExit = true; + _aotMetrics->noTimeSetCount++; + reason = "flipbook expired"; + } else if ((kIOPMAOTModeRespectTimers & _aotMode) && _scheduledAlarmUTC) { + clock_sec_t sec; + clock_usec_t usec; + clock_get_calendar_microtime(&sec, &usec); + if (_scheduledAlarmUTC <= sec) { + _aotExit = true; + _aotMetrics->rtcAlarmsCount++; + reason = "user alarm"; + } + } + exitNow = (_aotNow && _aotExit); + if (exitNow) { + _aotNow = false; + IOLog(LOG_PREFIX "AOT exit for %s, sc %d po %d, cp %d, rj %d, ex %d, nt %d, rt %d\n", + reason, + _aotMetrics->sleepCount, + _aotMetrics->possibleCount, + _aotMetrics->confirmedPossibleCount, + _aotMetrics->rejectedPossibleCount, + _aotMetrics->expiredPossibleCount, + _aotMetrics->noTimeSetCount, + _aotMetrics->rtcAlarmsCount); } + return exitNow; +} - // Notify legacy clients - applyToInterested(gIOPriorityPowerStateInterest, platformHaltRestartApplier, &ctx); - - // For normal shutdown, turn off File Server Mode. - if (kPEHaltCPU == pe_type) - { - const OSSymbol * setting = OSSymbol::withCString(kIOPMSettingRestartOnPowerLossKey); - OSNumber * num = OSNumber::withNumber((unsigned long long) 0, 32); - if (setting && num) - { - setPMSetting(setting, num); - setting->release(); - num->release(); - } - } - - if (kPEPagingOff != pe_type) - { - // Notify in power tree order - notifySystemShutdown(this, ctx.MessageType); +void +IOPMrootDomain::aotExit(bool cps) +{ + _aotTasksSuspended = false; + _aotReadyToFullWake = false; + if (_aotTimerScheduled) { + _aotTimerES->cancelTimeout(); + _aotTimerScheduled = false; + } + updateTasksSuspend(); + + _aotMetrics->totalTime += mach_absolute_time() - _aotLastWakeTime; + _aotLastWakeTime = 0; + if (_aotMetrics->sleepCount && (_aotMetrics->sleepCount <= kIOPMAOTMetricsKernelWakeCountMax)) { + strlcpy(&_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount - 1][0], + gWakeReasonString, + sizeof(_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount])); } - deltaTime = computeDeltaTimeMS(&startTime); - LOG("%s all drivers took %u ms\n", - (ctx.MessageType == kIOMessageSystemWillPowerOff) ? "PowerOff" : - (ctx.MessageType == kIOMessageSystemPagingOff) ? "PagingOff" : "Restart", - (uint32_t) deltaTime ); + _aotWakeTimeCalendar.selector = kPMCalendarTypeInvalid; + + _systemMessageClientMask = kSystemMessageClientLegacyApp; + tellClients(kIOMessageSystemWillPowerOn); + + if (cps) { + changePowerStateToPriv(getRUN_STATE()); + } } -//****************************************************************************** -// shutdownSystem -// -//****************************************************************************** +void +IOPMrootDomain::aotEvaluate(IOTimerEventSource * timer) +{ + bool exitNow; + + IOLog("aotEvaluate(%d) 0x%x\n", (timer != NULL), _aotPendingFlags); + + WAKEEVENT_LOCK(); + exitNow = aotShouldExit(false, false); + if (timer != NULL) { + _aotTimerScheduled = false; + } + WAKEEVENT_UNLOCK(); + if (exitNow) { + aotExit(true); + } else { +#if 0 + if (_aotLingerTime) { + uint64_t deadline; + IOLog("aot linger before sleep\n"); + clock_absolutetime_interval_to_deadline(_aotLingerTime, &deadline); + clock_delay_until(deadline); + } +#endif + privateSleepSystem(kIOPMSleepReasonSoftware); + } +} + +#else /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ -IOReturn IOPMrootDomain::shutdownSystem( void ) +unsigned long +IOPMrootDomain::getRUN_STATE(void) { - return kIOReturnUnsupported; + return ON_STATE; } +IOReturn +IOPMrootDomain::setWakeTime(uint64_t wakeContinuousTime) +{ + return kIOReturnUnsupported; +} + +#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + //****************************************************************************** -// restartSystem +// adjustPowerState // +// Conditions that affect our wake/sleep decision has changed. +// If conditions dictate that the system must remain awake, clamp power +// state to max with changePowerStateToPriv(ON). Otherwise if sleepASAP +// is TRUE, then remove the power clamp and allow the power state to drop +// to SLEEP_STATE. //****************************************************************************** -IOReturn IOPMrootDomain::restartSystem( void ) +void +IOPMrootDomain::adjustPowerState( bool sleepASAP ) { - return kIOReturnUnsupported; + DEBUG_LOG("adjustPowerState ps %s, asap %d, idleSleepEnabled %d\n", + getPowerStateString((uint32_t) getPowerState()), sleepASAP, idleSleepEnabled); + + ASSERT_GATED(); + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (_aotNow) { + bool exitNow; + + if (AOT_STATE != getPowerState()) { + return; + } + WAKEEVENT_LOCK(); + exitNow = aotShouldExit(true, false); + if (!exitNow + && !_aotTimerScheduled + && (kIOPMWakeEventAOTPossibleExit == (kIOPMWakeEventAOTPossibleFlags & _aotPendingFlags))) { + _aotTimerScheduled = true; + if (_aotLingerTime) { + _aotTimerES->setTimeout(_aotLingerTime); + } else { + _aotTimerES->setTimeout(800, kMillisecondScale); + } + } + WAKEEVENT_UNLOCK(); + if (exitNow) { + aotExit(true); + } else { + _aotReadyToFullWake = true; + if (!_aotTimerScheduled) { + privateSleepSystem(kIOPMSleepReasonSoftware); + } + } + return; + } +#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + if ((!idleSleepEnabled) || !checkSystemSleepEnabled()) { + changePowerStateToPriv(getRUN_STATE()); + } else if (sleepASAP) { + changePowerStateToPriv(SLEEP_STATE); + } } -// MARK: - -// MARK: System Capability +void +IOPMrootDomain::handleDisplayPowerOn() +{ + if (!wrangler) { + return; + } + if (displayPowerOnRequested) { + if (!checkSystemCanSustainFullWake()) { + return; + } + + // Force wrangler to max power state. If system is in dark wake + // this alone won't raise the wrangler's power state. + + wrangler->changePowerStateForRootDomain(kWranglerPowerStateMax); + + // System in dark wake, always requesting full wake should + // not have any bad side-effects, even if the request fails. + + if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics)) { + setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeNotification); + requestFullWake( kFullWakeReasonDisplayOn ); + } + } else { + // Relenquish desire to power up display. + // Must first transition to state 1 since wrangler doesn't + // power off the displays at state 0. At state 0 the root + // domain is removed from the wrangler's power client list. + + wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin + 1); + wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin); + } +} //****************************************************************************** -// tagPowerPlaneService +// dispatchPowerEvent // -// Running on PM work loop thread. +// IOPMPowerStateQueue callback function. Running on PM work loop thread. //****************************************************************************** -void IOPMrootDomain::tagPowerPlaneService( - IOService * service, - IOPMActions * actions ) +void +IOPMrootDomain::dispatchPowerEvent( + uint32_t event, void * arg0, uint64_t arg1 ) { - uint32_t flags = 0; - bool isDisplayWrangler; + ASSERT_GATED(); - memset(actions, 0, sizeof(*actions)); - actions->target = this; + switch (event) { + case kPowerEventFeatureChanged: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + messageClients(kIOPMMessageFeatureChange, this); + break; - if (service == this) - { - actions->actionPowerChangeStart = - OSMemberFunctionCast( - IOPMActionPowerChangeStart, this, - &IOPMrootDomain::handleOurPowerChangeStart); + case kPowerEventReceivedPowerNotification: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + handlePowerNotification((UInt32)(uintptr_t) arg0 ); + break; - actions->actionPowerChangeDone = - OSMemberFunctionCast( - IOPMActionPowerChangeDone, this, - &IOPMrootDomain::handleOurPowerChangeDone); + case kPowerEventSystemBootCompleted: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (systemBooting) { + systemBooting = false; - actions->actionPowerChangeOverride = - OSMemberFunctionCast( - IOPMActionPowerChangeOverride, this, - &IOPMrootDomain::overrideOurPowerChange); - return; - } + // read noidle setting from Device Tree + IORegistryEntry *defaults = IORegistryEntry::fromPath("IODeviceTree:/defaults"); + if (defaults != NULL) { + OSData *data = OSDynamicCast(OSData, defaults->getProperty("no-idle")); + if ((data != NULL) && (data->getLength() == 4)) { + gNoIdleFlag = *(uint32_t*)data->getBytesNoCopy(); + DLOG("Setting gNoIdleFlag to %u from device tree\n", gNoIdleFlag); + } + defaults->release(); + } + if (lowBatteryCondition) { + privateSleepSystem(kIOPMSleepReasonLowPower); -#if !NO_KERNEL_HID - isDisplayWrangler = (0 != service->metaCast("IODisplayWrangler")); - if (isDisplayWrangler) - { - wrangler = service; - } -#else - isDisplayWrangler = false; -#endif + // The rest is unnecessary since the system is expected + // to sleep immediately. The following wake will update + // everything. + break; + } -#if defined(__i386__) || defined(__x86_64__) - if (isDisplayWrangler) - flags |= kPMActionsFlagIsDisplayWrangler; - if (service->getProperty("IOPMStrictTreeOrder")) - flags |= kPMActionsFlagIsGraphicsDevice; - if (service->getProperty("IOPMUnattendedWakePowerState")) - flags |= kPMActionsFlagIsAudioDevice; -#endif + sleepWakeDebugMemAlloc(); + saveFailureData2File(); + + // If lid is closed, re-send lid closed notification + // now that booting is complete. + if (clamshellClosed) { + handlePowerNotification(kLocalEvalClamshellCommand); + } + evaluatePolicy( kStimulusAllowSystemSleepChanged ); + } + break; + + case kPowerEventSystemShutdown: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (kOSBooleanTrue == (OSBoolean *) arg0) { + /* We set systemShutdown = true during shutdown + * to prevent sleep at unexpected times while loginwindow is trying + * to shutdown apps and while the OS is trying to transition to + * complete power of. + * + * Set to true during shutdown, as soon as loginwindow shows + * the "shutdown countdown dialog", through individual app + * termination, and through black screen kernel shutdown. + */ + systemShutdown = true; + } else { + /* + * A shutdown was initiated, but then the shutdown + * was cancelled, clearing systemShutdown to false here. + */ + systemShutdown = false; + } + break; + + case kPowerEventUserDisabledSleep: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + userDisabledAllSleep = (kOSBooleanTrue == (OSBoolean *) arg0); + break; + + case kPowerEventRegisterSystemCapabilityClient: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (systemCapabilityNotifier) { + systemCapabilityNotifier->release(); + systemCapabilityNotifier = NULL; + } + if (arg0) { + systemCapabilityNotifier = (IONotifier *) arg0; + systemCapabilityNotifier->retain(); + } + /* intentional fall-through */ + [[clang::fallthrough]]; + + case kPowerEventRegisterKernelCapabilityClient: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (!_joinedCapabilityClients) { + _joinedCapabilityClients = OSSet::withCapacity(8); + } + if (arg0) { + IONotifier * notify = (IONotifier *) arg0; + if (_joinedCapabilityClients) { + _joinedCapabilityClients->setObject(notify); + synchronizePowerTree( kIOPMSyncNoChildNotify ); + } + notify->release(); + } + break; + + case kPowerEventPolicyStimulus: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (arg0) { + int stimulus = (uintptr_t) arg0; + evaluatePolicy( stimulus, (uint32_t) arg1 ); + } + break; + + case kPowerEventAssertionCreate: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (pmAssertions) { + pmAssertions->handleCreateAssertion((OSData *)arg0); + } + break; - // Find the power connection object that is a child of the PCI host - // bridge, and has a graphics/audio device attached below. Mark the - // power branch for delayed child notifications. - - if (flags) - { - IORegistryEntry * child = service; - IORegistryEntry * parent = child->getParentEntry(gIOPowerPlane); - - while (child != this) - { - if ((parent == pciHostBridgeDriver) || - (parent == this)) - { - if (OSDynamicCast(IOPowerConnection, child)) - { - IOPowerConnection * conn = (IOPowerConnection *) child; - conn->delayChildNotification = true; - } - break; - } - child = parent; - parent = child->getParentEntry(gIOPowerPlane); - } - } - - if (flags) - { - DLOG("%s tag flags %x\n", service->getName(), flags); - actions->parameter |= flags; - actions->actionPowerChangeOverride = - OSMemberFunctionCast( - IOPMActionPowerChangeOverride, this, - &IOPMrootDomain::overridePowerChangeForUIService); - - if (flags & kPMActionsFlagIsDisplayWrangler) - { - actions->actionActivityTickle = - OSMemberFunctionCast( - IOPMActionActivityTickle, this, - &IOPMrootDomain::handleActivityTickleForDisplayWrangler); - - actions->actionUpdatePowerClient = - OSMemberFunctionCast( - IOPMActionUpdatePowerClient, this, - &IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler); - } - return; - } - - // Locate the first PCI host bridge for PMTrace. - if (!pciHostBridgeDevice && service->metaCast("IOPCIBridge")) - { - IOService * provider = service->getProvider(); - if (OSDynamicCast(IOPlatformDevice, provider) && - provider->inPlane(gIODTPlane)) - { - pciHostBridgeDevice = provider; - pciHostBridgeDriver = service; - DLOG("PMTrace found PCI host bridge %s->%s\n", - provider->getName(), service->getName()); - } - } - - // Tag top-level PCI devices. The order of PMinit() call does not - // change across boots and is used as the PCI bit number. - if (pciHostBridgeDevice && service->metaCast("IOPCIDevice")) - { - // Would prefer to check built-in property, but tagPowerPlaneService() - // is called before pciDevice->registerService(). - IORegistryEntry * parent = service->getParentEntry(gIODTPlane); - if ((parent == pciHostBridgeDevice) && service->getProperty("acpi-device")) - { - int bit = pmTracer->recordTopLevelPCIDevice( service ); - if (bit >= 0) - { - // Save the assigned bit for fast lookup. - actions->parameter |= (bit & kPMActionsPCIBitNumberMask); - actions->actionPowerChangeStart = - OSMemberFunctionCast( - IOPMActionPowerChangeStart, this, - &IOPMrootDomain::handlePowerChangeStartForPCIDevice); + case kPowerEventAssertionRelease: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (pmAssertions) { + pmAssertions->handleReleaseAssertion(arg1); + } + break; - actions->actionPowerChangeDone = - OSMemberFunctionCast( - IOPMActionPowerChangeDone, this, - &IOPMrootDomain::handlePowerChangeDoneForPCIDevice); - } - } - } + case kPowerEventAssertionSetLevel: + DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (pmAssertions) { + pmAssertions->handleSetAssertionLevel(arg1, (IOPMDriverAssertionLevel)(uintptr_t)arg0); + } + break; + + case kPowerEventQueueSleepWakeUUID: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + handleQueueSleepWakeUUID((OSObject *)arg0); + break; + case kPowerEventPublishSleepWakeUUID: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + handlePublishSleepWakeUUID((bool)arg0); + break; + + case kPowerEventSetDisplayPowerOn: + DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1); + if (!wrangler) { + break; + } + if (arg1 != 0) { + displayPowerOnRequested = true; + } else { + displayPowerOnRequested = false; + } + handleDisplayPowerOn(); + break; + } } //****************************************************************************** -// PM actions for root domain +// systemPowerEventOccurred +// +// The power controller is notifying us of a hardware-related power management +// event that we must handle. +// +// systemPowerEventOccurred covers the same functionality that +// receivePowerNotification does; it simply provides a richer API for conveying +// more information. //****************************************************************************** -void IOPMrootDomain::overrideOurPowerChange( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex * inOutPowerState, - IOPMPowerChangeFlags * inOutChangeFlags, - IOPMRequestTag requestTag ) -{ - uint32_t powerState = (uint32_t) *inOutPowerState; - uint32_t changeFlags = *inOutChangeFlags; - uint32_t currentPowerState = (uint32_t) getPowerState(); - - if (changeFlags & kIOPMParentInitiated) - { - // Root parent is permanently pegged at max power, - // a parent initiated power change is unexpected. - *inOutChangeFlags |= kIOPMNotDone; - return; - } - - if (powerState < currentPowerState) - { - if (CAP_CURRENT(kIOPMSystemCapabilityGraphics)) - { - // Root domain is dropping power state ON->SLEEP. - // If system is in full wake, first drop to dark wake by - // converting the power state transitions to a capability - // change transition. - - darkWakeToSleepASAP = true; - - // Drop graphics and audio capability. - // No transition if system is already in dark wake. - - _desiredCapability &= ~( - kIOPMSystemCapabilityGraphics | - kIOPMSystemCapabilityAudio ); - - *inOutPowerState = ON_STATE; - *inOutChangeFlags |= kIOPMSynchronize; - - // Revert device desire from SLEEP->ON. - changePowerStateToPriv(ON_STATE); - } - else - { - // Broadcast root power down - *inOutChangeFlags |= kIOPMRootChangeDown; - } - } - else if (powerState > currentPowerState) - { - if ((_currentCapability & kIOPMSystemCapabilityCPU) == 0) - { - // Broadcast power up when waking from sleep, but not for the - // initial power change at boot by checking for cpu capability. - *inOutChangeFlags |= kIOPMRootChangeUp; - } - } -} - -void IOPMrootDomain::handleOurPowerChangeStart( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex powerState, - IOPMPowerChangeFlags * inOutChangeFlags, - IOPMRequestTag requestTag ) -{ - uint32_t changeFlags = *inOutChangeFlags; - uint32_t currentPowerState = (uint32_t) getPowerState(); - uint32_t sleepReason = requestTag ? requestTag : kIOPMSleepReasonIdle; - bool publishSleepReason = false; - - _systemTransitionType = kSystemTransitionNone; - _systemMessageClientMask = 0; - capabilityLoss = false; - - // 1. Explicit capability change. - - if (changeFlags & kIOPMSynchronize) - { - if (powerState == ON_STATE) - { - if (changeFlags & kIOPMSyncNoChildNotify) - _systemTransitionType = kSystemTransitionNewCapClient; - else - _systemTransitionType = kSystemTransitionCapability; - } - } - - // 2. Going to sleep (cancellation still possible). - - else if (powerState < currentPowerState) - _systemTransitionType = kSystemTransitionSleep; - - // 3. Woke from (idle or demand) sleep. - - else if (!systemBooting && - (changeFlags & kIOPMSelfInitiated) && - (powerState > currentPowerState)) - { - _systemTransitionType = kSystemTransitionWake; - _desiredCapability = kIOPMSystemCapabilityCPU | - kIOPMSystemCapabilityNetwork; - - // Early exit from dark wake to full (e.g. LID open) - if (kFullWakeReasonNone != fullWakeReason) - { - _desiredCapability |= ( - kIOPMSystemCapabilityGraphics | - kIOPMSystemCapabilityAudio ); - } -#if HIBERNATION - IOHibernateSetWakeCapabilities(_desiredCapability); -#endif - } - - // Update pending wake capability at the beginning of every - // state transition (including synchronize). This will become - // the current capability at the end of the transition. - - if (kSystemTransitionSleep == _systemTransitionType) - { - _pendingCapability = 0; - capabilityLoss = true; - } - else if (kSystemTransitionNewCapClient != _systemTransitionType) - { - _pendingCapability = _desiredCapability | - kIOPMSystemCapabilityCPU | - kIOPMSystemCapabilityNetwork; - - if (_pendingCapability & kIOPMSystemCapabilityGraphics) - _pendingCapability |= kIOPMSystemCapabilityAudio; - - if ((kSystemTransitionCapability == _systemTransitionType) && - (_pendingCapability == _currentCapability)) - { - // Cancel the PM state change. - _systemTransitionType = kSystemTransitionNone; - *inOutChangeFlags |= kIOPMNotDone; - } - if (__builtin_popcount(_pendingCapability) < - __builtin_popcount(_currentCapability)) - capabilityLoss = true; - } - - // 1. Capability change. - - if (kSystemTransitionCapability == _systemTransitionType) - { - // Dark to Full transition. - if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) - { - tracePoint( kIOPMTracePointDarkWakeExit ); - - if (pmStatsAppResponses) - { - setProperty(kIOPMSleepStatisticsAppsKey, pmStatsAppResponses); - pmStatsAppResponses->release(); - pmStatsAppResponses = OSArray::withCapacity(5); - } - - willEnterFullWake(); - } - - // Full to Dark transition. - if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) - { - tracePoint( kIOPMTracePointDarkWakeEntry ); - *inOutChangeFlags |= kIOPMSyncTellPowerDown; - _systemMessageClientMask = kSystemMessageClientPowerd | - kSystemMessageClientLegacyApp; - IOService::setAdvisoryTickleEnable( false ); - - // Publish the sleep reason for full to dark wake - publishSleepReason = true; - lastSleepReason = fullToDarkReason = sleepReason; - - // Publish a UUID for the Sleep --> Wake cycle - handlePublishSleepWakeUUID(true); - } - } - - // 2. System sleep. - - else if (kSystemTransitionSleep == _systemTransitionType) - { - // Beginning of a system sleep transition. - // Cancellation is still possible. - tracePoint( kIOPMTracePointSleepStarted, sleepReason ); - - _systemMessageClientMask = kSystemMessageClientAll; - if ((_currentCapability & kIOPMSystemCapabilityGraphics) == 0) - _systemMessageClientMask &= ~kSystemMessageClientLegacyApp; - if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) - _systemMessageClientMask &= ~kSystemMessageClientKernel; - - // Record the reason for dark wake back to sleep - // System may not have ever achieved full wake - - publishSleepReason = true; - lastSleepReason = sleepReason; - - if (timeline) - timeline->setSleepCycleInProgressFlag(true); - - recordPMEvent(kIOPMEventTypeSleep, NULL, sleepReason, kIOReturnSuccess); - - // Optimization to ignore wrangler power down thus skipping - // the disk spindown and arming the idle timer for demand sleep. - - if (changeFlags & kIOPMIgnoreChildren) - { - ignoreIdleSleepTimer = true; - } - } - - // 3. System wake. - - else if (kSystemTransitionWake == _systemTransitionType) - { - ignoreIdleSleepTimer = false; - tracePoint( kIOPMTracePointWakeWillPowerOnClients ); - if (pmStatsAppResponses) - { - setProperty(kIOPMSleepStatisticsAppsKey, pmStatsAppResponses); - pmStatsAppResponses->release(); - pmStatsAppResponses = OSArray::withCapacity(5); - } - - if (_pendingCapability & kIOPMSystemCapabilityGraphics) - { - willEnterFullWake(); - } - else - { - // Message powerd only - _systemMessageClientMask = kSystemMessageClientPowerd; - tellClients(kIOMessageSystemWillPowerOn); - } - } - - // The only location where the sleep reason is published. At this point - // sleep can still be cancelled, but sleep reason should be published - // early for logging purposes. - - if (publishSleepReason) - { - static const char * IOPMSleepReasons[] = - { - kIOPMClamshellSleepKey, - kIOPMPowerButtonSleepKey, - kIOPMSoftwareSleepKey, - kIOPMOSSwitchHibernationKey, - kIOPMIdleSleepKey, - kIOPMLowPowerSleepKey, - kIOPMThermalEmergencySleepKey, - kIOPMMaintenanceSleepKey, - kIOPMSleepServiceExitKey, - kIOPMDarkWakeThermalEmergencyKey - }; - - // Record sleep cause in IORegistry - uint32_t reasonIndex = sleepReason - kIOPMSleepReasonClamshell; - if (reasonIndex < sizeof(IOPMSleepReasons)/sizeof(IOPMSleepReasons[0])) { - DLOG("sleep reason %s\n", IOPMSleepReasons[reasonIndex]); - setProperty(kRootDomainSleepReasonKey, IOPMSleepReasons[reasonIndex]); - } - } - - if ((kSystemTransitionNone != _systemTransitionType) && - (kSystemTransitionNewCapClient != _systemTransitionType)) - { - _systemStateGeneration++; - systemDarkWake = false; - - DLOG("=== START (%u->%u, 0x%x) type %u, gen %u, msg %x, " - "dcp %x:%x:%x\n", - currentPowerState, (uint32_t) powerState, *inOutChangeFlags, - _systemTransitionType, _systemStateGeneration, - _systemMessageClientMask, - _desiredCapability, _currentCapability, _pendingCapability); - } -} - -void IOPMrootDomain::handleOurPowerChangeDone( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex powerState, - IOPMPowerChangeFlags changeFlags, - IOPMRequestTag requestTag __unused ) -{ - if (kSystemTransitionNewCapClient == _systemTransitionType) - { - _systemTransitionType = kSystemTransitionNone; - return; - } - - if (_systemTransitionType != kSystemTransitionNone) - { - uint32_t currentPowerState = (uint32_t) getPowerState(); - - if (changeFlags & kIOPMNotDone) - { - // Power down was cancelled or vetoed. - _pendingCapability = _currentCapability; - lastSleepReason = 0; - - if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics) && - CAP_CURRENT(kIOPMSystemCapabilityCPU)) - { - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusDarkWakeReentry, - _systemStateGeneration ); - } - - // Revert device desire to max. - changePowerStateToPriv(ON_STATE); - } - else - { - // Send message on dark wake to full wake promotion. - // tellChangeUp() handles the normal SLEEP->ON case. - - if (kSystemTransitionCapability == _systemTransitionType) - { - if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) - { - lastSleepReason = 0; // stop logging wrangler tickles - tellClients(kIOMessageSystemHasPoweredOn); - } - if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) - { - // Going dark, reset full wake state - // userIsActive will be cleared by wrangler powering down - wranglerTickled = false; - fullWakeReason = kFullWakeReasonNone; - } - } - - // Reset state after exiting from dark wake. - - if (CAP_GAIN(kIOPMSystemCapabilityGraphics) || - CAP_LOSS(kIOPMSystemCapabilityCPU)) - { - darkWakeMaintenance = false; - darkWakeToSleepASAP = false; - pciCantSleepValid = false; - darkWakeSleepService = false; - - if (CAP_LOSS(kIOPMSystemCapabilityCPU)) - { - // Remove the influence of display power assertion - // before next system wake. - if (wrangler) wrangler->changePowerStateForRootDomain( - kWranglerPowerStateMin ); - removeProperty(gIOPMUserTriggeredFullWakeKey); - } - } - - // Entered dark mode. - - if (((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) && - (_pendingCapability & kIOPMSystemCapabilityCPU)) - { -#if DISABLE_SLEEP_ASAP_FOR_NETWORK_WAKE - if (((gDarkWakeFlags & kDarkWakeFlagIgnoreDiskIOInDark) == 0) && - (kSystemTransitionWake == _systemTransitionType) && - (_lastDebugWakeSeconds == 0)) - { - OSObject * prop = copyProperty(kIOPMRootDomainWakeTypeKey); - if (prop) - { - OSString * wakeType = OSDynamicCast(OSString, prop); - if (wakeType && - wakeType->isEqualTo(kIOPMRootDomainWakeTypeNetwork)) - { - // Woke from network and entered dark wake. - if (darkWakeToSleepASAP) - { - DLOG("cleared darkWakeToSleepASAP\n"); - darkWakeToSleepASAP = false; - } - } - prop->release(); - } - } -#endif - // Queue an evaluation of whether to remain in dark wake, - // and for how long. This serves the purpose of draining - // any assertions from the queue. - - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusDarkWakeEntry, - _systemStateGeneration ); - } - } - - DLOG("=== FINISH (%u->%u, 0x%x) type %u, gen %u, msg %x, " - "dcp %x:%x:%x, dbgtimer %u\n", - currentPowerState, (uint32_t) powerState, changeFlags, - _systemTransitionType, _systemStateGeneration, - _systemMessageClientMask, - _desiredCapability, _currentCapability, _pendingCapability, - _lastDebugWakeSeconds); - - if (_pendingCapability & kIOPMSystemCapabilityGraphics) - { - displayWakeCnt++; -#if DARK_TO_FULL_EVALUATE_CLAMSHELL - if (clamshellExists && fullWakeThreadCall && - CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) - { - // Not the initial graphics full power, graphics won't - // send a power notification to trigger a lid state - // evaluation. - - AbsoluteTime deadline; - clock_interval_to_deadline(45, kSecondScale, &deadline); - thread_call_enter_delayed(fullWakeThreadCall, deadline); - } -#endif - } - else if (CAP_GAIN(kIOPMSystemCapabilityCPU)) - darkWakeCnt++; +IOReturn +IOPMrootDomain::systemPowerEventOccurred( + const OSSymbol *event, + uint32_t intValue) +{ + IOReturn attempt = kIOReturnSuccess; + OSNumber *newNumber = NULL; + + if (!event) { + return kIOReturnBadArgument; + } + + newNumber = OSNumber::withNumber(intValue, 8 * sizeof(intValue)); + if (!newNumber) { + return kIOReturnInternalError; + } + + attempt = systemPowerEventOccurred(event, (OSObject *)newNumber); + + newNumber->release(); - // Update current system capability. - if (_currentCapability != _pendingCapability) - _currentCapability = _pendingCapability; + return attempt; +} + +void +IOPMrootDomain::setThermalState(OSObject *value) +{ + OSNumber * num; - // Update highest system capability. + if (gIOPMWorkLoop->inGate() == false) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::setThermalState), + (OSObject *)this, + (void *)value); - _highestCapability |= _currentCapability; + return; + } + if (value && (num = OSDynamicCast(OSNumber, value))) { + thermalWarningState = ((num->unsigned32BitValue() == kIOPMThermalLevelWarning) || + (num->unsigned32BitValue() == kIOPMThermalLevelTrap)) ? 1 : 0; + } +} - if (darkWakePostTickle && - (kSystemTransitionWake == _systemTransitionType) && - (gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == - kDarkWakeFlagHIDTickleLate) - { - darkWakePostTickle = false; - reportUserInput(); - } +IOReturn +IOPMrootDomain::systemPowerEventOccurred( + const OSSymbol *event, + OSObject *value) +{ + OSDictionary *thermalsDict = NULL; + bool shouldUpdate = true; - // Reset tracepoint at completion of capability change, - // completion of wake transition, and aborted sleep transition. + if (!event || !value) { + return kIOReturnBadArgument; + } - if ((_systemTransitionType == kSystemTransitionCapability) || - (_systemTransitionType == kSystemTransitionWake) || - ((_systemTransitionType == kSystemTransitionSleep) && - (changeFlags & kIOPMNotDone))) - { - setProperty(kIOPMSystemCapabilitiesKey, _currentCapability, 64); - tracePoint( kIOPMTracePointSystemUp, 0 ); - } + // LOCK + // We reuse featuresDict Lock because it already exists and guards + // the very infrequently used publish/remove feature mechanism; so there's zero rsk + // of stepping on that lock. + if (featuresDictLock) { + IOLockLock(featuresDictLock); + } - _systemTransitionType = kSystemTransitionNone; - _systemMessageClientMask = 0; + thermalsDict = (OSDictionary *)getProperty(kIOPMRootDomainPowerStatusKey); - logGraphicsClamp = false; - } -} + if (thermalsDict && OSDynamicCast(OSDictionary, thermalsDict)) { + thermalsDict = OSDictionary::withDictionary(thermalsDict); + } else { + thermalsDict = OSDictionary::withCapacity(1); + } -//****************************************************************************** -// PM actions for graphics and audio. -//****************************************************************************** + if (!thermalsDict) { + shouldUpdate = false; + goto exit; + } -void IOPMrootDomain::overridePowerChangeForUIService( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex * inOutPowerState, - IOPMPowerChangeFlags * inOutChangeFlags ) -{ - uint32_t powerState = (uint32_t) *inOutPowerState; - uint32_t changeFlags = (uint32_t) *inOutChangeFlags; - - if (kSystemTransitionNone == _systemTransitionType) - { - // Not in midst of a system transition. - // Do not modify power limit enable state. - } - else if ((actions->parameter & kPMActionsFlagLimitPower) == 0) - { - // Activate power limiter. - - if ((actions->parameter & kPMActionsFlagIsDisplayWrangler) && - ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) && - (changeFlags & kIOPMSynchronize)) - { - actions->parameter |= kPMActionsFlagLimitPower; - } - else if ((actions->parameter & kPMActionsFlagIsAudioDevice) && - ((gDarkWakeFlags & kDarkWakeFlagAudioNotSuppressed) == 0) && - ((_pendingCapability & kIOPMSystemCapabilityAudio) == 0) && - (changeFlags & kIOPMSynchronize)) - { - actions->parameter |= kPMActionsFlagLimitPower; - } - else if ((actions->parameter & kPMActionsFlagIsGraphicsDevice) && - (_systemTransitionType == kSystemTransitionSleep)) - { - // For graphics devices, arm the limiter when entering - // system sleep. Not when dropping to dark wake. - actions->parameter |= kPMActionsFlagLimitPower; - } - - if (actions->parameter & kPMActionsFlagLimitPower) - { - DLOG("+ plimit %s %p\n", - service->getName(), OBFUSCATE(service)); - } - } - else - { - // Remove power limit. - - if ((actions->parameter & ( - kPMActionsFlagIsDisplayWrangler | - kPMActionsFlagIsGraphicsDevice )) && - (_pendingCapability & kIOPMSystemCapabilityGraphics)) - { - actions->parameter &= ~kPMActionsFlagLimitPower; - } - else if ((actions->parameter & kPMActionsFlagIsAudioDevice) && - (_pendingCapability & kIOPMSystemCapabilityAudio)) - { - actions->parameter &= ~kPMActionsFlagLimitPower; - } - - if ((actions->parameter & kPMActionsFlagLimitPower) == 0) - { - DLOG("- plimit %s %p\n", - service->getName(), OBFUSCATE(service)); - } - } - - if (actions->parameter & kPMActionsFlagLimitPower) - { - uint32_t maxPowerState = (uint32_t)(-1); - - if (changeFlags & (kIOPMDomainDidChange | kIOPMDomainWillChange)) - { - // Enforce limit for system power/cap transitions. - - maxPowerState = 0; - if ((service->getPowerState() > maxPowerState) && - (actions->parameter & kPMActionsFlagIsDisplayWrangler)) - { - maxPowerState++; - - // Remove lingering effects of any tickle before entering - // dark wake. It will take a new tickle to return to full - // wake, so the existing tickle state is useless. - - if (changeFlags & kIOPMDomainDidChange) - *inOutChangeFlags |= kIOPMExpireIdleTimer; - } - else if (actions->parameter & kPMActionsFlagIsGraphicsDevice) - { - maxPowerState++; - } - } - else - { - // Deny all self-initiated changes when power is limited. - // Wrangler tickle should never defeat the limiter. - - maxPowerState = service->getPowerState(); - } - - if (powerState > maxPowerState) - { - DLOG("> plimit %s %p (%u->%u, 0x%x)\n", - service->getName(), OBFUSCATE(service), powerState, maxPowerState, - changeFlags); - *inOutPowerState = maxPowerState; - - if (darkWakePostTickle && - (actions->parameter & kPMActionsFlagIsDisplayWrangler) && - (changeFlags & kIOPMDomainWillChange) && - ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) == - kDarkWakeFlagHIDTickleEarly)) - { - darkWakePostTickle = false; - reportUserInput(); - } - } - - if (!graphicsSuppressed && (changeFlags & kIOPMDomainDidChange)) - { - if (logGraphicsClamp) - { - AbsoluteTime now; - uint64_t nsec; - - clock_get_uptime(&now); - SUB_ABSOLUTETIME(&now, &systemWakeTime); - absolutetime_to_nanoseconds(now, &nsec); - if (kIOLogPMRootDomain & gIOKitDebug) - MSG("Graphics suppressed %u ms\n", - ((int)((nsec) / 1000000ULL))); - } - graphicsSuppressed = true; - } - } -} - -void IOPMrootDomain::handleActivityTickleForDisplayWrangler( - IOService * service, - IOPMActions * actions ) -{ - // Warning: Not running in PM work loop context - don't modify state !!! - // Trap tickle directed to IODisplayWrangler while running with graphics - // capability suppressed. - - assert(service == wrangler); - - clock_get_uptime(&userActivityTime); - bool aborting = ((lastSleepReason == kIOPMSleepReasonIdle) - || (lastSleepReason == kIOPMSleepReasonMaintenance)); - if (aborting) { - userActivityCount++; - DLOG("display wrangler tickled1 %d lastSleepReason %d\n", - userActivityCount, lastSleepReason); - } - - if (!wranglerTickled && - ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0)) - { - setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeHIDActivity); - DLOG("display wrangler tickled\n"); - if (kIOLogPMRootDomain & gIOKitDebug) - OSReportWithBacktrace("Dark wake display tickle"); - if (pmPowerStateQueue) - { - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusDarkWakeActivityTickle ); - } - } -} - -void IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler( - IOService * service, - IOPMActions * actions, - const OSSymbol * powerClient, - IOPMPowerStateIndex oldPowerState, - IOPMPowerStateIndex newPowerState ) -{ - assert(service == wrangler); - - // This function implements half of the user activity detection. - // User is active if: - // 1. DeviceDesire increases to max, - // and wrangler already in max power state - // (no power state change, caught by this routine) - // - // 2. Power change to max, and DeviceDesire is at max. - // (wrangler must reset DeviceDesire before system sleep) - // - // User is inactive if: - // 1. DeviceDesire drops to sleep state or below - - DLOG("wrangler %s (%u, %u->%u)\n", - powerClient->getCStringNoCopy(), - (uint32_t) service->getPowerState(), - (uint32_t) oldPowerState, (uint32_t) newPowerState); - - if (powerClient == gIOPMPowerClientDevice) - { - if ((newPowerState > oldPowerState) && - (newPowerState == kWranglerPowerStateMax) && - (service->getPowerState() == kWranglerPowerStateMax)) - { - evaluatePolicy( kStimulusUserIsActive ); - } - else - if ((newPowerState < oldPowerState) && - (newPowerState <= kWranglerPowerStateSleep)) - { - evaluatePolicy( kStimulusUserIsInactive ); - } - } -} + thermalsDict->setObject(event, value); -//****************************************************************************** -// Approve usage of delayed child notification by PM. -//****************************************************************************** + setProperty(kIOPMRootDomainPowerStatusKey, thermalsDict); -bool IOPMrootDomain::shouldDelayChildNotification( - IOService * service ) -{ - if (((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) != 0) && - (kFullWakeReasonNone == fullWakeReason) && - (kSystemTransitionWake == _systemTransitionType)) - { - DLOG("%s: delay child notify\n", service->getName()); - return true; - } - return false; -} + thermalsDict->release(); -//****************************************************************************** -// PM actions for PCI device. -//****************************************************************************** +exit: + // UNLOCK + if (featuresDictLock) { + IOLockUnlock(featuresDictLock); + } -void IOPMrootDomain::handlePowerChangeStartForPCIDevice( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex powerState, - IOPMPowerChangeFlags * inOutChangeFlags ) -{ - pmTracer->tracePCIPowerChange( - PMTraceWorker::kPowerChangeStart, - service, *inOutChangeFlags, - (actions->parameter & kPMActionsPCIBitNumberMask)); -} + if (shouldUpdate) { + if (event && + event->isEqualTo(kIOPMThermalLevelWarningKey)) { + setThermalState(value); + } + messageClients(kIOPMMessageSystemPowerEventOccurred, (void *)NULL); + } -void IOPMrootDomain::handlePowerChangeDoneForPCIDevice( - IOService * service, - IOPMActions * actions, - IOPMPowerStateIndex powerState, - IOPMPowerChangeFlags changeFlags ) -{ - pmTracer->tracePCIPowerChange( - PMTraceWorker::kPowerChangeCompleted, - service, changeFlags, - (actions->parameter & kPMActionsPCIBitNumberMask)); + return kIOReturnSuccess; } //****************************************************************************** -// registerInterest +// receivePowerNotification // -// Override IOService::registerInterest() to intercept special clients. +// The power controller is notifying us of a hardware-related power management +// event that we must handle. This may be a result of an 'environment' interrupt +// from the power mgt micro. //****************************************************************************** -IONotifier * IOPMrootDomain::registerInterest( - const OSSymbol * typeOfInterest, - IOServiceInterestHandler handler, - void * target, void * ref ) +IOReturn +IOPMrootDomain::receivePowerNotification( UInt32 msg ) { - IONotifier * notifier; - bool isSystemCapabilityClient; - bool isKernelCapabilityClient; - - isSystemCapabilityClient = - typeOfInterest && - typeOfInterest->isEqualTo(kIOPMSystemCapabilityInterest); + if (msg & kIOPMPowerButton) { + uint32_t currentPhase = pmTracer->getTracePhase(); + if (currentPhase != kIOPMTracePointSystemUp && currentPhase > kIOPMTracePointSystemSleep) { + DEBUG_LOG("power button pressed during wake. phase = %u\n", currentPhase); + swd_flags |= SWD_PWR_BTN_STACKSHOT; + thread_call_enter(powerButtonDown); + } else { + DEBUG_LOG("power button pressed when system is up\n"); + } + } else if (msg & kIOPMPowerButtonUp) { + if (swd_flags & SWD_PWR_BTN_STACKSHOT) { + swd_flags &= ~SWD_PWR_BTN_STACKSHOT; + thread_call_enter(powerButtonUp); + } + } else { + pmPowerStateQueue->submitPowerEvent( + kPowerEventReceivedPowerNotification, (void *)(uintptr_t) msg ); + } + return kIOReturnSuccess; +} - isKernelCapabilityClient = - typeOfInterest && - typeOfInterest->isEqualTo(gIOPriorityPowerStateInterest); +void +IOPMrootDomain::handlePowerNotification( UInt32 msg ) +{ + bool eval_clamshell = false; + bool eval_clamshell_alarm = false; - if (isSystemCapabilityClient) - typeOfInterest = gIOAppPowerStateInterest; + ASSERT_GATED(); - notifier = super::registerInterest(typeOfInterest, handler, target, ref); - if (notifier && pmPowerStateQueue) - { - if (isSystemCapabilityClient) - { - notifier->retain(); - if (pmPowerStateQueue->submitPowerEvent( - kPowerEventRegisterSystemCapabilityClient, notifier) == false) - notifier->release(); - } + /* + * Local (IOPMrootDomain only) eval clamshell command + */ + if (msg & kLocalEvalClamshellCommand) { + if (isRTCAlarmWake) { + eval_clamshell_alarm = true; - if (isKernelCapabilityClient) - { - notifier->retain(); - if (pmPowerStateQueue->submitPowerEvent( - kPowerEventRegisterKernelCapabilityClient, notifier) == false) - notifier->release(); - } - } + // reset isRTCAlarmWake. This evaluation should happen only once + // on RTC/Alarm wake. Any clamshell events after wake should follow + // the regular evaluation + isRTCAlarmWake = false; + } else { + eval_clamshell = true; + } + } - return notifier; -} + /* + * Overtemp + */ + if (msg & kIOPMOverTemp) { + MSG("PowerManagement emergency overtemp signal. Going to sleep!"); + privateSleepSystem(kIOPMSleepReasonThermalEmergency); + } -//****************************************************************************** -// systemMessageFilter -// -//****************************************************************************** + /* + * Forward DW thermal notification to client, if system is not going to sleep + */ + if ((msg & kIOPMDWOverTemp) && (_systemTransitionType != kSystemTransitionSleep)) { + DLOG("DarkWake thermal limits message received!\n"); -bool IOPMrootDomain::systemMessageFilter( - void * object, void * arg1, void * arg2, void * arg3 ) -{ - const IOPMInterestContext * context = (const IOPMInterestContext *) arg1; - bool isCapMsg = (context->messageType == kIOMessageSystemCapabilityChange); - bool isCapClient = false; - bool allow = false; - - do { - if ((kSystemTransitionNewCapClient == _systemTransitionType) && - (!isCapMsg || !_joinedCapabilityClients || - !_joinedCapabilityClients->containsObject((OSObject *) object))) - break; - - // Capability change message for app and kernel clients. - - if (isCapMsg) - { - if ((context->notifyType == kNotifyPriority) || - (context->notifyType == kNotifyCapabilityChangePriority)) - isCapClient = true; - - if ((context->notifyType == kNotifyCapabilityChangeApps) && - (object == (void *) systemCapabilityNotifier)) - isCapClient = true; - } - - if (isCapClient) - { - IOPMSystemCapabilityChangeParameters * capArgs = - (IOPMSystemCapabilityChangeParameters *) arg2; - - if (kSystemTransitionNewCapClient == _systemTransitionType) - { - capArgs->fromCapabilities = 0; - capArgs->toCapabilities = _currentCapability; - capArgs->changeFlags = 0; - } - else - { - capArgs->fromCapabilities = _currentCapability; - capArgs->toCapabilities = _pendingCapability; - - if (context->isPreChange) - capArgs->changeFlags = kIOPMSystemCapabilityWillChange; - else - capArgs->changeFlags = kIOPMSystemCapabilityDidChange; - } - - // Capability change messages only go to the PM configd plugin. - // Wait for response post-change if capabilitiy is increasing. - // Wait for response pre-change if capability is decreasing. - - if ((context->notifyType == kNotifyCapabilityChangeApps) && arg3 && - ( (capabilityLoss && context->isPreChange) || - (!capabilityLoss && !context->isPreChange) ) ) - { - // app has not replied yet, wait for it - *((OSObject **) arg3) = kOSBooleanFalse; - } - - allow = true; - break; - } - - // Capability client will always see kIOMessageCanSystemSleep, - // even for demand sleep. It will also have a chance to veto - // sleep one last time after all clients have responded to - // kIOMessageSystemWillSleep - - if ((kIOMessageCanSystemSleep == context->messageType) || - (kIOMessageSystemWillNotSleep == context->messageType)) - { - if (object == (OSObject *) systemCapabilityNotifier) - { - allow = true; - break; - } - - // Not idle sleep, don't ask apps. - if (context->changeFlags & kIOPMSkipAskPowerDown) - { - break; - } - } - - if (kIOPMMessageLastCallBeforeSleep == context->messageType) - { - if ((object == (OSObject *) systemCapabilityNotifier) && - CAP_HIGHEST(kIOPMSystemCapabilityGraphics) && - (fullToDarkReason == kIOPMSleepReasonIdle)) - allow = true; - break; - } - - // Reject capability change messages for legacy clients. - // Reject legacy system sleep messages for capability client. - - if (isCapMsg || (object == (OSObject *) systemCapabilityNotifier)) - { - break; - } - - // Filter system sleep messages. - - if ((context->notifyType == kNotifyApps) && - (_systemMessageClientMask & kSystemMessageClientLegacyApp)) - { - allow = true; - } - else if ((context->notifyType == kNotifyPriority) && - (_systemMessageClientMask & kSystemMessageClientKernel)) - { - allow = true; - } - } - while (false); - - if (allow && isCapMsg && _joinedCapabilityClients) - { - _joinedCapabilityClients->removeObject((OSObject *) object); - if (_joinedCapabilityClients->getCount() == 0) - { - DLOG("destroyed capability client set %p\n", - _joinedCapabilityClients); - _joinedCapabilityClients->release(); - _joinedCapabilityClients = 0; - } - } - - return allow; -} + messageClients(kIOPMMessageDarkWakeThermalEmergency); + } -//****************************************************************************** -// setMaintenanceWakeCalendar -// -//****************************************************************************** + /* + * Sleep Now! + */ + if (msg & kIOPMSleepNow) { + privateSleepSystem(kIOPMSleepReasonSoftware); + } -IOReturn IOPMrootDomain::setMaintenanceWakeCalendar( - const IOPMCalendarStruct * calendar ) -{ - OSData * data; - IOReturn ret = 0; - - if (!calendar) - return kIOReturnBadArgument; - - data = OSData::withBytesNoCopy((void *) calendar, sizeof(*calendar)); - if (!data) - return kIOReturnNoMemory; - - if (kPMCalendarTypeMaintenance == calendar->selector) { - ret = setPMSetting(gIOPMSettingMaintenanceWakeCalendarKey, data); - if (kIOReturnSuccess == ret) - OSBitOrAtomic(kIOPMAlarmBitMaintenanceWake, &_scheduledAlarms); - } else - if (kPMCalendarTypeSleepService == calendar->selector) - { - ret = setPMSetting(gIOPMSettingSleepServiceWakeCalendarKey, data); - if (kIOReturnSuccess == ret) - OSBitOrAtomic(kIOPMAlarmBitSleepServiceWake, &_scheduledAlarms); - } - DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms); - - data->release(); - return ret; -} + /* + * Power Emergency + */ + if (msg & kIOPMPowerEmergency) { + lowBatteryCondition = true; + privateSleepSystem(kIOPMSleepReasonLowPower); + } -// MARK: - -// MARK: Display Wrangler + /* + * Clamshell OPEN + */ + if (msg & kIOPMClamshellOpened) { + DLOG("Clamshell opened\n"); + // Received clamshel open message from clamshell controlling driver + // Update our internal state and tell general interest clients + clamshellClosed = false; + clamshellExists = true; + + // Don't issue a hid tickle when lid is open and polled on wake + if (msg & kIOPMSetValue) { + setProperty(kIOPMRootDomainWakeTypeKey, "Lid Open"); + reportUserInput(); + } -//****************************************************************************** -// displayWranglerNotification -// -// Handle the notification when the IODisplayWrangler changes power state. -//****************************************************************************** + // Tell PMCPU + informCPUStateChange(kInformLid, 0); -IOReturn IOPMrootDomain::displayWranglerNotification( - void * target, void * refCon, - UInt32 messageType, IOService * service, - void * messageArgument, vm_size_t argSize ) -{ -#if !NO_KERNEL_HID - int displayPowerState; - IOPowerStateChangeNotification * params = - (IOPowerStateChangeNotification *) messageArgument; - - if ((messageType != kIOMessageDeviceWillPowerOff) && - (messageType != kIOMessageDeviceHasPoweredOn)) - return kIOReturnUnsupported; - - ASSERT_GATED(); - if (!gRootDomain) - return kIOReturnUnsupported; - - displayPowerState = params->stateNumber; - DLOG("DisplayWrangler message 0x%x, power state %d\n", - (uint32_t) messageType, displayPowerState); - - switch (messageType) { - case kIOMessageDeviceWillPowerOff: - // Display wrangler has dropped power due to display idle - // or force system sleep. - // - // 4 Display ON kWranglerPowerStateMax - // 3 Display Dim kWranglerPowerStateDim - // 2 Display Sleep kWranglerPowerStateSleep - // 1 Not visible to user - // 0 Not visible to user kWranglerPowerStateMin - - if (displayPowerState <= kWranglerPowerStateSleep) - gRootDomain->evaluatePolicy( kStimulusDisplayWranglerSleep ); - break; - - case kIOMessageDeviceHasPoweredOn: - // Display wrangler has powered on due to user activity - // or wake from sleep. - - if (kWranglerPowerStateMax == displayPowerState) - { - gRootDomain->evaluatePolicy( kStimulusDisplayWranglerWake ); - - // See comment in handleUpdatePowerClientForDisplayWrangler - if (service->getPowerStateForClient(gIOPMPowerClientDevice) == - kWranglerPowerStateMax) - { - gRootDomain->evaluatePolicy( kStimulusUserIsActive ); - } - } - break; - } -#endif - return kIOReturnUnsupported; -} + // Tell general interest clients + sendClientClamshellNotification(); -//****************************************************************************** -// displayWranglerMatchPublished -// -// Receives a notification when the IODisplayWrangler is published. -// When it's published we install a power state change handler. -//****************************************************************************** + bool aborting = ((lastSleepReason == kIOPMSleepReasonClamshell) + || (lastSleepReason == kIOPMSleepReasonIdle) + || (lastSleepReason == kIOPMSleepReasonMaintenance)); + if (aborting) { + userActivityCount++; + } + DLOG("clamshell tickled %d lastSleepReason %d\n", userActivityCount, lastSleepReason); + } -bool IOPMrootDomain::displayWranglerMatchPublished( - void * target, - void * refCon, - IOService * newService, - IONotifier * notifier __unused) -{ -#if !NO_KERNEL_HID - // found the display wrangler, now install a handler - if( !newService->registerInterest( gIOGeneralInterest, - &displayWranglerNotification, target, 0) ) - { - return false; - } -#endif - return true; -} + /* + * Clamshell CLOSED + * Send the clamshell interest notification since the lid is closing. + */ + if (msg & kIOPMClamshellClosed) { + if (clamshellClosed && clamshellExists) { + DLOG("Ignoring redundant Clamshell close event\n"); + } else { + DLOG("Clamshell closed\n"); + // Received clamshel open message from clamshell controlling driver + // Update our internal state and tell general interest clients + clamshellClosed = true; + clamshellExists = true; + + // Tell PMCPU + informCPUStateChange(kInformLid, 1); + + // Tell general interest clients + sendClientClamshellNotification(); + + // And set eval_clamshell = so we can attempt + eval_clamshell = true; + } + } -#if defined(__i386__) || defined(__x86_64__) + /* + * Set Desktop mode (sent from graphics) + * + * -> reevaluate lid state + */ + if (msg & kIOPMSetDesktopMode) { + DLOG("Desktop mode\n"); + desktopMode = (0 != (msg & kIOPMSetValue)); + msg &= ~(kIOPMSetDesktopMode | kIOPMSetValue); -bool IOPMrootDomain::IONVRAMMatchPublished( - void * target, - void * refCon, - IOService * newService, - IONotifier * notifier) -{ - unsigned int len = 0; - IOPMrootDomain *rd = (IOPMrootDomain *)target; + sendClientClamshellNotification(); - if (PEReadNVRAMProperty(kIOSleepWakeDebugKey, NULL, &len)) - { - rd->swd_flags |= SWD_BOOT_BY_WDOG; - MSG("System was rebooted due to Sleep/Wake failure\n"); + // Re-evaluate the lid state + eval_clamshell = true; + } - if ( (rd->swd_logBufMap = rd->sleepWakeDebugRetrieve()) != NULL) { - rd->swd_flags |= SWD_VALID_LOGS; - } - } - if (notifier) notifier->remove(); - return true; -} + /* + * AC Adaptor connected + * + * -> reevaluate lid state + */ + if (msg & kIOPMSetACAdaptorConnected) { + acAdaptorConnected = (0 != (msg & kIOPMSetValue)); + msg &= ~(kIOPMSetACAdaptorConnected | kIOPMSetValue); -#else -bool IOPMrootDomain::IONVRAMMatchPublished( - void * target, - void * refCon, - IOService * newService, - IONotifier * notifier __unused) -{ - return false; -} + // Tell CPU PM + informCPUStateChange(kInformAC, !acAdaptorConnected); -#endif + // Tell BSD if AC is connected + // 0 == external power source; 1 == on battery + post_sys_powersource(acAdaptorConnected ? 0:1); -//****************************************************************************** -// reportUserInput -// -//****************************************************************************** + sendClientClamshellNotification(); -void IOPMrootDomain::reportUserInput( void ) -{ -#if !NO_KERNEL_HID - OSIterator * iter; - - if(!wrangler) - { - iter = getMatchingServices(serviceMatching("IODisplayWrangler")); - if(iter) - { - wrangler = (IOService *) iter->getNextObject(); - iter->release(); - } - } - - if(wrangler) - wrangler->activityTickle(0,0); -#endif -} + // Re-evaluate the lid state + eval_clamshell = true; -//****************************************************************************** -// latchDisplayWranglerTickle -//****************************************************************************** + // Lack of AC may have latched a display wrangler tickle. + // This mirrors the hardware's USB wake event latch, where a latched + // USB wake event followed by an AC attach will trigger a full wake. + latchDisplayWranglerTickle( false ); -bool IOPMrootDomain::latchDisplayWranglerTickle( bool latch ) -{ -#if !NO_KERNEL_HID - if (latch) - { - // Not too late to prevent the display from lighting up - if (!(_currentCapability & kIOPMSystemCapabilityGraphics) && - !(_pendingCapability & kIOPMSystemCapabilityGraphics) && - !checkSystemCanSustainFullWake()) - { - wranglerTickleLatched = true; - } - else - { - wranglerTickleLatched = false; - } - } - else if (wranglerTickleLatched && checkSystemCanSustainFullWake()) - { - wranglerTickleLatched = false; - - pmPowerStateQueue->submitPowerEvent( - kPowerEventPolicyStimulus, - (void *) kStimulusDarkWakeActivityTickle ); - } - - return wranglerTickleLatched; -#else - return false; +#if HIBERNATION + // AC presence will reset the standy timer delay adjustment. + _standbyTimerResetSeconds = 0; #endif -} + if (!userIsActive) { + // Reset userActivityTime when power supply is changed(rdr 13789330) + clock_get_uptime(&userActivityTime); + } + } -//****************************************************************************** -// setDisplayPowerOn -// -// For root domain user client -//****************************************************************************** + /* + * Enable Clamshell (external display disappear) + * + * -> reevaluate lid state + */ + if (msg & kIOPMEnableClamshell) { + DLOG("Clamshell enabled\n"); + // Re-evaluate the lid state + // System should sleep on external display disappearance + // in lid closed operation. + if (true == clamshellDisabled) { + eval_clamshell = true; + } -void IOPMrootDomain::setDisplayPowerOn( uint32_t options ) -{ - if (checkSystemCanSustainFullWake()) - { - pmPowerStateQueue->submitPowerEvent( kPowerEventSetDisplayPowerOn, - (void *) 0, options ); - } -} + clamshellDisabled = false; + sendClientClamshellNotification(); + } -// MARK: - -// MARK: Battery + /* + * Disable Clamshell (external display appeared) + * We don't bother re-evaluating clamshell state. If the system is awake, + * the lid is probably open. + */ + if (msg & kIOPMDisableClamshell) { + DLOG("Clamshell disabled\n"); + clamshellDisabled = true; + sendClientClamshellNotification(); + } -//****************************************************************************** -// batteryPublished -// -// Notification on battery class IOPowerSource appearance -//****************************************************************************** + /* + * Evaluate clamshell and SLEEP if appropiate + */ + if (eval_clamshell_alarm && clamshellClosed) { + if (shouldSleepOnRTCAlarmWake()) { + privateSleepSystem(kIOPMSleepReasonClamshell); + } + } else if (eval_clamshell && clamshellClosed) { + if (shouldSleepOnClamshellClosed()) { + privateSleepSystem(kIOPMSleepReasonClamshell); + } else { + evaluatePolicy( kStimulusDarkWakeEvaluate ); + } + } -bool IOPMrootDomain::batteryPublished( - void * target, - void * root_domain, - IOService * resourceService, - IONotifier * notifier __unused ) -{ - // rdar://2936060&4435589 - // All laptops have dimmable LCD displays - // All laptops have batteries - // So if this machine has a battery, publish the fact that the backlight - // supports dimming. - ((IOPMrootDomain *)root_domain)->publishFeature("DisplayDims"); + if (msg & kIOPMProModeEngaged) { + int newState = 1; + DLOG("ProModeEngaged\n"); + messageClient(kIOPMMessageProModeStateChange, systemCapabilityNotifier, &newState, sizeof(newState)); + } - return (true); + if (msg & kIOPMProModeDisengaged) { + int newState = 0; + DLOG("ProModeDisengaged\n"); + messageClient(kIOPMMessageProModeStateChange, systemCapabilityNotifier, &newState, sizeof(newState)); + } } -// MARK: - -// MARK: System PM Policy - //****************************************************************************** -// checkSystemSleepAllowed +// evaluatePolicy // +// Evaluate root-domain policy in response to external changes. //****************************************************************************** -bool IOPMrootDomain::checkSystemSleepAllowed( IOOptionBits options, - uint32_t sleepReason ) -{ - int err = 0; - - // Conditions that prevent idle and demand system sleep. +void +IOPMrootDomain::evaluatePolicy( int stimulus, uint32_t arg ) +{ + union { + struct { + int idleSleepEnabled : 1; + int idleSleepDisabled : 1; + int displaySleep : 1; + int sleepDelayChanged : 1; + int evaluateDarkWake : 1; + int adjustPowerState : 1; + int userBecameInactive : 1; + } bit; + uint32_t u32; + } flags; + + + ASSERT_GATED(); + flags.u32 = 0; + + switch (stimulus) { + case kStimulusDisplayWranglerSleep: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + if (!wranglerAsleep) { + // first transition to wrangler sleep or lower + flags.bit.displaySleep = true; + } + break; + + case kStimulusDisplayWranglerWake: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + displayIdleForDemandSleep = false; + wranglerAsleep = false; + break; + + case kStimulusEnterUserActiveState: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + if (_preventUserActive) { + DLOG("user active dropped\n"); + break; + } + if (!userIsActive) { + userIsActive = true; + userWasActive = true; + clock_get_uptime(&gUserActiveAbsTime); + + // Stay awake after dropping demand for display power on + if (kFullWakeReasonDisplayOn == fullWakeReason) { + fullWakeReason = fFullWakeReasonDisplayOnAndLocalUser; + DLOG("User activity while in notification wake\n"); + changePowerStateWithOverrideTo( getRUN_STATE(), 0); + } - do { - if (userDisabledAllSleep) - { - err = 1; // 1. user-space sleep kill switch - break; - } + kdebugTrace(kPMLogUserActiveState, 0, 1, 0); + setProperty(gIOPMUserIsActiveKey, kOSBooleanTrue); + messageClients(kIOPMMessageUserIsActiveChanged); + } + flags.bit.idleSleepDisabled = true; + break; + + case kStimulusLeaveUserActiveState: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + if (userIsActive) { + clock_get_uptime(&gUserInactiveAbsTime); + userIsActive = false; + clock_get_uptime(&userBecameInactiveTime); + flags.bit.userBecameInactive = true; + + kdebugTrace(kPMLogUserActiveState, 0, 0, 0); + setProperty(gIOPMUserIsActiveKey, kOSBooleanFalse); + messageClients(kIOPMMessageUserIsActiveChanged); + } + break; - if (systemBooting || systemShutdown || gWillShutdown) - { - err = 2; // 2. restart or shutdown in progress - break; - } + case kStimulusAggressivenessChanged: + { + DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + unsigned long minutesToIdleSleep = 0; + unsigned long minutesToDisplayDim = 0; + unsigned long minutesDelta = 0; + + // Fetch latest display and system sleep slider values. + getAggressiveness(kPMMinutesToSleep, &minutesToIdleSleep); + getAggressiveness(kPMMinutesToDim, &minutesToDisplayDim); + DLOG("aggressiveness changed: system %u->%u, display %u\n", + (uint32_t) sleepSlider, + (uint32_t) minutesToIdleSleep, + (uint32_t) minutesToDisplayDim); + + DLOG("idle time -> %ld secs (ena %d)\n", + idleSeconds, (minutesToIdleSleep != 0)); + + + // How long to wait before sleeping the system once + // the displays turns off is indicated by 'extraSleepDelay'. + + if (minutesToIdleSleep > minutesToDisplayDim) { + minutesDelta = minutesToIdleSleep - minutesToDisplayDim; + } else if (minutesToIdleSleep == minutesToDisplayDim) { + minutesDelta = 1; + } - if (options == 0) - break; + if ((!idleSleepEnabled) && (minutesToIdleSleep != 0)) { + idleSleepEnabled = flags.bit.idleSleepEnabled = true; + } - // Conditions above pegs the system at full wake. - // Conditions below prevent system sleep but does not prevent - // dark wake, and must be called from gated context. + if ((idleSleepEnabled) && (minutesToIdleSleep == 0)) { + flags.bit.idleSleepDisabled = true; + idleSleepEnabled = false; + } + if (0x7fffffff == minutesToIdleSleep) { + minutesToIdleSleep = idleSeconds; + } -#if !CONFIG_SLEEP - err = 3; // 3. config does not support sleep - break; -#endif + if (((minutesDelta != extraSleepDelay) || + (userActivityTime != userActivityTime_prev)) && + !flags.bit.idleSleepEnabled && !flags.bit.idleSleepDisabled) { + flags.bit.sleepDelayChanged = true; + } - if (lowBatteryCondition) - { - break; // always sleep on low battery - } - - if (sleepReason == kIOPMSleepReasonDarkWakeThermalEmergency) - { - break; // always sleep on dark wake thermal emergencies - } - - if (preventSystemSleepList->getCount() != 0) - { - err = 4; // 4. child prevent system sleep clamp - break; - } - - if (getPMAssertionLevel( kIOPMDriverAssertionCPUBit ) == - kIOPMDriverAssertionLevelOn) - { - err = 5; // 5. CPU assertion - break; - } - - if (pciCantSleepValid) - { - if (pciCantSleepFlag) - err = 6; // 6. PCI card does not support PM (cached) - break; - } - else if (sleepSupportedPEFunction && - CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) - { - IOReturn ret; - OSBitAndAtomic(~kPCICantSleep, &platformSleepSupport); - ret = getPlatform()->callPlatformFunction( - sleepSupportedPEFunction, false, - NULL, NULL, NULL, NULL); - pciCantSleepValid = true; - pciCantSleepFlag = false; - if ((platformSleepSupport & kPCICantSleep) || - ((ret != kIOReturnSuccess) && (ret != kIOReturnUnsupported))) - { - err = 6; // 6. PCI card does not support PM - pciCantSleepFlag = true; - break; - } - } - } - while (false); - - if (err) - { - DLOG("System sleep prevented by %d\n", err); - return false; - } - return true; -} - -bool IOPMrootDomain::checkSystemSleepEnabled( void ) -{ - return checkSystemSleepAllowed(0, 0); -} - -bool IOPMrootDomain::checkSystemCanSleep( uint32_t sleepReason ) -{ - ASSERT_GATED(); - return checkSystemSleepAllowed(1, sleepReason); -} + if (systemDarkWake && !darkWakeToSleepASAP && + (flags.bit.idleSleepEnabled || flags.bit.idleSleepDisabled)) { + // Reconsider decision to remain in dark wake + flags.bit.evaluateDarkWake = true; + } -//****************************************************************************** -// checkSystemCanSustainFullWake -//****************************************************************************** + sleepSlider = minutesToIdleSleep; + extraSleepDelay = minutesDelta; + userActivityTime_prev = userActivityTime; + } break; + + case kStimulusDemandSystemSleep: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + displayIdleForDemandSleep = true; + if (wrangler && wranglerIdleSettings) { + // Request wrangler idle only when demand sleep is triggered + // from full wake. + if (CAP_CURRENT(kIOPMSystemCapabilityGraphics)) { + wrangler->setProperties(wranglerIdleSettings); + DLOG("Requested wrangler idle\n"); + } + } + // arg = sleepReason + changePowerStateWithOverrideTo( SLEEP_STATE, arg ); + break; + + case kStimulusAllowSystemSleepChanged: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + flags.bit.adjustPowerState = true; + break; + + case kStimulusDarkWakeActivityTickle: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + // arg == true implies real and not self generated wrangler tickle. + // Update wake type on PM work loop instead of the tickle thread to + // eliminate the possibility of an early tickle clobbering the wake + // type set by the platform driver. + if (arg == true) { + setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeHIDActivity); + } -bool IOPMrootDomain::checkSystemCanSustainFullWake( void ) -{ -#if !NO_KERNEL_HID - if (lowBatteryCondition) - { - // Low battery wake, or received a low battery notification - // while system is awake. - return false; - } - - if (clamshellExists && clamshellClosed && !clamshellSleepDisabled) - { - if (!acAdaptorConnected) - { - DLOG("full wake check: no AC\n"); - return false; - } - - if (CAP_CURRENT(kIOPMSystemCapabilityGraphics) && - !desktopMode && !clamshellDisabled) - { - // No external display - DLOG("full wake check: no ext display\n"); - return false; - } - } -#endif - return true; -} + if (false == wranglerTickled) { + if (latchDisplayWranglerTickle(true)) { + DLOG("latched tickle\n"); + break; + } -//****************************************************************************** -// adjustPowerState -// -// Conditions that affect our wake/sleep decision has changed. -// If conditions dictate that the system must remain awake, clamp power -// state to max with changePowerStateToPriv(ON). Otherwise if sleepASAP -// is TRUE, then remove the power clamp and allow the power state to drop -// to SLEEP_STATE. -//****************************************************************************** + wranglerTickled = true; + DLOG("Requesting full wake after dark wake activity tickle\n"); + requestFullWake( kFullWakeReasonLocalUser ); + } + break; -void IOPMrootDomain::adjustPowerState( bool sleepASAP ) -{ - DLOG("adjustPowerState ps %u, asap %d, slider %ld\n", - (uint32_t) getPowerState(), sleepASAP, sleepSlider); + case kStimulusDarkWakeEntry: + case kStimulusDarkWakeReentry: + DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + // Any system transitions since the last dark wake transition + // will invalid the stimulus. - ASSERT_GATED(); + if (arg == _systemStateGeneration) { + DLOG("dark wake entry\n"); + systemDarkWake = true; - if ((sleepSlider == 0) || !checkSystemSleepEnabled()) - { - changePowerStateToPriv(ON_STATE); - } - else if ( sleepASAP ) - { - changePowerStateToPriv(SLEEP_STATE); - } -} + // Keep wranglerAsleep an invariant when wrangler is absent + if (wrangler) { + wranglerAsleep = true; + } -//****************************************************************************** -// dispatchPowerEvent -// -// IOPMPowerStateQueue callback function. Running on PM work loop thread. -//****************************************************************************** + if (kStimulusDarkWakeEntry == stimulus) { + clock_get_uptime(&userBecameInactiveTime); + flags.bit.evaluateDarkWake = true; + if (activitySinceSleep()) { + DLOG("User activity recorded while going to darkwake\n"); + reportUserInput(); + } + } -void IOPMrootDomain::dispatchPowerEvent( - uint32_t event, void * arg0, uint64_t arg1 ) -{ - DLOG("power event %u args %p 0x%llx\n", event, arg0, arg1); - ASSERT_GATED(); - - switch (event) - { - case kPowerEventFeatureChanged: - messageClients(kIOPMMessageFeatureChange, this); - break; - - case kPowerEventReceivedPowerNotification: - handlePowerNotification( (UInt32)(uintptr_t) arg0 ); - break; - - case kPowerEventSystemBootCompleted: - if (systemBooting) - { - systemBooting = false; - - if (lowBatteryCondition) - { - privateSleepSystem (kIOPMSleepReasonLowPower); - - // The rest is unnecessary since the system is expected - // to sleep immediately. The following wake will update - // everything. - break; - } - - if (swd_flags & SWD_VALID_LOGS) { - sleepWakeDebugDump(swd_logBufMap); - swd_logBufMap->release(); - swd_logBufMap = 0; - } - else if (swd_flags & SWD_BOOT_BY_WDOG) { - // If logs are invalid, write the failure code - sleepWakeDebugDump(NULL); - } - // If lid is closed, re-send lid closed notification - // now that booting is complete. - if ( clamshellClosed ) - { - handlePowerNotification(kLocalEvalClamshellCommand); - } - evaluatePolicy( kStimulusAllowSystemSleepChanged ); - - } - break; - - case kPowerEventSystemShutdown: - if (kOSBooleanTrue == (OSBoolean *) arg0) - { - /* We set systemShutdown = true during shutdown - to prevent sleep at unexpected times while loginwindow is trying - to shutdown apps and while the OS is trying to transition to - complete power of. - - Set to true during shutdown, as soon as loginwindow shows - the "shutdown countdown dialog", through individual app - termination, and through black screen kernel shutdown. - */ - systemShutdown = true; - } else { - /* - A shutdown was initiated, but then the shutdown - was cancelled, clearing systemShutdown to false here. - */ - systemShutdown = false; - } - break; - - case kPowerEventUserDisabledSleep: - userDisabledAllSleep = (kOSBooleanTrue == (OSBoolean *) arg0); - break; - - case kPowerEventRegisterSystemCapabilityClient: - if (systemCapabilityNotifier) - { - systemCapabilityNotifier->release(); - systemCapabilityNotifier = 0; - } - if (arg0) - { - systemCapabilityNotifier = (IONotifier *) arg0; - systemCapabilityNotifier->retain(); - } - /* intentional fall-through */ - - case kPowerEventRegisterKernelCapabilityClient: - if (!_joinedCapabilityClients) - _joinedCapabilityClients = OSSet::withCapacity(8); - if (arg0) - { - IONotifier * notify = (IONotifier *) arg0; - if (_joinedCapabilityClients) - { - _joinedCapabilityClients->setObject(notify); - synchronizePowerTree( kIOPMSyncNoChildNotify ); - } - notify->release(); - } - break; - - case kPowerEventPolicyStimulus: - if (arg0) - { - int stimulus = (uintptr_t) arg0; - evaluatePolicy( stimulus, (uint32_t) arg1 ); - } - break; - - case kPowerEventAssertionCreate: - if (pmAssertions) { - pmAssertions->handleCreateAssertion((OSData *)arg0); - } - break; - - - case kPowerEventAssertionRelease: - if (pmAssertions) { - pmAssertions->handleReleaseAssertion(arg1); - } - break; - - case kPowerEventAssertionSetLevel: - if (pmAssertions) { - pmAssertions->handleSetAssertionLevel(arg1, (IOPMDriverAssertionLevel)(uintptr_t)arg0); - } - break; - - case kPowerEventQueueSleepWakeUUID: - handleQueueSleepWakeUUID((OSObject *)arg0); - break; - case kPowerEventPublishSleepWakeUUID: - handlePublishSleepWakeUUID((bool)arg0); - break; - case kPowerEventSuspendClient: - handleSuspendPMNotificationClient((uintptr_t)arg0, (bool)arg1); - break; - - case kPowerEventSetDisplayPowerOn: - if (!wrangler) break; - if (arg1 != 0) - { - // Force wrangler to max power state. If system is in dark wake - // this alone won't raise the wrangler's power state. - - wrangler->changePowerStateForRootDomain(kWranglerPowerStateMax); - - // System in dark wake, always requesting full wake should - // not have any bad side-effects, even if the request fails. - - if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics)) - { - setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeNotification); - requestFullWake( kFullWakeReasonDisplayOn ); - } - } - else - { - // Relenquish desire to power up display. - // Must first transition to state 1 since wrangler doesn't - // power off the displays at state 0. At state 0 the root - // domain is removed from the wrangler's power client list. - - wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin + 1); - wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin); - } - break; - } -} + // Always accelerate disk spindown while in dark wake, + // even if system does not support/allow sleep. -//****************************************************************************** -// systemPowerEventOccurred -// -// The power controller is notifying us of a hardware-related power management -// event that we must handle. -// -// systemPowerEventOccurred covers the same functionality that -// receivePowerNotification does; it simply provides a richer API for conveying -// more information. -//****************************************************************************** + cancelIdleSleepTimer(); + setQuickSpinDownTimeout(); + } + break; -IOReturn IOPMrootDomain::systemPowerEventOccurred( - const OSSymbol *event, - uint32_t intValue) -{ - IOReturn attempt = kIOReturnSuccess; - OSNumber *newNumber = NULL; + case kStimulusDarkWakeEvaluate: + DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + if (systemDarkWake) { + flags.bit.evaluateDarkWake = true; + } + break; + + case kStimulusNoIdleSleepPreventers: + DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); + flags.bit.adjustPowerState = true; + break; + } /* switch(stimulus) */ + + if (flags.bit.evaluateDarkWake && (kFullWakeReasonNone == fullWakeReason)) { + if (darkWakeToSleepASAP || + (clamshellClosed && !(desktopMode && acAdaptorConnected))) { + uint32_t newSleepReason; + + if (CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) { + // System was previously in full wake. Sleep reason from + // full to dark already recorded in fullToDarkReason. + + if (lowBatteryCondition) { + newSleepReason = kIOPMSleepReasonLowPower; + } else { + newSleepReason = fullToDarkReason; + } + } else { + // In dark wake from system sleep. - if (!event) - return kIOReturnBadArgument; - - newNumber = OSNumber::withNumber(intValue, 8*sizeof(intValue)); - if (!newNumber) - return kIOReturnInternalError; + if (darkWakeSleepService) { + newSleepReason = kIOPMSleepReasonSleepServiceExit; + } else { + newSleepReason = kIOPMSleepReasonMaintenance; + } + } - attempt = systemPowerEventOccurred(event, (OSObject *)newNumber); + if (checkSystemCanSleep(newSleepReason)) { + privateSleepSystem(newSleepReason); + } + } else { // non-maintenance (network) dark wake + if (checkSystemCanSleep(kIOPMSleepReasonIdle)) { + // Release power clamp, and wait for children idle. + adjustPowerState(true); + } else { + changePowerStateToPriv(getRUN_STATE()); + } + } + } - newNumber->release(); + if (systemDarkWake) { + // The rest are irrelevant while system is in dark wake. + flags.u32 = 0; + } - return attempt; -} + if ((flags.bit.displaySleep) && + (kFullWakeReasonDisplayOn == fullWakeReason)) { + // kIOPMSleepReasonMaintenance? + DLOG("Display sleep while in notification wake\n"); + changePowerStateWithOverrideTo( SLEEP_STATE, kIOPMSleepReasonMaintenance ); + } -IOReturn IOPMrootDomain::systemPowerEventOccurred( - const OSSymbol *event, - OSObject *value) -{ - OSDictionary *thermalsDict = NULL; - bool shouldUpdate = true; - - if (!event || !value) - return kIOReturnBadArgument; + if (flags.bit.userBecameInactive || flags.bit.sleepDelayChanged) { + bool cancelQuickSpindown = false; - // LOCK - // We reuse featuresDict Lock because it already exists and guards - // the very infrequently used publish/remove feature mechanism; so there's zero rsk - // of stepping on that lock. - if (featuresDictLock) IOLockLock(featuresDictLock); + if (flags.bit.sleepDelayChanged) { + // Cancel existing idle sleep timer and quick disk spindown. + // New settings will be applied by the idleSleepEnabled flag + // handler below if idle sleep is enabled. - thermalsDict = (OSDictionary *)getProperty(kIOPMRootDomainPowerStatusKey); - - if (thermalsDict && OSDynamicCast(OSDictionary, thermalsDict)) { - thermalsDict = OSDictionary::withDictionary(thermalsDict); - } else { - thermalsDict = OSDictionary::withCapacity(1); - } + DLOG("extra sleep timer changed\n"); + cancelIdleSleepTimer(); + cancelQuickSpindown = true; + } else { + DLOG("user inactive\n"); + } - if (!thermalsDict) { - shouldUpdate = false; - goto exit; - } + if (!userIsActive && idleSleepEnabled) { + startIdleSleepTimer(getTimeToIdleSleep()); + } - thermalsDict->setObject (event, value); + if (cancelQuickSpindown) { + restoreUserSpinDownTimeout(); + } + } - setProperty (kIOPMRootDomainPowerStatusKey, thermalsDict); + if (flags.bit.idleSleepEnabled) { + DLOG("idle sleep timer enabled\n"); + if (!wrangler) { + changePowerStateToPriv(getRUN_STATE()); + startIdleSleepTimer( idleSeconds ); + } else { + // Start idle timer if prefs now allow system sleep + // and user is already inactive. Disk spindown is + // accelerated upon timer expiration. + + if (!userIsActive) { + startIdleSleepTimer(getTimeToIdleSleep()); + } + } + } - thermalsDict->release(); + if (flags.bit.idleSleepDisabled) { + DLOG("idle sleep timer disabled\n"); + cancelIdleSleepTimer(); + restoreUserSpinDownTimeout(); + adjustPowerState(); + } -exit: - // UNLOCK - if (featuresDictLock) IOLockUnlock(featuresDictLock); + if (flags.bit.adjustPowerState) { + bool sleepASAP = false; - if (shouldUpdate) - messageClients (kIOPMMessageSystemPowerEventOccurred, (void *)NULL); + if (!systemBooting && (0 == idleSleepPreventersCount())) { + if (!wrangler) { + changePowerStateToPriv(getRUN_STATE()); + if (idleSleepEnabled) { + // stay awake for at least idleSeconds + startIdleSleepTimer(idleSeconds); + } + } else if (!extraSleepDelay && !idleSleepTimerPending && !systemDarkWake) { + sleepASAP = true; + } + } - return kIOReturnSuccess; + adjustPowerState(sleepASAP); + } } -//****************************************************************************** -// receivePowerNotification -// -// The power controller is notifying us of a hardware-related power management -// event that we must handle. This may be a result of an 'environment' interrupt -// from the power mgt micro. //****************************************************************************** -IOReturn IOPMrootDomain::receivePowerNotification( UInt32 msg ) -{ - pmPowerStateQueue->submitPowerEvent( - kPowerEventReceivedPowerNotification, (void *)(uintptr_t) msg ); - return kIOReturnSuccess; -} - -void IOPMrootDomain::handlePowerNotification( UInt32 msg ) -{ - bool eval_clamshell = false; - - ASSERT_GATED(); - - /* - * Local (IOPMrootDomain only) eval clamshell command - */ - if (msg & kLocalEvalClamshellCommand) - { - eval_clamshell = true; - } - - /* - * Overtemp - */ - if (msg & kIOPMOverTemp) - { - MSG("PowerManagement emergency overtemp signal. Going to sleep!"); - privateSleepSystem (kIOPMSleepReasonThermalEmergency); - } - - /* - * Sleep if system is in dark wake - */ - if (msg & kIOPMDWOverTemp) - { - DLOG("DarkWake thermal limits message received!\n"); - - // Inform cap client that we're going to sleep - messageClients(kIOPMMessageDarkWakeThermalEmergency); - - } - - /* - * Sleep Now! - */ - if (msg & kIOPMSleepNow) - { - privateSleepSystem (kIOPMSleepReasonSoftware); - } - - /* - * Power Emergency - */ - if (msg & kIOPMPowerEmergency) - { - lowBatteryCondition = true; - privateSleepSystem (kIOPMSleepReasonLowPower); - } - - /* - * Clamshell OPEN - */ - if (msg & kIOPMClamshellOpened) - { - // Received clamshel open message from clamshell controlling driver - // Update our internal state and tell general interest clients - clamshellClosed = false; - clamshellExists = true; - - // Don't issue a hid tickle when lid is open and polled on wake - if (msg & kIOPMSetValue) - { - setProperty(kIOPMRootDomainWakeTypeKey, "Lid Open"); - reportUserInput(); - } - - // Tell PMCPU - informCPUStateChange(kInformLid, 0); - - // Tell general interest clients - sendClientClamshellNotification(); - - bool aborting = ((lastSleepReason == kIOPMSleepReasonClamshell) - || (lastSleepReason == kIOPMSleepReasonIdle) - || (lastSleepReason == kIOPMSleepReasonMaintenance)); - if (aborting) userActivityCount++; - DLOG("clamshell tickled %d lastSleepReason %d\n", userActivityCount, lastSleepReason); - } - - /* - * Clamshell CLOSED - * Send the clamshell interest notification since the lid is closing. - */ - if (msg & kIOPMClamshellClosed) - { - // Received clamshel open message from clamshell controlling driver - // Update our internal state and tell general interest clients - clamshellClosed = true; - clamshellExists = true; - - // Tell PMCPU - informCPUStateChange(kInformLid, 1); - - // Tell general interest clients - sendClientClamshellNotification(); - - // And set eval_clamshell = so we can attempt - eval_clamshell = true; - } - - /* - * Set Desktop mode (sent from graphics) - * - * -> reevaluate lid state - */ - if (msg & kIOPMSetDesktopMode) - { - desktopMode = (0 != (msg & kIOPMSetValue)); - msg &= ~(kIOPMSetDesktopMode | kIOPMSetValue); - - sendClientClamshellNotification(); - - // Re-evaluate the lid state - eval_clamshell = true; - } - - /* - * AC Adaptor connected - * - * -> reevaluate lid state - */ - if (msg & kIOPMSetACAdaptorConnected) - { - acAdaptorConnected = (0 != (msg & kIOPMSetValue)); - msg &= ~(kIOPMSetACAdaptorConnected | kIOPMSetValue); - - // Tell CPU PM - informCPUStateChange(kInformAC, !acAdaptorConnected); - - // Tell BSD if AC is connected - // 0 == external power source; 1 == on battery - post_sys_powersource(acAdaptorConnected ? 0:1); - - sendClientClamshellNotification(); - - // Re-evaluate the lid state - eval_clamshell = true; - - // Lack of AC may have latched a display wrangler tickle. - // This mirrors the hardware's USB wake event latch, where a latched - // USB wake event followed by an AC attach will trigger a full wake. - latchDisplayWranglerTickle( false ); +unsigned int +IOPMrootDomain::idleSleepPreventersCount() +{ +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (_aotMode) { + unsigned int count __block; + count = 0; + preventIdleSleepList->iterateObjects(^bool (OSObject * obj) + { + count += (NULL == obj->metaCast("AppleARMBacklight")); + return false; + }); + return count; + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ -#if HIBERNATION - // AC presence will reset the standy timer delay adjustment. - _standbyTimerResetSeconds = 0; -#endif - if (!userIsActive) { - // Reset userActivityTime when power supply is changed(rdr 13789330) - clock_get_uptime(&userActivityTime); - } - } - - /* - * Enable Clamshell (external display disappear) - * - * -> reevaluate lid state - */ - if (msg & kIOPMEnableClamshell) - { - // Re-evaluate the lid state - // System should sleep on external display disappearance - // in lid closed operation. - if (true == clamshellDisabled) - { - eval_clamshell = true; - } - - clamshellDisabled = false; - sendClientClamshellNotification(); - } - - /* - * Disable Clamshell (external display appeared) - * We don't bother re-evaluating clamshell state. If the system is awake, - * the lid is probably open. - */ - if (msg & kIOPMDisableClamshell) - { - clamshellDisabled = true; - sendClientClamshellNotification(); - } - - /* - * Evaluate clamshell and SLEEP if appropiate - */ - if (eval_clamshell && clamshellClosed) - { - if (shouldSleepOnClamshellClosed()) - privateSleepSystem (kIOPMSleepReasonClamshell); - else - evaluatePolicy( kStimulusDarkWakeEvaluate ); - } - - /* - * Power Button - */ - if (msg & kIOPMPowerButton) - { - if (!wranglerAsleep) - { - OSString *pbs = OSString::withCString("DisablePowerButtonSleep"); - // Check that power button sleep is enabled - if( pbs ) { - if( kOSBooleanTrue != getProperty(pbs)) - privateSleepSystem (kIOPMSleepReasonPowerButton); - } - } - else - reportUserInput(); - } + return preventIdleSleepList->getCount(); } -//****************************************************************************** -// evaluatePolicy -// -// Evaluate root-domain policy in response to external changes. -//****************************************************************************** - -void IOPMrootDomain::evaluatePolicy( int stimulus, uint32_t arg ) -{ - union { - struct { - int idleSleepEnabled : 1; - int idleSleepDisabled : 1; - int displaySleep : 1; - int sleepDelayChanged : 1; - int evaluateDarkWake : 1; - int adjustPowerState : 1; - int userBecameInactive : 1; - } bit; - uint32_t u32; - } flags; - - DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg); - - ASSERT_GATED(); - flags.u32 = 0; - - switch (stimulus) - { - case kStimulusDisplayWranglerSleep: - if (!wranglerAsleep) - { - // first transition to wrangler sleep or lower - wranglerAsleep = true; - flags.bit.displaySleep = true; - } - break; - - case kStimulusDisplayWranglerWake: - displayIdleForDemandSleep = false; - wranglerAsleep = false; - break; - - case kStimulusUserIsActive: - if (!userIsActive) - { - userIsActive = true; - userWasActive = true; - - // Stay awake after dropping demand for display power on - if (kFullWakeReasonDisplayOn == fullWakeReason) - fullWakeReason = fFullWakeReasonDisplayOnAndLocalUser; - - setProperty(gIOPMUserIsActiveKey, kOSBooleanTrue); - messageClients(kIOPMMessageUserIsActiveChanged); - } - flags.bit.idleSleepDisabled = true; - break; - - case kStimulusUserIsInactive: - if (userIsActive) - { - userIsActive = false; - clock_get_uptime(&userBecameInactiveTime); - flags.bit.userBecameInactive = true; - - setProperty(gIOPMUserIsActiveKey, kOSBooleanFalse); - messageClients(kIOPMMessageUserIsActiveChanged); - } - break; - - case kStimulusAggressivenessChanged: - { - unsigned long minutesToIdleSleep = 0; - unsigned long minutesToDisplayDim = 0; - unsigned long minutesDelta = 0; - - // Fetch latest display and system sleep slider values. - getAggressiveness(kPMMinutesToSleep, &minutesToIdleSleep); - getAggressiveness(kPMMinutesToDim, &minutesToDisplayDim); - DLOG("aggressiveness changed: system %u->%u, display %u\n", - (uint32_t) sleepSlider, - (uint32_t) minutesToIdleSleep, - (uint32_t) minutesToDisplayDim); - - DLOG("idle time -> %ld secs (ena %d)\n", - idleSeconds, (minutesToIdleSleep != 0)); - - if (0x7fffffff == minutesToIdleSleep) - minutesToIdleSleep = idleSeconds; - - // How long to wait before sleeping the system once - // the displays turns off is indicated by 'extraSleepDelay'. - - if ( minutesToIdleSleep > minutesToDisplayDim ) - minutesDelta = minutesToIdleSleep - minutesToDisplayDim; - else if ( minutesToIdleSleep == minutesToDisplayDim ) - minutesDelta = 1; - - if ((sleepSlider == 0) && (minutesToIdleSleep != 0)) - flags.bit.idleSleepEnabled = true; - - if ((sleepSlider != 0) && (minutesToIdleSleep == 0)) - flags.bit.idleSleepDisabled = true; - - if (((minutesDelta != extraSleepDelay) || - (userActivityTime != userActivityTime_prev)) && - !flags.bit.idleSleepEnabled && !flags.bit.idleSleepDisabled) - flags.bit.sleepDelayChanged = true; - - if (systemDarkWake && !darkWakeToSleepASAP && - (flags.bit.idleSleepEnabled || flags.bit.idleSleepDisabled)) - { - // Reconsider decision to remain in dark wake - flags.bit.evaluateDarkWake = true; - } - - sleepSlider = minutesToIdleSleep; - extraSleepDelay = minutesDelta; - userActivityTime_prev = userActivityTime; - } break; - - case kStimulusDemandSystemSleep: - displayIdleForDemandSleep = true; - if(wrangler && wranglerIdleSettings) - { - // Request wrangler idle only when demand sleep is triggered - // from full wake. - if(CAP_CURRENT(kIOPMSystemCapabilityGraphics)) - { - wrangler->setProperties(wranglerIdleSettings); - DLOG("Requested wrangler idle\n"); - } - } - // arg = sleepReason - changePowerStateWithOverrideTo( SLEEP_STATE, arg ); - break; - - case kStimulusAllowSystemSleepChanged: - flags.bit.adjustPowerState = true; - break; - - case kStimulusDarkWakeActivityTickle: - if (false == wranglerTickled) - { - if (latchDisplayWranglerTickle(true)) - { - DLOG("latched tickle\n"); - break; - } - - wranglerTickled = true; - DLOG("Requesting full wake after dark wake activity tickle\n"); - requestFullWake( kFullWakeReasonLocalUser ); - } - break; - - case kStimulusDarkWakeEntry: - case kStimulusDarkWakeReentry: - // Any system transitions since the last dark wake transition - // will invalid the stimulus. - - if (arg == _systemStateGeneration) - { - DLOG("dark wake entry\n"); - systemDarkWake = true; - - // Keep wranglerAsleep an invariant when wrangler is absent - if (wrangler) - wranglerAsleep = true; - - if (kStimulusDarkWakeEntry == stimulus) - { - clock_get_uptime(&userBecameInactiveTime); - flags.bit.evaluateDarkWake = true; - } - - // Always accelerate disk spindown while in dark wake, - // even if system does not support/allow sleep. - - cancelIdleSleepTimer(); - setQuickSpinDownTimeout(); - } - break; - - case kStimulusDarkWakeEvaluate: - if (systemDarkWake) - { - flags.bit.evaluateDarkWake = true; - } - break; - - case kStimulusNoIdleSleepPreventers: - flags.bit.adjustPowerState = true; - break; - - } /* switch(stimulus) */ - - if (flags.bit.evaluateDarkWake && (kFullWakeReasonNone == fullWakeReason)) - { - if (darkWakeToSleepASAP || - (clamshellClosed && !(desktopMode && acAdaptorConnected))) - { - uint32_t newSleepReason; - - if (CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) - { - // System was previously in full wake. Sleep reason from - // full to dark already recorded in fullToDarkReason. - - if (lowBatteryCondition) - newSleepReason = kIOPMSleepReasonLowPower; - else - newSleepReason = fullToDarkReason; - } - else - { - // In dark wake from system sleep. - - if (darkWakeSleepService) - newSleepReason = kIOPMSleepReasonSleepServiceExit; - else - newSleepReason = kIOPMSleepReasonMaintenance; - } - - if (checkSystemCanSleep(newSleepReason)) - { - privateSleepSystem(newSleepReason); - } - } - else // non-maintenance (network) dark wake - { - if (checkSystemCanSleep(kIOPMSleepReasonIdle)) - { - // Release power clamp, and wait for children idle. - adjustPowerState(true); - } - else - { - changePowerStateToPriv(ON_STATE); - } - } - } - - if (systemDarkWake) - { - // The rest are irrelevant while system is in dark wake. - flags.u32 = 0; - } - - if ((flags.bit.displaySleep) && - (kFullWakeReasonDisplayOn == fullWakeReason)) - { - // kIOPMSleepReasonMaintenance? - changePowerStateWithOverrideTo( SLEEP_STATE, kIOPMSleepReasonMaintenance ); - } - - if (flags.bit.userBecameInactive || flags.bit.sleepDelayChanged) - { - bool cancelQuickSpindown = false; - - if (flags.bit.sleepDelayChanged) - { - // Cancel existing idle sleep timer and quick disk spindown. - // New settings will be applied by the idleSleepEnabled flag - // handler below if idle sleep is enabled. - - DLOG("extra sleep timer changed\n"); - cancelIdleSleepTimer(); - cancelQuickSpindown = true; - } - else - { - DLOG("user inactive\n"); - } - - if (!userIsActive && !ignoreIdleSleepTimer && sleepSlider) - { - startIdleSleepTimer(getTimeToIdleSleep()); - } - - if (cancelQuickSpindown) - restoreUserSpinDownTimeout(); - } - - if (flags.bit.idleSleepEnabled) - { - DLOG("idle sleep timer enabled\n"); - if (!wrangler) - { - changePowerStateToPriv(ON_STATE); - if (idleSeconds) - { - startIdleSleepTimer( idleSeconds ); - } - } - else - { - // Start idle timer if prefs now allow system sleep - // and user is already inactive. Disk spindown is - // accelerated upon timer expiration. - - if (!userIsActive) - { - startIdleSleepTimer(getTimeToIdleSleep()); - } - } - } - - if (flags.bit.idleSleepDisabled) - { - DLOG("idle sleep timer disabled\n"); - cancelIdleSleepTimer(); - restoreUserSpinDownTimeout(); - adjustPowerState(); - } - - if (flags.bit.adjustPowerState) - { - bool sleepASAP = false; - - if (!systemBooting && (preventIdleSleepList->getCount() == 0)) - { - if (!wrangler) - { - changePowerStateToPriv(ON_STATE); - if (idleSeconds) - { - // stay awake for at least idleSeconds - startIdleSleepTimer(idleSeconds); - } - } - else if (!extraSleepDelay && !idleSleepTimerPending && !systemDarkWake) - { - sleepASAP = true; - } - } - - adjustPowerState(sleepASAP); - } -} //****************************************************************************** // requestFullWake @@ -6736,80 +8276,80 @@ void IOPMrootDomain::evaluatePolicy( int stimulus, uint32_t arg ) // Request transition from dark wake to full wake //****************************************************************************** -void IOPMrootDomain::requestFullWake( FullWakeReason reason ) -{ - uint32_t options = 0; - IOService * pciRoot = 0; - - // System must be in dark wake and a valid reason for entering full wake - if ((kFullWakeReasonNone == reason) || - (kFullWakeReasonNone != fullWakeReason) || - (CAP_CURRENT(kIOPMSystemCapabilityGraphics))) - { - return; - } - - // Will clear reason upon exit from full wake - fullWakeReason = reason; - - _desiredCapability |= (kIOPMSystemCapabilityGraphics | - kIOPMSystemCapabilityAudio); - - if ((kSystemTransitionWake == _systemTransitionType) && - !(_pendingCapability & kIOPMSystemCapabilityGraphics) && - !graphicsSuppressed) - { - DLOG("promote to full wake\n"); - - // Promote to full wake while waking up to dark wake due to tickle. - // PM will hold off notifying the graphics subsystem about system wake - // as late as possible, so if a HID tickle does arrive, graphics can - // power up on this same wake cycle. The latency to power up graphics - // on the next cycle can be huge on some systems. However, once any - // graphics suppression has taken effect, it is too late. All other - // graphics devices must be similarly suppressed. But the delay till - // the following cycle should be short. - - _pendingCapability |= (kIOPMSystemCapabilityGraphics | - kIOPMSystemCapabilityAudio); - - // Immediately bring up audio and graphics - pciRoot = pciHostBridgeDriver; - willEnterFullWake(); - } - - // Unsafe to cancel once graphics was powered. - // If system woke from dark wake, the return to sleep can - // be cancelled. "awake -> dark -> sleep" transition - // can be canceled also, during the "dark --> sleep" phase - // *prior* to driver power down. - if (!CAP_HIGHEST(kIOPMSystemCapabilityGraphics) || - _pendingCapability == 0) { - options |= kIOPMSyncCancelPowerDown; - } - - synchronizePowerTree(options, pciRoot); - if (kFullWakeReasonLocalUser == fullWakeReason) - { - // IOGraphics doesn't light the display even though graphics is - // enabled in kIOMessageSystemCapabilityChange message(radar 9502104) - // So, do an explicit activity tickle - if (wrangler) - wrangler->activityTickle(0,0); - } - - if (options & kIOPMSyncCancelPowerDown) - { - AbsoluteTime now; - uint64_t nsec; - - // Log a timestamp for the initial full wake - clock_get_uptime(&now); - SUB_ABSOLUTETIME(&now, &systemWakeTime); - absolutetime_to_nanoseconds(now, &nsec); - MSG("full wake (reason %u) %u ms\n", - fullWakeReason, ((int)((nsec) / 1000000ULL))); - } +void +IOPMrootDomain::requestFullWake( FullWakeReason reason ) +{ + uint32_t options = 0; + IOService * pciRoot = NULL; + bool promotion = false; + + // System must be in dark wake and a valid reason for entering full wake + if ((kFullWakeReasonNone == reason) || + (kFullWakeReasonNone != fullWakeReason) || + (CAP_CURRENT(kIOPMSystemCapabilityGraphics))) { + return; + } + + // Will clear reason upon exit from full wake + fullWakeReason = reason; + + _desiredCapability |= (kIOPMSystemCapabilityGraphics | + kIOPMSystemCapabilityAudio); + + if ((kSystemTransitionWake == _systemTransitionType) && + !(_pendingCapability & kIOPMSystemCapabilityGraphics) && + !graphicsSuppressed) { + // Promote to full wake while waking up to dark wake due to tickle. + // PM will hold off notifying the graphics subsystem about system wake + // as late as possible, so if a HID tickle does arrive, graphics can + // power up on this same wake cycle. The latency to power up graphics + // on the next cycle can be huge on some systems. However, once any + // graphics suppression has taken effect, it is too late. All other + // graphics devices must be similarly suppressed. But the delay till + // the following cycle should be short. + + _pendingCapability |= (kIOPMSystemCapabilityGraphics | + kIOPMSystemCapabilityAudio); + + // Immediately bring up audio and graphics + pciRoot = pciHostBridgeDriver; + willEnterFullWake(); + promotion = true; + } + + // Unsafe to cancel once graphics was powered. + // If system woke from dark wake, the return to sleep can + // be cancelled. "awake -> dark -> sleep" transition + // can be canceled also, during the "dark --> sleep" phase + // *prior* to driver power down. + if (!CAP_HIGHEST(kIOPMSystemCapabilityGraphics) || + _pendingCapability == 0) { + options |= kIOPMSyncCancelPowerDown; + } + + synchronizePowerTree(options, pciRoot); + if (kFullWakeReasonLocalUser == fullWakeReason) { + // IOGraphics doesn't light the display even though graphics is + // enabled in kIOMessageSystemCapabilityChange message(radar 9502104) + // So, do an explicit activity tickle + if (wrangler) { + wrangler->activityTickle(0, 0); + } + } + + // Log a timestamp for the initial full wake request. + // System may not always honor this full wake request. + if (!CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) { + AbsoluteTime now; + uint64_t nsec; + + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_nanoseconds(now, &nsec); + MSG("full wake %s (reason %u) %u ms\n", + promotion ? "promotion" : "request", + fullWakeReason, ((int)((nsec) / NSEC_PER_MSEC))); + } } //****************************************************************************** @@ -6822,29 +8362,34 @@ void IOPMrootDomain::requestFullWake( FullWakeReason reason ) // Assumptions: fullWakeReason was updated //****************************************************************************** -void IOPMrootDomain::willEnterFullWake( void ) +void +IOPMrootDomain::willEnterFullWake( void ) { - hibernateRetry = false; - ignoreIdleSleepTimer = false; - sleepTimerMaintenance = false; - sleepToStandby = false; + hibernateRetry = false; + sleepToStandby = false; + standbyNixed = false; + resetTimers = false; + sleepTimerMaintenance = false; - _systemMessageClientMask = kSystemMessageClientPowerd | - kSystemMessageClientLegacyApp; + _systemMessageClientMask = kSystemMessageClientPowerd | + kSystemMessageClientLegacyApp; - if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) - { - // Initial graphics full power - _systemMessageClientMask |= kSystemMessageClientKernel; + if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) { + // Initial graphics full power + _systemMessageClientMask |= kSystemMessageClientKernel; - // Set kIOPMUserTriggeredFullWakeKey before full wake for IOGraphics - setProperty(gIOPMUserTriggeredFullWakeKey, - (kFullWakeReasonLocalUser == fullWakeReason) ? - kOSBooleanTrue : kOSBooleanFalse); - } + // Set kIOPMUserTriggeredFullWakeKey before full wake for IOGraphics + setProperty(gIOPMUserTriggeredFullWakeKey, + (kFullWakeReasonLocalUser == fullWakeReason) ? + kOSBooleanTrue : kOSBooleanFalse); + } +#if HIBERNATION + IOHibernateSetWakeCapabilities(_pendingCapability); +#endif - IOService::setAdvisoryTickleEnable( true ); - tellClients(kIOMessageSystemWillPowerOn); + IOService::setAdvisoryTickleEnable( true ); + tellClients(kIOMessageSystemWillPowerOn); + preventTransitionToUserActive(false); } //****************************************************************************** @@ -6853,15 +8398,15 @@ void IOPMrootDomain::willEnterFullWake( void ) // System has already entered full wake. Invoked by a delayed thread call. //****************************************************************************** -void IOPMrootDomain::fullWakeDelayedWork( void ) +void +IOPMrootDomain::fullWakeDelayedWork( void ) { #if DARK_TO_FULL_EVALUATE_CLAMSHELL - // Not gated, don't modify state - if ((kSystemTransitionNone == _systemTransitionType) && - CAP_CURRENT(kIOPMSystemCapabilityGraphics)) - { - receivePowerNotification( kLocalEvalClamshellCommand ); - } + // Not gated, don't modify state + if ((kSystemTransitionNone == _systemTransitionType) && + CAP_CURRENT(kIOPMSystemCapabilityGraphics)) { + receivePowerNotification( kLocalEvalClamshellCommand ); + } #endif } @@ -6869,36 +8414,66 @@ void IOPMrootDomain::fullWakeDelayedWork( void ) // evaluateAssertions // //****************************************************************************** -void IOPMrootDomain::evaluateAssertions(IOPMDriverAssertionType newAssertions, IOPMDriverAssertionType oldAssertions) -{ - IOPMDriverAssertionType changedBits = newAssertions ^ oldAssertions; - messageClients(kIOPMMessageDriverAssertionsChanged); +// Bitmask of all kernel assertions that prevent system idle sleep. +// kIOPMDriverAssertionReservedBit7 is reserved for IOMediaBSDClient. +#define NO_IDLE_SLEEP_ASSERTIONS_MASK \ + (kIOPMDriverAssertionReservedBit7 | \ + kIOPMDriverAssertionPreventSystemIdleSleepBit) + +void +IOPMrootDomain::evaluateAssertions(IOPMDriverAssertionType newAssertions, IOPMDriverAssertionType oldAssertions) +{ + IOPMDriverAssertionType changedBits = newAssertions ^ oldAssertions; - if (changedBits & kIOPMDriverAssertionPreventDisplaySleepBit) { + messageClients(kIOPMMessageDriverAssertionsChanged); - if (wrangler) { - bool value = (newAssertions & kIOPMDriverAssertionPreventDisplaySleepBit) ? true : false; + if (changedBits & kIOPMDriverAssertionPreventDisplaySleepBit) { + if (wrangler) { + bool value = (newAssertions & kIOPMDriverAssertionPreventDisplaySleepBit) ? true : false; - DLOG("wrangler->setIgnoreIdleTimer\(%d)\n", value); - wrangler->setIgnoreIdleTimer( value ); - } - } + DLOG("wrangler->setIgnoreIdleTimer\(%d)\n", value); + wrangler->setIgnoreIdleTimer( value ); + } + } - if (changedBits & kIOPMDriverAssertionCPUBit) - evaluatePolicy(kStimulusDarkWakeEvaluate); + if (changedBits & kIOPMDriverAssertionCPUBit) { +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (_aotNow) { + IOLog("CPU assertions %d\n", (0 != (kIOPMDriverAssertionCPUBit & newAssertions))); + } + evaluatePolicy(_aotNow ? kStimulusNoIdleSleepPreventers : kStimulusDarkWakeEvaluate); +#else + evaluatePolicy(kStimulusDarkWakeEvaluate); +#endif + if (!assertOnWakeSecs && gIOLastWakeAbsTime) { + AbsoluteTime now; + clock_usec_t microsecs; + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_microtime(now, &assertOnWakeSecs, µsecs); + if (assertOnWakeReport) { + HISTREPORT_TALLYVALUE(assertOnWakeReport, (int64_t)assertOnWakeSecs); + DLOG("Updated assertOnWake %lu\n", (unsigned long)assertOnWakeSecs); + } + } + } - if (changedBits & kIOPMDriverAssertionReservedBit7) { - bool value = (newAssertions & kIOPMDriverAssertionReservedBit7) ? true : false; - if (value) { - DLOG("Driver assertion ReservedBit7 raised. Legacy IO preventing sleep\n"); - updatePreventIdleSleepList(this, true); - } - else { - DLOG("Driver assertion ReservedBit7 dropped\n"); - updatePreventIdleSleepList(this, false); - } - } + if (changedBits & NO_IDLE_SLEEP_ASSERTIONS_MASK) { + if ((newAssertions & NO_IDLE_SLEEP_ASSERTIONS_MASK) != 0) { + if ((oldAssertions & NO_IDLE_SLEEP_ASSERTIONS_MASK) == 0) { + DLOG("PreventIdleSleep driver assertion raised\n"); + bool ok = updatePreventIdleSleepList(this, true); + if (ok && (changedBits & kIOPMDriverAssertionPreventSystemIdleSleepBit)) { + // Cancel idle sleep if there is one in progress + cancelIdlePowerDown(this); + } + } + } else { + DLOG("PreventIdleSleep driver assertion dropped\n"); + updatePreventIdleSleepList(this, false); + } + } } // MARK: - @@ -6909,211 +8484,192 @@ void IOPMrootDomain::evaluateAssertions(IOPMDriverAssertionType newAssertions, I // //****************************************************************************** -void IOPMrootDomain::pmStatsRecordEvent( - int eventIndex, - AbsoluteTime timestamp) +void +IOPMrootDomain::pmStatsRecordEvent( + int eventIndex, + AbsoluteTime timestamp) { - bool starting = eventIndex & kIOPMStatsEventStartFlag ? true:false; - bool stopping = eventIndex & kIOPMStatsEventStopFlag ? true:false; - uint64_t delta; - uint64_t nsec; - OSData *publishPMStats = NULL; + bool starting = eventIndex & kIOPMStatsEventStartFlag ? true:false; + bool stopping = eventIndex & kIOPMStatsEventStopFlag ? true:false; + uint64_t delta; + uint64_t nsec; + OSData *publishPMStats = NULL; - eventIndex &= ~(kIOPMStatsEventStartFlag | kIOPMStatsEventStopFlag); + eventIndex &= ~(kIOPMStatsEventStartFlag | kIOPMStatsEventStopFlag); - absolutetime_to_nanoseconds(timestamp, &nsec); + absolutetime_to_nanoseconds(timestamp, &nsec); - switch (eventIndex) { - case kIOPMStatsHibernateImageWrite: - if (starting) - gPMStats.hibWrite.start = nsec; - else if (stopping) - gPMStats.hibWrite.stop = nsec; + switch (eventIndex) { + case kIOPMStatsHibernateImageWrite: + if (starting) { + gPMStats.hibWrite.start = nsec; + } else if (stopping) { + gPMStats.hibWrite.stop = nsec; + } - if (stopping) { - delta = gPMStats.hibWrite.stop - gPMStats.hibWrite.start; - IOLog("PMStats: Hibernate write took %qd ms\n", delta/1000000ULL); - } - break; - case kIOPMStatsHibernateImageRead: - if (starting) - gPMStats.hibRead.start = nsec; - else if (stopping) - gPMStats.hibRead.stop = nsec; + if (stopping) { + delta = gPMStats.hibWrite.stop - gPMStats.hibWrite.start; + IOLog("PMStats: Hibernate write took %qd ms\n", delta / NSEC_PER_MSEC); + } + break; + case kIOPMStatsHibernateImageRead: + if (starting) { + gPMStats.hibRead.start = nsec; + } else if (stopping) { + gPMStats.hibRead.stop = nsec; + } - if (stopping) { - delta = gPMStats.hibRead.stop - gPMStats.hibRead.start; - IOLog("PMStats: Hibernate read took %qd ms\n", delta/1000000ULL); + if (stopping) { + delta = gPMStats.hibRead.stop - gPMStats.hibRead.start; + IOLog("PMStats: Hibernate read took %qd ms\n", delta / NSEC_PER_MSEC); - publishPMStats = OSData::withBytes(&gPMStats, sizeof(gPMStats)); - setProperty(kIOPMSleepStatisticsKey, publishPMStats); - publishPMStats->release(); - bzero(&gPMStats, sizeof(gPMStats)); - } - break; - } + publishPMStats = OSData::withBytes(&gPMStats, sizeof(gPMStats)); + setProperty(kIOPMSleepStatisticsKey, publishPMStats); + publishPMStats->release(); + bzero(&gPMStats, sizeof(gPMStats)); + } + break; + } } /* * Appends a record of the application response to * IOPMrootDomain::pmStatsAppResponses */ -void IOPMrootDomain::pmStatsRecordApplicationResponse( - const OSSymbol *response, +void +IOPMrootDomain::pmStatsRecordApplicationResponse( + const OSSymbol *response, const char *name, int messageType, - uint32_t delay_ms, - int app_pid) -{ - OSDictionary *responseDescription = NULL; - OSNumber *delayNum = NULL; - OSNumber *powerCaps = NULL; - OSNumber *pidNum = NULL; - OSNumber *msgNum = NULL; - const OSSymbol *appname; - const OSSymbol *entryName; - OSObject *entryType; - int i; -#if defined(__i386__) || defined(__x86_64__) - swd_hdr *hdr = NULL; - OSString *UUIDstring = NULL; - uint32_t spindumpSize = 0; - const OSSymbol *namesym = NULL; -#endif + uint32_t delay_ms, + uint64_t id, + OSObject *object, + IOPMPowerStateIndex powerState) +{ + OSDictionary *responseDescription = NULL; + OSNumber *delayNum = NULL; + OSNumber *powerCaps = NULL; + OSNumber *pidNum = NULL; + OSNumber *msgNum = NULL; + const OSSymbol *appname; + const OSSymbol *sleep = NULL, *wake = NULL; + IOPMServiceInterestNotifier *notify = NULL; + + if (object && (notify = OSDynamicCast(IOPMServiceInterestNotifier, object))) { + if (response->isEqualTo(gIOPMStatsResponseTimedOut)) { + notify->ackTimeoutCnt++; + } else { + notify->ackTimeoutCnt = 0; + } + } - if (!pmStatsAppResponses || pmStatsAppResponses->getCount() > 50) - return; - - i = 0; - while ((responseDescription = (OSDictionary *) pmStatsAppResponses->getObject(i++))) - { - entryType = responseDescription->getObject(_statsResponseTypeKey); - entryName = (OSSymbol *) responseDescription->getObject(_statsNameKey); - powerCaps = (OSNumber *) responseDescription->getObject(_statsPowerCapsKey); - if (entryName && (entryType == response) && entryName->isEqualTo(name) && - (powerCaps->unsigned32BitValue() == _pendingCapability)) - { - OSNumber * entryValue; - entryValue = (OSNumber *) responseDescription->getObject(_statsTimeMSKey); - if (entryValue && (entryValue->unsigned32BitValue() < delay_ms)) - entryValue->setValue(delay_ms); - return; - } - } - - responseDescription = OSDictionary::withCapacity(5); - if (responseDescription) - { - if (response) { - responseDescription->setObject(_statsResponseTypeKey, response); - } - - if (messageType != 0) { - msgNum = OSNumber::withNumber(messageType, 32); - if (msgNum) { - responseDescription->setObject(_statsMessageTypeKey, msgNum); - msgNum->release(); - } - } - - if (name && (strlen(name) > 0)) - { - appname = OSSymbol::withCString(name); - if (appname) { - responseDescription->setObject(_statsNameKey, appname); - appname->release(); - } - } - - if (app_pid != -1) { - pidNum = OSNumber::withNumber(app_pid, 32); - if (pidNum) { - responseDescription->setObject(_statsPIDKey, pidNum); - pidNum->release(); - } - } - - delayNum = OSNumber::withNumber(delay_ms, 32); - if (delayNum) { - responseDescription->setObject(_statsTimeMSKey, delayNum); - delayNum->release(); - } - - powerCaps = OSNumber::withNumber(_pendingCapability, 32); - if (powerCaps) { - responseDescription->setObject(_statsPowerCapsKey, powerCaps); - powerCaps->release(); - } - - - if (pmStatsAppResponses) { - pmStatsAppResponses->setObject(responseDescription); - } - - responseDescription->release(); - } + if (response->isEqualTo(gIOPMStatsResponsePrompt) || + (_systemTransitionType == kSystemTransitionNone) || (_systemTransitionType == kSystemTransitionNewCapClient)) { + return; + } -#if defined(__i386__) || defined(__x86_64__) - if ((gIOKitDebug & kIOAppRespStacksOn) == 0) - goto done; - - if (!name || name[0] == '\0' || - !response->isEqualTo(gIOPMStatsApplicationResponseTimedOut)) - goto done; - - namesym = OSSymbol::withCString(name); - - // Skip stackshots of previous offenders - if (noAckApps->containsObject(namesym)) - goto done; - - if (noAckApps->getCount() == noAckApps->getCapacity()) { - // Remove oldest entry from over-flowing list - noAckApps->removeObject(noAckApps->getFirstObject()); - } - noAckApps->setLastObject(namesym); - - if (spindumpDesc != NULL) { - /* Add name of this new process in the header */ - hdr = (swd_hdr *)spindumpDesc->getBytesNoCopy(); - if (!hdr) goto done; - - snprintf(hdr->PMStatusCode, sizeof(hdr->PMStatusCode), "%s,%s",hdr->PMStatusCode, name); - goto done; - } - - spindumpSize = 256*1024; - spindumpDesc = IOBufferMemoryDescriptor::inTaskWithOptions( - kernel_task, kIODirectionIn | kIOMemoryMapperNone, spindumpSize); - - if (!spindumpDesc) - goto done; - - hdr = (swd_hdr *)spindumpDesc->getBytesNoCopy(); - memset(hdr, 0, sizeof(swd_hdr)); - if ((UUIDstring = OSDynamicCast(OSString, - getProperty(kIOPMSleepWakeUUIDKey))) != NULL ) { - snprintf(hdr->UUID, sizeof(hdr->UUID), "UUID: %s\n", UUIDstring->getCStringNoCopy()); - } - snprintf(hdr->cps, sizeof(hdr->cps), "caps: %d\n", _pendingCapability); - snprintf(hdr->PMStatusCode, sizeof(hdr->PMStatusCode), "Process: %s", name); - snprintf(hdr->reason, sizeof(hdr->reason), "\nStackshot reason: App Response Timeout\n"); - - hdr->spindump_offset = sizeof(swd_hdr); - - stack_snapshot_from_kernel(-1, (char*)hdr+hdr->spindump_offset, - spindumpSize - hdr->spindump_offset, - STACKSHOT_SAVE_LOADINFO | STACKSHOT_SAVE_KEXT_LOADINFO, - &hdr->spindump_size); - if (hdr->spindump_size == 0) { - spindumpDesc->release(); - spindumpDesc = NULL; - } -done: - if (namesym) namesym->release(); + + if (response->isEqualTo(gIOPMStatsDriverPSChangeSlow)) { + kdebugTrace(kPMLogDrvPSChangeDelay, id, messageType, delay_ms); + } else if (notify) { + // User space app or kernel capability client + if (id) { + kdebugTrace(kPMLogAppResponseDelay, id, notify->msgType, delay_ms); + } else { + kdebugTrace(kPMLogDrvResponseDelay, notify->uuid0, messageType, delay_ms); + } + notify->msgType = 0; + } + + responseDescription = OSDictionary::withCapacity(5); + if (responseDescription) { + if (response) { + responseDescription->setObject(_statsResponseTypeKey, response); + } + + msgNum = OSNumber::withNumber(messageType, 32); + if (msgNum) { + responseDescription->setObject(_statsMessageTypeKey, msgNum); + msgNum->release(); + } + + if (!name && notify && notify->identifier) { + name = notify->identifier->getCStringNoCopy(); + } + + if (name && (strlen(name) > 0)) { + appname = OSSymbol::withCString(name); + if (appname) { + responseDescription->setObject(_statsNameKey, appname); + appname->release(); + } + } + + if (!id && notify) { + id = notify->uuid0; + } + if (id != 0) { + pidNum = OSNumber::withNumber(id, 64); + if (pidNum) { + responseDescription->setObject(_statsPIDKey, pidNum); + pidNum->release(); + } + } + + delayNum = OSNumber::withNumber(delay_ms, 32); + if (delayNum) { + responseDescription->setObject(_statsTimeMSKey, delayNum); + delayNum->release(); + } + + if (response->isEqualTo(gIOPMStatsDriverPSChangeSlow)) { + powerCaps = OSNumber::withNumber(powerState, 32); + +#if !defined(__i386__) && !defined(__x86_64__) && (DEVELOPMENT || DEBUG) + IOLog("%s::powerStateChange type(%d) to(%lu) async took %d ms\n", + name, messageType, + powerState, delay_ms); #endif + } else { + powerCaps = OSNumber::withNumber(_pendingCapability, 32); + } + if (powerCaps) { + responseDescription->setObject(_statsPowerCapsKey, powerCaps); + powerCaps->release(); + } + + sleep = OSSymbol::withCString("Sleep"); + wake = OSSymbol::withCString("Wake"); + if (_systemTransitionType == kSystemTransitionSleep) { + responseDescription->setObject(kIOPMStatsSystemTransitionKey, sleep); + } else if (_systemTransitionType == kSystemTransitionWake) { + responseDescription->setObject(kIOPMStatsSystemTransitionKey, wake); + } else if (_systemTransitionType == kSystemTransitionCapability) { + if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) { + responseDescription->setObject(kIOPMStatsSystemTransitionKey, sleep); + } else if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) { + responseDescription->setObject(kIOPMStatsSystemTransitionKey, wake); + } + } + if (sleep) { + sleep->release(); + } + if (wake) { + wake->release(); + } - return; + + + IOLockLock(pmStatsLock); + if (pmStatsAppResponses && pmStatsAppResponses->getCount() < 50) { + pmStatsAppResponses->setObject(responseDescription); + } + IOLockUnlock(pmStatsLock); + + responseDescription->release(); + } + + return; } // MARK: - @@ -7124,137 +8680,344 @@ done: // //****************************************************************************** -#define kIOPMRegisterNVRAMTracePointHandlerKey \ - "IOPMRegisterNVRAMTracePointHandler" - -IOReturn IOPMrootDomain::callPlatformFunction( - const OSSymbol * functionName, - bool waitForFunction, - void * param1, void * param2, - void * param3, void * param4 ) -{ - if (pmTracer && functionName && - functionName->isEqualTo(kIOPMRegisterNVRAMTracePointHandlerKey) && - !pmTracer->tracePointHandler && !pmTracer->tracePointTarget) - { - uint32_t tracePointPhases, tracePointPCI; - uint64_t statusCode; - - pmTracer->tracePointHandler = (IOPMTracePointHandler) param1; - pmTracer->tracePointTarget = (void *) param2; - tracePointPCI = (uint32_t)(uintptr_t) param3; - tracePointPhases = (uint32_t)(uintptr_t) param4; - statusCode = (((uint64_t)tracePointPCI) << 32) | tracePointPhases; - if ((tracePointPhases >> 24) != kIOPMTracePointSystemUp) - { - MSG("Sleep failure code 0x%08x 0x%08x\n", - tracePointPCI, tracePointPhases); - } +#define kIOPMRegisterNVRAMTracePointHandlerKey \ + "IOPMRegisterNVRAMTracePointHandler" + +IOReturn +IOPMrootDomain::callPlatformFunction( + const OSSymbol * functionName, + bool waitForFunction, + void * param1, void * param2, + void * param3, void * param4 ) +{ + uint32_t bootFailureCode = 0xffffffff; + if (pmTracer && functionName && + functionName->isEqualTo(kIOPMRegisterNVRAMTracePointHandlerKey) && + !pmTracer->tracePointHandler && !pmTracer->tracePointTarget) { + uint32_t tracePointPhases, tracePointPCI; + uint64_t statusCode; + + pmTracer->tracePointHandler = (IOPMTracePointHandler) param1; + pmTracer->tracePointTarget = (void *) param2; + tracePointPCI = (uint32_t)(uintptr_t) param3; + tracePointPhases = (uint32_t)(uintptr_t) param4; + if ((tracePointPhases & 0xff) == kIOPMTracePointSystemSleep) { + IORegistryEntry *node = IORegistryEntry::fromPath( "/chosen", gIODTPlane ); + if (node) { + OSData *data = OSDynamicCast( OSData, node->getProperty(kIOEFIBootRomFailureKey)); + if (data && data->getLength() == sizeof(bootFailureCode)) { + memcpy(&bootFailureCode, data->getBytesNoCopy(), sizeof(bootFailureCode)); + } + node->release(); + } + // Failure code from EFI/BootRom is a four byte structure + tracePointPCI = OSSwapBigToHostInt32(bootFailureCode); + } + statusCode = (((uint64_t)tracePointPCI) << 32) | tracePointPhases; + if ((tracePointPhases & 0xff) != kIOPMTracePointSystemUp) { + MSG("Sleep failure code 0x%08x 0x%08x\n", + tracePointPCI, tracePointPhases); + } setProperty(kIOPMSleepWakeFailureCodeKey, statusCode, 64); - pmTracer->tracePointHandler( pmTracer->tracePointTarget, 0, 0 ); + pmTracer->tracePointHandler( pmTracer->tracePointTarget, 0, 0 ); - return kIOReturnSuccess; - } + return kIOReturnSuccess; + } #if HIBERNATION - else if (functionName && - functionName->isEqualTo(kIOPMInstallSystemSleepPolicyHandlerKey)) - { - if (gSleepPolicyHandler) - return kIOReturnExclusiveAccess; - if (!param1) - return kIOReturnBadArgument; - gSleepPolicyHandler = (IOPMSystemSleepPolicyHandler) param1; - gSleepPolicyTarget = (void *) param2; - setProperty("IOPMSystemSleepPolicyHandler", kOSBooleanTrue); - return kIOReturnSuccess; - } + else if (functionName && + functionName->isEqualTo(kIOPMInstallSystemSleepPolicyHandlerKey)) { + if (gSleepPolicyHandler) { + return kIOReturnExclusiveAccess; + } + if (!param1) { + return kIOReturnBadArgument; + } + gSleepPolicyHandler = (IOPMSystemSleepPolicyHandler) param1; + gSleepPolicyTarget = (void *) param2; + setProperty("IOPMSystemSleepPolicyHandler", kOSBooleanTrue); + return kIOReturnSuccess; + } #endif - return super::callPlatformFunction( - functionName, waitForFunction, param1, param2, param3, param4); + return super::callPlatformFunction( + functionName, waitForFunction, param1, param2, param3, param4); +} + +void +IOPMrootDomain::kdebugTrace(uint32_t event, uint64_t id, + uintptr_t param1, uintptr_t param2, uintptr_t param3) +{ + uint32_t code = IODBG_POWER(event); + uint64_t regId = id; + if (regId == 0) { + regId = getRegistryEntryID(); + } + IOTimeStampConstant(code, (uintptr_t) regId, param1, param2, param3); +} + + +void +IOPMrootDomain::tracePoint( uint8_t point ) +{ + if (systemBooting) { + return; + } + + if (kIOPMTracePointWakeCapabilityClients == point) { + acceptSystemWakeEvents(false); + } + + kdebugTrace(kPMLogSleepWakeTracePoint, 0, point, 0); + pmTracer->tracePoint(point); } -void IOPMrootDomain::tracePoint( uint8_t point ) +void +IOPMrootDomain::traceDetail(OSObject *object, bool start) { - if (systemBooting) return; + IOPMServiceInterestNotifier *notifier; + + if (systemBooting) { + return; + } + + notifier = OSDynamicCast(IOPMServiceInterestNotifier, object); + if (!notifier) { + return; + } - PMDebug(kPMLogSleepWakeTracePoint, point, 0); - pmTracer->tracePoint(point); + if (start) { + pmTracer->traceDetail( notifier->uuid0 >> 32 ); + kdebugTrace(kPMLogSleepWakeMessage, pmTracer->getTracePhase(), notifier->msgType, notifier->uuid0, notifier->uuid1); + if (notifier->identifier) { + DLOG("trace point 0x%02x msg 0x%x to %s\n", pmTracer->getTracePhase(), notifier->msgType, + notifier->identifier->getCStringNoCopy()); + } else { + DLOG("trace point 0x%02x msg 0x%x\n", pmTracer->getTracePhase(), notifier->msgType); + } + notifierThread = current_thread(); + notifierObject = notifier; + notifier->retain(); + } else { + notifierThread = NULL; + notifierObject = NULL; + notifier->release(); + } } -void IOPMrootDomain::tracePoint( uint8_t point, uint8_t data ) + +void +IOPMrootDomain::traceAckDelay(OSObject *object, uint32_t response, uint32_t delay_ms) { - if (systemBooting) return; + IOPMServiceInterestNotifier *notifier = OSDynamicCast(IOPMServiceInterestNotifier, object); + if (!notifier) { + DLOG("Unknown notifier\n"); + return; + } - PMDebug(kPMLogSleepWakeTracePoint, point, data); - pmTracer->tracePoint(point, data); + if (!systemBooting) { + kdebugTrace(kPMLogDrvResponseDelay, notifier->uuid0, notifier->uuid1, response, delay_ms); + if (notifier->identifier) { + DLOG("Response from %s took %d ms(response:%d)\n", + notifier->identifier->getCStringNoCopy(), delay_ms, response); + } else { + DLOG("Response from kext UUID %llx-%llx took %d ms(response:%d)\n", + notifier->uuid0, notifier->uuid1, delay_ms, response); + } + } } -void IOPMrootDomain::traceDetail( uint32_t detail ) +void +IOPMrootDomain::traceDetail(uint32_t msgType, uint32_t msgIndex, uint32_t delay) { - if (!systemBooting) - pmTracer->traceDetail( detail ); + if (!systemBooting) { + uint32_t detail = ((msgType & 0xffff) << 16) | (delay & 0xffff); + pmTracer->traceDetail( detail ); + kdebugTrace(kPMLogSleepWakeTracePoint, pmTracer->getTracePhase(), msgType, delay); + DLOG("trace point 0x%02x msgType 0x%x detail 0x%08x\n", pmTracer->getTracePhase(), msgType, delay); + } } -IOReturn IOPMrootDomain::configureReport(IOReportChannelList *channelList, - IOReportConfigureAction action, - void *result, - void *destination) +void +IOPMrootDomain::configureReportGated(uint64_t channel_id, uint64_t action, void *result) { - unsigned cnt; - if (action != kIOReportGetDimensions) goto exit; + size_t reportSize; + void **report = NULL; + uint32_t bktCnt; + uint32_t bktSize; + uint32_t *clientCnt; - for (cnt = 0; cnt < channelList->nchannels; cnt++) { - if ( (channelList->channels[cnt].channel_id == kSleepCntChID) || - (channelList->channels[cnt].channel_id == kDarkWkCntChID) || - (channelList->channels[cnt].channel_id == kUserWkCntChID) ) { - SIMPLEREPORT_UPDATERES(kIOReportGetDimensions, result); - } - } + ASSERT_GATED(); -exit: - return super::configureReport(channelList, action, result, destination); + report = NULL; + if (channel_id == kAssertDelayChID) { + report = &assertOnWakeReport; + bktCnt = kAssertDelayBcktCnt; + bktSize = kAssertDelayBcktSize; + clientCnt = &assertOnWakeClientCnt; + } else if (channel_id == kSleepDelaysChID) { + report = &sleepDelaysReport; + bktCnt = kSleepDelaysBcktCnt; + bktSize = kSleepDelaysBcktSize; + clientCnt = &sleepDelaysClientCnt; + } + + switch (action) { + case kIOReportEnable: + + if (*report) { + (*clientCnt)++; + break; + } + + reportSize = HISTREPORT_BUFSIZE(bktCnt); + *report = IOMalloc(reportSize); + if (*report == NULL) { + break; + } + bzero(*report, reportSize); + HISTREPORT_INIT(bktCnt, bktSize, *report, reportSize, + getRegistryEntryID(), channel_id, kIOReportCategoryPower); + + if (channel_id == kAssertDelayChID) { + assertOnWakeSecs = 0; + } + + break; + + case kIOReportDisable: + if (*clientCnt == 0) { + break; + } + if (*clientCnt == 1) { + IOFree(*report, HISTREPORT_BUFSIZE(bktCnt)); + *report = NULL; + } + (*clientCnt)--; + + if (channel_id == kAssertDelayChID) { + assertOnWakeSecs = -1; // Invalid value to prevent updates + } + break; + + case kIOReportGetDimensions: + if (*report) { + HISTREPORT_UPDATERES(*report, kIOReportGetDimensions, result); + } + break; + } + + return; +} + +IOReturn +IOPMrootDomain::configureReport(IOReportChannelList *channelList, + IOReportConfigureAction action, + void *result, + void *destination) +{ + unsigned cnt; + uint64_t configAction = (uint64_t)action; + + for (cnt = 0; cnt < channelList->nchannels; cnt++) { + if ((channelList->channels[cnt].channel_id == kSleepCntChID) || + (channelList->channels[cnt].channel_id == kDarkWkCntChID) || + (channelList->channels[cnt].channel_id == kUserWkCntChID)) { + if (action != kIOReportGetDimensions) { + continue; + } + SIMPLEREPORT_UPDATERES(kIOReportGetDimensions, result); + } else if ((channelList->channels[cnt].channel_id == kAssertDelayChID) || + (channelList->channels[cnt].channel_id == kSleepDelaysChID)) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::configureReportGated), + (OSObject *)this, (void *)channelList->channels[cnt].channel_id, + (void *)configAction, (void *)result); + } + } + + return super::configureReport(channelList, action, result, destination); } +IOReturn +IOPMrootDomain::updateReportGated(uint64_t ch_id, void *result, IOBufferMemoryDescriptor *dest) +{ + uint32_t size2cpy; + void *data2cpy; + void **report; + + ASSERT_GATED(); + + report = NULL; + if (ch_id == kAssertDelayChID) { + report = &assertOnWakeReport; + } else if (ch_id == kSleepDelaysChID) { + report = &sleepDelaysReport; + } + + if (*report == NULL) { + return kIOReturnNotOpen; + } + + HISTREPORT_UPDATEPREP(*report, data2cpy, size2cpy); + if (size2cpy > (dest->getCapacity() - dest->getLength())) { + return kIOReturnOverrun; + } + + HISTREPORT_UPDATERES(*report, kIOReportCopyChannelData, result); + dest->appendBytes(data2cpy, size2cpy); + + return kIOReturnSuccess; +} -IOReturn IOPMrootDomain::updateReport(IOReportChannelList *channelList, - IOReportUpdateAction action, - void *result, - void *destination) +IOReturn +IOPMrootDomain::updateReport(IOReportChannelList *channelList, + IOReportUpdateAction action, + void *result, + void *destination) { - uint32_t size2cpy; - void *data2cpy; - uint8_t buf[SIMPLEREPORT_BUFSIZE]; - IOBufferMemoryDescriptor *dest = OSDynamicCast(IOBufferMemoryDescriptor, (OSObject *)destination); - unsigned cnt; - uint64_t ch_id; + uint32_t size2cpy; + void *data2cpy; + uint8_t buf[SIMPLEREPORT_BUFSIZE]; + IOBufferMemoryDescriptor *dest = OSDynamicCast(IOBufferMemoryDescriptor, (OSObject *)destination); + unsigned cnt; + uint64_t ch_id; - if (action != kIOReportCopyChannelData) goto exit; + if (action != kIOReportCopyChannelData) { + goto exit; + } - for (cnt = 0; cnt < channelList->nchannels; cnt++) { - ch_id = channelList->channels[cnt].channel_id ; + for (cnt = 0; cnt < channelList->nchannels; cnt++) { + ch_id = channelList->channels[cnt].channel_id; - if ((ch_id == kSleepCntChID) || - (ch_id == kDarkWkCntChID) || (ch_id == kUserWkCntChID)) { - SIMPLEREPORT_INIT(buf, sizeof(buf), getRegistryEntryID(), ch_id, kIOReportCategoryPower); - } - else continue; + if ((ch_id == kAssertDelayChID) || (ch_id == kSleepDelaysChID)) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::updateReportGated), + (OSObject *)this, (void *)ch_id, + (void *)result, (void *)dest); + continue; + } else if ((ch_id == kSleepCntChID) || + (ch_id == kDarkWkCntChID) || (ch_id == kUserWkCntChID)) { + SIMPLEREPORT_INIT(buf, sizeof(buf), getRegistryEntryID(), ch_id, kIOReportCategoryPower); + } else { + continue; + } - if (ch_id == kSleepCntChID) - SIMPLEREPORT_SETVALUE(buf, sleepCnt); - else if (ch_id == kDarkWkCntChID) - SIMPLEREPORT_SETVALUE(buf, darkWakeCnt); - else if (ch_id == kUserWkCntChID) - SIMPLEREPORT_SETVALUE(buf, displayWakeCnt); + if (ch_id == kSleepCntChID) { + SIMPLEREPORT_SETVALUE(buf, sleepCnt); + } else if (ch_id == kDarkWkCntChID) { + SIMPLEREPORT_SETVALUE(buf, darkWakeCnt); + } else if (ch_id == kUserWkCntChID) { + SIMPLEREPORT_SETVALUE(buf, displayWakeCnt); + } - SIMPLEREPORT_UPDATEPREP(buf, data2cpy, size2cpy); - SIMPLEREPORT_UPDATERES(kIOReportCopyChannelData, result); - dest->appendBytes(data2cpy, size2cpy); - } + SIMPLEREPORT_UPDATEPREP(buf, data2cpy, size2cpy); + SIMPLEREPORT_UPDATERES(kIOReportCopyChannelData, result); + dest->appendBytes(data2cpy, size2cpy); + } exit: - return super::updateReport(channelList, action, result, destination); + return super::updateReport(channelList, action, result, destination); } @@ -7270,183 +9033,210 @@ OSDefineMetaClassAndStructors(PMTraceWorker, OSObject) #define kPMBestGuessPCIDevicesCount 25 #define kPMMaxRTCBitfieldSize 32 -PMTraceWorker *PMTraceWorker::tracer(IOPMrootDomain *owner) +PMTraceWorker * PMTraceWorker::tracer(IOPMrootDomain * owner) { - PMTraceWorker *me; - - me = OSTypeAlloc( PMTraceWorker ); - if (!me || !me->init()) - { - return NULL; - } + PMTraceWorker *me; + + me = OSTypeAlloc( PMTraceWorker ); + if (!me || !me->init()) { + return NULL; + } - DLOG("PMTraceWorker %p\n", OBFUSCATE(me)); + DLOG("PMTraceWorker %p\n", OBFUSCATE(me)); - // Note that we cannot instantiate the PCI device -> bit mappings here, since - // the IODeviceTree has not yet been created by IOPlatformExpert. We create - // this dictionary lazily. - me->owner = owner; - me->pciDeviceBitMappings = NULL; - me->pciMappingLock = IOLockAlloc(); - me->tracePhase = kIOPMTracePointSystemUp; - me->loginWindowPhase = 0; - me->traceData32 = 0; - return me; + // Note that we cannot instantiate the PCI device -> bit mappings here, since + // the IODeviceTree has not yet been created by IOPlatformExpert. We create + // this dictionary lazily. + me->owner = owner; + me->pciDeviceBitMappings = NULL; + me->pmTraceWorkerLock = IOLockAlloc(); + me->tracePhase = kIOPMTracePointSystemUp; + me->traceData32 = 0; + me->loginWindowData = 0; + me->coreDisplayData = 0; + me->coreGraphicsData = 0; + return me; } -void PMTraceWorker::RTC_TRACE(void) +void +PMTraceWorker::RTC_TRACE(void) { - if (tracePointHandler && tracePointTarget) - { + if (tracePointHandler && tracePointTarget) { uint32_t wordA; - wordA = (tracePhase << 24) | (loginWindowPhase << 16) | - (traceData8 << 8); + IOLockLock(pmTraceWorkerLock); + wordA = (loginWindowData << 24) | (coreDisplayData << 16) | + (coreGraphicsData << 8) | tracePhase; + IOLockUnlock(pmTraceWorkerLock); - tracePointHandler( tracePointTarget, traceData32, wordA ); + tracePointHandler( tracePointTarget, traceData32, wordA ); _LOG("RTC_TRACE wrote 0x%08x 0x%08x\n", traceData32, wordA); } +#if DEVELOPMENT || DEBUG + if ((swd_panic_phase != 0) && (swd_panic_phase == tracePhase)) { + DEBUG_LOG("Causing sleep wake failure in phase 0x%08x\n", tracePhase); + IOLock *l = IOLockAlloc(); + IOLockLock(l); + IOLockLock(l); + } +#endif } -int PMTraceWorker::recordTopLevelPCIDevice(IOService * pciDevice) +int +PMTraceWorker::recordTopLevelPCIDevice(IOService * pciDevice) { - const OSSymbol * deviceName; - int index = -1; + const OSSymbol * deviceName; + int index = -1; - IOLockLock(pciMappingLock); + IOLockLock(pmTraceWorkerLock); - if (!pciDeviceBitMappings) - { - pciDeviceBitMappings = OSArray::withCapacity(kPMBestGuessPCIDevicesCount); - if (!pciDeviceBitMappings) - goto exit; - } + if (!pciDeviceBitMappings) { + pciDeviceBitMappings = OSArray::withCapacity(kPMBestGuessPCIDevicesCount); + if (!pciDeviceBitMappings) { + goto exit; + } + } - // Check for bitmask overflow. - if (pciDeviceBitMappings->getCount() >= kPMMaxRTCBitfieldSize) - goto exit; + // Check for bitmask overflow. + if (pciDeviceBitMappings->getCount() >= kPMMaxRTCBitfieldSize) { + goto exit; + } - if ((deviceName = pciDevice->copyName()) && - (pciDeviceBitMappings->getNextIndexOfObject(deviceName, 0) == (unsigned int)-1) && - pciDeviceBitMappings->setObject(deviceName)) - { - index = pciDeviceBitMappings->getCount() - 1; - _LOG("PMTrace PCI array: set object %s => %d\n", - deviceName->getCStringNoCopy(), index); - } - if (deviceName) - deviceName->release(); - if (!addedToRegistry && (index >= 0)) - addedToRegistry = owner->setProperty("PCITopLevel", this); + if ((deviceName = pciDevice->copyName()) && + (pciDeviceBitMappings->getNextIndexOfObject(deviceName, 0) == (unsigned int)-1) && + pciDeviceBitMappings->setObject(deviceName)) { + index = pciDeviceBitMappings->getCount() - 1; + _LOG("PMTrace PCI array: set object %s => %d\n", + deviceName->getCStringNoCopy(), index); + } + if (deviceName) { + deviceName->release(); + } + if (!addedToRegistry && (index >= 0)) { + addedToRegistry = owner->setProperty("PCITopLevel", this); + } exit: - IOLockUnlock(pciMappingLock); - return index; -} - -bool PMTraceWorker::serialize(OSSerialize *s) const -{ - bool ok = false; - if (pciDeviceBitMappings) - { - IOLockLock(pciMappingLock); - ok = pciDeviceBitMappings->serialize(s); - IOLockUnlock(pciMappingLock); - } - return ok; -} - -void PMTraceWorker::tracePoint(uint8_t phase) -{ - // clear trace detail when phase begins - if (tracePhase != phase) - traceData32 = 0; - - tracePhase = phase; - - DLOG("trace point 0x%02x\n", tracePhase); - RTC_TRACE(); + IOLockUnlock(pmTraceWorkerLock); + return index; } -void PMTraceWorker::tracePoint(uint8_t phase, uint8_t data8) +bool +PMTraceWorker::serialize(OSSerialize *s) const { - // clear trace detail when phase begins - if (tracePhase != phase) - traceData32 = 0; - - tracePhase = phase; - traceData8 = data8; - - DLOG("trace point 0x%02x 0x%02x\n", tracePhase, traceData8); - RTC_TRACE(); + bool ok = false; + if (pciDeviceBitMappings) { + IOLockLock(pmTraceWorkerLock); + ok = pciDeviceBitMappings->serialize(s); + IOLockUnlock(pmTraceWorkerLock); + } + return ok; } -void PMTraceWorker::traceDetail(uint32_t detail) +void +PMTraceWorker::tracePoint(uint8_t phase) { - if (kIOPMTracePointSleepPriorityClients != tracePhase) - return; + // clear trace detail when phase begins + if (tracePhase != phase) { + traceData32 = 0; + } - traceData32 = detail; - DLOG("trace point 0x%02x detail 0x%08x\n", tracePhase, traceData32); + tracePhase = phase; - RTC_TRACE(); + DLOG("trace point 0x%02x\n", tracePhase); + RTC_TRACE(); } -void PMTraceWorker::traceLoginWindowPhase(uint8_t phase) +void +PMTraceWorker::traceDetail(uint32_t detail) { - loginWindowPhase = phase; + if (detail == traceData32) { + return; + } + traceData32 = detail; + RTC_TRACE(); +} + +void +PMTraceWorker::traceComponentWakeProgress(uint32_t component, uint32_t data) +{ + switch (component) { + case kIOPMLoginWindowProgress: + loginWindowData = data & kIOPMLoginWindowProgressMask; + break; + case kIOPMCoreDisplayProgress: + coreDisplayData = data & kIOPMCoreDisplayProgressMask; + break; + case kIOPMCoreGraphicsProgress: + coreGraphicsData = data & kIOPMCoreGraphicsProgressMask; + break; + default: + return; + } - DLOG("loginwindow tracepoint 0x%02x\n", loginWindowPhase); - RTC_TRACE(); + DLOG("component trace point 0x%02x data 0x%08x\n", component, data); + RTC_TRACE(); } -void PMTraceWorker::tracePCIPowerChange( +void +PMTraceWorker::tracePCIPowerChange( change_t type, IOService *service, uint32_t changeFlags, uint32_t bitNum) { - uint32_t bitMask; - uint32_t expectedFlag; + uint32_t bitMask; + uint32_t expectedFlag; // Ignore PCI changes outside of system sleep/wake. - if ((kIOPMTracePointSleepPowerPlaneDrivers != tracePhase) && - (kIOPMTracePointWakePowerPlaneDrivers != tracePhase)) - return; + if ((kIOPMTracePointSleepPowerPlaneDrivers != tracePhase) && + (kIOPMTracePointWakePowerPlaneDrivers != tracePhase)) { + return; + } // Only record the WillChange transition when going to sleep, // and the DidChange on the way up. changeFlags &= (kIOPMDomainWillChange | kIOPMDomainDidChange); expectedFlag = (kIOPMTracePointSleepPowerPlaneDrivers == tracePhase) ? - kIOPMDomainWillChange : kIOPMDomainDidChange; - if (changeFlags != expectedFlag) + kIOPMDomainWillChange : kIOPMDomainDidChange; + if (changeFlags != expectedFlag) { return; + } - // Mark this device off in our bitfield - if (bitNum < kPMMaxRTCBitfieldSize) - { - bitMask = (1 << bitNum); + // Mark this device off in our bitfield + if (bitNum < kPMMaxRTCBitfieldSize) { + bitMask = (1 << bitNum); + + if (kPowerChangeStart == type) { + traceData32 |= bitMask; + _LOG("PMTrace: Device %s started - bit %2d mask 0x%08x => 0x%08x\n", + service->getName(), bitNum, bitMask, traceData32); + owner->kdebugTrace(kPMLogPCIDevChangeStart, service->getRegistryEntryID(), traceData32, 0); + } else { + traceData32 &= ~bitMask; + _LOG("PMTrace: Device %s finished - bit %2d mask 0x%08x => 0x%08x\n", + service->getName(), bitNum, bitMask, traceData32); + owner->kdebugTrace(kPMLogPCIDevChangeDone, service->getRegistryEntryID(), traceData32, 0); + } - if (kPowerChangeStart == type) - { - traceData32 |= bitMask; - _LOG("PMTrace: Device %s started - bit %2d mask 0x%08x => 0x%08x\n", - service->getName(), bitNum, bitMask, traceData32); - } - else - { - traceData32 &= ~bitMask; - _LOG("PMTrace: Device %s finished - bit %2d mask 0x%08x => 0x%08x\n", - service->getName(), bitNum, bitMask, traceData32); - } + DLOG("trace point 0x%02x detail 0x%08x\n", tracePhase, traceData32); + RTC_TRACE(); + } +} - DLOG("trace point 0x%02x detail 0x%08x\n", tracePhase, traceData32); - RTC_TRACE(); - } +uint64_t +PMTraceWorker::getPMStatusCode() +{ + return ((uint64_t)traceData32 << 32) | ((uint64_t)tracePhase); } -uint64_t PMTraceWorker::getPMStatusCode( ) +uint8_t +PMTraceWorker::getTracePhase() { - return (((uint64_t)traceData32 << 32) | (tracePhase << 24) | - (loginWindowPhase << 16) | (traceData8 << 8)); + return tracePhase; +} +uint32_t +PMTraceWorker::getTraceData() +{ + return traceData32; } // MARK: - @@ -7457,56 +9247,52 @@ uint64_t PMTraceWorker::getPMStatusCode( ) // //****************************************************************************** -static unsigned int gPMHaltBusyCount; -static unsigned int gPMHaltIdleCount; -static int gPMHaltDepth; -static unsigned long gPMHaltEvent; -static IOLock * gPMHaltLock = 0; -static OSArray * gPMHaltArray = 0; -static const OSSymbol * gPMHaltClientAcknowledgeKey = 0; - -PMHaltWorker * PMHaltWorker::worker( void ) +PMHaltWorker * +PMHaltWorker::worker( void ) { - PMHaltWorker * me; - IOThread thread; + PMHaltWorker * me; + IOThread thread; do { me = OSTypeAlloc( PMHaltWorker ); - if (!me || !me->init()) + if (!me || !me->init()) { break; + } me->lock = IOLockAlloc(); - if (!me->lock) + if (!me->lock) { break; + } DLOG("PMHaltWorker %p\n", OBFUSCATE(me)); - me->retain(); // thread holds extra retain - if (KERN_SUCCESS != kernel_thread_start(&PMHaltWorker::main, (void *) me, &thread)) - { + me->retain(); // thread holds extra retain + if (KERN_SUCCESS != kernel_thread_start(&PMHaltWorker::main, (void *) me, &thread)) { me->release(); break; } thread_deallocate(thread); return me; - } while (false); - if (me) me->release(); - return 0; + if (me) { + me->release(); + } + return NULL; } -void PMHaltWorker::free( void ) +void +PMHaltWorker::free( void ) { DLOG("PMHaltWorker free %p\n", OBFUSCATE(this)); - if (lock) - { + if (lock) { IOLockFree(lock); - lock = 0; + lock = NULL; } return OSObject::free(); } -void PMHaltWorker::main( void * arg, wait_result_t waitResult ) +void +PMHaltWorker::main( void * arg, wait_result_t waitResult ) { PMHaltWorker * me = (PMHaltWorker *) arg; @@ -7515,22 +9301,18 @@ void PMHaltWorker::main( void * arg, wait_result_t waitResult ) me->depth = gPMHaltDepth; IOLockUnlock( gPMHaltLock ); - while (me->depth >= 0) - { + while (me->depth >= 0) { PMHaltWorker::work( me ); IOLockLock( gPMHaltLock ); - if (++gPMHaltIdleCount >= gPMHaltBusyCount) - { + if (++gPMHaltIdleCount >= gPMHaltBusyCount) { // This is the last thread to finish work on this level, // inform everyone to start working on next lower level. gPMHaltDepth--; me->depth = gPMHaltDepth; gPMHaltIdleCount = 0; thread_wakeup((event_t) &gPMHaltIdleCount); - } - else - { + } else { // One or more threads are still working on this level, // this thread must wait. me->depth = gPMHaltDepth - 1; @@ -7547,68 +9329,65 @@ void PMHaltWorker::main( void * arg, wait_result_t waitResult ) me->release(); } -void PMHaltWorker::work( PMHaltWorker * me ) +void +PMHaltWorker::work( PMHaltWorker * me ) { - IOService * service; - OSSet * inner; - AbsoluteTime startTime; - UInt32 deltaTime; - bool timeout; + IOService * service; + OSSet * inner; + AbsoluteTime startTime, elapsedTime; + UInt32 deltaTime; + bool timeout; - while (true) - { - service = 0; + while (true) { + service = NULL; timeout = false; // Claim an unit of work from the shared pool IOLockLock( gPMHaltLock ); inner = (OSSet *)gPMHaltArray->getObject(me->depth); - if (inner) - { - service = (IOService *)inner->getAnyObject(); - if (service) - { + if (inner) { + service = OSDynamicCast(IOService, inner->getAnyObject()); + if (service) { service->retain(); inner->removeObject(service); } } - IOLockUnlock( gPMHaltLock ); - if (!service) - break; // no more work at this depth - + IOLockUnlock( gPMHaltLock ); + if (!service) { + break; // no more work at this depth + } clock_get_uptime(&startTime); if (!service->isInactive() && - service->setProperty(gPMHaltClientAcknowledgeKey, me)) - { + service->setProperty(gPMHaltClientAcknowledgeKey, me)) { IOLockLock(me->lock); me->startTime = startTime; me->service = service; me->timeout = false; IOLockUnlock(me->lock); - service->systemWillShutdown( gPMHaltEvent ); + service->systemWillShutdown( gPMHaltMessageType ); // Wait for driver acknowledgement IOLockLock(me->lock); - while (service->getProperty(gPMHaltClientAcknowledgeKey)) - { - IOLockSleep(me->lock, me, THREAD_UNINT); + while (service->getProperty(gPMHaltClientAcknowledgeKey)) { + IOLockSleep(me->lock, me, THREAD_UNINT); } - me->service = 0; + me->service = NULL; timeout = me->timeout; IOLockUnlock(me->lock); } - deltaTime = computeDeltaTimeMS(&startTime); - if ((deltaTime > kPMHaltTimeoutMS) || timeout || - (gIOKitDebug & kIOLogPMRootDomain)) - { - LOG("%s driver %s (%p) took %u ms\n", - (gPMHaltEvent == kIOMessageSystemWillPowerOff) ? - "PowerOff" : "Restart", - service->getName(), OBFUSCATE(service), - (uint32_t) deltaTime ); + deltaTime = computeDeltaTimeMS(&startTime, &elapsedTime); + if ((deltaTime > kPMHaltTimeoutMS) || timeout) { + LOG("%s driver %s (0x%llx) took %u ms\n", + (gPMHaltMessageType == kIOMessageSystemWillPowerOff) ? + "PowerOff" : "Restart", + service->getName(), service->getRegistryEntryID(), + (uint32_t) deltaTime ); + halt_log_enter("PowerOff/Restart handler completed", + OSMemberFunctionCast(const void *, service, &IOService::systemWillShutdown), + elapsedTime); } service->release(); @@ -7616,66 +9395,65 @@ void PMHaltWorker::work( PMHaltWorker * me ) } } -void PMHaltWorker::checkTimeout( PMHaltWorker * me, AbsoluteTime * now ) +void +PMHaltWorker::checkTimeout( PMHaltWorker * me, AbsoluteTime * now ) { - UInt64 nano; - AbsoluteTime startTime; - AbsoluteTime endTime; + UInt64 nano; + AbsoluteTime startTime; + AbsoluteTime endTime; endTime = *now; IOLockLock(me->lock); - if (me->service && !me->timeout) - { + if (me->service && !me->timeout) { startTime = me->startTime; nano = 0; - if (CMP_ABSOLUTETIME(&endTime, &startTime) > 0) - { + if (CMP_ABSOLUTETIME(&endTime, &startTime) > 0) { SUB_ABSOLUTETIME(&endTime, &startTime); absolutetime_to_nanoseconds(endTime, &nano); - } - if (nano > 3000000000ULL) - { + } + if (nano > 3000000000ULL) { me->timeout = true; + + halt_log_enter("PowerOff/Restart still waiting on handler", + OSMemberFunctionCast(const void *, me->service, &IOService::systemWillShutdown), + endTime); MSG("%s still waiting on %s\n", - (gPMHaltEvent == kIOMessageSystemWillPowerOff) ? - "PowerOff" : "Restart", - me->service->getName()); + (gPMHaltMessageType == kIOMessageSystemWillPowerOff) ? "PowerOff" : "Restart", + me->service->getName()); } } IOLockUnlock(me->lock); } - //****************************************************************************** // acknowledgeSystemWillShutdown // // Acknowledgement from drivers that they have prepared for shutdown/restart. //****************************************************************************** -void IOPMrootDomain::acknowledgeSystemWillShutdown( IOService * from ) +void +IOPMrootDomain::acknowledgeSystemWillShutdown( IOService * from ) { - PMHaltWorker * worker; - OSObject * prop; + PMHaltWorker * worker; + OSObject * prop; - if (!from) + if (!from) { return; + } //DLOG("%s acknowledged\n", from->getName()); prop = from->copyProperty( gPMHaltClientAcknowledgeKey ); - if (prop) - { + if (prop) { worker = (PMHaltWorker *) prop; IOLockLock(worker->lock); from->removeProperty( gPMHaltClientAcknowledgeKey ); thread_wakeup((event_t) worker); IOLockUnlock(worker->lock); worker->release(); - } - else - { + } else { DLOG("%s acknowledged without worker property\n", - from->getName()); + from->getName()); } } @@ -7687,80 +9465,87 @@ void IOPMrootDomain::acknowledgeSystemWillShutdown( IOService * from ) //****************************************************************************** static void -notifySystemShutdown( IOService * root, unsigned long event ) +notifySystemShutdown( IOService * root, uint32_t messageType ) { #define PLACEHOLDER ((OSSet *)gPMHaltArray) - IORegistryIterator * iter; - IORegistryEntry * entry; - IOService * node; - OSSet * inner; - PMHaltWorker * workers[kPMHaltMaxWorkers]; - AbsoluteTime deadline; - unsigned int totalNodes = 0; - unsigned int depth; - unsigned int rootDepth; - unsigned int numWorkers; - unsigned int count; - int waitResult; - void * baseFunc; - bool ok; - - DLOG("%s event = %lx\n", __FUNCTION__, event); + IORegistryIterator * iter; + IORegistryEntry * entry; + IOService * node; + OSSet * inner; + PMHaltWorker * workers[kPMHaltMaxWorkers]; + AbsoluteTime deadline; + unsigned int totalNodes = 0; + unsigned int depth; + unsigned int rootDepth; + unsigned int numWorkers; + unsigned int count; + int waitResult; + void * baseFunc; + bool ok; + + DLOG("%s msgType = 0x%x\n", __FUNCTION__, messageType); baseFunc = OSMemberFunctionCast(void *, root, &IOService::systemWillShutdown); // Iterate the entire PM tree starting from root rootDepth = root->getDepth( gIOPowerPlane ); - if (!rootDepth) goto done; + if (!rootDepth) { + goto done; + } // debug - for repeated test runs - while (PMHaltWorker::metaClass->getInstanceCount()) + while (PMHaltWorker::metaClass->getInstanceCount()) { IOSleep(1); + } - if (!gPMHaltArray) - { + if (!gPMHaltArray) { gPMHaltArray = OSArray::withCapacity(40); - if (!gPMHaltArray) goto done; - } - else // debug + if (!gPMHaltArray) { + goto done; + } + } else { // debug gPMHaltArray->flushCollection(); + } - if (!gPMHaltLock) - { + if (!gPMHaltLock) { gPMHaltLock = IOLockAlloc(); - if (!gPMHaltLock) goto done; + if (!gPMHaltLock) { + goto done; + } } - if (!gPMHaltClientAcknowledgeKey) - { + if (!gPMHaltClientAcknowledgeKey) { gPMHaltClientAcknowledgeKey = - OSSymbol::withCStringNoCopy("PMShutdown"); - if (!gPMHaltClientAcknowledgeKey) goto done; + OSSymbol::withCStringNoCopy("PMShutdown"); + if (!gPMHaltClientAcknowledgeKey) { + goto done; + } } - gPMHaltEvent = event; + gPMHaltMessageType = messageType; // Depth-first walk of PM plane iter = IORegistryIterator::iterateOver( root, gIOPowerPlane, kIORegistryIterateRecursively); - if (iter) - { - while ((entry = iter->getNextObject())) - { + if (iter) { + while ((entry = iter->getNextObject())) { node = OSDynamicCast(IOService, entry); - if (!node) + if (!node) { continue; + } - if (baseFunc == - OSMemberFunctionCast(void *, node, &IOService::systemWillShutdown)) + if (baseFunc == + OSMemberFunctionCast(void *, node, &IOService::systemWillShutdown)) { continue; + } depth = node->getDepth( gIOPowerPlane ); - if (depth <= rootDepth) + if (depth <= rootDepth) { continue; + } ok = false; @@ -7771,21 +9556,17 @@ notifySystemShutdown( IOService * root, unsigned long event ) // refers to nodes with the same depth. count = gPMHaltArray->getCount(); - while (depth >= count) - { + while (depth >= count) { // expand array and insert placeholders gPMHaltArray->setObject(PLACEHOLDER); count++; } count = gPMHaltArray->getCount(); - if (depth < count) - { + if (depth < count) { inner = (OSSet *)gPMHaltArray->getObject(depth); - if (inner == PLACEHOLDER) - { + if (inner == PLACEHOLDER) { inner = OSSet::withCapacity(40); - if (inner) - { + if (inner) { gPMHaltArray->replaceObject(depth, inner); inner->release(); } @@ -7793,42 +9574,44 @@ notifySystemShutdown( IOService * root, unsigned long event ) // PM nodes that appear more than once in the tree will have // the same depth, OSSet will refuse to add the node twice. - if (inner) + if (inner) { ok = inner->setObject(node); + } } - if (!ok) + if (!ok) { DLOG("Skipped PM node %s\n", node->getName()); + } } iter->release(); } // debug only - for (int i = 0; (inner = (OSSet *)gPMHaltArray->getObject(i)); i++) - { + for (int i = 0; (inner = (OSSet *)gPMHaltArray->getObject(i)); i++) { count = 0; - if (inner != PLACEHOLDER) + if (inner != PLACEHOLDER) { count = inner->getCount(); + } DLOG("Nodes at depth %u = %u\n", i, count); } // strip placeholders (not all depths are populated) numWorkers = 0; - for (int i = 0; (inner = (OSSet *)gPMHaltArray->getObject(i)); ) - { - if (inner == PLACEHOLDER) - { + for (int i = 0; (inner = (OSSet *)gPMHaltArray->getObject(i));) { + if (inner == PLACEHOLDER) { gPMHaltArray->removeObject(i); continue; } count = inner->getCount(); - if (count > numWorkers) + if (count > numWorkers) { numWorkers = count; + } totalNodes += count; i++; } - if (gPMHaltArray->getCount() == 0 || !numWorkers) + if (gPMHaltArray->getCount() == 0 || !numWorkers) { goto done; + } gPMHaltBusyCount = 0; gPMHaltIdleCount = 0; @@ -7836,34 +9619,34 @@ notifySystemShutdown( IOService * root, unsigned long event ) // Create multiple workers (and threads) - if (numWorkers > kPMHaltMaxWorkers) + if (numWorkers > kPMHaltMaxWorkers) { numWorkers = kPMHaltMaxWorkers; + } DLOG("PM nodes %u, maxDepth %u, workers %u\n", - totalNodes, gPMHaltArray->getCount(), numWorkers); + totalNodes, gPMHaltArray->getCount(), numWorkers); - for (unsigned int i = 0; i < numWorkers; i++) + for (unsigned int i = 0; i < numWorkers; i++) { workers[i] = PMHaltWorker::worker(); + } // Wait for workers to exhaust all available work IOLockLock(gPMHaltLock); - while (gPMHaltDepth >= 0) - { + while (gPMHaltDepth >= 0) { clock_interval_to_deadline(1000, kMillisecondScale, &deadline); waitResult = IOLockSleepDeadline( gPMHaltLock, &gPMHaltDepth, deadline, THREAD_UNINT); - if (THREAD_TIMED_OUT == waitResult) - { + if (THREAD_TIMED_OUT == waitResult) { AbsoluteTime now; clock_get_uptime(&now); IOLockUnlock(gPMHaltLock); - for (unsigned int i = 0 ; i < numWorkers; i++) - { - if (workers[i]) + for (unsigned int i = 0; i < numWorkers; i++) { + if (workers[i]) { PMHaltWorker::checkTimeout(workers[i], &now); + } } IOLockLock(gPMHaltLock); } @@ -7872,10 +9655,10 @@ notifySystemShutdown( IOService * root, unsigned long event ) // Release all workers - for (unsigned int i = 0; i < numWorkers; i++) - { - if (workers[i]) + for (unsigned int i = 0; i < numWorkers; i++) { + if (workers[i]) { workers[i]->release(); + } // worker also retained by it's own thread } @@ -7885,213 +9668,408 @@ done: } // MARK: - -// MARK: Sleep/Wake Logging +// MARK: Kernel Assertion -//********************************************************************************* -// Sleep/Wake logging -// -//********************************************************************************* +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +IOPMDriverAssertionID +IOPMrootDomain::createPMAssertion( + IOPMDriverAssertionType whichAssertionBits, + IOPMDriverAssertionLevel assertionLevel, + IOService *ownerService, + const char *ownerDescription) +{ + IOReturn ret; + IOPMDriverAssertionID newAssertion; + + if (!pmAssertions) { + return 0; + } -IOMemoryDescriptor *IOPMrootDomain::getPMTraceMemoryDescriptor(void) -{ - if (timeline) - return timeline->getPMTraceMemoryDescriptor(); - else - return NULL; -} - -// Forwards external reports of detailed events to IOPMTimeline -IOReturn IOPMrootDomain::recordPMEvent(PMEventDetails *details) -{ - if (timeline && details) { - - IOReturn rc; - - // Record a detailed driver power change event, or... - if(details->eventClassifier == kIOPMEventClassDriverEvent) { - rc = timeline->recordDetailedPowerEvent( details ); - } - - // Record a system power management event - else if(details->eventClassifier == kIOPMEventClassSystemEvent) { - rc = timeline->recordSystemPowerEvent( details ); - } - else { - return kIOReturnBadArgument; - } - - // If we get to record this message, then we've reached the - // end of another successful Sleep --> Wake cycle - // At this point, we pat ourselves in the back and allow - // our Sleep --> Wake UUID to be published - if(details->eventType == kIOPMEventTypeWakeDone) { - timeline->setSleepCycleInProgressFlag(false); - } + ret = pmAssertions->createAssertion(whichAssertionBits, assertionLevel, ownerService, ownerDescription, &newAssertion); -/* - // Check if its time to clear the timeline buffer - if(getProperty(kIOPMSleepWakeUUIDKey) - && timeline->isSleepCycleInProgress() == false - && timeline->getNumEventsLoggedThisPeriod() > 500) { - - // Clear the old UUID - if(pmPowerStateQueue) { - pmPowerStateQueue->submitPowerEvent(kPowerEventPublishSleepWakeUUID, (void *)false ); - } -*/ - return rc; - } - else - return kIOReturnNotReady; + if (kIOReturnSuccess == ret) { + return newAssertion; + } else { + return 0; + } } -void IOPMrootDomain::recordPMEvent( uint32_t type, - const char *uuid, - uint32_t reason, - uint32_t result ) +IOReturn +IOPMrootDomain::releasePMAssertion(IOPMDriverAssertionID releaseAssertion) { - PMEventDetails *details = PMEventDetails::eventDetails(type, uuid, reason, result); - if (details) - { - recordPMEvent(details); - details->release(); - } -} + if (!pmAssertions) { + return kIOReturnInternalError; + } -IOReturn IOPMrootDomain::recordAndReleasePMEvent(PMEventDetails *details) -{ - IOReturn ret = kIOReturnBadArgument; + return pmAssertions->releaseAssertion(releaseAssertion); +} - if (details) - { - ret = recordPMEvent(details); - details->release(); - } - return ret; +IOReturn +IOPMrootDomain::setPMAssertionLevel( + IOPMDriverAssertionID assertionID, + IOPMDriverAssertionLevel assertionLevel) +{ + return pmAssertions->setAssertionLevel(assertionID, assertionLevel); } -// MARK: - -// MARK: Kernel Assertion +IOPMDriverAssertionLevel +IOPMrootDomain::getPMAssertionLevel(IOPMDriverAssertionType whichAssertion) +{ + IOPMDriverAssertionType sysLevels; -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + if (!pmAssertions || whichAssertion == 0) { + return kIOPMDriverAssertionLevelOff; + } -IOPMDriverAssertionID IOPMrootDomain::createPMAssertion( - IOPMDriverAssertionType whichAssertionBits, - IOPMDriverAssertionLevel assertionLevel, - IOService *ownerService, - const char *ownerDescription) -{ - IOReturn ret; - IOPMDriverAssertionID newAssertion; - - if (!pmAssertions) - return 0; - - ret = pmAssertions->createAssertion(whichAssertionBits, assertionLevel, ownerService, ownerDescription, &newAssertion); + sysLevels = pmAssertions->getActivatedAssertions(); - if (kIOReturnSuccess == ret) - return newAssertion; - else - return 0; + // Check that every bit set in argument 'whichAssertion' is asserted + // in the aggregate bits. + if ((sysLevels & whichAssertion) == whichAssertion) { + return kIOPMDriverAssertionLevelOn; + } else { + return kIOPMDriverAssertionLevelOff; + } } -IOReturn IOPMrootDomain::releasePMAssertion(IOPMDriverAssertionID releaseAssertion) +IOReturn +IOPMrootDomain::setPMAssertionUserLevels(IOPMDriverAssertionType inLevels) { - if (!pmAssertions) - return kIOReturnInternalError; - - return pmAssertions->releaseAssertion(releaseAssertion); + if (!pmAssertions) { + return kIOReturnNotFound; + } + + return pmAssertions->setUserAssertionLevels(inLevels); } -IOReturn IOPMrootDomain::setPMAssertionLevel( - IOPMDriverAssertionID assertionID, - IOPMDriverAssertionLevel assertionLevel) +bool +IOPMrootDomain::serializeProperties( OSSerialize * s ) const { - return pmAssertions->setAssertionLevel(assertionID, assertionLevel); + if (pmAssertions) { + pmAssertions->publishProperties(); + } + return IOService::serializeProperties(s); } -IOPMDriverAssertionLevel IOPMrootDomain::getPMAssertionLevel(IOPMDriverAssertionType whichAssertion) +OSObject * +IOPMrootDomain::copyProperty( const char * aKey) const { - IOPMDriverAssertionType sysLevels; + OSObject *obj = NULL; + obj = IOService::copyProperty(aKey); + + if (obj) { + return obj; + } + + if (!strncmp(aKey, kIOPMSleepWakeWdogRebootKey, + sizeof(kIOPMSleepWakeWdogRebootKey))) { + if (swd_flags & SWD_BOOT_BY_SW_WDOG) { + return kOSBooleanTrue; + } else { + return kOSBooleanFalse; + } + } + + if (!strncmp(aKey, kIOPMSleepWakeWdogLogsValidKey, + sizeof(kIOPMSleepWakeWdogLogsValidKey))) { + if (swd_flags & SWD_VALID_LOGS) { + return kOSBooleanTrue; + } else { + return kOSBooleanFalse; + } + } + + /* + * XXX: We should get rid of "DesktopMode" property when 'kAppleClamshellCausesSleepKey' + * is set properly in darwake from sleep. For that, kIOPMEnableClamshell msg has to be + * issued by DisplayWrangler on darkwake. + */ + if (!strcmp(aKey, "DesktopMode")) { + if (desktopMode) { + return kOSBooleanTrue; + } else { + return kOSBooleanFalse; + } + } + if (!strcmp(aKey, "DisplayIdleForDemandSleep")) { + if (displayIdleForDemandSleep) { + return kOSBooleanTrue; + } else { + return kOSBooleanFalse; + } + } + + if (!strcmp(aKey, kIOPMDriverWakeEventsKey)) { + OSArray * array = NULL; + WAKEEVENT_LOCK(); + if (_systemWakeEventsArray && _systemWakeEventsArray->getCount()) { + OSCollection *collection = _systemWakeEventsArray->copyCollection(); + if (collection && !(array = OSDynamicCast(OSArray, collection))) { + collection->release(); + } + } + WAKEEVENT_UNLOCK(); + return array; + } + + if (!strcmp(aKey, kIOPMSleepStatisticsAppsKey)) { + OSArray * array = NULL; + IOLockLock(pmStatsLock); + if (pmStatsAppResponses && pmStatsAppResponses->getCount()) { + OSCollection *collection = pmStatsAppResponses->copyCollection(); + if (collection && !(array = OSDynamicCast(OSArray, collection))) { + collection->release(); + } + pmStatsAppResponses->flushCollection(); + } + IOLockUnlock(pmStatsLock); + return array; + } + + if (!strcmp(aKey, kIOPMIdleSleepPreventersKey)) { + OSArray *idleSleepList = NULL; + gRootDomain->copySleepPreventersList(&idleSleepList, NULL); + return idleSleepList; + } - if (!pmAssertions || whichAssertion == 0) - return kIOPMDriverAssertionLevelOff; + if (!strcmp(aKey, kIOPMSystemSleepPreventersKey)) { + OSArray *systemSleepList = NULL; + gRootDomain->copySleepPreventersList(NULL, &systemSleepList); + return systemSleepList; + } + + if (!strcmp(aKey, kIOPMIdleSleepPreventersWithIDKey)) { + OSArray *idleSleepList = NULL; + gRootDomain->copySleepPreventersListWithID(&idleSleepList, NULL); + return idleSleepList; + } - sysLevels = pmAssertions->getActivatedAssertions(); - - // Check that every bit set in argument 'whichAssertion' is asserted - // in the aggregate bits. - if ((sysLevels & whichAssertion) == whichAssertion) - return kIOPMDriverAssertionLevelOn; - else - return kIOPMDriverAssertionLevelOff; + if (!strcmp(aKey, kIOPMSystemSleepPreventersWithIDKey)) { + OSArray *systemSleepList = NULL; + gRootDomain->copySleepPreventersListWithID(NULL, &systemSleepList); + return systemSleepList; + } + return NULL; } -IOReturn IOPMrootDomain::setPMAssertionUserLevels(IOPMDriverAssertionType inLevels) -{ - if (!pmAssertions) - return kIOReturnNotFound; +// MARK: - +// MARK: Wake Event Reporting - return pmAssertions->setUserAssertionLevels(inLevels); +void +IOPMrootDomain::copyWakeReasonString( char * outBuf, size_t bufSize ) +{ + WAKEEVENT_LOCK(); + strlcpy(outBuf, gWakeReasonString, bufSize); + WAKEEVENT_UNLOCK(); } -bool IOPMrootDomain::serializeProperties( OSSerialize * s ) const +//****************************************************************************** +// acceptSystemWakeEvents +// +// Private control for the acceptance of driver wake event claims. +//****************************************************************************** + +void +IOPMrootDomain::acceptSystemWakeEvents( bool accept ) { - if (pmAssertions) - { - pmAssertions->publishProperties(); - } - return( IOService::serializeProperties(s) ); + bool logWakeReason = false; + + WAKEEVENT_LOCK(); + if (accept) { + if (!_systemWakeEventsArray) { + _systemWakeEventsArray = OSArray::withCapacity(4); + } + _acceptSystemWakeEvents = (_systemWakeEventsArray != NULL); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (!(_aotNow && (kIOPMWakeEventAOTExitFlags & _aotPendingFlags))) +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + { + gWakeReasonString[0] = '\0'; + if (_systemWakeEventsArray) { + _systemWakeEventsArray->flushCollection(); + } + } + } else { + _acceptSystemWakeEvents = false; +#if CONFIG_EMBEDDED + logWakeReason = gWakeReasonSysctlRegistered; +#if DEVELOPMENT + static int panic_allowed = -1; + + if ((panic_allowed == -1) && + (PE_parse_boot_argn("swd_wakereason_panic", &panic_allowed, sizeof(panic_allowed)) == false)) { + panic_allowed = 0; + } + + if (panic_allowed) { + size_t i = 0; + // Panic if wake reason is null or empty + for (i = 0; (i < strlen(gWakeReasonString)); i++) { + if ((gWakeReasonString[i] != ' ') && (gWakeReasonString[i] != '\t')) { + break; + } + } + if (i >= strlen(gWakeReasonString)) { + panic("Wake reason is empty\n"); + } + } +#endif +#endif + } + WAKEEVENT_UNLOCK(); + + if (logWakeReason) { + MSG("system wake events:%s\n", gWakeReasonString); + } } -OSObject * IOPMrootDomain::copyProperty( const char * aKey) const +//****************************************************************************** +// claimSystemWakeEvent +// +// For a driver to claim a device is the source/conduit of a system wake event. +//****************************************************************************** + +void +IOPMrootDomain::claimSystemWakeEvent( + IOService * device, + IOOptionBits flags, + const char * reason, + OSObject * details ) { - OSObject *obj = NULL; - obj = IOService::copyProperty(aKey); + const OSSymbol * deviceName = NULL; + OSNumber * deviceRegId = NULL; + OSNumber * claimTime = NULL; + OSData * flagsData = NULL; + OSString * reasonString = NULL; + OSDictionary * d = NULL; + uint64_t timestamp; + bool ok = false; + bool addWakeReason; + + pmEventTimeStamp(×tamp); - if (obj) return obj; + if (!device || !reason) { + return; + } + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + IOOptionBits aotFlags = 0; + bool needAOTEvaluate = FALSE; + + if (kIOPMAOTModeAddEventFlags & _aotMode) { + if (!strcmp("hold", reason) + || !strcmp("help", reason) + || !strcmp("menu", reason) + || !strcmp("stockholm", reason) + || !strcmp("ringer", reason) + || !strcmp("ringerab", reason) + || !strcmp("smc0", reason) + || !strcmp("AOP.RTPWakeupAP", reason) + || !strcmp("BT.OutboxNotEmpty", reason) + || !strcmp("WL.OutboxNotEmpty", reason)) { + flags |= kIOPMWakeEventAOTExit; + } + } + +#if DEVELOPMENT || DEBUG + if (_aotLingerTime && !strcmp("rtc", reason)) { + flags |= kIOPMWakeEventAOTPossibleExit; + } +#endif /* DEVELOPMENT || DEBUG */ +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + deviceName = device->copyName(gIOServicePlane); + deviceRegId = OSNumber::withNumber(device->getRegistryEntryID(), 64); + claimTime = OSNumber::withNumber(timestamp, 64); + flagsData = OSData::withBytes(&flags, sizeof(flags)); + reasonString = OSString::withCString(reason); + d = OSDictionary::withCapacity(5 + (details ? 1 : 0)); + if (!deviceName || !deviceRegId || !claimTime || !flagsData || !reasonString) { + goto done; + } - if (!strncmp(aKey, kIOPMSleepWakeWdogRebootKey, - sizeof(kIOPMSleepWakeWdogRebootKey))) { - if (swd_flags & SWD_BOOT_BY_WDOG) - return OSBoolean::withBoolean(true); - else - return OSBoolean::withBoolean(false); - - } + d->setObject(gIONameKey, deviceName); + d->setObject(gIORegistryEntryIDKey, deviceRegId); + d->setObject(kIOPMWakeEventTimeKey, claimTime); + d->setObject(kIOPMWakeEventFlagsKey, flagsData); + d->setObject(kIOPMWakeEventReasonKey, reasonString); + if (details) { + d->setObject(kIOPMWakeEventDetailsKey, details); + } - if (!strncmp(aKey, kIOPMSleepWakeWdogLogsValidKey, - sizeof(kIOPMSleepWakeWdogLogsValidKey))) { - if (swd_flags & SWD_VALID_LOGS) - return OSBoolean::withBoolean(true); - else - return OSBoolean::withBoolean(false); - - } + WAKEEVENT_LOCK(); + addWakeReason = _acceptSystemWakeEvents; +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (_aotMode) { + IOLog("claimSystemWakeEvent(%s, %s, 0x%x) 0x%x %d\n", reason, deviceName->getCStringNoCopy(), (int)flags, _aotPendingFlags, _aotReadyToFullWake); + } + aotFlags = (kIOPMWakeEventAOTFlags & flags); + aotFlags = (aotFlags & ~_aotPendingFlags); + needAOTEvaluate = false; + if (_aotNow && aotFlags) { + if (kIOPMWakeEventAOTPossibleExit & flags) { + _aotMetrics->possibleCount++; + } + if (kIOPMWakeEventAOTConfirmedPossibleExit & flags) { + _aotMetrics->confirmedPossibleCount++; + } + if (kIOPMWakeEventAOTRejectedPossibleExit & flags) { + _aotMetrics->rejectedPossibleCount++; + } + if (kIOPMWakeEventAOTExpiredPossibleExit & flags) { + _aotMetrics->expiredPossibleCount++; + } - /* - * XXX: We should get rid of "DesktopMode" property when 'kAppleClamshellCausesSleepKey' - * is set properly in darwake from sleep. For that, kIOPMEnableClamshell msg has to be - * issued by DisplayWrangler on darkwake. - */ - if (!strcmp(aKey, "DesktopMode")) { - if (desktopMode) - return OSBoolean::withBoolean(true); - else - return OSBoolean::withBoolean(false); - } - if (!strcmp(aKey, "DisplayIdleForDemandSleep")) { - if (displayIdleForDemandSleep) { - return OSBoolean::withBoolean(true); - } - else { - return OSBoolean::withBoolean(false); - } - } - return NULL; + _aotPendingFlags |= aotFlags; + addWakeReason = _aotNow && _systemWakeEventsArray && ((kIOPMWakeEventAOTExitFlags & aotFlags)); + needAOTEvaluate = _aotReadyToFullWake; + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + if (!gWakeReasonSysctlRegistered) { + // Lazy registration until the platform driver stops registering + // the same name. + gWakeReasonSysctlRegistered = true; +#if CONFIG_EMBEDDED + sysctl_register_oid(&sysctl__kern_wakereason); +#endif + } + if (addWakeReason) { + ok = _systemWakeEventsArray->setObject(d); + if (gWakeReasonString[0] != '\0') { + strlcat(gWakeReasonString, " ", sizeof(gWakeReasonString)); + } + strlcat(gWakeReasonString, reason, sizeof(gWakeReasonString)); + } + WAKEEVENT_UNLOCK(); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (needAOTEvaluate) { + aotEvaluate(NULL); + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ +done: + if (deviceName) { + deviceName->release(); + } + if (deviceRegId) { + deviceRegId->release(); + } + if (claimTime) { + claimTime->release(); + } + if (flagsData) { + flagsData->release(); + } + if (reasonString) { + reasonString->release(); + } + if (d) { + d->release(); + } } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ @@ -8101,16 +10079,16 @@ OSObject * IOPMrootDomain::copyProperty( const char * aKey) const OSDefineMetaClassAndStructors( PMSettingHandle, OSObject ) -void PMSettingHandle::free( void ) +void +PMSettingHandle::free( void ) { - if (pmso) - { - pmso->clientHandleFreed(); - pmso->release(); - pmso = 0; - } + if (pmso) { + pmso->clientHandleFreed(); + pmso->release(); + pmso = NULL; + } - OSObject::free(); + OSObject::free(); } // MARK: - @@ -8120,858 +10098,512 @@ void PMSettingHandle::free( void ) #define super OSObject OSDefineMetaClassAndFinalStructors( PMSettingObject, OSObject ) -/* +/* * Static constructor/initializer for PMSettingObject */ PMSettingObject *PMSettingObject::pmSettingObject( - IOPMrootDomain *parent_arg, - IOPMSettingControllerCallback handler_arg, - OSObject *target_arg, - uintptr_t refcon_arg, - uint32_t supportedPowerSources, - const OSSymbol * settings[], - OSObject **handle_obj) -{ - uint32_t settingCount = 0; - PMSettingObject *pmso = 0; - PMSettingHandle *pmsh = 0; - - if ( !parent_arg || !handler_arg || !settings || !handle_obj ) - return NULL; - - // count OSSymbol entries in NULL terminated settings array - while (settings[settingCount]) { - settingCount++; - } - if (0 == settingCount) - return NULL; - - pmso = new PMSettingObject; - if (!pmso || !pmso->init()) - goto fail; - - pmsh = new PMSettingHandle; - if (!pmsh || !pmsh->init()) - goto fail; - - queue_init(&pmso->calloutQueue); - pmso->parent = parent_arg; - pmso->func = handler_arg; - pmso->target = target_arg; - pmso->refcon = refcon_arg; - pmso->settingCount = settingCount; - - pmso->retain(); // handle holds a retain on pmso - pmsh->pmso = pmso; - pmso->pmsh = pmsh; - - pmso->publishedFeatureID = (uint32_t *)IOMalloc(sizeof(uint32_t)*settingCount); - if (pmso->publishedFeatureID) { - for (unsigned int i=0; ipublishPMSetting( settings[i], - supportedPowerSources, &pmso->publishedFeatureID[i] ); - } - } - - *handle_obj = pmsh; - return pmso; - -fail: - if (pmso) pmso->release(); - if (pmsh) pmsh->release(); - return NULL; -} - -void PMSettingObject::free( void ) -{ - if (publishedFeatureID) { - for (uint32_t i=0; iremovePublishedFeature( publishedFeatureID[i] ); - } - } - - IOFree(publishedFeatureID, sizeof(uint32_t) * settingCount); - } - - super::free(); -} + IOPMrootDomain * parent_arg, + IOPMSettingControllerCallback handler_arg, + OSObject * target_arg, + uintptr_t refcon_arg, + uint32_t supportedPowerSources, + const OSSymbol * settings[], + OSObject * *handle_obj) +{ + uint32_t settingCount = 0; + PMSettingObject *pmso = NULL; + PMSettingHandle *pmsh = NULL; + + if (!parent_arg || !handler_arg || !settings || !handle_obj) { + return NULL; + } -void PMSettingObject::dispatchPMSetting( const OSSymbol * type, OSObject * object ) -{ - (*func)(target, type, object, refcon); -} + // count OSSymbol entries in NULL terminated settings array + while (settings[settingCount]) { + settingCount++; + } + if (0 == settingCount) { + return NULL; + } -void PMSettingObject::clientHandleFreed( void ) -{ - parent->deregisterPMSettingObject(this); -} + pmso = new PMSettingObject; + if (!pmso || !pmso->init()) { + goto fail; + } -// MARK: - -// MARK: IOPMTimeline + pmsh = new PMSettingHandle; + if (!pmsh || !pmsh->init()) { + goto fail; + } -#undef super -#define super OSObject + queue_init(&pmso->calloutQueue); + pmso->parent = parent_arg; + pmso->func = handler_arg; + pmso->target = target_arg; + pmso->refcon = refcon_arg; + pmso->settingCount = settingCount; + + pmso->retain(); // handle holds a retain on pmso + pmsh->pmso = pmso; + pmso->pmsh = pmsh; + + pmso->publishedFeatureID = (uint32_t *)IOMalloc(sizeof(uint32_t) * settingCount); + if (pmso->publishedFeatureID) { + for (unsigned int i = 0; i < settingCount; i++) { + // Since there is now at least one listener to this setting, publish + // PM root domain support for it. + parent_arg->publishPMSetting( settings[i], + supportedPowerSources, &pmso->publishedFeatureID[i] ); + } + } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* + *handle_obj = pmsh; + return pmso; -IOPMTimeline *IOPMTimeline::timeline(IOPMrootDomain *root_domain) -{ - IOPMTimeline *myself; - - if (!root_domain) - return NULL; - - myself = new IOPMTimeline; - - if (myself) { - myself->owner = root_domain; - myself->init(); - } - - return myself; +fail: + if (pmso) { + pmso->release(); + } + if (pmsh) { + pmsh->release(); + } + return NULL; } -bool IOPMTimeline::init(void) +void +PMSettingObject::free( void ) { - if (!super::init()) { - return false; - } - - logLock = IOLockAlloc(); - - // Fresh timeline, no events logged yet - this->numEventsLoggedThisPeriod = 0; - this->sleepCycleInProgress = false; + if (publishedFeatureID) { + for (uint32_t i = 0; i < settingCount; i++) { + if (publishedFeatureID[i]) { + parent->removePublishedFeature( publishedFeatureID[i] ); + } + } - //this->setEventsRecordingLevel(1); // TODO - this->setEventsTrackedCount(kIOPMDefaultSystemEventsTracked); + IOFree(publishedFeatureID, sizeof(uint32_t) * settingCount); + } - return true; + super::free(); } -void IOPMTimeline::free(void) +void +PMSettingObject::dispatchPMSetting( const OSSymbol * type, OSObject * object ) { - if (pmTraceMemoryDescriptor) { - pmTraceMemoryDescriptor->release(); - pmTraceMemoryDescriptor = NULL; - } - - IOLockFree(logLock); - - super::free(); + (*func)(target, type, object, refcon); } -IOMemoryDescriptor *IOPMTimeline::getPMTraceMemoryDescriptor() +void +PMSettingObject::clientHandleFreed( void ) { - return pmTraceMemoryDescriptor; + parent->deregisterPMSettingObject(this); } +// MARK: - +// MARK: PMAssertionsTracker + //********************************************************************************* //********************************************************************************* //********************************************************************************* +// class PMAssertionsTracker Implementation -bool IOPMTimeline::setProperties(OSDictionary *d) +#define kAssertUniqueIDStart 500 + +PMAssertionsTracker * +PMAssertionsTracker::pmAssertionsTracker( IOPMrootDomain *rootDomain ) { - OSNumber *n = NULL; - OSBoolean *b = NULL; - bool changed = false; + PMAssertionsTracker *myself; - /* Changes size of detailed events buffer */ - n = (OSNumber *)d->getObject(kIOPMTimelineSystemNumberTrackedKey); - if (OSDynamicCast(OSNumber, n)) - { - changed = true; - this->setEventsTrackedCount(n->unsigned32BitValue()); - } + myself = new PMAssertionsTracker; + if (myself) { + myself->init(); + myself->owner = rootDomain; + myself->issuingUniqueID = kAssertUniqueIDStart; + myself->assertionsArray = OSArray::withCapacity(5); + myself->assertionsKernel = 0; + myself->assertionsUser = 0; + myself->assertionsCombined = 0; + myself->assertionsArrayLock = IOLockAlloc(); + myself->tabulateProducerCount = myself->tabulateConsumerCount = 0; - /* enables or disables system events */ - b = (OSBoolean *)d->getObject(kIOPMTimelineEnabledKey); - if (b) - { - changed = true; - this->setEventsRecordingLevel((int)(kOSBooleanTrue == b)); - } + if (!myself->assertionsArray || !myself->assertionsArrayLock) { + myself = NULL; + } + } - return changed; + return myself; } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* - -OSDictionary *IOPMTimeline::copyInfoDictionary(void) +/* tabulate + * - Update assertionsKernel to reflect the state of all + * assertions in the kernel. + * - Update assertionsCombined to reflect both kernel & user space. + */ +void +PMAssertionsTracker::tabulate(void) { - OSDictionary *out = OSDictionary::withCapacity(3); - OSNumber *n = NULL; + int i; + int count; + PMAssertStruct *_a = NULL; + OSData *_d = NULL; - if (!out || !hdr) - return NULL; + IOPMDriverAssertionType oldKernel = assertionsKernel; + IOPMDriverAssertionType oldCombined = assertionsCombined; - n = OSNumber::withNumber(hdr->sizeEntries, 32); - out->setObject(kIOPMTimelineSystemNumberTrackedKey, n); - n->release(); - - n = OSNumber::withNumber(hdr->sizeBytes, 32); - out->setObject(kIOPMTimelineSystemBufferSizeKey, n); - n->release(); + ASSERT_GATED(); - // bool - out->setObject(kIOPMTimelineEnabledKey, eventsRecordingLevel ? kOSBooleanTrue : kOSBooleanFalse); + assertionsKernel = 0; + assertionsCombined = 0; - return out; -} + if (!assertionsArray) { + return; + } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* + if ((count = assertionsArray->getCount())) { + for (i = 0; i < count; i++) { + _d = OSDynamicCast(OSData, assertionsArray->getObject(i)); + if (_d) { + _a = (PMAssertStruct *)_d->getBytesNoCopy(); + if (_a && (kIOPMDriverAssertionLevelOn == _a->level)) { + assertionsKernel |= _a->assertionBits; + } + } + } + } -/* IOPMTimeline::recordSystemPowerEvent() - * - * Expected "type" arguments are listed in IOPMPrivate.h under enum "SystemEventTypes" - * Type arguments include "system events", and "Intermediate events" - * - * - System Events have paired "start" and "stop" events. - * - A start event shall be followed by a stop event. - * - Any number of Intermediate Events may fall between the - * start and stop events. - * - Intermediate events are meaningless outside the bounds of a system event's - * start & stoup routines. - * - It's invalid to record a Start event without a following Stop event; e.g. two - * Start events without an intervenining Stop event is invalid. - * - * Buffer invariants - * - The first recorded system event shall be preceded by an entry with type == 0 - * - IOPMTimeline may choose not to record intermediate events while there's not - * a system event in process. - */ -IOReturn IOPMTimeline::recordSystemPowerEvent( PMEventDetails *details ) -{ - static bool wakeDonePending = true; - IOPMSystemEventRecord *record_to = NULL; - OSString *swUUIDKey = NULL; - uint32_t useIndex = 0; - - if (!details) - return kIOReturnBadArgument; - - if (!traceBuffer) - return kIOReturnNotReady; - - if (details->eventType == kIOPMEventTypeWakeDone) - { - if(!wakeDonePending) - return kIOReturnBadArgument; - } - - IOLockLock(logLock); - - if (details->eventType == kIOPMEventTypeWake) { - wakeDonePending = true; - } else if (details->eventType == kIOPMEventTypeWakeDone) { - wakeDonePending = false; - } - - systemState = details->eventType; - - useIndex = _atomicIndexIncrement(&hdr->index, hdr->sizeEntries); - - // The entry immediately after the latest entry (and thus - // immediately before the first entry) shall have a type 0. - if (useIndex + 1 >= hdr->sizeEntries) { - traceBuffer[useIndex + 1].eventType = 0; - } else { - traceBuffer[0].eventType = 0; - } - - record_to = &traceBuffer[useIndex]; - bzero(record_to, sizeof(IOPMSystemEventRecord)); - - /*****/ - record_to->eventType = details->eventType; - record_to->eventReason = details->reason; - record_to->eventResult = details->result; - pmEventTimeStamp(&record_to->timestamp); - - // If caller doesn't provide a UUID, we'll use the UUID that's posted - // on IOPMrootDomain under key kIOPMSleepWakeUUIDKey - if (!details->uuid) { - swUUIDKey = OSDynamicCast(OSString, owner->copyProperty(kIOPMSleepWakeUUIDKey)); - - if (swUUIDKey) - details->uuid = swUUIDKey->getCStringNoCopy(); - } - - if (details->uuid) - strncpy(record_to->uuid, details->uuid, kMaxPMStringLength); - - if (swUUIDKey) - swUUIDKey->release(); - - numEventsLoggedThisPeriod++; - /*****/ - - IOLockUnlock(logLock); - - return kIOReturnSuccess; + tabulateProducerCount++; + assertionsCombined = assertionsKernel | assertionsUser; + if ((assertionsKernel != oldKernel) || + (assertionsCombined != oldCombined)) { + owner->evaluateAssertions(assertionsCombined, oldCombined); + } } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* - -IOReturn IOPMTimeline::recordDetailedPowerEvent( PMEventDetails *details ) +void +PMAssertionsTracker::publishProperties( void ) { - IOPMSystemEventRecord *record_to = NULL; - uint32_t useIndex; + OSArray *assertionsSummary = NULL; - if (!details->eventType || !details->ownerName) - return kIOReturnBadArgument; - - IOLockLock(logLock); + if (tabulateConsumerCount != tabulateProducerCount) { + IOLockLock(assertionsArrayLock); - useIndex = _atomicIndexIncrement(&hdr->index, hdr->sizeEntries); - - record_to = (IOPMSystemEventRecord *)&traceBuffer[useIndex]; - bzero(record_to, sizeof(IOPMSystemEventRecord)); + tabulateConsumerCount = tabulateProducerCount; - /*****/ - record_to->eventType = details->eventType; - if (details->ownerName && (strlen(details->ownerName) > 1)) { - strlcpy( record_to->ownerName, - details->ownerName, - sizeof(record_to->ownerName)); - } - - record_to->ownerDisambiguateID = details->ownerUnique; - - if (details->interestName && (strlen(details->interestName) > 1)) { - strlcpy(record_to->interestName, - details->interestName, - sizeof(record_to->interestName)); - } - - record_to->oldState = details->oldState; - record_to->newState = details->newState; - record_to->eventResult = details->result; - record_to->elapsedTimeUS = details->elapsedTimeUS; - pmEventTimeStamp(&record_to->timestamp); - - numEventsLoggedThisPeriod++; - /*****/ + /* Publish the IOPMrootDomain property "DriverPMAssertionsDetailed" + */ + assertionsSummary = copyAssertionsArray(); + if (assertionsSummary) { + owner->setProperty(kIOPMAssertionsDriverDetailedKey, assertionsSummary); + assertionsSummary->release(); + } else { + owner->removeProperty(kIOPMAssertionsDriverDetailedKey); + } - IOLockUnlock(logLock); - return kIOReturnSuccess; -} + /* Publish the IOPMrootDomain property "DriverPMAssertions" + */ + owner->setProperty(kIOPMAssertionsDriverKey, assertionsKernel, 64); -uint32_t IOPMTimeline::getNumEventsLoggedThisPeriod() { - return this->numEventsLoggedThisPeriod; + IOLockUnlock(assertionsArrayLock); + } } -void IOPMTimeline::setNumEventsLoggedThisPeriod(uint32_t newCount) { - this->numEventsLoggedThisPeriod = newCount; -} +PMAssertionsTracker::PMAssertStruct * +PMAssertionsTracker::detailsForID(IOPMDriverAssertionID _id, int *index) +{ + PMAssertStruct *_a = NULL; + OSData *_d = NULL; + int found = -1; + int count = 0; + int i = 0; + + if (assertionsArray + && (count = assertionsArray->getCount())) { + for (i = 0; i < count; i++) { + _d = OSDynamicCast(OSData, assertionsArray->getObject(i)); + if (_d) { + _a = (PMAssertStruct *)_d->getBytesNoCopy(); + if (_a && (_id == _a->id)) { + found = i; + break; + } + } + } + } -bool IOPMTimeline::isSleepCycleInProgress() { - return this->sleepCycleInProgress; + if (-1 == found) { + return NULL; + } else { + if (index) { + *index = found; + } + return _a; + } } -void IOPMTimeline::setSleepCycleInProgressFlag(bool flag) { - this->sleepCycleInProgress = flag; -} -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* - -void IOPMTimeline::setEventsTrackedCount(uint32_t newTracked) +/* PMAssertionsTracker::handleCreateAssertion + * Perform assertion work on the PM workloop. Do not call directly. + */ +IOReturn +PMAssertionsTracker::handleCreateAssertion(OSData *newAssertion) { - size_t make_buf_size = 0; - - make_buf_size = sizeof(IOPMTraceBufferHeader) + (newTracked * sizeof(IOPMSystemEventRecord)); - - IOLockLock(logLock); + ASSERT_GATED(); - if (pmTraceMemoryDescriptor) { - pmTraceMemoryDescriptor->release(); - pmTraceMemoryDescriptor = NULL; - } + if (newAssertion) { + IOLockLock(assertionsArrayLock); + assertionsArray->setObject(newAssertion); + IOLockUnlock(assertionsArrayLock); + newAssertion->release(); - hdr = NULL; - traceBuffer = NULL; - - if (0 == newTracked) - { - IOLog("IOPMrootDomain -> erased buffer.\n"); - goto exit; - } - - pmTraceMemoryDescriptor = IOBufferMemoryDescriptor::withOptions( - kIOMemoryKernelUserShared | kIODirectionIn | kIOMemoryMapperNone, - make_buf_size); - - if (!pmTraceMemoryDescriptor) - { - IOLog("IOPMRootDomain -> IOBufferMemoryDescriptor(%d) returns NULL\n", (int)make_buf_size); - goto exit; - } - - pmTraceMemoryDescriptor->prepare(kIODirectionIn); - - // Header occupies the first sizeof(IOPMTraceBufferHeader) bytes - hdr = (IOPMTraceBufferHeader *)pmTraceMemoryDescriptor->getBytesNoCopy(); - - // Recorded events occupy the remaining bulk of the buffer - traceBuffer = (IOPMSystemEventRecord *)((uint8_t *)hdr + sizeof(IOPMTraceBufferHeader)); - - bzero(hdr, make_buf_size); - - hdr->sizeBytes = make_buf_size; - hdr->sizeEntries = newTracked; - - IOLog("IOPMRootDomain -> IOBufferMemoryDescriptor(%d) returns bufferMB with address 0x%08x\n", (int)make_buf_size, (unsigned int)(uintptr_t)traceBuffer); - -exit: - IOLockUnlock(logLock); + tabulate(); + } + return kIOReturnSuccess; } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* - -void IOPMTimeline::setEventsRecordingLevel(uint32_t eventsTrackedBits) -{ +/* PMAssertionsTracker::createAssertion + * createAssertion allocates memory for a new PM assertion, and affects system behavior, if + * appropiate. + */ +IOReturn +PMAssertionsTracker::createAssertion( + IOPMDriverAssertionType which, + IOPMDriverAssertionLevel level, + IOService *serviceID, + const char *whoItIs, + IOPMDriverAssertionID *outID) +{ + OSData *dataStore = NULL; + PMAssertStruct track; + + // Warning: trillions and trillions of created assertions may overflow the unique ID. + track.id = OSIncrementAtomic64((SInt64*) &issuingUniqueID); + track.level = level; + track.assertionBits = which; + track.ownerString = whoItIs ? OSSymbol::withCString(whoItIs):NULL; + track.ownerService = serviceID; + track.registryEntryID = serviceID ? serviceID->getRegistryEntryID():0; + track.modifiedTime = 0; + pmEventTimeStamp(&track.createdTime); + + dataStore = OSData::withBytes(&track, sizeof(PMAssertStruct)); + if (!dataStore) { + if (track.ownerString) { + track.ownerString->release(); + } + return kIOReturnNoMemory; + } - // TODO + *outID = track.id; - return; + if (owner && owner->pmPowerStateQueue) { + owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionCreate, (void *)dataStore); + } + return kIOReturnSuccess; } -/* static helper to IOPMTimeline +/* PMAssertionsTracker::handleReleaseAssertion + * Runs in PM workloop. Do not call directly. */ -uint32_t IOPMTimeline::_atomicIndexIncrement(uint32_t *index, uint32_t limit) +IOReturn +PMAssertionsTracker::handleReleaseAssertion( + IOPMDriverAssertionID _id) { - uint32_t was_index; - uint32_t inc_index; - - if(!index) - return NULL; - - do { - was_index = *index; - inc_index = (was_index+1)%limit; - } while (!OSCompareAndSwap(was_index, inc_index, index)); + ASSERT_GATED(); - return inc_index; -} + int index; + PMAssertStruct *assertStruct = detailsForID(_id, &index); -// MARK: - -// MARK: PMAssertionsTracker + if (!assertStruct) { + return kIOReturnNotFound; + } -//********************************************************************************* -//********************************************************************************* -//********************************************************************************* -// class PMAssertionsTracker Implementation + IOLockLock(assertionsArrayLock); + if (assertStruct->ownerString) { + assertStruct->ownerString->release(); + } -#define kAssertUniqueIDStart 500 + assertionsArray->removeObject(index); + IOLockUnlock(assertionsArrayLock); -PMAssertionsTracker *PMAssertionsTracker::pmAssertionsTracker( IOPMrootDomain *rootDomain ) -{ - PMAssertionsTracker *myself; - - myself = new PMAssertionsTracker; - - if (myself) { - myself->init(); - myself->owner = rootDomain; - myself->issuingUniqueID = kAssertUniqueIDStart; - myself->assertionsArray = OSArray::withCapacity(5); - myself->assertionsKernel = 0; - myself->assertionsUser = 0; - myself->assertionsCombined = 0; - myself->assertionsArrayLock = IOLockAlloc(); - myself->tabulateProducerCount = myself->tabulateConsumerCount = 0; - - if (!myself->assertionsArray || !myself->assertionsArrayLock) - myself = NULL; - } - - return myself; + tabulate(); + return kIOReturnSuccess; } -/* tabulate - * - Update assertionsKernel to reflect the state of all - * assertions in the kernel. - * - Update assertionsCombined to reflect both kernel & user space. +/* PMAssertionsTracker::releaseAssertion + * Releases an assertion and affects system behavior if appropiate. + * Actual work happens on PM workloop. */ -void PMAssertionsTracker::tabulate(void) -{ - int i; - int count; - PMAssertStruct *_a = NULL; - OSData *_d = NULL; - - IOPMDriverAssertionType oldKernel = assertionsKernel; - IOPMDriverAssertionType oldCombined = assertionsCombined; - - ASSERT_GATED(); - - assertionsKernel = 0; - assertionsCombined = 0; - - if (!assertionsArray) - return; - - if ((count = assertionsArray->getCount())) - { - for (i=0; igetObject(i)); - if (_d) - { - _a = (PMAssertStruct *)_d->getBytesNoCopy(); - if (_a && (kIOPMDriverAssertionLevelOn == _a->level)) - assertionsKernel |= _a->assertionBits; - } - } - } - - tabulateProducerCount++; - assertionsCombined = assertionsKernel | assertionsUser; - - if ((assertionsKernel != oldKernel) || - (assertionsCombined != oldCombined)) - { - owner->evaluateAssertions(assertionsCombined, oldCombined); - } -} - -void PMAssertionsTracker::publishProperties( void ) -{ - OSArray *assertionsSummary = NULL; - - if (tabulateConsumerCount != tabulateProducerCount) - { - IOLockLock(assertionsArrayLock); - - tabulateConsumerCount = tabulateProducerCount; - - /* Publish the IOPMrootDomain property "DriverPMAssertionsDetailed" - */ - assertionsSummary = copyAssertionsArray(); - if (assertionsSummary) - { - owner->setProperty(kIOPMAssertionsDriverDetailedKey, assertionsSummary); - assertionsSummary->release(); - } - else - { - owner->removeProperty(kIOPMAssertionsDriverDetailedKey); - } - - /* Publish the IOPMrootDomain property "DriverPMAssertions" - */ - owner->setProperty(kIOPMAssertionsDriverKey, assertionsKernel, 64); - - IOLockUnlock(assertionsArrayLock); - } -} - -PMAssertionsTracker::PMAssertStruct *PMAssertionsTracker::detailsForID(IOPMDriverAssertionID _id, int *index) -{ - PMAssertStruct *_a = NULL; - OSData *_d = NULL; - int found = -1; - int count = 0; - int i = 0; - - if (assertionsArray - && (count = assertionsArray->getCount())) - { - for (i=0; igetObject(i)); - if (_d) - { - _a = (PMAssertStruct *)_d->getBytesNoCopy(); - if (_a && (_id == _a->id)) { - found = i; - break; - } - } - } - } - - if (-1 == found) { - return NULL; - } else { - if (index) - *index = found; - return _a; - } +IOReturn +PMAssertionsTracker::releaseAssertion( + IOPMDriverAssertionID _id) +{ + if (owner && owner->pmPowerStateQueue) { + owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionRelease, NULL, _id); + } + return kIOReturnSuccess; } -/* PMAssertionsTracker::handleCreateAssertion - * Perform assertion work on the PM workloop. Do not call directly. +/* PMAssertionsTracker::handleSetAssertionLevel + * Runs in PM workloop. Do not call directly. */ -IOReturn PMAssertionsTracker::handleCreateAssertion(OSData *newAssertion) +IOReturn +PMAssertionsTracker::handleSetAssertionLevel( + IOPMDriverAssertionID _id, + IOPMDriverAssertionLevel _level) { - ASSERT_GATED(); + PMAssertStruct *assertStruct = detailsForID(_id, NULL); + + ASSERT_GATED(); - if (newAssertion) - { - IOLockLock(assertionsArrayLock); - assertionsArray->setObject(newAssertion); - IOLockUnlock(assertionsArrayLock); - newAssertion->release(); + if (!assertStruct) { + return kIOReturnNotFound; + } + + IOLockLock(assertionsArrayLock); + pmEventTimeStamp(&assertStruct->modifiedTime); + assertStruct->level = _level; + IOLockUnlock(assertionsArrayLock); - tabulate(); - } - return kIOReturnSuccess; + tabulate(); + return kIOReturnSuccess; } -/* PMAssertionsTracker::createAssertion - * createAssertion allocates memory for a new PM assertion, and affects system behavior, if - * appropiate. +/* PMAssertionsTracker::setAssertionLevel */ -IOReturn PMAssertionsTracker::createAssertion( - IOPMDriverAssertionType which, - IOPMDriverAssertionLevel level, - IOService *serviceID, - const char *whoItIs, - IOPMDriverAssertionID *outID) -{ - OSData *dataStore = NULL; - PMAssertStruct track; - - // Warning: trillions and trillions of created assertions may overflow the unique ID. - track.id = OSIncrementAtomic64((SInt64*) &issuingUniqueID); - track.level = level; - track.assertionBits = which; - track.ownerString = whoItIs ? OSSymbol::withCString(whoItIs):0; - track.ownerService = serviceID; - track.registryEntryID = serviceID ? serviceID->getRegistryEntryID():0; - track.modifiedTime = 0; - pmEventTimeStamp(&track.createdTime); - - dataStore = OSData::withBytes(&track, sizeof(PMAssertStruct)); - if (!dataStore) - { - if (track.ownerString) - track.ownerString->release(); - return kIOReturnNoMemory; - } - - *outID = track.id; - - if (owner && owner->pmPowerStateQueue) { - owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionCreate, (void *)dataStore); - } - - return kIOReturnSuccess; +IOReturn +PMAssertionsTracker::setAssertionLevel( + IOPMDriverAssertionID _id, + IOPMDriverAssertionLevel _level) +{ + if (owner && owner->pmPowerStateQueue) { + owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionSetLevel, + (void *)(uintptr_t)_level, _id); + } + + return kIOReturnSuccess; } -/* PMAssertionsTracker::handleReleaseAssertion - * Runs in PM workloop. Do not call directly. - */ -IOReturn PMAssertionsTracker::handleReleaseAssertion( - IOPMDriverAssertionID _id) +IOReturn +PMAssertionsTracker::handleSetUserAssertionLevels(void * arg0) { - ASSERT_GATED(); + IOPMDriverAssertionType new_user_levels = *(IOPMDriverAssertionType *) arg0; - int index; - PMAssertStruct *assertStruct = detailsForID(_id, &index); - - if (!assertStruct) - return kIOReturnNotFound; + ASSERT_GATED(); - IOLockLock(assertionsArrayLock); - if (assertStruct->ownerString) - assertStruct->ownerString->release(); + if (new_user_levels != assertionsUser) { + assertionsUser = new_user_levels; + DLOG("assertionsUser 0x%llx\n", assertionsUser); + } - assertionsArray->removeObject(index); - IOLockUnlock(assertionsArrayLock); - - tabulate(); - return kIOReturnSuccess; + tabulate(); + return kIOReturnSuccess; } -/* PMAssertionsTracker::releaseAssertion - * Releases an assertion and affects system behavior if appropiate. - * Actual work happens on PM workloop. - */ -IOReturn PMAssertionsTracker::releaseAssertion( - IOPMDriverAssertionID _id) +IOReturn +PMAssertionsTracker::setUserAssertionLevels( + IOPMDriverAssertionType new_user_levels) { - if (owner && owner->pmPowerStateQueue) { - owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionRelease, 0, _id); - } - return kIOReturnSuccess; + if (gIOPMWorkLoop) { + gIOPMWorkLoop->runAction( + OSMemberFunctionCast( + IOWorkLoop::Action, + this, + &PMAssertionsTracker::handleSetUserAssertionLevels), + this, + (void *) &new_user_levels, NULL, NULL, NULL); + } + + return kIOReturnSuccess; } -/* PMAssertionsTracker::handleSetAssertionLevel - * Runs in PM workloop. Do not call directly. - */ -IOReturn PMAssertionsTracker::handleSetAssertionLevel( - IOPMDriverAssertionID _id, - IOPMDriverAssertionLevel _level) + +OSArray * +PMAssertionsTracker::copyAssertionsArray(void) { - PMAssertStruct *assertStruct = detailsForID(_id, NULL); + int count; + int i; + OSArray *outArray = NULL; - ASSERT_GATED(); + if (!assertionsArray || + (0 == (count = assertionsArray->getCount())) || + (NULL == (outArray = OSArray::withCapacity(count)))) { + goto exit; + } - if (!assertStruct) { - return kIOReturnNotFound; - } + for (i = 0; i < count; i++) { + PMAssertStruct *_a = NULL; + OSData *_d = NULL; + OSDictionary *details = NULL; - IOLockLock(assertionsArrayLock); - pmEventTimeStamp(&assertStruct->modifiedTime); - assertStruct->level = _level; - IOLockUnlock(assertionsArrayLock); + _d = OSDynamicCast(OSData, assertionsArray->getObject(i)); + if (_d && (_a = (PMAssertStruct *)_d->getBytesNoCopy())) { + OSNumber *_n = NULL; - tabulate(); - return kIOReturnSuccess; -} + details = OSDictionary::withCapacity(7); + if (!details) { + continue; + } -/* PMAssertionsTracker::setAssertionLevel - */ -IOReturn PMAssertionsTracker::setAssertionLevel( - IOPMDriverAssertionID _id, - IOPMDriverAssertionLevel _level) -{ - if (owner && owner->pmPowerStateQueue) { - owner->pmPowerStateQueue->submitPowerEvent(kPowerEventAssertionSetLevel, - (void *)(uintptr_t)_level, _id); - } - - return kIOReturnSuccess; -} - -IOReturn PMAssertionsTracker::handleSetUserAssertionLevels(void * arg0) -{ - IOPMDriverAssertionType new_user_levels = *(IOPMDriverAssertionType *) arg0; - - ASSERT_GATED(); - - if (new_user_levels != assertionsUser) - { - assertionsUser = new_user_levels; - DLOG("assertionsUser 0x%llx\n", assertionsUser); - } - - tabulate(); - return kIOReturnSuccess; -} - -IOReturn PMAssertionsTracker::setUserAssertionLevels( - IOPMDriverAssertionType new_user_levels) -{ - if (gIOPMWorkLoop) { - gIOPMWorkLoop->runAction( - OSMemberFunctionCast( - IOWorkLoop::Action, - this, - &PMAssertionsTracker::handleSetUserAssertionLevels), - this, - (void *) &new_user_levels, 0, 0, 0); - } - - return kIOReturnSuccess; -} - - -OSArray *PMAssertionsTracker::copyAssertionsArray(void) -{ - int count; - int i; - OSArray *outArray = NULL; - - if (!assertionsArray || - (0 == (count = assertionsArray->getCount())) || - (NULL == (outArray = OSArray::withCapacity(count)))) - { - goto exit; - } - - for (i=0; igetObject(i)); - if (_d && (_a = (PMAssertStruct *)_d->getBytesNoCopy())) - { - OSNumber *_n = NULL; - - details = OSDictionary::withCapacity(7); - if (!details) - continue; - - outArray->setObject(details); - details->release(); - - _n = OSNumber::withNumber(_a->id, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionIDKey, _n); - _n->release(); - } - _n = OSNumber::withNumber(_a->createdTime, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionCreatedTimeKey, _n); - _n->release(); - } - _n = OSNumber::withNumber(_a->modifiedTime, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionModifiedTimeKey, _n); - _n->release(); - } - _n = OSNumber::withNumber((uintptr_t)_a->registryEntryID, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionRegistryEntryIDKey, _n); - _n->release(); - } - _n = OSNumber::withNumber(_a->level, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionLevelKey, _n); - _n->release(); - } - _n = OSNumber::withNumber(_a->assertionBits, 64); - if (_n) { - details->setObject(kIOPMDriverAssertionAssertedKey, _n); - _n->release(); - } - - if (_a->ownerString) { - details->setObject(kIOPMDriverAssertionOwnerStringKey, _a->ownerString); - } - } - } + outArray->setObject(details); + details->release(); + + _n = OSNumber::withNumber(_a->id, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionIDKey, _n); + _n->release(); + } + _n = OSNumber::withNumber(_a->createdTime, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionCreatedTimeKey, _n); + _n->release(); + } + _n = OSNumber::withNumber(_a->modifiedTime, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionModifiedTimeKey, _n); + _n->release(); + } + _n = OSNumber::withNumber((uintptr_t)_a->registryEntryID, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionRegistryEntryIDKey, _n); + _n->release(); + } + _n = OSNumber::withNumber(_a->level, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionLevelKey, _n); + _n->release(); + } + _n = OSNumber::withNumber(_a->assertionBits, 64); + if (_n) { + details->setObject(kIOPMDriverAssertionAssertedKey, _n); + _n->release(); + } + + if (_a->ownerString) { + details->setObject(kIOPMDriverAssertionOwnerStringKey, _a->ownerString); + } + } + } exit: - return outArray; + return outArray; } -IOPMDriverAssertionType PMAssertionsTracker::getActivatedAssertions(void) +IOPMDriverAssertionType +PMAssertionsTracker::getActivatedAssertions(void) { - return assertionsCombined; + return assertionsCombined; } -IOPMDriverAssertionLevel PMAssertionsTracker::getAssertionLevel( - IOPMDriverAssertionType type) +IOPMDriverAssertionLevel +PMAssertionsTracker::getAssertionLevel( + IOPMDriverAssertionType type) { - if (type && ((type & assertionsKernel) == assertionsKernel)) - { - return kIOPMDriverAssertionLevelOn; - } else { - return kIOPMDriverAssertionLevelOff; - } + if (type && ((type & assertionsKernel) == assertionsKernel)) { + return kIOPMDriverAssertionLevelOn; + } else { + return kIOPMDriverAssertionLevelOff; + } } //********************************************************************************* @@ -8979,25 +10611,27 @@ IOPMDriverAssertionLevel PMAssertionsTracker::getAssertionLevel( //********************************************************************************* -static void pmEventTimeStamp(uint64_t *recordTS) +static void +pmEventTimeStamp(uint64_t *recordTS) { - clock_sec_t tsec; - clock_usec_t tusec; + clock_sec_t tsec; + clock_usec_t tusec; - if (!recordTS) - return; - - // We assume tsec fits into 32 bits; 32 bits holds enough - // seconds for 136 years since the epoch in 1970. - clock_get_calendar_microtime(&tsec, &tusec); + if (!recordTS) { + return; + } + // We assume tsec fits into 32 bits; 32 bits holds enough + // seconds for 136 years since the epoch in 1970. + clock_get_calendar_microtime(&tsec, &tusec); - // Pack the sec & microsec calendar time into a uint64_t, for fun. - *recordTS = 0; - *recordTS |= (uint32_t)tusec; - *recordTS |= ((uint64_t)tsec << 32); - return; + // Pack the sec & microsec calendar time into a uint64_t, for fun. + *recordTS = 0; + *recordTS |= (uint32_t)tusec; + *recordTS |= ((uint64_t)tsec << 32); + + return; } // MARK: - @@ -9017,543 +10651,1103 @@ OSDefineMetaClassAndFinalStructors(IORootParent, IOService) static IOPMPowerState patriarchPowerStates[2] = { - {1,0,ON_POWER,0,0,0,0,0,0,0,0,0}, - {1,0,ON_POWER,0,0,0,0,0,0,0,0,0}, + {1, 0, ON_POWER, 0, 0, 0, 0, 0, 0, 0, 0, 0}, + {1, 0, ON_POWER, 0, 0, 0, 0, 0, 0, 0, 0, 0}, }; -void IORootParent::initialize( void ) +void +IORootParent::initialize( void ) +{ + + gIOPMPSExternalConnectedKey = OSSymbol::withCStringNoCopy(kIOPMPSExternalConnectedKey); + gIOPMPSExternalChargeCapableKey = OSSymbol::withCStringNoCopy(kIOPMPSExternalChargeCapableKey); + gIOPMPSBatteryInstalledKey = OSSymbol::withCStringNoCopy(kIOPMPSBatteryInstalledKey); + gIOPMPSIsChargingKey = OSSymbol::withCStringNoCopy(kIOPMPSIsChargingKey); + gIOPMPSAtWarnLevelKey = OSSymbol::withCStringNoCopy(kIOPMPSAtWarnLevelKey); + gIOPMPSAtCriticalLevelKey = OSSymbol::withCStringNoCopy(kIOPMPSAtCriticalLevelKey); + gIOPMPSCurrentCapacityKey = OSSymbol::withCStringNoCopy(kIOPMPSCurrentCapacityKey); + gIOPMPSMaxCapacityKey = OSSymbol::withCStringNoCopy(kIOPMPSMaxCapacityKey); + gIOPMPSDesignCapacityKey = OSSymbol::withCStringNoCopy(kIOPMPSDesignCapacityKey); + gIOPMPSTimeRemainingKey = OSSymbol::withCStringNoCopy(kIOPMPSTimeRemainingKey); + gIOPMPSAmperageKey = OSSymbol::withCStringNoCopy(kIOPMPSAmperageKey); + gIOPMPSVoltageKey = OSSymbol::withCStringNoCopy(kIOPMPSVoltageKey); + gIOPMPSCycleCountKey = OSSymbol::withCStringNoCopy(kIOPMPSCycleCountKey); + gIOPMPSMaxErrKey = OSSymbol::withCStringNoCopy(kIOPMPSMaxErrKey); + gIOPMPSAdapterInfoKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterInfoKey); + gIOPMPSLocationKey = OSSymbol::withCStringNoCopy(kIOPMPSLocationKey); + gIOPMPSErrorConditionKey = OSSymbol::withCStringNoCopy(kIOPMPSErrorConditionKey); + gIOPMPSManufacturerKey = OSSymbol::withCStringNoCopy(kIOPMPSManufacturerKey); + gIOPMPSManufactureDateKey = OSSymbol::withCStringNoCopy(kIOPMPSManufactureDateKey); + gIOPMPSModelKey = OSSymbol::withCStringNoCopy(kIOPMPSModelKey); + gIOPMPSSerialKey = OSSymbol::withCStringNoCopy(kIOPMPSSerialKey); + gIOPMPSLegacyBatteryInfoKey = OSSymbol::withCStringNoCopy(kIOPMPSLegacyBatteryInfoKey); + gIOPMPSBatteryHealthKey = OSSymbol::withCStringNoCopy(kIOPMPSBatteryHealthKey); + gIOPMPSHealthConfidenceKey = OSSymbol::withCStringNoCopy(kIOPMPSHealthConfidenceKey); + gIOPMPSCapacityEstimatedKey = OSSymbol::withCStringNoCopy(kIOPMPSCapacityEstimatedKey); + gIOPMPSBatteryChargeStatusKey = OSSymbol::withCStringNoCopy(kIOPMPSBatteryChargeStatusKey); + gIOPMPSBatteryTemperatureKey = OSSymbol::withCStringNoCopy(kIOPMPSBatteryTemperatureKey); + gIOPMPSAdapterDetailsKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsKey); + gIOPMPSChargerConfigurationKey = OSSymbol::withCStringNoCopy(kIOPMPSChargerConfigurationKey); + gIOPMPSAdapterDetailsIDKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsIDKey); + gIOPMPSAdapterDetailsWattsKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsWattsKey); + gIOPMPSAdapterDetailsRevisionKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsRevisionKey); + gIOPMPSAdapterDetailsSerialNumberKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsSerialNumberKey); + gIOPMPSAdapterDetailsFamilyKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsFamilyKey); + gIOPMPSAdapterDetailsAmperageKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsAmperageKey); + gIOPMPSAdapterDetailsDescriptionKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsDescriptionKey); + gIOPMPSAdapterDetailsPMUConfigurationKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsPMUConfigurationKey); + gIOPMPSAdapterDetailsSourceIDKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsSourceIDKey); + gIOPMPSAdapterDetailsErrorFlagsKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsErrorFlagsKey); + gIOPMPSAdapterDetailsSharedSourceKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsSharedSourceKey); + gIOPMPSAdapterDetailsCloakedKey = OSSymbol::withCStringNoCopy(kIOPMPSAdapterDetailsCloakedKey); + gIOPMPSInvalidWakeSecondsKey = OSSymbol::withCStringNoCopy(kIOPMPSInvalidWakeSecondsKey); + gIOPMPSPostChargeWaitSecondsKey = OSSymbol::withCStringNoCopy(kIOPMPSPostChargeWaitSecondsKey); + gIOPMPSPostDishargeWaitSecondsKey = OSSymbol::withCStringNoCopy(kIOPMPSPostDishargeWaitSecondsKey); +} + +bool +IORootParent::start( IOService * nub ) { + IOService::start(nub); + attachToParent( getRegistryRoot(), gIOPowerPlane ); + PMinit(); + registerPowerDriver(this, patriarchPowerStates, 2); + makeUsable(); + return true; } -bool IORootParent::start( IOService * nub ) +void +IORootParent::shutDownSystem( void ) { - IOService::start(nub); - attachToParent( getRegistryRoot(), gIOPowerPlane ); - PMinit(); - registerPowerDriver(this, patriarchPowerStates, 2); - makeUsable(); - return true; } -void IORootParent::shutDownSystem( void ) +void +IORootParent::restartSystem( void ) { } -void IORootParent::restartSystem( void ) +void +IORootParent::sleepSystem( void ) { } -void IORootParent::sleepSystem( void ) +void +IORootParent::dozeSystem( void ) { } -void IORootParent::dozeSystem( void ) +void +IORootParent::sleepToDoze( void ) { } -void IORootParent::sleepToDoze( void ) +void +IORootParent::wakeSystem( void ) { } -void IORootParent::wakeSystem( void ) +OSObject * +IORootParent::copyProperty( const char * aKey) const { + return IOService::copyProperty(aKey); } -OSObject * IORootParent::copyProperty( const char * aKey) const +uint32_t +IOPMrootDomain::getWatchdogTimeout() { - return (IOService::copyProperty(aKey)); + if (gSwdSleepWakeTimeout) { + gSwdSleepTimeout = gSwdWakeTimeout = gSwdSleepWakeTimeout; + } + if ((pmTracer->getTracePhase() < kIOPMTracePointSystemSleep) || + (pmTracer->getTracePhase() == kIOPMTracePointDarkWakeEntry)) { + return gSwdSleepTimeout ? gSwdSleepTimeout : WATCHDOG_SLEEP_TIMEOUT; + } else { + return gSwdWakeTimeout ? gSwdWakeTimeout : WATCHDOG_WAKE_TIMEOUT; + } } #if defined(__i386__) || defined(__x86_64__) -void IOPMrootDomain::sleepWakeDebugLog(const char *fmt,...) -{ - char str[100]; - va_list ap; - int retry = 0; - char *ptr; - swd_hdr *hdr; - uint32_t len = 0; - uint32_t ts; - uint32_t curPos = 0, newPos = 0; - bool reset = false; - - if ( !(kIOPersistentLog & gIOKitDebug) || (swd_buffer == NULL)) - return; - - hdr = (swd_hdr *)swd_buffer; - if (hdr->dlog_size == 0) { - if ((hdr->spindump_size != 0) || !OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) - return; - - hdr->dlog_buf_offset = hdr->dlog_cur_pos = sizeof(swd_hdr); - hdr->dlog_size = SWD_DLOG_SIZE; - hdr->spindump_offset = sizeof(swd_hdr) + hdr->dlog_size; - memset(((char*)hdr)+hdr->dlog_buf_offset, 0, hdr->dlog_size); - gRootDomain->swd_lock = 0; - } - ts = mach_absolute_time() & 0xffffffff; - va_start(ap, fmt); - len = vsnprintf(str, sizeof(str), fmt, ap)+1; - va_end(ap); - if (len > sizeof(str)) len = sizeof(str); - len += 10; // 8 bytes for time stamp - - do { - curPos = hdr->dlog_cur_pos; - newPos = curPos+len; - if (newPos >= (hdr->dlog_buf_offset+hdr->dlog_size)) { - newPos = hdr->dlog_buf_offset+len; - reset = true; - } - else - reset = false; - if (retry++ == 3) return; // Don't try too hard - } while (!OSCompareAndSwap(curPos, newPos, &hdr->dlog_cur_pos)); - - if (reset) curPos = hdr->dlog_buf_offset; - ptr = (char*)hdr+curPos; - snprintf(ptr, len, "%08x: %s", ts, str); - -} - -void IOPMrootDomain::sleepWakeDebugTrig(bool wdogTrigger) -{ - swd_hdr * hdr = NULL; - addr64_t data[3]; - uint32_t wdog_panic = 0; - - char * dstAddr; - uint32_t bytesRemaining; - unsigned int len; - OSString * UUIDstring = NULL; - uint64_t code; - IOMemoryMap * logBufMap = NULL; - - if ( kIOSleepWakeWdogOff & gIOKitDebug ) - return; - - if (wdogTrigger) { - if (PE_parse_boot_argn("swd_panic", &wdog_panic, sizeof(wdog_panic)) && - (wdog_panic == 1)) { - // If boot-arg is set to panic on sleep/wake hang, call panic - panic("Sleep/Wake hang detected\n"); - return; - } - else if (swd_flags & SWD_BOOT_BY_WDOG) { - // If current boot is due to this watch dog trigger restart in previous boot, - // then don't trigger again until at least 1 successful sleep & wake. - if (!(sleepCnt && displayWakeCnt)) { - IOLog("Shutting down due to repeated Sleep/Wake failures\n"); - PEHaltRestart(kPERestartCPU); - return; - } - } - - } - - if (swd_buffer == NULL) { - sleepWakeDebugMemAlloc(); - if (swd_buffer == NULL) return; - } - - if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) - return; - - - hdr = (swd_hdr *)swd_buffer; - if ((UUIDstring = OSDynamicCast(OSString, getProperty(kIOPMSleepWakeUUIDKey))) != NULL ) { - - if (wdogTrigger || (!UUIDstring->isEqualTo(hdr->UUID))) { - const char *str = UUIDstring->getCStringNoCopy(); - snprintf(hdr->UUID, sizeof(hdr->UUID), "UUID: %s\n", str); - } - else { - DLOG("Data for current UUID already exists\n"); - goto exit; - } - } - - dstAddr = (char*)hdr + hdr->spindump_offset; - bytesRemaining = SWD_BUF_SIZE - hdr->spindump_offset; - - - DLOG("Taking snapshot. bytesRemaining: %d\n", bytesRemaining); - stack_snapshot_from_kernel(-1, dstAddr, bytesRemaining, - STACKSHOT_SAVE_LOADINFO | STACKSHOT_SAVE_KEXT_LOADINFO|STACKSHOT_SAVE_KERNEL_FRAMES_ONLY, - &hdr->spindump_size); - if (hdr->spindump_size != 0) { - DLOG("Traced %d bytes of snapshot\n", hdr->spindump_size); - dstAddr += hdr->spindump_size; - bytesRemaining -= hdr->spindump_size; - } - else { - DLOG("Failed to get spindump\n"); - hdr->spindump_size = 0; - } - - snprintf(hdr->cps, sizeof(hdr->cps), "cps: %d\n", ((IOService*)this)->getPowerState()); - code = pmTracer->getPMStatusCode(); - snprintf(hdr->PMStatusCode, sizeof(hdr->PMStatusCode), "Code: %08x %08x\n", - (uint32_t)((code >> 32) & 0xffffffff), (uint32_t)(code & 0xffffffff)); - snprintf(hdr->reason, sizeof(hdr->reason), "Stackshot reason: Watchdog\n"); - - - data[0] = sizeof(swd_hdr) + hdr->spindump_size + hdr->dlog_size; - /* Header & rootdomain log is constantly changing and is not covered by CRC */ - data[1] = crc32(0, ((char*)swd_buffer+hdr->spindump_offset), hdr->spindump_size); - data[2] = kvtophys((vm_offset_t)swd_buffer); - len = sizeof(addr64_t)*3; - DLOG("bytes: 0x%llx crc:0x%llx paddr:0x%llx\n", - data[0], data[1], data[2]); - - if (PEWriteNVRAMProperty(kIOSleepWakeDebugKey, data, len) == false) - { - DLOG("Failed to update nvram boot-args\n"); - goto exit; - } - -exit: +IOReturn +IOPMrootDomain::restartWithStackshot() +{ + takeStackshot(true); - gRootDomain->swd_lock = 0; + return kIOReturnSuccess; +} - if (wdogTrigger) { - IOLog("Restarting to collect Sleep wake debug logs\n"); - PEHaltRestart(kPERestartCPU); - } - else { - logBufMap = sleepWakeDebugRetrieve(); - if (logBufMap) { - sleepWakeDebugDump(logBufMap); - logBufMap->release(); - logBufMap = 0; - } - } +void +IOPMrootDomain::sleepWakeDebugTrig(bool wdogTrigger) +{ + takeStackshot(wdogTrigger); } -void IOPMrootDomain::sleepWakeDebugMemAlloc( ) +void +IOPMrootDomain::tracePhase2String(uint32_t tracePhase, const char **phaseString, const char **description) { - vm_size_t size = SWD_BUF_SIZE; + switch (tracePhase) { + case kIOPMTracePointSleepStarted: + *phaseString = "kIOPMTracePointSleepStarted"; + *description = "starting sleep"; + break; + + case kIOPMTracePointSleepApplications: + *phaseString = "kIOPMTracePointSleepApplications"; + *description = "notifying applications"; + break; + + case kIOPMTracePointSleepPriorityClients: + *phaseString = "kIOPMTracePointSleepPriorityClients"; + *description = "notifying clients about upcoming system capability changes"; + break; + + case kIOPMTracePointSleepWillChangeInterests: + *phaseString = "kIOPMTracePointSleepWillChangeInterests"; + *description = "creating hibernation file or while calling rootDomain's clients about upcoming rootDomain's state changes"; + break; + + case kIOPMTracePointSleepPowerPlaneDrivers: + *phaseString = "kIOPMTracePointSleepPowerPlaneDrivers"; + *description = "calling power state change callbacks"; + break; + + case kIOPMTracePointSleepDidChangeInterests: + *phaseString = "kIOPMTracePointSleepDidChangeInterests"; + *description = "calling rootDomain's clients about rootDomain's state changes"; + break; + + case kIOPMTracePointSleepCapabilityClients: + *phaseString = "kIOPMTracePointSleepCapabilityClients"; + *description = "notifying clients about current system capabilities"; + break; + + case kIOPMTracePointSleepPlatformActions: + *phaseString = "kIOPMTracePointSleepPlatformActions"; + *description = "calling Quiesce/Sleep action callbacks"; + break; + + case kIOPMTracePointSleepCPUs: + { + *phaseString = "kIOPMTracePointSleepCPUs"; +#if defined(__i386__) || defined(__x86_64__) + /* + * We cannot use the getCPUNumber() method to get the cpu number, since + * that cpu number is unrelated to the cpu number we need (we need the cpu + * number as enumerated by the scheduler, NOT the CPU number enumerated + * by ACPIPlatform as the CPUs are enumerated in MADT order). + * Instead, pass the Mach processor pointer associated with the current + * shutdown target so its associated cpu_id can be used in + * processor_to_datastring. + */ + if (currentShutdownTarget != NULL && + currentShutdownTarget->getMachProcessor() != NULL) { + const char *sbuf = processor_to_datastring("halting all non-boot CPUs", + currentShutdownTarget->getMachProcessor()); + *description = sbuf; + } else { + *description = "halting all non-boot CPUs"; + } +#else + *description = "halting all non-boot CPUs"; +#endif + break; + } + case kIOPMTracePointSleepPlatformDriver: + *phaseString = "kIOPMTracePointSleepPlatformDriver"; + *description = "executing platform specific code"; + break; + + case kIOPMTracePointHibernate: + *phaseString = "kIOPMTracePointHibernate"; + *description = "writing the hibernation image"; + break; + + case kIOPMTracePointSystemSleep: + *phaseString = "kIOPMTracePointSystemSleep"; + *description = "in EFI/Bootrom after last point of entry to sleep"; + break; + + case kIOPMTracePointWakePlatformDriver: + *phaseString = "kIOPMTracePointWakePlatformDriver"; + *description = "executing platform specific code"; + break; + + + case kIOPMTracePointWakePlatformActions: + *phaseString = "kIOPMTracePointWakePlatformActions"; + *description = "calling Wake action callbacks"; + break; + + case kIOPMTracePointWakeCPUs: + *phaseString = "kIOPMTracePointWakeCPUs"; + *description = "starting non-boot CPUs"; + break; + + case kIOPMTracePointWakeWillPowerOnClients: + *phaseString = "kIOPMTracePointWakeWillPowerOnClients"; + *description = "sending kIOMessageSystemWillPowerOn message to kernel and userspace clients"; + break; + + case kIOPMTracePointWakeWillChangeInterests: + *phaseString = "kIOPMTracePointWakeWillChangeInterests"; + *description = "calling rootDomain's clients about upcoming rootDomain's state changes"; + break; + + case kIOPMTracePointWakeDidChangeInterests: + *phaseString = "kIOPMTracePointWakeDidChangeInterests"; + *description = "calling rootDomain's clients about completed rootDomain's state changes"; + break; + + case kIOPMTracePointWakePowerPlaneDrivers: + *phaseString = "kIOPMTracePointWakePowerPlaneDrivers"; + *description = "calling power state change callbacks"; + break; + + case kIOPMTracePointWakeCapabilityClients: + *phaseString = "kIOPMTracePointWakeCapabilityClients"; + *description = "informing clients about current system capabilities"; + break; + + case kIOPMTracePointWakeApplications: + *phaseString = "kIOPMTracePointWakeApplications"; + *description = "sending asynchronous kIOMessageSystemHasPoweredOn message to userspace clients"; + break; + + case kIOPMTracePointDarkWakeEntry: + *phaseString = "kIOPMTracePointDarkWakeEntry"; + *description = "entering darkwake on way to sleep"; + break; + + case kIOPMTracePointDarkWakeExit: + *phaseString = "kIOPMTracePointDarkWakeExit"; + *description = "entering fullwake from darkwake"; + break; + + default: + *phaseString = NULL; + *description = NULL; + } +} - swd_hdr *hdr = NULL; +void +IOPMrootDomain::saveFailureData2File() +{ + unsigned int len = 0; + char failureStr[512]; + errno_t error; + char *outbuf; + OSNumber *statusCode; + uint64_t pmStatusCode = 0; + uint32_t phaseData = 0; + uint32_t phaseDetail = 0; + bool efiFailure = false; + + statusCode = OSDynamicCast(OSNumber, getProperty(kIOPMSleepWakeFailureCodeKey)); + if (statusCode) { + pmStatusCode = statusCode->unsigned64BitValue(); + phaseData = pmStatusCode & 0xFFFFFFFF; + phaseDetail = (pmStatusCode >> 32) & 0xFFFFFFFF; + if ((phaseData & 0xFF) == kIOPMTracePointSystemSleep) { + LOG("Sleep Wake failure in EFI\n"); + efiFailure = true; + failureStr[0] = 0; + snprintf(failureStr, sizeof(failureStr), "Sleep Wake failure in EFI\n\nFailure code:: 0x%08x 0x%08x\n\nPlease IGNORE the below stackshot\n", phaseDetail, phaseData); + len = strlen(failureStr); + } + } - IOBufferMemoryDescriptor *memDesc = NULL; + if (!efiFailure) { + if (PEReadNVRAMProperty(kIOSleepWakeFailurePanic, NULL, &len)) { + swd_flags |= SWD_BOOT_BY_SW_WDOG; + PERemoveNVRAMProperty(kIOSleepWakeFailurePanic); + // dump panic will handle saving nvram data + return; + } + /* Keeping this around for capturing data during power + * button press */ - if ( kIOSleepWakeWdogOff & gIOKitDebug ) - return; + if (!PEReadNVRAMProperty(kIOSleepWakeFailureString, NULL, &len)) { + DLOG("No sleep wake failure string\n"); + return; + } + if (len == 0) { + DLOG("Ignoring zero byte SleepWake failure string\n"); + goto exit; + } - if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) - return; + // if PMStatus code is zero, delete stackshot and return + if (statusCode) { + if (((pmStatusCode & 0xFFFFFFFF) & 0xFF) == 0) { + // there was no sleep wake failure + // this can happen if delete stackshot was called + // before take stackshot completed. Let us delete any + // sleep wake failure data in nvram + DLOG("Deleting stackshot on successful wake\n"); + deleteStackshot(); + return; + } + } - // Try allocating above 4GB. If that fails, try at 2GB - memDesc = IOBufferMemoryDescriptor::inTaskWithPhysicalMask( - kernel_task, kIOMemoryPhysicallyContiguous|kIOMemoryMapperNone, - size, 0xFFFFFFFF00000000ULL); - if (!memDesc) { - memDesc = IOBufferMemoryDescriptor::inTaskWithPhysicalMask( - kernel_task, kIOMemoryPhysicallyContiguous|kIOMemoryMapperNone, - size, 0xFFFFFFFF10000000ULL); - } + if (len > sizeof(failureStr)) { + len = sizeof(failureStr); + } + failureStr[0] = 0; + PEReadNVRAMProperty(kIOSleepWakeFailureString, failureStr, &len); + } + if (failureStr[0] != 0) { + error = sleepWakeDebugSaveFile(kSleepWakeFailureStringFile, failureStr, len); + if (error) { + DLOG("Failed to save SleepWake failure string to file. error:%d\n", error); + } else { + DLOG("Saved SleepWake failure string to file.\n"); + } + } - if (memDesc == NULL) - { - DLOG("Failed to allocate Memory descriptor for sleepWake debug\n"); - goto exit; - } + if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) { + goto exit; + } + if (swd_buffer) { + unsigned int len = 0; + errno_t error; + char nvram_var_name_buffer[20]; + unsigned int concat_len = 0; + swd_hdr *hdr = NULL; - hdr = (swd_hdr *)memDesc->getBytesNoCopy(); - memset(hdr, 0, sizeof(swd_hdr)); - hdr->version = 1; - hdr->alloc_size = size; + hdr = (swd_hdr *)swd_buffer; + outbuf = (char *)hdr + hdr->spindump_offset; - if (kIOPersistentLog & gIOKitDebug) { - hdr->dlog_buf_offset = hdr->dlog_cur_pos = sizeof(swd_hdr); - hdr->dlog_size = SWD_DLOG_SIZE; - memset(((char*)hdr)+hdr->dlog_buf_offset, 0, hdr->dlog_size); - } - hdr->spindump_offset = sizeof(swd_hdr) + hdr->dlog_size; + for (int i = 0; i < 8; i++) { + snprintf(nvram_var_name_buffer, 20, "%s%02d", SWD_STACKSHOT_VAR_PREFIX, i + 1); + if (!PEReadNVRAMProperty(nvram_var_name_buffer, NULL, &len)) { + LOG("No SleepWake blob to read beyond chunk %d\n", i); + break; + } + if (PEReadNVRAMProperty(nvram_var_name_buffer, outbuf + concat_len, &len) == FALSE) { + PERemoveNVRAMProperty(nvram_var_name_buffer); + LOG("Could not read the property :-(\n"); + break; + } + PERemoveNVRAMProperty(nvram_var_name_buffer); + concat_len += len; + } + LOG("Concatenated length for the SWD blob %d\n", concat_len); + + if (concat_len) { + error = sleepWakeDebugSaveFile(kSleepWakeStacksFilename, outbuf, concat_len); + if (error) { + LOG("Failed to save SleepWake zipped data to file. error:%d\n", error); + } else { + LOG("Saved SleepWake zipped data to file.\n"); + } + } else { + // There is a sleep wake failure string but no stackshot + // Write a placeholder stacks file so that swd runs + snprintf(outbuf, 20, "%s", "No stackshot data\n"); + error = sleepWakeDebugSaveFile(kSleepWakeStacksFilename, outbuf, 20); + if (error) { + LOG("Failed to save SleepWake zipped data to file. error:%d\n", error); + } else { + LOG("Saved SleepWake zipped data to file.\n"); + } + } + } else { + LOG("No buffer allocated to save failure stackshot\n"); + } - swd_buffer = (void *)hdr; - DLOG("SleepWake debug buffer size:0x%x\n", hdr->alloc_size); - DLOG("DLOG offset: 0x%x size:0x%x spindump offset:0x%x\n", - hdr->dlog_buf_offset, hdr->dlog_size, hdr->spindump_offset); + gRootDomain->swd_lock = 0; exit: - gRootDomain->swd_lock = 0; + PERemoveNVRAMProperty(kIOSleepWakeFailureString); + return; } -void IOPMrootDomain::sleepWakeDebugEnableWdog() + +void +IOPMrootDomain::getFailureData(thread_t *thread, char *failureStr, size_t strLen) { - swd_flags |= SWD_WDOG_ENABLED; - if (!swd_buffer) - sleepWakeDebugMemAlloc(); + IORegistryIterator * iter; + IORegistryEntry * entry; + IOService * node; + bool nodeFound = false; + + const void * callMethod = NULL; + const char * objectName = NULL; + uint32_t timeout = getWatchdogTimeout(); + const char * phaseString = NULL; + const char * phaseDescription = NULL; + + IOPMServiceInterestNotifier *notifier = OSDynamicCast(IOPMServiceInterestNotifier, notifierObject); + uint32_t tracePhase = pmTracer->getTracePhase(); + + *thread = NULL; + if ((tracePhase < kIOPMTracePointSystemSleep) || (tracePhase == kIOPMTracePointDarkWakeEntry)) { + snprintf(failureStr, strLen, "%sSleep transition timed out after %d seconds", failureStr, timeout); + } else { + snprintf(failureStr, strLen, "%sWake transition timed out after %d seconds", failureStr, timeout); + } + tracePhase2String(tracePhase, &phaseString, &phaseDescription); + + if (notifierThread) { + if (notifier && (notifier->identifier)) { + objectName = notifier->identifier->getCStringNoCopy(); + } + *thread = notifierThread; + } else { + iter = IORegistryIterator::iterateOver( + getPMRootDomain(), gIOPowerPlane, kIORegistryIterateRecursively); + + if (iter) { + while ((entry = iter->getNextObject())) { + node = OSDynamicCast(IOService, entry); + if (!node) { + continue; + } + if (OSDynamicCast(IOPowerConnection, node)) { + continue; + } + + if (node->getBlockingDriverCall(thread, &callMethod)) { + nodeFound = true; + break; + } + } + iter->release(); + } + if (nodeFound) { + OSKext *kext = OSKext::lookupKextWithAddress((vm_address_t)callMethod); + if (kext) { + objectName = kext->getIdentifierCString(); + kext->release(); + } + } + } + if (phaseDescription) { + snprintf(failureStr, strLen, "%s while %s.", failureStr, phaseDescription); + } + if (objectName) { + snprintf(failureStr, strLen, "%s Suspected bundle: %s.", failureStr, objectName); + } + if (*thread) { + snprintf(failureStr, strLen, "%s Thread 0x%llx.", failureStr, thread_tid(*thread)); + } + + DLOG("%s\n", failureStr); } -bool IOPMrootDomain::sleepWakeDebugIsWdogEnabled() +struct swd_stackshot_compressed_data { + z_output_func zoutput; + size_t zipped; + uint64_t totalbytes; + uint64_t lastpercent; + IOReturn error; + unsigned outremain; + unsigned outlen; + unsigned writes; + Bytef * outbuf; +}; +struct swd_stackshot_compressed_data swd_zip_var = { }; + +static void * +swd_zs_alloc(void *__unused ref, u_int items, u_int size) { - return ((swd_flags & SWD_WDOG_ENABLED) && - !systemBooting && !systemShutdown); + void *result; + LOG("Alloc in zipping %d items of size %d\n", items, size); + + result = (void *)(swd_zs_zmem + swd_zs_zoffset); + swd_zs_zoffset += ~31L & (31 + (items * size)); // 32b align for vector crc + LOG("Offset %zu\n", swd_zs_zoffset); + return result; } -errno_t IOPMrootDomain::sleepWakeDebugSaveFile(const char *name, char *buf, int len) +static int +swd_zinput(z_streamp strm, Bytef *buf, unsigned size) { - struct vnode *vp = NULL; - vfs_context_t ctx = vfs_context_current(); - kauth_cred_t cred = vfs_context_ucred(ctx); - struct vnode_attr va; - errno_t error = EIO; + unsigned len; + + len = strm->avail_in; + + if (len > size) { + len = size; + } + if (len == 0) { + return 0; + } - if (vnode_open(name, (O_CREAT | FWRITE | O_NOFOLLOW), - S_IRUSR|S_IRGRP|S_IROTH, VNODE_LOOKUP_NOFOLLOW, &vp, ctx) != 0) - { - IOLog("Failed to open the file %s\n", name); - goto exit; - } - VATTR_INIT(&va); - VATTR_WANTED(&va, va_nlink); - /* Don't dump to non-regular files or files with links. */ - if (vp->v_type != VREG || - vnode_getattr(vp, &va, ctx) || va.va_nlink != 1) { - IOLog("Bailing as this is not a regular file\n"); - goto exit; + if (strm->next_in != (Bytef *) strm) { + memcpy(buf, strm->next_in, len); + } else { + bzero(buf, len); } - VATTR_INIT(&va); - VATTR_SET(&va, va_data_size, 0); - vnode_setattr(vp, &va, ctx); - - error = vn_rdwr(UIO_WRITE, vp, buf, len, 0, - UIO_SYSSPACE, IO_NODELOCKED|IO_UNIT, cred, (int *) 0, vfs_context_proc(ctx)); - if (error != 0) - IOLog("Failed to save sleep wake log. err 0x%x\n", error); - else - DLOG("Saved %d bytes to file %s\n",len, name); + strm->adler = z_crc32(strm->adler, buf, len); -exit: - if (vp) vnode_close(vp, FWRITE, ctx); + strm->avail_in -= len; + strm->next_in += len; + strm->total_in += len; - return error; + return (int)len; +} +static int +swd_zoutput(z_streamp strm, Bytef *buf, unsigned len) +{ + unsigned int i = 0; + // if outlen > max size don't add to the buffer + if (strm && buf) { + if (swd_zip_var.outlen + len > SWD_COMPRESSED_BUFSIZE) { + LOG("No space to GZIP... not writing to NVRAM\n"); + return len; + } + } + for (i = 0; i < len; i++) { + *(swd_zip_var.outbuf + swd_zip_var.outlen + i) = *(buf + i); + } + swd_zip_var.outlen += len; + return len; } -void IOPMrootDomain::sleepWakeDebugDump(IOMemoryMap *logBufMap) +static void +swd_zs_free(void * __unused ref, void * __unused ptr) { - IOVirtualAddress srcBuf = NULL; - char *stackBuf = NULL, *logOffset = NULL; - int logSize = 0; +} + +static int +swd_compress(char *inPtr, char *outPtr, size_t numBytes) +{ + int wbits = 12; + int memlevel = 3; + + if (!swd_zs.zalloc) { + swd_zs.zalloc = swd_zs_alloc; + swd_zs.zfree = swd_zs_free; + if (deflateInit2(&swd_zs, Z_BEST_SPEED, Z_DEFLATED, wbits + 16, memlevel, Z_DEFAULT_STRATEGY)) { + // allocation failed + bzero(&swd_zs, sizeof(swd_zs)); + // swd_zs_zoffset = 0; + } else { + LOG("PMRD inited the zlib allocation routines\n"); + } + } - errno_t error = EIO; - uint64_t bufSize = 0; - swd_hdr *hdr = NULL; - char PMStatusCode[100]; - OSNumber *failStat = NULL; - if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) - return; - if ((logBufMap == 0) || ( (srcBuf = logBufMap->getVirtualAddress()) == 0) ) - { - DLOG("Nothing saved to dump to file\n"); - goto exit; - } + swd_zip_var.zipped = 0; + swd_zip_var.totalbytes = 0; // should this be the max that we have? + swd_zip_var.lastpercent = 0; + swd_zip_var.error = kIOReturnSuccess; + swd_zip_var.outremain = 0; + swd_zip_var.outlen = 0; + swd_zip_var.writes = 0; + swd_zip_var.outbuf = (Bytef *)outPtr; - hdr = (swd_hdr *)srcBuf; - bufSize = logBufMap->getLength(); - if (bufSize <= sizeof(swd_hdr)) - { - IOLog("SleepWake log buffer contents are invalid\n"); - goto exit; - } + swd_zip_var.totalbytes = numBytes; - stackBuf = (char*)hdr+hdr->spindump_offset; + swd_zs.avail_in = 0; + swd_zs.next_in = NULL; + swd_zs.avail_out = 0; + swd_zs.next_out = NULL; - error = sleepWakeDebugSaveFile("/var/tmp/SleepWakeStacks.dump", stackBuf, hdr->spindump_size); - if (error) goto exit; + deflateResetWithIO(&swd_zs, swd_zinput, swd_zoutput); - logOffset = (char*)hdr+offsetof(swd_hdr, UUID); - logSize = sizeof(swd_hdr)-offsetof(swd_hdr, UUID); - if ((hdr->dlog_buf_offset == sizeof(swd_hdr)) && (hdr->dlog_size == SWD_DLOG_SIZE)) - { - logSize += hdr->dlog_size; - } - error = sleepWakeDebugSaveFile("/var/tmp/SleepWakeLog.dump", logOffset, logSize); - if (error) goto exit; + z_stream *zs; + int zr; + zs = &swd_zs; - hdr->spindump_size = 0; - error = 0; + zr = Z_OK; -exit: - if (error) { - // Write just the SleepWakeLog.dump with failure code - if ((failStat = OSDynamicCast(OSNumber, getProperty(kIOPMSleepWakeFailureCodeKey))) != NULL) { - memset(PMStatusCode, 0x20, sizeof(PMStatusCode)); // Fill with spaces - PMStatusCode[sizeof(PMStatusCode)-1] = 0xa; // And an end-of-line at the end - const uint64_t fcode = failStat->unsigned64BitValue(); - snprintf(PMStatusCode, sizeof(PMStatusCode)-1, "Code: 0x%llx", fcode); - sleepWakeDebugSaveFile("/var/tmp/SleepWakeLog.dump", PMStatusCode, sizeof(PMStatusCode)); - } - } - gRootDomain->swd_lock = 0; -} - -IOMemoryMap *IOPMrootDomain::sleepWakeDebugRetrieve( ) -{ - IOVirtualAddress vaddr = NULL; - IOMemoryDescriptor * desc = NULL; - IOMemoryMap * logBufMap = NULL; - - uint32_t len; - addr64_t data[3]; - uint64_t bufSize = 0; - uint64_t crc = 0; - uint64_t newcrc = 0; - uint64_t paddr = 0; - swd_hdr *hdr = NULL; - bool ret = false; - - - if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) - return NULL; - - len = sizeof(addr64_t)*3; - if (!PEReadNVRAMProperty(kIOSleepWakeDebugKey, data, &len) || (len != sizeof(addr64_t)*3) ) - { - DLOG("No sleepWakeDebug note to read\n"); - return NULL; - } - PERemoveNVRAMProperty(kIOSleepWakeDebugKey); - - - bufSize = data[0]; - crc = data[1]; - paddr = data[2]; - if ( (bufSize <= sizeof(swd_hdr)) ||(bufSize > SWD_BUF_SIZE) || (crc == 0) ) - { - IOLog("SleepWake log buffer contents are invalid\n"); - return NULL; - } - - DLOG("size:0x%llx crc:0x%llx paddr:0x%llx\n", - bufSize, crc, paddr); - - - desc = IOMemoryDescriptor::withAddressRange( paddr, bufSize, - kIODirectionOutIn | kIOMemoryMapperNone, NULL); - if (desc == NULL) - { - IOLog("Fail to map SleepWake log buffer\n"); - goto exit; - } - - logBufMap = desc->map(); - - vaddr = logBufMap->getVirtualAddress(); - - - if ( (logBufMap->getLength() <= sizeof(swd_hdr)) || (vaddr == NULL) ) { - IOLog("Fail to map SleepWake log buffer\n"); - goto exit; - } - - hdr = (swd_hdr *)vaddr; - if (hdr->spindump_offset+hdr->spindump_size > bufSize) - { - IOLog("SleepWake log buffer contents are invalid\n"); - goto exit; - } - - hdr->crc = crc; - newcrc = crc32(0, (void *)((char*)vaddr+hdr->spindump_offset), - hdr->spindump_size); - if (newcrc != crc) { - IOLog("SleepWake log buffer contents are invalid\n"); - goto exit; - } - - ret = true; + while (swd_zip_var.error >= 0) { + if (!zs->avail_in) { + zs->next_in = (unsigned char *)inPtr ? (Bytef *)inPtr : (Bytef *)zs; /* zero marker? */ + zs->avail_in = numBytes; + } + if (!zs->avail_out) { + zs->next_out = (Bytef *)zs; + zs->avail_out = UINT32_MAX; + } + zr = deflate(zs, Z_NO_FLUSH); + if (Z_STREAM_END == zr) { + break; + } + if (zr != Z_OK) { + LOG("ZERR %d\n", zr); + swd_zip_var.error = zr; + } else { + if (zs->total_in == numBytes) { + break; + } + } + } + zr = Z_OK; + //now flush the stream + while (swd_zip_var.error >= 0) { + if (!zs->avail_out) { + zs->next_out = (Bytef *)zs; + zs->avail_out = UINT32_MAX; + } + zr = deflate(zs, Z_FINISH); + if (Z_STREAM_END == zr) { + break; + } + if (zr != Z_OK) { + LOG("ZERR %d\n", zr); + swd_zip_var.error = zr; + } else { + if (zs->total_in == numBytes) { + LOG("Total output size %d\n", swd_zip_var.outlen); + break; + } + } + } + return swd_zip_var.outlen; +} -exit: - if (!ret) { - if (logBufMap) logBufMap->release(); - logBufMap = 0; - } - if (desc) desc->release(); - gRootDomain->swd_lock = 0; - - return logBufMap; +void +IOPMrootDomain::deleteStackshot() +{ + if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) { + // takeStackshot hasn't completed + return; + } + LOG("Deleting any sleepwake failure data in nvram\n"); + + PERemoveNVRAMProperty(kIOSleepWakeFailureString); + char nvram_var_name_buf[20]; + for (int i = 0; i < 8; i++) { + snprintf(nvram_var_name_buf, 20, "%s%02d", SWD_STACKSHOT_VAR_PREFIX, i + 1); + if (PERemoveNVRAMProperty(nvram_var_name_buf) == false) { + LOG("Removing %s returned false\n", nvram_var_name_buf); + } + } + // force NVRAM sync + if (PEWriteNVRAMProperty(kIONVRAMSyncNowPropertyKey, kIONVRAMSyncNowPropertyKey, strlen(kIONVRAMSyncNowPropertyKey)) == false) { + DLOG("Failed to force nvram sync\n"); + } + gRootDomain->swd_lock = 0; +} +void +IOPMrootDomain::takeStackshot(bool wdogTrigger) +{ + swd_hdr * hdr = NULL; + int cnt = 0; + int max_cnt = 2; + pid_t pid = 0; + kern_return_t kr = KERN_SUCCESS; + uint32_t flags; + + char * dstAddr; + uint32_t size; + uint32_t bytesRemaining; + unsigned bytesWritten = 0; + + char failureStr[512]; + thread_t thread = NULL; + const char * swfPanic = "swfPanic"; + + + uint32_t bufSize; + int success = 0; + + if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) { + return; + } + + failureStr[0] = 0; + if ((kIOSleepWakeWdogOff & gIOKitDebug) || systemBooting || systemShutdown || gWillShutdown) { + return; + } + + if (wdogTrigger) { + getFailureData(&thread, failureStr, sizeof(failureStr)); + + if (PEGetCoprocessorVersion() >= kCoprocessorVersion2) { + goto skip_stackshot; + } + } else { + AbsoluteTime now; + uint64_t nsec; + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime); + absolutetime_to_nanoseconds(now, &nsec); + snprintf(failureStr, sizeof(failureStr), "%sPower button pressed during wake transition after %u ms.\n", failureStr, ((int)((nsec) / NSEC_PER_MSEC))); + } + + if (swd_buffer == NULL) { + sleepWakeDebugMemAlloc(); + if (swd_buffer == NULL) { + return; + } + } + hdr = (swd_hdr *)swd_buffer; + bufSize = hdr->alloc_size;; + + + + + dstAddr = (char*)hdr + hdr->spindump_offset; + flags = STACKSHOT_KCDATA_FORMAT | STACKSHOT_NO_IO_STATS | STACKSHOT_SAVE_KEXT_LOADINFO | STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY | STACKSHOT_THREAD_WAITINFO; + /* If not wdogTrigger only take kernel tasks stackshot + */ + if (wdogTrigger) { + pid = -1; + } else { + pid = 0; + } + + /* Attempt to take stackshot with all ACTIVE_KERNEL_THREADS + * If we run out of space, take stackshot with only kernel task + */ + while (success == 0 && cnt < max_cnt) { + bytesRemaining = bufSize - hdr->spindump_offset; + cnt++; + DLOG("Taking snapshot. bytesRemaining: %d\n", bytesRemaining); + + size = bytesRemaining; + kr = stack_snapshot_from_kernel(pid, dstAddr, size, flags, 0, &bytesWritten); + DLOG("stack_snapshot_from_kernel returned 0x%x. pid: %d bufsize:0x%x flags:0x%x bytesWritten: %d\n", + kr, pid, size, flags, bytesWritten); + if (kr == KERN_INSUFFICIENT_BUFFER_SIZE) { + if (pid == -1) { + pid = 0; + } else { + LOG("Insufficient buffer size for only kernel task\n"); + break; + } + } + if (kr == KERN_SUCCESS) { + if (bytesWritten == 0) { + MSG("Failed to get stackshot(0x%x) bufsize:0x%x flags:0x%x\n", kr, size, flags); + continue; + } + bytesRemaining -= bytesWritten; + hdr->spindump_size = (bufSize - bytesRemaining - hdr->spindump_offset); + + memset(hdr->reason, 0x20, sizeof(hdr->reason)); + + // Compress stackshot and save to NVRAM + { + char *outbuf = (char *)swd_compressed_buffer; + int outlen = 0; + int num_chunks = 0; + int max_chunks = 0; + int leftover = 0; + char nvram_var_name_buffer[20]; + + outlen = swd_compress((char*)hdr + hdr->spindump_offset, outbuf, bytesWritten); + + if (outlen) { + max_chunks = outlen / (2096 - 200); + leftover = outlen % (2096 - 200); + + if (max_chunks < 8) { + for (num_chunks = 0; num_chunks < max_chunks; num_chunks++) { + snprintf(nvram_var_name_buffer, 20, "%s%02d", SWD_STACKSHOT_VAR_PREFIX, num_chunks + 1); + if (PEWriteNVRAMPropertyWithCopy(nvram_var_name_buffer, (outbuf + (num_chunks * (2096 - 200))), (2096 - 200)) == FALSE) { + LOG("Failed to update NVRAM %d\n", num_chunks); + break; + } + } + if (leftover) { + snprintf(nvram_var_name_buffer, 20, "%s%02d", SWD_STACKSHOT_VAR_PREFIX, num_chunks + 1); + if (PEWriteNVRAMPropertyWithCopy(nvram_var_name_buffer, (outbuf + (num_chunks * (2096 - 200))), leftover) == FALSE) { + LOG("Failed to update NVRAM with leftovers\n"); + } + } + success = 1; + LOG("Successfully saved stackshot to NVRAM\n"); + } else { + LOG("Compressed failure stackshot is too large. size=%d bytes\n", outlen); + if (pid == -1) { + pid = 0; + } else { + LOG("Compressed failure stackshot of only kernel is too large size=%d bytes\n", outlen); + break; + } + } + } + } + } + } + + if (failureStr[0]) { + // append sleep-wake failure code + snprintf(failureStr, sizeof(failureStr), "%s\nFailure code:: 0x%08x %08x\n", + failureStr, pmTracer->getTraceData(), pmTracer->getTracePhase()); + if (PEWriteNVRAMProperty(kIOSleepWakeFailureString, failureStr, strlen(failureStr)) == false) { + DLOG("Failed to write SleepWake failure string\n"); + } + } + + // force NVRAM sync + if (PEWriteNVRAMProperty(kIONVRAMSyncNowPropertyKey, kIONVRAMSyncNowPropertyKey, strlen(kIONVRAMSyncNowPropertyKey)) == false) { + DLOG("Failed to force nvram sync\n"); + } + +skip_stackshot: + if (wdogTrigger) { + if (PEGetCoprocessorVersion() < kCoprocessorVersion2) { + if (swd_flags & SWD_BOOT_BY_SW_WDOG) { + // If current boot is due to this watch dog trigger restart in previous boot, + // then don't trigger again until at least 1 successful sleep & wake. + if (!(sleepCnt && (displayWakeCnt || darkWakeCnt))) { + LOG("Shutting down due to repeated Sleep/Wake failures\n"); + if (!tasksSuspended) { + tasksSuspended = TRUE; + updateTasksSuspend(); + } + PEHaltRestart(kPEHaltCPU); + return; + } + } + if (gSwdPanic == 0) { + LOG("Calling panic prevented by swd_panic boot-args. Calling restart"); + if (!tasksSuspended) { + tasksSuspended = TRUE; + updateTasksSuspend(); + } + PEHaltRestart(kPERestartCPU); + } + } + if (PEWriteNVRAMProperty(kIOSleepWakeFailurePanic, swfPanic, strlen(swfPanic)) == false) { + DLOG("Failed to write SleepWake failure panic key\n"); + } + if (thread) { + panic_with_thread_context(0, NULL, DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT, thread, "%s", failureStr); + } else { + panic_with_options(0, NULL, DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT, "%s", failureStr); + } + } else { + gRootDomain->swd_lock = 0; + return; + } } -void IOPMrootDomain::saveTimeoutAppStackShot(void *p0, void *p1) +void +IOPMrootDomain::sleepWakeDebugMemAlloc() { - IOPMrootDomain *rd = (IOPMrootDomain *)p0; - IOBufferMemoryDescriptor *spindumpDesc; - errno_t error = EIO; - swd_hdr *hdr; + vm_size_t size = SWD_STACKSHOT_SIZE + SWD_COMPRESSED_BUFSIZE + SWD_ZLIB_BUFSIZE; + + swd_hdr *hdr = NULL; + void *bufPtr = NULL; + + IOBufferMemoryDescriptor *memDesc = NULL; + + + if (kIOSleepWakeWdogOff & gIOKitDebug) { + return; + } + + if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) { + return; + } + + memDesc = IOBufferMemoryDescriptor::inTaskWithOptions( + kernel_task, kIODirectionIn | kIOMemoryMapperNone, + size); + if (memDesc == NULL) { + DLOG("Failed to allocate Memory descriptor for sleepWake debug\n"); + goto exit; + } - if (rd && rd->spindumpDesc) - { - spindumpDesc = rd->spindumpDesc; + bufPtr = memDesc->getBytesNoCopy(); - hdr = (swd_hdr*)spindumpDesc->getBytesNoCopy(); - error = rd->sleepWakeDebugSaveFile("/var/tmp/SleepWakeTimeoutStacks.dump", - (char*)hdr+hdr->spindump_offset, hdr->spindump_size); - if (error) goto done; + // Carve out memory for zlib routines + swd_zs_zmem = (vm_offset_t)bufPtr; + bufPtr = (char *)bufPtr + SWD_ZLIB_BUFSIZE; - error = rd->sleepWakeDebugSaveFile("/var/tmp/SleepWakeTimeoutLog.dump", - (char*)hdr+offsetof(swd_hdr, UUID), - sizeof(swd_hdr)-offsetof(swd_hdr, UUID)); + // Carve out memory for compressed stackshots + swd_compressed_buffer = bufPtr; + bufPtr = (char *)bufPtr + SWD_COMPRESSED_BUFSIZE; - done: - spindumpDesc->release(); - rd->spindumpDesc = 0; - - } + // Remaining is used for holding stackshot + hdr = (swd_hdr *)bufPtr; + memset(hdr, 0, sizeof(swd_hdr)); + hdr->signature = SWD_HDR_SIGNATURE; + hdr->alloc_size = SWD_STACKSHOT_SIZE; + hdr->spindump_offset = sizeof(swd_hdr); + swd_buffer = (void *)hdr; + swd_memDesc = memDesc; + DLOG("SleepWake debug buffer size:0x%x spindump offset:0x%x\n", hdr->alloc_size, hdr->spindump_offset); + +exit: + gRootDomain->swd_lock = 0; } -#else +void +IOPMrootDomain::sleepWakeDebugSpinDumpMemAlloc() +{ + vm_size_t size = SWD_SPINDUMP_SIZE; -void IOPMrootDomain::sleepWakeDebugLog(const char *fmt,...) + swd_hdr *hdr = NULL; + + IOBufferMemoryDescriptor *memDesc = NULL; + + if (!OSCompareAndSwap(0, 1, &gRootDomain->swd_lock)) { + return; + } + + memDesc = IOBufferMemoryDescriptor::inTaskWithOptions( + kernel_task, kIODirectionIn | kIOMemoryMapperNone, + SWD_SPINDUMP_SIZE); + + if (memDesc == NULL) { + DLOG("Failed to allocate Memory descriptor for sleepWake debug spindump\n"); + goto exit; + } + + + hdr = (swd_hdr *)memDesc->getBytesNoCopy(); + memset(hdr, 0, sizeof(swd_hdr)); + + hdr->signature = SWD_HDR_SIGNATURE; + hdr->alloc_size = size; + + hdr->spindump_offset = sizeof(swd_hdr); + swd_spindump_buffer = (void *)hdr; + +exit: + gRootDomain->swd_lock = 0; +} + +void +IOPMrootDomain::sleepWakeDebugEnableWdog() { } -void IOPMrootDomain::sleepWakeDebugTrig(bool restart) +bool +IOPMrootDomain::sleepWakeDebugIsWdogEnabled() { + return !systemBooting && !systemShutdown && !gWillShutdown; } -void IOPMrootDomain::sleepWakeDebugMemAlloc( ) +void +IOPMrootDomain::sleepWakeDebugSaveSpinDumpFile() { + swd_hdr *hdr = NULL; + errno_t error = EIO; + + if (swd_spindump_buffer && gSpinDumpBufferFull) { + hdr = (swd_hdr *)swd_spindump_buffer; + + error = sleepWakeDebugSaveFile("/var/tmp/SleepWakeDelayStacks.dump", + (char*)hdr + hdr->spindump_offset, hdr->spindump_size); + + if (error) { + return; + } + + sleepWakeDebugSaveFile("/var/tmp/SleepWakeDelayLog.dump", + (char*)hdr + offsetof(swd_hdr, UUID), + sizeof(swd_hdr) - offsetof(swd_hdr, UUID)); + + gSpinDumpBufferFull = false; + } } -void IOPMrootDomain::sleepWakeDebugDump(IOMemoryMap *map) +errno_t +IOPMrootDomain::sleepWakeDebugSaveFile(const char *name, char *buf, int len) { + struct vnode *vp = NULL; + vfs_context_t ctx = vfs_context_create(vfs_context_current()); + kauth_cred_t cred = vfs_context_ucred(ctx); + struct vnode_attr va; + errno_t error = EIO; + + if (vnode_open(name, (O_CREAT | FWRITE | O_NOFOLLOW), + S_IRUSR | S_IRGRP | S_IROTH, VNODE_LOOKUP_NOFOLLOW, &vp, ctx) != 0) { + LOG("Failed to open the file %s\n", name); + swd_flags |= SWD_FILEOP_ERROR; + goto exit; + } + VATTR_INIT(&va); + VATTR_WANTED(&va, va_nlink); + /* Don't dump to non-regular files or files with links. */ + if (vp->v_type != VREG || + vnode_getattr(vp, &va, ctx) || va.va_nlink != 1) { + LOG("Bailing as this is not a regular file\n"); + swd_flags |= SWD_FILEOP_ERROR; + goto exit; + } + VATTR_INIT(&va); + VATTR_SET(&va, va_data_size, 0); + vnode_setattr(vp, &va, ctx); + + + if (buf != NULL) { + error = vn_rdwr(UIO_WRITE, vp, buf, len, 0, + UIO_SYSSPACE, IO_NODELOCKED | IO_UNIT, cred, (int *) NULL, vfs_context_proc(ctx)); + if (error != 0) { + LOG("Failed to save sleep wake log. err 0x%x\n", error); + swd_flags |= SWD_FILEOP_ERROR; + } else { + DLOG("Saved %d bytes to file %s\n", len, name); + } + } + +exit: + if (vp) { + vnode_close(vp, FWRITE, ctx); + } + if (ctx) { + vfs_context_rele(ctx); + } + + return error; } -IOMemoryMap *IOPMrootDomain::sleepWakeDebugRetrieve( ) + +#else + +void +IOPMrootDomain::sleepWakeDebugTrig(bool restart) { - return NULL; + if (restart) { + if (gSwdPanic == 0) { + return; + } + panic("Sleep/Wake hang detected"); + return; + } } -void IOPMrootDomain::sleepWakeDebugEnableWdog() +void +IOPMrootDomain::takeStackshot(bool restart) +{ +#pragma unused(restart) +} +void +IOPMrootDomain::deleteStackshot() +{ +} +void +IOPMrootDomain::sleepWakeDebugMemAlloc() +{ +} +void +IOPMrootDomain::saveFailureData2File() { } -bool IOPMrootDomain::sleepWakeDebugIsWdogEnabled() +void +IOPMrootDomain::sleepWakeDebugEnableWdog() { - return false; } -errno_t IOPMrootDomain::sleepWakeDebugSaveFile(const char *name, char *buf, int len) +bool +IOPMrootDomain::sleepWakeDebugIsWdogEnabled() { - return 0; + return false; } -void IOPMrootDomain::saveTimeoutAppStackShot(void *p0, void *p1) +errno_t +IOPMrootDomain::sleepWakeDebugSaveFile(const char *name, char *buf, int len) { + return 0; } + #endif