forked from qt-creator/qt-creator
valgrind: code cosmetics
Change-Id: I695c7d40aeb0b0b1e6f8cc0856e5fa5d9d1ce2d1 Reviewed-on: http://codereview.qt.nokia.com/1600 Reviewed-by: hjk <qthjk@ovi.com>
This commit is contained in:
277
src/plugins/valgrind/callgrind/callgrindcontroller.cpp
Normal file
277
src/plugins/valgrind/callgrind/callgrindcontroller.cpp
Normal file
@@ -0,0 +1,277 @@
|
||||
/**************************************************************************
|
||||
**
|
||||
** This file is part of Qt Creator
|
||||
**
|
||||
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
||||
**
|
||||
** Contact: Nokia Corporation (info@qt.nokia.com)
|
||||
**
|
||||
**
|
||||
** GNU Lesser General Public License Usage
|
||||
**
|
||||
** 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.
|
||||
**
|
||||
** Other Usage
|
||||
**
|
||||
** Alternatively, this file may be used in accordance with the terms and
|
||||
** conditions contained in a signed written agreement between you and Nokia.
|
||||
**
|
||||
** If you have questions regarding the use of this file, please contact
|
||||
** Nokia at info@qt.nokia.com.
|
||||
**
|
||||
**************************************************************************/
|
||||
|
||||
#include "callgrindcontroller.h"
|
||||
|
||||
#include <QDebug>
|
||||
#include <QDir>
|
||||
|
||||
#include <valgrindprocess.h>
|
||||
|
||||
#include <utils/qtcassert.h>
|
||||
#include <utils/ssh/sftpchannel.h>
|
||||
|
||||
#include <QTemporaryFile>
|
||||
|
||||
#define CALLGRIND_CONTROL_DEBUG 0
|
||||
|
||||
const QLatin1String CALLGRIND_CONTROL_BINARY("callgrind_control");
|
||||
|
||||
namespace Valgrind {
|
||||
namespace Callgrind {
|
||||
|
||||
CallgrindController::CallgrindController(QObject *parent)
|
||||
: QObject(parent)
|
||||
, m_process(0)
|
||||
, m_valgrindProc(0)
|
||||
, m_lastOption(Unknown)
|
||||
{
|
||||
}
|
||||
|
||||
CallgrindController::~CallgrindController()
|
||||
{
|
||||
cleanupTempFile();
|
||||
}
|
||||
|
||||
QString toOptionString(CallgrindController::Option option)
|
||||
{
|
||||
/* Callgrind help from v3.6.0
|
||||
|
||||
Options:
|
||||
-h --help Show this help text
|
||||
--version Show version
|
||||
-l --long Show more information
|
||||
-s --stat Show statistics
|
||||
-b --back Show stack/back trace
|
||||
-e [<A>,...] Show event counters for <A>,... (default: all)
|
||||
--dump[=<s>] Request a dump optionally using <s> as description
|
||||
-z --zero Zero all event counters
|
||||
-k --kill Kill
|
||||
--instr=<on|off> Switch instrumentation state on/off
|
||||
-w=<dir> Specify the startup directory of an active Callgrind run
|
||||
*/
|
||||
|
||||
switch (option) {
|
||||
case CallgrindController::Dump:
|
||||
return "--dump";
|
||||
case CallgrindController::ResetEventCounters:
|
||||
return "--zero";
|
||||
case CallgrindController::Pause:
|
||||
return "--instr=off";
|
||||
case CallgrindController::UnPause:
|
||||
return "--instr=on";
|
||||
default:
|
||||
return ""; // never reached
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void CallgrindController::run(Option option)
|
||||
{
|
||||
if (m_process) {
|
||||
emit statusMessage(tr("Previous command has not yet finished."));
|
||||
return;
|
||||
}
|
||||
QTC_ASSERT(m_valgrindProc, return)
|
||||
|
||||
if (RemoteValgrindProcess *remote = qobject_cast<RemoteValgrindProcess *>(m_valgrindProc))
|
||||
m_process = new RemoteValgrindProcess(remote->connection(), this);
|
||||
else
|
||||
m_process = new LocalValgrindProcess(this);
|
||||
|
||||
connect(m_process, SIGNAL(finished(int,QProcess::ExitStatus)),
|
||||
SLOT(processFinished(int,QProcess::ExitStatus)));
|
||||
connect(m_process, SIGNAL(error(QProcess::ProcessError)),
|
||||
SLOT(processError(QProcess::ProcessError)));
|
||||
|
||||
// save back current running operation
|
||||
m_lastOption = option;
|
||||
|
||||
const QString optionString = toOptionString(option);
|
||||
|
||||
switch (option) {
|
||||
case CallgrindController::Dump:
|
||||
emit statusMessage(tr("Dumping profile data..."));
|
||||
break;
|
||||
case CallgrindController::ResetEventCounters:
|
||||
emit statusMessage(tr("Resetting event counters..."));
|
||||
break;
|
||||
case CallgrindController::Pause:
|
||||
emit statusMessage(tr("Pausing instrumentation..."));
|
||||
break;
|
||||
case CallgrindController::UnPause:
|
||||
emit statusMessage(tr("Unpausing instrumentation..."));
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
#if CALLGRIND_CONTROL_DEBUG
|
||||
m_process->setProcessChannelMode(QProcess::ForwardedChannels);
|
||||
#endif
|
||||
#ifdef Q_OS_WIN
|
||||
int pid = 0;
|
||||
#else
|
||||
const int pid = m_valgrindProc->pid();
|
||||
#endif
|
||||
m_process->run(CALLGRIND_CONTROL_BINARY,
|
||||
QStringList() << optionString << QString::number(pid),
|
||||
QString(), QString());
|
||||
}
|
||||
|
||||
void CallgrindController::processError(QProcess::ProcessError)
|
||||
{
|
||||
QTC_ASSERT(m_process, return)
|
||||
const QString error = m_process->errorString();
|
||||
emit statusMessage(QString("An error occurred while trying to run %1: %2").arg(CALLGRIND_CONTROL_BINARY).arg(error));
|
||||
|
||||
m_process->deleteLater();
|
||||
m_process = 0;
|
||||
}
|
||||
|
||||
void CallgrindController::processFinished(int rc, QProcess::ExitStatus status)
|
||||
{
|
||||
QTC_ASSERT(m_process, return);
|
||||
const QString error = m_process->errorString();
|
||||
|
||||
delete m_process;
|
||||
m_process = 0;
|
||||
|
||||
if (rc != 0 || status != QProcess::NormalExit) {
|
||||
qWarning() << "Controller exited abnormally:" << error;
|
||||
return;
|
||||
}
|
||||
|
||||
// this call went fine, we might run another task after this
|
||||
switch (m_lastOption) {
|
||||
case ResetEventCounters:
|
||||
// lets dump the new reset profiling info
|
||||
run(Dump);
|
||||
return;
|
||||
case Pause:
|
||||
// on pause, reset profiling info (for now)
|
||||
run(ResetEventCounters);
|
||||
return;
|
||||
case Dump:
|
||||
emit statusMessage(tr("Callgrind dumped profiling info"));
|
||||
break;
|
||||
case UnPause:
|
||||
emit statusMessage(tr("Callgrind unpaused."));
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
emit finished(m_lastOption);
|
||||
m_lastOption = Unknown;
|
||||
}
|
||||
|
||||
void CallgrindController::setValgrindProcess(ValgrindProcess *proc)
|
||||
{
|
||||
m_valgrindProc = proc;
|
||||
}
|
||||
|
||||
void CallgrindController::getLocalDataFile()
|
||||
{
|
||||
QTC_ASSERT(m_valgrindProc, return);
|
||||
|
||||
// we look for callgrind.out.PID, but there may be updated ones called ~.PID.NUM
|
||||
QString baseFileName = QString("callgrind.out.%1").
|
||||
arg(m_valgrindProc->pid());
|
||||
const QString workingDir = m_valgrindProc->workingDirectory();
|
||||
// first, set the to-be-parsed file to callgrind.out.PID
|
||||
QString fileName = workingDir.isEmpty() ? baseFileName : (workingDir + QDir::separator() + baseFileName);
|
||||
|
||||
if (RemoteValgrindProcess *remote = qobject_cast<RemoteValgrindProcess *>(m_valgrindProc)) {
|
||||
///TODO: error handling
|
||||
emit statusMessage(tr("Downloading remote profile data..."));
|
||||
m_ssh = remote->connection();
|
||||
// if there are files like callgrind.out.PID.NUM, set it to the most recent one of those
|
||||
QString cmd = QString("ls -t %1* | head -n 1").arg(fileName);
|
||||
m_findRemoteFile = m_ssh->createRemoteProcess(cmd.toUtf8());
|
||||
connect(m_findRemoteFile.data(), SIGNAL(outputAvailable(QByteArray)),
|
||||
this, SLOT(foundRemoteFile(QByteArray)));
|
||||
m_findRemoteFile->start();
|
||||
} else {
|
||||
QDir dir(workingDir, QString("%1.*").arg(baseFileName), QDir::Time);
|
||||
QStringList outputFiles = dir.entryList();
|
||||
// if there are files like callgrind.out.PID.NUM, set it to the most recent one of those
|
||||
if (!outputFiles.isEmpty())
|
||||
fileName = workingDir + QDir::separator() + dir.entryList().first();
|
||||
|
||||
emit localParseDataAvailable(fileName);
|
||||
}
|
||||
}
|
||||
|
||||
void CallgrindController::foundRemoteFile(const QByteArray &file)
|
||||
{
|
||||
m_remoteFile = file.trimmed();
|
||||
|
||||
m_sftp = m_ssh->createSftpChannel();
|
||||
connect(m_sftp.data(), SIGNAL(finished(Utils::SftpJobId,QString)),
|
||||
this, SLOT(sftpJobFinished(Utils::SftpJobId,QString)));
|
||||
connect(m_sftp.data(), SIGNAL(initialized()), this, SLOT(sftpInitialized()));
|
||||
m_sftp->initialize();
|
||||
}
|
||||
|
||||
void CallgrindController::sftpInitialized()
|
||||
{
|
||||
cleanupTempFile();
|
||||
QTemporaryFile dataFile(QDir::tempPath() + QDir::separator() + "callgrind.out.");
|
||||
QTC_ASSERT(dataFile.open(), return);
|
||||
m_tempDataFile = dataFile.fileName();
|
||||
dataFile.setAutoRemove(false);
|
||||
dataFile.close();
|
||||
|
||||
m_downloadJob = m_sftp->downloadFile(m_remoteFile, m_tempDataFile, Utils::SftpOverwriteExisting);
|
||||
}
|
||||
|
||||
void CallgrindController::sftpJobFinished(Utils::SftpJobId job, const QString &error)
|
||||
{
|
||||
QTC_ASSERT(job == m_downloadJob, return);
|
||||
|
||||
m_sftp->closeChannel();
|
||||
|
||||
if (error.isEmpty())
|
||||
emit localParseDataAvailable(m_tempDataFile);
|
||||
}
|
||||
|
||||
void CallgrindController::cleanupTempFile()
|
||||
{
|
||||
if (!m_tempDataFile.isEmpty() && QFile::exists(m_tempDataFile))
|
||||
QFile::remove(m_tempDataFile);
|
||||
|
||||
m_tempDataFile.clear();
|
||||
}
|
||||
|
||||
} // namespace Callgrind
|
||||
} // namespace Valgrind
|
||||
Reference in New Issue
Block a user