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

30 31
#define QT_NO_CAST_FROM_ASCII

con's avatar
con committed
32
#include "gdbengine.h"
33
#include "gdboptionspage.h"
34 35
#include "trkoptions.h"
#include "trkoptionspage.h"
36

37 38
#include "attachgdbadapter.h"
#include "coregdbadapter.h"
hjk's avatar
hjk committed
39
#include "plaingdbadapter.h"
40
#include "remotegdbadapter.h"
41
#include "trkgdbadapter.h"
con's avatar
con committed
42

43
#include "watchutils.h"
44
#include "debuggeractions.h"
45
#include "debuggeragents.h"
con's avatar
con committed
46 47
#include "debuggerconstants.h"
#include "debuggermanager.h"
48
#include "debuggertooltip.h"
49
#include "debuggerstringutils.h"
con's avatar
con committed
50 51 52 53 54 55 56
#include "gdbmi.h"

#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "stackhandler.h"
#include "watchhandler.h"
57
#include "sourcefileswindow.h"
con's avatar
con committed
58

59
#include "debuggerdialogs.h"
con's avatar
con committed
60

hjk's avatar
hjk committed
61
#include <utils/qtcassert.h>
62
#include <utils/fancymainwindow.h>
63
#include <texteditor/itexteditor.h>
64
#include <projectexplorer/toolchain.h>
65
#include <coreplugin/icore.h>
hjk's avatar
hjk committed
66

con's avatar
con committed
67 68 69
#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
70
#include <QtCore/QMetaObject>
con's avatar
con committed
71 72
#include <QtCore/QTime>
#include <QtCore/QTimer>
73
#include <QtCore/QTextStream>
con's avatar
con committed
74 75

#include <QtGui/QAction>
76
#include <QtCore/QCoreApplication>
con's avatar
con committed
77 78 79
#include <QtGui/QLabel>
#include <QtGui/QMainWindow>
#include <QtGui/QMessageBox>
80 81
#include <QtGui/QDialogButtonBox>
#include <QtGui/QPushButton>
82
#ifdef Q_OS_WIN
83
#    include "shared/sharedlibraryinjector.h"
84
#endif
con's avatar
con committed
85

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
86
#ifdef Q_OS_UNIX
con's avatar
con committed
87 88 89
#include <unistd.h>
#include <dlfcn.h>
#endif
hjk's avatar
hjk committed
90
#include <ctype.h>
con's avatar
con committed
91

92 93
namespace Debugger {
namespace Internal {
con's avatar
con committed
94 95

//#define DEBUG_PENDING  1
96
//#define DEBUG_SUBITEM  1
con's avatar
con committed
97 98 99 100

#if DEBUG_PENDING
#   define PENDING_DEBUG(s) qDebug() << s
#else
Roberto Raggi's avatar
Roberto Raggi committed
101
#   define PENDING_DEBUG(s)
con's avatar
con committed
102 103
#endif

104 105
#define CB(callback) &GdbEngine::callback, STRINGIFY(callback)

hjk's avatar
hjk committed
106
static bool stateAcceptsGdbCommands(DebuggerState state)
hjk's avatar
hjk committed
107 108
{
    return state == AdapterStarted
109
        || state == InferiorUnrunnable
hjk's avatar
hjk committed
110
        || state == InferiorStarting
hjk's avatar
hjk committed
111 112 113 114
        || state == InferiorRunningRequested
        || state == InferiorRunning
        || state == InferiorStopping
        || state == InferiorStopped
hjk's avatar
hjk committed
115 116 117 118 119
        || state == InferiorShuttingDown
        || state == InferiorShutDown
        || state == AdapterShuttingDown;
};

con's avatar
con committed
120 121 122 123 124 125
static int &currentToken()
{
    static int token = 0;
    return token;
}

126
// reads a MI-encoded item frome the consolestream
hjk's avatar
hjk committed
127
static bool parseConsoleStream(const GdbResponse &response, GdbMi *contents)
128
{
hjk's avatar
hjk committed
129
    GdbMi output = response.data.findChild("consolestreamoutput");
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
    QByteArray out = output.data();

    int markerPos = out.indexOf('"') + 1; // position of 'success marker'
    if (markerPos == 0 || out.at(markerPos) == 'f') {  // 't' or 'f'
        // custom dumper produced no output
        return false;
    }

    out = out.mid(markerPos +  1);
    out = out.left(out.lastIndexOf('"'));
    // optimization: dumper output never needs real C unquoting
    out.replace('\\', "");
    out = "dummy={" + out + "}";

    contents->fromString(out);
    //qDebug() << "CONTENTS" << contents->toString(true);
    return contents->isValid();
}

hjk's avatar
hjk committed
149
static QByteArray parsePlainConsoleStream(const GdbResponse &response)
150
{
hjk's avatar
hjk committed
151
    GdbMi output = response.data.findChild("consolestreamoutput");
152 153 154 155 156 157 158 159 160 161
    QByteArray out = output.data();
    // FIXME: proper decoding needed
    if (out.endsWith("\\n"))
        out.chop(2);
    while (out.endsWith('\n') || out.endsWith(' '))
        out.chop(1);
    int pos = out.indexOf(" = ");
    return out.mid(pos + 3);
}

con's avatar
con committed
162 163 164 165 166 167
///////////////////////////////////////////////////////////////////////
//
// GdbEngine
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
168 169
GdbEngine::GdbEngine(DebuggerManager *manager) :
    IDebuggerEngine(manager),
170
#ifdef Q_OS_WIN // Do injection loading with MinGW (call loading does not work with 64bit)
hjk's avatar
hjk committed
171
    m_dumperInjectionLoad(true)
172
#else
hjk's avatar
hjk committed
173
    m_dumperInjectionLoad(false)
174
#endif
con's avatar
con committed
175
{
176 177
    m_trkOptions = QSharedPointer<TrkOptions>(new TrkOptions);
    m_trkOptions->fromSettings(Core::ICore::instance()->settings());
hjk's avatar
hjk committed
178
    m_gdbAdapter = 0;
179

180 181
    connect(theDebuggerAction(AutoDerefPointers), SIGNAL(valueChanged(QVariant)),
            this, SLOT(setAutoDerefPointers(QVariant)));
182
}
183

184
void GdbEngine::connectDebuggingHelperActions()
185
{
186 187 188 189 190 191
    connect(theDebuggerAction(UseDebuggingHelpers), SIGNAL(valueChanged(QVariant)),
            this, SLOT(setUseDebuggingHelpers(QVariant)));
    connect(theDebuggerAction(DebugDebuggingHelpers), SIGNAL(valueChanged(QVariant)),
            this, SLOT(setDebugDebuggingHelpers(QVariant)));
    connect(theDebuggerAction(RecheckDebuggingHelpers), SIGNAL(triggered()),
            this, SLOT(recheckDebuggingHelperAvailability()));
192 193
}
   
194 195 196 197 198 199 200
void GdbEngine::disconnectDebuggingHelperActions()
{
    disconnect(theDebuggerAction(UseDebuggingHelpers), 0, this, 0);
    disconnect(theDebuggerAction(DebugDebuggingHelpers), 0, this, 0);
    disconnect(theDebuggerAction(RecheckDebuggingHelpers), 0, this, 0);
}

201 202 203 204
DebuggerStartMode GdbEngine::startMode() const
{
    QTC_ASSERT(!m_startParameters.isNull(), return NoStartMode);
    return m_startParameters->startMode;
con's avatar
con committed
205 206
}

207 208 209 210 211
QMainWindow *GdbEngine::mainWindow() const
{
    return m_manager->mainWindow();
}

con's avatar
con committed
212 213
GdbEngine::~GdbEngine()
{
hjk's avatar
hjk committed
214
    // prevent sending error messages afterwards
215
    delete m_gdbAdapter;
hjk's avatar
hjk committed
216 217
}

218
void GdbEngine::connectAdapter()
con's avatar
con committed
219 220
{
    // Gdb Process interaction
hjk's avatar
hjk committed
221
    connect(m_gdbAdapter, SIGNAL(readyReadStandardOutput()),
222
        this, SLOT(readGdbStandardOutput()));
hjk's avatar
hjk committed
223
    connect(m_gdbAdapter, SIGNAL(readyReadStandardError()),
224
        this, SLOT(readGdbStandardError()));
hjk's avatar
hjk committed
225 226 227

    connect(m_gdbAdapter, SIGNAL(adapterStarted()),
        this, SLOT(handleAdapterStarted()));
228 229
    connect(m_gdbAdapter, SIGNAL(adapterStartFailed(QString,QString)),
        this, SLOT(handleAdapterStartFailed(QString,QString)));
hjk's avatar
hjk committed
230 231 232 233 234 235 236 237 238 239 240 241
    connect(m_gdbAdapter, SIGNAL(adapterShutDown()),
        this, SLOT(handleAdapterShutDown()));
    connect(m_gdbAdapter, SIGNAL(adapterShutdownFailed(QString)),
        this, SLOT(handleAdapterShutdownFailed(QString)));

    connect(m_gdbAdapter, SIGNAL(inferiorStartFailed(QString)),
        this, SLOT(handleInferiorStartFailed(QString)));
    connect(m_gdbAdapter, SIGNAL(inferiorShutDown()),
        this, SLOT(handleInferiorShutDown()));
    connect(m_gdbAdapter, SIGNAL(inferiorShutdownFailed(QString)),
        this, SLOT(handleInferiorShutdownFailed(QString)));

242 243
    connect(m_gdbAdapter, SIGNAL(adapterCrashed(QString)),
        this, SLOT(handleAdapterCrashed(QString)));
244
}
245

246 247
void GdbEngine::initializeVariables()
{
248
    m_debuggingHelperState = DebuggingHelperUninitialized;
249
    m_gdbVersion = 100;
hjk's avatar
hjk committed
250
    m_gdbBuildVersion = -1;
hjk's avatar
hjk committed
251
    m_isSynchroneous = false;
252 253 254 255 256 257 258 259 260

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

    m_modulesListOutdated = true;
    m_oldestAcceptableToken = -1;
    m_outputCodec = QTextCodec::codecForLocale();
    m_pendingRequests = 0;
261
    m_commandsDoneCallback = 0;
hjk's avatar
hjk committed
262
    m_commandsToRunOnTemporaryBreak.clear();
263
    m_cookieForToken.clear();
264 265 266 267 268 269

    m_pendingConsoleStreamOutput.clear();
    m_pendingLogStreamOutput.clear();

    m_inbuffer.clear();

270 271 272 273
    // ConverterState has no reset() function.
    m_outputCodecState.~ConverterState();
    new (&m_outputCodecState) QTextCodec::ConverterState();

274 275
    m_currentFunctionArgs.clear();
    m_currentFrame.clear();
276
    m_dumperHelper.clear();
277 278
}

279
QString GdbEngine::errorMessage(QProcess::ProcessError error)
con's avatar
con committed
280 281 282
{
    switch (error) {
        case QProcess::FailedToStart:
283
            return tr("The Gdb process failed to start. Either the "
con's avatar
con committed
284
                "invoked program '%1' is missing, or you may have insufficient "
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
285
                "permissions to invoke the program.")
hjk's avatar
hjk committed
286
                .arg(theDebuggerStringSetting(GdbLocation));
con's avatar
con committed
287
        case QProcess::Crashed:
288
            return tr("The Gdb process crashed some time after starting "
con's avatar
con committed
289 290
                "successfully.");
        case QProcess::Timedout:
291
            return tr("The last waitFor...() function timed out. "
con's avatar
con committed
292 293 294
                "The state of QProcess is unchanged, and you can try calling "
                "waitFor...() again.");
        case QProcess::WriteError:
295
            return tr("An error occurred when attempting to write "
con's avatar
con committed
296 297 298
                "to the Gdb process. For example, the process may not be running, "
                "or it may have closed its input channel.");
        case QProcess::ReadError:
299
            return tr("An error occurred when attempting to read from "
con's avatar
con committed
300 301
                "the Gdb process. For example, the process may not be running.");
        default:
302
            return tr("An unknown error in the Gdb process occurred. ");
con's avatar
con committed
303 304 305 306 307 308 309
    }
}

#if 0
static void dump(const char *first, const char *middle, const QString & to)
{
    QByteArray ba(first, middle - first);
310
    Q_UNUSED(to)
con's avatar
con committed
311 312 313 314 315 316 317 318 319 320 321
    // 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

322 323
void GdbEngine::readDebugeeOutput(const QByteArray &data)
{
324
    m_manager->showApplicationOutput(m_outputCodec->toUnicode(
325 326 327
            data.constData(), data.length(), &m_outputCodecState));
}

hjk's avatar
hjk committed
328 329
void GdbEngine::debugMessage(const QString &msg)
{
330
    gdbOutputAvailable(LogDebug, msg);
hjk's avatar
hjk committed
331 332
}

333
void GdbEngine::handleResponse(const QByteArray &buff)
con's avatar
con committed
334 335 336
{
    static QTime lastTime;

337
    if (theDebuggerBoolSetting(LogTimeStamps))
338 339
        gdbOutputAvailable(LogTime, currentTime());
    gdbOutputAvailable(LogOutput, QString::fromLocal8Bit(buff, buff.length()));
con's avatar
con committed
340 341 342 343 344

#if 0
    qDebug() // << "#### start response handling #### "
        << currentTime()
        << lastTime.msecsTo(QTime::currentTime()) << "ms,"
345 346
        << "buf:" << buff.left(1500) << "..."
        //<< "buf:" << buff
347
        << "size:" << buff.size();
con's avatar
con committed
348
#else
349
    //qDebug() << "buf:" << buff;
con's avatar
con committed
350 351 352 353
#endif

    lastTime = QTime::currentTime();

354 355
    if (buff.isEmpty() || buff == "(gdb) ")
        return;
con's avatar
con committed
356

357 358 359
    const char *from = buff.constData();
    const char *to = from + buff.size();
    const char *inner;
con's avatar
con committed
360

361 362 363 364
    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
365
            break;
366 367 368
    if (from != inner) {
        token = QByteArray(from, inner - from).toInt();
        from = inner;
369
        //qDebug() << "found token" << token;
370
    }
con's avatar
con committed
371

hjk's avatar
hjk committed
372
    // next char decides kind of response
373 374 375 376 377 378 379 380 381 382 383 384 385 386
    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
387

hjk's avatar
hjk committed
388
            GdbMi result;
389 390
            while (from != to) {
                GdbMi data;
hjk's avatar
hjk committed
391
                if (*from != ',') {
hjk's avatar
hjk committed
392 393
                    // happens on archer where we get 
                    // 23^running <NL> *running,thread-id="all" <NL> (gdb) 
hjk's avatar
hjk committed
394
                    result.m_type = GdbMi::Tuple;
hjk's avatar
hjk committed
395 396 397 398 399
                    break;
                }
                ++from; // skip ','
                data.parseResultOrValue(from, to);
                if (data.isValid()) {
hjk's avatar
hjk committed
400 401 402
                    //qDebug() << "parsed result:" << data.toString();
                    result.m_children += data;
                    result.m_type = GdbMi::Tuple;
con's avatar
con committed
403 404
                }
            }
405
            if (asyncClass == "stopped") {
406
                handleStopResponse(result);
407 408
            } else if (asyncClass == "running") {
                // Archer has 'thread-id="all"' here
409 410 411 412
            } else if (asyncClass == "library-loaded") {
                // Archer has 'id="/usr/lib/libdrm.so.2",
                // target-name="/usr/lib/libdrm.so.2",
                // host-name="/usr/lib/libdrm.so.2",
413
                // symbols-loaded="0"
hjk's avatar
hjk committed
414
                QByteArray id = result.findChild("id").data();
415
                if (!id.isEmpty())
hjk's avatar
hjk committed
416
                    showStatusMessage(tr("Library %1 loaded.").arg(_(id)));
hjk's avatar
hjk committed
417 418 419 420
            } else if (asyncClass == "library-unloaded") {
                // Archer has 'id="/usr/lib/libdrm.so.2",
                // target-name="/usr/lib/libdrm.so.2",
                // host-name="/usr/lib/libdrm.so.2"
hjk's avatar
hjk committed
421
                QByteArray id = result.findChild("id").data();
hjk's avatar
hjk committed
422
                showStatusMessage(tr("Library %1 unloaded.").arg(_(id)));
423 424
            } else if (asyncClass == "thread-group-created") {
                // Archer has "{id="28902"}" 
hjk's avatar
hjk committed
425
                QByteArray id = result.findChild("id").data();
hjk's avatar
hjk committed
426
                showStatusMessage(tr("Thread group %1 created.").arg(_(id)));
427 428 429
                int pid = id.toInt();
                if (pid != inferiorPid())
                    handleInferiorPidChanged(pid);
430 431
            } else if (asyncClass == "thread-created") {
                //"{id="1",group-id="28902"}" 
hjk's avatar
hjk committed
432
                QByteArray id = result.findChild("id").data();
hjk's avatar
hjk committed
433
                showStatusMessage(tr("Thread %1 created.").arg(_(id)));
434 435
            } else if (asyncClass == "thread-group-exited") {
                // Archer has "{id="28902"}" 
hjk's avatar
hjk committed
436
                QByteArray id = result.findChild("id").data();
hjk's avatar
hjk committed
437
                showStatusMessage(tr("Thread group %1 exited.").arg(_(id)));
438 439
            } else if (asyncClass == "thread-exited") {
                //"{id="1",group-id="28902"}" 
hjk's avatar
hjk committed
440 441
                QByteArray id = result.findChild("id").data();
                QByteArray groupid = result.findChild("group-id").data();
hjk's avatar
hjk committed
442
                showStatusMessage(tr("Thread %1 in group %2 exited.")
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
443
                    .arg(_(id)).arg(_(groupid)));
hjk's avatar
hjk committed
444
            } else if (asyncClass == "thread-selected") {
hjk's avatar
hjk committed
445
                QByteArray id = result.findChild("id").data();
hjk's avatar
hjk committed
446
                showStatusMessage(tr("Thread %1 selected.").arg(_(id)));
hjk's avatar
hjk committed
447
                //"{id="2"}" 
448
            #if defined(Q_OS_MAC)
449 450 451 452 453 454 455 456 457 458 459
            } 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 {
460
                qDebug() << "IGNORED ASYNC OUTPUT"
hjk's avatar
hjk committed
461
                    << asyncClass << result.toString();
462
            }
463 464
            break;
        }
465

466
        case '~': {
467 468
            QByteArray data = GdbMi::parseCString(from, to);
            m_pendingConsoleStreamOutput += data;
469 470 471 472 473 474 475

            // Parse pid from noise.
            if (!inferiorPid()) {
                // Linux/Mac gdb: [New [Tt]hread 0x545 (LWP 4554)]
                static QRegExp re1(_("New .hread 0x[0-9a-f]+ \\(LWP ([0-9]*)\\)"));
                // MinGW 6.8: [New thread 2437.0x435345]
                static QRegExp re2(_("New .hread ([0-9]+)\\.0x[0-9a-f]*"));
hjk's avatar
hjk committed
476 477 478
                // Mac: [Switching to process 9294 local thread 0x2e03] or
                // [Switching to process 31773]
                static QRegExp re3(_("Switching to process ([0-9]+)"));
479 480 481 482 483
                QTC_ASSERT(re1.isValid() && re2.isValid(), return);
                if (re1.indexIn(_(data)) != -1)
                    maybeHandleInferiorPidChanged(re1.cap(1));
                else if (re2.indexIn(_(data)) != -1)
                    maybeHandleInferiorPidChanged(re2.cap(1));
484 485
                else if (re3.indexIn(_(data)) != -1)
                    maybeHandleInferiorPidChanged(re3.cap(1));
486
            }
487 488

            // Show some messages to give the impression something happens.
hjk's avatar
hjk committed
489
            if (data.startsWith("Reading symbols from "))
490
                showStatusMessage(tr("Reading %1...").arg(_(data.mid(21))), 1000);
491 492 493
            if (data.endsWith('\n'))
                data.chop(1);
            if (data.startsWith("[New ") || data.startsWith("[Thread "))
494
                showStatusMessage(_(data), 1000);
495 496
            break;
        }
497

498
        case '@': {
499
            readDebugeeOutput(GdbMi::parseCString(from, to));
500
            break;
con's avatar
con committed
501 502
        }

503 504 505 506 507 508
        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:"))
hjk's avatar
hjk committed
509
                manager()->showApplicationOutput(_(data.mid(9))); // cut "warning: "
con's avatar
con committed
510 511 512
            break;
        }

513
        case '^': {
hjk's avatar
hjk committed
514
            GdbResponse response;
con's avatar
con committed
515

hjk's avatar
hjk committed
516
            response.token = token;
con's avatar
con committed
517

518 519 520
            for (inner = from; inner != to; ++inner)
                if (*inner < 'a' || *inner > 'z')
                    break;
con's avatar
con committed
521

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
522
            QByteArray resultClass = QByteArray::fromRawData(from, inner - from);
523
            if (resultClass == "done") {
hjk's avatar
hjk committed
524
                response.resultClass = GdbResultDone;
525 526 527
            } else if (resultClass == "running") {
                setState(InferiorRunning);
                showStatusMessage(tr("Running..."));
hjk's avatar
hjk committed
528
                response.resultClass = GdbResultRunning;
529
            } else if (resultClass == "connected") {
hjk's avatar
hjk committed
530
                response.resultClass = GdbResultConnected;
531
            } else if (resultClass == "error") {
hjk's avatar
hjk committed
532
                response.resultClass = GdbResultError;
533
            } else if (resultClass == "exit") {
hjk's avatar
hjk committed
534
                response.resultClass = GdbResultExit;
535
            } else {
hjk's avatar
hjk committed
536
                response.resultClass = GdbResultUnknown;
537
            }
con's avatar
con committed
538

539 540
            from = inner;
            if (from != to) {
hjk's avatar
hjk committed
541 542
                if (*from == ',') {
                    ++from;
hjk's avatar
hjk committed
543 544 545
                    response.data.parseTuple_helper(from, to);
                    response.data.m_type = GdbMi::Tuple;
                    response.data.m_name = "data";
hjk's avatar
hjk committed
546 547
                } else {
                    // Archer has this
hjk's avatar
hjk committed
548 549
                    response.data.m_type = GdbMi::Tuple;
                    response.data.m_name = "data";
con's avatar
con committed
550 551
                }
            }
552 553 554

            //qDebug() << "\nLOG STREAM:" + m_pendingLogStreamOutput;
            //qDebug() << "\nCONSOLE STREAM:" + m_pendingConsoleStreamOutput;
hjk's avatar
hjk committed
555
            response.data.setStreamOutput("logstreamoutput",
556
                m_pendingLogStreamOutput);
hjk's avatar
hjk committed
557
            response.data.setStreamOutput("consolestreamoutput",
558 559 560 561
                m_pendingConsoleStreamOutput);
            m_pendingLogStreamOutput.clear();
            m_pendingConsoleStreamOutput.clear();

hjk's avatar
hjk committed
562
            handleResultRecord(response);
563 564 565 566 567
            break;
        }
        default: {
            qDebug() << "UNKNOWN RESPONSE TYPE" << c;
            break;
con's avatar
con committed
568 569 570 571 572 573
        }
    }
}

void GdbEngine::readGdbStandardError()
{
hjk's avatar
hjk committed
574
    qWarning() << "Unexpected gdb stderr:" << m_gdbAdapter->readAllStandardError();
con's avatar
con committed
575 576 577 578
}

void GdbEngine::readGdbStandardOutput()
{
579 580
    int newstart = 0;
    int scan = m_inbuffer.size();
con's avatar
con committed
581

hjk's avatar
hjk committed
582
    m_inbuffer.append(m_gdbAdapter->readAllStandardOutput());
con's avatar
con committed
583

584 585
    while (newstart < m_inbuffer.size()) {
        int start = newstart;
586
        int end = m_inbuffer.indexOf('\n', scan);
587 588 589 590 591
        if (end < 0) {
            m_inbuffer.remove(0, start);
            return;
        }
        newstart = end + 1;
592
        scan = newstart;
593 594
        if (end == start)
            continue;
595
        #if defined(Q_OS_WIN)
596 597 598 599 600
        if (m_inbuffer.at(end - 1) == '\r') {
            --end;
            if (end == start)
                continue;
        }
601
        #endif
602
        handleResponse(QByteArray::fromRawData(m_inbuffer.constData() + start, end - start));
con's avatar
con committed
603
    }
604
    m_inbuffer.clear();
con's avatar
con committed
605 606 607 608
}

void GdbEngine::interruptInferior()
{
hjk's avatar
hjk committed
609
    QTC_ASSERT(state() == InferiorRunning, qDebug() << state());
610

hjk's avatar
hjk committed
611
    if (state() == DebuggerNotReady) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
612
        debugMessage(_("TRYING TO INTERRUPT INFERIOR WITHOUT RUNNING GDB"));
613
        shutdown();
con's avatar
con committed
614
        return;
hjk's avatar
hjk committed
615
    }
con's avatar
con committed
616

hjk's avatar
hjk committed
617 618 619
    setState(InferiorStopping);
    showStatusMessage(tr("Stop requested..."), 5000);

620
    debugMessage(_("TRYING TO INTERUPT INFERIOR"));
hjk's avatar
hjk committed
621
    m_gdbAdapter->interruptInferior();
con's avatar
con committed
622 623 624 625
}

void GdbEngine::maybeHandleInferiorPidChanged(const QString &pid0)
{
626
    const qint64 pid = pid0.toLongLong();
con's avatar
con committed
627
    if (pid == 0) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
628
        debugMessage(_("Cannot parse PID from %1").arg(pid0));
con's avatar
con committed
629 630
        return;
    }
hjk's avatar
hjk committed
631
    if (pid == inferiorPid())
con's avatar
con committed
632
        return;
633 634
    debugMessage(_("FOUND PID %1").arg(pid));    

635
    handleInferiorPidChanged(pid);
636 637
    if (m_dumperInjectionLoad)
        tryLoadDebuggingHelpers();
con's avatar
con committed
638 639
}

hjk's avatar
hjk committed
640 641
void GdbEngine::postCommand(const QString &command, AdapterCallback callback,
                            const char *callbackName, const QVariant &cookie)
642 643 644 645 646 647 648
{
    postCommand(command, NoFlags, callback, callbackName, cookie);
}

void GdbEngine::postCommand(const QString &command, GdbCommandFlags flags,
                            AdapterCallback callback,
                            const char *callbackName, const QVariant &cookie)
hjk's avatar
hjk committed
649 650 651
{
    GdbCommand cmd;
    cmd.command = command;
652
    cmd.flags = flags;
hjk's avatar
hjk committed
653 654 655 656 657 658
    cmd.adapterCallback = callback;
    cmd.callbackName = callbackName;
    cmd.cookie = cookie;
    postCommandHelper(cmd);
}

659
void GdbEngine::postCommand(const QString &command, GdbCommandCallback callback,
660 661
                            const char *callbackName, const QVariant &cookie)
{
662
    postCommand(command, NoFlags, callback, callbackName, cookie);
663 664
}

665
void GdbEngine::postCommand(const QString &command, GdbCommandFlags flags,
666 667
                            GdbCommandCallback callback, const char *callbackName,
                            const QVariant &cookie)
hjk's avatar
hjk committed
668 669 670 671 672 673 674 675 676 677 678
{
    GdbCommand cmd;
    cmd.command = command;
    cmd.flags = flags;
    cmd.callback = callback;
    cmd.callbackName = callbackName;
    cmd.cookie = cookie;
    postCommandHelper(cmd);
}

void GdbEngine::postCommandHelper(const GdbCommand &cmd)
con's avatar
con committed
679
{
hjk's avatar
hjk committed
680
    if (!stateAcceptsGdbCommands(state())) {
hjk's avatar
hjk committed
681
        PENDING_DEBUG(_("NO GDB PROCESS RUNNING, CMD IGNORED: ") + cmd.command);
682 683
        debugMessage(_("NO GDB PROCESS RUNNING, CMD IGNORED: %1 %2")
            .arg(cmd.command).arg(state()));
con's avatar
con committed
684 685 686
        return;
    }

hjk's avatar
hjk committed
687
    if (cmd.flags & RebuildModel) {
con's avatar
con committed
688
        ++m_pendingRequests;
hjk's avatar
hjk committed
689
        PENDING_DEBUG("   CALLBACK" << cmd.callbackName
690
            << "INCREMENTS PENDING TO:" << m_pendingRequests << cmd.command);
con's avatar
con committed
691
    } else {
hjk's avatar
hjk committed
692
        PENDING_DEBUG("   UNKNOWN CALLBACK" << cmd.callbackName
693
            << "LEAVES PENDING AT:" << m_pendingRequests << cmd.command);
con's avatar
con committed
694 695
    }

hjk's avatar
hjk committed
696
    if (cmd.flags & NeedsStop) {
697
        if (state() == InferiorStopped || state() == AdapterStarted) {
hjk's avatar
hjk committed
698 699 700 701 702 703 704 705 706 707
            // Can be safely sent now.
            flushCommand(cmd);
        } else {
            // Queue the commands that we cannot send at once.
            showStatusMessage(tr("Stopping temporarily."), 1000);
            qDebug() << _("QUEUING COMMAND ") + cmd.command;
            debugMessage(_("QUEUING COMMAND ") + cmd.command);
            m_commandsToRunOnTemporaryBreak.append(cmd);
            interruptInferior();
        }
hjk's avatar
hjk committed
708
    } else if (!cmd.command.isEmpty()) {
709
        flushCommand(cmd);
con's avatar
con committed
710 711 712
    }
}

hjk's avatar
hjk committed
713
void GdbEngine::flushCommand(const GdbCommand &cmd0)
714
{
hjk's avatar
hjk committed
715
    GdbCommand cmd = cmd0;
hjk's avatar
hjk committed
716
    if (state() == DebuggerNotReady) {
717
        gdbInputAvailable(LogInput, cmd.command);
718 719 720 721
        debugMessage(_("GDB PROCESS NOT RUNNING, PLAIN CMD IGNORED: ") + cmd.command);
        return;
    }

722
    ++currentToken();
723
    cmd.postTime = QTime::currentTime();
724 725
    m_cookieForToken[currentToken()] = cmd;
    cmd.command = QString::number(currentToken()) + cmd.command;
726
    if (cmd.flags & EmbedToken)
727
        cmd.command = cmd.command.arg(currentToken());
728
    gdbInputAvailable(LogInput, cmd.command);
729 730

    m_gdbAdapter->write(cmd.command.toLatin1() + "\r\n");
731 732
}

hjk's avatar
hjk committed
733
void GdbEngine::handleResultRecord(const GdbResponse &response)
con's avatar
con committed
734
{
hjk's avatar
hjk committed
735
    //qDebug() << "TOKEN:" << response.token
736
    //    << " ACCEPTABLE:" << m_oldestAcceptableToken;
hjk's avatar
hjk committed
737
    //qDebug() << "\nRESULT" << response.token << response.toString();
con's avatar
con committed
738

hjk's avatar
hjk committed
739
    int token = response.token;
con's avatar
con committed
740 741 742
    if (token == -1)
        return;

743
    if (!m_cookieForToken.contains(token)) {
744 745 746 747
        // In theory this should not happen (rather the error should be
        // reported in the "first" response to the command) in practice it
        // does. We try to handle a few situations we are aware of gracefully.
        // Ideally, this code should not be present at all.
748 749
        debugMessage(_("COOKIE FOR TOKEN %1 ALREADY EATEN. "
            "TWO RESPONSES FOR ONE COMMAND?").arg(token));
hjk's avatar
hjk committed
750 751
        if (response.resultClass == GdbResultError) {
            QByteArray msg = response.data.findChild("msg").data();
752 753 754 755 756 757 758
            if (msg == "Cannot find new threads: generic error") {
                // Handle a case known to occur on Linux/gdb 6.8 when debugging moc
                // with helpers enabled. In this case we get a second response with
                // msg="Cannot find new threads: generic error"
                showMessageBox(QMessageBox::Critical,
                    tr("Executable failed"), QString::fromLocal8Bit(msg));
                showStatusMessage(tr("Process failed to start."));
759
                shutdown();
760 761 762
            } else if (msg == "\"finish\" not meaningful in the outermost frame.") { 
                // Handle a case known to appear on gdb 6.4 symbianelf when
                // the stack is cut due to access to protected memory.
763 764
                setState(InferiorStopping);
                setState(InferiorStopped);
765 766 767 768 769 770 771 772 773 774 775
            } else if (msg.startsWith("Cannot find bounds of current function")) {
                // Happens when running "-exec-next" in a function for which
                // there is no debug information. Divert to "-exec-next-step"
                setState(InferiorStopping);
                setState(InferiorStopped);
                nextIExec();
            } else {
                showMessageBox(QMessageBox::Critical,
                    tr("Executable failed"), QString::fromLocal8Bit(msg));
                showStatusMessage(tr("Executable failed: %1")
                    .arg(QString::fromLocal8Bit(msg)));
776
            }
777 778 779 780
        }
        return;
    }

781
    GdbCommand cmd = m_cookieForToken.take(token);
782
    if (theDebuggerBoolSetting(LogTimeStamps)) {
783
        gdbOutputAvailable(LogTime, _("Response time: %1: %2 s")
784 785 786
            .arg(cmd.command)
            .arg(cmd.postTime.msecsTo(QTime::currentTime()) / 1000.));
    }
con's avatar
con committed
787

hjk's avatar
hjk committed
788
    if (response.token < m_oldestAcceptableToken && (cmd.flags & Discardable)) {
789
        //debugMessage(_("### SKIPPING OLD RESULT") + response.toString());
con's avatar
con committed
790 791 792
        return;
    }

hjk's avatar
hjk committed
793 794 795
    GdbResponse responseWithCookie = response;
    responseWithCookie.cookie = cmd.cookie;

796
    if (response.resultClass != GdbResultError &&
797 798 799 800 801 802
        response.resultClass != ((cmd.flags & RunRequest) ? GdbResultRunning :
                                 (cmd.flags & ExitRequest) ? GdbResultExit :
                                 GdbResultDone)) {
        QString rsp = _(GdbResponse::stringFromResultClass(response.resultClass));
        qWarning() << "UNEXPECTED RESPONSE " << rsp << " TO COMMAND" << cmd.command << " AT " __FILE__ ":" STRINGIFY(__LINE__);
        debugMessage(_("UNEXPECTED RESPONSE %1 TO COMMAND %2").arg(rsp).arg(cmd.command));
803 804 805 806 807 808
    } else {
        if (cmd.callback)
            (this->*cmd.callback)(responseWithCookie);
        else if (cmd.adapterCallback)
            (m_gdbAdapter->*cmd.adapterCallback)(responseWithCookie);
    }
con's avatar
con committed
809

810
    if (cmd.flags & RebuildModel) {
con's avatar
con committed
811
        --m_pendingRequests;
hjk's avatar
hjk committed
812
        PENDING_DEBUG("   TYPE " << cmd.callbackName << " DECREMENTS PENDING TO: "
con's avatar
con committed
813
            << m_pendingRequests << cmd.command);
814
        if (m_pendingRequests <= 0) {
hjk's avatar
hjk committed
815 816
            PENDING_DEBUG("\n\n ....  AND TRIGGERS MODEL UPDATE\n");
            rebuildModel();
817
        }
con's avatar
con committed
818
    } else {
hjk's avatar
hjk committed
819
        PENDING_DEBUG("   UNKNOWN TYPE " << cmd.callbackName << " LEAVES PENDING AT: "
con's avatar
con committed
820 821
            << m_pendingRequests << cmd.command);
    }
822

823 824
    // Continue only if there are no commands wire anymore, so this will
    // be fully synchroneous.
825 826 827 828
    // This is somewhat inefficient, as it makes the last command synchronous.
    // An optimization would be requesting the continue immediately when the
    // event loop is entered, and let individual commands have a flag to suppress
    // that behavior.
829
    if (m_commandsDoneCallback && m_cookieForToken.isEmpty()) {
830
        debugMessage(_("ALL COMMANDS DONE; INVOKING CALLBACK"));
831 832
        CommandsDoneCallback cont = m_commandsDoneCallback;
        m_commandsDoneCallback = 0;
hjk's avatar
hjk committed
833 834 835
        (this->*cont)();
    } else {
        PENDING_DEBUG("MISSING TOKENS: " << m_cookieForToken.keys());
836
    }
con's avatar
con committed
837 838 839 840
}

void GdbEngine::executeDebuggerCommand(const QString &command)
{
hjk's avatar
hjk committed
841
    if (state() == DebuggerNotReady) {
842
        debugMessage(_("GDB PROCESS NOT RUNNING, PLAIN CMD IGNORED: ") + command);
con's avatar
con committed
843 844 845
        return;
    }

hjk's avatar
hjk committed
846
    m_gdbAdapter->write(command.toLatin1() + "\r\n");
con's avatar
con committed
847 848
}

849
// Called from CoreAdapter and AttachAdapter
850
void GdbEngine::updateAll()
851
{
852
    QTC_ASSERT(state() == InferiorUnrunnable || state() == InferiorStopped, /**/);
853
    tryLoadDebuggingHelpers();
hjk's avatar
hjk committed
854 855
    postCommand(_("-stack-list-frames"), WatchUpdate, CB(handleStackListFrames),
        QVariant::fromValue<StackCookie>(StackCookie(false, true)));
856
    manager()->stackHandler()->setCurrentIndex(0);
857
    if (supportsThreads())
858
        postCommand(_("-thread-list-ids"), WatchUpdate, CB(handleStackListThreads), 0);
hjk's avatar
hjk committed
859
    manager()->reloadRegisters();
hjk's avatar
hjk committed
860
    updateLocals(); 
861 862
}

hjk's avatar
hjk committed
863
void GdbEngine::handleQuerySources(const GdbResponse &response)
con's avatar
con committed
864
{
hjk's avatar
hjk committed
865
    if (response.resultClass == GdbResultDone) {
866
        QMap<QString, QString> oldShortToFull = m_shortToFullName;
con's avatar
con committed
867 868 869 870
        m_shortToFullName.clear();
        m_fullToShortName.clear();
        // "^done,files=[{file="../../../../bin/gdbmacros/gdbmacros.cpp",
        // fullname="/data5/dev/ide/main/bin/gdbmacros/gdbmacros.cpp"},
hjk's avatar
hjk committed
871
        GdbMi files = response.data.findChild("files");
con's avatar
con committed
872
        foreach (const GdbMi &item, files.children()) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
873
            QString fileName = QString::fromLocal8Bit(item.findChild("file").data());
con's avatar
con committed
874
            GdbMi fullName = item.findChild("fullname");
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
875
            QString full = QString::fromLocal8Bit(fullName.data());
con's avatar
con committed
876 877 878 879 880 881 882 883
            #ifdef Q_OS_WIN
            full = QDir::cleanPath(full);
            #endif
            if (fullName.isValid() && QFileInfo(full).isReadable()) {
                m_shortToFullName[fileName] = full;
                m_fullToShortName[full] = fileName;
            }
        }