Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: c225ec40891e0ae1e58d365427f6493b08b02e39 (plain) (blame)
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/*******************************************************************************
 * Copyright (c) 2010, 2016 Mentor Graphics Corporation 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
 * 
 * Contributors:
 * Anna Dushistova (Mentor Graphics) - initial API and implementation
 * Anna Dushistova (Mentor Graphics) - moved to org.eclipse.cdt.launch.remote.launching
 * Anna Dushistova (MontaVista)      - [318051][remote debug] Terminating when "Remote shell" process is selected doesn't work
 * Anna Dushistova (MontaVista)      - [368597][remote debug] if gdbserver fails to launch on target, launch doesn't get terminated
 *******************************************************************************/
package org.eclipse.cdt.launch.remote.launching;

import java.util.concurrent.RejectedExecutionException;

import org.eclipse.cdt.debug.core.ICDTLaunchConfigurationConstants;
import org.eclipse.cdt.dsf.concurrent.DsfRunnable;
import org.eclipse.cdt.dsf.concurrent.ImmediateRequestMonitor;
import org.eclipse.cdt.dsf.gdb.IGDBLaunchConfigurationConstants;
import org.eclipse.cdt.dsf.gdb.launching.GdbLaunch;
import org.eclipse.cdt.dsf.gdb.launching.GdbLaunchDelegate;
import org.eclipse.cdt.dsf.gdb.service.command.IGDBControl;
import org.eclipse.cdt.dsf.service.DsfServicesTracker;
import org.eclipse.cdt.dsf.service.DsfSession;
import org.eclipse.cdt.internal.launch.remote.Activator;
import org.eclipse.cdt.internal.launch.remote.Messages;
import org.eclipse.cdt.launch.remote.IRemoteConnectionConfigurationConstants;
import org.eclipse.cdt.launch.remote.RSEHelper;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.core.variables.VariablesPlugin;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.rse.core.RSECorePlugin;
import org.eclipse.rse.services.shells.HostShellProcessAdapter;
import org.eclipse.rse.services.shells.IHostOutput;
import org.eclipse.rse.services.shells.IHostShell;
import org.eclipse.rse.services.shells.IHostShellChangeEvent;
import org.eclipse.rse.services.shells.IHostShellOutputListener;

public class RemoteGdbLaunchDelegate extends GdbLaunchDelegate {
	
	@Override
	public void launch(ILaunchConfiguration config, String mode,
			ILaunch launch, IProgressMonitor monitor) throws CoreException {
		// Need to initialize RSE
		if (!RSECorePlugin.isInitComplete(RSECorePlugin.INIT_MODEL)) {
			monitor.subTask(Messages.RemoteRunLaunchDelegate_10);
			try {
				RSECorePlugin.waitForInitCompletion(RSECorePlugin.INIT_MODEL);
			} catch (InterruptedException e) {
				throw new CoreException(new Status(IStatus.ERROR,
						getPluginID(), IStatus.OK, e.getLocalizedMessage(), e));
			}
		}

		IPath exePath = checkBinaryDetails(config);
		Process remoteShellProcess = null;
		if (exePath != null) {
			// 1.Download binary if needed
			String remoteExePath = config.getAttribute(
					IRemoteConnectionConfigurationConstants.ATTR_REMOTE_PATH,
					""); //$NON-NLS-1$
			monitor.setTaskName(Messages.RemoteRunLaunchDelegate_2);
			RSEHelper.remoteFileDownload(config, launch, exePath.toString(),
					remoteExePath, new SubProgressMonitor(monitor, 80));
			// 2.Launch gdbserver on target
			String gdbserverPortNumber = config
					.getAttribute(
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_PORT,
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_PORT_DEFAULT);
			String gdbserverCommand = config
					.getAttribute(
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_COMMAND,
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_COMMAND_DEFAULT);
			String gdbserverOptions = config
					.getAttribute(
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_OPTIONS,
							IRemoteConnectionConfigurationConstants.ATTR_GDBSERVER_OPTIONS_DEFAULT);
			String commandArguments = gdbserverOptions + " " //$NON-NLS-1$
					+ ":" + gdbserverPortNumber + " " //$NON-NLS-1$ //$NON-NLS-2$
					+ RSEHelper.spaceEscapify(remoteExePath);
			String arguments = getProgramArguments(config);
			String prelaunchCmd = config
					.getAttribute(
							IRemoteConnectionConfigurationConstants.ATTR_PRERUN_COMMANDS,
							""); //$NON-NLS-1$

			if (arguments != null && !arguments.equals("")) //$NON-NLS-1$
				commandArguments += " " + arguments; //$NON-NLS-1$
			monitor.setTaskName(Messages.RemoteRunLaunchDelegate_9);
			
			// extending HostShellProcessAdapter here
	        final GdbLaunch l = (GdbLaunch)launch;
			IHostShell remoteShell = null;
			try {
				remoteShell = RSEHelper.execCmdInRemoteShell(config, prelaunchCmd,
						gdbserverCommand, commandArguments,
						new SubProgressMonitor(monitor, 5));
			} catch (Exception e1) {
				RSEHelper.abort(e1.getMessage(), e1,
						ICDTLaunchConfigurationConstants.ERR_INTERNAL_ERROR);

			}
			
			// We cannot use a global variable because multiple launches
			// could access them at the same time.  We need a different
			// variable for each launch, but we also need it be final.
			// Use a final array to do that.
			final boolean gdbServerReady[] = new boolean[1];
			gdbServerReady[0] = false;
			
			final Object lock = new Object();
			if (remoteShell != null) {
				remoteShell.addOutputListener(new IHostShellOutputListener() {

					public void shellOutputChanged(IHostShellChangeEvent event) {
						for (IHostOutput line : event.getLines()) {
							if (line.getString().contains("Listening on port")) { //$NON-NLS-1$
								synchronized (lock) {
									gdbServerReady[0] = true;
									lock.notifyAll();
								}
								break;
							}
						}
					}
				});

				try {
					remoteShellProcess = new HostShellProcessAdapter(remoteShell) {

						@Override
						public synchronized void destroy() {
							final DsfSession session = l.getSession();
							if (session != null) {
								try {
									session.getExecutor().execute(new DsfRunnable() {
										public void run() {
											DsfServicesTracker tracker = new DsfServicesTracker(
													Activator.getBundleContext(),
													session.getId());
											IGDBControl control = tracker
													.getService(IGDBControl.class);
											if (control != null) {
												control.terminate(new ImmediateRequestMonitor());
											}
											tracker.dispose();
										}
									});
								} catch (RejectedExecutionException e) {
									// Session disposed.
								}
							}
							super.destroy();
						}
					};
				} catch (Exception e) {
					if (remoteShellProcess != null) {
						remoteShellProcess.destroy();
					}
					RSEHelper.abort(Messages.RemoteRunLaunchDelegate_7, e,
							ICDTLaunchConfigurationConstants.ERR_INTERNAL_ERROR);
				}

				IProcess iProcess = DebugPlugin.newProcess(launch, remoteShellProcess,
						Messages.RemoteRunLaunchDelegate_RemoteShell);

				// Now wait until gdbserver is up and running on the remote host
				synchronized (lock) {
					while (gdbServerReady[0] == false) {
						if (monitor.isCanceled() || iProcess.isTerminated()) {
							//gdbserver launch failed
							if (remoteShellProcess != null) {
								remoteShellProcess.destroy();
							}

							// Need to shutdown the DSF launch session because it is
							// partially started already.
							try {
								l.getSession().getExecutor().execute(new DsfRunnable() {
									public void run() {
				                        l.shutdownSession(new ImmediateRequestMonitor());
									}
								});
							} catch (RejectedExecutionException e) {
								// Session disposed.
							}

							RSEHelper.abort(Messages.RemoteGdbLaunchDelegate_gdbserverFailedToStartErrorMessage, null,
									ICDTLaunchConfigurationConstants.ERR_DEBUGGER_NOT_INSTALLED);
						}
						try {
							lock.wait(300);
						} catch (InterruptedException e) {
						}
					}
				}

				// 3. Let debugger know how gdbserver was started on the remote
				ILaunchConfigurationWorkingCopy wc = config.getWorkingCopy();
				wc.setAttribute(IGDBLaunchConfigurationConstants.ATTR_REMOTE_TCP,
						true);
				wc.setAttribute(IGDBLaunchConfigurationConstants.ATTR_HOST,
						RSEHelper.getRemoteHostname(config));
				wc.setAttribute(IGDBLaunchConfigurationConstants.ATTR_PORT,
						gdbserverPortNumber);
				wc.doSave();

			}
			try{
				super.launch(config, mode, launch, monitor);
			} catch(CoreException ex) {
				//launch failed, need to kill gdbserver
				if (remoteShellProcess != null) {
					remoteShellProcess.destroy();
				}

				//report failure further	
				throw ex;
			} finally {
				monitor.done();
			}
		}
	}

	protected String getProgramArguments(ILaunchConfiguration config)
			throws CoreException {
		String args = config.getAttribute(
				ICDTLaunchConfigurationConstants.ATTR_PROGRAM_ARGUMENTS,
				(String) null);
		if (args != null) {
			args = VariablesPlugin.getDefault().getStringVariableManager()
					.performStringSubstitution(args);
		}
		return args;
	}

	@Override
	protected String getPluginID() {
		return Activator.PLUGIN_ID;
	}
}

Back to the top