[binutils-gdb] [gdb/symtab] Fix assert in process_imported_unit_die

[binutils-gdb] [gdb/symtab] Fix assert in process_imported_unit_die

[Tom de Vries]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=8728fb3385c136b05dc16fb6664a57028acd0d73

commit 8728fb3385c136b05dc16fb6664a57028acd0d73
Author: Tom de Vries <tdevries@suse.de>
Date:   Fri Jul 8 15:56:06 2022 +0200

    [gdb/symtab] Fix assert in process_imported_unit_die
    
    When running test-case gdb.dwarf2/dw2-symtab-includes.exp with target board
    cc-with-debug-names, I run into:
    ...
    (gdb) maint expand-symtab dw2-symtab-includes.h^M
    src/gdb/dwarf2/read.h:311: internal-error: unit_type: \
      Assertion `m_unit_type != 0' failed.^M
    A problem internal to GDB has been detected,^M
    further debugging may prove unreliable.^M
    ----- Backtrace -----^M
    FAIL: gdb.dwarf2/dw2-symtab-includes.exp: maint expand-symtab \
      dw2-symtab-includes.h (GDB internal error)
    ...
    
    The assert was recently added in commit 2c474c46943 ("[gdb/symtab] Add get/set
    functions for per_cu->lang/unit_type").
    
    The assert is triggered here:
    ...
        /* We're importing a C++ compilation unit with tag DW_TAG_compile_unit
           into another compilation unit, at root level.  Regard this as a hint,
           and ignore it.  */
        if (die->parent && die->parent->parent == NULL
            && per_cu->unit_type () == DW_UT_compile
            && per_cu->lang () == language_cplus)
          return;
    ...
    
    We're trying to access unit_type / lang which hasn't been set yet.
    
    Normally, these are set during cooked index creation, but that's not the case
    when using an index (or using -readnow).
    
    In other words, this lto binary reading speed optimization only works in the
    normal use case.
    
    IWBN to have this working in all use cases, but for now, allow lang () and
    unit_type () to return language_unknown and 0 here.
    
    Tested on x86_64-linux.
    
    Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=29321

Diff:
---
 gdb/dwarf2/read.c |  7 ++++---
 gdb/dwarf2/read.h | 10 ++++++----
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/gdb/dwarf2/read.c b/gdb/dwarf2/read.c
index 9f92b420645..55e61b882a9 100644
--- a/gdb/dwarf2/read.c
+++ b/gdb/dwarf2/read.c
@@ -8538,10 +8538,11 @@ process_imported_unit_die (struct die_info *die, struct dwarf2_cu *cu)
 
       /* We're importing a C++ compilation unit with tag DW_TAG_compile_unit
 	 into another compilation unit, at root level.  Regard this as a hint,
-	 and ignore it.  */
+	 and ignore it.  This is a best effort, it only works if unit_type and
+	 lang are already set.  */
       if (die->parent && die->parent->parent == NULL
-	  && per_cu->unit_type () == DW_UT_compile
-	  && per_cu->lang () == language_cplus)
+	  && per_cu->unit_type (false) == DW_UT_compile
+	  && per_cu->lang (false) == language_cplus)
 	return;
 
       /* If necessary, add it to the queue and load its DIEs.  */
diff --git a/gdb/dwarf2/read.h b/gdb/dwarf2/read.h
index 1d9c66aafad..c9afa074ae9 100644
--- a/gdb/dwarf2/read.h
+++ b/gdb/dwarf2/read.h
@@ -306,9 +306,10 @@ public:
       gdb_assert (m_dwarf_version == version);
   }
 
-  dwarf_unit_type unit_type () const
+  dwarf_unit_type unit_type (bool strict_p = true) const
   {
-    gdb_assert (m_unit_type != 0);
+    if (strict_p)
+      gdb_assert (m_unit_type != 0);
     return m_unit_type;
   }
 
@@ -322,9 +323,10 @@ public:
       gdb_assert (m_unit_type == unit_type);
   }
 
-  enum language lang () const
+  enum language lang (bool strict_p = true) const
   {
-    gdb_assert (m_lang != language_unknown);
+    if (strict_p)
+      gdb_assert (m_lang != language_unknown);
     return m_lang;
   }