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. When GDB is
72 configured for some 32-bit targets (e.g. Solaris 2.7 sparc), BFD is
73 configured to handle 64-bit targets, so CORE_ADDR is 64 bits. We
74 have to extract only the significant bits of addresses to get the
75 right address when accessing the core file BFD.
77 Assume that the address is unsigned. */
79 #define SOLIB_EXTRACT_ADDRESS(MEMBER) \
80 extract_unsigned_integer (&(MEMBER), sizeof (MEMBER))
82 /* local data declarations */
84 static struct link_dynamic dynamic_copy;
85 static struct link_dynamic_2 ld_2_copy;
86 static struct ld_debug debug_copy;
87 static CORE_ADDR debug_addr;
88 static CORE_ADDR flag_addr;
91 #define offsetof(TYPE, MEMBER) ((unsigned long) &((TYPE *)0)->MEMBER)
93 #define fieldsize(TYPE, MEMBER) (sizeof (((TYPE *)0)->MEMBER))
95 /* link map access functions */
98 LM_ADDR (struct so_list *so)
100 int lm_addr_offset = offsetof (struct link_map, lm_addr);
101 int lm_addr_size = fieldsize (struct link_map, lm_addr);
103 return (CORE_ADDR) extract_signed_integer (so->lm_info->lm + lm_addr_offset,
108 LM_NEXT (struct so_list *so)
110 int lm_next_offset = offsetof (struct link_map, lm_next);
111 int lm_next_size = fieldsize (struct link_map, lm_next);
113 /* Assume that the address is unsigned. */
114 return extract_unsigned_integer (so->lm_info->lm + lm_next_offset,
119 LM_NAME (struct so_list *so)
121 int lm_name_offset = offsetof (struct link_map, lm_name);
122 int lm_name_size = fieldsize (struct link_map, lm_name);
124 /* Assume that the address is unsigned. */
125 return extract_unsigned_integer (so->lm_info->lm + lm_name_offset,
129 static CORE_ADDR debug_base; /* Base of dynamic linker structures */
131 /* Local function prototypes */
133 static int match_main (char *);
135 /* Allocate the runtime common object file. */
138 allocate_rt_common_objfile (void)
140 struct objfile *objfile;
141 struct objfile *last_one;
143 objfile = (struct objfile *) xmalloc (sizeof (struct objfile));
144 memset (objfile, 0, sizeof (struct objfile));
146 objfile->psymbol_cache = bcache_xmalloc ();
147 objfile->macro_cache = bcache_xmalloc ();
148 obstack_init (&objfile->objfile_obstack);
149 objfile->name = mstrsave (objfile->md, "rt_common");
151 /* Add this file onto the tail of the linked list of other such files. */
153 objfile->next = NULL;
154 if (object_files == NULL)
155 object_files = objfile;
158 for (last_one = object_files;
160 last_one = last_one->next);
161 last_one->next = objfile;
164 rt_common_objfile = objfile;
167 /* Read all dynamically loaded common symbol definitions from the inferior
168 and put them into the minimal symbol table for the runtime common
172 solib_add_common_symbols (CORE_ADDR rtc_symp)
174 struct rtc_symb inferior_rtc_symb;
175 struct nlist inferior_rtc_nlist;
179 /* Remove any runtime common symbols from previous runs. */
181 if (rt_common_objfile != NULL && rt_common_objfile->minimal_symbol_count)
183 obstack_free (&rt_common_objfile->objfile_obstack, 0);
184 obstack_init (&rt_common_objfile->objfile_obstack);
185 rt_common_objfile->minimal_symbol_count = 0;
186 rt_common_objfile->msymbols = NULL;
187 terminate_minimal_symbol_table (rt_common_objfile);
190 init_minimal_symbol_collection ();
191 make_cleanup_discard_minimal_symbols ();
195 read_memory (rtc_symp,
196 (char *) &inferior_rtc_symb,
197 sizeof (inferior_rtc_symb));
198 read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_sp),
199 (char *) &inferior_rtc_nlist,
200 sizeof (inferior_rtc_nlist));
201 if (inferior_rtc_nlist.n_type == N_COMM)
203 /* FIXME: The length of the symbol name is not available, but in the
204 current implementation the common symbol is allocated immediately
205 behind the name of the symbol. */
206 len = inferior_rtc_nlist.n_value - inferior_rtc_nlist.n_un.n_strx;
208 name = xmalloc (len);
209 read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_nlist.n_un.n_name),
212 /* Allocate the runtime common objfile if necessary. */
213 if (rt_common_objfile == NULL)
214 allocate_rt_common_objfile ();
216 prim_record_minimal_symbol (name, inferior_rtc_nlist.n_value,
217 mst_bss, rt_common_objfile);
220 rtc_symp = SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_next);
223 /* Install any minimal symbols that have been collected as the current
224 minimal symbols for the runtime common objfile. */
226 install_minimal_symbols (rt_common_objfile);
234 locate_base -- locate the base address of dynamic linker structs
238 CORE_ADDR locate_base (void)
242 For both the SunOS and SVR4 shared library implementations, if the
243 inferior executable has been linked dynamically, there is a single
244 address somewhere in the inferior's data space which is the key to
245 locating all of the dynamic linker's runtime structures. This
246 address is the value of the debug base symbol. The job of this
247 function is to find and return that address, or to return 0 if there
248 is no such address (the executable is statically linked for example).
250 For SunOS, the job is almost trivial, since the dynamic linker and
251 all of it's structures are statically linked to the executable at
252 link time. Thus the symbol for the address we are looking for has
253 already been added to the minimal symbol table for the executable's
254 objfile at the time the symbol file's symbols were read, and all we
255 have to do is look it up there. Note that we explicitly do NOT want
256 to find the copies in the shared library.
258 The SVR4 version is a bit more complicated because the address
259 is contained somewhere in the dynamic info section. We have to go
260 to a lot more work to discover the address of the debug base symbol.
261 Because of this complexity, we cache the value we find and return that
262 value on subsequent invocations. Note there is no copy in the
263 executable symbol tables.
270 struct minimal_symbol *msymbol;
271 CORE_ADDR address = 0;
274 /* For SunOS, we want to limit the search for the debug base symbol to the
275 executable being debugged, since there is a duplicate named symbol in the
276 shared library. We don't want the shared library versions. */
278 for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)
280 msymbol = lookup_minimal_symbol (*symbolp, NULL, symfile_objfile);
281 if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))
283 address = SYMBOL_VALUE_ADDRESS (msymbol);
294 first_link_map_member -- locate first member in dynamic linker's map
298 static CORE_ADDR first_link_map_member (void)
302 Find the first element in the inferior's dynamic link map, and
303 return its address in the inferior. This function doesn't copy the
304 link map entry itself into our address space; current_sos actually
308 first_link_map_member (void)
312 read_memory (debug_base, (char *) &dynamic_copy, sizeof (dynamic_copy));
313 if (dynamic_copy.ld_version >= 2)
315 /* It is a version that we can deal with, so read in the secondary
316 structure and find the address of the link map list from it. */
317 read_memory (SOLIB_EXTRACT_ADDRESS (dynamic_copy.ld_un.ld_2),
318 (char *) &ld_2_copy, sizeof (struct link_dynamic_2));
319 lm = SOLIB_EXTRACT_ADDRESS (ld_2_copy.ld_loaded);
325 open_symbol_file_object (void *from_ttyp)
333 current_sos -- build a list of currently loaded shared objects
337 struct so_list *current_sos ()
341 Build a list of `struct so_list' objects describing the shared
342 objects currently loaded in the inferior. This list does not
343 include an entry for the main executable file.
345 Note that we only gather information directly available from the
346 inferior --- we don't examine any of the shared library files
347 themselves. The declaration of `struct so_list' says which fields
348 we provide values for. */
350 static struct so_list *
351 sunos_current_sos (void)
354 struct so_list *head = 0;
355 struct so_list **link_ptr = &head;
359 /* Make sure we've looked up the inferior's dynamic linker's base
363 debug_base = locate_base ();
365 /* If we can't find the dynamic linker's base structure, this
366 must not be a dynamically linked executable. Hmm. */
371 /* Walk the inferior's link map list, and build our list of
372 `struct so_list' nodes. */
373 lm = first_link_map_member ();
377 = (struct so_list *) xmalloc (sizeof (struct so_list));
378 struct cleanup *old_chain = make_cleanup (xfree, new);
380 memset (new, 0, sizeof (*new));
382 new->lm_info = xmalloc (sizeof (struct lm_info));
383 make_cleanup (xfree, new->lm_info);
385 new->lm_info->lm = xmalloc (sizeof (struct link_map));
386 make_cleanup (xfree, new->lm_info->lm);
387 memset (new->lm_info->lm, 0, sizeof (struct link_map));
389 read_memory (lm, new->lm_info->lm, sizeof (struct link_map));
393 /* Extract this shared object's name. */
394 target_read_string (LM_NAME (new), &buffer,
395 SO_NAME_MAX_PATH_SIZE - 1, &errcode);
398 warning ("current_sos: Can't read pathname for load map: %s\n",
399 safe_strerror (errcode));
403 strncpy (new->so_name, buffer, SO_NAME_MAX_PATH_SIZE - 1);
404 new->so_name[SO_NAME_MAX_PATH_SIZE - 1] = '\0';
406 strcpy (new->so_original_name, new->so_name);
409 /* If this entry has no name, or its name matches the name
410 for the main executable, don't include it in the list. */
411 if (! new->so_name[0]
412 || match_main (new->so_name))
418 link_ptr = &new->next;
421 discard_cleanups (old_chain);
428 /* On some systems, the only way to recognize the link map entry for
429 the main executable file is by looking at its name. Return
430 non-zero iff SONAME matches one of the known main executable names. */
433 match_main (char *soname)
437 for (mainp = main_name_list; *mainp != NULL; mainp++)
439 if (strcmp (soname, *mainp) == 0)
448 sunos_in_dynsym_resolve_code (CORE_ADDR pc)
457 disable_break -- remove the "mapping changed" breakpoint
461 static int disable_break ()
465 Removes the breakpoint that gets hit when the dynamic linker
466 completes a mapping change.
473 CORE_ADDR breakpoint_addr; /* Address where end bkpt is set */
477 /* Read the debugger structure from the inferior to retrieve the
478 address of the breakpoint and the original contents of the
479 breakpoint address. Remove the breakpoint by writing the original
482 read_memory (debug_addr, (char *) &debug_copy, sizeof (debug_copy));
484 /* Set `in_debugger' to zero now. */
486 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
488 breakpoint_addr = SOLIB_EXTRACT_ADDRESS (debug_copy.ldd_bp_addr);
489 write_memory (breakpoint_addr, (char *) &debug_copy.ldd_bp_inst,
490 sizeof (debug_copy.ldd_bp_inst));
492 /* For the SVR4 version, we always know the breakpoint address. For the
493 SunOS version we don't know it until the above code is executed.
494 Grumble if we are stopped anywhere besides the breakpoint address. */
496 if (stop_pc != breakpoint_addr)
498 warning ("stopped at unknown breakpoint while handling shared libraries");
509 enable_break -- arrange for dynamic linker to hit breakpoint
513 int enable_break (void)
517 Both the SunOS and the SVR4 dynamic linkers have, as part of their
518 debugger interface, support for arranging for the inferior to hit
519 a breakpoint after mapping in the shared libraries. This function
520 enables that breakpoint.
522 For SunOS, there is a special flag location (in_debugger) which we
523 set to 1. When the dynamic linker sees this flag set, it will set
524 a breakpoint at a location known only to itself, after saving the
525 original contents of that place and the breakpoint address itself,
526 in it's own internal structures. When we resume the inferior, it
527 will eventually take a SIGTRAP when it runs into the breakpoint.
528 We handle this (in a different place) by restoring the contents of
529 the breakpointed location (which is only known after it stops),
530 chasing around to locate the shared libraries that have been
531 loaded, then resuming.
533 For SVR4, the debugger interface structure contains a member (r_brk)
534 which is statically initialized at the time the shared library is
535 built, to the offset of a function (_r_debug_state) which is guaran-
536 teed to be called once before mapping in a library, and again when
537 the mapping is complete. At the time we are examining this member,
538 it contains only the unrelocated offset of the function, so we have
539 to do our own relocation. Later, when the dynamic linker actually
540 runs, it relocates r_brk to be the actual address of _r_debug_state().
542 The debugger interface structure also contains an enumeration which
543 is set to either RT_ADD or RT_DELETE prior to changing the mapping,
544 depending upon whether or not the library is being mapped or unmapped,
545 and then set to RT_CONSISTENT after the library is mapped/unmapped.
555 /* Get link_dynamic structure */
557 j = target_read_memory (debug_base, (char *) &dynamic_copy,
558 sizeof (dynamic_copy));
565 /* Calc address of debugger interface structure */
567 debug_addr = SOLIB_EXTRACT_ADDRESS (dynamic_copy.ldd);
569 /* Calc address of `in_debugger' member of debugger interface structure */
571 flag_addr = debug_addr + (CORE_ADDR) ((char *) &debug_copy.ldd_in_debugger -
572 (char *) &debug_copy);
574 /* Write a value of 1 to this member. */
577 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
587 special_symbol_handling -- additional shared library symbol handling
591 void special_symbol_handling ()
595 Once the symbols from a shared object have been loaded in the usual
596 way, we are called to do any system specific symbol handling that
599 For SunOS4, this consists of grunging around in the dynamic
600 linkers structures to find symbol definitions for "common" symbols
601 and adding them to the minimal symbol table for the runtime common
607 sunos_special_symbol_handling (void)
613 /* Get link_dynamic structure */
615 j = target_read_memory (debug_base, (char *) &dynamic_copy,
616 sizeof (dynamic_copy));
623 /* Calc address of debugger interface structure */
624 /* FIXME, this needs work for cross-debugging of core files
625 (byteorder, size, alignment, etc). */
627 debug_addr = SOLIB_EXTRACT_ADDRESS (dynamic_copy.ldd);
630 /* Read the debugger structure from the inferior, just to make sure
631 we have a current copy. */
633 j = target_read_memory (debug_addr, (char *) &debug_copy,
634 sizeof (debug_copy));
636 return; /* unreadable */
638 /* Get common symbol definitions for the loaded object. */
640 if (debug_copy.ldd_cp)
642 solib_add_common_symbols (SOLIB_EXTRACT_ADDRESS (debug_copy.ldd_cp));
646 /* Relocate the main executable. This function should be called upon
647 stopping the inferior process at the entry point to the program.
648 The entry point from BFD is compared to the PC and if they are
649 different, the main executable is relocated by the proper amount.
651 As written it will only attempt to relocate executables which
652 lack interpreter sections. It seems likely that only dynamic
653 linker executables will get relocated, though it should work
654 properly for a position-independent static executable as well. */
657 sunos_relocate_main_executable (void)
659 asection *interp_sect;
660 CORE_ADDR pc = read_pc ();
662 /* Decide if the objfile needs to be relocated. As indicated above,
663 we will only be here when execution is stopped at the beginning
664 of the program. Relocation is necessary if the address at which
665 we are presently stopped differs from the start address stored in
666 the executable AND there's no interpreter section. The condition
667 regarding the interpreter section is very important because if
668 there *is* an interpreter section, execution will begin there
669 instead. When there is an interpreter section, the start address
670 is (presumably) used by the interpreter at some point to start
671 execution of the program.
673 If there is an interpreter, it is normal for it to be set to an
674 arbitrary address at the outset. The job of finding it is
675 handled in enable_break().
677 So, to summarize, relocations are necessary when there is no
678 interpreter section and the start address obtained from the
679 executable is different from the address at which GDB is
682 [ The astute reader will note that we also test to make sure that
683 the executable in question has the DYNAMIC flag set. It is my
684 opinion that this test is unnecessary (undesirable even). It
685 was added to avoid inadvertent relocation of an executable
686 whose e_type member in the ELF header is not ET_DYN. There may
687 be a time in the future when it is desirable to do relocations
688 on other types of files as well in which case this condition
689 should either be removed or modified to accomodate the new file
690 type. (E.g, an ET_EXEC executable which has been built to be
691 position-independent could safely be relocated by the OS if
692 desired. It is true that this violates the ABI, but the ABI
693 has been known to be bent from time to time.) - Kevin, Nov 2000. ]
696 interp_sect = bfd_get_section_by_name (exec_bfd, ".interp");
697 if (interp_sect == NULL
698 && (bfd_get_file_flags (exec_bfd) & DYNAMIC) != 0
699 && bfd_get_start_address (exec_bfd) != pc)
701 struct cleanup *old_chain;
702 struct section_offsets *new_offsets;
704 CORE_ADDR displacement;
706 /* It is necessary to relocate the objfile. The amount to
707 relocate by is simply the address at which we are stopped
708 minus the starting address from the executable.
710 We relocate all of the sections by the same amount. This
711 behavior is mandated by recent editions of the System V ABI.
712 According to the System V Application Binary Interface,
713 Edition 4.1, page 5-5:
715 ... Though the system chooses virtual addresses for
716 individual processes, it maintains the segments' relative
717 positions. Because position-independent code uses relative
718 addressesing between segments, the difference between
719 virtual addresses in memory must match the difference
720 between virtual addresses in the file. The difference
721 between the virtual address of any segment in memory and
722 the corresponding virtual address in the file is thus a
723 single constant value for any one executable or shared
724 object in a given process. This difference is the base
725 address. One use of the base address is to relocate the
726 memory image of the program during dynamic linking.
728 The same language also appears in Edition 4.0 of the System V
729 ABI and is left unspecified in some of the earlier editions. */
731 displacement = pc - bfd_get_start_address (exec_bfd);
734 new_offsets = xcalloc (symfile_objfile->num_sections,
735 sizeof (struct section_offsets));
736 old_chain = make_cleanup (xfree, new_offsets);
738 for (i = 0; i < symfile_objfile->num_sections; i++)
740 if (displacement != ANOFFSET (symfile_objfile->section_offsets, i))
742 new_offsets->offsets[i] = displacement;
746 objfile_relocate (symfile_objfile, new_offsets);
748 do_cleanups (old_chain);
756 sunos_solib_create_inferior_hook -- shared library startup support
760 void sunos_solib_create_inferior_hook()
764 When gdb starts up the inferior, it nurses it along (through the
765 shell) until it is ready to execute it's first instruction. At this
766 point, this function gets called via expansion of the macro
767 SOLIB_CREATE_INFERIOR_HOOK.
769 For SunOS executables, this first instruction is typically the
770 one at "_start", or a similar text label, regardless of whether
771 the executable is statically or dynamically linked. The runtime
772 startup code takes care of dynamically linking in any shared
773 libraries, once gdb allows the inferior to continue.
775 For SVR4 executables, this first instruction is either the first
776 instruction in the dynamic linker (for dynamically linked
777 executables) or the instruction at "start" for statically linked
778 executables. For dynamically linked executables, the system
779 first exec's /lib/libc.so.N, which contains the dynamic linker,
780 and starts it running. The dynamic linker maps in any needed
781 shared libraries, maps in the actual user executable, and then
782 jumps to "start" in the user executable.
784 For both SunOS shared libraries, and SVR4 shared libraries, we
785 can arrange to cooperate with the dynamic linker to discover the
786 names of shared libraries that are dynamically linked, and the
787 base addresses to which they are linked.
789 This function is responsible for discovering those names and
790 addresses, and saving sufficient information about them to allow
791 their symbols to be read at a later time.
795 Between enable_break() and disable_break(), this code does not
796 properly handle hitting breakpoints which the user might have
797 set in the startup code or in the dynamic linker itself. Proper
798 handling will probably have to wait until the implementation is
799 changed to use the "breakpoint handler function" method.
801 Also, what if child has exit()ed? Must exit loop somehow.
805 sunos_solib_create_inferior_hook (void)
807 /* Relocate the main executable if necessary. */
808 sunos_relocate_main_executable ();
810 if ((debug_base = locate_base ()) == 0)
812 /* Can't find the symbol or the executable is statically linked. */
816 if (!enable_break ())
818 warning ("shared library handler failed to enable breakpoint");
822 /* SCO and SunOS need the loop below, other systems should be using the
823 special shared library breakpoints and the shared library breakpoint
826 Now run the target. It will eventually hit the breakpoint, at
827 which point all of the libraries will have been mapped in and we
828 can go groveling around in the dynamic linker structures to find
829 out what we need to know about them. */
831 clear_proceed_status ();
832 stop_soon = STOP_QUIETLY;
833 stop_signal = TARGET_SIGNAL_0;
836 target_resume (pid_to_ptid (-1), 0, stop_signal);
837 wait_for_inferior ();
839 while (stop_signal != TARGET_SIGNAL_TRAP);
840 stop_soon = NO_STOP_QUIETLY;
842 /* We are now either at the "mapping complete" breakpoint (or somewhere
843 else, a condition we aren't prepared to deal with anyway), so adjust
844 the PC as necessary after a breakpoint, disable the breakpoint, and
845 add any shared libraries that were mapped in. */
847 if (DECR_PC_AFTER_BREAK)
849 stop_pc -= DECR_PC_AFTER_BREAK;
850 write_register (PC_REGNUM, stop_pc);
853 if (!disable_break ())
855 warning ("shared library handler failed to disable breakpoint");
858 solib_add ((char *) 0, 0, (struct target_ops *) 0, auto_solib_add);
862 sunos_clear_solib (void)
868 sunos_free_so (struct so_list *so)
870 xfree (so->lm_info->lm);
875 sunos_relocate_section_addresses (struct so_list *so,
876 struct section_table *sec)
878 sec->addr += LM_ADDR (so);
879 sec->endaddr += LM_ADDR (so);
882 static struct target_so_ops sunos_so_ops;
885 _initialize_sunos_solib (void)
887 sunos_so_ops.relocate_section_addresses = sunos_relocate_section_addresses;
888 sunos_so_ops.free_so = sunos_free_so;
889 sunos_so_ops.clear_solib = sunos_clear_solib;
890 sunos_so_ops.solib_create_inferior_hook = sunos_solib_create_inferior_hook;
891 sunos_so_ops.special_symbol_handling = sunos_special_symbol_handling;
892 sunos_so_ops.current_sos = sunos_current_sos;
893 sunos_so_ops.open_symbol_file_object = open_symbol_file_object;
894 sunos_so_ops.in_dynsym_resolve_code = sunos_in_dynsym_resolve_code;
896 /* FIXME: Don't do this here. *_gdbarch_init() should set so_ops. */
897 current_target_so_ops = &sunos_so_ops;