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 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 */
46 /* external data declarations */
48 /* FIXME: gdbarch needs to control this variable */
49 struct target_so_ops *current_target_so_ops;
51 /* local data declarations */
53 static struct so_list *so_list_head; /* List of known shared objects */
55 static int solib_cleanup_queued = 0; /* make_run_cleanup called */
57 /* Local function prototypes */
59 static void do_clear_solib (PTR);
61 /* If non-zero, this is a prefix that will be added to the front of the name
62 shared libraries with an absolute filename for loading. */
63 static char *solib_absolute_prefix = NULL;
65 /* If non-empty, this is a search path for loading non-absolute shared library
66 symbol files. This takes precedence over the environment variables PATH
67 and LD_LIBRARY_PATH. */
68 static char *solib_search_path = NULL;
74 solib_open -- Find a shared library file and open it.
78 int solib_open (char *in_patname, char **found_pathname);
82 Global variable SOLIB_ABSOLUTE_PREFIX is used as a prefix directory
83 to search for shared libraries if they have an absolute path.
85 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
86 (or set of directories, as in LD_LIBRARY_PATH) to search for all
87 shared libraries if not found in SOLIB_ABSOLUTE_PREFIX.
90 * If path is absolute, look in SOLIB_ABSOLUTE_PREFIX.
91 * If path is absolute or relative, look for it literally (unmodified).
92 * Look in SOLIB_SEARCH_PATH.
93 * Look in inferior's $PATH.
94 * Look in inferior's $LD_LIBRARY_PATH.
98 file handle for opened solib, or -1 for failure. */
101 solib_open (char *in_pathname, char **found_pathname)
104 char *temp_pathname = NULL;
105 char *p = in_pathname;
107 while (*p && !IS_DIR_SEPARATOR (*p))
112 if (! IS_ABSOLUTE_PATH (in_pathname) || solib_absolute_prefix == NULL)
113 temp_pathname = in_pathname;
116 int prefix_len = strlen (solib_absolute_prefix);
118 /* Remove trailing slashes from absolute prefix. */
119 while (prefix_len > 0
120 && IS_DIR_SEPARATOR (solib_absolute_prefix[prefix_len - 1]))
123 /* Cat the prefixed pathname together. */
124 temp_pathname = alloca (prefix_len + strlen (in_pathname) + 1);
125 strncpy (temp_pathname, solib_absolute_prefix, prefix_len);
126 temp_pathname[prefix_len] = '\0';
127 strcat (temp_pathname, in_pathname);
130 /* Now see if we can open it. */
131 found_file = open (temp_pathname, O_RDONLY, 0);
134 /* If the search in solib_absolute_prefix failed, and the path name is
135 absolute at this point, make it relative. (openp will try and open the
136 file according to its absolute path otherwise, which is not what we want.)
137 Affects subsequent searches for this solib. */
138 if (found_file < 0 && IS_ABSOLUTE_PATH (in_pathname))
140 /* First, get rid of any drive letters etc. */
141 while (!IS_DIR_SEPARATOR (*in_pathname))
144 /* Next, get rid of all leading dir separators. */
145 while (IS_DIR_SEPARATOR (*in_pathname))
149 /* If not found, next search the solib_search_path (if any). */
150 if (found_file < 0 && solib_search_path != NULL)
151 found_file = openp (solib_search_path,
152 1, in_pathname, O_RDONLY, 0, &temp_pathname);
154 /* If not found, next search the solib_search_path (if any) for the basename
155 only (ignoring the path). This is to allow reading solibs from a path
156 that differs from the opened path. */
157 if (found_file < 0 && solib_search_path != NULL)
158 found_file = openp (solib_search_path,
159 1, lbasename (in_pathname), O_RDONLY, 0,
162 /* If not found, next search the inferior's $PATH environment variable. */
163 if (found_file < 0 && solib_search_path != NULL)
164 found_file = openp (get_in_environ (inferior_environ, "PATH"),
165 1, in_pathname, O_RDONLY, 0, &temp_pathname);
167 /* If not found, next search the inferior's $LD_LIBRARY_PATH
168 environment variable. */
169 if (found_file < 0 && solib_search_path != NULL)
170 found_file = openp (get_in_environ (inferior_environ, "LD_LIBRARY_PATH"),
171 1, in_pathname, O_RDONLY, 0, &temp_pathname);
173 /* Done. If not found, tough luck. Return found_file and
174 (optionally) found_pathname. */
175 if (found_pathname != NULL && temp_pathname != NULL)
176 *found_pathname = xstrdup (temp_pathname);
185 solib_map_sections -- open bfd and build sections for shared lib
189 static int solib_map_sections (struct so_list *so)
193 Given a pointer to one of the shared objects in our list
194 of mapped objects, use the recorded name to open a bfd
195 descriptor for the object, build a section table, and then
196 relocate all the section addresses by the base address at
197 which the shared object was mapped.
201 In most (all?) cases the shared object file name recorded in the
202 dynamic linkage tables will be a fully qualified pathname. For
203 cases where it isn't, do we really mimic the systems search
204 mechanism correctly in the below code (particularly the tilde
209 solib_map_sections (PTR arg)
211 struct so_list *so = (struct so_list *) arg; /* catch_errors bogon */
213 char *scratch_pathname;
215 struct section_table *p;
216 struct cleanup *old_chain;
219 filename = tilde_expand (so->so_name);
221 old_chain = make_cleanup (xfree, filename);
222 scratch_chan = solib_open (filename, &scratch_pathname);
224 if (scratch_chan < 0)
226 perror_with_name (filename);
229 /* Leave scratch_pathname allocated. abfd->name will point to it. */
230 abfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
233 close (scratch_chan);
234 error ("Could not open `%s' as an executable file: %s",
235 scratch_pathname, bfd_errmsg (bfd_get_error ()));
238 /* Leave bfd open, core_xfer_memory and "info files" need it. */
242 /* copy full path name into so_name, so that later symbol_file_add
244 if (strlen (scratch_pathname) >= SO_NAME_MAX_PATH_SIZE)
245 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
246 strcpy (so->so_name, scratch_pathname);
248 if (!bfd_check_format (abfd, bfd_object))
250 error ("\"%s\": not in executable format: %s.",
251 scratch_pathname, bfd_errmsg (bfd_get_error ()));
253 if (build_section_table (abfd, &so->sections, &so->sections_end))
255 error ("Can't find the file sections in `%s': %s",
256 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
259 for (p = so->sections; p < so->sections_end; p++)
261 /* Relocate the section binding addresses as recorded in the shared
262 object's file by the base address to which the object was actually
264 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so, p);
265 if (STREQ (p->the_bfd_section->name, ".text"))
271 /* Free the file names, close the file now. */
272 do_cleanups (old_chain);
279 free_so --- free a `struct so_list' object
283 void free_so (struct so_list *so)
287 Free the storage associated with the `struct so_list' object SO.
288 If we have opened a BFD for SO, close it.
290 The caller is responsible for removing SO from whatever list it is
291 a member of. If we have placed SO's sections in some target's
292 section table, the caller is responsible for removing them.
294 This function doesn't mess with objfiles at all. If there is an
295 objfile associated with SO that needs to be removed, the caller is
296 responsible for taking care of that. */
299 free_so (struct so_list *so)
301 char *bfd_filename = 0;
304 xfree (so->sections);
308 bfd_filename = bfd_get_filename (so->abfd);
309 if (! bfd_close (so->abfd))
310 warning ("cannot close \"%s\": %s",
311 bfd_filename, bfd_errmsg (bfd_get_error ()));
315 xfree (bfd_filename);
317 TARGET_SO_FREE_SO (so);
323 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
326 symbol_add_stub (PTR arg)
328 register struct so_list *so = (struct so_list *) arg; /* catch_errs bogon */
329 struct section_addr_info *sap;
331 /* Have we already loaded this shared object? */
332 ALL_OBJFILES (so->objfile)
334 if (strcmp (so->objfile->name, so->so_name) == 0)
338 sap = build_section_addr_info_from_section_table (so->sections,
341 so->objfile = symbol_file_add (so->so_name, so->from_tty,
342 sap, 0, OBJF_SHARED);
343 free_section_addr_info (sap);
351 update_solib_list --- synchronize GDB's shared object list with inferior's
355 void update_solib_list (int from_tty, struct target_ops *TARGET)
357 Extract the list of currently loaded shared objects from the
358 inferior, and compare it with the list of shared objects currently
359 in GDB's so_list_head list. Edit so_list_head to bring it in sync
360 with the inferior's new list.
362 If we notice that the inferior has unloaded some shared objects,
363 free any symbolic info GDB had read about those shared objects.
365 Don't load symbolic info for any new shared objects; just add them
366 to the list, and leave their symbols_loaded flag clear.
368 If FROM_TTY is non-null, feel free to print messages about what
371 If TARGET is non-null, add the sections of all new shared objects
372 to TARGET's section table. Note that this doesn't remove any
373 sections for shared objects that have been unloaded, and it
374 doesn't check to see if the new shared objects are already present in
375 the section table. But we only use this for core files and
376 processes we've just attached to, so that's okay. */
379 update_solib_list (int from_tty, struct target_ops *target)
381 struct so_list *inferior = TARGET_SO_CURRENT_SOS ();
382 struct so_list *gdb, **gdb_link;
384 /* If we are attaching to a running process for which we
385 have not opened a symbol file, we may be able to get its
388 symfile_objfile == NULL)
389 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT, (PTR) &from_tty,
390 "Error reading attached process's symbol file.\n",
393 /* Since this function might actually add some elements to the
394 so_list_head list, arrange for it to be cleaned up when
396 if (!solib_cleanup_queued)
398 make_run_cleanup (do_clear_solib, NULL);
399 solib_cleanup_queued = 1;
402 /* GDB and the inferior's dynamic linker each maintain their own
403 list of currently loaded shared objects; we want to bring the
404 former in sync with the latter. Scan both lists, seeing which
405 shared objects appear where. There are three cases:
407 - A shared object appears on both lists. This means that GDB
408 knows about it already, and it's still loaded in the inferior.
409 Nothing needs to happen.
411 - A shared object appears only on GDB's list. This means that
412 the inferior has unloaded it. We should remove the shared
413 object from GDB's tables.
415 - A shared object appears only on the inferior's list. This
416 means that it's just been loaded. We should add it to GDB's
419 So we walk GDB's list, checking each entry to see if it appears
420 in the inferior's list too. If it does, no action is needed, and
421 we remove it from the inferior's list. If it doesn't, the
422 inferior has unloaded it, and we remove it from GDB's list. By
423 the time we're done walking GDB's list, the inferior's list
424 contains only the new shared objects, which we then add. */
427 gdb_link = &so_list_head;
430 struct so_list *i = inferior;
431 struct so_list **i_link = &inferior;
433 /* Check to see whether the shared object *gdb also appears in
434 the inferior's current list. */
437 if (! strcmp (gdb->so_original_name, i->so_original_name))
444 /* If the shared object appears on the inferior's list too, then
445 it's still loaded, so we don't need to do anything. Delete
446 it from the inferior's list, and leave it on GDB's list. */
451 gdb_link = &gdb->next;
455 /* If it's not on the inferior's list, remove it from GDB's tables. */
458 *gdb_link = gdb->next;
460 /* Unless the user loaded it explicitly, free SO's objfile. */
461 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
462 free_objfile (gdb->objfile);
464 /* Some targets' section tables might be referring to
465 sections from so->abfd; remove them. */
466 remove_target_sections (gdb->abfd);
473 /* Now the inferior's list contains only shared objects that don't
474 appear in GDB's list --- those that are newly loaded. Add them
475 to GDB's shared object list. */
480 /* Add the new shared objects to GDB's list. */
481 *gdb_link = inferior;
483 /* Fill in the rest of each of the `struct so_list' nodes. */
484 for (i = inferior; i; i = i->next)
486 i->from_tty = from_tty;
488 /* Fill in the rest of the `struct so_list' node. */
489 catch_errors (solib_map_sections, i,
490 "Error while mapping shared library sections:\n",
493 /* If requested, add the shared object's sections to the TARGET's
494 section table. Do this immediately after mapping the object so
495 that later nodes in the list can query this object, as is needed
499 int count = (i->sections_end - i->sections);
502 int space = target_resize_to_sections (target, count);
503 memcpy (target->to_sections + space,
505 count * sizeof (i->sections[0]));
515 solib_add -- read in symbol info for newly added shared libraries
519 void solib_add (char *pattern, int from_tty, struct target_ops
520 *TARGET, int readsyms)
524 Read in symbolic information for any shared objects whose names
525 match PATTERN. (If we've already read a shared object's symbol
526 info, leave it alone.) If PATTERN is zero, read them all.
528 If READSYMS is 0, defer reading symbolic information until later
529 but still do any needed low level processing.
531 FROM_TTY and TARGET are as described for update_solib_list, above. */
534 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
540 char *re_err = re_comp (pattern);
543 error ("Invalid regexp: %s", re_err);
546 update_solib_list (from_tty, target);
548 /* Walk the list of currently loaded shared libraries, and read
549 symbols for any that match the pattern --- or any whose symbols
550 aren't already loaded, if no pattern was given. */
553 int loaded_any_symbols = 0;
555 for (gdb = so_list_head; gdb; gdb = gdb->next)
556 if (! pattern || re_exec (gdb->so_name))
560 if (gdb->symbols_loaded)
563 printf_unfiltered ("Symbols already loaded for %s\n",
569 (symbol_add_stub, gdb,
570 "Error while reading shared library symbols:\n",
574 printf_unfiltered ("Loaded symbols for %s\n",
576 gdb->symbols_loaded = 1;
577 loaded_any_symbols = 1;
582 if (from_tty && pattern && ! any_matches)
584 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
586 if (loaded_any_symbols)
588 /* Getting new symbols may change our opinion about what is
590 reinit_frame_cache ();
592 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
602 info_sharedlibrary_command -- code for "info sharedlibrary"
606 static void info_sharedlibrary_command ()
610 Walk through the shared library list and print information
611 about each attached library.
615 info_sharedlibrary_command (char *ignore, int from_tty)
617 register struct so_list *so = NULL; /* link map state variable */
622 if (TARGET_PTR_BIT == 32)
627 else if (TARGET_PTR_BIT == 64)
634 internal_error (__FILE__, __LINE__,
635 "TARGET_PTR_BIT returned unknown size %d",
639 update_solib_list (from_tty, 0);
641 for (so = so_list_head; so; so = so->next)
647 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width, "From",
648 addr_width, "To", "Syms Read",
649 "Shared Object Library");
653 printf_unfiltered ("%-*s", addr_width,
654 so->textsection != NULL
655 ? local_hex_string_custom (
656 (LONGEST) so->textsection->addr,
659 printf_unfiltered ("%-*s", addr_width,
660 so->textsection != NULL
661 ? local_hex_string_custom (
662 (LONGEST) so->textsection->endaddr,
665 printf_unfiltered ("%-12s", so->symbols_loaded ? "Yes" : "No");
666 printf_unfiltered ("%s\n", so->so_name);
669 if (so_list_head == NULL)
671 printf_unfiltered ("No shared libraries loaded at this time.\n");
679 solib_address -- check to see if an address is in a shared lib
683 char * solib_address (CORE_ADDR address)
687 Provides a hook for other gdb routines to discover whether or
688 not a particular address is within the mapped address space of
691 For example, this routine is called at one point to disable
692 breakpoints which are in shared libraries that are not currently
697 solib_address (CORE_ADDR address)
699 register struct so_list *so = 0; /* link map state variable */
701 for (so = so_list_head; so; so = so->next)
703 struct section_table *p;
705 for (p = so->sections; p < so->sections_end; p++)
707 if (p->addr <= address && address < p->endaddr)
708 return (so->so_name);
715 /* Called by free_all_symtabs */
720 /* This function is expected to handle ELF shared libraries. It is
721 also used on Solaris, which can run either ELF or a.out binaries
722 (for compatibility with SunOS 4), both of which can use shared
723 libraries. So we don't know whether we have an ELF executable or
724 an a.out executable until the user chooses an executable file.
726 ELF shared libraries don't get mapped into the address space
727 until after the program starts, so we'd better not try to insert
728 breakpoints in them immediately. We have to wait until the
729 dynamic linker has loaded them; we'll hit a bp_shlib_event
730 breakpoint (look for calls to create_solib_event_breakpoint) when
733 SunOS shared libraries seem to be different --- they're present
734 as soon as the process begins execution, so there's no need to
735 put off inserting breakpoints. There's also nowhere to put a
736 bp_shlib_event breakpoint, so if we put it off, we'll never get
739 So: disable breakpoints only if we're using ELF shared libs. */
741 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
742 disable_breakpoints_in_shlibs (1);
746 struct so_list *so = so_list_head;
747 so_list_head = so->next;
749 remove_target_sections (so->abfd);
753 TARGET_SO_CLEAR_SOLIB ();
757 do_clear_solib (PTR dummy)
759 solib_cleanup_queued = 0;
765 solib_create_inferior_hook -- shared library startup support
769 void solib_create_inferior_hook()
773 When gdb starts up the inferior, it nurses it along (through the
774 shell) until it is ready to execute it's first instruction. At this
775 point, this function gets called via expansion of the macro
776 SOLIB_CREATE_INFERIOR_HOOK. */
779 solib_create_inferior_hook (void)
781 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
786 in_solib_dynsym_resolve_code -- check to see if an address is in
787 dynamic loader's dynamic symbol
792 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
796 Determine if PC is in the dynamic linker's symbol resolution
797 code. Return 1 if so, 0 otherwise.
801 in_solib_dynsym_resolve_code (CORE_ADDR pc)
803 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc);
810 sharedlibrary_command -- handle command to explicitly add library
814 static void sharedlibrary_command (char *args, int from_tty)
821 sharedlibrary_command (char *args, int from_tty)
824 solib_add (args, from_tty, (struct target_ops *) 0, 1);
829 no_shared_libraries -- handle command to explicitly discard symbols
830 from shared libraries.
834 Implements the command "nosharedlibrary", which discards symbols
835 that have been auto-loaded from shared libraries. Symbols from
836 shared libraries that were added by explicit request of the user
837 are not discarded. Also called from remote.c. */
840 no_shared_libraries (char *ignored, int from_tty)
842 objfile_purge_solibs ();
843 do_clear_solib (NULL);
847 _initialize_solib (void)
849 struct cmd_list_element *c;
851 add_com ("sharedlibrary", class_files, sharedlibrary_command,
852 "Load shared object library symbols for files matching REGEXP.");
853 add_info ("sharedlibrary", info_sharedlibrary_command,
854 "Status of loaded shared object libraries.");
855 add_com ("nosharedlibrary", class_files, no_shared_libraries,
856 "Unload all shared object library symbols.");
859 (add_set_cmd ("auto-solib-add", class_support, var_boolean,
860 (char *) &auto_solib_add,
861 "Set autoloading of shared library symbols.\n\
862 If \"on\", symbols from all shared object libraries will be loaded\n\
863 automatically when the inferior begins execution, when the dynamic linker\n\
864 informs gdb that a new library has been loaded, or when attaching to the\n\
865 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'.",
869 c = add_set_cmd ("solib-absolute-prefix", class_support, var_filename,
870 (char *) &solib_absolute_prefix,
871 "Set prefix for loading absolute shared library symbol files.\n\
872 For other (relative) files, you can add values using `set solib-search-path'.",
874 add_show_from_set (c, &showlist);
875 set_cmd_completer (c, filename_completer);
877 c = add_set_cmd ("solib-search-path", class_support, var_string,
878 (char *) &solib_search_path,
879 "Set the search path for loading non-absolute shared library symbol files.\n\
880 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
882 add_show_from_set (c, &showlist);
883 set_cmd_completer (c, filename_completer);