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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "windebuginterface.h"
#ifdef Q_OS_WIN
#include <utils/qtcassert.h>
#include <QCoreApplication>
#include <qt_windows.h>
#include <algorithm>
/*!
\class ProjectExplorer::Internal::WinDebugInterface
\brief The WinDebugInterface class is used on Windows to capture output of
the Windows API \c OutputDebugString() function.
Emits output by process id.
The \c OutputDebugString() function puts its data into a shared memory segment named
\c DBWIN_BUFFER which can be accessed via file mapping.
*/
namespace ProjectExplorer {
namespace Internal {
WinDebugInterface *WinDebugInterface::m_instance = nullptr;
WinDebugInterface *WinDebugInterface::instance()
{
return m_instance;
}
bool WinDebugInterface::stop()
{
if (!m_instance->m_waitHandles[TerminateEventHandle])
return false;
SetEvent(m_instance->m_waitHandles[TerminateEventHandle]);
return true;
}
WinDebugInterface::WinDebugInterface(QObject *parent) :
QThread(parent)
{
m_instance = this;
m_creatorPid = QCoreApplication::applicationPid();
setObjectName(QLatin1String("WinDebugInterfaceThread"));
connect(this, &WinDebugInterface::_q_debugOutputReady,
this, &WinDebugInterface::dispatchDebugOutput, Qt::QueuedConnection);
}
WinDebugInterface::~WinDebugInterface()
{
if (stop())
wait(500);
m_instance = nullptr;
}
void WinDebugInterface::run()
{
m_waitHandles[DataReadyEventHandle] = m_waitHandles[TerminateEventHandle] = nullptr;
m_bufferReadyEvent = nullptr;
m_sharedFile = nullptr;
m_sharedMem = nullptr;
if (!runLoop())
emit cannotRetrieveDebugOutput();
if (m_sharedMem) {
UnmapViewOfFile(m_sharedMem);
m_sharedMem = nullptr;
}
if (m_sharedFile) {
CloseHandle(m_sharedFile);
m_sharedFile = nullptr;
}
if (m_waitHandles[TerminateEventHandle]) {
CloseHandle(m_waitHandles[TerminateEventHandle]);
m_waitHandles[TerminateEventHandle] = nullptr;
}
if (m_waitHandles[DataReadyEventHandle]) {
CloseHandle(m_waitHandles[DataReadyEventHandle]);
m_waitHandles[DataReadyEventHandle] = nullptr;
}
if (m_bufferReadyEvent) {
CloseHandle(m_bufferReadyEvent);
m_bufferReadyEvent = nullptr;
}
}
bool WinDebugInterface::runLoop()
{
m_waitHandles[TerminateEventHandle] = CreateEvent(NULL, FALSE, FALSE, NULL);
if (GetLastError() == ERROR_ALREADY_EXISTS)
return false;
m_waitHandles[DataReadyEventHandle] = CreateEvent(NULL, FALSE, FALSE, L"DBWIN_DATA_READY");
if (!m_waitHandles[TerminateEventHandle] || !m_waitHandles[DataReadyEventHandle]
|| GetLastError() == ERROR_ALREADY_EXISTS)
return false;
m_bufferReadyEvent = CreateEvent(NULL, FALSE, FALSE, L"DBWIN_BUFFER_READY");
if (!m_bufferReadyEvent
|| GetLastError() == ERROR_ALREADY_EXISTS)
return false;
m_sharedFile = CreateFileMapping((HANDLE)-1, NULL, PAGE_READWRITE, 0, 4096, L"DBWIN_BUFFER");
if (!m_sharedFile || GetLastError() == ERROR_ALREADY_EXISTS)
return false;
m_sharedMem = MapViewOfFile(m_sharedFile, FILE_MAP_READ, 0, 0, 512);
if (!m_sharedMem)
return false;
LPSTR message = reinterpret_cast<LPSTR>(m_sharedMem) + sizeof(DWORD);
auto processId = reinterpret_cast<LPDWORD>(m_sharedMem);
SetEvent(m_bufferReadyEvent);
while (true) {
const DWORD ret = WaitForMultipleObjects(HandleCount, m_waitHandles, FALSE, INFINITE);
if (ret == WAIT_FAILED || ret - WAIT_OBJECT_0 == TerminateEventHandle) {
std::lock_guard<std::mutex> guard(m_outputMutex);
emitReadySignal();
break;
}
if (ret - WAIT_OBJECT_0 == DataReadyEventHandle) {
if (*processId != m_creatorPid) {
std::lock_guard<std::mutex> guard(m_outputMutex);
m_debugOutput[*processId].push_back(QString::fromLocal8Bit(message));
emitReadySignal();
}
SetEvent(m_bufferReadyEvent);
}
}
return true;
}
void WinDebugInterface::emitReadySignal()
{
// This function must be called from the WinDebugInterface thread only.
QTC_ASSERT(QThread::currentThread() == this, return);
if (m_debugOutput.empty() || m_readySignalEmitted)
return;
m_readySignalEmitted = true;
emit _q_debugOutputReady();
}
void WinDebugInterface::dispatchDebugOutput()
{
// Called in the thread this object was created in, not in the WinDebugInterfaceThread.
QTC_ASSERT(QThread::currentThread() == QCoreApplication::instance()->thread(), return);
static size_t maxMessagesToSend = 100;
std::vector<std::pair<qint64, QString>> output;
bool hasMoreOutput = false;
m_outputMutex.lock();
for (auto &entry : m_debugOutput) {
std::vector<QString> &src = entry.second;
if (src.empty())
continue;
QString dst;
size_t n = std::min(maxMessagesToSend, src.size());
for (size_t i = 0; i < n; ++i)
dst += src.at(i);
src.erase(src.begin(), std::next(src.begin(), n));
if (!src.empty())
hasMoreOutput = true;
output.emplace_back(entry.first, std::move(dst));
}
if (!hasMoreOutput)
m_readySignalEmitted = false;
m_outputMutex.unlock();
for (const auto &p : qAsConst(output))
emit debugOutput(p.first, p.second);
if (hasMoreOutput)
emit _q_debugOutputReady();
}
void WinDebugInterface::startIfNeeded()
{
if (!m_instance->isRunning())
m_instance->start();
}
} // namespace Internal
} // namespace ProjectExplorer
#else
namespace ProjectExplorer {
namespace Internal {
WinDebugInterface *WinDebugInterface::m_instance = nullptr;
WinDebugInterface *WinDebugInterface::instance() { return nullptr; }
WinDebugInterface::WinDebugInterface(QObject *) { }
WinDebugInterface::~WinDebugInterface() { }
void WinDebugInterface::run() { }
bool WinDebugInterface::runLoop() { return false; }
void WinDebugInterface::emitReadySignal() { }
void WinDebugInterface::dispatchDebugOutput() { }
bool WinDebugInterface::stop() { return false; }
void WinDebugInterface::startIfNeeded() { }
} // namespace Internal
} // namespace ProjectExplorer
#endif
|
