elf/x86: Issue an error on discarded output .plt section
[binutils-gdb.git] / gdb / symfile.h
index 5b8b781e17fc0a2e531c95bc9f12d8967a0ec0ed..22b091182aaabb17d9deb2ca7eda3babf9d67be2 100644 (file)
@@ -1,6 +1,6 @@
 /* Definitions for reading symbol files into GDB.
 
-   Copyright (C) 1990-2018 Free Software Foundation, Inc.
+   Copyright (C) 1990-2021 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -26,7 +26,9 @@
 #include "symfile-add-flags.h"
 #include "objfile-flags.h"
 #include "gdb_bfd.h"
-#include "common/function-view.h"
+#include "gdbsupport/function-view.h"
+#include "target-section.h"
+#include "quick-symbol.h"
 
 /* Opaque declarations.  */
 struct target_section;
@@ -40,11 +42,6 @@ struct agent_expr;
 struct axs_value;
 class probe;
 
-/* Comparison function for symbol look ups.  */
-
-typedef int (symbol_compare_ftype) (const char *string1,
-                                   const char *string2);
-
 struct other_sections
 {
   other_sections (CORE_ADDR addr_, std::string &&name_, int sectindex_)
@@ -80,211 +77,31 @@ typedef std::vector<other_sections> section_addr_info;
    each BFD section belongs to.  */
 struct symfile_segment_data
 {
-  /* How many segments are present in this file.  If there are
-     two, the text segment is the first one and the data segment
-     is the second one.  */
-  int num_segments;
+  struct segment
+  {
+    segment (CORE_ADDR base, CORE_ADDR size)
+      : base (base), size (size)
+    {}
+
+    /* The original base address the segment.  */
+    CORE_ADDR base;
 
-  /* If NUM_SEGMENTS is greater than zero, the original base address
-     of each segment.  */
-  CORE_ADDR *segment_bases;
+    /* The memory size of the segment.  */
+    CORE_ADDR size;
+  };
 
-  /* If NUM_SEGMENTS is greater than zero, the memory size of each
-     segment.  */
-  CORE_ADDR *segment_sizes;
+  /* The segments present in this file.  If there are
+     two, the text segment is the first one and the data segment
+     is the second one.  */
+  std::vector<segment> segments;
 
-  /* If NUM_SEGMENTS is greater than zero, this is an array of entries
-     recording which segment contains each BFD section.
-     SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
+  /* This is an array of entries recording which segment contains each BFD
+     section.  SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
      S, or zero if it is not in any segment.  */
-  int *segment_info;
+  std::vector<int> segment_info;
 };
 
-/* Callback for quick_symbol_functions->map_symbol_filenames.  */
-
-typedef void (symbol_filename_ftype) (const char *filename,
-                                     const char *fullname, void *data);
-
-/* Callback for quick_symbol_functions->expand_symtabs_matching
-   to match a file name.  */
-
-typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
-                                                 bool basenames);
-
-/* Callback for quick_symbol_functions->expand_symtabs_matching
-   to match a symbol name.  */
-
-typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
-
-/* Callback for quick_symbol_functions->expand_symtabs_matching
-   to be called after a symtab has been expanded.  */
-
-typedef void (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
-
-/* The "quick" symbol functions exist so that symbol readers can
-   avoiding an initial read of all the symbols.  For example, symbol
-   readers might choose to use the "partial symbol table" utilities,
-   which is one implementation of the quick symbol functions.
-
-   The quick symbol functions are generally opaque: the underlying
-   representation is hidden from the caller.
-
-   In general, these functions should only look at whatever special
-   index the symbol reader creates -- looking through the symbol
-   tables themselves is handled by generic code.  If a function is
-   defined as returning a "symbol table", this means that the function
-   should only return a newly-created symbol table; it should not
-   examine pre-existing ones.
-
-   The exact list of functions here was determined in an ad hoc way
-   based on gdb's history.  */
-
-struct quick_symbol_functions
-{
-  /* Return true if this objfile has any "partial" symbols
-     available.  */
-  int (*has_symbols) (struct objfile *objfile);
-
-  /* Return the symbol table for the "last" file appearing in
-     OBJFILE.  */
-  struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
-
-  /* Forget all cached full file names for OBJFILE.  */
-  void (*forget_cached_source_info) (struct objfile *objfile);
-
-  /* Expand and iterate over each "partial" symbol table in OBJFILE
-     where the source file is named NAME.
-
-     If NAME is not absolute, a match after a '/' in the symbol table's
-     file name will also work, REAL_PATH is NULL then.  If NAME is
-     absolute then REAL_PATH is non-NULL absolute file name as resolved
-     via gdb_realpath from NAME.
-
-     If a match is found, the "partial" symbol table is expanded.
-     Then, this calls iterate_over_some_symtabs (or equivalent) over
-     all newly-created symbol tables, passing CALLBACK to it.
-     The result of this call is returned.  */
-  bool (*map_symtabs_matching_filename)
-    (struct objfile *objfile, const char *name, const char *real_path,
-     gdb::function_view<bool (symtab *)> callback);
-
-  /* Check to see if the symbol is defined in a "partial" symbol table
-     of OBJFILE.  BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
-     depending on whether we want to search global symbols or static
-     symbols.  NAME is the name of the symbol to look for.  DOMAIN
-     indicates what sort of symbol to search for.
-
-     Returns the newly-expanded compunit in which the symbol is
-     defined, or NULL if no such symbol table exists.  If OBJFILE
-     contains !TYPE_OPAQUE symbol prefer its compunit.  If it contains
-     only TYPE_OPAQUE symbol(s), return at least that compunit.  */
-  struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
-                                           int block_index, const char *name,
-                                           domain_enum domain);
-
-  /* Print statistics about any indices loaded for OBJFILE.  The
-     statistics should be printed to gdb_stdout.  This is used for
-     "maint print statistics".  */
-  void (*print_stats) (struct objfile *objfile);
-
-  /* Dump any indices loaded for OBJFILE.  The dump should go to
-     gdb_stdout.  This is used for "maint print objfiles".  */
-  void (*dump) (struct objfile *objfile);
-
-  /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
-     the corresponding symbol tables are loaded.  */
-  void (*expand_symtabs_for_function) (struct objfile *objfile,
-                                      const char *func_name);
-
-  /* Read all symbol tables associated with OBJFILE.  */
-  void (*expand_all_symtabs) (struct objfile *objfile);
-
-  /* Read all symbol tables associated with OBJFILE which have
-     symtab_to_fullname equal to FULLNAME.
-     This is for the purposes of examining code only, e.g., expand_line_sal.
-     The routine may ignore debug info that is known to not be useful with
-     code, e.g., DW_TAG_type_unit for dwarf debug info.  */
-  void (*expand_symtabs_with_fullname) (struct objfile *objfile,
-                                       const char *fullname);
-
-  /* Find global or static symbols in all tables that are in DOMAIN
-     and for which MATCH (symbol name, NAME) == 0, passing each to 
-     CALLBACK, reading in partial symbol tables as needed.  Look
-     through global symbols if GLOBAL and otherwise static symbols.
-     Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
-     found.  After each block is processed, passes NULL to CALLBACK.
-     MATCH must be weaker than strcmp_iw_ordered in the sense that
-     strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0.  ORDERED_COMPARE,
-     if non-null, must be an ordering relation compatible with
-     strcmp_iw_ordered in the sense that
-            strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
-     and 
-            strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
-     (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
-     CALLBACK returns 0 to indicate that the scan should continue, or
-     non-zero to indicate that the scan should be terminated.  */
-
-  void (*map_matching_symbols) (struct objfile *,
-                               const char *name, domain_enum domain,
-                               int global,
-                               int (*callback) (struct block *,
-                                                struct symbol *, void *),
-                               void *data,
-                               symbol_name_match_type match,
-                               symbol_compare_ftype *ordered_compare);
-
-  /* Expand all symbol tables in OBJFILE matching some criteria.
-
-     FILE_MATCHER is called for each file in OBJFILE.  The file name
-     is passed to it.  If the matcher returns false, the file is
-     skipped.  If FILE_MATCHER is NULL the file is not skipped.  If
-     BASENAMES is true the matcher should consider only file base
-     names (the passed file name is already only the lbasename'd
-     part).
-
-     Otherwise, if KIND does not match, this symbol is skipped.
-
-     If even KIND matches, SYMBOL_MATCHER is called for each symbol
-     defined in the file.  The symbol "search" name is passed to
-     SYMBOL_MATCHER.
-
-     If SYMBOL_MATCHER returns false, then the symbol is skipped.
-
-     Otherwise, the symbol's symbol table is expanded.  */
-  void (*expand_symtabs_matching)
-    (struct objfile *objfile,
-     gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
-     const lookup_name_info &lookup_name,
-     gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
-     gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
-     enum search_domain kind);
-
-  /* Return the comp unit from OBJFILE that contains PC and
-     SECTION.  Return NULL if there is no such compunit.  This
-     should return the compunit that contains a symbol whose
-     address exactly matches PC, or, if there is no exact match, the
-     compunit that contains a symbol whose address is closest to
-     PC.  */
-  struct compunit_symtab *(*find_pc_sect_compunit_symtab)
-    (struct objfile *objfile, struct bound_minimal_symbol msymbol,
-     CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
-
-  /* Return the comp unit from OBJFILE that contains a symbol at
-     ADDRESS.  Return NULL if there is no such comp unit.  Unlike
-     find_pc_sect_compunit_symtab, any sort of symbol (not just text
-     symbols) can be considered, and only exact address matches are
-     considered.  This pointer may be NULL.  */
-  struct compunit_symtab *(*find_compunit_symtab_by_address)
-    (struct objfile *objfile, CORE_ADDR address);
-
-  /* Call a callback for every file defined in OBJFILE whose symtab is
-     not already read in.  FUN is the callback.  It is passed the file's
-     FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
-     the DATA passed to this function.  */
-  void (*map_symbol_filenames) (struct objfile *objfile,
-                               symbol_filename_ftype *fun, void *data,
-                               int need_fullname);
-};
+using symfile_segment_data_up = std::unique_ptr<symfile_segment_data>;
 
 /* Structure of functions used for probe support.  If one of these functions
    is provided, all must be.  */
@@ -292,7 +109,8 @@ struct quick_symbol_functions
 struct sym_probe_fns
 {
   /* If non-NULL, return a reference to vector of probe objects.  */
-  const std::vector<probe *> &(*sym_get_probes) (struct objfile *);
+  const std::vector<std::unique_ptr<probe>> &(*sym_get_probes)
+    (struct objfile *);
 };
 
 /* Structure to keep track of symbol reading functions for various
@@ -319,13 +137,6 @@ struct sym_fns
 
   void (*sym_read) (struct objfile *, symfile_add_flags);
 
-  /* Read the partial symbols for an objfile.  This may be NULL, in which case
-     gdb has to check other ways if this objfile has any symbols.  This may
-     only be non-NULL if the objfile actually does have debuginfo available.
-     */
-
-  void (*sym_read_psymbols) (struct objfile *);
-
   /* Called when we are finished with an objfile.  Should do all
      cleanup that is specific to the object file format for the
      particular objfile.  */
@@ -345,7 +156,7 @@ struct sym_fns
      the segments of ABFD.  Each segment is a unit of the file
      which may be relocated independently.  */
 
-  struct symfile_segment_data *(*sym_segments) (bfd *abfd);
+  symfile_segment_data_up (*sym_segments) (bfd *abfd);
 
   /* This function should read the linetable from the objfile when
      the line table cannot be read while processing the debugging
@@ -362,18 +173,13 @@ struct sym_fns
   /* If non-NULL, this objfile has probe support, and all the probe
      functions referred to here will be non-NULL.  */
   const struct sym_probe_fns *sym_probe_fns;
-
-  /* The "quick" (aka partial) symbol functions for this symbol
-     reader.  */
-  const struct quick_symbol_functions *qf;
 };
 
 extern section_addr_info
   build_section_addr_info_from_objfile (const struct objfile *objfile);
 
 extern void relative_addr_info_to_section_offsets
-  (struct section_offsets *section_offsets, int num_sections,
-   const section_addr_info &addrs);
+  (section_offsets &section_offsets, const section_addr_info &addrs);
 
 extern void addr_info_make_relative (section_addr_info *addrs,
                                     bfd *abfd);
@@ -387,13 +193,13 @@ extern void default_symfile_offsets (struct objfile *objfile,
 /* The default version of sym_fns.sym_segments for readers that don't
    do anything special.  */
 
-extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
+extern symfile_segment_data_up default_symfile_segments (bfd *abfd);
 
 /* The default version of sym_fns.sym_relocate for readers that don't
    do anything special.  */
 
 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
-                                           asection *sectp, bfd_byte *buf);
+                                          asection *sectp, bfd_byte *buf);
 
 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
   ATTRIBUTE_NONNULL (1);
@@ -420,7 +226,7 @@ extern struct objfile *symbol_file_add (const char *, symfile_add_flags,
 
 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, symfile_add_flags,
                                                 section_addr_info *,
-                                                 objfile_flags, struct objfile *parent);
+                                                objfile_flags, struct objfile *parent);
 
 extern void symbol_file_add_separate (bfd *, const char *, symfile_add_flags,
                                      struct objfile *);
@@ -431,14 +237,11 @@ extern std::string find_separate_debug_file_by_debuglink (struct objfile *);
    existing section table.  */
 
 extern section_addr_info
-   build_section_addr_info_from_section_table (const struct target_section
-                                              *start,
-                                              const struct target_section
-                                              *end);
+    build_section_addr_info_from_section_table (const target_section_table &table);
 
                        /*   Variables   */
 
-/* If non-zero, shared library symbols will be added automatically
+/* If true, shared library symbols will be added automatically
    when the inferior is created, new libraries are loaded, or when
    attaching to the inferior.  This is almost always what users will
    want to have happen; but for very large programs, the startup time
@@ -448,14 +251,12 @@ extern section_addr_info
    library symbols are not loaded, commands like "info fun" will *not*
    report all the functions that are actually present.  */
 
-extern int auto_solib_add;
+extern bool auto_solib_add;
 
 /* From symfile.c */
 
 extern void set_initial_language (void);
 
-extern void find_lowest_section (bfd *, asection *, void *);
-
 extern gdb_bfd_ref_ptr symfile_bfd_open (const char *);
 
 extern int get_section_index (struct objfile *, const char *);
@@ -514,119 +315,43 @@ extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
 
 extern int symfile_map_offsets_to_segments (bfd *,
                                            const struct symfile_segment_data *,
-                                           struct section_offsets *,
+                                           section_offsets &,
                                            int, const CORE_ADDR *);
-struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
-void free_symfile_segment_data (struct symfile_segment_data *data);
+symfile_segment_data_up get_symfile_segment_data (bfd *abfd);
 
 extern scoped_restore_tmpl<int> increment_reading_symtab (void);
 
-void expand_symtabs_matching
+bool expand_symtabs_matching
   (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
    const lookup_name_info &lookup_name,
    gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
    gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
+   block_search_flags search_flags,
    enum search_domain kind);
 
-void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
-                          int need_fullname);
-
-/* From dwarf2read.c */
-
-/* Names for a dwarf2 debugging section.  The field NORMAL is the normal
-   section name (usually from the DWARF standard), while the field COMPRESSED
-   is the name of compressed sections.  If your object file format doesn't
-   support compressed sections, the field COMPRESSED can be NULL.  Likewise,
-   the debugging section is not supported, the field NORMAL can be NULL too.
-   It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
-   field.  */
-
-struct dwarf2_section_names {
-  const char *normal;
-  const char *compressed;
-};
-
-/* List of names for dward2 debugging sections.  Also most object file formats
-   use the standardized (ie ELF) names, some (eg XCOFF) have customized names
-   due to restrictions.
-   The table for the standard names is defined in dwarf2read.c.  Please
-   update all instances of dwarf2_debug_sections if you add a field to this
-   structure.  It is always safe to use { NULL, NULL } in this case.  */
-
-struct dwarf2_debug_sections {
-  struct dwarf2_section_names info;
-  struct dwarf2_section_names abbrev;
-  struct dwarf2_section_names line;
-  struct dwarf2_section_names loc;
-  struct dwarf2_section_names loclists;
-  struct dwarf2_section_names macinfo;
-  struct dwarf2_section_names macro;
-  struct dwarf2_section_names str;
-  struct dwarf2_section_names line_str;
-  struct dwarf2_section_names ranges;
-  struct dwarf2_section_names rnglists;
-  struct dwarf2_section_names types;
-  struct dwarf2_section_names addr;
-  struct dwarf2_section_names frame;
-  struct dwarf2_section_names eh_frame;
-  struct dwarf2_section_names gdb_index;
-  struct dwarf2_section_names debug_names;
-  struct dwarf2_section_names debug_aranges;
-  /* This field has no meaning, but exists solely to catch changes to
-     this structure which are not reflected in some instance.  */
-  int sentinel;
-};
-
-extern int dwarf2_has_info (struct objfile *,
-                            const struct dwarf2_debug_sections *);
-
-/* Dwarf2 sections that can be accessed by dwarf2_get_section_info.  */
-enum dwarf2_section_enum {
-  DWARF2_DEBUG_FRAME,
-  DWARF2_EH_FRAME
-};
-
-extern void dwarf2_get_section_info (struct objfile *,
-                                     enum dwarf2_section_enum,
-                                    asection **, const gdb_byte **,
-                                    bfd_size_type *);
-
-/* A DWARF names index variant.  */
-enum class dw_index_kind
-{
-  /* GDB's own .gdb_index format.   */
-  GDB_INDEX,
+void map_symbol_filenames (gdb::function_view<symbol_filename_ftype> fun,
+                          bool need_fullname);
 
-  /* DWARF5 .debug_names.  */
-  DEBUG_NAMES,
-};
+/* Target-agnostic function to load the sections of an executable into memory.
 
-/* Initialize for reading DWARF for OBJFILE.  Return false if this
-   file will use psymtabs, or true if using an index, in which case
-   *INDEX_KIND is set to the index variant in use.  */
-extern bool dwarf2_initialize_objfile (struct objfile *objfile,
-                                      dw_index_kind *index_kind);
+   ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
+   optional offset to apply to each section.  */
+extern void generic_load (const char *args, int from_tty);
 
-extern void dwarf2_build_psymtabs (struct objfile *);
-extern void dwarf2_build_frame_info (struct objfile *);
+/* From minidebug.c.  */
 
-/* From mdebugread.c */
+extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
 
-extern void mdebug_build_psymtabs (minimal_symbol_reader &,
-                                  struct objfile *,
-                                  const struct ecoff_debug_swap *,
-                                  struct ecoff_debug_info *);
+/* True if we are printing debug output about separate debug info files.  */
 
-extern void elfmdebug_build_psymtabs (struct objfile *,
-                                     const struct ecoff_debug_swap *,
-                                     asection *);
+extern bool separate_debug_file_debug;
 
-/* From minidebug.c.  */
+/* Read full symbols immediately.  */
 
-extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
+extern int readnow_symbol_files;
 
-/* True if we are printing debug output about separate debug info files.  */
+/* Never read full symbols.  */
 
-extern int separate_debug_file_debug;
+extern int readnever_symbol_files;
 
 #endif /* !defined(SYMFILE_H) */