tst_dumpers.cpp 211 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Bill King's avatar
Bill King committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
Bill King's avatar
Bill King committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
Bill King's avatar
Bill King committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
Bill King's avatar
Bill King committed
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22
** 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.
Bill King's avatar
Bill King committed
23
**
hjk's avatar
hjk committed
24 25
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
Bill King's avatar
Bill King committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
Bill King's avatar
Bill King committed
29

hjk's avatar
hjk committed
30
#include "debuggerprotocol.h"
31
#include "simplifytype.h"
32 33
#include "watchdata.h"
#include "watchutils.h"
34

35
#ifdef Q_CC_MSVC
36
#include <utils/environment.h>
37 38 39
#include <utils/qtcprocess.h>
#include <utils/fileutils.h>
#include <utils/synchronousprocess.h>
40
#endif // Q_CC_MSVC
41

42
#include "temporarydir.h"
43

44
#include <QtTest>
45
#include <math.h>
46

47
#if  QT_VERSION >= 0x050000
48
#define MSKIP_SINGLE(x) do { disarm(); QSKIP(x); } while (0)
49
#else
50
#define MSKIP_SINGLE(x) do { disarm(); QSKIP(x, SkipSingle); } while (0)
51 52
#endif

53
using namespace Debugger;
hjk's avatar
hjk committed
54
using namespace Internal;
55

56
#ifdef Q_CC_MSVC
57

58
// Copied from abstractmsvctoolchain.cpp to avoid plugin dependency.
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
static bool generateEnvironmentSettings(Utils::Environment &env,
                                        const QString &batchFile,
                                        const QString &batchArgs,
                                        QMap<QString, QString> &envPairs)
{
    // Create a temporary file name for the output. Use a temporary file here
    // as I don't know another way to do this in Qt...
    // Note, can't just use a QTemporaryFile all the way through as it remains open
    // internally so it can't be streamed to later.
    QString tempOutFile;
    QTemporaryFile* pVarsTempFile = new QTemporaryFile(QDir::tempPath() + QLatin1String("/XXXXXX.txt"));
    pVarsTempFile->setAutoRemove(false);
    pVarsTempFile->open();
    pVarsTempFile->close();
    tempOutFile = pVarsTempFile->fileName();
    delete pVarsTempFile;

    // Create a batch file to create and save the env settings
    Utils::TempFileSaver saver(QDir::tempPath() + QLatin1String("/XXXXXX.bat"));

    QByteArray call = "call ";
    call += Utils::QtcProcess::quoteArg(batchFile).toLocal8Bit();
    if (!batchArgs.isEmpty()) {
        call += ' ';
        call += batchArgs.toLocal8Bit();
    }
    saver.write(call + "\r\n");

    const QByteArray redirect = "set > " + Utils::QtcProcess::quoteArg(
                                    QDir::toNativeSeparators(tempOutFile)).toLocal8Bit() + "\r\n";
    saver.write(redirect);
    if (!saver.finalize()) {
        qWarning("%s: %s", Q_FUNC_INFO, qPrintable(saver.errorString()));
        return false;
    }

    Utils::QtcProcess run;
    // As of WinSDK 7.1, there is logic preventing the path from being set
    // correctly if "ORIGINALPATH" is already set. That can cause problems
    // if Creator is launched within a session set up by setenv.cmd.
    env.unset(QLatin1String("ORIGINALPATH"));
    run.setEnvironment(env);
    const QString cmdPath = QString::fromLocal8Bit(qgetenv("COMSPEC"));
    // Windows SDK setup scripts require command line switches for environment expansion.
    QString cmdArguments = QLatin1String(" /E:ON /V:ON /c \"");
    cmdArguments += QDir::toNativeSeparators(saver.fileName());
    cmdArguments += QLatin1Char('"');
    run.setCommand(cmdPath, cmdArguments);
    run.start();

    if (!run.waitForStarted()) {
        qWarning("%s: Unable to run '%s': %s", Q_FUNC_INFO, qPrintable(batchFile),
                 qPrintable(run.errorString()));
        return false;
    }
    if (!run.waitForFinished()) {
        qWarning("%s: Timeout running '%s'", Q_FUNC_INFO, qPrintable(batchFile));
        Utils::SynchronousProcess::stopProcess(run);
        return false;
    }
    // The SDK/MSVC scripts do not return exit codes != 0. Check on stdout.
    const QByteArray stdOut = run.readAllStandardOutput();
    if (!stdOut.isEmpty() && (stdOut.contains("Unknown") || stdOut.contains("Error")))
        qWarning("%s: '%s' reports:\n%s", Q_FUNC_INFO, call.constData(), stdOut.constData());

    //
    // Now parse the file to get the environment settings
    QFile varsFile(tempOutFile);
    if (!varsFile.open(QIODevice::ReadOnly))
        return false;

    QRegExp regexp(QLatin1String("(\\w*)=(.*)"));
    while (!varsFile.atEnd()) {
        const QString line = QString::fromLocal8Bit(varsFile.readLine()).trimmed();
        if (regexp.exactMatch(line)) {
            const QString varName = regexp.cap(1);
            const QString varValue = regexp.cap(2);

            if (!varValue.isEmpty())
                envPairs.insert(varName, varValue);
        }
    }

    // Tidy up and remove the file
    varsFile.close();
    varsFile.remove();

    return true;
}

149 150 151 152 153

#ifndef CDBEXT_PATH
#define CDBEXT_PATH ""
#endif

154 155 156 157 158 159 160 161
static void setupCdb(QString *makeBinary, QProcessEnvironment *environment)
{
    QByteArray envBat = qgetenv("QTC_MSVC_ENV_BAT");
    QMap <QString, QString> envPairs;
    Utils::Environment env = Utils::Environment::systemEnvironment();
    QVERIFY(generateEnvironmentSettings(env, QString::fromLatin1(envBat), QString(), envPairs));
    for (QMap<QString,QString>::const_iterator envIt = envPairs.begin(); envIt != envPairs.end(); ++envIt)
            env.set(envIt.key(), envIt.value());
162
    const QByteArray cdbextPath = CDBEXT_PATH "\\qtcreatorcdbext64";
163
    QVERIFY(QFile::exists(QString::fromLatin1(cdbextPath + QByteArray("\\qtcreatorcdbext.dll"))));
164
    env.set(QLatin1String("_NT_DEBUGGER_EXTENSION_PATH"), QString::fromLatin1(cdbextPath));
165 166 167 168 169 170 171 172 173 174 175
    *makeBinary = env.searchInPath(QLatin1String("nmake.exe"));
    *environment = env.toProcessEnvironment();
}

#else

static void setupCdb(QString *, QProcessEnvironment *) {}

#endif // Q_CC_MSVC


176 177
static QByteArray noValue = "\001";

178 179 180 181 182 183 184 185 186 187
static QString toHex(const QString &str)
{
    QString encoded;
    foreach (const QChar c, str) {
        encoded += QString::fromLatin1("%1")
            .arg(c.unicode(), 2, 16, QLatin1Char('0'));
    }
    return encoded;
}

hjk's avatar
hjk committed
188 189
struct Context
{
hjk's avatar
hjk committed
190
    Context() : qtVersion(0), gccVersion(0) {}
hjk's avatar
hjk committed
191 192 193

    QByteArray nameSpace;
    int qtVersion;
hjk's avatar
hjk committed
194
    int gccVersion;
hjk's avatar
hjk committed
195 196
};

hjk's avatar
hjk committed
197 198
struct Name
{
hjk's avatar
hjk committed
199 200 201 202 203
    Name() : name(noValue) {}
    Name(const char *str) : name(str) {}
    Name(const QByteArray &ba) : name(ba) {}

    bool matches(const QByteArray &actualName0, const Context &context) const
hjk's avatar
hjk committed
204 205 206
    {
        QByteArray actualName = actualName0;
        QByteArray expectedName = name;
hjk's avatar
hjk committed
207
        expectedName.replace("@Q", context.nameSpace + 'Q');
hjk's avatar
hjk committed
208 209 210 211 212 213 214
        return actualName == expectedName;
    }

    QByteArray name;
};

static Name nameFromIName(const QByteArray &iname)
hjk's avatar
hjk committed
215 216
{
    int pos = iname.lastIndexOf('.');
hjk's avatar
hjk committed
217
    return Name(pos == -1 ? iname : iname.mid(pos + 1));
hjk's avatar
hjk committed
218 219 220 221 222 223 224 225
}

static QByteArray parentIName(const QByteArray &iname)
{
    int pos = iname.lastIndexOf('.');
    return pos == -1 ? QByteArray() : iname.left(pos);
}

hjk's avatar
hjk committed
226
struct ValueBase
227
{
hjk's avatar
hjk committed
228 229 230 231
    ValueBase()
      : hasPtrSuffix(false), isFloatValue(false), substituteNamespace(true),
        qtVersion(0), minimalGccVersion(0)
    {}
hjk's avatar
hjk committed
232 233

    bool hasPtrSuffix;
234
    bool isFloatValue;
235
    bool substituteNamespace;
hjk's avatar
hjk committed
236 237
    int qtVersion;
    int minimalGccVersion;
hjk's avatar
hjk committed
238 239 240 241
};

struct Value : public ValueBase
{
242 243 244 245
    Value() : value(QString::fromLatin1(noValue)) {}
    Value(const char *str) : value(QLatin1String(str)) {}
    Value(const QByteArray &ba) : value(QString::fromLatin1(ba.data(), ba.size())) {}
    Value(const QString &str) : value(str) {}
246

hjk's avatar
hjk committed
247
    bool matches(const QString &actualValue0, const Context &context) const
248
    {
249
        if (value == QString::fromLatin1(noValue))
250
            return true;
hjk's avatar
hjk committed
251 252

        if (context.qtVersion) {
hjk's avatar
hjk committed
253
            if (qtVersion == 4) {
hjk's avatar
hjk committed
254 255 256 257
                if (context.qtVersion < 0x40000 || context.qtVersion >= 0x50000) {
                    //QWARN("Qt 4 specific case skipped");
                    return true;
                }
hjk's avatar
hjk committed
258
            } else if (qtVersion == 5) {
hjk's avatar
hjk committed
259 260 261 262 263 264
                if (context.qtVersion < 0x50000 || context.qtVersion >= 0x60000) {
                    //QWARN("Qt 5 specific case skipped");
                    return true;
                }
            }
        }
hjk's avatar
hjk committed
265 266 267 268 269 270
        if (minimalGccVersion && context.gccVersion) {
            if (minimalGccVersion >= context.gccVersion) {
                //QWARN("Current GCC is too old for this test.")
                return true;
            }
        }
271 272 273
        QString actualValue = actualValue0;
        if (actualValue == QLatin1String(" "))
            actualValue.clear(); // FIXME: Remove later.
274
        QString expectedValue = value;
275 276
        if (substituteNamespace)
            expectedValue.replace(QLatin1Char('@'), QString::fromLatin1(context.nameSpace));
hjk's avatar
hjk committed
277

278
        if (hasPtrSuffix)
279 280
            return actualValue.startsWith(expectedValue + QLatin1String(" @0x"))
                || actualValue.startsWith(expectedValue + QLatin1String("@0x"));
281 282 283 284 285 286 287 288 289 290 291 292

        if (isFloatValue) {
            double f1 = fabs(expectedValue.toDouble());
            double f2 = fabs(actualValue.toDouble());
            //qDebug() << "expected float: " << qPrintable(expectedValue) << f1;
            //qDebug() << "actual   float: " << qPrintable(actualValue) << f2;
            if (f1 < f2)
                std::swap(f1, f2);
            return f1 - f2 <= 0.01 * f2;
        }


293
        return actualValue == expectedValue;
294 295
    }

hjk's avatar
hjk committed
296 297
    void setMinimalGccVersion(int version) { minimalGccVersion = version; }

298
    QString value;
299 300 301 302 303 304 305 306
};

struct Pointer : Value
{
    Pointer() { hasPtrSuffix = true; }
    Pointer(const QByteArray &value) : Value(value) { hasPtrSuffix = true; }
};

307 308 309 310 311 312
struct FloatValue : Value
{
    FloatValue() { isFloatValue = true; }
    FloatValue(const QByteArray &value) : Value(value) { isFloatValue = true; }
};

hjk's avatar
hjk committed
313 314
struct Value4 : Value
{
hjk's avatar
hjk committed
315
    Value4(const QByteArray &value) : Value(value) { qtVersion = 4; }
hjk's avatar
hjk committed
316 317 318 319
};

struct Value5 : Value
{
hjk's avatar
hjk committed
320
    Value5(const QByteArray &value) : Value(value) { qtVersion = 5; }
hjk's avatar
hjk committed
321 322
};

323 324 325 326 327
struct UnsubstitutedValue : Value
{
    UnsubstitutedValue(const QByteArray &value) : Value(value) { substituteNamespace = false; }
};

328 329
struct Type
{
330 331 332
    Type() : qtVersion(0), isPattern(false) {}
    Type(const char *str) : type(str), qtVersion(0), isPattern(false) {}
    Type(const QByteArray &ba) : type(ba), qtVersion(0), isPattern(false) {}
hjk's avatar
hjk committed
333 334

    bool matches(const QByteArray &actualType0, const Context &context) const
335
    {
336
        if (context.qtVersion) {
hjk's avatar
hjk committed
337
            if (qtVersion == 4) {
338 339 340 341
                if (context.qtVersion < 0x40000 || context.qtVersion >= 0x50000) {
                    //QWARN("Qt 4 specific case skipped");
                    return true;
                }
hjk's avatar
hjk committed
342
            } else if (qtVersion == 5) {
343 344 345 346 347 348
                if (context.qtVersion < 0x50000 || context.qtVersion >= 0x60000) {
                    //QWARN("Qt 5 specific case skipped");
                    return true;
                }
            }
        }
349
        QByteArray actualType =
350
            simplifyType(QString::fromLatin1(actualType0)).toLatin1();
351
        actualType.replace(' ', "");
hjk's avatar
hjk committed
352
        actualType.replace("const", "");
353 354
        QByteArray expectedType = type;
        expectedType.replace(' ', "");
355
        expectedType.replace("const", "");
hjk's avatar
hjk committed
356
        expectedType.replace('@', context.nameSpace);
357 358 359 360 361
        if (isPattern) {
            QString actual = QString::fromLatin1(actualType);
            QString expected = QString::fromLatin1(expectedType);
            return QRegExp(expected).exactMatch(actual);
        }
362 363 364
        return actualType == expectedType;
    }
    QByteArray type;
hjk's avatar
hjk committed
365
    int qtVersion;
366
    bool isPattern;
367 368 369 370
};

struct Type4 : Type
{
hjk's avatar
hjk committed
371
    Type4(const QByteArray &ba) : Type(ba) { qtVersion = 4; }
372 373 374 375
};

struct Type5 : Type
{
hjk's avatar
hjk committed
376
    Type5(const QByteArray &ba) : Type(ba) { qtVersion = 5; }
377 378
};

379 380 381 382 383
struct Pattern : Type
{
    Pattern(const QByteArray &ba) : Type(ba) { isPattern = true; }
};

384 385
enum DebuggerEngine
{
hjk's avatar
hjk committed
386 387 388 389 390 391 392 393 394
    GdbEngine = 0x01,
    CdbEngine = 0x02,
    LldbEngine = 0x04,

    AllEngines = GdbEngine | CdbEngine | LldbEngine,

    NoCdbEngine = AllEngines & (~CdbEngine),
    NoLldbEngine = AllEngines & (~LldbEngine),
    NoGdbEngine = AllEngines & (~GdbEngine)
395 396 397 398
};

struct CheckBase
{
hjk's avatar
hjk committed
399
    CheckBase() : enginesForCheck(AllEngines) {}
400
    mutable int enginesForCheck;
401 402 403
};

struct Check : CheckBase
404 405 406
{
    Check() {}

hjk's avatar
hjk committed
407
    Check(const QByteArray &iname, const Value &value, const Type &type)
hjk's avatar
hjk committed
408 409 410 411
        : iname(iname), expectedName(nameFromIName(iname)),
          expectedValue(value), expectedType(type)
    {}

hjk's avatar
hjk committed
412
    Check(const QByteArray &iname, const Name &name,
413
         const Value &value, const Type &type)
414 415 416 417
        : iname(iname), expectedName(name),
          expectedValue(value), expectedType(type)
    {}

418 419
    bool matchesEngine(DebuggerEngine engine) const
    {
420 421 422
        return (engine & enginesForCheck);
    }

hjk's avatar
hjk committed
423
    const Check &operator%(DebuggerEngine engine)
424
    {
hjk's avatar
hjk committed
425
        enginesForCheck = engine;
426
        return *this;
427
    }
428

429
    QByteArray iname;
hjk's avatar
hjk committed
430
    Name expectedName;
431
    Value expectedValue;
432
    Type expectedType;
433 434
};

hjk's avatar
hjk committed
435
struct CheckType : public Check
436
{
hjk's avatar
hjk committed
437
    CheckType(const QByteArray &iname, const Name &name,
438
         const Type &type)
439 440
        : Check(iname, name, noValue, type)
    {}
441

442
    CheckType(const QByteArray &iname, const Type &type)
hjk's avatar
hjk committed
443 444 445 446
        : Check(iname, noValue, type)
    {}
};

hjk's avatar
hjk committed
447
struct Profile
hjk's avatar
hjk committed
448 449 450 451
{
    Profile(const QByteArray &contents) : contents(contents) {}

    QByteArray contents;
452 453
};

hjk's avatar
hjk committed
454

hjk's avatar
hjk committed
455 456
struct Cxx11Profile : public Profile
{
457 458 459 460 461 462
    Cxx11Profile()
      : Profile("greaterThan(QT_MAJOR_VERSION,4): CONFIG += c++11\n"
                "else: QMAKE_CXXFLAGS += -std=c++0x\n")
    {}
};

463 464 465 466 467 468 469
struct BoostProfile : public Profile
{
    BoostProfile()
      : Profile("macx:INCLUDEPATH += /usr/local/include")
    {}
};

470
struct MacLibCppProfile : public Profile
471
{
472
    MacLibCppProfile()
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
      : Profile("macx {\n"
                "QMAKE_CXXFLAGS += -stdlib=libc++\n"
                "LIBS += -stdlib=libc++\n"
                "QMAKE_MACOSX_DEPLOYMENT_TARGET = 10.7\n"
                "QMAKE_IOS_DEPLOYMENT_TARGET = 10.7\n"
                "QMAKE_CFLAGS -= -mmacosx-version-min=10.6\n"
                "QMAKE_CFLAGS += -mmacosx-version-min=10.7\n"
                "QMAKE_CXXFLAGS -= -mmacosx-version-min=10.6\n"
                "QMAKE_CXXFLAGS += -mmacosx-version-min=10.7\n"
                "QMAKE_OBJECTIVE_CFLAGS -= -mmacosx-version-min=10.6\n"
                "QMAKE_OBJECTIVE_CFLAGS += -mmacosx-version-min=10.7\n"
                "QMAKE_LFLAGS -= -mmacosx-version-min=10.6\n"
                "QMAKE_LFLAGS += -mmacosx-version-min=10.7\n"
                "}")
    {}
hjk's avatar
hjk committed
488 489
};

490
struct VersionBase
491 492
{
    // Minimum and maximum are inclusive.
493
    VersionBase(int minimum = 0, int maximum = INT_MAX)
494
    {
495
        isRestricted = minimum != 0 || maximum != INT_MAX;
496 497 498
        max = maximum;
        min = minimum;
    }
499 500

    bool isRestricted;
501 502 503 504
    int min;
    int max;
};

505
struct QtVersion : VersionBase
hjk's avatar
hjk committed
506
{
507
    QtVersion(int minimum = 0, int maximum = INT_MAX)
508 509 510
        : VersionBase(minimum, maximum)
    {}
};
hjk's avatar
hjk committed
511

512 513
struct GccVersion : VersionBase
{
514
    GccVersion(int minimum = 0, int maximum = INT_MAX)
515 516 517 518
        : VersionBase(minimum, maximum)
    {}
};

519 520
struct GdbVersion : VersionBase
{
521
    GdbVersion(int minimum = 0, int maximum = INT_MAX)
522 523 524 525 526 527
        : VersionBase(minimum, maximum)
    {}
};

struct LldbVersion : VersionBase
{
528
    LldbVersion(int minimum = 0, int maximum = INT_MAX)
529 530
        : VersionBase(minimum, maximum)
    {}
hjk's avatar
hjk committed
531 532
};

533
struct ForceC {};
hjk's avatar
hjk committed
534
struct EigenProfile {};
535
struct UseDebugImage {};
536

hjk's avatar
hjk committed
537 538 539
struct CoreProfile {};
struct CorePrivateProfile {};
struct GuiProfile {};
hjk's avatar
hjk committed
540
struct NetworkProfile {};
hjk's avatar
hjk committed
541

542 543
struct BigArrayProfile {};

hjk's avatar
hjk committed
544 545
struct DataBase
{
546 547
    DataBase()
      : useQt(false), useQHash(false),
hjk's avatar
hjk committed
548
        forceC(false), engines(AllEngines),
549 550
        glibcxxDebug(false), useDebugImage(false),
        bigArray(false)
551
    {}
hjk's avatar
hjk committed
552 553

    mutable bool useQt;
554
    mutable bool useQHash;
hjk's avatar
hjk committed
555
    mutable bool forceC;
556
    mutable int engines;
557
    mutable bool glibcxxDebug;
558
    mutable bool useDebugImage;
559
    mutable bool bigArray;
560
    mutable GdbVersion neededGdbVersion;     // DEC. 70600
hjk's avatar
hjk committed
561
    mutable LldbVersion neededLldbVersion;
562 563
    mutable QtVersion neededQtVersion;       // HEX! 0x50300
    mutable GccVersion neededGccVersion;     // DEC. 40702
hjk's avatar
hjk committed
564 565 566
};

class Data : public DataBase
567
{
hjk's avatar
hjk committed
568 569
public:
    Data() {}
hjk's avatar
hjk committed
570
    Data(const QByteArray &code) : code(code) {}
571

572
    Data(const QByteArray &includes, const QByteArray &code)
hjk's avatar
hjk committed
573
        : includes(includes), code(code)
hjk's avatar
hjk committed
574
    {}
575

hjk's avatar
hjk committed
576
    const Data &operator+(const Check &check) const
577
    {
578
        checks.append(check);
579 580 581
        return *this;
    }

hjk's avatar
hjk committed
582
    const Data &operator+(const Profile &profile) const
hjk's avatar
hjk committed
583 584 585 586 587
    {
        profileExtra += profile.contents;
        return *this;
    }

hjk's avatar
hjk committed
588
    const Data &operator+(const QtVersion &qtVersion) const
589 590 591 592 593
    {
        neededQtVersion = qtVersion;
        return *this;
    }

hjk's avatar
hjk committed
594
    const Data &operator+(const GccVersion &gccVersion) const
595 596 597 598 599
    {
        neededGccVersion = gccVersion;
        return *this;
    }

hjk's avatar
hjk committed
600
    const Data &operator+(const GdbVersion &gdbVersion) const
601 602 603 604 605
    {
        neededGdbVersion = gdbVersion;
        return *this;
    }

hjk's avatar
hjk committed
606
    const Data &operator+(const LldbVersion &lldbVersion) const
hjk's avatar
hjk committed
607 608 609 610 611
    {
        neededLldbVersion = lldbVersion;
        return *this;
    }

hjk's avatar
hjk committed
612
    const Data &operator+(const DebuggerEngine &enginesForTest) const
hjk's avatar
hjk committed
613
    {
614
        engines = enginesForTest;
hjk's avatar
hjk committed
615 616 617
        return *this;
    }

hjk's avatar
hjk committed
618
    const Data &operator+(const EigenProfile &) const
hjk's avatar
hjk committed
619 620 621 622 623 624 625 626
    {
        profileExtra +=
            "INCLUDEPATH += /usr/include/eigen2\n"
            "INCLUDEPATH += /usr/include/eigen3\n";

        return *this;
    }

hjk's avatar
hjk committed
627
    const Data &operator+(const UseDebugImage &) const
628 629 630 631 632
    {
        useDebugImage = true;
        return *this;
    }

hjk's avatar
hjk committed
633
    const Data &operator+(const CoreProfile &) const
hjk's avatar
hjk committed
634 635 636
    {
        profileExtra +=
            "CONFIG += QT\n"
637
            "QT += core\n";
hjk's avatar
hjk committed
638 639

        useQt = true;
640 641
        useQHash = true;

hjk's avatar
hjk committed
642 643 644
        return *this;
    }

hjk's avatar
hjk committed
645
    const Data &operator+(const NetworkProfile &) const
hjk's avatar
hjk committed
646 647 648 649 650 651 652 653 654 655 656
    {
        profileExtra +=
            "CONFIG += QT\n"
            "QT += core network\n";

        useQt = true;
        useQHash = true;

        return *this;
    }

657 658 659 660 661 662
    const Data &operator+(const BigArrayProfile &) const
    {
        this->bigArray = true;
        return *this;
    }

hjk's avatar
hjk committed
663
    const Data &operator+(const GuiProfile &) const
hjk's avatar
hjk committed
664
    {
hjk's avatar
hjk committed
665
        this->operator+(CoreProfile());
hjk's avatar
hjk committed
666 667 668 669 670 671 672
        profileExtra +=
            "QT += gui\n"
            "greaterThan(QT_MAJOR_VERSION, 4):QT *= widgets\n";

        return *this;
    }

hjk's avatar
hjk committed
673
    const Data &operator+(const CorePrivateProfile &) const
hjk's avatar
hjk committed
674
    {
hjk's avatar
hjk committed
675
        this->operator+(CoreProfile());
hjk's avatar
hjk committed
676 677
        profileExtra +=
            "greaterThan(QT_MAJOR_VERSION, 4) {\n"
678
            "  QT += core-private\n"
hjk's avatar
hjk committed
679 680 681 682 683 684
            "  CONFIG += no_private_qt_headers_warning\n"
            "}";

        return *this;
    }

hjk's avatar
hjk committed
685
    const Data &operator+(const ForceC &) const
686 687 688 689 690
    {
        forceC = true;
        return *this;
    }

hjk's avatar
hjk committed
691
public:
hjk's avatar
hjk committed
692
    mutable QByteArray profileExtra;
693 694
    mutable QByteArray includes;
    mutable QByteArray code;
695
    mutable QList<Check> checks;
hjk's avatar
hjk committed
696 697
};

698 699 700 701
struct TempStuff
{
    TempStuff() : buildTemp(QLatin1String("qt_tst_dumpers_"))
    {
702
        buildPath = QDir::currentPath() + QLatin1Char('/')  + buildTemp.path();
703 704 705 706 707 708 709 710 711
        buildTemp.setAutoRemove(false);
        QVERIFY(!buildPath.isEmpty());
    }

    QByteArray input;
    QTemporaryDir buildTemp;
    QString buildPath;
};

hjk's avatar
hjk committed
712
Q_DECLARE_METATYPE(Data)
hjk's avatar
hjk committed
713

714
class tst_Dumpers : public QObject
715 716 717 718
{
    Q_OBJECT

public:
719 720 721
    tst_Dumpers()
    {
        t = 0;
722
        m_keepTemp = true;
723
        m_forceKeepTemp = false;
724 725 726
        m_gdbVersion = 0;
        m_gdbBuildVersion = 0;
        m_lldbVersion = 0;
727
        m_qtVersion = 0;
728
        m_gccVersion = 0;
729 730
        m_isMacGdb = false;
        m_isQnxGdb = false;
731
        m_useGLibCxxDebug = false;
732
    }
733 734

private slots:
hjk's avatar
hjk committed
735
    void initTestCase();
hjk's avatar
hjk committed
736 737
    void dumper();
    void dumper_data();
738 739
    void init();
    void cleanup();
hjk's avatar
hjk committed
740 741

private:
742
    void disarm() { t->buildTemp.setAutoRemove(!keepTemp()); }
743
    bool keepTemp() const { return m_keepTemp || m_forceKeepTemp; }
744
    TempStuff *t;
hjk's avatar
hjk committed
745 746
    QByteArray m_debuggerBinary;
    QByteArray m_qmakeBinary;
747
    QProcessEnvironment m_env;
748
    DebuggerEngine m_debuggerEngine;
749
    QString m_makeBinary;
hjk's avatar
hjk committed
750
    bool m_keepTemp;
751
    bool m_forceKeepTemp;
752 753
    int m_gdbVersion; // 7.5.1 -> 70501
    int m_gdbBuildVersion;
754
    int m_lldbVersion;
755
    int m_qtVersion; // 5.2.0 -> 50200
756
    int m_gccVersion;
757 758
    bool m_isMacGdb;
    bool m_isQnxGdb;
759
    bool m_useGLibCxxDebug;
hjk's avatar
hjk committed
760 761 762 763
};

void tst_Dumpers::initTestCase()
{
764
    m_debuggerBinary = qgetenv("QTC_DEBUGGER_PATH_FOR_TEST");
hjk's avatar
hjk committed
765 766
    if (m_debuggerBinary.isEmpty())
        m_debuggerBinary = "gdb";
767
    qDebug() << "Debugger           : " << m_debuggerBinary.constData();
768

hjk's avatar
hjk committed
769
    m_debuggerEngine = GdbEngine;
770
    if (m_debuggerBinary.endsWith("cdb.exe"))
hjk's avatar
hjk committed
771
        m_debuggerEngine = CdbEngine;
772

773 774
    QString base = QFileInfo(QString::fromLatin1(m_debuggerBinary)).baseName();
    if (base.startsWith(QLatin1String("lldb")))
hjk's avatar
hjk committed
775
        m_debuggerEngine = LldbEngine;
hjk's avatar
hjk committed
776

hjk's avatar
hjk committed
777
    m_qmakeBinary = qgetenv("QTC_QMAKE_PATH_FOR_TEST");
hjk's avatar
hjk committed
778 779
    if (m_qmakeBinary.isEmpty())
        m_qmakeBinary = "qmake";
780 781 782 783 784 785 786
    qDebug() << "QMake              : " << m_qmakeBinary.constData();

    m_useGLibCxxDebug = qgetenv("QTC_USE_GLIBCXXDEBUG_FOR_TEST").toInt();
    qDebug() << "Use _GLIBCXX_DEBUG : " << m_useGLibCxxDebug;

    m_forceKeepTemp = qgetenv("QTC_KEEP_TEMP_FOR_TEST").toInt();
    qDebug() << "Force keep temp    : " << m_forceKeepTemp;
hjk's avatar
hjk committed
787

hjk's avatar
hjk committed
788
    if (m_debuggerEngine == GdbEngine) {
789 790 791 792 793 794 795 796 797
        QProcess debugger;
        debugger.start(QString::fromLatin1(m_debuggerBinary)
                       + QLatin1String(" -i mi -quiet -nx"));
        bool ok = debugger.waitForStarted();
        debugger.write("set confirm off\npython print 43\nshow version\nquit\n");
        ok = debugger.waitForFinished();
        QVERIFY(ok);
        QByteArray output = debugger.readAllStandardOutput();
        //qDebug() << "stdout: " << output;
798 799
        bool usePython = !output.contains("Python scripting is not supported in this copy of GDB");
        qDebug() << "Python             : " << (usePython ? "ok" : "*** not ok ***");
800
        qDebug() << "Dumper dir         : " << DUMPERDIR;
801
        QVERIFY(usePython);
802 803 804 805 806 807 808 809 810

        QString version = QString::fromLocal8Bit(output);
        int pos1 = version.indexOf(QLatin1String("&\"show version\\n"));
        QVERIFY(pos1 != -1);
        pos1 += 20;
        int pos2 = version.indexOf(QLatin1String("~\"Copyright (C) "), pos1);
        QVERIFY(pos2 != -1);
        pos2 -= 4;
        version = version.mid(pos1, pos2 - pos1);
811
        extractGdbVersion(version, &m_gdbVersion,
812
            &m_gdbBuildVersion, &m_isMacGdb, &m_isQnxGdb);
813 814
        m_env = QProcessEnvironment::systemEnvironment();
        m_makeBinary = QLatin1String("make");
815
        qDebug() << "Gdb version        : " << m_gdbVersion;
hjk's avatar
hjk committed
816
    } else if (m_debuggerEngine == CdbEngine) {
817
        setupCdb(&m_makeBinary, &m_env);
hjk's avatar
hjk committed
818
    } else if (m_debuggerEngine == LldbEngine) {
819
        QProcess debugger;
820 821
        QString cmd = QString::fromUtf8(m_debuggerBinary + " -v");
        debugger.start(cmd);
822 823 824 825 826
        bool ok = debugger.waitForFinished(2000);
        QVERIFY(ok);
        QByteArray output = debugger.readAllStandardOutput();
        output += debugger.readAllStandardError();
        output = output.trimmed();
827 828
        // Should be something like "LLDB-178" (Mac OS X 10.8)
        // or "lldb version 3.5 ( revision )" (Ubuntu 13.10)
829 830 831 832 833
        QByteArray ba = output.mid(output.indexOf('-') + 1);
        int pos = ba.indexOf('.');
        if (pos >= 0)
            ba = ba.left(pos);
        m_lldbVersion = ba.toInt();
834 835 836 837 838 839 840 841 842 843
        if (!m_lldbVersion) {
            if (output.startsWith("lldb version")) {
                int pos1 = output.indexOf('.', 13);
                int major = output.mid(13, pos1++ - 13).toInt();
                int pos2 = output.indexOf(' ', pos1);
                int minor = output.mid(pos1, pos2++ - pos1).toInt();
                m_lldbVersion = 100 * major + 10 * minor;
            }
        }

844
        qDebug() << "Lldb version       :" << output << ba << m_lldbVersion;
845
        QVERIFY(m_lldbVersion);
846 847 848

        m_env = QProcessEnvironment::systemEnvironment();
        m_makeBinary = QLatin1String("make");
849
    }
hjk's avatar
hjk committed
850 851
}

852
void tst_Dumpers::init()
hjk's avatar
hjk committed
853
{
854
    t = new TempStuff();
hjk's avatar
hjk committed
855 856
}

857
void tst_Dumpers::cleanup()
hjk's avatar
hjk committed
858
{
859 860
    if (!t->buildTemp.autoRemove()) {
        QFile logger(t->buildPath + QLatin1String("/input.txt"));
hjk's avatar
hjk committed
861
        logger.open(QIODevice::ReadWrite);
862
        logger.write(t->input);
hjk's avatar
hjk committed
863
    }
864 865
    delete t;
}
866

hjk's avatar
hjk committed
867 868 869 870
void tst_Dumpers::dumper()
{
    QFETCH(Data, data);

871 872 873
    if (!(data.engines & m_debuggerEngine))
        MSKIP_SINGLE("The test is excluded for this debugger engine.");

hjk's avatar
hjk committed
874
    if (data.neededGdbVersion.isRestricted && m_debuggerEngine == GdbEngine) {
875
        if (data.neededGdbVersion.min > m_gdbVersion)
hjk's avatar
hjk committed
876 877
            MSKIP_SINGLE("Need minimum GDB version "
                + QByteArray::number(data.neededGdbVersion.min));
878
        if (data.neededGdbVersion.max < m_gdbVersion)
hjk's avatar
hjk committed
879 880 881 882
            MSKIP_SINGLE("Need maximum GDB version "
                + QByteArray::number(data.neededGdbVersion.max));
    }

hjk's avatar
hjk committed
883
    if (data.neededLldbVersion.isRestricted && m_debuggerEngine == LldbEngine) {
884
        if (data.neededLldbVersion.min > m_lldbVersion)
hjk's avatar
hjk committed
885 886
            MSKIP_SINGLE("Need minimum LLDB version "
                + QByteArray::number(data.neededLldbVersion.min));
887
        if (data.neededLldbVersion.max < m_lldbVersion)
hjk's avatar
hjk committed
888 889
            MSKIP_SINGLE("Need maximum LLDB version "
                + QByteArray::number(data.neededLldbVersion.max));
890
    }
891

hjk's avatar
hjk committed
892 893 894 895
    QString cmd;
    QByteArray output;
    QByteArray error;

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    if (data.neededQtVersion.isRestricted) {
        QProcess qmake;
        qmake.setWorkingDirectory(t->buildPath);
        cmd = QString::fromLatin1(m_qmakeBinary);
        qmake.start(cmd, QStringList(QLatin1String("--version")));
        QVERIFY(qmake.waitForFinished());
        output = qmake.readAllStandardOutput();
        error = qmake.readAllStandardError();
        int pos0 = output.indexOf("Qt version");
        if (pos0 == -1) {
            qDebug() << "Output: " << output;
            qDebug() << "Error: " << error;
            QVERIFY(false);
        }
        pos0 += 11;
        int pos1 = output.indexOf('.', pos0 + 1);
        int major = output.mid(pos0, pos1++ - pos0).toInt();
        int pos2 = output.indexOf('.', pos1 + 1);
        int minor = output.mid(pos1, pos2++ - pos1).toInt();
        int pos3 = output.indexOf(' ', pos2 + 1);
        int patch = output.mid(pos2, pos3++ - pos2).toInt();
917
        m_qtVersion = 0x10000 * major + 0x100 * minor + patch;
918 919 920

        if (data.neededQtVersion.min > m_qtVersion)
            MSKIP_SINGLE("Need minimum Qt version "
921
                + QByteArray::number(data.neededQtVersion.min, 16));
922 923
        if (data.neededQtVersion.max < m_qtVersion)
            MSKIP_SINGLE("Need maximum Qt version "
924
                + QByteArray::number(data.neededQtVersion.max, 16));
925 926
    }

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
    if (data.neededGccVersion.isRestricted) {
        QProcess gcc;
        gcc.setWorkingDirectory(t->buildPath);
        cmd = QLatin1String("gcc");
        gcc.start(cmd, QStringList(QLatin1String("--version")));
        QVERIFY(gcc.waitForFinished());
        output = gcc.readAllStandardOutput();
        error = gcc.readAllStandardError();
        int pos = output.indexOf('\n');
        if (pos != -1)
            output = output.left(pos);
        qDebug() << "Extracting GCC version from: " << output;
        pos = output.lastIndexOf(' ');
        output = output.mid(pos + 1);
        int pos1 = output.indexOf('.');
        int major = output.left(pos1++).toInt();
        int pos2 = output.indexOf('.', pos1 + 1);
        int minor = output.mid(pos1, pos2++ - pos1).toInt();
        int patch = output.mid(pos2).toInt();
        m_gccVersion = 10000 * major + 100 * minor + patch;
        qDebug() << "GCC version: " << m_gccVersion;

        if (data.neededGccVersion.min > m_gccVersion)
            MSKIP_SINGLE("Need minimum GCC version "
                + QByteArray::number(data.neededGccVersion.min));
        if (data.neededGccVersion.max < m_gccVersion)
            MSKIP_SINGLE("Need maximum GCC version "
                + QByteArray::number(data.neededGccVersion.max));
    }

957 958
    const char *mainFile = data.forceC ? "main.c" : "main.cpp";

959 960
    QFile proFile(t->buildPath + QLatin1String("/doit.pro"));
    QVERIFY(proFile.open(QIODevice::ReadWrite));
961 962 963
    proFile.write("SOURCES = ");
    proFile.write(mainFile);
    proFile.write("\nTARGET = doit\n");
964
    proFile.write("\nCONFIG -= app_bundle\n");
965 966
    proFile.write("\nCONFIG -= release\n");
    proFile.write("\nCONFIG += debug\n");
hjk's avatar
hjk committed
967 968 969 970
    if (data.useQt)
        proFile.write("QT -= widgets gui\n");
    else
        proFile.write("CONFIG -= QT\n");
971 972
    if (m_useGLibCxxDebug)
        proFile.write("DEFINES += _GLIBCXX_DEBUG\n");
973 974
    if (m_gdbVersion < 70500)
        proFile.write("QMAKE_CXXFLAGS += -gdwarf-3\n");
hjk's avatar
hjk committed
975
    proFile.write(data.profileExtra);
hjk's avatar
hjk committed
976 977
    proFile