Adding GDB PrettyPrinter for mlir::Identifier.

[csigg]

Summary

This is the first bit from D73546. Primarily setting up the corresponding test. Will add more pretty printers in a separate revision.

[csigg]

I think clang-tidy can't find the include because there is no complication database for that file because we don't run debuginfo-tests as part of the premerge-check. We can either change that (but dexter tests fail for me locally), add the file to .clang-tidy-ignore, or simply ignore the error. Which one would you prefer?

[mehdi_amini]

Ignoring clang-tidy is the common solution here I believe.

[dblaikie]

Generally looks plausible to me.

[teemperor]

This is breaking the Green Dragon bot: http://green.lab.llvm.org/green/view/LLDB/job/lldb-cmake/23667/console

[Orlando]

I've reverted this for now (485e6db8729) because one of our internal build bot is failing in the same way. I don't think many (any?) of the bots on http://lab.llvm.org:8011/console build the debuginfo-tests project!

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.
 
 find_package(Python3 COMPONENTS Interpreter)
 
 add_llvm_executable(check-gdb-llvm-support
         llvm-prettyprinters/gdb/llvm-support.cpp
 )
 target_link_libraries(check-gdb-llvm-support PRIVATE LLVMSupport)
 
+add_llvm_executable(check-gdb-mlir-support
+        llvm-prettyprinters/gdb/mlir-support.cpp
+)
+target_include_directories(check-gdb-mlir-support PRIVATE ${LLVM_EXTERNAL_MLIR_SOURCE_DIR}/include)
+target_link_libraries(check-gdb-mlir-support PRIVATE MLIRIR MLIRSupport 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-config
   llvm-objdump
   check-gdb-llvm-support
+  check-gdb-mlir-support
   not
   )
 
 if("compiler-rt" IN_LIST LLVM_ENABLE_PROJECTS)
   # llgdb-tests/asan.c and other asan* files.
   if(TARGET asan)
     list(APPEND DEBUGINFO_TEST_DEPS asan)
   endif()

debuginfo-tests/lit.cfg.py

 
 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),
+    ToolSubst("%mlir_src_root", config.mlir_src_root),
 ]
 
 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/lit.site.cfg.py.in

 config.debuginfo_tests_obj_root = "@DEBUGINFO_TESTS_BINARY_DIR@"
 config.debuginfo_tests_src_root = "@DEBUGINFO_TESTS_SOURCE_DIR@"
 config.has_lld = lit.util.pythonize_bool("@DEBUGINFO_TESTS_HAS_LLD@")
 config.host_triple = "@LLVM_HOST_TRIPLE@"
 config.target_triple = "@TARGET_TRIPLE@"
 config.host_arch = "@HOST_ARCH@"
 config.is_msvc = lit.util.pythonize_bool("@MSVC@")
 
+config.mlir_src_root = "@MLIR_SOURCE_DIR@"
+
 config.llvm_use_sanitizer = "@LLVM_USE_SANITIZER@"
 
 config.python3_executable = "@Python3_EXECUTABLE@"
 
 # Support substitution of the tools_dir with user parameters. This is
 # used when we can't determine the tool dir at configuration time.
 try:
     config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params

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

+#include "mlir/IR/Identifier.h"
+#include "mlir/IR/MLIRContext.h"
+
+mlir::MLIRContext Context;
+
+auto Identifier = mlir::Identifier::get("foo", &Context);
+
+int main() { return 0; }

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

+# RUN: gdb -q -batch -n -iex 'source %mlir_src_root/utils/gdb-scripts/prettyprinters.py' -x %s %llvm_tools_dir/check-gdb-mlir-support | FileCheck %s --dump-input=fail
+# REQUIRES: debug-info
+
+break main
+run
+
+# CHECK: "foo"
+p Identifier

mlir/utils/gdb-scripts/prettyprinters.py

+"""GDB pretty printers for MLIR types."""
+
+import gdb.printing
+
+class IdentifierPrinter:
+  """Prints an mlir::Identifier instance."""
+
+  def __init__(self, val):
+    self.entry = val['entry']
+
+  def to_string(self):
+    ptr = (self.entry + 1).cast(gdb.lookup_type('char').pointer());
+    return ptr.string(length=self.entry['keyLength'])
+
+  def display_hint(self):
+    return 'string'
+
+pp = gdb.printing.RegexpCollectionPrettyPrinter('MLIRSupport')
+
+pp.add_printer('mlir::Identifier', '^mlir::Identifier$', IdentifierPrinter)
+
+gdb.printing.register_pretty_printer(gdb.current_objfile(), pp)