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