LLDB mainline
SBTrace.cpp
Go to the documentation of this file.
1//===-- SBTrace.cpp -------------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
11
12#include "lldb/API/SBDebugger.h"
14#include "lldb/API/SBThread.h"
15#include "lldb/API/SBTrace.h"
16
18
19#include <memory>
20
21using namespace lldb;
22using namespace lldb_private;
23using namespace llvm;
24
26
27SBTrace::SBTrace(const lldb::TraceSP &trace_sp) : m_opaque_sp(trace_sp) {
28 LLDB_INSTRUMENT_VA(this, trace_sp);
29}
30
32 const SBFileSpec &trace_description_file) {
33 LLDB_INSTRUMENT_VA(error, debugger, trace_description_file);
34
35 Expected<lldb::TraceSP> trace_or_err = Trace::LoadPostMortemTraceFromFile(
36 debugger.ref(), trace_description_file.ref());
37
38 if (!trace_or_err) {
39 error.SetErrorString(toString(trace_or_err.takeError()).c_str());
40 return SBTrace();
41 }
42
43 return SBTrace(trace_or_err.get());
44}
45
47 LLDB_INSTRUMENT_VA(this, error, thread);
48
49 if (!m_opaque_sp) {
50 error.SetErrorString("error: invalid trace");
51 return SBTraceCursor();
52 }
53 if (!thread.get()) {
54 error.SetErrorString("error: invalid thread");
55 return SBTraceCursor();
56 }
57
58 if (llvm::Expected<lldb::TraceCursorSP> trace_cursor_sp =
59 m_opaque_sp->CreateNewCursor(*thread.get())) {
60 return SBTraceCursor(std::move(*trace_cursor_sp));
61 } else {
62 error.SetErrorString(llvm::toString(trace_cursor_sp.takeError()).c_str());
63 return SBTraceCursor();
64 }
65}
66
68 bool compact) {
69 LLDB_INSTRUMENT_VA(this, error, bundle_dir, compact);
70
71 error.Clear();
72 SBFileSpec file_spec;
73
74 if (!m_opaque_sp)
75 error.SetErrorString("error: invalid trace");
76 else if (Expected<FileSpec> desc_file =
77 m_opaque_sp->SaveToDisk(bundle_dir.ref(), compact))
78 file_spec.SetFileSpec(*desc_file);
79 else
80 error.SetErrorString(llvm::toString(desc_file.takeError()).c_str());
81
82 return file_spec;
83}
84
87 if (!m_opaque_sp)
88 return nullptr;
89
90 return ConstString(m_opaque_sp->GetStartConfigurationHelp()).GetCString();
91}
92
94 LLDB_INSTRUMENT_VA(this, configuration);
96 if (!m_opaque_sp)
97 error.SetErrorString("error: invalid trace");
98 else if (llvm::Error err =
99 m_opaque_sp->Start(configuration.m_impl_up->GetObjectSP()))
100 error.SetErrorString(llvm::toString(std::move(err)).c_str());
101 return error;
102}
103
105 const SBStructuredData &configuration) {
106 LLDB_INSTRUMENT_VA(this, thread, configuration);
107
109 if (!m_opaque_sp)
110 error.SetErrorString("error: invalid trace");
111 else {
112 if (llvm::Error err =
113 m_opaque_sp->Start(std::vector<lldb::tid_t>{thread.GetThreadID()},
114 configuration.m_impl_up->GetObjectSP()))
115 error.SetErrorString(llvm::toString(std::move(err)).c_str());
116 }
117
118 return error;
119}
120
122 LLDB_INSTRUMENT_VA(this);
124 if (!m_opaque_sp)
125 error.SetErrorString("error: invalid trace");
126 else if (llvm::Error err = m_opaque_sp->Stop())
127 error.SetErrorString(llvm::toString(std::move(err)).c_str());
128 return error;
129}
130
132 LLDB_INSTRUMENT_VA(this, thread);
134 if (!m_opaque_sp)
135 error.SetErrorString("error: invalid trace");
136 else if (llvm::Error err = m_opaque_sp->Stop({thread.GetThreadID()}))
137 error.SetErrorString(llvm::toString(std::move(err)).c_str());
138 return error;
139}
140
142 LLDB_INSTRUMENT_VA(this);
143 return this->operator bool();
144}
145
146SBTrace::operator bool() const {
147 LLDB_INSTRUMENT_VA(this);
148 return (bool)m_opaque_sp;
149}
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_INSTRUMENT_VA(...)
lldb_private::Debugger & ref() const
void SetFileSpec(const lldb_private::FileSpec &fspec)
Definition: SBFileSpec.cpp:164
const lldb_private::FileSpec & ref() const
Definition: SBFileSpec.cpp:162
StructuredDataImplUP m_impl_up
lldb_private::Thread * get()
Definition: SBThread.cpp:1338
bool IsValid()
Definition: SBTrace.cpp:141
const char * GetStartConfigurationHelp()
Definition: SBTrace.cpp:85
SBTrace()
Default constructor for an invalid Trace object.
Definition: SBTrace.cpp:25
SBError Start(const SBStructuredData &configuration)
Start tracing all current and future threads in a live process using a provided configuration.
Definition: SBTrace.cpp:93
SBTraceCursor CreateNewCursor(SBError &error, SBThread &thread)
Get a TraceCursor for the given thread's trace.
Definition: SBTrace.cpp:46
SBError Stop()
Stop tracing all threads in a live process.
Definition: SBTrace.cpp:121
static SBTrace LoadTraceFromFile(SBError &error, SBDebugger &debugger, const SBFileSpec &trace_description_file)
See SBDebugger::LoadTraceFromFile.
Definition: SBTrace.cpp:31
SBFileSpec SaveToDisk(SBError &error, const SBFileSpec &bundle_dir, bool compact=false)
Save the trace to the specified directory, which will be created if needed.
Definition: SBTrace.cpp:67
lldb::TraceSP m_opaque_sp
Definition: SBTrace.h:142
A uniqued constant string class.
Definition: ConstString.h:40
const char * GetCString() const
Get the string value as a C string.
Definition: ConstString.h:214
static llvm::Expected< lldb::TraceSP > LoadPostMortemTraceFromFile(Debugger &debugger, const FileSpec &trace_description_file)
Load a trace from a trace description file and create Targets, Processes and Threads based on the con...
Definition: Trace.cpp:96
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
const char * toString(AppleArm64ExceptionClass EC)
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::Trace > TraceSP
Definition: lldb-forward.h:446
Definition: Debugger.h:54