1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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. */
25 #include <sys/types.h>
27 #include "gdb_string.h"
36 #include "gdb_regex.h"
41 #include "completer.h"
42 #include "filenames.h" /* for DOSish file names */
45 #include <readline/readline.h>
47 /* external data declarations */
49 /* FIXME: gdbarch needs to control this variable */
50 struct target_so_ops
*current_target_so_ops
;
52 /* local data declarations */
54 static struct so_list
*so_list_head
; /* List of known shared objects */
56 static int solib_cleanup_queued
= 0; /* make_run_cleanup called */
58 /* Local function prototypes */
60 static void do_clear_solib (void *);
62 /* If non-zero, this is a prefix that will be added to the front of the name
63 shared libraries with an absolute filename for loading. */
64 static char *solib_absolute_prefix
= NULL
;
66 /* If non-empty, this is a search path for loading non-absolute shared library
67 symbol files. This takes precedence over the environment variables PATH
68 and LD_LIBRARY_PATH. */
69 static char *solib_search_path
= NULL
;
75 solib_open -- Find a shared library file and open it.
79 int solib_open (char *in_patname, char **found_pathname);
83 Global variable SOLIB_ABSOLUTE_PREFIX is used as a prefix directory
84 to search for shared libraries if they have an absolute path.
86 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
87 (or set of directories, as in LD_LIBRARY_PATH) to search for all
88 shared libraries if not found in SOLIB_ABSOLUTE_PREFIX.
91 * If path is absolute, look in SOLIB_ABSOLUTE_PREFIX.
92 * If path is absolute or relative, look for it literally (unmodified).
93 * Look in SOLIB_SEARCH_PATH.
94 * If available, use target defined search function.
95 * Look in inferior's $PATH.
96 * Look in inferior's $LD_LIBRARY_PATH.
100 file handle for opened solib, or -1 for failure. */
103 solib_open (char *in_pathname
, char **found_pathname
)
106 char *temp_pathname
= NULL
;
107 char *p
= in_pathname
;
109 while (*p
&& !IS_DIR_SEPARATOR (*p
))
114 if (! IS_ABSOLUTE_PATH (in_pathname
) || solib_absolute_prefix
== NULL
)
115 temp_pathname
= in_pathname
;
118 int prefix_len
= strlen (solib_absolute_prefix
);
120 /* Remove trailing slashes from absolute prefix. */
121 while (prefix_len
> 0
122 && IS_DIR_SEPARATOR (solib_absolute_prefix
[prefix_len
- 1]))
125 /* Cat the prefixed pathname together. */
126 temp_pathname
= alloca (prefix_len
+ strlen (in_pathname
) + 1);
127 strncpy (temp_pathname
, solib_absolute_prefix
, prefix_len
);
128 temp_pathname
[prefix_len
] = '\0';
129 strcat (temp_pathname
, in_pathname
);
132 /* Now see if we can open it. */
133 found_file
= open (temp_pathname
, O_RDONLY
, 0);
136 /* If the search in solib_absolute_prefix failed, and the path name is
137 absolute at this point, make it relative. (openp will try and open the
138 file according to its absolute path otherwise, which is not what we want.)
139 Affects subsequent searches for this solib. */
140 if (found_file
< 0 && IS_ABSOLUTE_PATH (in_pathname
))
142 /* First, get rid of any drive letters etc. */
143 while (!IS_DIR_SEPARATOR (*in_pathname
))
146 /* Next, get rid of all leading dir separators. */
147 while (IS_DIR_SEPARATOR (*in_pathname
))
151 /* If not found, next search the solib_search_path (if any). */
152 if (found_file
< 0 && solib_search_path
!= NULL
)
153 found_file
= openp (solib_search_path
,
154 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
156 /* If not found, next search the solib_search_path (if any) for the basename
157 only (ignoring the path). This is to allow reading solibs from a path
158 that differs from the opened path. */
159 if (found_file
< 0 && solib_search_path
!= NULL
)
160 found_file
= openp (solib_search_path
,
161 1, lbasename (in_pathname
), O_RDONLY
, 0,
164 /* If not found, try to use target supplied solib search method */
165 if (found_file
< 0 && TARGET_SO_FIND_AND_OPEN_SOLIB
!= NULL
)
166 found_file
= TARGET_SO_FIND_AND_OPEN_SOLIB
167 (in_pathname
, O_RDONLY
, &temp_pathname
);
169 /* If not found, next search the inferior's $PATH environment variable. */
170 if (found_file
< 0 && solib_search_path
!= NULL
)
171 found_file
= openp (get_in_environ (inferior_environ
, "PATH"),
172 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
174 /* If not found, next search the inferior's $LD_LIBRARY_PATH
175 environment variable. */
176 if (found_file
< 0 && solib_search_path
!= NULL
)
177 found_file
= openp (get_in_environ (inferior_environ
, "LD_LIBRARY_PATH"),
178 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
180 /* Done. If not found, tough luck. Return found_file and
181 (optionally) found_pathname. */
182 if (found_pathname
!= NULL
&& temp_pathname
!= NULL
)
183 *found_pathname
= xstrdup (temp_pathname
);
192 solib_map_sections -- open bfd and build sections for shared lib
196 static int solib_map_sections (struct so_list *so)
200 Given a pointer to one of the shared objects in our list
201 of mapped objects, use the recorded name to open a bfd
202 descriptor for the object, build a section table, and then
203 relocate all the section addresses by the base address at
204 which the shared object was mapped.
208 In most (all?) cases the shared object file name recorded in the
209 dynamic linkage tables will be a fully qualified pathname. For
210 cases where it isn't, do we really mimic the systems search
211 mechanism correctly in the below code (particularly the tilde
216 solib_map_sections (void *arg
)
218 struct so_list
*so
= (struct so_list
*) arg
; /* catch_errors bogon */
220 char *scratch_pathname
;
222 struct section_table
*p
;
223 struct cleanup
*old_chain
;
226 filename
= tilde_expand (so
->so_name
);
228 old_chain
= make_cleanup (xfree
, filename
);
229 scratch_chan
= solib_open (filename
, &scratch_pathname
);
231 if (scratch_chan
< 0)
233 perror_with_name (filename
);
236 /* Leave scratch_pathname allocated. abfd->name will point to it. */
237 abfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
240 close (scratch_chan
);
241 error ("Could not open `%s' as an executable file: %s",
242 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
245 /* Leave bfd open, core_xfer_memory and "info files" need it. */
249 /* copy full path name into so_name, so that later symbol_file_add
251 if (strlen (scratch_pathname
) >= SO_NAME_MAX_PATH_SIZE
)
252 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
253 strcpy (so
->so_name
, scratch_pathname
);
255 if (!bfd_check_format (abfd
, bfd_object
))
257 error ("\"%s\": not in executable format: %s.",
258 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
260 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
262 error ("Can't find the file sections in `%s': %s",
263 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
266 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
268 /* Relocate the section binding addresses as recorded in the shared
269 object's file by the base address to which the object was actually
271 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so
, p
);
272 if (STREQ (p
->the_bfd_section
->name
, ".text"))
278 /* Free the file names, close the file now. */
279 do_cleanups (old_chain
);
286 free_so --- free a `struct so_list' object
290 void free_so (struct so_list *so)
294 Free the storage associated with the `struct so_list' object SO.
295 If we have opened a BFD for SO, close it.
297 The caller is responsible for removing SO from whatever list it is
298 a member of. If we have placed SO's sections in some target's
299 section table, the caller is responsible for removing them.
301 This function doesn't mess with objfiles at all. If there is an
302 objfile associated with SO that needs to be removed, the caller is
303 responsible for taking care of that. */
306 free_so (struct so_list
*so
)
308 char *bfd_filename
= 0;
311 xfree (so
->sections
);
315 bfd_filename
= bfd_get_filename (so
->abfd
);
316 if (! bfd_close (so
->abfd
))
317 warning ("cannot close \"%s\": %s",
318 bfd_filename
, bfd_errmsg (bfd_get_error ()));
322 xfree (bfd_filename
);
324 TARGET_SO_FREE_SO (so
);
330 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
333 symbol_add_stub (void *arg
)
335 register struct so_list
*so
= (struct so_list
*) arg
; /* catch_errs bogon */
336 struct section_addr_info
*sap
;
338 /* Have we already loaded this shared object? */
339 ALL_OBJFILES (so
->objfile
)
341 if (strcmp (so
->objfile
->name
, so
->so_name
) == 0)
345 sap
= build_section_addr_info_from_section_table (so
->sections
,
348 so
->objfile
= symbol_file_add (so
->so_name
, so
->from_tty
,
349 sap
, 0, OBJF_SHARED
);
350 free_section_addr_info (sap
);
358 update_solib_list --- synchronize GDB's shared object list with inferior's
362 void update_solib_list (int from_tty, struct target_ops *TARGET)
364 Extract the list of currently loaded shared objects from the
365 inferior, and compare it with the list of shared objects currently
366 in GDB's so_list_head list. Edit so_list_head to bring it in sync
367 with the inferior's new list.
369 If we notice that the inferior has unloaded some shared objects,
370 free any symbolic info GDB had read about those shared objects.
372 Don't load symbolic info for any new shared objects; just add them
373 to the list, and leave their symbols_loaded flag clear.
375 If FROM_TTY is non-null, feel free to print messages about what
378 If TARGET is non-null, add the sections of all new shared objects
379 to TARGET's section table. Note that this doesn't remove any
380 sections for shared objects that have been unloaded, and it
381 doesn't check to see if the new shared objects are already present in
382 the section table. But we only use this for core files and
383 processes we've just attached to, so that's okay. */
386 update_solib_list (int from_tty
, struct target_ops
*target
)
388 struct so_list
*inferior
= TARGET_SO_CURRENT_SOS ();
389 struct so_list
*gdb
, **gdb_link
;
391 /* If we are attaching to a running process for which we
392 have not opened a symbol file, we may be able to get its
395 symfile_objfile
== NULL
)
396 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT
, &from_tty
,
397 "Error reading attached process's symbol file.\n",
400 /* Since this function might actually add some elements to the
401 so_list_head list, arrange for it to be cleaned up when
403 if (!solib_cleanup_queued
)
405 make_run_cleanup (do_clear_solib
, NULL
);
406 solib_cleanup_queued
= 1;
409 /* GDB and the inferior's dynamic linker each maintain their own
410 list of currently loaded shared objects; we want to bring the
411 former in sync with the latter. Scan both lists, seeing which
412 shared objects appear where. There are three cases:
414 - A shared object appears on both lists. This means that GDB
415 knows about it already, and it's still loaded in the inferior.
416 Nothing needs to happen.
418 - A shared object appears only on GDB's list. This means that
419 the inferior has unloaded it. We should remove the shared
420 object from GDB's tables.
422 - A shared object appears only on the inferior's list. This
423 means that it's just been loaded. We should add it to GDB's
426 So we walk GDB's list, checking each entry to see if it appears
427 in the inferior's list too. If it does, no action is needed, and
428 we remove it from the inferior's list. If it doesn't, the
429 inferior has unloaded it, and we remove it from GDB's list. By
430 the time we're done walking GDB's list, the inferior's list
431 contains only the new shared objects, which we then add. */
434 gdb_link
= &so_list_head
;
437 struct so_list
*i
= inferior
;
438 struct so_list
**i_link
= &inferior
;
440 /* Check to see whether the shared object *gdb also appears in
441 the inferior's current list. */
444 if (! strcmp (gdb
->so_original_name
, i
->so_original_name
))
451 /* If the shared object appears on the inferior's list too, then
452 it's still loaded, so we don't need to do anything. Delete
453 it from the inferior's list, and leave it on GDB's list. */
458 gdb_link
= &gdb
->next
;
462 /* If it's not on the inferior's list, remove it from GDB's tables. */
465 *gdb_link
= gdb
->next
;
467 /* Unless the user loaded it explicitly, free SO's objfile. */
468 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
469 free_objfile (gdb
->objfile
);
471 /* Some targets' section tables might be referring to
472 sections from so->abfd; remove them. */
473 remove_target_sections (gdb
->abfd
);
480 /* Now the inferior's list contains only shared objects that don't
481 appear in GDB's list --- those that are newly loaded. Add them
482 to GDB's shared object list. */
487 /* Add the new shared objects to GDB's list. */
488 *gdb_link
= inferior
;
490 /* Fill in the rest of each of the `struct so_list' nodes. */
491 for (i
= inferior
; i
; i
= i
->next
)
493 i
->from_tty
= from_tty
;
495 /* Fill in the rest of the `struct so_list' node. */
496 catch_errors (solib_map_sections
, i
,
497 "Error while mapping shared library sections:\n",
500 /* If requested, add the shared object's sections to the TARGET's
501 section table. Do this immediately after mapping the object so
502 that later nodes in the list can query this object, as is needed
506 int count
= (i
->sections_end
- i
->sections
);
509 int space
= target_resize_to_sections (target
, count
);
510 memcpy (target
->to_sections
+ space
,
512 count
* sizeof (i
->sections
[0]));
522 solib_add -- read in symbol info for newly added shared libraries
526 void solib_add (char *pattern, int from_tty, struct target_ops
527 *TARGET, int readsyms)
531 Read in symbolic information for any shared objects whose names
532 match PATTERN. (If we've already read a shared object's symbol
533 info, leave it alone.) If PATTERN is zero, read them all.
535 If READSYMS is 0, defer reading symbolic information until later
536 but still do any needed low level processing.
538 FROM_TTY and TARGET are as described for update_solib_list, above. */
541 solib_add (char *pattern
, int from_tty
, struct target_ops
*target
, int readsyms
)
547 char *re_err
= re_comp (pattern
);
550 error ("Invalid regexp: %s", re_err
);
553 update_solib_list (from_tty
, target
);
555 /* Walk the list of currently loaded shared libraries, and read
556 symbols for any that match the pattern --- or any whose symbols
557 aren't already loaded, if no pattern was given. */
560 int loaded_any_symbols
= 0;
562 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
563 if (! pattern
|| re_exec (gdb
->so_name
))
567 if (gdb
->symbols_loaded
)
570 printf_unfiltered ("Symbols already loaded for %s\n",
576 (symbol_add_stub
, gdb
,
577 "Error while reading shared library symbols:\n",
581 printf_unfiltered ("Loaded symbols for %s\n",
583 gdb
->symbols_loaded
= 1;
584 loaded_any_symbols
= 1;
589 if (from_tty
&& pattern
&& ! any_matches
)
591 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
593 if (loaded_any_symbols
)
595 /* Getting new symbols may change our opinion about what is
597 reinit_frame_cache ();
599 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
609 info_sharedlibrary_command -- code for "info sharedlibrary"
613 static void info_sharedlibrary_command ()
617 Walk through the shared library list and print information
618 about each attached library.
622 info_sharedlibrary_command (char *ignore
, int from_tty
)
624 register struct so_list
*so
= NULL
; /* link map state variable */
629 if (TARGET_PTR_BIT
== 32)
634 else if (TARGET_PTR_BIT
== 64)
641 internal_error (__FILE__
, __LINE__
,
642 "TARGET_PTR_BIT returned unknown size %d",
646 update_solib_list (from_tty
, 0);
648 for (so
= so_list_head
; so
; so
= so
->next
)
654 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width
, "From",
655 addr_width
, "To", "Syms Read",
656 "Shared Object Library");
660 printf_unfiltered ("%-*s", addr_width
,
661 so
->textsection
!= NULL
662 ? local_hex_string_custom (
663 (LONGEST
) so
->textsection
->addr
,
666 printf_unfiltered ("%-*s", addr_width
,
667 so
->textsection
!= NULL
668 ? local_hex_string_custom (
669 (LONGEST
) so
->textsection
->endaddr
,
672 printf_unfiltered ("%-12s", so
->symbols_loaded
? "Yes" : "No");
673 printf_unfiltered ("%s\n", so
->so_name
);
676 if (so_list_head
== NULL
)
678 printf_unfiltered ("No shared libraries loaded at this time.\n");
686 solib_address -- check to see if an address is in a shared lib
690 char * solib_address (CORE_ADDR address)
694 Provides a hook for other gdb routines to discover whether or
695 not a particular address is within the mapped address space of
698 For example, this routine is called at one point to disable
699 breakpoints which are in shared libraries that are not currently
704 solib_address (CORE_ADDR address
)
706 register struct so_list
*so
= 0; /* link map state variable */
708 for (so
= so_list_head
; so
; so
= so
->next
)
710 struct section_table
*p
;
712 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
714 if (p
->addr
<= address
&& address
< p
->endaddr
)
715 return (so
->so_name
);
722 /* Called by free_all_symtabs */
727 /* This function is expected to handle ELF shared libraries. It is
728 also used on Solaris, which can run either ELF or a.out binaries
729 (for compatibility with SunOS 4), both of which can use shared
730 libraries. So we don't know whether we have an ELF executable or
731 an a.out executable until the user chooses an executable file.
733 ELF shared libraries don't get mapped into the address space
734 until after the program starts, so we'd better not try to insert
735 breakpoints in them immediately. We have to wait until the
736 dynamic linker has loaded them; we'll hit a bp_shlib_event
737 breakpoint (look for calls to create_solib_event_breakpoint) when
740 SunOS shared libraries seem to be different --- they're present
741 as soon as the process begins execution, so there's no need to
742 put off inserting breakpoints. There's also nowhere to put a
743 bp_shlib_event breakpoint, so if we put it off, we'll never get
746 So: disable breakpoints only if we're using ELF shared libs. */
748 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
749 disable_breakpoints_in_shlibs (1);
753 struct so_list
*so
= so_list_head
;
754 so_list_head
= so
->next
;
756 remove_target_sections (so
->abfd
);
760 TARGET_SO_CLEAR_SOLIB ();
764 do_clear_solib (void *dummy
)
766 solib_cleanup_queued
= 0;
772 solib_create_inferior_hook -- shared library startup support
776 void solib_create_inferior_hook()
780 When gdb starts up the inferior, it nurses it along (through the
781 shell) until it is ready to execute it's first instruction. At this
782 point, this function gets called via expansion of the macro
783 SOLIB_CREATE_INFERIOR_HOOK. */
786 solib_create_inferior_hook (void)
788 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
793 in_solib_dynsym_resolve_code -- check to see if an address is in
794 dynamic loader's dynamic symbol
799 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
803 Determine if PC is in the dynamic linker's symbol resolution
804 code. Return 1 if so, 0 otherwise.
808 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
810 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc
);
817 sharedlibrary_command -- handle command to explicitly add library
821 static void sharedlibrary_command (char *args, int from_tty)
828 sharedlibrary_command (char *args
, int from_tty
)
831 solib_add (args
, from_tty
, (struct target_ops
*) 0, 1);
836 no_shared_libraries -- handle command to explicitly discard symbols
837 from shared libraries.
841 Implements the command "nosharedlibrary", which discards symbols
842 that have been auto-loaded from shared libraries. Symbols from
843 shared libraries that were added by explicit request of the user
844 are not discarded. Also called from remote.c. */
847 no_shared_libraries (char *ignored
, int from_tty
)
849 objfile_purge_solibs ();
850 do_clear_solib (NULL
);
854 reload_shared_libraries (char *ignored
, int from_tty
)
856 no_shared_libraries (NULL
, from_tty
);
857 solib_add (NULL
, from_tty
, NULL
, auto_solib_add
);
860 extern initialize_file_ftype _initialize_solib
; /* -Wmissing-prototypes */
863 _initialize_solib (void)
865 struct cmd_list_element
*c
;
867 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
868 "Load shared object library symbols for files matching REGEXP.");
869 add_info ("sharedlibrary", info_sharedlibrary_command
,
870 "Status of loaded shared object libraries.");
871 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
872 "Unload all shared object library symbols.");
875 (add_set_cmd ("auto-solib-add", class_support
, var_boolean
,
876 (char *) &auto_solib_add
,
877 "Set autoloading of shared library symbols.\n\
878 If \"on\", symbols from all shared object libraries will be loaded\n\
879 automatically when the inferior begins execution, when the dynamic linker\n\
880 informs gdb that a new library has been loaded, or when attaching to the\n\
881 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'.",
885 c
= add_set_cmd ("solib-absolute-prefix", class_support
, var_filename
,
886 (char *) &solib_absolute_prefix
,
887 "Set prefix for loading absolute shared library symbol files.\n\
888 For other (relative) files, you can add values using `set solib-search-path'.",
890 add_show_from_set (c
, &showlist
);
891 set_cmd_cfunc (c
, reload_shared_libraries
);
892 set_cmd_completer (c
, filename_completer
);
894 /* Set the default value of "solib-absolute-prefix" from the sysroot, if
896 solib_absolute_prefix
= xstrdup (gdb_sysroot
);
898 c
= add_set_cmd ("solib-search-path", class_support
, var_string
,
899 (char *) &solib_search_path
,
900 "Set the search path for loading non-absolute shared library symbol files.\n\
901 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
903 add_show_from_set (c
, &showlist
);
904 set_cmd_cfunc (c
, reload_shared_libraries
);
905 set_cmd_completer (c
, filename_completer
);