cdbsymbolgroupcontext.cpp 29.5 KB
Newer Older
1
2
3
4
5
6
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, 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.
**
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
27
28
29
30
31
32
**
**************************************************************************/

#include "cdbsymbolgroupcontext.h"
#include "cdbdebugengine_p.h"
#include "watchhandler.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
33
#include "watchutils.h"
hjk's avatar
hjk committed
34

Friedemann Kleint's avatar
Friedemann Kleint committed
35
#include <QtCore/QTextStream>
36
#include <QtCore/QCoreApplication>
37
#include <QtCore/QRegExp>
Friedemann Kleint's avatar
Friedemann Kleint committed
38

Friedemann Kleint's avatar
Friedemann Kleint committed
39
enum { debug = 0 };
40
enum { debugInternalDumpers = 0 };
Friedemann Kleint's avatar
Friedemann Kleint committed
41

42
43
44
// name separator for shadowed variables
static const char iNameShadowDelimiter = '#';

45
46
47
48
static inline QString msgSymbolNotFound(const QString &s)
{
    return QString::fromLatin1("The symbol '%1' could not be found.").arg(s);
}
49

50
51
52
53
54
static inline QString msgOutOfScope()
{
    return QCoreApplication::translate("SymbolGroup", "Out of scope");
}

hjk's avatar
hjk committed
55
56
57
58
static inline bool isTopLevelSymbol(const DEBUG_SYMBOL_PARAMETERS &p)
{
    return p.ParentSymbol == DEBUG_ANY_ID;
}
59

Friedemann Kleint's avatar
Friedemann Kleint committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
static inline void debugSymbolFlags(unsigned long f, QTextStream &str)
{
    if (f & DEBUG_SYMBOL_EXPANDED)
        str << "DEBUG_SYMBOL_EXPANDED";
    if (f & DEBUG_SYMBOL_READ_ONLY)
        str << "|DEBUG_SYMBOL_READ_ONLY";
    if (f & DEBUG_SYMBOL_IS_ARRAY)
        str << "|DEBUG_SYMBOL_IS_ARRAY";
    if (f & DEBUG_SYMBOL_IS_FLOAT)
        str << "|DEBUG_SYMBOL_IS_FLOAT";
    if (f & DEBUG_SYMBOL_IS_ARGUMENT)
        str << "|DEBUG_SYMBOL_IS_ARGUMENT";
    if (f & DEBUG_SYMBOL_IS_LOCAL)
        str << "|DEBUG_SYMBOL_IS_LOCAL";
}

hjk's avatar
hjk committed
76
QTextStream &operator<<(QTextStream &str, const DEBUG_SYMBOL_PARAMETERS &p)
Friedemann Kleint's avatar
Friedemann Kleint committed
77
78
{
    str << " Type=" << p.TypeId << " parent=";
79
    if (isTopLevelSymbol(p)) {
Friedemann Kleint's avatar
Friedemann Kleint committed
80
81
        str << "<ROOT>";
    } else {
hjk's avatar
hjk committed
82
        str << p.ParentSymbol;
Friedemann Kleint's avatar
Friedemann Kleint committed
83
84
85
86
87
    }
    str << " Subs=" << p.SubElements << " flags=" << p.Flags << '/';
    debugSymbolFlags(p.Flags, str);
    return str;
}
88

89
90
91
92
93
94
95
96
static inline QString hexSymbolOffset(CIDebugSymbolGroup *sg, unsigned long index)
{
    ULONG64 rc = 0;
    if (FAILED(sg->GetSymbolOffset(index, &rc)))
        rc = 0;
    return QLatin1String("0x") + QString::number(rc, 16);
}

97
98
99
100
101
102
103
104
105
106
// A helper function to extract a string value from a member function of
// IDebugSymbolGroup2 taking the symbol index and a character buffer.
// Pass in the the member function as '&IDebugSymbolGroup2::GetSymbolNameWide'

typedef HRESULT  (__stdcall IDebugSymbolGroup2::*WideStringRetrievalFunction)(ULONG, PWSTR, ULONG, PULONG);

static inline QString getSymbolString(IDebugSymbolGroup2 *sg,
                                      WideStringRetrievalFunction wsf,
                                      unsigned long index)
{
107
108
109
    // Template type names can get quite long....
    enum { BufSize = 1024 };
    static WCHAR nameBuffer[BufSize + 1];
110
111
    // Name
    ULONG nameLength;
112
    const HRESULT hr = (sg->*wsf)(index, nameBuffer, BufSize, &nameLength);
113
114
    if (SUCCEEDED(hr)) {
        nameBuffer[nameLength] = 0;
115
        return QString::fromUtf16(reinterpret_cast<const ushort *>(nameBuffer));
116
117
118
119
120
    }
    return QString();
}

namespace Debugger {
hjk's avatar
hjk committed
121
namespace Internal {
122

123
124
125
126
127
128
129
130
131
132

CdbSymbolGroupRecursionContext::CdbSymbolGroupRecursionContext(CdbSymbolGroupContext *ctx,
                                                         int ido,
                                                         CIDebugDataSpaces *ds) :
    context(ctx),
    internalDumperOwner(ido),
    dataspaces(ds)
{
}

133
134
135
136
137
138
139
140
141
static inline CdbSymbolGroupContext::SymbolState getSymbolState(const DEBUG_SYMBOL_PARAMETERS &p)
{
    if (p.SubElements == 0u)
        return CdbSymbolGroupContext::LeafSymbol;
    return (p.Flags & DEBUG_SYMBOL_EXPANDED) ?
               CdbSymbolGroupContext::ExpandedSymbol :
               CdbSymbolGroupContext::CollapsedSymbol;
}

142
CdbSymbolGroupContext::CdbSymbolGroupContext(const QString &prefix,
143
144
                                             CIDebugSymbolGroup *symbolGroup,
                                             const QStringList &uninitializedVariables) :
145
146
    m_prefix(prefix),
    m_nameDelimiter(QLatin1Char('.')),
147
    m_uninitializedVariables(uninitializedVariables.toSet()),
148
149
    m_symbolGroup(symbolGroup),
    m_unnamedSymbolNumber(1)
150
{
151

152
153
154
155
156
157
158
}

CdbSymbolGroupContext::~CdbSymbolGroupContext()
{
    m_symbolGroup->Release();
}

Friedemann Kleint's avatar
Friedemann Kleint committed
159
CdbSymbolGroupContext *CdbSymbolGroupContext::create(const QString &prefix,
160
                                                     CIDebugSymbolGroup *symbolGroup,
161
                                                     const QStringList &uninitializedVariables,
Friedemann Kleint's avatar
Friedemann Kleint committed
162
163
                                                     QString *errorMessage)
{
164
    CdbSymbolGroupContext *rc = new CdbSymbolGroupContext(prefix, symbolGroup, uninitializedVariables);
Friedemann Kleint's avatar
Friedemann Kleint committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
    if (!rc->init(errorMessage)) {
        delete rc;
        return 0;
    }
    return rc;
}

bool CdbSymbolGroupContext::init(QString *errorMessage)
{
    // retrieve the root symbols
    ULONG count;
    HRESULT hr = m_symbolGroup->GetNumberSymbols(&count);
    if (FAILED(hr)) {
        *errorMessage = msgComFailed("GetNumberSymbols", hr);
        return false;
    }

182
183
184
    if (count) {
        m_symbolParameters.reserve(3u * count);
        m_symbolParameters.resize(count);
Friedemann Kleint's avatar
Friedemann Kleint committed
185

186
187
188
189
190
        hr = m_symbolGroup->GetSymbolParameters(0, count, symbolParameters());
        if (FAILED(hr)) {
            *errorMessage = QString::fromLatin1("In %1: %2 (%3 symbols)").arg(QLatin1String(Q_FUNC_INFO), msgComFailed("GetSymbolParameters", hr)).arg(count);
            return false;
        }
191
        populateINameIndexMap(m_prefix, DEBUG_ANY_ID, count);
Friedemann Kleint's avatar
Friedemann Kleint committed
192
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
193
    if (debug)
194
        qDebug() << Q_FUNC_INFO << '\n'<< toString(true);
Friedemann Kleint's avatar
Friedemann Kleint committed
195
196
197
    return true;
}

198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* Make the entries for iname->index mapping. We might encounter
 * already expanded subitems when doing it for top-level ('this'-pointers),
 * recurse in that case, (skip over expanded children).
 * Loop backwards to detect shadowed variables in the order the
/* debugger expects them:
\code
int x;             // Occurrence (1), should be reported as "x <shadowed 1>"
if (true) {
   int x = 5; (2)  // Occurrence (2), should be reported as "x"
}
\endcode
 * The order in the symbol group is (1),(2). Give them an iname of
 * <root>#<shadowed-nr>, which will be split apart for display. */

212
void CdbSymbolGroupContext::populateINameIndexMap(const QString &prefix, unsigned long parentId,
213
                                                  unsigned long end)
Friedemann Kleint's avatar
Friedemann Kleint committed
214
215
{
    const QString symbolPrefix = prefix + m_nameDelimiter;
Friedemann Kleint's avatar
Friedemann Kleint committed
216
    if (debug)
217
218
        qDebug() << Q_FUNC_INFO << '\n'<< symbolPrefix << parentId << end;
    for (unsigned long i = end - 1; ; i--) {
219
220
        const DEBUG_SYMBOL_PARAMETERS &p = m_symbolParameters.at(i);
        if (parentId == p.ParentSymbol) {
221
222
223
224
225
226
227
228
            // "__formal" occurs when someone writes "void foo(int /* x */)..."
            static const QString unnamedFormalParameter = QLatin1String("__formal");
            QString symbolName = getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolNameWide, i);
            if (symbolName == unnamedFormalParameter) {
                symbolName = QLatin1String("<unnamed");
                symbolName += QString::number(m_unnamedSymbolNumber++);
                symbolName += QLatin1Char('>');
            }
229
230
231
232
233
234
235
236
237
            // Find a unique name in case the variable is shadowed by
            // an existing one
            const QString namePrefix = symbolPrefix + symbolName;
            QString name = namePrefix;
            for (int n = 1; m_inameIndexMap.contains(name); n++) {
                name.truncate(namePrefix.size());
                name += QLatin1Char(iNameShadowDelimiter);
                name += QString::number(n);
            }
238
239
            m_inameIndexMap.insert(name, i);
            if (getSymbolState(p) == ExpandedSymbol)
240
                populateINameIndexMap(name, i, i + 1 + p.SubElements);
241
        }
242
243
        if (i == 0 || i == parentId)
            break;
Friedemann Kleint's avatar
Friedemann Kleint committed
244
245
246
    }
}

Friedemann Kleint's avatar
Friedemann Kleint committed
247
QString CdbSymbolGroupContext::toString(bool verbose) const
Friedemann Kleint's avatar
Friedemann Kleint committed
248
249
250
251
252
253
254
{
    QString rc;
    QTextStream str(&rc);
    const int count = m_symbolParameters.size();
    for (int i = 0; i < count; i++) {
        str << i << ' ';
        const DEBUG_SYMBOL_PARAMETERS &p = m_symbolParameters.at(i);
255
        if (!isTopLevelSymbol(p))
Friedemann Kleint's avatar
Friedemann Kleint committed
256
257
258
            str << "    ";
        str << getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolNameWide, i);
        if (p.Flags & DEBUG_SYMBOL_IS_LOCAL)
259
260
261
262
            str << " '" << getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolTypeNameWide, i) << '\'';
        str << " Address: " << hexSymbolOffset(m_symbolGroup, i);
        if (verbose)
            str << " '" << getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolValueTextWide, i) << '\'';
Friedemann Kleint's avatar
Friedemann Kleint committed
263
264
        str << p << '\n';
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
265
266
267
268
269
270
    if (verbose) {
        str << "NameIndexMap\n";
        NameIndexMap::const_iterator ncend = m_inameIndexMap.constEnd();
        for (NameIndexMap::const_iterator it = m_inameIndexMap.constBegin() ; it != ncend; ++it)
            str << it.key() << ' ' << it.value() << '\n';
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
271
272
273
    return rc;
}

274
275
276
277
CdbSymbolGroupContext::SymbolState CdbSymbolGroupContext::symbolState(unsigned long index) const
{
    return getSymbolState(m_symbolParameters.at(index));
}
Friedemann Kleint's avatar
Friedemann Kleint committed
278

279
CdbSymbolGroupContext::SymbolState CdbSymbolGroupContext::symbolState(const QString &prefix) const
Friedemann Kleint's avatar
Friedemann Kleint committed
280
{
281
282
    if (prefix == m_prefix) // root
        return ExpandedSymbol;
Friedemann Kleint's avatar
Friedemann Kleint committed
283
284
    unsigned long index;
    if (!lookupPrefix(prefix, &index)) {
285
        qWarning("WARNING %s: %s\n", Q_FUNC_INFO, qPrintable(msgSymbolNotFound(prefix)));
Friedemann Kleint's avatar
Friedemann Kleint committed
286
287
288
289
290
291
292
293
294
        return LeafSymbol;
    }
    return symbolState(index);
}

// Find index of a prefix
bool CdbSymbolGroupContext::lookupPrefix(const QString &prefix, unsigned long *index) const
{
    *index = 0;
295
    const NameIndexMap::const_iterator it = m_inameIndexMap.constFind(prefix);
Friedemann Kleint's avatar
Friedemann Kleint committed
296
297
298
299
    if (it == m_inameIndexMap.constEnd())
        return false;
    *index = it.value();
    return true;
Friedemann Kleint's avatar
Friedemann Kleint committed
300
301
302
303
304
305
306
}

/* Retrieve children and get the position. */
bool CdbSymbolGroupContext::getChildSymbolsPosition(const QString &prefix,
                                                    unsigned long *start,
                                                    unsigned long *parentId,
                                                    QString *errorMessage)
307
{
Friedemann Kleint's avatar
Friedemann Kleint committed
308
    if (debug)
Friedemann Kleint's avatar
Friedemann Kleint committed
309
        qDebug() << Q_FUNC_INFO << '\n'<< prefix;
310

Friedemann Kleint's avatar
Friedemann Kleint committed
311
312
313
314
315
    *start = *parentId = 0;
    // Root item?
    if (prefix == m_prefix) {
        *start = 0;
        *parentId = DEBUG_ANY_ID;
Friedemann Kleint's avatar
Friedemann Kleint committed
316
        if (debug)
317
            qDebug() << '<' << prefix << "at" << *start;
Friedemann Kleint's avatar
Friedemann Kleint committed
318
319
320
321
322
323
324
        return true;
    }
    // Get parent index, make sure it is expanded
    NameIndexMap::const_iterator nit = m_inameIndexMap.constFind(prefix);
    if (nit == m_inameIndexMap.constEnd()) {
        *errorMessage = QString::fromLatin1("'%1' not found.").arg(prefix);
        return false;
325
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
326
327
328
329
    *parentId = nit.value();
    *start = nit.value() + 1;
    if (!expandSymbol(prefix, *parentId, errorMessage))
        return false;
Friedemann Kleint's avatar
Friedemann Kleint committed
330
    if (debug)
331
        qDebug() << '<' << prefix << "at" << *start;
Friedemann Kleint's avatar
Friedemann Kleint committed
332
    return true;
333
334
}

335
336
337
338
339
static inline QString msgExpandFailed(const QString &prefix, unsigned long index, const QString &why)
{
    return QString::fromLatin1("Unable to expand '%1' %2: %3").arg(prefix).arg(index).arg(why);
}

Friedemann Kleint's avatar
Friedemann Kleint committed
340
341
// Expand a symbol using the symbol group interface.
bool CdbSymbolGroupContext::expandSymbol(const QString &prefix, unsigned long index, QString *errorMessage)
342
{
Friedemann Kleint's avatar
Friedemann Kleint committed
343
    if (debug)
344
        qDebug() << '>' << Q_FUNC_INFO << '\n' << prefix << index;
345

346
347
348
349
350
    switch (symbolState(index)) {
    case LeafSymbol:
        *errorMessage = QString::fromLatin1("Attempt to expand leaf node '%1' %2!").arg(prefix).arg(index);
        return false;
    case ExpandedSymbol:
Friedemann Kleint's avatar
Friedemann Kleint committed
351
        return true;
352
353
354
    case CollapsedSymbol:
        break;
    }
355

Friedemann Kleint's avatar
Friedemann Kleint committed
356
357
    HRESULT hr = m_symbolGroup->ExpandSymbol(index, TRUE);
    if (FAILED(hr)) {
358
        *errorMessage = msgExpandFailed(prefix, index, msgComFailed("ExpandSymbol", hr));
Friedemann Kleint's avatar
Friedemann Kleint committed
359
360
361
362
363
364
365
        return false;
    }
    // Hopefully, this will never fail, else data structure will be foobar.
    const ULONG oldSize = m_symbolParameters.size();
    ULONG newSize;
    hr = m_symbolGroup->GetNumberSymbols(&newSize);
    if (FAILED(hr)) {
366
        *errorMessage = msgExpandFailed(prefix, index, msgComFailed("GetNumberSymbols", hr));
Friedemann Kleint's avatar
Friedemann Kleint committed
367
368
        return false;
    }
369

Friedemann Kleint's avatar
Friedemann Kleint committed
370
371
372
    // Retrieve the new parameter structs which will be inserted
    // after the parents, offsetting consecutive indexes.
    m_symbolParameters.resize(newSize);
373

Friedemann Kleint's avatar
Friedemann Kleint committed
374
375
    hr = m_symbolGroup->GetSymbolParameters(0, newSize, symbolParameters());
    if (FAILED(hr)) {
376
        *errorMessage = msgExpandFailed(prefix, index, msgComFailed("GetSymbolParameters", hr));
Friedemann Kleint's avatar
Friedemann Kleint committed
377
        return false;
378
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
379
380
381
382
383
384
385
386
    // The new symbols are inserted after the parent symbol.
    // We need to correct the following values in the name->index map
    const unsigned long newSymbolCount = newSize - oldSize;
    const NameIndexMap::iterator nend = m_inameIndexMap.end();
    for (NameIndexMap::iterator it = m_inameIndexMap.begin(); it != nend; ++it)
        if (it.value() > index)
            it.value() += newSymbolCount;
    // insert the new symbols
387
    populateINameIndexMap(prefix, index, index + 1 + newSymbolCount);
Friedemann Kleint's avatar
Friedemann Kleint committed
388
    if (debug > 1)
389
        qDebug() << '<' << Q_FUNC_INFO << '\n' << prefix << index << '\n' << toString();
Friedemann Kleint's avatar
Friedemann Kleint committed
390
    return true;
391
392
393
394
395
}

void CdbSymbolGroupContext::clear()
{
    m_symbolParameters.clear();
Friedemann Kleint's avatar
Friedemann Kleint committed
396
397
398
    m_inameIndexMap.clear();
}

399
QString CdbSymbolGroupContext::symbolINameAt(unsigned long index) const
400
{
401
402
    return m_inameIndexMap.key(index);
}
403

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
// Return hexadecimal pointer value from a CDB pointer value
// which look like "0x000032a" or "0x00000000`0250124a" on 64-bit systems.
static bool inline getPointerValue(QString stringValue, quint64 *value)
{
    *value = 0;
    if (!stringValue.startsWith(QLatin1String("0x")))
        return false;
    stringValue.remove(0, 2);
    // Remove 64bit separator
    if (stringValue.size() > 8 && stringValue.at(8) == QLatin1Char('`'))
        stringValue.remove(8, 1);
    bool ok;
    *value = stringValue.toULongLong(&ok, 16);
    return ok;
}

// check for "0x000", "0x000 class X" or its 64-bit equivalents.
421
422
423
424
static inline bool isNullPointer(const WatchData &wd)
{
    if (!isPointerType(wd.type))
        return false;
425
426
427
428
429
430
    QString stringValue = wd.value;
    const int blankPos = stringValue.indexOf(QLatin1Char(' '));
    if (blankPos != -1)
        stringValue.truncate(blankPos);
    quint64 value;
    return getPointerValue(stringValue, &value) && value == 0u;
431
432
}

433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
// Fix a symbol group value. It is set to the class type for
// expandable classes (type="class std::foo<..>[*]",
// value="std::foo<...>[*]". This is not desired
// as it widens the value column for complex std::template types.
// Remove the inner template type.

static inline QString removeInnerTemplateType(QString value)
{
    const int firstBracketPos = value.indexOf(QLatin1Char('<'));
    const int lastBracketPos = firstBracketPos != -1 ? value.lastIndexOf(QLatin1Char('>')) : -1;
    if (lastBracketPos != -1)
        value.replace(firstBracketPos + 1, lastBracketPos - firstBracketPos -1, QLatin1String("..."));
    return value;
}

static inline QString fixValue(const QString &value)
{
    if (value.size() < 20 || value.endsWith(QLatin1Char('"')))
        return value;
    return removeInnerTemplateType(value);
}

455
WatchData CdbSymbolGroupContext::watchDataAt(unsigned long index) const
456
{
457
    WatchData wd;
458
    wd.iname = symbolINameAt(index);
459
    wd.exp = wd.iname;
460
461
    // Determine name from iname and format shadowed variables correctly
    // as "<shadowed X>, see populateINameIndexMap().
462
    const int lastDelimiterPos = wd.iname.lastIndexOf(m_nameDelimiter);
463
464
465
466
467
468
469
    QString name = lastDelimiterPos == -1 ? wd.iname : wd.iname.mid(lastDelimiterPos + 1);
    int shadowedNumber = 0;
    const int shadowedPos = name.lastIndexOf(QLatin1Char(iNameShadowDelimiter));
    if (shadowedPos != -1) {
        shadowedNumber = name.mid(shadowedPos + 1).toInt();
        name.truncate(shadowedPos);
    }
470
    // For class hierarchies, we get sometimes complicated std::template types here.
471
472
473
    // (std::map extends std::tree<>... Remove them for display only.
    const QString fullShadowedName = WatchData::shadowedName(name, shadowedNumber);
    wd.name = WatchData::shadowedName(removeInnerTemplateType(name), shadowedNumber);
474
    wd.addr = hexSymbolOffset(m_symbolGroup, index);
475
476
477
478
479
480
481
482
    const QString type = getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolTypeNameWide, index);    
    wd.setType(type);    
    // Check for unitialized variables at level 0 only.
    const DEBUG_SYMBOL_PARAMETERS &p = m_symbolParameters.at(index);
    if (p.ParentSymbol == DEBUG_ANY_ID && m_uninitializedVariables.contains(fullShadowedName)) {
        wd.setError(WatchData::msgNotInScope());
        return wd;
    }
483
484
    const QString value = getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolValueTextWide, index);
    wd.setValue(fixValue(value));
485
    wd.setChildrenNeeded(); // compensate side effects of above setters
Friedemann Kleint's avatar
Friedemann Kleint committed
486
487
    // Figure out children. The SubElement is only a guess unless the symbol,
    // is expanded, so, we leave this as a guess for later updates.
488
    // If the symbol has children (expanded or not), we leave the 'Children' flag
489
490
    // in 'needed' state. Suppress 0-pointers right ("0x000 class X")
    // here as they only lead to children with memory access errors.
491
    const bool hasChildren = p.SubElements && !isNullPointer(wd);
492
    wd.setHasChildren(hasChildren);
Friedemann Kleint's avatar
Friedemann Kleint committed
493
    if (debug > 1)
494
        qDebug() << Q_FUNC_INFO << index << '\n' << wd.toString();
Friedemann Kleint's avatar
Friedemann Kleint committed
495
496
497
    return wd;
}

498
499
WatchData CdbSymbolGroupContext::dumpSymbolAt(CIDebugDataSpaces *ds, unsigned long index)
{
500
    WatchData rc = watchDataAt(index);
501
502
503
504
    dump(ds, &rc);
    return rc;
}

505
506
507
508
509
510
511
512
513
514
515
bool CdbSymbolGroupContext::assignValue(const QString &iname, const QString &value,
                                        QString *newValue, QString *errorMessage)
{
    if (debugCDB)
        qDebug() << Q_FUNC_INFO << '\n' << iname << value;
    const NameIndexMap::const_iterator it = m_inameIndexMap.constFind(iname);
    if (it == m_inameIndexMap.constEnd()) {
        *errorMessage = msgSymbolNotFound(iname);
        return false;
    }
    const unsigned long  index = it.value();
516
    const HRESULT hr = m_symbolGroup->WriteSymbolWide(index, reinterpret_cast<PCWSTR>(value.utf16()));
517
518
519
520
521
522
523
524
525
526
    if (FAILED(hr)) {
        *errorMessage = QString::fromLatin1("Unable to assign '%1' to '%2': %3").
                        arg(value, iname, msgComFailed("WriteSymbolWide", hr));
        return false;
    }
    if (newValue)
        *newValue = getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolValueTextWide, index);
    return true;
}

Friedemann Kleint's avatar
Friedemann Kleint committed
527
528
// format an array of integers as "0x323, 0x2322, ..."
template <class Integer>
529
static QString formatArrayHelper(const Integer *array, int size, int base = 10)
Friedemann Kleint's avatar
Friedemann Kleint committed
530
531
532
{
    QString rc;
    const QString hexPrefix = QLatin1String("0x");
hjk's avatar
hjk committed
533
    const QString separator = QLatin1String(", ");
534
    const bool hex = base == 16;
Friedemann Kleint's avatar
Friedemann Kleint committed
535
536
537
    for (int i = 0; i < size; i++) {
        if (i)
            rc += separator;
538
539
540
        if (hex)
            rc += hexPrefix;
        rc += QString::number(array[i], base);
Friedemann Kleint's avatar
Friedemann Kleint committed
541
542
543
544
545
546
    }
    return rc;
}

QString CdbSymbolGroupContext::hexFormatArray(const unsigned short *array, int size)
{
547
    return formatArrayHelper(array, size, 16);
Friedemann Kleint's avatar
Friedemann Kleint committed
548
549
}

550
551
552
553
554
555
556
557
558
559
560
561
// Helper to format an integer with
// a hex prefix in case base = 16
template <class Integer>
        inline QString formatInteger(Integer value, int base)
{
    QString rc;
    if (base == 16)
        rc = QLatin1String("0x");
    rc += QString::number(value, base);
    return rc;
}

562
QString CdbSymbolGroupContext::debugValueToString(const DEBUG_VALUE &dv, CIDebugControl *ctl,
563
564
                                                  QString *qType,
                                                  int integerBase)
Friedemann Kleint's avatar
Friedemann Kleint committed
565
566
567
{
    switch (dv.Type) {
    case DEBUG_VALUE_INT8:
568
569
570
        if (qType)
            *qType = QLatin1String("char");
        return formatInteger(dv.I8, integerBase);
Friedemann Kleint's avatar
Friedemann Kleint committed
571
    case DEBUG_VALUE_INT16:
572
573
574
        if (qType)
            *qType = QLatin1String("short");
        return formatInteger(static_cast<short>(dv.I16), integerBase);
Friedemann Kleint's avatar
Friedemann Kleint committed
575
    case DEBUG_VALUE_INT32:
576
577
578
        if (qType)
            *qType = QLatin1String("long");
        return formatInteger(static_cast<long>(dv.I32), integerBase);
Friedemann Kleint's avatar
Friedemann Kleint committed
579
    case DEBUG_VALUE_INT64:
580
581
582
        if (qType)
            *qType = QLatin1String("long long");
        return formatInteger(static_cast<long long>(dv.I64), integerBase);
Friedemann Kleint's avatar
Friedemann Kleint committed
583
    case DEBUG_VALUE_FLOAT32:
584
585
        if (qType)
            *qType = QLatin1String("float");
Friedemann Kleint's avatar
Friedemann Kleint committed
586
587
        return QString::number(dv.F32);
    case DEBUG_VALUE_FLOAT64:
588
589
        if (qType)
            *qType = QLatin1String("double");
Friedemann Kleint's avatar
Friedemann Kleint committed
590
591
592
593
594
595
596
        return QString::number(dv.F64);
    case DEBUG_VALUE_FLOAT80:
    case DEBUG_VALUE_FLOAT128: { // Convert to double
            DEBUG_VALUE doubleValue;
            double d = 0.0;
            if (SUCCEEDED(ctl->CoerceValue(const_cast<DEBUG_VALUE*>(&dv), DEBUG_VALUE_FLOAT64, &doubleValue)))
                d = dv.F64;
597
598
            if (qType)
                *qType = QLatin1String(dv.Type == DEBUG_VALUE_FLOAT80 ? "80bit-float" : "128bit-float");
Friedemann Kleint's avatar
Friedemann Kleint committed
599
600
601
            return QString::number(d);
        }
    case DEBUG_VALUE_VECTOR64: {
602
603
604
605
606
607
608
609
            if (qType)
                *qType = QLatin1String("64bit-vector");
            QString rc = QLatin1String("bytes: ");
            rc += formatArrayHelper(dv.VI8, 8, integerBase);
            rc += QLatin1String(" long: ");
            rc += formatArrayHelper(dv.VI32, 2, integerBase);
            return rc;
        }
Friedemann Kleint's avatar
Friedemann Kleint committed
610
    case DEBUG_VALUE_VECTOR128: {
611
612
613
614
615
616
617
618
            if (qType)
                *qType = QLatin1String("128bit-vector");
            QString rc = QLatin1String("bytes: ");
            rc += formatArrayHelper(dv.VI8, 16, integerBase);
            rc += QLatin1String(" long long: ");
            rc += formatArrayHelper(dv.VI64, 2, integerBase);
            return rc;
        }
Friedemann Kleint's avatar
Friedemann Kleint committed
619
    }
620
621
622
    if (qType)
        *qType = QString::fromLatin1("Unknown type #%1:").arg(dv.Type);
    return formatArrayHelper(dv.RawBytes, 24, integerBase);
Friedemann Kleint's avatar
Friedemann Kleint committed
623
624
}

625
bool CdbSymbolGroupContext::debugValueToInteger(const DEBUG_VALUE &dv, qint64 *value)
Friedemann Kleint's avatar
Friedemann Kleint committed
626
{
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
    *value = 0;
    switch (dv.Type) {
    case DEBUG_VALUE_INT8:
        *value = dv.I8;
        return true;
    case DEBUG_VALUE_INT16:
        *value = static_cast<short>(dv.I16);
        return true;
    case DEBUG_VALUE_INT32:
        *value = static_cast<long>(dv.I32);
        return true;
    case DEBUG_VALUE_INT64:
        *value = static_cast<long long>(dv.I64);
        return true;
    default:
        break;
Friedemann Kleint's avatar
Friedemann Kleint committed
643
    }
644
    return false;
645
646
}

647
648
649
650
651
652
653
654
655
656
/* The special type dumpers have an integer return code meaning:
 *  0:  ok
 *  1:  Dereferencing or retrieving memory failed, this is out of scope,
 *      do not try to query further.
 * > 1: A structural error was encountered, that is, the implementation
 *      of the class changed (Qt or say, a different STL implementation).
 *      Visibly warn about it.
 * To add further types, have a look at the toString() output of the
 * symbol group. */

Friedemann Kleint's avatar
Friedemann Kleint committed
657
static QString msgStructuralError(const QString &name, const QString &type, int code)
658
{
Friedemann Kleint's avatar
Friedemann Kleint committed
659
    return QString::fromLatin1("Warning: Internal dumper for '%1' (%2) failed with %3.").arg(name, type).arg(code);
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
}

static inline bool isStdStringOrPointer(const QString &type)
{
#define STD_WSTRING "std::basic_string<unsigned short,std::char_traits<unsigned short>,std::allocator<unsigned short> >"
#define STD_STRING "std::basic_string<char,std::char_traits<char>,std::allocator<char> >"
    return type.endsWith(QLatin1String(STD_STRING))
            || type.endsWith(QLatin1String(STD_STRING" *"))
            || type.endsWith(QLatin1String(STD_WSTRING))
            || type.endsWith(QLatin1String(STD_WSTRING" *"));
#undef STD_WSTRING
#undef STD_STRING
}

CdbSymbolGroupContext::DumperResult
        CdbSymbolGroupContext::dump(CIDebugDataSpaces *ds, WatchData *wd)
{
    DumperResult rc = DumperNotHandled;
    do {
        // Is this a previously detected Null-Pointer?
        if (wd->isHasChildrenKnown() && !wd->hasChildren)
            break;
        // QString
        if (wd->type.endsWith(QLatin1String("QString")) || wd->type.endsWith(QLatin1String("QString *"))) {
            const int drc = dumpQString(ds, wd);
            switch (drc) {
            case 0:
                rc = DumperOk;
                break;
            case 1:
                rc = DumperError;
                break;
            default:
Friedemann Kleint's avatar
Friedemann Kleint committed
693
                qWarning("%s\n", qPrintable(msgStructuralError(wd->iname, wd->type, drc)));
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
                rc = DumperNotHandled;
                break;
            }
        }
        // StdString
        if (isStdStringOrPointer(wd->type)) {
            const int drc = dumpStdString(wd);
            switch (drc) {
            case 0:
                rc = DumperOk;
                break;
            case 1:
                rc = DumperError;
                break;
            default:
Friedemann Kleint's avatar
Friedemann Kleint committed
709
                qWarning("%s\n", qPrintable(msgStructuralError(wd->iname, wd->type, drc)));
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
                rc = DumperNotHandled;
                break;
            }

        }
    } while (false);
    if (debugInternalDumpers)
        qDebug() << "CdbSymbolGroupContext::dump" << rc << wd->toString();
    return rc;
}

// Get integer value of symbol group
static inline bool getIntValue(CIDebugSymbolGroup *sg, int index, int *value)
{
    const QString valueS = getSymbolString(sg, &IDebugSymbolGroup2::GetSymbolValueTextWide, index);
    bool ok;
    *value = valueS.toInt(&ok);
    return ok;
}

// Get pointer value of symbol group ("0xAAB")
731
// Note that this is on "00000000`0250124a" on 64bit systems.
732
733
static inline bool getPointerValue(CIDebugSymbolGroup *sg, int index, quint64 *value)
{
734
735
    const QString stringValue = getSymbolString(sg, &IDebugSymbolGroup2::GetSymbolValueTextWide, index);
    return getPointerValue(stringValue, value);
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
}

int CdbSymbolGroupContext::dumpQString(CIDebugDataSpaces *ds, WatchData *wd)
{
    const int maxLength = 40;
    QString errorMessage;
    unsigned long stringIndex;
    if (!lookupPrefix(wd->iname, &stringIndex))
        return 1;

    // Expand string and it's "d" (step over 'static null')
    if (!expandSymbol(wd->iname, stringIndex, &errorMessage))
        return 2;
    const unsigned long dIndex = stringIndex + 4;
    if (!expandSymbol(wd->iname, dIndex, &errorMessage))
        return 3;
    const unsigned long sizeIndex = dIndex + 3;
    const unsigned long arrayIndex = dIndex + 4;
    // Get size and pointer
    int size;
    if (!getIntValue(m_symbolGroup, sizeIndex, &size))
        return 4;
    quint64 array;
    if (!getPointerValue(m_symbolGroup, arrayIndex, &array))
        return 5;
    // Fetch
    const bool truncated = size > maxLength;
    if (truncated)
        size = maxLength;
    const QChar doubleQuote = QLatin1Char('"');
766
767
768
    QString value;
    if (size > 0) {
        value += doubleQuote;
769
770
771
772
773
774
775
776
777
778
779
780
781
        // Should this ever be a remote debugger, need to check byte order.
        unsigned short *buf =  new unsigned short[size + 1];
        unsigned long bytesRead;
        const HRESULT hr = ds->ReadVirtual(array, buf, size * sizeof(unsigned short), &bytesRead);
        if (FAILED(hr)) {
            delete [] buf;
            return 1;
        }
        buf[bytesRead / sizeof(unsigned short)] = 0;
        value += QString::fromUtf16(buf);
        delete [] buf;
        if (truncated)
            value += QLatin1String("...");
782
783
784
785
786
        value += doubleQuote;
    } else if (size == 0) {
        value = QString(doubleQuote) + doubleQuote;
    } else {
        value = "Invalid QString";
787
    }
788

789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
    wd->setValue(value);
    wd->setHasChildren(false);
    return 0;
}

int CdbSymbolGroupContext::dumpStdString(WatchData *wd)
{
    const int maxLength = 40;
    QString errorMessage;
    unsigned long stringIndex;
    if (!lookupPrefix(wd->iname, &stringIndex))
        return 1;

    // Expand string ->string_val->_bx.
    if (!expandSymbol(wd->iname, stringIndex, &errorMessage))
        return 1;
    const unsigned long bxIndex = stringIndex + 3;
    if (!expandSymbol(wd->iname, bxIndex, &errorMessage))
        return 2;
    // Check if size is something sane
    const int sizeIndex = stringIndex + 6;
    int size;
    if (!getIntValue(m_symbolGroup, sizeIndex, &size))
        return 3;
    if (size < 0)
        return 1;
    // Just copy over the value of the buf[]-array, which should be the string
    const QChar doubleQuote = QLatin1Char('"');
    const int bufIndex = stringIndex + 4;
    QString bufValue = getSymbolString(m_symbolGroup, &IDebugSymbolGroup2::GetSymbolValueTextWide, bufIndex);
    const int quotePos = bufValue.indexOf(doubleQuote);
    if (quotePos == -1)
        return 1;
    bufValue.remove(0, quotePos);
    if (bufValue.size() > maxLength) {
        bufValue.truncate(maxLength);
        bufValue += QLatin1String("...\"");
    }
    wd->setValue(bufValue);
    wd->setHasChildren(false);
    return 0;
}

hjk's avatar
hjk committed
832
833
} // namespace Internal
} // namespace Debugger