summaryrefslogtreecommitdiff
path: root/indra/newview/llwindebug.cpp
blob: 8a66fca3497f150536afe5d2364e5a9a4f929401 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/**
 * @file llwindebug.cpp
 * @brief Windows debugging functions
 *
 * $LicenseInfo:firstyear=2004&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */
#include "llviewerprecompiledheaders.h"

#include "llwindebug.h"
#include "lldir.h"


// 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
                                    );

MINIDUMPWRITEDUMP f_mdwp = NULL;


class LLMemoryReserve {
public:
    LLMemoryReserve();
    ~LLMemoryReserve();
    void reserve();
    void release();
private:
    unsigned char *mReserve;
    static const size_t MEMORY_RESERVATION_SIZE;
};

LLMemoryReserve::LLMemoryReserve() :
    mReserve(NULL)
{
}

LLMemoryReserve::~LLMemoryReserve()
{
    release();
}

// I dunno - this just seemed like a pretty good value.
const size_t LLMemoryReserve::MEMORY_RESERVATION_SIZE = 5 * 1024 * 1024;

void LLMemoryReserve::reserve()
{
    if(NULL == mReserve)
    {
        mReserve = new unsigned char[MEMORY_RESERVATION_SIZE];
    }
}

void LLMemoryReserve::release()
{
    if (NULL != mReserve)
    {
        delete [] mReserve;
    }
    mReserve = NULL;
}

static LLMemoryReserve gEmergencyMemoryReserve;


LONG NTAPI vectoredHandler(PEXCEPTION_POINTERS exception_infop)
{
    LLWinDebug::instance().generateMinidump(exception_infop);
    return EXCEPTION_CONTINUE_SEARCH;
}

// static
void  LLWinDebug::initSingleton()
{
    static bool s_first_run = true;
    // Load the dbghelp dll now, instead of waiting for the crash.
    // Less potential for stack mangling

    // Don't install vectored exception handler if being debugged.
    if(IsDebuggerPresent()) return;

    if (s_first_run)
    {
        // First, try loading from the directory that the app resides in.
        std::string local_dll_name = gDirUtilp->findFile("dbghelp.dll", gDirUtilp->getWorkingDir(), gDirUtilp->getExecutableDir());

        HMODULE hDll = NULL;
        hDll = LoadLibraryA(local_dll_name.c_str());
        if (!hDll)
        {
            hDll = LoadLibrary(L"dbghelp.dll");
        }

        if (!hDll)
        {
            LL_WARNS("AppInit") << "Couldn't find dbghelp.dll!" << LL_ENDL;
        }
        else
        {
            f_mdwp = (MINIDUMPWRITEDUMP) GetProcAddress(hDll, "MiniDumpWriteDump");

            if (!f_mdwp)
            {
                FreeLibrary(hDll);
                hDll = NULL;
            }
        }

        gEmergencyMemoryReserve.reserve();

        s_first_run = false;

        // Add this exeption hanlder to save windows style minidump.
        AddVectoredExceptionHandler(0, &vectoredHandler);
    }
}

void LLWinDebug::cleanupSingleton()
{
    gEmergencyMemoryReserve.release();
}

void LLWinDebug::writeDumpToFile(MINIDUMP_TYPE type, MINIDUMP_EXCEPTION_INFORMATION *ExInfop, const std::string& filename)
{
    // Temporary fix to switch out the code that writes the DMP file.
    // Fix coming that doesn't write a mini dump file for regular C++ exceptions.
    const bool enable_write_dump_file = false;
    if ( enable_write_dump_file )
    {
        if(f_mdwp == NULL || gDirUtilp == NULL)
        {
            return;
        }
        else
        {
            std::string dump_path = gDirUtilp->getExpandedFilename(LL_PATH_LOGS, filename);

            HANDLE hFile = CreateFileA(dump_path.c_str(),
                                        GENERIC_WRITE,
                                        FILE_SHARE_WRITE,
                                        NULL,
                                        CREATE_ALWAYS,
                                        FILE_ATTRIBUTE_NORMAL,
                                        NULL);

            if (hFile != INVALID_HANDLE_VALUE)
            {
                // Write the dump, ignoring the return value
                f_mdwp(GetCurrentProcess(),
                        GetCurrentProcessId(),
                        hFile,
                        type,
                        ExInfop,
                        NULL,
                        NULL);

                CloseHandle(hFile);
            }

        }
    }
}

// static
void LLWinDebug::generateMinidump(struct _EXCEPTION_POINTERS *exception_infop)
{
    std::string dump_path = gDirUtilp->getExpandedFilename(LL_PATH_LOGS,
                                                "SecondLifeException");
    if (exception_infop)
    {
        // Since there is exception info... Release the hounds.
        gEmergencyMemoryReserve.release();

        _MINIDUMP_EXCEPTION_INFORMATION ExInfo;

        ExInfo.ThreadId = ::GetCurrentThreadId();
        ExInfo.ExceptionPointers = exception_infop;
        ExInfo.ClientPointers = NULL;
        writeDumpToFile((MINIDUMP_TYPE)(MiniDumpWithDataSegs | MiniDumpWithIndirectlyReferencedMemory), &ExInfo, "SecondLife.dmp");
    }
}