1 //===-- ProcessLaunchInfo.cpp -----------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/Host/Config.h"
12 #include "lldb/Core/Debugger.h"
13 #include "lldb/Core/Log.h"
14 #include "lldb/Target/ProcessLaunchInfo.h"
15 #include "lldb/Target/FileAction.h"
16 #include "lldb/Target/Target.h"
19 using namespace lldb_private;
21 //----------------------------------------------------------------------------
22 // ProcessLaunchInfo member functions
23 //----------------------------------------------------------------------------
25 ProcessLaunchInfo::ProcessLaunchInfo () :
31 m_pty (new lldb_utility::PseudoTerminal),
33 m_monitor_callback (NULL),
34 m_monitor_callback_baton (NULL),
35 m_monitor_signals (false),
37 m_hijack_listener_sp ()
41 ProcessLaunchInfo::ProcessLaunchInfo(const char *stdin_path, const char *stdout_path, const char *stderr_path,
42 const char *working_directory, uint32_t launch_flags) :
46 m_flags(launch_flags),
48 m_pty(new lldb_utility::PseudoTerminal),
50 m_monitor_callback(NULL),
51 m_monitor_callback_baton(NULL),
52 m_monitor_signals(false),
54 m_hijack_listener_sp()
58 FileAction file_action;
59 const bool read = true;
60 const bool write = false;
61 if (file_action.Open(STDIN_FILENO, stdin_path, read, write))
62 AppendFileAction (file_action);
66 FileAction file_action;
67 const bool read = false;
68 const bool write = true;
69 if (file_action.Open(STDOUT_FILENO, stdout_path, read, write))
70 AppendFileAction (file_action);
74 FileAction file_action;
75 const bool read = false;
76 const bool write = true;
77 if (file_action.Open(STDERR_FILENO, stderr_path, read, write))
78 AppendFileAction (file_action);
80 if (working_directory)
81 SetWorkingDirectory(working_directory);
85 ProcessLaunchInfo::AppendCloseFileAction (int fd)
87 FileAction file_action;
88 if (file_action.Close (fd))
90 AppendFileAction (file_action);
97 ProcessLaunchInfo::AppendDuplicateFileAction (int fd, int dup_fd)
99 FileAction file_action;
100 if (file_action.Duplicate (fd, dup_fd))
102 AppendFileAction (file_action);
109 ProcessLaunchInfo::AppendOpenFileAction (int fd, const char *path, bool read, bool write)
111 FileAction file_action;
112 if (file_action.Open (fd, path, read, write))
114 AppendFileAction (file_action);
121 ProcessLaunchInfo::AppendSuppressFileAction (int fd, bool read, bool write)
123 FileAction file_action;
124 if (file_action.Open (fd, "/dev/null", read, write))
126 AppendFileAction (file_action);
133 ProcessLaunchInfo::GetFileActionAtIndex(size_t idx) const
135 if (idx < m_file_actions.size())
136 return &m_file_actions[idx];
141 ProcessLaunchInfo::GetFileActionForFD(int fd) const
143 for (size_t idx=0, count=m_file_actions.size(); idx < count; ++idx)
145 if (m_file_actions[idx].GetFD () == fd)
146 return &m_file_actions[idx];
152 ProcessLaunchInfo::GetWorkingDirectory () const
154 if (m_working_dir.empty())
156 return m_working_dir.c_str();
160 ProcessLaunchInfo::SetWorkingDirectory (const char *working_dir)
162 if (working_dir && working_dir[0])
163 m_working_dir.assign (working_dir);
165 m_working_dir.clear();
169 ProcessLaunchInfo::GetProcessPluginName () const
171 if (m_plugin_name.empty())
173 return m_plugin_name.c_str();
177 ProcessLaunchInfo::SetProcessPluginName (const char *plugin)
179 if (plugin && plugin[0])
180 m_plugin_name.assign (plugin);
182 m_plugin_name.clear();
186 ProcessLaunchInfo::GetShell () const
192 ProcessLaunchInfo::SetShell (const FileSpec &shell)
197 m_shell.ResolveExecutableLocation();
198 m_flags.Set (lldb::eLaunchFlagLaunchInShell);
201 m_flags.Clear (lldb::eLaunchFlagLaunchInShell);
205 ProcessLaunchInfo::SetLaunchInSeparateProcessGroup (bool separate)
208 m_flags.Set(lldb::eLaunchFlagLaunchInSeparateProcessGroup);
210 m_flags.Clear (lldb::eLaunchFlagLaunchInSeparateProcessGroup);
215 ProcessLaunchInfo::Clear ()
217 ProcessInfo::Clear();
218 m_working_dir.clear();
219 m_plugin_name.clear();
222 m_file_actions.clear();
224 m_listener_sp.reset();
225 m_hijack_listener_sp.reset();
229 ProcessLaunchInfo::SetMonitorProcessCallback (Host::MonitorChildProcessCallback callback,
231 bool monitor_signals)
233 m_monitor_callback = callback;
234 m_monitor_callback_baton = baton;
235 m_monitor_signals = monitor_signals;
239 ProcessLaunchInfo::MonitorProcess () const
241 if (m_monitor_callback && ProcessIDIsValid())
243 Host::StartMonitoringChildProcess (m_monitor_callback,
244 m_monitor_callback_baton,
253 ProcessLaunchInfo::SetDetachOnError (bool enable)
256 m_flags.Set(lldb::eLaunchFlagDetachOnError);
258 m_flags.Clear(lldb::eLaunchFlagDetachOnError);
262 ProcessLaunchInfo::FinalizeFileActions (Target *target, bool default_to_use_pty)
264 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
266 // If nothing for stdin or stdout or stderr was specified, then check the process for any default
267 // settings that were set with "settings set"
268 if (GetFileActionForFD(STDIN_FILENO) == NULL ||
269 GetFileActionForFD(STDOUT_FILENO) == NULL ||
270 GetFileActionForFD(STDERR_FILENO) == NULL)
273 log->Printf ("ProcessLaunchInfo::%s at least one of stdin/stdout/stderr was not set, evaluating default handling",
276 if (m_flags.Test(eLaunchFlagDisableSTDIO))
279 log->Printf ("ProcessLaunchInfo::%s eLaunchFlagDisableSTDIO set, adding suppression action for stdin, stdout and stderr",
281 AppendSuppressFileAction (STDIN_FILENO , true, false);
282 AppendSuppressFileAction (STDOUT_FILENO, false, true);
283 AppendSuppressFileAction (STDERR_FILENO, false, true);
287 // Check for any values that might have gotten set with any of:
288 // (lldb) settings set target.input-path
289 // (lldb) settings set target.output-path
290 // (lldb) settings set target.error-path
296 // Only override with the target settings if we don't already have
297 // an action for in, out or error
298 if (GetFileActionForFD(STDIN_FILENO) == NULL)
299 in_path = target->GetStandardInputPath();
300 if (GetFileActionForFD(STDOUT_FILENO) == NULL)
301 out_path = target->GetStandardOutputPath();
302 if (GetFileActionForFD(STDERR_FILENO) == NULL)
303 err_path = target->GetStandardErrorPath();
307 log->Printf ("ProcessLaunchInfo::%s target stdin='%s', target stdout='%s', stderr='%s'",
309 in_path ? in_path.GetPath().c_str () : "<null>",
310 out_path ? out_path.GetPath().c_str () : "<null>",
311 err_path ? err_path.GetPath().c_str () : "<null>");
314 if (in_path && in_path.GetPath(path, sizeof(path)))
316 AppendOpenFileAction(STDIN_FILENO, path, true, false);
318 log->Printf ("ProcessLaunchInfo::%s appended stdin open file action for %s",
320 in_path.GetPath().c_str ());
323 if (out_path && out_path.GetPath(path, sizeof(path)))
325 AppendOpenFileAction(STDOUT_FILENO, path, false, true);
327 log->Printf ("ProcessLaunchInfo::%s appended stdout open file action for %s",
329 out_path.GetPath().c_str ());
332 if (err_path && err_path.GetPath(path, sizeof(path)))
335 log->Printf ("ProcessLaunchInfo::%s appended stderr open file action for %s",
337 err_path.GetPath().c_str ());
338 AppendOpenFileAction(STDERR_FILENO, path, false, true);
341 if (default_to_use_pty && (!in_path || !out_path || !err_path))
344 log->Printf ("ProcessLaunchInfo::%s default_to_use_pty is set, and at least one stdin/stderr/stdout is unset, so generating a pty to use for it",
347 if (m_pty->OpenFirstAvailableMaster(O_RDWR| O_NOCTTY, NULL, 0))
349 const char *slave_path = m_pty->GetSlaveName(NULL, 0);
351 // Only use the slave tty if we don't have anything specified for
352 // input and don't have an action for stdin
353 if (!in_path && GetFileActionForFD(STDIN_FILENO) == NULL)
355 AppendOpenFileAction(STDIN_FILENO, slave_path, true, false);
358 // Only use the slave tty if we don't have anything specified for
359 // output and don't have an action for stdout
360 if (!out_path && GetFileActionForFD(STDOUT_FILENO) == NULL)
362 AppendOpenFileAction(STDOUT_FILENO, slave_path, false, true);
365 // Only use the slave tty if we don't have anything specified for
366 // error and don't have an action for stderr
367 if (!err_path && GetFileActionForFD(STDERR_FILENO) == NULL)
369 AppendOpenFileAction(STDERR_FILENO, slave_path, false, true);
379 ProcessLaunchInfo::ConvertArgumentsForLaunchingInShell (Error &error,
382 bool first_arg_is_full_shell_command,
387 if (GetFlags().Test (eLaunchFlagLaunchInShell))
391 std::string shell_executable = m_shell.GetPath();
393 const char **argv = GetArguments().GetConstArgumentVector ();
394 if (argv == NULL || argv[0] == NULL)
396 Args shell_arguments;
397 std::string safe_arg;
398 shell_arguments.AppendArgument (shell_executable.c_str());
399 const llvm::Triple &triple = GetArchitecture().GetTriple();
400 if (triple.getOS() == llvm::Triple::Win32 && !triple.isWindowsCygwinEnvironment())
401 shell_arguments.AppendArgument("/C");
403 shell_arguments.AppendArgument("-c");
405 StreamString shell_command;
408 // Add a modified PATH environment variable in case argv[0]
409 // is a relative path.
410 const char *argv0 = argv[0];
411 FileSpec arg_spec(argv0, false);
412 if (arg_spec.IsRelativeToCurrentWorkingDirectory())
414 // We have a relative path to our executable which may not work if
415 // we just try to run "a.out" (without it being converted to "./a.out")
416 const char *working_dir = GetWorkingDirectory();
417 // Be sure to put quotes around PATH's value in case any paths have spaces...
418 std::string new_path("PATH=\"");
419 const size_t empty_path_len = new_path.size();
421 if (working_dir && working_dir[0])
423 new_path += working_dir;
427 char current_working_dir[PATH_MAX];
428 const char *cwd = getcwd(current_working_dir, sizeof(current_working_dir));
432 const char *curr_path = getenv("PATH");
435 if (new_path.size() > empty_path_len)
437 new_path += curr_path;
440 shell_command.PutCString(new_path.c_str());
443 if (triple.getOS() != llvm::Triple::Win32 || triple.isWindowsCygwinEnvironment())
444 shell_command.PutCString("exec");
446 // Only Apple supports /usr/bin/arch being able to specify the architecture
447 if (GetArchitecture().IsValid() && // Valid architecture
448 GetArchitecture().GetTriple().getVendor() == llvm::Triple::Apple && // Apple only
449 GetArchitecture().GetCore() != ArchSpec::eCore_x86_64_x86_64h) // Don't do this for x86_64h
451 shell_command.Printf(" /usr/bin/arch -arch %s", GetArchitecture().GetArchitectureName());
452 // Set the resume count to 2:
454 // 2 - stop in /usr/bin/arch
455 // 3 - then we will stop in our program
456 SetResumeCount(num_resumes + 1);
460 // Set the resume count to 1:
462 // 2 - then we will stop in our program
463 SetResumeCount(num_resumes);
467 if (first_arg_is_full_shell_command)
469 // There should only be one argument that is the shell command itself to be used as is
470 if (argv[0] && !argv[1])
471 shell_command.Printf("%s", argv[0]);
477 for (size_t i=0; argv[i] != NULL; ++i)
479 const char *arg = Args::GetShellSafeArgument (argv[i], safe_arg);
480 shell_command.Printf(" %s", arg);
483 shell_arguments.AppendArgument (shell_command.GetString().c_str());
484 m_executable = m_shell;
485 m_arguments = shell_arguments;
490 error.SetErrorString ("invalid shell path");
495 error.SetErrorString ("not launching in shell");
501 ProcessLaunchInfo::GetListenerForProcess (Debugger &debugger)
504 return *m_listener_sp;
506 return debugger.GetListener();