IO_COMPLETION_ROUTINE回呼函式 (wdm.h)
IoCompletion 例程會完成 I/O 作業的處理。
語法
IO_COMPLETION_ROUTINE IoCompletionRoutine;
NTSTATUS IoCompletionRoutine(
[in] PDEVICE_OBJECT DeviceObject,
[in] PIRP Irp,
[in, optional] PVOID Context
)
{...}
參數
[in] DeviceObject
呼叫端提供的 DEVICE_OBJECT 結構的指標。 這是目標裝置的裝置物件,先前是由驅動程式的 AddDevice 例程所建立。
[in] Irp
描述 I/O 作業之 IRP 結構的呼叫端提供的指標。
[in, optional] Context
呼叫端提供的驅動程式特定內容資訊指標,先前在呼叫 IoSetCompletionRoutine 或 IoSetCompletionRoutineEx時提供。 內容信息必須儲存在非分頁記憶體中,因為可以在DISPATCH_LEVEL呼叫 IoCompletion 例程。 如需詳細資訊,請參閱下列一節。
傳回值
如果 IoCompletion 例程判斷 IRP 需要額外的處理,則必須傳回STATUS_MORE_PROCESSING_REQUIRED。 如需詳細資訊,請參閱下列一節。 否則,它應該會傳回STATUS_SUCCESS。 (I/O 管理員只會檢查是否存在STATUS_MORE_PROCESSING_REQUIRED。
言論
驅動程式的 IoCompletion 例程會在任意線程或 DPC 內容中執行,並在小於或等於DISPATCH_LEVEL的 IRQL 上執行。 因為撰寫在DISPATCH_LEVEL執行的程式代碼也會在較低層級執行,因此 IoCompletion 例程應該設計成在DISPATCH_LEVEL執行。 不過,由於這些例程不保證會在DISPATCH_LEVEL執行,因此它們不得呼叫實際需要在DISPATCH_LEVEL執行的系統例程。 (如需 IRQL 的詳細資訊,請參閱 管理硬體優先順序。
若要註冊特定 IRP 的 IoCompletion 例程,驅動程式必須呼叫 IoSetCompletionRoutine 或 IoSetCompletionRoutineEx,這會將 IoCompletion 例程的位址儲存在下一個較低的驅動程式 I/O 堆棧位置中。 (因此,最低層級驅動程序無法註冊 IoCompletion 例程。驅動程式通常會從其中一個分派例程呼叫 IoSetCompletionRoutine 或 IoSetCompletionRoutineEx,每次收到 IRP 時。 大部分的驅動程式,包括所有 PnP 驅動程式,都可以使用 IoSetCompletionRoutine 來註冊其 IoCompletion 例程。 在 IoCompletion 例程 執行之前可能卸除的非 PnP 驅動程式,應該改為使用 IoSetCompletionRoutineEx。
當任何驅動程式完成 IRP 時,它會呼叫 IoCompleteRequest,接著會呼叫每個較高層級驅動程式的 IoCompletion 例程,從下一個最高到最高,直到呼叫所有較高 IoCompletion 例程,或直到一個例程傳回STATUS_MORE_PROCESSING_REQUIRED為止。
當您建立 IRP 時,請配置目前驅動程式的堆疊位置,以及任何較低的驅動程式。 如果您未配置足夠的堆疊位置,呼叫完成例程時,DeviceObject 指標可能會設定為 NULL。 如果您使用 [Context] 字段,將資訊傳遞至 IoCompletion,而不是依賴 DeviceObject 參數,您可以避免配置目前驅動程式的額外堆疊位置。
如果 IoCompletion 例程傳回STATUS_MORE_PROCESSING_REQUIRED,則下層驅動程式呼叫 IoCompleteRequest 會立即傳回。 在此情況下,較高層級的驅動程序必須呼叫 IoCompleteRequest 來完成 IRP。
如需實作 IoCompletion 例程的詳細資訊,請參閱 完成 IRP。
例子
若要定義 IoCompletion 回呼例程,您必須先提供函式宣告,以識別您要定義的回呼例程類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、靜態驅動程式驗證器 (SDV)和其他驗證工具尋找錯誤,而且是撰寫 Windows作系統驅動程式的需求。
例如,若要定義名為 MyIoCompletion
的 IoCompletion 回呼例程,請使用IO_COMPLETION_ROUTINE類型,如下列程式代碼範例所示:
IO_COMPLETION_ROUTINE MyIoCompletion;
然後,實作回呼例程,如下所示:
_Use_decl_annotations_
NTSTATUS
MyIoCompletion(
PDEVICE_OBJECT DeviceObject,
PIRP Irp,
PVOID Context
)
{
// Function body
}
IO_COMPLETION_ROUTINE函式類型定義於 Wdm.h 頭檔中。 若要在執行程式代碼分析工具時更準確地識別錯誤,請務必將 _Use_decl_annotations_
批註新增至函式定義。
_Use_decl_annotations_
批注可確保會使用套用至頭檔中IO_COMPLETION_ROUTINE函式類型的批注。 如需函式宣告需求的詳細資訊,請參閱 使用 WDM 驅動程式的函式角色類型來宣告函式。 如需 _Use_decl_annotations_
的相關信息,請參閱 批注函式行為。
要求
要求 | 價值 |
---|---|
目標平臺 | 桌面 |
標頭 | wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h) |
IRQL | 在 IRQL <= DISPATCH_LEVEL 呼叫 (請參閱一節)。 |