forked from qt-creator/qt-creator
Tracing: Add Chrome Trace Format Visualizer plugin
This new plugin adds a viewer for Chrome Trace Format (CTF) files (aka Trace Event Format). It uses the same UI components as the QML Profiler timeline and the Perf Profiler. The Trace Event Format is generated by different kinds of tracing tools. Usually the files are display with the trace-viewer, built into Chrome (chrome://tracing). This plugin was developed because of the high memory usage of trace-viewer, which makes it difficult to use with trace files bigger than 100 MB. The plugin fully supports all event types used in data generated by LTTng, converted to CTF by https://github.com/KDAB/ctf2ctf. Some of the more advanced event types used for example in Android system traces, though, are not supported. The viewer will silently ignore unsupported event types. Supported Event Types: - Begin, End, Duration and Instant events - Counter events (graphs) - Metadata events (process and thread name) The plugin uses nlohmann/json instead of QJson because of the ~128 MB object size limit by QJson. [ChangeLog][Tracing][CtfVisualizer] Added Chrome Trace Format Visualizer plugin Change-Id: I5969f7f83f3305712d4aec04487e2403510af64b Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
This commit is contained in:
Tim Henning
383
src/plugins/ctfvisualizer/ctftimelinemodel.cpp
Normal file
383
src/plugins/ctfvisualizer/ctftimelinemodel.cpp
Normal file
@@ -0,0 +1,383 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2019 Klarälvdalens Datakonsult AB, a KDAB Group company,
|
||||
** info@kdab.com, author Tim Henning <tim.henning@kdab.com>
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** This file is part of Qt Creator.
|
||||
**
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and The Qt Company. For licensing terms
|
||||
** and conditions see https://www.qt.io/terms-conditions. For further
|
||||
** information use the contact form at https://www.qt.io/contact-us.
|
||||
**
|
||||
** GNU General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU
|
||||
** General Public License version 3 as published by the Free Software
|
||||
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
||||
** included in the packaging of this file. Please review the following
|
||||
** information to ensure the GNU General Public License requirements will
|
||||
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#include "ctftimelinemodel.h"
|
||||
|
||||
#include "ctftracemanager.h"
|
||||
#include "ctfvisualizerconstants.h"
|
||||
|
||||
#include <tracing/timelineformattime.h>
|
||||
#include <tracing/timelinemodelaggregator.h>
|
||||
#include <utils/qtcassert.h>
|
||||
|
||||
#include <QDebug>
|
||||
|
||||
#include <string>
|
||||
|
||||
|
||||
namespace CtfVisualizer {
|
||||
namespace Internal {
|
||||
|
||||
using json = nlohmann::json;
|
||||
using namespace Constants;
|
||||
|
||||
CtfTimelineModel::CtfTimelineModel(Timeline::TimelineModelAggregator *parent,
|
||||
CtfTraceManager *traceManager, int tid, int pid)
|
||||
: Timeline::TimelineModel (parent)
|
||||
, m_traceManager(traceManager)
|
||||
, m_threadId(tid)
|
||||
, m_processId(pid)
|
||||
{
|
||||
updateName();
|
||||
setCollapsedRowCount(1);
|
||||
setCategoryColor(colorByHue(pid * 25));
|
||||
setHasMixedTypesInExpandedState(true);
|
||||
}
|
||||
|
||||
QRgb CtfTimelineModel::color(int index) const
|
||||
{
|
||||
return colorBySelectionId(index);
|
||||
}
|
||||
|
||||
QVariantList CtfTimelineModel::labels() const
|
||||
{
|
||||
QVariantList result;
|
||||
|
||||
QVector<std::string> sortedCounterNames = m_counterNames;
|
||||
std::sort(sortedCounterNames.begin(), sortedCounterNames.end());
|
||||
for (int i = 0; i < sortedCounterNames.size(); ++i) {
|
||||
QVariantMap element;
|
||||
element.insert(QLatin1String("description"), QString("~ %1").arg(QString::fromStdString(sortedCounterNames[i])));
|
||||
element.insert(QLatin1String("id"), i);
|
||||
result << element;
|
||||
}
|
||||
|
||||
for (int i = 0; i < m_maxStackSize; ++i) {
|
||||
QVariantMap element;
|
||||
element.insert(QLatin1String("description"), QStringLiteral("- ").append(tr("Stack Level %1").arg(i)));
|
||||
element.insert(QLatin1String("id"), m_counterNames.size() + i);
|
||||
result << element;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
QVariantMap CtfTimelineModel::orderedDetails(int index) const
|
||||
{
|
||||
QMap<int, QPair<QString, QString>> info = m_details.value(index);
|
||||
info.insert(2, {tr("Start"), Timeline::formatTime(startTime(index))});
|
||||
info.insert(3, {tr("Wall Duration"), Timeline::formatTime(duration(index))});
|
||||
QVariantMap data;
|
||||
QString title = info.value(0).second;
|
||||
data.insert("title", title);
|
||||
QVariantList content;
|
||||
auto it = info.constBegin();
|
||||
auto end = info.constEnd();
|
||||
++it; // skip title
|
||||
while (it != end) {
|
||||
content.append(it.value().first);
|
||||
content.append(it.value().second);
|
||||
++it;
|
||||
}
|
||||
data.insert("content", content);
|
||||
emit detailsRequested(title);
|
||||
return data;
|
||||
}
|
||||
|
||||
int CtfTimelineModel::expandedRow(int index) const
|
||||
{
|
||||
// m_itemToCounterIdx[index] is 0 for non-counter indexes
|
||||
const int counterIdx = m_itemToCounterIdx.value(index, 0);
|
||||
if (counterIdx > 0) {
|
||||
return m_counterIndexToRow[counterIdx - 1] + 1;
|
||||
}
|
||||
return m_nestingLevels.value(index) + m_counterData.size() + 1;
|
||||
}
|
||||
|
||||
int CtfTimelineModel::collapsedRow(int index) const
|
||||
{
|
||||
Q_UNUSED(index);
|
||||
return 0;
|
||||
}
|
||||
|
||||
int CtfTimelineModel::typeId(int index) const
|
||||
{
|
||||
QTC_ASSERT(index >= 0 && index < count(), return -1);
|
||||
return selectionId(index);
|
||||
}
|
||||
|
||||
bool CtfTimelineModel::handlesTypeId(int typeId) const
|
||||
{
|
||||
return m_handledTypeIds.contains(typeId);
|
||||
}
|
||||
|
||||
float CtfTimelineModel::relativeHeight(int index) const
|
||||
{
|
||||
// m_itemToCounterIdx[index] is 0 for non-counter indexes
|
||||
const int counterIdx = m_itemToCounterIdx.value(index, 0);
|
||||
if (counterIdx > 0) {
|
||||
const CounterData &data = m_counterData[counterIdx - 1];
|
||||
const float value = m_counterValues[index] / std::max(data.max, 1.0f);
|
||||
return value;
|
||||
}
|
||||
return 1.0f;
|
||||
}
|
||||
|
||||
QPair<bool, qint64> CtfTimelineModel::addEvent(const json &event, double timeOffset)
|
||||
{
|
||||
const double timestamp = event.value(CtfTracingClockTimestampKey, 0.0);
|
||||
const qint64 normalizedTime = qint64((timestamp - timeOffset) * 1000);
|
||||
const std::string eventPhase = event.value(CtfEventPhaseKey, "");
|
||||
const std::string name = event.value(CtfEventNameKey, "");
|
||||
qint64 duration = -1;
|
||||
|
||||
const int selectionId = m_traceManager->getSelectionId(name);
|
||||
m_handledTypeIds.insert(selectionId);
|
||||
|
||||
bool visibleOnTimeline = false;
|
||||
if (eventPhase == CtfEventTypeBegin || eventPhase == CtfEventTypeComplete
|
||||
|| eventPhase == CtfEventTypeInstant || eventPhase == CtfEventTypeInstantDeprecated) {
|
||||
duration = newStackEvent(event, normalizedTime, eventPhase, name, selectionId);
|
||||
visibleOnTimeline = true;
|
||||
} else if (eventPhase == CtfEventTypeEnd) {
|
||||
duration = closeStackEvent(event, timestamp, normalizedTime);
|
||||
visibleOnTimeline = true;
|
||||
} else if (eventPhase == CtfEventTypeCounter) {
|
||||
addCounterValue(event, normalizedTime, name, selectionId);
|
||||
visibleOnTimeline = true;
|
||||
} else if (eventPhase == CtfEventTypeMetadata) {
|
||||
const std::string name = event[CtfEventNameKey];
|
||||
if (name == "thread_name") {
|
||||
m_threadName = QString::fromStdString(event["args"]["name"]);
|
||||
updateName();
|
||||
} else if (name == "process_name") {
|
||||
m_processName = QString::fromStdString(event["args"]["name"]);
|
||||
updateName();
|
||||
}
|
||||
}
|
||||
return {visibleOnTimeline, duration};
|
||||
}
|
||||
|
||||
void CtfTimelineModel::finalize(double traceBegin, double traceEnd, const QString &processName, const QString &threadName)
|
||||
{
|
||||
m_processName = processName;
|
||||
m_threadName = threadName;
|
||||
updateName();
|
||||
|
||||
qint64 normalizedEnd = qint64((traceEnd - traceBegin) * 1000);
|
||||
while (!m_openEventIds.isEmpty()) {
|
||||
int index = m_openEventIds.pop();
|
||||
qint64 duration = normalizedEnd - startTime(index);
|
||||
insertEnd(index, duration);
|
||||
m_details[index].insert(3, {reuse(tr("Wall Duration")), Timeline::formatTime(duration)});
|
||||
m_details[index].insert(6, {reuse(tr("Unfinished")), reuse(tr("true"))});
|
||||
}
|
||||
computeNesting();
|
||||
|
||||
QVector<std::string> sortedCounterNames = m_counterNames;
|
||||
std::sort(sortedCounterNames.begin(), sortedCounterNames.end());
|
||||
m_counterIndexToRow.resize(m_counterNames.size());
|
||||
for (int i = 0; i < m_counterIndexToRow.size(); ++i) {
|
||||
m_counterIndexToRow[i] = sortedCounterNames.indexOf(m_counterNames[i]);
|
||||
}
|
||||
|
||||
// we insert an empty row in expanded state because otherwise
|
||||
// the row label would be where the thread label is
|
||||
setExpandedRowCount(1 + m_counterData.size() + m_maxStackSize);
|
||||
emit contentChanged();
|
||||
}
|
||||
|
||||
void CtfTimelineModel::updateName()
|
||||
{
|
||||
if (m_threadName.isEmpty()) {
|
||||
setDisplayName(tr("> Thread %1").arg(m_threadId));
|
||||
} else {
|
||||
setDisplayName(QString("> %1 (%2)").arg(m_threadName).arg(m_threadId));
|
||||
}
|
||||
QString process = m_processName.isEmpty() ? QString::number(m_processId) :
|
||||
QString("%1 (%2)").arg(m_processName).arg(m_processId);
|
||||
QString thread = m_threadName.isEmpty() ? QString::number(m_threadId) :
|
||||
QString("%1 (%2)").arg(m_threadName).arg(m_threadId);
|
||||
setTooltip(QString("Process: %1\nThread: %2").arg(process).arg(thread));
|
||||
}
|
||||
|
||||
qint64 CtfTimelineModel::newStackEvent(const json &event, qint64 normalizedTime,
|
||||
const std::string &eventPhase, const std::string &name,
|
||||
int selectionId)
|
||||
{
|
||||
int nestingLevel = m_openEventIds.size();
|
||||
m_maxStackSize = std::max(m_maxStackSize, m_openEventIds.size() + 1);
|
||||
int index = 0;
|
||||
qint64 duration = -1;
|
||||
if (eventPhase == CtfEventTypeBegin) {
|
||||
index = insertStart(normalizedTime, selectionId);
|
||||
m_openEventIds.push(index);
|
||||
// if this event was inserted before existing events, we need to
|
||||
// check whether indexes stored in m_openEventIds need to be updated (increased):
|
||||
// (the top element is the current event and is skipped)
|
||||
for (int i = m_openEventIds.size() - 2; i >= 0; --i) {
|
||||
if (m_openEventIds[i] >= index) ++m_openEventIds[i];
|
||||
}
|
||||
} else if (eventPhase == CtfEventTypeComplete) {
|
||||
duration = qint64(event[CtfDurationKey]) * 1000;
|
||||
index = insert(normalizedTime, duration, selectionId);
|
||||
for (int i = m_openEventIds.size() - 1; i >= 0; --i) {
|
||||
if (m_openEventIds[i] >= index) {
|
||||
++m_openEventIds[i];
|
||||
// if the event is before an open event, the nesting level decreases:
|
||||
--nestingLevel;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
index = insert(normalizedTime, 0, selectionId);
|
||||
for (int i = m_openEventIds.size() - 1; i >= 0; --i) {
|
||||
if (m_openEventIds[i] >= index) {
|
||||
++m_openEventIds[i];
|
||||
--nestingLevel;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (index >= m_details.size()) {
|
||||
m_details.resize(index + 1);
|
||||
m_details[index] = QMap<int, QPair<QString, QString>>();
|
||||
m_nestingLevels.resize(index + 1);
|
||||
m_nestingLevels[index] = nestingLevel;
|
||||
} else {
|
||||
m_details.insert(index, QMap<int, QPair<QString, QString>>());
|
||||
m_nestingLevels.insert(index, nestingLevel);
|
||||
}
|
||||
if (m_counterValues.size() > index) {
|
||||
// if the event was inserted before any counter, we need
|
||||
// to shift the values after it and update the last index:
|
||||
m_counterValues.insert(index, 0);
|
||||
m_itemToCounterIdx.insert(index, 0);
|
||||
for (CounterData &counterData: m_counterData) {
|
||||
if (counterData.startEventIndex >= index) ++counterData.startEventIndex;
|
||||
}
|
||||
}
|
||||
|
||||
if (!name.empty()) {
|
||||
m_details[index].insert(0, {{}, reuse(QString::fromStdString(name))});
|
||||
}
|
||||
if (event.contains(CtfEventCategoryKey)) {
|
||||
m_details[index].insert(1, {reuse(tr("Categories")), reuse(QString::fromStdString(event[CtfEventCategoryKey]))});
|
||||
}
|
||||
if (event.contains("args") && !event["args"].empty()) {
|
||||
QString argsJson = QString::fromStdString(event["args"].dump(1));
|
||||
// strip leading and trailing curled brackets:
|
||||
argsJson = argsJson.size() > 4 ? argsJson.mid(2, argsJson.size() - 4) : argsJson;
|
||||
m_details[index].insert(4, {reuse(tr("Arguments")), reuse(argsJson)});
|
||||
}
|
||||
if (eventPhase == CtfEventTypeInstant) {
|
||||
m_details[index].insert(6, {reuse(tr("Instant")), reuse(tr("true"))});
|
||||
if (event.contains("s")) {
|
||||
std::string scope = event["s"];
|
||||
if (scope == "g") {
|
||||
m_details[index].insert(7, {reuse(tr("Scope")), reuse(tr("global"))});
|
||||
} else if (scope == "p") {
|
||||
m_details[index].insert(7, {reuse(tr("Scope")), reuse(tr("process"))});
|
||||
} else {
|
||||
m_details[index].insert(7, {reuse(tr("Scope")), reuse(tr("thread"))});
|
||||
}
|
||||
}
|
||||
}
|
||||
return duration;
|
||||
}
|
||||
|
||||
qint64 CtfTimelineModel::closeStackEvent(const json &event, double timestamp, qint64 normalizedTime)
|
||||
{
|
||||
if (m_openEventIds.isEmpty()) {
|
||||
qWarning() << QString("End event without open 'begin' event at timestamp %1").arg(timestamp, 0, 'f');
|
||||
return -1;
|
||||
} else {
|
||||
const int index = m_openEventIds.pop();
|
||||
const qint64 duration = normalizedTime - startTime(index);
|
||||
insertEnd(index, duration);
|
||||
if (event.contains("args") && !event["args"].empty()) {
|
||||
QString argsJson = QString::fromStdString(event["args"].dump(1));
|
||||
// strip leading and trailing curled brackets:
|
||||
argsJson = argsJson.size() > 4 ? argsJson.mid(2, argsJson.size() - 4) : argsJson;
|
||||
m_details[index].insert(5, {reuse(tr("Return Arguments")), reuse(argsJson)});
|
||||
}
|
||||
return duration;
|
||||
}
|
||||
}
|
||||
|
||||
void CtfTimelineModel::addCounterValue(const json &event, qint64 normalizedTime,
|
||||
const std::string &name, int selectionId)
|
||||
{
|
||||
if (!event.contains("args")) return;
|
||||
// CTF documentation says all keys of 'args' should be displayed in
|
||||
// one stacked graph, but we will display them separately:
|
||||
for (auto it: event["args"].items()) {
|
||||
std::string counterName = event.contains("id") ?
|
||||
name + event.value("id", "") : name;
|
||||
const std::string &key = it.key();
|
||||
if (key != "value") {
|
||||
counterName += " " + key;
|
||||
}
|
||||
const float value = it.value();
|
||||
int counterIndex = m_counterNames.indexOf(counterName);
|
||||
if (counterIndex < 0) {
|
||||
counterIndex = m_counterData.size();
|
||||
m_counterNames.append(counterName);
|
||||
m_counterData.append(CounterData());
|
||||
}
|
||||
CounterData &data = m_counterData[counterIndex];
|
||||
if (data.startEventIndex >= 0) {
|
||||
insertEnd(data.startEventIndex, normalizedTime - data.end);
|
||||
}
|
||||
const int index = insertStart(normalizedTime, selectionId);
|
||||
data.startEventIndex = index;
|
||||
data.end = normalizedTime;
|
||||
data.min = std::min(data.min, value);
|
||||
data.max = std::max(data.max, value);
|
||||
if (index >= m_counterValues.size()) {
|
||||
m_counterValues.resize(index + 1);
|
||||
m_counterValues[index] = value;
|
||||
m_itemToCounterIdx.resize(index + 1);
|
||||
// m_itemToCounterIdx[index] == 0 is used to indicate a non-counter value
|
||||
m_itemToCounterIdx[index] = counterIndex + 1;
|
||||
} else {
|
||||
m_counterValues.insert(index, value);
|
||||
m_itemToCounterIdx.insert(index, counterIndex + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const QString &CtfTimelineModel::reuse(const QString &value)
|
||||
{
|
||||
auto it = m_reusableStrings.find(value);
|
||||
if (it == m_reusableStrings.end()) {
|
||||
m_reusableStrings.insert(value);
|
||||
return value;
|
||||
}
|
||||
return *it;
|
||||
}
|
||||
|
||||
|
||||
} // namespace Internal
|
||||
} // namespace CtfVisualizer
|
||||
|
||||
Reference in New Issue
Block a user