CrashReportContext Class Reference

This object is for internal usage. More...

#include <CrashReportContext.h>

Public Member Functions
bool	SetSenderPathUTF8 (const std::string &path)
bool	SetReportURL (const std::string &url)
bool	SetParameters (const std::map< std::string, std::string > &p)
void	StartHandler (const std::string &databasePath)
bool	SetSenderPathUTF8 (const std::string &path)
bool	SetReportURL (const std::string &path)
bool	SetParameters (const std::map< std::string, std::string > &p)
void	StartHandler (const std::string &databasePath)

Private Attributes
char	mSenderPath [MaxBufferLength] {}
char	mReportURL [MaxBufferLength] {}
char	mParameters [MaxBufferLength] {}
wchar_t	mSenderPath [MaxBufferLength] {}
wchar_t	mReportURL [MaxBufferLength] {}
wchar_t	mParameters [MaxBufferLength] {}
wchar_t	mCommand [MaxCommandLength] {}

Static Private Attributes
static constexpr size_t	MaxBufferLength { 2048 }
static constexpr size_t	MaxCommandLength { 8192 }

Friends
bool	SendReport (CrashReportContext *ctx, const char *minidumpPath)
bool	MakeCommand (CrashReportContext *ctx, const wchar_t *path, const wchar_t *id)
bool	SendReport (CrashReportContext *ctx, const wchar_t *path, const wchar_t *id)

Detailed Description

This object is for internal usage.

---

Audacity: A Digital Audio Editor

CrashReportContext.h

Vitaly Sverchinsky

Simple POD type, holds user data required to start handler. Fields are initialized with Set* methods, which may return false if internal buffer isn't large enough to store value passed as an argument. After initialization call StartHandler providing path to the database, where minidumps will be stored.

Definition at line 24 of file unix/CrashReportContext.h.

Member Function Documentation

SetParameters() [1/2]

bool CrashReportContext::SetParameters

(

const std::map< std::string, std::string > &

p

)

Definition at line 125 of file unix/CrashReportContext.cpp.

{
    auto str = StringifyParameters(p);
    return StrcpyChecked(mParameters, MaxBufferLength, str);
}

References MaxBufferLength, mParameters, str, anonymous_namespace{CrashReportContext.cpp}::StrcpyChecked(), and anonymous_namespace{CrashReportContext.cpp}::StringifyParameters().

Here is the call graph for this function:

SetParameters() [2/2]

bool CrashReportContext::SetParameters

(

const std::map< std::string, std::string > &

p

)

SetReportURL() [1/2]

bool CrashReportContext::SetReportURL

(

const std::string &

path

)

SetReportURL() [2/2]

bool CrashReportContext::SetReportURL

(

const std::string &

url

)

Definition at line 120 of file unix/CrashReportContext.cpp.

{
    return StrcpyChecked(mReportURL, MaxBufferLength, url);
}

References MaxBufferLength, mReportURL, and anonymous_namespace{CrashReportContext.cpp}::StrcpyChecked().

Here is the call graph for this function:

SetSenderPathUTF8() [1/2]

bool CrashReportContext::SetSenderPathUTF8

(

const std::string &

path

)

Definition at line 115 of file unix/CrashReportContext.cpp.

{
    return StrcpyChecked(mSenderPath, MaxBufferLength, path + "/" + CRASHREPORTER_PROGRAM_NAME);
}

References MaxBufferLength, mSenderPath, and anonymous_namespace{CrashReportContext.cpp}::StrcpyChecked().

Referenced by BreakpadConfigurer::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSenderPathUTF8() [2/2]

bool CrashReportContext::SetSenderPathUTF8

(

const std::string &

path

)

StartHandler() [1/2]

void CrashReportContext::StartHandler

(

const std::string &

databasePath

)

Definition at line 131 of file unix/CrashReportContext.cpp.

{
    //intentinal leak: error hooks may be useful while application is terminating
    //CrashReportContext data should be alive too...
#if(__APPLE__)
    static auto handler = new google_breakpad::ExceptionHandler(
        databasePath,
        nullptr,
        DumpCallback,
        this,
        true,
        nullptr
    );
#else 
    google_breakpad::MinidumpDescriptor descriptor(databasePath);
   static auto handler = new google_breakpad::ExceptionHandler(
      descriptor,
      nullptr,
      DumpCallback,
      this,
      true,
      -1
   );
#endif
}

References anonymous_namespace{CrashReportContext.cpp}::DumpCallback(), and audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler.

Here is the call graph for this function:

StartHandler() [2/2]

void CrashReportContext::StartHandler

(

const std::string &

databasePath

)

Friends And Related Function Documentation

MakeCommand

bool MakeCommand ( CrashReportContext *  ctx, const wchar_t *  path, const wchar_t *  id  )

friend

Definition at line 72 of file win32/CrashReportContext.cpp.

{
   //utility path
   auto ok = StrcpyChecked(c->mCommand, CrashReportContext::MaxCommandLength, L"\"");
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, c->mSenderPath);
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L"\"");
 
   //parameters: /p "..."
   if (ok && c->mParameters[0] != 0)
   {
      ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L" /a \"");
      ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, c->mParameters);
      ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L"\"");
   }
   //crash report URL: /u https://...
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxBufferLength, L" /u \"");
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxBufferLength, c->mReportURL);
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxBufferLength, L"\" ");
   //minidump path: path/to/minidump.dmp
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L" \"");
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, path);
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L"\\");
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, id);
   ok = ok && StrcatChecked(c->mCommand, CrashReportContext::MaxCommandLength, L".dmp\"");
   return ok;
}

SendReport [1/2]

bool SendReport ( CrashReportContext *  ctx, const char *  minidumpPath  )

friend

---

Audacity: A Digital Audio Editor

CrashReportContext.cpp

Vitaly Sverchinsky

Some parts of the code are designed to operate while app is crashing, so there may be some restrictions on heap usage. For more information please read Breakpad documentation.

Definition at line 26 of file unix/CrashReportContext.cpp.

{
    auto pid = fork();
    if(pid == 0)
    {
        if(c->mParameters[0] != 0)
        {
            execl(c->mSenderPath, CRASHREPORTER_PROGRAM_NAME, "-a", c->mParameters, "-u", c->mReportURL, minidumpPath, NULL);
        }
        else
        {
            execl(c->mSenderPath, CRASHREPORTER_PROGRAM_NAME, "-u", c->mReportURL, minidumpPath, NULL);
        }
        fprintf(stderr, "Failed to start handler: %s\n", strerror(errno));
        abort();
    }
    return pid != -1;
}

SendReport [2/2]

bool SendReport ( CrashReportContext *  ctx, const wchar_t *  path, const wchar_t *  id  )

friend

Definition at line 99 of file win32/CrashReportContext.cpp.

{
   if (!MakeCommand(c, path, id))
      return false;
 
   STARTUPINFOW si;
   ZeroMemory(&si, sizeof(si));
   si.cb = sizeof(si);
   si.dwFlags = STARTF_USESHOWWINDOW;
   si.wShowWindow = SW_SHOW;
 
   PROCESS_INFORMATION pi;
   ZeroMemory(&pi, sizeof(pi));
 
   if (CreateProcessW(NULL, c->mCommand, NULL, NULL, FALSE, 0, NULL, NULL, &si, &pi))
   {
      CloseHandle(pi.hProcess);
      CloseHandle(pi.hThread);
      return true;
   }
   else
      return false;
}

Member Data Documentation

MaxBufferLength

static constexpr size_t CrashReportContext::MaxBufferLength { 2048 }

staticconstexprprivate

Definition at line 26 of file unix/CrashReportContext.h.

Referenced by SetParameters(), SetReportURL(), and SetSenderPathUTF8().

MaxCommandLength

constexpr size_t CrashReportContext::MaxCommandLength { 8192 }

staticconstexprprivate

Definition at line 27 of file win32/CrashReportContext.h.

mCommand

wchar_t CrashReportContext::mCommand[MaxCommandLength] {}

private

Definition at line 34 of file win32/CrashReportContext.h.

mParameters [1/2]

char CrashReportContext::mParameters[MaxBufferLength] {}

private

Definition at line 30 of file unix/CrashReportContext.h.

Referenced by SetParameters().

mParameters [2/2]

wchar_t CrashReportContext::mParameters[MaxBufferLength] {}

private

Definition at line 31 of file win32/CrashReportContext.h.

mReportURL [1/2]

char CrashReportContext::mReportURL[MaxBufferLength] {}

private

Definition at line 29 of file unix/CrashReportContext.h.

Referenced by SetReportURL().

mReportURL [2/2]

wchar_t CrashReportContext::mReportURL[MaxBufferLength] {}

private

Definition at line 30 of file win32/CrashReportContext.h.

mSenderPath [1/2]

char CrashReportContext::mSenderPath[MaxBufferLength] {}

private

Definition at line 28 of file unix/CrashReportContext.h.

Referenced by SetSenderPathUTF8().

mSenderPath [2/2]

wchar_t CrashReportContext::mSenderPath[MaxBufferLength] {}

private

Definition at line 29 of file win32/CrashReportContext.h.

---

The documentation for this class was generated from the following files:

• unix/CrashReportContext.h
• win32/CrashReportContext.h
• unix/CrashReportContext.cpp
• win32/CrashReportContext.cpp