blob: 9a7e2c65a49fcc4f2d8001795e859965f2a461e0 [file] [log] [blame]
Chris Lattner24943d22010-06-08 16:52:24 +00001//===-- Process.cpp ---------------------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "lldb/Target/Process.h"
11
12#include "lldb/lldb-private-log.h"
13
14#include "lldb/Breakpoint/StoppointCallbackContext.h"
15#include "lldb/Breakpoint/BreakpointLocation.h"
16#include "lldb/Core/Event.h"
Caroline Tice861efb32010-11-16 05:07:41 +000017#include "lldb/Core/ConnectionFileDescriptor.h"
Chris Lattner24943d22010-06-08 16:52:24 +000018#include "lldb/Core/Debugger.h"
Caroline Tice861efb32010-11-16 05:07:41 +000019#include "lldb/Core/InputReader.h"
Chris Lattner24943d22010-06-08 16:52:24 +000020#include "lldb/Core/Log.h"
21#include "lldb/Core/PluginManager.h"
22#include "lldb/Core/State.h"
Greg Claytonf15996e2011-04-07 22:46:35 +000023#include "lldb/Expression/ClangUserExpression.h"
Caroline Tice6e4c5ce2010-09-04 00:03:46 +000024#include "lldb/Interpreter/CommandInterpreter.h"
Chris Lattner24943d22010-06-08 16:52:24 +000025#include "lldb/Host/Host.h"
26#include "lldb/Target/ABI.h"
Greg Clayton0baa3942010-11-04 01:54:29 +000027#include "lldb/Target/DynamicLoader.h"
Jim Ingham642036f2010-09-23 02:01:19 +000028#include "lldb/Target/LanguageRuntime.h"
29#include "lldb/Target/CPPLanguageRuntime.h"
30#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone4b9c1f2011-03-08 22:40:15 +000031#include "lldb/Target/Platform.h"
Chris Lattner24943d22010-06-08 16:52:24 +000032#include "lldb/Target/RegisterContext.h"
Greg Clayton643ee732010-08-04 01:40:35 +000033#include "lldb/Target/StopInfo.h"
Chris Lattner24943d22010-06-08 16:52:24 +000034#include "lldb/Target/Target.h"
35#include "lldb/Target/TargetList.h"
36#include "lldb/Target/Thread.h"
37#include "lldb/Target/ThreadPlan.h"
38
39using namespace lldb;
40using namespace lldb_private;
41
Greg Clayton24bc5d92011-03-30 18:16:51 +000042void
Greg Claytonb72d0f02011-04-12 05:54:46 +000043ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton24bc5d92011-03-30 18:16:51 +000044{
45 const char *cstr;
Greg Claytonff39f742011-04-01 00:29:43 +000046 if (m_pid != LLDB_INVALID_PROCESS_ID)
47 s.Printf (" pid = %i\n", m_pid);
48
49 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
50 s.Printf (" parent = %i\n", m_parent_pid);
51
52 if (m_executable)
53 {
54 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
55 s.PutCString (" file = ");
56 m_executable.Dump(&s);
57 s.EOL();
58 }
Greg Claytonb72d0f02011-04-12 05:54:46 +000059 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +000060 if (argc > 0)
61 {
62 for (uint32_t i=0; i<argc; i++)
63 {
Greg Claytonb72d0f02011-04-12 05:54:46 +000064 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Claytonff39f742011-04-01 00:29:43 +000065 if (i < 10)
Greg Claytonb72d0f02011-04-12 05:54:46 +000066 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +000067 else
Greg Claytonb72d0f02011-04-12 05:54:46 +000068 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +000069 }
70 }
Greg Claytonb72d0f02011-04-12 05:54:46 +000071
72 const uint32_t envc = m_environment.GetArgumentCount();
73 if (envc > 0)
74 {
75 for (uint32_t i=0; i<envc; i++)
76 {
77 const char *env = m_environment.GetArgumentAtIndex(i);
78 if (i < 10)
79 s.Printf (" env[%u] = %s\n", i, env);
80 else
81 s.Printf ("env[%u] = %s\n", i, env);
82 }
83 }
84
Greg Claytonff39f742011-04-01 00:29:43 +000085 if (m_arch.IsValid())
86 s.Printf (" arch = %s\n", m_arch.GetTriple().str().c_str());
87
Greg Claytonb72d0f02011-04-12 05:54:46 +000088 if (m_uid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +000089 {
Greg Claytonb72d0f02011-04-12 05:54:46 +000090 cstr = platform->GetUserName (m_uid);
91 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +000092 }
Greg Claytonb72d0f02011-04-12 05:54:46 +000093 if (m_gid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +000094 {
Greg Claytonb72d0f02011-04-12 05:54:46 +000095 cstr = platform->GetGroupName (m_gid);
96 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +000097 }
Greg Claytonb72d0f02011-04-12 05:54:46 +000098 if (m_euid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +000099 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000100 cstr = platform->GetUserName (m_euid);
101 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000102 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000103 if (m_egid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000104 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000105 cstr = platform->GetGroupName (m_egid);
106 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000107 }
108}
109
110void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000111ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000112{
Greg Claytonb72d0f02011-04-12 05:54:46 +0000113 const char *label;
114 if (show_args || verbose)
115 label = "ARGUMENTS";
116 else
117 label = "NAME";
118
Greg Claytonff39f742011-04-01 00:29:43 +0000119 if (verbose)
120 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000121 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000122 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
123 }
124 else
125 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000126 s.Printf ("PID PARENT USER ARCH %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000127 s.PutCString ("====== ====== ========== ======= ============================\n");
128 }
Greg Clayton24bc5d92011-03-30 18:16:51 +0000129}
130
131void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000132ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000133{
134 if (m_pid != LLDB_INVALID_PROCESS_ID)
135 {
136 const char *cstr;
137 s.Printf ("%-6u %-6u ", m_pid, m_parent_pid);
138
Greg Clayton24bc5d92011-03-30 18:16:51 +0000139
Greg Claytonff39f742011-04-01 00:29:43 +0000140 if (verbose)
141 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000142 cstr = platform->GetUserName (m_uid);
Greg Claytonff39f742011-04-01 00:29:43 +0000143 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
144 s.Printf ("%-10s ", cstr);
145 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000146 s.Printf ("%-10u ", m_uid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000147
Greg Claytonb72d0f02011-04-12 05:54:46 +0000148 cstr = platform->GetGroupName (m_gid);
Greg Claytonff39f742011-04-01 00:29:43 +0000149 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
150 s.Printf ("%-10s ", cstr);
151 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000152 s.Printf ("%-10u ", m_gid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000153
Greg Claytonb72d0f02011-04-12 05:54:46 +0000154 cstr = platform->GetUserName (m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000155 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
156 s.Printf ("%-10s ", cstr);
157 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000158 s.Printf ("%-10u ", m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000159
Greg Claytonb72d0f02011-04-12 05:54:46 +0000160 cstr = platform->GetGroupName (m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000161 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
162 s.Printf ("%-10s ", cstr);
163 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000164 s.Printf ("%-10u ", m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000165 s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
166 }
167 else
168 {
169 s.Printf ("%-10s %.*-7s ",
Greg Claytonb72d0f02011-04-12 05:54:46 +0000170 platform->GetUserName (m_euid),
Greg Claytonff39f742011-04-01 00:29:43 +0000171 (int)m_arch.GetTriple().getArchName().size(),
172 m_arch.GetTriple().getArchName().data());
173 }
174
Greg Claytonb72d0f02011-04-12 05:54:46 +0000175 if (verbose || show_args)
Greg Claytonff39f742011-04-01 00:29:43 +0000176 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000177 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +0000178 if (argc > 0)
179 {
180 for (uint32_t i=0; i<argc; i++)
181 {
182 if (i > 0)
183 s.PutChar (' ');
Greg Claytonb72d0f02011-04-12 05:54:46 +0000184 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Claytonff39f742011-04-01 00:29:43 +0000185 }
186 }
187 }
188 else
189 {
190 s.PutCString (GetName());
191 }
192
193 s.EOL();
Greg Clayton24bc5d92011-03-30 18:16:51 +0000194 }
195}
196
Greg Claytonb72d0f02011-04-12 05:54:46 +0000197
198void
199ProcessInfo::SetArgumentsFromArgs (const Args& args,
200 bool first_arg_is_executable,
201 bool first_arg_is_executable_and_argument)
202{
203 // Copy all arguments
204 m_arguments = args;
205
206 // Is the first argument the executable?
207 if (first_arg_is_executable)
208 {
209 const char *first_arg = args.GetArgumentAtIndex (0);
210 if (first_arg)
211 {
212 // Yes the first argument is an executable, set it as the executable
213 // in the launch options. Don't resolve the file path as the path
214 // could be a remote platform path
215 const bool resolve = false;
216 m_executable.SetFile(first_arg, resolve);
217
218 // If argument zero is an executable and shouldn't be included
219 // in the arguments, remove it from the front of the arguments
220 if (first_arg_is_executable_and_argument == false)
221 m_arguments.DeleteArgumentAtIndex (0);
222 }
223 }
224}
225
Greg Clayton24bc5d92011-03-30 18:16:51 +0000226bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000227ProcessLaunchInfo::FileAction::Open (int fd, const char *path, bool read, bool write)
228{
229 if ((read || write) && fd >= 0 && path && path[0])
230 {
231 m_action = eFileActionOpen;
232 m_fd = fd;
233 if (read && write)
234 m_arg = O_RDWR;
235 else if (read)
236 m_arg = O_RDONLY;
237 else
238 m_arg = O_WRONLY;
239 m_path.assign (path);
240 return true;
241 }
242 else
243 {
244 Clear();
245 }
246 return false;
247}
248
249bool
250ProcessLaunchInfo::FileAction::Close (int fd)
251{
252 Clear();
253 if (fd >= 0)
254 {
255 m_action = eFileActionClose;
256 m_fd = fd;
257 }
258 return m_fd >= 0;
259}
260
261
262bool
263ProcessLaunchInfo::FileAction::Duplicate (int fd, int dup_fd)
264{
265 Clear();
266 if (fd >= 0 && dup_fd >= 0)
267 {
268 m_action = eFileActionDuplicate;
269 m_fd = fd;
270 m_arg = dup_fd;
271 }
272 return m_fd >= 0;
273}
274
275
276
277bool
278ProcessLaunchInfo::FileAction::AddPosixSpawnFileAction (posix_spawn_file_actions_t *file_actions,
279 const FileAction *info,
280 Log *log,
281 Error& error)
282{
283 if (info == NULL)
284 return false;
285
286 switch (info->m_action)
287 {
288 case eFileActionNone:
289 error.Clear();
290 break;
291
292 case eFileActionClose:
293 if (info->m_fd == -1)
294 error.SetErrorString ("invalid fd for posix_spawn_file_actions_addclose(...)");
295 else
296 {
297 error.SetError (::posix_spawn_file_actions_addclose (file_actions, info->m_fd),
298 eErrorTypePOSIX);
299 if (log && (error.Fail() || log))
300 error.PutToLog(log, "posix_spawn_file_actions_addclose (action=%p, fd=%i)",
301 file_actions, info->m_fd);
302 }
303 break;
304
305 case eFileActionDuplicate:
306 if (info->m_fd == -1)
307 error.SetErrorString ("invalid fd for posix_spawn_file_actions_adddup2(...)");
308 else if (info->m_arg == -1)
309 error.SetErrorString ("invalid duplicate fd for posix_spawn_file_actions_adddup2(...)");
310 else
311 {
312 error.SetError (::posix_spawn_file_actions_adddup2 (file_actions, info->m_fd, info->m_arg),
313 eErrorTypePOSIX);
314 if (log && (error.Fail() || log))
315 error.PutToLog(log, "posix_spawn_file_actions_adddup2 (action=%p, fd=%i, dup_fd=%i)",
316 file_actions, info->m_fd, info->m_arg);
317 }
318 break;
319
320 case eFileActionOpen:
321 if (info->m_fd == -1)
322 error.SetErrorString ("invalid fd in posix_spawn_file_actions_addopen(...)");
323 else
324 {
325 int oflag = info->m_arg;
326 mode_t mode = 0;
327
328 error.SetError (::posix_spawn_file_actions_addopen (file_actions,
329 info->m_fd,
330 info->m_path.c_str(),
331 oflag,
332 mode),
333 eErrorTypePOSIX);
334 if (error.Fail() || log)
335 error.PutToLog(log,
336 "posix_spawn_file_actions_addopen (action=%p, fd=%i, path='%s', oflag=%i, mode=%i)",
337 file_actions, info->m_fd, info->m_path.c_str(), oflag, mode);
338 }
339 break;
340
341 default:
342 error.SetErrorStringWithFormat ("invalid file action: %i", info->m_action);
343 break;
344 }
345 return error.Success();
346}
347
348Error
Greg Clayton143fcc32011-04-13 00:18:08 +0000349ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000350{
351 Error error;
352 char short_option = (char) m_getopt_table[option_idx].val;
353
354 switch (short_option)
355 {
356 case 's': // Stop at program entry point
357 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
358 break;
359
360 case 'e': // STDERR for read + write
361 {
362 ProcessLaunchInfo::FileAction action;
363 if (action.Open(STDERR_FILENO, option_arg, true, true))
364 launch_info.AppendFileAction (action);
365 }
366 break;
367
368 case 'i': // STDIN for read only
369 {
370 ProcessLaunchInfo::FileAction action;
371 if (action.Open(STDIN_FILENO, option_arg, true, false))
372 launch_info.AppendFileAction (action);
373 }
374 break;
375
376 case 'o': // Open STDOUT for write only
377 {
378 ProcessLaunchInfo::FileAction action;
379 if (action.Open(STDOUT_FILENO, option_arg, false, true))
380 launch_info.AppendFileAction (action);
381 }
382 break;
383
384 case 'p': // Process plug-in name
385 launch_info.SetProcessPluginName (option_arg);
386 break;
387
388 case 'n': // Disable STDIO
389 {
390 ProcessLaunchInfo::FileAction action;
391 if (action.Open(STDERR_FILENO, "/dev/null", true, true))
392 launch_info.AppendFileAction (action);
393 if (action.Open(STDOUT_FILENO, "/dev/null", false, true))
394 launch_info.AppendFileAction (action);
395 if (action.Open(STDIN_FILENO, "/dev/null", true, false))
396 launch_info.AppendFileAction (action);
397 }
398 break;
399
400 case 'w':
401 launch_info.SetWorkingDirectory (option_arg);
402 break;
403
404 case 't': // Open process in new terminal window
405 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
406 break;
407
408 case 'a':
409 launch_info.GetArchitecture().SetTriple (option_arg,
410 m_interpreter.GetPlatform(true).get());
411 break;
412
413 case 'A':
414 launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
415 break;
416
417 case 'v':
418 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
419 break;
420
421 default:
422 error.SetErrorStringWithFormat("Invalid short option character '%c'.\n", short_option);
423 break;
424
425 }
426 return error;
427}
428
429OptionDefinition
430ProcessLaunchCommandOptions::g_option_table[] =
431{
432{ LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', no_argument, NULL, 0, eArgTypeNone, "Stop at the entry point of the program when launching a process."},
433{ LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', no_argument, NULL, 0, eArgTypeNone, "Disable address space layout randomization when launching a process."},
434{ LLDB_OPT_SET_ALL, false, "plugin", 'p', required_argument, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
435{ LLDB_OPT_SET_ALL, false, "working-dir", 'w', required_argument, NULL, 0, eArgTypePath, "Set the current working directory to <path> when running the inferior."},
436{ LLDB_OPT_SET_ALL, false, "arch", 'a', required_argument, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
437{ LLDB_OPT_SET_ALL, false, "environment", 'v', required_argument, NULL, 0, eArgTypeNone, "Specify an environment variable name/value stirng (--environement NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
438
439{ LLDB_OPT_SET_1 , false, "stdin", 'i', required_argument, NULL, 0, eArgTypePath, "Redirect stdin for the process to <path>."},
440{ LLDB_OPT_SET_1 , false, "stdout", 'o', required_argument, NULL, 0, eArgTypePath, "Redirect stdout for the process to <path>."},
441{ LLDB_OPT_SET_1 , false, "stderr", 'e', required_argument, NULL, 0, eArgTypePath, "Redirect stderr for the process to <path>."},
442
443{ LLDB_OPT_SET_2 , false, "tty", 't', no_argument, NULL, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)."},
444
445{ LLDB_OPT_SET_3 , false, "no-stdio", 'n', no_argument, NULL, 0, eArgTypeNone, "Do not set up for terminal I/O to go to running process."},
446
447{ 0 , false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
448};
449
450
451
452bool
453ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000454{
455 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
456 return true;
457 const char *match_name = m_match_info.GetName();
458 if (!match_name)
459 return true;
460
461 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
462}
463
464bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000465ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000466{
467 if (!NameMatches (proc_info.GetName()))
468 return false;
469
470 if (m_match_info.ProcessIDIsValid() &&
471 m_match_info.GetProcessID() != proc_info.GetProcessID())
472 return false;
473
474 if (m_match_info.ParentProcessIDIsValid() &&
475 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
476 return false;
477
Greg Claytonb72d0f02011-04-12 05:54:46 +0000478 if (m_match_info.UserIDIsValid () &&
479 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000480 return false;
481
Greg Claytonb72d0f02011-04-12 05:54:46 +0000482 if (m_match_info.GroupIDIsValid () &&
483 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000484 return false;
485
486 if (m_match_info.EffectiveUserIDIsValid () &&
487 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
488 return false;
489
490 if (m_match_info.EffectiveGroupIDIsValid () &&
491 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
492 return false;
493
494 if (m_match_info.GetArchitecture().IsValid() &&
495 m_match_info.GetArchitecture() != proc_info.GetArchitecture())
496 return false;
497 return true;
498}
499
500bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000501ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000502{
503 if (m_name_match_type != eNameMatchIgnore)
504 return false;
505
506 if (m_match_info.ProcessIDIsValid())
507 return false;
508
509 if (m_match_info.ParentProcessIDIsValid())
510 return false;
511
Greg Claytonb72d0f02011-04-12 05:54:46 +0000512 if (m_match_info.UserIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000513 return false;
514
Greg Claytonb72d0f02011-04-12 05:54:46 +0000515 if (m_match_info.GroupIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000516 return false;
517
518 if (m_match_info.EffectiveUserIDIsValid ())
519 return false;
520
521 if (m_match_info.EffectiveGroupIDIsValid ())
522 return false;
523
524 if (m_match_info.GetArchitecture().IsValid())
525 return false;
526
527 if (m_match_all_users)
528 return false;
529
530 return true;
531
532}
533
534void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000535ProcessInstanceInfoMatch::Clear()
Greg Clayton24bc5d92011-03-30 18:16:51 +0000536{
537 m_match_info.Clear();
538 m_name_match_type = eNameMatchIgnore;
539 m_match_all_users = false;
540}
Greg Claytonfd119992011-01-07 06:08:19 +0000541
Chris Lattner24943d22010-06-08 16:52:24 +0000542Process*
543Process::FindPlugin (Target &target, const char *plugin_name, Listener &listener)
544{
545 ProcessCreateInstance create_callback = NULL;
546 if (plugin_name)
547 {
548 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (plugin_name);
549 if (create_callback)
550 {
551 std::auto_ptr<Process> debugger_ap(create_callback(target, listener));
552 if (debugger_ap->CanDebug(target))
553 return debugger_ap.release();
554 }
555 }
556 else
557 {
Greg Clayton54e7afa2010-07-09 20:39:50 +0000558 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner24943d22010-06-08 16:52:24 +0000559 {
Greg Clayton54e7afa2010-07-09 20:39:50 +0000560 std::auto_ptr<Process> debugger_ap(create_callback(target, listener));
561 if (debugger_ap->CanDebug(target))
562 return debugger_ap.release();
Chris Lattner24943d22010-06-08 16:52:24 +0000563 }
564 }
565 return NULL;
566}
567
568
569//----------------------------------------------------------------------
570// Process constructor
571//----------------------------------------------------------------------
572Process::Process(Target &target, Listener &listener) :
573 UserID (LLDB_INVALID_PROCESS_ID),
Greg Clayton49ce6822010-10-31 03:01:06 +0000574 Broadcaster ("lldb.process"),
Greg Claytonc0c1b0c2010-11-19 03:46:01 +0000575 ProcessInstanceSettings (*GetSettingsController()),
Chris Lattner24943d22010-06-08 16:52:24 +0000576 m_target (target),
Chris Lattner24943d22010-06-08 16:52:24 +0000577 m_public_state (eStateUnloaded),
578 m_private_state (eStateUnloaded),
579 m_private_state_broadcaster ("lldb.process.internal_state_broadcaster"),
580 m_private_state_control_broadcaster ("lldb.process.internal_state_control_broadcaster"),
581 m_private_state_listener ("lldb.process.internal_state_listener"),
582 m_private_state_control_wait(),
583 m_private_state_thread (LLDB_INVALID_HOST_THREAD),
584 m_stop_id (0),
585 m_thread_index_id (0),
586 m_exit_status (-1),
587 m_exit_string (),
588 m_thread_list (this),
589 m_notifications (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000590 m_image_tokens (),
591 m_listener (listener),
592 m_breakpoint_site_list (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000593 m_dynamic_checkers_ap (),
Caroline Tice861efb32010-11-16 05:07:41 +0000594 m_unix_signals (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000595 m_abi_sp (),
Caroline Tice861efb32010-11-16 05:07:41 +0000596 m_process_input_reader (),
Greg Claytona875b642011-01-09 21:07:35 +0000597 m_stdio_communication ("process.stdio"),
Greg Clayton20d338f2010-11-18 05:57:03 +0000598 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Greg Claytonfd119992011-01-07 06:08:19 +0000599 m_stdout_data (),
Greg Clayton613b8732011-05-17 03:37:42 +0000600 m_memory_cache (*this),
601 m_allocated_memory_cache (*this),
Greg Clayton7e2f91c2011-01-29 07:10:55 +0000602 m_next_event_action_ap()
Chris Lattner24943d22010-06-08 16:52:24 +0000603{
Caroline Tice1ebef442010-09-27 00:30:10 +0000604 UpdateInstanceName();
605
Greg Claytone005f2c2010-11-06 01:53:30 +0000606 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +0000607 if (log)
608 log->Printf ("%p Process::Process()", this);
609
Greg Clayton49ce6822010-10-31 03:01:06 +0000610 SetEventName (eBroadcastBitStateChanged, "state-changed");
611 SetEventName (eBroadcastBitInterrupt, "interrupt");
612 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
613 SetEventName (eBroadcastBitSTDERR, "stderr-available");
614
Chris Lattner24943d22010-06-08 16:52:24 +0000615 listener.StartListeningForEvents (this,
616 eBroadcastBitStateChanged |
617 eBroadcastBitInterrupt |
618 eBroadcastBitSTDOUT |
619 eBroadcastBitSTDERR);
620
621 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
622 eBroadcastBitStateChanged);
623
624 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
625 eBroadcastInternalStateControlStop |
626 eBroadcastInternalStateControlPause |
627 eBroadcastInternalStateControlResume);
628}
629
630//----------------------------------------------------------------------
631// Destructor
632//----------------------------------------------------------------------
633Process::~Process()
634{
Greg Claytone005f2c2010-11-06 01:53:30 +0000635 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +0000636 if (log)
637 log->Printf ("%p Process::~Process()", this);
638 StopPrivateStateThread();
639}
640
641void
642Process::Finalize()
643{
644 // Do any cleanup needed prior to being destructed... Subclasses
645 // that override this method should call this superclass method as well.
Jim Ingham88fa7bd2011-02-16 17:54:55 +0000646
647 // We need to destroy the loader before the derived Process class gets destroyed
648 // since it is very likely that undoing the loader will require access to the real process.
649 if (m_dyld_ap.get() != NULL)
650 m_dyld_ap.reset();
Chris Lattner24943d22010-06-08 16:52:24 +0000651}
652
653void
654Process::RegisterNotificationCallbacks (const Notifications& callbacks)
655{
656 m_notifications.push_back(callbacks);
657 if (callbacks.initialize != NULL)
658 callbacks.initialize (callbacks.baton, this);
659}
660
661bool
662Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
663{
664 std::vector<Notifications>::iterator pos, end = m_notifications.end();
665 for (pos = m_notifications.begin(); pos != end; ++pos)
666 {
667 if (pos->baton == callbacks.baton &&
668 pos->initialize == callbacks.initialize &&
669 pos->process_state_changed == callbacks.process_state_changed)
670 {
671 m_notifications.erase(pos);
672 return true;
673 }
674 }
675 return false;
676}
677
678void
679Process::SynchronouslyNotifyStateChanged (StateType state)
680{
681 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
682 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
683 {
684 if (notification_pos->process_state_changed)
685 notification_pos->process_state_changed (notification_pos->baton, this, state);
686 }
687}
688
689// FIXME: We need to do some work on events before the general Listener sees them.
690// For instance if we are continuing from a breakpoint, we need to ensure that we do
691// the little "insert real insn, step & stop" trick. But we can't do that when the
692// event is delivered by the broadcaster - since that is done on the thread that is
693// waiting for new events, so if we needed more than one event for our handling, we would
694// stall. So instead we do it when we fetch the event off of the queue.
695//
696
697StateType
698Process::GetNextEvent (EventSP &event_sp)
699{
700 StateType state = eStateInvalid;
701
702 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
703 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
704
705 return state;
706}
707
708
709StateType
710Process::WaitForProcessToStop (const TimeValue *timeout)
711{
712 StateType match_states[] = { eStateStopped, eStateCrashed, eStateDetached, eStateExited, eStateUnloaded };
713 return WaitForState (timeout, match_states, sizeof(match_states) / sizeof(StateType));
714}
715
716
717StateType
718Process::WaitForState
719(
720 const TimeValue *timeout,
721 const StateType *match_states, const uint32_t num_match_states
722)
723{
724 EventSP event_sp;
725 uint32_t i;
Greg Claytond8c62532010-10-07 04:19:01 +0000726 StateType state = GetState();
Chris Lattner24943d22010-06-08 16:52:24 +0000727 while (state != eStateInvalid)
728 {
Greg Claytond8c62532010-10-07 04:19:01 +0000729 // If we are exited or detached, we won't ever get back to any
730 // other valid state...
731 if (state == eStateDetached || state == eStateExited)
732 return state;
733
Chris Lattner24943d22010-06-08 16:52:24 +0000734 state = WaitForStateChangedEvents (timeout, event_sp);
735
736 for (i=0; i<num_match_states; ++i)
737 {
738 if (match_states[i] == state)
739 return state;
740 }
741 }
742 return state;
743}
744
Jim Ingham63e24d72010-10-11 23:53:14 +0000745bool
746Process::HijackProcessEvents (Listener *listener)
747{
748 if (listener != NULL)
749 {
750 return HijackBroadcaster(listener, eBroadcastBitStateChanged);
751 }
752 else
753 return false;
754}
755
756void
757Process::RestoreProcessEvents ()
758{
759 RestoreBroadcaster();
760}
761
Jim Inghamf9f40c22011-02-08 05:20:59 +0000762bool
763Process::HijackPrivateProcessEvents (Listener *listener)
764{
765 if (listener != NULL)
766 {
767 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged);
768 }
769 else
770 return false;
771}
772
773void
774Process::RestorePrivateProcessEvents ()
775{
776 m_private_state_broadcaster.RestoreBroadcaster();
777}
778
Chris Lattner24943d22010-06-08 16:52:24 +0000779StateType
780Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp)
781{
Greg Claytone005f2c2010-11-06 01:53:30 +0000782 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +0000783
784 if (log)
785 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
786
787 StateType state = eStateInvalid;
Greg Clayton36f63a92010-10-19 03:25:40 +0000788 if (m_listener.WaitForEventForBroadcasterWithType (timeout,
789 this,
790 eBroadcastBitStateChanged,
791 event_sp))
Chris Lattner24943d22010-06-08 16:52:24 +0000792 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
793
794 if (log)
795 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
796 __FUNCTION__,
797 timeout,
798 StateAsCString(state));
799 return state;
800}
801
802Event *
803Process::PeekAtStateChangedEvents ()
804{
Greg Claytone005f2c2010-11-06 01:53:30 +0000805 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +0000806
807 if (log)
808 log->Printf ("Process::%s...", __FUNCTION__);
809
810 Event *event_ptr;
Greg Clayton36f63a92010-10-19 03:25:40 +0000811 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
812 eBroadcastBitStateChanged);
Chris Lattner24943d22010-06-08 16:52:24 +0000813 if (log)
814 {
815 if (event_ptr)
816 {
817 log->Printf ("Process::%s (event_ptr) => %s",
818 __FUNCTION__,
819 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
820 }
821 else
822 {
823 log->Printf ("Process::%s no events found",
824 __FUNCTION__);
825 }
826 }
827 return event_ptr;
828}
829
830StateType
831Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
832{
Greg Claytone005f2c2010-11-06 01:53:30 +0000833 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +0000834
835 if (log)
836 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
837
838 StateType state = eStateInvalid;
Greg Clayton72e1c782011-01-22 23:43:18 +0000839 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
840 &m_private_state_broadcaster,
841 eBroadcastBitStateChanged,
842 event_sp))
Chris Lattner24943d22010-06-08 16:52:24 +0000843 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
844
845 // This is a bit of a hack, but when we wait here we could very well return
846 // to the command-line, and that could disable the log, which would render the
847 // log we got above invalid.
Chris Lattner24943d22010-06-08 16:52:24 +0000848 if (log)
Greg Clayton72e1c782011-01-22 23:43:18 +0000849 {
850 if (state == eStateInvalid)
851 log->Printf ("Process::%s (timeout = %p, event_sp) => TIMEOUT", __FUNCTION__, timeout);
852 else
853 log->Printf ("Process::%s (timeout = %p, event_sp) => %s", __FUNCTION__, timeout, StateAsCString(state));
854 }
Chris Lattner24943d22010-06-08 16:52:24 +0000855 return state;
856}
857
858bool
859Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
860{
Greg Claytone005f2c2010-11-06 01:53:30 +0000861 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +0000862
863 if (log)
864 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
865
866 if (control_only)
867 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
868 else
869 return m_private_state_listener.WaitForEvent(timeout, event_sp);
870}
871
872bool
873Process::IsRunning () const
874{
875 return StateIsRunningState (m_public_state.GetValue());
876}
877
878int
879Process::GetExitStatus ()
880{
881 if (m_public_state.GetValue() == eStateExited)
882 return m_exit_status;
883 return -1;
884}
885
Greg Clayton638351a2010-12-04 00:10:17 +0000886
887void
888Process::ProcessInstanceSettings::GetHostEnvironmentIfNeeded ()
889{
890 if (m_inherit_host_env && !m_got_host_env)
891 {
892 m_got_host_env = true;
893 StringList host_env;
894 const size_t host_env_count = Host::GetEnvironment (host_env);
895 for (size_t idx=0; idx<host_env_count; idx++)
896 {
897 const char *env_entry = host_env.GetStringAtIndex (idx);
898 if (env_entry)
899 {
Greg Clayton1f3dd642010-12-15 20:52:40 +0000900 const char *equal_pos = ::strchr(env_entry, '=');
Greg Clayton638351a2010-12-04 00:10:17 +0000901 if (equal_pos)
902 {
903 std::string key (env_entry, equal_pos - env_entry);
904 std::string value (equal_pos + 1);
905 if (m_env_vars.find (key) == m_env_vars.end())
906 m_env_vars[key] = value;
907 }
908 }
909 }
910 }
911}
912
913
914size_t
915Process::ProcessInstanceSettings::GetEnvironmentAsArgs (Args &env)
916{
917 GetHostEnvironmentIfNeeded ();
918
919 dictionary::const_iterator pos, end = m_env_vars.end();
920 for (pos = m_env_vars.begin(); pos != end; ++pos)
921 {
922 std::string env_var_equal_value (pos->first);
923 env_var_equal_value.append(1, '=');
924 env_var_equal_value.append (pos->second);
925 env.AppendArgument (env_var_equal_value.c_str());
926 }
927 return env.GetArgumentCount();
928}
929
930
Chris Lattner24943d22010-06-08 16:52:24 +0000931const char *
932Process::GetExitDescription ()
933{
934 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
935 return m_exit_string.c_str();
936 return NULL;
937}
938
Greg Clayton72e1c782011-01-22 23:43:18 +0000939bool
Chris Lattner24943d22010-06-08 16:52:24 +0000940Process::SetExitStatus (int status, const char *cstr)
941{
Greg Clayton68ca8232011-01-25 02:58:48 +0000942 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
943 if (log)
944 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
945 status, status,
946 cstr ? "\"" : "",
947 cstr ? cstr : "NULL",
948 cstr ? "\"" : "");
949
Greg Clayton72e1c782011-01-22 23:43:18 +0000950 // We were already in the exited state
951 if (m_private_state.GetValue() == eStateExited)
Greg Clayton68ca8232011-01-25 02:58:48 +0000952 {
Greg Clayton644ddfb2011-01-26 23:47:29 +0000953 if (log)
954 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton72e1c782011-01-22 23:43:18 +0000955 return false;
Greg Clayton68ca8232011-01-25 02:58:48 +0000956 }
Greg Clayton72e1c782011-01-22 23:43:18 +0000957
958 m_exit_status = status;
959 if (cstr)
960 m_exit_string = cstr;
961 else
962 m_exit_string.clear();
Chris Lattner24943d22010-06-08 16:52:24 +0000963
Greg Clayton72e1c782011-01-22 23:43:18 +0000964 DidExit ();
Greg Clayton58e844b2010-12-08 05:08:21 +0000965
Greg Clayton72e1c782011-01-22 23:43:18 +0000966 SetPrivateState (eStateExited);
967 return true;
Chris Lattner24943d22010-06-08 16:52:24 +0000968}
969
970// This static callback can be used to watch for local child processes on
971// the current host. The the child process exits, the process will be
972// found in the global target list (we want to be completely sure that the
973// lldb_private::Process doesn't go away before we can deliver the signal.
974bool
975Process::SetProcessExitStatus
976(
977 void *callback_baton,
978 lldb::pid_t pid,
979 int signo, // Zero for no signal
980 int exit_status // Exit value of process if signal is zero
981)
982{
983 if (signo == 0 || exit_status)
984 {
Greg Clayton63094e02010-06-23 01:19:29 +0000985 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner24943d22010-06-08 16:52:24 +0000986 if (target_sp)
987 {
988 ProcessSP process_sp (target_sp->GetProcessSP());
989 if (process_sp)
990 {
991 const char *signal_cstr = NULL;
992 if (signo)
993 signal_cstr = process_sp->GetUnixSignals().GetSignalAsCString (signo);
994
995 process_sp->SetExitStatus (exit_status, signal_cstr);
996 }
997 }
998 return true;
999 }
1000 return false;
1001}
1002
1003
1004uint32_t
1005Process::GetNextThreadIndexID ()
1006{
1007 return ++m_thread_index_id;
1008}
1009
1010StateType
1011Process::GetState()
1012{
1013 // If any other threads access this we will need a mutex for it
1014 return m_public_state.GetValue ();
1015}
1016
1017void
1018Process::SetPublicState (StateType new_state)
1019{
Greg Clayton68ca8232011-01-25 02:58:48 +00001020 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001021 if (log)
1022 log->Printf("Process::SetPublicState (%s)", StateAsCString(new_state));
1023 m_public_state.SetValue (new_state);
1024}
1025
1026StateType
1027Process::GetPrivateState ()
1028{
1029 return m_private_state.GetValue();
1030}
1031
1032void
1033Process::SetPrivateState (StateType new_state)
1034{
Greg Clayton68ca8232011-01-25 02:58:48 +00001035 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001036 bool state_changed = false;
1037
1038 if (log)
1039 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1040
1041 Mutex::Locker locker(m_private_state.GetMutex());
1042
1043 const StateType old_state = m_private_state.GetValueNoLock ();
1044 state_changed = old_state != new_state;
1045 if (state_changed)
1046 {
1047 m_private_state.SetValueNoLock (new_state);
1048 if (StateIsStoppedState(new_state))
1049 {
1050 m_stop_id++;
Greg Claytonfd119992011-01-07 06:08:19 +00001051 m_memory_cache.Clear();
Chris Lattner24943d22010-06-08 16:52:24 +00001052 if (log)
1053 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_stop_id);
1054 }
1055 // Use our target to get a shared pointer to ourselves...
1056 m_private_state_broadcaster.BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (GetTarget().GetProcessSP(), new_state));
1057 }
1058 else
1059 {
1060 if (log)
1061 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state), StateAsCString(old_state));
1062 }
1063}
1064
1065
1066uint32_t
1067Process::GetStopID() const
1068{
1069 return m_stop_id;
1070}
1071
1072addr_t
1073Process::GetImageInfoAddress()
1074{
1075 return LLDB_INVALID_ADDRESS;
1076}
1077
Greg Clayton0baa3942010-11-04 01:54:29 +00001078//----------------------------------------------------------------------
1079// LoadImage
1080//
1081// This function provides a default implementation that works for most
1082// unix variants. Any Process subclasses that need to do shared library
1083// loading differently should override LoadImage and UnloadImage and
1084// do what is needed.
1085//----------------------------------------------------------------------
1086uint32_t
1087Process::LoadImage (const FileSpec &image_spec, Error &error)
1088{
1089 DynamicLoader *loader = GetDynamicLoader();
1090 if (loader)
1091 {
1092 error = loader->CanLoadImage();
1093 if (error.Fail())
1094 return LLDB_INVALID_IMAGE_TOKEN;
1095 }
1096
1097 if (error.Success())
1098 {
1099 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
1100 if (thread_sp == NULL)
1101 thread_sp = GetThreadList ().GetThreadAtIndex(0, true);
1102
1103 if (thread_sp)
1104 {
1105 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1106
1107 if (frame_sp)
1108 {
1109 ExecutionContext exe_ctx;
1110 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamea9d4262010-11-05 19:25:48 +00001111 bool unwind_on_error = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001112 StreamString expr;
1113 char path[PATH_MAX];
1114 image_spec.GetPath(path, sizeof(path));
1115 expr.Printf("dlopen (\"%s\", 2)", path);
1116 const char *prefix = "extern \"C\" void* dlopen (const char *path, int mode);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001117 lldb::ValueObjectSP result_valobj_sp;
Sean Callanan696cf5f2011-05-07 01:06:41 +00001118 ClangUserExpression::Evaluate (exe_ctx, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
Greg Clayton0baa3942010-11-04 01:54:29 +00001119 if (result_valobj_sp->GetError().Success())
1120 {
1121 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001122 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001123 {
1124 addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1125 if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1126 {
1127 uint32_t image_token = m_image_tokens.size();
1128 m_image_tokens.push_back (image_ptr);
1129 return image_token;
1130 }
1131 }
1132 }
1133 }
1134 }
1135 }
1136 return LLDB_INVALID_IMAGE_TOKEN;
1137}
1138
1139//----------------------------------------------------------------------
1140// UnloadImage
1141//
1142// This function provides a default implementation that works for most
1143// unix variants. Any Process subclasses that need to do shared library
1144// loading differently should override LoadImage and UnloadImage and
1145// do what is needed.
1146//----------------------------------------------------------------------
1147Error
1148Process::UnloadImage (uint32_t image_token)
1149{
1150 Error error;
1151 if (image_token < m_image_tokens.size())
1152 {
1153 const addr_t image_addr = m_image_tokens[image_token];
1154 if (image_addr == LLDB_INVALID_ADDRESS)
1155 {
1156 error.SetErrorString("image already unloaded");
1157 }
1158 else
1159 {
1160 DynamicLoader *loader = GetDynamicLoader();
1161 if (loader)
1162 error = loader->CanLoadImage();
1163
1164 if (error.Success())
1165 {
1166 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
1167 if (thread_sp == NULL)
1168 thread_sp = GetThreadList ().GetThreadAtIndex(0, true);
1169
1170 if (thread_sp)
1171 {
1172 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1173
1174 if (frame_sp)
1175 {
1176 ExecutionContext exe_ctx;
1177 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamea9d4262010-11-05 19:25:48 +00001178 bool unwind_on_error = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001179 StreamString expr;
1180 expr.Printf("dlclose ((void *)0x%llx)", image_addr);
1181 const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001182 lldb::ValueObjectSP result_valobj_sp;
Sean Callanan696cf5f2011-05-07 01:06:41 +00001183 ClangUserExpression::Evaluate (exe_ctx, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
Greg Clayton0baa3942010-11-04 01:54:29 +00001184 if (result_valobj_sp->GetError().Success())
1185 {
1186 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001187 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001188 {
1189 if (scalar.UInt(1))
1190 {
1191 error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
1192 }
1193 else
1194 {
1195 m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
1196 }
1197 }
1198 }
1199 else
1200 {
1201 error = result_valobj_sp->GetError();
1202 }
1203 }
1204 }
1205 }
1206 }
1207 }
1208 else
1209 {
1210 error.SetErrorString("invalid image token");
1211 }
1212 return error;
1213}
1214
Greg Clayton75906e42011-05-11 18:39:18 +00001215const lldb::ABISP &
Chris Lattner24943d22010-06-08 16:52:24 +00001216Process::GetABI()
1217{
Greg Clayton75906e42011-05-11 18:39:18 +00001218 if (!m_abi_sp)
1219 m_abi_sp = ABI::FindPlugin(m_target.GetArchitecture());
1220 return m_abi_sp;
Chris Lattner24943d22010-06-08 16:52:24 +00001221}
1222
Jim Ingham642036f2010-09-23 02:01:19 +00001223LanguageRuntime *
1224Process::GetLanguageRuntime(lldb::LanguageType language)
1225{
1226 LanguageRuntimeCollection::iterator pos;
1227 pos = m_language_runtimes.find (language);
1228 if (pos == m_language_runtimes.end())
1229 {
1230 lldb::LanguageRuntimeSP runtime(LanguageRuntime::FindPlugin(this, language));
1231
1232 m_language_runtimes[language]
1233 = runtime;
1234 return runtime.get();
1235 }
1236 else
1237 return (*pos).second.get();
1238}
1239
1240CPPLanguageRuntime *
1241Process::GetCPPLanguageRuntime ()
1242{
1243 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus);
1244 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1245 return static_cast<CPPLanguageRuntime *> (runtime);
1246 return NULL;
1247}
1248
1249ObjCLanguageRuntime *
1250Process::GetObjCLanguageRuntime ()
1251{
1252 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC);
1253 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1254 return static_cast<ObjCLanguageRuntime *> (runtime);
1255 return NULL;
1256}
1257
Chris Lattner24943d22010-06-08 16:52:24 +00001258BreakpointSiteList &
1259Process::GetBreakpointSiteList()
1260{
1261 return m_breakpoint_site_list;
1262}
1263
1264const BreakpointSiteList &
1265Process::GetBreakpointSiteList() const
1266{
1267 return m_breakpoint_site_list;
1268}
1269
1270
1271void
1272Process::DisableAllBreakpointSites ()
1273{
1274 m_breakpoint_site_list.SetEnabledForAll (false);
1275}
1276
1277Error
1278Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1279{
1280 Error error (DisableBreakpointSiteByID (break_id));
1281
1282 if (error.Success())
1283 m_breakpoint_site_list.Remove(break_id);
1284
1285 return error;
1286}
1287
1288Error
1289Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1290{
1291 Error error;
1292 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1293 if (bp_site_sp)
1294 {
1295 if (bp_site_sp->IsEnabled())
1296 error = DisableBreakpoint (bp_site_sp.get());
1297 }
1298 else
1299 {
1300 error.SetErrorStringWithFormat("invalid breakpoint site ID: %i", break_id);
1301 }
1302
1303 return error;
1304}
1305
1306Error
1307Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1308{
1309 Error error;
1310 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1311 if (bp_site_sp)
1312 {
1313 if (!bp_site_sp->IsEnabled())
1314 error = EnableBreakpoint (bp_site_sp.get());
1315 }
1316 else
1317 {
1318 error.SetErrorStringWithFormat("invalid breakpoint site ID: %i", break_id);
1319 }
1320 return error;
1321}
1322
Stephen Wilson3fd1f362010-07-17 00:56:13 +00001323lldb::break_id_t
Chris Lattner24943d22010-06-08 16:52:24 +00001324Process::CreateBreakpointSite (BreakpointLocationSP &owner, bool use_hardware)
1325{
Greg Clayton265ab332011-05-19 18:17:41 +00001326 const addr_t load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
Chris Lattner24943d22010-06-08 16:52:24 +00001327 if (load_addr != LLDB_INVALID_ADDRESS)
1328 {
1329 BreakpointSiteSP bp_site_sp;
1330
1331 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
1332 // create a new breakpoint site and add it.
1333
1334 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
1335
1336 if (bp_site_sp)
1337 {
1338 bp_site_sp->AddOwner (owner);
1339 owner->SetBreakpointSite (bp_site_sp);
1340 return bp_site_sp->GetID();
1341 }
1342 else
1343 {
1344 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, LLDB_INVALID_THREAD_ID, use_hardware));
1345 if (bp_site_sp)
1346 {
1347 if (EnableBreakpoint (bp_site_sp.get()).Success())
1348 {
1349 owner->SetBreakpointSite (bp_site_sp);
1350 return m_breakpoint_site_list.Add (bp_site_sp);
1351 }
1352 }
1353 }
1354 }
1355 // We failed to enable the breakpoint
1356 return LLDB_INVALID_BREAK_ID;
1357
1358}
1359
1360void
1361Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
1362{
1363 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
1364 if (num_owners == 0)
1365 {
1366 DisableBreakpoint(bp_site_sp.get());
1367 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
1368 }
1369}
1370
1371
1372size_t
1373Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
1374{
1375 size_t bytes_removed = 0;
1376 addr_t intersect_addr;
1377 size_t intersect_size;
1378 size_t opcode_offset;
1379 size_t idx;
1380 BreakpointSiteSP bp;
1381
1382 for (idx = 0; (bp = m_breakpoint_site_list.GetByIndex(idx)) != NULL; ++idx)
1383 {
1384 if (bp->GetType() == BreakpointSite::eSoftware)
1385 {
1386 if (bp->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
1387 {
1388 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
1389 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
1390 assert(opcode_offset + intersect_size <= bp->GetByteSize());
1391 size_t buf_offset = intersect_addr - bp_addr;
1392 ::memcpy(buf + buf_offset, bp->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
1393 }
1394 }
1395 }
1396 return bytes_removed;
1397}
1398
1399
Greg Claytonb1888f22011-03-19 01:12:21 +00001400
1401size_t
1402Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
1403{
1404 PlatformSP platform_sp (m_target.GetPlatform());
1405 if (platform_sp)
1406 return platform_sp->GetSoftwareBreakpointTrapOpcode (m_target, bp_site);
1407 return 0;
1408}
1409
Chris Lattner24943d22010-06-08 16:52:24 +00001410Error
1411Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
1412{
1413 Error error;
1414 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00001415 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00001416 const addr_t bp_addr = bp_site->GetLoadAddress();
1417 if (log)
1418 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx", bp_site->GetID(), (uint64_t)bp_addr);
1419 if (bp_site->IsEnabled())
1420 {
1421 if (log)
1422 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
1423 return error;
1424 }
1425
1426 if (bp_addr == LLDB_INVALID_ADDRESS)
1427 {
1428 error.SetErrorString("BreakpointSite contains an invalid load address.");
1429 return error;
1430 }
1431 // Ask the lldb::Process subclass to fill in the correct software breakpoint
1432 // trap for the breakpoint site
1433 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
1434
1435 if (bp_opcode_size == 0)
1436 {
1437 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%llx.\n", bp_addr);
1438 }
1439 else
1440 {
1441 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
1442
1443 if (bp_opcode_bytes == NULL)
1444 {
1445 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
1446 return error;
1447 }
1448
1449 // Save the original opcode by reading it
1450 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
1451 {
1452 // Write a software breakpoint in place of the original opcode
1453 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1454 {
1455 uint8_t verify_bp_opcode_bytes[64];
1456 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1457 {
1458 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
1459 {
1460 bp_site->SetEnabled(true);
1461 bp_site->SetType (BreakpointSite::eSoftware);
1462 if (log)
1463 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS",
1464 bp_site->GetID(),
1465 (uint64_t)bp_addr);
1466 }
1467 else
1468 error.SetErrorString("Failed to verify the breakpoint trap in memory.");
1469 }
1470 else
1471 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
1472 }
1473 else
1474 error.SetErrorString("Unable to write breakpoint trap to memory.");
1475 }
1476 else
1477 error.SetErrorString("Unable to read memory at breakpoint address.");
1478 }
Stephen Wilsonc2b98252011-01-12 04:20:03 +00001479 if (log && error.Fail())
Chris Lattner24943d22010-06-08 16:52:24 +00001480 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
1481 bp_site->GetID(),
1482 (uint64_t)bp_addr,
1483 error.AsCString());
1484 return error;
1485}
1486
1487Error
1488Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
1489{
1490 Error error;
1491 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00001492 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00001493 addr_t bp_addr = bp_site->GetLoadAddress();
1494 lldb::user_id_t breakID = bp_site->GetID();
1495 if (log)
Stephen Wilson9ff73ed2011-01-14 21:07:07 +00001496 log->Printf ("Process::DisableBreakpoint (breakID = %d) addr = 0x%llx", breakID, (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00001497
1498 if (bp_site->IsHardware())
1499 {
1500 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
1501 }
1502 else if (bp_site->IsEnabled())
1503 {
1504 const size_t break_op_size = bp_site->GetByteSize();
1505 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
1506 if (break_op_size > 0)
1507 {
1508 // Clear a software breakoint instruction
Greg Clayton54e7afa2010-07-09 20:39:50 +00001509 uint8_t curr_break_op[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00001510 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner24943d22010-06-08 16:52:24 +00001511 bool break_op_found = false;
1512
1513 // Read the breakpoint opcode
1514 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
1515 {
1516 bool verify = false;
1517 // Make sure we have the a breakpoint opcode exists at this address
1518 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
1519 {
1520 break_op_found = true;
1521 // We found a valid breakpoint opcode at this address, now restore
1522 // the saved opcode.
1523 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
1524 {
1525 verify = true;
1526 }
1527 else
1528 error.SetErrorString("Memory write failed when restoring original opcode.");
1529 }
1530 else
1531 {
1532 error.SetErrorString("Original breakpoint trap is no longer in memory.");
1533 // Set verify to true and so we can check if the original opcode has already been restored
1534 verify = true;
1535 }
1536
1537 if (verify)
1538 {
Greg Clayton54e7afa2010-07-09 20:39:50 +00001539 uint8_t verify_opcode[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00001540 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner24943d22010-06-08 16:52:24 +00001541 // Verify that our original opcode made it back to the inferior
1542 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
1543 {
1544 // compare the memory we just read with the original opcode
1545 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
1546 {
1547 // SUCCESS
1548 bp_site->SetEnabled(false);
1549 if (log)
1550 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
1551 return error;
1552 }
1553 else
1554 {
1555 if (break_op_found)
1556 error.SetErrorString("Failed to restore original opcode.");
1557 }
1558 }
1559 else
1560 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
1561 }
1562 }
1563 else
1564 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
1565 }
1566 }
1567 else
1568 {
1569 if (log)
1570 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
1571 return error;
1572 }
1573
1574 if (log)
1575 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
1576 bp_site->GetID(),
1577 (uint64_t)bp_addr,
1578 error.AsCString());
1579 return error;
1580
1581}
1582
Greg Claytonfd119992011-01-07 06:08:19 +00001583// Comment out line below to disable memory caching
1584#define ENABLE_MEMORY_CACHING
1585// Uncomment to verify memory caching works after making changes to caching code
1586//#define VERIFY_MEMORY_READS
1587
1588#if defined (ENABLE_MEMORY_CACHING)
1589
1590#if defined (VERIFY_MEMORY_READS)
Chris Lattner24943d22010-06-08 16:52:24 +00001591
1592size_t
1593Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
1594{
Greg Claytonfd119992011-01-07 06:08:19 +00001595 // Memory caching is enabled, with debug verification
1596 if (buf && size)
1597 {
1598 // Uncomment the line below to make sure memory caching is working.
1599 // I ran this through the test suite and got no assertions, so I am
1600 // pretty confident this is working well. If any changes are made to
1601 // memory caching, uncomment the line below and test your changes!
1602
1603 // Verify all memory reads by using the cache first, then redundantly
1604 // reading the same memory from the inferior and comparing to make sure
1605 // everything is exactly the same.
1606 std::string verify_buf (size, '\0');
1607 assert (verify_buf.size() == size);
1608 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
1609 Error verify_error;
1610 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
1611 assert (cache_bytes_read == verify_bytes_read);
1612 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
1613 assert (verify_error.Success() == error.Success());
1614 return cache_bytes_read;
1615 }
1616 return 0;
1617}
1618
1619#else // #if defined (VERIFY_MEMORY_READS)
1620
1621size_t
1622Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
1623{
1624 // Memory caching enabled, no verification
Greg Clayton613b8732011-05-17 03:37:42 +00001625 return m_memory_cache.Read (addr, buf, size, error);
Greg Claytonfd119992011-01-07 06:08:19 +00001626}
1627
1628#endif // #else for #if defined (VERIFY_MEMORY_READS)
1629
1630#else // #if defined (ENABLE_MEMORY_CACHING)
1631
1632size_t
1633Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
1634{
1635 // Memory caching is disabled
1636 return ReadMemoryFromInferior (addr, buf, size, error);
1637}
1638
1639#endif // #else for #if defined (ENABLE_MEMORY_CACHING)
1640
1641
1642size_t
Greg Claytonb72d0f02011-04-12 05:54:46 +00001643Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len)
1644{
1645 size_t total_cstr_len = 0;
1646 if (dst && dst_max_len)
1647 {
1648 // NULL out everything just to be safe
1649 memset (dst, 0, dst_max_len);
1650 Error error;
1651 addr_t curr_addr = addr;
1652 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
1653 size_t bytes_left = dst_max_len - 1;
1654 char *curr_dst = dst;
1655
1656 while (bytes_left > 0)
1657 {
1658 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
1659 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
1660 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
1661
1662 if (bytes_read == 0)
1663 {
1664 dst[total_cstr_len] = '\0';
1665 break;
1666 }
1667 const size_t len = strlen(curr_dst);
1668
1669 total_cstr_len += len;
1670
1671 if (len < bytes_to_read)
1672 break;
1673
1674 curr_dst += bytes_read;
1675 curr_addr += bytes_read;
1676 bytes_left -= bytes_read;
1677 }
1678 }
1679 return total_cstr_len;
1680}
1681
1682size_t
Greg Claytonfd119992011-01-07 06:08:19 +00001683Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
1684{
Chris Lattner24943d22010-06-08 16:52:24 +00001685 if (buf == NULL || size == 0)
1686 return 0;
1687
1688 size_t bytes_read = 0;
1689 uint8_t *bytes = (uint8_t *)buf;
1690
1691 while (bytes_read < size)
1692 {
1693 const size_t curr_size = size - bytes_read;
1694 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
1695 bytes + bytes_read,
1696 curr_size,
1697 error);
1698 bytes_read += curr_bytes_read;
1699 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
1700 break;
1701 }
1702
1703 // Replace any software breakpoint opcodes that fall into this range back
1704 // into "buf" before we return
1705 if (bytes_read > 0)
1706 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
1707 return bytes_read;
1708}
1709
Greg Claytonf72fdee2010-12-16 20:01:20 +00001710uint64_t
1711Process::ReadUnsignedInteger (lldb::addr_t vm_addr, size_t integer_byte_size, Error &error)
1712{
1713 if (integer_byte_size > sizeof(uint64_t))
1714 {
1715 error.SetErrorString ("unsupported integer size");
1716 }
1717 else
1718 {
1719 uint8_t tmp[sizeof(uint64_t)];
Greg Clayton395fc332011-02-15 21:59:32 +00001720 DataExtractor data (tmp,
1721 integer_byte_size,
1722 m_target.GetArchitecture().GetByteOrder(),
1723 m_target.GetArchitecture().GetAddressByteSize());
Greg Claytonf72fdee2010-12-16 20:01:20 +00001724 if (ReadMemory (vm_addr, tmp, integer_byte_size, error) == integer_byte_size)
1725 {
1726 uint32_t offset = 0;
1727 return data.GetMaxU64 (&offset, integer_byte_size);
1728 }
1729 }
1730 // Any plug-in that doesn't return success a memory read with the number
1731 // of bytes that were requested should be setting the error
1732 assert (error.Fail());
1733 return 0;
1734}
1735
Chris Lattner24943d22010-06-08 16:52:24 +00001736size_t
1737Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
1738{
1739 size_t bytes_written = 0;
1740 const uint8_t *bytes = (const uint8_t *)buf;
1741
1742 while (bytes_written < size)
1743 {
1744 const size_t curr_size = size - bytes_written;
1745 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
1746 bytes + bytes_written,
1747 curr_size,
1748 error);
1749 bytes_written += curr_bytes_written;
1750 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
1751 break;
1752 }
1753 return bytes_written;
1754}
1755
1756size_t
1757Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
1758{
Greg Claytonfd119992011-01-07 06:08:19 +00001759#if defined (ENABLE_MEMORY_CACHING)
1760 m_memory_cache.Flush (addr, size);
1761#endif
1762
Chris Lattner24943d22010-06-08 16:52:24 +00001763 if (buf == NULL || size == 0)
1764 return 0;
Jim Inghame41494a2011-04-16 00:01:13 +00001765
1766 // Need to bump the stop ID after writing so that ValueObjects will know to re-read themselves.
1767 // FUTURE: Doing this should be okay, but if anybody else gets upset about the stop_id changing when
1768 // the target hasn't run, then we will need to add a "memory generation" as well as a stop_id...
1769 m_stop_id++;
1770
Chris Lattner24943d22010-06-08 16:52:24 +00001771 // We need to write any data that would go where any current software traps
1772 // (enabled software breakpoints) any software traps (breakpoints) that we
1773 // may have placed in our tasks memory.
1774
1775 BreakpointSiteList::collection::const_iterator iter = m_breakpoint_site_list.GetMap()->lower_bound (addr);
1776 BreakpointSiteList::collection::const_iterator end = m_breakpoint_site_list.GetMap()->end();
1777
1778 if (iter == end || iter->second->GetLoadAddress() > addr + size)
Greg Claytonc8bc1c32011-05-16 02:35:02 +00001779 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner24943d22010-06-08 16:52:24 +00001780
1781 BreakpointSiteList::collection::const_iterator pos;
1782 size_t bytes_written = 0;
Greg Clayton54e7afa2010-07-09 20:39:50 +00001783 addr_t intersect_addr = 0;
1784 size_t intersect_size = 0;
1785 size_t opcode_offset = 0;
Chris Lattner24943d22010-06-08 16:52:24 +00001786 const uint8_t *ubuf = (const uint8_t *)buf;
1787
1788 for (pos = iter; pos != end; ++pos)
1789 {
1790 BreakpointSiteSP bp;
1791 bp = pos->second;
1792
1793 assert(bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset));
1794 assert(addr <= intersect_addr && intersect_addr < addr + size);
1795 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
1796 assert(opcode_offset + intersect_size <= bp->GetByteSize());
1797
1798 // Check for bytes before this breakpoint
1799 const addr_t curr_addr = addr + bytes_written;
1800 if (intersect_addr > curr_addr)
1801 {
1802 // There are some bytes before this breakpoint that we need to
1803 // just write to memory
1804 size_t curr_size = intersect_addr - curr_addr;
1805 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
1806 ubuf + bytes_written,
1807 curr_size,
1808 error);
1809 bytes_written += curr_bytes_written;
1810 if (curr_bytes_written != curr_size)
1811 {
1812 // We weren't able to write all of the requested bytes, we
1813 // are done looping and will return the number of bytes that
1814 // we have written so far.
1815 break;
1816 }
1817 }
1818
1819 // Now write any bytes that would cover up any software breakpoints
1820 // directly into the breakpoint opcode buffer
1821 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
1822 bytes_written += intersect_size;
1823 }
1824
1825 // Write any remaining bytes after the last breakpoint if we have any left
1826 if (bytes_written < size)
1827 bytes_written += WriteMemoryPrivate (addr + bytes_written,
1828 ubuf + bytes_written,
1829 size - bytes_written,
1830 error);
Jim Inghame41494a2011-04-16 00:01:13 +00001831
Chris Lattner24943d22010-06-08 16:52:24 +00001832 return bytes_written;
1833}
Greg Clayton613b8732011-05-17 03:37:42 +00001834#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner24943d22010-06-08 16:52:24 +00001835addr_t
1836Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
1837{
Greg Clayton613b8732011-05-17 03:37:42 +00001838#if defined (USE_ALLOCATE_MEMORY_CACHE)
1839 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
1840#else
Greg Clayton2860ba92011-01-23 19:58:49 +00001841 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
1842 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1843 if (log)
Greg Clayton613b8732011-05-17 03:37:42 +00001844 log->Printf("Process::AllocateMemory(size=%4zu, permissions=%s) => 0x%16.16llx (m_stop_id = %u)",
Greg Clayton2860ba92011-01-23 19:58:49 +00001845 size,
Greg Clayton613b8732011-05-17 03:37:42 +00001846 GetPermissionsAsCString (permissions),
Greg Clayton2860ba92011-01-23 19:58:49 +00001847 (uint64_t)allocated_addr,
1848 m_stop_id);
1849 return allocated_addr;
Greg Clayton613b8732011-05-17 03:37:42 +00001850#endif
Chris Lattner24943d22010-06-08 16:52:24 +00001851}
1852
1853Error
1854Process::DeallocateMemory (addr_t ptr)
1855{
Greg Clayton613b8732011-05-17 03:37:42 +00001856 Error error;
1857#if defined (USE_ALLOCATE_MEMORY_CACHE)
1858 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
1859 {
1860 error.SetErrorStringWithFormat ("deallocation of memory at 0x%llx failed.", (uint64_t)ptr);
1861 }
1862#else
1863 error = DoDeallocateMemory (ptr);
Greg Clayton2860ba92011-01-23 19:58:49 +00001864
1865 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1866 if (log)
1867 log->Printf("Process::DeallocateMemory(addr=0x%16.16llx) => err = %s (m_stop_id = %u)",
1868 ptr,
1869 error.AsCString("SUCCESS"),
1870 m_stop_id);
Greg Clayton613b8732011-05-17 03:37:42 +00001871#endif
Greg Clayton2860ba92011-01-23 19:58:49 +00001872 return error;
Chris Lattner24943d22010-06-08 16:52:24 +00001873}
1874
1875
1876Error
1877Process::EnableWatchpoint (WatchpointLocation *watchpoint)
1878{
1879 Error error;
1880 error.SetErrorString("watchpoints are not supported");
1881 return error;
1882}
1883
1884Error
1885Process::DisableWatchpoint (WatchpointLocation *watchpoint)
1886{
1887 Error error;
1888 error.SetErrorString("watchpoints are not supported");
1889 return error;
1890}
1891
1892StateType
1893Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
1894{
1895 StateType state;
1896 // Now wait for the process to launch and return control to us, and then
1897 // call DidLaunch:
1898 while (1)
1899 {
Greg Clayton72e1c782011-01-22 23:43:18 +00001900 event_sp.reset();
1901 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
1902
1903 if (StateIsStoppedState(state))
Chris Lattner24943d22010-06-08 16:52:24 +00001904 break;
Greg Clayton72e1c782011-01-22 23:43:18 +00001905
1906 // If state is invalid, then we timed out
1907 if (state == eStateInvalid)
1908 break;
1909
1910 if (event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00001911 HandlePrivateEvent (event_sp);
1912 }
1913 return state;
1914}
1915
1916Error
1917Process::Launch
1918(
1919 char const *argv[],
1920 char const *envp[],
Greg Clayton452bf612010-08-31 18:35:14 +00001921 uint32_t launch_flags,
Chris Lattner24943d22010-06-08 16:52:24 +00001922 const char *stdin_path,
1923 const char *stdout_path,
Greg Claytonde915be2011-01-23 05:56:20 +00001924 const char *stderr_path,
1925 const char *working_directory
Chris Lattner24943d22010-06-08 16:52:24 +00001926)
1927{
1928 Error error;
Chris Lattner24943d22010-06-08 16:52:24 +00001929 m_abi_sp.reset();
Greg Clayton75c703d2011-02-16 04:46:07 +00001930 m_dyld_ap.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00001931 m_process_input_reader.reset();
Chris Lattner24943d22010-06-08 16:52:24 +00001932
1933 Module *exe_module = m_target.GetExecutableModule().get();
1934 if (exe_module)
1935 {
Greg Clayton180546b2011-04-30 01:09:13 +00001936 char local_exec_file_path[PATH_MAX];
1937 char platform_exec_file_path[PATH_MAX];
1938 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
1939 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner24943d22010-06-08 16:52:24 +00001940 if (exe_module->GetFileSpec().Exists())
1941 {
Greg Claytona2f74232011-02-24 22:24:29 +00001942 if (PrivateStateThreadIsValid ())
1943 PausePrivateStateThread ();
1944
Chris Lattner24943d22010-06-08 16:52:24 +00001945 error = WillLaunch (exe_module);
1946 if (error.Success())
1947 {
Greg Claytond8c62532010-10-07 04:19:01 +00001948 SetPublicState (eStateLaunching);
Chris Lattner24943d22010-06-08 16:52:24 +00001949 // The args coming in should not contain the application name, the
1950 // lldb_private::Process class will add this in case the executable
1951 // gets resolved to a different file than was given on the command
1952 // line (like when an applicaiton bundle is specified and will
1953 // resolve to the contained exectuable file, or the file given was
1954 // a symlink or other file system link that resolves to a different
1955 // file).
1956
1957 // Get the resolved exectuable path
1958
1959 // Make a new argument vector
1960 std::vector<const char *> exec_path_plus_argv;
1961 // Append the resolved executable path
Greg Clayton180546b2011-04-30 01:09:13 +00001962 exec_path_plus_argv.push_back (platform_exec_file_path);
Chris Lattner24943d22010-06-08 16:52:24 +00001963
1964 // Push all args if there are any
1965 if (argv)
1966 {
1967 for (int i = 0; argv[i]; ++i)
1968 exec_path_plus_argv.push_back(argv[i]);
1969 }
1970
1971 // Push a NULL to terminate the args.
1972 exec_path_plus_argv.push_back(NULL);
1973
1974 // Now launch using these arguments.
Greg Clayton53d68e72010-07-20 22:52:08 +00001975 error = DoLaunch (exe_module,
1976 exec_path_plus_argv.empty() ? NULL : &exec_path_plus_argv.front(),
1977 envp,
Greg Clayton452bf612010-08-31 18:35:14 +00001978 launch_flags,
Greg Clayton53d68e72010-07-20 22:52:08 +00001979 stdin_path,
1980 stdout_path,
Greg Claytonde915be2011-01-23 05:56:20 +00001981 stderr_path,
1982 working_directory);
Chris Lattner24943d22010-06-08 16:52:24 +00001983
1984 if (error.Fail())
1985 {
1986 if (GetID() != LLDB_INVALID_PROCESS_ID)
1987 {
1988 SetID (LLDB_INVALID_PROCESS_ID);
1989 const char *error_string = error.AsCString();
1990 if (error_string == NULL)
1991 error_string = "launch failed";
1992 SetExitStatus (-1, error_string);
1993 }
1994 }
1995 else
1996 {
1997 EventSP event_sp;
1998 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
1999
2000 if (state == eStateStopped || state == eStateCrashed)
2001 {
Greg Clayton75c703d2011-02-16 04:46:07 +00002002
Chris Lattner24943d22010-06-08 16:52:24 +00002003 DidLaunch ();
2004
Greg Clayton4fdf7602011-03-20 04:57:14 +00002005 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
Greg Clayton75c703d2011-02-16 04:46:07 +00002006 if (m_dyld_ap.get())
2007 m_dyld_ap->DidLaunch();
2008
Chris Lattner24943d22010-06-08 16:52:24 +00002009 // This delays passing the stopped event to listeners till DidLaunch gets
2010 // a chance to complete...
2011 HandlePrivateEvent (event_sp);
Greg Claytona2f74232011-02-24 22:24:29 +00002012
2013 if (PrivateStateThreadIsValid ())
2014 ResumePrivateStateThread ();
2015 else
2016 StartPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00002017 }
2018 else if (state == eStateExited)
2019 {
2020 // We exited while trying to launch somehow. Don't call DidLaunch as that's
2021 // not likely to work, and return an invalid pid.
2022 HandlePrivateEvent (event_sp);
2023 }
2024 }
2025 }
2026 }
2027 else
2028 {
Greg Clayton180546b2011-04-30 01:09:13 +00002029 error.SetErrorStringWithFormat("File doesn't exist: '%s'.\n", local_exec_file_path);
Chris Lattner24943d22010-06-08 16:52:24 +00002030 }
2031 }
2032 return error;
2033}
2034
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002035Process::NextEventAction::EventActionResult
2036Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002037{
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002038 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
2039 switch (state)
Greg Claytonc1d37752010-10-18 01:45:30 +00002040 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002041 case eStateRunning:
Greg Claytona2f74232011-02-24 22:24:29 +00002042 case eStateConnected:
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002043 return eEventActionRetry;
2044
2045 case eStateStopped:
2046 case eStateCrashed:
Jim Ingham7508e732010-08-09 23:31:02 +00002047 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002048 // During attach, prior to sending the eStateStopped event,
2049 // lldb_private::Process subclasses must set the process must set
2050 // the new process ID.
2051 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
Greg Clayton75c703d2011-02-16 04:46:07 +00002052 m_process->CompleteAttach ();
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002053 return eEventActionSuccess;
Jim Ingham7508e732010-08-09 23:31:02 +00002054 }
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002055
2056
2057 break;
2058 default:
2059 case eStateExited:
2060 case eStateInvalid:
2061 m_exit_string.assign ("No valid Process");
2062 return eEventActionExit;
2063 break;
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002064 }
2065}
Chris Lattner24943d22010-06-08 16:52:24 +00002066
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002067Process::NextEventAction::EventActionResult
2068Process::AttachCompletionHandler::HandleBeingInterrupted()
2069{
2070 return eEventActionSuccess;
2071}
2072
2073const char *
2074Process::AttachCompletionHandler::GetExitString ()
2075{
2076 return m_exit_string.c_str();
Chris Lattner24943d22010-06-08 16:52:24 +00002077}
2078
2079Error
2080Process::Attach (lldb::pid_t attach_pid)
2081{
2082
Chris Lattner24943d22010-06-08 16:52:24 +00002083 m_abi_sp.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002084 m_process_input_reader.reset();
Chris Lattner24943d22010-06-08 16:52:24 +00002085
Jim Ingham7508e732010-08-09 23:31:02 +00002086 // Find the process and its architecture. Make sure it matches the architecture
2087 // of the current Target, and if not adjust it.
2088
Greg Claytonb72d0f02011-04-12 05:54:46 +00002089 ProcessInstanceInfo process_info;
Greg Claytonb1888f22011-03-19 01:12:21 +00002090 PlatformSP platform_sp (m_target.GetDebugger().GetPlatformList().GetSelectedPlatform ());
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002091 if (platform_sp)
Jim Ingham7508e732010-08-09 23:31:02 +00002092 {
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002093 if (platform_sp->GetProcessInfo (attach_pid, process_info))
2094 {
2095 const ArchSpec &process_arch = process_info.GetArchitecture();
2096 if (process_arch.IsValid())
2097 GetTarget().SetArchitecture(process_arch);
2098 }
Jim Ingham7508e732010-08-09 23:31:02 +00002099 }
2100
Greg Clayton75c703d2011-02-16 04:46:07 +00002101 m_dyld_ap.reset();
2102
Greg Clayton54e7afa2010-07-09 20:39:50 +00002103 Error error (WillAttachToProcessWithID(attach_pid));
Chris Lattner24943d22010-06-08 16:52:24 +00002104 if (error.Success())
2105 {
Greg Claytond8c62532010-10-07 04:19:01 +00002106 SetPublicState (eStateAttaching);
2107
Greg Clayton54e7afa2010-07-09 20:39:50 +00002108 error = DoAttachToProcessWithID (attach_pid);
Chris Lattner24943d22010-06-08 16:52:24 +00002109 if (error.Success())
2110 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002111 SetNextEventAction(new Process::AttachCompletionHandler(this));
2112 StartPrivateStateThread();
Chris Lattner24943d22010-06-08 16:52:24 +00002113 }
2114 else
2115 {
2116 if (GetID() != LLDB_INVALID_PROCESS_ID)
2117 {
2118 SetID (LLDB_INVALID_PROCESS_ID);
2119 const char *error_string = error.AsCString();
2120 if (error_string == NULL)
2121 error_string = "attach failed";
2122
2123 SetExitStatus(-1, error_string);
2124 }
2125 }
2126 }
2127 return error;
2128}
2129
2130Error
2131Process::Attach (const char *process_name, bool wait_for_launch)
2132{
Chris Lattner24943d22010-06-08 16:52:24 +00002133 m_abi_sp.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002134 m_process_input_reader.reset();
Jim Ingham7508e732010-08-09 23:31:02 +00002135
2136 // Find the process and its architecture. Make sure it matches the architecture
2137 // of the current Target, and if not adjust it.
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002138 Error error;
Jim Ingham7508e732010-08-09 23:31:02 +00002139
Jim Inghamea294182010-08-17 21:54:19 +00002140 if (!wait_for_launch)
Jim Ingham7508e732010-08-09 23:31:02 +00002141 {
Greg Claytonb72d0f02011-04-12 05:54:46 +00002142 ProcessInstanceInfoList process_infos;
Greg Claytonb1888f22011-03-19 01:12:21 +00002143 PlatformSP platform_sp (m_target.GetDebugger().GetPlatformList().GetSelectedPlatform ());
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002144 if (platform_sp)
Jim Inghamea294182010-08-17 21:54:19 +00002145 {
Greg Claytonb72d0f02011-04-12 05:54:46 +00002146 ProcessInstanceInfoMatch match_info;
Greg Clayton24bc5d92011-03-30 18:16:51 +00002147 match_info.GetProcessInfo().SetName(process_name);
2148 match_info.SetNameMatchType (eNameMatchEquals);
2149 platform_sp->FindProcesses (match_info, process_infos);
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002150 if (process_infos.GetSize() > 1)
Chris Lattner24943d22010-06-08 16:52:24 +00002151 {
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002152 error.SetErrorStringWithFormat ("More than one process named %s\n", process_name);
2153 }
2154 else if (process_infos.GetSize() == 0)
2155 {
2156 error.SetErrorStringWithFormat ("Could not find a process named %s\n", process_name);
2157 }
2158 else
2159 {
Greg Claytonb72d0f02011-04-12 05:54:46 +00002160 ProcessInstanceInfo process_info;
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002161 if (process_infos.GetInfoAtIndex (0, process_info))
2162 {
2163 const ArchSpec &process_arch = process_info.GetArchitecture();
2164 if (process_arch.IsValid() && process_arch != GetTarget().GetArchitecture())
2165 {
2166 // Set the architecture on the target.
2167 GetTarget().SetArchitecture (process_arch);
2168 }
2169 }
Chris Lattner24943d22010-06-08 16:52:24 +00002170 }
2171 }
2172 else
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002173 {
2174 error.SetErrorString ("Invalid platform");
2175 }
2176 }
2177
2178 if (error.Success())
2179 {
2180 m_dyld_ap.reset();
2181
2182 error = WillAttachToProcessWithName(process_name, wait_for_launch);
2183 if (error.Success())
Chris Lattner24943d22010-06-08 16:52:24 +00002184 {
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002185 SetPublicState (eStateAttaching);
2186 error = DoAttachToProcessWithName (process_name, wait_for_launch);
2187 if (error.Fail())
2188 {
2189 if (GetID() != LLDB_INVALID_PROCESS_ID)
2190 {
2191 SetID (LLDB_INVALID_PROCESS_ID);
2192 const char *error_string = error.AsCString();
2193 if (error_string == NULL)
2194 error_string = "attach failed";
2195
2196 SetExitStatus(-1, error_string);
2197 }
2198 }
2199 else
2200 {
2201 SetNextEventAction(new Process::AttachCompletionHandler(this));
2202 StartPrivateStateThread();
2203 }
Chris Lattner24943d22010-06-08 16:52:24 +00002204 }
2205 }
2206 return error;
2207}
2208
Greg Clayton75c703d2011-02-16 04:46:07 +00002209void
2210Process::CompleteAttach ()
2211{
2212 // Let the process subclass figure out at much as it can about the process
2213 // before we go looking for a dynamic loader plug-in.
2214 DidAttach();
2215
2216 // We have complete the attach, now it is time to find the dynamic loader
2217 // plug-in
Greg Clayton4fdf7602011-03-20 04:57:14 +00002218 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
Greg Clayton75c703d2011-02-16 04:46:07 +00002219 if (m_dyld_ap.get())
2220 m_dyld_ap->DidAttach();
2221
2222 // Figure out which one is the executable, and set that in our target:
2223 ModuleList &modules = m_target.GetImages();
2224
2225 size_t num_modules = modules.GetSize();
2226 for (int i = 0; i < num_modules; i++)
2227 {
2228 ModuleSP module_sp (modules.GetModuleAtIndex(i));
Greg Claytonb72d0f02011-04-12 05:54:46 +00002229 if (module_sp && module_sp->IsExecutable())
Greg Clayton75c703d2011-02-16 04:46:07 +00002230 {
2231 ModuleSP target_exe_module_sp (m_target.GetExecutableModule());
2232 if (target_exe_module_sp != module_sp)
2233 m_target.SetExecutableModule (module_sp, false);
2234 break;
2235 }
2236 }
2237}
2238
Chris Lattner24943d22010-06-08 16:52:24 +00002239Error
Greg Claytone71e2582011-02-04 01:58:07 +00002240Process::ConnectRemote (const char *remote_url)
2241{
Greg Claytone71e2582011-02-04 01:58:07 +00002242 m_abi_sp.reset();
2243 m_process_input_reader.reset();
2244
2245 // Find the process and its architecture. Make sure it matches the architecture
2246 // of the current Target, and if not adjust it.
2247
2248 Error error (DoConnectRemote (remote_url));
2249 if (error.Success())
2250 {
Greg Claytona2f74232011-02-24 22:24:29 +00002251 if (GetID() != LLDB_INVALID_PROCESS_ID)
2252 {
Greg Clayton24bc5d92011-03-30 18:16:51 +00002253 EventSP event_sp;
2254 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
2255
2256 if (state == eStateStopped || state == eStateCrashed)
2257 {
2258 // If we attached and actually have a process on the other end, then
2259 // this ended up being the equivalent of an attach.
2260 CompleteAttach ();
2261
2262 // This delays passing the stopped event to listeners till
2263 // CompleteAttach gets a chance to complete...
2264 HandlePrivateEvent (event_sp);
2265
2266 }
Greg Claytona2f74232011-02-24 22:24:29 +00002267 }
Greg Clayton24bc5d92011-03-30 18:16:51 +00002268
2269 if (PrivateStateThreadIsValid ())
2270 ResumePrivateStateThread ();
2271 else
2272 StartPrivateStateThread ();
Greg Claytone71e2582011-02-04 01:58:07 +00002273 }
2274 return error;
2275}
2276
2277
2278Error
Chris Lattner24943d22010-06-08 16:52:24 +00002279Process::Resume ()
2280{
Greg Claytone005f2c2010-11-06 01:53:30 +00002281 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00002282 if (log)
Jim Inghamac959662011-01-24 06:34:17 +00002283 log->Printf("Process::Resume() m_stop_id = %u, public state: %s private state: %s",
2284 m_stop_id,
2285 StateAsCString(m_public_state.GetValue()),
2286 StateAsCString(m_private_state.GetValue()));
Chris Lattner24943d22010-06-08 16:52:24 +00002287
2288 Error error (WillResume());
2289 // Tell the process it is about to resume before the thread list
2290 if (error.Success())
2291 {
Johnny Chen9c11d472010-12-02 20:53:05 +00002292 // Now let the thread list know we are about to resume so it
Chris Lattner24943d22010-06-08 16:52:24 +00002293 // can let all of our threads know that they are about to be
2294 // resumed. Threads will each be called with
2295 // Thread::WillResume(StateType) where StateType contains the state
2296 // that they are supposed to have when the process is resumed
2297 // (suspended/running/stepping). Threads should also check
2298 // their resume signal in lldb::Thread::GetResumeSignal()
2299 // to see if they are suppoed to start back up with a signal.
2300 if (m_thread_list.WillResume())
2301 {
2302 error = DoResume();
2303 if (error.Success())
2304 {
2305 DidResume();
2306 m_thread_list.DidResume();
Jim Inghamac959662011-01-24 06:34:17 +00002307 if (log)
2308 log->Printf ("Process thinks the process has resumed.");
Chris Lattner24943d22010-06-08 16:52:24 +00002309 }
2310 }
2311 else
2312 {
Jim Inghamac959662011-01-24 06:34:17 +00002313 error.SetErrorStringWithFormat("Process::WillResume() thread list returned false after WillResume");
Chris Lattner24943d22010-06-08 16:52:24 +00002314 }
2315 }
Jim Inghamac959662011-01-24 06:34:17 +00002316 else if (log)
2317 log->Printf ("Process::WillResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner24943d22010-06-08 16:52:24 +00002318 return error;
2319}
2320
2321Error
2322Process::Halt ()
2323{
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002324 // Pause our private state thread so we can ensure no one else eats
2325 // the stop event out from under us.
Jim Inghamf9f40c22011-02-08 05:20:59 +00002326 Listener halt_listener ("lldb.process.halt_listener");
2327 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton20d338f2010-11-18 05:57:03 +00002328
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002329 EventSP event_sp;
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002330 Error error (WillHalt());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002331
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002332 if (error.Success())
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002333 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002334
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002335 bool caused_stop = false;
2336
2337 // Ask the process subclass to actually halt our process
2338 error = DoHalt(caused_stop);
Chris Lattner24943d22010-06-08 16:52:24 +00002339 if (error.Success())
Jim Ingham3ae449a2010-11-17 02:32:00 +00002340 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002341 if (m_public_state.GetValue() == eStateAttaching)
2342 {
2343 SetExitStatus(SIGKILL, "Cancelled async attach.");
2344 Destroy ();
2345 }
2346 else
Jim Ingham3ae449a2010-11-17 02:32:00 +00002347 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002348 // If "caused_stop" is true, then DoHalt stopped the process. If
2349 // "caused_stop" is false, the process was already stopped.
2350 // If the DoHalt caused the process to stop, then we want to catch
2351 // this event and set the interrupted bool to true before we pass
2352 // this along so clients know that the process was interrupted by
2353 // a halt command.
2354 if (caused_stop)
Greg Clayton20d338f2010-11-18 05:57:03 +00002355 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00002356 // Wait for 1 second for the process to stop.
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002357 TimeValue timeout_time;
2358 timeout_time = TimeValue::Now();
2359 timeout_time.OffsetWithSeconds(1);
Jim Inghamf9f40c22011-02-08 05:20:59 +00002360 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
2361 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002362
Jim Inghamf9f40c22011-02-08 05:20:59 +00002363 if (!got_event || state == eStateInvalid)
Greg Clayton20d338f2010-11-18 05:57:03 +00002364 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002365 // We timeout out and didn't get a stop event...
Jim Inghamf9f40c22011-02-08 05:20:59 +00002366 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
Greg Clayton20d338f2010-11-18 05:57:03 +00002367 }
2368 else
2369 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002370 if (StateIsStoppedState (state))
2371 {
2372 // We caused the process to interrupt itself, so mark this
2373 // as such in the stop event so clients can tell an interrupted
2374 // process from a natural stop
2375 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
2376 }
2377 else
2378 {
2379 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2380 if (log)
2381 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
2382 error.SetErrorString ("Did not get stopped event after halt.");
2383 }
Greg Clayton20d338f2010-11-18 05:57:03 +00002384 }
2385 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002386 DidHalt();
Jim Ingham3ae449a2010-11-17 02:32:00 +00002387 }
2388 }
Chris Lattner24943d22010-06-08 16:52:24 +00002389 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002390 // Resume our private state thread before we post the event (if any)
Jim Inghamf9f40c22011-02-08 05:20:59 +00002391 RestorePrivateProcessEvents();
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002392
2393 // Post any event we might have consumed. If all goes well, we will have
2394 // stopped the process, intercepted the event and set the interrupted
2395 // bool in the event. Post it to the private event queue and that will end up
2396 // correctly setting the state.
2397 if (event_sp)
2398 m_private_state_broadcaster.BroadcastEvent(event_sp);
2399
Chris Lattner24943d22010-06-08 16:52:24 +00002400 return error;
2401}
2402
2403Error
2404Process::Detach ()
2405{
2406 Error error (WillDetach());
2407
2408 if (error.Success())
2409 {
2410 DisableAllBreakpointSites();
2411 error = DoDetach();
2412 if (error.Success())
2413 {
2414 DidDetach();
2415 StopPrivateStateThread();
2416 }
2417 }
2418 return error;
2419}
2420
2421Error
2422Process::Destroy ()
2423{
2424 Error error (WillDestroy());
2425 if (error.Success())
2426 {
2427 DisableAllBreakpointSites();
2428 error = DoDestroy();
2429 if (error.Success())
2430 {
2431 DidDestroy();
2432 StopPrivateStateThread();
2433 }
Caroline Tice861efb32010-11-16 05:07:41 +00002434 m_stdio_communication.StopReadThread();
2435 m_stdio_communication.Disconnect();
2436 if (m_process_input_reader && m_process_input_reader->IsActive())
2437 m_target.GetDebugger().PopInputReader (m_process_input_reader);
2438 if (m_process_input_reader)
2439 m_process_input_reader.reset();
Chris Lattner24943d22010-06-08 16:52:24 +00002440 }
2441 return error;
2442}
2443
2444Error
2445Process::Signal (int signal)
2446{
2447 Error error (WillSignal());
2448 if (error.Success())
2449 {
2450 error = DoSignal(signal);
2451 if (error.Success())
2452 DidSignal();
2453 }
2454 return error;
2455}
2456
Greg Clayton395fc332011-02-15 21:59:32 +00002457lldb::ByteOrder
2458Process::GetByteOrder () const
Chris Lattner24943d22010-06-08 16:52:24 +00002459{
Greg Clayton395fc332011-02-15 21:59:32 +00002460 return m_target.GetArchitecture().GetByteOrder();
Chris Lattner24943d22010-06-08 16:52:24 +00002461}
2462
2463uint32_t
Greg Clayton395fc332011-02-15 21:59:32 +00002464Process::GetAddressByteSize () const
Chris Lattner24943d22010-06-08 16:52:24 +00002465{
Greg Clayton395fc332011-02-15 21:59:32 +00002466 return m_target.GetArchitecture().GetAddressByteSize();
Chris Lattner24943d22010-06-08 16:52:24 +00002467}
2468
Greg Clayton395fc332011-02-15 21:59:32 +00002469
Chris Lattner24943d22010-06-08 16:52:24 +00002470bool
2471Process::ShouldBroadcastEvent (Event *event_ptr)
2472{
2473 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
2474 bool return_value = true;
Greg Claytone005f2c2010-11-06 01:53:30 +00002475 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00002476
2477 switch (state)
2478 {
Greg Claytone71e2582011-02-04 01:58:07 +00002479 case eStateConnected:
Chris Lattner24943d22010-06-08 16:52:24 +00002480 case eStateAttaching:
2481 case eStateLaunching:
2482 case eStateDetached:
2483 case eStateExited:
2484 case eStateUnloaded:
2485 // These events indicate changes in the state of the debugging session, always report them.
2486 return_value = true;
2487 break;
2488 case eStateInvalid:
2489 // We stopped for no apparent reason, don't report it.
2490 return_value = false;
2491 break;
2492 case eStateRunning:
2493 case eStateStepping:
2494 // If we've started the target running, we handle the cases where we
2495 // are already running and where there is a transition from stopped to
2496 // running differently.
2497 // running -> running: Automatically suppress extra running events
2498 // stopped -> running: Report except when there is one or more no votes
2499 // and no yes votes.
2500 SynchronouslyNotifyStateChanged (state);
2501 switch (m_public_state.GetValue())
2502 {
2503 case eStateRunning:
2504 case eStateStepping:
2505 // We always suppress multiple runnings with no PUBLIC stop in between.
2506 return_value = false;
2507 break;
2508 default:
2509 // TODO: make this work correctly. For now always report
2510 // run if we aren't running so we don't miss any runnning
2511 // events. If I run the lldb/test/thread/a.out file and
2512 // break at main.cpp:58, run and hit the breakpoints on
2513 // multiple threads, then somehow during the stepping over
2514 // of all breakpoints no run gets reported.
2515 return_value = true;
2516
2517 // This is a transition from stop to run.
2518 switch (m_thread_list.ShouldReportRun (event_ptr))
2519 {
2520 case eVoteYes:
2521 case eVoteNoOpinion:
2522 return_value = true;
2523 break;
2524 case eVoteNo:
2525 return_value = false;
2526 break;
2527 }
2528 break;
2529 }
2530 break;
2531 case eStateStopped:
2532 case eStateCrashed:
2533 case eStateSuspended:
2534 {
2535 // We've stopped. First see if we're going to restart the target.
2536 // If we are going to stop, then we always broadcast the event.
2537 // If we aren't going to stop, let the thread plans decide if we're going to report this event.
Jim Ingham5a47e8b2010-06-19 04:45:32 +00002538 // If no thread has an opinion, we don't report it.
Jim Ingham3ae449a2010-11-17 02:32:00 +00002539 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner24943d22010-06-08 16:52:24 +00002540 {
Greg Clayton20d338f2010-11-18 05:57:03 +00002541 if (log)
2542 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s", event_ptr, StateAsCString(state));
Jim Ingham3ae449a2010-11-17 02:32:00 +00002543 return true;
2544 }
2545 else
2546 {
Chris Lattner24943d22010-06-08 16:52:24 +00002547 RefreshStateAfterStop ();
2548
2549 if (m_thread_list.ShouldStop (event_ptr) == false)
2550 {
2551 switch (m_thread_list.ShouldReportStop (event_ptr))
2552 {
2553 case eVoteYes:
2554 Process::ProcessEventData::SetRestartedInEvent (event_ptr, true);
Johnny Chen028784b2010-10-14 00:54:32 +00002555 // Intentional fall-through here.
Chris Lattner24943d22010-06-08 16:52:24 +00002556 case eVoteNoOpinion:
Chris Lattner24943d22010-06-08 16:52:24 +00002557 case eVoteNo:
2558 return_value = false;
2559 break;
2560 }
2561
2562 if (log)
Jim Ingham3ae449a2010-11-17 02:32:00 +00002563 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s", event_ptr, StateAsCString(state));
Chris Lattner24943d22010-06-08 16:52:24 +00002564 Resume ();
2565 }
2566 else
2567 {
2568 return_value = true;
2569 SynchronouslyNotifyStateChanged (state);
2570 }
2571 }
2572 }
2573 }
2574
2575 if (log)
2576 log->Printf ("Process::ShouldBroadcastEvent (%p) => %s", event_ptr, StateAsCString(state), return_value ? "YES" : "NO");
2577 return return_value;
2578}
2579
Chris Lattner24943d22010-06-08 16:52:24 +00002580
2581bool
2582Process::StartPrivateStateThread ()
2583{
Greg Claytone005f2c2010-11-06 01:53:30 +00002584 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00002585
Greg Claytonb72d0f02011-04-12 05:54:46 +00002586 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner24943d22010-06-08 16:52:24 +00002587 if (log)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002588 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
2589
2590 if (already_running)
2591 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00002592
2593 // Create a thread that watches our internal state and controls which
2594 // events make it to clients (into the DCProcess event queue).
Greg Claytona875b642011-01-09 21:07:35 +00002595 char thread_name[1024];
2596 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%i)>", GetID());
2597 m_private_state_thread = Host::ThreadCreate (thread_name, Process::PrivateStateThread, this, NULL);
Greg Clayton09c81ef2011-02-08 01:34:25 +00002598 return IS_VALID_LLDB_HOST_THREAD(m_private_state_thread);
Chris Lattner24943d22010-06-08 16:52:24 +00002599}
2600
2601void
2602Process::PausePrivateStateThread ()
2603{
2604 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
2605}
2606
2607void
2608Process::ResumePrivateStateThread ()
2609{
2610 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
2611}
2612
2613void
2614Process::StopPrivateStateThread ()
2615{
Greg Claytonb72d0f02011-04-12 05:54:46 +00002616 if (PrivateStateThreadIsValid ())
2617 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Chris Lattner24943d22010-06-08 16:52:24 +00002618}
2619
2620void
2621Process::ControlPrivateStateThread (uint32_t signal)
2622{
Greg Claytone005f2c2010-11-06 01:53:30 +00002623 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00002624
2625 assert (signal == eBroadcastInternalStateControlStop ||
2626 signal == eBroadcastInternalStateControlPause ||
2627 signal == eBroadcastInternalStateControlResume);
2628
2629 if (log)
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00002630 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner24943d22010-06-08 16:52:24 +00002631
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00002632 // Signal the private state thread. First we should copy this is case the
2633 // thread starts exiting since the private state thread will NULL this out
2634 // when it exits
2635 const lldb::thread_t private_state_thread = m_private_state_thread;
Greg Clayton09c81ef2011-02-08 01:34:25 +00002636 if (IS_VALID_LLDB_HOST_THREAD(private_state_thread))
Chris Lattner24943d22010-06-08 16:52:24 +00002637 {
2638 TimeValue timeout_time;
2639 bool timed_out;
2640
2641 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
2642
2643 timeout_time = TimeValue::Now();
2644 timeout_time.OffsetWithSeconds(2);
2645 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
2646 m_private_state_control_wait.SetValue (false, eBroadcastNever);
2647
2648 if (signal == eBroadcastInternalStateControlStop)
2649 {
2650 if (timed_out)
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00002651 Host::ThreadCancel (private_state_thread, NULL);
Chris Lattner24943d22010-06-08 16:52:24 +00002652
2653 thread_result_t result = NULL;
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00002654 Host::ThreadJoin (private_state_thread, &result, NULL);
Greg Claytonc607d862010-07-22 18:34:21 +00002655 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00002656 }
2657 }
2658}
2659
2660void
2661Process::HandlePrivateEvent (EventSP &event_sp)
2662{
Greg Claytone005f2c2010-11-06 01:53:30 +00002663 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002664
Greg Clayton68ca8232011-01-25 02:58:48 +00002665 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002666
2667 // First check to see if anybody wants a shot at this event:
Jim Ingham68bffc52011-01-29 04:05:41 +00002668 if (m_next_event_action_ap.get() != NULL)
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002669 {
Jim Ingham68bffc52011-01-29 04:05:41 +00002670 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002671 switch (action_result)
2672 {
2673 case NextEventAction::eEventActionSuccess:
2674 SetNextEventAction(NULL);
2675 break;
2676 case NextEventAction::eEventActionRetry:
2677 break;
2678 case NextEventAction::eEventActionExit:
Jim Ingham84c86382011-01-29 01:57:31 +00002679 // Handle Exiting Here. If we already got an exited event,
2680 // we should just propagate it. Otherwise, swallow this event,
2681 // and set our state to exit so the next event will kill us.
2682 if (new_state != eStateExited)
2683 {
2684 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham68bffc52011-01-29 04:05:41 +00002685 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham84c86382011-01-29 01:57:31 +00002686 SetNextEventAction(NULL);
2687 return;
2688 }
2689 SetNextEventAction(NULL);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002690 break;
2691 }
2692 }
2693
Chris Lattner24943d22010-06-08 16:52:24 +00002694 // See if we should broadcast this state to external clients?
2695 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner24943d22010-06-08 16:52:24 +00002696
2697 if (should_broadcast)
2698 {
2699 if (log)
2700 {
Greg Clayton68ca8232011-01-25 02:58:48 +00002701 log->Printf ("Process::%s (pid = %i) broadcasting new state %s (old state %s) to %s",
2702 __FUNCTION__,
2703 GetID(),
2704 StateAsCString(new_state),
2705 StateAsCString (GetState ()),
2706 IsHijackedForEvent(eBroadcastBitStateChanged) ? "hijacked" : "public");
Chris Lattner24943d22010-06-08 16:52:24 +00002707 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00002708 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton68ca8232011-01-25 02:58:48 +00002709 if (StateIsRunningState (new_state))
Caroline Tice861efb32010-11-16 05:07:41 +00002710 PushProcessInputReader ();
2711 else
2712 PopProcessInputReader ();
Jim Inghamd60d94a2011-03-11 03:53:59 +00002713
Chris Lattner24943d22010-06-08 16:52:24 +00002714 BroadcastEvent (event_sp);
2715 }
2716 else
2717 {
2718 if (log)
2719 {
Greg Clayton68ca8232011-01-25 02:58:48 +00002720 log->Printf ("Process::%s (pid = %i) suppressing state %s (old state %s): should_broadcast == false",
2721 __FUNCTION__,
2722 GetID(),
2723 StateAsCString(new_state),
2724 StateAsCString (GetState ()),
2725 IsHijackedForEvent(eBroadcastBitStateChanged) ? "hijacked" : "public");
Chris Lattner24943d22010-06-08 16:52:24 +00002726 }
2727 }
2728}
2729
2730void *
2731Process::PrivateStateThread (void *arg)
2732{
2733 Process *proc = static_cast<Process*> (arg);
2734 void *result = proc->RunPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00002735 return result;
2736}
2737
2738void *
2739Process::RunPrivateStateThread ()
2740{
2741 bool control_only = false;
2742 m_private_state_control_wait.SetValue (false, eBroadcastNever);
2743
Greg Claytone005f2c2010-11-06 01:53:30 +00002744 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00002745 if (log)
2746 log->Printf ("Process::%s (arg = %p, pid = %i) thread starting...", __FUNCTION__, this, GetID());
2747
2748 bool exit_now = false;
2749 while (!exit_now)
2750 {
2751 EventSP event_sp;
2752 WaitForEventsPrivate (NULL, event_sp, control_only);
2753 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
2754 {
2755 switch (event_sp->GetType())
2756 {
2757 case eBroadcastInternalStateControlStop:
2758 exit_now = true;
2759 continue; // Go to next loop iteration so we exit without
2760 break; // doing any internal state managment below
2761
2762 case eBroadcastInternalStateControlPause:
2763 control_only = true;
2764 break;
2765
2766 case eBroadcastInternalStateControlResume:
2767 control_only = false;
2768 break;
2769 }
Jim Ingham3ae449a2010-11-17 02:32:00 +00002770
Jim Ingham3ae449a2010-11-17 02:32:00 +00002771 if (log)
2772 log->Printf ("Process::%s (arg = %p, pid = %i) got a control event: %d", __FUNCTION__, this, GetID(), event_sp->GetType());
2773
Chris Lattner24943d22010-06-08 16:52:24 +00002774 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham3ae449a2010-11-17 02:32:00 +00002775 continue;
Chris Lattner24943d22010-06-08 16:52:24 +00002776 }
2777
2778
2779 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
2780
2781 if (internal_state != eStateInvalid)
2782 {
2783 HandlePrivateEvent (event_sp);
2784 }
2785
Greg Clayton3b2c41c2010-10-18 04:14:23 +00002786 if (internal_state == eStateInvalid ||
2787 internal_state == eStateExited ||
2788 internal_state == eStateDetached )
Jim Ingham3ae449a2010-11-17 02:32:00 +00002789 {
Jim Ingham3ae449a2010-11-17 02:32:00 +00002790 if (log)
2791 log->Printf ("Process::%s (arg = %p, pid = %i) about to exit with internal state %s...", __FUNCTION__, this, GetID(), StateAsCString(internal_state));
2792
Chris Lattner24943d22010-06-08 16:52:24 +00002793 break;
Jim Ingham3ae449a2010-11-17 02:32:00 +00002794 }
Chris Lattner24943d22010-06-08 16:52:24 +00002795 }
2796
Caroline Tice926060e2010-10-29 21:48:37 +00002797 // Verify log is still enabled before attempting to write to it...
Chris Lattner24943d22010-06-08 16:52:24 +00002798 if (log)
2799 log->Printf ("Process::%s (arg = %p, pid = %i) thread exiting...", __FUNCTION__, this, GetID());
2800
Greg Claytona4881d02011-01-22 07:12:45 +00002801 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
2802 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00002803 return NULL;
2804}
2805
Chris Lattner24943d22010-06-08 16:52:24 +00002806//------------------------------------------------------------------
2807// Process Event Data
2808//------------------------------------------------------------------
2809
2810Process::ProcessEventData::ProcessEventData () :
2811 EventData (),
2812 m_process_sp (),
2813 m_state (eStateInvalid),
Greg Clayton54e7afa2010-07-09 20:39:50 +00002814 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00002815 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00002816 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00002817{
2818}
2819
2820Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
2821 EventData (),
2822 m_process_sp (process_sp),
2823 m_state (state),
Greg Clayton54e7afa2010-07-09 20:39:50 +00002824 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00002825 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00002826 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00002827{
2828}
2829
2830Process::ProcessEventData::~ProcessEventData()
2831{
2832}
2833
2834const ConstString &
2835Process::ProcessEventData::GetFlavorString ()
2836{
2837 static ConstString g_flavor ("Process::ProcessEventData");
2838 return g_flavor;
2839}
2840
2841const ConstString &
2842Process::ProcessEventData::GetFlavor () const
2843{
2844 return ProcessEventData::GetFlavorString ();
2845}
2846
Chris Lattner24943d22010-06-08 16:52:24 +00002847void
2848Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
2849{
2850 // This function gets called twice for each event, once when the event gets pulled
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00002851 // off of the private process event queue, and then any number of times, first when it gets pulled off of
2852 // the public event queue, then other times when we're pretending that this is where we stopped at the
2853 // end of expression evaluation. m_update_state is used to distinguish these
2854 // three cases; it is 0 when we're just pulling it off for private handling,
2855 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Chris Lattner24943d22010-06-08 16:52:24 +00002856
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00002857 if (m_update_state != 1)
Chris Lattner24943d22010-06-08 16:52:24 +00002858 return;
2859
2860 m_process_sp->SetPublicState (m_state);
2861
2862 // If we're stopped and haven't restarted, then do the breakpoint commands here:
2863 if (m_state == eStateStopped && ! m_restarted)
2864 {
2865 int num_threads = m_process_sp->GetThreadList().GetSize();
2866 int idx;
Greg Clayton643ee732010-08-04 01:40:35 +00002867
Chris Lattner24943d22010-06-08 16:52:24 +00002868 for (idx = 0; idx < num_threads; ++idx)
2869 {
2870 lldb::ThreadSP thread_sp = m_process_sp->GetThreadList().GetThreadAtIndex(idx);
2871
Jim Ingham6297a3a2010-10-20 00:39:53 +00002872 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
2873 if (stop_info_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002874 {
Jim Ingham6297a3a2010-10-20 00:39:53 +00002875 stop_info_sp->PerformAction(event_ptr);
Chris Lattner24943d22010-06-08 16:52:24 +00002876 }
2877 }
Greg Clayton643ee732010-08-04 01:40:35 +00002878
Jim Ingham6fb8baa2010-08-10 00:59:59 +00002879 // The stop action might restart the target. If it does, then we want to mark that in the
2880 // event so that whoever is receiving it will know to wait for the running event and reflect
2881 // that state appropriately.
2882
Chris Lattner24943d22010-06-08 16:52:24 +00002883 if (m_process_sp->GetPrivateState() == eStateRunning)
2884 SetRestarted(true);
Jim Inghamd60d94a2011-03-11 03:53:59 +00002885 else
2886 {
2887 // Finally, if we didn't restart, run the Stop Hooks here:
2888 // They might also restart the target, so watch for that.
2889 m_process_sp->GetTarget().RunStopHooks();
2890 if (m_process_sp->GetPrivateState() == eStateRunning)
2891 SetRestarted(true);
2892 }
2893
Chris Lattner24943d22010-06-08 16:52:24 +00002894 }
2895}
2896
2897void
2898Process::ProcessEventData::Dump (Stream *s) const
2899{
2900 if (m_process_sp)
2901 s->Printf(" process = %p (pid = %u), ", m_process_sp.get(), m_process_sp->GetID());
2902
Greg Claytonb72d0f02011-04-12 05:54:46 +00002903 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner24943d22010-06-08 16:52:24 +00002904}
2905
2906const Process::ProcessEventData *
2907Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
2908{
2909 if (event_ptr)
2910 {
2911 const EventData *event_data = event_ptr->GetData();
2912 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
2913 return static_cast <const ProcessEventData *> (event_ptr->GetData());
2914 }
2915 return NULL;
2916}
2917
2918ProcessSP
2919Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
2920{
2921 ProcessSP process_sp;
2922 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
2923 if (data)
2924 process_sp = data->GetProcessSP();
2925 return process_sp;
2926}
2927
2928StateType
2929Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
2930{
2931 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
2932 if (data == NULL)
2933 return eStateInvalid;
2934 else
2935 return data->GetState();
2936}
2937
2938bool
2939Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
2940{
2941 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
2942 if (data == NULL)
2943 return false;
2944 else
2945 return data->GetRestarted();
2946}
2947
2948void
2949Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
2950{
2951 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
2952 if (data != NULL)
2953 data->SetRestarted(new_value);
2954}
2955
2956bool
Jim Ingham3ae449a2010-11-17 02:32:00 +00002957Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
2958{
2959 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
2960 if (data == NULL)
2961 return false;
2962 else
2963 return data->GetInterrupted ();
2964}
2965
2966void
2967Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
2968{
2969 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
2970 if (data != NULL)
2971 data->SetInterrupted(new_value);
2972}
2973
2974bool
Chris Lattner24943d22010-06-08 16:52:24 +00002975Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
2976{
2977 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
2978 if (data)
2979 {
2980 data->SetUpdateStateOnRemoval();
2981 return true;
2982 }
2983 return false;
2984}
2985
Chris Lattner24943d22010-06-08 16:52:24 +00002986void
Greg Claytona830adb2010-10-04 01:05:56 +00002987Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner24943d22010-06-08 16:52:24 +00002988{
2989 exe_ctx.target = &m_target;
2990 exe_ctx.process = this;
2991 exe_ctx.thread = NULL;
2992 exe_ctx.frame = NULL;
2993}
2994
2995lldb::ProcessSP
2996Process::GetSP ()
2997{
2998 return GetTarget().GetProcessSP();
2999}
3000
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003001//uint32_t
3002//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
3003//{
3004// return 0;
3005//}
3006//
3007//ArchSpec
3008//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
3009//{
3010// return Host::GetArchSpecForExistingProcess (pid);
3011//}
3012//
3013//ArchSpec
3014//Process::GetArchSpecForExistingProcess (const char *process_name)
3015//{
3016// return Host::GetArchSpecForExistingProcess (process_name);
3017//}
3018//
Caroline Tice861efb32010-11-16 05:07:41 +00003019void
3020Process::AppendSTDOUT (const char * s, size_t len)
3021{
Greg Clayton20d338f2010-11-18 05:57:03 +00003022 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Tice861efb32010-11-16 05:07:41 +00003023 m_stdout_data.append (s, len);
3024
Greg Claytonb3781332010-12-05 19:16:56 +00003025 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (GetTarget().GetProcessSP(), GetState()));
Caroline Tice861efb32010-11-16 05:07:41 +00003026}
3027
3028void
3029Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
3030{
3031 Process *process = (Process *) baton;
3032 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
3033}
3034
3035size_t
3036Process::ProcessInputReaderCallback (void *baton,
3037 InputReader &reader,
3038 lldb::InputReaderAction notification,
3039 const char *bytes,
3040 size_t bytes_len)
3041{
3042 Process *process = (Process *) baton;
3043
3044 switch (notification)
3045 {
3046 case eInputReaderActivate:
3047 break;
3048
3049 case eInputReaderDeactivate:
3050 break;
3051
3052 case eInputReaderReactivate:
3053 break;
3054
Caroline Tice4a348082011-05-02 20:41:46 +00003055 case eInputReaderAsynchronousOutputWritten:
3056 break;
3057
Caroline Tice861efb32010-11-16 05:07:41 +00003058 case eInputReaderGotToken:
3059 {
3060 Error error;
3061 process->PutSTDIN (bytes, bytes_len, error);
3062 }
3063 break;
3064
Caroline Ticec4f55fe2010-11-19 20:47:54 +00003065 case eInputReaderInterrupt:
3066 process->Halt ();
3067 break;
3068
3069 case eInputReaderEndOfFile:
3070 process->AppendSTDOUT ("^D", 2);
3071 break;
3072
Caroline Tice861efb32010-11-16 05:07:41 +00003073 case eInputReaderDone:
3074 break;
3075
3076 }
3077
3078 return bytes_len;
3079}
3080
3081void
3082Process::ResetProcessInputReader ()
3083{
3084 m_process_input_reader.reset();
3085}
3086
3087void
3088Process::SetUpProcessInputReader (int file_descriptor)
3089{
3090 // First set up the Read Thread for reading/handling process I/O
3091
3092 std::auto_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (file_descriptor, true));
3093
3094 if (conn_ap.get())
3095 {
3096 m_stdio_communication.SetConnection (conn_ap.release());
3097 if (m_stdio_communication.IsConnected())
3098 {
3099 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
3100 m_stdio_communication.StartReadThread();
3101
3102 // Now read thread is set up, set up input reader.
3103
3104 if (!m_process_input_reader.get())
3105 {
3106 m_process_input_reader.reset (new InputReader(m_target.GetDebugger()));
3107 Error err (m_process_input_reader->Initialize (Process::ProcessInputReaderCallback,
3108 this,
3109 eInputReaderGranularityByte,
3110 NULL,
3111 NULL,
3112 false));
3113
3114 if (err.Fail())
3115 m_process_input_reader.reset();
3116 }
3117 }
3118 }
3119}
3120
3121void
3122Process::PushProcessInputReader ()
3123{
3124 if (m_process_input_reader && !m_process_input_reader->IsActive())
3125 m_target.GetDebugger().PushInputReader (m_process_input_reader);
3126}
3127
3128void
3129Process::PopProcessInputReader ()
3130{
3131 if (m_process_input_reader && m_process_input_reader->IsActive())
3132 m_target.GetDebugger().PopInputReader (m_process_input_reader);
3133}
3134
Greg Claytond284b662011-02-18 01:44:25 +00003135// The process needs to know about installed plug-ins
Greg Clayton990de7b2010-11-18 23:32:35 +00003136void
Caroline Tice2a456812011-03-10 22:14:10 +00003137Process::SettingsInitialize ()
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003138{
Greg Claytonb3448432011-03-24 21:19:54 +00003139 static std::vector<OptionEnumValueElement> g_plugins;
Greg Claytond284b662011-02-18 01:44:25 +00003140
3141 int i=0;
3142 const char *name;
3143 OptionEnumValueElement option_enum;
3144 while ((name = PluginManager::GetProcessPluginNameAtIndex (i)) != NULL)
3145 {
3146 if (name)
3147 {
3148 option_enum.value = i;
3149 option_enum.string_value = name;
3150 option_enum.usage = PluginManager::GetProcessPluginDescriptionAtIndex (i);
3151 g_plugins.push_back (option_enum);
3152 }
3153 ++i;
3154 }
3155 option_enum.value = 0;
3156 option_enum.string_value = NULL;
3157 option_enum.usage = NULL;
3158 g_plugins.push_back (option_enum);
3159
3160 for (i=0; (name = SettingsController::instance_settings_table[i].var_name); ++i)
3161 {
3162 if (::strcmp (name, "plugin") == 0)
3163 {
3164 SettingsController::instance_settings_table[i].enum_values = &g_plugins[0];
3165 break;
3166 }
3167 }
Greg Clayton990de7b2010-11-18 23:32:35 +00003168 UserSettingsControllerSP &usc = GetSettingsController();
3169 usc.reset (new SettingsController);
3170 UserSettingsController::InitializeSettingsController (usc,
3171 SettingsController::global_settings_table,
3172 SettingsController::instance_settings_table);
Caroline Tice2a456812011-03-10 22:14:10 +00003173
3174 // Now call SettingsInitialize() for each 'child' of Process settings
3175 Thread::SettingsInitialize ();
Greg Clayton990de7b2010-11-18 23:32:35 +00003176}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003177
Greg Clayton990de7b2010-11-18 23:32:35 +00003178void
Caroline Tice2a456812011-03-10 22:14:10 +00003179Process::SettingsTerminate ()
Greg Claytond284b662011-02-18 01:44:25 +00003180{
Caroline Tice2a456812011-03-10 22:14:10 +00003181 // Must call SettingsTerminate() on each 'child' of Process settings before terminating Process settings.
3182
3183 Thread::SettingsTerminate ();
3184
3185 // Now terminate Process Settings.
3186
Greg Clayton990de7b2010-11-18 23:32:35 +00003187 UserSettingsControllerSP &usc = GetSettingsController();
3188 UserSettingsController::FinalizeSettingsController (usc);
3189 usc.reset();
3190}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003191
Greg Clayton990de7b2010-11-18 23:32:35 +00003192UserSettingsControllerSP &
3193Process::GetSettingsController ()
3194{
3195 static UserSettingsControllerSP g_settings_controller;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003196 return g_settings_controller;
3197}
3198
Caroline Tice1ebef442010-09-27 00:30:10 +00003199void
3200Process::UpdateInstanceName ()
3201{
3202 ModuleSP module_sp = GetTarget().GetExecutableModule();
3203 if (module_sp)
3204 {
3205 StreamString sstr;
3206 sstr.Printf ("%s", module_sp->GetFileSpec().GetFilename().AsCString());
3207
Greg Claytonc0c1b0c2010-11-19 03:46:01 +00003208 GetSettingsController()->RenameInstanceSettings (GetInstanceName().AsCString(),
Greg Claytonb72d0f02011-04-12 05:54:46 +00003209 sstr.GetData());
Caroline Tice1ebef442010-09-27 00:30:10 +00003210 }
3211}
3212
Greg Clayton427f2902010-12-14 02:59:59 +00003213ExecutionResults
Jim Ingham360f53f2010-11-30 02:22:11 +00003214Process::RunThreadPlan (ExecutionContext &exe_ctx,
3215 lldb::ThreadPlanSP &thread_plan_sp,
3216 bool stop_others,
3217 bool try_all_threads,
3218 bool discard_on_error,
3219 uint32_t single_thread_timeout_usec,
3220 Stream &errors)
3221{
3222 ExecutionResults return_value = eExecutionSetupError;
3223
Jim Ingham15dcb7c2011-01-20 02:03:18 +00003224 if (thread_plan_sp.get() == NULL)
3225 {
3226 errors.Printf("RunThreadPlan called with empty thread plan.");
Greg Claytonb3448432011-03-24 21:19:54 +00003227 return eExecutionSetupError;
Jim Ingham15dcb7c2011-01-20 02:03:18 +00003228 }
3229
Jim Ingham5ab7fba2011-05-17 22:24:54 +00003230 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
3231 // For that to be true the plan can't be private - since private plans suppress themselves in the
3232 // GetCompletedPlan call.
3233
3234 bool orig_plan_private = thread_plan_sp->GetPrivate();
3235 thread_plan_sp->SetPrivate(false);
3236
Jim Inghamac959662011-01-24 06:34:17 +00003237 if (m_private_state.GetValue() != eStateStopped)
3238 {
3239 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Greg Claytonb3448432011-03-24 21:19:54 +00003240 return eExecutionSetupError;
Jim Inghamac959662011-01-24 06:34:17 +00003241 }
3242
Jim Ingham360f53f2010-11-30 02:22:11 +00003243 // Save this value for restoration of the execution context after we run
Greg Clayton265ab332011-05-19 18:17:41 +00003244 const uint32_t thread_idx_id = exe_ctx.thread->GetIndexID();
Jim Ingham360f53f2010-11-30 02:22:11 +00003245
3246 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
3247 // so we should arrange to reset them as well.
3248
3249 lldb::ThreadSP selected_thread_sp = exe_ctx.process->GetThreadList().GetSelectedThread();
3250 lldb::StackFrameSP selected_frame_sp;
3251
3252 uint32_t selected_tid;
3253 if (selected_thread_sp != NULL)
3254 {
3255 selected_tid = selected_thread_sp->GetIndexID();
3256 selected_frame_sp = selected_thread_sp->GetSelectedFrame();
3257 }
3258 else
3259 {
3260 selected_tid = LLDB_INVALID_THREAD_ID;
3261 }
3262
3263 exe_ctx.thread->QueueThreadPlan(thread_plan_sp, true);
3264
Jim Ingham6ae318c2011-01-23 21:14:08 +00003265 Listener listener("lldb.process.listener.run-thread-plan");
Jim Inghamf9f40c22011-02-08 05:20:59 +00003266
3267 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
3268 // restored on exit to the function.
3269
3270 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Jim Inghamac959662011-01-24 06:34:17 +00003271
Jim Ingham6ae318c2011-01-23 21:14:08 +00003272 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham15dcb7c2011-01-20 02:03:18 +00003273 if (log)
3274 {
3275 StreamString s;
3276 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Jim Inghamf9f40c22011-02-08 05:20:59 +00003277 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4x to run thread plan \"%s\".",
3278 exe_ctx.thread->GetIndexID(),
3279 exe_ctx.thread->GetID(),
3280 s.GetData());
Jim Ingham15dcb7c2011-01-20 02:03:18 +00003281 }
3282
Jim Inghamf9f40c22011-02-08 05:20:59 +00003283 bool got_event;
3284 lldb::EventSP event_sp;
3285 lldb::StateType stop_state = lldb::eStateInvalid;
Jim Ingham360f53f2010-11-30 02:22:11 +00003286
3287 TimeValue* timeout_ptr = NULL;
3288 TimeValue real_timeout;
3289
Jim Inghamf9f40c22011-02-08 05:20:59 +00003290 bool first_timeout = true;
3291 bool do_resume = true;
Jim Ingham360f53f2010-11-30 02:22:11 +00003292
Jim Ingham360f53f2010-11-30 02:22:11 +00003293 while (1)
3294 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003295 // We usually want to resume the process if we get to the top of the loop.
3296 // The only exception is if we get two running events with no intervening
3297 // stop, which can happen, we will just wait for then next stop event.
Jim Ingham360f53f2010-11-30 02:22:11 +00003298
Jim Inghamf9f40c22011-02-08 05:20:59 +00003299 if (do_resume)
Jim Ingham360f53f2010-11-30 02:22:11 +00003300 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003301 // Do the initial resume and wait for the running event before going further.
3302
3303 Error resume_error = exe_ctx.process->Resume ();
3304 if (!resume_error.Success())
3305 {
3306 errors.Printf("Error resuming inferior: \"%s\".\n", resume_error.AsCString());
Greg Claytonb3448432011-03-24 21:19:54 +00003307 return_value = eExecutionSetupError;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003308 break;
3309 }
3310
3311 real_timeout = TimeValue::Now();
3312 real_timeout.OffsetWithMicroSeconds(500000);
3313 timeout_ptr = &real_timeout;
3314
3315 got_event = listener.WaitForEvent(NULL, event_sp);
3316 if (!got_event)
3317 {
3318 if (log)
3319 log->Printf("Didn't get any event after initial resume, exiting.");
3320
3321 errors.Printf("Didn't get any event after initial resume, exiting.");
Greg Claytonb3448432011-03-24 21:19:54 +00003322 return_value = eExecutionSetupError;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003323 break;
3324 }
3325
3326 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3327 if (stop_state != eStateRunning)
3328 {
3329 if (log)
3330 log->Printf("Didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
3331
3332 errors.Printf("Didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
Greg Claytonb3448432011-03-24 21:19:54 +00003333 return_value = eExecutionSetupError;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003334 break;
3335 }
3336
3337 if (log)
3338 log->Printf ("Resuming succeeded.");
3339 // We need to call the function synchronously, so spin waiting for it to return.
3340 // If we get interrupted while executing, we're going to lose our context, and
3341 // won't be able to gather the result at this point.
3342 // We set the timeout AFTER the resume, since the resume takes some time and we
3343 // don't want to charge that to the timeout.
3344
3345 if (single_thread_timeout_usec != 0)
3346 {
3347 real_timeout = TimeValue::Now();
3348 if (first_timeout)
3349 real_timeout.OffsetWithMicroSeconds(single_thread_timeout_usec);
3350 else
3351 real_timeout.OffsetWithSeconds(10);
3352
3353 timeout_ptr = &real_timeout;
3354 }
3355 }
3356 else
3357 {
3358 if (log)
3359 log->Printf ("Handled an extra running event.");
3360 do_resume = true;
3361 }
3362
3363 // Now wait for the process to stop again:
3364 stop_state = lldb::eStateInvalid;
3365 event_sp.reset();
3366 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
3367
3368 if (got_event)
3369 {
3370 if (event_sp.get())
3371 {
3372 bool keep_going = false;
3373 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3374 if (log)
3375 log->Printf("In while loop, got event: %s.", StateAsCString(stop_state));
3376
3377 switch (stop_state)
3378 {
3379 case lldb::eStateStopped:
Jim Ingham2370a972011-05-17 01:10:11 +00003380 {
3381 // Yay, we're done. Now make sure that our thread plan actually completed.
Greg Clayton265ab332011-05-19 18:17:41 +00003382 ThreadSP thread_sp = exe_ctx.process->GetThreadList().FindThreadByIndexID (thread_idx_id);
Jim Ingham2370a972011-05-17 01:10:11 +00003383 if (!thread_sp)
3384 {
3385 // Ooh, our thread has vanished. Unlikely that this was successful execution...
3386 if (log)
Greg Clayton265ab332011-05-19 18:17:41 +00003387 log->Printf ("Execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
Jim Ingham2370a972011-05-17 01:10:11 +00003388 return_value = eExecutionInterrupted;
3389 }
3390 else
3391 {
3392 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
3393 StopReason stop_reason = stop_info_sp->GetStopReason();
3394 if (stop_reason == eStopReasonPlanComplete)
3395 {
3396 if (log)
3397 log->Printf ("Execution completed successfully.");
3398 // Now mark this plan as private so it doesn't get reported as the stop reason
3399 // after this point.
3400 if (thread_plan_sp)
Jim Ingham5ab7fba2011-05-17 22:24:54 +00003401 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Ingham2370a972011-05-17 01:10:11 +00003402 return_value = eExecutionCompleted;
3403 }
3404 else
3405 {
3406 if (log)
3407 log->Printf ("Thread plan didn't successfully complete.");
3408
3409 return_value = eExecutionInterrupted;
3410 }
3411 }
3412 }
3413 break;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003414 case lldb::eStateCrashed:
3415 if (log)
3416 log->Printf ("Execution crashed.");
Greg Claytonb3448432011-03-24 21:19:54 +00003417 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003418 break;
3419 case lldb::eStateRunning:
3420 do_resume = false;
3421 keep_going = true;
3422 break;
3423 default:
3424 if (log)
3425 log->Printf("Execution stopped with unexpected state: %s.", StateAsCString(stop_state));
Jim Ingham2370a972011-05-17 01:10:11 +00003426
3427 errors.Printf ("Execution stopped with unexpected state.");
Greg Claytonb3448432011-03-24 21:19:54 +00003428 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003429 break;
3430 }
3431 if (keep_going)
3432 continue;
3433 else
3434 break;
3435 }
3436 else
3437 {
3438 if (log)
3439 log->Printf ("got_event was true, but the event pointer was null. How odd...");
Greg Claytonb3448432011-03-24 21:19:54 +00003440 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003441 break;
3442 }
3443 }
3444 else
3445 {
3446 // If we didn't get an event that means we've timed out...
3447 // We will interrupt the process here. Depending on what we were asked to do we will
3448 // either exit, or try with all threads running for the same timeout.
Jim Ingham360f53f2010-11-30 02:22:11 +00003449 // Not really sure what to do if Halt fails here...
Jim Inghamf9f40c22011-02-08 05:20:59 +00003450
Stephen Wilsonc2b98252011-01-12 04:20:03 +00003451 if (log) {
Jim Ingham360f53f2010-11-30 02:22:11 +00003452 if (try_all_threads)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003453 {
3454 if (first_timeout)
3455 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
3456 "trying with all threads enabled.",
3457 single_thread_timeout_usec);
3458 else
3459 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
3460 "and timeout: %d timed out.",
3461 single_thread_timeout_usec);
3462 }
Jim Ingham360f53f2010-11-30 02:22:11 +00003463 else
Jim Inghamf9f40c22011-02-08 05:20:59 +00003464 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
3465 "halt and abandoning execution.",
Jim Ingham360f53f2010-11-30 02:22:11 +00003466 single_thread_timeout_usec);
Stephen Wilsonc2b98252011-01-12 04:20:03 +00003467 }
Jim Ingham360f53f2010-11-30 02:22:11 +00003468
Jim Inghamc556b462011-01-22 01:30:53 +00003469 Error halt_error = exe_ctx.process->Halt();
Jim Inghamc556b462011-01-22 01:30:53 +00003470 if (halt_error.Success())
Jim Ingham360f53f2010-11-30 02:22:11 +00003471 {
Jim Ingham360f53f2010-11-30 02:22:11 +00003472 if (log)
Greg Clayton68ca8232011-01-25 02:58:48 +00003473 log->Printf ("Process::RunThreadPlan(): Halt succeeded.");
Jim Ingham360f53f2010-11-30 02:22:11 +00003474
Jim Inghamf9f40c22011-02-08 05:20:59 +00003475 // If halt succeeds, it always produces a stopped event. Wait for that:
3476
3477 real_timeout = TimeValue::Now();
3478 real_timeout.OffsetWithMicroSeconds(500000);
3479
3480 got_event = listener.WaitForEvent(&real_timeout, event_sp);
Jim Ingham360f53f2010-11-30 02:22:11 +00003481
3482 if (got_event)
3483 {
3484 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3485 if (log)
3486 {
Greg Clayton68ca8232011-01-25 02:58:48 +00003487 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
Jim Inghamf9f40c22011-02-08 05:20:59 +00003488 if (stop_state == lldb::eStateStopped
3489 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
Jim Ingham360f53f2010-11-30 02:22:11 +00003490 log->Printf (" Event was the Halt interruption event.");
3491 }
3492
Jim Inghamf9f40c22011-02-08 05:20:59 +00003493 if (stop_state == lldb::eStateStopped)
Jim Ingham360f53f2010-11-30 02:22:11 +00003494 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003495 // Between the time we initiated the Halt and the time we delivered it, the process could have
3496 // already finished its job. Check that here:
Jim Ingham360f53f2010-11-30 02:22:11 +00003497
Jim Inghamf9f40c22011-02-08 05:20:59 +00003498 if (exe_ctx.thread->IsThreadPlanDone (thread_plan_sp.get()))
3499 {
3500 if (log)
3501 log->Printf ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
3502 "Exiting wait loop.");
Greg Claytonb3448432011-03-24 21:19:54 +00003503 return_value = eExecutionCompleted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003504 break;
3505 }
Jim Ingham360f53f2010-11-30 02:22:11 +00003506
Jim Inghamf9f40c22011-02-08 05:20:59 +00003507 if (!try_all_threads)
3508 {
3509 if (log)
3510 log->Printf ("try_all_threads was false, we stopped so now we're quitting.");
Greg Claytonb3448432011-03-24 21:19:54 +00003511 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003512 break;
3513 }
3514
3515 if (first_timeout)
3516 {
3517 // Set all the other threads to run, and return to the top of the loop, which will continue;
3518 first_timeout = false;
3519 thread_plan_sp->SetStopOthers (false);
3520 if (log)
3521 log->Printf ("Process::RunThreadPlan(): About to resume.");
3522
3523 continue;
3524 }
3525 else
3526 {
3527 // Running all threads failed, so return Interrupted.
3528 if (log)
3529 log->Printf("Process::RunThreadPlan(): running all threads timed out.");
Greg Claytonb3448432011-03-24 21:19:54 +00003530 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003531 break;
3532 }
Jim Ingham360f53f2010-11-30 02:22:11 +00003533 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00003534 }
3535 else
3536 { if (log)
3537 log->Printf("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
3538 "I'm getting out of here passing Interrupted.");
Greg Claytonb3448432011-03-24 21:19:54 +00003539 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003540 break;
Jim Ingham360f53f2010-11-30 02:22:11 +00003541 }
3542 }
Jim Inghamc556b462011-01-22 01:30:53 +00003543 else
3544 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003545 // This branch is to work around some problems with gdb-remote's Halt. It is a little racy, and can return
3546 // an error from halt, but if you wait a bit you'll get a stopped event anyway.
Jim Inghamc556b462011-01-22 01:30:53 +00003547 if (log)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003548 log->Printf ("Process::RunThreadPlan(): halt failed: error = \"%s\", I'm just going to wait a little longer and see if I get a stopped event.",
3549 halt_error.AsCString());
3550 real_timeout = TimeValue::Now();
3551 real_timeout.OffsetWithMicroSeconds(500000);
3552 timeout_ptr = &real_timeout;
3553 got_event = listener.WaitForEvent(&real_timeout, event_sp);
3554 if (!got_event || event_sp.get() == NULL)
Jim Ingham6ae318c2011-01-23 21:14:08 +00003555 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003556 // This is not going anywhere, bag out.
3557 if (log)
3558 log->Printf ("Process::RunThreadPlan(): halt failed: and waiting for the stopped event failed.");
Greg Claytonb3448432011-03-24 21:19:54 +00003559 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003560 break;
Jim Ingham6ae318c2011-01-23 21:14:08 +00003561 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00003562 else
3563 {
3564 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3565 if (log)
3566 log->Printf ("Process::RunThreadPlan(): halt failed: but then I got a stopped event. Whatever...");
3567 if (stop_state == lldb::eStateStopped)
3568 {
3569 // Between the time we initiated the Halt and the time we delivered it, the process could have
3570 // already finished its job. Check that here:
3571
3572 if (exe_ctx.thread->IsThreadPlanDone (thread_plan_sp.get()))
3573 {
3574 if (log)
3575 log->Printf ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
3576 "Exiting wait loop.");
Greg Claytonb3448432011-03-24 21:19:54 +00003577 return_value = eExecutionCompleted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003578 break;
3579 }
3580
3581 if (first_timeout)
3582 {
3583 // Set all the other threads to run, and return to the top of the loop, which will continue;
3584 first_timeout = false;
3585 thread_plan_sp->SetStopOthers (false);
3586 if (log)
3587 log->Printf ("Process::RunThreadPlan(): About to resume.");
3588
3589 continue;
3590 }
3591 else
3592 {
3593 // Running all threads failed, so return Interrupted.
3594 if (log)
3595 log->Printf("Process::RunThreadPlan(): running all threads timed out.");
Greg Claytonb3448432011-03-24 21:19:54 +00003596 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003597 break;
3598 }
3599 }
3600 else
3601 {
3602 log->Printf ("Process::RunThreadPlan(): halt failed, I waited and didn't get"
3603 " a stopped event, instead got %s.", StateAsCString(stop_state));
Greg Claytonb3448432011-03-24 21:19:54 +00003604 return_value = eExecutionInterrupted;
Jim Inghamf9f40c22011-02-08 05:20:59 +00003605 break;
3606 }
3607 }
Jim Inghamc556b462011-01-22 01:30:53 +00003608 }
3609
Jim Ingham360f53f2010-11-30 02:22:11 +00003610 }
3611
Jim Inghamf9f40c22011-02-08 05:20:59 +00003612 } // END WAIT LOOP
3613
3614 // Now do some processing on the results of the run:
3615 if (return_value == eExecutionInterrupted)
3616 {
Jim Ingham360f53f2010-11-30 02:22:11 +00003617 if (log)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003618 {
3619 StreamString s;
3620 if (event_sp)
3621 event_sp->Dump (&s);
3622 else
3623 {
3624 log->Printf ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
3625 }
3626
3627 StreamString ts;
3628
3629 const char *event_explanation;
3630
3631 do
3632 {
3633 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
3634
3635 if (!event_data)
3636 {
3637 event_explanation = "<no event data>";
3638 break;
3639 }
3640
3641 Process *process = event_data->GetProcessSP().get();
3642
3643 if (!process)
3644 {
3645 event_explanation = "<no process>";
3646 break;
3647 }
3648
3649 ThreadList &thread_list = process->GetThreadList();
3650
3651 uint32_t num_threads = thread_list.GetSize();
3652 uint32_t thread_index;
3653
3654 ts.Printf("<%u threads> ", num_threads);
3655
3656 for (thread_index = 0;
3657 thread_index < num_threads;
3658 ++thread_index)
3659 {
3660 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
3661
3662 if (!thread)
3663 {
3664 ts.Printf("<?> ");
3665 continue;
3666 }
3667
3668 ts.Printf("<0x%4.4x ", thread->GetID());
3669 RegisterContext *register_context = thread->GetRegisterContext().get();
3670
3671 if (register_context)
3672 ts.Printf("[ip 0x%llx] ", register_context->GetPC());
3673 else
3674 ts.Printf("[ip unknown] ");
3675
3676 lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
3677 if (stop_info_sp)
3678 {
3679 const char *stop_desc = stop_info_sp->GetDescription();
3680 if (stop_desc)
3681 ts.PutCString (stop_desc);
3682 }
3683 ts.Printf(">");
3684 }
3685
3686 event_explanation = ts.GetData();
3687 } while (0);
3688
3689 if (log)
3690 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
3691
3692 if (discard_on_error && thread_plan_sp)
3693 {
3694 exe_ctx.thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
3695 }
3696 }
3697 }
3698 else if (return_value == eExecutionSetupError)
3699 {
3700 if (log)
3701 log->Printf("Process::RunThreadPlan(): execution set up error.");
3702
3703 if (discard_on_error && thread_plan_sp)
3704 {
3705 exe_ctx.thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
3706 }
3707 }
3708 else
3709 {
Jim Ingham360f53f2010-11-30 02:22:11 +00003710 if (exe_ctx.thread->IsThreadPlanDone (thread_plan_sp.get()))
3711 {
Greg Clayton68ca8232011-01-25 02:58:48 +00003712 if (log)
3713 log->Printf("Process::RunThreadPlan(): thread plan is done");
Greg Claytonb3448432011-03-24 21:19:54 +00003714 return_value = eExecutionCompleted;
Jim Ingham360f53f2010-11-30 02:22:11 +00003715 }
3716 else if (exe_ctx.thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
3717 {
Greg Clayton68ca8232011-01-25 02:58:48 +00003718 if (log)
3719 log->Printf("Process::RunThreadPlan(): thread plan was discarded");
Greg Claytonb3448432011-03-24 21:19:54 +00003720 return_value = eExecutionDiscarded;
Jim Ingham360f53f2010-11-30 02:22:11 +00003721 }
3722 else
3723 {
3724 if (log)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003725 log->Printf("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Ingham360f53f2010-11-30 02:22:11 +00003726 if (discard_on_error && thread_plan_sp)
3727 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003728 if (log)
3729 log->Printf("Process::RunThreadPlan(): discarding thread plan 'cause discard_on_error is set.");
Jim Ingham360f53f2010-11-30 02:22:11 +00003730 exe_ctx.thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
3731 }
Jim Ingham360f53f2010-11-30 02:22:11 +00003732 }
3733 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00003734
Jim Ingham360f53f2010-11-30 02:22:11 +00003735 // Thread we ran the function in may have gone away because we ran the target
3736 // Check that it's still there.
Greg Clayton265ab332011-05-19 18:17:41 +00003737 exe_ctx.thread = exe_ctx.process->GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
Jim Ingham360f53f2010-11-30 02:22:11 +00003738 if (exe_ctx.thread)
3739 exe_ctx.frame = exe_ctx.thread->GetStackFrameAtIndex(0).get();
3740
3741 // Also restore the current process'es selected frame & thread, since this function calling may
3742 // be done behind the user's back.
3743
3744 if (selected_tid != LLDB_INVALID_THREAD_ID)
3745 {
3746 if (exe_ctx.process->GetThreadList().SetSelectedThreadByIndexID (selected_tid))
3747 {
3748 // We were able to restore the selected thread, now restore the frame:
3749 exe_ctx.process->GetThreadList().GetSelectedThread()->SetSelectedFrame(selected_frame_sp.get());
3750 }
3751 }
3752
3753 return return_value;
3754}
3755
3756const char *
3757Process::ExecutionResultAsCString (ExecutionResults result)
3758{
3759 const char *result_name;
3760
3761 switch (result)
3762 {
Greg Claytonb3448432011-03-24 21:19:54 +00003763 case eExecutionCompleted:
Jim Ingham360f53f2010-11-30 02:22:11 +00003764 result_name = "eExecutionCompleted";
3765 break;
Greg Claytonb3448432011-03-24 21:19:54 +00003766 case eExecutionDiscarded:
Jim Ingham360f53f2010-11-30 02:22:11 +00003767 result_name = "eExecutionDiscarded";
3768 break;
Greg Claytonb3448432011-03-24 21:19:54 +00003769 case eExecutionInterrupted:
Jim Ingham360f53f2010-11-30 02:22:11 +00003770 result_name = "eExecutionInterrupted";
3771 break;
Greg Claytonb3448432011-03-24 21:19:54 +00003772 case eExecutionSetupError:
Jim Ingham360f53f2010-11-30 02:22:11 +00003773 result_name = "eExecutionSetupError";
3774 break;
Greg Claytonb3448432011-03-24 21:19:54 +00003775 case eExecutionTimedOut:
Jim Ingham360f53f2010-11-30 02:22:11 +00003776 result_name = "eExecutionTimedOut";
3777 break;
3778 }
3779 return result_name;
3780}
3781
Greg Claytonabe0fed2011-04-18 08:33:37 +00003782void
3783Process::GetStatus (Stream &strm)
3784{
3785 const StateType state = GetState();
3786 if (StateIsStoppedState(state))
3787 {
3788 if (state == eStateExited)
3789 {
3790 int exit_status = GetExitStatus();
3791 const char *exit_description = GetExitDescription();
3792 strm.Printf ("Process %d exited with status = %i (0x%8.8x) %s\n",
3793 GetID(),
3794 exit_status,
3795 exit_status,
3796 exit_description ? exit_description : "");
3797 }
3798 else
3799 {
3800 if (state == eStateConnected)
3801 strm.Printf ("Connected to remote target.\n");
3802 else
3803 strm.Printf ("Process %d %s\n", GetID(), StateAsCString (state));
3804 }
3805 }
3806 else
3807 {
3808 strm.Printf ("Process %d is running.\n", GetID());
3809 }
3810}
3811
3812size_t
3813Process::GetThreadStatus (Stream &strm,
3814 bool only_threads_with_stop_reason,
3815 uint32_t start_frame,
3816 uint32_t num_frames,
3817 uint32_t num_frames_with_source)
3818{
3819 size_t num_thread_infos_dumped = 0;
3820
3821 const size_t num_threads = GetThreadList().GetSize();
3822 for (uint32_t i = 0; i < num_threads; i++)
3823 {
3824 Thread *thread = GetThreadList().GetThreadAtIndex(i).get();
3825 if (thread)
3826 {
3827 if (only_threads_with_stop_reason)
3828 {
3829 if (thread->GetStopInfo().get() == NULL)
3830 continue;
3831 }
3832 thread->GetStatus (strm,
3833 start_frame,
3834 num_frames,
3835 num_frames_with_source);
3836 ++num_thread_infos_dumped;
3837 }
3838 }
3839 return num_thread_infos_dumped;
3840}
3841
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003842//--------------------------------------------------------------
Greg Claytond0a5a232010-09-19 02:33:57 +00003843// class Process::SettingsController
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003844//--------------------------------------------------------------
3845
Greg Claytond0a5a232010-09-19 02:33:57 +00003846Process::SettingsController::SettingsController () :
Caroline Tice5bc8c972010-09-20 20:44:43 +00003847 UserSettingsController ("process", Target::GetSettingsController())
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003848{
Greg Clayton638351a2010-12-04 00:10:17 +00003849 m_default_settings.reset (new ProcessInstanceSettings (*this,
3850 false,
Caroline Tice004afcb2010-09-08 17:48:55 +00003851 InstanceSettings::GetDefaultName().AsCString()));
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003852}
3853
Greg Claytond0a5a232010-09-19 02:33:57 +00003854Process::SettingsController::~SettingsController ()
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003855{
3856}
3857
3858lldb::InstanceSettingsSP
Greg Claytond0a5a232010-09-19 02:33:57 +00003859Process::SettingsController::CreateInstanceSettings (const char *instance_name)
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003860{
Greg Claytonc0c1b0c2010-11-19 03:46:01 +00003861 ProcessInstanceSettings *new_settings = new ProcessInstanceSettings (*GetSettingsController(),
3862 false,
3863 instance_name);
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003864 lldb::InstanceSettingsSP new_settings_sp (new_settings);
3865 return new_settings_sp;
3866}
3867
3868//--------------------------------------------------------------
3869// class ProcessInstanceSettings
3870//--------------------------------------------------------------
3871
Greg Clayton638351a2010-12-04 00:10:17 +00003872ProcessInstanceSettings::ProcessInstanceSettings
3873(
3874 UserSettingsController &owner,
3875 bool live_instance,
3876 const char *name
3877) :
3878 InstanceSettings (owner, name ? name : InstanceSettings::InvalidName().AsCString(), live_instance),
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003879 m_run_args (),
3880 m_env_vars (),
3881 m_input_path (),
3882 m_output_path (),
3883 m_error_path (),
Caroline Ticebd666012010-12-03 18:46:09 +00003884 m_disable_aslr (true),
Greg Clayton638351a2010-12-04 00:10:17 +00003885 m_disable_stdio (false),
3886 m_inherit_host_env (true),
3887 m_got_host_env (false)
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003888{
Caroline Tice396704b2010-09-09 18:26:37 +00003889 // CopyInstanceSettings is a pure virtual function in InstanceSettings; it therefore cannot be called
3890 // until the vtables for ProcessInstanceSettings are properly set up, i.e. AFTER all the initializers.
3891 // For this reason it has to be called here, rather than in the initializer or in the parent constructor.
Caroline Tice75b11a32010-09-16 19:05:55 +00003892 // This is true for CreateInstanceName() too.
3893
3894 if (GetInstanceName () == InstanceSettings::InvalidName())
3895 {
3896 ChangeInstanceName (std::string (CreateInstanceName().AsCString()));
3897 m_owner.RegisterInstanceSettings (this);
3898 }
Caroline Tice396704b2010-09-09 18:26:37 +00003899
3900 if (live_instance)
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003901 {
3902 const lldb::InstanceSettingsSP &pending_settings = m_owner.FindPendingSettings (m_instance_name);
3903 CopyInstanceSettings (pending_settings,false);
Caroline Tice396704b2010-09-09 18:26:37 +00003904 //m_owner.RemovePendingSettings (m_instance_name);
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003905 }
3906}
3907
3908ProcessInstanceSettings::ProcessInstanceSettings (const ProcessInstanceSettings &rhs) :
Greg Claytonc0c1b0c2010-11-19 03:46:01 +00003909 InstanceSettings (*Process::GetSettingsController(), CreateInstanceName().AsCString()),
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003910 m_run_args (rhs.m_run_args),
3911 m_env_vars (rhs.m_env_vars),
3912 m_input_path (rhs.m_input_path),
3913 m_output_path (rhs.m_output_path),
3914 m_error_path (rhs.m_error_path),
Caroline Ticebd666012010-12-03 18:46:09 +00003915 m_disable_aslr (rhs.m_disable_aslr),
3916 m_disable_stdio (rhs.m_disable_stdio)
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003917{
3918 if (m_instance_name != InstanceSettings::GetDefaultName())
3919 {
3920 const lldb::InstanceSettingsSP &pending_settings = m_owner.FindPendingSettings (m_instance_name);
3921 CopyInstanceSettings (pending_settings,false);
3922 m_owner.RemovePendingSettings (m_instance_name);
3923 }
3924}
3925
3926ProcessInstanceSettings::~ProcessInstanceSettings ()
3927{
3928}
3929
3930ProcessInstanceSettings&
3931ProcessInstanceSettings::operator= (const ProcessInstanceSettings &rhs)
3932{
3933 if (this != &rhs)
3934 {
3935 m_run_args = rhs.m_run_args;
3936 m_env_vars = rhs.m_env_vars;
3937 m_input_path = rhs.m_input_path;
3938 m_output_path = rhs.m_output_path;
3939 m_error_path = rhs.m_error_path;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003940 m_disable_aslr = rhs.m_disable_aslr;
Caroline Ticebd666012010-12-03 18:46:09 +00003941 m_disable_stdio = rhs.m_disable_stdio;
Greg Clayton638351a2010-12-04 00:10:17 +00003942 m_inherit_host_env = rhs.m_inherit_host_env;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003943 }
3944
3945 return *this;
3946}
3947
3948
3949void
3950ProcessInstanceSettings::UpdateInstanceSettingsVariable (const ConstString &var_name,
3951 const char *index_value,
3952 const char *value,
3953 const ConstString &instance_name,
3954 const SettingEntry &entry,
Greg Claytonb3448432011-03-24 21:19:54 +00003955 VarSetOperationType op,
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003956 Error &err,
3957 bool pending)
3958{
3959 if (var_name == RunArgsVarName())
3960 UserSettingsController::UpdateStringArrayVariable (op, index_value, m_run_args, value, err);
3961 else if (var_name == EnvVarsVarName())
Greg Clayton638351a2010-12-04 00:10:17 +00003962 {
Greg Claytonb72d0f02011-04-12 05:54:46 +00003963 // This is nice for local debugging, but it is isn't correct for
3964 // remote debugging. We need to stop process.env-vars from being
3965 // populated with the host environment and add this as a launch option
3966 // and get the correct environment from the Target's platform.
3967 // GetHostEnvironmentIfNeeded ();
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003968 UserSettingsController::UpdateDictionaryVariable (op, index_value, m_env_vars, value, err);
Greg Clayton638351a2010-12-04 00:10:17 +00003969 }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003970 else if (var_name == InputPathVarName())
3971 UserSettingsController::UpdateStringVariable (op, m_input_path, value, err);
3972 else if (var_name == OutputPathVarName())
3973 UserSettingsController::UpdateStringVariable (op, m_output_path, value, err);
3974 else if (var_name == ErrorPathVarName())
3975 UserSettingsController::UpdateStringVariable (op, m_error_path, value, err);
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003976 else if (var_name == DisableASLRVarName())
Greg Clayton17cd9952011-04-22 03:55:06 +00003977 UserSettingsController::UpdateBooleanVariable (op, m_disable_aslr, value, true, err);
Caroline Ticebd666012010-12-03 18:46:09 +00003978 else if (var_name == DisableSTDIOVarName ())
Greg Clayton17cd9952011-04-22 03:55:06 +00003979 UserSettingsController::UpdateBooleanVariable (op, m_disable_stdio, value, false, err);
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003980}
3981
3982void
3983ProcessInstanceSettings::CopyInstanceSettings (const lldb::InstanceSettingsSP &new_settings,
3984 bool pending)
3985{
3986 if (new_settings.get() == NULL)
3987 return;
3988
3989 ProcessInstanceSettings *new_process_settings = (ProcessInstanceSettings *) new_settings.get();
3990
3991 m_run_args = new_process_settings->m_run_args;
3992 m_env_vars = new_process_settings->m_env_vars;
3993 m_input_path = new_process_settings->m_input_path;
3994 m_output_path = new_process_settings->m_output_path;
3995 m_error_path = new_process_settings->m_error_path;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003996 m_disable_aslr = new_process_settings->m_disable_aslr;
Caroline Ticebd666012010-12-03 18:46:09 +00003997 m_disable_stdio = new_process_settings->m_disable_stdio;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00003998}
3999
Caroline Ticebcb5b452010-09-20 21:37:42 +00004000bool
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004001ProcessInstanceSettings::GetInstanceSettingsValue (const SettingEntry &entry,
4002 const ConstString &var_name,
Caroline Tice5bc8c972010-09-20 20:44:43 +00004003 StringList &value,
Caroline Ticebcb5b452010-09-20 21:37:42 +00004004 Error *err)
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004005{
4006 if (var_name == RunArgsVarName())
4007 {
4008 if (m_run_args.GetArgumentCount() > 0)
Greg Claytonc14069e2010-09-14 03:47:41 +00004009 {
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004010 for (int i = 0; i < m_run_args.GetArgumentCount(); ++i)
4011 value.AppendString (m_run_args.GetArgumentAtIndex (i));
Greg Claytonc14069e2010-09-14 03:47:41 +00004012 }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004013 }
4014 else if (var_name == EnvVarsVarName())
4015 {
Greg Clayton638351a2010-12-04 00:10:17 +00004016 GetHostEnvironmentIfNeeded ();
4017
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004018 if (m_env_vars.size() > 0)
4019 {
4020 std::map<std::string, std::string>::iterator pos;
4021 for (pos = m_env_vars.begin(); pos != m_env_vars.end(); ++pos)
4022 {
4023 StreamString value_str;
4024 value_str.Printf ("%s=%s", pos->first.c_str(), pos->second.c_str());
4025 value.AppendString (value_str.GetData());
4026 }
4027 }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004028 }
4029 else if (var_name == InputPathVarName())
4030 {
4031 value.AppendString (m_input_path.c_str());
4032 }
4033 else if (var_name == OutputPathVarName())
4034 {
4035 value.AppendString (m_output_path.c_str());
4036 }
4037 else if (var_name == ErrorPathVarName())
4038 {
4039 value.AppendString (m_error_path.c_str());
4040 }
Greg Claytona99b0bf2010-12-04 00:12:24 +00004041 else if (var_name == InheritHostEnvVarName())
4042 {
4043 if (m_inherit_host_env)
4044 value.AppendString ("true");
4045 else
4046 value.AppendString ("false");
4047 }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004048 else if (var_name == DisableASLRVarName())
4049 {
4050 if (m_disable_aslr)
4051 value.AppendString ("true");
4052 else
4053 value.AppendString ("false");
4054 }
Caroline Ticebd666012010-12-03 18:46:09 +00004055 else if (var_name == DisableSTDIOVarName())
4056 {
4057 if (m_disable_stdio)
4058 value.AppendString ("true");
4059 else
4060 value.AppendString ("false");
4061 }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004062 else
Caroline Ticebcb5b452010-09-20 21:37:42 +00004063 {
4064 if (err)
4065 err->SetErrorStringWithFormat ("unrecognized variable name '%s'", var_name.AsCString());
4066 return false;
4067 }
4068 return true;
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004069}
4070
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004071const ConstString
4072ProcessInstanceSettings::CreateInstanceName ()
4073{
4074 static int instance_count = 1;
4075 StreamString sstr;
4076
4077 sstr.Printf ("process_%d", instance_count);
4078 ++instance_count;
4079
4080 const ConstString ret_val (sstr.GetData());
4081 return ret_val;
4082}
4083
4084const ConstString &
4085ProcessInstanceSettings::RunArgsVarName ()
4086{
4087 static ConstString run_args_var_name ("run-args");
4088
4089 return run_args_var_name;
4090}
4091
4092const ConstString &
4093ProcessInstanceSettings::EnvVarsVarName ()
4094{
4095 static ConstString env_vars_var_name ("env-vars");
4096
4097 return env_vars_var_name;
4098}
4099
4100const ConstString &
Greg Clayton638351a2010-12-04 00:10:17 +00004101ProcessInstanceSettings::InheritHostEnvVarName ()
4102{
4103 static ConstString g_name ("inherit-env");
4104
4105 return g_name;
4106}
4107
4108const ConstString &
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004109ProcessInstanceSettings::InputPathVarName ()
4110{
4111 static ConstString input_path_var_name ("input-path");
4112
4113 return input_path_var_name;
4114}
4115
4116const ConstString &
4117ProcessInstanceSettings::OutputPathVarName ()
4118{
Caroline Tice87097232010-09-07 18:35:40 +00004119 static ConstString output_path_var_name ("output-path");
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004120
4121 return output_path_var_name;
4122}
4123
4124const ConstString &
4125ProcessInstanceSettings::ErrorPathVarName ()
4126{
Caroline Tice87097232010-09-07 18:35:40 +00004127 static ConstString error_path_var_name ("error-path");
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004128
4129 return error_path_var_name;
4130}
4131
4132const ConstString &
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004133ProcessInstanceSettings::DisableASLRVarName ()
4134{
4135 static ConstString disable_aslr_var_name ("disable-aslr");
4136
4137 return disable_aslr_var_name;
4138}
4139
Caroline Ticebd666012010-12-03 18:46:09 +00004140const ConstString &
4141ProcessInstanceSettings::DisableSTDIOVarName ()
4142{
4143 static ConstString disable_stdio_var_name ("disable-stdio");
4144
4145 return disable_stdio_var_name;
4146}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004147
4148//--------------------------------------------------
Greg Claytond0a5a232010-09-19 02:33:57 +00004149// SettingsController Variable Tables
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004150//--------------------------------------------------
4151
4152SettingEntry
Greg Claytond0a5a232010-09-19 02:33:57 +00004153Process::SettingsController::global_settings_table[] =
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004154{
4155 //{ "var-name", var-type , "default", enum-table, init'd, hidden, "help-text"},
4156 { NULL, eSetVarTypeNone, NULL, NULL, 0, 0, NULL }
4157};
4158
4159
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004160SettingEntry
Greg Claytond0a5a232010-09-19 02:33:57 +00004161Process::SettingsController::instance_settings_table[] =
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004162{
Greg Clayton638351a2010-12-04 00:10:17 +00004163 //{ "var-name", var-type, "default", enum-table, init'd, hidden, "help-text"},
4164 { "run-args", eSetVarTypeArray, NULL, NULL, false, false, "A list containing all the arguments to be passed to the executable when it is run." },
4165 { "env-vars", eSetVarTypeDictionary, NULL, NULL, false, false, "A list of all the environment variables to be passed to the executable's environment, and their values." },
4166 { "inherit-env", eSetVarTypeBoolean, "true", NULL, false, false, "Inherit the environment from the process that is running LLDB." },
Greg Claytonde915be2011-01-23 05:56:20 +00004167 { "input-path", eSetVarTypeString, NULL, NULL, false, false, "The file/path to be used by the executable program for reading its input." },
4168 { "output-path", eSetVarTypeString, NULL, NULL, false, false, "The file/path to be used by the executable program for writing its output." },
4169 { "error-path", eSetVarTypeString, NULL, NULL, false, false, "The file/path to be used by the executable program for writings its error messages." },
Greg Claytond284b662011-02-18 01:44:25 +00004170 { "plugin", eSetVarTypeEnum, NULL, NULL, false, false, "The plugin to be used to run the process." },
Greg Clayton638351a2010-12-04 00:10:17 +00004171 { "disable-aslr", eSetVarTypeBoolean, "true", NULL, false, false, "Disable Address Space Layout Randomization (ASLR)" },
4172 { "disable-stdio", eSetVarTypeBoolean, "false", NULL, false, false, "Disable stdin/stdout for process (e.g. for a GUI application)" },
4173 { NULL, eSetVarTypeNone, NULL, NULL, false, false, NULL }
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004174};
4175
4176
Jim Ingham7508e732010-08-09 23:31:02 +00004177