[DebugInfo] Dexter tests for -debug-info-kind=constructor

[jmorse]

Summary

While mucking about with the new -debug-info-kind=constructor build type, I figured it would be worth adding some integration tests to ensure that complete types can still be found by debuggers in the built programs.

There are two tests here: one simply checks the "foo" type can be examined in a different translation unit. The second checks that when we have partial type information for "foo" because of inlined elements from it (under DWARF at least) in main.o, debuggers can still find the complete type definition. This test is also run with -O2 -flto.

Each test examines fields in "bar" when stepped onto the output line, that we can step into the asString() method, and that the fields are still examinable there.

This test format requires multiple translation units; the empty "test.cfg" file reminds Dexter that it should be treating this as a whole directory test, not a single file test.

[akhuang]

thanks for writing tests for this! I think it looks good.

I tried running this patch on my machine though and the tests always pass (using llvm-lit) even if I change numbers, so I don't know if something's going on with the directory test format?

[jmorse]

I tried running this patch on my machine though and the tests always pass (using llvm-lit) even if I change numbers, so I don't know if something's going on with the directory test format?

Hmmmmmm, I tried to apply the patch locally too, and "patch" seemingly omitted the empty test.cfg files. I've given them a non-empty body now, so perhaps they'll survive better.

Other tweaks:

• Duplicated test-runner files, one for unix one for Windows and cdb/dbgeng. (Using the same RUN lines is still a work-in-progress with Dexter, alas)
• dllexport'd the main symbol, as dbgeng has a problem setting a breakpoint there for some reason
• Disabled the LTO test on Windows -- using WinDbg I can't find any locals in the compiled code (saved with --save-temps). Not clear to me why -- CodeView is alien to me.
• DbgEng test runs relies on D91737 for a fix

Will land this without objection in a couple of days, once D91737 is in.

debuginfo-tests/dexter-tests/debug-info-kind-cons/lit.local.cfg

+config.suffixes = ['.dexter']

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/construct.cpp

+#include "theclass.h"
+
+foo *makeFoo() {
+  return new foo();
+}
+

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/main.cpp

+#include <iostream>
+#include <string>
+
+#include "theclass.h"
+
+#ifdef _WIN32
+__declspec(dllexport)
+#endif
+int main() {
+  foo *bar = makeFoo(); 
+  std::cout << bar->asString() << std::endl; // DexLabel("output_line")
+  delete bar;
+  return 0;
+}
+
+std::string foo::asString() const {
+  using namespace std::string_literals;
+  return "a "s + std::to_string(a) + " b "s + std::to_string(b); // DexLabel('str')
+}
+
+/*
+
+We should be able to see the fields of bar even with constructor homing,
+
+DexExpectWatchValue('bar->a', 1, on_line="output_line")
+DexExpectWatchValue('bar->b', 2, on_line="output_line")
+
+Check that we can step into asString too and look at the fields.
+
+DexExpectProgramState({
+        'frames': [
+                {
+                        'location': {
+                                'lineno': 'str'
+                        },
+                        'function': 'asString',
+                        'watches': {
+                                'a': '1',
+                                'b': '2'
+                        }
+                },
+                {
+                        'location': {
+                                'lineno': 'output_line'
+                        }
+                }
+        ]
+})
+*/
+

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/test.cfg

+This space intentionally left blank. (Enables Dexter directory based tests).

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/theclass.h

+#include <string>
+
+class foo {
+public:
+  int a;
+  int b;
+  
+  foo() : a(1), b(2) { }
+
+  ~foo() { }
+
+  std::string asString() const;
+};
+
+foo *makeFoo();

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/unix.dexter

+// UNSUPPORTED: system-windows
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:     --builder 'clang' --debugger 'lldb' \
+// RUN:     --cflags "-O0 -g -std=c++14 -Xclang -fuse-ctor-homing" -- %s/..
+
+// And again under LTO with opts:
+
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:    --builder 'clang' --debugger 'lldb' --ldflags="-flto -fuse-ld=lld" \
+// RUN:    --cflags "-O2 -g -std=c++14 -Xclang -fuse-ctor-homing -flto" -- %s/..

debuginfo-tests/dexter-tests/debug-info-kind-cons/partial-type/win.dexter

+// UNSUPPORTED: !system-windows
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:     --builder 'clang' --debugger 'dbgeng' --ldflags="-g"\
+// RUN:     --cflags "-O0 -g -std=c++14 -Xclang -fuse-ctor-homing" -- %s/..
+
+// Running under LTO currently fails -- none of the local variables appear
+// to be present.
+
+// run: %dexter --fail-lt 1.0 -w \
+// run:    --builder 'clang' --debugger 'dbgeng' --ldflags="-flto -g" \
+// run:    --cflags "-O2 -g -std=c++14 -Xclang -fuse-ctor-homing -flto" -- %s/..

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/construct.cpp

+#include "theclass.h"
+
+foo::foo() : a(1), b(2) { }
+
+foo::~foo() { }
+
+foo *makeFoo() {
+  return new foo();
+}
+
+std::string foo::asString() const {
+  using namespace std::string_literals;
+  return "a "s + std::to_string(a) + " b "s + std::to_string(b);
+}
+

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/main.cpp

+#include <iostream>
+#include <string>
+
+#include "theclass.h"
+
+#ifdef _WIN32
+__declspec(dllexport)
+#endif
+int main() {
+  foo *bar = makeFoo(); 
+  std::cout << bar->asString() << std::endl; // DexLabel("output_line")
+  delete bar;
+  return 0;
+}
+
+/*
+
+We should be able to see the fields of bar even with constructor homing,
+
+DexExpectWatchValue('bar->a', 1, on_line="output_line")
+DexExpectWatchValue('bar->b', 2, on_line="output_line")
+
+Check that we can step into asString too and look at the fields.
+
+DexExpectProgramState({
+        'frames': [
+                {
+                        'location': {
+                                'lineno': 13
+                        },
+                        'function': 'asString',
+                        'watches': {
+                                'a': '1',
+                                'b': '2'
+                        }
+                },
+                {
+                        'location': {
+                                'lineno': 'output_line'
+                        }
+                }
+        ]
+})
+*/
+

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/test.cfg

+This space intentionally left blank. (Enables Dexter directory based tests).

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/theclass.h

+#include <string>
+
+class foo {
+public:
+  int a;
+  int b;
+  
+  foo();
+
+  ~foo();
+
+  std::string asString() const;
+};
+
+foo *makeFoo();

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/unix.dexter

+// UNSUPPORTED: system-windows
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:     --builder 'clang' --debugger 'lldb' \
+// RUN:     --cflags "-O0 -g -std=c++14 -Xclang -fuse-ctor-homing" -- %s/..
+
+// And again under LTO with opts:
+
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:    --builder 'clang' --debugger 'lldb' --ldflags="-flto -fuse-ld=lld" \
+// RUN:    --cflags "-O2 -g -std=c++14 -Xclang -fuse-ctor-homing -flto" -- %s/..

debuginfo-tests/dexter-tests/debug-info-kind-cons/simple/win.dexter

+// UNSUPPORTED: !system-windows
+// RUN: %dexter --fail-lt 1.0 -w \
+// RUN:     --builder 'clang' --debugger 'dbgeng' --ldflags="-g"\
+// RUN:     --cflags "-O0 -g -std=c++14 -Xclang -fuse-ctor-homing" -- %s/..
+
+// Running under LTO currently fails -- none of the local variables appear
+// to be present.
+
+// run: %dexter --fail-lt 1.0 -w \
+// run:    --builder 'clang' --debugger 'dbgeng' --ldflags="-flto -g" \
+// run:    --cflags "-O2 -g -std=c++14 -Xclang -fuse-ctor-homing -flto" -- %s/..