util.c File Reference

#include <ntoskrnl.h>
#include <debug.h>

Include dependency graph for util.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	RtlpGetStackLimits (PULONG_PTR StackBase, PULONG_PTR StackLimit)
NTSTATUS NTAPI	IoComputeDesiredAccessFileObject (IN PFILE_OBJECT FileObject, IN PACCESS_MASK DesiredAccess)
VOID NTAPI	IoAcquireCancelSpinLock (OUT PKIRQL Irql)
PVOID NTAPI	IoGetInitialStack (VOID)
VOID NTAPI	IoGetStackLimits (OUT PULONG_PTR LowLimit, OUT PULONG_PTR HighLimit)
BOOLEAN NTAPI	IoIsSystemThread (IN PETHREAD Thread)
BOOLEAN NTAPI	IoIsWdmVersionAvailable (IN UCHAR MajorVersion, IN UCHAR MinorVersion)
PEPROCESS NTAPI	IoGetCurrentProcess (VOID)
VOID NTAPI	IoReleaseCancelSpinLock (IN KIRQL Irql)
PEPROCESS NTAPI	IoThreadToProcess (IN PETHREAD Thread)
NTSTATUS NTAPI	IoCheckDesiredAccess (IN OUT PACCESS_MASK DesiredAccess, IN ACCESS_MASK GrantedAccess)
NTSTATUS NTAPI	IoCheckEaBufferValidity (IN PFILE_FULL_EA_INFORMATION EaBuffer, IN ULONG EaLength, OUT PULONG ErrorOffset)
NTSTATUS NTAPI	IoCheckFunctionAccess (IN ACCESS_MASK GrantedAccess, IN UCHAR MajorFunction, IN UCHAR MinorFunction, IN ULONG IoControlCode, IN PVOID ExtraData OPTIONAL, IN PVOID ExtraData2 OPTIONAL)
NTSTATUS NTAPI	IoValidateDeviceIoControlAccess (IN PIRP Irp, IN ULONG RequiredAccess)
VOID NTAPI	IoSetDeviceToVerify (IN PETHREAD Thread, IN PDEVICE_OBJECT DeviceObject)
VOID NTAPI	IoSetHardErrorOrVerifyDevice (IN PIRP Irp, IN PDEVICE_OBJECT DeviceObject)
PDEVICE_OBJECT NTAPI	IoGetDeviceToVerify (IN PETHREAD Thread)
NTSTATUS NTAPI	IoCheckQuerySetVolumeInformation (IN FS_INFORMATION_CLASS FsInformationClass, IN ULONG Length, IN BOOLEAN SetOperation)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 14 of file util.c.

Function Documentation

IoAcquireCancelSpinLock()

VOID NTAPI IoAcquireCancelSpinLock

(

OUT PKIRQL

Irql

)

Definition at line 56 of file util.c.

{
    /* Just acquire the internal lock */
    *Irql = KeAcquireQueuedSpinLock(LockQueueIoCancelLock);
}

Referenced by BeepCleanup(), BeepStartIo(), DispPrepareIrpForCancel(), EndRequestHandler(), FsRtlAcknowledgeOplockBreak(), FsRtlNotifySetCancelRoutine(), FsRtlOplockBreakToII(), FsRtlOplockBreakToNone(), FsRtlOplockCleanup(), FsRtlRemoveAndCompleteIrp(), FsRtlRemoveAndCompleteWaitIrp(), FsRtlRequestExclusiveOplock(), FsRtlRequestOplockII(), FsRtlUninitializeOplock(), FsRtlWaitOnIrp(), HandleReadIrp(), IoCancelIrp(), IopStartNextPacket(), IopStartNextPacketByKey(), IoStartPacket(), IRPFinish(), KsAddIrpToCancelableQueue(), KsCancelIo(), KsMoveIrpsOnCancelableQueue(), KsReleaseIrpOnCancelableQueue(), KsRemoveIrpFromCancelableQueue(), MountMgrChangeNotify(), MountMgrCleanup(), MountMgrNotify(), NduDispatchRead(), QueueUserModeIrp(), RxCompleteRequest_Real(), RxFsdCommonDispatch(), USBH_CheckHubIdle(), USBH_FdoCleanup(), USBH_FdoIdleNotificationCallback(), USBH_FdoIdleNotificationRequestComplete(), USBH_FdoSubmitIdleRequestIrp(), USBH_FdoSubmitWaitWakeIrp(), USBH_FdoWWIrpIoCompletion(), USBH_HubQueuePortIdleIrps(), USBH_HubQueuePortWakeIrps(), USBH_PdoRemoveDevice(), USBH_PortIdleNotificationRequest(), USBPORT_DoneTransfer(), USBPORT_FlushCancelList(), USBSTOR_QueueAddIrp(), and USBSTOR_StartIo().

IoCheckDesiredAccess()

NTSTATUS NTAPI IoCheckDesiredAccess	(	IN OUT PACCESS_MASK	DesiredAccess,
		IN ACCESS_MASK	GrantedAccess
	)

Definition at line 172 of file util.c.

{
    PAGED_CODE();
 
    /* Map the generic mask */
    RtlMapGenericMask(DesiredAccess,
                      &IoFileObjectType->TypeInfo.GenericMapping);
 
    /* Fail if the access masks don't grant full access */
    if ((~(*DesiredAccess) & GrantedAccess)) return STATUS_ACCESS_DENIED;
    return STATUS_SUCCESS;
}

IoCheckEaBufferValidity()

NTSTATUS NTAPI IoCheckEaBufferValidity	(	IN PFILE_FULL_EA_INFORMATION	EaBuffer,
		IN ULONG	EaLength,
		OUT PULONG	ErrorOffset
	)

Definition at line 191 of file util.c.

{
    ULONG NextEntryOffset;
    UCHAR EaNameLength;
    ULONG ComputedLength;
    PFILE_FULL_EA_INFORMATION Current;
 
    PAGED_CODE();
 
    /* We will browse all the entries */
    for (Current = EaBuffer; ; Current = (PFILE_FULL_EA_INFORMATION)((ULONG_PTR)Current + NextEntryOffset))
    {
        /* Check that we have enough bits left for the current entry */
        if (EaLength < FIELD_OFFSET(FILE_FULL_EA_INFORMATION, EaName))
        {
            goto FailPath;
        }
 
        EaNameLength = Current->EaNameLength;
        ComputedLength = Current->EaValueLength + EaNameLength + FIELD_OFFSET(FILE_FULL_EA_INFORMATION, EaName) + 1;
        /* Check that we have enough bits left for storing the name and its value */
        if (EaLength < ComputedLength)
        {
            goto FailPath;
        }
 
        /* Make sure the name is null terminated */
        if (Current->EaName[EaNameLength] != ANSI_NULL)
        {
            goto FailPath;
        }
 
        /* Get the next entry offset */
        NextEntryOffset = Current->NextEntryOffset;
        /* If it's 0, it's a termination case */
        if (NextEntryOffset == 0)
        {
            /* If we don't overflow! */
            if ((LONG)(EaLength - ComputedLength) < 0)
            {
                goto FailPath;
            }
 
            break;
        }
 
        /* Compare the next offset we computed with the provided one, they must match */
        if (ALIGN_UP_BY(ComputedLength, sizeof(ULONG)) != NextEntryOffset)
        {
            goto FailPath;
        }
 
        /* Check next entry offset value is positive */
        if ((LONG)NextEntryOffset < 0)
        {
            goto FailPath;
        }
 
        /* Compute the remaining bits */
        EaLength -= NextEntryOffset;
        /* We must have bits left */
        if ((LONG)EaLength < 0)
        {
            goto FailPath;
        }
 
        /* Move to the next entry */
    }
 
    /* If we end here, everything went OK */
    return STATUS_SUCCESS;
 
FailPath:
    /* If we end here, we failed, set failed offset */
    *ErrorOffset = (ULONG_PTR)Current - (ULONG_PTR)EaBuffer;
    return STATUS_EA_LIST_INCONSISTENT;
}

Referenced by _Dispatch_type_(), _tmain(), Ext2OverwriteEa(), Ext2SetEa(), FatCommonSetEa(), file_create(), fsctl_set_xattr(), get_ea_len(), IopCreateFile(), nfs41_SetEaInformation(), open_fcb(), and open_file3().

IoCheckFunctionAccess()

NTSTATUS NTAPI IoCheckFunctionAccess	(	IN ACCESS_MASK	GrantedAccess,
		IN UCHAR	MajorFunction,
		IN UCHAR	MinorFunction,
		IN ULONG	IoControlCode,
		IN PVOID ExtraData	OPTIONAL,
		IN PVOID ExtraData2	OPTIONAL
	)

Definition at line 276 of file util.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by UDFCommonFileInfo(), UDFCommonQueryVolInfo(), and UDFCommonSetVolInfo().

IoCheckQuerySetVolumeInformation()

NTSTATUS NTAPI IoCheckQuerySetVolumeInformation	(	IN FS_INFORMATION_CLASS	FsInformationClass,
		IN ULONG	Length,
		IN BOOLEAN	SetOperation
	)

Definition at line 347 of file util.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

IoComputeDesiredAccessFileObject()

NTSTATUS NTAPI IoComputeDesiredAccessFileObject	(	IN PFILE_OBJECT	FileObject,
		IN PACCESS_MASK	DesiredAccess
	)

Definition at line 26 of file util.c.

{
    /* Assume failure */
    *DesiredAccess = 0;
 
    /* First check we really have a FileObject */
    if (OBJECT_TO_OBJECT_HEADER(FileObject)->Type != IoFileObjectType)
    {
        return STATUS_OBJECT_TYPE_MISMATCH;
    }
 
    /* Then compute desired access:
     * Check if the handle has either FILE_WRITE_DATA or FILE_APPEND_DATA was
     * granted. However, if this is a named pipe, make sure we don't ask for
     * FILE_APPEND_DATA as it interferes with the FILE_CREATE_PIPE_INSTANCE
     * access right!
     */
    *DesiredAccess = ((!(FileObject->Flags & FO_NAMED_PIPE) ? FILE_APPEND_DATA : 0) | FILE_WRITE_DATA);
 
    return STATUS_SUCCESS;
}

Referenced by ObReferenceFileObjectForWrite().

IoGetCurrentProcess()

PEPROCESS NTAPI IoGetCurrentProcess

(

VOID

)

Definition at line 139 of file util.c.

{
    /* Return the current thread's process */
    return (PEPROCESS)PsGetCurrentThread()->Tcb.ApcState.Process;
}

Referenced by DbgP(), InitializeDeviceData(), nfs41_CreateSrvCall(), print_error(), print_hexbuf(), RxDriverEntry(), RxFinalizeSrvCall(), and RxInitializeDispatcher().

IoGetDeviceToVerify()

PDEVICE_OBJECT NTAPI IoGetDeviceToVerify

(

IN PETHREAD

Thread

)

Definition at line 336 of file util.c.

{
    /* Return the pointer that was set with IoSetDeviceToVerify */
    return Thread->DeviceToVerify;
}

Referenced by _Requires_lock_held_(), Ext2ExceptionHandler(), UDFExceptionHandler(), verify_vcb(), VfatBlockDeviceIoControl(), VfatReadDisk(), VfatReadDiskPartial(), VfatWriteDisk(), and VfatWriteDiskPartial().

IoGetInitialStack()

PVOID NTAPI IoGetInitialStack

(

VOID

)

Definition at line 67 of file util.c.

{
    /* Return the initial stack from the TCB */
    return PsGetCurrentThread()->Tcb.InitialStack;
}

IoGetStackLimits()

VOID NTAPI IoGetStackLimits	(	OUT PULONG_PTR	LowLimit,
		OUT PULONG_PTR	HighLimit
	)

Definition at line 78 of file util.c.

{
    PKPRCB Prcb = KeGetCurrentPrcb();
    ULONG_PTR DpcStack = (ULONG_PTR)(Prcb->DpcStack);
    volatile ULONG_PTR StackAddress;
 
    /* Save our stack address so we always know it's valid */
    StackAddress = (ULONG_PTR)(&StackAddress);
 
    /* Get stack values */
    RtlpGetStackLimits(LowLimit, HighLimit);
 
    /* Check if we're outside the stack */
    if ((StackAddress < *LowLimit) || (StackAddress > *HighLimit))
    {
        /* Check if we may be in a DPC */
        if (KeGetCurrentIrql() >= DISPATCH_LEVEL)
        {
            /* Check if we really are in a DPC */
            if ((Prcb->DpcRoutineActive) &&
                (StackAddress <= DpcStack) &&
                (StackAddress >= DpcStack - KERNEL_STACK_SIZE))
            {
                /* Use the DPC stack limits */
                *HighLimit = DpcStack;
                *LowLimit = DpcStack - KERNEL_STACK_SIZE;
            }
        }
    }
}

Referenced by _IRQL_requires_max_(), CdSetThreadContext(), FatFreeStringBuffer(), RxIsThisAnRdbssTopLevelContext(), and RxSetupNetFileObject().

IoIsSystemThread()

BOOLEAN NTAPI IoIsSystemThread

(

IN PETHREAD

Thread

)

Definition at line 115 of file util.c.

{
    /* Call the Ps Function */
    return PsIsSystemThread(Thread);
}

Referenced by _Requires_lock_held_(), do_read(), and FatUpdateDiskStats().

IoIsWdmVersionAvailable()

BOOLEAN NTAPI IoIsWdmVersionAvailable	(	IN UCHAR	MajorVersion,
		IN UCHAR	MinorVersion
	)

Definition at line 126 of file util.c.

{
    /* Return support for WDM 1.30 (Windows Server 2003) */
    if (MajorVersion <= 1 && MinorVersion <= 0x30) return TRUE;
    return FALSE;
}

Referenced by DriverEntry(), FreeBT_AddDevice(), StartDevice(), and CMiniportWaveCMI::validateFormat().

IoReleaseCancelSpinLock()

VOID NTAPI IoReleaseCancelSpinLock

(

IN KIRQL

Irql

)

Definition at line 150 of file util.c.

{
    /* Release the internal lock */
    KeReleaseQueuedSpinLock(LockQueueIoCancelLock, Irql);
}

Referenced by _Function_class_(), _Releases_lock_(), AfdCancelHandler(), BeepCancel(), BeepCleanup(), BeepStartIo(), CancelQueued(), CancelRoutine(), ClassCancelRoutine(), DispCancelListenRequest(), DispCancelRequest(), DispPrepareIrpForCancel(), EndRequestHandler(), FsRtlAcknowledgeOplockBreak(), FsRtlCancelExclusiveIrp(), FsRtlCancelNotify(), FsRtlCancelOplockIIIrp(), FsRtlCancelWaitIrp(), FsRtlNotifySetCancelRoutine(), FsRtlOplockBreakToII(), FsRtlOplockBreakToNone(), FsRtlOplockCleanup(), FsRtlRemoveAndCompleteIrp(), FsRtlRemoveAndCompleteWaitIrp(), FsRtlRequestExclusiveOplock(), FsRtlRequestOplockII(), FsRtlUninitializeOplock(), FsRtlWaitOnIrp(), HandleReadIrp(), IoCancelIrp(), IopStartNextPacket(), IopStartNextPacketByKey(), IoStartPacket(), IRPFinish(), KsCancelRoutine(), KsMoveIrpsOnCancelableQueue(), KsRemoveIrpFromCancelableQueue(), MountMgrCancel(), MountMgrChangeNotify(), MountMgrCleanup(), MountMgrNotify(), NduDispatchRead(), NpCancelDataQueueIrp(), NpCancelListeningQueueIrp(), NpCancelWaitQueueIrp(), QueueUserModeIrp(), ReadIrpCancel(), RxCancelRoutine(), RxCompleteRequest_Real(), RxFsdCommonDispatch(), USBH_CheckHubIdle(), USBH_FdoCleanup(), USBH_FdoIdleNotificationCallback(), USBH_FdoIdleNotificationRequestComplete(), USBH_FdoSubmitIdleRequestIrp(), USBH_FdoSubmitWaitWakeIrp(), USBH_FdoWWIrpIoCompletion(), USBH_HubQueuePortIdleIrps(), USBH_HubQueuePortWakeIrps(), USBH_PdoRemoveDevice(), USBH_PortIdleNotificationCancelRoutine(), USBH_PortIdleNotificationRequest(), USBPORT_CancelActiveTransferIrp(), USBPORT_CancelPendingTransferIrp(), USBPORT_CancelPendingWakeIrp(), USBPORT_DoneTransfer(), USBPORT_FlushCancelList(), USBSTOR_Cancel(), USBSTOR_CancelIo(), USBSTOR_QueueAddIrp(), USBSTOR_StartIo(), and WmipNotificationIrpCancel().

IoSetDeviceToVerify()

VOID NTAPI IoSetDeviceToVerify	(	IN PETHREAD	Thread,
		IN PDEVICE_OBJECT	DeviceObject
	)

Definition at line 304 of file util.c.

{
    /* Set the pointer in the thread */
    Thread->DeviceToVerify = DeviceObject;
}

Referenced by _Requires_lock_held_(), Ext2ExceptionHandler(), UDFExceptionHandler(), verify_vcb(), VfatBlockDeviceIoControl(), VfatReadDisk(), VfatReadDiskPartial(), VfatWriteDisk(), and VfatWriteDiskPartial().

IoSetHardErrorOrVerifyDevice()

VOID NTAPI IoSetHardErrorOrVerifyDevice	(	IN PIRP	Irp,
		IN PDEVICE_OBJECT	DeviceObject
	)

Definition at line 316 of file util.c.

{
    /* Ignore in case the IRP is not associated with any thread */
    if (!Irp->Tail.Overlay.Thread)
    {
        DPRINT1("IoSetHardErrorOrVerifyDevice(0x%p, 0x%p): IRP has no thread, ignoring.\n",
                Irp, DeviceObject);
        return;
    }
 
    /* Set the pointer in the IRP */
    Irp->Tail.Overlay.Thread->DeviceToVerify = DeviceObject;
}

Referenced by _Requires_lock_held_(), CdVerifyFcbOperation(), CdVerifyVcb(), ClassIoComplete(), ClassIoCompleteAssociated(), ClassReadWrite(), DiskDeviceControl(), DiskReadWriteVerification(), Ext2CreateFile(), Ext2ExceptionHandler(), Ext2VerifyVcb(), FatQuickVerifyVcb(), FatUnpinRepinnedBcbs(), FatVerifyVcb(), is_volume_mounted(), mount_vol(), RequestCompletion(), ScsiFlopDeviceControl(), SignalMediaChanged(), TransferPktComplete(), UDFPerformVerify(), UDFVerifyVcb(), VcdDeviceControl(), and ViVerifyVolume().

IoThreadToProcess()

PEPROCESS NTAPI IoThreadToProcess

(

IN PETHREAD

Thread

)

Definition at line 161 of file util.c.

{
    /* Return the thread's process */
    return Thread->ThreadsProcess;
}

Referenced by NpCreateClientEnd().

IoValidateDeviceIoControlAccess()

NTSTATUS NTAPI IoValidateDeviceIoControlAccess	(	IN PIRP	Irp,
		IN ULONG	RequiredAccess
	)

Definition at line 292 of file util.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

RtlpGetStackLimits()

VOID NTAPI RtlpGetStackLimits	(	PULONG_PTR	StackBase,
		PULONG_PTR	StackLimit
	)

Referenced by IoGetStackLimits().