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

hjk's avatar
hjk committed
92
// FIXME: temporary hack to evalaute tbreak based step-over behaviour
hjk's avatar
hjk committed
93 94 95
static QString lastFile;
static int lastLine;

96 97
namespace Debugger {
namespace Internal {
con's avatar
con committed
98 99

//#define DEBUG_PENDING  1
100
//#define DEBUG_SUBITEM  1
con's avatar
con committed
101 102 103 104

#if DEBUG_PENDING
#   define PENDING_DEBUG(s) qDebug() << s
#else
Roberto Raggi's avatar
Roberto Raggi committed
105
#   define PENDING_DEBUG(s)
con's avatar
con committed
106 107
#endif

108 109
#define CB(callback) &GdbEngine::callback, STRINGIFY(callback)

hjk's avatar
hjk committed
110
static bool stateAcceptsGdbCommands(DebuggerState state)
hjk's avatar
hjk committed
111 112
{
    return state == AdapterStarted
113
        || state == InferiorUnrunnable
hjk's avatar
hjk committed
114 115 116
        || state == InferiorPreparing
        || state == InferiorPrepared
        || state == InferiorStarting
hjk's avatar
hjk committed
117 118 119 120
        || state == InferiorRunningRequested
        || state == InferiorRunning
        || state == InferiorStopping
        || state == InferiorStopped
hjk's avatar
hjk committed
121 122 123 124 125
        || state == InferiorShuttingDown
        || state == InferiorShutDown
        || state == AdapterShuttingDown;
};

con's avatar
con committed
126 127 128 129 130 131
static int &currentToken()
{
    static int token = 0;
    return token;
}

132
// reads a MI-encoded item frome the consolestream
hjk's avatar
hjk committed
133
static bool parseConsoleStream(const GdbResponse &response, GdbMi *contents)
134
{
hjk's avatar
hjk committed
135
    GdbMi output = response.data.findChild("consolestreamoutput");
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
    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
155
static QByteArray parsePlainConsoleStream(const GdbResponse &response)
156
{
hjk's avatar
hjk committed
157
    GdbMi output = response.data.findChild("consolestreamoutput");
158 159 160 161 162 163 164 165 166 167
    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
168 169 170 171 172 173
///////////////////////////////////////////////////////////////////////
//
// GdbEngine
//
///////////////////////////////////////////////////////////////////////

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

186 187
    connect(theDebuggerAction(AutoDerefPointers), SIGNAL(valueChanged(QVariant)),
            this, SLOT(setAutoDerefPointers(QVariant)));
188
}
189

190
void GdbEngine::connectDebuggingHelperActions()
191
{
192 193 194 195 196 197
    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()));
198 199
}
   
200 201 202 203 204 205 206
void GdbEngine::disconnectDebuggingHelperActions()
{
    disconnect(theDebuggerAction(UseDebuggingHelpers), 0, this, 0);
    disconnect(theDebuggerAction(DebugDebuggingHelpers), 0, this, 0);
    disconnect(theDebuggerAction(RecheckDebuggingHelpers), 0, this, 0);
}

207 208 209 210
DebuggerStartMode GdbEngine::startMode() const
{
    QTC_ASSERT(!m_startParameters.isNull(), return NoStartMode);
    return m_startParameters->startMode;
con's avatar
con committed
211 212
}

213 214 215 216 217
QMainWindow *GdbEngine::mainWindow() const
{
    return m_manager->mainWindow();
}

con's avatar
con committed
218 219
GdbEngine::~GdbEngine()
{
hjk's avatar
hjk committed
220
    // prevent sending error messages afterwards
221
    delete m_gdbAdapter;
hjk's avatar
hjk committed
222 223
}

224
void GdbEngine::connectAdapter()
con's avatar
con committed
225 226
{
    // Gdb Process interaction
hjk's avatar
hjk committed
227
    connect(m_gdbAdapter, SIGNAL(readyReadStandardOutput()),
228
        this, SLOT(readGdbStandardOutput()));
hjk's avatar
hjk committed
229
    connect(m_gdbAdapter, SIGNAL(readyReadStandardError()),
230
        this, SLOT(readGdbStandardError()));
hjk's avatar
hjk committed
231 232 233

    connect(m_gdbAdapter, SIGNAL(adapterStarted()),
        this, SLOT(handleAdapterStarted()));
234 235
    connect(m_gdbAdapter, SIGNAL(adapterStartFailed(QString,QString)),
        this, SLOT(handleAdapterStartFailed(QString,QString)));
hjk's avatar
hjk committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    connect(m_gdbAdapter, SIGNAL(adapterShutDown()),
        this, SLOT(handleAdapterShutDown()));
    connect(m_gdbAdapter, SIGNAL(adapterShutdownFailed(QString)),
        this, SLOT(handleAdapterShutdownFailed(QString)));

    connect(m_gdbAdapter, SIGNAL(inferiorPrepared()),
        this, SLOT(handleInferiorPrepared()));
    connect(m_gdbAdapter, SIGNAL(inferiorPreparationFailed(QString)),
        this, SLOT(handleInferiorPreparationFailed(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)));

253 254
    connect(m_gdbAdapter, SIGNAL(adapterCrashed(QString)),
        this, SLOT(handleAdapterCrashed(QString)));
255
}
256

257 258
void GdbEngine::initializeVariables()
{
259
    m_debuggingHelperState = DebuggingHelperUninitialized;
260
    m_gdbVersion = 100;
hjk's avatar
hjk committed
261
    m_gdbBuildVersion = -1;
262 263 264 265 266 267 268 269 270

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

    m_modulesListOutdated = true;
    m_oldestAcceptableToken = -1;
    m_outputCodec = QTextCodec::codecForLocale();
    m_pendingRequests = 0;
271
    m_commandsDoneCallback = 0;
hjk's avatar
hjk committed
272
    m_commandsToRunOnTemporaryBreak.clear();
273
    m_cookieForToken.clear();
274 275 276 277 278 279 280
    m_customOutputForToken.clear();

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

    m_inbuffer.clear();

281 282 283 284
    // ConverterState has no reset() function.
    m_outputCodecState.~ConverterState();
    new (&m_outputCodecState) QTextCodec::ConverterState();

285 286
    m_currentFunctionArgs.clear();
    m_currentFrame.clear();
287
    m_dumperHelper.clear();
288 289
}

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

#if 0
static void dump(const char *first, const char *middle, const QString & to)
{
    QByteArray ba(first, middle - first);
321
    Q_UNUSED(to)
con's avatar
con committed
322 323 324 325 326 327 328 329 330 331 332
    // 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

333 334
void GdbEngine::readDebugeeOutput(const QByteArray &data)
{
335
    m_manager->showApplicationOutput(m_outputCodec->toUnicode(
336 337 338
            data.constData(), data.length(), &m_outputCodecState));
}

hjk's avatar
hjk committed
339 340
void GdbEngine::debugMessage(const QString &msg)
{
341
    gdbOutputAvailable(LogDebug, msg);
hjk's avatar
hjk committed
342 343
}

344
void GdbEngine::handleResponse(const QByteArray &buff)
con's avatar
con committed
345 346 347
{
    static QTime lastTime;

348
    if (theDebuggerBoolSetting(LogTimeStamps))
349 350
        gdbOutputAvailable(LogTime, currentTime());
    gdbOutputAvailable(LogOutput, QString::fromLocal8Bit(buff, buff.length()));
con's avatar
con committed
351 352 353 354 355

#if 0
    qDebug() // << "#### start response handling #### "
        << currentTime()
        << lastTime.msecsTo(QTime::currentTime()) << "ms,"
356 357
        << "buf:" << buff.left(1500) << "..."
        //<< "buf:" << buff
358
        << "size:" << buff.size();
con's avatar
con committed
359
#else
360
    //qDebug() << "buf:" << buff;
con's avatar
con committed
361 362 363 364
#endif

    lastTime = QTime::currentTime();

365 366
    if (buff.isEmpty() || buff == "(gdb) ")
        return;
con's avatar
con committed
367

368 369 370
    const char *from = buff.constData();
    const char *to = from + buff.size();
    const char *inner;
con's avatar
con committed
371

372 373 374 375
    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
376
            break;
377 378 379
    if (from != inner) {
        token = QByteArray(from, inner - from).toInt();
        from = inner;
380
        //qDebug() << "found token" << token;
381
    }
con's avatar
con committed
382

hjk's avatar
hjk committed
383
    // next char decides kind of response
384 385 386 387 388 389 390 391 392 393 394 395 396 397
    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
398

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

477
        case '~': {
478 479
            QByteArray data = GdbMi::parseCString(from, to);
            m_pendingConsoleStreamOutput += data;
480 481 482 483 484 485 486

            // 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
487 488 489
                // Mac: [Switching to process 9294 local thread 0x2e03] or
                // [Switching to process 31773]
                static QRegExp re3(_("Switching to process ([0-9]+)"));
490 491 492 493 494
                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));
495 496
                else if (re3.indexIn(_(data)) != -1)
                    maybeHandleInferiorPidChanged(re3.cap(1));
497
            }
498 499

            // Show some messages to give the impression something happens.
hjk's avatar
hjk committed
500
            if (data.startsWith("Reading symbols from "))
501
                showStatusMessage(tr("Reading %1...").arg(_(data.mid(21))), 1000);
502 503 504
            if (data.endsWith('\n'))
                data.chop(1);
            if (data.startsWith("[New ") || data.startsWith("[Thread "))
505
                showStatusMessage(_(data), 1000);
506 507
            break;
        }
508

509
        case '@': {
510
            readDebugeeOutput(GdbMi::parseCString(from, to));
511
            break;
con's avatar
con committed
512 513
        }

514 515 516 517 518 519
        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
520
                manager()->showApplicationOutput(_(data.mid(9))); // cut "warning: "
con's avatar
con committed
521 522 523
            break;
        }

524
        case '^': {
hjk's avatar
hjk committed
525
            GdbResponse response;
con's avatar
con committed
526

hjk's avatar
hjk committed
527
            response.token = token;
con's avatar
con committed
528

529 530 531
            for (inner = from; inner != to; ++inner)
                if (*inner < 'a' || *inner > 'z')
                    break;
con's avatar
con committed
532

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
533
            QByteArray resultClass = QByteArray::fromRawData(from, inner - from);
534
            if (resultClass == "done") {
hjk's avatar
hjk committed
535
                response.resultClass = GdbResultDone;
536 537 538
            } else if (resultClass == "running") {
                setState(InferiorRunning);
                showStatusMessage(tr("Running..."));
hjk's avatar
hjk committed
539
                response.resultClass = GdbResultRunning;
540
            } else if (resultClass == "connected") {
hjk's avatar
hjk committed
541
                response.resultClass = GdbResultConnected;
542
            } else if (resultClass == "error") {
hjk's avatar
hjk committed
543
                response.resultClass = GdbResultError;
544
            } else if (resultClass == "exit") {
hjk's avatar
hjk committed
545
                response.resultClass = GdbResultExit;
546
            } else {
hjk's avatar
hjk committed
547
                response.resultClass = GdbResultUnknown;
548
            }
con's avatar
con committed
549

550 551
            from = inner;
            if (from != to) {
hjk's avatar
hjk committed
552 553
                if (*from == ',') {
                    ++from;
hjk's avatar
hjk committed
554 555 556
                    response.data.parseTuple_helper(from, to);
                    response.data.m_type = GdbMi::Tuple;
                    response.data.m_name = "data";
hjk's avatar
hjk committed
557 558
                } else {
                    // Archer has this
hjk's avatar
hjk committed
559 560
                    response.data.m_type = GdbMi::Tuple;
                    response.data.m_name = "data";
con's avatar
con committed
561 562
                }
            }
563 564 565

            //qDebug() << "\nLOG STREAM:" + m_pendingLogStreamOutput;
            //qDebug() << "\nCONSOLE STREAM:" + m_pendingConsoleStreamOutput;
hjk's avatar
hjk committed
566
            response.data.setStreamOutput("logstreamoutput",
567
                m_pendingLogStreamOutput);
hjk's avatar
hjk committed
568
            response.data.setStreamOutput("consolestreamoutput",
569 570 571
                m_pendingConsoleStreamOutput);
            QByteArray custom = m_customOutputForToken[token];
            if (!custom.isEmpty())
hjk's avatar
hjk committed
572
                response.data.setStreamOutput("customvaluecontents",
573 574 575 576 577
                    '{' + custom + '}');
            //m_customOutputForToken.remove(token);
            m_pendingLogStreamOutput.clear();
            m_pendingConsoleStreamOutput.clear();

hjk's avatar
hjk committed
578
            handleResultRecord(response);
579 580 581 582 583
            break;
        }
        default: {
            qDebug() << "UNKNOWN RESPONSE TYPE" << c;
            break;
con's avatar
con committed
584 585 586 587 588 589
        }
    }
}

void GdbEngine::readGdbStandardError()
{
hjk's avatar
hjk committed
590
    qWarning() << "Unexpected gdb stderr:" << m_gdbAdapter->readAllStandardError();
con's avatar
con committed
591 592 593 594
}

void GdbEngine::readGdbStandardOutput()
{
595 596
    int newstart = 0;
    int scan = m_inbuffer.size();
con's avatar
con committed
597

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

600 601
    while (newstart < m_inbuffer.size()) {
        int start = newstart;
602
        int end = m_inbuffer.indexOf('\n', scan);
603 604 605 606 607
        if (end < 0) {
            m_inbuffer.remove(0, start);
            return;
        }
        newstart = end + 1;
608
        scan = newstart;
609 610
        if (end == start)
            continue;
611
        #if defined(Q_OS_WIN)
612 613 614 615 616
        if (m_inbuffer.at(end - 1) == '\r') {
            --end;
            if (end == start)
                continue;
        }
617
        #endif
618
        handleResponse(QByteArray::fromRawData(m_inbuffer.constData() + start, end - start));
con's avatar
con committed
619
    }
620
    m_inbuffer.clear();
con's avatar
con committed
621 622 623 624
}

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

hjk's avatar
hjk committed
627
    if (state() == DebuggerNotReady) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
628
        debugMessage(_("TRYING TO INTERRUPT INFERIOR WITHOUT RUNNING GDB"));
629
        shutdown();
con's avatar
con committed
630
        return;
hjk's avatar
hjk committed
631
    }
con's avatar
con committed
632

hjk's avatar
hjk committed
633 634 635
    setState(InferiorStopping);
    showStatusMessage(tr("Stop requested..."), 5000);

636
    debugMessage(_("TRYING TO INTERUPT INFERIOR"));
hjk's avatar
hjk committed
637
    m_gdbAdapter->interruptInferior();
con's avatar
con committed
638 639 640 641
}

void GdbEngine::maybeHandleInferiorPidChanged(const QString &pid0)
{
642
    const qint64 pid = pid0.toLongLong();
con's avatar
con committed
643
    if (pid == 0) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
644
        debugMessage(_("Cannot parse PID from %1").arg(pid0));
con's avatar
con committed
645 646
        return;
    }
hjk's avatar
hjk committed
647
    if (pid == inferiorPid())
con's avatar
con committed
648
        return;
649 650
    debugMessage(_("FOUND PID %1").arg(pid));    

651
    handleInferiorPidChanged(pid);
652 653
    if (m_dumperInjectionLoad)
        tryLoadDebuggingHelpers();
con's avatar
con committed
654 655
}

hjk's avatar
hjk committed
656 657
void GdbEngine::postCommand(const QString &command, AdapterCallback callback,
                            const char *callbackName, const QVariant &cookie)
658 659 660 661 662 663 664
{
    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
665 666 667
{
    GdbCommand cmd;
    cmd.command = command;
668
    cmd.flags = flags;
hjk's avatar
hjk committed
669 670 671 672 673 674
    cmd.adapterCallback = callback;
    cmd.callbackName = callbackName;
    cmd.cookie = cookie;
    postCommandHelper(cmd);
}

675
void GdbEngine::postCommand(const QString &command, GdbCommandCallback callback,
676 677
                            const char *callbackName, const QVariant &cookie)
{
678
    postCommand(command, NoFlags, callback, callbackName, cookie);
679 680
}

681
void GdbEngine::postCommand(const QString &command, GdbCommandFlags flags,
682 683
                            GdbCommandCallback callback, const char *callbackName,
                            const QVariant &cookie)
hjk's avatar
hjk committed
684 685 686 687 688 689 690 691 692 693 694
{
    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
695
{
hjk's avatar
hjk committed
696
    if (!stateAcceptsGdbCommands(state())) {
hjk's avatar
hjk committed
697
        PENDING_DEBUG(_("NO GDB PROCESS RUNNING, CMD IGNORED: ") + cmd.command);
698 699
        debugMessage(_("NO GDB PROCESS RUNNING, CMD IGNORED: %1 %2")
            .arg(cmd.command).arg(state()));
con's avatar
con committed
700 701 702
        return;
    }

hjk's avatar
hjk committed
703
    if (cmd.flags & RebuildModel) {
con's avatar
con committed
704
        ++m_pendingRequests;
hjk's avatar
hjk committed
705
        PENDING_DEBUG("   CALLBACK" << cmd.callbackName
706
            << "INCREMENTS PENDING TO:" << m_pendingRequests << cmd.command);
con's avatar
con committed
707
    } else {
hjk's avatar
hjk committed
708
        PENDING_DEBUG("   UNKNOWN CALLBACK" << cmd.callbackName
709
            << "LEAVES PENDING AT:" << m_pendingRequests << cmd.command);
con's avatar
con committed
710 711
    }

hjk's avatar
hjk committed
712 713 714 715 716 717 718 719 720 721 722 723 724 725
    if (cmd.flags & NeedsStop) {
        if (state() == InferiorStopped
            || state() == EngineStarting
            || state() == InferiorPrepared) {
            // 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
726
    } else if (!cmd.command.isEmpty()) {
727
        flushCommand(cmd);
con's avatar
con committed
728 729 730
    }
}

hjk's avatar
hjk committed
731
void GdbEngine::flushCommand(const GdbCommand &cmd0)
732
{
hjk's avatar
hjk committed
733
    GdbCommand cmd = cmd0;
hjk's avatar
hjk committed
734
    if (state() == DebuggerNotReady) {
735
        gdbInputAvailable(LogInput, cmd.command);
736 737 738 739
        debugMessage(_("GDB PROCESS NOT RUNNING, PLAIN CMD IGNORED: ") + cmd.command);
        return;
    }

740
    ++currentToken();
741
    cmd.postTime = QTime::currentTime();
742 743
    m_cookieForToken[currentToken()] = cmd;
    cmd.command = QString::number(currentToken()) + cmd.command;
744
    if (cmd.flags & EmbedToken)
745
        cmd.command = cmd.command.arg(currentToken());
746
    gdbInputAvailable(LogInput, cmd.command);
747 748

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

hjk's avatar
hjk committed
751
void GdbEngine::handleResultRecord(const GdbResponse &response)
con's avatar
con committed
752
{
hjk's avatar
hjk committed
753
    //qDebug() << "TOKEN:" << response.token
754
    //    << " ACCEPTABLE:" << m_oldestAcceptableToken;
hjk's avatar
hjk committed
755
    //qDebug() << "\nRESULT" << response.token << response.toString();
con's avatar
con committed
756

hjk's avatar
hjk committed
757
    int token = response.token;
con's avatar
con committed
758 759 760
    if (token == -1)
        return;

761
    if (!m_cookieForToken.contains(token)) {
762 763 764 765
        // 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.
766 767
        debugMessage(_("COOKIE FOR TOKEN %1 ALREADY EATEN. "
            "TWO RESPONSES FOR ONE COMMAND?").arg(token));
hjk's avatar
hjk committed
768 769
        if (response.resultClass == GdbResultError) {
            QByteArray msg = response.data.findChild("msg").data();
770 771 772 773 774 775 776
            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."));
777
                shutdown();
778 779 780
            } 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.
781 782
                setState(InferiorStopping);
                setState(InferiorStopped);
783 784 785 786 787 788 789 790 791 792 793
            } 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)));
794
            }
795 796 797 798
        }
        return;
    }

799
    GdbCommand cmd = m_cookieForToken.take(token);
800
    if (theDebuggerBoolSetting(LogTimeStamps)) {
801
        gdbOutputAvailable(LogTime, _("Response time: %1: %2 s")
802 803 804
            .arg(cmd.command)
            .arg(cmd.postTime.msecsTo(QTime::currentTime()) / 1000.));
    }
con's avatar
con committed
805

hjk's avatar
hjk committed
806
    if (response.token < m_oldestAcceptableToken && (cmd.flags & Discardable)) {
807
        //debugMessage(_("### SKIPPING OLD RESULT") + response.toString());
con's avatar
con committed
808 809 810
        return;
    }

hjk's avatar
hjk committed
811 812 813
    GdbResponse responseWithCookie = response;
    responseWithCookie.cookie = cmd.cookie;

814
    if (cmd.callback)
hjk's avatar
hjk committed
815
        (this->*cmd.callback)(responseWithCookie);
hjk's avatar
hjk committed
816
    if (cmd.adapterCallback)
hjk's avatar
hjk committed
817
        (m_gdbAdapter->*cmd.adapterCallback)(responseWithCookie);
con's avatar
con committed
818

819
    if (cmd.flags & RebuildModel) {
con's avatar
con committed
820
        --m_pendingRequests;
hjk's avatar
hjk committed
821
        PENDING_DEBUG("   TYPE " << cmd.callbackName << " DECREMENTS PENDING TO: "
con's avatar
con committed
822
            << m_pendingRequests << cmd.command);
823
        if (m_pendingRequests <= 0) {
hjk's avatar
hjk committed
824 825
            PENDING_DEBUG("\n\n ....  AND TRIGGERS MODEL UPDATE\n");
            rebuildModel();
826
        }
con's avatar
con committed
827
    } else {
hjk's avatar
hjk committed
828
        PENDING_DEBUG("   UNKNOWN TYPE " << cmd.callbackName << " LEAVES PENDING AT: "
con's avatar
con committed
829 830
            << m_pendingRequests << cmd.command);
    }
831

832 833
    // Continue only if there are no commands wire anymore, so this will
    // be fully synchroneous.
834 835 836 837
    // 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.
838
    if (m_commandsDoneCallback && m_cookieForToken.isEmpty()) {
839
        debugMessage(_("ALL COMMANDS DONE; INVOKING CALLBACK"));
840 841
        CommandsDoneCallback cont = m_commandsDoneCallback;
        m_commandsDoneCallback = 0;
hjk's avatar
hjk committed
842 843 844
        (this->*cont)();
    } else {
        PENDING_DEBUG("MISSING TOKENS: " << m_cookieForToken.keys());
845
    }
con's avatar
con committed
846 847 848 849
}

void GdbEngine::executeDebuggerCommand(const QString &command)
{
hjk's avatar
hjk committed
850
    if (state() == DebuggerNotReady) {
851
        debugMessage(_("GDB PROCESS NOT RUNNING, PLAIN CMD IGNORED: ") + command);
con's avatar
con committed
852 853 854
        return;
    }

hjk's avatar
hjk committed
855
    m_gdbAdapter->write(command.toLatin1() + "\r\n");
con's avatar
con committed
856 857
}

858
// Called from CoreAdapter and AttachAdapter
859
void GdbEngine::updateAll()
860
{
861
    QTC_ASSERT(state() == InferiorUnrunnable || state() == InferiorStopped, /**/);