1 //===-- ProcessPOSIX.cpp ----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
16 // Other libraries and framework includes
17 #include "lldb/Breakpoint/Watchpoint.h"
18 #include "lldb/Core/Module.h"
19 #include "lldb/Core/PluginManager.h"
20 #include "lldb/Core/State.h"
21 #include "lldb/Host/FileSpec.h"
22 #include "lldb/Host/Host.h"
23 #include "lldb/Symbol/ObjectFile.h"
24 #include "lldb/Target/DynamicLoader.h"
25 #include "lldb/Target/Platform.h"
26 #include "lldb/Target/Target.h"
28 #include "ProcessPOSIX.h"
29 #include "ProcessPOSIXLog.h"
30 #include "Plugins/Process/Utility/InferiorCallPOSIX.h"
31 #include "ProcessMonitor.h"
32 #include "POSIXThread.h"
35 using namespace lldb_private;
37 //------------------------------------------------------------------------------
41 ProcessPOSIX::CreateInstance(Target& target, Listener &listener)
43 return new ProcessPOSIX(target, listener);
48 ProcessPOSIX::Initialize()
50 static bool g_initialized = false;
55 PluginManager::RegisterPlugin(GetPluginNameStatic(),
56 GetPluginDescriptionStatic(),
59 Log::Callbacks log_callbacks = {
60 ProcessPOSIXLog::DisableLog,
61 ProcessPOSIXLog::EnableLog,
62 ProcessPOSIXLog::ListLogCategories
65 Log::RegisterLogChannel (ProcessPOSIX::GetPluginNameStatic(), log_callbacks);
70 //------------------------------------------------------------------------------
71 // Constructors and destructors.
73 ProcessPOSIX::ProcessPOSIX(Target& target, Listener &listener)
74 : Process(target, listener),
75 m_byte_order(lldb::endian::InlHostByteOrder()),
78 m_message_mutex (Mutex::eMutexTypeRecursive),
82 // FIXME: Putting this code in the ctor and saving the byte order in a
83 // member variable is a hack to avoid const qual issues in GetByteOrder.
84 lldb::ModuleSP module = GetTarget().GetExecutableModule();
85 if (module && module->GetObjectFile())
86 m_byte_order = module->GetObjectFile()->GetByteOrder();
89 ProcessPOSIX::~ProcessPOSIX()
94 //------------------------------------------------------------------------------
97 ProcessPOSIX::Finalize()
102 m_monitor->StopMonitor();
106 ProcessPOSIX::CanDebug(Target &target, bool plugin_specified_by_name)
108 // For now we are just making sure the file exists for a given module
109 ModuleSP exe_module_sp(target.GetExecutableModule());
110 if (exe_module_sp.get())
111 return exe_module_sp->GetFileSpec().Exists();
112 // If there is no executable module, we return true since we might be preparing to attach.
117 ProcessPOSIX::DoAttachToProcessWithID(lldb::pid_t pid)
120 assert(m_monitor == NULL);
122 Log *log (ProcessPOSIXLog::GetLogIfAllCategoriesSet (POSIX_LOG_PROCESS));
123 if (log && log->GetMask().Test(POSIX_LOG_VERBOSE))
124 log->Printf ("ProcessPOSIX::%s(pid = %" PRIi64 ")", __FUNCTION__, GetID());
126 m_monitor = new ProcessMonitor(this, pid, error);
128 if (!error.Success())
131 PlatformSP platform_sp (m_target.GetPlatform ());
132 assert (platform_sp.get());
134 return error; // FIXME: Detatch?
136 // Find out what we can about this process
137 ProcessInstanceInfo process_info;
138 platform_sp->GetProcessInfo (pid, process_info);
140 // Resolve the executable module
141 ModuleSP exe_module_sp;
142 FileSpecList executable_search_paths (Target::GetDefaultExecutableSearchPaths());
143 error = platform_sp->ResolveExecutable(process_info.GetExecutableFile(),
144 m_target.GetArchitecture(),
146 executable_search_paths.GetSize() ? &executable_search_paths : NULL);
147 if (!error.Success())
150 // Fix the target architecture if necessary
151 const ArchSpec &module_arch = exe_module_sp->GetArchitecture();
152 if (module_arch.IsValid() && !m_target.GetArchitecture().IsExactMatch(module_arch))
153 m_target.SetArchitecture(module_arch);
155 // Initialize the target module list
156 m_target.SetExecutableModule (exe_module_sp, true);
158 SetSTDIOFileDescriptor(m_monitor->GetTerminalFD());
166 ProcessPOSIX::DoAttachToProcessWithID (lldb::pid_t pid, const ProcessAttachInfo &attach_info)
168 return DoAttachToProcessWithID(pid);
172 ProcessPOSIX::WillLaunch(Module* module)
179 ProcessPOSIX::GetFilePath(
180 const lldb_private::ProcessLaunchInfo::FileAction *file_action,
181 const char *default_path)
183 const char *pts_name = "/dev/pts/";
184 const char *path = NULL;
188 if (file_action->GetAction () == ProcessLaunchInfo::FileAction::eFileActionOpen)
189 path = file_action->GetPath();
190 // By default the stdio paths passed in will be pseudo-terminal
191 // (/dev/pts). If so, convert to using a different default path
192 // instead to redirect I/O to the debugger console. This should
193 // also handle user overrides to /dev/null or a different file.
194 if (::strncmp(path, pts_name, ::strlen(pts_name)) == 0)
202 ProcessPOSIX::DoLaunch (Module *module,
203 const ProcessLaunchInfo &launch_info)
206 assert(m_monitor == NULL);
208 const char* working_dir = launch_info.GetWorkingDirectory();
210 FileSpec WorkingDir(working_dir, true);
211 if (!WorkingDir || WorkingDir.GetFileType() != FileSpec::eFileTypeDirectory)
213 error.SetErrorStringWithFormat("No such file or directory: %s", working_dir);
218 SetPrivateState(eStateLaunching);
220 const lldb_private::ProcessLaunchInfo::FileAction *file_action;
222 // Default of NULL will mean to use existing open file descriptors
223 const char *stdin_path = NULL;
224 const char *stdout_path = NULL;
225 const char *stderr_path = NULL;
227 file_action = launch_info.GetFileActionForFD (STDIN_FILENO);
228 stdin_path = GetFilePath(file_action, stdin_path);
230 file_action = launch_info.GetFileActionForFD (STDOUT_FILENO);
231 stdout_path = GetFilePath(file_action, stdout_path);
233 file_action = launch_info.GetFileActionForFD (STDERR_FILENO);
234 stderr_path = GetFilePath(file_action, stderr_path);
236 m_monitor = new ProcessMonitor (this,
238 launch_info.GetArguments().GetConstArgumentVector(),
239 launch_info.GetEnvironmentEntries().GetConstArgumentVector(),
248 if (!error.Success())
251 SetSTDIOFileDescriptor(m_monitor->GetTerminalFD());
253 SetID(m_monitor->GetPID());
258 ProcessPOSIX::DidLaunch()
263 ProcessPOSIX::DoResume()
265 StateType state = GetPrivateState();
267 assert(state == eStateStopped);
269 SetPrivateState(eStateRunning);
271 bool did_resume = false;
273 Mutex::Locker lock(m_thread_list.GetMutex());
275 uint32_t thread_count = m_thread_list.GetSize(false);
276 for (uint32_t i = 0; i < thread_count; ++i)
278 POSIXThread *thread = static_cast<POSIXThread*>(
279 m_thread_list.GetThreadAtIndex(i, false).get());
280 did_resume = thread->Resume() || did_resume;
282 assert(did_resume && "Process resume failed!");
288 ProcessPOSIX::GetImageInfoAddress()
290 Target *target = &GetTarget();
291 ObjectFile *obj_file = target->GetExecutableModule()->GetObjectFile();
292 Address addr = obj_file->GetImageInfoAddress();
295 return addr.GetLoadAddress(target);
297 return LLDB_INVALID_ADDRESS;
301 ProcessPOSIX::DoHalt(bool &caused_stop)
309 else if (kill(GetID(), SIGSTOP))
312 error.SetErrorToErrno();
322 ProcessPOSIX::DoDetach(bool keep_stopped)
327 // FIXME: If you want to implement keep_stopped,
328 // this would be the place to do it.
329 error.SetErrorString("Detaching with keep_stopped true is not currently supported on this platform.");
333 Mutex::Locker lock(m_thread_list.GetMutex());
335 uint32_t thread_count = m_thread_list.GetSize(false);
336 for (uint32_t i = 0; i < thread_count; ++i)
338 POSIXThread *thread = static_cast<POSIXThread*>(
339 m_thread_list.GetThreadAtIndex(i, false).get());
340 error = m_monitor->Detach(thread->GetID());
344 SetPrivateState(eStateDetached);
350 ProcessPOSIX::DoSignal(int signal)
354 if (kill(GetID(), signal))
355 error.SetErrorToErrno();
361 ProcessPOSIX::DoDestroy()
367 // Drive the exit event to completion (do not keep the inferior in
371 if ((m_monitor == NULL || kill(m_monitor->GetPID(), SIGKILL)) && error.Success())
373 error.SetErrorToErrno();
377 SetPrivateState(eStateExited);
384 ProcessPOSIX::SendMessage(const ProcessMessage &message)
386 Mutex::Locker lock(m_message_mutex);
388 Mutex::Locker thread_lock(m_thread_list.GetMutex());
390 POSIXThread *thread = static_cast<POSIXThread*>(
391 m_thread_list.FindThreadByID(message.GetTID(), false).get());
393 switch (message.GetKind())
395 case ProcessMessage::eInvalidMessage:
398 case ProcessMessage::eLimboMessage:
400 thread->SetState(eStateStopped);
401 if (message.GetTID() == GetID())
403 m_exit_status = message.GetExitStatus();
406 SetPrivateState(eStateExited);
407 m_monitor->Detach(GetID());
411 StopAllThreads(message.GetTID());
412 SetPrivateState(eStateStopped);
417 StopAllThreads(message.GetTID());
418 SetPrivateState(eStateStopped);
422 case ProcessMessage::eExitMessage:
424 thread->SetState(eStateExited);
425 // FIXME: I'm not sure we need to do this.
426 if (message.GetTID() == GetID())
428 m_exit_status = message.GetExitStatus();
429 SetExitStatus(m_exit_status, NULL);
431 else if (!IsAThreadRunning())
432 SetPrivateState(eStateStopped);
435 case ProcessMessage::eSignalMessage:
436 case ProcessMessage::eSignalDeliveredMessage:
437 if (message.GetSignal() == SIGSTOP &&
438 AddThreadForInitialStopIfNeeded(message.GetTID()))
440 // Intentional fall-through
442 case ProcessMessage::eBreakpointMessage:
443 case ProcessMessage::eTraceMessage:
444 case ProcessMessage::eWatchpointMessage:
445 case ProcessMessage::eNewThreadMessage:
446 case ProcessMessage::eCrashMessage:
448 thread->SetState(eStateStopped);
449 StopAllThreads(message.GetTID());
450 SetPrivateState(eStateStopped);
454 m_message_queue.push(message);
458 ProcessPOSIX::StopAllThreads(lldb::tid_t stop_tid)
460 // FIXME: Will this work the same way on FreeBSD and Linux?
464 ProcessPOSIX::AddThreadForInitialStopIfNeeded(lldb::tid_t stop_tid)
466 bool added_to_set = false;
467 ThreadStopSet::iterator it = m_seen_initial_stop.find(stop_tid);
468 if (it == m_seen_initial_stop.end())
470 m_seen_initial_stop.insert(stop_tid);
477 ProcessPOSIX::CreateNewPOSIXThread(lldb_private::Process &process, lldb::tid_t tid)
479 return new POSIXThread(process, tid);
483 ProcessPOSIX::RefreshStateAfterStop()
485 Log *log (ProcessPOSIXLog::GetLogIfAllCategoriesSet (POSIX_LOG_PROCESS));
486 if (log && log->GetMask().Test(POSIX_LOG_VERBOSE))
487 log->Printf ("ProcessPOSIX::%s(), message_queue size = %d", __FUNCTION__, (int)m_message_queue.size());
489 Mutex::Locker lock(m_message_mutex);
491 // This method used to only handle one message. Changing it to loop allows
492 // it to handle the case where we hit a breakpoint while handling a different
494 while (!m_message_queue.empty())
496 ProcessMessage &message = m_message_queue.front();
498 // Resolve the thread this message corresponds to and pass it along.
499 lldb::tid_t tid = message.GetTID();
501 log->Printf ("ProcessPOSIX::%s(), message_queue size = %d, pid = %" PRIi64, __FUNCTION__, (int)m_message_queue.size(), tid);
502 POSIXThread *thread = static_cast<POSIXThread*>(
503 GetThreadList().FindThreadByID(tid, false).get());
505 if (message.GetKind() == ProcessMessage::eNewThreadMessage)
508 log->Printf ("ProcessPOSIX::%s() adding thread, tid = %" PRIi64, __FUNCTION__, message.GetChildTID());
509 lldb::tid_t child_tid = message.GetChildTID();
511 thread_sp.reset(CreateNewPOSIXThread(*this, child_tid));
513 Mutex::Locker lock(m_thread_list.GetMutex());
515 m_thread_list.AddThread(thread_sp);
518 m_thread_list.RefreshStateAfterStop();
521 thread->Notify(message);
523 if (message.GetKind() == ProcessMessage::eExitMessage)
525 // FIXME: We should tell the user about this, but the limbo message is probably better for that.
527 log->Printf ("ProcessPOSIX::%s() removing thread, tid = %" PRIi64, __FUNCTION__, tid);
529 Mutex::Locker lock(m_thread_list.GetMutex());
531 ThreadSP thread_sp = m_thread_list.RemoveThreadByID(tid, false);
533 m_seen_initial_stop.erase(tid);
536 m_message_queue.pop();
541 ProcessPOSIX::IsAlive()
543 StateType state = GetPrivateState();
544 return state != eStateDetached
545 && state != eStateExited
546 && state != eStateInvalid
547 && state != eStateUnloaded;
551 ProcessPOSIX::DoReadMemory(addr_t vm_addr,
552 void *buf, size_t size, Error &error)
555 return m_monitor->ReadMemory(vm_addr, buf, size, error);
559 ProcessPOSIX::DoWriteMemory(addr_t vm_addr, const void *buf, size_t size,
563 return m_monitor->WriteMemory(vm_addr, buf, size, error);
567 ProcessPOSIX::DoAllocateMemory(size_t size, uint32_t permissions,
570 addr_t allocated_addr = LLDB_INVALID_ADDRESS;
573 if (permissions & lldb::ePermissionsReadable)
574 prot |= eMmapProtRead;
575 if (permissions & lldb::ePermissionsWritable)
576 prot |= eMmapProtWrite;
577 if (permissions & lldb::ePermissionsExecutable)
578 prot |= eMmapProtExec;
580 if (InferiorCallMmap(this, allocated_addr, 0, size, prot,
581 eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0)) {
582 m_addr_to_mmap_size[allocated_addr] = size;
585 allocated_addr = LLDB_INVALID_ADDRESS;
586 error.SetErrorStringWithFormat("unable to allocate %zu bytes of memory with permissions %s", size, GetPermissionsAsCString (permissions));
589 return allocated_addr;
593 ProcessPOSIX::DoDeallocateMemory(lldb::addr_t addr)
596 MMapMap::iterator pos = m_addr_to_mmap_size.find(addr);
597 if (pos != m_addr_to_mmap_size.end() &&
598 InferiorCallMunmap(this, addr, pos->second))
599 m_addr_to_mmap_size.erase (pos);
601 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
607 ProcessPOSIX::ResolveIndirectFunction(const Address *address, Error &error)
609 addr_t function_addr = LLDB_INVALID_ADDRESS;
610 if (address == NULL) {
611 error.SetErrorStringWithFormat("unable to determine direct function call for NULL address");
612 } else if (!InferiorCall(this, address, function_addr)) {
613 function_addr = LLDB_INVALID_ADDRESS;
614 error.SetErrorStringWithFormat("unable to determine direct function call for indirect function %s",
615 address->CalculateSymbolContextSymbol()->GetName().AsCString());
617 return function_addr;
621 ProcessPOSIX::GetSoftwareBreakpointTrapOpcode(BreakpointSite* bp_site)
623 static const uint8_t g_i386_opcode[] = { 0xCC };
625 ArchSpec arch = GetTarget().GetArchitecture();
626 const uint8_t *opcode = NULL;
627 size_t opcode_size = 0;
629 switch (arch.GetCore())
632 assert(false && "CPU type not supported!");
635 case ArchSpec::eCore_x86_32_i386:
636 case ArchSpec::eCore_x86_64_x86_64:
637 opcode = g_i386_opcode;
638 opcode_size = sizeof(g_i386_opcode);
642 bp_site->SetTrapOpcode(opcode, opcode_size);
647 ProcessPOSIX::EnableBreakpointSite(BreakpointSite *bp_site)
649 return EnableSoftwareBreakpoint(bp_site);
653 ProcessPOSIX::DisableBreakpointSite(BreakpointSite *bp_site)
655 return DisableSoftwareBreakpoint(bp_site);
659 ProcessPOSIX::EnableWatchpoint(Watchpoint *wp, bool notify)
664 user_id_t watchID = wp->GetID();
665 addr_t addr = wp->GetLoadAddress();
666 Log *log (ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_WATCHPOINTS));
668 log->Printf ("ProcessPOSIX::EnableWatchpoint(watchID = %" PRIu64 ")",
673 log->Printf("ProcessPOSIX::EnableWatchpoint(watchID = %" PRIu64
674 ") addr = 0x%8.8" PRIx64 ": watchpoint already enabled.",
675 watchID, (uint64_t)addr);
679 // Try to find a vacant watchpoint slot in the inferiors' main thread
680 uint32_t wp_hw_index = LLDB_INVALID_INDEX32;
681 Mutex::Locker lock(m_thread_list.GetMutex());
682 POSIXThread *thread = static_cast<POSIXThread*>(
683 m_thread_list.GetThreadAtIndex(0, false).get());
686 wp_hw_index = thread->FindVacantWatchpointIndex();
688 if (wp_hw_index == LLDB_INVALID_INDEX32)
690 error.SetErrorString("Setting hardware watchpoint failed.");
694 wp->SetHardwareIndex(wp_hw_index);
695 bool wp_enabled = true;
696 uint32_t thread_count = m_thread_list.GetSize(false);
697 for (uint32_t i = 0; i < thread_count; ++i)
699 thread = static_cast<POSIXThread*>(
700 m_thread_list.GetThreadAtIndex(i, false).get());
702 wp_enabled &= thread->EnableHardwareWatchpoint(wp);
708 wp->SetEnabled(true, notify);
713 // Watchpoint enabling failed on at least one
714 // of the threads so roll back all of them
715 DisableWatchpoint(wp, false);
716 error.SetErrorString("Setting hardware watchpoint failed");
721 error.SetErrorString("Watchpoint argument was NULL.");
726 ProcessPOSIX::DisableWatchpoint(Watchpoint *wp, bool notify)
731 user_id_t watchID = wp->GetID();
732 addr_t addr = wp->GetLoadAddress();
733 Log *log (ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_WATCHPOINTS));
735 log->Printf("ProcessPOSIX::DisableWatchpoint(watchID = %" PRIu64 ")",
737 if (!wp->IsEnabled())
740 log->Printf("ProcessPOSIX::DisableWatchpoint(watchID = %" PRIu64
741 ") addr = 0x%8.8" PRIx64 ": watchpoint already disabled.",
742 watchID, (uint64_t)addr);
743 // This is needed (for now) to keep watchpoints disabled correctly
744 wp->SetEnabled(false, notify);
748 if (wp->IsHardware())
750 bool wp_disabled = true;
751 Mutex::Locker lock(m_thread_list.GetMutex());
752 uint32_t thread_count = m_thread_list.GetSize(false);
753 for (uint32_t i = 0; i < thread_count; ++i)
755 POSIXThread *thread = static_cast<POSIXThread*>(
756 m_thread_list.GetThreadAtIndex(i, false).get());
758 wp_disabled &= thread->DisableHardwareWatchpoint(wp);
764 wp->SetHardwareIndex(LLDB_INVALID_INDEX32);
765 wp->SetEnabled(false, notify);
769 error.SetErrorString("Disabling hardware watchpoint failed");
773 error.SetErrorString("Watchpoint argument was NULL.");
778 ProcessPOSIX::GetWatchpointSupportInfo(uint32_t &num)
781 Mutex::Locker lock(m_thread_list.GetMutex());
782 POSIXThread *thread = static_cast<POSIXThread*>(
783 m_thread_list.GetThreadAtIndex(0, false).get());
785 num = thread->NumSupportedHardwareWatchpoints();
787 error.SetErrorString("Process does not exist.");
792 ProcessPOSIX::GetWatchpointSupportInfo(uint32_t &num, bool &after)
794 Error error = GetWatchpointSupportInfo(num);
795 // Watchpoints trigger and halt the inferior after
796 // the corresponding instruction has been executed.
802 ProcessPOSIX::UpdateThreadListIfNeeded()
804 Mutex::Locker lock(m_thread_list.GetMutex());
805 // Do not allow recursive updates.
806 return m_thread_list.GetSize(false);
810 ProcessPOSIX::UpdateThreadList(ThreadList &old_thread_list, ThreadList &new_thread_list)
812 Log *log (ProcessPOSIXLog::GetLogIfAllCategoriesSet (POSIX_LOG_THREAD));
813 if (log && log->GetMask().Test(POSIX_LOG_VERBOSE))
814 log->Printf ("ProcessPOSIX::%s() (pid = %" PRIi64 ")", __FUNCTION__, GetID());
816 // Update the process thread list with this new thread.
817 // FIXME: We should be using tid, not pid.
819 ThreadSP thread_sp (old_thread_list.FindThreadByID (GetID(), false));
821 thread_sp.reset(CreateNewPOSIXThread(*this, GetID()));
824 if (log && log->GetMask().Test(POSIX_LOG_VERBOSE))
825 log->Printf ("ProcessPOSIX::%s() updated pid = %" PRIi64, __FUNCTION__, GetID());
826 new_thread_list.AddThread(thread_sp);
828 return new_thread_list.GetSize(false) > 0;
832 ProcessPOSIX::GetByteOrder() const
834 // FIXME: We should be able to extract this value directly. See comment in
840 ProcessPOSIX::PutSTDIN(const char *buf, size_t len, Error &error)
843 if ((status = write(m_monitor->GetTerminalFD(), buf, len)) < 0)
845 error.SetErrorToErrno();
852 ProcessPOSIX::GetUnixSignals()
857 //------------------------------------------------------------------------------
858 // Utility functions.
861 ProcessPOSIX::HasExited()
863 switch (GetPrivateState())
877 ProcessPOSIX::IsStopped()
879 switch (GetPrivateState())
886 case eStateSuspended:
894 ProcessPOSIX::IsAThreadRunning()
896 bool is_running = false;
897 Mutex::Locker lock(m_thread_list.GetMutex());
898 uint32_t thread_count = m_thread_list.GetSize(false);
899 for (uint32_t i = 0; i < thread_count; ++i)
901 POSIXThread *thread = static_cast<POSIXThread*>(
902 m_thread_list.GetThreadAtIndex(i, false).get());
903 StateType thread_state = thread->GetState();
904 if (thread_state == eStateRunning || thread_state == eStateStepping)