gdbengine.cpp 137 KB
Newer Older
con's avatar
con committed
1
2
3
4
/***************************************************************************
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
7
8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
9
10
11
**
** Non-Open Source Usage
**
con's avatar
con committed
12
13
14
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
15
16
17
18
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
con's avatar
con committed
19
20
21
22
23
24
25
26
27
28
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
29
** rights. These rights are described in the Nokia Qt GPL Exception
30
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
31
32
**
***************************************************************************/
con's avatar
con committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46

#include "gdbengine.h"

#include "debuggerconstants.h"
#include "debuggermanager.h"
#include "gdbmi.h"
#include "procinterrupt.h"

#include "disassemblerhandler.h"
#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "stackhandler.h"
#include "watchhandler.h"
47
#include "sourcefileswindow.h"
con's avatar
con committed
48
49
50
51

#include "startexternaldialog.h"
#include "attachexternaldialog.h"

hjk's avatar
hjk committed
52
53
#include <utils/qtcassert.h>

con's avatar
con committed
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
#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QTime>
#include <QtCore/QTimer>

#include <QtGui/QAction>
#include <QtGui/QLabel>
#include <QtGui/QMainWindow>
#include <QtGui/QMessageBox>
#include <QtGui/QToolTip>

#if defined(Q_OS_LINUX) || defined(Q_OS_MAC)
#include <unistd.h>
#include <dlfcn.h>
#endif

using namespace Debugger;
using namespace Debugger::Internal;
using namespace Debugger::Constants;

Q_DECLARE_METATYPE(Debugger::Internal::GdbMi);

//#define DEBUG_PENDING  1
//#define DEBUG_SUBITEM  1

#if DEBUG_PENDING
#   define PENDING_DEBUG(s) qDebug() << s
#else
#   define PENDING_DEBUG(s) 
#endif

static const QString tooltipIName = "tooltip";

///////////////////////////////////////////////////////////////////////
//
// GdbCommandType
//
///////////////////////////////////////////////////////////////////////

enum GdbCommandType
{
    GdbInvalidCommand = 0,

    GdbShowVersion = 100,
    GdbFileExecAndSymbols,
    GdbQueryPwd,
    GdbQuerySources,
    GdbAsyncOutput2,
103
    GdbStart,
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
104
    GdbAttached,
con's avatar
con committed
105
106
107
108
109
110
111
112
113
114
115
116
    GdbExecRun,
    GdbExecRunToFunction,
    GdbExecStep,
    GdbExecNext,
    GdbExecStepI,
    GdbExecNextI,
    GdbExecContinue,
    GdbExecFinish,
    GdbExecJumpToLine,
    GdbExecInterrupt,
    GdbInfoShared,
    GdbInfoProc,
117
    GdbInfoThreads,
con's avatar
con committed
118
119
    GdbQueryDataDumper1,
    GdbQueryDataDumper2,
120
    GdbTemporaryContinue,
con's avatar
con committed
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

    BreakCondition = 200,
    BreakEnablePending,
    BreakSetAnnotate,
    BreakDelete,
    BreakList,
    BreakIgnore,
    BreakInfo,
    BreakInsert,
    BreakInsert1,

    DisassemblerList = 300,

    ModulesList = 400,

    RegisterListNames = 500,
    RegisterListValues,

    StackSelectThread = 600,
    StackListThreads,
    StackListFrames,
    StackListLocals,
    StackListArguments,

    WatchVarAssign = 700,             // data changed by user
    WatchVarListChildren,
    WatchVarCreate,
    WatchEvaluateExpression,
    WatchToolTip,
    WatchDumpCustomSetup,
    WatchDumpCustomValue1,           // waiting for gdb ack
152
    WatchDumpCustomValue2,           // waiting for actual data
con's avatar
con committed
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
    WatchDumpCustomEditValue,
};

QString dotEscape(QString str)
{
    str.replace(' ', '.');
    str.replace('\\', '.');
    str.replace('/', '.');
    return str;
}

QString currentTime()
{
    return QTime::currentTime().toString("hh:mm:ss.zzz");
}

static int &currentToken()
{
    static int token = 0;
    return token;
}

static bool isSkippableFunction(const QString &funcName, const QString &fileName)
{
    if (fileName.endsWith("kernel/qobject.cpp"))
        return true;
    if (fileName.endsWith("kernel/moc_qobject.cpp"))
        return true;
    if (fileName.endsWith("kernel/qmetaobject.cpp"))
        return true;
    if (fileName.endsWith(".moc"))
        return true;

    if (funcName.endsWith("::qt_metacall"))
        return true;

    return false;
}

static bool isLeavableFunction(const QString &funcName, const QString &fileName)
{
    if (funcName.endsWith("QObjectPrivate::setCurrentSender"))
        return true;
    if (fileName.endsWith("kernel/qmetaobject.cpp")
            && funcName.endsWith("QMetaObject::methodOffset"))
        return true;
    if (fileName.endsWith("kernel/qobject.h"))
        return true;
    if (fileName.endsWith("kernel/qobject.cpp")
            && funcName.endsWith("QObjectConnectionListVector::at"))
        return true;
    if (fileName.endsWith("kernel/qobject.cpp")
            && funcName.endsWith("~QObject"))
        return true;
    if (fileName.endsWith("thread/qmutex.cpp"))
        return true;
    if (fileName.endsWith("thread/qthread.cpp"))
        return true;
    if (fileName.endsWith("thread/qthread_unix.cpp"))
        return true;
    if (fileName.endsWith("thread/qmutex.h"))
        return true;
    if (fileName.contains("thread/qbasicatomic"))
        return true;
    if (fileName.contains("thread/qorderedmutexlocker_p"))
        return true;
    if (fileName.contains("arch/qatomic"))
        return true;
    if (fileName.endsWith("tools/qvector.h"))
        return true;
    if (fileName.endsWith("tools/qlist.h"))
        return true;
    if (fileName.endsWith("tools/qhash.h"))
        return true;
    if (fileName.endsWith("tools/qmap.h"))
        return true;
    if (fileName.endsWith("tools/qstring.h"))
        return true;
    if (fileName.endsWith("global/qglobal.h"))
        return true;

    return false;
}


///////////////////////////////////////////////////////////////////////
//
// GdbEngine
//
///////////////////////////////////////////////////////////////////////

GdbEngine::GdbEngine(DebuggerManager *parent)
{
    q = parent;
    qq = parent->engineInterface();
248
249
    initializeVariables();
    initializeConnections();
con's avatar
con committed
250
251
252
253
}

GdbEngine::~GdbEngine()
{
hjk's avatar
hjk committed
254
255
    // prevent sending error messages afterwards
    m_gdbProc.disconnect(this);
con's avatar
con committed
256
257
}

258
void GdbEngine::initializeConnections()
con's avatar
con committed
259
260
261
262
263
264
265
266
267
268
269
270
{
    // Gdb Process interaction
    connect(&m_gdbProc, SIGNAL(error(QProcess::ProcessError)), this,
        SLOT(gdbProcError(QProcess::ProcessError)));
    connect(&m_gdbProc, SIGNAL(readyReadStandardOutput()), this,
        SLOT(readGdbStandardOutput()));
    connect(&m_gdbProc, SIGNAL(readyReadStandardError()), this,
        SLOT(readGdbStandardError()));
    connect(&m_gdbProc, SIGNAL(finished(int, QProcess::ExitStatus)), q,
        SLOT(exitDebugger()));

    // Output
271
272
    connect(&m_outputCollector, SIGNAL(byteDelivery(QByteArray)),
            SLOT(readDebugeeOutput(QByteArray)));
con's avatar
con committed
273
274
275
276
277
278
279
280
281
    connect(this, SIGNAL(gdbResponseAvailable()),
        this, SLOT(handleResponse()), Qt::QueuedConnection);

    connect(this, SIGNAL(gdbOutputAvailable(QString,QString)),
        q, SLOT(showDebuggerOutput(QString,QString)),
        Qt::QueuedConnection);
    connect(this, SIGNAL(gdbInputAvailable(QString,QString)),
        q, SLOT(showDebuggerInput(QString,QString)),
        Qt::QueuedConnection);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
282
283
    connect(this, SIGNAL(applicationOutputAvailable(QString)),
        q, SLOT(showApplicationOutput(QString)),
con's avatar
con committed
284
285
286
        Qt::QueuedConnection);
}

287
288
289
290
void GdbEngine::initializeVariables()
{
    m_dataDumperState = DataDumperUninitialized;
    m_gdbVersion = 100;
hjk's avatar
hjk committed
291
    m_gdbBuildVersion = -1;
292
293
294
295
296
297
298
299
300
301

    m_fullToShortName.clear();
    m_shortToFullName.clear();
    m_varToType.clear();

    m_modulesListOutdated = true;
    m_oldestAcceptableToken = -1;
    m_outputCodec = QTextCodec::codecForLocale();
    m_pendingRequests = 0;
    m_waitingForBreakpointSynchronizationToContinue = false;
302
    m_waitingForFirstBreakpointToBeHit = false;
303
    m_commandsToRunOnTemporaryBreak.clear();
304
305
}

con's avatar
con committed
306
307
308
309
310
311
312
void GdbEngine::gdbProcError(QProcess::ProcessError error)
{
    QString msg;
    switch (error) {
        case QProcess::FailedToStart:
            msg = QString(tr("The Gdb process failed to start. Either the "
                "invoked program '%1' is missing, or you may have insufficient "
313
                "permissions to invoke the program.")).arg(q->settings()->m_gdbCmd);
con's avatar
con committed
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
            break;
        case QProcess::Crashed:
            msg = tr("The Gdb process crashed some time after starting "
                "successfully.");
            break;
        case QProcess::Timedout:
            msg = tr("The last waitFor...() function timed out. "
                "The state of QProcess is unchanged, and you can try calling "
                "waitFor...() again.");
            break;
        case QProcess::WriteError:
            msg = tr("An error occurred when attempting to write "
                "to the Gdb process. For example, the process may not be running, "
                "or it may have closed its input channel.");
            break;
        case QProcess::ReadError:
            msg = tr("An error occurred when attempting to read from "
                "the Gdb process. For example, the process may not be running.");
            break;
        default:
            msg = tr("An unknown error in the Gdb process occurred. "
                "This is the default return value of error().");
    }

338
    q->showStatusMessage(msg);
con's avatar
con committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
    QMessageBox::critical(q->mainWindow(), tr("Error"), msg);
    // act as if it was closed by the core
    q->exitDebugger();
}

static inline bool isNameChar(char c)
{
    // could be 'stopped' or 'shlibs-added'
    return (c >= 'a' && c <= 'z') || c == '-';
}

#if 0
static void dump(const char *first, const char *middle, const QString & to)
{
    QByteArray ba(first, middle - first);
    Q_UNUSED(to);
    // note that qDebug cuts off output after a certain size... (bug?)
    qDebug("\n>>>>> %s\n%s\n====\n%s\n<<<<<\n",
        qPrintable(currentTime()),
        qPrintable(QString(ba).trimmed()),
        qPrintable(to.trimmed()));
    //qDebug() << "";
    //qDebug() << qPrintable(currentTime())
    //    << " Reading response:  " << QString(ba).trimmed() << "\n";
}
#endif

366
367
368
369
370
371
void GdbEngine::readDebugeeOutput(const QByteArray &data)
{
    emit applicationOutputAvailable(m_outputCodec->toUnicode(
            data.constData(), data.length(), &m_outputCodecState));
}

hjk's avatar
hjk committed
372
373
374
375
376
void GdbEngine::debugMessage(const QString &msg)
{
    emit gdbOutputAvailable("debug:", msg);
}

377
void GdbEngine::handleResponse(const QByteArray &buff)
con's avatar
con committed
378
379
380
381
{
    static QTime lastTime;

    emit gdbOutputAvailable("            ", currentTime());
382
    emit gdbOutputAvailable("stdout:", buff);
con's avatar
con committed
383
384
385
386
387

#if 0
    qDebug() // << "#### start response handling #### "
        << currentTime()
        << lastTime.msecsTo(QTime::currentTime()) << "ms,"
388
389
390
        << "buf: " << buff.left(1500) << "..."
        //<< "buf: " << buff
        << "size:" << buff.size();
con's avatar
con committed
391
#else
392
    //qDebug() << "buf: " << buff;
con's avatar
con committed
393
394
395
396
#endif

    lastTime = QTime::currentTime();

397
398
399
400
401
402
403
404
405
406
407
    if (buff.isEmpty() || buff == "(gdb) ")
        return;

    const char *from = buff.constData();
    const char *to = from + buff.size();
    const char *inner;

    int token = -1;
    // token is a sequence of numbers
    for (inner = from; inner != to; ++inner)
        if (*inner < '0' || *inner > '9')
con's avatar
con committed
408
            break;
409
410
411
412
413
    if (from != inner) {
        token = QByteArray(from, inner - from).toInt();
        from = inner;
        //qDebug() << "found token " << token;
    }
con's avatar
con committed
414

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
    // next char decides kind of record
    const char c = *from++;
    //qDebug() << "CODE:" << c;
    switch (c) {
        case '*':
        case '+':
        case '=': {
            QByteArray asyncClass;
            for (; from != to; ++from) {
                const char c = *from;
                if (!isNameChar(c))
                    break;
                asyncClass += *from;
            }
            //qDebug() << "ASYNCCLASS" << asyncClass;
con's avatar
con committed
430

431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
            GdbMi record;
            while (from != to) {
                if (*from != ',') {
                    qDebug() << "MALFORMED ASYNC OUTPUT" << from;
                    return;
                }
                ++from; // skip ','
                GdbMi data;
                data.parseResultOrValue(from, to);
                if (data.isValid()) {
                    //qDebug() << "parsed response: " << data.toString();
                    record.m_children += data;
                    record.m_type = GdbMi::Tuple;
                }
            }
            if (asyncClass == "stopped") {
                handleAsyncOutput(record);
            } else if (asyncClass == "running") {
                // Archer has 'thread-id="all"' here
            #ifdef Q_OS_MAC
            } else if (asyncClass == "shlibs-updated") {
                // MAC announces updated libs
            } else if (asyncClass == "shlibs-added") {
                // MAC announces added libs
                // {shlib-info={num="2", name="libmathCommon.A_debug.dylib",
                // kind="-", dyld-addr="0x7f000", reason="dyld", requested-state="Y",
                // state="Y", path="/usr/lib/system/libmathCommon.A_debug.dylib",
                // description="/usr/lib/system/libmathCommon.A_debug.dylib",
                // loaded_addr="0x7f000", slide="0x7f000", prefix=""}}
            #endif
            } else {
                qDebug() << "IGNORED ASYNC OUTPUT "
                    << asyncClass << record.toString();
            }
            break;
        }
con's avatar
con committed
467

468
469
470
471
        case '~': {
            m_pendingConsoleStreamOutput += GdbMi::parseCString(from, to);
            break;
        }
con's avatar
con committed
472

473
474
475
        case '@': {
            m_pendingTargetStreamOutput += GdbMi::parseCString(from, to);
            break;
con's avatar
con committed
476
477
        }

478
479
480
481
482
483
484
        case '&': {
            QByteArray data = GdbMi::parseCString(from, to);
            m_pendingLogStreamOutput += data;
            // On Windows, the contents seem to depend on the debugger
            // version and/or OS version used.
            if (data.startsWith("warning:"))
                qq->showApplicationOutput(data);
con's avatar
con committed
485
486
487
            break;
        }

488
489
        case '^': {
            GdbResultRecord record;
con's avatar
con committed
490

491
            record.token = token;
492

493
494
495
            for (inner = from; inner != to; ++inner)
                if (*inner < 'a' || *inner > 'z')
                    break;
496

497
498
499
500
501
502
503
504
505
506
507
508
509
510
            QByteArray resultClass(from, inner - from);

            if (resultClass == "done")
                record.resultClass = GdbResultDone;
            else if (resultClass == "running")
                record.resultClass = GdbResultRunning;
            else if (resultClass == "connected")
                record.resultClass = GdbResultConnected;
            else if (resultClass == "error")
                record.resultClass = GdbResultError;
            else if (resultClass == "exit")
                record.resultClass = GdbResultExit;
            else
                record.resultClass = GdbResultUnknown;
con's avatar
con committed
511

512
513
514
515
516
            from = inner;
            if (from != to) {
                if (*from != ',') {
                    qDebug() << "MALFORMED RESULT OUTPUT" << from;
                    return;
con's avatar
con committed
517
                }
518
519
520
521
                ++from;
                record.data.parseTuple_helper(from, to);
                record.data.m_type = GdbMi::Tuple;
                record.data.m_name = "data";
con's avatar
con committed
522
            }
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547

            //qDebug() << "\nLOG STREAM:" + m_pendingLogStreamOutput;
            //qDebug() << "\nTARGET STREAM:" + m_pendingTargetStreamOutput;
            //qDebug() << "\nCONSOLE STREAM:" + m_pendingConsoleStreamOutput;
            record.data.setStreamOutput("logstreamoutput",
                m_pendingLogStreamOutput);
            record.data.setStreamOutput("targetstreamoutput",
                m_pendingTargetStreamOutput);
            record.data.setStreamOutput("consolestreamoutput",
                m_pendingConsoleStreamOutput);
            QByteArray custom = m_customOutputForToken[token];
            if (!custom.isEmpty())
                record.data.setStreamOutput("customvaluecontents",
                    '{' + custom + '}');
            //m_customOutputForToken.remove(token);
            m_pendingLogStreamOutput.clear();
            m_pendingTargetStreamOutput.clear();
            m_pendingConsoleStreamOutput.clear();

            handleResultRecord(record);
            break;
        }
        default: {
            qDebug() << "UNKNOWN RESPONSE TYPE" << c;
            break;
con's avatar
con committed
548
549
550
551
552
553
        }
    }
}

void GdbEngine::readGdbStandardError()
{
554
    qWarning() << "Unexpected gdb stderr:" << m_gdbProc.readAllStandardError();
con's avatar
con committed
555
556
557
558
}

void GdbEngine::readGdbStandardOutput()
{
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
    m_inbuffer.append(m_gdbProc.readAllStandardOutput());

    int newstart = 0;
    while (newstart < m_inbuffer.size()) {
        int start = newstart;
        int end = m_inbuffer.indexOf('\n', start);
        if (end < 0) {
            m_inbuffer.remove(0, start);
            return;
        }
        newstart = end + 1;
        if (end == start)
            continue;
        if (m_inbuffer.at(end - 1) == '\r') {
            --end;
            if (end == start)
                continue;
        }
        handleResponse(QByteArray::fromRawData(m_inbuffer.constData() + start, end - start));
con's avatar
con committed
578
579
580
581
582
    }
}

void GdbEngine::interruptInferior()
{
583
584
585
586
    qq->notifyInferiorStopRequested();
    if (m_gdbProc.state() == QProcess::NotRunning) {
        debugMessage("TRYING TO INTERRUPT INFERIOR WITHOUT RUNNING GDB");
        qq->notifyInferiorExited();
con's avatar
con committed
587
        return;
588
    }
con's avatar
con committed
589

hjk's avatar
hjk committed
590
    if (q->m_attachedPID > 0) {
591
592
593
594
        if (!interruptProcess(q->m_attachedPID))
        //    qq->notifyInferiorStopped();
        //else
            debugMessage(QString("CANNOT INTERRUPT %1").arg(q->m_attachedPID));
con's avatar
con committed
595
596
597
598
599
        return;
    }

#ifdef Q_OS_MAC
    sendCommand("-exec-interrupt", GdbExecInterrupt);
600
    //qq->notifyInferiorStopped();
con's avatar
con committed
601
#else
602
603
604
605
    if (!interruptChildProcess(m_gdbProc.pid()))
    //    qq->notifyInferiorStopped();
    //else
        debugMessage(QString("CANNOT STOP INFERIOR"));
con's avatar
con committed
606
607
608
609
610
611
612
#endif
}

void GdbEngine::maybeHandleInferiorPidChanged(const QString &pid0)
{
    int pid = pid0.toInt();
    if (pid == 0) {
hjk's avatar
hjk committed
613
        debugMessage(QString("Cannot parse PID from %1").arg(pid0));
con's avatar
con committed
614
615
        return;
    }
hjk's avatar
hjk committed
616
    if (pid == q->m_attachedPID)
con's avatar
con committed
617
        return;
hjk's avatar
hjk committed
618
    debugMessage(QString("FOUND PID %1").arg(pid));
hjk's avatar
hjk committed
619
    q->m_attachedPID = pid;
con's avatar
con committed
620
621
622
623
    qq->notifyInferiorPidChanged(pid); 
}

void GdbEngine::sendSynchronizedCommand(const QString & command,
624
    int type, const QVariant &cookie, StopNeeded needStop)
con's avatar
con committed
625
{
626
    sendCommand(command, type, cookie, needStop, Synchronized);
con's avatar
con committed
627
628
629
}

void GdbEngine::sendCommand(const QString &command, int type,
630
    const QVariant &cookie, StopNeeded needStop, Synchronization synchronized)
con's avatar
con committed
631
632
{
    if (m_gdbProc.state() == QProcess::NotRunning) {
hjk's avatar
hjk committed
633
        debugMessage("NO GDB PROCESS RUNNING, CMD IGNORED: " + command);
con's avatar
con committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
        return;
    }

    if (synchronized) {
        ++m_pendingRequests;
        PENDING_DEBUG("   TYPE " << type << " INCREMENTS PENDING TO: "
            << m_pendingRequests << command);
    } else {
        PENDING_DEBUG("   UNKNOWN TYPE " << type << " LEAVES PENDING AT: "
            << m_pendingRequests << command);
    }

    GdbCookie cmd;
    cmd.synchronized = synchronized;
    cmd.command = command;
    cmd.type = type;
    cmd.cookie = cookie;

652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
    if (needStop && q->status() != DebuggerInferiorStopped
            && q->status() != DebuggerProcessStartingUp) {
        // queue the commands that we cannot send at once
        QTC_ASSERT(q->status() == DebuggerInferiorRunning,
            qDebug() << "STATUS: " << q->status());
        q->showStatusMessage(tr("Stopping temporarily."));
        debugMessage("QUEUING COMMAND " + cmd.command);
        m_commandsToRunOnTemporaryBreak.append(cmd);
        interruptInferior();
    } else if (!command.isEmpty()) {
        ++currentToken();
        m_cookieForToken[currentToken()] = cmd;
        cmd.command = QString::number(currentToken()) + cmd.command;
        if (cmd.command.contains("%1"))
            cmd.command = cmd.command.arg(currentToken());
con's avatar
con committed
667
668
669

        m_gdbProc.write(cmd.command.toLatin1() + "\r\n");
        //emit gdbInputAvailable(QString(), "         " +  currentTime());
670
671
        //emit gdbInputAvailable(QString(), "[" + currentTime() + "]    " + cmd.command);
        emit gdbInputAvailable(QString(), cmd.command);
con's avatar
con committed
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
    }
}

void GdbEngine::handleResultRecord(const GdbResultRecord &record)
{
    //qDebug() << "TOKEN: " << record.token
    //    << " ACCEPTABLE: " << m_oldestAcceptableToken;
    //qDebug() << "";
    //qDebug() << "\nRESULT" << record.token << record.toString();

    int token = record.token;
    if (token == -1)
        return;

    GdbCookie cmd = m_cookieForToken.take(token);

688
    if (record.token < m_oldestAcceptableToken) {
con's avatar
con committed
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
        //qDebug() << "### SKIPPING OLD RESULT " << record.toString();
        //QMessageBox::information(m_mainWindow, tr("Skipped"), "xxx");
        return;
    }

#if 0
    qDebug() << "# handleOutput, "
        << "cmd type: " << cmd.type
        << "cmd synchronized: " << cmd.synchronized
        << "\n record: " << record.toString();
#endif

    // << "\n data: " << record.data.toString(true);

    if (cmd.type != GdbInvalidCommand)
        handleResult(record, cmd.type, cmd.cookie);

    if (cmd.synchronized) {
        --m_pendingRequests;
        PENDING_DEBUG("   TYPE " << cmd.type << " DECREMENTS PENDING TO: "
            << m_pendingRequests << cmd.command);
710
711
        if (m_pendingRequests <= 0) {
            PENDING_DEBUG(" ....  AND TRIGGERS MODEL UPDATE");
con's avatar
con committed
712
            updateWatchModel2();
713
        }
con's avatar
con committed
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
    } else {
        PENDING_DEBUG("   UNKNOWN TYPE " << cmd.type << " LEAVES PENDING AT: "
            << m_pendingRequests << cmd.command);
    }
}

void GdbEngine::handleResult(const GdbResultRecord & record, int type,
    const QVariant & cookie)
{
    switch (type) {
        case GdbExecNext:
        case GdbExecStep:
        case GdbExecNextI:
        case GdbExecStepI:
        case GdbExecContinue:
        case GdbExecFinish:
            // evil code sharing
            handleExecRun(record);
            break;
733

734
735
        case GdbStart:
            handleStart(record);
736
            break;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
737
738
739
        case GdbAttached:
            handleAttach();
            break;
con's avatar
con committed
740
741
742
        case GdbInfoProc:
            handleInfoProc(record);
            break;
743
744
745
        case GdbInfoThreads:
            handleInfoThreads(record);
            break;
con's avatar
con committed
746
747
748
749
750
751
752
753
754
755
756
757
758

        case GdbShowVersion:
            handleShowVersion(record);
            break;
        case GdbFileExecAndSymbols:
            handleFileExecAndSymbols(record);
            break;
        case GdbExecRunToFunction:
            // that should be "^running". We need to handle the resulting
            // "Stopped"
            //handleExecRunToFunction(record);
            break;
        case GdbExecInterrupt:
759
            qq->notifyInferiorStopped();
con's avatar
con committed
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
            break;
        case GdbExecJumpToLine:
            handleExecJumpToLine(record);
            break;
        case GdbQueryPwd:
            handleQueryPwd(record);
            break;
        case GdbQuerySources:
            handleQuerySources(record);
            break;
        case GdbAsyncOutput2:
            handleAsyncOutput2(cookie.value<GdbMi>());
            break;
        case GdbInfoShared:
            handleInfoShared(record);
            break;
        case GdbQueryDataDumper1:
            handleQueryDataDumper1(record);
            break;
        case GdbQueryDataDumper2:
            handleQueryDataDumper2(record);
            break;
782
783
784
785
        case GdbTemporaryContinue:
            continueInferior();
            q->showStatusMessage(tr("Continuing after temporary stop."));
            break;
con's avatar
con committed
786
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
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866

        case BreakList:
            handleBreakList(record);
            break;
        case BreakInsert:
            handleBreakInsert(record, cookie.toInt());
            break;
        case BreakInsert1:
            handleBreakInsert1(record, cookie.toInt());
            break;
        case BreakInfo:
            handleBreakInfo(record, cookie.toInt());
            break;
        case BreakEnablePending:
        case BreakDelete:
            // nothing
            break;
        case BreakIgnore:
            handleBreakIgnore(record, cookie.toInt());
            break;
        case BreakCondition:
            handleBreakCondition(record, cookie.toInt());
            break;

        case DisassemblerList:
            handleDisassemblerList(record, cookie.toString());
            break;

        case ModulesList:
            handleModulesList(record);
            break;

        case RegisterListNames:
            handleRegisterListNames(record);
            break;
        case RegisterListValues:
            handleRegisterListValues(record);
            break;

        case StackListFrames:
            handleStackListFrames(record);
            break;
        case StackListThreads:
            handleStackListThreads(record, cookie.toInt());
            break;
        case StackSelectThread:
            handleStackSelectThread(record, cookie.toInt());
            break;
        case StackListLocals:
            handleStackListLocals(record);
            break;
        case StackListArguments:
            handleStackListArguments(record);
            break;

        case WatchVarListChildren:
            handleVarListChildren(record, cookie.value<WatchData>());
            break;
        case WatchVarCreate:
            handleVarCreate(record, cookie.value<WatchData>());
            break;
        case WatchVarAssign:
            handleVarAssign();
            break;
        case WatchEvaluateExpression:
            handleEvaluateExpression(record, cookie.value<WatchData>());
            break;
        case WatchToolTip:
            handleToolTip(record, cookie.toString());
            break;
        case WatchDumpCustomValue1:
            handleDumpCustomValue1(record, cookie.value<WatchData>());
            break;
        case WatchDumpCustomValue2:
            handleDumpCustomValue2(record, cookie.value<WatchData>());
            break;
        case WatchDumpCustomSetup:
            handleDumpCustomSetup(record);
            break;

        default:
hjk's avatar
hjk committed
867
868
            debugMessage(QString("FIXME: GdbEngine::handleResult: "
                "should not happen %1").arg(type));
con's avatar
con committed
869
870
871
872
873
874
875
876
            break;
    }
}

void GdbEngine::executeDebuggerCommand(const QString &command)
{
    //createGdbProcessIfNeeded();
    if (m_gdbProc.state() == QProcess::NotRunning) {
hjk's avatar
hjk committed
877
        debugMessage("NO GDB PROCESS RUNNING, PLAIN CMD IGNORED: " + command);
con's avatar
con committed
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
        return;
    }

    GdbCookie cmd;
    cmd.command = command;
    cmd.type = -1;

    emit gdbInputAvailable(QString(), cmd.command);
    m_gdbProc.write(cmd.command.toLatin1() + "\r\n");
}

void GdbEngine::handleQueryPwd(const GdbResultRecord &record)
{
    // FIXME: remove this special case as soon as 'pwd'
    // is supported by MI
    //qDebug() << "PWD OUTPUT:" <<  record.toString();
    // Gdb responses _unless_ we get an error first.
    if (record.resultClass == GdbResultDone) {
#ifdef Q_OS_LINUX
        // "5^done,{logstreamoutput="pwd ",consolestreamoutput
        // ="Working directory /home/apoenitz/dev/work/test1.  "}
        m_pwd = record.data.findChild("consolestreamoutput").data();
        int pos = m_pwd.indexOf("Working directory");
        m_pwd = m_pwd.mid(pos + 18);
        m_pwd = m_pwd.trimmed();
        if (m_pwd.endsWith('.'))
            m_pwd.chop(1);
#endif
#ifdef Q_OS_WIN
        // ~"Working directory C:\\Users\\Thomas\\Documents\\WBTest3\\debug.\n"
        m_pwd = record.data.findChild("consolestreamoutput").data();
        m_pwd = m_pwd.trimmed();
#endif
hjk's avatar
hjk committed
911
        debugMessage("PWD RESULT: " + m_pwd);
con's avatar
con committed
912
913
914
915
916
917
    }
}

void GdbEngine::handleQuerySources(const GdbResultRecord &record)
{
    if (record.resultClass == GdbResultDone) {
918
        QMap<QString, QString> oldShortToFull = m_shortToFullName;
con's avatar
con committed
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
        m_shortToFullName.clear();
        m_fullToShortName.clear();
        // "^done,files=[{file="../../../../bin/gdbmacros/gdbmacros.cpp",
        // fullname="/data5/dev/ide/main/bin/gdbmacros/gdbmacros.cpp"},
        GdbMi files = record.data.findChild("files");
        foreach (const GdbMi &item, files.children()) {
            QString fileName = item.findChild("file").data();
            GdbMi fullName = item.findChild("fullname");
            QString full = fullName.data();
            #ifdef Q_OS_WIN
            full = QDir::cleanPath(full);
            #endif
            if (fullName.isValid() && QFileInfo(full).isReadable()) {
                //qDebug() << "STORING 2: " << fileName << full;
                m_shortToFullName[fileName] = full;
                m_fullToShortName[full] = fileName;
            }
        }
937
938
        if (m_shortToFullName != oldShortToFull)
            qq->sourceFileWindow()->setSourceFiles(m_shortToFullName);
con's avatar
con committed
939
940
941
    }
}

942
943
944
945
946
947
948
949
950
951
952
953
954
void GdbEngine::handleInfoThreads(const GdbResultRecord &record)
{
    if (record.resultClass == GdbResultDone) {
        // FIXME: use something more robust
        // WIN:     * 3 Thread 2312.0x4d0  0x7c91120f in ?? () 
        // LINUX:   * 1 Thread 0x7f466273c6f0 (LWP 21455)  0x0000000000404542 in ...
        QRegExp re(QLatin1String("Thread (\\d+)\\.0x.* in"));
        QString data = record.data.findChild("consolestreamoutput").data();
        if (re.indexIn(data) != -1)
            maybeHandleInferiorPidChanged(re.cap(1));
    }
}

con's avatar
con committed
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
void GdbEngine::handleInfoProc(const GdbResultRecord &record)
{
    if (record.resultClass == GdbResultDone) {
        #if defined(Q_OS_MAC)
        //^done,process-id="85075"
        maybeHandleInferiorPidChanged(record.data.findChild("process-id").data());
        #endif

        #if defined(Q_OS_LINUX) || defined(Q_OS_WIN)
        // FIXME: use something more robust
        QRegExp re(QLatin1String("process (\\d+)"));
        QString data = record.data.findChild("consolestreamoutput").data();
        if (re.indexIn(data) != -1)
            maybeHandleInferiorPidChanged(re.cap(1));
        #endif
    }
}

void GdbEngine::handleInfoShared(const GdbResultRecord &record)
{
    if (record.resultClass == GdbResultDone) {
        // let the modules handler do the parsing
        handleModulesList(record);
    }
}

void GdbEngine::handleExecJumpToLine(const GdbResultRecord &record)
{
    // FIXME: remove this special case as soon as 'jump'
    // is supported by MI
    // "&"jump /home/apoenitz/dev/work/test1/test1.cpp:242"
    // ~"Continuing at 0x4058f3."
    // ~"run1 (argc=1, argv=0x7fffb213a478) at test1.cpp:242"
    // ~"242\t x *= 2;"
    //109^done"
    qq->notifyInferiorStopped();
991
    q->showStatusMessage(tr("Jumped. Stopped."));
con's avatar
con committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
    QString output = record.data.findChild("logstreamoutput").data();
    if (!output.isEmpty())
        return;
    QString fileAndLine = output.section(' ', 1, 1);
    QString file = fileAndLine.section(':', 0, 0);
    int line = fileAndLine.section(':', 1, 1).toInt();
    q->gotoLocation(file, line, true);
}

void GdbEngine::handleExecRunToFunction(const GdbResultRecord &record)
{
    // FIXME: remove this special case as soon as there's a real
    // reason given when the temporary breakpoint is hit.
    // reight now we get:
    // 14*stopped,thread-id="1",frame={addr="0x0000000000403ce4",
    // func="foo",args=[{name="str",value="@0x7fff0f450460"}],
    // file="main.cpp",fullname="/tmp/g/main.cpp",line="37"}
    qq->notifyInferiorStopped();
1010
    q->showStatusMessage(tr("Run to Function finished. Stopped."));
con's avatar
con committed
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
    GdbMi frame = record.data.findChild("frame");
    QString file = frame.findChild("fullname").data();
    int line = frame.findChild("line").data().toInt();
    qDebug() << "HIT: " << file << line << " IN " << frame.toString()
        << " -- " << record.toString();
    q->gotoLocation(file, line, true);
}

static bool isExitedReason(const QString &reason)
{
    return reason == QLatin1String("exited-normally")   // inferior exited normally
        || reason == QLatin1String("exited-signalled")  // inferior exited because of a signal
        //|| reason == QLatin1String("signal-received") // inferior received signal
        || reason == QLatin1String("exited");           // inferior exited
}

static bool isStoppedReason(const QString &reason)
{
    return reason == QLatin1String("function-finished")  // -exec-finish
        || reason == QLatin1String("signal-received")  // handled as "isExitedReason"
        || reason == QLatin1String("breakpoint-hit")     // -exec-continue
        || reason == QLatin1String("end-stepping-range") // -exec-next, -exec-step
        || reason == QLatin1String("location-reached")   // -exec-until
        || reason == QLatin1String("access-watchpoint-trigger")
        || reason == QLatin1String("read-watchpoint-trigger")
#ifdef Q_OS_MAC
        || reason.isEmpty()
#endif
    ;
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
void GdbEngine::handleAqcuiredInferior()
{
    #if defined(Q_OS_WIN)
    sendCommand("info thread", GdbInfoThreads);
    #endif
    #if defined(Q_OS_LINUX)
    sendCommand("info proc", GdbInfoProc);
    #endif
    #if defined(Q_OS_MAC)
    sendCommand("info pid", GdbInfoProc, QVariant(), NeedsStop);
    #endif
    reloadSourceFiles();
    tryLoadCustomDumpers();

#ifndef Q_OS_MAC
    // intentionally after tryLoadCustomDumpers(),
    // otherwise we'd interupt solib loading.
    if (qq->wantsAllPluginBreakpoints()) {
        sendCommand("set auto-solib-add on");
        sendCommand("set stop-on-solib-events 0");
        sendCommand("sharedlibrary .*");
    } else if (qq->wantsSelectedPluginBreakpoints()) {
        sendCommand("set auto-solib-add on");
        sendCommand("set stop-on-solib-events 1");
        sendCommand("sharedlibrary " + qq->selectedPluginBreakpointsPattern());
    } else if (qq->wantsNoPluginBreakpoints()) {
        // should be like that already
        sendCommand("set auto-solib-add off");
        sendCommand("set stop-on-solib-events 0");
    }
#endif
    // nicer to see a bit of the world we live in
    reloadModules();
    attemptBreakpointSynchronization();
}

con's avatar
con committed
1078
1079
1080
1081
void GdbEngine::handleAsyncOutput(const GdbMi &data)
{
    const QString reason = data.findChild("reason").data();

1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
    if (isExitedReason(reason)) {
        qq->notifyInferiorExited();
        QString msg = "Program exited normally";
        if (reason == "exited") {
            msg = "Program exited with exit code "
                + data.findChild("exit-code").toString();
        } else if (reason == "exited-signalled") {
            msg = "Program exited after receiving signal "
                + data.findChild("signal-name").toString();
        } else if (reason == "signal-received") {
            msg = "Program exited after receiving signal "
                + data.findChild("signal-name").toString();
        }
        q->showStatusMessage(msg);
        // FIXME: shouldn't this use a statis change?
        debugMessage("CALLING PARENT EXITDEBUGGER");
        q->exitDebugger();
        return;
    }


1103
1104
1105
    //MAC: bool isFirstStop = data.findChild("bkptno").data() == "1";
    //!MAC: startSymbolName == data.findChild("frame").findChild("func")
    if (m_waitingForFirstBreakpointToBeHit) {
1106
1107
1108
1109
        // If the executable dies already that early we might get something
        // like stdout:49*stopped,reason="exited",exit-code="0177"
        // This is handled now above.

1110
        qq->notifyInferiorStopped();
1111
        m_waitingForFirstBreakpointToBeHit = false;
1112
1113
1114
        //
        // this will "continue" if done
        m_waitingForBreakpointSynchronizationToContinue = true;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1115
1116
1117
        //
        // that's the "early stop"
        handleAqcuiredInferior();
1118
        return;
1119
1120
    }

1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
    if (!m_commandsToRunOnTemporaryBreak.isEmpty()) {
        QTC_ASSERT(q->status() == DebuggerInferiorStopRequested, 
            qDebug() << "STATUS: " << q->status())
        qq->notifyInferiorStopped();
        q->showStatusMessage(tr("Temporarily stopped."));
        // FIXME: racy
        foreach (const GdbCookie &cmd, m_commandsToRunOnTemporaryBreak) {
            debugMessage(QString("RUNNING QUEUED COMMAND %1 %2")
                .arg(cmd.command).arg(cmd.type));
            sendCommand(cmd.command, cmd.type, cmd.cookie);
        }
        sendCommand("p temporaryStop", GdbTemporaryContinue);
        m_commandsToRunOnTemporaryBreak.clear();
        q->showStatusMessage(tr("Handling queued commands."));
        return;
    }

1138
    QString msg = data.findChild("consolestreamoutput").data();
1139
1140
    if (msg.contains("Stopped due to shared library event") || reason.isEmpty()) {
        if (qq->wantsSelectedPluginBreakpoints()) {
hjk's avatar
hjk committed
1141
1142
            debugMessage("SHARED LIBRARY EVENT: " + data.toString());
            debugMessage("PATTERN: " + qq->selectedPluginBreakpointsPattern());
1143
            sendCommand("sharedlibrary " + qq->selectedPluginBreakpointsPattern());
con's avatar
con committed
1144
            continueInferior();
1145
1146
            q->showStatusMessage(tr("Loading %1...").arg(QString(data.toString())));
            return;
con's avatar
con committed
1147
        }
1148
        m_modulesListOutdated = true;
1149
        // fall through
con's avatar
con committed
1150
1151
    }

1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
    // seen on XP after removing a breakpoint while running
    //  stdout:945*stopped,reason="signal-received",signal-name="SIGTRAP",
    //  signal-meaning="Trace/breakpoint trap",thread-id="2",
    //  frame={addr="0x7c91120f",func="ntdll!DbgUiConnectToDbg",
    //  args=[],from="C:\\WINDOWS\\system32\\ntdll.dll"}
    if (reason == "signal-received"
          && data.findChild("signal-name").toString() == "SIGTRAP") {
        continueInferior();
        return;
    }

1163
    //tryLoadCustomDumpers();
con's avatar
con committed
1164
1165
1166
1167
1168
1169

    // jump over well-known frames
    static int stepCounter = 0;
    if (qq->skipKnownFrames()) {
        if (reason == "end-stepping-range" || reason == "function-finished") {
            GdbMi frame = data.findChild("frame");
hjk's avatar
hjk committed
1170
            //debugMessage(frame.toString());
con's avatar
con committed
1171
1172
1173
1174
1175
1176
            m_currentFrame = frame.findChild("addr").data() + '%' +
                 frame.findChild("func").data() + '%';

            QString funcName = frame.findChild("func").data();
            QString fileName = frame.findChild("file").data();
            if (isLeavableFunction(funcName, fileName)) {
hjk's avatar
hjk committed
1177
                //debugMessage("LEAVING" + funcName);
con's avatar
con committed
1178
1179
1180
1181
1182
1183
                ++stepCounter;
                q->stepOutExec();
                //stepExec();
                return;
            }
            if (isSkippableFunction(funcName, fileName)) {
hjk's avatar
hjk committed
1184
                //debugMessage("SKIPPING" + funcName);
con's avatar
con committed
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
                ++stepCounter;
                q->stepExec();
                return;
            }
            //if (stepCounter)
            //    qDebug() << "STEPCOUNTER:" << stepCounter;
            stepCounter = 0;
        }
    }

    if (isStoppedReason(reason) || reason.isEmpty()) {
1196
        if (m_modulesListOutdated) {
1197
            reloadModules();
1198
            m_modulesListOutdated = false;
1199
        }
con's avatar
con committed
1200
1201
        // Need another round trip
        if (reason == "breakpoint-hit") {
1202
            q->showStatusMessage(tr("Stopped at breakpoint"));
con's avatar
con committed
1203
            GdbMi frame = data.findChild("frame");
hjk's avatar
hjk committed
1204
            //debugMessage("HIT BREAKPOINT: " + frame.toString());
con's avatar
con committed
1205
1206
1207
            m_currentFrame = frame.findChild("addr").data() + '%' +
                 frame.findChild("func").data() + '%';

1208
            QApplication::alert(q->mainWindow(), 3000);
1209
            reloadSourceFiles();
con's avatar
con committed
1210
1211
1212
1213
            sendCommand("-break-list", BreakList);
            QVariant var = QVariant::fromValue<GdbMi>(data);
            sendCommand("p 0", GdbAsyncOutput2, var);  // dummy
        } else {
hjk's avatar
hjk committed
1214
            q->showStatusMessage(tr("Stopped: \"%1\"").arg(reason));
con's avatar
con committed
1215
1216
1217
1218
1219
            handleAsyncOutput2(data);
        }
        return;
    }

hjk's avatar
hjk committed
1220
    debugMessage("STOPPED FOR UNKNOWN REASON: " + data.toString());
con's avatar
con committed
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
    // Ignore it. Will be handled with full response later in the
    // JumpToLine or RunToFunction handlers
#if 1
    // FIXME: remove this special case as soon as there's a real
    // reason given when the temporary breakpoint is hit.
    // reight now we get:
    // 14*stopped,thread-id="1",frame={addr="0x0000000000403ce4",
    // func="foo",args=[{name="str",value="@0x7fff0f450460"}],
    // file="main.cpp",fullname="/tmp/g/main.cpp",line="37"}
    //
    // MAC yields sometimes:
    // stdout:3661*stopped,time={wallclock="0.00658",user="0.00142",
    // system="0.00136",start="1218810678.805432",end="1218810678.812011"}
    q->resetLocation();
    qq->notifyInferiorStopped();
1236
    q->showStatusMessage(tr("Run to Function finished. Stopped."));
con's avatar
con committed
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
    GdbMi frame = data.findChild("frame");
    QString file = frame.findChild("fullname").data();
    int line = frame.findChild("line").data().toInt();
    qDebug() << "HIT: " << file << line << " IN " << frame.toString()
        << " -- " << data.toString();
    q->gotoLocation(file, line, true);
#endif
}


void GdbEngine::handleAsyncOutput2(const GdbMi &data)
{
    qq->notifyInferiorStopped();

    //
    // Stack
    //
    qq->stackHandler()->setCurrentIndex(0);
    updateLocals(); // Quick shot

    int currentId = data.findChild("thread-id").data().toInt();
    sendSynchronizedCommand("-stack-list-frames", StackListFrames);
    if (supportsThreads())
        sendSynchronizedCommand("-thread-list-ids", StackListThreads, currentId);

    //
    // Disassembler
    //
    // Linux:
    //"79*stopped,reason="end-stepping-range",reason="breakpoint-hit",bkptno="1",
    //thread-id="1",frame={addr="0x0000000000405d8f",func="run1",
    //args=[{name="argc",value="1"},{name="argv",value="0x7fffb7c23058"}],
    //file="test1.cpp",fullname="/home/apoenitz/dev/work/test1/test1.cpp",line="261"}"
    // Mac: (but only sometimes)
    m_address = data.findChild("frame").findChild("addr").data();
    qq->reloadDisassembler();

    //
    // Registers
    //
    qq->reloadRegisters();
}

void GdbEngine::handleShowVersion(const GdbResultRecord &response)
{
hjk's avatar
hjk committed
1282
1283
1284
    //qDebug () << "VERSION 2:" << response.data.findChild("consolestreamoutput").data();
    //qDebug () << "VERSION:" << response.toString();
    debugMessage("VERSION:" + response.toString());
con's avatar
con committed
1285
1286
    if (response.resultClass == GdbResultDone) {
        m_gdbVersion = 100;
hjk's avatar
hjk committed
1287
        m_gdbBuildVersion = -1;
con's avatar
con committed
1288
        QString msg = response.data.findChild("consolestreamoutput").data();
hjk's avatar
hjk committed
1289
        QRegExp supported("GNU gdb(.*) (\\d+)\\.(\\d+)(\\.(\\d+))?(-(\\d+))?");
1290
        if (supported.indexIn(msg) == -1) {
hjk's avatar
hjk committed
1291
            debugMessage("UNSUPPORTED GDB VERSION " + msg);
con's avatar
con committed
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
            QStringList list = msg.split("\n");
            while (list.size() > 2)
                list.removeLast();
            msg = tr("The debugger you are using identifies itself as:")
                + "<p><p>" + list.join("<br>") + "<p><p>"
                + tr("This version is not officially supported by Qt Creator.\n"
                     "Debugging will most likely not work well.\n"
                     "Using gdb 6.7 or later is strongly recommended.");
#if 0
            // ugly, but 'Show again' check box...
            static QErrorMessage *err = new QErrorMessage(m_mainWindow);
            err->setMinimumSize(400, 300);
            err->showMessage(msg);
#else
            //QMessageBox::information(m_mainWindow, tr("Warning"), msg);
#endif
1308
1309
1310
        } else {
            m_gdbVersion = 10000 * supported.cap(2).toInt()
                         +   100 * supported.cap(3).toInt()
hjk's avatar
hjk committed
1311
                         +     1 * supported.cap(5).toInt();
hjk's avatar
hjk committed
1312
1313
            m_gdbBuildVersion = supported.cap(7).toInt();
            debugMessage(QString("GDB VERSION: %1").arg(m_gdbVersion));
con's avatar
con committed
1314
        }
hjk's avatar
hjk committed
1315
        //qDebug () << "VERSION 3:" << m_gdbVersion << m_gdbBuildVersion;
con's avatar
con committed
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
    }
}

void GdbEngine::handleFileExecAndSymbols
    (const GdbResultRecord &response)
{
    if (response.resultClass == GdbResultDone) {
        //m_breakHandler->clearBreakMarkers();
    } else if (response.resultClass == GdbResultError) {
        QString msg = response.data.findChild("msg").data();
        QMessageBox::critical(q->mainWindow(), tr("Error"),
            tr("Starting executable failed:\n") + msg);
hjk's avatar
hjk committed
1328
        QTC_ASSERT(q->status() == DebuggerInferiorRunning, /**/);
con's avatar
con committed
1329
1330
1331
1332
1333
1334
1335
1336
        interruptInferior();
    }
}

void GdbEngine::handleExecRun(const GdbResultRecord &response)
{
    if (response.resultClass == GdbResultRunning) {
        qq->notifyInferiorRunning();
1337
        q->showStatusMessage(tr("Running..."));
con's avatar
con committed
1338
1339
1340
1341
1342
    } else if (response.resultClass == GdbResultError) {
        QString msg = response.data.findChild("msg").data();
        if (msg == "Cannot find bounds of current function") {
            qq->notifyInferiorStopped();
            //q->showStatusMessage(tr("No debug information available. "
1343
            //  "Leaving function..."));
con's avatar
con committed
1344
1345
1346
1347
            //stepOutExec();
        } else {
            QMessageBox::critical(q->mainWindow(), tr("Error"),
                tr("Starting executable failed:\n") + msg);
hjk's avatar
hjk committed
1348
            QTC_ASSERT(q->status() == DebuggerInferiorRunning, /**/);
con's avatar
con committed
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
            interruptInferior();
        }
    }
}

void GdbEngine::queryFullName(const QString &fileName, QString *full)
{
    *full = fullName(fileName);
}

QString GdbEngine::shortName(const QString &fullName)
{
    return m_fullToShortName.value(fullName, QString());
}

QString GdbEngine::fullName(const QString &fileName)
{
    //QString absName = m_manager->currentWorkingDirectory() + "/" + file; ??
    if (fileName.isEmpty())
        return QString();
    QString full = m_shortToFullName.value(fileName, QString());
hjk's avatar
hjk committed
1370
    //debugMessage("RESOLVING: " + fileName + " " +  full);
con's avatar
con committed
1371
1372
1373
1374
1375
1376
1377
1378
1379
    if (!full.isEmpty())
        return full;
    QFileInfo fi(fileName);
    if (!fi.isReadable())
        return QString();
    full = fi.absoluteFilePath();
    #ifdef Q_OS_WIN
    full = QDir::cleanPath(full);
    #endif
hjk's avatar
hjk committed
1380
    //debugMessage("STORING: " + fileName + " " + full);
con's avatar
con committed
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
    m_shortToFullName[fileName] = full;
    m_fullToShortName[full] = fileName;
    return full;
}

QString GdbEngine::fullName(const QStringList &candidates)
{
    QString full;
    foreach (const QString &fileName, candidates) {
        full = fullName(fileName);
        if (!full.isEmpty())
            return full;
    }
    foreach (const QString &fileName, candidates) {
        if (!fileName.isEmpty())
            return fileName;
    }
    return full;
}

void GdbEngine::shutdown()
{
    exitDebugger();
}

void GdbEngine::exitDebugger()
{
hjk's avatar
hjk committed
1408
1409
1410
1411
    debugMessage(QString("GDBENGINE EXITDEBUFFER: %1").arg(m_gdbProc.state()));
    if (m_gdbProc.state() == QProcess::Starting) {
        debugMessage(QString("WAITING FOR GDB STARTUP TO SHUTDOWN: %1")
            .arg(m_gdbProc.state()));
con's avatar
con committed
1412
        m_gdbProc.waitForStarted();
hjk's avatar
hjk committed
1413
    }
con's avatar
con committed
1414
    if (m_gdbProc.state() == QProcess::Running) {
hjk's avatar
hjk committed
1415
1416
        debugMessage(QString("WAITING FOR RUNNING GDB TO SHUTDOWN: %1")
            .arg(m_gdbProc.state()));
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
        if (q->status() != DebuggerInferiorStopped
            && q->status() != DebuggerProcessStartingUp) {
            QTC_ASSERT(q->status() == DebuggerInferiorRunning,
                qDebug() << "STATUS ON EXITDEBUGGER: " << q->status());
            interruptInferior();
        }
        if (q->startMode() == DebuggerManager::AttachExternal)
            sendCommand("detach");
        else
            sendCommand("kill");
con's avatar
con committed
1427
1428
1429
1430
        sendCommand("-gdb-exit");
        // 20s can easily happen when loading webkit debug information
        m_gdbProc.waitForFinished(20000);
        if (m_gdbProc.state() != QProcess::Running) {
hjk's avatar
hjk committed
1431
1432
            debugMessage(QString("FORCING TERMINATION: %1")
                .arg(m_gdbProc.state()));
con's avatar
con committed
1433
1434
1435
1436
1437
            m_gdbProc.terminate();
            m_gdbProc.waitForFinished(20000);
        }
    }
    if (m_gdbProc.state() != QProcess::NotRunning)
hjk's avatar
hjk committed
1438
        debugMessage("PROBLEM STOPPING DEBUGGER");
con's avatar
con committed
1439

1440
    m_outputCollector.shutdown();
1441
    initializeVariables();
1442
    //q->settings()->m_debugDumpers = false;
con's avatar
con committed
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
}


int GdbEngine::currentFrame() const
{
    return qq->stackHandler()->currentIndex();
}


bool GdbEngine::startDebugger()
{
    QStringList gdbArgs;

    QFileInfo fi(q->m_executable);
    QString fileName = '"' + fi.absoluteFilePath() + '"';

    if (m_gdbProc.state() != QProcess::NotRunning) {
hjk's avatar
hjk committed
1460
        debugMessage("GDB IS ALREADY RUNNING!");
con's avatar
con committed
1461
1462
1463
        return false;
    }

1464
1465
1466
1467
1468
1469
1470
1471
1472
    if (!m_outputCollector.listen()) {
        QMessageBox::critical(q->mainWindow(), tr("Debugger Startup Failure"),
                              tr("Cannot set up communication with child process: %1")
                              .arg(m_outputCollector.errorString()));
        return false;
    }

    gdbArgs.prepend(QLatin1String("--tty=") + m_outputCollector.serverName());

con's avatar
con committed
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
    //gdbArgs.prepend(QLatin1String("--quiet"));
    gdbArgs.prepend(QLatin1String("mi"));
    gdbArgs.prepend(QLatin1String("-i"));

    if (!q->m_workingDir.isEmpty())
        m_gdbProc.setWorkingDirectory(q->m_workingDir);
    if (!q->m_environment.isEmpty())
        m_gdbProc.setEnvironment(q->m_environment);

    #if 0
1483
    qDebug() << "Command: " << q->settings()->m_gdbCmd;
con's avatar
con committed
1484
    qDebug() << "WorkingDirectory: " << m_gdbProc.workingDirectory();
1485
    qDebug() << "ScriptFile: " << q->settings()->m_scriptFile;
con's avatar
con committed
1486
1487
1488
1489
1490
1491
    qDebug() << "Environment: " << m_gdbProc.environment();
    qDebug() << "Arguments: " << gdbArgs;
    qDebug() << "BuildDir: " << q->m_buildDir;
    qDebug() << "ExeFile: " << q->m_executable;
    #endif

1492
    q->showStatusMessage(tr("Starting Debugger: ") + q->settings()->m_gdbCmd + ' ' + gdbArgs.join(" "));
1493
    m_gdbProc.start(q->settings()->m_gdbCmd, gdbArgs);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1494
    if (!m_gdbProc.waitForStarted()) {
1495
1496
        QMessageBox::critical(q->mainWindow(), tr("Debugger Startup Failure"),
                              tr("Cannot start debugger: %1").arg(m_gdbProc.errorString()));
1497
        m_outputCollector.shutdown();
con's avatar
con committed
1498
        return false;
1499
    }
con's avatar
con committed
1500

1501
    q->showStatusMessage(tr("Gdb Running"));
con's avatar
con committed
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517

    sendCommand("show version", GdbShowVersion);
    //sendCommand("-enable-timings");
    sendCommand("set print static-members off"); // Seemingly doesn't work.
    //sendCommand("define hook-stop\n-thread-list-ids\n-stack-list-frames\nend");
    //sendCommand("define hook-stop\nprint 4\nend");
    //sendCommand("define hookpost-stop\nprint 5\nend");
    //sendCommand("define hook-call\nprint 6\nend");
    //sendCommand("define hookpost-call\nprint 7\nend");
    //sendCommand("set print object on"); // works with CLI, but not MI
    //sendCommand("set step-mode on");  // we can't work with that yes
    //sendCommand("set exec-done-display on");
    //sendCommand("set print pretty on");
    //sendCommand("set confirm off");
    //sendCommand("set pagination off");
    sendCommand("set breakpoint pending on", BreakEnablePending);
1518
    sendCommand("set print elements 10000");
1519
    sendCommand("-data-list-register-names", RegisterListNames);
con's avatar
con committed
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544

    // one of the following is needed to prevent crashes in gdb on code like:
    //  template <class T> T foo() { return T(0); }
    //  int main() { return foo<int>(); }
    //  (gdb) call 'int foo<int>'()
    //  /build/buildd/gdb-6.8/gdb/valops.c:2069: internal-error:
    sendCommand("set overload-resolution off");
    //sendCommand("set demangle-style none");

    // From the docs:
    //  Stop means reenter debugger if this signal happens (implies print).
    //  Print means print a message if this signal happens.
    //  Pass means let program see this signal;
    //  otherwise program doesn't know.
    //  Pass and Stop may be combined.
    // We need "print" as otherwise we would get no feedback whatsoever
    // Custom Dumper crashs which happen regularily for when accessing
    // uninitialized variables.
    sendCommand("handle SIGSEGV nopass stop print");

    // This is useful to kill the inferior whenever gdb dies.
    //sendCommand("handle SIGTERM pass nostop print");

    sendCommand("set unwindonsignal on");
    sendCommand("pwd", GdbQueryPwd);
1545
1546
    sendCommand("set width 0");
    sendCommand("set height 0");
con's avatar
con committed
1547
1548
1549
1550

    #ifdef Q_OS_MAC
    sendCommand("-gdb-set inferior-auto-start-cfm off");
    sendCommand("-gdb-set sharedLibrary load-rules "
con's avatar
con committed
1551
1552
1553
1554
1555
1556
1557
1558
            "dyld \".*libSystem.*\" all "
            "dyld \".*libauto.*\" all "
            "dyld \".*AppKit.*\" all "
            "dyld \".*PBGDBIntrospectionSupport.*\" all "
            "dyld \".*Foundation.*\" all "
            "dyld \".*CFDataFormatters.*\" all "
            "dyld \".*libobjc.*\" all "
            "dyld \".*CarbonDataFormatters.*\" all");
con's avatar
con committed
1559
    #endif
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575

    QString scriptFileName = q->settings()->m_scriptFile;
    if (!scriptFileName.isEmpty()) {
        QFile scriptFile(scriptFileName);
        if (scriptFile.open(QIODevice::ReadOnly)) {
            sendCommand("source " + scriptFileName);
        } else {
            QMessageBox::warning(q->mainWindow(),
            tr("Cannot find debugger initialization script"),
            tr("The debugger settings point to a script file at '%1' "
               "which is not accessible. If a script file is not needed, "
               "consider clearing that entry to avoid this warning. "
              ).arg(scriptFileName));
        }
    }

1576
    if (q->startMode() == DebuggerManager::AttachExternal) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1577
        sendCommand("attach " + QString::number(q->m_attachedPID), GdbAttached);
1578
    } else {
1579
        // StartInternal or StartExternal
1580
1581
1582
1583
1584
        sendCommand("-file-exec-and-symbols " + fileName, GdbFileExecAndSymbols);
        //sendCommand("file " + fileName, GdbFileExecAndSymbols);
        #ifdef Q_OS_MAC
        sendCommand("sharedlibrary apply-load-rules all");
        #endif
1585
1586
        if (!q->m_processArgs.isEmpty())
            sendCommand("-exec-arguments " + q->m_processArgs.join(" "));
hjk's avatar
hjk committed
1587
        #ifndef Q_OS_MAC
1588
        sendCommand("set auto-solib-add off");
1589
        sendCommand("info target", GdbStart);
1590
1591
1592
1593
1594
1595
1596
        #else
        // On MacOS, breaking in at the entry point wreaks havoc.
        sendCommand("tbreak main");
        m_waitingForFirstBreakpointToBeHit = true;
        qq->notifyInferiorRunningRequested();
        sendCommand("-exec-run");
        #endif
1597
1598
    }

con's avatar
con committed
1599
    // set all to "pending"
1600
    if (q->startMode() == DebuggerManager::AttachExternal)
con's avatar
con committed
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
        qq->breakHandler()->removeAllBreakpoints();
    else
        qq->breakHandler()->setAllPending();

    return true;
}

void GdbEngine::continueInferior()
{
    q->resetLocation();
    setTokenBarrier();
1612
    qq->notifyInferiorRunningRequested();
con's avatar
con committed
1613
1614
1615
    sendCommand("-exec-continue", GdbExecContinue);
}

1616
void GdbEngine::handleStart(const GdbResultRecord &response)
1617
{
1618
#ifdef Q_OS_MAC
1619
    Q_UNUSED(response);
1620
#else
1621
    if (response.resultClass == GdbResultDone) {
1622
1623
1624
        // [some leading stdout here]
        // stdout:&"        Entry point: 0x80831f0  0x08048134 - 0x08048147 is .interp\n"
        // [some trailing stdout here]
1625
        QString msg = response.data.findChild("consolestreamoutput").data();
1626
1627
        QRegExp needle("\\bEntry point: (0x[0-9a-f]+)\\b");
        if (needle.indexIn(msg) != -1) {
hjk's avatar
hjk committed
1628
            //debugMessage("STREAM: " + msg + " " + needle.cap(1));
1629
            sendCommand("tbreak *" + needle.cap(1));
1630
            m_waitingForFirstBreakpointToBeHit = true;
1631
            qq->notifyInferiorRunningRequested();
1632
            sendCommand("-exec-run");
1633
        } else {
hjk's avatar
hjk committed
1634
            debugMessage("PARSING START ADDRESS FAILED: " + msg);
1635
1636
        }
    } else if (response.resultClass == GdbResultError) {
1637
        debugMessage("FETCHING START ADDRESS FAILED: " + response.toString());
1638
    }
1639
#endif
1640
1641
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
void GdbEngine::handleAttach()
{
    qq->notifyInferiorStopped();
    q->showStatusMessage(tr("Attached to running process. Stopped."));
    handleAqcuiredInferior();

    q->resetLocation();

    //
    // Stack
    //
    qq->stackHandler()->setCurrentIndex(0);
    updateLocals(); // Quick shot

    sendSynchronizedCommand("-stack-list-frames", StackListFrames);
    if (supportsThreads())