fxtimerapi.cpp File Reference

#include "coreprivshared.hpp"
#include "fxtimer.hpp"

Include dependency graph for fxtimerapi.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS STDCALL WDFEXPORT(WdfTimerCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	if (!NT_SUCCESS(status))
	FxObjectHandleGetPtrAndGlobals (pFxDriverGlobals, Attributes->ParentObject, FX_TYPE_OBJECT,(PVOID *)&pParent, &pFxDriverGlobals)
	FxPointerNotNull (pFxDriverGlobals, Config)
	FxPointerNotNull (pFxDriverGlobals, Timer)
	if (Config->Size !=sizeof(WDF_TIMER_CONFIG) &&Config->Size !=sizeof(WDF_TIMER_CONFIG_V1_7) &&Config->Size !=sizeof(WDF_TIMER_CONFIG_V1_11))
	if (Config->Period > MAXLONG)
	if (Config->Size > sizeof(WDF_TIMER_CONFIG_V1_7) &&(pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1, 13)==FALSE))
	if (Config->Size > sizeof(WDF_TIMER_CONFIG_V1_11))
	if (Config->Period > 0 &&Attributes->ExecutionLevel==WdfExecutionLevelPassive)
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Timer, FX_TYPE_TIMER,(PVOID *)&pFxTimer)
return pFxTimer	Start (li)
	__drv_when (Wait==__true, __drv_maxIRQL(PASSIVE_LEVEL)) __drv_when(Wait
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Timer, FX_TYPE_TIMER,(PVOID *)&pFxTimer, &pFxDriverGlobals)
	if (Wait)
return pFxTimer	Stop (Wait)
return pFxTimer	GetObject ()

Variables
_Must_inspect_result_ __in PWDF_TIMER_CONFIG	Config
_Must_inspect_result_ __in PWDF_TIMER_CONFIG __in PWDF_OBJECT_ATTRIBUTES	Attributes
_Must_inspect_result_ __in PWDF_TIMER_CONFIG __in PWDF_OBJECT_ATTRIBUTES __out WDFTIMER *	Timer
PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
FxObject *	pParent
NTSTATUS	status
__in WDFTIMER __in LONGLONG	DueTime
FxTimer *	pFxTimer
LARGE_INTEGER	li
li	QuadPart = DueTime
__in WDFTIMER __in BOOLEAN	Wait

Function Documentation

__drv_maxIRQL()

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_when()

__drv_when	(	Wait	= = __true,
		__drv_maxIRQL(PASSIVE_LEVEL)
	)

FxObjectHandleGetPtr()

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Timer	,
		FX_TYPE_TIMER	,
		(PVOID *)&	pFxTimer
	)

FxObjectHandleGetPtrAndGlobals() [1/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Timer	,
		FX_TYPE_TIMER	,
		(PVOID *)&	pFxTimer,
		&	pFxDriverGlobals
	)

FxObjectHandleGetPtrAndGlobals() [2/2]

FxObjectHandleGetPtrAndGlobals	(	pFxDriverGlobals	,
		Attributes->	ParentObject,
		FX_TYPE_OBJECT	,
		(PVOID *)&	pParent,
		&	pFxDriverGlobals
	)

FxPointerNotNull() [1/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		Config
	)

FxPointerNotNull() [2/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		Timer
	)

GetObject()

return pFxTimer GetObject

(

)

if() [1/7]

if

(

!

NT_SUCCESSstatus

)

Definition at line 93 of file fxtimerapi.cpp.

                             {
        return status;
    }

if() [2/7]

if	(	Config->	Period,
		0 &&Attributes->	ExecutionLevel = = WdfExecutionLevelPassive
	)

Definition at line 184 of file fxtimerapi.cpp.

                                                                {
        status = STATUS_NOT_SUPPORTED;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "Passive level periodic timer is not supported. "
            "Use one shot timer and queue the next timer from the callback "
            "or use a dedicated thread, %!STATUS!",
            status);
 
        return status;
    }

if() [3/7]

if	(	Config->	Period,
		MAXLONG
	)

Definition at line 119 of file fxtimerapi.cpp.

                                  {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "Period value %u for a periodic timer cannot be greater than "
            "MAXLONG, %!STATUS!", Config->Period, status);
 
        return status;
    }

if() [4/7]

if

(

Config->Size !

= sizeof(WDF_TIMER_CONFIG) && Config->Size != sizeof(WDF_TIMER_CONFIG_V1_7) && Config->Size != sizeof(WDF_TIMER_CONFIG_V1_11)

)

Definition at line 106 of file fxtimerapi.cpp.

                                                        {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "PWDF_TIMER_CONFIG Size %d, expected %d, %!STATUS!",
            Config->Size, sizeof(WDF_TIMER_CONFIG), status);
 
        return status;
    }

if() [5/7]

if	(	Config->	Size,
		sizeof(WDF_TIMER_CONFIG_V1_11)
	)

Definition at line 149 of file fxtimerapi.cpp.

                                                       {
 
#if (FX_CORE_MODE == FX_CORE_USER_MODE)
        if (Config->UseHighResolutionTimer) {
 
            status = STATUS_NOT_IMPLEMENTED;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                "UseHighResolutionTimer option is not supported for UMDF "
                "%!STATUS!", status);
            return status;
        }
#endif
 
        if ((Config->TolerableDelay > 0) &&
            (Config->UseHighResolutionTimer)) {
 
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                "UseHighResolutionTimer option sepcified with non zero tolerable delay %u "
                "%!STATUS!", Config->TolerableDelay, status);
 
            return status;
        }
    }

if() [6/7]

if	(	Config->	Size,
		sizeof(WDF_TIMER_CONFIG_V1_7) &&(pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1, 13)==FALSE)
	)

Definition at line 134 of file fxtimerapi.cpp.

                                                                          {
        if (Config->TolerableDelay > MAXLONG) {
 
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                "TolerableDelay value %u cannot be greater than MAXLONG, "
                "%!STATUS!", Config->TolerableDelay, status);
 
            return status;
        }
    }

if() [7/7]

if

(

Wait

)

Definition at line 289 of file fxtimerapi.cpp.

              {
        status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
        if (!NT_SUCCESS(status)) {
            return FALSE;
        }
    }

Start()

return pFxTimer Start

(

li

)

Stop()

return pFxTimer Stop

(

Wait

)

Variable Documentation

Attributes

_Must_inspect_result_ __in PWDF_TIMER_CONFIG __in PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 49 of file fxtimerapi.cpp.

Config

_Must_inspect_result_ __in PWDF_TIMER_CONFIG Config

Definition at line 47 of file fxtimerapi.cpp.

DueTime

__in WDFTIMER __in LONGLONG DueTime

Initial value:

{
    DDI_ENTRY()

Definition at line 210 of file fxtimerapi.cpp.

li

LARGE_INTEGER li

Definition at line 235 of file fxtimerapi.cpp.

Referenced by __file_size(), CRegPropertyBag::_CopyStreamIntoBuff(), CDesktopUpgradePropertyBag::_NewStreamFromOld(), AddIPAddressToListView(), AddPrincipalListEntry(), create_cache_entry(), CreateFilterList(), CreatePrincipalListItem(), DeleteItemFromList(), DisplayEvent(), DisplayEventData(), dwarf2_init_zsection(), EDIT_EM_LineLength(), EDIT_EM_PosFromChar(), EDIT_MoveWordBackward(), EDIT_MoveWordForward(), EDIT_PaintLine(), EDIT_PaintText(), EDIT_WM_LButtonDblClk(), elf_map_file_read(), EnumDeviceDriverFilesCallback(), ff_wtoupper(), FillDevicesListViewControl(), FreeDriveItemContext(), GetDefaultItem(), GetGWListEntry(), GetIPListEntry(), GetListViewItem(), GetSelectedItem(), gettimeofday(), InitFilterListBox(), InitializeRecycleBinDlg(), InitializeTcpipAdvancedIpDlg(), InsertIpAddressToListView(), InsertItemToListView(), InsertListItem(), CNetConnectionPropertyUi::LANPropertiesUIDlg(), LANStatusUiDetailsDlg(), ListViewGetSelectedItemData(), ListViewSelectItem(), navigate_history(), NtUserBuildPropList(), out_seek(), pe_map_file(), RecycleBinDlg(), SetLinger(), SetListViewText(), StoreDriveSettings(), StrToIntExA(), StrToIntExW(), SymGetLinePrev64(), symt_get_func_line_next(), TcpipAdvancedIpDlg(), TcpipFilterPortDlg(), test_cache_read(), test_DPA_LoadStream(), test_save_history(), Database::toSdb(), UpdatePrincipalListItem(), and UpdateSystemTime().

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 84 of file fxtimerapi.cpp.

Referenced by if().

pFxTimer

FxTimer * pFxTimer

Definition at line 234 of file fxtimerapi.cpp.

Referenced by FxTimer::_Create().

pParent

FxObject* pParent

Definition at line 85 of file fxtimerapi.cpp.

QuadPart

li QuadPart = DueTime

Definition at line 242 of file fxtimerapi.cpp.

status

NTSTATUS status

Initial value:

= FxValidateObjectAttributesForParentHandle(pFxDriverGlobals,
                                                       Attributes,
                                                       FX_VALIDATE_OPTION_PARENT_REQUIRED)

Definition at line 86 of file fxtimerapi.cpp.

Referenced by if().

Timer

__in WDFTIMER Timer

Initial value:

{
    DDI_ENTRY()

Definition at line 51 of file fxtimerapi.cpp.

Wait

__in WDFTIMER __in BOOLEAN Wait

Initial value:

{
    DDI_ENTRY()

Definition at line 257 of file fxtimerapi.cpp.