[PATCH 1/2] gdb/dwarf: rename cooked_index to cooked_index_shard

[PATCH 1/2] gdb/dwarf: rename cooked_index to cooked_index_shard

[Simon Marchi]

I propose to rename cooked_index_vector and cooked_index such that the
"main" object, that is the entry point to the index, is called
cooked_index.  The fact that the cooked index is implemented as a vector
of smaller indexes is an implementation detail.

This patch renames cooked_index to cooked_index_shard.  The following
patch renames cooked_index_vector to cooked_index.

Change-Id: Id650f97dcb23c48f8409fa0974cd093ca0b75177
---
 gdb/dwarf2/cooked-index.c | 22 +++++++++++-----------
 gdb/dwarf2/cooked-index.h | 12 ++++++------
 gdb/dwarf2/read.c         | 14 +++++++-------
 3 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/gdb/dwarf2/cooked-index.c b/gdb/dwarf2/cooked-index.c
index 82dc44dd74b0..61f825ba6299 100644
--- a/gdb/dwarf2/cooked-index.c
+++ b/gdb/dwarf2/cooked-index.c
@@ -204,10 +204,10 @@ cooked_index_entry::write_scope (struct obstack *storage,
 /* See cooked-index.h.  */
 
 const cooked_index_entry *
-cooked_index::add (sect_offset die_offset, enum dwarf_tag tag,
-		   cooked_index_flag flags, const char *name,
-		   const cooked_index_entry *parent_entry,
-		   dwarf2_per_cu_data *per_cu)
+cooked_index_shard::add (sect_offset die_offset, enum dwarf_tag tag,
+			 cooked_index_flag flags, const char *name,
+			 const cooked_index_entry *parent_entry,
+			 dwarf2_per_cu_data *per_cu)
 {
   cooked_index_entry *result = create (die_offset, tag, flags, name,
 				       parent_entry, per_cu);
@@ -228,7 +228,7 @@ cooked_index::add (sect_offset die_offset, enum dwarf_tag tag,
 /* See cooked-index.h.  */
 
 void
-cooked_index::finalize ()
+cooked_index_shard::finalize ()
 {
   m_future = gdb::thread_pool::g_thread_pool->post_task ([this] ()
     {
@@ -239,8 +239,8 @@ cooked_index::finalize ()
 /* See cooked-index.h.  */
 
 gdb::unique_xmalloc_ptr<char>
-cooked_index::handle_gnat_encoded_entry (cooked_index_entry *entry,
-					 htab_t gnat_entries)
+cooked_index_shard::handle_gnat_encoded_entry (cooked_index_entry *entry,
+					       htab_t gnat_entries)
 {
   std::string canonical = ada_decode (entry->name, false, false);
   if (canonical.empty ())
@@ -281,7 +281,7 @@ cooked_index::handle_gnat_encoded_entry (cooked_index_entry *entry,
 /* See cooked-index.h.  */
 
 void
-cooked_index::do_finalize ()
+cooked_index_shard::do_finalize ()
 {
   auto hash_name_ptr = [] (const void *p)
     {
@@ -378,8 +378,8 @@ cooked_index::do_finalize ()
 
 /* See cooked-index.h.  */
 
-cooked_index::range
-cooked_index::find (const std::string &name, bool completing) const
+cooked_index_shard::range
+cooked_index_shard::find (const std::string &name, bool completing) const
 {
   wait ();
 
@@ -441,7 +441,7 @@ cooked_index_vector::get_addrmaps () const
 cooked_index_vector::range
 cooked_index_vector::find (const std::string &name, bool completing) const
 {
-  std::vector<cooked_index::range> result_range;
+  std::vector<cooked_index_shard::range> result_range;
   result_range.reserve (m_vector.size ());
   for (auto &entry : m_vector)
     result_range.push_back (entry->find (name, completing));
diff --git a/gdb/dwarf2/cooked-index.h b/gdb/dwarf2/cooked-index.h
index fa7d8840d166..22fb0110ea27 100644
--- a/gdb/dwarf2/cooked-index.h
+++ b/gdb/dwarf2/cooked-index.h
@@ -232,11 +232,11 @@ class cooked_index_vector;
    Operations on the index are described below.  They are chosen to
    make it relatively simple to implement the symtab "quick"
    methods.  */
-class cooked_index
+class cooked_index_shard
 {
 public:
-  cooked_index () = default;
-  DISABLE_COPY_AND_ASSIGN (cooked_index);
+  cooked_index_shard () = default;
+  DISABLE_COPY_AND_ASSIGN (cooked_index_shard);
 
   /* Create a new cooked_index_entry and register it with this object.
      Entries are owned by this object.  The new item is returned.  */
@@ -353,7 +353,7 @@ class cooked_index_vector : public dwarf_scanner_base
 
   /* A convenience typedef for the vector that is contained in this
      object.  */
-  typedef std::vector<std::unique_ptr<cooked_index>> vec_type;
+  using vec_type = std::vector<std::unique_ptr<cooked_index_shard>>;
 
   explicit cooked_index_vector (vec_type &&vec);
   DISABLE_COPY_AND_ASSIGN (cooked_index_vector);
@@ -378,7 +378,7 @@ class cooked_index_vector : public dwarf_scanner_base
   }
 
   /* A range over a vector of subranges.  */
-  typedef range_chain<cooked_index::range> range;
+  using range = range_chain<cooked_index_shard::range>;
 
   /* Look up an entry by name.  Returns a range of all matching
      results.  If COMPLETING is true, then a larger range, suitable
@@ -388,7 +388,7 @@ class cooked_index_vector : public dwarf_scanner_base
   /* Return a range of all the entries.  */
   range all_entries () const
   {
-    std::vector<cooked_index::range> result_range;
+    std::vector<cooked_index_shard::range> result_range;
     result_range.reserve (m_vector.size ());
     for (auto &entry : m_vector)
       result_range.push_back (entry->all_entries ());
diff --git a/gdb/dwarf2/read.c b/gdb/dwarf2/read.c
index 6cee22a3faa6..9c7cb1e4dbca 100644
--- a/gdb/dwarf2/read.c
+++ b/gdb/dwarf2/read.c
@@ -6611,7 +6611,7 @@ class cooked_index_storage
 					eq_cutu_reader,
 					htab_delete_entry<cutu_reader>,
 					xcalloc, xfree)),
-      m_index (new cooked_index)
+      m_index (new cooked_index_shard)
   {
   }
 
@@ -6657,9 +6657,9 @@ class cooked_index_storage
     return m_index->add (die_offset, tag, flags, name, parent_entry, per_cu);
   }
 
-  /* Install the current addrmap into the index being constructed,
+  /* Install the current addrmap into the index shard being constructed,
      then transfer ownership of the index to the caller.  */
-  std::unique_ptr<cooked_index> release ()
+  std::unique_ptr<cooked_index_shard> release ()
   {
     m_index->install_addrmap (&m_addrmap);
     return std::move (m_index);
@@ -6692,8 +6692,8 @@ class cooked_index_storage
   abbrev_cache m_abbrev_cache;
   /* A hash table of cutu_reader objects.  */
   htab_up m_reader_hash;
-  /* The index that is being constructed.  */
-  std::unique_ptr<cooked_index> m_index;
+  /* The index shard that is being constructed.  */
+  std::unique_ptr<cooked_index_shard> m_index;
 
   /* A writeable addrmap being constructed by this scanner.  */
   addrmap_mutable m_addrmap;
@@ -7102,7 +7102,7 @@ dwarf2_build_psymtabs_hard (dwarf2_per_objfile *per_objfile)
   cooked_index_storage index_storage;
   create_all_units (per_objfile);
   build_type_psymtabs (per_objfile, &index_storage);
-  std::vector<std::unique_ptr<cooked_index>> indexes;
+  std::vector<std::unique_ptr<cooked_index_shard>> indexes;
 
   per_bfd->quick_file_names_table
     = create_quick_file_names_table (per_bfd->all_units.size ());
@@ -7128,7 +7128,7 @@ dwarf2_build_psymtabs_hard (dwarf2_per_objfile *per_objfile)
        GDB's I/O system is not thread-safe.  run_on_main_thread could be
        used, but that would mean the messages are printed after the
        prompt, which looks weird.  */
-    using result_type = std::pair<std::unique_ptr<cooked_index>,
+    using result_type = std::pair<std::unique_ptr<cooked_index_shard>,
 				  std::vector<gdb_exception>>;
     std::vector<result_type> results
       = gdb::parallel_for_each (1, per_bfd->all_units.begin (),
-- 
2.39.1

[PATCH 2/2] gdb/dwarf: rename cooked_index_vector to cooked_index

[Simon Marchi]

See previous patch's commit message for rationale.

Change-Id: I6b8cdc045dffccc1c01ed690ff258af09f6ff076
---
 gdb/dwarf2/cooked-index.c | 14 +++++++-------
 gdb/dwarf2/cooked-index.h | 18 +++++++++---------
 gdb/dwarf2/index-write.c  | 11 ++++-------
 gdb/dwarf2/mapped-index.h |  6 +++---
 gdb/dwarf2/read.c         | 24 ++++++++++++------------
 5 files changed, 35 insertions(+), 38 deletions(-)

diff --git a/gdb/dwarf2/cooked-index.c b/gdb/dwarf2/cooked-index.c
index 61f825ba6299..f253a4267c9b 100644
--- a/gdb/dwarf2/cooked-index.c
+++ b/gdb/dwarf2/cooked-index.c
@@ -404,7 +404,7 @@ cooked_index_shard::find (const std::string &name, bool completing) const
   return range (lower, upper);
 }
 
-cooked_index_vector::cooked_index_vector (vec_type &&vec)
+cooked_index::cooked_index (vec_type &&vec)
   : m_vector (std::move (vec))
 {
   for (auto &idx : m_vector)
@@ -414,7 +414,7 @@ cooked_index_vector::cooked_index_vector (vec_type &&vec)
 /* See cooked-index.h.  */
 
 dwarf2_per_cu_data *
-cooked_index_vector::lookup (CORE_ADDR addr)
+cooked_index::lookup (CORE_ADDR addr)
 {
   for (const auto &index : m_vector)
     {
@@ -428,7 +428,7 @@ cooked_index_vector::lookup (CORE_ADDR addr)
 /* See cooked-index.h.  */
 
 std::vector<const addrmap *>
-cooked_index_vector::get_addrmaps () const
+cooked_index::get_addrmaps () const
 {
   std::vector<const addrmap *> result;
   for (const auto &index : m_vector)
@@ -438,8 +438,8 @@ cooked_index_vector::get_addrmaps () const
 
 /* See cooked-index.h.  */
 
-cooked_index_vector::range
-cooked_index_vector::find (const std::string &name, bool completing) const
+cooked_index::range
+cooked_index::find (const std::string &name, bool completing) const
 {
   std::vector<cooked_index_shard::range> result_range;
   result_range.reserve (m_vector.size ());
@@ -451,7 +451,7 @@ cooked_index_vector::find (const std::string &name, bool completing) const
 /* See cooked-index.h.  */
 
 const cooked_index_entry *
-cooked_index_vector::get_main () const
+cooked_index::get_main () const
 {
   const cooked_index_entry *result = nullptr;
 
@@ -471,7 +471,7 @@ cooked_index_vector::get_main () const
 /* See cooked-index.h.  */
 
 void
-cooked_index_vector::dump (gdbarch *arch) const
+cooked_index::dump (gdbarch *arch) const
 {
   /* Ensure the index is done building.  */
   this->wait ();
diff --git a/gdb/dwarf2/cooked-index.h b/gdb/dwarf2/cooked-index.h
index 22fb0110ea27..7a8216abbf36 100644
--- a/gdb/dwarf2/cooked-index.h
+++ b/gdb/dwarf2/cooked-index.h
@@ -223,7 +223,7 @@ struct cooked_index_entry : public allocate_on_obstack
   void write_scope (struct obstack *storage, const char *sep) const;
 };
 
-class cooked_index_vector;
+class cooked_index;
 
 /* An index of interesting DIEs.  This is "cooked", in contrast to a
    mapped .debug_names or .gdb_index, which are "raw".  An entry in
@@ -264,7 +264,7 @@ class cooked_index_shard
     m_future.wait ();
   }
 
-  friend class cooked_index_vector;
+  friend class cooked_index;
 
   /* A simple range over part of m_entries.  */
   typedef iterator_range<std::vector<cooked_index_entry *>::const_iterator>
@@ -343,11 +343,11 @@ class cooked_index_shard
 };
 
 /* The main index of DIEs.  The parallel DIE indexers create
-   cooked_index objects.  Then, these are all handled to a
-   cooked_index_vector for storage and final indexing.  The index is
+   cooked_index_shard objects.  Then, these are all handled to a
+   cooked_index for storage and final indexing.  The index is
    made by iterating over the entries previously created.  */
 
-class cooked_index_vector : public dwarf_scanner_base
+class cooked_index : public dwarf_scanner_base
 {
 public:
 
@@ -355,8 +355,8 @@ class cooked_index_vector : public dwarf_scanner_base
      object.  */
   using vec_type = std::vector<std::unique_ptr<cooked_index_shard>>;
 
-  explicit cooked_index_vector (vec_type &&vec);
-  DISABLE_COPY_AND_ASSIGN (cooked_index_vector);
+  explicit cooked_index (vec_type &&vec);
+  DISABLE_COPY_AND_ASSIGN (cooked_index);
 
   /* Wait until the finalization of the entire cooked_index_vector is
      done.  */
@@ -366,7 +366,7 @@ class cooked_index_vector : public dwarf_scanner_base
       item->wait ();
   }
 
-  ~cooked_index_vector ()
+  ~cooked_index ()
   {
     /* The 'finalize' methods may be run in a different thread.  If
        this object is destroyed before these complete, then one will
@@ -408,7 +408,7 @@ class cooked_index_vector : public dwarf_scanner_base
      "main".  This will return NULL if no such entry is available.  */
   const cooked_index_entry *get_main () const;
 
-  cooked_index_vector *index_for_writing () override
+  cooked_index *index_for_writing () override
   {
     return this;
   }
diff --git a/gdb/dwarf2/index-write.c b/gdb/dwarf2/index-write.c
index 82cd3a8636d0..52f6054b234c 100644
--- a/gdb/dwarf2/index-write.c
+++ b/gdb/dwarf2/index-write.c
@@ -1124,7 +1124,7 @@ write_gdbindex_1 (FILE *out_file,
 /* Write the contents of the internal "cooked" index.  */
 
 static void
-write_cooked_index (cooked_index_vector *table,
+write_cooked_index (cooked_index *table,
 		    const cu_index_map &cu_index_htab,
 		    struct mapped_symtab *symtab)
 {
@@ -1199,8 +1199,7 @@ write_cooked_index (cooked_index_vector *table,
    associated dwz file, DWZ_OUT_FILE must be NULL.  */
 
 static void
-write_gdbindex (dwarf2_per_objfile *per_objfile,
-		cooked_index_vector *table,
+write_gdbindex (dwarf2_per_objfile *per_objfile, cooked_index *table,
 		FILE *out_file, FILE *dwz_out_file)
 {
   mapped_symtab symtab;
@@ -1289,8 +1288,7 @@ static const gdb_byte dwarf5_gdb_augmentation[] = { 'G', 'D', 'B', 0 };
    many bytes were expected to be written into OUT_FILE.  */
 
 static void
-write_debug_names (dwarf2_per_objfile *per_objfile,
-		   cooked_index_vector *table,
+write_debug_names (dwarf2_per_objfile *per_objfile, cooked_index *table,
 		   FILE *out_file, FILE *out_file_str)
 {
   const bool dwarf5_is_dwarf64 = check_dwarf64_offsets (per_objfile);
@@ -1464,8 +1462,7 @@ write_dwarf_index (dwarf2_per_objfile *per_objfile, const char *dir,
 
   if (per_objfile->per_bfd->index_table == nullptr)
     error (_("No debugging symbols"));
-  cooked_index_vector *table
-    = per_objfile->per_bfd->index_table->index_for_writing ();
+  cooked_index *table = per_objfile->per_bfd->index_table->index_for_writing ();
 
   if (per_objfile->per_bfd->types.size () > 1)
     error (_("Cannot make an index when the file has multiple .debug_types sections"));
diff --git a/gdb/dwarf2/mapped-index.h b/gdb/dwarf2/mapped-index.h
index 40f244495643..29c7291ef969 100644
--- a/gdb/dwarf2/mapped-index.h
+++ b/gdb/dwarf2/mapped-index.h
@@ -47,7 +47,7 @@ struct name_component
   offset_type idx;
 };
 
-class cooked_index_vector;
+class cooked_index;
 
 /* Base class of all DWARF scanner types.  */
 
@@ -72,7 +72,7 @@ struct dwarf_scanner_base
   /* This is called when writing an index.  For a cooked index, it
      will return 'this' as a cooked index.  For other forms, it will
      throw an exception with an appropriate error message.  */
-  virtual cooked_index_vector *index_for_writing () = 0;
+  virtual cooked_index *index_for_writing () = 0;
 };
 
 /* Base class containing bits shared by both .gdb_index and
@@ -117,7 +117,7 @@ struct mapped_index_base : public dwarf_scanner_base
 				 enum language lang,
 				 dwarf2_per_objfile *per_objfile) const;
 
-  cooked_index_vector *index_for_writing () override
+  cooked_index *index_for_writing () override
   {
     error (_("Cannot use an index to create the index"));
   }
diff --git a/gdb/dwarf2/read.c b/gdb/dwarf2/read.c
index 9c7cb1e4dbca..ee4e7c1530a9 100644
--- a/gdb/dwarf2/read.c
+++ b/gdb/dwarf2/read.c
@@ -7173,7 +7173,7 @@ dwarf2_build_psymtabs_hard (dwarf2_per_objfile *per_objfile)
   indexes.push_back (index_storage.release ());
   indexes.shrink_to_fit ();
 
-  cooked_index_vector *vec = new cooked_index_vector (std::move (indexes));
+  cooked_index *vec = new cooked_index (std::move (indexes));
   per_bfd->index_table.reset (vec);
 
   const cooked_index_entry *main_entry = vec->get_main ();
@@ -18590,8 +18590,8 @@ struct cooked_index_functions : public dwarf2_base_index_functions
   void dump (struct objfile *objfile) override
   {
     dwarf2_per_objfile *per_objfile = get_dwarf2_per_objfile (objfile);
-    cooked_index_vector *index
-      = (gdb::checked_static_cast<cooked_index_vector *>
+    cooked_index *index
+      = (gdb::checked_static_cast<cooked_index *>
 	  (per_objfile->per_bfd->index_table.get ()));
     if (index == nullptr)
       return;
@@ -18636,8 +18636,8 @@ cooked_index_functions::find_per_cu (dwarf2_per_bfd *per_bfd,
 {
   if (per_bfd->index_table == nullptr)
     return nullptr;
-  cooked_index_vector *table
-    = (gdb::checked_static_cast<cooked_index_vector *>
+  cooked_index *table
+    = (gdb::checked_static_cast<cooked_index *>
        (per_bfd->index_table.get ()));
   return table->lookup (adjusted_pc);
 }
@@ -18654,8 +18654,8 @@ cooked_index_functions::find_compunit_symtab_by_address
     return nullptr;
 
   CORE_ADDR baseaddr = objfile->data_section_offset ();
-  cooked_index_vector *table
-    = (gdb::checked_static_cast<cooked_index_vector *>
+  cooked_index *table
+    = (gdb::checked_static_cast<cooked_index *>
        (per_objfile->per_bfd->index_table.get ()));
   dwarf2_per_cu_data *per_cu = table->lookup (address - baseaddr);
   if (per_cu == nullptr)
@@ -18682,8 +18682,8 @@ cooked_index_functions::expand_matching_symbols
   symbol_name_matcher_ftype *name_match
     = lang->get_symbol_name_matcher (lookup_name);
 
-  cooked_index_vector *table
-    = (gdb::checked_static_cast<cooked_index_vector *>
+  cooked_index *table
+    = (gdb::checked_static_cast<cooked_index *>
        (per_objfile->per_bfd->index_table.get ()));
   for (const cooked_index_entry *entry : table->all_entries ())
     {
@@ -18716,8 +18716,8 @@ cooked_index_functions::expand_symtabs_matching
   if (per_objfile->per_bfd->index_table == nullptr)
     return true;
 
-  cooked_index_vector *table
-    = (gdb::checked_static_cast<cooked_index_vector *>
+  cooked_index *table
+    = (gdb::checked_static_cast<cooked_index *>
        (per_objfile->per_bfd->index_table.get ()));
   table->wait ();
 
@@ -18845,7 +18845,7 @@ make_cooked_index_funcs ()
 }
 
 quick_symbol_functions_up
-cooked_index_vector::make_quick_functions () const
+cooked_index::make_quick_functions () const
 {
   return make_cooked_index_funcs ();
 }
-- 
2.39.1

Re: [PATCH 1/2] gdb/dwarf: rename cooked_index to cooked_index_shard

[Tom Tromey]

>>>>> "Simon" == Simon Marchi via Gdb-patches <gdb-patches@sourceware.org> writes:

Simon> I propose to rename cooked_index_vector and cooked_index such that the
Simon> "main" object, that is the entry point to the index, is called
Simon> cooked_index.  The fact that the cooked index is implemented as a vector
Simon> of smaller indexes is an implementation detail.

Agreed.  Thank you for doing this.

Approved-By: Tom Tromey <tom@tromey.com>

Tom

Re: [PATCH 2/2] gdb/dwarf: rename cooked_index_vector to cooked_index

[Tom Tromey]

>>>>> "Simon" == Simon Marchi via Gdb-patches <gdb-patches@sourceware.org> writes:

Simon> See previous patch's commit message for rationale.

I've found that "previous" is more confusing when reading the git log.
Maybe just a reference to the _shard rename would be sufficient here
though.

Approved-By: Tom Tromey <tom@tromey.com>

Tom

Re: [PATCH 2/2] gdb/dwarf: rename cooked_index_vector to cooked_index

[Simon Marchi]

On 1/31/23 15:56, Tom Tromey wrote:
>>>>>> "Simon" == Simon Marchi via Gdb-patches <gdb-patches@sourceware.org> writes:
> 
> Simon> See previous patch's commit message for rationale.
> 
> I've found that "previous" is more confusing when reading the git log.
> Maybe just a reference to the _shard rename would be sufficient here
> though.
> 
> Approved-By: Tom Tromey <tom@tromey.com>

Argh, I'm tired, and I pushed the patches before addressing your
comment, sorry about that.

Simon

Re: [PATCH 2/2] gdb/dwarf: rename cooked_index_vector to cooked_index

[Tom Tromey]

Simon> Argh, I'm tired, and I pushed the patches before addressing your
Simon> comment, sorry about that.

It's no big deal, don't worry about it.

Tom