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_map_sections -- open bfd and build sections for shared lib
75 static int solib_map_sections (struct so_list *so)
79 Given a pointer to one of the shared objects in our list
80 of mapped objects, use the recorded name to open a bfd
81 descriptor for the object, build a section table, and then
82 relocate all the section addresses by the base address at
83 which the shared object was mapped.
87 In most (all?) cases the shared object file name recorded in the
88 dynamic linkage tables will be a fully qualified pathname. For
89 cases where it isn't, do we really mimic the systems search
90 mechanism correctly in the below code (particularly the tilde
95 solib_map_sections (PTR arg
)
97 struct so_list
*so
= (struct so_list
*) arg
; /* catch_errors bogon */
99 char *scratch_pathname
;
101 struct section_table
*p
;
102 struct cleanup
*old_chain
;
105 filename
= tilde_expand (so
->so_name
);
107 if (solib_absolute_prefix
&& ROOTED_P (filename
))
108 /* Prefix shared libraries with absolute filenames with
109 SOLIB_ABSOLUTE_PREFIX. */
114 pfx_len
= strlen (solib_absolute_prefix
);
116 /* Remove trailing slashes. */
117 while (pfx_len
> 0 && SLASH_P (solib_absolute_prefix
[pfx_len
- 1]))
120 pfxed_fn
= xmalloc (pfx_len
+ strlen (filename
) + 1);
121 strcpy (pfxed_fn
, solib_absolute_prefix
);
122 strcat (pfxed_fn
, filename
);
128 old_chain
= make_cleanup (free
, filename
);
132 if (solib_search_path
)
133 scratch_chan
= openp (solib_search_path
,
134 1, filename
, O_RDONLY
, 0, &scratch_pathname
);
135 if (scratch_chan
< 0)
136 scratch_chan
= openp (get_in_environ (inferior_environ
, "PATH"),
137 1, filename
, O_RDONLY
, 0, &scratch_pathname
);
138 if (scratch_chan
< 0)
140 scratch_chan
= openp (get_in_environ
141 (inferior_environ
, "LD_LIBRARY_PATH"),
142 1, filename
, O_RDONLY
, 0, &scratch_pathname
);
144 if (scratch_chan
< 0)
146 perror_with_name (filename
);
148 /* Leave scratch_pathname allocated. abfd->name will point to it. */
150 abfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
153 close (scratch_chan
);
154 error ("Could not open `%s' as an executable file: %s",
155 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
157 /* Leave bfd open, core_xfer_memory and "info files" need it. */
159 abfd
->cacheable
= true;
161 /* copy full path name into so_name, so that later symbol_file_add can find
163 if (strlen (scratch_pathname
) >= SO_NAME_MAX_PATH_SIZE
)
164 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
165 strcpy (so
->so_name
, scratch_pathname
);
167 if (!bfd_check_format (abfd
, bfd_object
))
169 error ("\"%s\": not in executable format: %s.",
170 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
172 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
174 error ("Can't find the file sections in `%s': %s",
175 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
178 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
180 /* Relocate the section binding addresses as recorded in the shared
181 object's file by the base address to which the object was actually
183 p
->addr
+= TARGET_SO_LM_ADDR (so
);
184 p
->endaddr
+= TARGET_SO_LM_ADDR (so
);
185 so
->lmend
= max (p
->endaddr
, so
->lmend
);
186 if (STREQ (p
->the_bfd_section
->name
, ".text"))
192 /* Free the file names, close the file now. */
193 do_cleanups (old_chain
);
200 free_so --- free a `struct so_list' object
204 void free_so (struct so_list *so)
208 Free the storage associated with the `struct so_list' object SO.
209 If we have opened a BFD for SO, close it.
211 The caller is responsible for removing SO from whatever list it is
212 a member of. If we have placed SO's sections in some target's
213 section table, the caller is responsible for removing them.
215 This function doesn't mess with objfiles at all. If there is an
216 objfile associated with SO that needs to be removed, the caller is
217 responsible for taking care of that. */
220 free_so (struct so_list
*so
)
222 char *bfd_filename
= 0;
229 bfd_filename
= bfd_get_filename (so
->abfd
);
230 if (! bfd_close (so
->abfd
))
231 warning ("cannot close \"%s\": %s",
232 bfd_filename
, bfd_errmsg (bfd_get_error ()));
238 TARGET_SO_FREE_SO (so
);
244 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
247 symbol_add_stub (PTR arg
)
249 register struct so_list
*so
= (struct so_list
*) arg
; /* catch_errs bogon */
250 struct section_addr_info
*sap
;
251 CORE_ADDR lowest_addr
= 0;
253 asection
*lowest_sect
= NULL
;
255 /* Have we already loaded this shared object? */
256 ALL_OBJFILES (so
->objfile
)
258 if (strcmp (so
->objfile
->name
, so
->so_name
) == 0)
262 /* Find the shared object's text segment. */
265 lowest_addr
= so
->textsection
->addr
;
266 lowest_sect
= bfd_get_section_by_name (so
->abfd
, ".text");
267 lowest_index
= lowest_sect
->index
;
269 else if (so
->abfd
!= NULL
)
271 /* If we didn't find a mapped non zero sized .text section, set
272 up lowest_addr so that the relocation in symbol_file_add does
274 lowest_sect
= bfd_get_section_by_name (so
->abfd
, ".text");
275 if (lowest_sect
== NULL
)
276 bfd_map_over_sections (so
->abfd
, find_lowest_section
,
280 lowest_addr
= bfd_section_vma (so
->abfd
, lowest_sect
)
281 + TARGET_SO_LM_ADDR (so
);
282 lowest_index
= lowest_sect
->index
;
286 sap
= build_section_addr_info_from_section_table (so
->sections
,
289 sap
->other
[lowest_index
].addr
= lowest_addr
;
291 so
->objfile
= symbol_file_add (so
->so_name
, so
->from_tty
,
292 sap
, 0, OBJF_SHARED
);
293 free_section_addr_info (sap
);
301 update_solib_list --- synchronize GDB's shared object list with inferior's
305 void update_solib_list (int from_tty, struct target_ops *TARGET)
307 Extract the list of currently loaded shared objects from the
308 inferior, and compare it with the list of shared objects currently
309 in GDB's so_list_head list. Edit so_list_head to bring it in sync
310 with the inferior's new list.
312 If we notice that the inferior has unloaded some shared objects,
313 free any symbolic info GDB had read about those shared objects.
315 Don't load symbolic info for any new shared objects; just add them
316 to the list, and leave their symbols_loaded flag clear.
318 If FROM_TTY is non-null, feel free to print messages about what
321 If TARGET is non-null, add the sections of all new shared objects
322 to TARGET's section table. Note that this doesn't remove any
323 sections for shared objects that have been unloaded, and it
324 doesn't check to see if the new shared objects are already present in
325 the section table. But we only use this for core files and
326 processes we've just attached to, so that's okay. */
329 update_solib_list (int from_tty
, struct target_ops
*target
)
331 struct so_list
*inferior
= TARGET_SO_CURRENT_SOS ();
332 struct so_list
*gdb
, **gdb_link
;
334 /* If we are attaching to a running process for which we
335 have not opened a symbol file, we may be able to get its
338 symfile_objfile
== NULL
)
339 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT
, (PTR
) &from_tty
,
340 "Error reading attached process's symbol file.\n",
343 /* Since this function might actually add some elements to the
344 so_list_head list, arrange for it to be cleaned up when
346 if (!solib_cleanup_queued
)
348 make_run_cleanup (do_clear_solib
, NULL
);
349 solib_cleanup_queued
= 1;
352 /* GDB and the inferior's dynamic linker each maintain their own
353 list of currently loaded shared objects; we want to bring the
354 former in sync with the latter. Scan both lists, seeing which
355 shared objects appear where. There are three cases:
357 - A shared object appears on both lists. This means that GDB
358 knows about it already, and it's still loaded in the inferior.
359 Nothing needs to happen.
361 - A shared object appears only on GDB's list. This means that
362 the inferior has unloaded it. We should remove the shared
363 object from GDB's tables.
365 - A shared object appears only on the inferior's list. This
366 means that it's just been loaded. We should add it to GDB's
369 So we walk GDB's list, checking each entry to see if it appears
370 in the inferior's list too. If it does, no action is needed, and
371 we remove it from the inferior's list. If it doesn't, the
372 inferior has unloaded it, and we remove it from GDB's list. By
373 the time we're done walking GDB's list, the inferior's list
374 contains only the new shared objects, which we then add. */
377 gdb_link
= &so_list_head
;
380 struct so_list
*i
= inferior
;
381 struct so_list
**i_link
= &inferior
;
383 /* Check to see whether the shared object *gdb also appears in
384 the inferior's current list. */
387 if (! strcmp (gdb
->so_original_name
, i
->so_original_name
))
394 /* If the shared object appears on the inferior's list too, then
395 it's still loaded, so we don't need to do anything. Delete
396 it from the inferior's list, and leave it on GDB's list. */
401 gdb_link
= &gdb
->next
;
405 /* If it's not on the inferior's list, remove it from GDB's tables. */
408 *gdb_link
= gdb
->next
;
410 /* Unless the user loaded it explicitly, free SO's objfile. */
411 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
412 free_objfile (gdb
->objfile
);
414 /* Some targets' section tables might be referring to
415 sections from so->abfd; remove them. */
416 remove_target_sections (gdb
->abfd
);
423 /* Now the inferior's list contains only shared objects that don't
424 appear in GDB's list --- those that are newly loaded. Add them
425 to GDB's shared object list. */
430 /* Add the new shared objects to GDB's list. */
431 *gdb_link
= inferior
;
433 /* Fill in the rest of each of the `struct so_list' nodes. */
434 for (i
= inferior
; i
; i
= i
->next
)
436 i
->from_tty
= from_tty
;
438 /* Fill in the rest of the `struct so_list' node. */
439 catch_errors (solib_map_sections
, i
,
440 "Error while mapping shared library sections:\n",
444 /* If requested, add the shared objects' sections to the the
445 TARGET's section table. */
450 /* Figure out how many sections we'll need to add in total. */
452 for (i
= inferior
; i
; i
= i
->next
)
453 new_sections
+= (i
->sections_end
- i
->sections
);
455 if (new_sections
> 0)
457 int space
= target_resize_to_sections (target
, new_sections
);
459 for (i
= inferior
; i
; i
= i
->next
)
461 int count
= (i
->sections_end
- i
->sections
);
462 memcpy (target
->to_sections
+ space
,
464 count
* sizeof (i
->sections
[0]));
475 solib_add -- read in symbol info for newly added shared libraries
479 void solib_add (char *pattern, int from_tty, struct target_ops *TARGET)
483 Read in symbolic information for any shared objects whose names
484 match PATTERN. (If we've already read a shared object's symbol
485 info, leave it alone.) If PATTERN is zero, read them all.
487 FROM_TTY and TARGET are as described for update_solib_list, above. */
490 solib_add (char *pattern
, int from_tty
, struct target_ops
*target
)
496 char *re_err
= re_comp (pattern
);
499 error ("Invalid regexp: %s", re_err
);
502 update_solib_list (from_tty
, target
);
504 /* Walk the list of currently loaded shared libraries, and read
505 symbols for any that match the pattern --- or any whose symbols
506 aren't already loaded, if no pattern was given. */
509 int loaded_any_symbols
= 0;
511 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
512 if (! pattern
|| re_exec (gdb
->so_name
))
516 if (gdb
->symbols_loaded
)
519 printf_unfiltered ("Symbols already loaded for %s\n",
525 (symbol_add_stub
, gdb
,
526 "Error while reading shared library symbols:\n",
530 printf_unfiltered ("Loaded symbols for %s\n",
532 gdb
->symbols_loaded
= 1;
533 loaded_any_symbols
= 1;
538 if (from_tty
&& pattern
&& ! any_matches
)
540 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
542 if (loaded_any_symbols
)
544 /* Getting new symbols may change our opinion about what is
546 reinit_frame_cache ();
548 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
558 info_sharedlibrary_command -- code for "info sharedlibrary"
562 static void info_sharedlibrary_command ()
566 Walk through the shared library list and print information
567 about each attached library.
571 info_sharedlibrary_command (char *ignore
, int from_tty
)
573 register struct so_list
*so
= NULL
; /* link map state variable */
579 if (exec_bfd
== NULL
)
581 printf_unfiltered ("No executable file.\n");
585 arch_size
= bfd_get_arch_size (exec_bfd
);
586 /* Default to 32-bit in case of failure (non-elf). */
587 if (arch_size
== 32 || arch_size
== -1)
592 else if (arch_size
== 64)
598 update_solib_list (from_tty
, 0);
600 for (so
= so_list_head
; so
; so
= so
->next
)
606 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width
, "From",
607 addr_width
, "To", "Syms Read",
608 "Shared Object Library");
612 printf_unfiltered ("%-*s", addr_width
,
613 local_hex_string_custom (
614 (unsigned long) TARGET_SO_LM_ADDR (so
),
616 printf_unfiltered ("%-*s", addr_width
,
617 local_hex_string_custom ((unsigned long) so
->lmend
,
619 printf_unfiltered ("%-12s", so
->symbols_loaded
? "Yes" : "No");
620 printf_unfiltered ("%s\n", so
->so_name
);
623 if (so_list_head
== NULL
)
625 printf_unfiltered ("No shared libraries loaded at this time.\n");
633 solib_address -- check to see if an address is in a shared lib
637 char * solib_address (CORE_ADDR address)
641 Provides a hook for other gdb routines to discover whether or
642 not a particular address is within the mapped address space of
643 a shared library. Any address between the base mapping address
644 and the first address beyond the end of the last mapping, is
645 considered to be within the shared library address space, for
648 For example, this routine is called at one point to disable
649 breakpoints which are in shared libraries that are not currently
654 solib_address (CORE_ADDR address
)
656 register struct so_list
*so
= 0; /* link map state variable */
658 for (so
= so_list_head
; so
; so
= so
->next
)
660 if (TARGET_SO_LM_ADDR (so
) <= address
&& address
< so
->lmend
)
661 return (so
->so_name
);
667 /* Called by free_all_symtabs */
672 /* This function is expected to handle ELF shared libraries. It is
673 also used on Solaris, which can run either ELF or a.out binaries
674 (for compatibility with SunOS 4), both of which can use shared
675 libraries. So we don't know whether we have an ELF executable or
676 an a.out executable until the user chooses an executable file.
678 ELF shared libraries don't get mapped into the address space
679 until after the program starts, so we'd better not try to insert
680 breakpoints in them immediately. We have to wait until the
681 dynamic linker has loaded them; we'll hit a bp_shlib_event
682 breakpoint (look for calls to create_solib_event_breakpoint) when
685 SunOS shared libraries seem to be different --- they're present
686 as soon as the process begins execution, so there's no need to
687 put off inserting breakpoints. There's also nowhere to put a
688 bp_shlib_event breakpoint, so if we put it off, we'll never get
691 So: disable breakpoints only if we're using ELF shared libs. */
693 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
694 disable_breakpoints_in_shlibs (1);
698 struct so_list
*so
= so_list_head
;
699 so_list_head
= so
->next
;
703 TARGET_SO_CLEAR_SOLIB ();
707 do_clear_solib (PTR dummy
)
709 solib_cleanup_queued
= 0;
715 solib_create_inferior_hook -- shared library startup support
719 void solib_create_inferior_hook()
723 When gdb starts up the inferior, it nurses it along (through the
724 shell) until it is ready to execute it's first instruction. At this
725 point, this function gets called via expansion of the macro
726 SOLIB_CREATE_INFERIOR_HOOK. */
729 solib_create_inferior_hook (void)
731 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
739 sharedlibrary_command -- handle command to explicitly add library
743 static void sharedlibrary_command (char *args, int from_tty)
750 sharedlibrary_command (char *args
, int from_tty
)
753 solib_add (args
, from_tty
, (struct target_ops
*) 0);
758 _initialize_solib (void)
760 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
761 "Load shared object library symbols for files matching REGEXP.");
762 add_info ("sharedlibrary", info_sharedlibrary_command
,
763 "Status of loaded shared object libraries.");
766 (add_set_cmd ("auto-solib-add", class_support
, var_zinteger
,
767 (char *) &auto_solib_add
,
768 "Set autoloading of shared library symbols.\n\
769 If nonzero, symbols from all shared object libraries will be loaded\n\
770 automatically when the inferior begins execution or when the dynamic linker\n\
771 informs gdb that a new library has been loaded. Otherwise, symbols\n\
772 must be loaded manually, using `sharedlibrary'.",
777 (add_set_cmd ("solib-absolute-prefix", class_support
, var_filename
,
778 (char *) &solib_absolute_prefix
,
779 "Set prefix for loading absolute shared library symbol files.\n\
780 For other (relative) files, you can add values using `set solib-search-path'.",
784 (add_set_cmd ("solib-search-path", class_support
, var_string
,
785 (char *) &solib_search_path
,
786 "Set the search path for loading non-absolute shared library symbol files.\n\
787 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",