vlMiniDumper.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 1992-2025 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vlutil/vlMachineTypes.h>
#include <string>
#include <vlutil/vlMutex.h>

// Preprocessor Directive which allows reuse in MAK RTI applications and VR-Link based applications.
#ifdef DtUSE_UTILITIES_NAMESPACE
#define DtMiniDumper Dt ## MAKRti ## MiniDumper
#endif

#ifdef WIN32

#if _MSC_VER < 1300
#  define DECLSPEC_DEPRECATED
// VC6: change this path to your Platform SDK headers
#  include "M:\\dev7\\vs\\devtools\\common\\win32sdk\\include\\dbghelp.h"         // must be XP version of file
#else
// VC7: ships with updated headers
#define _WINSOCKAPI_
#include <windows.h>
#  include "dbghelp.h"
#endif

// based on dbghelp.h
typedef BOOL (WINAPI* MINIDUMPWRITEDUMP)( HANDLE hProcess, DWORD dwPid, HANDLE hFile,
   MINIDUMP_TYPE DumpType, CONST PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
   CONST PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
   CONST PMINIDUMP_CALLBACK_INFORMATION CallbackParam );

class DT_DLL_VLUTIL DtMiniDumper
{

public:

   DtMiniDumper( const char* szAppName, bool promptUser = true );

   static bool isPdbInCurrentWorkinDirectory(const std::string& module);
   static std::string backTrace();
protected:

   static LONG WINAPI TopLevelFilter( struct _EXCEPTION_POINTERS* pExceptionInfo );

   static LONG WINAPI VectoredExceptionHandler(PEXCEPTION_POINTERS pExceptionInfo);
   
   static BOOL CALLBACK TopLevelFilterCallback(PVOID pParam, const PMINIDUMP_CALLBACK_INPUT pInput, PMINIDUMP_CALLBACK_OUTPUT pOutput);

   enum DtMiniDumpType
   { 
      MINIDUMP_TINY = MiniDumpNormal,
      MINIDUMP_MINI = (MiniDumpWithIndirectlyReferencedMemory |
                        MiniDumpScanMemory),
      MINIDUMP_MIDI = (MiniDumpWithPrivateReadWriteMemory |
                        MiniDumpWithDataSegs | 
                        MiniDumpWithHandleData |
                        MiniDumpWithFullMemoryInfo |
                        MiniDumpWithThreadInfo |
                        MiniDumpWithUnloadedModules),
      MINIDUMP_MAX = (MiniDumpWithFullMemory |
                        MiniDumpWithFullMemoryInfo |
                        MiniDumpWithHandleData |
                        MiniDumpWithThreadInfo |
                        MiniDumpWithUnloadedModules)
   };
protected:

   static char* m_szAppName;
   static bool myPrompt;
   static bool myDisableHandler;
   static DtMiniDumper::DtMiniDumpType myMiniDumpType;
#ifdef DtUSE_UTILITIES_NAMESPACE
   static DtUSE_UTILITIES_NAMESPACE::DtMutex theMutex;
#else
   static DtMutex theMutex;
#endif
};

#define DtINIT_MINIDUMPER( execName ) DtMiniDumper miniDump( execName );
#define DtINIT_MINIDUMPER_NO_PROMPT( execName ) DtMiniDumper miniDump( execName, false );

#define DtSILENTLY_CRASH( unused ) \
{ \
   ::SetUnhandledExceptionFilter(0); \
   SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX); \
}
#else // WIN32

#include <map>
#include <string>
#include <signal.h>
#include <execinfo.h>
#include <ucontext.h>

class DT_DLL_VLUTIL DtMiniDumper
{
public:

   static void printCallStack( int sig, siginfo_t* info, void* secret );

   static std::string myApplicationName;
protected:

   static void initializeAddressSpace();

   static void objFileAndNameFromStack( char* stackEntry,
      std::string& objFile, std::string& objFileName );

   static std::string lookupFileInfo( const std::string& objFile,
      unsigned long offset );

private:

   DtMiniDumper();

protected:

   typedef std::map<std::string,unsigned long> AddressSpaceMap;

   static AddressSpaceMap myAddressSpaceMap;

};

typedef void (*SigActionCb)( int, siginfo_t*, void* );
#define DtINIT_MINIDUMPER( execName ) \
{ \
   struct sigaction sa; \
   DtMiniDumper::myApplicationName = execName; \
   sa.sa_sigaction = (SigActionCb) DtMiniDumper::printCallStack; \
   sa.sa_flags = SA_SIGINFO; \
   sigemptyset( &sa.sa_mask ); \
   sigaction( SIGSEGV, &sa, 0 ); \
   sigaction( SIGABRT, &sa, 0 ); \
   sigaction( SIGFPE, &sa, 0 ); \
}

// TODO
#define DtINIT_MINIDUMPER_NO_PROMPT( unused ) \
{ \
   struct sigaction sa; \
   sa.sa_sigaction = (SigActionCb) DtMiniDumper::printCallStack; \
   sa.sa_flags = SA_SIGINFO; \
   sigemptyset( &sa.sa_mask ); \
   sigaction( SIGSEGV, &sa, 0 ); \
}

// TODO
#define DtSILENTLY_CRASH( unused ) \
{ \
}
#endif