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. */
253 bfd_set_cacheable (abfd, 1);
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 (strcmp (p->the_bfd_section->name, ".text") == 0)
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 /* Return address of first so_list entry in master shared object list. */
338 master_so_list (void)
344 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
347 symbol_add_stub (void *arg)
349 struct so_list *so = (struct so_list *) arg; /* catch_errs bogon */
350 struct section_addr_info *sap;
352 /* Have we already loaded this shared object? */
353 ALL_OBJFILES (so->objfile)
355 if (strcmp (so->objfile->name, so->so_name) == 0)
359 sap = build_section_addr_info_from_section_table (so->sections,
362 so->objfile = symbol_file_add (so->so_name, so->from_tty,
363 sap, 0, OBJF_SHARED);
364 free_section_addr_info (sap);
372 update_solib_list --- synchronize GDB's shared object list with inferior's
376 void update_solib_list (int from_tty, struct target_ops *TARGET)
378 Extract the list of currently loaded shared objects from the
379 inferior, and compare it with the list of shared objects currently
380 in GDB's so_list_head list. Edit so_list_head to bring it in sync
381 with the inferior's new list.
383 If we notice that the inferior has unloaded some shared objects,
384 free any symbolic info GDB had read about those shared objects.
386 Don't load symbolic info for any new shared objects; just add them
387 to the list, and leave their symbols_loaded flag clear.
389 If FROM_TTY is non-null, feel free to print messages about what
392 If TARGET is non-null, add the sections of all new shared objects
393 to TARGET's section table. Note that this doesn't remove any
394 sections for shared objects that have been unloaded, and it
395 doesn't check to see if the new shared objects are already present in
396 the section table. But we only use this for core files and
397 processes we've just attached to, so that's okay. */
400 update_solib_list (int from_tty, struct target_ops *target)
402 struct so_list *inferior = TARGET_SO_CURRENT_SOS ();
403 struct so_list *gdb, **gdb_link;
405 /* If we are attaching to a running process for which we
406 have not opened a symbol file, we may be able to get its
409 symfile_objfile == NULL)
410 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT, &from_tty,
411 "Error reading attached process's symbol file.\n",
414 /* Since this function might actually add some elements to the
415 so_list_head list, arrange for it to be cleaned up when
417 if (!solib_cleanup_queued)
419 make_run_cleanup (do_clear_solib, NULL);
420 solib_cleanup_queued = 1;
423 /* GDB and the inferior's dynamic linker each maintain their own
424 list of currently loaded shared objects; we want to bring the
425 former in sync with the latter. Scan both lists, seeing which
426 shared objects appear where. There are three cases:
428 - A shared object appears on both lists. This means that GDB
429 knows about it already, and it's still loaded in the inferior.
430 Nothing needs to happen.
432 - A shared object appears only on GDB's list. This means that
433 the inferior has unloaded it. We should remove the shared
434 object from GDB's tables.
436 - A shared object appears only on the inferior's list. This
437 means that it's just been loaded. We should add it to GDB's
440 So we walk GDB's list, checking each entry to see if it appears
441 in the inferior's list too. If it does, no action is needed, and
442 we remove it from the inferior's list. If it doesn't, the
443 inferior has unloaded it, and we remove it from GDB's list. By
444 the time we're done walking GDB's list, the inferior's list
445 contains only the new shared objects, which we then add. */
448 gdb_link = &so_list_head;
451 struct so_list *i = inferior;
452 struct so_list **i_link = &inferior;
454 /* Check to see whether the shared object *gdb also appears in
455 the inferior's current list. */
458 if (! strcmp (gdb->so_original_name, i->so_original_name))
465 /* If the shared object appears on the inferior's list too, then
466 it's still loaded, so we don't need to do anything. Delete
467 it from the inferior's list, and leave it on GDB's list. */
472 gdb_link = &gdb->next;
476 /* If it's not on the inferior's list, remove it from GDB's tables. */
479 *gdb_link = gdb->next;
481 /* Unless the user loaded it explicitly, free SO's objfile. */
482 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
483 free_objfile (gdb->objfile);
485 /* Some targets' section tables might be referring to
486 sections from so->abfd; remove them. */
487 remove_target_sections (gdb->abfd);
494 /* Now the inferior's list contains only shared objects that don't
495 appear in GDB's list --- those that are newly loaded. Add them
496 to GDB's shared object list. */
501 /* Add the new shared objects to GDB's list. */
502 *gdb_link = inferior;
504 /* Fill in the rest of each of the `struct so_list' nodes. */
505 for (i = inferior; i; i = i->next)
507 i->from_tty = from_tty;
509 /* Fill in the rest of the `struct so_list' node. */
510 catch_errors (solib_map_sections, i,
511 "Error while mapping shared library sections:\n",
514 /* If requested, add the shared object's sections to the TARGET's
515 section table. Do this immediately after mapping the object so
516 that later nodes in the list can query this object, as is needed
520 int count = (i->sections_end - i->sections);
523 int space = target_resize_to_sections (target, count);
524 memcpy (target->to_sections + space,
526 count * sizeof (i->sections[0]));
536 solib_add -- read in symbol info for newly added shared libraries
540 void solib_add (char *pattern, int from_tty, struct target_ops
541 *TARGET, int readsyms)
545 Read in symbolic information for any shared objects whose names
546 match PATTERN. (If we've already read a shared object's symbol
547 info, leave it alone.) If PATTERN is zero, read them all.
549 If READSYMS is 0, defer reading symbolic information until later
550 but still do any needed low level processing.
552 FROM_TTY and TARGET are as described for update_solib_list, above. */
555 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
561 char *re_err = re_comp (pattern);
564 error ("Invalid regexp: %s", re_err);
567 update_solib_list (from_tty, target);
569 /* Walk the list of currently loaded shared libraries, and read
570 symbols for any that match the pattern --- or any whose symbols
571 aren't already loaded, if no pattern was given. */
574 int loaded_any_symbols = 0;
576 for (gdb = so_list_head; gdb; gdb = gdb->next)
577 if (! pattern || re_exec (gdb->so_name))
581 if (gdb->symbols_loaded)
584 printf_unfiltered ("Symbols already loaded for %s\n",
590 (symbol_add_stub, gdb,
591 "Error while reading shared library symbols:\n",
595 printf_unfiltered ("Loaded symbols for %s\n",
597 gdb->symbols_loaded = 1;
598 loaded_any_symbols = 1;
603 if (from_tty && pattern && ! any_matches)
605 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
607 if (loaded_any_symbols)
609 /* Getting new symbols may change our opinion about what is
611 reinit_frame_cache ();
613 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
623 info_sharedlibrary_command -- code for "info sharedlibrary"
627 static void info_sharedlibrary_command ()
631 Walk through the shared library list and print information
632 about each attached library.
636 info_sharedlibrary_command (char *ignore, int from_tty)
638 struct so_list *so = NULL; /* link map state variable */
643 if (TARGET_PTR_BIT == 32)
648 else if (TARGET_PTR_BIT == 64)
655 internal_error (__FILE__, __LINE__,
656 "TARGET_PTR_BIT returned unknown size %d",
660 update_solib_list (from_tty, 0);
662 for (so = so_list_head; so; so = so->next)
668 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width, "From",
669 addr_width, "To", "Syms Read",
670 "Shared Object Library");
674 printf_unfiltered ("%-*s", addr_width,
675 so->textsection != NULL
676 ? local_hex_string_custom (
677 (LONGEST) so->textsection->addr,
680 printf_unfiltered ("%-*s", addr_width,
681 so->textsection != NULL
682 ? local_hex_string_custom (
683 (LONGEST) so->textsection->endaddr,
686 printf_unfiltered ("%-12s", so->symbols_loaded ? "Yes" : "No");
687 printf_unfiltered ("%s\n", so->so_name);
690 if (so_list_head == NULL)
692 printf_unfiltered ("No shared libraries loaded at this time.\n");
700 solib_address -- check to see if an address is in a shared lib
704 char * solib_address (CORE_ADDR address)
708 Provides a hook for other gdb routines to discover whether or
709 not a particular address is within the mapped address space of
712 For example, this routine is called at one point to disable
713 breakpoints which are in shared libraries that are not currently
718 solib_address (CORE_ADDR address)
720 struct so_list *so = 0; /* link map state variable */
722 for (so = so_list_head; so; so = so->next)
724 struct section_table *p;
726 for (p = so->sections; p < so->sections_end; p++)
728 if (p->addr <= address && address < p->endaddr)
729 return (so->so_name);
736 /* Called by free_all_symtabs */
741 /* This function is expected to handle ELF shared libraries. It is
742 also used on Solaris, which can run either ELF or a.out binaries
743 (for compatibility with SunOS 4), both of which can use shared
744 libraries. So we don't know whether we have an ELF executable or
745 an a.out executable until the user chooses an executable file.
747 ELF shared libraries don't get mapped into the address space
748 until after the program starts, so we'd better not try to insert
749 breakpoints in them immediately. We have to wait until the
750 dynamic linker has loaded them; we'll hit a bp_shlib_event
751 breakpoint (look for calls to create_solib_event_breakpoint) when
754 SunOS shared libraries seem to be different --- they're present
755 as soon as the process begins execution, so there's no need to
756 put off inserting breakpoints. There's also nowhere to put a
757 bp_shlib_event breakpoint, so if we put it off, we'll never get
760 So: disable breakpoints only if we're using ELF shared libs. */
762 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
763 disable_breakpoints_in_shlibs (1);
767 struct so_list *so = so_list_head;
768 so_list_head = so->next;
770 remove_target_sections (so->abfd);
774 TARGET_SO_CLEAR_SOLIB ();
778 do_clear_solib (void *dummy)
780 solib_cleanup_queued = 0;
786 solib_create_inferior_hook -- shared library startup support
790 void solib_create_inferior_hook()
794 When gdb starts up the inferior, it nurses it along (through the
795 shell) until it is ready to execute it's first instruction. At this
796 point, this function gets called via expansion of the macro
797 SOLIB_CREATE_INFERIOR_HOOK. */
800 solib_create_inferior_hook (void)
802 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
807 in_solib_dynsym_resolve_code -- check to see if an address is in
808 dynamic loader's dynamic symbol
813 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
817 Determine if PC is in the dynamic linker's symbol resolution
818 code. Return 1 if so, 0 otherwise.
822 in_solib_dynsym_resolve_code (CORE_ADDR pc)
824 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc);
831 sharedlibrary_command -- handle command to explicitly add library
835 static void sharedlibrary_command (char *args, int from_tty)
842 sharedlibrary_command (char *args, int from_tty)
845 solib_add (args, from_tty, (struct target_ops *) 0, 1);
850 no_shared_libraries -- handle command to explicitly discard symbols
851 from shared libraries.
855 Implements the command "nosharedlibrary", which discards symbols
856 that have been auto-loaded from shared libraries. Symbols from
857 shared libraries that were added by explicit request of the user
858 are not discarded. Also called from remote.c. */
861 no_shared_libraries (char *ignored, int from_tty)
863 objfile_purge_solibs ();
864 do_clear_solib (NULL);
868 reload_shared_libraries (char *ignored, int from_tty)
870 no_shared_libraries (NULL, from_tty);
871 solib_add (NULL, from_tty, NULL, auto_solib_add);
874 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
877 _initialize_solib (void)
879 struct cmd_list_element *c;
881 add_com ("sharedlibrary", class_files, sharedlibrary_command,
882 "Load shared object library symbols for files matching REGEXP.");
883 add_info ("sharedlibrary", info_sharedlibrary_command,
884 "Status of loaded shared object libraries.");
885 add_com ("nosharedlibrary", class_files, no_shared_libraries,
886 "Unload all shared object library symbols.");
889 (add_set_cmd ("auto-solib-add", class_support, var_boolean,
890 (char *) &auto_solib_add,
891 "Set autoloading of shared library symbols.\n\
892 If \"on\", symbols from all shared object libraries will be loaded\n\
893 automatically when the inferior begins execution, when the dynamic linker\n\
894 informs gdb that a new library has been loaded, or when attaching to the\n\
895 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'.",
899 c = add_set_cmd ("solib-absolute-prefix", class_support, var_filename,
900 (char *) &solib_absolute_prefix,
901 "Set prefix for loading absolute shared library symbol files.\n\
902 For other (relative) files, you can add values using `set solib-search-path'.",
904 add_show_from_set (c, &showlist);
905 set_cmd_cfunc (c, reload_shared_libraries);
906 set_cmd_completer (c, filename_completer);
908 /* Set the default value of "solib-absolute-prefix" from the sysroot, if
910 solib_absolute_prefix = xstrdup (gdb_sysroot);
912 c = add_set_cmd ("solib-search-path", class_support, var_string,
913 (char *) &solib_search_path,
914 "Set the search path for loading non-absolute shared library symbol files.\n\
915 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
917 add_show_from_set (c, &showlist);
918 set_cmd_cfunc (c, reload_shared_libraries);
919 set_cmd_completer (c, filename_completer);