cmfuncs.h File Reference

Go to the source code of this file.

Functions
	$if (_WDMDDK_) _IRQL_requires_max_(APC_LEVEL) NTKERNELAPI NTSTATUS NTAPI CmRegisterCallback(_In_ PEX_CALLBACK_FUNCTION Function
	_IRQL_requires_max_ (APC_LEVEL) NTKERNELAPI NTSTATUS NTAPI CmUnRegisterCallback(_In_ LARGE_INTEGER Cookie)
	Probes and locks virtual pages in memory for the specified process.

Variables
_In_opt_ PVOID	Context
_In_opt_ PVOID _Out_ PLARGE_INTEGER	Cookie
_In_ PCUNICODE_STRING	Altitude
_In_ PCUNICODE_STRING _In_ PVOID	Driver
_In_ PCUNICODE_STRING _In_ PVOID _In_opt_ PVOID _Out_ PLARGE_INTEGER _Reserved_ PVOID	Reserved
_Out_opt_ PULONG	Minor
_In_ PLARGE_INTEGER _In_ PVOID	NewContext
_In_ PLARGE_INTEGER _In_ PVOID _Out_opt_ PVOID *	OldContext
_In_ PVOID	Object
_In_ PVOID _Out_opt_ PULONG_PTR	ObjectID
_In_ PVOID _Out_opt_ PULONG_PTR _Outptr_opt_ PCUNICODE_STRING *	ObjectName

Function Documentation

$if()

$if

(

_WDMDDK_

)

Kernel definitions for ARM64

Kernel definitions for AMD64

Kernel definitions for ARM

Definition at line 1 of file ke.h.

{
    ULONG Dummy;
} KFLOATING_SAVE, *PKFLOATING_SAVE;

_IRQL_requires_max_()

_IRQL_requires_max_

(

APC_LEVEL

)

Probes and locks virtual pages in memory for the specified process.

Parameters

[in,out]	MemoryDescriptorList	Memory Descriptor List (MDL) containing the buffer to be probed and locked.
[in]	Process	The process for which the buffer should be probed and locked.
[in]	AccessMode	Access mode for probing the pages. Can be KernelMode or UserMode.
[in]	LockOperation	The type of the probing and locking operation. Can be IoReadAccess, IoWriteAccess or IoModifyAccess.

Returns

Nothing.

See also

MmProbeAndLockPages

Remarks

Must be called at IRQL <= APC_LEVEL

Probes and locks virtual pages in memory for the specified process.

Frees previously reserved amount of memory in system virtual address space.

Parameters

[in]	NumberOfBytes	Size, in bytes, of memory to reserve.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

A pointer to the 1st memory block of the reserved buffer in case of success, NULL otherwise.

Remarks

Must be called at IRQL <= APC_LEVEL

Parameters

[in]	BaseAddress	A pointer to the 1st memory block of the reserved buffer.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

Nothing.

See also

MmAllocateMappingAddress

Remarks

Must be called at IRQL <= APC_LEVEL

Definition at line 37 of file cddata.c.

{
    THREAD_CONTEXT ThreadContext = {0};
    PIRP_CONTEXT IrpContext = NULL;
    BOOLEAN Wait;
 
#ifdef CD_SANITY
    PVOID PreviousTopLevel;
#endif
 
    NTSTATUS Status;
 
#if DBG
 
    KIRQL SaveIrql = KeGetCurrentIrql();
 
#endif
 
    ASSERT_OPTIONAL_IRP( Irp );
 
    UNREFERENCED_PARAMETER( DeviceObject );
 
    FsRtlEnterFileSystem();
 
#ifdef CD_SANITY
    PreviousTopLevel = IoGetTopLevelIrp();
#endif
 
    //
    //  Loop until this request has been completed or posted.
    //
 
    do {
 
        //
        //  Use a try-except to handle the exception cases.
        //
 
        _SEH2_TRY {
 
            //
            //  If the IrpContext is NULL then this is the first pass through
            //  this loop.
            //
 
            if (IrpContext == NULL) {
 
                //
                //  Decide if this request is waitable an allocate the IrpContext.
                //  If the file object in the stack location is NULL then this
                //  is a mount which is always waitable.  Otherwise we look at
                //  the file object flags.
                //
 
                if (IoGetCurrentIrpStackLocation( Irp )->FileObject == NULL) {
 
                    Wait = TRUE;
 
                } else {
 
                    Wait = CanFsdWait( Irp );
                }
 
                IrpContext = CdCreateIrpContext( Irp, Wait );
 
                //
                //  Update the thread context information.
                //
 
                CdSetThreadContext( IrpContext, &ThreadContext );
 
#ifdef CD_SANITY
                NT_ASSERT( !CdTestTopLevel ||
                        SafeNodeType( IrpContext->TopLevel ) == CDFS_NTC_IRP_CONTEXT );
#endif
 
            //
            //  Otherwise cleanup the IrpContext for the retry.
            //
 
            } else {
 
                //
                //  Set the MORE_PROCESSING flag to make sure the IrpContext
                //  isn't inadvertently deleted here.  Then cleanup the
                //  IrpContext to perform the retry.
                //
 
                SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
                CdCleanupIrpContext( IrpContext, FALSE );
            }
 
            //
            //  Case on the major irp code.
            //
 
            switch (IrpContext->MajorFunction) {
 
            case IRP_MJ_CREATE :
 
                Status = CdCommonCreate( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLOSE :
 
                Status = CdCommonClose( IrpContext, Irp );
                break;
 
            case IRP_MJ_READ :
 
                //
                //  If this is an Mdl complete request, don't go through
                //  common read.
                //
 
                if (FlagOn( IrpContext->MinorFunction, IRP_MN_COMPLETE )) {
 
                    Status = CdCompleteMdl( IrpContext, Irp );
 
                } else {
 
                    Status = CdCommonRead( IrpContext, Irp );
                }
 
                break;
 
            case IRP_MJ_WRITE :
 
                Status = CdCommonWrite( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_INFORMATION :
 
                Status = CdCommonQueryInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_SET_INFORMATION :
 
                Status = CdCommonSetInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_VOLUME_INFORMATION :
 
                Status = CdCommonQueryVolInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_DIRECTORY_CONTROL :
 
                Status = CdCommonDirControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_FILE_SYSTEM_CONTROL :
 
                Status = CdCommonFsControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_DEVICE_CONTROL :
 
                Status = CdCommonDevControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_LOCK_CONTROL :
 
                Status = CdCommonLockControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLEANUP :
 
                Status = CdCommonCleanup( IrpContext, Irp );
                break;
 
            case IRP_MJ_PNP :
 
                Status = CdCommonPnp( IrpContext, Irp );
                break;
 
            case IRP_MJ_SHUTDOWN :
 
                Status = CdCommonShutdown( IrpContext, Irp );
                break;
 
            default :
 
                Status = STATUS_INVALID_DEVICE_REQUEST;
                CdCompleteRequest( IrpContext, Irp, Status );
            }
 
        } _SEH2_EXCEPT( CdExceptionFilter( IrpContext, _SEH2_GetExceptionInformation() )) {
 
            Status = CdProcessException( IrpContext, Irp, _SEH2_GetExceptionCode() );
        } _SEH2_END;
 
    } while (Status == STATUS_CANT_WAIT);
 
#ifdef CD_SANITY
    NT_ASSERT( !CdTestTopLevel ||
            (PreviousTopLevel == IoGetTopLevelIrp()) );
#endif
 
    FsRtlExitFileSystem();
 
    NT_ASSERT( SaveIrql == KeGetCurrentIrql( ));
 
    return Status;
}

Variable Documentation

Altitude

_In_ PCUNICODE_STRING Altitude

Definition at line 32 of file cmfuncs.h.

Context

_In_ PCUNICODE_STRING _In_ PVOID _In_opt_ PVOID Context

Definition at line 13 of file cmfuncs.h.

Cookie

_In_ PLARGE_INTEGER Cookie

Definition at line 14 of file cmfuncs.h.

Referenced by $endif(), BasepGetModuleHandleExW(), CmRegisterCallback(), CmUnRegisterCallback(), CreateRemoteThread(), ExtractFilesFromCab(), GetModuleFileNameW(), LdrAddRefDll(), LdrDisableThreadCalloutsForDll(), LdrEnumerateLoadedModules(), LdrGetDllHandleEx(), LdrInitShimEngineDynamic(), LdrLoadDll(), LdrLockLoaderLock(), LdrpFetchAddressOfSecurityCookie(), LdrpInitSecurityCookie(), LdrRegisterDllNotification(), LdrUnloadAlternateResourceModule(), LdrUnlockLoaderLock(), LdrUnregisterDllNotification(), NotifyFileExtractCallback(), NtQueryInformationProcess(), PeLdrInitSecurityCookie(), PeLdrpFetchAddressOfSecurityCookie(), RtlEncodePointer(), and test_IInitializeSpy_twice().

Driver

_In_ PCUNICODE_STRING _In_ PVOID Driver

Definition at line 33 of file cmfuncs.h.

Minor

_Out_opt_ PULONG Minor

Definition at line 44 of file cmfuncs.h.

Referenced by GetVersionInformationFromInfFile(), HalpDispatchPnp(), IsOsVersionGreaterThanOrEqualTo(), _FX_DRIVER_GLOBALS::IsVerificationEnabled(), _FX_DRIVER_GLOBALS::IsVersionGreaterThanOrEqualTo(), QueryAvailableFileSystemFormat(), RamdiskPnp(), TreeView_Set3StateCheck(), USBH_FdoPnP(), USBH_FdoPower(), USBH_PdoPnP(), USBH_PdoPower(), USBPORT_FdoPnP(), USBPORT_PdoPnP(), VgaInterpretCmdStream(), WdmlibRtlIsNtDdiVersionAvailable(), and WsProcSetVersion().

NewContext

_In_ PLARGE_INTEGER _In_ PVOID NewContext

Definition at line 53 of file cmfuncs.h.

Object

_In_ PVOID Object

Definition at line 62 of file cmfuncs.h.

ObjectID

_In_ PVOID _Out_opt_ PULONG_PTR ObjectID

Definition at line 63 of file cmfuncs.h.

ObjectName

_In_ PVOID _Out_opt_ PULONG_PTR _Outptr_opt_ PCUNICODE_STRING* ObjectName

Definition at line 64 of file cmfuncs.h.

Referenced by AccessCheckAndAuditAlarmA(), AccessCheckAndAuditAlarmW(), AcpiUtEvaluateNumericObject(), BaseFormatObjectAttributes(), CmpGetSymbolicLink(), CODE_SEG(), FltpGetBaseDeviceObjectName(), FltpGetObjectName(), GetFinalPathNameByHandleW(), IntResolveDesktop(), IoGetDeviceObjectPointer(), IopGetDeviceObjectPointer(), IopStartRamdisk(), IopUnloadDriver(), KsiCreateObjectType(), LpcpCreatePort(), LsapCreateDbObject(), LsapOpenDbObject(), NpCreatePipeEx(), NpOpenPipeEx(), NtAccessCheckAndAuditAlarm(), NtAccessCheckByTypeAndAuditAlarm(), NtAccessCheckByTypeResultListAndAuditAlarm(), NtAccessCheckByTypeResultListAndAuditAlarmByHandle(), NtOpenObjectAuditAlarm(), NtUnloadKey2(), ObCreateObject(), ObCreateObjectType(), ObInsertObject(), ObjectNameInformationTests(), ObjectOpenAuditAlarmA(), ObjectOpenAuditAlarmW(), ObOpenObjectByName(), ObpAllocateObject(), ObpAllocateObjectNameBuffer(), ObpCaptureObjectCreateInformation(), ObpCaptureObjectName(), ObpIsUnsecureName(), ObpLookupObjectName(), ObQueryNameString(), ObReferenceObjectByName(), ProbeAndCaptureObjectAttributes(), SampCreateDbObject(), SampOpenDbObject(), ScmCreateOrReferenceServiceImage(), SepAccessCheckAndAuditAlarm(), SepOpenObjectAuditAlarm(), SetNamedSecurityInfoA(), START_TEST(), and TreeResetNamedSecurityInfoA().

OldContext

_In_ PLARGE_INTEGER _In_ PVOID _Out_opt_ PVOID* OldContext

Definition at line 54 of file cmfuncs.h.

Reserved

_In_ PCUNICODE_STRING _In_ PVOID _In_opt_ PVOID _Out_ PLARGE_INTEGER _Reserved_ PVOID Reserved

Definition at line 36 of file cmfuncs.h.