power.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	tagWIN32POWERCALLOUT

Macros
#define	ASSERT_POWER_CALLOUT_LOCK_ACQUIRED()    ASSERT(gpPowerCalloutMutexOwnerThread == KeGetCurrentThread())

Typedefs
typedef enum tagPOWER_CALLOUT_TYPE	POWER_CALLOUT_TYPE
typedef struct tagWIN32POWERCALLOUT	WIN32POWERCALLOUT
typedef struct tagWIN32POWERCALLOUT *	PWIN32POWERCALLOUT

Enumerations
enum	tagPOWER_CALLOUT_TYPE { POWER_CALLOUT_EVENT = 0 , POWER_CALLOUT_STATE }

Functions
NTSTATUS NTAPI	IntInitWin32PowerManagement (_In_ HANDLE hPowerRequestEvent)
	Initializes the power management side of Win32 kernel-mode subsystem component. This enables communication between the power manager of the NT kernel and Win32k.
NTSTATUS NTAPI	IntWin32PowerManagementCleanup (VOID)
	Cleanup procedure that frees all the allocated resources by the power manager. It is triggered during Win32k subsystem unloading.
NTSTATUS NTAPI	IntHandlePowerEvent (_In_ PWIN32_POWEREVENT_PARAMETERS pWin32PwrEventParams)
	Handles an incoming power event callout from the NT power manager.
NTSTATUS NTAPI	IntHandlePowerState (_In_ PWIN32_POWERSTATE_PARAMETERS pWin32PwrStateParams)
	Handles an incoming power state callout from the NT power manager.
FORCEINLINE VOID	IntAcquirePowerCalloutLock (VOID)
FORCEINLINE VOID	IntReleasePowerCalloutLock (VOID)
FORCEINLINE BOOL	IntIsThreadWin32Thread (_In_ PETHREAD Thread)

Variables
LIST_ENTRY	gPowerCalloutsQueueList
PFAST_MUTEX	gpPowerCalloutMutexLock
PKEVENT	gpPowerRequestCalloutEvent
PKTHREAD	gpPowerCalloutMutexOwnerThread

Macro Definition Documentation

ASSERT_POWER_CALLOUT_LOCK_ACQUIRED

#define ASSERT_POWER_CALLOUT_LOCK_ACQUIRED

(

)

ASSERT(gpPowerCalloutMutexOwnerThread == KeGetCurrentThread())

Definition at line 40 of file power.h.

Typedef Documentation

POWER_CALLOUT_TYPE

typedef enum tagPOWER_CALLOUT_TYPE POWER_CALLOUT_TYPE

PWIN32POWERCALLOUT

typedef struct tagWIN32POWERCALLOUT * PWIN32POWERCALLOUT

WIN32POWERCALLOUT

typedef struct tagWIN32POWERCALLOUT WIN32POWERCALLOUT

Enumeration Type Documentation

tagPOWER_CALLOUT_TYPE

enum tagPOWER_CALLOUT_TYPE

Enumerator
POWER_CALLOUT_EVENT
POWER_CALLOUT_STATE

Definition at line 13 of file power.h.

{
    POWER_CALLOUT_EVENT = 0,
    POWER_CALLOUT_STATE
} POWER_CALLOUT_TYPE;

Function Documentation

IntAcquirePowerCalloutLock()

FORCEINLINE VOID IntAcquirePowerCalloutLock

(

VOID

)

Definition at line 78 of file power.h.

{
    KeEnterCriticalRegion();
    ExAcquireFastMutexUnsafe(gpPowerCalloutMutexLock);
    gpPowerCalloutMutexOwnerThread = KeGetCurrentThread();
}

Referenced by IntDeployPowerCallout(), and IntEnlistPowerCallout().

IntHandlePowerEvent()

NTSTATUS NTAPI IntHandlePowerEvent

(

_In_ PWIN32_POWEREVENT_PARAMETERS

pWin32PwrEventParams

)

Handles an incoming power event callout from the NT power manager.

Parameters

[in]

pWin32PwrEventParams

A pointer to power event parameters that is given by the NT power manager of the kernel.

Returns

Returns STATUS_UNSUCCESSFUL if the Client/Server subsystem is not running, of which power callouts cannot be handled. Returns STATUS_INVALID_PARAMETER if the provided power event parameters are not valid. Returns STATUS_INSUFFICIENT_RESOURCES if there is a lack of memory to allocate for the power callout. Otherwise it returns STATUS_SUCCESS to indicate the power callout was handled successfully.

Definition at line 362 of file power.c.

{
    PWIN32POWERCALLOUT pWin32PwrCallout;
    NTSTATUS Status;
 
    /*
     * CSRSS is not running. As a consequence, the USER subsystem is neither
     * up and running as the Client/Server subsystem is responsible to fire
     * up other subsystems. Another case is that the system undergoes shutdown
     * and Win32k cleanup is currently in effect. Either way, just quit.
     */
    if (!gpepCSRSS)
    {
        TRACE("CSRSS is not running, bailing out\n");
        return STATUS_UNSUCCESSFUL;
    }
 
    /* Validate the power event parameters, just to be sure we have not gotten anything else */
    Status = IntValidateWin32PowerParams(pWin32PwrEventParams);
    if (!NT_SUCCESS(Status))
    {
        ERR("Could not deploy power callout, invalid Win32 power parameters!\n");
        return Status;
    }
 
    /* Allocate pool of memory for this power callout */
    pWin32PwrCallout = ExAllocatePoolZero(NonPagedPool,
                                          sizeof(WIN32POWERCALLOUT),
                                          USERTAG_POWER);
    if (pWin32PwrCallout == NULL)
    {
        ERR("Allocating memory for Win32 power callout failed\n");
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Fill the necessary power datum */
    pWin32PwrCallout->Type = POWER_CALLOUT_EVENT;
    pWin32PwrCallout->Params.EventNumber = pWin32PwrEventParams->EventNumber;
    pWin32PwrCallout->Params.Code = pWin32PwrEventParams->Code;
 
    /* Enqueue this power request for later processing */
    IntEnlistPowerCallout(pWin32PwrCallout);
    return STATUS_SUCCESS;
}

Referenced by DriverEntry().

IntHandlePowerState()

NTSTATUS NTAPI IntHandlePowerState

(

_In_ PWIN32_POWERSTATE_PARAMETERS

pWin32PwrStateParams

)

Handles an incoming power state callout from the NT power manager.

Parameters

[in]

pWin32PwrStateParams

A pointer to power state parameters that is given by the NT power manager of the kernel.

Definition at line 419 of file power.c.

{
    /* FIXME */
    ERR("IntHandlePowerState is UNIMPLEMENTED\n");
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by DriverEntry().

IntInitWin32PowerManagement()

NTSTATUS NTAPI IntInitWin32PowerManagement

(

_In_ HANDLE

hPowerRequestEvent

)

Initializes the power management side of Win32 kernel-mode subsystem component. This enables communication between the power manager of the NT kernel and Win32k.

Parameters

[in]

hPowerRequestEvent

A handle to the global power request event, provided by the Winsrv module. This allows CSRSS to be notified of power callouts that cannot be handled by Win32k.

Returns

Returns STATUS_INSUFFICIENT_RESOURCES if pool allocation for the power callout lock has failed due to lack of necessary memory. A failure NTSTATUS code is returned if the power request event could not be referenced. Otherwise STATUS_SUCCESS is returned to indicate the power management has initialized successfully.

Definition at line 271 of file power.c.

{
    NTSTATUS Status;
 
    /* Allocate memory pool for the power callout mutex */
    gpPowerCalloutMutexLock = ExAllocatePoolZero(NonPagedPool,
                                                 sizeof(FAST_MUTEX),
                                                 USERTAG_POWER);
    if (gpPowerCalloutMutexLock == NULL)
    {
        ERR("Failed to allocate pool of memory for the power callout mutex\n");
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Initialize the mutex and owner thread */
    ExInitializeFastMutex(gpPowerCalloutMutexLock);
    gpPowerCalloutMutexOwnerThread = NULL;
 
    /* Initialize the global queue list and the power callout (aka request) event object */
    InitializeListHead(&gPowerCalloutsQueueList);
    Status = ObReferenceObjectByHandle(hPowerRequestEvent,
                                       EVENT_ALL_ACCESS,
                                       *ExEventObjectType,
                                       KernelMode,
                                       (PVOID *)&gpPowerRequestCalloutEvent,
                                       NULL);
    if (!NT_SUCCESS(Status))
    {
        ERR("Failed to reference the power callout event handle (Status 0x%08lx)\n", Status);
        ExFreePoolWithTag(gpPowerCalloutMutexLock, USERTAG_POWER);
        return Status;
    }
 
    return STATUS_SUCCESS;
}

Referenced by NtUserInitialize().

IntIsThreadWin32Thread()

FORCEINLINE BOOL IntIsThreadWin32Thread

(

_In_ PETHREAD

Thread

)

Definition at line 99 of file power.h.

{
    return (Thread->Tcb.Win32Thread != NULL) ? TRUE : FALSE;
}

Referenced by IntEnlistPowerCallout().

IntReleasePowerCalloutLock()

FORCEINLINE VOID IntReleasePowerCalloutLock

(

VOID

)

Definition at line 87 of file power.h.

{
    ExReleaseFastMutexUnsafe(gpPowerCalloutMutexLock);
    gpPowerCalloutMutexOwnerThread = NULL;
    KeLeaveCriticalRegion();
}

Referenced by IntDeployPowerCallout(), and IntEnlistPowerCallout().

IntWin32PowerManagementCleanup()

NTSTATUS NTAPI IntWin32PowerManagementCleanup

(

VOID

)

Cleanup procedure that frees all the allocated resources by the power manager. It is triggered during Win32k subsystem unloading.

Definition at line 315 of file power.c.

{
    PWIN32POWERCALLOUT pWin32PwrCallout;
 
    /* Dereference the power request event */
    ObDereferenceObject(gpPowerRequestCalloutEvent);
    gpPowerRequestCalloutEvent = NULL;
 
    /*
     * Enumerate all pending power callouts and free them. We do not
     * need to do this with the lock held as the CSR process is tore
     * apart during Win32k cleanup, so future power callouts would not
     * be allowed anyway, therefore we are safe.
     */
    for (pWin32PwrCallout = IntGetNextPowerCallout(NULL);
         pWin32PwrCallout != NULL;
         pWin32PwrCallout = IntGetNextPowerCallout(pWin32PwrCallout))
    {
        ExFreePoolWithTag(pWin32PwrCallout, USERTAG_POWER);
    }
 
    /* Tear apart the power callout lock mutex */
    ExFreePoolWithTag(gpPowerCalloutMutexLock, USERTAG_POWER);
    gpPowerCalloutMutexLock = NULL;
    return STATUS_SUCCESS;
}

Referenced by _Function_class_().

Variable Documentation

gPowerCalloutsQueueList

LIST_ENTRY gPowerCalloutsQueueList

extern

Definition at line 15 of file power.c.

Referenced by IntEnlistPowerCallout(), IntGetNextPowerCallout(), and IntInitWin32PowerManagement().

gpPowerCalloutMutexLock

PFAST_MUTEX gpPowerCalloutMutexLock

extern

Definition at line 16 of file power.c.

Referenced by IntAcquirePowerCalloutLock(), IntInitWin32PowerManagement(), IntReleasePowerCalloutLock(), and IntWin32PowerManagementCleanup().

gpPowerCalloutMutexOwnerThread

PKTHREAD gpPowerCalloutMutexOwnerThread

extern

Definition at line 18 of file power.c.

Referenced by IntAcquirePowerCalloutLock(), IntInitWin32PowerManagement(), and IntReleasePowerCalloutLock().

gpPowerRequestCalloutEvent

PKEVENT gpPowerRequestCalloutEvent

extern

Definition at line 17 of file power.c.

Referenced by IntEnlistPowerCallout(), IntInitWin32PowerManagement(), and IntWin32PowerManagementCleanup().