add queriering via ssh to RemoteHost

Author: lievenhey

src/CMakeLists.txt

@@ -54,6 +54,7 @@ set(HOTSPOT_SRCS
     perfcontrolfifowrapper.cpp
     errnoutil.cpp
     recordhost.cpp
+    remotedevice.cpp
     # ui files:
     mainwindow.ui
     aboutdialog.ui

src/recordhost.cpp

@@ -140,12 +140,35 @@ RecordHost::PerfCapabilities fetchLocalPerfCapabilities(const QString& perfPath)
 
     return capabilities;
 }
+
+RecordHost::PerfCapabilities fetchRemotePerfCapabilities(const RemoteDevice& device)
+{
+    RecordHost::PerfCapabilities capabilities;
+
+    const auto buildOptions =
+        device.getProgramOutput({QStringLiteral("perf"), QStringLiteral("version"), QStringLiteral("--build-options")});
+    const auto help = device.getProgramOutput({QStringLiteral("perf"), QStringLiteral("--help")});
+
+    capabilities.canCompress = Zstd_FOUND && buildOptions.contains("zszd: [ on  ]");
+    capabilities.canSwitchEvents = help.contains("--switch-events");
+    capabilities.canSampleCpu = help.contains("--sample-cpu");
+
+    // TODO: implement
+    capabilities.canProfileOffCpu = false;
+    capabilities.privilegesAlreadyElevated = false;
+
+    capabilities.canUseAio = false; // AIO doesn't work with perf streaming
+    capabilities.canElevatePrivileges = false; // we currently don't support this
+
+    return capabilities;
+}
 }
 
 RecordHost::RecordHost(QObject* parent)
     : QObject(parent)
     , m_checkPerfCapabilitiesJob(this)
     , m_checkPerfInstalledJob(this)
+    , m_remoteDevice(this)
 {
     connect(this, &RecordHost::errorOccurred, this, [this](const QString& message) { m_error = message; });
 
@@ -160,6 +183,10 @@ RecordHost::RecordHost(QObject* parent)
     connectIsReady(&RecordHost::pidsChanged);
     connectIsReady(&RecordHost::currentWorkingDirectoryChanged);
 
+    connect(&m_remoteDevice, &RemoteDevice::connected, this, &RecordHost::checkRequirements);
+
+    connect(&m_remoteDevice, &RemoteDevice::connected, this, [this] { emit isReadyChanged(isReady()); });
+
     setHost(QStringLiteral("localhost"));
 }
 
@@ -169,7 +196,13 @@ bool RecordHost::isReady() const
 {
     switch (m_recordType) {
     case RecordType::LaunchApplication:
-        // client application is already validated in  the setter
+        // client application is already validated in the setter
+        if (m_clientApplication.isEmpty() && m_cwd.isEmpty())
+            return false;
+        break;
+    case RecordType::LaunchRemoteApplication:
+        if (!m_remoteDevice.isConnected())
+            return false;
         if (m_clientApplication.isEmpty() && m_cwd.isEmpty())
             return false;
         break;
@@ -216,35 +249,13 @@ void RecordHost::setHost(const QString& host)
     m_perfCapabilities = {};
     emit perfCapabilitiesChanged(m_perfCapabilities);
 
-    const auto perfPath = perfBinaryPath();
-    m_checkPerfCapabilitiesJob.startJob([perfPath](auto&&) { return fetchLocalPerfCapabilities(perfPath); },
-                                        [this](RecordHost::PerfCapabilities capabilities) {
-                                            Q_ASSERT(QThread::currentThread() == thread());
-
-                                            m_perfCapabilities = capabilities;
-                                            emit perfCapabilitiesChanged(m_perfCapabilities);
-                                        });
-
-    m_checkPerfInstalledJob.startJob(
-        [isLocal = isLocal(), perfPath](auto&&) {
-            if (isLocal) {
-                if (perfPath.isEmpty()) {
-                    return !QStandardPaths::findExecutable(QStringLiteral("perf")).isEmpty();
-                }
-
-                return QFileInfo::exists(perfPath);
-            }
-
-            qWarning() << "remote is not implemented";
-            return false;
-        },
-        [this](bool isInstalled) {
-            if (!isInstalled) {
-                emit errorOccurred(tr("perf is not installed"));
-            }
-            m_isPerfInstalled = isInstalled;
-            emit isPerfInstalledChanged(isInstalled);
-        });
+    m_remoteDevice.disconnect();
+    if (isLocal()) {
+        checkRequirements();
+    } else {
+        // checkRequirements will be called via RemoteDevice::connected
+        m_remoteDevice.connectToDevice(m_host);
+    }
 }
 
 void RecordHost::setCurrentWorkingDirectory(const QString& cwd)
@@ -265,16 +276,25 @@ void RecordHost::setCurrentWorkingDirectory(const QString& cwd)
             m_cwd = cwd;
             emit currentWorkingDirectoryChanged(cwd);
         }
-        return;
+    } else {
+        if (!m_remoteDevice.checkIfDirectoryExists(cwd)) {
+            emit errorOccurred(tr("Working directory folder cannot be found: %1").arg(cwd));
+        } else {
+            emit errorOccurred({});
+            m_cwd = cwd;
+            emit currentWorkingDirectoryChanged(m_cwd);
+        }
     }
-
-    qWarning() << "is not implemented for remote";
 }
 
 void RecordHost::setClientApplication(const QString& clientApplication)
 {
     Q_ASSERT(QThread::currentThread() == thread());
 
+    if (m_clientApplication == clientApplication) {
+        return;
+    }
+
     if (isLocal()) {
         QFileInfo application(KShell::tildeExpand(clientApplication));
         if (!application.exists()) {
@@ -296,10 +316,15 @@ void RecordHost::setClientApplication(const QString& clientApplication)
         if (m_cwd.isEmpty()) {
             setCurrentWorkingDirectory(application.dir().absolutePath());
         }
-        return;
+    } else {
+        if (!m_remoteDevice.checkIfFileExists(clientApplication)) {
+            emit errorOccurred(tr("Application file cannot be found: %1").arg(clientApplication));
+        } else {
+            emit errorOccurred({});
+            m_clientApplication = clientApplication;
+            emit clientApplicationChanged(m_clientApplication);
+        }
     }
-
-    qWarning() << "is not implemented for remote";
 }
 
 void RecordHost::setClientApplicationArguments(const QString& arguments)
@@ -314,11 +339,11 @@ void RecordHost::setClientApplicationArguments(const QString& arguments)
 
 void RecordHost::setOutputFileName(const QString& filePath)
 {
-    if (isLocal()) {
-        const auto perfDataExtension = QStringLiteral(".data");
+    const auto perfDataExtension = QStringLiteral(".data");
+    const QFileInfo file(filePath);
+    const QFileInfo folder(file.absolutePath());
 
-        const QFileInfo file(filePath);
-        const QFileInfo folder(file.absolutePath());
+    if (isLocal()) {
 
         if (!folder.exists()) {
             emit errorOccurred(tr("Output file directory folder cannot be found: %1").arg(folder.path()));
@@ -333,11 +358,18 @@ void RecordHost::setOutputFileName(const QString& filePath)
             m_outputFileName = filePath;
             emit outputFileNameChanged(m_outputFileName);
         }
-
-        return;
+    } else {
+        // TODO: check if this really nessesary depending if the output will be saved on the device or host
+        if (m_remoteDevice.checkIfDirectoryExists(folder.path())) {
+            emit errorOccurred(tr("Output file directory folder cannot be found: %1").arg(folder.path()));
+        } else if (!filePath.endsWith(perfDataExtension)) {
+            emit errorOccurred(tr("Output file must end with %1").arg(perfDataExtension));
+        } else {
+            emit errorOccurred({});
+            m_outputFileName = filePath;
+            emit outputFileNameChanged(m_outputFileName);
+        }
     }
-
-    qWarning() << "is not implemented for remote";
 }
 
 void RecordHost::setRecordType(RecordType type)
@@ -379,3 +411,44 @@ QString RecordHost::perfBinaryPath() const
     }
     return {};
 }
+
+void RecordHost::checkRequirements()
+{
+    const auto perfPath = perfBinaryPath();
+    m_checkPerfCapabilitiesJob.startJob(
+        [isLocal = isLocal(), &remoteDevice = m_remoteDevice, perfPath](auto&&) {
+            if (isLocal) {
+                return fetchLocalPerfCapabilities(perfPath);
+            } else {
+                return fetchRemotePerfCapabilities(remoteDevice);
+            }
+        },
+        [this](RecordHost::PerfCapabilities capabilities) {
+            Q_ASSERT(QThread::currentThread() == thread());
+
+            m_perfCapabilities = capabilities;
+            emit perfCapabilitiesChanged(m_perfCapabilities);
+        });
+
+    m_checkPerfInstalledJob.startJob(
+        [isLocal = isLocal(), &remoteDevice = m_remoteDevice, perfPath](auto&&) {
+            if (isLocal) {
+                if (perfPath.isEmpty()) {
+                    return !QStandardPaths::findExecutable(QStringLiteral("perf")).isEmpty();
+                }
+
+                return QFileInfo::exists(perfPath);
+            } else {
+                return remoteDevice.checkIfProgramExists(QStringLiteral("perf"));
+            }
+
+            return false;
+        },
+        [this](bool isInstalled) {
+            if (!isInstalled) {
+                emit errorOccurred(tr("perf is not installed"));
+            }
+            m_isPerfInstalled = isInstalled;
+            emit isPerfInstalledChanged(isInstalled);
+        });
+}

src/recordhost.h

@@ -8,6 +8,7 @@
 #pragma once
 
 #include "jobtracker.h"
+#include "remotedevice.h"
 
 #include <QObject>
 
@@ -118,6 +119,7 @@ class RecordHost : public QObject
     void pidsChanged();
 
 private:
+    void checkRequirements();
     bool isLocal() const;
 
     QString m_host;
@@ -132,6 +134,7 @@ class RecordHost : public QObject
     RecordType m_recordType = RecordType::LaunchApplication;
     bool m_isPerfInstalled = false;
     QStringList m_pids;
+    RemoteDevice m_remoteDevice;
 };
 
 Q_DECLARE_METATYPE(RecordHost::PerfCapabilities)

src/recordpage.cpp

@@ -211,8 +211,16 @@ RecordPage::RecordPage(QWidget* parent)
     auto settings = Settings::instance();
     connect(settings, &Settings::devicesChanged, this, [this](const QStringList& devices) {
         ui->deviceComboBox->clear();
-        ui->deviceComboBox->insertItems(0, devices);
+        ui->deviceComboBox->insertItem(0, QStringLiteral("localhost"));
+        ui->deviceComboBox->insertItems(1, devices);
+        ui->deviceComboBox->setCurrentIndex(0);
     });
+    ui->deviceComboBox->insertItem(0, QStringLiteral("localhost"));
+    ui->deviceComboBox->insertItems(1, settings->devices());
+    ui->deviceComboBox->setCurrentIndex(0);
+
+    connect(ui->deviceComboBox, qOverload<int>(&QComboBox::currentIndexChanged), this,
+            [this] { m_recordHost->setHost(ui->deviceComboBox->currentText()); });
 
     ui->compressionComboBox->addItem(tr("Disabled"), -1);
     ui->compressionComboBox->addItem(tr("Enabled (Default Level)"), 0);

src/settings.cpp

@@ -231,13 +231,16 @@ void Settings::loadFromFile()
         sharedConfig->group("PerfPaths").writeEntry("lastUsed", envName);
     });
 
-    setSSHPath(sharedConfig->group("SSH").readEntry("ssh"));
-    setSSHCopyKeyPath(sharedConfig->group("SSH").readEntry("ssh-copy-id"));
+    const auto& ssh = sharedConfig->group("SSH");
+    setSSHPath(ssh.readEntry("ssh"));
+    setSSHCopyKeyPath(ssh.readEntry("ssh-copy-id"));
 
     connect(this, &Settings::sshPathChanged, this,
             [sharedConfig](const QString& path) { sharedConfig->group("SSH").writeEntry("ssh", path); });
     connect(this, &Settings::sshCopyIdPathChanged, this,
             [sharedConfig](const QString& path) { sharedConfig->group("SSH").writeEntry("ssh-copy-id", path); });
+
+    setDevices(ssh.groupList());
 }
 
 void Settings::setSourceCodePaths(const QString& paths)

tests/integrationtests/CMakeLists.txt

@@ -7,6 +7,7 @@ ecm_add_test(
     ../../src/perfcontrolfifowrapper.cpp
     ../../src/perfrecord.cpp
     ../../src/recordhost.cpp
+    ../../src/remotedevice.cpp
     ../../src/settings.cpp
     ../../src/util.cpp
     ../../src/errnoutil.cpp