X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fdwarf-index-write.c;h=66c2368b9c14d244b600b18b578e3e40da0a247c;hb=c1b5c1ebc938b6dc0277363b8c47d75b0b5a621f;hp=8734f99212dac7120fce2b0c1fc4bb1a2a5caef8;hpb=af97b4161f07a716783183f1b17fa5cac9f99a49;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/dwarf-index-write.c b/gdb/dwarf-index-write.c index 8734f99212..66c2368b9c 100644 --- a/gdb/dwarf-index-write.c +++ b/gdb/dwarf-index-write.c @@ -19,13 +19,15 @@ #include "defs.h" +#include "dwarf-index-write.h" + #include "addrmap.h" #include "cli/cli-decode.h" -#include "common/byte-vector.h" -#include "common/filestuff.h" -#include "common/gdb_unlinker.h" -#include "common/pathstuff.h" -#include "common/scoped_fd.h" +#include "gdbsupport/byte-vector.h" +#include "gdbsupport/filestuff.h" +#include "gdbsupport/gdb_unlinker.h" +#include "gdbsupport/pathstuff.h" +#include "gdbsupport/scoped_fd.h" #include "complaints.h" #include "dwarf-index-common.h" #include "dwarf2.h" @@ -34,6 +36,7 @@ #include "gdbcmd.h" #include "objfiles.h" #include "psympriv.h" +#include "ada-lang.h" #include #include @@ -56,7 +59,7 @@ GDB_INDEX_SYMBOL_KIND_SET_VALUE((cu_index), (value)); \ } while (0) -/* Ensure we don't use more than the alloted nuber of bits for the CU. */ +/* Ensure we don't use more than the allotted number of bits for the CU. */ #define DW2_GDB_INDEX_CU_SET_VALUE(cu_index, value) \ do { \ gdb_assert (((value) & ~GDB_INDEX_CU_MASK) == 0); \ @@ -256,7 +259,7 @@ add_index_entry (struct mapped_symtab *symtab, const char *name, (which would allow us to avoid the duplication by only having to check the last entry pushed), but a symbol could have multiple kinds in one CU. To keep things simple we don't worry about the duplication here and - sort and uniqufy the list after we've processed all symbols. */ + sort and uniquify the list after we've processed all symbols. */ slot.cu_indices.push_back (cu_index_and_attrs); } @@ -540,15 +543,16 @@ write_psymbols (struct mapped_symtab *symtab, { struct partial_symbol *psym = *psymp; - if (psym->ginfo.language == language_ada) - error (_("Ada is not currently supported by the index")); + if (psym->ginfo.language () == language_ada) + error (_("Ada is not currently supported by the index; " + "use the DWARF 5 index instead")); /* Only add a given psymbol once. */ if (psyms_seen.insert (psym).second) { gdb_index_symbol_kind kind = symbol_kind (psym); - add_index_entry (symtab, symbol_search_name (&psym->ginfo), + add_index_entry (symtab, psym->ginfo.search_name (), is_static, kind, cu_index); } } @@ -684,7 +688,44 @@ public: const int dwarf_tag = psymbol_tag (psym); if (dwarf_tag == 0) return; - const char *const name = symbol_search_name (&psym->ginfo); + const char *name = psym->ginfo.search_name (); + + if (psym->ginfo.language () == language_ada) + { + /* We want to ensure that the Ada main function's name appears + verbatim in the index. However, this name will be of the + form "_ada_mumble", and will be rewritten by ada_decode. + So, recognize it specially here and add it to the index by + hand. */ + if (strcmp (main_name (), name) == 0) + { + const auto insertpair + = m_name_to_value_set.emplace (c_str_view (name), + std::set ()); + std::set &value_set = insertpair.first->second; + value_set.emplace (symbol_value (dwarf_tag, cu_index, is_static, + kind)); + } + + /* In order for the index to work when read back into gdb, it + has to supply a funny form of the name: it should be the + encoded name, with any suffixes stripped. Using the + ordinary encoded name will not work properly with the + searching logic in find_name_components_bounds; nor will + using the decoded name. Furthermore, an Ada "verbatim" + name (of the form "") must be entered without the + angle brackets. Note that the current index is unusual, + see PR symtab/24820 for details. */ + std::string decoded = ada_decode (name); + if (decoded[0] == '<') + name = (char *) obstack_copy0 (&m_string_obstack, + decoded.c_str () + 1, + decoded.length () - 2); + else + name = obstack_strdup (&m_string_obstack, + ada_encode (decoded.c_str ())); + } + const auto insertpair = m_name_to_value_set.emplace (c_str_view (name), std::set ()); @@ -912,7 +953,7 @@ private: { public: - /* Object costructor to be called for current DWARF2_PER_OBJFILE. + /* Object constructor to be called for current DWARF2_PER_OBJFILE. All .debug_str section strings are automatically stored. */ debug_str_lookup (struct dwarf2_per_objfile *dwarf2_per_objfile) : m_abfd (dwarf2_per_objfile->objfile->obfd), @@ -1181,9 +1222,6 @@ private: { struct partial_symbol *psym = *psymp; - if (psym->ginfo.language == language_ada) - error (_("Ada is not currently supported by the index")); - /* Only add a given psymbol once. */ if (psyms_seen.insert (psym).second) insert (psym, cu_index, is_static, kind); @@ -1244,6 +1282,9 @@ private: /* .debug_names entry pool. */ data_buf m_entry_pool; + + /* Temporary storage for Ada names. */ + auto_obstack m_string_obstack; }; /* Return iff any of the needed offsets does not fit into 32-bit @@ -1289,15 +1330,81 @@ psyms_seen_size (struct dwarf2_per_objfile *dwarf2_per_objfile) return psyms_count / 4; } -/* Write new .gdb_index section for OBJFILE into OUT_FILE. - Return how many bytes were expected to be written into OUT_FILE. */ +/* Assert that FILE's size is EXPECTED_SIZE. Assumes file's seek + position is at the end of the file. */ -static size_t -write_gdbindex (struct dwarf2_per_objfile *dwarf2_per_objfile, FILE *out_file) +static void +assert_file_size (FILE *file, size_t expected_size) +{ + const auto file_size = ftell (file); + if (file_size == -1) + perror_with_name (("ftell")); + gdb_assert (file_size == expected_size); +} + +/* Write a gdb index file to OUT_FILE from all the sections passed as + arguments. */ + +static void +write_gdbindex_1 (FILE *out_file, + const data_buf &cu_list, + const data_buf &types_cu_list, + const data_buf &addr_vec, + const data_buf &symtab_vec, + const data_buf &constant_pool) +{ + data_buf contents; + const offset_type size_of_header = 6 * sizeof (offset_type); + offset_type total_len = size_of_header; + + /* The version number. */ + contents.append_data (MAYBE_SWAP (8)); + + /* The offset of the CU list from the start of the file. */ + contents.append_data (MAYBE_SWAP (total_len)); + total_len += cu_list.size (); + + /* The offset of the types CU list from the start of the file. */ + contents.append_data (MAYBE_SWAP (total_len)); + total_len += types_cu_list.size (); + + /* The offset of the address table from the start of the file. */ + contents.append_data (MAYBE_SWAP (total_len)); + total_len += addr_vec.size (); + + /* The offset of the symbol table from the start of the file. */ + contents.append_data (MAYBE_SWAP (total_len)); + total_len += symtab_vec.size (); + + /* The offset of the constant pool from the start of the file. */ + contents.append_data (MAYBE_SWAP (total_len)); + total_len += constant_pool.size (); + + gdb_assert (contents.size () == size_of_header); + + contents.file_write (out_file); + cu_list.file_write (out_file); + types_cu_list.file_write (out_file); + addr_vec.file_write (out_file); + symtab_vec.file_write (out_file); + constant_pool.file_write (out_file); + + assert_file_size (out_file, total_len); +} + +/* Write contents of a .gdb_index section for OBJFILE into OUT_FILE. + If OBJFILE has an associated dwz file, write contents of a .gdb_index + section for that dwz file into DWZ_OUT_FILE. If OBJFILE does not have an + associated dwz file, DWZ_OUT_FILE must be NULL. */ + +static void +write_gdbindex (struct dwarf2_per_objfile *dwarf2_per_objfile, FILE *out_file, + FILE *dwz_out_file) { struct objfile *objfile = dwarf2_per_objfile->objfile; mapped_symtab symtab; - data_buf cu_list; + data_buf objfile_cu_list; + data_buf dwz_cu_list; /* While we're scanning CU's create a table that maps a psymtab pointer (which is what addrmap records) to its index (which is what is recorded @@ -1331,6 +1438,10 @@ write_gdbindex (struct dwarf2_per_objfile *dwarf2_per_objfile, FILE *out_file) const auto insertpair = cu_index_htab.emplace (psymtab, i); gdb_assert (insertpair.second); + /* The all_comp_units list contains CUs read from the objfile as well as + from the eventual dwz file. We need to place the entry in the + corresponding index. */ + data_buf &cu_list = per_cu->is_dwz ? dwz_cu_list : objfile_cu_list; cu_list.append_uint (8, BFD_ENDIAN_LITTLE, to_underlying (per_cu->sect_off)); cu_list.append_uint (8, BFD_ENDIAN_LITTLE, per_cu->length); @@ -1361,43 +1472,13 @@ write_gdbindex (struct dwarf2_per_objfile *dwarf2_per_objfile, FILE *out_file) data_buf symtab_vec, constant_pool; write_hash_table (&symtab, symtab_vec, constant_pool); - data_buf contents; - const offset_type size_of_contents = 6 * sizeof (offset_type); - offset_type total_len = size_of_contents; - - /* The version number. */ - contents.append_data (MAYBE_SWAP (8)); - - /* The offset of the CU list from the start of the file. */ - contents.append_data (MAYBE_SWAP (total_len)); - total_len += cu_list.size (); + write_gdbindex_1(out_file, objfile_cu_list, types_cu_list, addr_vec, + symtab_vec, constant_pool); - /* The offset of the types CU list from the start of the file. */ - contents.append_data (MAYBE_SWAP (total_len)); - total_len += types_cu_list.size (); - - /* The offset of the address table from the start of the file. */ - contents.append_data (MAYBE_SWAP (total_len)); - total_len += addr_vec.size (); - - /* The offset of the symbol table from the start of the file. */ - contents.append_data (MAYBE_SWAP (total_len)); - total_len += symtab_vec.size (); - - /* The offset of the constant pool from the start of the file. */ - contents.append_data (MAYBE_SWAP (total_len)); - total_len += constant_pool.size (); - - gdb_assert (contents.size () == size_of_contents); - - contents.file_write (out_file); - cu_list.file_write (out_file); - types_cu_list.file_write (out_file); - addr_vec.file_write (out_file); - symtab_vec.file_write (out_file); - constant_pool.file_write (out_file); - - return total_len; + if (dwz_out_file != NULL) + write_gdbindex_1 (dwz_out_file, dwz_cu_list, {}, {}, {}, {}); + else + gdb_assert (dwz_cu_list.empty ()); } /* DWARF-5 augmentation string for GDB's DW_IDX_GNU_* extension. */ @@ -1407,7 +1488,7 @@ static const gdb_byte dwarf5_gdb_augmentation[] = { 'G', 'D', 'B', 0 }; needed addition to .debug_str section to OUT_FILE_STR. Return how many bytes were expected to be written into OUT_FILE. */ -static size_t +static void write_debug_names (struct dwarf2_per_objfile *dwarf2_per_objfile, FILE *out_file, FILE *out_file_str) { @@ -1528,26 +1609,69 @@ write_debug_names (struct dwarf2_per_objfile *dwarf2_per_objfile, types_cu_list.file_write (out_file); nametable.file_write (out_file, out_file_str); - return expected_bytes; + assert_file_size (out_file, expected_bytes); } -/* Assert that FILE's size is EXPECTED_SIZE. Assumes file's seek - position is at the end of the file. */ +/* This represents an index file being written (work-in-progress). -static void -assert_file_size (FILE *file, const char *filename, size_t expected_size) + The data is initially written to a temporary file. When the finalize method + is called, the file is closed and moved to its final location. + + On failure (if this object is being destroyed with having called finalize), + the temporary file is closed and deleted. */ + +struct index_wip_file { - const auto file_size = ftell (file); - if (file_size == -1) - error (_("Can't get `%s' size"), filename); - gdb_assert (file_size == expected_size); -} + index_wip_file (const char *dir, const char *basename, + const char *suffix) + { + filename = (std::string (dir) + SLASH_STRING + basename + + suffix); + + filename_temp = make_temp_filename (filename); + + scoped_fd out_file_fd (gdb_mkostemp_cloexec (filename_temp.data (), + O_BINARY)); + if (out_file_fd.get () == -1) + perror_with_name (("mkstemp")); + + out_file = out_file_fd.to_file ("wb"); + + if (out_file == nullptr) + error (_("Can't open `%s' for writing"), filename_temp.data ()); + + unlink_file.emplace (filename_temp.data ()); + } + + void finalize () + { + /* We want to keep the file. */ + unlink_file->keep (); + + /* Close and move the str file in place. */ + unlink_file.reset (); + if (rename (filename_temp.data (), filename.c_str ()) != 0) + perror_with_name (("rename")); + } + + std::string filename; + gdb::char_vector filename_temp; + + /* Order matters here; we want FILE to be closed before + FILENAME_TEMP is unlinked, because on MS-Windows one cannot + delete a file that is still open. So, we wrap the unlinker in an + optional and emplace it once we know the file name. */ + gdb::optional unlink_file; + + gdb_file_up out_file; +}; /* See dwarf-index-write.h. */ void write_psymtabs_to_index (struct dwarf2_per_objfile *dwarf2_per_objfile, const char *dir, const char *basename, + const char *dwz_basename, dw_index_kind index_kind) { struct objfile *objfile = dwarf2_per_objfile->objfile; @@ -1555,7 +1679,7 @@ write_psymtabs_to_index (struct dwarf2_per_objfile *dwarf2_per_objfile, if (dwarf2_per_objfile->using_index) error (_("Cannot use an index to create the index")); - if (VEC_length (dwarf2_section_info_def, dwarf2_per_objfile->types) > 1) + if (dwarf2_per_objfile->types.size () > 1) error (_("Cannot make an index when the file has multiple .debug_types sections")); if (!objfile->partial_symtabs->psymtabs @@ -1566,74 +1690,33 @@ write_psymtabs_to_index (struct dwarf2_per_objfile *dwarf2_per_objfile, if (stat (objfile_name (objfile), &st) < 0) perror_with_name (objfile_name (objfile)); - std::string filename (std::string (dir) + SLASH_STRING + basename - + (index_kind == dw_index_kind::DEBUG_NAMES - ? INDEX5_SUFFIX : INDEX4_SUFFIX)); - gdb::char_vector filename_temp = make_temp_filename (filename); + const char *index_suffix = (index_kind == dw_index_kind::DEBUG_NAMES + ? INDEX5_SUFFIX : INDEX4_SUFFIX); - /* Order matters here; we want FILE to be closed before - FILENAME_TEMP is unlinked, because on MS-Windows one cannot - delete a file that is still open. So, we wrap the unlinker in an - optional and emplace it once we know the file name. */ - gdb::optional unlink_file; - scoped_fd out_file_fd (gdb_mkostemp_cloexec (filename_temp.data (), - O_BINARY)); - if (out_file_fd.get () == -1) - perror_with_name (("mkstemp")); - - gdb_file_up out_file = out_file_fd.to_file ("wb"); - if (out_file == nullptr) - error (_("Can't open `%s' for writing"), filename_temp.data ()); + index_wip_file objfile_index_wip (dir, basename, index_suffix); + gdb::optional dwz_index_wip; - unlink_file.emplace (filename_temp.data ()); + if (dwz_basename != NULL) + dwz_index_wip.emplace (dir, dwz_basename, index_suffix); if (index_kind == dw_index_kind::DEBUG_NAMES) { - std::string filename_str (std::string (dir) + SLASH_STRING - + basename + DEBUG_STR_SUFFIX); - gdb::char_vector filename_str_temp = make_temp_filename (filename_str); - - /* As above, arrange to unlink the file only after the file - descriptor has been closed. */ - gdb::optional unlink_file_str; - scoped_fd out_file_str_fd - (gdb_mkostemp_cloexec (filename_str_temp.data (), O_BINARY)); - if (out_file_str_fd.get () == -1) - perror_with_name (("mkstemp")); - - gdb_file_up out_file_str = out_file_str_fd.to_file ("wb"); - if (out_file_str == nullptr) - error (_("Can't open `%s' for writing"), filename_str_temp.data ()); - - unlink_file_str.emplace (filename_str_temp.data ()); - - const size_t total_len - = write_debug_names (dwarf2_per_objfile, out_file.get (), - out_file_str.get ()); - assert_file_size (out_file.get (), filename_temp.data (), total_len); - - /* We want to keep the file .debug_str file too. */ - unlink_file_str->keep (); - - /* Close and move the str file in place. */ - out_file_str.reset (); - if (rename (filename_str_temp.data (), filename_str.c_str ()) != 0) - perror_with_name (("rename")); + index_wip_file str_wip_file (dir, basename, DEBUG_STR_SUFFIX); + + write_debug_names (dwarf2_per_objfile, objfile_index_wip.out_file.get (), + str_wip_file.out_file.get ()); + + str_wip_file.finalize (); } else - { - const size_t total_len - = write_gdbindex (dwarf2_per_objfile, out_file.get ()); - assert_file_size (out_file.get (), filename_temp.data (), total_len); - } + write_gdbindex (dwarf2_per_objfile, objfile_index_wip.out_file.get (), + (dwz_index_wip.has_value () + ? dwz_index_wip->out_file.get () : NULL)); - /* We want to keep the file. */ - unlink_file->keep (); + objfile_index_wip.finalize (); - /* Close and move the file in place. */ - out_file.reset (); - if (rename (filename_temp.data (), filename.c_str ()) != 0) - perror_with_name (("rename")); + if (dwz_index_wip.has_value ()) + dwz_index_wip->finalize (); } /* Implementation of the `save gdb-index' command. @@ -1678,8 +1761,14 @@ save_gdb_index_command (const char *arg, int from_tty) try { const char *basename = lbasename (objfile_name (objfile)); + const dwz_file *dwz = dwarf2_get_dwz_file (dwarf2_per_objfile); + const char *dwz_basename = NULL; + + if (dwz != NULL) + dwz_basename = lbasename (dwz->filename ()); + write_psymtabs_to_index (dwarf2_per_objfile, arg, basename, - index_kind); + dwz_basename, index_kind); } catch (const gdb_exception_error &except) {