gdb/solist.h

   1 /* Shared library declarations for GDB, the GNU Debugger.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
   3    2001
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef SOLIST_H
  24 #define SOLIST_H
  25
  26 #define SO_NAME_MAX_PATH_SIZE 512       /* FIXME: Should be dynamic */
  27
  28 /* Forward declaration for target specific link map information.  This
  29    struct is opaque to all but the target specific file.  */
  30 struct lm_info;
  31
  32 struct so_list
  33   {
  34     /* The following fields of the structure come directly from the
  35        dynamic linker's tables in the inferior, and are initialized by
  36        current_sos.  */
  37
  38     struct so_list *next;       /* next structure in linked list */
  39
  40     /* A pointer to target specific link map information.  Often this
  41        will be a copy of struct link_map from the user process, but
  42        it need not be; it can be any collection of data needed to
  43        traverse the dynamic linker's data structures. */
  44     struct lm_info *lm_info;
  45
  46     /* Shared object file name, exactly as it appears in the
  47        inferior's link map.  This may be a relative path, or something
  48        which needs to be looked up in LD_LIBRARY_PATH, etc.  We use it
  49        to tell which entries in the inferior's dynamic linker's link
  50        map we've already loaded.  */
  51     char so_original_name[SO_NAME_MAX_PATH_SIZE];
  52
  53     /* shared object file name, expanded to something GDB can open */
  54     char so_name[SO_NAME_MAX_PATH_SIZE];
  55
  56     /* The following fields of the structure are built from
  57        information gathered from the shared object file itself, and
  58        are set when we actually add it to our symbol tables.
  59
  60        current_sos must initialize these fields to 0.  */
  61
  62     bfd *abfd;
  63     char symbols_loaded;        /* flag: symbols read in yet? */
  64     char from_tty;              /* flag: print msgs? */
  65     struct objfile *objfile;    /* objfile for loaded lib */
  66     struct section_table *sections;
  67     struct section_table *sections_end;
  68     struct section_table *textsection;
  69   };
  70
  71 struct target_so_ops
  72   {
  73     /* Adjust the section binding addresses by the base address at
  74        which the object was actually mapped.  */
  75     void (*relocate_section_addresses) (struct so_list *so,
  76                                         struct section_table *);
  77
  78     /* Free the the link map info and any other private data
  79        structures associated with a so_list entry.  */
  80     void (*free_so) (struct so_list *so);
  81
  82     /* Reset or free private data structures not associated with
  83        so_list entries.  */
  84     void (*clear_solib) (void);
  85
  86     /* Target dependent code to run after child process fork.  */
  87     void (*solib_create_inferior_hook) (void);
  88
  89     /* Do additional symbol handling, lookup, etc. after symbols
  90        for a shared object have been loaded.  */
  91     void (*special_symbol_handling) (void);
  92
  93     /* Construct a list of the currently loaded shared objects.  */
  94     struct so_list *(*current_sos) (void);
  95
  96     /* Find, open, and read the symbols for the main executable.  */
  97     int (*open_symbol_file_object) (void *from_ttyp);
  98
  99     /* Determine if PC lies in the dynamic symbol resolution code of
 100        the run time loader */
 101     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
 102
 103     /* Extra hook for finding and opening a solib.
 104        Convenience function for remote debuggers finding host libs.  */
 105     int (*find_and_open_solib) (char *soname,
 106         unsigned o_flags, char **temp_pathname);
 107
 108   };
 109
 110 /* Free the memory associated with a (so_list *).  */
 111 void free_so (struct so_list *so);
 112
 113 /* Return address of first so_list entry in master shared object list.  */
 114 struct so_list *master_so_list (void);
 115
 116 /* Find solib binary file and open it.  */
 117 extern int solib_open (char *in_pathname, char **found_pathname);
 118
 119 /* FIXME: gdbarch needs to control this variable */
 120 extern struct target_so_ops *current_target_so_ops;
 121
 122 #define TARGET_SO_RELOCATE_SECTION_ADDRESSES \
 123   (current_target_so_ops->relocate_section_addresses)
 124 #define TARGET_SO_FREE_SO (current_target_so_ops->free_so)
 125 #define TARGET_SO_CLEAR_SOLIB (current_target_so_ops->clear_solib)
 126 #define TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK \
 127   (current_target_so_ops->solib_create_inferior_hook)
 128 #define TARGET_SO_SPECIAL_SYMBOL_HANDLING \
 129   (current_target_so_ops->special_symbol_handling)
 130 #define TARGET_SO_CURRENT_SOS (current_target_so_ops->current_sos)
 131 #define TARGET_SO_OPEN_SYMBOL_FILE_OBJECT \
 132   (current_target_so_ops->open_symbol_file_object)
 133 #define TARGET_SO_IN_DYNSYM_RESOLVE_CODE \
 134   (current_target_so_ops->in_dynsym_resolve_code)
 135 #define TARGET_SO_FIND_AND_OPEN_SOLIB \
 136   (current_target_so_ops->find_and_open_solib)
 137
 138 #endif