FsRtlCancellableWaitForMultipleObjects 函数 (ntifs.h)
FsRtlCancellableWaitForMultipleObjects 例程对一个或多个调度程序对象执行可取消的等待操作(可以终止的等待)。
语法
NTSTATUS FsRtlCancellableWaitForMultipleObjects(
[in] ULONG Count,
[in] PVOID [] ObjectArray,
[in] WAIT_TYPE WaitType,
[in, optional] PLARGE_INTEGER Timeout,
[in, optional] PKWAIT_BLOCK WaitBlockArray,
[in, optional] PIRP Irp
);
参数
[in] Count
要等待的对象数。
[in] ObjectArray
指向调度程序对象的指针数组(事件、互斥体、信号灯、线程和计时器),调用方为其提供存储。
[in] WaitType
WaitAll,指示所有指定对象在满足等待之前必须达到信号状态;或 WaitAny,指示在满足等待之前,任何一个对象必须达到信号状态。
[in, optional] Timeout
指向可选超时值的指针。 此参数以 100 纳秒为单位指定等待完成的绝对时间或相对时间。
如果 超时 指向零值(即 *Timeout == 0),则例程返回而不等待。 如果调用方提供 NULL 指针(即,Timeout == NULL),则例程将无限期等待,直到将任何或所有调度程序对象设置为信号状态。
正值指定相对于 1601 年 1 月 1 日绝对时间。 负值指定相对于当前时间的间隔。 绝对过期时间跟踪系统时间中的任何更改;相对过期时间不受系统时间更改的影响。
如果指定了 超时,则如果给定间隔过期时未满足任何指定的等待条件,则将自动满足等待。
超时值为零(即 *Timeout == 0)允许测试一组等待条件,并在可以立即满足等待时有条件地执行任何其他操作,就像获取互斥体一样。
[in, optional] WaitBlockArray
如果 计数<= THREAD_WAIT_OBJECTS,WaitBlockArray 可以为 NULL。 否则,此参数必须指向 sizeof(KWAIT_BLOCK * Count)
字节的内存缓冲区。 该例程在执行等待操作时使用此缓冲区进行记录保留。
[in, optional] Irp
指向与用户颁发的 I/O 操作对应的原始 IRP 的指针,该操作可由用户取消。 调用方必须确保 IRP 在此例程的持续时间内保持有效,并且 IRP 不得具有取消例程集(例如,IoSetCancelRoutine 不得在 IRP 上调用)。 请注意,IRP 必须由调用方持有,不能将其传递给较低级别的驱动程序。
返回值
FsRtlCancellableWaitForMultipleObjects 可以返回以下值之一:
返回代码 | 描述 |
---|---|
STATUS_SUCCESS | 为 WaitType 参数指定 WaitAll 调用方,ObjectArray 数组中的所有调度程序对象都已设置为信号状态。 |
STATUS_TIMEOUT | 在满足指定的等待条件集之前发生超时。 当无法立即满足指定的等待条件集并且 超时 设置为零时,可以返回此值。 |
通过STATUS_WAIT_63 STATUS_WAIT_0 | WaitType 指定的调用方 WaitAny,ObjectArray 数组中的调度程序对象之一已设置为信号状态。 返回值的下六位对满足等待的对象从零开始的索引进行编码。 |
通过STATUS_ABANDONED_WAIT_63 STATUS_ABANDONED_WAIT_0 | 调用方试图等待已放弃的互斥体。 返回值的下六位对 ObjectArray 数组中互斥体的从零开始的索引进行编码。 |
STATUS_CANCELLED | 等待被指定的 IRP 上的挂起取消请求中断。 请注意,仅当有效的 IRP 传递给 FsRtlCancellableWaitForMultipleObjects 并且 IRP 已由 CancelSynchronousIo取消时,才会返回此值。 |
STATUS_THREAD_IS_TERMINATING | 由于线程已由应用程序或用户终止,等待中断。 |
返回值仅指示等待状态。 如果适用,应直接从处理原始用户模式 IRP 过程中生成的另一个 IRP 获取 I/O 请求的实际状态。
请注意,NT_SUCCESS宏为STATUS_CANCELLED返回 FALSE(“failure”),对于所有其他状态值STATUS_THREAD_IS_TERMINATING状态值和 TRUE(“success”)。
言论
FsRtlCancellableWaitForMultipleObjects 例程对调度程序对象执行可取消的等待操作。 如果线程由用户或应用程序终止,或者如果 CancelSynchronousIo 在与线程关联的线程 IRP(同步 IRP)上发布取消请求,则会取消等待。
FsRtlCancellableWaitForMultipleObjects 例程旨在支持从 Windows Vista 开始的 I/O 完成/取消指南。 这些准则的目标是允许用户(或应用程序)快速终止应用程序。 反过来,这又要求应用程序能够快速终止正在执行 I/O 的线程以及任何当前的 I/O 操作。 此例程为用户线程提供了一种阻止(即等待)内核中 I/O 完成、调度程序对象或同步变量的方法,允许等待随时取消。 如果线程由用户或应用程序终止,此例程还允许线程等待终止。
例如,重定向程序可能需要创建一个或多个辅助 IRP 才能处理用户模式 IRP 并同步等待辅助 IRP 完成。 执行此操作的一种方法是设置一个事件,该事件将由辅助 IRP 的完成例程发出信号,然后等待事件发出信号。 然后,若要执行可取消的等待操作,FsRtlCancellableWaitForMultipleObjects 将调用传入与辅助 IRP 关联的事件以及原始用户模式 IRP。 如果发生挂起终止事件,或者原始用户模式 IRP 已取消,则线程等待发出信号的事件将被取消。
请注意,终止等待不会自动取消调用方颁发的任何 I/O 操作,该操作必须由调用方单独处理。
每个线程对象都有一个内置的等待块数组,可用于同时等待多个对象。 尽可能在等待多操作中使用内置的等待块数组,因为无需分配额外的等待块存储,以后才解除分配。 但是,如果必须同时等待的对象数大于内置等待块的数量,请使用 WaitBlockArray 参数指定要在等待操作中使用的备用等待块集。 驱动程序只需为 WaitBlockArray分配足够大的内存缓冲区。 不需要初始化缓冲区,驱动程序可以将缓冲区视为不透明结构。 在例程返回后,可以释放缓冲区。
如果 计数 大于MAXIMUM_WAIT_OBJECTS,或者如果 WaitBlockArray 为 NULL 且 Count 大于 THREAD_WAIT_OBJECTS,则系统会发出 Bug 检查0xC:MAXIMUM_WAIT_OBJECTS_EXCEEDED。
当传递给 FsRtlCancellableWaitForMultipleObjects 的 ObjectArray 参数是互斥体时,需要特别考虑一下。 如果等待的调度程序对象是互斥体,则 APC 传递与等待期间所有其他调度程序对象的传递相同。 但是,FsRtlCancellableWaitForMultipleObjects 返回STATUS_SUCCESS并且线程实际保存互斥体后,只传递特殊的内核模式 APC。 禁用了所有其他 APC(内核模式和用户模式)的传递。 在释放互斥体之前,对 APC 传递的这种限制会一直存在。
互斥体只能递归获取 MINLONG 时间。 如果超出此限制,则例程将引发STATUS_MUTANT_LIMIT_EXCEEDED异常。
如果可选的 Irp 参数指向有效的 IRP,则必须在 IRQL PASSIVE_LEVEL调用 FsRtlCancellableWaitForMultipleObjects。 如果未使用 Irp 参数,则可以在 IRQL 中调用例程,或等于APC_LEVEL。 调用方可以根据需要通过调用 KeEnterCriticalRegion 或 FsRtlEnterFileSystem 例程来禁用正常内核 APC。 但是,不能禁用特殊内核 APC。
如果 IRQL 大于或等于 APC_LEVEL,并且 Irp 参数指向有效的 IRP,则 FsRtlCancellableWaitForMultipleObjects 将在调试生成上断言。
要求
要求 | 价值 |
---|---|
最低支持的客户端 | Windows Vista |
目标平台 | 普遍 |
标头 | ntifs.h (include Ntifs.h) |
库 | NtosKrnl.lib |
DLL | NtosKrnl.exe |
IRQL | 请参阅“备注”部分。 |
DDI 符合性规则 | HwStorPortProhibitedDIS(storport)、PowerIrpDDis(wdm)、SpNoWait(storport) |