If SBDebugger::InitializeWithErrorHandling succeeds, the returned SBError is not marked as valid

[DavidSpickett]

SBDebugger::InitializeWithErrorHandling does not set the returned error as valid if it succeeds. The error is marked as success by default construction though.

$ cat test_api.cpp 
#include <iostream>
#include "lldb/API/SBDebugger.h"
#include "lldb/API/SBError.h"

int main() {
    lldb::SBError err = lldb::SBDebugger::InitializeWithErrorHandling();

    std::cout << "SBError validity: " << err.IsValid() << "\n";
    std::cout << "SBError success: " << err.Success() << "\n";
    std::cout << "SBError fail: " << err.Fail() << "\n";

    if (err.IsValid() && !err.Success())
        std::cout << "Error message: " << err.GetCString() << "\n";

    return 0;
}

$ cat makefile 
all:
	g++ test_api.cpp -o test_api -I /home/david.spickett/llvm.install/include/ -L /home/david.spickett/llvm.install/lib/ -llldb

run:
	LD_LIBRARY_PATH=/home/david.spickett/llvm.install/lib ./test_api

This produces:

$ make run
LD_LIBRARY_PATH=/home/david.spickett/llvm.install/lib ./test_api
SBError validity: 0
SBError success: 1
SBError fail: 0

I would expect the SBError to be valid and marked as success.

[llvmbot]

@llvm/issue-subscribers-lldb

Author: David Spickett (DavidSpickett)

`SBDebugger::InitializeWithErrorHandling` does not set the returned error as valid if it succeeds. The error is marked as success by default construction though.

$ cat test_api.cpp 
#include <iostream>
#include "lldb/API/SBDebugger.h"
#include "lldb/API/SBError.h"

int main() {
    lldb::SBError err = lldb::SBDebugger::InitializeWithErrorHandling();

    std::cout << "SBError validity: " << err.IsValid() << "\n";
    std::cout << "SBError success: " << err.Success() << "\n";
    std::cout << "SBError fail: " << err.Fail() << "\n";

    if (err.IsValid() && !err.Success())
        std::cout << "Error message: " << err.GetCString() << "\n";

    return 0;
}

$ cat makefile 
all:
	g++ test_api.cpp -o test_api -I /home/david.spickett/llvm.install/include/ -L /home/david.spickett/llvm.install/lib/ -llldb

run:
	LD_LIBRARY_PATH=/home/david.spickett/llvm.install/lib ./test_api

This produces:

$ make run
LD_LIBRARY_PATH=/home/david.spickett/llvm.install/lib ./test_api
SBError validity: 0
SBError success: 1
SBError fail: 0

I would expect the SBError to be valid and marked as success.

[DavidSpickett]

Adding my own error shows that the error case works as expected:

$ git -C ../llvm-project diff
diff --git a/lldb/source/API/SystemInitializerFull.cpp b/lldb/source/API/SystemInitializerFull.cpp
index 4cf7dd149e02..762b7c64897c 100644
--- a/lldb/source/API/SystemInitializerFull.cpp
+++ b/lldb/source/API/SystemInitializerFull.cpp
@@ -51,6 +51,8 @@ SystemInitializerFull::SystemInitializerFull()
 SystemInitializerFull::~SystemInitializerFull() = default;
 
 llvm::Error SystemInitializerFull::Initialize() {
+  return llvm::createStringError("fake error");
+
   llvm::Error error = SystemInitializerCommon::Initialize();
   if (error)
     return error;

$ make run
LD_LIBRARY_PATH=/home/david.spickett/llvm.install/lib ./test_api
SBError validity: 1
SBError success: 0
SBError fail: 1
Error message: fake error