FltCheckOplock function (fltkernel.h)
A minifilter driver calls FltCheckOplock to synchronize the callback data structure for an IRP-based file I/O operation with the file's current opportunistic lock (oplock) state.
Syntax
FLT_PREOP_CALLBACK_STATUS FLTAPI FltCheckOplock(
[in] POPLOCK Oplock,
[in] PFLT_CALLBACK_DATA CallbackData,
[in, optional] PVOID Context,
[in, optional] PFLTOPLOCK_WAIT_COMPLETE_ROUTINE WaitCompletionRoutine,
[in, optional] PFLTOPLOCK_PREPOST_CALLBACKDATA_ROUTINE PrePostCallbackDataRoutine
);
Parameters
[in] Oplock
An opaque oplock pointer for the file. This pointer must have been initialized by a previous call to FltInitializeOplock.
[in] CallbackData
A pointer to the callback data (FLT_CALLBACK_DATA) structure for the I/O operation.
[in, optional] Context
A pointer to caller-defined context information to be passed to the callback routines that WaitCompletionRoutine and PrePostCallbackDataRoutine point to. The Filter Manager treats this information as opaque.
[in, optional] WaitCompletionRoutine
A pointer to a caller-supplied callback routine. If an oplock break is in progress, the Filter Manager calls this routine when the oplock break is completed. This parameter is optional and can be NULL. If it is NULL, the caller is put into a wait state until the oplock break is completed.
This routine is declared as follows:
typedef VOID
(*PFLTOPLOCK_WAIT_COMPLETE_ROUTINE) (
IN PFLT_CALLBACK_DATA CallbackData,
IN PVOID Context
);
This routine has the following parameters:
CallbackData
Pointer to the callback data structure for the I/O operation.
Context
A context information pointer that was passed in the Context parameter to FltCheckOplock.
[in, optional] PrePostCallbackDataRoutine
A pointer to a caller-supplied callback routine to be called if the I/O operation is posted to a work queue. This parameter is optional and can be NULL.
This routine is declared as follows:
typedef VOID
(*PFLTOPLOCK_PREPOST_CALLBACKDATA_ROUTINE) (
IN PFLT_CALLBACK_DATA CallbackData,
IN PVOID Context
);
CallbackData
A pointer to the callback data structure for the I/O operation.
Context
A context information pointer that was passed in the Context parameter to FltCheckOplock.
Return value
FltCheckOplock returns one of the following FLT_PREOP_CALLBACK_STATUS codes:
| Return code | Description |
|---|---|
|
FltCheckOplock encountered a pool allocation failure, or a call to the FsRtlCheckOplock function returned an error. FltCheckOplock will set the error code in the Status member of the IO_STATUS_BLOCK structure of the IoStatus member of the FLT_CALLBACK_DATA callback data structure. The CallbackData parameter points to this FLT_CALLBACK_DATA. |
|
An oplock break was initiated, which caused the Filter Manager to post the I/O operation to a work queue. The I/O operation is represented by the callback data that the CallbackData parameter points to. |
|
The I/O operation was performed immediately. Be aware that if this operation was a create operation that specified FILE_COMPLETE_IF_OPLOCKED in the create-options parameter, there might actually be an oplock break in progress even though the operation was performed immediately. To determine whether this is the situation, the caller should check the status in the Status member of the IO_STATUS_BLOCK structure of the IoStatus member of the FLT_CALLBACK_DATA callback data structure. |
Remarks
A minifilter driver calls FltCheckOplock to synchronize an IRP-based I/O operation with the current oplock state of a file according to the following conditions:
- If the I/O operation will cause the oplock to break, the oplock break is initiated.
- If the I/O operation cannot continue until the oplock break is complete, FltCheckOplock returns FLT_PREOP_PENDING and calls the callback routine that the PrePostCallbackDataRoutine parameter points to.
IRP_MJ_CLEANUP
IRP_MJ_CREATE
IRP_MJ_FILE_SYSTEM_CONTROL
IRP_MJ_FLUSH_BUFFERS
IRP_MJ_LOCK_CONTROL
IRP_MJ_READ
IRP_MJ_SET_INFORMATION
IRP_MJ_WRITE
The I/O operation must be an IRP-based I/O operation. To determine whether a given callback data structure represents an IRP-based I/O operation, use the FLT_IS_IRP_OPERATION macro.
Minifilters must not call FltCheckOplock again within the callback specified in WaitCompletionRoutine. Doing so can result in a deadlock condition if the oplock package calls the completion callback before FltCheckOplock returns.
For detailed information about opportunistic locks, see the Microsoft Windows SDK documentation.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Universal |
| Header | fltkernel.h (include Fltkernel.h) |
| IRQL | <= APC_LEVEL |
See also
FSCTL_OPBATCH_ACK_CLOSE_PENDING