Add test for GDB pretty printers.

[merge_guards_bot]

Unit tests: pass. 61175 tests passed, 0 failed and 729 were skipped.

clang-tidy: fail. Please fix clang-tidy findings.

clang-format: fail. Please format your changes with clang-format by running git-clang-format HEAD^ or applying this patch.

Build artifacts: diff.json, clang-tidy.txt, clang-format.patch, CMakeCache.txt, console-log.txt, test-results.xml

[csigg]

llvm/utils/gdb-scripts/prettyprinters.py

322 ↗

(On Diff #236535)

Note: this change is from https://reviews.llvm.org/D72136, which I will merge first.

[csigg]

Fix variable name casing.

[merge_guards_bot]

Unit tests: unknown.

clang-tidy: unknown.

clang-format: unknown.

Build artifacts: diff.json, console-log.txt

[dblaikie]

Seems OK to me, but @aprantl - could you take a look too since I don't often use/interact with the debuginfo-tests. Do you think this is something worth having/appropriate to have there?

debuginfo-tests/gdb-tests/prettyprinters.cpp

20 ↗

(On Diff #236538)

attribute((optnone)) might be tidier

[csigg]

O0 > optnone

[merge_guards_bot]

Unit tests: pass. 61175 tests passed, 0 failed and 729 were skipped.

clang-tidy: fail. Please fix clang-tidy findings.

clang-format: fail. Please format your changes with clang-format by running git-clang-format HEAD^ or applying this patch.

Build artifacts: diff.json, clang-tidy.txt, clang-format.patch, CMakeCache.txt, console-log.txt, test-results.xml

[aprantl]

This is cute. We should do something similar with the LLDB pretty printers.

1. What do you think about putting this into an llvm subdirectory, to make clear that this is a test of llvm/utils rather than generic debug info as all the other tests?
2. We are gradually moving away from test_debuginfo.pl in favor of dexter. Have you looked at whether this could be implemented using dexter?

[csigg]

1. What do you think about putting this into an llvm subdirectory, to make clear that this is a test of llvm/utils rather than generic debug info as all the other tests?

Do you mean something like debuginfo-tests/llvm-prettyprinters/? Or 'llvm/tests/prettyprinter'?

2. We are gradually moving away from test_debuginfo.pl in favor of dexter. Have you looked at whether this could be implemented using dexter?

I didn't look any further when I saw that dexter doesn't support GDB (according to the readme).
Not sure if we need to use a debugger abstraction because the pretty printers aren't standardized and therefore the tests will be pretty debugger specific.
If you would like to move away from test_debuginfo.pl, maybe I should split the C++ code and gdb commands+CHECKS into two different files manually. It's not perfect FileCheck methodology, but for a single test in a subdirectory it should be manageable.

[aprantl]

What about debuginfo-tests/llvm-prettyprinters/gdb/ and then we'll create an lldb subdirectory next to later?

I didn't look any further when I saw that dexter doesn't support GDB (according to the readme).

CC @jmorse

I forgot about that. I believe there exists a binding but it hasn't been upstreamed yet.

[csigg]

Move to different directory, split file.

[csigg]

Revert test_debuginfo.pl.

[merge_guards_bot]

Unit tests: pass. 61745 tests passed, 0 failed and 780 were skipped.

clang-tidy: fail. Please fix clang-tidy findings.

clang-format: fail. Please format your changes with clang-format by running git-clang-format HEAD^ or applying this patch.

Build artifacts: diff.json, clang-tidy.txt, clang-format.patch, CMakeCache.txt, console-log.txt, test-results.xml

[merge_guards_bot]

Unit tests: pass. 61745 tests passed, 0 failed and 780 were skipped.

clang-tidy: fail. Please fix clang-tidy findings.

clang-format: fail. Please format your changes with clang-format by running git-clang-format HEAD^ or applying this patch.

Build artifacts: diff.json, clang-tidy.txt, clang-format.patch, CMakeCache.txt, console-log.txt, test-results.xml

[jmorse]

(Heading through my email backlog),

Adrian wrote:

We are gradually moving away from test_debuginfo.pl in favor of dexter. Have you looked at whether this could be implemented using dexter?

Christian wrote:

Not sure if we need to use a debugger abstraction because the pretty printers aren't standardized and therefore the tests will be pretty debugger specific.

I agree with Christian, while Dexter is good for ensuring that information is read accurately by different DWARF/CodeView consumers, how that's presented to the user is open to choices in the debugger application. IMHO, YMMV.

[dblaikie]

debuginfo-tests/CMakeLists.txt

5–9

Might need to change the way this is built, @tbosch identified a bug where this test fails on a non-debug build of LLVM, because it doesn't explicitly request debug info, so it gets the build defaults. (either that, or the test should detect this situation - use a REQUIRES or similar to not run in the absence of debug info)

https://bugs.llvm.org/show_bug.cgi?id=45652

[dblaikie]

debuginfo-tests/CMakeLists.txt

5–9

@csigg ping on this ^ issue - could you take a look?

[csigg]

debuginfo-tests/CMakeLists.txt

5–9

https://reviews.llvm.org/D79897 should fix it.
Sorry for the delay.

debuginfo-tests/CMakeLists.txt

 # Debug Info tests.  These tests invoke clang to generate programs with
 # various types of debug info, and then run those programs under a debugger
 # such as GDB or LLDB to verify the results.
 
+add_llvm_executable(prettyprinters
+        llvm-prettyprinters/gdb/prettyprinters.cpp
+)
+target_link_libraries(prettyprinters PRIVATE LLVMSupport)
+
 set(DEBUGINFO_TESTS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(DEBUGINFO_TESTS_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
 set(DEBUGINFO_TEST_DEPS
   clang
   FileCheck
   count
   llvm-objdump
   not
+  prettyprinters
   )
 
 # The Windows builder scripts pass -fuse-ld=lld.
 if (WIN32)
   set(DEBUGINFO_TEST_DEPS ${DEBUGINFO_TEST_DEPS} lld)
 endif()
 
 if (NOT DEFINED PYTHON_EXECUTABLE)

debuginfo-tests/lit.cfg.py

 # test_exec_root: The root path where tests should be run.
 config.test_exec_root = config.debuginfo_tests_obj_root
 
 llvm_config.use_default_substitutions()
 
 tools = [
     ToolSubst('%test_debuginfo', command=os.path.join(
         config.debuginfo_tests_src_root, 'llgdb-tests', 'test_debuginfo.pl')),
+    ToolSubst("%llvm_src_root", config.llvm_src_root),
+    ToolSubst("%llvm_tools_dir", config.llvm_tools_dir),
 ]
 
 def get_required_attr(config, attr_name):
   attr_value = getattr(config, attr_name, None)
   if attr_value == None:
     lit_config.fatal(
       "No attribute %r in test configuration! You may need to run "
       "tests from your build directory or add this attribute "

debuginfo-tests/llvm-prettyprinters/gdb/lit.local.cfg

+import lit.util
+
+# debuginfo-tests are not expected to pass in a cross-compilation setup.
+if 'native' not in config.available_features or lit.util.which('gdb') is None:
+    config.unsupported = True
+
+config.suffixes = ['.gdb']
+
+

debuginfo-tests/llvm-prettyprinters/gdb/prettyprinters.cpp

+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/Optional.h"
+#include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/Twine.h"
+#include "llvm/Support/Error.h"
+
+int Array[] = {1, 2, 3};
+
+llvm::ArrayRef<int> ArrayRef(Array);
+llvm::MutableArrayRef<int> MutableArrayRef(Array);
+llvm::DenseMap<int, int> DenseMap = {{4, 5}, {6, 7}};
+llvm::Expected<int> ExpectedValue(8);
+llvm::Expected<int> ExpectedError(llvm::createStringError({}, ""));
+llvm::Optional<int> OptionalValue(9);
+llvm::Optional<int> OptionalNone(llvm::None);
+llvm::SmallVector<int, 5> SmallVector = {10, 11, 12};
+llvm::SmallString<5> SmallString("foo");
+llvm::StringRef StringRef = "bar";
+llvm::Twine Twine = llvm::Twine(SmallString) + StringRef;
+
+int main() {
+  return 0;
+}

debuginfo-tests/llvm-prettyprinters/gdb/prettyprinters.gdb

+# RUN: gdb -q -batch -n -iex 'source %llvm_src_root/utils/gdb-scripts/prettyprinters.py' -x %s %llvm_tools_dir/prettyprinters | FileCheck %s
+
+break main
+run
+
+# CHECK: llvm::ArrayRef of length 3 = {1, 2, 3}
+p ArrayRef
+
+# CHECK: llvm::ArrayRef of length 3 = {1, 2, 3}
+p MutableArrayRef
+
+# CHECK: llvm::DenseMap with 2 elements = {
+# CHECK:   [4] = 5,
+# CHECK:   [6] = 7,
+# CHECK: }
+p DenseMap
+
+# CHECK: llvm::Expected = {value = 8}
+p ExpectedValue
+
+# CHECK: llvm::Expected is error
+p ExpectedError
+
+# CHECK: llvm::Optional = {value = 9}
+p OptionalValue
+
+# CHECK: llvm::Optional is not initialized
+p OptionalNone
+
+# CHECK: llvm::SmallVector of Size 3, Capacity 5 = {10, 11, 12}
+p SmallVector
+
+# CHECK: "foo"
+p SmallString
+
+# CHECK: "bar"
+p StringRef
+
+# CHECK: "\"foo\"\"bar\""
+p Twine
+