handleapi.cpp File Reference

#include "fxobjectpch.hpp"

Include dependency graph for handleapi.cpp:

Go to the source code of this file.

Functions
size_t	FxGetContextSize (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes)
_Must_inspect_result_ NTSTATUS	FxCalculateObjectTotalSize2 (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT RawObjectSize, __in USHORT ExtraSize, __in size_t ContextSize, __out size_t *Total)
_Must_inspect_result_ NTSTATUS	FxCalculateObjectTotalSize (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT RawObjectSize, __in USHORT ExtraSize, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out size_t *Total)
PVOID	FxObjectHandleAlloc (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType, __in size_t Size, __in ULONG Tag, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize, __in FxObjectType ObjectType)
VOID	FxContextHeaderInit (__in FxContextHeader *Header, __in FxObject *Object, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes)
PVOID	FxObjectAndHandleHeaderInit (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PVOID AllocationStart, __in USHORT ObjectSize, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in FxObjectType ObjectType)
VOID	FxObjectHandleGetPtrQI (__in FxObject *Object, __out PVOID *PPObject, __in WDFOBJECT Handle, __in WDFTYPE Type, __in WDFOBJECT_OFFSET Offset)
_Must_inspect_result_ NTSTATUS	FxObjectAllocateContext (__in FxObject *Object, __in PWDF_OBJECT_ATTRIBUTES Attributes, __in BOOLEAN AllowCallbacksOnly, __deref_opt_out PVOID *Context)
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) WDFAPI NTSTATUS STDCALL WDFEXPORT(WdfObjectAllocateContext)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxPointerNotNull (GetFxDriverGlobals(DriverGlobals), Handle)
	if (offset !=0)
	__drv_maxIRQL (DISPATCH_LEVEL+1) WDFAPI PVOID FASTCALL WDFEXPORT(WdfObjectGetTypedContextWorker)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxPointerNotNull (pFxDriverGlobals, TypeInfo)
	for (;pHeader !=NULL;pHeader=pHeader->NextHeader)
	if (TypeInfo->ContextName !=NULL)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGHANDLE, "Attempting to get context type %s from WDFOBJECT 0x%p", pGivenName, Handle)
	return (WDFOBJECT) pObject -> GetObjectHandle()

Variables
_Must_inspect_result_ __in WDFOBJECT	Handle
_Must_inspect_result_ __in WDFOBJECT __in PWDF_OBJECT_ATTRIBUTES	Attributes
_Must_inspect_result_ __in WDFOBJECT __in PWDF_OBJECT_ATTRIBUTES __deref_opt_out PVOID *	Context
NTSTATUS	status = FxObjectAllocateContext(object, Attributes, FALSE, Context)
FxObject *	object = FxObject::_GetObjectFromHandle(Handle, &offset)
WDFOBJECT_OFFSET	offset = 0
Done	__pad0__
__in WDFOBJECT __in PCWDF_OBJECT_CONTEXT_TYPE_INFO	TypeInfo
FxContextHeader *	pHeader = pObject->GetContextHeader()
FxObject *	pObject = FxObject::_GetObjectFromHandle(Handle, &offset)
PFX_DRIVER_GLOBALS	pFxDriverGlobals = pObject->GetDriverGlobals()
PCHAR	pGivenName
	else
return	NULL
__in PVOID	ContextPointer

Function Documentation

__drv_maxIRQL() [1/2]

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_maxIRQL() [2/2]

__drv_maxIRQL

(

DISPATCH_LEVEL+

1

)

DoTraceLevelMessage()

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_WARNING	,
		TRACINGHANDLE	,
		"Attempting to get context type %s from WDFOBJECT 0x%p"	,
		pGivenName	,
		Handle
	)

Referenced by FxCalculateObjectTotalSize2(), FxObjectAllocateContext(), FxObjectHandleGetPtrQI(), and if().

for()

for

(

;pHeader !

= NULL; pHeader = pHeader->NextHeader

)

Definition at line 634 of file handleapi.cpp.

                                                            {
        if (pHeader->ContextTypeInfo == TypeInfo) {
            return &pHeader->Context[0];
        }
    }

FxCalculateObjectTotalSize()

_Must_inspect_result_ NTSTATUS FxCalculateObjectTotalSize	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	RawObjectSize,
		__in USHORT	ExtraSize,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes,
		__out size_t *	Total
	)

Definition at line 147 of file handleapi.cpp.

{
    return FxCalculateObjectTotalSize2(FxDriverGlobals,
                                       RawObjectSize,
                                       ExtraSize,
                                       FxGetContextSize(Attributes),
                                       Total);
}

Referenced by FxObjectAllocateContext(), FxObjectHandleAlloc(), FxLookasideList::InitializeLookaside(), and VfAllocateContext().

FxCalculateObjectTotalSize2()

_Must_inspect_result_ NTSTATUS FxCalculateObjectTotalSize2	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	RawObjectSize,
		__in USHORT	ExtraSize,
		__in size_t	ContextSize,
		__out size_t *	Total
	)

Definition at line 73 of file handleapi.cpp.

{
    NTSTATUS status;
 
    *Total = 0;
 
    status = RtlSizeTAdd(
        WDF_ALIGN_SIZE_UP(COMPUTE_OBJECT_SIZE(RawObjectSize, ExtraSize), MEMORY_ALLOCATION_ALIGNMENT),
        FX_CONTEXT_HEADER_SIZE,
        Total
        );
 
    if (NT_SUCCESS(status)) {
        if (ContextSize != 0) {
            size_t alignUp;
 
            alignUp = ALIGN_UP(ContextSize, PVOID);
 
            //
            // overflow after aligning up to a pointer boundary;
            //
            if (alignUp < ContextSize) {
                return STATUS_INTEGER_OVERFLOW;
            }
 
            status = RtlSizeTAdd(*Total, alignUp, Total);
        }
    }
 
    if (NT_SUCCESS(status) && FxDriverGlobals->IsObjectDebugOn()) {
        //
        // Attempt to add in the debug extension
        //
        status = RtlSizeTAdd(*Total,
                             FxObjectDebugExtensionSize,
                             Total);
    }
 
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(
            FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGOBJECT,
            "Size overflow, object size 0x%x, extra object size 0x%x, "
            "context size 0x%I64x, %!STATUS!",
            RawObjectSize, ExtraSize, ContextSize, status);
    }
 
    return status;
}

Referenced by FxCalculateObjectTotalSize(), and FxDevice::Initialize().

FxContextHeaderInit()

VOID FxContextHeaderInit	(	__in FxContextHeader *	Header,
		__in FxObject *	Object,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes
	)

Definition at line 248 of file handleapi.cpp.

{
    RtlZeroMemory(Header, FX_CONTEXT_HEADER_SIZE);
 
    Header->Object = Object;
 
    if (Attributes != NULL) {
        if (Attributes->ContextTypeInfo != NULL) {
            size_t contextSize;
 
            if (Attributes->ContextSizeOverride != 0) {
                contextSize = Attributes->ContextSizeOverride;
 
            }
            else {
                contextSize = Attributes->ContextTypeInfo->ContextSize;
            }
 
            //
            // Zero initialize the entire context
            //
            RtlZeroMemory(&Header->Context[0], ALIGN_UP(contextSize, PVOID));
        }
 
        Header->ContextTypeInfo = Attributes->ContextTypeInfo;
    }
}

Referenced by FxObjectAllocateContext(), FxObjectAndHandleHeaderInit(), and VfAddContextToHandle().

FxGetContextSize()

size_t FxGetContextSize

(

__in_opt PWDF_OBJECT_ATTRIBUTES

Attributes

)

Definition at line 38 of file handleapi.cpp.

{
    size_t contextSize = 0;
 
    if (Attributes != NULL) {
        if (Attributes->ContextTypeInfo != NULL) {
            if (Attributes->ContextSizeOverride != 0) {
                contextSize = Attributes->ContextSizeOverride;
            }
            else {
                contextSize = Attributes->ContextTypeInfo->ContextSize;
            }
        }
    }
 
    return contextSize;
}

Referenced by FxCalculateObjectTotalSize(), and FxDevice::Initialize().

FxObjectAllocateContext()

_Must_inspect_result_ NTSTATUS FxObjectAllocateContext	(	__in FxObject *	Object,
		__in PWDF_OBJECT_ATTRIBUTES	Attributes,
		__in BOOLEAN	AllowCallbacksOnly,
		__deref_opt_out PVOID *	Context
	)

Definition at line 397 of file handleapi.cpp.

{
    PFX_DRIVER_GLOBALS  fxDriverGlobals;
    NTSTATUS            status;
    FxContextHeader *   header;
    size_t              size;
    BOOLEAN             relRef;
    ULONG               flags;
 
    fxDriverGlobals = Object->GetDriverGlobals();
    header = NULL;
    relRef = FALSE;
 
    //
    // Init validation flags.
    //
    flags = FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED;
    if (fxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,11)) {
        flags |= FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED;
    }
 
    //
    // Basic validations.
    //
    status = FxValidateObjectAttributes(fxDriverGlobals, Attributes, flags);
    if (!NT_SUCCESS(status)) {
        goto Done;
    }
 
    //
    // Check for context type!
    //
    if (Attributes->ContextTypeInfo == NULL && AllowCallbacksOnly == FALSE) {
        status = STATUS_OBJECT_NAME_INVALID;
        DoTraceLevelMessage(
            fxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGHANDLE,
            "Attributes %p ContextTypeInfo is NULL, %!STATUS!",
            Attributes, status);
        goto Done;
    }
 
    Object->ADDREF(&status);
    relRef = TRUE;
 
    //
    // By passing 0's for raw object size and extra size, we can compute the
    // size of only the header and its contents.
    //
    status = FxCalculateObjectTotalSize(fxDriverGlobals, 0, 0, Attributes, &size);
    if (!NT_SUCCESS(status)) {
        goto Done;
    }
 
    header = (FxContextHeader*)
                FxPoolAllocate(fxDriverGlobals, NonPagedPool, size);
 
    if (header == NULL) {
        status = STATUS_INSUFFICIENT_RESOURCES;
        goto Done;
    }
 
    FxContextHeaderInit(header, Object, Attributes);
 
    status = Object->AddContext(header, Context, Attributes);
 
    //
    // STATUS_OBJECT_NAME_EXISTS will not fail NT_SUCCESS, so check
    // explicitly for STATUS_SUCCESS.
    //
    if (status != STATUS_SUCCESS) {
        FxPoolFree(header);
    }
 
Done:
 
    if (relRef) {
        Object->RELEASE(&status);
    }
 
    return status;
}

Referenced by FxPkgGeneral::OnCreate(), and FxUsbInterface::UpdatePipeAttributes().

FxObjectAndHandleHeaderInit()

PVOID FxObjectAndHandleHeaderInit	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in PVOID	AllocationStart,
		__in USHORT	ObjectSize,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes,
		__in FxObjectType	ObjectType
	)

Definition at line 292 of file handleapi.cpp.

{
    FxObject* pObject;
 
    if (FxDriverGlobals->IsObjectDebugOn()) {
        FxObjectDebugExtension* pExtension;
 
        pExtension = (FxObjectDebugExtension*) AllocationStart;
 
        RtlZeroMemory(pExtension, FxObjectDebugExtensionSize);
        pExtension->Signature = FxObjectDebugExtensionSignature;
 
        pObject = (FxObject*) &pExtension->AllocationStart[0];
    }
    else {
        pObject = (FxObject*) AllocationStart;
    }
 
    if (ObjectType == FxObjectTypeExternal) {
        FxContextHeaderInit(
            (FxContextHeader*) WDF_PTR_ADD_OFFSET(pObject, ObjectSize),
            pObject,
            Attributes
            );
    }
 
    return pObject;
}

Referenced by FxDevice::AllocateRequestMemory(), FxObjectHandleAlloc(), FxMemoryBufferFromPoolLookaside::operator new(), and FxMemoryBufferFromLookaside::operator new().

FxObjectHandleAlloc()

PVOID FxObjectHandleAlloc	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in POOL_TYPE	PoolType,
		__in size_t	Size,
		__in ULONG	Tag,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes,
		__in USHORT	ExtraSize,
		__in FxObjectType	ObjectType
	)

Definition at line 163 of file handleapi.cpp.

{
    PVOID   blob;
    size_t  totalSize;
    NTSTATUS status;
 
    if (Tag == 0) {
        Tag = FxDriverGlobals->Tag;
        ASSERT(Tag != 0);
    }
 
    if (ObjectType == FxObjectTypeInternal) {
        //
        // An internal object might need the debug extension size added to it,
        // but that's it.  No extra size, no FxContextHeader.
        //
        if (FxDriverGlobals->IsObjectDebugOn()) {
            status = RtlSizeTAdd(Size,
                                 FxObjectDebugExtensionSize,
                                 &totalSize);
        }
        else {
            totalSize = Size;
            status = STATUS_SUCCESS;
        }
    }
    else {
        status = FxCalculateObjectTotalSize(FxDriverGlobals,
                                            (USHORT) Size,
                                            ExtraSize,
                                            Attributes,
                                            &totalSize);
    }
 
    if (!NT_SUCCESS(status)) {
        return NULL;
    }
 
    blob = FxPoolAllocateWithTag(FxDriverGlobals, PoolType, totalSize, Tag);
 
    if (blob != NULL) {
        blob = FxObjectAndHandleHeaderInit(
            FxDriverGlobals,
            blob,
            COMPUTE_OBJECT_SIZE((USHORT) Size, ExtraSize),
            Attributes,
            ObjectType
            );
    }
 
    return blob;
}

Referenced by FxObject::operator new(), and FxMemoryBuffer::operator new().

FxObjectHandleGetPtrQI()

VOID FxObjectHandleGetPtrQI	(	__in FxObject *	Object,
		__out PVOID *	PPObject,
		__in WDFOBJECT	Handle,
		__in WDFTYPE	Type,
		__in WDFOBJECT_OFFSET	Offset
	)

Definition at line 347 of file handleapi.cpp.

{
    FxQueryInterfaceParams params = { PPObject, Type, Offset };
    NTSTATUS status;
 
    *PPObject = NULL;
 
    status = Object->QueryInterface(&params);
 
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(
            Object->GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "Object Type Mismatch, Handle 0x%p, Type 0x%x, "
            "Obj 0x%p, SB 0x%x",
            Handle, Type, Object, Object->GetType());
 
        FxVerifierBugCheck(Object->GetDriverGlobals(),
                           WDF_INVALID_HANDLE,
                           (ULONG_PTR) Handle,
                           Type);
 
        /* NOTREACHED */
        return;
    }
}

Referenced by FxObjectHandleGetPtr(), and FxObjectHandleGetPtrOffset().

FxPointerNotNull() [1/2]

FxPointerNotNull	(	GetFxDriverGlobals(DriverGlobals)	,
		Handle
	)

FxPointerNotNull() [2/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		TypeInfo
	)

if() [1/2]

if

(

offset !

= 0

)

Definition at line 552 of file handleapi.cpp.

                     {
 
 
 
        status = STATUS_OBJECT_PATH_INVALID;
        DoTraceLevelMessage(
            object->GetDriverGlobals(), TRACE_LEVEL_WARNING, TRACINGHANDLE,
            "WDFHANDLE %p cannot have contexts added to it, %!STATUS!",
            Handle, status);
        goto Done;
    }

if() [2/2]

if

(

TypeInfo->ContextName !

= NULL

)

Definition at line 642 of file handleapi.cpp.

                                       {
        pGivenName = TypeInfo->ContextName;
    }

return()

return

(

WDFOBJECT

)

-> GetObjectHandle()

Variable Documentation

__pad0__

Done __pad0__

Definition at line 569 of file handleapi.cpp.

Attributes

_Must_inspect_result_ __in WDFOBJECT __in PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 514 of file handleapi.cpp.

Context

_Must_inspect_result_ __in WDFOBJECT __in PWDF_OBJECT_ATTRIBUTES __deref_opt_out PVOID* Context

Initial value:

{
    DDI_ENTRY_IMPERSONATION_OK()

Definition at line 516 of file handleapi.cpp.

ContextPointer

__in PVOID ContextPointer

Initial value:

{
    DDI_ENTRY_IMPERSONATION_OK()

Definition at line 664 of file handleapi.cpp.

Referenced by KiInitializeContextThread(), WdfObjectContextGetObject(), and WriteMinidump().

else

else

Initial value:

{
        pGivenName = "<no typename given>"

Definition at line 645 of file handleapi.cpp.

Handle

__in WDFOBJECT Handle

Definition at line 512 of file handleapi.cpp.

Referenced by FxObjectHandleGetPtrQI(), and if().

NULL

return NULL

Definition at line 653 of file handleapi.cpp.

Referenced by FxContextHeaderInit(), FxGetContextSize(), FxObjectAllocateContext(), FxObjectHandleAlloc(), and FxObjectHandleGetPtrQI().

object

object = FxObject::_GetObjectFromHandle(Handle, &offset)

Definition at line 538 of file handleapi.cpp.

offset

offset = 0

Definition at line 539 of file handleapi.cpp.

pFxDriverGlobals

pFxDriverGlobals = pObject->GetDriverGlobals()

Definition at line 606 of file handleapi.cpp.

pGivenName

PCHAR pGivenName

Definition at line 640 of file handleapi.cpp.

Referenced by if(), and VfWdfObjectGetTypedContext().

pHeader

FxContextHeader * pHeader = pObject->GetContextHeader()

Definition at line 604 of file handleapi.cpp.

Referenced by FxObject::_CleanupPointer(), FxLookasideList::_Reclaim(), AddPropSheetPageCallback(), FxDevice::AllocateRequestMemory(), cache_container_lock_index(), cache_container_unlock_index(), FxObject::CallCleanupCallbacks(), FxObject::ClearEvtCallbacks(), FxObject::Commit(), CreateOffloadInfo5Internal(), CURSORICON_GetCursorDataFromANI(), DeleteUrlCacheEntryA(), for(), FxDevice::FreeRequestMemory(), FxIFRStart(), FxPoolAllocator(), FxPoolFree(), GetDosHeader(), GetPEFileHeader(), GetPEOptionalHeader(), FxLookasideList::InitObjectAlloc(), FxPagedLookasideListFromPool::InitPagedAlloc(), IsUrlCacheEntryExpiredA(), ITypeLib2_Constructor_SLTG(), LoadPropSheetHandlers(), ParaNdis_IndicateReceivedPacket(), FxObject::ProcessDestroy(), FxPagedLookasideListFromPool::ReclaimPool(), RecycleBin5_RecycleBin5_Delete(), RecycleBin5_RecycleBin5_DeleteFile(), RecycleBin5_RecycleBin5_Restore(), RecycleBin5Enum_RecycleBinEnumList_Next(), FxRequestFromLookaside::SelfDestruct(), SetUrlCacheEntryInfoA(), UnlockUrlCacheEntryFileA(), urlcache_create_file_pathA(), urlcache_create_file_pathW(), urlcache_entry_delete(), urlcache_enum_hash_tables(), urlcache_find_hash_entry(), urlcache_find_next_entry(), urlcache_get_hash_table(), urlcache_hash_entry_create(), VfAddContextToHandle(), VfAllocateContext(), and VfWdfObjectGetTypedContext().

pObject

pObject = FxObject::_GetObjectFromHandle(Handle, &offset)

Definition at line 605 of file handleapi.cpp.

Referenced by FxObjectAndHandleHeaderInit().

status

status = FxObjectAllocateContext(object, Attributes, FALSE, Context)

Definition at line 537 of file handleapi.cpp.

Referenced by FxCalculateObjectTotalSize2(), FxObjectAllocateContext(), FxObjectHandleAlloc(), and FxObjectHandleGetPtrQI().

TypeInfo

__in WDFOBJECT __in PCWDF_OBJECT_CONTEXT_TYPE_INFO TypeInfo

Initial value:

{
    DDI_ENTRY_IMPERSONATION_OK()

Definition at line 583 of file handleapi.cpp.

Referenced by D3DXGetShaderSamplers(), for(), if(), IopParseDevice(), ObpDeallocateObject(), parse_ctab_constant_type(), VfWdfObjectGetTypedContext(), and WdfObjectGetTypedContextWorker().