kernel-shark: Command line options for selecting plots
v2 cover kernel-shark: Command line options for selecting plots
The patch-set implements new commandline options for KernelShark that can be used to pre-select the CPU and Task plots to be shown, before opening the GUI. The idea was suggested by Julia Lawall.
Changes is v2:
- Fixing a bug in the parsing of the string representing the list of IDs, given to the command line options.
- New Patch 3/3 that limits the number of CPU plots shown by default when KernelShark starts.
Yordan Karadzhov (VMware) (3):
kernel-shark: Add methods for selecting the plots to be shown
kernel-shark: Add command line options for selecting plots to be shown
kernel-shark: Set a maximum number of plots to be shown by default
kernel-shark/src/KsGLWidget.cpp | 13 +++++++++-- kernel-shark/src/KsMainWindow.cpp | 39 +++++++++++++++++++++++++++++++ kernel-shark/src/KsMainWindow.hpp | 4 ++++ kernel-shark/src/KsUtils.cpp | 24 +++++++++++++++++++ kernel-shark/src/KsUtils.hpp | 2 ++ kernel-shark/src/kernelshark.cpp | 34 ++++++++++++++++++++++++--- 6 files changed, 111 insertions(+), 5 deletions(-)
Signature · 1 line
2.20.1
PATCH v2 1/3 kernel-shark: Add methods for selecting the plots to be shown
The methods are added to the public interface of the KsMainWindow class and can be used to pre-select the CPU and Task plots to be shown, before opening the GUI.
--- kernel-shark/src/KsMainWindow.cpp | 39 +++++++++++++++++++++++++++++++ kernel-shark/src/KsMainWindow.hpp | 4 ++++ 2 files changed, 43 insertions(+)
kernel-shark/src/KsMainWindow.cpp +39 -0
@@ -172,6 +172,45 @@ KsMainWindow::~KsMainWindow() kshark_free(kshark_ctx); } +/** Set the list ot CPU cores to be plotted. */ +void KsMainWindow::setCPUPlots(QVector<int> cpus) +{ + int nCPUs = tep_get_cpus(_data.tep()); + auto lamCPUCheck = [=] (int cpu) { + if (cpu >= nCPUs) { + qWarning() << "Warning: No CPU" << cpu << "found in the data."; + return true; + } + + return false; + }; + + cpus.erase(std::remove_if(cpus.begin(), cpus.end(), lamCPUCheck), + cpus.end()); + + _graph.cpuReDraw(cpus); +} + +/** Set the list ot tasks (pids) to be plotted. */ +void KsMainWindow::setTaskPlots(QVector<int> pids) +{ + QVector<int> allPids = KsUtils::getPidList(); + auto lamPidCheck = [=] (int pid) { + int i = allPids.indexOf(pid); + if (i < 0) { + qWarning() << "Warning: No Pid" << pid << "found in the data."; + return true; + } + + return false; + }; + + pids.erase(std::remove_if(pids.begin(), pids.end(), lamPidCheck), + pids.end()); + + _graph.taskReDraw(pids); +} + /** * Reimplemented event handler used to update the geometry of the window on * resize events.
kernel-shark/src/KsMainWindow.hpp +4 -0
@@ -61,6 +61,10 @@ public: _plugins.unregisterPlugin(plugin); } + void setCPUPlots(QVector<int> cpus); + + void setTaskPlots(QVector<int> pids); + void resizeEvent(QResizeEvent* event); /** Set the Full Screen mode. */
Signature · 1 line
2.20.1
PATCH v2 2/3 kernel-shark: Add command line options for selecting plots to be shown
In reply to Yordan Karadzhov (VMware)Example:
kernelshark -i mytrace.dat --cpu '1 4-7' --pid 11
This will show CPUs: 1, 4, 5, 6, 7 and task(PID): 11.
--- kernel-shark/src/KsUtils.cpp | 24 ++++++++++++++++++++++ kernel-shark/src/KsUtils.hpp | 2 ++ kernel-shark/src/kernelshark.cpp | 34 +++++++++++++++++++++++++++++--- 3 files changed, 57 insertions(+), 3 deletions(-)
kernel-shark/src/KsUtils.cpp +24 -0
@@ -298,6 +298,30 @@ QStringList splitArguments(QString cmd) return argv; } +/** Parse a string containing Ids. The string can be of the form "1 4-7 9". */ +QVector<int> parseIdList(QString v_str) +{ + QStringList list = v_str.split(" ", QString::SkipEmptyParts); + QVector<int> v; + + for (auto item: list) { + int i = item.indexOf('-'); + if (i > 0) { + /* This item is an interval. */ + int to = item.right(item.size() - i - 1).toInt(); + int from = item.left(i).toInt(); + int s = v.size(); + + v.resize(s + to - from + 1); + std::iota(v.begin() + s, v.end(), from); + } else { + v.append(item.toInt()); + } + } + + return v; +} + }; // KsUtils /** A stream operator for converting QColor into KsPlot::Color. */
kernel-shark/src/KsUtils.hpp +2 -0
@@ -132,6 +132,8 @@ QString getSaveFile(QWidget *parent, QStringList splitArguments(QString cmd); +QVector<int> parseIdList(QString v_str); + }; // KsUtils /** Identifier of the Dual Marker active state. */
kernel-shark/src/kernelshark.cpp +31 -3
@@ -29,20 +29,43 @@ void usage(const char *prog) printf(" -u unregister plugin, use plugin name or absolute path\n"); printf(" -s import a session\n"); printf(" -l import the last session\n"); + puts(" --cpu show plots for CPU cores, default is \"show all\""); + puts(" --pid show plots for tasks, default is \"do not show\""); + puts("\n example:"); + puts(" kernelshark -i mytrace.dat --cpu \'1 4-7\' --pid 11 -p path/to/my/plugin/myplugin.so\n"); } +#define KS_LONG_OPTS 0 +static option longOptions[] = { + {"help", no_argument, nullptr, 'h'}, + {"pid", required_argument, nullptr, KS_LONG_OPTS}, + {"cpu", required_argument, nullptr, KS_LONG_OPTS}, + {nullptr, 0, nullptr, 0} +}; + int main(int argc, char **argv) { QApplication::setAttribute(Qt::AA_EnableHighDpiScaling); QApplication a(argc, argv); + QVector<int> cpuPlots, taskPlots; + bool fromSession = false; + int optionIndex = 0; KsMainWindow ks; - int c; - bool fromSession = false; - while ((c = getopt(argc, argv, "hvi:p:u:s:l")) != -1) { + while ((c = getopt_long(argc, argv, "hvi:p:u:s:l", + longOptions, + &optionIndex)) != -1) { switch(c) { + case KS_LONG_OPTS: + if (strcmp(longOptions[optionIndex].name, "cpu") == 0) + cpuPlots = KsUtils::parseIdList(QString(optarg)); + else if (strcmp(longOptions[optionIndex].name, "pid") == 0) + taskPlots = KsUtils::parseIdList(QString(optarg)); + + break; + case 'h': usage(argv[0]); return 0;
@@ -95,6 +118,11 @@ int main(int argc, char **argv) ks.loadDataFile(QString(input_file)); } + if (cpuPlots.count() || taskPlots.count()) { + ks.setCPUPlots(cpuPlots); + ks.setTaskPlots(taskPlots); + } + ks.show(); return a.exec(); }
Signature · 1 line
2.20.1
PATCH v2 3/3 kernel-shark: Set a maximum number of plots to be shown by default
In reply to Yordan Karadzhov (VMware)Set a maximum number of CPU plots to be shown by default. No more than 16 CPU plots will be shown if no command line options, per-selecting the plots, are provided. This will be useful when opening trace file containing hundreds of CPU cores.
--- kernel-shark/src/KsGLWidget.cpp | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
kernel-shark/src/KsGLWidget.cpp +11 -2
@@ -340,6 +340,11 @@ void KsGLWidget::keyReleaseEvent(QKeyEvent *event) return; } +/** + * The maximum number of CPU plots to be shown by default when the GUI starts. + */ +#define KS_MAX_START_PLOTS 16 + /** * @brief Load and show trace data. *
@@ -358,7 +363,6 @@ void KsGLWidget::loadData(KsDataStore *data) * One bin will correspond to one pixel. */ nBins = width() - _hMargin * 2; - nCPUs = tep_get_cpus(_data->tep()); _model.reset();
@@ -368,8 +372,13 @@ void KsGLWidget::loadData(KsDataStore *data) ksmodel_set_bining(_model.histo(), nBins, tMin, tMax); _model.fill(_data->rows(), _data->size()); - /* Make a default CPU list. All CPUs will be plotted. */ + /* Make a default CPU list. All CPUs (or the first N_max) will be plotted. */ _cpuList = {}; + + nCPUs = tep_get_cpus(_data->tep()); + if (nCPUs > KS_MAX_START_PLOTS) + nCPUs = KS_MAX_START_PLOTS; + for (int i = 0; i < nCPUs; ++i) _cpuList.append(i);
Signature · 1 line
2.20.1