3 #include "apitracecall.h"
13 #include <qjson/parser.h>
16 * Wrapper around a QProcess which enforces IO to block .
18 * Several QIODevice users (notably QJSON) expect blocking semantics, e.g.,
19 * they expect that QIODevice::read() will blocked until the requested ammount
20 * of bytes is read or end of file is reached. But by default QProcess, does
21 * not block. And passing QIODevice::Unbuffered mitigates but does not fully
22 * address the problem either.
24 * This class wraps around QProcess, providing QIODevice interface, while
25 * ensuring that all reads block.
27 * This class also works around a bug in QProcess::atEnd() implementation.
30 * - http://qt-project.org/wiki/Simple_Crypt_IO_Device
31 * - http://qt-project.org/wiki/Custom_IO_Device
33 class BlockingIODevice : public QIODevice
35 /* We don't use the Q_OBJECT in this class given we don't declare any
36 * signals and slots or use any other services provided by Qt's meta-object
39 BlockingIODevice(QProcess * io);
40 bool isSequential() const;
42 bool waitForReadyRead(int msecs = -1);
45 qint64 readData(char * data, qint64 maxSize);
46 qint64 writeData(const char * data, qint64 maxSize);
52 BlockingIODevice::BlockingIODevice(QProcess * io) :
56 * We pass QIODevice::Unbuffered to prevent the base QIODevice class to do
57 * its own buffering on top of the overridden readData() method.
59 * The only buffering used will be to satisfy QIODevice::peek() and
60 * QIODevice::ungetChar().
62 setOpenMode(ReadOnly | Unbuffered);
65 bool BlockingIODevice::isSequential() const
70 bool BlockingIODevice::atEnd() const
73 * XXX: QProcess::atEnd() documentation is wrong -- it will return true
74 * even when the process is running --, so we try to workaround that here.
76 if (m_device->atEnd()) {
77 if (m_device->state() == QProcess::Running) {
78 if (!m_device->waitForReadyRead(-1)) {
86 bool BlockingIODevice::waitForReadyRead(int msecs)
92 qint64 BlockingIODevice::readData(char * data, qint64 maxSize)
94 qint64 bytesToRead = maxSize;
97 qint64 chunkSize = m_device->read(data + readSoFar, bytesToRead);
105 Q_ASSERT(chunkSize <= bytesToRead);
106 bytesToRead -= chunkSize;
107 readSoFar += chunkSize;
109 if (!m_device->waitForReadyRead(-1)) {
110 qDebug() << "waitForReadyRead failed\n";
114 } while(bytesToRead);
119 qint64 BlockingIODevice::writeData(const char * data, qint64 maxSize)
125 Q_DECLARE_METATYPE(QList<ApiTraceError>);
127 Retracer::Retracer(QObject *parent)
129 m_benchmarking(false),
130 m_doubleBuffered(true),
131 m_captureState(false),
134 qRegisterMetaType<QList<ApiTraceError> >();
137 QString format = QLatin1String("%1;");
139 QString format = QLatin1String("%1:");
141 QString buildPath = format.arg(APITRACE_BINARY_DIR);
142 m_processEnvironment = QProcessEnvironment::systemEnvironment();
143 m_processEnvironment.insert("PATH", buildPath +
144 m_processEnvironment.value("PATH"));
147 m_processEnvironment.value("PATH").toLatin1());
150 QString Retracer::fileName() const
155 void Retracer::setFileName(const QString &name)
160 void Retracer::setAPI(trace::API api)
165 bool Retracer::isBenchmarking() const
167 return m_benchmarking;
170 void Retracer::setBenchmarking(bool bench)
172 m_benchmarking = bench;
175 bool Retracer::isDoubleBuffered() const
177 return m_doubleBuffered;
180 void Retracer::setDoubleBuffered(bool db)
182 m_doubleBuffered = db;
185 void Retracer::setCaptureAtCallNumber(qlonglong num)
190 qlonglong Retracer::captureAtCallNumber() const
192 return m_captureCall;
195 bool Retracer::captureState() const
197 return m_captureState;
200 void Retracer::setCaptureState(bool enable)
202 m_captureState = enable;
205 bool Retracer::captureThumbnails() const
207 return m_captureThumbnails;
210 void Retracer::setCaptureThumbnails(bool enable)
212 m_captureThumbnails = enable;
217 * Starting point for the retracing thread.
219 * Overrides QThread::run().
223 QString msg = QLatin1String("Replay finished!");
226 * Construct command line
230 QStringList arguments;
232 if (m_api == trace::API_GL) {
233 prog = QLatin1String("glretrace");
234 } else if (m_api == trace::API_EGL) {
235 prog = QLatin1String("eglretrace");
237 emit finished(QLatin1String("Unsupported API"));
241 if (m_doubleBuffered) {
242 arguments << QLatin1String("-db");
244 arguments << QLatin1String("-sb");
247 if (m_captureState) {
248 arguments << QLatin1String("-D");
249 arguments << QString::number(m_captureCall);
250 } else if (m_captureThumbnails) {
251 arguments << QLatin1String("-s"); // emit snapshots
252 arguments << QLatin1String("-"); // emit to stdout
253 } else if (m_benchmarking) {
254 arguments << QLatin1String("-b");
257 arguments << m_fileName;
265 process.start(prog, arguments, QIODevice::ReadOnly);
266 if (!process.waitForStarted(-1)) {
267 emit finished(QLatin1String("Could not start process"));
272 * Process standard output
275 QList<QImage> thumbnails;
276 QVariantMap parsedJson;
278 process.setReadChannel(QProcess::StandardOutput);
279 if (process.waitForReadyRead(-1)) {
280 BlockingIODevice io(&process);
282 if (m_captureState) {
284 * Parse JSON from the output.
286 * XXX: QJSON expects blocking IO.
288 * XXX: QJSON's scanner is inneficient as it abuses single
289 * character QIODevice::peek (not cheap), instead of maintaining a
290 * lookahead character on its own.
294 QJson::Parser jsonParser;
295 parsedJson = jsonParser.parse(&io, &ok).toMap();
297 msg = QLatin1String("failed to parse JSON");
299 } else if (m_captureThumbnails) {
301 * Parse concatenated PNM images from output.
304 while (!io.atEnd()) {
305 unsigned channels = 0;
310 qint64 headerSize = 0;
311 int headerLines = 3; // assume no optional comment line
313 for (int headerLine = 0; headerLine < headerLines; ++headerLine) {
314 qint64 headerRead = io.readLine(&header[headerSize], sizeof(header) - headerSize);
316 // if header actually contains optional comment line, ...
317 if (headerLine == 1 && header[headerSize] == '#') {
321 headerSize += headerRead;
324 const char *headerEnd = image::readPNMHeader(header, headerSize, &channels, &width, &height);
326 // if invalid PNM header was encountered, ...
327 if (header == headerEnd) {
328 qDebug() << "error: invalid snapshot stream encountered";
332 // qDebug() << "channels: " << channels << ", width: " << width << ", height: " << height";
334 QImage snapshot = QImage(width, height, channels == 1 ? QImage::Format_Mono : QImage::Format_RGB888);
336 int rowBytes = channels * width;
337 for (int y = 0; y < height; ++y) {
338 unsigned char *scanLine = snapshot.scanLine(y);
339 qint64 readBytes = io.read((char *) scanLine, rowBytes);
340 Q_ASSERT(readBytes == rowBytes);
343 QImage thumb = thumbnail(snapshot);
344 thumbnails.append(thumb);
347 Q_ASSERT(process.state() != QProcess::Running);
351 output = process.readAllStandardOutput();
352 if (output.length() < 80) {
353 msg = QString::fromUtf8(output);
359 * Wait for process termination
362 process.waitForFinished(-1);
364 if (process.exitStatus() != QProcess::NormalExit) {
365 msg = QLatin1String("Process crashed");
366 } else if (process.exitCode() != 0) {
367 msg = QLatin1String("Process exited with non zero exit code");
374 QList<ApiTraceError> errors;
375 process.setReadChannel(QProcess::StandardError);
376 QRegExp regexp("(^\\d+): +(\\b\\w+\\b): ([^\\r\\n]+)[\\r\\n]*$");
377 while (!process.atEnd()) {
378 QString line = process.readLine();
379 if (regexp.indexIn(line) != -1) {
381 error.callIndex = regexp.cap(1).toInt();
382 error.type = regexp.cap(2);
383 error.message = regexp.cap(3);
384 errors.append(error);
392 if (m_captureState) {
393 ApiTraceState *state = new ApiTraceState(parsedJson);
394 emit foundState(state);
395 msg = QLatin1String("State fetched.");
398 if (m_captureThumbnails && !thumbnails.isEmpty()) {
399 emit foundThumbnails(thumbnails);
402 if (!errors.isEmpty()) {
403 emit retraceErrors(errors);
409 #include "retracer.moc"