1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*
execution.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2017 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#ifndef GAMMARAY_EXECUTION_H
#define GAMMARAY_EXECUTION_H
#include "gammaray_core_export.h"
#include <common/sourcelocation.h>
#include <QMetaType>
#include <QVector>
#include <memory>
namespace GammaRay {
/*! Functions to inspect the current program execution. */
namespace Execution {
/*! Checks whether the given memory address is inside a read-only data section. */
GAMMARAY_CORE_EXPORT bool isReadOnlyData(const void *data);
/*! Returns @c true if we have the capability to generate stack traces. */
GAMMARAY_CORE_EXPORT bool stackTracingAvailable();
/*! Returns @c true if we have a way to obtain fast stack traces.
* That is, if we can defer stack frame resolution to later point in time.
*/
GAMMARAY_CORE_EXPORT bool hasFastStackTrace();
class TracePrivate;
/*! An instance of a backtrace.
* This is essentially just a list of addresses, and needs to
* be resolved to symbol names and source location for display.
*/
class GAMMARAY_CORE_EXPORT Trace
{
public:
Trace();
Trace(const Trace &other);
~Trace();
Trace &operator=(const Trace &other);
bool empty() const;
int size() const;
private:
friend class TracePrivate;
std::shared_ptr<TracePrivate> d;
};
/*! Create a backtrace.
* @param maxDepth The maximum amount of frames to trace
* @param skip The amount of frames to skip from the beginning. This is useful to
* exclude the code triggering the trace for example. Traces returned by this function
* already start at the calling frame, so you do not need to account for the internals
* of this here.
*/
GAMMARAY_CORE_EXPORT Trace stackTrace(int maxDepth, int skip = 0);
/*! A resolved frame in a stack trace. */
class GAMMARAY_CORE_EXPORT ResolvedFrame
{
public:
QString name;
SourceLocation location;
};
/*! Resolve a single backtrace frame. */
GAMMARAY_CORE_EXPORT ResolvedFrame resolveOne(const Trace &trace, int index);
/*! Resolve an entire backtrace. */
GAMMARAY_CORE_EXPORT QVector<ResolvedFrame> resolveAll(const Trace &trace);
}
}
Q_DECLARE_METATYPE(GammaRay::Execution::Trace)
#endif // GAMMARAY_EXECUTION_H
|
