FsRtlOplockFsctrl 関数 (ntifs.h)

[アーティクル]
08/07/2023

FsRtlOplockFsctrl は、ファイルシステムまたはフィルタードライバーに代わって、さまざまな日和見ロック (oplock) 操作を実行します。

構文

NTSTATUS FsRtlOplockFsctrl(
  [in] POPLOCK Oplock,
  [in] PIRP    Irp,
  [in] ULONG   OpenCount
);

パラメーター

[in] Oplock

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

[in] Irp

I/O 操作の IRP へのポインター。このパラメーターは必須であり、 NULL にすることはできません。

[in] OpenCount

排他 oplock が要求されている場合は、ファイルのユーザーハンドルの数。レベル 2、R、または RH oplock 要求に 0 以外の値を設定すると、ファイルにバイト範囲ロックがあることを示します。 oplock 型の詳細については、「 Oplock の概要」を参照してください。

戻り値

FsRtlOplockFsctrl は 、次のいずれかの NTSTATUS 値を返します。

リターンコード	説明
STATUS_SUCCESS	IRP_MJ_CREATE要求の場合、STATUS_SUCCESSは、要求されたフィルター oplock が許可されたことを示します。 FSCTL 操作の場合、STATUS_SUCCESSの意味は FSCTL コードによって異なります。詳細については、次の「解説」セクションに記載されている FSCTL コードのリファレンスページを参照してください。
STATUS_CANCELLED	I/O 操作が取り消されました。 STATUS_CANCELLEDはエラーコードです。
STATUS_INVALID_PARAMETER	I/O 操作の FSCTL コードは、次の「解説」セクションに記載されている有効な値の 1 つではありません。 STATUS_INVALID_PARAMETERはエラーコードです。
STATUS_OPLOCK_NOT_GRANTED	oplock を許可できませんでした。 STATUS_OPLOCK_NOT_GRANTEDはエラーコードです。
STATUS_PENDING	FSCTL 操作にのみ使用されます。 STATUS_PENDINGの意味は、FSCTL コードによって異なります。詳細については、次の「解説」セクションに記載されている FSCTL コードのリファレンスページを参照してください。 STATUS_PENDINGは成功コードです。
STATUS_CANNOT_BREAK_OPLOCK	新しい oplock を許可できませんでした。 IRP はIRP_MJ_CREATE要求であり、FILE_OPEN_REQUIRING_OPLOCK操作の作成オプションパラメーターで指定されました。 STATUS_CANNOT_BREAK_OPLOCKは成功コードです。

注釈

ファイルシステムとレガシフィルタードライバーは FsRtlOplockFsctrl を呼び出して、作成またはファイルシステムコントロールの I/O 操作に対してさまざまな oplock 操作を実行します。ミニフィルターでは、 FsRtlOplockFsctrl の代わりに FltOplockFsctrl を呼び出す必要があります。

Irp パラメーターが指す IRP は、IRP_MJ_FILE_SYSTEM_CONTROLまたはIRP_MJ_CREATE操作の有効な IRP である必要があります。

IRP がIRP_MJ_FILE_SYSTEM_CONTROL要求である場合、FsRtlOplockFsctrl は、IrpSp-Parameters.FileSystemControl.FsControlCode> に設定されている次のいずれかの FSCTL コードで使用できます。

これらの FSCTL と一般的な日和見ロックの詳細については、Microsoft Windows SDKドキュメントを参照してください。

IRP が IRP_MJ_CREATE 要求である場合、 FsRtlOplockFsctrl を使用して、次のすべての条件が満たされている場合に保留中のフィルター oplock を要求できます。

OpenCount パラメーターの値は 1 である必要があります。
IRP_MJ_CREATE要求の DesiredAccess パラメーターの値はFILE_READ_ATTRIBUTESする必要があります。
IRP_MJ_CREATE要求の ShareAccess パラメーターの値は、FILE_SHARE_READする必要があります|FILE_SHARE_WRITE |FILE_SHARE_DELETE。

保留中のフィルター oplock の要求が許可されている場合、 FsRtlOplockFsctrl はSTATUS_SUCCESSを返します。パラメーターの作成の詳細については、 IRP_MJ_CREATEのリファレンスエントリを参照してください。

この関数を呼び出すフィルターとファイルシステムは、システム提供の oplock パッケージに呼び出しを同期する必要があります。詳細については、「 Oplock 同期」を参照してください。

要件

要件	値
対象プラットフォーム	ユニバーサル
Header	ntifs.h (Ntifs.h を含む)
Library	NtosKrnl.lib
[DLL]	NtosKrnl.exe
IRQL	<= APC_LEVEL