/* Shared library declarations for GDB, the GNU Debugger.
- Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
- 2001, 2007 Free Software Foundation, Inc.
+ Copyright (C) 1990-2022 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 2 of the License, or
+ 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,
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, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef SOLIST_H
#define SOLIST_H
#define SO_NAME_MAX_PATH_SIZE 512 /* FIXME: Should be dynamic */
+/* For domain_enum domain. */
+#include "symtab.h"
+#include "gdb_bfd.h"
+#include "target-section.h"
-/* Forward declaration for target specific link map information. This
- struct is opaque to all but the target specific file. */
-struct lm_info;
+/* Base class for target-specific link map information. */
+
+struct lm_info_base
+{
+};
struct so_list
- {
- /* The following fields of the structure come directly from the
- dynamic linker's tables in the inferior, and are initialized by
- current_sos. */
-
- struct so_list *next; /* next structure in linked list */
-
- /* A pointer to target specific link map information. Often this
- will be a copy of struct link_map from the user process, but
- it need not be; it can be any collection of data needed to
- traverse the dynamic linker's data structures. */
- struct lm_info *lm_info;
-
- /* Shared object file name, exactly as it appears in the
- inferior's link map. This may be a relative path, or something
- which needs to be looked up in LD_LIBRARY_PATH, etc. We use it
- to tell which entries in the inferior's dynamic linker's link
- map we've already loaded. */
- char so_original_name[SO_NAME_MAX_PATH_SIZE];
-
- /* shared object file name, expanded to something GDB can open */
- char so_name[SO_NAME_MAX_PATH_SIZE];
-
- /* The following fields of the structure are built from
- information gathered from the shared object file itself, and
- are set when we actually add it to our symbol tables.
-
- current_sos must initialize these fields to 0. */
-
- bfd *abfd;
- char symbols_loaded; /* flag: symbols read in yet? */
- char from_tty; /* flag: print msgs? */
- struct objfile *objfile; /* objfile for loaded lib */
- struct section_table *sections;
- struct section_table *sections_end;
-
- /* Record the range of addresses belonging to this shared library.
- There may not be just one (e.g. if two segments are relocated
- differently); but this is only used for "info sharedlibrary". */
- CORE_ADDR addr_low, addr_high;
- };
+{
+ /* The following fields of the structure come directly from the
+ dynamic linker's tables in the inferior, and are initialized by
+ current_sos. */
-struct target_so_ops
- {
- /* Adjust the section binding addresses by the base address at
- which the object was actually mapped. */
- void (*relocate_section_addresses) (struct so_list *so,
- struct section_table *);
+ struct so_list *next; /* next structure in linked list */
+
+ /* A pointer to target specific link map information. Often this
+ will be a copy of struct link_map from the user process, but
+ it need not be; it can be any collection of data needed to
+ traverse the dynamic linker's data structures. */
+ lm_info_base *lm_info;
+
+ /* Shared object file name, exactly as it appears in the
+ inferior's link map. This may be a relative path, or something
+ which needs to be looked up in LD_LIBRARY_PATH, etc. We use it
+ to tell which entries in the inferior's dynamic linker's link
+ map we've already loaded. */
+ char so_original_name[SO_NAME_MAX_PATH_SIZE];
+
+ /* Shared object file name, expanded to something GDB can open. */
+ char so_name[SO_NAME_MAX_PATH_SIZE];
- /* Free the the link map info and any other private data
- structures associated with a so_list entry. */
- void (*free_so) (struct so_list *so);
+ /* Program space this shared library belongs to. */
+ struct program_space *pspace;
- /* Reset or free private data structures not associated with
- so_list entries. */
- void (*clear_solib) (void);
+ /* The following fields of the structure are built from
+ information gathered from the shared object file itself, and
+ are set when we actually add it to our symbol tables.
- /* Target dependent code to run after child process fork. */
- void (*solib_create_inferior_hook) (void);
+ current_sos must initialize these fields to 0. */
- /* Do additional symbol handling, lookup, etc. after symbols
- for a shared object have been loaded. */
- void (*special_symbol_handling) (void);
+ bfd *abfd;
+ char symbols_loaded; /* flag: symbols read in yet? */
- /* Construct a list of the currently loaded shared objects. */
- struct so_list *(*current_sos) (void);
+ /* objfile with symbols for a loaded library. Target memory is read from
+ ABFD. OBJFILE may be NULL either before symbols have been loaded, if
+ the file cannot be found or after the command "nosharedlibrary". */
+ struct objfile *objfile;
- /* Find, open, and read the symbols for the main executable. */
- int (*open_symbol_file_object) (void *from_ttyp);
+ target_section_table *sections;
- /* Determine if PC lies in the dynamic symbol resolution code of
- the run time loader */
- int (*in_dynsym_resolve_code) (CORE_ADDR pc);
+ /* Record the range of addresses belonging to this shared library.
+ There may not be just one (e.g. if two segments are relocated
+ differently). This is used for "info sharedlibrary" and
+ the MI command "-file-list-shared-libraries". The latter has a format
+ that supports outputting multiple segments once the related code
+ supports them. */
+ CORE_ADDR addr_low, addr_high;
+};
- /* Extra hook for finding and opening a solib.
- Convenience function for remote debuggers finding host libs. */
- int (*find_and_open_solib) (char *soname,
- unsigned o_flags, char **temp_pathname);
-
- };
+struct target_so_ops
+{
+ /* Adjust the section binding addresses by the base address at
+ which the object was actually mapped. */
+ void (*relocate_section_addresses) (struct so_list *so,
+ struct target_section *);
+
+ /* Free the link map info and any other private data structures
+ associated with a so_list entry. */
+ void (*free_so) (struct so_list *so);
+
+ /* Reset private data structures associated with SO.
+ This is called when SO is about to be reloaded.
+ It is also called before free_so when SO is about to be freed. */
+ void (*clear_so) (struct so_list *so);
+
+ /* Reset or free private data structures not associated with
+ so_list entries. */
+ void (*clear_solib) (void);
+
+ /* Target dependent code to run after child process fork. */
+ void (*solib_create_inferior_hook) (int from_tty);
+
+ /* Construct a list of the currently loaded shared objects. This
+ list does not include an entry for the main executable file.
+
+ Note that we only gather information directly available from the
+ inferior --- we don't examine any of the shared library files
+ themselves. The declaration of `struct so_list' says which fields
+ we provide values for. */
+ struct so_list *(*current_sos) (void);
+
+ /* Find, open, and read the symbols for the main executable. If
+ FROM_TTY is non-zero, allow messages to be printed. */
+ int (*open_symbol_file_object) (int from_ttyp);
+
+ /* Determine if PC lies in the dynamic symbol resolution code of
+ the run time loader. */
+ int (*in_dynsym_resolve_code) (CORE_ADDR pc);
+
+ /* Find and open shared library binary file. */
+ gdb_bfd_ref_ptr (*bfd_open) (const char *pathname);
+
+ /* Optional extra hook for finding and opening a solib.
+ If TEMP_PATHNAME is non-NULL: If the file is successfully opened a
+ pointer to a malloc'd and realpath'd copy of SONAME is stored there,
+ otherwise NULL is stored there. */
+ int (*find_and_open_solib) (const char *soname,
+ unsigned o_flags,
+ gdb::unique_xmalloc_ptr<char> *temp_pathname);
+
+ /* Given two so_list objects, one from the GDB thread list
+ and another from the list returned by current_sos, return 1
+ if they represent the same library.
+ Falls back to using strcmp on so_original_name field when set
+ to NULL. */
+ int (*same) (struct so_list *gdb, struct so_list *inferior);
+
+ /* Return whether a region of memory must be kept in a core file
+ for shared libraries loaded before "gcore" is used to be
+ handled correctly when the core file is loaded. This only
+ applies when the section would otherwise not be kept in the
+ core file (in particular, for readonly sections). */
+ int (*keep_data_in_core) (CORE_ADDR vaddr,
+ unsigned long size);
+
+ /* Enable or disable optional solib event breakpoints as
+ appropriate. This should be called whenever
+ stop_on_solib_events is changed. This pointer can be
+ NULL, in which case no enabling or disabling is necessary
+ for this target. */
+ void (*update_breakpoints) (void);
+
+ /* Target-specific processing of solib events that will be
+ performed before solib_add is called. This pointer can be
+ NULL, in which case no specific preprocessing is necessary
+ for this target. */
+ void (*handle_event) (void);
+};
+
+using so_list_range = next_range<so_list>;
/* Free the memory associated with a (so_list *). */
void free_so (struct so_list *so);
-/* Return address of first so_list entry in master shared object list. */
-struct so_list *master_so_list (void);
+/* A deleter that calls free_so. */
+struct so_deleter
+{
+ void operator() (struct so_list *so) const
+ {
+ free_so (so);
+ }
+};
+
+/* A unique pointer to a so_list. */
+typedef std::unique_ptr<so_list, so_deleter> so_list_up;
+
+/* Find main executable binary file. */
+extern gdb::unique_xmalloc_ptr<char> exec_file_find (const char *in_pathname,
+ int *fd);
+
+/* Find shared library binary file. */
+extern gdb::unique_xmalloc_ptr<char> solib_find (const char *in_pathname,
+ int *fd);
+
+/* Open BFD for shared library file. */
+extern gdb_bfd_ref_ptr solib_bfd_fopen (const char *pathname, int fd);
/* Find solib binary file and open it. */
-extern int solib_open (char *in_pathname, char **found_pathname);
+extern gdb_bfd_ref_ptr solib_bfd_open (const char *in_pathname);
-/* FIXME: gdbarch needs to control this variable */
+/* FIXME: gdbarch needs to control this variable. */
extern struct target_so_ops *current_target_so_ops;
-#define TARGET_SO_RELOCATE_SECTION_ADDRESSES \
- (current_target_so_ops->relocate_section_addresses)
-#define TARGET_SO_FIND_AND_OPEN_SOLIB \
- (current_target_so_ops->find_and_open_solib)
-#define TARGET_SO_IN_DYNSYM_RESOLVE_CODE \
- (current_target_so_ops->in_dynsym_resolve_code)
-
#endif