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
224
225
226
227
228
229
|
/*******************************************************************************
* Copyright (c) 2016 Ericsson and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package org.eclipse.cdt.dsf.gdb.internal.ui.console;
import java.util.concurrent.RejectedExecutionException;
import org.eclipse.cdt.debug.ui.CDebugUIPlugin;
import org.eclipse.cdt.debug.ui.debuggerconsole.IDebuggerConsole;
import org.eclipse.cdt.debug.ui.debuggerconsole.IDebuggerConsoleManager;
import org.eclipse.cdt.dsf.concurrent.ConfinedToDsfExecutor;
import org.eclipse.cdt.dsf.concurrent.DsfRunnable;
import org.eclipse.cdt.dsf.debug.service.command.ICommandControlService;
import org.eclipse.cdt.dsf.debug.service.command.ICommandControlService.ICommandControlInitializedDMEvent;
import org.eclipse.cdt.dsf.gdb.internal.ui.GdbUIPlugin;
import org.eclipse.cdt.dsf.gdb.launching.GdbLaunch;
import org.eclipse.cdt.dsf.gdb.service.IGDBBackend;
import org.eclipse.cdt.dsf.gdb.service.command.IGDBControl;
import org.eclipse.cdt.dsf.mi.service.IMIBackend;
import org.eclipse.cdt.dsf.service.DsfServiceEventHandler;
import org.eclipse.cdt.dsf.service.DsfServicesTracker;
import org.eclipse.cdt.dsf.service.DsfSession;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchesListener2;
/**
* A console manager for GDB sessions which adds and removes
* gdb cli consoles.
*
* There is a single such console per debug session.
* This console interacts directly with the GDB process using
* the standard GDB CLI interface.
* These consoles cannot be enabled/disabled by the user.
* However, they are only supported by GDB >= 7.12;
* to handle this limitation, the console manager will use the DSF Backend
* service to establish if it should start a gdb cli console or not.
*/
public class GdbCliConsoleManager implements ILaunchesListener2 {
/**
* Start the tracing console. We don't do this in a constructor, because
* we need to use <code>this</code>.
*/
public void startup() {
// Listen to launch events
DebugPlugin.getDefault().getLaunchManager().addLaunchListener(this);
}
public void shutdown() {
DebugPlugin.getDefault().getLaunchManager().removeLaunchListener(this);
}
@Override
public void launchesAdded(ILaunch[] launches) {
for (ILaunch launch : launches) {
handleConsoleForLaunch(launch);
}
}
@Override
public void launchesChanged(ILaunch[] launches) {
}
@Override
public void launchesRemoved(ILaunch[] launches) {
for (ILaunch launch : launches) {
removeConsole(launch);
}
}
@Override
public void launchesTerminated(ILaunch[] launches) {
for (ILaunch launch : launches) {
renameConsole(launch);
}
}
protected void handleConsoleForLaunch(ILaunch launch) {
// Full CLI GDB consoles are only added for GdbLaunches
if (launch instanceof GdbLaunch) {
new GdbConsoleCreator((GdbLaunch)launch).init();
}
}
protected void removeConsole(ILaunch launch) {
IDebuggerConsole console = getConsole(launch);
if (console != null) {
removeConsole(console);
}
}
private void renameConsole(ILaunch launch) {
IDebuggerConsole console = getConsole(launch);
if (console != null) {
console.resetName();
}
}
private IDebuggerConsole getConsole(ILaunch launch) {
IDebuggerConsoleManager manager = CDebugUIPlugin.getDebuggerConsoleManager();
for (IDebuggerConsole console : manager.getConsoles()) {
if (console.getLaunch().equals(launch)) {
return console;
}
}
return null;
}
private void addConsole(IDebuggerConsole console) {
getDebuggerConsoleManager().addConsole(console);
}
private void removeConsole(IDebuggerConsole console) {
getDebuggerConsoleManager().removeConsole(console);
}
private IDebuggerConsoleManager getDebuggerConsoleManager() {
return CDebugUIPlugin.getDebuggerConsoleManager();
}
/**
* Class that determines what type of console should be created
* for this particular Gdblaunch. It figures this out by asking the
* Backend service. It then either creates a GdbFullCliConsole or
* a GdbBasicCliConsole.
*/
private class GdbConsoleCreator {
private GdbLaunch fLaunch;
private DsfSession fSession;
public GdbConsoleCreator(GdbLaunch launch) {
fLaunch = launch;
fSession = launch.getSession();
}
public void init() {
try {
fSession.getExecutor().submit(new DsfRunnable() {
@Override
public void run() {
// Look for backend service right away. It probably
// won't be available yet but we must make sure.
DsfServicesTracker tracker = new DsfServicesTracker(GdbUIPlugin.getBundleContext(), fSession.getId());
// Use the lowest level service name in case those are created but don't implement
// the most specialized classes IGDBControl or IGDBBackend.
ICommandControlService control = tracker.getService(ICommandControlService.class);
IMIBackend backend = tracker.getService(IMIBackend.class);
tracker.dispose();
// If we use the old console we not only need the backend service but
// also the control service. For simplicity, always wait for both.
if (backend != null && control != null) {
// Backend and Control services already available, we can start!
verifyAndCreateCliConsole();
} else {
// Backend service or Control service not available yet, let's wait for them to start.
new GdbServiceStartedListener(GdbConsoleCreator.this, fSession);
}
}
});
} catch (RejectedExecutionException e) {
}
}
@ConfinedToDsfExecutor("fSession.getExecutor()")
private void verifyAndCreateCliConsole() {
String gdbVersion;
try {
gdbVersion = fLaunch.getGDBVersion();
} catch (CoreException e) {
gdbVersion = "???"; //$NON-NLS-1$
assert false : "Should not happen since the gdb version is cached"; //$NON-NLS-1$
}
String consoleTitle = fLaunch.getGDBPath().toOSString().trim() + " (" + gdbVersion +")"; //$NON-NLS-1$ //$NON-NLS-2$
DsfServicesTracker tracker = new DsfServicesTracker(GdbUIPlugin.getBundleContext(), fSession.getId());
IGDBControl control = tracker.getService(IGDBControl.class);
IGDBBackend backend = tracker.getService(IGDBBackend.class);
tracker.dispose();
IDebuggerConsole console;
if (backend != null && backend.isFullGdbConsoleSupported()) {
// Create a full GDB cli console
console = new GdbFullCliConsole(fLaunch, consoleTitle, backend.getProcess(), backend.getProcessPty());
} else if (control != null) {
// Create a simple text console for the cli.
console = new GdbBasicCliConsole(fLaunch, consoleTitle, control.getGDBBackendProcess());
} else {
// Something is wrong. Don't create a console
assert false;
return;
}
addConsole(console);
// Make sure the Debugger Console view is visible but do not force it to the top
getDebuggerConsoleManager().openConsoleView();
}
}
/**
* Class used to listen for started events for the services we need.
* This class must be public to receive the event.
*/
public class GdbServiceStartedListener {
private DsfSession fSession;
private GdbConsoleCreator fCreator;
public GdbServiceStartedListener(GdbConsoleCreator creator, DsfSession session) {
fCreator = creator;
fSession = session;
fSession.addServiceEventListener(this, null);
}
@DsfServiceEventHandler
public final void eventDispatched(ICommandControlInitializedDMEvent event) {
// With the commandControl service started, we know the backend service
// is also started. So we are good to go.
fCreator.verifyAndCreateCliConsole();
// No longer need to receive events.
fSession.removeServiceEventListener(this);
}
}
}
|
