FsRtlCopyWrite 関数 (ntifs.h)

[アーティクル]
10/04/2023

FsRtlCopyWrite ルーチンは、ユーザーバッファーからキャッシュされたファイルにデータをコピーします。

構文

BOOLEAN FsRtlCopyWrite(
  [in]  PFILE_OBJECT     FileObject,
  [in]  PLARGE_INTEGER   FileOffset,
  [in]  ULONG            Length,
  [in]  BOOLEAN          Wait,
  [in]  ULONG            LockKey,
  [in]  PVOID            Buffer,
  [out] PIO_STATUS_BLOCK IoStatus,
  [in]  PDEVICE_OBJECT   DeviceObject
);

パラメーター

[in] FileObject

データの書き込み先となるキャッシュされたファイルのファイルオブジェクトへのポインター。

[in] FileOffset

キャッシュされたファイル内の開始バイトオフセットを指定する変数へのポインター。

[in] Length

書き込まれるデータの長さ (バイト単位)。

[in] Wait

すべてのデータがコピーされるまで呼び出し元を待機状態にできる場合は TRUE に設定し、それ以外の場合は FALSE に設定します。

[in] LockKey

ロックするバイト範囲に関連付けられている値。ロックする範囲が、既にロックされている別の範囲と非決定的ロックと重複している場合、または読み取る範囲が、既に非決定的にロックされている別の範囲のサブ範囲である場合、このパラメーターの値は、その非決定的ロックのキーである必要がありますロックは、呼び出し元スレッドの親プロセスによって保持されている必要があります。それ以外の場合、このパラメーターは無効です。

[in] Buffer

データのコピー元となるバッファーへのポインター。

[out] IoStatus

最後の完了状態と操作に関する情報を受け取る呼び出し元によって割り当てられた構造体へのポインター。データが正常にコピーされた場合、 IoStatus.Status にはSTATUS_SUCCESSが含まれます。すべてのデータが正常にコピーされない場合、 IoStatus.Information にはコピーされた実際のバイト数が含まれます。

[in] DeviceObject

ファイルデータを保持するマウントされたボリュームのデバイスオブジェクトへのポインター。

戻り値

FsRtlCopyWrite は、コピー要求が完了した場合は TRUE を返し、それ以外の場合は FALSE を返します。 TRUE の戻り値は、必ずしもコピー操作が成功したことを意味するわけではないことに注意してください。

FsRtlCopyWrite が FALSE を返す場合、または IoStatus の内容がコピー操作が失敗したことを示している場合、呼び出し元は FsRtlCopyWrite を呼び出す代わりに書き込み IRP を割り当てる必要があります。

注釈

ファイルシステム固有の高速 I/O 書き込みルーチンを実装するのではなく、ファイルキャッシュをサポートするファイルシステムの開発者は、高速 I/O 書き込み要求を処理するためのファイルシステムのエントリポイントとして FsRtlCopyWrite を使用することを検討する必要があります。そのためには、ファイルシステムの DriverEntry ルーチンが、ファイルシステムドライバーオブジェクトのFAST_IO_DISPATCH構造で FastIoWrite エントリポイントを FsRtlCopyWrite に設定する必要があります。さらに、ファイルシステムでは次の操作を行う必要があります。

高速 I/O が実行される可能性がある各ファイルについて、ファイルシステムはFSRTL_COMMON_FCB_HEADER構造体を割り当てて初期化する必要があります。

ほとんどのファイルシステムでは、これは、開いているファイルの状態を維持するために使用されるファイル制御ブロック (FCB) または同等の構造体にFSRTL_COMMON_FCB_HEADER構造を含めることによって実現されます。

通常、FSRTL_COMMON_FCB_HEADER構造体のストレージは、ページプールから割り当てられます。
高速 I/O を実行するファイルごとに、ファイル・システムはファイルのファイル・オブジェクトをFSRTL_COMMON_FCB_HEADER構造にリンクする必要があります。これは、各ファイルオブジェクトの FsContext メンバーを、この構造体 (または、FSRTL_COMMON_FCB_HEADER構造体を含む FCB またはその他の構造体) を指すように設定することによって行われます。
ファイルをキャッシュする場合、ファイルシステムは、ファイルのFSRTL_COMMON_FCB_HEADER構造の IsFastIoPossible メンバーを適切な値に設定する必要があります。この値は、ファイルがキャッシュされたままである限り、必要に応じて更新する必要があります。

特に、ファイルシステムでは、キャッシュされたファイルに対する排他的なバイト範囲ロックが存在するとすぐに、FSRTL_COMMON_FCB_HEADER構造体の IsFastIoPossible メンバーを FastIoIsQuestionable に設定する必要があります。

Wait が TRUE の場合、FsRtlCopyWrite はデータをコピーして TRUE を返す必要があります。キャッシュされたファイルの必要なページが既にメモリに存在する場合、データはすぐにコピーされ、ブロックは発生しません。必要なページが常駐していない場合、呼び出し元は、必要なすべてのページが常駐状態になり、データをコピーできるようになるまで待機状態になります。

Wait が FALSE の場合、FsRtlCopyWrite はブロックを拒否し、ファイルのメインリソースを取得できない場合、またはキャッシュされたファイルの必要なページがまだメモリ内に存在しない場合は FALSE を返します。

ファイルシステムの FastIoCheckIfPossible ルーチンは、 FileOffset および Length で定義されているバイト範囲に、呼び出し元が適切な LockKey 値を渡さない排他的にロックされたバイト範囲を含めないようにする役割を担います。ファイルシステムが FsRtlXxxLockYyy サポートルーチンを使用してバイト範囲ロックを管理する場合は、FsRtlCopyRead を呼び出す前に FastIoCheckIfPossible ルーチンから FsRtlFastCheckLockForWrite を呼び出すことによってこれを実現できます。

ファイルをキャッシュするには、 CcInitializeCacheMap ルーチンを使用します。

要件

要件	値
対象プラットフォーム	ユニバーサル
Header	ntifs.h (Ntifs.h を含む)
Library	NtosKrnl.lib
[DLL]	NtosKrnl.exe
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	HwStorPortProhibitedDDIs(storport), PowerIrpDDis(wdm)

こちらもご覧ください

CcInitializeCacheMap

FsRtlCopyRead

FsRtlFastCheckLockForWrite

次の方法で共有

FsRtlCopyWrite 関数 (ntifs.h)

構文

パラメーター

戻り値

注釈

要件

こちらもご覧ください

フィードバック

その他のリソース