win/mon/VBoxUsbHook.cpp

	VBoxUsbHook.cpp revision 3a25521ac18f48906d84edec68c454d619e251f2
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/* $Id$ */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/** @file
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Driver Dispatch Table Hooking API
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/*
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Copyright (C) 2011 Oracle Corporation
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync *
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * available from http://www.virtualbox.org. This file is free software;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * you can redistribute it and/or modify it under the terms of the GNU
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * General Public License (GPL) as published by the Free Software
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync#include "VBoxUsbMon.h"
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync#define VBOXUSBHOOK_MEMTAG 'HUBV'
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncNTSTATUS VBoxUsbHookInstall(PVBOXUSBHOOK_ENTRY pHook)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KIRQL Irql;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeAcquireSpinLock(&pHook->Lock, &Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    if (pHook->fIsInstalled)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        AssertFailed();
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        return STATUS_UNSUCCESSFUL;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->pfnOldHandler = (PDRIVER_DISPATCH)InterlockedExchangePointer((PVOID*)&pHook->pDrvObj->MajorFunction[pHook->iMjFunction], pHook->pfnHook);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pHook->pfnOldHandler);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pHook->pfnHook != pHook->pfnOldHandler);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->fIsInstalled = TRUE;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    return STATUS_SUCCESS;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncNTSTATUS VBoxUsbHookUninstall(PVBOXUSBHOOK_ENTRY pHook)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KIRQL Irql;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeAcquireSpinLock(&pHook->Lock, &Irql);
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    if (!pHook->fIsInstalled)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        return STATUS_SUCCESS;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
7d6ce198fd361f58bd1ebdeee7772f76b4e58966vboxsync
2fce40121ae472df2fd959fbe19775ed43304a0bvboxsync    PDRIVER_DISPATCH pfnOldVal = (PDRIVER_DISPATCH)InterlockedCompareExchangePointer((PVOID*)&pHook->pDrvObj->MajorFunction[pHook->iMjFunction], pHook->pfnOldHandler, pHook->pfnHook);
edde275acba04aca58db4172a163741e3abadfbcvboxsync    Assert(pfnOldVal == pHook->pfnHook);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    if (pfnOldVal != pHook->pfnHook)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        AssertMsgFailed(("unhook failed!!!\n"));
40839c441cb305d84420565f7ca25403d8177413vboxsync        /* this is bad! this could happen if someone else has chained another hook,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync         * or (which is even worse) restored the "initial" entry value it saved when doing a hooking before us
7d6ce198fd361f58bd1ebdeee7772f76b4e58966vboxsync         * return the failure and don't do anything else
7d6ce198fd361f58bd1ebdeee7772f76b4e58966vboxsync         * the best thing to do if this happens is to leave everything as is
7d6ce198fd361f58bd1ebdeee7772f76b4e58966vboxsync         * and to prevent the driver from being unloaded to ensure no one references our unloaded hook routine */
7d6ce198fd361f58bd1ebdeee7772f76b4e58966vboxsync        KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        return STATUS_UNSUCCESSFUL;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->fIsInstalled = FALSE;
edde275acba04aca58db4172a163741e3abadfbcvboxsync    KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    /* wait for the current handlers to exit */
a1d9d394b49969e730c5a8e037ea2d672a48dbf6vboxsync    VBoxDrvToolRefWaitEqual(&pHook->HookRef, 1);
edde275acba04aca58db4172a163741e3abadfbcvboxsync
edde275acba04aca58db4172a163741e3abadfbcvboxsync    return STATUS_SUCCESS;
edde275acba04aca58db4172a163741e3abadfbcvboxsync}
edde275acba04aca58db4172a163741e3abadfbcvboxsync
a1d9d394b49969e730c5a8e037ea2d672a48dbf6vboxsyncBOOLEAN VBoxUsbHookIsInstalled(PVBOXUSBHOOK_ENTRY pHook)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KIRQL Irql;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    BOOLEAN fIsInstalled;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeAcquireSpinLock(&pHook->Lock, &Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    fIsInstalled = pHook->fIsInstalled;
2fce40121ae472df2fd959fbe19775ed43304a0bvboxsync    KeReleaseSpinLock(&pHook->Lock, Irql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    return fIsInstalled;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncVOID VBoxUsbHookInit(PVBOXUSBHOOK_ENTRY pHook, PDRIVER_OBJECT pDrvObj, UCHAR iMjFunction, PDRIVER_DISPATCH pfnHook)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pDrvObj);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(iMjFunction <= IRP_MJ_MAXIMUM_FUNCTION);
2fce40121ae472df2fd959fbe19775ed43304a0bvboxsync    Assert(pfnHook);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    memset(pHook, 0, sizeof (*pHook));
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    InitializeListHead(&pHook->RequestList);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeInitializeSpinLock(&pHook->Lock);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    VBoxDrvToolRefInit(&pHook->HookRef);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->pDrvObj = pDrvObj;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->iMjFunction = iMjFunction;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pHook->pfnHook = pfnHook;
2fce40121ae472df2fd959fbe19775ed43304a0bvboxsync    Assert(!pHook->pfnOldHandler);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(!pHook->fIsInstalled);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncstatic void vboxUsbHookRequestRegisterCompletion(PVBOXUSBHOOK_ENTRY pHook, PDEVICE_OBJECT pDevObj, PIRP pIrp, PIO_COMPLETION_ROUTINE pfnCompletion, PVBOXUSBHOOK_REQUEST pRequest)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pfnCompletion);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pRequest);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pDevObj);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pIrp);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    PIO_STACK_LOCATION pSl = IoGetCurrentIrpStackLocation(pIrp);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    memset(pRequest, 0, sizeof (*pRequest));
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->pHook = pHook;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->OldLocation = *pSl;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->pDevObj = pDevObj;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->pIrp = pIrp;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->bCompletionStopped = FALSE;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pSl->CompletionRoutine = pfnCompletion;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pSl->Context = pRequest;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pSl->Control = SL_INVOKE_ON_SUCCESS | SL_INVOKE_ON_ERROR | SL_INVOKE_ON_CANCEL;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KIRQL oldIrql;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeAcquireSpinLock(&pHook->Lock, &oldIrql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    InsertTailList(&pHook->RequestList, &pRequest->ListEntry);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeReleaseSpinLock(&pHook->Lock, oldIrql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncNTSTATUS VBoxUsbHookRequestPassDownHookCompletion(PVBOXUSBHOOK_ENTRY pHook, PDEVICE_OBJECT pDevObj, PIRP pIrp, PIO_COMPLETION_ROUTINE pfnCompletion, PVBOXUSBHOOK_REQUEST pRequest)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(pfnCompletion);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    vboxUsbHookRequestRegisterCompletion(pHook, pDevObj, pIrp, pfnCompletion, pRequest);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    return pHook->pfnOldHandler(pDevObj, pIrp);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsyncNTSTATUS VBoxUsbHookRequestPassDownHookSkip(PVBOXUSBHOOK_ENTRY pHook, PDEVICE_OBJECT pDevObj, PIRP pIrp)
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync{
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    return pHook->pfnOldHandler(pDevObj, pIrp);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncNTSTATUS VBoxUsbHookRequestMoreProcessingRequired(PVBOXUSBHOOK_ENTRY pHook, PDEVICE_OBJECT pDevObj, PIRP pIrp, PVBOXUSBHOOK_REQUEST pRequest)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync{
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    Assert(!pRequest->bCompletionStopped);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    pRequest->bCompletionStopped = TRUE;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    return STATUS_MORE_PROCESSING_REQUIRED;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
eb259de2a9eac4b4dda56e89f5004671f926bd9bvboxsync
eb259de2a9eac4b4dda56e89f5004671f926bd9bvboxsyncNTSTATUS VBoxUsbHookRequestComplete(PVBOXUSBHOOK_ENTRY pHook, PDEVICE_OBJECT pDevObj, PIRP pIrp, PVBOXUSBHOOK_REQUEST pRequest)
93e05ea894cefd56ca308d72372b4dd8045bd1eevboxsync{
93e05ea894cefd56ca308d72372b4dd8045bd1eevboxsync    NTSTATUS Status = STATUS_SUCCESS;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    if (pRequest->OldLocation.CompletionRoutine && pRequest->OldLocation.Control)
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    {
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync        Status = pRequest->OldLocation.CompletionRoutine(pDevObj, pIrp, pRequest->OldLocation.Context);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    if (Status != STATUS_MORE_PROCESSING_REQUIRED)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        if (pRequest->bCompletionStopped)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync            IoCompleteRequest(pIrp, IO_NO_INCREMENT);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        }
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    /*
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync     * else - in case driver returned STATUS_MORE_PROCESSING_REQUIRED,
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync     * it will call IoCompleteRequest itself
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync     */
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    KIRQL oldIrql;
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    KeAcquireSpinLock(&pHook->Lock, &oldIrql);
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    RemoveEntryList(&pRequest->ListEntry);
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    KeReleaseSpinLock(&pHook->Lock, oldIrql);
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    return Status;
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync}
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync#define PVBOXUSBHOOK_REQUEST_FROM_LE(_pLe) ( (PVBOXUSBHOOK_REQUEST)( ((uint8_t*)(_pLe)) - RT_OFFSETOF(VBOXUSBHOOK_REQUEST, ListEntry) ) )
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsyncVOID VBoxUsbHookVerifyCompletion(PVBOXUSBHOOK_ENTRY pHook, PVBOXUSBHOOK_REQUEST pRequest, PIRP pIrp)
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync{
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    KIRQL oldIrql;
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    KeAcquireSpinLock(&pHook->Lock, &oldIrql);
a60be2c64ea23bb7ce4c9998bcd541c4db879fbavboxsync    for (PLIST_ENTRY pLe = pHook->RequestList.Flink; pLe != &pHook->RequestList; pLe = pLe->Flink)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    {
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        PVBOXUSBHOOK_REQUEST pCur = PVBOXUSBHOOK_REQUEST_FROM_LE(pLe);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        if (pCur != pRequest)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync            continue;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        if (pCur->pIrp != pIrp)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync            continue;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync        AssertFailed();
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    }
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync    KeReleaseSpinLock(&pHook->Lock, oldIrql);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync}
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync