[Reproducers] Capture return values of functions returning by ptr/ref

For some reason I had convinced myself that functions returning by
pointer or reference do not require recording their result. However,
after further considering I don't see how that could work, at least not
with the current implementation. Interestingly enough, the reproducer
instrumentation already (mostly) accounts for this, though the
lldb-instr tool did not.

This patch adds the missing macros and updates the lldb-instr tool.

Differential revision: https://reviews.llvm.org/D60178

llvm-svn: 357639

lldb/include/lldb/Utility/ReproducerInstrumentation.h

@@ -185,7 +185,7 @@ template <typename... Ts> inline std::string log_args(const Ts &... ts) {
   }
 
 #define LLDB_RECORD_RESULT(Result)                                             \
-  sb_recorder ? sb_recorder->RecordResult(Result) : Result;
+  sb_recorder ? sb_recorder->RecordResult(Result) : (Result);
 
 /// The LLDB_RECORD_DUMMY macro is special because it doesn't actually record
 /// anything. It's used to track API boundaries when we cannot record for
@@ -643,13 +643,7 @@ public:
       return;
 
     unsigned id = m_registry.GetID(uintptr_t(f));
-
+    Log(id);
-#ifndef LLDB_REPRO_INSTR_TRACE
-    LLDB_LOG(GetLogIfAllCategoriesSet(LIBLLDB_LOG_API), "Recording {0}: {1}",
-             id, m_pretty_func);
-#else
-    llvm::errs() << "Recording " << id << ": " << m_pretty_func << "\n";
-#endif
 
     m_serializer.SerializeAll(id);
     m_serializer.SerializeAll(args...);
@@ -670,13 +664,7 @@ public:
       return;
 
     unsigned id = m_registry.GetID(uintptr_t(f));
-
+    Log(id);
-#ifndef LLDB_REPRO_INSTR_TRACE
-    LLDB_LOG(GetLogIfAllCategoriesSet(LIBLLDB_LOG_API), "Recording {0}: {1}",
-             id, m_pretty_func);
-#else
-    llvm::errs() << "Recording " << id << ": " << m_pretty_func << "\n";
-#endif
 
     m_serializer.SerializeAll(id);
     m_serializer.SerializeAll(args...);
@@ -687,14 +675,14 @@ public:
   }
 
   /// Record the result of a function call.
-  template <typename Result> Result RecordResult(const Result &r) {
+  template <typename Result> Result RecordResult(Result &&r) {
     UpdateBoundary();
     if (ShouldCapture()) {
       assert(!m_result_recorded);
       m_serializer.SerializeAll(r);
       m_result_recorded = true;
     }
-    return r;
+    return std::forward<Result>(r);
   }
 
 private:
@@ -704,6 +692,7 @@ private:
   }
 
   bool ShouldCapture() { return m_local_boundary; }
+  void Log(unsigned id);
 
   Serializer &m_serializer;
   Registry &m_registry;

lldb/lit/tools/lldb-instr/Inputs/foo.cpp

@@ -16,3 +16,11 @@ Foo Foo::H() { return Foo(); }
 void Foo::I() const { MACRO_FOO; }
 Bar Foo::J() const { return MACRO_BAR(Bar()); }
 Bar Foo::K(void *v) const { return Bar(); }
+Bar &Foo::L() const {
+  Bar *b = new Bar();
+  return *b;
+};
+Bar *Foo::M() const {
+  Bar *b = new Bar();
+  return b;
+};

lldb/lit/tools/lldb-instr/Inputs/foo.h

@@ -14,4 +14,6 @@ struct Foo {
   void I() const;
   Bar J() const;
   Bar K(void *v) const;
+  Bar &L() const;
+  Bar *M() const;
 };

lldb/lit/tools/lldb-instr/TestInstrumentationRecord.test

@@ -20,3 +20,5 @@
 # CHECK-NOT: LLDB_RECORD_RESULT(Bar());
 # CHECK: LLDB_RECORD_DUMMY(Bar, Foo, K, (void *), v);
 # CHECK-NOT: LLDB_RECORD_RESULT(Bar());
+# CHECK: LLDB_RECORD_RESULT(*b)
+# CHECK: LLDB_RECORD_RESULT(b)

lldb/lit/tools/lldb-instr/TestInstrumentationRegister.test

@@ -11,6 +11,9 @@
 # CHECK: LLDB_REGISTER_METHOD_CONST(int, Foo, D, (bool));
 # CHECK: LLDB_REGISTER_STATIC_METHOD(void, Foo, E, ());
 # CHECK: LLDB_REGISTER_STATIC_METHOD(int, Foo, F, (int));
+# CHECK: LLDB_REGISTER_METHOD_CONST(Bar, Foo, J, ());
+# CHECK: LLDB_REGISTER_METHOD_CONST(Bar &, Foo, L, ());
+# CHECK: LLDB_REGISTER_METHOD_CONST(Bar *, Foo, M, ());
 # CHECK-NOT: LLDB_REGISTER_STATIC_METHOD(void, Foo, G
 # CHECK-NOT: LLDB_REGISTER_METHOD_CONST(void, Foo, I, ());
 # CHECK-NOT: LLDB_REGISTER_METHOD_CONST(Bar, Foo, K, (void*));

lldb/source/API/SBAddress.cpp

@@ -60,7 +60,7 @@ const SBAddress &SBAddress::operator=(const SBAddress &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool lldb::operator==(const SBAddress &lhs, const SBAddress &rhs) {

lldb/source/API/SBAttachInfo.cpp

@@ -64,7 +64,7 @@ SBAttachInfo &SBAttachInfo::operator=(const SBAttachInfo &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = clone(rhs.m_opaque_sp);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 lldb::pid_t SBAttachInfo::GetProcessID() {

lldb/source/API/SBBlock.cpp

@@ -41,7 +41,7 @@ const SBBlock &SBBlock::operator=(const SBBlock &rhs) {
                      SBBlock, operator=,(const lldb::SBBlock &), rhs);
 
   m_opaque_ptr = rhs.m_opaque_ptr;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBBlock::~SBBlock() { m_opaque_ptr = NULL; }

lldb/source/API/SBBreakpoint.cpp

@@ -62,7 +62,7 @@ const SBBreakpoint &SBBreakpoint::operator=(const SBBreakpoint &rhs) {
                      SBBreakpoint, operator=,(const lldb::SBBreakpoint &), rhs);
 
   m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBBreakpoint::operator==(const lldb::SBBreakpoint &rhs) {

lldb/source/API/SBBreakpointLocation.cpp

@@ -54,7 +54,7 @@ operator=(const SBBreakpointLocation &rhs) {
       rhs);
 
   m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBBreakpointLocation::~SBBreakpointLocation() {}

lldb/source/API/SBBreakpointName.cpp

@@ -166,12 +166,12 @@ operator=(const SBBreakpointName &rhs) {
 
   if (!rhs.m_impl_up) {
     m_impl_up.reset();
-    return *this;
+    return LLDB_RECORD_RESULT(*this);
   }
 
   m_impl_up.reset(new SBBreakpointNameImpl(rhs.m_impl_up->GetTarget(),
                                            rhs.m_impl_up->GetName()));
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBBreakpointName::operator==(const lldb::SBBreakpointName &rhs) {

lldb/source/API/SBBroadcaster.cpp

@@ -45,7 +45,7 @@ const SBBroadcaster &SBBroadcaster::operator=(const SBBroadcaster &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
     m_opaque_ptr = rhs.m_opaque_ptr;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBBroadcaster::~SBBroadcaster() { reset(NULL, false); }

lldb/source/API/SBCommandInterpreter.cpp

@@ -196,7 +196,7 @@ operator=(const SBCommandInterpreter &rhs) {
       rhs);
 
   m_opaque_ptr = rhs.m_opaque_ptr;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBCommandInterpreter::IsValid() const {

lldb/source/API/SBCommandReturnObject.cpp

@@ -43,7 +43,7 @@ CommandReturnObject *SBCommandReturnObject::Release() {
   LLDB_RECORD_METHOD_NO_ARGS(lldb_private::CommandReturnObject *,
                              SBCommandReturnObject, Release);
 
-  return m_opaque_up.release();
+  return LLDB_RECORD_RESULT(m_opaque_up.release());
 }
 
 const SBCommandReturnObject &SBCommandReturnObject::
@@ -55,7 +55,7 @@ operator=(const SBCommandReturnObject &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBCommandReturnObject::IsValid() const {

lldb/source/API/SBCompileUnit.cpp

@@ -38,7 +38,7 @@ const SBCompileUnit &SBCompileUnit::operator=(const SBCompileUnit &rhs) {
                      rhs);
 
   m_opaque_ptr = rhs.m_opaque_ptr;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBCompileUnit::~SBCompileUnit() { m_opaque_ptr = NULL; }

lldb/source/API/SBData.cpp

@@ -38,7 +38,7 @@ const SBData &SBData::operator=(const SBData &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBData::~SBData() {}

lldb/source/API/SBDebugger.cpp

@@ -182,7 +182,7 @@ SBDebugger &SBDebugger::operator=(const SBDebugger &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBDebugger::Initialize() {
@@ -373,7 +373,7 @@ FILE *SBDebugger::GetInputFileHandle() {
   if (m_opaque_sp) {
     StreamFileSP stream_file_sp(m_opaque_sp->GetInputFile());
     if (stream_file_sp)
-      return stream_file_sp->GetFile().GetStream();
+      return LLDB_RECORD_RESULT(stream_file_sp->GetFile().GetStream());
   }
   return nullptr;
 }
@@ -384,7 +384,7 @@ FILE *SBDebugger::GetOutputFileHandle() {
   if (m_opaque_sp) {
     StreamFileSP stream_file_sp(m_opaque_sp->GetOutputFile());
     if (stream_file_sp)
-      return stream_file_sp->GetFile().GetStream();
+      return LLDB_RECORD_RESULT(stream_file_sp->GetFile().GetStream());
   }
   return nullptr;
 }
@@ -395,7 +395,7 @@ FILE *SBDebugger::GetErrorFileHandle() {
   if (m_opaque_sp) {
     StreamFileSP stream_file_sp(m_opaque_sp->GetErrorFile());
     if (stream_file_sp)
-      return stream_file_sp->GetFile().GetStream();
+      return LLDB_RECORD_RESULT(stream_file_sp->GetFile().GetStream());
   }
   return nullptr;
 }

lldb/source/API/SBDeclaration.cpp

@@ -42,7 +42,7 @@ const SBDeclaration &SBDeclaration::operator=(const SBDeclaration &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBDeclaration::SetDeclaration(

lldb/source/API/SBError.cpp

@@ -33,7 +33,7 @@ const SBError &SBError::operator=(const SBError &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 const char *SBError::GetCString() const {

lldb/source/API/SBEvent.cpp

@@ -55,7 +55,7 @@ const SBEvent &SBEvent::operator=(const SBEvent &rhs) {
     m_event_sp = rhs.m_event_sp;
     m_opaque_ptr = rhs.m_opaque_ptr;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBEvent::~SBEvent() {}

lldb/source/API/SBExecutionContext.cpp

@@ -75,7 +75,7 @@ operator=(const lldb::SBExecutionContext &rhs) {
       SBExecutionContext, operator=,(const lldb::SBExecutionContext &), rhs);
 
   m_exe_ctx_sp = rhs.m_exe_ctx_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 ExecutionContextRef *SBExecutionContext::get() const {

lldb/source/API/SBExpressionOptions.cpp

@@ -37,7 +37,7 @@ operator=(const SBExpressionOptions &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBExpressionOptions::~SBExpressionOptions() {}

lldb/source/API/SBFileSpec.cpp

@@ -59,7 +59,7 @@ const SBFileSpec &SBFileSpec::operator=(const SBFileSpec &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBFileSpec::operator==(const SBFileSpec &rhs) const {

lldb/source/API/SBFileSpecList.cpp

@@ -41,7 +41,7 @@ const SBFileSpecList &SBFileSpecList::operator=(const SBFileSpecList &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 uint32_t SBFileSpecList::GetSize() const {

lldb/source/API/SBFrame.cpp

@@ -78,7 +78,7 @@ const SBFrame &SBFrame::operator=(const SBFrame &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = clone(rhs.m_opaque_sp);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 StackFrameSP SBFrame::GetFrameSP() const {

lldb/source/API/SBFunction.cpp

@@ -39,7 +39,7 @@ const SBFunction &SBFunction::operator=(const SBFunction &rhs) {
                      SBFunction, operator=,(const lldb::SBFunction &), rhs);
 
   m_opaque_ptr = rhs.m_opaque_ptr;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBFunction::~SBFunction() { m_opaque_ptr = NULL; }

lldb/source/API/SBInstruction.cpp

@@ -87,7 +87,7 @@ const SBInstruction &SBInstruction::operator=(const SBInstruction &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBInstruction::~SBInstruction() {}

lldb/source/API/SBInstructionList.cpp

@@ -37,7 +37,7 @@ operator=(const SBInstructionList &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBInstructionList::~SBInstructionList() {}

lldb/source/API/SBLineEntry.cpp

@@ -41,7 +41,7 @@ const SBLineEntry &SBLineEntry::operator=(const SBLineEntry &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBLineEntry::SetLineEntry(const lldb_private::LineEntry &lldb_object_ref) {

lldb/source/API/SBListener.cpp

@@ -42,7 +42,7 @@ const lldb::SBListener &SBListener::operator=(const lldb::SBListener &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
     m_unused_ptr = nullptr;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBListener::SBListener(const lldb::ListenerSP &listener_sp)

lldb/source/API/SBMemoryRegionInfo.cpp

@@ -43,7 +43,7 @@ operator=(const SBMemoryRegionInfo &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBMemoryRegionInfo::~SBMemoryRegionInfo() {}

lldb/source/API/SBMemoryRegionInfoList.cpp

@@ -94,7 +94,7 @@ operator=(const SBMemoryRegionInfoList &rhs) {
   if (this != &rhs) {
     *m_opaque_up = *rhs.m_opaque_up;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 uint32_t SBMemoryRegionInfoList::GetSize() const {

lldb/source/API/SBModule.cpp

@@ -73,7 +73,7 @@ const SBModule &SBModule::operator=(const SBModule &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBModule::~SBModule() {}

lldb/source/API/SBModuleSpec.cpp

@@ -35,7 +35,7 @@ const SBModuleSpec &SBModuleSpec::operator=(const SBModuleSpec &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBModuleSpec::~SBModuleSpec() {}
@@ -166,7 +166,7 @@ SBModuleSpecList &SBModuleSpecList::operator=(const SBModuleSpecList &rhs) {
 
   if (this != &rhs)
     *m_opaque_up = *rhs.m_opaque_up;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBModuleSpecList::~SBModuleSpecList() {}

lldb/source/API/SBProcess.cpp

@@ -72,7 +72,7 @@ const SBProcess &SBProcess::operator=(const SBProcess &rhs) {
 
   if (this != &rhs)
     m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 //----------------------------------------------------------------------

lldb/source/API/SBProcessInfo.cpp

@@ -34,7 +34,7 @@ SBProcessInfo &SBProcessInfo::operator=(const SBProcessInfo &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 ProcessInstanceInfo &SBProcessInfo::ref() {

lldb/source/API/SBQueue.cpp

@@ -240,7 +240,7 @@ const lldb::SBQueue &SBQueue::operator=(const lldb::SBQueue &rhs) {
                      SBQueue, operator=,(const lldb::SBQueue &), rhs);
 
   m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBQueue::~SBQueue() {}

lldb/source/API/SBSection.cpp

@@ -41,7 +41,7 @@ const SBSection &SBSection::operator=(const SBSection &rhs) {
                      SBSection, operator=,(const lldb::SBSection &), rhs);
 
   m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBSection::~SBSection() {}

lldb/source/API/SBSourceManager.cpp

@@ -101,7 +101,7 @@ operator=(const lldb::SBSourceManager &rhs) {
                      rhs);
 
   m_opaque_up.reset(new SourceManagerImpl(*(rhs.m_opaque_up.get())));
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBSourceManager::~SBSourceManager() {}

lldb/source/API/SBStringList.cpp

@@ -36,7 +36,7 @@ const SBStringList &SBStringList::operator=(const SBStringList &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBStringList::~SBStringList() {}

lldb/source/API/SBStructuredData.cpp

@@ -54,7 +54,7 @@ operator=(const lldb::SBStructuredData &rhs) {
       SBStructuredData, operator=,(const lldb::SBStructuredData &), rhs);
 
   *m_impl_up = *rhs.m_impl_up;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 lldb::SBError SBStructuredData::SetFromJSON(lldb::SBStream &stream) {

lldb/source/API/SBSymbol.cpp

@@ -34,7 +34,7 @@ const SBSymbol &SBSymbol::operator=(const SBSymbol &rhs) {
                      SBSymbol, operator=,(const lldb::SBSymbol &), rhs);
 
   m_opaque_ptr = rhs.m_opaque_ptr;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBSymbol::~SBSymbol() { m_opaque_ptr = NULL; }

lldb/source/API/SBSymbolContext.cpp

@@ -46,7 +46,7 @@ const SBSymbolContext &SBSymbolContext::operator=(const SBSymbolContext &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBSymbolContext::SetSymbolContext(const SymbolContext *sc_ptr) {

lldb/source/API/SBSymbolContextList.cpp

@@ -38,7 +38,7 @@ operator=(const SBSymbolContextList &rhs) {
 
   if (this != &rhs)
     m_opaque_up = clone(rhs.m_opaque_up);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 uint32_t SBSymbolContextList::GetSize() const {

lldb/source/API/SBTarget.cpp

@@ -118,7 +118,7 @@ const SBTarget &SBTarget::operator=(const SBTarget &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 //----------------------------------------------------------------------

lldb/source/API/SBThread.cpp

@@ -84,7 +84,7 @@ const lldb::SBThread &SBThread::operator=(const SBThread &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = clone(rhs.m_opaque_sp);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 //----------------------------------------------------------------------
@@ -1402,9 +1402,8 @@ lldb_private::Thread *SBThread::operator->() {
 
   ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
   if (thread_sp)
-    return thread_sp.get();
+    return LLDB_RECORD_RESULT(thread_sp.get());
-  else
+  return nullptr;
-    return NULL;
 }
 
 lldb_private::Thread *SBThread::get() {
@@ -1412,9 +1411,8 @@ lldb_private::Thread *SBThread::get() {
 
   ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
   if (thread_sp)
-    return thread_sp.get();
+    return LLDB_RECORD_RESULT(thread_sp.get());
-  else
+  return nullptr;
-    return NULL;
 }
 
 namespace lldb_private {

lldb/source/API/SBThreadCollection.cpp

@@ -32,7 +32,7 @@ operator=(const SBThreadCollection &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBThreadCollection::SBThreadCollection(const ThreadCollectionSP &threads)

lldb/source/API/SBThreadPlan.cpp

@@ -82,7 +82,7 @@ const lldb::SBThreadPlan &SBThreadPlan::operator=(const SBThreadPlan &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 //----------------------------------------------------------------------
 // Destructor
@@ -92,7 +92,7 @@ SBThreadPlan::~SBThreadPlan() {}
 lldb_private::ThreadPlan *SBThreadPlan::get() {
   LLDB_RECORD_METHOD_NO_ARGS(lldb_private::ThreadPlan *, SBThreadPlan, get);
 
-  return m_opaque_sp.get();
+  return LLDB_RECORD_RESULT(m_opaque_sp.get());
 }
 
 bool SBThreadPlan::IsValid() const {

lldb/source/API/SBType.cpp

@@ -86,7 +86,7 @@ SBType &SBType::operator=(const SBType &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBType::~SBType() {}
@@ -592,7 +592,7 @@ SBTypeList &SBTypeList::operator=(const SBTypeList &rhs) {
          i < rhs_size; i++)
       Append(const_cast<SBTypeList &>(rhs).GetTypeAtIndex(i));
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBTypeList::Append(SBType type) {
@@ -642,7 +642,7 @@ lldb::SBTypeMember &SBTypeMember::operator=(const lldb::SBTypeMember &rhs) {
     if (rhs.IsValid())
       m_opaque_up.reset(new TypeMemberImpl(rhs.ref()));
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeMember::IsValid() const {
@@ -771,7 +771,7 @@ operator=(const lldb::SBTypeMemberFunction &rhs) {
 
   if (this != &rhs)
     m_opaque_sp = rhs.m_opaque_sp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeMemberFunction::IsValid() const {

lldb/source/API/SBTypeCategory.cpp

@@ -616,7 +616,7 @@ operator=(const lldb::SBTypeCategory &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeCategory::operator==(lldb::SBTypeCategory &rhs) {

lldb/source/API/SBTypeEnumMember.cpp

@@ -40,12 +40,13 @@ SBTypeEnumMember::SBTypeEnumMember(const SBTypeEnumMember &rhs)
 }
 
 SBTypeEnumMember &SBTypeEnumMember::operator=(const SBTypeEnumMember &rhs) {
-  LLDB_RECORD_CONSTRUCTOR(SBTypeEnumMember, (const lldb::SBTypeEnumMember &),
+  LLDB_RECORD_METHOD(
-                          rhs);
+      SBTypeEnumMember &,
+      SBTypeEnumMember, operator=,(const lldb::SBTypeEnumMember &), rhs);
 
   if (this != &rhs)
     m_opaque_sp = clone(rhs.m_opaque_sp);
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeEnumMember::IsValid() const {
@@ -147,7 +148,7 @@ operator=(const SBTypeEnumMemberList &rhs) {
       Append(
           const_cast<SBTypeEnumMemberList &>(rhs).GetTypeEnumMemberAtIndex(i));
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 void SBTypeEnumMemberList::Append(SBTypeEnumMember enum_member) {

lldb/source/API/SBTypeFilter.cpp

@@ -126,7 +126,7 @@ lldb::SBTypeFilter &SBTypeFilter::operator=(const lldb::SBTypeFilter &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeFilter::operator==(lldb::SBTypeFilter &rhs) {

lldb/source/API/SBTypeFormat.cpp

@@ -121,7 +121,7 @@ lldb::SBTypeFormat &SBTypeFormat::operator=(const lldb::SBTypeFormat &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeFormat::operator==(lldb::SBTypeFormat &rhs) {

lldb/source/API/SBTypeNameSpecifier.cpp

@@ -108,7 +108,7 @@ operator=(const lldb::SBTypeNameSpecifier &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeNameSpecifier::operator==(lldb::SBTypeNameSpecifier &rhs) {

lldb/source/API/SBTypeSummary.cpp

@@ -345,7 +345,7 @@ lldb::SBTypeSummary &SBTypeSummary::operator=(const lldb::SBTypeSummary &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeSummary::operator==(lldb::SBTypeSummary &rhs) {

lldb/source/API/SBTypeSynthetic.cpp

@@ -143,7 +143,7 @@ operator=(const lldb::SBTypeSynthetic &rhs) {
   if (this != &rhs) {
     m_opaque_sp = rhs.m_opaque_sp;
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 bool SBTypeSynthetic::operator==(lldb::SBTypeSynthetic &rhs) {

lldb/source/API/SBUnixSignals.cpp

@@ -40,7 +40,7 @@ const SBUnixSignals &SBUnixSignals::operator=(const SBUnixSignals &rhs) {
 
   if (this != &rhs)
     m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBUnixSignals::~SBUnixSignals() {}

lldb/source/API/SBValue.cpp

@@ -236,7 +236,7 @@ SBValue &SBValue::operator=(const SBValue &rhs) {
   if (this != &rhs) {
     SetSP(rhs.m_opaque_sp);
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBValue::~SBValue() {}

lldb/source/API/SBValueList.cpp

@@ -111,7 +111,7 @@ const SBValueList &SBValueList::operator=(const SBValueList &rhs) {
     else
       m_opaque_up.reset();
   }
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 ValueListImpl *SBValueList::operator->() { return m_opaque_up.get(); }

lldb/source/API/SBVariablesOptions.cpp

@@ -99,7 +99,7 @@ operator=(const SBVariablesOptions &options) {
       options);
 
   m_opaque_up.reset(new VariablesOptionsImpl(options.ref()));
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBVariablesOptions::~SBVariablesOptions() = default;

lldb/source/API/SBWatchpoint.cpp

@@ -43,7 +43,7 @@ const SBWatchpoint &SBWatchpoint::operator=(const SBWatchpoint &rhs) {
                      SBWatchpoint, operator=,(const lldb::SBWatchpoint &), rhs);
 
   m_opaque_wp = rhs.m_opaque_wp;
-  return *this;
+  return LLDB_RECORD_RESULT(*this);
 }
 
 SBWatchpoint::~SBWatchpoint() {}

lldb/source/Utility/ReproducerInstrumentation.cpp

@@ -117,4 +117,13 @@ Recorder::~Recorder() {
   UpdateBoundary();
 }
 
+void Recorder::Log(unsigned id) {
+#ifndef LLDB_REPRO_INSTR_TRACE
+  LLDB_LOG(GetLogIfAllCategoriesSet(LIBLLDB_LOG_API), "Recording {0}: {1}", id,
+           m_pretty_func);
+#else
+  llvm::errs() << "Recording " << id << ": " << m_pretty_func << "\n";
+#endif
+}
+
 bool lldb_private::repro::Recorder::g_global_boundary;

lldb/tools/lldb-instr/Instrument.cpp

@@ -245,7 +245,9 @@ public:
 
     // If the function returns a class or struct, we need to wrap its return
     // statement(s).
-    if (!ShouldInsertDummy && ReturnType->isStructureOrClassType()) {
+    bool ShouldRecordResult = ReturnType->isStructureOrClassType() ||
+                              ReturnType->getPointeeCXXRecordDecl();
+    if (!ShouldInsertDummy && ShouldRecordResult) {
       SBReturnVisitor Visitor(MyRewriter);
       Visitor.TraverseDecl(Decl);
     }

lldb/unittests/Utility/ReproducerInstrumentationTest.cpp

@@ -89,6 +89,8 @@ public:
   /// {
   InstrumentedBar();
   InstrumentedFoo GetInstrumentedFoo();
+  InstrumentedFoo &GetInstrumentedFooRef();
+  InstrumentedFoo *GetInstrumentedFooPtr();
   void SetInstrumentedFoo(InstrumentedFoo *foo);
   void SetInstrumentedFoo(InstrumentedFoo &foo);
   void Validate();
@@ -201,6 +203,22 @@ InstrumentedFoo InstrumentedBar::GetInstrumentedFoo() {
   return LLDB_RECORD_RESULT(InstrumentedFoo(0));
 }
 
+InstrumentedFoo &InstrumentedBar::GetInstrumentedFooRef() {
+  LLDB_RECORD_METHOD_NO_ARGS(InstrumentedFoo &, InstrumentedBar,
+                             GetInstrumentedFooRef);
+  InstrumentedFoo *foo = new InstrumentedFoo(0);
+  m_get_instrumend_foo_called = true;
+  return LLDB_RECORD_RESULT(*foo);
+}
+
+InstrumentedFoo *InstrumentedBar::GetInstrumentedFooPtr() {
+  LLDB_RECORD_METHOD_NO_ARGS(InstrumentedFoo *, InstrumentedBar,
+                             GetInstrumentedFooPtr);
+  InstrumentedFoo *foo = new InstrumentedFoo(0);
+  m_get_instrumend_foo_called = true;
+  return LLDB_RECORD_RESULT(foo);
+}
+
 void InstrumentedBar::SetInstrumentedFoo(InstrumentedFoo *foo) {
   LLDB_RECORD_METHOD(void, InstrumentedBar, SetInstrumentedFoo,
                      (InstrumentedFoo *), foo);
@@ -239,6 +257,10 @@ TestingRegistry::TestingRegistry() {
   LLDB_REGISTER_CONSTRUCTOR(InstrumentedBar, ());
   LLDB_REGISTER_METHOD(InstrumentedFoo, InstrumentedBar, GetInstrumentedFoo,
                        ());
+  LLDB_REGISTER_METHOD(InstrumentedFoo &, InstrumentedBar,
+                       GetInstrumentedFooRef, ());
+  LLDB_REGISTER_METHOD(InstrumentedFoo *, InstrumentedBar,
+                       GetInstrumentedFooPtr, ());
   LLDB_REGISTER_METHOD(void, InstrumentedBar, SetInstrumentedFoo,
                        (InstrumentedFoo *));
   LLDB_REGISTER_METHOD(void, InstrumentedBar, SetInstrumentedFoo,
@@ -487,6 +509,80 @@ TEST(RecordReplayTest, InstrumentedBar) {
   {
     InstrumentedBar bar;
     InstrumentedFoo foo = bar.GetInstrumentedFoo();
+#if 0
+    InstrumentedFoo& foo_ref = bar.GetInstrumentedFooRef();
+    InstrumentedFoo* foo_ptr = bar.GetInstrumentedFooPtr();
+#endif
+
+    int b = 200;
+    float c = 300.3;
+    double e = 400.4;
+
+    foo.A(100);
+    foo.B(b);
+    foo.C(&c);
+    foo.D("bar");
+    InstrumentedFoo::E(e);
+    InstrumentedFoo::F();
+    foo.Validate();
+
+    bar.SetInstrumentedFoo(foo);
+    bar.SetInstrumentedFoo(&foo);
+    bar.Validate();
+  }
+
+  ClearObjects();
+
+  TestingRegistry registry;
+  registry.Replay(os.str());
+
+  ValidateObjects(1, 1);
+}
+
+TEST(RecordReplayTest, InstrumentedBarRef) {
+  std::string str;
+  llvm::raw_string_ostream os(str);
+  g_registry.emplace();
+  g_serializer.emplace(os);
+
+  {
+    InstrumentedBar bar;
+    InstrumentedFoo &foo = bar.GetInstrumentedFooRef();
+
+    int b = 200;
+    float c = 300.3;
+    double e = 400.4;
+
+    foo.A(100);
+    foo.B(b);
+    foo.C(&c);
+    foo.D("bar");
+    InstrumentedFoo::E(e);
+    InstrumentedFoo::F();
+    foo.Validate();
+
+    bar.SetInstrumentedFoo(foo);
+    bar.SetInstrumentedFoo(&foo);
+    bar.Validate();
+  }
+
+  ClearObjects();
+
+  TestingRegistry registry;
+  registry.Replay(os.str());
+
+  ValidateObjects(1, 1);
+}
+
+TEST(RecordReplayTest, InstrumentedBarPtr) {
+  std::string str;
+  llvm::raw_string_ostream os(str);
+  g_registry.emplace();
+  g_serializer.emplace(os);
+
+  {
+    InstrumentedBar bar;
+    InstrumentedFoo &foo = *(bar.GetInstrumentedFooPtr());
 
     int b = 200;
     float c = 300.3;