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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#include "peutils.h"
#include <utils/winutils.h>
#include <QtCore/QStringList>
#include <QtCore/QDebug>
#include <climits>
#include <windows.h>
using Utils::winErrorMessage;
// Create a pointer from base and offset when rummaging around in
// a memory mapped file
template <class Ptr>
inline Ptr *makePtr(void *base, ptrdiff_t offset)
{
return reinterpret_cast<Ptr*>(static_cast<char*>(base) + offset);
}
// CodeView header
struct CV_HEADER
{
DWORD CvSignature; // NBxx
LONG Offset; // Always 0 for NB10
};
// CodeView NB10 debug information of a PDB 2.00 file (VS 6)
struct CV_INFO_PDB20
{
CV_HEADER Header;
DWORD Signature;
DWORD Age;
BYTE PdbFileName[1];
};
// CodeView RSDS debug information of a PDB 7.00 file
struct CV_INFO_PDB70
{
DWORD CvSignature;
GUID Signature;
DWORD Age;
BYTE PdbFileName[1];
};
// Retrieve the NT image header of an executable via the legacy DOS header.
static IMAGE_NT_HEADERS *getNtHeader(void *fileMemory, QString *errorMessage)
{
IMAGE_DOS_HEADER *dosHeader = static_cast<PIMAGE_DOS_HEADER>(fileMemory);
// Check DOS header consistency
if (IsBadReadPtr(dosHeader, sizeof(IMAGE_DOS_HEADER))
|| dosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
*errorMessage = QString::fromLatin1("DOS header check failed.");
return 0;
}
// Retrieve NT header
IMAGE_NT_HEADERS *ntHeaders = makePtr<IMAGE_NT_HEADERS>(dosHeader, dosHeader->e_lfanew);
// check NT header consistency
if (IsBadReadPtr(ntHeaders, sizeof(ntHeaders->Signature))
|| ntHeaders->Signature != IMAGE_NT_SIGNATURE
|| IsBadReadPtr(&ntHeaders->FileHeader, sizeof(IMAGE_FILE_HEADER))) {
*errorMessage = QString::fromLatin1("NT header check failed.");
return 0;
}
// Check magic
const WORD magic = ntHeaders->OptionalHeader.Magic;
#ifdef __GNUC__ // MinGW does not have complete 64bit definitions.
if (magic != 0x10b) {
*errorMessage = QString::fromLatin1("NT header check failed; magic %1 is not that of a 32-bit executable.").
arg(magic);
return 0;
}
#else
if (magic != IMAGE_NT_OPTIONAL_HDR32_MAGIC && magic != IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
*errorMessage = QString::fromLatin1("NT header check failed; magic %1 is none of %2, %3.").
arg(magic).arg(IMAGE_NT_OPTIONAL_HDR32_MAGIC).arg(IMAGE_NT_OPTIONAL_HDR64_MAGIC);
return 0;
}
#endif
// Check section headers
IMAGE_SECTION_HEADER *sectionHeaders = IMAGE_FIRST_SECTION(ntHeaders);
if (IsBadReadPtr(sectionHeaders, ntHeaders->FileHeader.NumberOfSections * sizeof(IMAGE_SECTION_HEADER))) {
*errorMessage = QString::fromLatin1("NT header section header check failed.");
return 0;
}
return ntHeaders;
}
// Find the COFF section an RVA belongs to and convert to file offset
static bool getFileOffsetFromRVA(IMAGE_NT_HEADERS *ntHeaders, DWORD rva, DWORD* fileOffset)
{
IMAGE_SECTION_HEADER *sectionHeader = IMAGE_FIRST_SECTION(ntHeaders);
for (int i = 0; i < ntHeaders->FileHeader.NumberOfSections; i++, sectionHeader++) {
const DWORD sectionSize = sectionHeader->Misc.VirtualSize ?
sectionHeader->Misc.VirtualSize : sectionHeader->SizeOfRawData;
if ((rva >= sectionHeader->VirtualAddress) && (rva < sectionHeader->VirtualAddress + sectionSize)) {
const DWORD diff = sectionHeader->VirtualAddress - sectionHeader->PointerToRawData;
*fileOffset = rva - diff;
return true;
}
}
return false;
}
// Retrieve debug directory and number of entries
static bool getDebugDirectory(IMAGE_NT_HEADERS *ntHeaders, void *fileMemory,
IMAGE_DEBUG_DIRECTORY **debugDir, int *count, QString *errorMessage)
{
DWORD debugDirRva = 0;
DWORD debugDirSize;
*debugDir = 0;
*count = 0;
#ifdef __GNUC__ // MinGW does not have complete 64bit definitions.
typedef IMAGE_OPTIONAL_HEADER IMAGE_OPTIONAL_HEADER32;
#else
// Find the virtual address
const bool is64Bit = ntHeaders->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC;
if (is64Bit) {
IMAGE_OPTIONAL_HEADER64 *optionalHeader64 = reinterpret_cast<IMAGE_OPTIONAL_HEADER64*>(&(ntHeaders->OptionalHeader));
debugDirRva = optionalHeader64->DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress;
debugDirSize = optionalHeader64->DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG].Size;
} else {
#endif
IMAGE_OPTIONAL_HEADER32 *optionalHeader32 = reinterpret_cast<IMAGE_OPTIONAL_HEADER32*>(&(ntHeaders->OptionalHeader));
debugDirRva = optionalHeader32->DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress;
debugDirSize = optionalHeader32->DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG].Size;
#ifndef __GNUC__
}
#endif
// Empty. This is the case for MinGW binaries
if (debugDirSize == 0)
return true;
// Look up in file
DWORD debugDirOffset;
if (!getFileOffsetFromRVA(ntHeaders, debugDirRva, &debugDirOffset)) {
*errorMessage = QString::fromLatin1("Unable to locate debug dir RVA %1/%2.").arg(debugDirRva).arg(debugDirSize);
return false;
}
*debugDir = makePtr<IMAGE_DEBUG_DIRECTORY>(fileMemory, debugDirOffset);
// Check
if (IsBadReadPtr(*debugDir, debugDirSize) || debugDirSize < sizeof(IMAGE_DEBUG_DIRECTORY)) {
*errorMessage = QString::fromLatin1("Debug directory corrupted.");
return 0;
}
*count = debugDirSize / sizeof(IMAGE_DEBUG_DIRECTORY);
return debugDir;
}
// Return the PDB file of a Code View debug section
static QString getPDBFileOfCodeViewSection(void *debugInfo, DWORD size)
{
static const DWORD CV_SIGNATURE_NB10 = 0x3031424e; // '01BN';
static const DWORD CV_SIGNATURE_RSDS = 0x53445352; // 'SDSR';
if (IsBadReadPtr(debugInfo, size) || size < sizeof(DWORD))
return QString();
const DWORD cvSignature = *static_cast<DWORD*>(debugInfo);
if (cvSignature == CV_SIGNATURE_NB10) {
CV_INFO_PDB20* cvInfo = static_cast<CV_INFO_PDB20*>(debugInfo);
if (IsBadReadPtr(debugInfo, sizeof(CV_INFO_PDB20)))
return QString();
CHAR* pdbFileName = reinterpret_cast<CHAR*>(cvInfo->PdbFileName);
if (IsBadStringPtrA(pdbFileName, UINT_MAX))
return QString();
return QString::fromLocal8Bit(pdbFileName);
}
if (cvSignature == CV_SIGNATURE_RSDS) {
CV_INFO_PDB70* cvInfo = static_cast<CV_INFO_PDB70*>(debugInfo);
if (IsBadReadPtr(debugInfo, sizeof(CV_INFO_PDB70)))
return QString();
CHAR* pdbFileName = reinterpret_cast<CHAR*>(cvInfo->PdbFileName);
if (IsBadStringPtrA(pdbFileName, UINT_MAX))
return QString();
return QString::fromLocal8Bit(pdbFileName);
}
return QString();
}
// Collect all PDB files of all debug sections
static void collectPDBfiles(void *fileMemory, IMAGE_DEBUG_DIRECTORY *directoryBase, int count, QStringList *pdbFiles)
{
for (int i = 0; i < count; i++, directoryBase++)
if (directoryBase->Type == IMAGE_DEBUG_TYPE_CODEVIEW) {
const QString pdb = getPDBFileOfCodeViewSection(static_cast<char*>(fileMemory) + directoryBase->PointerToRawData, directoryBase->SizeOfData);
if (!pdb.isEmpty())
pdbFiles->push_back(pdb);
}
}
namespace Debugger {
namespace Internal {
bool getPDBFiles(const QString &peExecutableFileName, QStringList *rc, QString *errorMessage)
{
HANDLE hFile = NULL;
HANDLE hFileMap = NULL;
void *fileMemory = 0;
bool success = false;
rc->clear();
do {
// Create a memory mapping of the file
hFile = CreateFile(reinterpret_cast<const WCHAR*>(peExecutableFileName.utf16()), GENERIC_READ, FILE_SHARE_READ, NULL,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile == INVALID_HANDLE_VALUE || hFile == NULL) {
*errorMessage = QString::fromLatin1("Cannot open '%1': %2").arg(peExecutableFileName, winErrorMessage(GetLastError()));
break;
}
hFileMap = CreateFileMapping(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
if (hFileMap == NULL) {
*errorMessage = QString::fromLatin1("Cannot create file mapping of '%1': %2").arg(peExecutableFileName, winErrorMessage(GetLastError()));
break;
}
fileMemory = MapViewOfFile(hFileMap, FILE_MAP_READ, 0, 0, 0);
if (!fileMemory) {
*errorMessage = QString::fromLatin1("Cannot map '%1': %2").arg(peExecutableFileName, winErrorMessage(GetLastError()));
break;
}
IMAGE_NT_HEADERS *ntHeaders = getNtHeader(fileMemory, errorMessage);
if (!ntHeaders)
break;
int debugSectionCount;
IMAGE_DEBUG_DIRECTORY *debugDir;
if (!getDebugDirectory(ntHeaders, fileMemory, &debugDir, &debugSectionCount, errorMessage))
return false;
if (debugSectionCount)
collectPDBfiles(fileMemory, debugDir, debugSectionCount, rc);
success = true;
} while(false);
if (fileMemory)
UnmapViewOfFile(fileMemory);
if (hFileMap != NULL)
CloseHandle(hFileMap);
if (hFile != NULL && hFile != INVALID_HANDLE_VALUE)
CloseHandle(hFile);
return success;
}
} // namespace Internal
} // namespace Debugger
|
