fxhandle.h File Reference

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

Go to the source code of this file.

Classes
struct	FxContextHeader

Macros
#define	FX_CONTEXT_HEADER_SIZE   FIELD_OFFSET(FxContextHeader, Context)
#define	COMPUTE_RAW_OBJECT_SIZE(_rawObjectSize)    ((USHORT) WDF_ALIGN_SIZE_UP(_rawObjectSize, MEMORY_ALLOCATION_ALIGNMENT))
#define	COMPUTE_OBJECT_SIZE(_rawObjectSize, _extraSize)    (COMPUTE_RAW_OBJECT_SIZE(_rawObjectSize) + (USHORT) WDF_ALIGN_SIZE_UP(_extraSize, MEMORY_ALLOCATION_ALIGNMENT))

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 __inline	FxObjectHandleCreate (__in FxObject *Object, __out PWDFOBJECT Handle)
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)
__inline BOOLEAN	FxObjectCheckType (__in FxObject *Object, __in WDFTYPE Type)
__inline VOID	FxObjectHandleGetPtr (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFOBJECT Handle, __in WDFTYPE Type, __out PVOID *PPObject)
__inline VOID	FxObjectHandleGetPtrOffset (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFOBJECT Handle, __in WDFTYPE Type, __out PVOID *PPObject, __out PWDFOBJECT_OFFSET Offset)
VOID __inline	FxObjectHandleGetPtrAndGlobals (__in PFX_DRIVER_GLOBALS CallersGlobals, __in WDFOBJECT Handle, __in WDFTYPE Type, __out PVOID *PPObject, __out PFX_DRIVER_GLOBALS *ObjectGlobals)
VOID __inline	FxObjectHandleGetGlobals (__in PFX_DRIVER_GLOBALS CallersGlobals, __in WDFOBJECT Handle, __out PFX_DRIVER_GLOBALS *ObjectGlobals)

Macro Definition Documentation

COMPUTE_OBJECT_SIZE

#define COMPUTE_OBJECT_SIZE	(		_rawObjectSize,
			_extraSize
	)		(COMPUTE_RAW_OBJECT_SIZE(_rawObjectSize) + (USHORT) WDF_ALIGN_SIZE_UP(_extraSize, MEMORY_ALLOCATION_ALIGNMENT))

Definition at line 107 of file fxhandle.h.

COMPUTE_RAW_OBJECT_SIZE

#define COMPUTE_RAW_OBJECT_SIZE

(

_rawObjectSize

)

((USHORT) WDF_ALIGN_SIZE_UP(_rawObjectSize, MEMORY_ALLOCATION_ALIGNMENT))

Definition at line 100 of file fxhandle.h.

FX_CONTEXT_HEADER_SIZE

#define FX_CONTEXT_HEADER_SIZE   FIELD_OFFSET(FxContextHeader, Context)

Definition at line 98 of file fxhandle.h.

Function Documentation

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().

FxObjectCheckType()

__inline BOOLEAN FxObjectCheckType	(	__in FxObject *	Object,
		__in WDFTYPE	Type
	)

Definition at line 240 of file fxhandle.h.

{
    NTSTATUS status;
    PVOID tmpObject;
    FxQueryInterfaceParams params = {&tmpObject, Type, 0};
 
    //
    // Do a quick non virtual call for the type and only do the slow QI if
    // the first types do not match
    //
 
    if (Object->GetType() == Type) {
        return TRUE;
    }
 
    status = Object->QueryInterface(&params);
 
    if (!NT_SUCCESS(status)) {
        return FALSE;
    }
 
    return TRUE;
 
}

Referenced by FxUsbDevice::IsObjectDisposedOnRemove().

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;
}

FxObjectHandleCreate()

VOID __inline FxObjectHandleCreate	(	__in FxObject *	Object,
		__out PWDFOBJECT	Handle
	)

Definition at line 176 of file fxhandle.h.

{
#if FX_SUPER_DBG
    if (Object->GetDriverGlobals()->FxVerifierHandle) {
 
 
 
 
 
 
        ASSERT(Object->GetObjectSize() > 0);
        ASSERT(Object == Object->GetContextHeader()->Object);
    }
#endif
 
    ASSERT((((ULONG_PTR) Object) & FxHandleFlagMask) == 0x0);
    *Handle = Object->GetObjectHandle();
}

Referenced by FxObject::Commit().

FxObjectHandleGetGlobals()

VOID __inline FxObjectHandleGetGlobals	(	__in PFX_DRIVER_GLOBALS	CallersGlobals,
		__in WDFOBJECT	Handle,
		__out PFX_DRIVER_GLOBALS *	ObjectGlobals
	)

Definition at line 453 of file fxhandle.h.

{
    PVOID pObject;
 
    FxObjectHandleGetPtrAndGlobals(CallersGlobals,
                                   Handle,
                                   FX_TYPE_OBJECT,
                                   &pObject,
                                   ObjectGlobals);
 
    UNREFERENCED_PARAMETER(pObject);
}

Referenced by if().

FxObjectHandleGetPtr()

__inline VOID FxObjectHandleGetPtr	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFOBJECT	Handle,
		__in WDFTYPE	Type,
		__out PVOID *	PPObject
	)

Definition at line 283 of file fxhandle.h.

{
    WDFOBJECT_OFFSET offset;
    FxObject* pObject;
 
    if (Handle == NULL) {
 
 
 
 
 
        FxVerifierBugCheck(FxDriverGlobals,
                           WDF_INVALID_HANDLE,
                           (ULONG_PTR) Handle,
                           Type);
 
        /* NOTREACHED */
        return;
    }
 
    offset = 0;
    pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
 
    //
    // The only DDI you can call on an object which has a ref count of zero is
    // WdfObjectGetTypedContextWorker().
    //
    ASSERT(pObject->GetRefCnt() > 0);
 
    //
    // Do a quick non virtual call for the type and only do the slow QI if
    // the first types do not match
    //
    if (pObject->GetType() == Type) {
        *PPObject = pObject;
        ASSERT(offset == 0x0);
        return;
    }
    else {
        FxObjectHandleGetPtrQI(pObject, PPObject, Handle, Type, offset);
    }
}

Referenced by FxObjectHandleGetPtrAndGlobals().

FxObjectHandleGetPtrAndGlobals()

VOID __inline FxObjectHandleGetPtrAndGlobals	(	__in PFX_DRIVER_GLOBALS	CallersGlobals,
		__in WDFOBJECT	Handle,
		__in WDFTYPE	Type,
		__out PVOID *	PPObject,
		__out PFX_DRIVER_GLOBALS *	ObjectGlobals
	)

Definition at line 414 of file fxhandle.h.

{
    //
    // All FX_TYPEs except for IFX_TYPE_MEMORY derive from FxObject, so our cast
    // below will work with all types but IFX_TYPE_MEMORY (in which case the caller
    // should call FxObjectHandleGetPtr and then get the globals on their own
    // from the IFxMemory interface).
    //
    ASSERT(Type != IFX_TYPE_MEMORY);
 
    FxObjectHandleGetPtr(CallersGlobals,
                         Handle,
                         Type,
                         PPObject);
 
    *ObjectGlobals = ((FxObject*) (*PPObject))->GetDriverGlobals();
}

Referenced by FxObjectHandleGetGlobals().

FxObjectHandleGetPtrOffset()

__inline VOID FxObjectHandleGetPtrOffset	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFOBJECT	Handle,
		__in WDFTYPE	Type,
		__out PVOID *	PPObject,
		__out PWDFOBJECT_OFFSET	Offset
	)

Definition at line 345 of file fxhandle.h.

{
    FxObject* pObject;
 
    if (Handle == NULL) {
 
 
 
 
 
        FxVerifierBugCheck(FxDriverGlobals,
                           WDF_INVALID_HANDLE,
                           (ULONG_PTR) Handle,
                           Type);
 
        /* NOTREACHED */
        return;
    }
 
    *Offset = 0;
    pObject = FxObject::_GetObjectFromHandle(Handle, Offset);
 
    //
    // The only DDI you can call on an object which has a ref count of zero is
    // WdfObjectGetTypedContextWorker().
    //
    ASSERT(pObject->GetRefCnt() > 0);
 
    //
    // Do a quick non virtual call for the type and only do the slow QI if
    // the first types do not match
    //
    if (pObject->GetType() == Type) {
        *PPObject = pObject;
        ASSERT(*Offset == 0x0);
        return;
    }
    else {
        FxObjectHandleGetPtrQI(pObject, PPObject, Handle, Type, *Offset);
    }
}

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().