1 //===-- SBProcess.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/API/SBProcess.h"
15 #include "lldb/lldb-defines.h"
16 #include "lldb/lldb-types.h"
18 #include "lldb/Core/Debugger.h"
19 #include "lldb/Core/Module.h"
20 #include "lldb/Core/PluginManager.h"
21 #include "lldb/Core/State.h"
22 #include "lldb/Core/StreamFile.h"
23 #include "lldb/Interpreter/Args.h"
24 #include "lldb/Target/MemoryRegionInfo.h"
25 #include "lldb/Target/Process.h"
26 #include "lldb/Target/RegisterContext.h"
27 #include "lldb/Target/SystemRuntime.h"
28 #include "lldb/Target/Target.h"
29 #include "lldb/Target/Thread.h"
30 #include "lldb/Utility/Log.h"
31 #include "lldb/Utility/Stream.h"
35 #include "lldb/API/SBBroadcaster.h"
36 #include "lldb/API/SBCommandReturnObject.h"
37 #include "lldb/API/SBDebugger.h"
38 #include "lldb/API/SBEvent.h"
39 #include "lldb/API/SBFileSpec.h"
40 #include "lldb/API/SBMemoryRegionInfo.h"
41 #include "lldb/API/SBMemoryRegionInfoList.h"
42 #include "lldb/API/SBStream.h"
43 #include "lldb/API/SBStringList.h"
44 #include "lldb/API/SBStructuredData.h"
45 #include "lldb/API/SBThread.h"
46 #include "lldb/API/SBThreadCollection.h"
47 #include "lldb/API/SBTrace.h"
48 #include "lldb/API/SBTraceOptions.h"
49 #include "lldb/API/SBUnixSignals.h"
52 using namespace lldb_private;
54 SBProcess::SBProcess() : m_opaque_wp() {}
56 //----------------------------------------------------------------------
57 // SBProcess constructor
58 //----------------------------------------------------------------------
60 SBProcess::SBProcess(const SBProcess &rhs) : m_opaque_wp(rhs.m_opaque_wp) {}
62 SBProcess::SBProcess(const lldb::ProcessSP &process_sp)
63 : m_opaque_wp(process_sp) {}
65 const SBProcess &SBProcess::operator=(const SBProcess &rhs) {
67 m_opaque_wp = rhs.m_opaque_wp;
71 //----------------------------------------------------------------------
73 //----------------------------------------------------------------------
74 SBProcess::~SBProcess() {}
76 const char *SBProcess::GetBroadcasterClassName() {
77 return Process::GetStaticBroadcasterClass().AsCString();
80 const char *SBProcess::GetPluginName() {
81 ProcessSP process_sp(GetSP());
83 return process_sp->GetPluginName().GetCString();
88 const char *SBProcess::GetShortPluginName() {
89 ProcessSP process_sp(GetSP());
91 return process_sp->GetPluginName().GetCString();
96 lldb::ProcessSP SBProcess::GetSP() const { return m_opaque_wp.lock(); }
98 void SBProcess::SetSP(const ProcessSP &process_sp) { m_opaque_wp = process_sp; }
100 void SBProcess::Clear() { m_opaque_wp.reset(); }
102 bool SBProcess::IsValid() const {
103 ProcessSP process_sp(m_opaque_wp.lock());
104 return ((bool)process_sp && process_sp->IsValid());
107 bool SBProcess::RemoteLaunch(char const **argv, char const **envp,
108 const char *stdin_path, const char *stdout_path,
109 const char *stderr_path,
110 const char *working_directory,
111 uint32_t launch_flags, bool stop_at_entry,
112 lldb::SBError &error) {
113 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
115 log->Printf("SBProcess(%p)::RemoteLaunch (argv=%p, envp=%p, stdin=%s, "
116 "stdout=%s, stderr=%s, working-dir=%s, launch_flags=0x%x, "
117 "stop_at_entry=%i, &error (%p))...",
118 static_cast<void *>(m_opaque_wp.lock().get()),
119 static_cast<void *>(argv), static_cast<void *>(envp),
120 stdin_path ? stdin_path : "NULL",
121 stdout_path ? stdout_path : "NULL",
122 stderr_path ? stderr_path : "NULL",
123 working_directory ? working_directory : "NULL", launch_flags,
124 stop_at_entry, static_cast<void *>(error.get()));
126 ProcessSP process_sp(GetSP());
128 std::lock_guard<std::recursive_mutex> guard(
129 process_sp->GetTarget().GetAPIMutex());
130 if (process_sp->GetState() == eStateConnected) {
132 launch_flags |= eLaunchFlagStopAtEntry;
133 ProcessLaunchInfo launch_info(
134 FileSpec{stdin_path, false}, FileSpec{stdout_path, false},
135 FileSpec{stderr_path, false}, FileSpec{working_directory, false},
137 Module *exe_module = process_sp->GetTarget().GetExecutableModulePointer();
139 launch_info.SetExecutableFile(exe_module->GetPlatformFileSpec(), true);
141 launch_info.GetArguments().AppendArguments(argv);
143 launch_info.GetEnvironmentEntries().SetArguments(envp);
144 error.SetError(process_sp->Launch(launch_info));
146 error.SetErrorString("must be in eStateConnected to call RemoteLaunch");
149 error.SetErrorString("unable to attach pid");
154 error.GetDescription(sstr);
155 log->Printf("SBProcess(%p)::RemoteLaunch (...) => SBError (%p): %s",
156 static_cast<void *>(process_sp.get()),
157 static_cast<void *>(error.get()), sstr.GetData());
160 return error.Success();
163 bool SBProcess::RemoteAttachToProcessWithID(lldb::pid_t pid,
164 lldb::SBError &error) {
165 ProcessSP process_sp(GetSP());
167 std::lock_guard<std::recursive_mutex> guard(
168 process_sp->GetTarget().GetAPIMutex());
169 if (process_sp->GetState() == eStateConnected) {
170 ProcessAttachInfo attach_info;
171 attach_info.SetProcessID(pid);
172 error.SetError(process_sp->Attach(attach_info));
174 error.SetErrorString(
175 "must be in eStateConnected to call RemoteAttachToProcessWithID");
178 error.SetErrorString("unable to attach pid");
181 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
184 error.GetDescription(sstr);
185 log->Printf("SBProcess(%p)::RemoteAttachToProcessWithID (%" PRIu64
186 ") => SBError (%p): %s",
187 static_cast<void *>(process_sp.get()), pid,
188 static_cast<void *>(error.get()), sstr.GetData());
191 return error.Success();
194 uint32_t SBProcess::GetNumThreads() {
195 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
197 uint32_t num_threads = 0;
198 ProcessSP process_sp(GetSP());
200 Process::StopLocker stop_locker;
202 const bool can_update = stop_locker.TryLock(&process_sp->GetRunLock());
203 std::lock_guard<std::recursive_mutex> guard(
204 process_sp->GetTarget().GetAPIMutex());
205 num_threads = process_sp->GetThreadList().GetSize(can_update);
209 log->Printf("SBProcess(%p)::GetNumThreads () => %d",
210 static_cast<void *>(process_sp.get()), num_threads);
215 SBThread SBProcess::GetSelectedThread() const {
216 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
220 ProcessSP process_sp(GetSP());
222 std::lock_guard<std::recursive_mutex> guard(
223 process_sp->GetTarget().GetAPIMutex());
224 thread_sp = process_sp->GetThreadList().GetSelectedThread();
225 sb_thread.SetThread(thread_sp);
229 log->Printf("SBProcess(%p)::GetSelectedThread () => SBThread(%p)",
230 static_cast<void *>(process_sp.get()),
231 static_cast<void *>(thread_sp.get()));
236 SBThread SBProcess::CreateOSPluginThread(lldb::tid_t tid,
237 lldb::addr_t context) {
238 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
242 ProcessSP process_sp(GetSP());
244 std::lock_guard<std::recursive_mutex> guard(
245 process_sp->GetTarget().GetAPIMutex());
246 thread_sp = process_sp->CreateOSPluginThread(tid, context);
247 sb_thread.SetThread(thread_sp);
251 log->Printf("SBProcess(%p)::CreateOSPluginThread (tid=0x%" PRIx64
252 ", context=0x%" PRIx64 ") => SBThread(%p)",
253 static_cast<void *>(process_sp.get()), tid, context,
254 static_cast<void *>(thread_sp.get()));
259 SBTarget SBProcess::GetTarget() const {
260 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
264 ProcessSP process_sp(GetSP());
266 target_sp = process_sp->GetTarget().shared_from_this();
267 sb_target.SetSP(target_sp);
271 log->Printf("SBProcess(%p)::GetTarget () => SBTarget(%p)",
272 static_cast<void *>(process_sp.get()),
273 static_cast<void *>(target_sp.get()));
278 size_t SBProcess::PutSTDIN(const char *src, size_t src_len) {
279 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
282 ProcessSP process_sp(GetSP());
285 ret_val = process_sp->PutSTDIN(src, src_len, error);
289 log->Printf("SBProcess(%p)::PutSTDIN (src=\"%s\", src_len=%" PRIu64
291 static_cast<void *>(process_sp.get()), src,
292 static_cast<uint64_t>(src_len), static_cast<uint64_t>(ret_val));
297 size_t SBProcess::GetSTDOUT(char *dst, size_t dst_len) const {
298 size_t bytes_read = 0;
299 ProcessSP process_sp(GetSP());
302 bytes_read = process_sp->GetSTDOUT(dst, dst_len, error);
305 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
308 "SBProcess(%p)::GetSTDOUT (dst=\"%.*s\", dst_len=%" PRIu64
310 static_cast<void *>(process_sp.get()), static_cast<int>(bytes_read),
311 dst, static_cast<uint64_t>(dst_len), static_cast<uint64_t>(bytes_read));
316 size_t SBProcess::GetSTDERR(char *dst, size_t dst_len) const {
317 size_t bytes_read = 0;
318 ProcessSP process_sp(GetSP());
321 bytes_read = process_sp->GetSTDERR(dst, dst_len, error);
324 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
327 "SBProcess(%p)::GetSTDERR (dst=\"%.*s\", dst_len=%" PRIu64
329 static_cast<void *>(process_sp.get()), static_cast<int>(bytes_read),
330 dst, static_cast<uint64_t>(dst_len), static_cast<uint64_t>(bytes_read));
335 size_t SBProcess::GetAsyncProfileData(char *dst, size_t dst_len) const {
336 size_t bytes_read = 0;
337 ProcessSP process_sp(GetSP());
340 bytes_read = process_sp->GetAsyncProfileData(dst, dst_len, error);
343 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
346 "SBProcess(%p)::GetAsyncProfileData (dst=\"%.*s\", dst_len=%" PRIu64
348 static_cast<void *>(process_sp.get()), static_cast<int>(bytes_read),
349 dst, static_cast<uint64_t>(dst_len), static_cast<uint64_t>(bytes_read));
354 lldb::SBTrace SBProcess::StartTrace(SBTraceOptions &options,
355 lldb::SBError &error) {
356 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
357 ProcessSP process_sp(GetSP());
359 SBTrace trace_instance;
360 trace_instance.SetSP(process_sp);
361 lldb::user_id_t uid = LLDB_INVALID_UID;
364 error.SetErrorString("invalid process");
367 uid = process_sp->StartTrace(options.m_traceoptions_sp, error.ref());
368 trace_instance.SetTraceUID(uid);
369 LLDB_LOG(log, "SBProcess::returned uid - %" PRIx64, uid);
371 return trace_instance;
374 void SBProcess::ReportEventState(const SBEvent &event, FILE *out) const {
378 ProcessSP process_sp(GetSP());
380 const StateType event_state = SBProcess::GetStateFromEvent(event);
382 int message_len = ::snprintf(
383 message, sizeof(message), "Process %" PRIu64 " %s\n",
384 process_sp->GetID(), SBDebugger::StateAsCString(event_state));
387 ::fwrite(message, 1, message_len, out);
391 void SBProcess::AppendEventStateReport(const SBEvent &event,
392 SBCommandReturnObject &result) {
393 ProcessSP process_sp(GetSP());
395 const StateType event_state = SBProcess::GetStateFromEvent(event);
397 ::snprintf(message, sizeof(message), "Process %" PRIu64 " %s\n",
398 process_sp->GetID(), SBDebugger::StateAsCString(event_state));
400 result.AppendMessage(message);
404 bool SBProcess::SetSelectedThread(const SBThread &thread) {
405 ProcessSP process_sp(GetSP());
407 std::lock_guard<std::recursive_mutex> guard(
408 process_sp->GetTarget().GetAPIMutex());
409 return process_sp->GetThreadList().SetSelectedThreadByID(
410 thread.GetThreadID());
415 bool SBProcess::SetSelectedThreadByID(lldb::tid_t tid) {
416 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
418 bool ret_val = false;
419 ProcessSP process_sp(GetSP());
421 std::lock_guard<std::recursive_mutex> guard(
422 process_sp->GetTarget().GetAPIMutex());
423 ret_val = process_sp->GetThreadList().SetSelectedThreadByID(tid);
427 log->Printf("SBProcess(%p)::SetSelectedThreadByID (tid=0x%4.4" PRIx64
429 static_cast<void *>(process_sp.get()), tid,
430 (ret_val ? "true" : "false"));
435 bool SBProcess::SetSelectedThreadByIndexID(uint32_t index_id) {
436 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
438 bool ret_val = false;
439 ProcessSP process_sp(GetSP());
441 std::lock_guard<std::recursive_mutex> guard(
442 process_sp->GetTarget().GetAPIMutex());
443 ret_val = process_sp->GetThreadList().SetSelectedThreadByIndexID(index_id);
447 log->Printf("SBProcess(%p)::SetSelectedThreadByID (tid=0x%x) => %s",
448 static_cast<void *>(process_sp.get()), index_id,
449 (ret_val ? "true" : "false"));
454 SBThread SBProcess::GetThreadAtIndex(size_t index) {
455 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
459 ProcessSP process_sp(GetSP());
461 Process::StopLocker stop_locker;
462 const bool can_update = stop_locker.TryLock(&process_sp->GetRunLock());
463 std::lock_guard<std::recursive_mutex> guard(
464 process_sp->GetTarget().GetAPIMutex());
465 thread_sp = process_sp->GetThreadList().GetThreadAtIndex(index, can_update);
466 sb_thread.SetThread(thread_sp);
470 log->Printf("SBProcess(%p)::GetThreadAtIndex (index=%d) => SBThread(%p)",
471 static_cast<void *>(process_sp.get()),
472 static_cast<uint32_t>(index),
473 static_cast<void *>(thread_sp.get()));
478 uint32_t SBProcess::GetNumQueues() {
479 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
481 uint32_t num_queues = 0;
482 ProcessSP process_sp(GetSP());
484 Process::StopLocker stop_locker;
485 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
486 std::lock_guard<std::recursive_mutex> guard(
487 process_sp->GetTarget().GetAPIMutex());
488 num_queues = process_sp->GetQueueList().GetSize();
493 log->Printf("SBProcess(%p)::GetNumQueues () => %d",
494 static_cast<void *>(process_sp.get()), num_queues);
499 SBQueue SBProcess::GetQueueAtIndex(size_t index) {
500 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
504 ProcessSP process_sp(GetSP());
506 Process::StopLocker stop_locker;
507 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
508 std::lock_guard<std::recursive_mutex> guard(
509 process_sp->GetTarget().GetAPIMutex());
510 queue_sp = process_sp->GetQueueList().GetQueueAtIndex(index);
511 sb_queue.SetQueue(queue_sp);
516 log->Printf("SBProcess(%p)::GetQueueAtIndex (index=%d) => SBQueue(%p)",
517 static_cast<void *>(process_sp.get()),
518 static_cast<uint32_t>(index),
519 static_cast<void *>(queue_sp.get()));
524 uint32_t SBProcess::GetStopID(bool include_expression_stops) {
525 ProcessSP process_sp(GetSP());
527 std::lock_guard<std::recursive_mutex> guard(
528 process_sp->GetTarget().GetAPIMutex());
529 if (include_expression_stops)
530 return process_sp->GetStopID();
532 return process_sp->GetLastNaturalStopID();
537 SBEvent SBProcess::GetStopEventForStopID(uint32_t stop_id) {
538 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
542 ProcessSP process_sp(GetSP());
544 std::lock_guard<std::recursive_mutex> guard(
545 process_sp->GetTarget().GetAPIMutex());
546 event_sp = process_sp->GetStopEventForStopID(stop_id);
547 sb_event.reset(event_sp);
551 log->Printf("SBProcess(%p)::GetStopEventForStopID (stop_id=%" PRIu32
553 static_cast<void *>(process_sp.get()), stop_id,
554 static_cast<void *>(event_sp.get()));
559 StateType SBProcess::GetState() {
561 StateType ret_val = eStateInvalid;
562 ProcessSP process_sp(GetSP());
564 std::lock_guard<std::recursive_mutex> guard(
565 process_sp->GetTarget().GetAPIMutex());
566 ret_val = process_sp->GetState();
569 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
571 log->Printf("SBProcess(%p)::GetState () => %s",
572 static_cast<void *>(process_sp.get()),
573 lldb_private::StateAsCString(ret_val));
578 int SBProcess::GetExitStatus() {
580 ProcessSP process_sp(GetSP());
582 std::lock_guard<std::recursive_mutex> guard(
583 process_sp->GetTarget().GetAPIMutex());
584 exit_status = process_sp->GetExitStatus();
586 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
588 log->Printf("SBProcess(%p)::GetExitStatus () => %i (0x%8.8x)",
589 static_cast<void *>(process_sp.get()), exit_status,
595 const char *SBProcess::GetExitDescription() {
596 const char *exit_desc = NULL;
597 ProcessSP process_sp(GetSP());
599 std::lock_guard<std::recursive_mutex> guard(
600 process_sp->GetTarget().GetAPIMutex());
601 exit_desc = process_sp->GetExitDescription();
603 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
605 log->Printf("SBProcess(%p)::GetExitDescription () => %s",
606 static_cast<void *>(process_sp.get()), exit_desc);
610 lldb::pid_t SBProcess::GetProcessID() {
611 lldb::pid_t ret_val = LLDB_INVALID_PROCESS_ID;
612 ProcessSP process_sp(GetSP());
614 ret_val = process_sp->GetID();
616 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
618 log->Printf("SBProcess(%p)::GetProcessID () => %" PRIu64,
619 static_cast<void *>(process_sp.get()), ret_val);
624 uint32_t SBProcess::GetUniqueID() {
625 uint32_t ret_val = 0;
626 ProcessSP process_sp(GetSP());
628 ret_val = process_sp->GetUniqueID();
629 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
631 log->Printf("SBProcess(%p)::GetUniqueID () => %" PRIu32,
632 static_cast<void *>(process_sp.get()), ret_val);
636 ByteOrder SBProcess::GetByteOrder() const {
637 ByteOrder byteOrder = eByteOrderInvalid;
638 ProcessSP process_sp(GetSP());
640 byteOrder = process_sp->GetTarget().GetArchitecture().GetByteOrder();
642 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
644 log->Printf("SBProcess(%p)::GetByteOrder () => %d",
645 static_cast<void *>(process_sp.get()), byteOrder);
650 uint32_t SBProcess::GetAddressByteSize() const {
652 ProcessSP process_sp(GetSP());
654 size = process_sp->GetTarget().GetArchitecture().GetAddressByteSize();
656 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
658 log->Printf("SBProcess(%p)::GetAddressByteSize () => %d",
659 static_cast<void *>(process_sp.get()), size);
664 SBError SBProcess::Continue() {
665 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
668 ProcessSP process_sp(GetSP());
671 log->Printf("SBProcess(%p)::Continue ()...",
672 static_cast<void *>(process_sp.get()));
675 std::lock_guard<std::recursive_mutex> guard(
676 process_sp->GetTarget().GetAPIMutex());
678 if (process_sp->GetTarget().GetDebugger().GetAsyncExecution())
679 sb_error.ref() = process_sp->Resume();
681 sb_error.ref() = process_sp->ResumeSynchronous(NULL);
683 sb_error.SetErrorString("SBProcess is invalid");
687 sb_error.GetDescription(sstr);
688 log->Printf("SBProcess(%p)::Continue () => SBError (%p): %s",
689 static_cast<void *>(process_sp.get()),
690 static_cast<void *>(sb_error.get()), sstr.GetData());
696 SBError SBProcess::Destroy() {
698 ProcessSP process_sp(GetSP());
700 std::lock_guard<std::recursive_mutex> guard(
701 process_sp->GetTarget().GetAPIMutex());
702 sb_error.SetError(process_sp->Destroy(false));
704 sb_error.SetErrorString("SBProcess is invalid");
706 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
709 sb_error.GetDescription(sstr);
710 log->Printf("SBProcess(%p)::Destroy () => SBError (%p): %s",
711 static_cast<void *>(process_sp.get()),
712 static_cast<void *>(sb_error.get()), sstr.GetData());
718 SBError SBProcess::Stop() {
720 ProcessSP process_sp(GetSP());
722 std::lock_guard<std::recursive_mutex> guard(
723 process_sp->GetTarget().GetAPIMutex());
724 sb_error.SetError(process_sp->Halt());
726 sb_error.SetErrorString("SBProcess is invalid");
728 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
731 sb_error.GetDescription(sstr);
732 log->Printf("SBProcess(%p)::Stop () => SBError (%p): %s",
733 static_cast<void *>(process_sp.get()),
734 static_cast<void *>(sb_error.get()), sstr.GetData());
740 SBError SBProcess::Kill() {
742 ProcessSP process_sp(GetSP());
744 std::lock_guard<std::recursive_mutex> guard(
745 process_sp->GetTarget().GetAPIMutex());
746 sb_error.SetError(process_sp->Destroy(true));
748 sb_error.SetErrorString("SBProcess is invalid");
750 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
753 sb_error.GetDescription(sstr);
754 log->Printf("SBProcess(%p)::Kill () => SBError (%p): %s",
755 static_cast<void *>(process_sp.get()),
756 static_cast<void *>(sb_error.get()), sstr.GetData());
762 SBError SBProcess::Detach() {
763 // FIXME: This should come from a process default.
764 bool keep_stopped = false;
765 return Detach(keep_stopped);
768 SBError SBProcess::Detach(bool keep_stopped) {
770 ProcessSP process_sp(GetSP());
772 std::lock_guard<std::recursive_mutex> guard(
773 process_sp->GetTarget().GetAPIMutex());
774 sb_error.SetError(process_sp->Detach(keep_stopped));
776 sb_error.SetErrorString("SBProcess is invalid");
781 SBError SBProcess::Signal(int signo) {
783 ProcessSP process_sp(GetSP());
785 std::lock_guard<std::recursive_mutex> guard(
786 process_sp->GetTarget().GetAPIMutex());
787 sb_error.SetError(process_sp->Signal(signo));
789 sb_error.SetErrorString("SBProcess is invalid");
790 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
793 sb_error.GetDescription(sstr);
794 log->Printf("SBProcess(%p)::Signal (signo=%i) => SBError (%p): %s",
795 static_cast<void *>(process_sp.get()), signo,
796 static_cast<void *>(sb_error.get()), sstr.GetData());
801 SBUnixSignals SBProcess::GetUnixSignals() {
802 if (auto process_sp = GetSP())
803 return SBUnixSignals{process_sp};
808 void SBProcess::SendAsyncInterrupt() {
809 ProcessSP process_sp(GetSP());
811 process_sp->SendAsyncInterrupt();
815 SBThread SBProcess::GetThreadByID(tid_t tid) {
818 ProcessSP process_sp(GetSP());
820 Process::StopLocker stop_locker;
821 const bool can_update = stop_locker.TryLock(&process_sp->GetRunLock());
822 std::lock_guard<std::recursive_mutex> guard(
823 process_sp->GetTarget().GetAPIMutex());
824 thread_sp = process_sp->GetThreadList().FindThreadByID(tid, can_update);
825 sb_thread.SetThread(thread_sp);
828 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
830 log->Printf("SBProcess(%p)::GetThreadByID (tid=0x%4.4" PRIx64
831 ") => SBThread (%p)",
832 static_cast<void *>(process_sp.get()), tid,
833 static_cast<void *>(thread_sp.get()));
838 SBThread SBProcess::GetThreadByIndexID(uint32_t index_id) {
841 ProcessSP process_sp(GetSP());
843 Process::StopLocker stop_locker;
844 const bool can_update = stop_locker.TryLock(&process_sp->GetRunLock());
845 std::lock_guard<std::recursive_mutex> guard(
846 process_sp->GetTarget().GetAPIMutex());
848 process_sp->GetThreadList().FindThreadByIndexID(index_id, can_update);
849 sb_thread.SetThread(thread_sp);
852 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
854 log->Printf("SBProcess(%p)::GetThreadByID (tid=0x%x) => SBThread (%p)",
855 static_cast<void *>(process_sp.get()), index_id,
856 static_cast<void *>(thread_sp.get()));
861 StateType SBProcess::GetStateFromEvent(const SBEvent &event) {
862 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
864 StateType ret_val = Process::ProcessEventData::GetStateFromEvent(event.get());
867 log->Printf("SBProcess::GetStateFromEvent (event.sp=%p) => %s",
868 static_cast<void *>(event.get()),
869 lldb_private::StateAsCString(ret_val));
874 bool SBProcess::GetRestartedFromEvent(const SBEvent &event) {
875 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
877 bool ret_val = Process::ProcessEventData::GetRestartedFromEvent(event.get());
880 log->Printf("SBProcess::%s (event.sp=%p) => %d", __FUNCTION__,
881 static_cast<void *>(event.get()), ret_val);
886 size_t SBProcess::GetNumRestartedReasonsFromEvent(const lldb::SBEvent &event) {
887 return Process::ProcessEventData::GetNumRestartedReasons(event.get());
891 SBProcess::GetRestartedReasonAtIndexFromEvent(const lldb::SBEvent &event,
893 return Process::ProcessEventData::GetRestartedReasonAtIndex(event.get(), idx);
896 SBProcess SBProcess::GetProcessFromEvent(const SBEvent &event) {
897 ProcessSP process_sp =
898 Process::ProcessEventData::GetProcessFromEvent(event.get());
900 // StructuredData events also know the process they come from.
902 process_sp = EventDataStructuredData::GetProcessFromEvent(event.get());
905 return SBProcess(process_sp);
908 bool SBProcess::GetInterruptedFromEvent(const SBEvent &event) {
909 return Process::ProcessEventData::GetInterruptedFromEvent(event.get());
912 lldb::SBStructuredData
913 SBProcess::GetStructuredDataFromEvent(const lldb::SBEvent &event) {
914 return SBStructuredData(event.GetSP());
917 bool SBProcess::EventIsProcessEvent(const SBEvent &event) {
918 return (event.GetBroadcasterClass() == SBProcess::GetBroadcasterClass()) &&
919 !EventIsStructuredDataEvent(event);
922 bool SBProcess::EventIsStructuredDataEvent(const lldb::SBEvent &event) {
923 EventSP event_sp = event.GetSP();
924 EventData *event_data = event_sp ? event_sp->GetData() : nullptr;
925 return event_data && (event_data->GetFlavor() ==
926 EventDataStructuredData::GetFlavorString());
929 SBBroadcaster SBProcess::GetBroadcaster() const {
930 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
932 ProcessSP process_sp(GetSP());
934 SBBroadcaster broadcaster(process_sp.get(), false);
937 log->Printf("SBProcess(%p)::GetBroadcaster () => SBBroadcaster (%p)",
938 static_cast<void *>(process_sp.get()),
939 static_cast<void *>(broadcaster.get()));
944 const char *SBProcess::GetBroadcasterClass() {
945 return Process::GetStaticBroadcasterClass().AsCString();
948 size_t SBProcess::ReadMemory(addr_t addr, void *dst, size_t dst_len,
950 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
952 size_t bytes_read = 0;
954 ProcessSP process_sp(GetSP());
957 log->Printf("SBProcess(%p)::ReadMemory (addr=0x%" PRIx64
958 ", dst=%p, dst_len=%" PRIu64 ", SBError (%p))...",
959 static_cast<void *>(process_sp.get()), addr,
960 static_cast<void *>(dst), static_cast<uint64_t>(dst_len),
961 static_cast<void *>(sb_error.get()));
964 Process::StopLocker stop_locker;
965 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
966 std::lock_guard<std::recursive_mutex> guard(
967 process_sp->GetTarget().GetAPIMutex());
968 bytes_read = process_sp->ReadMemory(addr, dst, dst_len, sb_error.ref());
971 log->Printf("SBProcess(%p)::ReadMemory() => error: process is running",
972 static_cast<void *>(process_sp.get()));
973 sb_error.SetErrorString("process is running");
976 sb_error.SetErrorString("SBProcess is invalid");
981 sb_error.GetDescription(sstr);
982 log->Printf("SBProcess(%p)::ReadMemory (addr=0x%" PRIx64
983 ", dst=%p, dst_len=%" PRIu64 ", SBError (%p): %s) => %" PRIu64,
984 static_cast<void *>(process_sp.get()), addr,
985 static_cast<void *>(dst), static_cast<uint64_t>(dst_len),
986 static_cast<void *>(sb_error.get()), sstr.GetData(),
987 static_cast<uint64_t>(bytes_read));
993 size_t SBProcess::ReadCStringFromMemory(addr_t addr, void *buf, size_t size,
994 lldb::SBError &sb_error) {
995 size_t bytes_read = 0;
996 ProcessSP process_sp(GetSP());
998 Process::StopLocker stop_locker;
999 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1000 std::lock_guard<std::recursive_mutex> guard(
1001 process_sp->GetTarget().GetAPIMutex());
1002 bytes_read = process_sp->ReadCStringFromMemory(addr, (char *)buf, size,
1005 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1007 log->Printf("SBProcess(%p)::ReadCStringFromMemory() => error: process "
1009 static_cast<void *>(process_sp.get()));
1010 sb_error.SetErrorString("process is running");
1013 sb_error.SetErrorString("SBProcess is invalid");
1018 uint64_t SBProcess::ReadUnsignedFromMemory(addr_t addr, uint32_t byte_size,
1019 lldb::SBError &sb_error) {
1021 ProcessSP process_sp(GetSP());
1023 Process::StopLocker stop_locker;
1024 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1025 std::lock_guard<std::recursive_mutex> guard(
1026 process_sp->GetTarget().GetAPIMutex());
1027 value = process_sp->ReadUnsignedIntegerFromMemory(addr, byte_size, 0,
1030 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1032 log->Printf("SBProcess(%p)::ReadUnsignedFromMemory() => error: process "
1034 static_cast<void *>(process_sp.get()));
1035 sb_error.SetErrorString("process is running");
1038 sb_error.SetErrorString("SBProcess is invalid");
1043 lldb::addr_t SBProcess::ReadPointerFromMemory(addr_t addr,
1044 lldb::SBError &sb_error) {
1045 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
1046 ProcessSP process_sp(GetSP());
1048 Process::StopLocker stop_locker;
1049 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1050 std::lock_guard<std::recursive_mutex> guard(
1051 process_sp->GetTarget().GetAPIMutex());
1052 ptr = process_sp->ReadPointerFromMemory(addr, sb_error.ref());
1054 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1056 log->Printf("SBProcess(%p)::ReadPointerFromMemory() => error: process "
1058 static_cast<void *>(process_sp.get()));
1059 sb_error.SetErrorString("process is running");
1062 sb_error.SetErrorString("SBProcess is invalid");
1067 size_t SBProcess::WriteMemory(addr_t addr, const void *src, size_t src_len,
1068 SBError &sb_error) {
1069 size_t bytes_written = 0;
1071 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1073 ProcessSP process_sp(GetSP());
1076 log->Printf("SBProcess(%p)::WriteMemory (addr=0x%" PRIx64
1077 ", src=%p, src_len=%" PRIu64 ", SBError (%p))...",
1078 static_cast<void *>(process_sp.get()), addr,
1079 static_cast<const void *>(src), static_cast<uint64_t>(src_len),
1080 static_cast<void *>(sb_error.get()));
1083 Process::StopLocker stop_locker;
1084 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1085 std::lock_guard<std::recursive_mutex> guard(
1086 process_sp->GetTarget().GetAPIMutex());
1088 process_sp->WriteMemory(addr, src, src_len, sb_error.ref());
1091 log->Printf("SBProcess(%p)::WriteMemory() => error: process is running",
1092 static_cast<void *>(process_sp.get()));
1093 sb_error.SetErrorString("process is running");
1099 sb_error.GetDescription(sstr);
1100 log->Printf("SBProcess(%p)::WriteMemory (addr=0x%" PRIx64
1101 ", src=%p, src_len=%" PRIu64 ", SBError (%p): %s) => %" PRIu64,
1102 static_cast<void *>(process_sp.get()), addr,
1103 static_cast<const void *>(src), static_cast<uint64_t>(src_len),
1104 static_cast<void *>(sb_error.get()), sstr.GetData(),
1105 static_cast<uint64_t>(bytes_written));
1108 return bytes_written;
1111 bool SBProcess::GetDescription(SBStream &description) {
1112 Stream &strm = description.ref();
1114 ProcessSP process_sp(GetSP());
1116 char path[PATH_MAX];
1117 GetTarget().GetExecutable().GetPath(path, sizeof(path));
1118 Module *exe_module = process_sp->GetTarget().GetExecutableModulePointer();
1119 const char *exe_name = NULL;
1121 exe_name = exe_module->GetFileSpec().GetFilename().AsCString();
1123 strm.Printf("SBProcess: pid = %" PRIu64 ", state = %s, threads = %d%s%s",
1124 process_sp->GetID(), lldb_private::StateAsCString(GetState()),
1125 GetNumThreads(), exe_name ? ", executable = " : "",
1126 exe_name ? exe_name : "");
1128 strm.PutCString("No value");
1134 SBProcess::GetNumSupportedHardwareWatchpoints(lldb::SBError &sb_error) const {
1135 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1138 ProcessSP process_sp(GetSP());
1140 std::lock_guard<std::recursive_mutex> guard(
1141 process_sp->GetTarget().GetAPIMutex());
1142 sb_error.SetError(process_sp->GetWatchpointSupportInfo(num));
1144 log->Printf("SBProcess(%p)::GetNumSupportedHardwareWatchpoints () => %u",
1145 static_cast<void *>(process_sp.get()), num);
1147 sb_error.SetErrorString("SBProcess is invalid");
1152 uint32_t SBProcess::LoadImage(lldb::SBFileSpec &sb_remote_image_spec,
1153 lldb::SBError &sb_error) {
1154 return LoadImage(SBFileSpec(), sb_remote_image_spec, sb_error);
1157 uint32_t SBProcess::LoadImage(const lldb::SBFileSpec &sb_local_image_spec,
1158 const lldb::SBFileSpec &sb_remote_image_spec,
1159 lldb::SBError &sb_error) {
1160 ProcessSP process_sp(GetSP());
1162 Process::StopLocker stop_locker;
1163 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1164 std::lock_guard<std::recursive_mutex> guard(
1165 process_sp->GetTarget().GetAPIMutex());
1166 PlatformSP platform_sp = process_sp->GetTarget().GetPlatform();
1167 return platform_sp->LoadImage(process_sp.get(), *sb_local_image_spec,
1168 *sb_remote_image_spec, sb_error.ref());
1170 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1172 log->Printf("SBProcess(%p)::LoadImage() => error: process is running",
1173 static_cast<void *>(process_sp.get()));
1174 sb_error.SetErrorString("process is running");
1177 return LLDB_INVALID_IMAGE_TOKEN;
1180 lldb::SBError SBProcess::UnloadImage(uint32_t image_token) {
1181 lldb::SBError sb_error;
1182 ProcessSP process_sp(GetSP());
1184 Process::StopLocker stop_locker;
1185 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1186 std::lock_guard<std::recursive_mutex> guard(
1187 process_sp->GetTarget().GetAPIMutex());
1188 PlatformSP platform_sp = process_sp->GetTarget().GetPlatform();
1190 platform_sp->UnloadImage(process_sp.get(), image_token));
1192 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1194 log->Printf("SBProcess(%p)::UnloadImage() => error: process is running",
1195 static_cast<void *>(process_sp.get()));
1196 sb_error.SetErrorString("process is running");
1199 sb_error.SetErrorString("invalid process");
1203 lldb::SBError SBProcess::SendEventData(const char *event_data) {
1204 lldb::SBError sb_error;
1205 ProcessSP process_sp(GetSP());
1207 Process::StopLocker stop_locker;
1208 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1209 std::lock_guard<std::recursive_mutex> guard(
1210 process_sp->GetTarget().GetAPIMutex());
1211 sb_error.SetError(process_sp->SendEventData(event_data));
1213 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1216 "SBProcess(%p)::SendEventData() => error: process is running",
1217 static_cast<void *>(process_sp.get()));
1218 sb_error.SetErrorString("process is running");
1221 sb_error.SetErrorString("invalid process");
1225 uint32_t SBProcess::GetNumExtendedBacktraceTypes() {
1226 ProcessSP process_sp(GetSP());
1227 if (process_sp && process_sp->GetSystemRuntime()) {
1228 SystemRuntime *runtime = process_sp->GetSystemRuntime();
1229 return runtime->GetExtendedBacktraceTypes().size();
1234 const char *SBProcess::GetExtendedBacktraceTypeAtIndex(uint32_t idx) {
1235 ProcessSP process_sp(GetSP());
1236 if (process_sp && process_sp->GetSystemRuntime()) {
1237 SystemRuntime *runtime = process_sp->GetSystemRuntime();
1238 const std::vector<ConstString> &names =
1239 runtime->GetExtendedBacktraceTypes();
1240 if (idx < names.size()) {
1241 return names[idx].AsCString();
1243 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1245 log->Printf("SBProcess(%p)::GetExtendedBacktraceTypeAtIndex() => "
1246 "error: requested extended backtrace name out of bounds",
1247 static_cast<void *>(process_sp.get()));
1253 SBThreadCollection SBProcess::GetHistoryThreads(addr_t addr) {
1254 ProcessSP process_sp(GetSP());
1255 SBThreadCollection threads;
1257 threads = SBThreadCollection(process_sp->GetHistoryThreads(addr));
1262 bool SBProcess::IsInstrumentationRuntimePresent(
1263 InstrumentationRuntimeType type) {
1264 ProcessSP process_sp(GetSP());
1268 InstrumentationRuntimeSP runtime_sp =
1269 process_sp->GetInstrumentationRuntime(type);
1271 if (!runtime_sp.get())
1274 return runtime_sp->IsActive();
1277 lldb::SBError SBProcess::SaveCore(const char *file_name) {
1278 lldb::SBError error;
1279 ProcessSP process_sp(GetSP());
1281 error.SetErrorString("SBProcess is invalid");
1285 std::lock_guard<std::recursive_mutex> guard(
1286 process_sp->GetTarget().GetAPIMutex());
1288 if (process_sp->GetState() != eStateStopped) {
1289 error.SetErrorString("the process is not stopped");
1293 FileSpec core_file(file_name, false);
1294 error.ref() = PluginManager::SaveCore(process_sp, core_file);
1299 SBProcess::GetMemoryRegionInfo(lldb::addr_t load_addr,
1300 SBMemoryRegionInfo &sb_region_info) {
1301 lldb::SBError sb_error;
1302 ProcessSP process_sp(GetSP());
1303 MemoryRegionInfoSP region_info_sp =
1304 std::make_shared<lldb_private::MemoryRegionInfo>();
1306 Process::StopLocker stop_locker;
1307 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1308 std::lock_guard<std::recursive_mutex> guard(
1309 process_sp->GetTarget().GetAPIMutex());
1311 process_sp->GetMemoryRegionInfo(load_addr, *region_info_sp);
1312 if (sb_error.Success()) {
1313 sb_region_info.ref() = *region_info_sp;
1316 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1319 "SBProcess(%p)::GetMemoryRegionInfo() => error: process is running",
1320 static_cast<void *>(process_sp.get()));
1321 sb_error.SetErrorString("process is running");
1324 sb_error.SetErrorString("SBProcess is invalid");
1329 lldb::SBMemoryRegionInfoList SBProcess::GetMemoryRegions() {
1330 lldb::SBError sb_error;
1331 lldb::SBMemoryRegionInfoList sb_region_list;
1332 ProcessSP process_sp(GetSP());
1334 Process::StopLocker stop_locker;
1335 if (stop_locker.TryLock(&process_sp->GetRunLock())) {
1336 std::lock_guard<std::recursive_mutex> guard(
1337 process_sp->GetTarget().GetAPIMutex());
1338 std::vector<MemoryRegionInfoSP> region_list;
1339 sb_error.ref() = process_sp->GetMemoryRegions(region_list);
1340 if (sb_error.Success()) {
1341 std::vector<MemoryRegionInfoSP>::iterator end = region_list.end();
1342 for (std::vector<MemoryRegionInfoSP>::iterator it = region_list.begin();
1344 SBMemoryRegionInfo sb_region_info(it->get());
1345 sb_region_list.Append(sb_region_info);
1349 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
1352 "SBProcess(%p)::GetMemoryRegionInfo() => error: process is running",
1353 static_cast<void *>(process_sp.get()));
1354 sb_error.SetErrorString("process is running");
1357 sb_error.SetErrorString("SBProcess is invalid");
1359 return sb_region_list;