1 /* Handle SunOS shared libraries for GDB, the GNU Debugger.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
4 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"
28 #include <sys/param.h>
31 /* SunOS shared libs need the nlist structure. */
45 /* Link map info to include in an allocated so_list entry */
49 /* Pointer to copy of link map from inferior. The type is char *
50 rather than void *, so that we may use byte offsets to find the
51 various fields without the need for a cast. */
56 /* Symbols which are used to locate the base of the link map structures. */
58 static char *debug_base_symbols[] =
65 static char *main_name_list[] =
71 /* Macro to extract an address from a solib structure.
72 When GDB is configured for some 32-bit targets (e.g. Solaris 2.7
73 sparc), BFD is configured to handle 64-bit targets, so CORE_ADDR is
74 64 bits. We have to extract only the significant bits of addresses
75 to get the right address when accessing the core file BFD. */
77 #define SOLIB_EXTRACT_ADDRESS(MEMBER) \
78 extract_address (&(MEMBER), sizeof (MEMBER))
80 /* local data declarations */
82 static struct link_dynamic dynamic_copy;
83 static struct link_dynamic_2 ld_2_copy;
84 static struct ld_debug debug_copy;
85 static CORE_ADDR debug_addr;
86 static CORE_ADDR flag_addr;
89 #define offsetof(TYPE, MEMBER) ((unsigned long) &((TYPE *)0)->MEMBER)
91 #define fieldsize(TYPE, MEMBER) (sizeof (((TYPE *)0)->MEMBER))
93 /* link map access functions */
96 LM_ADDR (struct so_list *so)
98 int lm_addr_offset = offsetof (struct link_map, lm_addr);
99 int lm_addr_size = fieldsize (struct link_map, lm_addr);
101 return (CORE_ADDR) extract_signed_integer (so->lm_info->lm + lm_addr_offset,
106 LM_NEXT (struct so_list *so)
108 int lm_next_offset = offsetof (struct link_map, lm_next);
109 int lm_next_size = fieldsize (struct link_map, lm_next);
111 return extract_address (so->lm_info->lm + lm_next_offset, lm_next_size);
115 LM_NAME (struct so_list *so)
117 int lm_name_offset = offsetof (struct link_map, lm_name);
118 int lm_name_size = fieldsize (struct link_map, lm_name);
120 return extract_address (so->lm_info->lm + lm_name_offset, lm_name_size);
123 static CORE_ADDR debug_base; /* Base of dynamic linker structures */
125 /* Local function prototypes */
127 static int match_main (char *);
129 /* Allocate the runtime common object file. */
132 allocate_rt_common_objfile (void)
134 struct objfile *objfile;
135 struct objfile *last_one;
137 objfile = (struct objfile *) xmalloc (sizeof (struct objfile));
138 memset (objfile, 0, sizeof (struct objfile));
140 objfile->psymbol_cache = bcache_xmalloc ();
141 objfile->macro_cache = bcache_xmalloc ();
142 obstack_specify_allocation (&objfile->psymbol_obstack, 0, 0, xmalloc,
144 obstack_specify_allocation (&objfile->symbol_obstack, 0, 0, xmalloc,
146 obstack_specify_allocation (&objfile->type_obstack, 0, 0, xmalloc,
148 objfile->name = mstrsave (objfile->md, "rt_common");
150 /* Add this file onto the tail of the linked list of other such files. */
152 objfile->next = NULL;
153 if (object_files == NULL)
154 object_files = objfile;
157 for (last_one = object_files;
159 last_one = last_one->next);
160 last_one->next = objfile;
163 rt_common_objfile = objfile;
166 /* Read all dynamically loaded common symbol definitions from the inferior
167 and put them into the minimal symbol table for the runtime common
171 solib_add_common_symbols (CORE_ADDR rtc_symp)
173 struct rtc_symb inferior_rtc_symb;
174 struct nlist inferior_rtc_nlist;
178 /* Remove any runtime common symbols from previous runs. */
180 if (rt_common_objfile != NULL && rt_common_objfile->minimal_symbol_count)
182 obstack_free (&rt_common_objfile->symbol_obstack, 0);
183 obstack_specify_allocation (&rt_common_objfile->symbol_obstack, 0, 0,
185 rt_common_objfile->minimal_symbol_count = 0;
186 rt_common_objfile->msymbols = NULL;
189 init_minimal_symbol_collection ();
190 make_cleanup_discard_minimal_symbols ();
194 read_memory (rtc_symp,
195 (char *) &inferior_rtc_symb,
196 sizeof (inferior_rtc_symb));
197 read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_sp),
198 (char *) &inferior_rtc_nlist,
199 sizeof (inferior_rtc_nlist));
200 if (inferior_rtc_nlist.n_type == N_COMM)
202 /* FIXME: The length of the symbol name is not available, but in the
203 current implementation the common symbol is allocated immediately
204 behind the name of the symbol. */
205 len = inferior_rtc_nlist.n_value - inferior_rtc_nlist.n_un.n_strx;
207 name = xmalloc (len);
208 read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_nlist.n_un.n_name),
211 /* Allocate the runtime common objfile if necessary. */
212 if (rt_common_objfile == NULL)
213 allocate_rt_common_objfile ();
215 prim_record_minimal_symbol (name, inferior_rtc_nlist.n_value,
216 mst_bss, rt_common_objfile);
219 rtc_symp = SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_next);
222 /* Install any minimal symbols that have been collected as the current
223 minimal symbols for the runtime common objfile. */
225 install_minimal_symbols (rt_common_objfile);
233 locate_base -- locate the base address of dynamic linker structs
237 CORE_ADDR locate_base (void)
241 For both the SunOS and SVR4 shared library implementations, if the
242 inferior executable has been linked dynamically, there is a single
243 address somewhere in the inferior's data space which is the key to
244 locating all of the dynamic linker's runtime structures. This
245 address is the value of the debug base symbol. The job of this
246 function is to find and return that address, or to return 0 if there
247 is no such address (the executable is statically linked for example).
249 For SunOS, the job is almost trivial, since the dynamic linker and
250 all of it's structures are statically linked to the executable at
251 link time. Thus the symbol for the address we are looking for has
252 already been added to the minimal symbol table for the executable's
253 objfile at the time the symbol file's symbols were read, and all we
254 have to do is look it up there. Note that we explicitly do NOT want
255 to find the copies in the shared library.
257 The SVR4 version is a bit more complicated because the address
258 is contained somewhere in the dynamic info section. We have to go
259 to a lot more work to discover the address of the debug base symbol.
260 Because of this complexity, we cache the value we find and return that
261 value on subsequent invocations. Note there is no copy in the
262 executable symbol tables.
269 struct minimal_symbol *msymbol;
270 CORE_ADDR address = 0;
273 /* For SunOS, we want to limit the search for the debug base symbol to the
274 executable being debugged, since there is a duplicate named symbol in the
275 shared library. We don't want the shared library versions. */
277 for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)
279 msymbol = lookup_minimal_symbol (*symbolp, NULL, symfile_objfile);
280 if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))
282 address = SYMBOL_VALUE_ADDRESS (msymbol);
293 first_link_map_member -- locate first member in dynamic linker's map
297 static CORE_ADDR first_link_map_member (void)
301 Find the first element in the inferior's dynamic link map, and
302 return its address in the inferior. This function doesn't copy the
303 link map entry itself into our address space; current_sos actually
307 first_link_map_member (void)
311 read_memory (debug_base, (char *) &dynamic_copy, sizeof (dynamic_copy));
312 if (dynamic_copy.ld_version >= 2)
314 /* It is a version that we can deal with, so read in the secondary
315 structure and find the address of the link map list from it. */
316 read_memory (SOLIB_EXTRACT_ADDRESS (dynamic_copy.ld_un.ld_2),
317 (char *) &ld_2_copy, sizeof (struct link_dynamic_2));
318 lm = SOLIB_EXTRACT_ADDRESS (ld_2_copy.ld_loaded);
324 open_symbol_file_object (void *from_ttyp)
332 current_sos -- build a list of currently loaded shared objects
336 struct so_list *current_sos ()
340 Build a list of `struct so_list' objects describing the shared
341 objects currently loaded in the inferior. This list does not
342 include an entry for the main executable file.
344 Note that we only gather information directly available from the
345 inferior --- we don't examine any of the shared library files
346 themselves. The declaration of `struct so_list' says which fields
347 we provide values for. */
349 static struct so_list *
350 sunos_current_sos (void)
353 struct so_list *head = 0;
354 struct so_list **link_ptr = &head;
358 /* Make sure we've looked up the inferior's dynamic linker's base
362 debug_base = locate_base ();
364 /* If we can't find the dynamic linker's base structure, this
365 must not be a dynamically linked executable. Hmm. */
370 /* Walk the inferior's link map list, and build our list of
371 `struct so_list' nodes. */
372 lm = first_link_map_member ();
376 = (struct so_list *) xmalloc (sizeof (struct so_list));
377 struct cleanup *old_chain = make_cleanup (xfree, new);
379 memset (new, 0, sizeof (*new));
381 new->lm_info = xmalloc (sizeof (struct lm_info));
382 make_cleanup (xfree, new->lm_info);
384 new->lm_info->lm = xmalloc (sizeof (struct link_map));
385 make_cleanup (xfree, new->lm_info->lm);
386 memset (new->lm_info->lm, 0, sizeof (struct link_map));
388 read_memory (lm, new->lm_info->lm, sizeof (struct link_map));
392 /* Extract this shared object's name. */
393 target_read_string (LM_NAME (new), &buffer,
394 SO_NAME_MAX_PATH_SIZE - 1, &errcode);
397 warning ("current_sos: Can't read pathname for load map: %s\n",
398 safe_strerror (errcode));
402 strncpy (new->so_name, buffer, SO_NAME_MAX_PATH_SIZE - 1);
403 new->so_name[SO_NAME_MAX_PATH_SIZE - 1] = '\0';
405 strcpy (new->so_original_name, new->so_name);
408 /* If this entry has no name, or its name matches the name
409 for the main executable, don't include it in the list. */
410 if (! new->so_name[0]
411 || match_main (new->so_name))
417 link_ptr = &new->next;
420 discard_cleanups (old_chain);
427 /* On some systems, the only way to recognize the link map entry for
428 the main executable file is by looking at its name. Return
429 non-zero iff SONAME matches one of the known main executable names. */
432 match_main (char *soname)
436 for (mainp = main_name_list; *mainp != NULL; mainp++)
438 if (strcmp (soname, *mainp) == 0)
447 sunos_in_dynsym_resolve_code (CORE_ADDR pc)
456 disable_break -- remove the "mapping changed" breakpoint
460 static int disable_break ()
464 Removes the breakpoint that gets hit when the dynamic linker
465 completes a mapping change.
472 CORE_ADDR breakpoint_addr; /* Address where end bkpt is set */
476 /* Read the debugger structure from the inferior to retrieve the
477 address of the breakpoint and the original contents of the
478 breakpoint address. Remove the breakpoint by writing the original
481 read_memory (debug_addr, (char *) &debug_copy, sizeof (debug_copy));
483 /* Set `in_debugger' to zero now. */
485 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
487 breakpoint_addr = SOLIB_EXTRACT_ADDRESS (debug_copy.ldd_bp_addr);
488 write_memory (breakpoint_addr, (char *) &debug_copy.ldd_bp_inst,
489 sizeof (debug_copy.ldd_bp_inst));
491 /* For the SVR4 version, we always know the breakpoint address. For the
492 SunOS version we don't know it until the above code is executed.
493 Grumble if we are stopped anywhere besides the breakpoint address. */
495 if (stop_pc != breakpoint_addr)
497 warning ("stopped at unknown breakpoint while handling shared libraries");
508 enable_break -- arrange for dynamic linker to hit breakpoint
512 int enable_break (void)
516 Both the SunOS and the SVR4 dynamic linkers have, as part of their
517 debugger interface, support for arranging for the inferior to hit
518 a breakpoint after mapping in the shared libraries. This function
519 enables that breakpoint.
521 For SunOS, there is a special flag location (in_debugger) which we
522 set to 1. When the dynamic linker sees this flag set, it will set
523 a breakpoint at a location known only to itself, after saving the
524 original contents of that place and the breakpoint address itself,
525 in it's own internal structures. When we resume the inferior, it
526 will eventually take a SIGTRAP when it runs into the breakpoint.
527 We handle this (in a different place) by restoring the contents of
528 the breakpointed location (which is only known after it stops),
529 chasing around to locate the shared libraries that have been
530 loaded, then resuming.
532 For SVR4, the debugger interface structure contains a member (r_brk)
533 which is statically initialized at the time the shared library is
534 built, to the offset of a function (_r_debug_state) which is guaran-
535 teed to be called once before mapping in a library, and again when
536 the mapping is complete. At the time we are examining this member,
537 it contains only the unrelocated offset of the function, so we have
538 to do our own relocation. Later, when the dynamic linker actually
539 runs, it relocates r_brk to be the actual address of _r_debug_state().
541 The debugger interface structure also contains an enumeration which
542 is set to either RT_ADD or RT_DELETE prior to changing the mapping,
543 depending upon whether or not the library is being mapped or unmapped,
544 and then set to RT_CONSISTENT after the library is mapped/unmapped.
554 /* Get link_dynamic structure */
556 j = target_read_memory (debug_base, (char *) &dynamic_copy,
557 sizeof (dynamic_copy));
564 /* Calc address of debugger interface structure */
566 debug_addr = SOLIB_EXTRACT_ADDRESS (dynamic_copy.ldd);
568 /* Calc address of `in_debugger' member of debugger interface structure */
570 flag_addr = debug_addr + (CORE_ADDR) ((char *) &debug_copy.ldd_in_debugger -
571 (char *) &debug_copy);
573 /* Write a value of 1 to this member. */
576 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
586 special_symbol_handling -- additional shared library symbol handling
590 void special_symbol_handling ()
594 Once the symbols from a shared object have been loaded in the usual
595 way, we are called to do any system specific symbol handling that
598 For SunOS4, this consists of grunging around in the dynamic
599 linkers structures to find symbol definitions for "common" symbols
600 and adding them to the minimal symbol table for the runtime common
606 sunos_special_symbol_handling (void)
612 /* Get link_dynamic structure */
614 j = target_read_memory (debug_base, (char *) &dynamic_copy,
615 sizeof (dynamic_copy));
622 /* Calc address of debugger interface structure */
623 /* FIXME, this needs work for cross-debugging of core files
624 (byteorder, size, alignment, etc). */
626 debug_addr = SOLIB_EXTRACT_ADDRESS (dynamic_copy.ldd);
629 /* Read the debugger structure from the inferior, just to make sure
630 we have a current copy. */
632 j = target_read_memory (debug_addr, (char *) &debug_copy,
633 sizeof (debug_copy));
635 return; /* unreadable */
637 /* Get common symbol definitions for the loaded object. */
639 if (debug_copy.ldd_cp)
641 solib_add_common_symbols (SOLIB_EXTRACT_ADDRESS (debug_copy.ldd_cp));
645 /* Relocate the main executable. This function should be called upon
646 stopping the inferior process at the entry point to the program.
647 The entry point from BFD is compared to the PC and if they are
648 different, the main executable is relocated by the proper amount.
650 As written it will only attempt to relocate executables which
651 lack interpreter sections. It seems likely that only dynamic
652 linker executables will get relocated, though it should work
653 properly for a position-independent static executable as well. */
656 sunos_relocate_main_executable (void)
658 asection *interp_sect;
659 CORE_ADDR pc = read_pc ();
661 /* Decide if the objfile needs to be relocated. As indicated above,
662 we will only be here when execution is stopped at the beginning
663 of the program. Relocation is necessary if the address at which
664 we are presently stopped differs from the start address stored in
665 the executable AND there's no interpreter section. The condition
666 regarding the interpreter section is very important because if
667 there *is* an interpreter section, execution will begin there
668 instead. When there is an interpreter section, the start address
669 is (presumably) used by the interpreter at some point to start
670 execution of the program.
672 If there is an interpreter, it is normal for it to be set to an
673 arbitrary address at the outset. The job of finding it is
674 handled in enable_break().
676 So, to summarize, relocations are necessary when there is no
677 interpreter section and the start address obtained from the
678 executable is different from the address at which GDB is
681 [ The astute reader will note that we also test to make sure that
682 the executable in question has the DYNAMIC flag set. It is my
683 opinion that this test is unnecessary (undesirable even). It
684 was added to avoid inadvertent relocation of an executable
685 whose e_type member in the ELF header is not ET_DYN. There may
686 be a time in the future when it is desirable to do relocations
687 on other types of files as well in which case this condition
688 should either be removed or modified to accomodate the new file
689 type. (E.g, an ET_EXEC executable which has been built to be
690 position-independent could safely be relocated by the OS if
691 desired. It is true that this violates the ABI, but the ABI
692 has been known to be bent from time to time.) - Kevin, Nov 2000. ]
695 interp_sect = bfd_get_section_by_name (exec_bfd, ".interp");
696 if (interp_sect == NULL
697 && (bfd_get_file_flags (exec_bfd) & DYNAMIC) != 0
698 && bfd_get_start_address (exec_bfd) != pc)
700 struct cleanup *old_chain;
701 struct section_offsets *new_offsets;
703 CORE_ADDR displacement;
705 /* It is necessary to relocate the objfile. The amount to
706 relocate by is simply the address at which we are stopped
707 minus the starting address from the executable.
709 We relocate all of the sections by the same amount. This
710 behavior is mandated by recent editions of the System V ABI.
711 According to the System V Application Binary Interface,
712 Edition 4.1, page 5-5:
714 ... Though the system chooses virtual addresses for
715 individual processes, it maintains the segments' relative
716 positions. Because position-independent code uses relative
717 addressesing between segments, the difference between
718 virtual addresses in memory must match the difference
719 between virtual addresses in the file. The difference
720 between the virtual address of any segment in memory and
721 the corresponding virtual address in the file is thus a
722 single constant value for any one executable or shared
723 object in a given process. This difference is the base
724 address. One use of the base address is to relocate the
725 memory image of the program during dynamic linking.
727 The same language also appears in Edition 4.0 of the System V
728 ABI and is left unspecified in some of the earlier editions. */
730 displacement = pc - bfd_get_start_address (exec_bfd);
733 new_offsets = xcalloc (symfile_objfile->num_sections,
734 sizeof (struct section_offsets));
735 old_chain = make_cleanup (xfree, new_offsets);
737 for (i = 0; i < symfile_objfile->num_sections; i++)
739 if (displacement != ANOFFSET (symfile_objfile->section_offsets, i))
741 new_offsets->offsets[i] = displacement;
745 objfile_relocate (symfile_objfile, new_offsets);
747 do_cleanups (old_chain);
755 sunos_solib_create_inferior_hook -- shared library startup support
759 void sunos_solib_create_inferior_hook()
763 When gdb starts up the inferior, it nurses it along (through the
764 shell) until it is ready to execute it's first instruction. At this
765 point, this function gets called via expansion of the macro
766 SOLIB_CREATE_INFERIOR_HOOK.
768 For SunOS executables, this first instruction is typically the
769 one at "_start", or a similar text label, regardless of whether
770 the executable is statically or dynamically linked. The runtime
771 startup code takes care of dynamically linking in any shared
772 libraries, once gdb allows the inferior to continue.
774 For SVR4 executables, this first instruction is either the first
775 instruction in the dynamic linker (for dynamically linked
776 executables) or the instruction at "start" for statically linked
777 executables. For dynamically linked executables, the system
778 first exec's /lib/libc.so.N, which contains the dynamic linker,
779 and starts it running. The dynamic linker maps in any needed
780 shared libraries, maps in the actual user executable, and then
781 jumps to "start" in the user executable.
783 For both SunOS shared libraries, and SVR4 shared libraries, we
784 can arrange to cooperate with the dynamic linker to discover the
785 names of shared libraries that are dynamically linked, and the
786 base addresses to which they are linked.
788 This function is responsible for discovering those names and
789 addresses, and saving sufficient information about them to allow
790 their symbols to be read at a later time.
794 Between enable_break() and disable_break(), this code does not
795 properly handle hitting breakpoints which the user might have
796 set in the startup code or in the dynamic linker itself. Proper
797 handling will probably have to wait until the implementation is
798 changed to use the "breakpoint handler function" method.
800 Also, what if child has exit()ed? Must exit loop somehow.
804 sunos_solib_create_inferior_hook (void)
806 /* Relocate the main executable if necessary. */
807 sunos_relocate_main_executable ();
809 if ((debug_base = locate_base ()) == 0)
811 /* Can't find the symbol or the executable is statically linked. */
815 if (!enable_break ())
817 warning ("shared library handler failed to enable breakpoint");
821 /* SCO and SunOS need the loop below, other systems should be using the
822 special shared library breakpoints and the shared library breakpoint
825 Now run the target. It will eventually hit the breakpoint, at
826 which point all of the libraries will have been mapped in and we
827 can go groveling around in the dynamic linker structures to find
828 out what we need to know about them. */
830 clear_proceed_status ();
831 stop_soon_quietly = 1;
832 stop_signal = TARGET_SIGNAL_0;
835 target_resume (pid_to_ptid (-1), 0, stop_signal);
836 wait_for_inferior ();
838 while (stop_signal != TARGET_SIGNAL_TRAP);
839 stop_soon_quietly = 0;
841 /* We are now either at the "mapping complete" breakpoint (or somewhere
842 else, a condition we aren't prepared to deal with anyway), so adjust
843 the PC as necessary after a breakpoint, disable the breakpoint, and
844 add any shared libraries that were mapped in. */
846 if (DECR_PC_AFTER_BREAK)
848 stop_pc -= DECR_PC_AFTER_BREAK;
849 write_register (PC_REGNUM, stop_pc);
852 if (!disable_break ())
854 warning ("shared library handler failed to disable breakpoint");
857 solib_add ((char *) 0, 0, (struct target_ops *) 0, auto_solib_add);
861 sunos_clear_solib (void)
867 sunos_free_so (struct so_list *so)
869 xfree (so->lm_info->lm);
874 sunos_relocate_section_addresses (struct so_list *so,
875 struct section_table *sec)
877 sec->addr += LM_ADDR (so);
878 sec->endaddr += LM_ADDR (so);
881 static struct target_so_ops sunos_so_ops;
884 _initialize_sunos_solib (void)
886 sunos_so_ops.relocate_section_addresses = sunos_relocate_section_addresses;
887 sunos_so_ops.free_so = sunos_free_so;
888 sunos_so_ops.clear_solib = sunos_clear_solib;
889 sunos_so_ops.solib_create_inferior_hook = sunos_solib_create_inferior_hook;
890 sunos_so_ops.special_symbol_handling = sunos_special_symbol_handling;
891 sunos_so_ops.current_sos = sunos_current_sos;
892 sunos_so_ops.open_symbol_file_object = open_symbol_file_object;
893 sunos_so_ops.in_dynsym_resolve_code = sunos_in_dynsym_resolve_code;
895 /* FIXME: Don't do this here. *_gdbarch_init() should set so_ops. */
896 current_target_so_ops = &sunos_so_ops;