Optional Dispatch Routines

Drivers might include the following dispatch routines:

  • DispatchCleanup

    IRP_MJ_CLEANUP indicates that the last handle for a file object that is associated with the target device object is being closed. Outstanding I/O requests for the file object might still exist. Drivers can implement a DispatchCleanup routine to perform cleanup that is not specific to any particular file handle. Drivers can also use their DispatchClose routine for the same purpose.

  • DispatchQueryInformation, DispatchSetInformation

    Some highest-level drivers might have to process IRP_MJ_QUERY_INFORMATION and IRP_MJ_SET_INFORMATION IRPs. Such requests indicate that a user-mode application, kernel-mode component, or driver has requested information about the length of the file object (representing the driver's device object) for which the user-mode requester has a handle, or that the user-mode requester is attempting to set an end-of-file on that file object.

    Parallel class and serial device drivers handle these requests by setting the FILE_STANDARD_INFORMATION or FILE_POSITION_INFORMATION length or position to zero. Other highest-level device drivers should support these requests, particularly if a user-mode application or kernel-mode driver might call C runtime functions to manipulate the file object. File system drivers must support these requests more fully than these highest-level device drivers.

  • DispatchFlushBuffers

    A driver that caches data in a device or buffers data internally in driver-allocated memory might receive IRP_MJ_FLUSH_BUFFERS. Receipt of this request indicates that the driver should write its buffered data or flush the cached data out to the device, or should discard buffered or cached data that was read from the device.

    For example, the system keyboard and mouse class drivers, which have internal ring buffers for input data from their devices, support the flush request. Drivers of mass-storage devices and drivers layered above them also support this request.

  • DispatchShutdown

    Any driver that is likely to be called before the system shuts down must handle IRP_MJ_SHUTDOWN. The DispatchShutdown routine should do whatever driver-determined cleanup is necessary before the power manager sends a system set-power IRP to shut down the system. A driver can call IoRegisterShutdownNotification or IoRegisterLastChanceShutdownNotification to register for shutdown notification.

Drivers for mass-storage devices and intermediate drivers layered over them can rely on a highest-level file system driver to send them shutdown IRPs when the system is about to shut down. That is, the FSD is responsible for making sure that any cached file data is written out to peripheral devices, calling underlying drivers to flush data from their device caches or buffers (if any), and so forth before the system is shut down.

The driver of a mass-storage device that caches data internally must provide DispatchShutdown and DispatchFlushBuffers routines. If a mass-storage driver buffers data in memory but its device has no internal cache, it also must provide DispatchShutdown and DispatchFlushBuffers routines.

Any intermediate driver layered above a driver that handles IRP_MJ_FLUSH_BUFFERS and IRP_MJ_SHUTDOWN requests also provide DispatchShutdown and DispatchFlushBuffers routines.

Send comments about this topic to Microsoft