1 /* Handle shared libraries for GDB, the GNU Debugger.
2 Copyright 1990, 91, 92, 93, 94, 95, 96, 98, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GDB.
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 2 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
24 #include <sys/types.h>
26 #include "gdb_string.h"
35 #include "gdb_regex.h"
43 /* external data declarations */
45 /* FIXME: gdbarch needs to control this variable */
46 struct target_so_ops
*current_target_so_ops
;
48 /* local data declarations */
50 static struct so_list
*so_list_head
; /* List of known shared objects */
52 static int solib_cleanup_queued
= 0; /* make_run_cleanup called */
54 /* Local function prototypes */
56 static void do_clear_solib (PTR
);
58 /* If non-zero, this is a prefix that will be added to the front of the name
59 shared libraries with an absolute filename for loading. */
60 static char *solib_absolute_prefix
= NULL
;
62 /* If non-empty, this is a search path for loading non-absolute shared library
63 symbol files. This takes precedence over the environment variables PATH
64 and LD_LIBRARY_PATH. */
65 static char *solib_search_path
= NULL
;
71 solib_open -- Find a shared library file and open it.
75 int solib_open (char *in_patname, char **found_pathname);
79 Global variable SOLIB_ABSOLUTE_PREFIX is used as a prefix directory
80 to search for shared libraries if they have an absolute path.
82 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
83 (or set of directories, as in LD_LIBRARY_PATH) to search for all
84 shared libraries if not found in SOLIB_ABSOLUTE_PREFIX.
87 * If path is absolute, look in SOLIB_ABSOLUTE_PREFIX.
88 * If path is absolute, look for it literally (unmodified).
89 * Look in SOLIB_SEARCH_PATH.
90 * Look in inferior's $PATH.
91 * Look in inferior's $LD_LIBRARY_PATH.
95 file handle for opened solib, or -1 for failure. */
98 solib_open (char *in_pathname
, char **found_pathname
)
101 char *temp_pathname
= NULL
;
103 if (solib_absolute_prefix
!= NULL
&&
104 ROOTED_P (in_pathname
))
106 int prefix_len
= strlen (solib_absolute_prefix
);
108 /* Remove trailing slashes from absolute prefix. */
109 while (prefix_len
> 0 && SLASH_P (solib_absolute_prefix
[prefix_len
- 1]))
112 /* Cat the prefixed pathname together. */
113 temp_pathname
= alloca (prefix_len
+ strlen (in_pathname
) + 1);
114 strncpy (temp_pathname
, solib_absolute_prefix
, prefix_len
);
115 temp_pathname
[prefix_len
] = '\0';
116 strcat (temp_pathname
, in_pathname
);
118 /* Now see if we can open it. */
119 found_file
= open (temp_pathname
, O_RDONLY
, 0);
122 /* If not found, next search the solib_search_path (if any). */
123 if (found_file
< 0 && solib_search_path
!= NULL
)
124 found_file
= openp (solib_search_path
,
125 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
127 /* If not found, next search the inferior's $PATH environment variable. */
128 if (found_file
< 0 && solib_search_path
!= NULL
)
129 found_file
= openp (get_in_environ (inferior_environ
, "PATH"),
130 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
132 /* If not found, next search the inferior's $LD_LIBRARY_PATH
133 environment variable. */
134 if (found_file
< 0 && solib_search_path
!= NULL
)
135 found_file
= openp (get_in_environ (inferior_environ
, "LD_LIBRARY_PATH"),
136 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
138 /* Done. If not found, tough luck. Return found_file and
139 (optionally) found_pathname. */
140 if (found_pathname
!= NULL
)
141 *found_pathname
= strsave (temp_pathname
);
150 solib_map_sections -- open bfd and build sections for shared lib
154 static int solib_map_sections (struct so_list *so)
158 Given a pointer to one of the shared objects in our list
159 of mapped objects, use the recorded name to open a bfd
160 descriptor for the object, build a section table, and then
161 relocate all the section addresses by the base address at
162 which the shared object was mapped.
166 In most (all?) cases the shared object file name recorded in the
167 dynamic linkage tables will be a fully qualified pathname. For
168 cases where it isn't, do we really mimic the systems search
169 mechanism correctly in the below code (particularly the tilde
174 solib_map_sections (PTR arg
)
176 struct so_list
*so
= (struct so_list
*) arg
; /* catch_errors bogon */
178 char *scratch_pathname
;
180 struct section_table
*p
;
181 struct cleanup
*old_chain
;
184 filename
= tilde_expand (so
->so_name
);
186 old_chain
= make_cleanup (free
, filename
);
187 scratch_chan
= solib_open (filename
, &scratch_pathname
);
189 if (scratch_chan
< 0)
191 perror_with_name (filename
);
194 /* Leave scratch_pathname allocated. abfd->name will point to it. */
195 abfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
198 close (scratch_chan
);
199 error ("Could not open `%s' as an executable file: %s",
200 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
203 /* Leave bfd open, core_xfer_memory and "info files" need it. */
205 abfd
->cacheable
= true;
207 /* copy full path name into so_name, so that later symbol_file_add
209 if (strlen (scratch_pathname
) >= SO_NAME_MAX_PATH_SIZE
)
210 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
211 strcpy (so
->so_name
, scratch_pathname
);
213 if (!bfd_check_format (abfd
, bfd_object
))
215 error ("\"%s\": not in executable format: %s.",
216 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
218 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
220 error ("Can't find the file sections in `%s': %s",
221 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
224 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
226 /* Relocate the section binding addresses as recorded in the shared
227 object's file by the base address to which the object was actually
229 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so
, p
);
230 if (STREQ (p
->the_bfd_section
->name
, ".text"))
236 /* Free the file names, close the file now. */
237 do_cleanups (old_chain
);
244 free_so --- free a `struct so_list' object
248 void free_so (struct so_list *so)
252 Free the storage associated with the `struct so_list' object SO.
253 If we have opened a BFD for SO, close it.
255 The caller is responsible for removing SO from whatever list it is
256 a member of. If we have placed SO's sections in some target's
257 section table, the caller is responsible for removing them.
259 This function doesn't mess with objfiles at all. If there is an
260 objfile associated with SO that needs to be removed, the caller is
261 responsible for taking care of that. */
264 free_so (struct so_list
*so
)
266 char *bfd_filename
= 0;
273 bfd_filename
= bfd_get_filename (so
->abfd
);
274 if (! bfd_close (so
->abfd
))
275 warning ("cannot close \"%s\": %s",
276 bfd_filename
, bfd_errmsg (bfd_get_error ()));
282 TARGET_SO_FREE_SO (so
);
288 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
291 symbol_add_stub (PTR arg
)
293 register struct so_list
*so
= (struct so_list
*) arg
; /* catch_errs bogon */
294 struct section_addr_info
*sap
;
296 /* Have we already loaded this shared object? */
297 ALL_OBJFILES (so
->objfile
)
299 if (strcmp (so
->objfile
->name
, so
->so_name
) == 0)
303 sap
= build_section_addr_info_from_section_table (so
->sections
,
306 so
->objfile
= symbol_file_add (so
->so_name
, so
->from_tty
,
307 sap
, 0, OBJF_SHARED
);
308 free_section_addr_info (sap
);
316 update_solib_list --- synchronize GDB's shared object list with inferior's
320 void update_solib_list (int from_tty, struct target_ops *TARGET)
322 Extract the list of currently loaded shared objects from the
323 inferior, and compare it with the list of shared objects currently
324 in GDB's so_list_head list. Edit so_list_head to bring it in sync
325 with the inferior's new list.
327 If we notice that the inferior has unloaded some shared objects,
328 free any symbolic info GDB had read about those shared objects.
330 Don't load symbolic info for any new shared objects; just add them
331 to the list, and leave their symbols_loaded flag clear.
333 If FROM_TTY is non-null, feel free to print messages about what
336 If TARGET is non-null, add the sections of all new shared objects
337 to TARGET's section table. Note that this doesn't remove any
338 sections for shared objects that have been unloaded, and it
339 doesn't check to see if the new shared objects are already present in
340 the section table. But we only use this for core files and
341 processes we've just attached to, so that's okay. */
344 update_solib_list (int from_tty
, struct target_ops
*target
)
346 struct so_list
*inferior
= TARGET_SO_CURRENT_SOS ();
347 struct so_list
*gdb
, **gdb_link
;
349 /* If we are attaching to a running process for which we
350 have not opened a symbol file, we may be able to get its
353 symfile_objfile
== NULL
)
354 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT
, (PTR
) &from_tty
,
355 "Error reading attached process's symbol file.\n",
358 /* Since this function might actually add some elements to the
359 so_list_head list, arrange for it to be cleaned up when
361 if (!solib_cleanup_queued
)
363 make_run_cleanup (do_clear_solib
, NULL
);
364 solib_cleanup_queued
= 1;
367 /* GDB and the inferior's dynamic linker each maintain their own
368 list of currently loaded shared objects; we want to bring the
369 former in sync with the latter. Scan both lists, seeing which
370 shared objects appear where. There are three cases:
372 - A shared object appears on both lists. This means that GDB
373 knows about it already, and it's still loaded in the inferior.
374 Nothing needs to happen.
376 - A shared object appears only on GDB's list. This means that
377 the inferior has unloaded it. We should remove the shared
378 object from GDB's tables.
380 - A shared object appears only on the inferior's list. This
381 means that it's just been loaded. We should add it to GDB's
384 So we walk GDB's list, checking each entry to see if it appears
385 in the inferior's list too. If it does, no action is needed, and
386 we remove it from the inferior's list. If it doesn't, the
387 inferior has unloaded it, and we remove it from GDB's list. By
388 the time we're done walking GDB's list, the inferior's list
389 contains only the new shared objects, which we then add. */
392 gdb_link
= &so_list_head
;
395 struct so_list
*i
= inferior
;
396 struct so_list
**i_link
= &inferior
;
398 /* Check to see whether the shared object *gdb also appears in
399 the inferior's current list. */
402 if (! strcmp (gdb
->so_original_name
, i
->so_original_name
))
409 /* If the shared object appears on the inferior's list too, then
410 it's still loaded, so we don't need to do anything. Delete
411 it from the inferior's list, and leave it on GDB's list. */
416 gdb_link
= &gdb
->next
;
420 /* If it's not on the inferior's list, remove it from GDB's tables. */
423 *gdb_link
= gdb
->next
;
425 /* Unless the user loaded it explicitly, free SO's objfile. */
426 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
427 free_objfile (gdb
->objfile
);
429 /* Some targets' section tables might be referring to
430 sections from so->abfd; remove them. */
431 remove_target_sections (gdb
->abfd
);
438 /* Now the inferior's list contains only shared objects that don't
439 appear in GDB's list --- those that are newly loaded. Add them
440 to GDB's shared object list. */
445 /* Add the new shared objects to GDB's list. */
446 *gdb_link
= inferior
;
448 /* Fill in the rest of each of the `struct so_list' nodes. */
449 for (i
= inferior
; i
; i
= i
->next
)
451 i
->from_tty
= from_tty
;
453 /* Fill in the rest of the `struct so_list' node. */
454 catch_errors (solib_map_sections
, i
,
455 "Error while mapping shared library sections:\n",
459 /* If requested, add the shared objects' sections to the the
460 TARGET's section table. */
465 /* Figure out how many sections we'll need to add in total. */
467 for (i
= inferior
; i
; i
= i
->next
)
468 new_sections
+= (i
->sections_end
- i
->sections
);
470 if (new_sections
> 0)
472 int space
= target_resize_to_sections (target
, new_sections
);
474 for (i
= inferior
; i
; i
= i
->next
)
476 int count
= (i
->sections_end
- i
->sections
);
477 memcpy (target
->to_sections
+ space
,
479 count
* sizeof (i
->sections
[0]));
490 solib_add -- read in symbol info for newly added shared libraries
494 void solib_add (char *pattern, int from_tty, struct target_ops *TARGET)
498 Read in symbolic information for any shared objects whose names
499 match PATTERN. (If we've already read a shared object's symbol
500 info, leave it alone.) If PATTERN is zero, read them all.
502 FROM_TTY and TARGET are as described for update_solib_list, above. */
505 solib_add (char *pattern
, int from_tty
, struct target_ops
*target
)
511 char *re_err
= re_comp (pattern
);
514 error ("Invalid regexp: %s", re_err
);
517 update_solib_list (from_tty
, target
);
519 /* Walk the list of currently loaded shared libraries, and read
520 symbols for any that match the pattern --- or any whose symbols
521 aren't already loaded, if no pattern was given. */
524 int loaded_any_symbols
= 0;
526 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
527 if (! pattern
|| re_exec (gdb
->so_name
))
531 if (gdb
->symbols_loaded
)
534 printf_unfiltered ("Symbols already loaded for %s\n",
540 (symbol_add_stub
, gdb
,
541 "Error while reading shared library symbols:\n",
545 printf_unfiltered ("Loaded symbols for %s\n",
547 gdb
->symbols_loaded
= 1;
548 loaded_any_symbols
= 1;
553 if (from_tty
&& pattern
&& ! any_matches
)
555 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
557 if (loaded_any_symbols
)
559 /* Getting new symbols may change our opinion about what is
561 reinit_frame_cache ();
563 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
573 info_sharedlibrary_command -- code for "info sharedlibrary"
577 static void info_sharedlibrary_command ()
581 Walk through the shared library list and print information
582 about each attached library.
586 info_sharedlibrary_command (char *ignore
, int from_tty
)
588 register struct so_list
*so
= NULL
; /* link map state variable */
594 if (exec_bfd
== NULL
)
596 printf_unfiltered ("No executable file.\n");
600 arch_size
= bfd_get_arch_size (exec_bfd
);
601 /* Default to 32-bit in case of failure (non-elf). */
602 if (arch_size
== 32 || arch_size
== -1)
607 else if (arch_size
== 64)
613 update_solib_list (from_tty
, 0);
615 for (so
= so_list_head
; so
; so
= so
->next
)
621 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width
, "From",
622 addr_width
, "To", "Syms Read",
623 "Shared Object Library");
627 printf_unfiltered ("%-*s", addr_width
,
628 so
->textsection
!= NULL
629 ? local_hex_string_custom (
630 (unsigned long) so
->textsection
->addr
,
633 printf_unfiltered ("%-*s", addr_width
,
634 so
->textsection
!= NULL
635 ? local_hex_string_custom (
636 (unsigned long) so
->textsection
->endaddr
,
639 printf_unfiltered ("%-12s", so
->symbols_loaded
? "Yes" : "No");
640 printf_unfiltered ("%s\n", so
->so_name
);
643 if (so_list_head
== NULL
)
645 printf_unfiltered ("No shared libraries loaded at this time.\n");
653 solib_address -- check to see if an address is in a shared lib
657 char * solib_address (CORE_ADDR address)
661 Provides a hook for other gdb routines to discover whether or
662 not a particular address is within the mapped address space of
665 For example, this routine is called at one point to disable
666 breakpoints which are in shared libraries that are not currently
671 solib_address (CORE_ADDR address
)
673 register struct so_list
*so
= 0; /* link map state variable */
675 for (so
= so_list_head
; so
; so
= so
->next
)
677 struct section_table
*p
;
679 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
681 if (p
->addr
<= address
&& address
< p
->endaddr
)
682 return (so
->so_name
);
689 /* Called by free_all_symtabs */
694 /* This function is expected to handle ELF shared libraries. It is
695 also used on Solaris, which can run either ELF or a.out binaries
696 (for compatibility with SunOS 4), both of which can use shared
697 libraries. So we don't know whether we have an ELF executable or
698 an a.out executable until the user chooses an executable file.
700 ELF shared libraries don't get mapped into the address space
701 until after the program starts, so we'd better not try to insert
702 breakpoints in them immediately. We have to wait until the
703 dynamic linker has loaded them; we'll hit a bp_shlib_event
704 breakpoint (look for calls to create_solib_event_breakpoint) when
707 SunOS shared libraries seem to be different --- they're present
708 as soon as the process begins execution, so there's no need to
709 put off inserting breakpoints. There's also nowhere to put a
710 bp_shlib_event breakpoint, so if we put it off, we'll never get
713 So: disable breakpoints only if we're using ELF shared libs. */
715 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
716 disable_breakpoints_in_shlibs (1);
720 struct so_list
*so
= so_list_head
;
721 so_list_head
= so
->next
;
725 TARGET_SO_CLEAR_SOLIB ();
729 do_clear_solib (PTR dummy
)
731 solib_cleanup_queued
= 0;
737 solib_create_inferior_hook -- shared library startup support
741 void solib_create_inferior_hook()
745 When gdb starts up the inferior, it nurses it along (through the
746 shell) until it is ready to execute it's first instruction. At this
747 point, this function gets called via expansion of the macro
748 SOLIB_CREATE_INFERIOR_HOOK. */
751 solib_create_inferior_hook (void)
753 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
761 sharedlibrary_command -- handle command to explicitly add library
765 static void sharedlibrary_command (char *args, int from_tty)
772 sharedlibrary_command (char *args
, int from_tty
)
775 solib_add (args
, from_tty
, (struct target_ops
*) 0);
780 _initialize_solib (void)
782 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
783 "Load shared object library symbols for files matching REGEXP.");
784 add_info ("sharedlibrary", info_sharedlibrary_command
,
785 "Status of loaded shared object libraries.");
788 (add_set_cmd ("auto-solib-add", class_support
, var_zinteger
,
789 (char *) &auto_solib_add
,
790 "Set autoloading of shared library symbols.\n\
791 If nonzero, symbols from all shared object libraries will be loaded\n\
792 automatically when the inferior begins execution or when the dynamic linker\n\
793 informs gdb that a new library has been loaded. Otherwise, symbols\n\
794 must be loaded manually, using `sharedlibrary'.",
799 (add_set_cmd ("solib-absolute-prefix", class_support
, var_filename
,
800 (char *) &solib_absolute_prefix
,
801 "Set prefix for loading absolute shared library symbol files.\n\
802 For other (relative) files, you can add values using `set solib-search-path'.",
806 (add_set_cmd ("solib-search-path", class_support
, var_string
,
807 (char *) &solib_search_path
,
808 "Set the search path for loading non-absolute shared library symbol files.\n\
809 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",