FsRtlOplockBreakH 関数 (ntifs.h)

  • [アーティクル]

FsRtlOplockBreakH ルーチンは、日和見ロック (oplocks) CACHE_HANDLE_LEVEL中断します。

構文

NTSTATUS FsRtlOplockBreakH(
  [in]           POPLOCK                       Oplock,
  [in]           PIRP                          Irp,
  [in]           ULONG                         Flags,
  [in, optional] PVOID                         Context,
  [in, optional] POPLOCK_WAIT_COMPLETE_ROUTINE CompletionRoutine,
  [in, optional] POPLOCK_FS_PREPOST_IRP        PostIrpRoutine
);

パラメーター

[in] Oplock

ファイルの不透明な日和見ロック ポインター。 このポインターは、 FsRtlInitializeOplock の以前の呼び出しによって初期化されている必要があります。

[in] Irp

I/O 操作の IRP へのポインター。

[in] Flags

関連付けられたファイル I/O 操作のビットマスク。 ファイル システムまたはフィルター ドライバーは、 FsRtlOplockBreakH の動作を指定するビットを設定します。 Flags パラメーターには、次のオプションがあります。

OPLOCK_FLAG_COMPLETE_IF_OPLOCKED (0x00000001)

oplock 中断の原因となった操作をブロックまたは保留中にせずに、oplock の中断を続行することを許可するように指定します。

OPLOCK_FLAG_IGNORE_OPLOCK_KEYS (0x00000008)

Windows 7 以降のバージョンでサポートされています。

oplock キーに関係なく、oplock の中断CACHE_HANDLE_LEVEL続行することを許可するように指定します。

[in, optional] Context

CompletionRoutine パラメーターと PostIrpRoutine パラメーターが指すコールバック ルーチンに渡される呼び出し元定義のコンテキスト情報へのポインター。

[in, optional] CompletionRoutine

呼び出し元が指定したコールバック ルーチンへのポインター。 oplock ブレークが進行中の場合は、中断が完了したときにこのルーチンが呼び出されます。 このパラメーターは省略可能であり、 NULL にすることができます。 NULL の場合、呼び出し元は oplock ブレークが完了するまで待機状態になります。

このルーチンは、次のように宣言されます。

typedef VOID
(*POPLOCK_WAIT_COMPLETE_ROUTINE) (
      IN PVOID Context,
      IN PIRP Irp
      );

このルーチンには、次のパラメーターがあります。

Context

Context パラメーターで FsRtlOplockBreakH に渡されたコンテキスト情報ポインター。

Irp

I/O 操作の IRP へのポインター。

[in, optional] PostIrpRoutine

I/O 操作をペンドする場合に呼び出される呼び出し元が指定したコールバック ルーチンへのポインター。 ルーチンは、oplock パッケージが IRP をペンする前に呼び出されます。 このパラメーターは省略可能であり、 NULL にすることができます。

このルーチンは、次のように宣言されます。

typedef VOID
(*POPLOCK_FS_PREPOST_IRP) (
      IN PVOID Context,
      IN PIRP Irp
      );

Context

Context パラメーターで FsRtlOplockBreakH に渡されたコンテキスト情報ポインター。

Irp

I/O 操作の IRP へのポインター。

戻り値

FsRtlOplockBreakH は、次のいずれかのSTATUS_SUCCESSまたは適切な NTSTATUS コードを返します。

リターン コード 説明
STATUS_CANCELLED
 IRP が取り消されました。 STATUS_CANCELLEDはエラー コードです。
STATUS_PENDING
 IRP が作業キューにポストされました。 STATUS_PENDINGは成功コードです。
STATUS_CANNOT_BREAK_OPLOCK
 日和見ロック (oplock) の中断を実行できません。 IRP はIRP_MJ_CREATE要求です。 FILE_OPEN_REQUIRING_OPLOCK操作の create options パラメーターで指定され、許可された oplock があります。 STATUS_CANNOT_BREAK_OPLOCKはエラー コードです。

注釈

操作が oplocks CACHE_HANDLE_LEVEL中断する必要がある場合、操作は FsRtlOplockBreakH を呼び出します。

呼び出し元が Flags パラメーターでOPLOCK_FLAG_IGNORE_OPLOCK_KEYS フラグを指定した場合、 FsRtlOplockBreakH は oplock キーに関係なく、すべてのCACHE_HANDLE_LEVEL oplock を中断します。 FsRtlOplockBreakH の既定の動作は、呼び出し元のファイル オブジェクトのキーと一致しないキーを持つ oplock を中断することです。

ミニフィルターは、 FsRtlOplockBreakH ではなく FltOplockBreakH を呼び出す必要があります。

要件

要件 値
サポートされている最小のクライアント FsRtlOplockBreakH ルーチンは、Windows 7 以降で使用できます。
対象プラットフォーム ユニバーサル
Header ntifs.h (Ntifs.h を含む)
Library NtosKrnl.lib
[DLL] NtosKrnl.exe
IRQL <= APC_LEVEL

こちらもご覧ください

FltOplockBreakH

FsRtlInitializeOplock