The Tor Browser: tools/trace-malloc/lib/nsDebugHelpWin32.cpp@b8a032363ba2 (annotated)

tools/trace-malloc/lib/nsDebugHelpWin32.cpp@b8a032363ba2 (annotated)

tools/trace-malloc/lib/nsDebugHelpWin32.cpp

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #if defined(_WIN32) && (defined(_M_IX86) || defined(_M_X64))
 // This is the .cpp file where the globals live
 #define DHW_IMPLEMENT_GLOBALS
 #include <stdio.h>
 #include "prprf.h"
 #include "prlog.h"
 #include "plstr.h"
 #include "prlock.h"
 #include "nscore.h"
 #include "nsDebugHelpWin32.h"
 #else
 #error "nsDebugHelpWin32.cpp should only be built in Win32 x86/x64 builds"
 #endif
 /***************************************************************************/
 PRLock*           DHWImportHooker::gLock  = nullptr;
 DHWImportHooker*  DHWImportHooker::gHooks = nullptr;
 decltype(GetProcAddress)* DHWImportHooker::gRealGetProcAddress = nullptr;
 static bool
 dhwEnsureImageHlpInitialized()
 {
   static bool gInitialized = false;
   static bool gTried       = false;
   if (!gInitialized && !gTried) {
     gTried = true;
     HMODULE module = ::LoadLibrary("DBGHELP.DLL");
     if (!module) {
       DWORD dw = GetLastError();
       printf("DumpStack Error: DBGHELP.DLL wasn't found. GetLastError() returned 0x%8.8X\n"
              "                 This DLL is needed for succeessfully implementing trace-malloc.\n"
              "                 This dll ships by default on Win2k. Disabling trace-malloc functionality.\n"
              , dw);
       return false;
     }
 #define INIT_PROC(typename_, name_) \
     dhw##name_ = (decltype(name_)*) ::GetProcAddress(module, #name_); \
     if(!dhw##name_) return false;
 #ifdef _WIN64
     INIT_PROC(ENUMERATELOADEDMODULES64, EnumerateLoadedModules64);
 #else
     INIT_PROC(ENUMERATELOADEDMODULES, EnumerateLoadedModules);
 #endif
     INIT_PROC(IMAGEDIRECTORYENTRYTODATA, ImageDirectoryEntryToData);
 #undef INIT_PROC
     gInitialized = true;
   }
   return gInitialized;
 }
 DHWImportHooker&
 DHWImportHooker::getGetProcAddressHooker()
 {
   static DHWImportHooker gGetProcAddress("Kernel32.dll", "GetProcAddress",
                                            (PROC)DHWImportHooker::GetProcAddress);
   return gGetProcAddress;
 }
 DHWImportHooker&
 DHWImportHooker::getLoadLibraryWHooker()
 {
   static DHWImportHooker gLoadLibraryW("Kernel32.dll", "LoadLibraryW",
                                          (PROC)DHWImportHooker::LoadLibraryW);
   return gLoadLibraryW;
 }
 DHWImportHooker&
 DHWImportHooker::getLoadLibraryExWHooker()
 {
   static DHWImportHooker gLoadLibraryExW("Kernel32.dll", "LoadLibraryExW",
                                          (PROC)DHWImportHooker::LoadLibraryExW);
   return gLoadLibraryExW;
 }
 DHWImportHooker&
 DHWImportHooker::getLoadLibraryAHooker()
 {
   static DHWImportHooker gLoadLibraryA("Kernel32.dll", "LoadLibraryA",
                                          (PROC)DHWImportHooker::LoadLibraryA);
   return gLoadLibraryA;
 }
 DHWImportHooker&
 DHWImportHooker::getLoadLibraryExAHooker()
 {
   static DHWImportHooker gLoadLibraryExA("Kernel32.dll", "LoadLibraryExA",
                                            (PROC)DHWImportHooker::LoadLibraryExA);
   return gLoadLibraryExA;
 }
 static HMODULE ThisModule()
 {
     MEMORY_BASIC_INFORMATION info;
     return VirtualQuery(ThisModule, &info, sizeof(info)) ?
                             (HMODULE) info.AllocationBase : nullptr;
 }
 DHWImportHooker::DHWImportHooker(const char* aModuleName,
                                  const char* aFunctionName,
                                  PROC aHook,
                                  bool aExcludeOurModule /* = false */)
     :   mNext(nullptr),
         mModuleName(aModuleName),
         mFunctionName(aFunctionName),
         mOriginal(nullptr),
         mHook(aHook),
         mIgnoreModule(aExcludeOurModule ? ThisModule() : nullptr),
         mHooking(true)
 {
     //printf("DHWImportHooker hooking %s, function %s\n",aModuleName, aFunctionName);
     if(!gLock)
         gLock = PR_NewLock();
     PR_Lock(gLock);
     dhwEnsureImageHlpInitialized(); // for the extra ones we care about.
     if(!gRealGetProcAddress)
         gRealGetProcAddress = ::GetProcAddress;
     mOriginal = gRealGetProcAddress(::GetModuleHandleA(aModuleName),
                                     aFunctionName),
     mNext = gHooks;
     gHooks = this;
     PatchAllModules();
     PR_Unlock(gLock);
 }
 DHWImportHooker::~DHWImportHooker()
 {
     PR_Lock(gLock);
     mHooking = false;
     PatchAllModules();
     for (DHWImportHooker **cur = &gHooks;
          (PR_ASSERT(*cur), *cur); /* assert that we find this */
          cur = &(*cur)->mNext)
     {
         if (*cur == this)
         {
             *cur = mNext;
             break;
         }
     }
     if(!gHooks)
     {
         PRLock* theLock = gLock;
         gLock = nullptr;
         PR_Unlock(theLock);
         PR_DestroyLock(theLock);
     }
     if (gLock)
         PR_Unlock(gLock);
 }
 #ifdef _WIN64
 static BOOL CALLBACK ModuleEnumCallback(PCSTR ModuleName,
                                         DWORD64 ModuleBase,
                                         ULONG ModuleSize,
                                         PVOID UserContext)
 #else
 static BOOL CALLBACK ModuleEnumCallback(PCSTR ModuleName,
                                         ULONG ModuleBase,
                                         ULONG ModuleSize,
                                         PVOID UserContext)
 #endif
 {
     //printf("Module Name %s\n",ModuleName);
     DHWImportHooker* self = (DHWImportHooker*) UserContext;
     HMODULE aModule = (HMODULE) ModuleBase;
     return self->PatchOneModule(aModule, ModuleName);
 }
 bool
 DHWImportHooker::PatchAllModules()
 {
     // Need to cast to PENUMLOADED_MODULES_CALLBACK because the
     // constness of the first parameter of PENUMLOADED_MODULES_CALLBACK
     // varies over SDK versions (from non-const to const over time).
     // See bug 391848 and bug 415426.
 #ifdef _WIN64
     return dhwEnumerateLoadedModules64(::GetCurrentProcess(),
                (PENUMLOADED_MODULES_CALLBACK64)ModuleEnumCallback, this);
 #else
     return dhwEnumerateLoadedModules(::GetCurrentProcess(),
                (PENUMLOADED_MODULES_CALLBACK)ModuleEnumCallback, this);
 #endif
 }
 bool
 DHWImportHooker::PatchOneModule(HMODULE aModule, const char* name)
 {
     if(aModule == mIgnoreModule)
     {
         return true;
     }
     // do the fun stuff...
     PIMAGE_IMPORT_DESCRIPTOR desc;
     ULONG size;
     desc = (PIMAGE_IMPORT_DESCRIPTOR)
         dhwImageDirectoryEntryToData(aModule, true,
                                      IMAGE_DIRECTORY_ENTRY_IMPORT, &size);
     if(!desc)
     {
         return true;
     }
     for(; desc->Name; desc++)
     {
         const char* entryModuleName = (const char*)
             ((char*)aModule + desc->Name);
         if(!lstrcmpi(entryModuleName, mModuleName))
             break;
     }
     if(!desc->Name)
     {
         return true;
     }
     PIMAGE_THUNK_DATA thunk = (PIMAGE_THUNK_DATA)
         ((char*) aModule + desc->FirstThunk);
     for(; thunk->u1.Function; thunk++)
     {
         PROC original;
         PROC replacement;
         if(mHooking)
         {
             original = mOriginal;
             replacement = mHook;
         }
         else
         {
             original = mHook;
             replacement = mOriginal;
         }
         PROC* ppfn = (PROC*) &thunk->u1.Function;
         if(*ppfn == original)
         {
             DWORD dwDummy;
             VirtualProtect(ppfn, sizeof(ppfn), PAGE_EXECUTE_READWRITE, &dwDummy);
             BOOL result = WriteProcessMemory(GetCurrentProcess(),
                                ppfn, &replacement, sizeof(replacement), nullptr);
             if (!result) //failure
             {
               printf("failure name %s  func %x\n",name,*ppfn);
               DWORD error = GetLastError();
               return true;
             }
             else
             {
               // printf("success name %s  func %x\n",name,*ppfn);
               DWORD filler = result+1;
               return result;
             }
         }
     }
     return true;
 }
 bool
 DHWImportHooker::ModuleLoaded(HMODULE aModule, DWORD flags)
 {
     //printf("ModuleLoaded\n");
     if(aModule && !(flags & LOAD_LIBRARY_AS_DATAFILE))
     {
         PR_Lock(gLock);
         // We don't know that the newly loaded module didn't drag in implicitly
         // linked modules, so we patch everything in sight.
         for(DHWImportHooker* cur = gHooks; cur; cur = cur->mNext)
             cur->PatchAllModules();
         PR_Unlock(gLock);
     }
     return true;
 }
 // static
 HMODULE WINAPI
 DHWImportHooker::LoadLibraryW(PCWSTR path)
 {
     //wprintf(L"LoadLibraryW %s\n",path);
     HMODULE hmod = DHW_ORIGINAL(::LoadLibraryW, getLoadLibraryWHooker())(path);
     ModuleLoaded(hmod, 0);
     return hmod;
 }
 // static
 HMODULE WINAPI
 DHWImportHooker::LoadLibraryExW(PCWSTR path, HANDLE file, DWORD flags)
 {
     //wprintf(L"LoadLibraryExW %s\n",path);
     HMODULE hmod = DHW_ORIGINAL(::LoadLibraryExW, getLoadLibraryExWHooker())(path, file, flags);
     ModuleLoaded(hmod, flags);
     return hmod;
 }
 // static
 HMODULE WINAPI
 DHWImportHooker::LoadLibraryA(PCSTR path)
 {
     //printf("LoadLibraryA %s\n",path);
     HMODULE hmod = DHW_ORIGINAL(::LoadLibraryA, getLoadLibraryAHooker())(path);
     ModuleLoaded(hmod, 0);
     return hmod;
 }
 // static
 HMODULE WINAPI
 DHWImportHooker::LoadLibraryExA(PCSTR path, HANDLE file, DWORD flags)
 {
     //printf("LoadLibraryExA %s\n",path);
     HMODULE hmod = DHW_ORIGINAL(::LoadLibraryExA, getLoadLibraryExAHooker())(path, file, flags);
     ModuleLoaded(hmod, flags);
     return hmod;
 }
 // static
 FARPROC WINAPI
 DHWImportHooker::GetProcAddress(HMODULE aModule, PCSTR aFunctionName)
 {
     FARPROC pfn = gRealGetProcAddress(aModule, aFunctionName);
     if(pfn)
     {
         PR_Lock(gLock);
         for(DHWImportHooker* cur = gHooks; cur; cur = cur->mNext)
         {
             if(pfn == cur->mOriginal)
             {
                 pfn = cur->mHook;
                 break;
             }
         }
         PR_Unlock(gLock);
     }
     return pfn;
 }

The Tor Browser / annotate

tools/trace-malloc/lib/nsDebugHelpWin32.cpp@b8a032363ba2 (annotated)

tools/trace-malloc/lib/nsDebugHelpWin32.cpp