DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE callback function (wdm.h)

The DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE callback defines a routine that runs in a hot-swappable worker thread created by IoDriverProxyCreateHotSwappableWorkerThread.

Syntax

DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE DriverProxyHotswapWorkerRoutine;

BOOLEAN DriverProxyHotswapWorkerRoutine(
  PVOID WorkerContext,
  NTSTATUS WaitStatus
)
{...}

Parameters

WorkerContext

[in] A pointer to driver-defined context information that was specified when the worker thread was created. This context is passed through from the Context field of the DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE_START_CONTEXT structure.

WaitStatus

[in] The status returned from the wait operation. This indicates why the worker thread was awakened. See KeWaitForMultipleObjects for possible wait status values.

Return value

DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE returns one of the following values:

Remarks

This callback is invoked when the worker thread wakes up from waiting on kernel objects. The routine determines whether the thread should continue running or terminate.

This callback routine runs at PASSIVE_LEVEL in the context of a system worker thread created specifically for hot-swappable operations. The thread maintains the same IRQL throughout its execution (IRQL_requires_same).

The worker routine is called each time the thread wakes up from waiting on the kernel objects specified in the DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE_START_CONTEXT structure. Based on the WaitStatus and the current state of the driver, the routine should decide whether to continue processing (return TRUE) or terminate the worker thread (return FALSE).

The worker thread infrastructure ensures that the thread can be safely terminated and recreated as part of driver hot-swap operations, maintaining system stability during runtime driver updates.

Requirements

See also

IoDriverProxyCreateHotSwappableWorkerThread

DRIVER_PROXY_HOTSWAP_WORKER_ROUTINE_START_CONTEXT