add gui to configure ssh

Author: lievenhey

src/CMakeLists.txt

@@ -50,6 +50,7 @@ set(hotspot_SRCS
     perfoutputwidgettext.cpp
     perfoutputwidgetkonsole.cpp
     costcontextmenu.cpp
+    ssh.cpp
 
     # ui files:
     mainwindow.ui

src/mainwindow.cpp

@@ -128,6 +128,8 @@ MainWindow::MainWindow(QWidget* parent)
         settings->setObjdump(m_settingsDialog->objdump());
     });
 
+    connect(m_settingsDialog, &QDialog::accepted, m_recordPage, &RecordPage::onRemoteDevicesChanged);
+
     connect(settings, &Settings::sysrootChanged, m_resultsPage, &ResultsPage::setSysroot);
     connect(settings, &Settings::appPathChanged, m_resultsPage, &ResultsPage::setAppPath);
     connect(settings, &Settings::objdumpChanged, m_resultsPage, &ResultsPage::setObjdump);

src/perfrecordssh.cpp

@@ -16,33 +16,11 @@
 #include <csignal>
 
 #include "hotspot-config.h"
-
-QString sshOutput(const QString& hostname, const QStringList& command)
-{
-    QProcess ssh;
-    ssh.setProgram(QStandardPaths::findExecutable(QLatin1String("ssh")));
-    const auto arguments = QStringList({hostname}) + command;
-    ssh.setArguments(arguments);
-    ssh.start();
-    ssh.waitForFinished();
-    return QString::fromUtf8(ssh.readAll());
-}
-
-int sshExitCode(const QString& hostname, const QStringList& command)
-{
-    QProcess ssh;
-    ssh.setProgram(QStandardPaths::findExecutable(QLatin1String("ssh")));
-    const auto arguments = QStringList({hostname}) + command;
-    ssh.setArguments(arguments);
-    ssh.start();
-    ssh.waitForFinished();
-    return ssh.exitCode();
-}
+#include "ssh.h"
 
 PerfRecordSSH::PerfRecordSSH(QObject* parent)
     : PerfRecord(parent)
 {
-    m_hostname = QStringLiteral("user@localhost");
 }
 
 PerfRecordSSH::~PerfRecordSSH() = default;
@@ -102,7 +80,7 @@ QString PerfRecordSSH::currentUsername()
 
 bool PerfRecordSSH::canTrace(const QString& path)
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
 
     // assume best case
@@ -111,7 +89,7 @@ bool PerfRecordSSH::canTrace(const QString& path)
 
 bool PerfRecordSSH::canProfileOffCpu()
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
     return canTrace(QStringLiteral("events/sched/sched_switch"));
 }
@@ -142,16 +120,16 @@ QString perfBuildOptions(const QString& hostname)
 
 bool PerfRecordSSH::canSampleCpu()
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
-    return perfRecordHelp(m_hostname).contains(QLatin1String("--sample-cpu"));
+    return perfRecordHelp(m_deviceName).contains(QLatin1String("--sample-cpu"));
 }
 
 bool PerfRecordSSH::canSwitchEvents()
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
-    return perfRecordHelp(m_hostname).contains(QLatin1String("--switch-events"));
+    return perfRecordHelp(m_deviceName).contains(QLatin1String("--switch-events"));
 }
 
 bool PerfRecordSSH::canUseAio()
@@ -162,16 +140,16 @@ bool PerfRecordSSH::canUseAio()
 
 bool PerfRecordSSH::canCompress()
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
-    return Zstd_FOUND && perfBuildOptions(m_hostname).contains(QLatin1String("zstd: [ on  ]"));
+    return Zstd_FOUND && perfBuildOptions(m_deviceName).contains(QLatin1String("zstd: [ on  ]"));
 }
 
 bool PerfRecordSSH::isPerfInstalled()
 {
-    if (m_hostname.isEmpty())
+    if (m_deviceName.isEmpty())
         return false;
-    return sshExitCode(m_hostname, {QLatin1String("command"), QLatin1String("-v"), QLatin1String("perf")}) != 0;
+    return sshExitCode(m_deviceName, {QLatin1String("command"), QLatin1String("-v"), QLatin1String("perf")}) != 0;
 }
 
 void PerfRecordSSH::startRecording(const QStringList& perfOptions, const QString& outputPath,
@@ -197,29 +175,26 @@ void PerfRecordSSH::startRecording(const QStringList& perfOptions, const QString
         return;
     }
 
+    qRegisterMetaType<QProcess::ExitStatus>("QProcess::ExitStatus");
+
     QStringList perfCommand = {QStringLiteral("record"), QStringLiteral("-o"), QStringLiteral("-")};
     perfCommand += perfOptions;
     perfCommand += recordOptions;
-
     m_outputFile = new QFile(outputPath);
     m_outputFile->open(QIODevice::WriteOnly);
 
-    m_recordProcess = new QProcess(this);
-    m_recordProcess->setProgram(QStandardPaths::findExecutable(QLatin1String("ssh")));
-    m_recordProcess->setArguments({m_hostname, QLatin1String("perf ") + perfCommand.join(QLatin1Char(' '))});
-    m_recordProcess->start();
-    m_recordProcess->waitForStarted();
+    m_recordProcess = createSshProcess(m_deviceName, perfCommand);
 
     emit recordingStarted(QLatin1String("perf"), perfCommand);
 
-    connect(m_recordProcess, &QProcess::readyReadStandardOutput, this,
+    connect(m_recordProcess.get(), &QProcess::readyReadStandardOutput, this,
             [this] { m_outputFile->write(m_recordProcess->readAllStandardOutput()); });
 
-    connect(m_recordProcess, &QProcess::readyReadStandardError, this,
+    connect(m_recordProcess.get(), &QProcess::readyReadStandardError, this,
             [this] { emit recordingOutput(QString::fromUtf8(m_recordProcess->readAllStandardError())); });
 
-    connect(m_recordProcess, static_cast<void (QProcess::*)(int, QProcess::ExitStatus)>(&QProcess::finished), this,
-            [this](int exitCode, QProcess::ExitStatus exitStatus) {
+    connect(m_recordProcess.get(), static_cast<void (QProcess::*)(int, QProcess::ExitStatus)>(&QProcess::finished),
+            this, [this](int exitCode, QProcess::ExitStatus exitStatus) {
                 Q_UNUSED(exitStatus)
 
                 m_outputFile->close();

src/perfrecordssh.h

@@ -8,6 +8,7 @@
 #pragma once
 
 #include "perfrecord.h"
+#include <QProcess>
 
 class QFile;
 
@@ -18,6 +19,11 @@ class PerfRecordSSH : public PerfRecord
     PerfRecordSSH(QObject* parent = nullptr);
     ~PerfRecordSSH();
 
+    void setDeviceName(const QString& device)
+    {
+        m_deviceName = device;
+    }
+
     void record(const QStringList& perfOptions, const QString& outputPath, bool elevatePrivileges,
                 const QString& exePath, const QStringList& exeOptions, const QString& workingDirectory) override;
     void record(const QStringList& perfOptions, const QString& outputPath, bool elevatePrivileges,
@@ -48,8 +54,8 @@ class PerfRecordSSH : public PerfRecord
     void startRecording(const QStringList& perfOptions, const QString& outputPath, const QStringList& recordOptions,
                         const QString& workingDirectory);
 
-    QProcess* m_recordProcess = nullptr;
+    std::unique_ptr<QProcess> m_recordProcess = nullptr;
     QFile* m_outputFile;
-    QString m_hostname;
+    QString m_deviceName;
     bool m_userTerminated = false;
 };

src/recordpage.cpp

@@ -428,8 +428,10 @@ RecordPage::RecordPage(QWidget* parent)
 
     perfRecordChanged();
 
-    ui->remoteTargetComboBox->addItem(QStringLiteral("localhost"));
-    ui->remoteTargetComboBox->addItem(QStringLiteral("remote test 1"));
+    const auto sshPath = QStandardPaths::findExecutable(QLatin1String("ssh"));
+    ui->remoteTargetGroup->setVisible(!sshPath.isEmpty());
+
+    onRemoteDevicesChanged();
 
     connect(ui->remoteTargetComboBox, qOverload<int>(&QComboBox::currentIndexChanged), this,
             [this, perfRecordChanged](int index) {
@@ -857,3 +859,17 @@ void RecordPage::updateOffCpuCheckboxState()
         ui->offCpuCheckBox->setChecked(config().readEntry(QStringLiteral("offCpuProfiling"), false));
     }
 }
+
+void RecordPage::onRemoteDevicesChanged()
+{
+    ui->remoteTargetComboBox->clear();
+    ui->remoteTargetComboBox->addItem(QStringLiteral("localhost"));
+
+    const auto deviceConfig = KSharedConfig::openConfig()->group("devices");
+    auto t = deviceConfig.groupList();
+    for (const auto& device : deviceConfig.groupList()) {
+        if (deviceConfig.hasGroup(device)) {
+            ui->remoteTargetComboBox->addItem(device);
+        }
+    }
+}

src/recordpage.h

@@ -54,6 +54,9 @@ class RecordPage : public QWidget
     void homeButtonClicked();
     void openFile(QString filePath);
 
+public slots:
+    void onRemoteDevicesChanged();
+
 private slots:
     void onApplicationNameChanged(const QString& filePath);
     void onStartRecordingButtonClicked(bool checked);

src/settings.cpp

@@ -221,4 +221,13 @@ void Settings::loadFromFile()
     connect(this, &Settings::lastUsedEnvironmentChanged, [sharedConfig, this](const QString& envName) {
         sharedConfig->group("PerfPaths").writeEntry("lastUsed", envName);
     });
+
+    const auto askpass = QStandardPaths::findExecutable(QLatin1String("ksshaskpass"));
+    setSshaskPassPath(sharedConfig->group("SSH").readEntry("sshaskpass", askpass));
+}
+
+void Settings::setSshaskPassPath(const QString& sshaskpath)
+{
+    m_sshaskPassPath = sshaskpath;
+    emit sshaskPassChanged(m_sshaskPassPath);
 }

src/settings.h

@@ -138,6 +138,11 @@ class Settings : public QObject
         return m_lastUsedEnvironment;
     }
 
+    QString sshaskPassPath() const
+    {
+        return m_sshaskPassPath;
+    }
+
     void loadFromFile();
 
 signals:
@@ -157,6 +162,7 @@ class Settings : public QObject
     void objdumpChanged(const QString& objdump);
     void callgraphChanged();
     void lastUsedEnvironmentChanged(const QString& envName);
+    void sshaskPassChanged(const QString& path);
 
 public slots:
     void setPrettifySymbols(bool prettifySymbols);
@@ -177,6 +183,7 @@ public slots:
     void setCallgraphColors(const QColor& active, const QColor& inactive);
     void setCostAggregation(CostAggregation costAggregation);
     void setLastUsedEnvironment(const QString& envName);
+    void setSshaskPassPath(const QString& sshaskpath);
 
 private:
     Settings() = default;
@@ -198,6 +205,7 @@ public slots:
     QString m_appPath;
     QString m_arch;
     QString m_objdump;
+    QString m_sshaskPassPath;
 
     QString m_lastUsedEnvironment;