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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/****************************************************************************
**
** Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Rafael Roquetto <rafael.roquetto@kdab.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "lttng.h"
#include "provider.h"
#include "helpers.h"
#include "panic.h"
#include "qtheaders.h"
#include <qfile.h>
#include <qfileinfo.h>
#include <qtextstream.h>
#include <qdebug.h>
static void writeCtfMacro(QTextStream &stream, const Tracepoint::Field &field)
{
const QString ¶mType = field.paramType;
const QString &name = field.name;
const QString &seqLen = field.seqLen;
const int arrayLen = field.arrayLen;
switch (field.backendType) {
case Tracepoint::Field::Array:
stream << "ctf_array(" <<paramType << ", "
<< name << ", " << name << ", " << arrayLen << ")";
return;
case Tracepoint::Field::Sequence:
stream << "ctf_sequence(" << paramType
<< ", " << name << ", " << name
<< ", unsigned int, " << seqLen << ")";
return;
case Tracepoint::Field::Integer:
stream << "ctf_integer(" << paramType << ", " << name << ", " << name << ")";
return;
case Tracepoint::Field::IntegerHex:
case Tracepoint::Field::Pointer:
stream << "ctf_integer_hex(" << paramType << ", " << name << ", " << name << ")";
return;
case Tracepoint::Field::Float:
stream << "ctf_float(" << paramType << ", " << name << ", " << name << ")";
return;
case Tracepoint::Field::String:
stream << "ctf_string(" << name << ", " << name << ")";
return;
case Tracepoint::Field::QtString:
stream << "ctf_sequence(const ushort, " << name << ", "
<< name << ".utf16(), unsigned int, " << name << ".size())";
return;
case Tracepoint::Field::QtByteArray:
stream << "ctf_sequence(const char, " << name << ", "
<< name << ".constData(), unsigned int, " << name << ".size())";
return;
case Tracepoint::Field::QtUrl:
stream << "ctf_sequence(const char, " << name << ", "
<< name << ".toEncoded().constData(), unsigned int, "
<< name << ".toEncoded().size())";
return;
case Tracepoint::Field::QtRect:
stream << "ctf_integer(int, x, " << name << ".x()) "
<< "ctf_integer(int, y, " << name << ".y()) "
<< "ctf_integer(int, width, " << name << ".width()) "
<< "ctf_integer(int, height, " << name << ".height()) ";
return;
case Tracepoint::Field::Unknown:
panic("Cannot deduce CTF type for '%s %s", qPrintable(paramType), qPrintable(name));
break;
}
}
static void writePrologue(QTextStream &stream, const QString &fileName, const Provider &provider)
{
const QString guard = includeGuard(fileName);
stream << "#undef TRACEPOINT_PROVIDER\n";
stream << "#define TRACEPOINT_PROVIDER " << provider.name << "\n";
stream << "\n";
// include prefix text or qt headers only once
stream << "#if !defined(" << guard << ")\n";
stream << qtHeaders();
stream << "\n";
if (!provider.prefixText.isEmpty())
stream << provider.prefixText.join(QLatin1Char('\n')) << "\n\n";
stream << "#endif\n\n";
/* the first guard is the usual one, the second is required
* by LTTNG to force the re-evaluation of TRACEPOINT_* macros
*/
stream << "#if !defined(" << guard << ") || defined(TRACEPOINT_HEADER_MULTI_READ)\n";
stream << "#define " << guard << "\n\n"
<< "#undef TRACEPOINT_INCLUDE\n"
<< "#define TRACEPOINT_INCLUDE \"" << fileName << "\"\n\n";
stream << "#include <lttng/tracepoint.h>\n\n";
}
static void writeEpilogue(QTextStream &stream, const QString &fileName)
{
stream << "\n";
stream << "#endif // " << includeGuard(fileName) << "\n"
<< "#include <lttng/tracepoint-event.h>\n"
<< "#include <private/qtrace_p.h>\n";
}
static void writeWrapper(QTextStream &stream,
const Tracepoint &tracepoint, const QString &providerName)
{
const QString argList = formatFunctionSignature(tracepoint.args);
const QString paramList = formatParameterList(tracepoint.args, LTTNG);
const QString &name = tracepoint.name;
const QString includeGuard = QStringLiteral("TP_%1_%2").arg(providerName).arg(name).toUpper();
/* prevents the redefinion of the inline wrapper functions
* once LTTNG recursively includes this header file
*/
stream << "\n"
<< "#ifndef " << includeGuard << "\n"
<< "#define " << includeGuard << "\n"
<< "namespace QtPrivate {\n";
stream << "inline void trace_" << name << "(" << argList << ")\n"
<< "{\n"
<< " tracepoint(" << providerName << ", " << name << paramList << ");\n"
<< "}\n";
stream << "inline void do_trace_" << name << "(" << argList << ")\n"
<< "{\n"
<< " do_tracepoint(" << providerName << ", " << name << paramList << ");\n"
<< "}\n";
stream << "inline bool trace_" << name << "_enabled()\n"
<< "{\n"
<< " return tracepoint_enabled(" << providerName << ", " << name << ");\n"
<< "}\n";
stream << "} // namespace QtPrivate\n"
<< "#endif // " << includeGuard << "\n\n";
}
static void writeTracepoint(QTextStream &stream,
const Tracepoint &tracepoint, const QString &providerName)
{
stream << "TRACEPOINT_EVENT(\n"
<< " " << providerName << ",\n"
<< " " << tracepoint.name << ",\n"
<< " TP_ARGS(";
const char *comma = nullptr;
for (const Tracepoint::Argument &arg : tracepoint.args) {
stream << comma << arg.type << ", " << arg.name;
comma = ", ";
}
stream << "),\n"
<< " TP_FIELDS(";
const char *newline = nullptr;
for (const Tracepoint::Field &f : tracepoint.fields) {
stream << newline;
writeCtfMacro(stream, f);
newline = "\n ";
}
stream << ")\n)\n\n";
}
static void writeTracepoints(QTextStream &stream, const Provider &provider)
{
for (const Tracepoint &t : provider.tracepoints) {
writeTracepoint(stream, t, provider.name);
writeWrapper(stream, t, provider.name);
}
}
void writeLttng(QFile &file, const Provider &provider)
{
QTextStream stream(&file);
const QString fileName = QFileInfo(file.fileName()).fileName();
writePrologue(stream, fileName, provider);
writeTracepoints(stream, provider);
writeEpilogue(stream, fileName);
}
|
