irp cancel boilerplate.c File Reference

Go to the source code of this file.

Functions
	CancelRoutine (DEV_OBJ Dev, Irp)
	IoSetCancelRoutine (Irp, CancelRoutine)
	if (Irp->Cancel &&IoSetCancelRoutine(Irp, NULL))
	IoMarkIrpPending (Irp)
	InsertTailList (Queue)
	Unlock (theLock)
	if (!IoSetCancelRoutine(Irp, NULL))
	IoCompleteRequest (Irp, IO_NO_INCREMENT)

Variables
	QUEUE_BOLIERPLATE
Irp Tail Overlay	DriverContext [3] = &theLock
Irp IoStatus	Status = STATUS_PENDING
	DEQUEUE_BOILERPLATE
	Irp = RemoveHeadList(Queue)
Irp IoStatus	Information = 0

Function Documentation

CancelRoutine()

CancelRoutine	(	DEV_OBJ	Dev,
		Irp
	)

Definition at line 10 of file irp cancel boilerplate.c.

{
   //don't need this since we have our own sync. protecting irp cancellation
   IoReleaseCancelSpinLock(Irp->CancelIrql);
 
   theLock = Irp->Tail.Overlay.DriverContext[3];
 
   Lock(theLock);
   RemoveEntryList(&Irp->Tail.Overlay.ListEntry);
   Unlock(theLock);
 
   Irp->IoStatus.Status = STATUS_CANCELLED;
   Irp->IoStatus.Information = 0;
 
   IoCompleteRequest(Irp, IO_NO_INCREMENT);
 
}

if() [1/2]

if

(

!

IoSetCancelRoutineIrp, NULL

)

Definition at line 75 of file irp cancel boilerplate.c.

   {
      /*
      Cancel routine WILL be called after we release the spinlock. It will try to remove
      the irp from the list and cancel/complete this irp. Since we allready removed it,
      make its ListEntry point to itself.
      */
 
      InitializeListHead(&Irp->Tail.Overlay.ListEntry);
 
      Unlock(theLock);
 
      return;
   }

if() [2/2]

if

(

Irp->Cancel &&

IoSetCancelRoutineIrp, NULL

)

Definition at line 39 of file irp cancel boilerplate.c.

   {
      /*
      Irp has already been cancelled (before we got to queue it),
      and we got to remove the cancel routine before the canceler could,
      so we cancel/complete the irp ourself.
      */
 
      Unlock(theLock);
 
      Irp->IoStatus.Status = STATUS_CANCELLED;
      Irp->IoStatus.Information = 0;
      IoCompleteRequest(Irp, IO_NO_INCREMENT);
 
      return FALSE;
   }

InsertTailList()

InsertTailList

(

Queue

)

IoCompleteRequest()

IoCompleteRequest	(	Irp	,
		IO_NO_INCREMENT
	)

IoMarkIrpPending()

IoMarkIrpPending

(

Irp

)

Referenced by _Dispatch_type_(), _Function_class_(), _Requires_lock_held_(), _Success_(), ACPIDispatchDeviceControl(), AfdConnectedSocketReadData(), AfdSelect(), BeepDeviceControl(), CdDevCtrlCompletionRoutine(), CdMultiAsyncCompletionRoutine(), CdSingleAsyncCompletionRoutine(), ClassDeviceControl(), ClassDeviceHwFirmwareDownloadProcess(), ClassIoComplete(), ClasspDeviceLockFailurePowerIrpCompletion(), ClasspEnqueueIdleRequest(), ClasspPowerDownCompletion(), ClasspPowerHandler(), ClasspPowerUpCompletion(), ClasspStartNextPowerIrpCompletion(), ClassReadWrite(), ClassRetryRequest(), CreateRedirectedFile(), DGReceiveDatagram(), DiskInfoExceptionCheck(), DiskInfoExceptionComplete(), DiskIoctlVerify(), DiskShutdownFlush(), DispatchReadWrite(), DispEchoRequest(), DispTdiConnect(), DispTdiDisconnect(), DispTdiListen(), DispTdiQueryIpHwAddress(), DispTdiReceive(), DispTdiReceiveDatagram(), DispTdiSend(), DispTdiSendDatagram(), do_read(), Ext2DeviceControlCompletion(), Ext2ExceptionHandler(), Ext2FlushCompletionRoutine(), Ext2LockIrp(), Ext2ReadWriteBlocks(), FatFlushCompletionRoutine(), FatMultiAsyncCompletionRoutine(), FatPrePostIrp(), FatSingleAsyncCompletionRoutine(), FDO_HandleResetCyclePort(), FinishDevPoUpIrp(), FreeBT_DispatchPower(), FreeBT_DispatchRead(), FreeBT_DispatchWrite(), FreeBT_GetHCIEvent(), FreeBT_HCIEventCompletion(), FreeBT_HCISendCompletion(), FreeBT_SendHCICommand(), FsRtlAcknowledgeOplockBreak(), FsRtlCancelNotify(), FsRtlNotifyCompleteIrp(), FsRtlNotifyFilterChangeDirectory(), FsRtlPrivateLock(), FsRtlRequestExclusiveOplock(), FsRtlRequestOplockII(), FsRtlWaitOnIrp(), HandleReadIrp(), HidClass_Read(), HidUsb_ReadReportCompletion(), HoldIoRequests(), i8042KbdDeviceControl(), i8042KbdInternalDeviceControl(), i8042MouInternalDeviceControl(), IKsPin_DispatchKsStream(), IoCsqInsertIrpEx(), IofCompleteRequest(), KsServiceBusEnumCreateRequest(), LanReadData(), MountMgrChangeNotify(), MsfsRead(), MupForwardIoRequest(), NdisIDeviceIoControl(), NpAddDataQueueEntry(), NpAddWaiter(), NpSetListeningPipeState(), NtfsQueueRequest(), PortClsPower(), ProSendAndFreePnPEvent(), QueueRequest(), QueueUserModeIrp(), RawCompletionRoutine(), RequestProcessPowerIrpCompletion(), RequestProcessSetPower(), RxFsdCommonDispatch(), RxFsdDispatch(), RxLowIoSubmit(), RxPrePostIrp(), ScsiPortDispatchScsi(), SendIrpToThread(), SerialDeviceControl(), SerialRead(), SermouseInternalDeviceControl(), ServiceTransferRequest(), SetIrpIoStatus(), TestIrpHandler(), TransferPktComplete(), UDFDevIoctlCompletion(), UDFExceptionHandler(), UDFFlushCompletion(), UDFPostRequest(), USBH_FdoPower(), USBH_PdoIoctlResetPort(), USBH_PortIdleNotificationRequest(), USBH_QueryCapsComplete(), USBH_SelectConfigOrInterfaceComplete(), USBPORT_AbortPipe(), USBPORT_HandleSubmitURB(), USBPORT_IdleNotification(), USBPORT_PdoPower(), USBPORT_QueuePendingTransferIrp(), USBSTOR_HandleInternalDeviceControl(), USBSTOR_QueueAddIrp(), USBSTOR_SendRequest(), VfatQueueRequest(), VfatWrite(), VfdDeviceControl(), VfdReadWrite(), WaitWakeCompletionRoutine(), WmipReceiveNotifications(), WskConnect(), WskSendTo(), and WskStreamIo().

IoSetCancelRoutine()

IoSetCancelRoutine	(	Irp	,
		CancelRoutine
	)

Referenced by AfdConnectedSocketReadData(), AfdConnectedSocketWriteData(), AfdDisconnect(), AfdPacketSocketWriteData(), AfdSelect(), BeepCleanup(), BeepStartIo(), DisconnectComplete(), DispPrepareIrpForCancel(), EndRequestHandler(), FreeBT_DispatchClean(), FsRtlAcknowledgeOplockBreak(), FsRtlCancelExclusiveIrp(), FsRtlCancelNotify(), FsRtlCancelOplockIIIrp(), FsRtlCancelWaitIrp(), FsRtlNotifySetCancelRoutine(), FsRtlOplockBreakToII(), FsRtlOplockBreakToNone(), FsRtlOplockCleanup(), FsRtlRemoveAndCompleteIrp(), FsRtlRemoveAndCompleteWaitIrp(), FsRtlRequestExclusiveOplock(), FsRtlRequestOplockII(), FsRtlUninitializeOplock(), FsRtlWaitOnIrp(), HandleReadIrp(), IoCancelIrp(), IoCsqInsertIrpEx(), IoCsqRemoveIrp(), IoCsqRemoveNextIrp(), IRPFinish(), KsAddIrpToCancelableQueue(), KsCancelIo(), KsReleaseIrpOnCancelableQueue(), ListenComplete(), MountMgrChangeNotify(), MountMgrNotify(), NduDispatchRead(), NpAddDataQueueEntry(), NpAddWaiter(), NpCancelWaiter(), NpCheckForNotify(), NpCompleteStalledWrites(), NpRemoveDataQueueEntry(), NpSetClosingPipeState(), NpSetConnectedPipeState(), NpSetDisconnectedPipeState(), NpSetListeningPipeState(), NpTimerDispatch(), PacketSocketRecvComplete(), PacketSocketSendComplete(), ProcessQueuedRequests(), QueueRequest(), QueueUserModeIrp(), ReceiveActivity(), ReceiveComplete(), RemoveHeadList_IRP(), RxCompleteRequest_Real(), RxFsdCommonDispatch(), SatisfyPreAccept(), SendComplete(), SignalSocket(), StreamSocketConnectComplete(), UnlockAndMaybeComplete(), USBH_FdoCleanup(), USBH_HubQueuePortIdleIrps(), USBH_PdoRemoveDevice(), USBH_PortIdleNotificationRequest(), USBPORT_CompletePdoWaitWake(), USBPORT_DoneTransfer(), USBPORT_FlushCancelList(), USBPORT_FlushPendingTransfers(), USBPORT_PdoPower(), USBPORT_QueuePendingTransferIrp(), USBSTOR_QueueAddIrp(), USBSTOR_StartIo(), and WmipReceiveNotifications().

Unlock()

Unlock

(

theLock

)

Variable Documentation

DEQUEUE_BOILERPLATE

DEQUEUE_BOILERPLATE

Initial value:

{
   Lock(theLock)

Definition at line 69 of file irp cancel boilerplate.c.

DriverContext

Irp Tail Overlay DriverContext[3] = &theLock

Definition at line 36 of file irp cancel boilerplate.c.

Information

Irp IoStatus Information = 0

Definition at line 100 of file irp cancel boilerplate.c.

Irp

Irp = RemoveHeadList(Queue)

Definition at line 73 of file irp cancel boilerplate.c.

QUEUE_BOLIERPLATE

QUEUE_BOLIERPLATE

Initial value:

{
   Lock(theLock)

Definition at line 32 of file irp cancel boilerplate.c.

Status

Irp IoStatus Status = STATUS_PENDING

Definition at line 59 of file irp cancel boilerplate.c.