binutils-gdb/gdb/dwarf2/dwz.h
Tom de Vries 973db6fae3 [gdb/symtab] Error out for .debug_types section in dwz file
There are two methods to factor out type information in a dwarf4 executable:
- use -fdebug-info-types to generate type units in a .debug_types section, and
- use dwz to create partial units.

The dwz method has an extra benefit: it also allows to factor out information
between executables into a newly created .dwz file, pointed to by a
.gnu_debugaltlink section.

There is nothing prohibiting a .gnu_debugaltlink file to contain a
.debug_types section.

It's just not generated by dwz or any other tool atm, and consequently gdb has
no support for it.  Enhancement PR symtab/30838 is open about the lack of
support.

Make the current situation explicit by emitting a dwarf error:
...
(gdb) file struct-with-sig-2^M
Reading symbols from struct-with-sig-2...^M
Dwarf Error: .debug_types section not supported in dwz file^M
...
and add an assert in write_gdbindex:
...
+      /* See enhancement PR symtab/30838.  */
+      gdb_assert (!(per_cu->is_dwz && per_cu->is_debug_types));
...
to clarify why we can use:
...
      data_buf &cu_list = (per_cu->is_debug_types
                           ? types_cu_list
                           : per_cu->is_dwz ? dwz_cu_list : objfile_cu_list);
...

The test-case is a modified copy from gdb.dwarf2/struct-with-sig.exp, so it
keeps the copyright years range.

Tested on x86_64-linux.

Tested-By: Guinevere Larsen <blarsen@redhat.com>

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30838
2023-09-20 16:05:55 +02:00

77 lines
2.5 KiB
C++

/* DWARF DWZ handling for GDB.
Copyright (C) 2003-2023 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDB_DWARF2_DWZ_H
#define GDB_DWARF2_DWZ_H
#include "gdb_bfd.h"
#include "dwarf2/index-cache.h"
#include "dwarf2/section.h"
struct dwarf2_per_bfd;
/* This represents a '.dwz' file. */
struct dwz_file
{
dwz_file (gdb_bfd_ref_ptr &&bfd)
: dwz_bfd (std::move (bfd))
{
}
const char *filename () const
{
return bfd_get_filename (this->dwz_bfd.get ());
}
/* A dwz file can only contain a few sections. */
struct dwarf2_section_info abbrev {};
struct dwarf2_section_info info {};
struct dwarf2_section_info str {};
struct dwarf2_section_info line {};
struct dwarf2_section_info macro {};
struct dwarf2_section_info gdb_index {};
struct dwarf2_section_info debug_names {};
struct dwarf2_section_info types {};
/* The dwz's BFD. */
gdb_bfd_ref_ptr dwz_bfd;
/* If we loaded the index from an external file, this contains the
resources associated to the open file, memory mapping, etc. */
std::unique_ptr<index_cache_resource> index_cache_res;
/* Read a string at offset STR_OFFSET in the .debug_str section from
this dwz file. Throw an error if the offset is too large. If
the string consists of a single NUL byte, return NULL; otherwise
return a pointer to the string. */
const char *read_string (struct objfile *objfile, LONGEST str_offset);
};
/* Open the separate '.dwz' debug file, if needed. If there is no
.gnu_debugaltlink section in the file, then the result depends on
REQUIRE: if REQUIRE is true, then error; if REQUIRE is false,
return NULL. Always error if there is such a section but the file
cannot be found. */
extern dwz_file *dwarf2_get_dwz_file (dwarf2_per_bfd *per_bfd,
bool require = false);
#endif /* GDB_DWARF2_DWZ_H */