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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "windebuginterface.h"
#ifdef Q_OS_WIN
# if (QT_VERSION < QT_VERSION_CHECK(5, 4, 1))
# define NOMINMAX
# endif
#include <windows.h>
#include <QApplication>
#include <QTime>
/*!
\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 = 0;
WinDebugInterface *WinDebugInterface::instance()
{
return m_instance;
}
bool WinDebugInterface::stop()
{
if (!m_waitHandles[TerminateEventHandle])
return false;
SetEvent(m_waitHandles[TerminateEventHandle]);
return true;
}
WinDebugInterface::WinDebugInterface(QObject *parent) :
QThread(parent)
{
m_instance = this;
m_creatorPid = qApp->applicationPid();
setObjectName(QLatin1String("WinDebugInterfaceThread"));
}
WinDebugInterface::~WinDebugInterface()
{
if (stop())
wait(500);
m_instance = 0;
}
void WinDebugInterface::run()
{
m_waitHandles[DataReadyEventHandle] = m_waitHandles[TerminateEventHandle] = 0;
m_bufferReadyEvent = 0;
m_sharedFile = 0;
m_sharedMem = 0;
if (!runLoop())
emit cannotRetrieveDebugOutput();
if (m_sharedMem) {
UnmapViewOfFile(m_sharedMem);
m_sharedMem = 0;
}
if (m_sharedFile) {
CloseHandle(m_sharedFile);
m_sharedFile = 0;
}
if (m_waitHandles[TerminateEventHandle]) {
CloseHandle(m_waitHandles[TerminateEventHandle]);
m_waitHandles[TerminateEventHandle] = 0;
}
if (m_waitHandles[DataReadyEventHandle]) {
CloseHandle(m_waitHandles[DataReadyEventHandle]);
m_waitHandles[DataReadyEventHandle] = 0;
}
if (m_bufferReadyEvent) {
CloseHandle(m_bufferReadyEvent);
m_bufferReadyEvent = 0;
}
}
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);
LPDWORD processId = reinterpret_cast<LPDWORD>(m_sharedMem);
SetEvent(m_bufferReadyEvent);
QTime timer; // time since last signal sent
timer.start();
QMap<qint64, QString> delayedMessages;
auto flushMessages = [this, &delayedMessages, &timer](){
auto it = delayedMessages.constBegin();
auto end = delayedMessages.constEnd();
for (; it != end; ++it)
emit debugOutput(it.key(), it.value());
delayedMessages.clear();
timer.start();
};
while (true) {
DWORD timeout = INFINITE;
if (!delayedMessages.isEmpty()) // if we have delayed message, don't wait forever
timeout = qMax(60 - timer.elapsed(), 1);
const DWORD ret = WaitForMultipleObjects(HandleCount, m_waitHandles, FALSE, timeout);
if (ret == WAIT_FAILED || ret - WAIT_OBJECT_0 == TerminateEventHandle) {
flushMessages();
break;
}
if (ret == WAIT_TIMEOUT) {
flushMessages();
SetEvent(m_bufferReadyEvent);
} else if (ret - WAIT_OBJECT_0 == DataReadyEventHandle) {
if (*processId != m_creatorPid) {
if (timer.elapsed() < 60) {
delayedMessages[*processId].append(QString::fromLocal8Bit(message));
} else {
delayedMessages[*processId] += QString::fromLocal8Bit(message);
flushMessages();
}
}
SetEvent(m_bufferReadyEvent);
}
}
return true;
}
} // namespace Internal
} // namespace ProjectExplorer
#else
namespace ProjectExplorer {
namespace Internal {
WinDebugInterface *WinDebugInterface::m_instance = 0;
WinDebugInterface *WinDebugInterface::instance() { return 0; }
WinDebugInterface::WinDebugInterface(QObject *) {}
WinDebugInterface::~WinDebugInterface() {}
void WinDebugInterface::run() {}
bool WinDebugInterface::runLoop() { return false; }
} // namespace Internal
} // namespace ProjectExplorer
#endif
|
