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 there is a solib_absolute_prefix and path is absolute:
92 * Search for solib_absolute_prefix/path.
94 * Look for it literally (unmodified).
95 * Look in SOLIB_SEARCH_PATH.
96 * If available, use target defined search function.
97 * If solib_absolute_prefix is NOT set, perform the following two searches:
98 * Look in inferior's $PATH.
99 * Look in inferior's $LD_LIBRARY_PATH.
101 * The last check avoids doing this search when targetting remote
102 * machines since solib_absolute_prefix will almost always be set.
106 file handle for opened solib, or -1 for failure. */
109 solib_open (char *in_pathname
, char **found_pathname
)
112 char *temp_pathname
= NULL
;
113 char *p
= in_pathname
;
115 while (*p
&& !IS_DIR_SEPARATOR (*p
))
120 if (! IS_ABSOLUTE_PATH (in_pathname
) || solib_absolute_prefix
== NULL
)
121 temp_pathname
= in_pathname
;
124 int prefix_len
= strlen (solib_absolute_prefix
);
126 /* Remove trailing slashes from absolute prefix. */
127 while (prefix_len
> 0
128 && IS_DIR_SEPARATOR (solib_absolute_prefix
[prefix_len
- 1]))
131 /* Cat the prefixed pathname together. */
132 temp_pathname
= alloca (prefix_len
+ strlen (in_pathname
) + 1);
133 strncpy (temp_pathname
, solib_absolute_prefix
, prefix_len
);
134 temp_pathname
[prefix_len
] = '\0';
135 strcat (temp_pathname
, in_pathname
);
138 /* Now see if we can open it. */
139 found_file
= open (temp_pathname
, O_RDONLY
, 0);
142 /* If the search in solib_absolute_prefix failed, and the path name is
143 absolute at this point, make it relative. (openp will try and open the
144 file according to its absolute path otherwise, which is not what we want.)
145 Affects subsequent searches for this solib. */
146 if (found_file
< 0 && IS_ABSOLUTE_PATH (in_pathname
))
148 /* First, get rid of any drive letters etc. */
149 while (!IS_DIR_SEPARATOR (*in_pathname
))
152 /* Next, get rid of all leading dir separators. */
153 while (IS_DIR_SEPARATOR (*in_pathname
))
157 /* If not found, search the solib_search_path (if any). */
158 if (found_file
< 0 && solib_search_path
!= NULL
)
159 found_file
= openp (solib_search_path
,
160 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
162 /* If not found, next search the solib_search_path (if any) for the basename
163 only (ignoring the path). This is to allow reading solibs from a path
164 that differs from the opened path. */
165 if (found_file
< 0 && solib_search_path
!= NULL
)
166 found_file
= openp (solib_search_path
,
167 1, lbasename (in_pathname
), O_RDONLY
, 0,
170 /* If not found, try to use target supplied solib search method */
171 if (found_file
< 0 && TARGET_SO_FIND_AND_OPEN_SOLIB
!= NULL
)
172 found_file
= TARGET_SO_FIND_AND_OPEN_SOLIB
173 (in_pathname
, O_RDONLY
, &temp_pathname
);
175 /* If not found, next search the inferior's $PATH environment variable. */
176 if (found_file
< 0 && solib_absolute_prefix
== NULL
)
177 found_file
= openp (get_in_environ (inferior_environ
, "PATH"),
178 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
180 /* If not found, next search the inferior's $LD_LIBRARY_PATH
181 environment variable. */
182 if (found_file
< 0 && solib_absolute_prefix
== NULL
)
183 found_file
= openp (get_in_environ (inferior_environ
, "LD_LIBRARY_PATH"),
184 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
186 /* Done. If not found, tough luck. Return found_file and
187 (optionally) found_pathname. */
188 if (found_pathname
!= NULL
&& temp_pathname
!= NULL
)
189 *found_pathname
= xstrdup (temp_pathname
);
198 solib_map_sections -- open bfd and build sections for shared lib
202 static int solib_map_sections (struct so_list *so)
206 Given a pointer to one of the shared objects in our list
207 of mapped objects, use the recorded name to open a bfd
208 descriptor for the object, build a section table, and then
209 relocate all the section addresses by the base address at
210 which the shared object was mapped.
214 In most (all?) cases the shared object file name recorded in the
215 dynamic linkage tables will be a fully qualified pathname. For
216 cases where it isn't, do we really mimic the systems search
217 mechanism correctly in the below code (particularly the tilde
222 solib_map_sections (void *arg
)
224 struct so_list
*so
= (struct so_list
*) arg
; /* catch_errors bogon */
226 char *scratch_pathname
;
228 struct section_table
*p
;
229 struct cleanup
*old_chain
;
232 filename
= tilde_expand (so
->so_name
);
234 old_chain
= make_cleanup (xfree
, filename
);
235 scratch_chan
= solib_open (filename
, &scratch_pathname
);
237 if (scratch_chan
< 0)
239 perror_with_name (filename
);
242 /* Leave scratch_pathname allocated. abfd->name will point to it. */
243 abfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
246 close (scratch_chan
);
247 error ("Could not open `%s' as an executable file: %s",
248 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
251 /* Leave bfd open, core_xfer_memory and "info files" need it. */
255 /* copy full path name into so_name, so that later symbol_file_add
257 if (strlen (scratch_pathname
) >= SO_NAME_MAX_PATH_SIZE
)
258 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
259 strcpy (so
->so_name
, scratch_pathname
);
261 if (!bfd_check_format (abfd
, bfd_object
))
263 error ("\"%s\": not in executable format: %s.",
264 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
266 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
268 error ("Can't find the file sections in `%s': %s",
269 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
272 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
274 /* Relocate the section binding addresses as recorded in the shared
275 object's file by the base address to which the object was actually
277 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so
, p
);
278 if (STREQ (p
->the_bfd_section
->name
, ".text"))
284 /* Free the file names, close the file now. */
285 do_cleanups (old_chain
);
292 free_so --- free a `struct so_list' object
296 void free_so (struct so_list *so)
300 Free the storage associated with the `struct so_list' object SO.
301 If we have opened a BFD for SO, close it.
303 The caller is responsible for removing SO from whatever list it is
304 a member of. If we have placed SO's sections in some target's
305 section table, the caller is responsible for removing them.
307 This function doesn't mess with objfiles at all. If there is an
308 objfile associated with SO that needs to be removed, the caller is
309 responsible for taking care of that. */
312 free_so (struct so_list
*so
)
314 char *bfd_filename
= 0;
317 xfree (so
->sections
);
321 bfd_filename
= bfd_get_filename (so
->abfd
);
322 if (! bfd_close (so
->abfd
))
323 warning ("cannot close \"%s\": %s",
324 bfd_filename
, bfd_errmsg (bfd_get_error ()));
328 xfree (bfd_filename
);
330 TARGET_SO_FREE_SO (so
);
336 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
339 symbol_add_stub (void *arg
)
341 register struct so_list
*so
= (struct so_list
*) arg
; /* catch_errs bogon */
342 struct section_addr_info
*sap
;
344 /* Have we already loaded this shared object? */
345 ALL_OBJFILES (so
->objfile
)
347 if (strcmp (so
->objfile
->name
, so
->so_name
) == 0)
351 sap
= build_section_addr_info_from_section_table (so
->sections
,
354 so
->objfile
= symbol_file_add (so
->so_name
, so
->from_tty
,
355 sap
, 0, OBJF_SHARED
);
356 free_section_addr_info (sap
);
364 update_solib_list --- synchronize GDB's shared object list with inferior's
368 void update_solib_list (int from_tty, struct target_ops *TARGET)
370 Extract the list of currently loaded shared objects from the
371 inferior, and compare it with the list of shared objects currently
372 in GDB's so_list_head list. Edit so_list_head to bring it in sync
373 with the inferior's new list.
375 If we notice that the inferior has unloaded some shared objects,
376 free any symbolic info GDB had read about those shared objects.
378 Don't load symbolic info for any new shared objects; just add them
379 to the list, and leave their symbols_loaded flag clear.
381 If FROM_TTY is non-null, feel free to print messages about what
384 If TARGET is non-null, add the sections of all new shared objects
385 to TARGET's section table. Note that this doesn't remove any
386 sections for shared objects that have been unloaded, and it
387 doesn't check to see if the new shared objects are already present in
388 the section table. But we only use this for core files and
389 processes we've just attached to, so that's okay. */
392 update_solib_list (int from_tty
, struct target_ops
*target
)
394 struct so_list
*inferior
= TARGET_SO_CURRENT_SOS ();
395 struct so_list
*gdb
, **gdb_link
;
397 /* If we are attaching to a running process for which we
398 have not opened a symbol file, we may be able to get its
401 symfile_objfile
== NULL
)
402 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT
, &from_tty
,
403 "Error reading attached process's symbol file.\n",
406 /* Since this function might actually add some elements to the
407 so_list_head list, arrange for it to be cleaned up when
409 if (!solib_cleanup_queued
)
411 make_run_cleanup (do_clear_solib
, NULL
);
412 solib_cleanup_queued
= 1;
415 /* GDB and the inferior's dynamic linker each maintain their own
416 list of currently loaded shared objects; we want to bring the
417 former in sync with the latter. Scan both lists, seeing which
418 shared objects appear where. There are three cases:
420 - A shared object appears on both lists. This means that GDB
421 knows about it already, and it's still loaded in the inferior.
422 Nothing needs to happen.
424 - A shared object appears only on GDB's list. This means that
425 the inferior has unloaded it. We should remove the shared
426 object from GDB's tables.
428 - A shared object appears only on the inferior's list. This
429 means that it's just been loaded. We should add it to GDB's
432 So we walk GDB's list, checking each entry to see if it appears
433 in the inferior's list too. If it does, no action is needed, and
434 we remove it from the inferior's list. If it doesn't, the
435 inferior has unloaded it, and we remove it from GDB's list. By
436 the time we're done walking GDB's list, the inferior's list
437 contains only the new shared objects, which we then add. */
440 gdb_link
= &so_list_head
;
443 struct so_list
*i
= inferior
;
444 struct so_list
**i_link
= &inferior
;
446 /* Check to see whether the shared object *gdb also appears in
447 the inferior's current list. */
450 if (! strcmp (gdb
->so_original_name
, i
->so_original_name
))
457 /* If the shared object appears on the inferior's list too, then
458 it's still loaded, so we don't need to do anything. Delete
459 it from the inferior's list, and leave it on GDB's list. */
464 gdb_link
= &gdb
->next
;
468 /* If it's not on the inferior's list, remove it from GDB's tables. */
471 *gdb_link
= gdb
->next
;
473 /* Unless the user loaded it explicitly, free SO's objfile. */
474 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
475 free_objfile (gdb
->objfile
);
477 /* Some targets' section tables might be referring to
478 sections from so->abfd; remove them. */
479 remove_target_sections (gdb
->abfd
);
486 /* Now the inferior's list contains only shared objects that don't
487 appear in GDB's list --- those that are newly loaded. Add them
488 to GDB's shared object list. */
493 /* Add the new shared objects to GDB's list. */
494 *gdb_link
= inferior
;
496 /* Fill in the rest of each of the `struct so_list' nodes. */
497 for (i
= inferior
; i
; i
= i
->next
)
499 i
->from_tty
= from_tty
;
501 /* Fill in the rest of the `struct so_list' node. */
502 catch_errors (solib_map_sections
, i
,
503 "Error while mapping shared library sections:\n",
506 /* If requested, add the shared object's sections to the TARGET's
507 section table. Do this immediately after mapping the object so
508 that later nodes in the list can query this object, as is needed
512 int count
= (i
->sections_end
- i
->sections
);
515 int space
= target_resize_to_sections (target
, count
);
516 memcpy (target
->to_sections
+ space
,
518 count
* sizeof (i
->sections
[0]));
528 solib_add -- read in symbol info for newly added shared libraries
532 void solib_add (char *pattern, int from_tty, struct target_ops
533 *TARGET, int readsyms)
537 Read in symbolic information for any shared objects whose names
538 match PATTERN. (If we've already read a shared object's symbol
539 info, leave it alone.) If PATTERN is zero, read them all.
541 If READSYMS is 0, defer reading symbolic information until later
542 but still do any needed low level processing.
544 FROM_TTY and TARGET are as described for update_solib_list, above. */
547 solib_add (char *pattern
, int from_tty
, struct target_ops
*target
, int readsyms
)
553 char *re_err
= re_comp (pattern
);
556 error ("Invalid regexp: %s", re_err
);
559 update_solib_list (from_tty
, target
);
561 /* Walk the list of currently loaded shared libraries, and read
562 symbols for any that match the pattern --- or any whose symbols
563 aren't already loaded, if no pattern was given. */
566 int loaded_any_symbols
= 0;
568 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
569 if (! pattern
|| re_exec (gdb
->so_name
))
573 if (gdb
->symbols_loaded
)
576 printf_unfiltered ("Symbols already loaded for %s\n",
582 (symbol_add_stub
, gdb
,
583 "Error while reading shared library symbols:\n",
587 printf_unfiltered ("Loaded symbols for %s\n",
589 gdb
->symbols_loaded
= 1;
590 loaded_any_symbols
= 1;
595 if (from_tty
&& pattern
&& ! any_matches
)
597 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
599 if (loaded_any_symbols
)
601 /* Getting new symbols may change our opinion about what is
603 reinit_frame_cache ();
605 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
615 info_sharedlibrary_command -- code for "info sharedlibrary"
619 static void info_sharedlibrary_command ()
623 Walk through the shared library list and print information
624 about each attached library.
628 info_sharedlibrary_command (char *ignore
, int from_tty
)
630 register struct so_list
*so
= NULL
; /* link map state variable */
635 if (TARGET_PTR_BIT
== 32)
640 else if (TARGET_PTR_BIT
== 64)
647 internal_error (__FILE__
, __LINE__
,
648 "TARGET_PTR_BIT returned unknown size %d",
652 update_solib_list (from_tty
, 0);
654 for (so
= so_list_head
; so
; so
= so
->next
)
660 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width
, "From",
661 addr_width
, "To", "Syms Read",
662 "Shared Object Library");
666 printf_unfiltered ("%-*s", addr_width
,
667 so
->textsection
!= NULL
668 ? local_hex_string_custom (
669 (LONGEST
) so
->textsection
->addr
,
672 printf_unfiltered ("%-*s", addr_width
,
673 so
->textsection
!= NULL
674 ? local_hex_string_custom (
675 (LONGEST
) so
->textsection
->endaddr
,
678 printf_unfiltered ("%-12s", so
->symbols_loaded
? "Yes" : "No");
679 printf_unfiltered ("%s\n", so
->so_name
);
682 if (so_list_head
== NULL
)
684 printf_unfiltered ("No shared libraries loaded at this time.\n");
692 solib_address -- check to see if an address is in a shared lib
696 char * solib_address (CORE_ADDR address)
700 Provides a hook for other gdb routines to discover whether or
701 not a particular address is within the mapped address space of
704 For example, this routine is called at one point to disable
705 breakpoints which are in shared libraries that are not currently
710 solib_address (CORE_ADDR address
)
712 register struct so_list
*so
= 0; /* link map state variable */
714 for (so
= so_list_head
; so
; so
= so
->next
)
716 struct section_table
*p
;
718 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
720 if (p
->addr
<= address
&& address
< p
->endaddr
)
721 return (so
->so_name
);
728 /* Called by free_all_symtabs */
733 /* This function is expected to handle ELF shared libraries. It is
734 also used on Solaris, which can run either ELF or a.out binaries
735 (for compatibility with SunOS 4), both of which can use shared
736 libraries. So we don't know whether we have an ELF executable or
737 an a.out executable until the user chooses an executable file.
739 ELF shared libraries don't get mapped into the address space
740 until after the program starts, so we'd better not try to insert
741 breakpoints in them immediately. We have to wait until the
742 dynamic linker has loaded them; we'll hit a bp_shlib_event
743 breakpoint (look for calls to create_solib_event_breakpoint) when
746 SunOS shared libraries seem to be different --- they're present
747 as soon as the process begins execution, so there's no need to
748 put off inserting breakpoints. There's also nowhere to put a
749 bp_shlib_event breakpoint, so if we put it off, we'll never get
752 So: disable breakpoints only if we're using ELF shared libs. */
754 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
755 disable_breakpoints_in_shlibs (1);
759 struct so_list
*so
= so_list_head
;
760 so_list_head
= so
->next
;
762 remove_target_sections (so
->abfd
);
766 TARGET_SO_CLEAR_SOLIB ();
770 do_clear_solib (void *dummy
)
772 solib_cleanup_queued
= 0;
778 solib_create_inferior_hook -- shared library startup support
782 void solib_create_inferior_hook()
786 When gdb starts up the inferior, it nurses it along (through the
787 shell) until it is ready to execute it's first instruction. At this
788 point, this function gets called via expansion of the macro
789 SOLIB_CREATE_INFERIOR_HOOK. */
792 solib_create_inferior_hook (void)
794 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
799 in_solib_dynsym_resolve_code -- check to see if an address is in
800 dynamic loader's dynamic symbol
805 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
809 Determine if PC is in the dynamic linker's symbol resolution
810 code. Return 1 if so, 0 otherwise.
814 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
816 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc
);
823 sharedlibrary_command -- handle command to explicitly add library
827 static void sharedlibrary_command (char *args, int from_tty)
834 sharedlibrary_command (char *args
, int from_tty
)
837 solib_add (args
, from_tty
, (struct target_ops
*) 0, 1);
842 no_shared_libraries -- handle command to explicitly discard symbols
843 from shared libraries.
847 Implements the command "nosharedlibrary", which discards symbols
848 that have been auto-loaded from shared libraries. Symbols from
849 shared libraries that were added by explicit request of the user
850 are not discarded. Also called from remote.c. */
853 no_shared_libraries (char *ignored
, int from_tty
)
855 objfile_purge_solibs ();
856 do_clear_solib (NULL
);
860 reload_shared_libraries (char *ignored
, int from_tty
)
862 no_shared_libraries (NULL
, from_tty
);
863 solib_add (NULL
, from_tty
, NULL
, auto_solib_add
);
866 extern initialize_file_ftype _initialize_solib
; /* -Wmissing-prototypes */
869 _initialize_solib (void)
871 struct cmd_list_element
*c
;
873 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
874 "Load shared object library symbols for files matching REGEXP.");
875 add_info ("sharedlibrary", info_sharedlibrary_command
,
876 "Status of loaded shared object libraries.");
877 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
878 "Unload all shared object library symbols.");
881 (add_set_cmd ("auto-solib-add", class_support
, var_boolean
,
882 (char *) &auto_solib_add
,
883 "Set autoloading of shared library symbols.\n\
884 If \"on\", symbols from all shared object libraries will be loaded\n\
885 automatically when the inferior begins execution, when the dynamic linker\n\
886 informs gdb that a new library has been loaded, or when attaching to the\n\
887 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'.",
891 c
= add_set_cmd ("solib-absolute-prefix", class_support
, var_filename
,
892 (char *) &solib_absolute_prefix
,
893 "Set prefix for loading absolute shared library symbol files.\n\
894 For other (relative) files, you can add values using `set solib-search-path'.",
896 add_show_from_set (c
, &showlist
);
897 set_cmd_cfunc (c
, reload_shared_libraries
);
898 set_cmd_completer (c
, filename_completer
);
900 /* Set the default value of "solib-absolute-prefix" from the sysroot, if
902 solib_absolute_prefix
= xstrdup (gdb_sysroot
);
904 c
= add_set_cmd ("solib-search-path", class_support
, var_string
,
905 (char *) &solib_search_path
,
906 "Set the search path for loading non-absolute shared library symbol files.\n\
907 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
909 add_show_from_set (c
, &showlist
);
910 set_cmd_cfunc (c
, reload_shared_libraries
);
911 set_cmd_completer (c
, filename_completer
);