qt-creator/src/plugins/qt4projectmanager/qt-maemo/maemodebugsupport.cpp

/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Creator.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "maemodebugsupport.h"

#include "maemodeployables.h"
#include "maemodeploystep.h"
#include "maemoglobal.h"
#include "maemosshrunner.h"
#include "maemousedportsgatherer.h"

#include <coreplugin/ssh/sftpchannel.h>
#include <debugger/debuggerplugin.h>
#include <debugger/debuggerrunner.h>
#include <debugger/debuggerengine.h>

#include <projectexplorer/toolchaintype.h>

#include <QtCore/QDir>
#include <QtCore/QFileInfo>

#define ASSERT_STATE(state) ASSERT_STATE_GENERIC(State, state, m_state)

using namespace Core;
using namespace Debugger;
using namespace ProjectExplorer;

namespace Qt4ProjectManager {
namespace Internal {

RunControl *MaemoDebugSupport::createDebugRunControl(MaemoRunConfiguration *runConfig)
{
    DebuggerStartParameters params;
    const MaemoDeviceConfig &devConf = runConfig->deviceConfig();

    const MaemoRunConfiguration::DebuggingType debuggingType
        = runConfig->debuggingType();
    if (debuggingType != MaemoRunConfiguration::DebugCppOnly) {
        params.qmlServerAddress = runConfig->deviceConfig().server.host;
        params.qmlServerPort = -1;
    }
    if (debuggingType != MaemoRunConfiguration::DebugQmlOnly) {
        params.processArgs = runConfig->arguments();
        params.sysRoot = runConfig->sysRoot();
        params.toolChainType = ProjectExplorer::ToolChain_GCC_MAEMO;
        params.dumperLibrary = runConfig->dumperLib();
        params.remoteDumperLib = uploadDir(devConf).toUtf8() + '/'
            + QFileInfo(runConfig->dumperLib()).fileName().toUtf8();
        if (runConfig->useRemoteGdb()) {
            params.startMode = StartRemoteGdb;
            params.executable = runConfig->remoteExecutableFilePath();
            params.debuggerCommand
                = MaemoGlobal::remoteCommandPrefix(runConfig->remoteExecutableFilePath())
                    + environment(runConfig->debuggingType(), runConfig->userEnvironmentChanges())
                    + QLatin1String(" /usr/bin/gdb");
            params.connParams = devConf.server;
            params.localMountDir = runConfig->localDirToMountForRemoteGdb();
            params.remoteMountPoint
                = runConfig->remoteProjectSourcesMountPoint();
            const QString execDirAbs
                = QDir::fromNativeSeparators(QFileInfo(runConfig->localExecutableFilePath()).path());
            const QString execDirRel
                = QDir(params.localMountDir).relativeFilePath(execDirAbs);
            params.remoteSourcesDir = QString(params.remoteMountPoint
                + QLatin1Char('/') + execDirRel).toUtf8();
        } else {
            params.startMode = AttachToRemote;
            params.executable = runConfig->localExecutableFilePath();
            params.debuggerCommand = runConfig->gdbCmd();
            params.remoteChannel = devConf.server.host + QLatin1String(":-1");
            params.useServerStartScript = true;
            params.remoteArchitecture = QLatin1String("arm");
            params.gnuTarget = QLatin1String("arm-none-linux-gnueabi");
        }
    } else {
        params.startMode = AttachToRemote;
    }

    DebuggerRunControl * const runControl =
        DebuggerPlugin::createDebugger(params, runConfig);
    MaemoDebugSupport *debugSupport =
        new MaemoDebugSupport(runConfig, runControl->engine());
    connect(runControl, SIGNAL(finished()),
        debugSupport, SLOT(handleDebuggingFinished()));
    return runControl;
}

MaemoDebugSupport::MaemoDebugSupport(MaemoRunConfiguration *runConfig,
    DebuggerEngine *engine)
    : QObject(engine), m_engine(engine), m_runConfig(runConfig),
      m_runner(new MaemoSshRunner(this, runConfig, true)),
      m_debuggingType(runConfig->debuggingType()),
      m_dumperLib(runConfig->dumperLib()),
      m_state(Inactive), m_gdbServerPort(-1), m_qmlPort(-1)
{
    connect(m_engine, SIGNAL(requestRemoteSetup()), this,
        SLOT(handleAdapterSetupRequested()));
}

MaemoDebugSupport::~MaemoDebugSupport()
{
    setState(Inactive);
}

void MaemoDebugSupport::showMessage(const QString &msg, int channel)
{
    if (m_engine)
        m_engine->showMessage(msg, channel);
}

void MaemoDebugSupport::handleAdapterSetupRequested()
{
    ASSERT_STATE(Inactive);

    setState(StartingRunner);
    showMessage(tr("Preparing remote side ..."), AppStuff);
    disconnect(m_runner, 0, this, 0);
    connect(m_runner, SIGNAL(error(QString)), this,
        SLOT(handleSshError(QString)));
    connect(m_runner, SIGNAL(readyForExecution()), this,
        SLOT(startExecution()));
    connect(m_runner, SIGNAL(reportProgress(QString)), this,
        SLOT(handleProgressReport(QString)));
    m_runner->start();
}

void MaemoDebugSupport::handleSshError(const QString &error)
{
    if (m_state == Debugging) {
        showMessage(tr("SSH connection error: %1").arg(error),
            AppError);
    } else if (m_state != Inactive) {
        handleAdapterSetupFailed(error);
    }
}

void MaemoDebugSupport::startExecution()
{
    if (m_state == Inactive)
        return;

    ASSERT_STATE(StartingRunner);

    if (!useGdb() && m_debuggingType != MaemoRunConfiguration::DebugQmlOnly) {
        if (!setPort(m_gdbServerPort))
            return;
    }
    if (m_debuggingType != MaemoRunConfiguration::DebugCppOnly) {
        if (!setPort(m_qmlPort))
            return;
    }

    if (m_debuggingType != MaemoRunConfiguration::DebugQmlOnly
            && !m_dumperLib.isEmpty()
            && m_runConfig
            && m_runConfig->deployStep()->currentlyNeedsDeployment(m_runner->deviceConfig().server.host,
                   MaemoDeployable(m_dumperLib, uploadDir(m_runner->deviceConfig())))) {
        setState(InitializingUploader);
        m_uploader = m_runner->connection()->createSftpChannel();
        connect(m_uploader.data(), SIGNAL(initialized()), this,
                SLOT(handleSftpChannelInitialized()));
        connect(m_uploader.data(), SIGNAL(initializationFailed(QString)), this,
                SLOT(handleSftpChannelInitializationFailed(QString)));
        connect(m_uploader.data(), SIGNAL(finished(Core::SftpJobId, QString)),
                this, SLOT(handleSftpJobFinished(Core::SftpJobId, QString)));
        m_uploader->initialize();
    } else {
        setState(DumpersUploaded);
        startDebugging();
    }
}

void MaemoDebugSupport::handleSftpChannelInitialized()
{
    if (m_state == Inactive)
        return;

    ASSERT_STATE(InitializingUploader);

    const QString fileName = QFileInfo(m_dumperLib).fileName();
    const QString remoteFilePath
        = uploadDir(m_runner->deviceConfig()) + '/' + fileName;
    m_uploadJob = m_uploader->uploadFile(m_dumperLib, remoteFilePath,
        SftpOverwriteExisting);
    if (m_uploadJob == SftpInvalidJob) {
        handleAdapterSetupFailed(tr("Upload failed: Could not open file '%1'")
            .arg(m_dumperLib));
    } else {
        setState(UploadingDumpers);
        showMessage(tr("Started uploading debugging helpers ('%1').")
            .arg(m_dumperLib), AppStuff);
    }
}

void MaemoDebugSupport::handleSftpChannelInitializationFailed(const QString &error)
{
    if (m_state == Inactive)
        return;
    ASSERT_STATE(InitializingUploader);
    handleAdapterSetupFailed(error);
}

void MaemoDebugSupport::handleSftpJobFinished(Core::SftpJobId job,
    const QString &error)
{
    if (m_state == Inactive)
        return;

    ASSERT_STATE(UploadingDumpers);

    if (job != m_uploadJob) {
        qWarning("Warning: Unknown debugging helpers upload job %d finished.", job);
        return;
    }

    if (!error.isEmpty()) {
        handleAdapterSetupFailed(tr("Could not upload debugging helpers: %1.")
            .arg(error));
    } else {
        setState(DumpersUploaded);
        if (m_runConfig) {
            m_runConfig->deployStep()->setDeployed(m_runner->deviceConfig().server.host,
                MaemoDeployable(m_dumperLib, uploadDir(m_runner->deviceConfig())));
        }
        showMessage(tr("Finished uploading debugging helpers."), AppStuff);
        startDebugging();
    }
    m_uploadJob = SftpInvalidJob;
}

void MaemoDebugSupport::startDebugging()
{
    ASSERT_STATE(DumpersUploaded);

    if (useGdb()) {
        handleAdapterSetupDone();
    } else {
        setState(StartingRemoteProcess);
        m_gdbserverOutput.clear();
        connect(m_runner, SIGNAL(remoteErrorOutput(QByteArray)), this,
            SLOT(handleRemoteErrorOutput(QByteArray)));
        connect(m_runner, SIGNAL(remoteOutput(QByteArray)), this,
            SLOT(handleRemoteOutput(QByteArray)));
        const QString &remoteExe = m_runner->remoteExecutable();
        const QString cmdPrefix = MaemoGlobal::remoteCommandPrefix(remoteExe);
        const QString env
            = environment(m_debuggingType, m_runner->userEnvChanges());
        const QString args = m_runner->arguments();
        const QString remoteCommandLine
            = m_debuggingType == MaemoRunConfiguration::DebugQmlOnly
                ? QString::fromLocal8Bit("%1 %2 %3 %4").arg(cmdPrefix).arg(env)
                      .arg(remoteExe).arg(args)
                : QString::fromLocal8Bit("%1 %2 gdbserver :%3 %4 %5")
                      .arg(cmdPrefix).arg(env).arg(m_gdbServerPort)
                      .arg(remoteExe).arg(args);
        m_runner->startExecution(remoteCommandLine.toUtf8());
    }
}

void MaemoDebugSupport::handleDebuggingFinished()
{
    setState(Inactive);
}

void MaemoDebugSupport::handleRemoteOutput(const QByteArray &output)
{
    ASSERT_STATE(QList<State>() << Inactive << Debugging);
    showMessage(QString::fromUtf8(output), AppOutput);
}

void MaemoDebugSupport::handleRemoteErrorOutput(const QByteArray &output)
{
    ASSERT_STATE(QList<State>() << Inactive << StartingRemoteProcess << Debugging);

    if (!m_engine)
        return;

    showMessage(QString::fromUtf8(output), AppOutput);
    if (m_state == StartingRemoteProcess
            && m_debuggingType != MaemoRunConfiguration::DebugQmlOnly) {
        m_gdbserverOutput += output;
        if (m_gdbserverOutput.contains("Listening on port")) {
            handleAdapterSetupDone();
            m_gdbserverOutput.clear();
        }
    }
}

void MaemoDebugSupport::handleProgressReport(const QString &progressOutput)
{
    showMessage(progressOutput, AppStuff);
}

void MaemoDebugSupport::handleAdapterSetupFailed(const QString &error)
{
    setState(Inactive);
    m_engine->handleRemoteSetupFailed(tr("Initial setup failed: %1").arg(error));
}

void MaemoDebugSupport::handleAdapterSetupDone()
{
    setState(Debugging);
    m_engine->handleRemoteSetupDone(m_gdbServerPort, m_qmlPort);
}

void MaemoDebugSupport::setState(State newState)
{
    if (m_state == newState)
        return;
    m_state = newState;
    if (m_state == Inactive) {
        if (m_uploader) {
            disconnect(m_uploader.data(), 0, this, 0);
            m_uploader->closeChannel();
        }
        m_runner->stop();
    }
}

QString MaemoDebugSupport::environment(MaemoRunConfiguration::DebuggingType debuggingType,
    const QList<Utils::EnvironmentItem> &userEnvChanges)
{
    // FIXME: this must use command line argument instead: -qmljsdebugger=port:1234.
    if (debuggingType != MaemoRunConfiguration::DebugCppOnly) {
//        env << Utils::EnvironmentItem(QLatin1String(Debugger::Constants::E_QML_DEBUG_SERVER_PORT),
//            QString::number(qmlServerPort(rc)));
    }
    return MaemoGlobal::remoteEnvironment(userEnvChanges);
}

QString MaemoDebugSupport::uploadDir(const MaemoDeviceConfig &devConf)
{
    return MaemoGlobal::homeDirOnDevice(devConf.server.uname);
}

bool MaemoDebugSupport::useGdb() const
{
    return m_engine->startParameters().startMode == StartRemoteGdb
        && m_debuggingType != MaemoRunConfiguration::DebugQmlOnly;
}

bool MaemoDebugSupport::setPort(int &port)
{
    port = m_runner->usedPortsGatherer()->getNextFreePort(m_runner->freePorts());
    if (port == -1) {
        handleAdapterSetupFailed(tr("Not enough free ports on device for debugging."));
        return false;
    }
    return true;
}

} // namespace Internal
} // namespace Qt4ProjectManager